Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SkillManagementServiceClient

Hierarchy

  • BaseServiceClient
    • SkillManagementServiceClient

Index

Constructors

Properties

Methods

Constructors

constructor

  • new SkillManagementServiceClient(apiConfiguration: ApiConfiguration, authenticationConfiguration: AuthenticationConfiguration, customUserAgent?: string): SkillManagementServiceClient

Properties

Protected apiConfiguration

apiConfiguration: ApiConfiguration

ApiConfiguration instance to provide dependencies for this service client

Private lwaServiceClient

lwaServiceClient: LwaServiceClient

Private userAgent

userAgent: string

Methods

addTestersToBetaTestV1

  • addTestersToBetaTestV1(skillId: string, testersRequest: TestersList): Promise<void>

associateIspWithSkillV1

  • associateIspWithSkillV1(productId: string, skillId: string): Promise<void>
  • Parameters

    • productId: string

      The in-skill product ID.

    • skillId: string

      The skill ID.

    Returns Promise<void>

callAddTestersToBetaTestV1

  • callAddTestersToBetaTestV1(skillId: string, testersRequest: TestersList): Promise<ApiResponse>

callAssociateIspWithSkillV1

  • callAssociateIspWithSkillV1(productId: string, skillId: string): Promise<ApiResponse>
  • Parameters

    • productId: string

      The in-skill product ID.

    • skillId: string

      The skill ID.

    Returns Promise<ApiResponse>

callCreateBetaTestV1

  • callCreateBetaTestV1(skillId: string, createTestBody?: TestBody): Promise<ApiResponse>
  • Parameters

    • skillId: string

      The skill ID.

    • Optional createTestBody: TestBody

      JSON object containing the details of a beta test used to create the test.

    Returns Promise<ApiResponse>

callCreateCatalogUploadV1

  • callCreateCatalogUploadV1(catalogId: string, catalogUploadRequestBody: CatalogUploadBase): Promise<ApiResponse>

callCreateExportRequestForSkillV1

  • callCreateExportRequestForSkillV1(skillId: string, stage: string): Promise<ApiResponse>

callCreateInteractionModelCatalogV1

  • callCreateInteractionModelCatalogV1(catalog: DefinitionData): Promise<ApiResponse>

callCreateInteractionModelCatalogVersionV1

  • callCreateInteractionModelCatalogVersionV1(catalogId: string, catalog: VersionData): Promise<ApiResponse>

callCreateIspForVendorV1

callCreateSkillForVendorV1

  • callCreateSkillForVendorV1(createSkillRequest: CreateSkillRequest): Promise<ApiResponse>

callCreateSkillPackageV1

callCreateUploadUrlV1

  • callCreateUploadUrlV1(): Promise<ApiResponse>

callDeleteAccountLinkingInfoV1

  • callDeleteAccountLinkingInfoV1(skillId: string, stageV2: string): Promise<ApiResponse>
  • Parameters

    • skillId: string

      The skill ID.

    • stageV2: string

      Stages of a skill including the new certified stage. * `development` - skills which are currently in development corresponds to this stage. * `certified` - skills which have completed certification and ready for publishing corresponds to this stage. * `live` - skills which are currently live corresponds to this stage.

    Returns Promise<ApiResponse>

callDeleteInteractionModelCatalogV1

  • callDeleteInteractionModelCatalogV1(catalogId: string): Promise<ApiResponse>

callDeleteInteractionModelCatalogVersionV1

  • callDeleteInteractionModelCatalogVersionV1(catalogId: string, version: string): Promise<ApiResponse>
  • Parameters

    • catalogId: string

      Unique identifier of the catalog

    • version: string

      Version for interaction model.

    Returns Promise<ApiResponse>

callDeleteIspForProductV1

  • callDeleteIspForProductV1(productId: string, stage: string, ifMatch?: string): Promise<ApiResponse>
  • Parameters

    • productId: string

      The in-skill product ID.

    • stage: string

      Stage for skill.

    • Optional ifMatch: string

      Request header that specified an entity tag. The server will update the resource only if the eTag matches with the resource's current eTag.

    Returns Promise<ApiResponse>

callDeletePrivateDistributionAccountIdV1

  • callDeletePrivateDistributionAccountIdV1(skillId: string, stage: string, id: string): Promise<ApiResponse>
  • Parameters

    • skillId: string

      The skill ID.

    • stage: string

      Stage for skill.

    • id: string

      ARN that a skill can be privately distributed to.

    Returns Promise<ApiResponse>

callDeleteSkillEnablementV1

  • callDeleteSkillEnablementV1(skillId: string, stage: string): Promise<ApiResponse>

callDeleteSkillV1

  • callDeleteSkillV1(skillId: string): Promise<ApiResponse>

callDisassociateIspWithSkillV1

  • callDisassociateIspWithSkillV1(productId: string, skillId: string): Promise<ApiResponse>
  • Parameters

    • productId: string

      The in-skill product ID.

    • skillId: string

      The skill ID.

    Returns Promise<ApiResponse>

callEndBetaTestV1

  • callEndBetaTestV1(skillId: string): Promise<ApiResponse>

callGenerateCatalogUploadUrlV1

callGenerateCredentialsForAlexaHostedSkillV1

callGetAccountLinkingInfoV1

  • callGetAccountLinkingInfoV1(skillId: string, stageV2: string): Promise<ApiResponse>
  • Parameters

    • skillId: string

      The skill ID.

    • stageV2: string

      Stages of a skill including the new certified stage. * `development` - skills which are currently in development corresponds to this stage. * `certified` - skills which have completed certification and ready for publishing corresponds to this stage. * `live` - skills which are currently live corresponds to this stage.

    Returns Promise<ApiResponse>

callGetAlexaHostedSkillMetadataV1

  • callGetAlexaHostedSkillMetadataV1(skillId: string): Promise<ApiResponse>

callGetAlexaHostedSkillUserPermissionsV1

  • callGetAlexaHostedSkillUserPermissionsV1(vendorId: string, permission: string): Promise<ApiResponse>
  • Parameters

    • vendorId: string

      vendorId

    • permission: string

      The permission of a hosted skill feature that customer needs to check.

    Returns Promise<ApiResponse>

callGetBetaTestV1

  • callGetBetaTestV1(skillId: string): Promise<ApiResponse>

callGetCertificationReviewV1

  • callGetCertificationReviewV1(skillId: string, certificationId: string, acceptLanguage?: string): Promise<ApiResponse>
  • Parameters

    • skillId: string

      The skill ID.

    • certificationId: string

      Id of the certification. Reserved word identifier of mostRecent can be used to get the most recent certification for the skill. Note that the behavior of the API in this case would be the same as when the actual certification id of the most recent certification is used in the request.

    • Optional acceptLanguage: string

      User's locale/language in context.

    Returns Promise<ApiResponse>

callGetCertificationsListV1

  • callGetCertificationsListV1(skillId: string, nextToken?: string, maxResults?: number): Promise<ApiResponse>
  • Parameters

    • skillId: string

      The skill ID.

    • Optional nextToken: string

      When response to this API call is truncated (that is, isTruncated response element value is true), the response also includes the nextToken element. The value of nextToken can be used in the next request as the continuation-token to list the next set of objects. The continuation token is an opaque value that Skill Management API understands. Token has expiry of 24 hours.

    • Optional maxResults: number

      Sets the maximum number of results returned in the response body. If you want to retrieve fewer than upper limit of 50 results, you can add this parameter to your request. maxResults should not exceed the upper limit. The response might contain fewer results than maxResults, but it will never contain more. If there are additional results that satisfy the search criteria, but these results were not returned, the response contains isTruncated = true.

    Returns Promise<ApiResponse>

callGetContentUploadByIdV1

  • callGetContentUploadByIdV1(catalogId: string, uploadId: string): Promise<ApiResponse>
  • Parameters

    • catalogId: string

      Unique identifier of the catalog

    • uploadId: string

      Unique identifier of the upload

    Returns Promise<ApiResponse>

callGetImportStatusV1

  • callGetImportStatusV1(importId: string): Promise<ApiResponse>

