ASK CLI Command Reference

This reference describes all the commands available through Alexa Skills Kit Command Line Interface (ASK CLI). For an overview of the ASK CLI, see ASK CLI Overview. To get started quickly with the ASK CLI, see the ASK CLI Quick Start.

Overview

Valid syntax for the ASK CLI commands include the following:

$ ask [options]
$ ask [command] [options]
$ ask [command] [subcommand] [options]

ASK CLI has two different kinds of commands for manipulating skills associated with your developer account.

  • High-level commands simplify working with your Alexa skill projects by abstracting details and performing multiple actions. Start with these commands if you are new to skill development, or when you don't need fine control over API calls. Some examples of high-level commands are new, deploy, and configure.

  • Low-level commands are to control individual parts of your Alexa Skill. These commands are wrappers of the Alexa Skill Management API (SMAPI) operations, so they give you control over each API call. These commands are useful when you want to change portions of a skill that you have already added to your account. The subcommands of the smapi command are low-level commands.

To get the version number of the ASK CLI that is installed on your computer, use the --version option as follows.

$ ask [--version | -V]

Common parameters

The ASK CLI commands have common parameters, such as --help and --debug. The common parameters have the same behavior in each command that includes them. The common parameters are documented in this section.

Debug mode for commands

Most ASK CLI commands can be run in debug mode, by appending --debug to the command. The same results appear as when –debug is not specified, except that an additional debug message is displayed (sent to stderr) after the command finishes executing. This debug message consists of these fields: timestamp, api-name, request-id, method, url, response-code, request-header, request-body, response-header, and response-body.

To save these results, run the command and pipe the output to a local text file, as follows:

$ ask [command] <other parameters> --debug 2> debug.txt

Help mode for commands

Each ASK CLI command provides help about what it does and it's options by appending --help to the command. When you run the command in help mode, the command itself does not run.

 $ ask [command] --help

Skill stage

Many ASK CLI commands refer to the stage of a skill. The stage value can be either development or live. If development, the skill is not published. If live, the skill is published, but it might be either live in production, hidden from users, or removed from the skill store. For more details, see Publication status.

configure command

Initialize ASK CLI with your Amazon developer account credentials. Run this command to initialize the tool with your developer account credentials before performing skill operations. This command uses port 9090 and if this port is already in use, you get an error.

The ask configure command helps you configure the credentials that ASK CLI uses to authenticate you to Amazon developer services and Amazon Web Services (AWS). This interactive command opens a web browser so you can sign in to your Amazon Developer account, and prompts you to enter information or answer questions about the credentials you want to use.

You can use ask configure to view and configure profiles, which contain credentials for different Amazon or AWS accounts. With profiles, you can use ASK CLI to manage skills that belong to different account by using the -p or --profile option with commands like ask new, ask deploy, and others.

For more details about how ASK CLI stores and manages your Amazon developer and AWS credentials, see Manage Credentials with ASK CLI.

Syntax

ask configure [--profile | -p <profile>]
              [--no-browser]
              [--debug]
              [--help | -h]

Options

--profile, -p
Optional. Specifies a profile to use for the credentials that you are configuring. If you omit this option, ASK CLI prompts you to choose the profile from a list or create a new one.
--no-browser
Optional. Use this option when you run the ask init command on a computer that does not have a web browser. ASK CLI displays a URL that you can use to sign in with your Amazon developer account by using a web browser on a different computer. After you sign in, the browser displays a code that you can enter at the command line to complete the configuration of your credentials.

deploy command

Deploy a skill to your developer account including your skill manifest, voice interaction model, and AWS Lambda functions. For an overview and usage examples, see deploy a skill project to the development stage in the ASK CLI overview.

Syntax

ask deploy [--profile | -p <profile>]
           [--ignore-hash]
           [--debug]
           [--help | -h]

Options

--profile, -p
Optional. The profile under which ASK CLI deploys the skill resources. When you don't include this option, the ASK CLI uses the default profile.
--ignore-hash
Optional. Forces the skill to deploy again even if it has not changed.

dialog command

Opens a dialog mode in which developers can simulate a multi-turn conversation with Alexa. Each dialog uses simulate-skill, which is an asynchronous operation that continues to poll the simulation result until it's available and then shows the Alexa text responses. The interaction mode does not start if the parameters are invalid and does not end unless the user enters the special command '!quit' or Ctrl+C.

There are two special commands that the user can enter in the dialog: .quit, which terminates the interaction mode, and .record, which prompts the user to input a file name so the dialog input can be recorded, along with the current interaction mode skillId, locale, input type, and all input texts. The .record command only records the user inputs in the latest session.

If you run this command with the --replay option, specify the recording file that contains the skill information and user input. The replay option replays the user inputs, and Alexa responds as if in a conversation. See Replay file format. Do not specify the skillId in the command line.

If you run this command without the --replay option, then you enter the dialog directly, as if speaking to Alexa for the specified skill. You must either specify the skillId or run the command from the skill project root directory, and you must specify the locale.

  • If the skill session has not ended, you continue to see the User > prompt on the command line, and you can continue to input text as if conversing with Alexa.

  • If the skill session has ended, you see the line ---Skill Session Ended.--- in the command-line window, but the interaction mode remains open. You still see the User > prompt, and you can continue to input text.

Syntax

ask dialog [--skill-id | -s <skill-id>]
           [--locale | -l <locale>]
           [--stage | -g <stage>]
           [--replay | -r <file-path>]

Options

--skill-id, -s
Optional. This should be in the format amzn1.ask.skill.12345678-1234-1234-123456789123. If you don't specify the skill id or the --replay option, you must run this command from the root directory where the skill has already been created or cloned. You can't specify both the --skill-id and the --replay option.
--locale, -l
Optional if ASK_DEFAULT_DEVICE_LOCALE environment variable is set, otherwise, required if the --replay option is not used. Locale for the skill to be simulated. Valid values are en-US, en-GB, en-CA, en-AU, en-IN, de-DE, or ja-JP. If not specified and if the --replay option is not specified, you are prompted to enter the locale. You cannot specify locale if you use the --replay option.
--stage, -g
Optional. Indicates stage of the skill. Use development or live as values. Defaults to development.
--replay, -r
Optional. Specify a replay file to simulate a conversation with your skill. This file contains text utterances from the start of the session or your last recording point. You can use the recorded files to automate the execution of frequently used tests. This replay file may contain the skill-id and locale. If the file does not contain the skill-id, this command must be run from the skill project root directory where the skill to be tested has already been created or cloned.
--profile, -p
Optional. To use a profile other than the default, include the profile name.
--debug
Optional. Appends a debug message to the standard error.

Replay file format

The replay file takes the following format.

{
    "skillId":"amazon.skill.123..",
    "locale": "en-US",
    "type": "text",
    "userInput": ["book flight", "Vancouver"]
}
Attribute Description
skillId Specifies the skill to be simulated.
locale Specifies the locale that you want to test for the skill, such as "en-US".
type "text"
userInput An array of utterances that the user would say to the skill.

You can create a replay file manually with the appropriate information, following the format shown, and save the file for future use.

You can also create a replay file as follows:

  • Type the command ask dialog.
  • Enter .record at the prompt.
  • Enter the requested information as you are prompted for it. This includes the filename to save the file.

In either case, specify the desired replay file when you use the --replay option.

init command

The ask init command helps you set up a new or an existing Alexa skill project. The command helps you create an ask-resources.json file to help deploy the skill. It sets the most common attributes and suggests sensible defaults for using AWS Lambda as your endpoint.

Syntax

ask init [--hosted-skill-id <hosted-skill-id>]
         [--profile | -p <profile>]
         [--debug]

Options

--hosted-skill-id
Optional. Specifying the Skill ID of an Alexa-hosted skill starts a workflow to clone the skill to the current directory.
--profile, -p
Optional. The profile under which ASK CLI creates the skill. If not specified, ASK CLI uses the default profile.

new command

The ask new command creates a new skill project by copying from a skill template. It creates a new Alexa skill project on your computer, with the necessary folders and files to deploy it with minimal changes. For an overview and usage examples, see create a new skill project in the ASK CLI overview.

Syntax

ask new [--template-url <url>]
        [--profile | -p <profile>]
        [--debug]
        [--help]

Options

--template-url
Optional: The URL of a Git repository that contains a skill template.
--profile, -p
Optional. The profile under which ASK CLI creates the skill. If not specified, ASK CLI uses the default profile.