callGetInteractionModelCatalogDefinitionV1

  • callGetInteractionModelCatalogDefinitionV1(catalogId: string): Promise<ApiResponse>

callGetInteractionModelCatalogUpdateStatusV1

  • callGetInteractionModelCatalogUpdateStatusV1(catalogId: string, updateRequestId: string): Promise<ApiResponse>
  • Parameters

    • catalogId: string

      Unique identifier of the catalog

    • updateRequestId: string

      The identifier for catalog version creation process

    Returns Promise<ApiResponse>

callGetInteractionModelCatalogValuesV1

  • callGetInteractionModelCatalogValuesV1(catalogId: string, version: string, maxResults?: number, nextToken?: string): Promise<ApiResponse>
  • Parameters

    • catalogId: string

      Unique identifier of the catalog

    • version: string

      Version for interaction model.

    • Optional maxResults: number

      Sets the maximum number of results returned in the response body. If you want to retrieve fewer than upper limit of 50 results, you can add this parameter to your request. maxResults should not exceed the upper limit. The response might contain fewer results than maxResults, but it will never contain more. If there are additional results that satisfy the search criteria, but these results were not returned, the response contains isTruncated = true.

    • Optional nextToken: string

      When response to this API call is truncated (that is, isTruncated response element value is true), the response also includes the nextToken element. The value of nextToken can be used in the next request as the continuation-token to list the next set of objects. The continuation token is an opaque value that Skill Management API understands. Token has expiry of 24 hours.

    Returns Promise<ApiResponse>

callGetInteractionModelCatalogVersionV1

  • callGetInteractionModelCatalogVersionV1(catalogId: string, version: string): Promise<ApiResponse>
  • Parameters

    • catalogId: string

      Unique identifier of the catalog

    • version: string

      Version for interaction model.

    Returns Promise<ApiResponse>

callGetInteractionModelMetadataV1

  • callGetInteractionModelMetadataV1(skillId: string, stageV2: string, locale: string): Promise<ApiResponse>
  • Parameters

    • skillId: string

      The skill ID.

    • stageV2: string

      Stages of a skill including the new certified stage. * `development` - skills which are currently in development corresponds to this stage. * `certified` - skills which have completed certification and ready for publishing corresponds to this stage. * `live` - skills which are currently live corresponds to this stage.

    • locale: string

      The locale for the model requested e.g. en-GB, en-US, de-DE.

    Returns Promise<ApiResponse>

callGetInteractionModelV1

  • callGetInteractionModelV1(skillId: string, stageV2: string, locale: string): Promise<ApiResponse>
  • Parameters

    • skillId: string

      The skill ID.

    • stageV2: string

      Stages of a skill including the new certified stage. * `development` - skills which are currently in development corresponds to this stage. * `certified` - skills which have completed certification and ready for publishing corresponds to this stage. * `live` - skills which are currently live corresponds to this stage.

    • locale: string

      The locale for the model requested e.g. en-GB, en-US, de-DE.

    Returns Promise<ApiResponse>

callGetInteractionModelVersionV1

  • callGetInteractionModelVersionV1(skillId: string, stageV2: string, locale: string, version: string): Promise<ApiResponse>
  • Parameters

    • skillId: string

      The skill ID.

    • stageV2: string

      Stages of a skill including the new certified stage. * `development` - skills which are currently in development corresponds to this stage. * `certified` - skills which have completed certification and ready for publishing corresponds to this stage. * `live` - skills which are currently live corresponds to this stage.

    • locale: string

      The locale for the model requested e.g. en-GB, en-US, de-DE.

    • version: string

      Version for interaction model.

    Returns Promise<ApiResponse>

callGetIspAssociatedSkillsV1

  • callGetIspAssociatedSkillsV1(productId: string, stage: string, nextToken?: string, maxResults?: number): Promise<ApiResponse>
  • Parameters

    • productId: string

      The in-skill product ID.

    • stage: string

      Stage for skill.

    • Optional nextToken: string

      When response to this API call is truncated (that is, isTruncated response element value is true), the response also includes the nextToken element. The value of nextToken can be used in the next request as the continuation-token to list the next set of objects. The continuation token is an opaque value that Skill Management API understands. Token has expiry of 24 hours.

    • Optional maxResults: number

      Sets the maximum number of results returned in the response body. If you want to retrieve fewer than upper limit of 50 results, you can add this parameter to your request. maxResults should not exceed the upper limit. The response might contain fewer results than maxResults, but it will never contain more. If there are additional results that satisfy the search criteria, but these results were not returned, the response contains isTruncated = true.

    Returns Promise<ApiResponse>

callGetIspDefinitionV1

  • callGetIspDefinitionV1(productId: string, stage: string): Promise<ApiResponse>
  • Parameters

    • productId: string

      The in-skill product ID.

    • stage: string

      Stage for skill.

    Returns Promise<ApiResponse>

callGetIspListForSkillIdV1

  • callGetIspListForSkillIdV1(skillId: string, stage: string, nextToken?: string, maxResults?: number): Promise<ApiResponse>
  • Parameters

    • skillId: string

      The skill ID.

    • stage: string

      Stage for skill.

    • Optional nextToken: string

      When response to this API call is truncated (that is, isTruncated response element value is true), the response also includes the nextToken element. The value of nextToken can be used in the next request as the continuation-token to list the next set of objects. The continuation token is an opaque value that Skill Management API understands. Token has expiry of 24 hours.

    • Optional maxResults: number

      Sets the maximum number of results returned in the response body. If you want to retrieve fewer than upper limit of 50 results, you can add this parameter to your request. maxResults should not exceed the upper limit. The response might contain fewer results than maxResults, but it will never contain more. If there are additional results that satisfy the search criteria, but these results were not returned, the response contains isTruncated = true.

    Returns Promise<ApiResponse>

callGetIspListForVendorV1

  • callGetIspListForVendorV1(vendorId: string, nextToken?: string, maxResults?: number, productId?: Array<string>, stage?: string, type?: string, referenceName?: string, status?: string, isAssociatedWithSkill?: string): Promise<ApiResponse>
  • Parameters

    • vendorId: string

      The vendor ID.

    • Optional nextToken: string

      When response to this API call is truncated (that is, isTruncated response element value is true), the response also includes the nextToken element. The value of nextToken can be used in the next request as the continuation-token to list the next set of objects. The continuation token is an opaque value that Skill Management API understands. Token has expiry of 24 hours.

    • Optional maxResults: number

      Sets the maximum number of results returned in the response body. If you want to retrieve fewer than upper limit of 50 results, you can add this parameter to your request. maxResults should not exceed the upper limit. The response might contain fewer results than maxResults, but it will never contain more. If there are additional results that satisfy the search criteria, but these results were not returned, the response contains isTruncated = true.

    • Optional productId: Array<string>

      The list of in-skill product IDs that you wish to get the summary for. A maximum of 50 in-skill product IDs can be specified in a single listInSkillProducts call. Please note that this parameter must not be used with 'nextToken' and/or 'maxResults' parameter.

    • Optional stage: string

      Filter in-skill products by specified stage.

    • Optional type: string

      Type of in-skill product to filter on.

    • Optional referenceName: string

      Filter in-skill products by reference name.

    • Optional status: string

      Status of in-skill product.

    • Optional isAssociatedWithSkill: string

      Filter in-skill products by whether or not they are associated to a skill.

    Returns Promise<ApiResponse>

callGetIspSummaryV1

  • callGetIspSummaryV1(productId: string, stage: string): Promise<ApiResponse>
  • Parameters

    • productId: string

      The in-skill product ID.

    • stage: string

      Stage for skill.

    Returns Promise<ApiResponse>

callGetListOfTestersV1

  • callGetListOfTestersV1(skillId: string, nextToken?: string, maxResults?: number): Promise<ApiResponse>
  • Parameters

    • skillId: string

      The skill ID.

    • Optional nextToken: string

      When response to this API call is truncated (that is, isTruncated response element value is true), the response also includes the nextToken element. The value of nextToken can be used in the next request as the continuation-token to list the next set of objects. The continuation token is an opaque value that Skill Management API understands. Token has expiry of 24 hours.

    • Optional maxResults: number

      Sets the maximum number of results returned in the response body. If you want to retrieve fewer than upper limit of 50 results, you can add this parameter to your request. maxResults should not exceed the upper limit. The response might contain fewer results than maxResults, but it will never contain more. If there are additional results that satisfy the search criteria, but these results were not returned, the response contains isTruncated = true.

    Returns Promise<ApiResponse>