util command

The util command provides utility tools to manage Alexa skill development.

generate-lwa-tokens

Generates Login with Amazon tokens from an LWA client. For more information, see Login with Amazon.

Syntax

ask util generate-lwa-tokens [--profile | -p <profile>]
                             [--client-id]
                             [--client-confirmation]
                             [--scopes]
                             [--no-browser]
                             [--debug]

Options

--profile, -p
Optional. The profile for the request. If not specified, ASK CLI uses the default profile.
--client-id
Optional. The client-id when registering LWA application.
--client-confirmation
Optional. The client-secret when registering LWA application.
--scopes
Optional. A list of scopes you are requesting access to, delimited by spaces.
--no-browser
Optional. A URL appears that you can use to sign in with your Amazon developer account from anywhere.

git-credentials-helper

Returns the git credentials for an Alexa-hosted skill repository.

Syntax

ask util git-credentials-helper [--profile | -p <profile>]
                                [--debug]
                                [--help]

Options

--profile, -p
Optional. The profile under which ASK CLI deploys the skill resources. If not specified, ASK CLI uses the default profile.

upgrade-project

Upgrades ASK CLI v1.x skill projects to the ASK CLI v2 project format.

Syntax

ask util upgrade-project [--profile | -p <profile>]
                         [--debug]
                         [--help]

Options

--profile, -p
Optional. The profile under which ASK CLI deploys the skill resources. If not specified, ASK CLI uses the default profile.

smapi command

The smapi command provides subcommands that have a one-to-one relationship with the underlying API operations in the Alexa Skill Management API (SMAPI). The commands allow detailed control of API inputs and expose raw outputs. There are subcommands for creating and updating the skill, the voice interaction model, and account linking information as well as starting the skill certification process.

Use the smapi command and subcommands to manage details of Alexa skills associated with your developer account. Use these commands if you want to create or update portions of an Alexa skill, and for beta testing your skill.

Syntax

$ ask smapi <subcommand>

add-testers-to-beta-test

Add testers to a beta test for the given Alexa skill. The system sends invitation email to each tester and add entitlement on the acceptance.

Syntax

$ ask smapi add-testers-to-beta-test [--skill-id | -s <skill-id>]
                                     [--testers-emails <testers-emails>]
                                     [--profile | -p <profile>]
                                     [--debug]

Options

--skill-id, -s
Required. The skill ID.
--testers-emails
Required. List of email address of beta testers. [MULTIPLE]: Values can be separated by comma.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

associate-isp-with-skill

Associate an in-skill product with a skill.

Syntax

$ ask smapi associate-isp-with-skill [--product-id <product-id>]
                                     [--skill-id | -s <skill-id>]
                                     [--profile | -p <profile>]
                                     [--debug]

Options

--product-id
Required. The in-skill product ID.
--skill-id, -s
Required. The skill ID.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

clone-locale

Creates a new clone-locale workflow for a skill. For more details on skill cloning, see Clone a Skill Locale or the associated SMAPI API references.

Syntax:

ask smapi clone-locale [-s,--skill-id <skill-id>]
                       [-g,--stage <stage>]
                       [--source-locale <source-locale>]
                       [--target-locales <target-locales>]
                       [--overwrite-mode <overwrite-mode>]
                       [-p, --profile <profile>]
                       [--debug]
                       [-h, --help]

Options:

-s, --skill-id
Required. The skill ID of the skill you are cloning.
-g, --stage
Required. The publishing stage of the skill you are cloning.
Accepted values: development
--sourceLocale
Required. The locale of the skill assets you're cloning, for example, en-US. You can only set a single sourceLocale per clone.
--targetLocales
Required. A list of locales where sourceLocale assets copy to, for example, en-CA. You can include multiple locales in a single command by using a comma separated list.
--overwrite-mode
Optional. Build to an existing target and overwrite the current locale.
Possible Values: OVERWRITE,DO_NOT_OVERWRITE
Default value: DO_NOT_OVERWRITE
-p, --profile
Optional. The profile under which ASK CLI deploys the skill resources. If not provided, ASK CLI uses the default profile.
--debug
Optional. When you include this option, ASK CLI displays debug messages in the output of the command.

create-beta-test

Create a beta test for a given Alexa skill.

Syntax

$ ask smapi create-beta-test [--skill-id | -s <skill-id>]
                             [--feedback-email <feedback-email>]
                             [--profile | -p <profile>]
                             [--debug]

Options

--skill-id, -s
Required. The skill ID.
--feedback-email
Optional. Email address for providing feedback.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

create-catalog-upload

Create a new upload for a catalog and returns location to track the upload process.

Syntax

$ ask smapi create-catalog-upload [--catalog-id | -c <catalog-id>]
                                  [--catalog-upload-request-body <catalog-upload-request-body>]
                                  [--profile | -p <profile>]
                                  [--debug]

Options

--catalog-id, -c
Required. Unique identifier of the catalog.
--catalog-upload-request-body
Required. Request body for create content upload [JSON].
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

create-export-request-for-skill

Create a new export for a skill with given skillId and stage.

Syntax

$ ask smapi create-export-request-for-skill [--skill-id | -s <skill-id>]
                                            [--stage | -g <stage>]
                                            [--profile | -p <profile>]
                                            [--debug]

Options

--skill-id, -s
Required. The skill ID.
--stage, -g
Required. Stage for skill.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

create-interaction-model-catalog

Create a new catalog. For more information, see Reference-Based Catalog Management.

Syntax

$ ask smapi create-interaction-model-catalog [--catalog-name <catalog-name>]
                                             [--catalog-description <catalog-description>]
                                             [--vendor-id <vendor-id>]
                                             [--profile | -p <profile>]
                                             [--debug]

Options

--catalog-name
Optional. Name of the catalog.
--catalog-description
Optional. Description string about the catalog.
--vendor-id
Required. The vendorId that the catalog should belong to.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

create-interaction-model-catalog-version

Create a new version of catalog for the given catalogId. For more information, see Reference-Based Catalog Management.

Syntax

$ ask smapi create-interaction-model-catalog-version [--catalog-id | -c <catalog-id>]
                                                     [--source-type <source-type>]
                                                     [--source-url <source-url>]
                                                     [--description <description>]
                                                     [--profile | -p <profile>]
                                                     [--debug]

Options

--catalog-id, -c
Required. Unique identifier of the catalog.
--source-type
Optional. Type of catalog.
--source-url
Optional. Url to the catalog reference.
--description
Required. Description string for specific catalog version.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

create-interaction-model-slot-type

Create a new version of slot type within the given slotTypeId.

Syntax

$ ask smapi create-interaction-model-slot-type [--slot-type <slot-type>]
                                               [--profile | -p <profile>]
                                               [--debug]

Options

--slot-type
Required. [JSON].
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

create-interaction-model-slot-type-version

Create a new version of slot type entity for the given slotTypeId.

Syntax

$ ask smapi create-interaction-model-slot-type-version [--slot-type-id <slot-type-id>]
                                                       [--slot-type <slot-type>]
                                                       [--profile | -p <profile>]
                                                       [--debug]

Options

--slot-type-id
Required. The identifier for a slot type.
--slot-type
Required. [JSON].
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

create-isp-for-vendor

Create a new in-skill product for given vendorId.

Syntax

$ ask smapi create-isp-for-vendor [--create-in-skill-product-request <create-in-skill-product-request>]
                                  [--profile | -p <profile>]
                                  [--debug]

Options

--create-in-skill-product-request
Required. defines the request body for createInSkillProduct API. [JSON].
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

create-skill-for-vendor

Create a new skill for given vendorId.

Syntax

$ ask smapi create-skill-for-vendor [--manifest <manifest>]
                                    [--profile | -p <profile>]
                                    [--debug]

Options

--manifest
Required. Defines the request body for createSkill API. [JSON].
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

create-skill-package

Create a new import for a skill.

Syntax

$ ask smapi create-skill-package [--vendor-id <vendor-id>]
                                 [--location <location>]
                                 [--profile | -p <profile>]
                                 [--debug]

Options

--vendor-id
Required. ID of the vendor owning the skill.
--location
Required. Location of the package.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

create-upload-url

Create a new uploadUrl.

Syntax

$ ask smapi create-upload-url [--profile | -p <profile>]
                              [--debug]

Options

--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

delete-account-linking-info

Delete AccountLinking information of a skill for the given stage.

Syntax

$ ask smapi delete-account-linking-info [--skill-id | -s <skill-id>]
                                        [--stage | -g <stage>]
                                        [--profile | -p <profile>]
                                        [--debug]

Options

--skill-id, -s
Required. The skill ID.
--stage, -g
Required. 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.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

delete-interaction-model-catalog

Delete a catalog. For more information, see Reference-Based Catalog Management.

Syntax

$ ask smapi delete-interaction-model-catalog [--catalog-id | -c <catalog-id>]
                                             [--profile | -p <profile>]
                                             [--debug]

Options

--catalog-id, -c
Required. Unique identifier of the catalog.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

delete-interaction-model-catalog-version

Delete a version of a catalog. For more information, see Reference-Based Catalog Management.

Syntax

$ ask smapi delete-interaction-model-catalog-version [--catalog-id | -c <catalog-id>]
                                                     [--version <version>]
                                                     [--profile | -p <profile>]
                                                     [--debug]

Options

--catalog-id, -c
Required. Unique identifier of the catalog.
--version
Required. The version of the voice interaction model.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

delete-interaction-model-slot-type

Delete the slot type.

Syntax

$ ask smapi delete-interaction-model-slot-type [--slot-type-id <slot-type-id>]
                                               [--profile | -p <profile>]
                                               [--debug]

Options

--slot-type-id
Required. The identifier for a slot type.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

delete-interaction-model-slot-type-version

Delete slot type version.

Syntax

$ ask smapi delete-interaction-model-slot-type-version [--slot-type-id <slot-type-id>]
                                                       [--version <version>]
                                                       [--profile | -p <profile>]
                                                       [--debug]

Options

--slot-type-id
Required. The identifier for a slot type.
--version
Required. The version of the voice interaction model.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

delete-isp-for-product

Deletes the in-skill product for given productId. Only development stage supported. Live in-skill products or in-skill products associated with a skill cannot be deleted by this API.

Syntax

$ ask smapi delete-isp-for-product [--product-id <product-id>]
                                   [--stage | -g <stage>]
                                   [--if-match <if-match>]
                                   [--profile | -p <profile>]
                                   [--debug]

Options

--product-id
Required. The in-skill product ID.
--stage, -g
Required. Stage for skill.
--if-match
Optional. Request header that specified an entity tag. The server updates the resource only if the eTag matches the resource's current eTag.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

delete-private-distribution-account-id

Remove an id from the private distribution accounts.

Syntax

$ ask smapi delete-private-distribution-account-id [--skill-id | -s <skill-id>]
                                                   [--stage | -g <stage>]
                                                   [--id <id>]
                                                   [--profile | -p <profile>]
                                                   [--debug]

Options

--skill-id, -s
Required. The skill ID.
--stage, -g
Required. Stage for skill.
--id
Required. ARN that a skill can be privately distributed to.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

delete-skill

Delete the skill and model for given skillId.

Syntax

$ ask smapi delete-skill [--skill-id | -s <skill-id>]
                         [--profile | -p <profile>]
                         [--debug]

Options

--skill-id, -s
Required. The skill ID.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

delete-skill-enablement

Delete the enablement for given skillId/stage and customerId (retrieved from Auth token).

Syntax

$ ask smapi delete-skill-enablement [--skill-id | -s <skill-id>]
                                    [--stage | -g <stage>]
                                    [--profile | -p <profile>]
                                    [--debug]

Options

--skill-id, -s
Required. The skill ID.
--stage, -g
Required. Stage for skill.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

disassociate-isp-with-skill

Disassociate an in-skill product from a skill.

Syntax

$ ask smapi disassociate-isp-with-skill [--product-id <product-id>]
                                        [--skill-id | -s <skill-id>]
                                        [--profile | -p <profile>]
                                        [--debug]

Options

--product-id
Required. The in-skill product ID.
--skill-id, -s
Required. The skill ID.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

end-beta-test

End a beta test for a given Alexa skill. The system revokes the entitlement of each tester and sends access-end notification email to them.

Syntax

$ ask smapi end-beta-test [--skill-id | -s <skill-id>]
                          [--profile | -p <profile>]
                          [--debug]

Options

--skill-id, -s
Required. The skill ID.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

export-package

Download the skill package to the skill-package folder in the current directory.

Syntax

$ ask smapi export-package [--skill-id | -s <skill-id>]
                           [--stage | -g <stage>]
                           [--profile | -p <profile>]
                           [--debug]

Options

--skill-id, -s
Required. The skill identifier.
--stage, -g
Required. Stage for the skill.
--profile, -p
Optional. The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
Optional. When you include this option, debug messages appear in the output of the command.

generate-catalog-upload-url

Generate presigned urls to upload data.

Syntax

$ ask smapi generate-catalog-upload-url [--catalog-id | -c <catalog-id>]
                                        [--number-of-upload-parts <number-of-upload-parts>]
                                        [--profile | -p <profile>]
                                        [--debug]

Options

--catalog-id, -c
Required. Unique identifier of the catalog.
--number-of-upload-parts
Required. The number of partial files. An equal number of presigned urls are generated to upload each partial file.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

generate-credentials-for-alexa-hosted-skill

Generate credentials to access the repository of an Alexa-hosted skill.

Syntax

$ ask smapi generate-credentials-for-alexa-hosted-skill [--skill-id | -s <skill-id>]
                                                        [--repository-url <repository-url>]
                                                        [--repository-type <repository-type>]
                                                        [--profile | -p <profile>]
                                                        [--debug]

Options

--skill-id, -s
Required. The skill ID.
--repository-url
Optional. The url of the repository for the Alexa-hosted skill.
--repository-type
Optional. The type of repository for the Alexa-hosted skill. [ENUM]: GIT.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

get-account-linking-info

Get AccountLinking information for the skill.

Syntax

$ ask smapi get-account-linking-info [--skill-id | -s <skill-id>]
                                     [--stage | -g <stage>]
                                     [--profile | -p <profile>]
                                     [--debug]

Options

--skill-id, -s
Required. The skill ID.
--stage, -g
Required. 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.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

get-alexa-hosted-skill-metadata

Get Alexa-hosted skill metadata.

Syntax

$ ask smapi get-alexa-hosted-skill-metadata [--skill-id | -s <skill-id>]
                                            [--profile | -p <profile>]
                                            [--debug]

Options

--skill-id, -s
Required. The skill ID.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

get-alexa-hosted-skill-user-permissions

Get the current user permissions about Alexa-hosted skill features.

Syntax

$ ask smapi get-alexa-hosted-skill-user-permissions [--permission <permission>]
                                                    [--profile | -p <profile>]
                                                    [--debug]

Options

--permission
Required. The permission of a hosted skill feature that customer needs to check.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

get-beta-test

Get a beta test for a given Alexa skill.

Syntax

$ ask smapi get-beta-test [--skill-id | -s <skill-id>]
                          [--profile | -p <profile>]
                          [--debug]

Options

--skill-id, -s
Required. The skill ID.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

get-certification-review

Gets a specific certification resource. The response contains the review tracking information for a skill to show how much time the skill is expected to remain under review by Amazon. Once the review is complete, the response also contains the outcome of the review. Old certifications may not be available, however any ongoing certification would always give a response. If the certification is unavailable the result returns a 404 HTTP status code.

Syntax

$ ask smapi get-certification-review [--accept-language <accept-language>]
                                     [--skill-id | -s <skill-id>]
                                     [--certification-id | -c <certification-id>]
                                     [--profile | -p <profile>]
                                     [--debug]

Options

--accept-language
Optional. User's locale/language in context.
--skill-id, -s
Required. The skill ID.
--certification-id, -c
Required. Id of the certification. Reserved word identifier of mostRecent can be used to get the most recent certification for the skill. 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.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

get-certifications-list

Get list of all certifications available for a skill, including information about past certifications and any ongoing certification. The default sort order is descending on skillSubmissionTimestamp for Certifications.

Syntax

$ ask smapi get-certifications-list [--skill-id | -s <skill-id>]
                                    [--next-token <next-token>]
                                    [--max-results <max-results>]
                                    [--profile | -p <profile>]
                                    [--debug]

Options

--skill-id, -s
Required. The skill ID.
--next-token
Optional. 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.
--max-results
Optional. 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 never contains more . If there are additional results that satisfy the search criteria, but these results were not returned, the response contains isTruncated = true.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