callGetSSLCertificatesV1

  • callGetSSLCertificatesV1(skillId: string): Promise<ApiResponse>

callGetSkillEnablementStatusV1

  • callGetSkillEnablementStatusV1(skillId: string, stage: string): Promise<ApiResponse>

callGetSkillManifestV1

  • callGetSkillManifestV1(skillId: string, stageV2: string): Promise<ApiResponse>
  • Parameters

    • skillId: string

      The skill ID.

    • stageV2: string

      Stages of a skill including the new certified stage. * `development` - skills which are currently in development corresponds to this stage. * `certified` - skills which have completed certification and ready for publishing corresponds to this stage. * `live` - skills which are currently live corresponds to this stage.

    Returns Promise<ApiResponse>

callGetSkillMetricsV1

  • callGetSkillMetricsV1(skillId: string, startTime: string, endTime: string, period: string, metric: string, stage: string, skillType: string, intent?: string, locale?: string, maxResults?: number, nextToken?: string): Promise<ApiResponse>
  • Parameters

    • skillId: string

      The skill ID.

    • startTime: string

      The start time of query.

    • endTime: string

      The end time of query (The maximum time duration is 1 week)

    • period: string

      The aggregation period to use when retrieving the metric, follows ISO_8601#Durations format.

    • metric: string

      A distinct set of logic which predictably returns a set of data.

    • stage: string

      The stage of the skill (live, development).

    • skillType: string

      The type of the skill (custom, smartHome and flashBriefing).

    • Optional intent: string

      The intent of the skill.

    • Optional locale: string

      The locale for the skill. e.g. en-GB, en-US, de-DE and etc.

    • Optional maxResults: number

      Sets the maximum number of results returned in the response body. If you want to retrieve fewer than upper limit of 50 results, you can add this parameter to your request. maxResults should not exceed the upper limit. The response might contain fewer results than maxResults, but it will never contain more. If there are additional results that satisfy the search criteria, but these results were not returned, the response contains isTruncated = true.

    • Optional nextToken: string

      When response to this API call is truncated (that is, isTruncated response element value is true), the response also includes the nextToken element. The value of nextToken can be used in the next request as the continuation-token to list the next set of objects. The continuation token is an opaque value that Skill Management API understands. Token has expiry of 24 hours.

    Returns Promise<ApiResponse>

callGetSkillSimulationV1

  • callGetSkillSimulationV1(skillId: string, simulationId: string): Promise<ApiResponse>
  • Parameters

    • skillId: string

      The skill ID.

    • simulationId: string

      Id of the simulation.

    Returns Promise<ApiResponse>

callGetSkillStatusV1

  • callGetSkillStatusV1(skillId: string, resource?: string): Promise<ApiResponse>
  • Parameters

    • skillId: string

      The skill ID.

    • Optional resource: string

      Resource name for which status information is desired. It is an optional, filtering parameter and can be used more than once, to retrieve status for all the desired (sub)resources only, in single API call. If this parameter is not specified, status for all the resources/sub-resources will be returned.

    Returns Promise<ApiResponse>

callGetSkillValidationsV1

  • callGetSkillValidationsV1(skillId: string, validationId: string, stage: string, acceptLanguage?: string): Promise<ApiResponse>
  • Parameters

    • skillId: string

      The skill ID.

    • validationId: string

      Id of the validation. Reserved word identifier of mostRecent can be used to get the most recent validation for the skill and stage. Note that the behavior of the API in this case would be the same as when the actual validation id of the most recent validation is used in the request.

    • stage: string

      Stage for skill.

    • Optional acceptLanguage: string

      User's locale/language in context.

    Returns Promise<ApiResponse>

callGetStatusOfExportRequestV1

  • callGetStatusOfExportRequestV1(exportId: string): Promise<ApiResponse>