get-clone-locale-status

Returns the status of an in progress clone-locale workflow. For more details on skill cloning, see Clone a Skill Locale or the associated SMAPI API references.

Syntax:

ask smapi get-clone-locale-status [-s,--skill-id <skill-id>]
                                  [-g,--stage <stage>]
                                  [--clone-locale-request-id <clone-locale-request-id>]
                                  [-p, --profile <profile>]
                                  [--debug]
                                  [-h, --help]

Options:

-s, --skill-id
Required. The skill ID of the skill are cloning.
-g, --stage
Required. The publishing stage of the skill you are cloning.
Accepted values: development
--clone-locale-request-id
Required. Defines the identifier for a clone-locale workflow. If set to ~latest, the request returns the status of the latest clone locale workflow.
-p, --profile
Optional. The profile under which ASK CLI deploys the skill resources. If not provided, ASK CLI uses the default profile.
--debug
Optional. When you include this option, ASK CLI displays debug messages in the output of the command.

get-content-upload-by-id

Get detailed information about an upload for a specific catalog. Includes the upload's ingestion steps and a url for downloading the file.

Syntax

$ ask smapi get-content-upload-by-id [--catalog-id | -c <catalog-id>]
                                     [--upload-id <upload-id>]
                                     [--profile | -p <profile>]
                                     [--debug]

Options

--catalog-id, -c
Required. Unique identifier of the catalog.
--upload-id
Required. Unique identifier of the upload.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

get-import-status

Get status for given importId.

Syntax

$ ask smapi get-import-status [--import-id <import-id>]
                              [--profile | -p <profile>]
                              [--debug]

Options

--import-id
Required. The Import ID.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

get-interaction-model

Gets the voice interaction model for the skill in the given stage.

Syntax

$ ask smapi get-interaction-model [--skill-id | -s <skill-id>]
                                  [--stage | -g <stage>]
                                  [--locale | -l <locale>]
                                  [--profile | -p <profile>]
                                  [--debug]

Options

--skill-id, -s
Required. The skill ID.
--stage, -g
Required. 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, -l
Required. The locale for the model requested e.g. en-GB, en-US, de-DE.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

get-interaction-model-catalog-definition

Get the catalog definition. For more information, see Reference-Based Catalog Management.

Syntax

$ ask smapi get-interaction-model-catalog-definition [--catalog-id | -c <catalog-id>]
                                                     [--profile | -p <profile>]
                                                     [--debug]

Options

--catalog-id, -c
Required. Unique identifier of the catalog.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

get-interaction-model-catalog-update-status

Gets the status of a previous request to create or update a catalog. For more information, see Reference-Based Catalog Management.

Syntax

$ ask smapi get-interaction-model-catalog-update-status [--catalog-id | -c <catalog-id>]
                                                        [--update-request-id <update-request-id>]
                                                        [--profile | -p <profile>]
                                                        [--debug]

Options

--catalog-id, -c
Required. Unique identifier of the catalog.
--update-request-id
Required. The identifier for the slot type version creation process.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

get-interaction-model-catalog-values

Get values from the given interaction model catalog and version. For more information, see Reference-Based Catalog Management.

Syntax

$ ask smapi get-interaction-model-catalog-values [--catalog-id | -c <catalog-id>]
                                                 [--version <version>]
                                                 [--max-results <max-results>]
                                                 [--next-token <next-token>]
                                                 [--profile | -p <profile>]
                                                 [--debug]

Options

--catalog-id, -c
Required. Unique identifier of the catalog.
--version
Required. The version of the voice interaction model.
--max-results
Optional. 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 never contains more . If there are additional results that satisfy the search criteria, but these results were not returned, the response contains isTruncated = true.
--next-token
Optional. 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.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

get-interaction-model-catalog-version

Gets a specific version of a catalog. For more information, see Reference-Based Catalog Management.

Syntax

$ ask smapi get-interaction-model-catalog-version [--catalog-id | -c <catalog-id>]
                                                  [--version <version>]
                                                  [--profile | -p <profile>]
                                                  [--debug]

Options

--catalog-id, -c
Required. Unique identifier of the catalog.
--version
Required. The version of the voice interaction model.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

get-interaction-model-metadata

Get the latest metadata for the voice interaction model for the given stage.

Syntax

$ ask smapi get-interaction-model-metadata [--skill-id | -s <skill-id>]
                                           [--stage | -g <stage>]
                                           [--locale | -l <locale>]
                                           [--profile | -p <profile>]
                                           [--debug]

Options

--skill-id, -s
Required. The skill ID.
--stage, -g
Required. 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, -l
Required. The locale for the model requested e.g. en-GB, en-US, de-DE.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

get-interaction-model-slot-type-build-status

Get the status of slot type resource and its sub-resources for a given slotTypeId.

Syntax

$ ask smapi get-interaction-model-slot-type-build-status [--slot-type-id <slot-type-id>]
                                                         [--update-request-id <update-request-id>]
                                                         [--profile | -p <profile>]
                                                         [--debug]

Options

--slot-type-id
Required. The identifier for a slot type.
--update-request-id
Required. The identifier for slotType version creation process.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

get-interaction-model-slot-type-definition

Get the slot type definition.

Syntax

$ ask smapi get-interaction-model-slot-type-definition [--slot-type-id <slot-type-id>]
                                                       [--profile | -p <profile>]
                                                       [--debug]

Options

--slot-type-id
Required. The identifier for a slot type.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

get-interaction-model-slot-type-version

Get slot type version data of given slot type version.

Syntax

$ ask smapi get-interaction-model-slot-type-version [--slot-type-id <slot-type-id>]
                                                    [--version <version>]
                                                    [--profile | -p <profile>]
                                                    [--debug]

Options

--slot-type-id
Required. The identifier for a slot type.
--version
Required. The version of the voice interaction model.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

get-interaction-model-version

Gets the specified version of the voice interaction model of a skill.

Syntax

$ ask smapi get-interaction-model-version [--skill-id | -s <skill-id>]
                                          [--stage | -g <stage>]
                                          [--locale | -l <locale>]
                                          [--version <version>]
                                          [--profile | -p <profile>]
                                          [--debug]

Options

--skill-id, -s
Required. The skill ID.
--stage, -g
Required. 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, -l
Required. The locale for the model requested e.g. en-GB, en-US, de-DE.
--version
Required. The version of the voice interaction model to get. Use ~current to get the current version of the voice interaction model.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

get-isp-associated-skills

Get the associated skills for the in-skill product.

Syntax

$ ask smapi get-isp-associated-skills [--product-id <product-id>]
                                      [--stage | -g <stage>]
                                      [--next-token <next-token>]
                                      [--max-results <max-results>]
                                      [--profile | -p <profile>]
                                      [--debug]

Options

--product-id
Required. The in-skill product ID.
--stage, -g
Required. Stage for skill.
--next-token
Optional. 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.
--max-results
Optional. 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 never contains more . If there are additional results that satisfy the search criteria, but these results were not returned, the response contains isTruncated = true.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

get-isp-definition

Returns the in-skill product definition for given productId.

Syntax

$ ask smapi get-isp-definition [--product-id <product-id>]
                               [--stage | -g <stage>]
                               [--profile | -p <profile>]
                               [--debug]

Options

--product-id
Required. The in-skill product ID.
--stage, -g
Required. Stage for skill.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

get-isp-list-for-skill-id

Get the list of in-skill products for the skillId.

Syntax

$ ask smapi get-isp-list-for-skill-id [--skill-id | -s <skill-id>]
                                      [--stage | -g <stage>]
                                      [--next-token <next-token>]
                                      [--max-results <max-results>]
                                      [--profile | -p <profile>]
                                      [--debug]

Options

--skill-id, -s
Required. The skill ID.
--stage, -g
Required. Stage for skill.
--next-token
Optional. 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.
--max-results
Optional. 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 never contains more. If there are additional results that satisfy the search criteria, but these results were not returned, the response contains isTruncated = true.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

get-isp-list-for-vendor

Get the list of in-skill products for the vendor.

Syntax

$ ask smapi get-isp-list-for-vendor [--next-token <next-token>]
                                    [--max-results <max-results>]
                                    [--product-id <product-id>]
                                    [--stage | -g <stage>]
                                    [--type <type>]
                                    [--reference-name <reference-name>]
                                    [--status <status>]
                                    [--is-associated-with-skill <is-associated-with-skill>]
                                    [--profile | -p <profile>]
                                    [--debug]

Options

--next-token
Optional. 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.
--max-results
Optional. 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 never contains more. If there are additional results that satisfy the search criteria, but these results were not returned, the response contains isTruncated = true.
--product-id
Optional. 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. This parameter must not be used with 'nextToken' and/or 'maxResults' parameter. [MULTIPLE]: Values can be separated by comma.
--stage, -g
Optional. Filter in-skill products by specified stage. [ENUM]: development,live.
--type
Optional. Type of in-skill product to filter on. [ENUM]: SUBSCRIPTION,ENTITLEMENT,CONSUMABLE.
--reference-name
Optional. Filter in-skill products by reference name.
--status
Optional. Status of in-skill product. [ENUM]: INCOMPLETE,COMPLETE,CERTIFICATION,PUBLISHED,SUPPRESSED.
--is-associated-with-skill
Optional. Filter in-skill products by whether or not they are associated to a skill. [ENUM]: ASSOCIATED_WITH_SKILL,NO_SKILL_ASSOCIATIONS.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

get-isp-summary

Get the summary information for an in-skill product.

Syntax

$ ask smapi get-isp-summary [--product-id <product-id>]
                            [--stage | -g <stage>]
                            [--profile | -p <profile>]
                            [--debug]

Options

--product-id
Required. The in-skill product ID.
--stage, -g
Required. Stage for skill.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

get-list-of-testers

List all testers in a beta test for the given Alexa skill.

Syntax

$ ask smapi get-list-of-testers [--skill-id | -s <skill-id>]
                                [--next-token <next-token>]
                                [--max-results <max-results>]
                                [--profile | -p <profile>]
                                [--debug]

Options

--skill-id, -s
Required. The skill ID.
--next-token
Optional. 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.
--max-results
Optional. 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 never contains more . If there are additional results that satisfy the search criteria, but these results were not returned, the response contains isTruncated = true.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

get-skill-enablement-status

Check whether an enablement exist for given skillId/stage and customerId (retrieved from Auth token).

Syntax

$ ask smapi get-skill-enablement-status [--skill-id | -s <skill-id>]
                                        [--stage | -g <stage>]
                                        [--profile | -p <profile>]
                                        [--debug]

Options

--skill-id, -s
Required. The skill ID.
--stage, -g
Required. Stage for skill.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

get-skill-manifest

Return the skill manifest for given skillId and stage.

Syntax

$ ask smapi get-skill-manifest [--skill-id | -s <skill-id>]
                               [--stage | -g <stage>]
                               [--profile | -p <profile>]
                               [--debug]

Options

--skill-id, -s
Required. The skill ID.
--stage, -g
Required. 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.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

get-skill-metrics

Get analytic metrics report of skill usage.

Syntax

$ ask smapi get-skill-metrics [--skill-id | -s <skill-id>]
                              [--start-time <start-time>]
                              [--end-time <end-time>]
                              [--period <period>]
                              [--metric <metric>]
                              [--stage | -g <stage>]
                              [--skill-type <skill-type>]
                              [--intent <intent>]
                              [--locale | -l <locale>]
                              [--max-results <max-results>]
                              [--next-token <next-token>]
                              [--profile | -p <profile>]
                              [--debug]

Options

--skill-id, -s
Required. The skill ID.
--start-time
Required. The start time of query.
--end-time
Required. The end time of query (The maximum time duration is 1 week).
--period
Required. The aggregation period to use when retrieving the metric, follows ISO_8601#Durations format.
--metric
Required. A distinct set of logic which predictably returns a set of data.
--stage, -g
Required. The stage of the skill (live, development).
--skill-type
Required. The type of the skill (custom, smartHome and flashBriefing).
--intent
Optional. The intent of the skill.
--locale, -l
Optional. The locale for the skill. e.g. en-GB, en-US, de-DE and etc.
--max-results
Optional. 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 never contains more . If there are additional results that satisfy the search criteria, but these results were not returned, the response contains isTruncated = true.
--next-token
Optional. 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.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

get-skill-simulation

This API gets the result of a previously executed simulation. A successful response contains the status of the executed simulation. If the simulation successfully completed, the response contains information related to skill invocation. In cases where requests to this API results in an error, the response contains an error code and a description of the problem. In cases where the simulation failed, the response contains a status attribute indicating that a failure occurred and details about what was sent to the skill endpoint. Simulation results are stored for 10 minutes. A request for an expired simulation result returns a 404 HTTP status code.

Syntax

$ ask smapi get-skill-simulation [--skill-id | -s <skill-id>]
                                 [--stage | -g <stage>]
                                 [--simulation-id | -i <simulation-id>]
                                 [--profile | -p <profile>]
                                 [--debug]

Options

--skill-id, -s
Required. The skill ID.
--stage, -g
Required. Stage for skill.
--simulation-id, -i
Required. Id of the simulation.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

get-skill-status

Get the status of skill resource and its sub-resources for a given skillId.

Syntax

$ ask smapi get-skill-status [--skill-id | -s <skill-id>]
                             [--resource <resource>]
                             [--profile | -p <profile>]
                             [--debug]

Options

--skill-id, -s
Required. The skill ID.
--resource
Optional. 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 and sub-resources are returned.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

get-skill-validations

This API gets the result of a previously executed validation. A successful response contains the status of the executed validation. If the validation successfully completed, the response contains information related to executed validations. In cases where requests to this API results in an error, the response contains a description of the problem. In cases where the validation failed, the response contains a status attribute indicating that a failure occurred. Validation results are stored for 60 minutes. A request for an expired validation result returns a 404 HTTP status code.

Syntax

$ ask smapi get-skill-validations [--skill-id | -s <skill-id>]
                                  [--validation-id | -i  <validation-id>]
                                  [--stage | -g <stage>]
                                  [--accept-language <accept-language>]
                                  [--profile | -p <profile>]
                                  [--debug]

Options

--skill-id, -s
Required. The skill ID.
--validation-id, -i
Required. Id of the validation. Reserved word identifier of mostRecent can be used to get the most recent validation for the skill and stage. 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, -g
Required. Stage for skill.
--accept-language
Optional. User's locale/language in context.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

get-ssl-certificates

Return the ssl certificate sets currently associated with this skill. Sets consist of one ssl certificate blob associated with a region as well as the default certificate for the skill.

Syntax

$ ask smapi get-ssl-certificates [--skill-id | -s <skill-id>]
                                 [--profile | -p <profile>]
                                 [--debug]

Options

--skill-id, -s
Required. The skill ID.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

get-status-of-export-request

Get status for given exportId.

Syntax

$ ask smapi get-status-of-export-request [--export-id <export-id>]
                                         [--profile | -p <profile>]
                                         [--debug]

Options

--export-id
Required. The Export ID.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

get-task

Get the task definition details for a specified task name and version.

Syntax

$ ask smapi get-task [--skill-id | -s <skill-id>]
                     [--task-name <task-name>]
                     [--task-version <task-version>]
                     [--profile | -p <profile>]
                     [--debug]

Options

--skill-id, -s
Required. The skill ID.
--task-name
Required. The task name.
--task-version
Required. The task version. For example, "1".
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

get-utterance-data

Syntax

$ ask smapi get-utterance-data [--skill-id | -s <skill-id>]
                               [--next-token <next-token>]
                               [--max-results <max-results>]
                               [--sort-direction <sort-direction>]
                               [--sort-field <sort-field>]
                               [--stage | -g <stage>]
                               [--locale | -l <locale>]
                               [--dialog-act-name <dialog-act-name>]
                               [--intent-confidence-bin <intent-confidence-bin>]
                               [--intent-name <intent-name>]
                               [--intent-slots-name <intent-slots-name>]
                               [--interaction-type <interaction-type>]
                               [--publication-status <publication-status>]
                               [--utterance-text <utterance-text>]
                               [--profile | -p <profile>]
                               [--debug]

Options