callGetUtteranceDataV1

  • callGetUtteranceDataV1(skillId: string, nextToken?: string, maxResults?: number, sortDirection?: string, sortField?: string, stage?: Array<StageType>, locale?: Array<LocaleInQuery>, dialogActName?: Array<DialogActName>, intentConfidenceBin?: Array<IntentConfidenceBin>, intentName?: Array<string>, intentSlotsName?: Array<string>, interactionType?: Array<InteractionType>, publicationStatus?: Array<PublicationStatus>, utteranceText?: Array<string>): Promise<ApiResponse>
  • Parameters

    • skillId: string

      The skill ID.

    • Optional nextToken: string

      When response to this API call is truncated (that is, isTruncated response element value is true), the response also includes the nextToken element. The value of nextToken can be used in the next request as the continuation-token to list the next set of objects. The continuation token is an opaque value that Skill Management API understands. Token has expiry of 24 hours.

    • Optional maxResults: number

      Sets the maximum number of results returned in the response body. If you want to retrieve fewer than upper limit of 50 results, you can add this parameter to your request. maxResults should not exceed the upper limit. The response might contain fewer results than maxResults, but it will never contain more. If there are additional results that satisfy the search criteria, but these results were not returned, the response contains isTruncated = true.

    • Optional sortDirection: string

      Sets the sorting direction of the result items. When set to 'asc' these items are returned in ascending order of sortField value and when set to 'desc' these items are returned in descending order of sortField value.

    • Optional sortField: string

      Sets the field on which the sorting would be applied.

    • Optional stage: Array<StageType>

      A filter used to retrieve items where the stage is equal to the given value.

    • Optional locale: Array<LocaleInQuery>
    • Optional dialogActName: Array<DialogActName>

      A filter used to retrieve items where the dialogAct name is equal to the given value. * `Dialog.ElicitSlot`: Alexa asked the user for the value of a specific slot. (https://developer.amazon.com/docs/custom-skills/dialog-interface-reference.html#elicitslot) * `Dialog.ConfirmSlot`: Alexa confirmed the value of a specific slot before continuing with the dialog. (https://developer.amazon.com/docs/custom-skills/dialog-interface-reference.html#confirmslot) * `Dialog.ConfirmIntent`: Alexa confirmed the all the information the user has provided for the intent before the skill took action. (https://developer.amazon.com/docs/custom-skills/dialog-interface-reference.html#confirmintent)

    • Optional intentConfidenceBin: Array<IntentConfidenceBin>
    • Optional intentName: Array<string>

      A filter used to retrieve items where the intent name is equal to the given value.

    • Optional intentSlotsName: Array<string>

      A filter used to retrieve items where the one of the slot names is equal to the given value.

    • Optional interactionType: Array<InteractionType>
    • Optional publicationStatus: Array<PublicationStatus>
    • Optional utteranceText: Array<string>

      A filter used to retrieve items where the utterance text contains the given phrase. Each filter value can be at-least 1 character and at-most 100 characters long.

    Returns Promise<ApiResponse>

callGetVendorListV1

  • callGetVendorListV1(): Promise<ApiResponse>

callImportSkillPackageV1

  • callImportSkillPackageV1(updateSkillWithPackageRequest: UpdateSkillWithPackageRequest, skillId: string, ifMatch?: string): Promise<ApiResponse>
  • Parameters

    • updateSkillWithPackageRequest: UpdateSkillWithPackageRequest

      Defines the request body for updatePackage API.

    • skillId: string

      The skill ID.

    • Optional ifMatch: string

      Request header that specified an entity tag. The server will update the resource only if the eTag matches with the resource's current eTag.

    Returns Promise<ApiResponse>

callListInteractionModelCatalogsV1

  • callListInteractionModelCatalogsV1(vendorId: string, maxResults?: number, nextToken?: string, sortDirection?: string): Promise<ApiResponse>
  • Parameters

    • vendorId: string

      The vendor ID.

    • Optional maxResults: number

      Sets the maximum number of results returned in the response body. If you want to retrieve fewer than upper limit of 50 results, you can add this parameter to your request. maxResults should not exceed the upper limit. The response might contain fewer results than maxResults, but it will never contain more. If there are additional results that satisfy the search criteria, but these results were not returned, the response contains isTruncated = true.

    • Optional nextToken: string

      When response to this API call is truncated (that is, isTruncated response element value is true), the response also includes the nextToken element. The value of nextToken can be used in the next request as the continuation-token to list the next set of objects. The continuation token is an opaque value that Skill Management API understands. Token has expiry of 24 hours.

    • Optional sortDirection: string

      Sets the sorting direction of the result items. When set to 'asc' these items are returned in ascending order of sortField value and when set to 'desc' these items are returned in descending order of sortField value.

    Returns Promise<ApiResponse>

callListInteractionModelVersionsV1

  • callListInteractionModelVersionsV1(skillId: string, stageV2: string, locale: string, nextToken?: string, maxResults?: number, sortDirection?: string, sortField?: string): Promise<ApiResponse>
  • Parameters

    • skillId: string

      The skill ID.

    • stageV2: string

      Stages of a skill including the new certified stage. * `development` - skills which are currently in development corresponds to this stage. * `certified` - skills which have completed certification and ready for publishing corresponds to this stage. * `live` - skills which are currently live corresponds to this stage.

    • locale: string

      The locale for the model requested e.g. en-GB, en-US, de-DE.

    • Optional nextToken: string

      When response to this API call is truncated (that is, isTruncated response element value is true), the response also includes the nextToken element. The value of nextToken can be used in the next request as the continuation-token to list the next set of objects. The continuation token is an opaque value that Skill Management API understands. Token has expiry of 24 hours.

    • Optional maxResults: number

      Sets the maximum number of results returned in the response body. If you want to retrieve fewer than upper limit of 50 results, you can add this parameter to your request. maxResults should not exceed the upper limit. The response might contain fewer results than maxResults, but it will never contain more. If there are additional results that satisfy the search criteria, but these results were not returned, the response contains isTruncated = true.

    • Optional sortDirection: string

      Sets the sorting direction of the result items. When set to 'asc' these items are returned in ascending order of sortField value and when set to 'desc' these items are returned in descending order of sortField value.

    • Optional sortField: string

      Sets the field on which the sorting would be applied.

    Returns Promise<ApiResponse>

callListPrivateDistributionAccountsV1

  • callListPrivateDistributionAccountsV1(skillId: string, stage: string, nextToken?: string, maxResults?: number): Promise<ApiResponse>
  • Parameters

    • skillId: string

      The skill ID.

    • stage: string

      Stage for skill.

    • Optional nextToken: string

      When response to this API call is truncated (that is, isTruncated response element value is true), the response also includes the nextToken element. The value of nextToken can be used in the next request as the continuation-token to list the next set of objects. The continuation token is an opaque value that Skill Management API understands. Token has expiry of 24 hours.

    • Optional maxResults: number

      Sets the maximum number of results returned in the response body. If you want to retrieve fewer than upper limit of 50 results, you can add this parameter to your request. maxResults should not exceed the upper limit. The response might contain fewer results than maxResults, but it will never contain more. If there are additional results that satisfy the search criteria, but these results were not returned, the response contains isTruncated = true.

    Returns Promise<ApiResponse>

callListSkillsForVendorV1

  • callListSkillsForVendorV1(vendorId: string, nextToken?: string, maxResults?: number, skillId?: Array<string>): Promise<ApiResponse>
  • Parameters

    • vendorId: string

      The vendor ID.

    • Optional nextToken: string

      When response to this API call is truncated (that is, isTruncated response element value is true), the response also includes the nextToken element. The value of nextToken can be used in the next request as the continuation-token to list the next set of objects. The continuation token is an opaque value that Skill Management API understands. Token has expiry of 24 hours.

    • Optional maxResults: number

      Sets the maximum number of results returned in the response body. If you want to retrieve fewer than upper limit of 50 results, you can add this parameter to your request. maxResults should not exceed the upper limit. The response might contain fewer results than maxResults, but it will never contain more. If there are additional results that satisfy the search criteria, but these results were not returned, the response contains isTruncated = true.

    • Optional skillId: Array<string>

      the list of skillIds that you wish to get the summary for. A maximum of 10 skillIds can be specified to get the skill summary in single listSkills call. Please note that this parameter must not be used with 'nextToken' or/and 'maxResults' parameter.

    Returns Promise<ApiResponse>

callProfileNluV1

  • callProfileNluV1(profileNluRequest: ProfileNluRequest, skillId: string, stage: string, locale: string): Promise<ApiResponse>
  • Parameters

    • profileNluRequest: ProfileNluRequest

      Payload sent to the profile nlu API.

    • skillId: string

      The skill ID.

    • stage: string

      Stage for skill.

    • locale: string

      The locale for the model requested e.g. en-GB, en-US, de-DE.

    Returns Promise<ApiResponse>

callRemoveTestersFromBetaTestV1

  • callRemoveTestersFromBetaTestV1(skillId: string, testersRequest: TestersList): Promise<ApiResponse>

callRequestFeedbackFromTestersV1

  • callRequestFeedbackFromTestersV1(skillId: string, testersRequest: TestersList): Promise<ApiResponse>

callResetEntitlementForProductV1

  • callResetEntitlementForProductV1(productId: string, stage: string): Promise<ApiResponse>
  • Parameters

    • productId: string

      The in-skill product ID.

    • stage: string

      Stage for skill.

    Returns Promise<ApiResponse>

callSendReminderToTestersV1

  • callSendReminderToTestersV1(skillId: string, testersRequest: TestersList): Promise<ApiResponse>

callSetInteractionModelV1

  • callSetInteractionModelV1(skillId: string, stageV2: string, locale: string, interactionModel: InteractionModelData, ifMatch?: string): Promise<ApiResponse>
  • Parameters

    • skillId: string

      The skill ID.

    • stageV2: string

      Stages of a skill including the new certified stage. * `development` - skills which are currently in development corresponds to this stage. * `certified` - skills which have completed certification and ready for publishing corresponds to this stage. * `live` - skills which are currently live corresponds to this stage.

    • locale: string

      The locale for the model requested e.g. en-GB, en-US, de-DE.

    • interactionModel: InteractionModelData
    • Optional ifMatch: string

      Request header that specified an entity tag. The server will update the resource only if the eTag matches with the resource's current eTag.

    Returns Promise<ApiResponse>

callSetPrivateDistributionAccountIdV1

  • callSetPrivateDistributionAccountIdV1(skillId: string, stage: string, id: string): Promise<ApiResponse>
  • Parameters

    • skillId: string

      The skill ID.

    • stage: string

      Stage for skill.

    • id: string

      ARN that a skill can be privately distributed to.

    Returns Promise<ApiResponse>

callSetSSLCertificatesV1

  • callSetSSLCertificatesV1(skillId: string, sslCertificatePayload: SSLCertificatePayload): Promise<ApiResponse>

callSetSkillEnablementV1

  • callSetSkillEnablementV1(skillId: string, stage: string): Promise<ApiResponse>

callSimulateSkillV1

  • callSimulateSkillV1(skillId: string, simulationsApiRequest: SimulationsApiRequest): Promise<ApiResponse>

callStartBetaTestV1

  • callStartBetaTestV1(skillId: string): Promise<ApiResponse>

callSubmitSkillForCertificationV1

callSubmitSkillValidationV1

  • callSubmitSkillValidationV1(validationsApiRequest: ValidationsApiRequest, skillId: string, stage: string): Promise<ApiResponse>

callUpdateAccountLinkingInfoV1

  • callUpdateAccountLinkingInfoV1(skillId: string, stageV2: string, accountLinkingRequest: AccountLinkingRequest, ifMatch?: string): Promise<ApiResponse>
  • Parameters

    • skillId: string

      The skill ID.

    • stageV2: string

      Stages of a skill including the new certified stage. * `development` - skills which are currently in development corresponds to this stage. * `certified` - skills which have completed certification and ready for publishing corresponds to this stage. * `live` - skills which are currently live corresponds to this stage.

    • accountLinkingRequest: AccountLinkingRequest

      The fields required to create accountLinking partner.

    • Optional ifMatch: string

      Request header that specified an entity tag. The server will update the resource only if the eTag matches with the resource's current eTag.

    Returns Promise<ApiResponse>

callUpdateBetaTestV1

  • callUpdateBetaTestV1(skillId: string, createTestBody?: TestBody): Promise<ApiResponse>
  • Parameters

    • skillId: string

      The skill ID.

    • Optional createTestBody: TestBody

      JSON object containing the details of a beta test used to create the test.

    Returns Promise<ApiResponse>

callUpdateInteractionModelCatalogV1

  • callUpdateInteractionModelCatalogV1(catalogId: string, updateRequest: UpdateRequest): Promise<ApiResponse>

callUpdateInteractionModelCatalogVersionV1

  • callUpdateInteractionModelCatalogVersionV1(catalogId: string, version: string, catalogUpdate?: CatalogUpdate): Promise<ApiResponse>
  • Parameters

    • catalogId: string

      Unique identifier of the catalog

    • version: string

      Version for interaction model.

    • Optional catalogUpdate: CatalogUpdate

    Returns Promise<ApiResponse>

callUpdateIspForProductV1

  • callUpdateIspForProductV1(productId: string, stage: string, updateInSkillProductRequest: UpdateInSkillProductRequest, ifMatch?: string): Promise<ApiResponse>
  • Parameters

    • productId: string

      The in-skill product ID.

    • stage: string

      Stage for skill.

    • updateInSkillProductRequest: UpdateInSkillProductRequest

      defines the request body for updateInSkillProduct API.

    • Optional ifMatch: string

      Request header that specified an entity tag. The server will update the resource only if the eTag matches with the resource's current eTag.

    Returns Promise<ApiResponse>

callUpdateSkillManifestV1

  • callUpdateSkillManifestV1(skillId: string, stageV2: string, updateSkillRequest: SkillManifestEnvelope, ifMatch?: string): Promise<ApiResponse>
  • Parameters

    • skillId: string

      The skill ID.

    • stageV2: string

      Stages of a skill including the new certified stage. * `development` - skills which are currently in development corresponds to this stage. * `certified` - skills which have completed certification and ready for publishing corresponds to this stage. * `live` - skills which are currently live corresponds to this stage.

    • updateSkillRequest: SkillManifestEnvelope

      Defines the request body for updateSkill API.

    • Optional ifMatch: string

      Request header that specified an entity tag. The server will update the resource only if the eTag matches with the resource's current eTag.

    Returns Promise<ApiResponse>

callWithdrawSkillFromCertificationV1

  • callWithdrawSkillFromCertificationV1(skillId: string, withdrawRequest: WithdrawRequest): Promise<ApiResponse>

createBetaTestV1

  • createBetaTestV1(skillId: string, createTestBody?: TestBody): Promise<void>
  • Parameters

    • skillId: string

      The skill ID.

    • Optional createTestBody: TestBody

      JSON object containing the details of a beta test used to create the test.

    Returns Promise<void>

createCatalogUploadV1

  • createCatalogUploadV1(catalogId: string, catalogUploadRequestBody: CatalogUploadBase): Promise<void>

createExportRequestForSkillV1

  • createExportRequestForSkillV1(skillId: string, stage: string): Promise<void>

createInteractionModelCatalogV1

createInteractionModelCatalogVersionV1

  • createInteractionModelCatalogVersionV1(catalogId: string, catalog: VersionData): Promise<void>

createIspForVendorV1

createSkillForVendorV1

createSkillPackageV1

createUploadUrlV1

deleteAccountLinkingInfoV1

  • deleteAccountLinkingInfoV1(skillId: string, stageV2: string): Promise<void>
  • Parameters

    • skillId: string

      The skill ID.

    • stageV2: string

      Stages of a skill including the new certified stage. * `development` - skills which are currently in development corresponds to this stage. * `certified` - skills which have completed certification and ready for publishing corresponds to this stage. * `live` - skills which are currently live corresponds to this stage.

    Returns Promise<void>

deleteInteractionModelCatalogV1

  • deleteInteractionModelCatalogV1(catalogId: string): Promise<void>

deleteInteractionModelCatalogVersionV1

  • deleteInteractionModelCatalogVersionV1(catalogId: string, version: string): Promise<void>
  • Parameters

    • catalogId: string

      Unique identifier of the catalog

    • version: string

      Version for interaction model.

    Returns Promise<void>

deleteIspForProductV1

  • deleteIspForProductV1(productId: string, stage: string, ifMatch?: string): Promise<void>
  • Parameters

    • productId: string

      The in-skill product ID.

    • stage: string

      Stage for skill.

    • Optional ifMatch: string

      Request header that specified an entity tag. The server will update the resource only if the eTag matches with the resource's current eTag.

    Returns Promise<void>

deletePrivateDistributionAccountIdV1

  • deletePrivateDistributionAccountIdV1(skillId: string, stage: string, id: string): Promise<void>
  • Parameters

    • skillId: string

      The skill ID.

    • stage: string

      Stage for skill.

    • id: string

      ARN that a skill can be privately distributed to.

    Returns Promise<void>

deleteSkillEnablementV1

  • deleteSkillEnablementV1(skillId: string, stage: string): Promise<void>

deleteSkillV1

  • deleteSkillV1(skillId: string): Promise<void>

disassociateIspWithSkillV1

  • disassociateIspWithSkillV1(productId: string, skillId: string): Promise<void>
  • Parameters

    • productId: string

      The in-skill product ID.

    • skillId: string

      The skill ID.

    Returns Promise<void>

endBetaTestV1

  • endBetaTestV1(skillId: string): Promise<void>

generateCatalogUploadUrlV1

generateCredentialsForAlexaHostedSkillV1

getAccountLinkingInfoV1

  • Parameters

    • skillId: string

      The skill ID.

    • stageV2: string

      Stages of a skill including the new certified stage. * `development` - skills which are currently in development corresponds to this stage. * `certified` - skills which have completed certification and ready for publishing corresponds to this stage. * `live` - skills which are currently live corresponds to this stage.

    Returns Promise<AccountLinkingResponse>

getAlexaHostedSkillMetadataV1

getAlexaHostedSkillUserPermissionsV1

  • getAlexaHostedSkillUserPermissionsV1(vendorId: string, permission: string): Promise<HostedSkillPermission>

getBetaTestV1

  • getBetaTestV1(skillId: string): Promise<BetaTest>

getCertificationReviewV1

  • getCertificationReviewV1(skillId: string, certificationId: string, acceptLanguage?: string): Promise<CertificationResponse>
  • Parameters

    • skillId: string

      The skill ID.

    • certificationId: string

      Id of the certification. Reserved word identifier of mostRecent can be used to get the most recent certification for the skill. Note that the behavior of the API in this case would be the same as when the actual certification id of the most recent certification is used in the request.

    • Optional acceptLanguage: string

      User's locale/language in context.

    Returns Promise<CertificationResponse>

getCertificationsListV1

  • Parameters

    • skillId: string

      The skill ID.

    • Optional nextToken: string

      When response to this API call is truncated (that is, isTruncated response element value is true), the response also includes the nextToken element. The value of nextToken can be used in the next request as the continuation-token to list the next set of objects. The continuation token is an opaque value that Skill Management API understands. Token has expiry of 24 hours.

    • Optional maxResults: number

      Sets the maximum number of results returned in the response body. If you want to retrieve fewer than upper limit of 50 results, you can add this parameter to your request. maxResults should not exceed the upper limit. The response might contain fewer results than maxResults, but it will never contain more. If there are additional results that satisfy the search criteria, but these results were not returned, the response contains isTruncated = true.

    Returns Promise<ListCertificationsResponse>

getContentUploadByIdV1

getImportStatusV1

getInteractionModelCatalogDefinitionV1

getInteractionModelCatalogUpdateStatusV1

  • getInteractionModelCatalogUpdateStatusV1(catalogId: string, updateRequestId: string): Promise<CatalogStatus>
  • Parameters

    • catalogId: string

      Unique identifier of the catalog

    • updateRequestId: string

      The identifier for catalog version creation process

    Returns Promise<CatalogStatus>

getInteractionModelCatalogValuesV1

  • getInteractionModelCatalogValuesV1(catalogId: string, version: string, maxResults?: number, nextToken?: string): Promise<CatalogValues>
  • Parameters

    • catalogId: string

      Unique identifier of the catalog

    • version: string

      Version for interaction model.

    • Optional maxResults: number

      Sets the maximum number of results returned in the response body. If you want to retrieve fewer than upper limit of 50 results, you can add this parameter to your request. maxResults should not exceed the upper limit. The response might contain fewer results than maxResults, but it will never contain more. If there are additional results that satisfy the search criteria, but these results were not returned, the response contains isTruncated = true.

    • Optional nextToken: string

      When response to this API call is truncated (that is, isTruncated response element value is true), the response also includes the nextToken element. The value of nextToken can be used in the next request as the continuation-token to list the next set of objects. The continuation token is an opaque value that Skill Management API understands. Token has expiry of 24 hours.

    Returns Promise<CatalogValues>

getInteractionModelCatalogVersionV1

  • getInteractionModelCatalogVersionV1(catalogId: string, version: string): Promise<CatalogVersionData>

getInteractionModelMetadataV1

  • getInteractionModelMetadataV1(skillId: string, stageV2: string, locale: string): Promise<void>
  • Parameters

    • skillId: string

      The skill ID.

    • stageV2: string

      Stages of a skill including the new certified stage. * `development` - skills which are currently in development corresponds to this stage. * `certified` - skills which have completed certification and ready for publishing corresponds to this stage. * `live` - skills which are currently live corresponds to this stage.

    • locale: string

      The locale for the model requested e.g. en-GB, en-US, de-DE.

    Returns Promise<void>

getInteractionModelV1

  • getInteractionModelV1(skillId: string, stageV2: string, locale: string): Promise<InteractionModelData>
  • Parameters

    • skillId: string

      The skill ID.

    • stageV2: string

      Stages of a skill including the new certified stage. * `development` - skills which are currently in development corresponds to this stage. * `certified` - skills which have completed certification and ready for publishing corresponds to this stage. * `live` - skills which are currently live corresponds to this stage.

    • locale: string

      The locale for the model requested e.g. en-GB, en-US, de-DE.

    Returns Promise<InteractionModelData>

getInteractionModelVersionV1

  • getInteractionModelVersionV1(skillId: string, stageV2: string, locale: string, version: string): Promise<InteractionModelData>
  • Parameters

    • skillId: string

      The skill ID.

    • stageV2: string

      Stages of a skill including the new certified stage. * `development` - skills which are currently in development corresponds to this stage. * `certified` - skills which have completed certification and ready for publishing corresponds to this stage. * `live` - skills which are currently live corresponds to this stage.

    • locale: string

      The locale for the model requested e.g. en-GB, en-US, de-DE.

    • version: string

      Version for interaction model.

    Returns Promise<InteractionModelData>

getIspAssociatedSkillsV1

  • getIspAssociatedSkillsV1(productId: string, stage: string, nextToken?: string, maxResults?: number): Promise<AssociatedSkillResponse>
  • Parameters

    • productId: string

      The in-skill product ID.

    • stage: string

      Stage for skill.

    • Optional nextToken: string

      When response to this API call is truncated (that is, isTruncated response element value is true), the response also includes the nextToken element. The value of nextToken can be used in the next request as the continuation-token to list the next set of objects. The continuation token is an opaque value that Skill Management API understands. Token has expiry of 24 hours.

    • Optional maxResults: number

      Sets the maximum number of results returned in the response body. If you want to retrieve fewer than upper limit of 50 results, you can add this parameter to your request. maxResults should not exceed the upper limit. The response might contain fewer results than maxResults, but it will never contain more. If there are additional results that satisfy the search criteria, but these results were not returned, the response contains isTruncated = true.

    Returns Promise<AssociatedSkillResponse>

getIspDefinitionV1

getIspListForSkillIdV1

  • getIspListForSkillIdV1(skillId: string, stage: string, nextToken?: string, maxResults?: number): Promise<ListInSkillProductResponse>
  • Parameters

    • skillId: string

      The skill ID.

    • stage: string

      Stage for skill.

    • Optional nextToken: string

      When response to this API call is truncated (that is, isTruncated response element value is true), the response also includes the nextToken element. The value of nextToken can be used in the next request as the continuation-token to list the next set of objects. The continuation token is an opaque value that Skill Management API understands. Token has expiry of 24 hours.

    • Optional maxResults: number

      Sets the maximum number of results returned in the response body. If you want to retrieve fewer than upper limit of 50 results, you can add this parameter to your request. maxResults should not exceed the upper limit. The response might contain fewer results than maxResults, but it will never contain more. If there are additional results that satisfy the search criteria, but these results were not returned, the response contains isTruncated = true.

    Returns Promise<ListInSkillProductResponse>

getIspListForVendorV1

  • getIspListForVendorV1(vendorId: string, nextToken?: string, maxResults?: number, productId?: Array<string>, stage?: string, type?: string, referenceName?: string, status?: string, isAssociatedWithSkill?: string): Promise<ListInSkillProductResponse>
  • Parameters

    • vendorId: string

      The vendor ID.

    • Optional nextToken: string

      When response to this API call is truncated (that is, isTruncated response element value is true), the response also includes the nextToken element. The value of nextToken can be used in the next request as the continuation-token to list the next set of objects. The continuation token is an opaque value that Skill Management API understands. Token has expiry of 24 hours.

    • Optional maxResults: number

      Sets the maximum number of results returned in the response body. If you want to retrieve fewer than upper limit of 50 results, you can add this parameter to your request. maxResults should not exceed the upper limit. The response might contain fewer results than maxResults, but it will never contain more. If there are additional results that satisfy the search criteria, but these results were not returned, the response contains isTruncated = true.

    • Optional productId: Array<string>

      The list of in-skill product IDs that you wish to get the summary for. A maximum of 50 in-skill product IDs can be specified in a single listInSkillProducts call. Please note that this parameter must not be used with 'nextToken' and/or 'maxResults' parameter.

    • Optional stage: string

      Filter in-skill products by specified stage.

    • Optional type: string

      Type of in-skill product to filter on.

    • Optional referenceName: string

      Filter in-skill products by reference name.

    • Optional status: string

      Status of in-skill product.

    • Optional isAssociatedWithSkill: string

      Filter in-skill products by whether or not they are associated to a skill.

    Returns Promise<ListInSkillProductResponse>

getIspSummaryV1

getListOfTestersV1

  • getListOfTestersV1(skillId: string, nextToken?: string, maxResults?: number): Promise<ListTestersResponse>
  • Parameters

    • skillId: string

      The skill ID.

    • Optional nextToken: string

      When response to this API call is truncated (that is, isTruncated response element value is true), the response also includes the nextToken element. The value of nextToken can be used in the next request as the continuation-token to list the next set of objects. The continuation token is an opaque value that Skill Management API understands. Token has expiry of 24 hours.

    • Optional maxResults: number

      Sets the maximum number of results returned in the response body. If you want to retrieve fewer than upper limit of 50 results, you can add this parameter to your request. maxResults should not exceed the upper limit. The response might contain fewer results than maxResults, but it will never contain more. If there are additional results that satisfy the search criteria, but these results were not returned, the response contains isTruncated = true.

    Returns Promise<ListTestersResponse>

getSSLCertificatesV1

getSkillEnablementStatusV1

  • getSkillEnablementStatusV1(skillId: string, stage: string): Promise<void>

getSkillManifestV1

  • Parameters

    • skillId: string

      The skill ID.

    • stageV2: string

      Stages of a skill including the new certified stage. * `development` - skills which are currently in development corresponds to this stage. * `certified` - skills which have completed certification and ready for publishing corresponds to this stage. * `live` - skills which are currently live corresponds to this stage.

    Returns Promise<SkillManifestEnvelope>

getSkillMetricsV1

  • getSkillMetricsV1(skillId: string, startTime: string, endTime: string, period: string, metric: string, stage: string, skillType: string, intent?: string, locale?: string, maxResults?: number, nextToken?: string): Promise<GetMetricDataResponse>
  • Parameters

    • skillId: string

      The skill ID.

    • startTime: string

      The start time of query.

    • endTime: string

      The end time of query (The maximum time duration is 1 week)

    • period: string

      The aggregation period to use when retrieving the metric, follows ISO_8601#Durations format.

    • metric: string

      A distinct set of logic which predictably returns a set of data.

    • stage: string

      The stage of the skill (live, development).

    • skillType: string

      The type of the skill (custom, smartHome and flashBriefing).

    • Optional intent: string

      The intent of the skill.

    • Optional locale: string

      The locale for the skill. e.g. en-GB, en-US, de-DE and etc.

    • Optional maxResults: number

      Sets the maximum number of results returned in the response body. If you want to retrieve fewer than upper limit of 50 results, you can add this parameter to your request. maxResults should not exceed the upper limit. The response might contain fewer results than maxResults, but it will never contain more. If there are additional results that satisfy the search criteria, but these results were not returned, the response contains isTruncated = true.

    • Optional nextToken: string

      When response to this API call is truncated (that is, isTruncated response element value is true), the response also includes the nextToken element. The value of nextToken can be used in the next request as the continuation-token to list the next set of objects. The continuation token is an opaque value that Skill Management API understands. Token has expiry of 24 hours.

    Returns Promise<GetMetricDataResponse>

getSkillSimulationV1

getSkillStatusV1

  • getSkillStatusV1(skillId: string, resource?: string): Promise<SkillStatus>
  • Parameters

    • skillId: string

      The skill ID.

    • Optional resource: string

      Resource name for which status information is desired. It is an optional, filtering parameter and can be used more than once, to retrieve status for all the desired (sub)resources only, in single API call. If this parameter is not specified, status for all the resources/sub-resources will be returned.

    Returns Promise<SkillStatus>

getSkillValidationsV1

  • getSkillValidationsV1(skillId: string, validationId: string, stage: string, acceptLanguage?: string): Promise<ValidationsApiResponse>
  • Parameters

    • skillId: string

      The skill ID.

    • validationId: string

      Id of the validation. Reserved word identifier of mostRecent can be used to get the most recent validation for the skill and stage. Note that the behavior of the API in this case would be the same as when the actual validation id of the most recent validation is used in the request.

    • stage: string

      Stage for skill.

    • Optional acceptLanguage: string

      User's locale/language in context.

    Returns Promise<ValidationsApiResponse>

getStatusOfExportRequestV1

  • getStatusOfExportRequestV1(exportId: string): Promise<ExportResponse>

getUtteranceDataV1

  • Parameters

    • skillId: string

      The skill ID.

    • Optional nextToken: string

      When response to this API call is truncated (that is, isTruncated response element value is true), the response also includes the nextToken element. The value of nextToken can be used in the next request as the continuation-token to list the next set of objects. The continuation token is an opaque value that Skill Management API understands. Token has expiry of 24 hours.

    • Optional maxResults: number

      Sets the maximum number of results returned in the response body. If you want to retrieve fewer than upper limit of 50 results, you can add this parameter to your request. maxResults should not exceed the upper limit. The response might contain fewer results than maxResults, but it will never contain more. If there are additional results that satisfy the search criteria, but these results were not returned, the response contains isTruncated = true.

    • Optional sortDirection: string

      Sets the sorting direction of the result items. When set to 'asc' these items are returned in ascending order of sortField value and when set to 'desc' these items are returned in descending order of sortField value.

    • Optional sortField: string

      Sets the field on which the sorting would be applied.

    • Optional stage: Array<StageType>

      A filter used to retrieve items where the stage is equal to the given value.

    • Optional locale: Array<LocaleInQuery>
    • Optional dialogActName: Array<DialogActName>

      A filter used to retrieve items where the dialogAct name is equal to the given value. * `Dialog.ElicitSlot`: Alexa asked the user for the value of a specific slot. (https://developer.amazon.com/docs/custom-skills/dialog-interface-reference.html#elicitslot) * `Dialog.ConfirmSlot`: Alexa confirmed the value of a specific slot before continuing with the dialog. (https://developer.amazon.com/docs/custom-skills/dialog-interface-reference.html#confirmslot) * `Dialog.ConfirmIntent`: Alexa confirmed the all the information the user has provided for the intent before the skill took action. (https://developer.amazon.com/docs/custom-skills/dialog-interface-reference.html#confirmintent)

    • Optional intentConfidenceBin: Array<IntentConfidenceBin>
    • Optional intentName: Array<string>

      A filter used to retrieve items where the intent name is equal to the given value.

    • Optional intentSlotsName: Array<string>

      A filter used to retrieve items where the one of the slot names is equal to the given value.

    • Optional interactionType: Array<InteractionType>
    • Optional publicationStatus: Array<PublicationStatus>
    • Optional utteranceText: Array<string>

      A filter used to retrieve items where the utterance text contains the given phrase. Each filter value can be at-least 1 character and at-most 100 characters long.

    Returns Promise<IntentRequests>

getVendorListV1

  • getVendorListV1(): Promise<Vendors>

importSkillPackageV1

  • Parameters

    • updateSkillWithPackageRequest: UpdateSkillWithPackageRequest

      Defines the request body for updatePackage API.

    • skillId: string

      The skill ID.

    • Optional ifMatch: string

      Request header that specified an entity tag. The server will update the resource only if the eTag matches with the resource's current eTag.

    Returns Promise<void>

Protected invoke

  • invoke(method: string, endpoint: string, path: string, pathParams: Map<string, string>, queryParams: Array<object>, headerParams: Array<object>, bodyParam: any, errors: Map<number, string>, nonJsonBody?: boolean): Promise<any>
  • Invocation wrapper to implement service operations in generated classes

    Parameters

    • method: string

      HTTP method, such as 'POST', 'GET', 'DELETE', etc.

    • endpoint: string

      base API url

    • path: string

      the path pattern with possible placeholders for path parameters in form {paramName}

    • pathParams: Map<string, string>

      path parameters collection

    • queryParams: Array<object>

      query parameters collection

    • headerParams: Array<object>

      headers collection

    • bodyParam: any

      if body parameter is present it is provided here, otherwise null or undefined

    • errors: Map<number, string>

      maps recognized status codes to messages

    • Optional nonJsonBody: boolean

      if the body is in JSON format

    Returns Promise<any>

listInteractionModelCatalogsV1

  • listInteractionModelCatalogsV1(vendorId: string, maxResults?: number, nextToken?: string, sortDirection?: string): Promise<ListCatalogResponse>
  • Parameters

    • vendorId: string

      The vendor ID.

    • Optional maxResults: number

      Sets the maximum number of results returned in the response body. If you want to retrieve fewer than upper limit of 50 results, you can add this parameter to your request. maxResults should not exceed the upper limit. The response might contain fewer results than maxResults, but it will never contain more. If there are additional results that satisfy the search criteria, but these results were not returned, the response contains isTruncated = true.

    • Optional nextToken: string

      When response to this API call is truncated (that is, isTruncated response element value is true), the response also includes the nextToken element. The value of nextToken can be used in the next request as the continuation-token to list the next set of objects. The continuation token is an opaque value that Skill Management API understands. Token has expiry of 24 hours.

    • Optional sortDirection: string

      Sets the sorting direction of the result items. When set to 'asc' these items are returned in ascending order of sortField value and when set to 'desc' these items are returned in descending order of sortField value.

    Returns Promise<ListCatalogResponse>

listInteractionModelVersionsV1

  • listInteractionModelVersionsV1(skillId: string, stageV2: string, locale: string, nextToken?: string, maxResults?: number, sortDirection?: string, sortField?: string): Promise<ListResponse>
  • Parameters

    • skillId: string

      The skill ID.

    • stageV2: string

      Stages of a skill including the new certified stage. * `development` - skills which are currently in development corresponds to this stage. * `certified` - skills which have completed certification and ready for publishing corresponds to this stage. * `live` - skills which are currently live corresponds to this stage.

    • locale: string

      The locale for the model requested e.g. en-GB, en-US, de-DE.

    • Optional nextToken: string

      When response to this API call is truncated (that is, isTruncated response element value is true), the response also includes the nextToken element. The value of nextToken can be used in the next request as the continuation-token to list the next set of objects. The continuation token is an opaque value that Skill Management API understands. Token has expiry of 24 hours.

    • Optional maxResults: number

      Sets the maximum number of results returned in the response body. If you want to retrieve fewer than upper limit of 50 results, you can add this parameter to your request. maxResults should not exceed the upper limit. The response might contain fewer results than maxResults, but it will never contain more. If there are additional results that satisfy the search criteria, but these results were not returned, the response contains isTruncated = true.

    • Optional sortDirection: string

      Sets the sorting direction of the result items. When set to 'asc' these items are returned in ascending order of sortField value and when set to 'desc' these items are returned in descending order of sortField value.

    • Optional sortField: string

      Sets the field on which the sorting would be applied.

    Returns Promise<ListResponse>

listPrivateDistributionAccountsV1

  • Parameters

    • skillId: string

      The skill ID.

    • stage: string

      Stage for skill.

    • Optional nextToken: string

      When response to this API call is truncated (that is, isTruncated response element value is true), the response also includes the nextToken element. The value of nextToken can be used in the next request as the continuation-token to list the next set of objects. The continuation token is an opaque value that Skill Management API understands. Token has expiry of 24 hours.

    • Optional maxResults: number

      Sets the maximum number of results returned in the response body. If you want to retrieve fewer than upper limit of 50 results, you can add this parameter to your request. maxResults should not exceed the upper limit. The response might contain fewer results than maxResults, but it will never contain more. If there are additional results that satisfy the search criteria, but these results were not returned, the response contains isTruncated = true.

    Returns Promise<ListPrivateDistributionAccountsResponse>

listSkillsForVendorV1

  • listSkillsForVendorV1(vendorId: string, nextToken?: string, maxResults?: number, skillId?: Array<string>): Promise<ListSkillResponse>
  • Parameters

    • vendorId: string

      The vendor ID.

    • Optional nextToken: string

      When response to this API call is truncated (that is, isTruncated response element value is true), the response also includes the nextToken element. The value of nextToken can be used in the next request as the continuation-token to list the next set of objects. The continuation token is an opaque value that Skill Management API understands. Token has expiry of 24 hours.

    • Optional maxResults: number

      Sets the maximum number of results returned in the response body. If you want to retrieve fewer than upper limit of 50 results, you can add this parameter to your request. maxResults should not exceed the upper limit. The response might contain fewer results than maxResults, but it will never contain more. If there are additional results that satisfy the search criteria, but these results were not returned, the response contains isTruncated = true.

    • Optional skillId: Array<string>

      the list of skillIds that you wish to get the summary for. A maximum of 10 skillIds can be specified to get the skill summary in single listSkills call. Please note that this parameter must not be used with 'nextToken' or/and 'maxResults' parameter.

    Returns Promise<ListSkillResponse>

profileNluV1

removeTestersFromBetaTestV1

  • removeTestersFromBetaTestV1(skillId: string, testersRequest: TestersList): Promise<void>

requestFeedbackFromTestersV1

  • requestFeedbackFromTestersV1(skillId: string, testersRequest: TestersList): Promise<void>

resetEntitlementForProductV1

  • resetEntitlementForProductV1(productId: string, stage: string): Promise<void>
  • Parameters

    • productId: string

      The in-skill product ID.

    • stage: string

      Stage for skill.

    Returns Promise<void>

sendReminderToTestersV1

  • sendReminderToTestersV1(skillId: string, testersRequest: TestersList): Promise<void>

setInteractionModelV1

  • setInteractionModelV1(skillId: string, stageV2: string, locale: string, interactionModel: InteractionModelData, ifMatch?: string): Promise<void>
  • Parameters

    • skillId: string

      The skill ID.

    • stageV2: string

      Stages of a skill including the new certified stage. * `development` - skills which are currently in development corresponds to this stage. * `certified` - skills which have completed certification and ready for publishing corresponds to this stage. * `live` - skills which are currently live corresponds to this stage.

    • locale: string

      The locale for the model requested e.g. en-GB, en-US, de-DE.

    • interactionModel: InteractionModelData
    • Optional ifMatch: string

      Request header that specified an entity tag. The server will update the resource only if the eTag matches with the resource's current eTag.

    Returns Promise<void>

setPrivateDistributionAccountIdV1

  • setPrivateDistributionAccountIdV1(skillId: string, stage: string, id: string): Promise<void>
  • Parameters

    • skillId: string

      The skill ID.

    • stage: string

      Stage for skill.

    • id: string

      ARN that a skill can be privately distributed to.

    Returns Promise<void>

setSSLCertificatesV1

setSkillEnablementV1

  • setSkillEnablementV1(skillId: string, stage: string): Promise<void>

simulateSkillV1

startBetaTestV1

  • startBetaTestV1(skillId: string): Promise<void>

submitSkillForCertificationV1

submitSkillValidationV1

updateAccountLinkingInfoV1

  • updateAccountLinkingInfoV1(skillId: string, stageV2: string, accountLinkingRequest: AccountLinkingRequest, ifMatch?: string): Promise<void>
  • Parameters

    • skillId: string

      The skill ID.

    • stageV2: string

      Stages of a skill including the new certified stage. * `development` - skills which are currently in development corresponds to this stage. * `certified` - skills which have completed certification and ready for publishing corresponds to this stage. * `live` - skills which are currently live corresponds to this stage.

    • accountLinkingRequest: AccountLinkingRequest

      The fields required to create accountLinking partner.

    • Optional ifMatch: string

      Request header that specified an entity tag. The server will update the resource only if the eTag matches with the resource's current eTag.

    Returns Promise<void>

updateBetaTestV1

  • updateBetaTestV1(skillId: string, createTestBody?: TestBody): Promise<void>
  • Parameters

    • skillId: string

      The skill ID.

    • Optional createTestBody: TestBody

      JSON object containing the details of a beta test used to create the test.

    Returns Promise<void>

updateInteractionModelCatalogV1

  • updateInteractionModelCatalogV1(catalogId: string, updateRequest: UpdateRequest): Promise<void>

updateInteractionModelCatalogVersionV1

  • updateInteractionModelCatalogVersionV1(catalogId: string, version: string, catalogUpdate?: CatalogUpdate): Promise<void>
  • Parameters

    • catalogId: string

      Unique identifier of the catalog

    • version: string

      Version for interaction model.

    • Optional catalogUpdate: CatalogUpdate

    Returns Promise<void>

updateIspForProductV1

  • updateIspForProductV1(productId: string, stage: string, updateInSkillProductRequest: UpdateInSkillProductRequest, ifMatch?: string): Promise<void>
  • Parameters

    • productId: string

      The in-skill product ID.

    • stage: string

      Stage for skill.

    • updateInSkillProductRequest: UpdateInSkillProductRequest

      defines the request body for updateInSkillProduct API.

    • Optional ifMatch: string

      Request header that specified an entity tag. The server will update the resource only if the eTag matches with the resource's current eTag.

    Returns Promise<void>

updateSkillManifestV1

  • updateSkillManifestV1(skillId: string, stageV2: string, updateSkillRequest: SkillManifestEnvelope, ifMatch?: string): Promise<void>
  • Parameters

    • skillId: string

      The skill ID.

    • stageV2: string

      Stages of a skill including the new certified stage. * `development` - skills which are currently in development corresponds to this stage. * `certified` - skills which have completed certification and ready for publishing corresponds to this stage. * `live` - skills which are currently live corresponds to this stage.

    • updateSkillRequest: SkillManifestEnvelope

      Defines the request body for updateSkill API.

    • Optional ifMatch: string

      Request header that specified an entity tag. The server will update the resource only if the eTag matches with the resource's current eTag.

    Returns Promise<void>

withdrawSkillFromCertificationV1

  • withdrawSkillFromCertificationV1(skillId: string, withdrawRequest: WithdrawRequest): Promise<void>