--skill-id, -s
Required. The skill ID.
--next-token
Optional. 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.
--max-results
Optional. 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 never contains more . If there are additional results that satisfy the search criteria, but these results were not returned, the response contains isTruncated = true.
--sort-direction
Optional. 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.
--sort-field
Optional. Sets the field on which the sorting would be applied.
--stage, -g
Optional. A filter used to retrieve items where the stage is equal to the given value. [MULTIPLE]: Values can be separated by comma. [ENUM]: development,live.
--locale, -l
Optional. A filter used to retrieve items where the locale is equal to the given value. [MULTIPLE]: Values can be separated by comma. [ENUM]: en-US,en-GB,en-IN,en-CA,en-AU,de-DE,ja-JP.
--dialog-act-name
Optional. Dialog act directive name.* Dialog.ElicitSlot: Alexa asked the user for the value of a specific slot. For more information, see ElicitSlot directive. * Dialog.ConfirmSlot: Alexa confirmed the value of a specific slot before continuing with the dialog. For more information, see ConfirmSlot directive. * Dialog.ConfirmIntent: Alexa confirmed the all the information the user has provided for the intent before the skill took action. For more information, see ConfirmIntent directive. [MULTIPLE]: Values can be separated by comma. [ENUM]: Dialog.ElicitSlot,Dialog.ConfirmSlot,Dialog.ConfirmIntent.
--intent-confidence-bin
Optional. A filter used to retrieve items where the intent confidence bin is equal to the given value.* `HIGH`: Intent was recognized with high confidence. * `MEDIUM`: Intent was recognized with medium confidence. * `LOW`: Intent was recognized with low confidence. Low confidence intents are not sent to the skill. [MULTIPLE]: Values can be separated by comma. [ENUM]: HIGH,MEDIUM,LOW.
--intent-name
Optional. A filter used to retrieve items where the intent name is equal to the given value. [MULTIPLE]: Values can be separated by comma.
--intent-slots-name
Optional. A filter used to retrieve items where the one of the slot names is equal to the given value. [MULTIPLE]: Values can be separated by comma.
--interaction-type
Optional. Indicates if the utterance was executed as a "ONE_SHOT" interaction or "MODAL" interaction.* `ONE_SHOT`: The user invokes the skill and states their intent in a single phrase. * `MODAL`: The user first invokes the skill and then states their intent. [MULTIPLE]: Values can be separated by comma. [ENUM]: ONE_SHOT,MODAL.
--publication-status
Optional. The publication status of the skill when this interaction occurred [MULTIPLE]: Values can be separated by comma. [ENUM]: Development,Certification.
--utterance-text
Optional. 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. [MULTIPLE]: Values can be separated by comma.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

get-vendor-list

Get the list of Vendor information.

Syntax

$ ask smapi get-vendor-list [--profile | -p <profile>]
                            [--debug]

Options

--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

import-skill-package

Create a new import for a skill with given skillId.

Syntax

$ ask smapi import-skill-package [--location <location>]
                                 [--skill-id | -s <skill-id>]
                                 [--if-match <if-match>]
                                 [--profile | -p <profile>]
                                 [--debug]

Options

--location
Required. Location of the package.
--skill-id, -s
Required. The skill ID.
--if-match
Optional. Request header that specified an entity tag. The server updates the resource only if the eTag matches the resource's current eTag.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

invoke-skill

This is a synchronous API that invokes the Lambda (or third party HTTPS) endpoint for a skill. The response contains information about the endpoint that was called, and the payloads sent to and received from the endpoint. You can only call invoke-skill for skills that you own and that are enabled.

If an error occurs at the skill endpoint, the response contains a failure status attribute and details about what was sent to the endpoint. If an error occurs in invoke-skill, the response contains an error code and a description of the problem.

Calls to the skill endpoint time out after 10 seconds. This API is designed to allow extension to an asynchronous API if a longer timeout is required.

Syntax

$ ask smapi invoke-skill [--skill-id | -s <skill-id>]
                         [--endpoint-region <endpoint-region>]
                         [--skill-request-body <skill-request-body>]
                         [--full-response]
                         [--profile | -p <profile>]
                         [--debug]

Options

--skill-id, -s
Required. The skill ID.
--endpoint-region
Required. The region in which to call the endpoint. One of: NA, EU, FE.
--skill-request-body
Required. The JSON for the request body. You can specify the JSON as a string or in a file. If you specify a file, you can specify it with either an absolute or relative path. For example, "$(cat {filepath})" or "file:{filepath}".
--full-response
When you include this option, the body, headers, and status code of the response are returned as one object.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

invoke-skill-end-point

This is a synchronous API that invokes the Lambda (or third party HTTPS) endpoint for a skill. The response contains information about the endpoint that was called, and the payloads sent to and received from the endpoint. You can only call invoke-skill for skills that you own and that are enabled.

If an error occurs at the skill endpoint, the response contains a failure status attribute and details about what was sent to the endpoint. If an error occurs in invoke-skill, the response contains an error code and a description of the problem.

Calls to the skill endpoint time out after 10 seconds. This API is designed to allow extension to an asynchronous API if a longer timeout is required.

Syntax

$ ask smapi invoke-skill-end-point [--skill-id | -s <skill-id>]
                                   [--stage | -g <stage>]
                                   [--endpoint-region <endpoint-region>]
                                   [--skill-request-body <skill-request-body>]
                                   [--profile | -p <profile>]
                                   [--debug]

Options

--skill-id, -s
Required. The skill ID.
--stage, -g
Required. The stage of the skill. One of: development, live.
--endpoint-region
Required. The region in which to call the endpoint. One of: NA, EU, FE.
--skill-request-body
Required. The JSON for the request body. You can specify the JSON as a string or in a file. If you specify a file, you can specify it using either an absolute or relative path. For example, "$(cat {filepath})" or "file:{filepath}".
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

list-interaction-model-catalogs

List all catalogs. For more information, see Reference-Based Catalog Management.

Syntax

$ ask smapi list-interaction-model-catalogs [--max-results <max-results>]
                                            [--next-token <next-token>]
                                            [--sort-direction <sort-direction>]
                                            [--profile | -p <profile>]
                                            [--debug]

Options

--max-results
Optional. 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 never contains more . If there are additional results that satisfy the search criteria, but these results were not returned, the response contains isTruncated = true.
--next-token
Optional. 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.
--sort-direction
Optional. 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.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

list-interaction-model-versions

Gets a list of versions of a catalog. For more information, see Reference-Based Catalog Management.

Syntax

$ ask smapi list-interaction-model-versions [--skill-id | -s <skill-id>]
                                            [--stage | -g <stage>]
                                            [--locale | -l <locale>]
                                            [--next-token <next-token>]
                                            [--max-results <max-results>]
                                            [--sort-direction <sort-direction>]
                                            [--sort-field <sort-field>]
                                            [--profile | -p <profile>]
                                            [--debug]

Options

--skill-id, -s
Required. The skill ID.
--stage, -g
Required. 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, -l
Required. The locale for the model requested e.g. en-GB, en-US, de-DE.
--next-token
Optional. 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.
--max-results
Optional. 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 never contains more . If there are additional results that satisfy the search criteria, but these results were not returned, the response contains isTruncated = true.
--sort-direction
Optional. 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.
--sort-field
Optional. Sets the field on which the sorting would be applied.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

list-interaction-model-slot-types

List all slot types for the vendor.

Syntax

$ ask smapi list-interaction-model-slot-types [--max-results <max-results>]
                                              [--next-token <next-token>]
                                              [--sort-direction <sort-direction>]
                                              [--profile | -p <profile>]
                                              [--debug]

Options

--max-results
Optional. 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 never contains more . If there are additional results that satisfy the search criteria, but these results were not returned, the response contains isTruncated = true.
--next-token
Optional. 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.
--sort-direction
Optional. 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.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

list-interaction-model-slot-type-versions

List all slot type versions for the slot type id.

Syntax

$ ask smapi list-interaction-model-slot-type-versions [--slot-type-id <slot-type-id>]
                                                      [--max-results <max-results>]
                                                      [--next-token <next-token>]
                                                      [--sort-direction <sort-direction>]
                                                      [--profile | -p <profile>]
                                                      [--debug]

Options

--slot-type-id
Required. The identifier for a slot type.
--max-results
Optional. 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 never contains more . If there are additional results that satisfy the search criteria, but these results were not returned, the response contains isTruncated = true.
--next-token
Optional. 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.
--sort-direction
Optional. 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.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

list-private-distribution-accounts

List private distribution accounts.

Syntax

$ ask smapi list-private-distribution-accounts [--skill-id | -s <skill-id>]
                                               [--stage | -g <stage>]
                                               [--next-token <next-token>]
                                               [--max-results <max-results>]
                                               [--profile | -p <profile>]
                                               [--debug]

Options

--skill-id, -s
Required. The skill ID.
--stage, -g
Required. Stage for skill.
--next-token
Optional. 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.
--max-results
Optional. 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 never contains more . If there are additional results that satisfy the search criteria, but these results were not returned, the response contains isTruncated = true.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

list-skills-for-vendor

Get the list of skills for the vendor.

Syntax

$ ask smapi list-skills-for-vendor [--next-token <next-token>]
                                   [--max-results <max-results>]
                                   [--skill-id | -s <skill-id>]
                                   [--profile | -p <profile>]
                                   [--debug]

Options

--next-token
Optional. 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.
--max-results
Optional. 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 never contains more . If there are additional results that satisfy the search criteria, but these results were not returned, the response contains isTruncated = true.
--skill-id, -s
Optional. 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. This parameter must not be used with 'nextToken' or/and 'maxResults' parameter. [MULTIPLE]: Values can be separated by comma.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

profile-nlu

Profile an utterance against the voice interaction model.

Syntax

$ ask smapi profile-nlu [--utterance | -u <utterance>]
                        [--multi-turn-token <multi-turn-token>]
                        [--skill-id | -s <skill-id>]
                        [--stage | -g <stage>]
                        [--locale | -l <locale>]
                        [--profile | -p <profile>]
                        [--debug]

Options

--utterance, -u
Required. Actual representation of user input to Alexa.
--multi-turn-token
Required. Opaque string which contains multi-turn related context.
--skill-id, -s
Required. The skill ID.
--stage, -g
Required. Stage for skill.
--locale, -l
Required. The locale for the model requested e.g. en-GB, en-US, de-DE.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

query-development-audit-logs

The SMAPI Audit Logs API provides customers with an audit history of all SMAPI calls made by a developer or developers with permissions on that account.

Syntax

$ ask smapi query-development-audit-logs [--vendor-id <vendor-id>]
                                         [--request-filters-clients <request-filters-clients>]
                                         [--request-filters-operations <request-filters-operations>]
                                         [--request-filters-resources <request-filters-resources>]
                                         [--request-filters-requesters <request-filters-requesters>]
                                         [--request-filters-start-time <request-filters-start-time>]
                                         [--request-filters-end-time <request-filters-end-time>]
                                         [--request-filters-http-response-codes <request-filters-http-response-codes>]
                                         [--sort-direction <sort-direction>]
                                         [--sort-field <sort-field>]
                                         [--pagination-context-next-token <pagination-context-next-token>]
                                         [--pagination-context-max-results <pagination-context-max-results>]
                                         [--profile | -p <profile>]
                                         [--debug]

Options

--vendor-id
Required. Vendor Id. See Customer Details.
--request-filters-clients
Optional. List of Client IDs for filtering.
--request-filters-operations
Optional. Filters for a list of operation names and versions.
--request-filters-resources
Optional. Filters for a list of resources and/or their types. See documentation for allowed types.
--request-filters-requesters
Optional. Request Filters for filtering audit logs.
--request-filters-start-time
Optional. Sets the start time for this search. Any audit logs with timestamps after this time (inclusive) are included in the response.
--request-filters-end-time
Optional. Sets the end time for this search. Any audit logs with timestamps before this time (exclusive) are included in the result.
--request-filters-http-response-codes
Optional. Filters for HTTP response codes. For example, '200' or '503'.
--sort-direction
Optional. 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. [ENUM]: ASC,DESC.
--sort-field
Optional. Sets the field on which the sorting would be applied. [ENUM]: timestamp,operation,resource.id,resource.type,requester.userId,client.id,httpResponseCode.
--pagination-context-next-token
Optional. When the response to this API call is truncated, the response 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 this API understands. Token has expiry of 1 hour.
--pagination-context-max-results
Optional. Sets the maximum number of results returned in the response body. If you want to retrieve more or less than the default of 50 results, you can add this parameter to your request. maxResults can exceed the upper limit of 250 but, more than 250 items are not returned. The response might contain fewer results than maxResults for purpose of keeping SLA or because there are not enough items, but it never contains more .
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

remove-testers-from-beta-test

Remove testers from a beta test for the given Alexa skill. The system sends access-end email to each tester and removes entitlement for them.

Syntax

$ ask smapi remove-testers-from-beta-test [--skill-id | -s <skill-id>]
                                          [--testers-emails <testers-emails>]
                                          [--profile | -p <profile>]
                                          [--debug]

Options

--skill-id, -s
Required. The skill ID.
--testers-emails
Required. List of email address of beta testers. [MULTIPLE]: Values can be separated by comma.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

request-feedback-from-testers

Request feedback from the testers in a beta test for the given Alexa skill. The system sends notification emails to testers to request feedback.

Syntax

$ ask smapi request-feedback-from-testers [--skill-id | -s <skill-id>]
                                          [--testers-emails <testers-emails>]
                                          [--profile | -p <profile>]
                                          [--debug]

Options

--skill-id, -s
Required. The skill ID.
--testers-emails
Required. List of email address of beta testers. [MULTIPLE]: Values can be separated by comma.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

reset-entitlement-for-product

Reset the entitlement(s) of the product for the current user.

Syntax

$ ask smapi reset-entitlement-for-product [--product-id <product-id>]
                                          [--stage | -g <stage>]
                                          [--profile | -p <profile>]
                                          [--debug]

Options

--product-id
Required. The in-skill product ID.
--stage, -g
Required. Stage for skill.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

search-task

Returns task information for a skill. You can search by keywords and provider skill ID. If you omit both keywords and provider skill id, all tasks for the skill are returned.

Syntax

$ ask smapi search-task [--skill-id | -s <skill-id>]
                        [--provider-skill-id <provider-skill-id>]
                        [--keywords <keywords>]
                        [--max-results <max-results>]
                        [--next-token <next-token>]
                        [--profile | -p <profile>]
                        [--debug]

Options

--skill-id, -s
Required. The skill ID.
--provider-skill-id
Optional. The provider skill ID.
--keywords
Optional. Keywords can include descriptions of tasks, task names, or tags from the task definition. Use commas to separate keywords. Each keyword can contain multiple words. For example, --keywords "computer software, vacuum cleaner".
--max-results
Optional. 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 never contains more . If there are additional results that satisfy the search criteria, but these results were not returned, the response contains isTruncated = true.
--next-token
Optional. 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.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

send-reminder-to-testers

Send reminder to the testers in a beta test for the given Alexa skill. The system sends invitation email to each tester and adds entitlement on acceptance.

Syntax

$ ask smapi send-reminder-to-testers [--skill-id | -s <skill-id>]
                                     [--testers-emails <testers-emails>]
                                     [--profile | -p <profile>]
                                     [--debug]

Options

--skill-id, -s
Required. The skill ID.
--testers-emails
Required. List of email address of beta testers. [MULTIPLE]: Values can be separated by comma.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

set-interaction-model

Create a voice interaction model for a skill.

Syntax

$ ask smapi set-interaction-model [--skill-id | -s <skill-id>]
                                  [--stage | -g <stage>]
                                  [--locale | -l <locale>]
                                  [--interaction-model <interaction-model>]
                                  [--if-match <if-match>]
                                  [--profile | -p <profile>]
                                  [--debug]

Options

--skill-id, -s
Required. The skill ID.
--stage, -g
Required. 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, -l
Required. The locale for the model requested e.g. en-GB, en-US, de-DE.
--interaction-model
Required. The JSON for the voice interaction model. [JSON].
--if-match
Optional. Request header that specified an entity tag. The server updates the resource only if the eTag matches the resource's current eTag.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

set-private-distribution-account-id

Add an id to the private distribution accounts.

Syntax

$ ask smapi set-private-distribution-account-id [--skill-id | -s <skill-id>]
                                                [--stage | -g <stage>]
                                                [--id <id>]
                                                [--profile | -p <profile>]
                                                [--debug]

Options

--skill-id, -s
Required. The skill ID.
--stage, -g
Required. Stage for skill.
--id
Required. ARN that a skill can be privately distributed to.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

set-skill-enablement

Create or update the enablement for given skillId/stage and customerId (retrieved from Auth token).

Syntax

$ ask smapi set-skill-enablement [--skill-id | -s <skill-id>]
                                 [--stage | -g <stage>]
                                 [--profile | -p <profile>]
                                 [--debug]

Options

--skill-id, -s
Required. The skill ID.
--stage, -g
Required. Stage for skill.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

set-ssl-certificates

Update the ssl certificates associated with this skill.

Syntax

$ ask smapi set-ssl-certificates [--skill-id | -s <skill-id>]
                                 [--ssl-certificate-payload <ssl-certificate-payload>]
                                 [--profile | -p <profile>]
                                 [--debug]

Options

--skill-id, -s
Required. The skill ID.
--ssl-certificate-payload
Required. Defines the input/output of the ssl certificates api for a skill. [JSON].
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

simulate-skill

This is an asynchronous API that simulates a skill execution in the Alexa eco-system given an utterance text of what a customer would say to Alexa. A successful response contains a header with the location of the simulation resource. In cases where requests to this API results in an error, the response contains an error code and a description of the problem. The skill being simulated must belong to and be enabled by the user of this API. Concurrent requests per user is currently not supported.

Syntax

$ ask smapi simulate-skill [--skill-id | -s <skill-id>]
                           [--stage | -g <stage>]
                           [--input-content <input-content>]
                           [--device-locale <device-locale>]
                           [--session-mode <session-mode>]
                           [--profile | -p <profile>]
                           [--debug]

Options

--skill-id, -s
Required. The skill ID.
--stage, -g
Required. Stage for skill.
--input-content
Required. A string corresponding to the utterance text of what a customer would say to Alexa.
--device-locale
Required. A valid locale (e.g "en-US") for the virtual device used in simulation.
--session-mode
Optional. Indicate the session mode of the current simulation is using. [ENUM]: DEFAULT,FORCE_NEW_SESSION.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

start-beta-test

Start a beta test for a given Alexa skill. The system sends invitation emails to each tester in the test, and add entitlement on the acceptance.

Syntax

$ ask smapi start-beta-test [--skill-id | -s <skill-id>]
                            [--profile | -p <profile>]
                            [--debug]

Options

--skill-id, -s
Required. The skill ID.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

submit-skill-for-certification

Submit the skill for certification.

Syntax

$ ask smapi submit-skill-for-certification [--skill-id | -s <skill-id>]
                                           [--publication-method <publication-method>]
                                           [--profile | -p <profile>]
                                           [--debug]

Options

--skill-id, -s
Required. The skill ID.
--publication-method
Optional. Determines if the skill should be submitted only for certification and manually publish later or publish immediately after the skill is certified. Omitting the publication method defaults to auto publishing. [ENUM]: MANUAL_PUBLISHING,AUTO_PUBLISHING.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

submit-skill-validation

This is an asynchronous API which allows a skill developer to execute various validations against their skill.

Syntax

$ ask smapi submit-skill-validation [--locales | -l <locales>]
                                    [--skill-id | -s <skill-id>]
                                    [--stage | -g <stage>]
                                    [--profile | -p <profile>]
                                    [--debug]

Options

--locale, -ls
Required..
--skill-id, -s
Required. The skill ID.
--stage, -g
Required. Stage for skill.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

update-account-linking-info

Create AccountLinking information for the skill.

Syntax

$ ask smapi update-account-linking-info [--skill-id | -s <skill-id>]
                                        [--stage | -g <stage>]
                                        [--account-linking-request <account-linking-request>]
                                        [--if-match <if-match>]
                                        [--profile | -p <profile>]
                                        [--debug]

Options

--skill-id, -s
Required. The skill ID.
--stage, -g
Required. 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.
--account-linking-request
Required. The fields required to create accountLinking partner. [JSON].
--if-match
Optional. Request header that specified an entity tag. The server updates the resource only if the eTag matches the resource's current eTag.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

update-beta-test

Update a beta test for a given Alexa skill.

Syntax

$ ask smapi update-beta-test [--skill-id | -s <skill-id>]
                             [--feedback-email <feedback-email>]
                             [--profile | -p <profile>]
                             [--debug]

Options

--skill-id, -s
Required. The skill ID.
--feedback-email
Optional. Email address for providing feedback.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

update-interaction-model-catalog

Update a catalog. For more information, see Reference-Based Catalog Management.

Syntax

$ ask smapi update-interaction-model-catalog [--catalog-id | -c <catalog-id>]
                                             [--slot-type-description <slot-type-description>]
                                             [--profile | -p <profile>]
                                             [--debug]

Options

--catalog-id, -c
Required. Unique identifier of the catalog.
--slot-type-description
Optional. The slot type description with a 255 character maximum.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

update-interaction-model-catalog-version

Update the description and instructions for a specified version of a catalog. For more information, see Reference-Based Catalog Management.

Syntax

$ ask smapi update-interaction-model-catalog-version [--catalog-id | -c <catalog-id>]
                                                     [--version <version>]
                                                     [--description <description>]
                                                     [--profile | -p <profile>]
                                                     [--debug]

Options

--catalog-id, -c
Required. Unique identifier of the catalog.
--version
Required. The version of the voice interaction model.
--description
Optional. The catalog description with a 255 character maximum.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

update-interaction-model-slot-type

Update description and vendorGuidance string for certain version of a slot type.

Syntax

$ ask smapi update-interaction-model-slot-type [--slot-type-id <slot-type-id>]
                                               [--slot-type-description <slot-type-description>]
                                               [--profile | -p <profile>]
                                               [--debug]

Options

--slot-type-id
Required. The identifier for a slot type.
--slot-type-description
Optional. The slot type description with a 255 character maximum.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

update-interaction-model-slot-type-version

Update description and vendorGuidance string for certain version of a slot type.

Syntax

$ ask smapi update-interaction-model-slot-type-version [--slot-type-id <slot-type-id>]
                                                       [--version <version>]
                                                       [--slot-type-description <slot-type-description>]
                                                       [--profile | -p <profile>]
                                                       [--debug]

Options

--slot-type-id
Required. The identifier for a slot type.
--version
Required. The version of the voice interaction model.
--slot-type-description
Optional. The slot type description with a 255 character maximum.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

update-isp-for-product

Update the in-skill product definition for given productId. Only development stage supported.

Syntax

$ ask smapi update-isp-for-product [--if-match <if-match>]
                                   [--product-id <product-id>]
                                   [--stage | -g <stage>]
                                   [--in-skill-product <in-skill-product>]
                                   [--profile | -p <profile>]
                                   [--debug]

Options

--if-match
Optional. Request header that specified an entity tag. The server updates the resource only if the eTag matches the resource's current eTag.
--product-id
Required. The in-skill product ID.
--stage, -g
Required. Stage for skill.
--in-skill-product
Required. defines the request body for updateInSkillProduct API. [JSON].
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

update-skill-manifest

Update skill manifest for given skillId and stage.

Syntax

$ ask smapi update-skill-manifest [--if-match <if-match>]
                                  [--skill-id | -s <skill-id>]
                                  [--stage | -g <stage>]
                                  [--manifest <manifest>]
                                  [--profile | -p <profile>]
                                  [--debug]

Options

--if-match
Optional. Request header that specified an entity tag. The server updates the resource only if the eTag matches the resource's current eTag.
--skill-id, -s
Required. The skill ID.
--stage, -g
Required. 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.
--manifest
Required. Defines the request body for updateSkill API. [JSON].
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.

upload-catalog

Upload a file for the catalog.

Syntax

$ ask smapi upload-catalog [--catalog-id | -c <catalog-id>]
                           [--file | -f <file>]
                           [--profile | -p <profile>]
                           [--debug]

Options

--catalog-id, -c
Required. Unique identifier of the catalog.
--file, -f
Required. Path to the target file input.
--profile, -p
Optional. The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
Optional. When you include this option, debug messages appear in the output of the command.

withdraw-skill-from-certification

Withdraw the skill from certification.

Syntax

$ ask smapi withdraw-skill-from-certification [--skill-id | -s <skill-id>]
                                              [--reason <reason>]
                                              [--message <message>]
                                              [--profile | -p <profile>]
                                              [--debug]

Options

--skill-id, -s
Required. The skill ID.
--reason
Optional. The reason to withdraw. [ENUM]: TEST_SKILL,MORE_FEATURES,DISCOVERED_ISSUE,NOT_RECEIVED_CERTIFICATION_FEEDBACK,NOT_INTEND_TO_PUBLISH,OTHER.
--message
Required. The message only in case the reason in OTHER.
--profile, -p
The ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.
--debug
When you include this option, debug messages appear in the output of the command.