ask-cli/docs/concepts/Smapi-Command.md

Alexa Skills Kit (ASK) Command Line Interfaces

# SMAPI COMMAND

Provides a number of subcommands that map 1:1 to the underlying API operations in 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, interaction model, and account linking information as well as starting the skill certification process.

`smapi` command format:

`$ ask smapi <subcommand> `

## Subcommands

| Task  | Subcommand |
|---|---|
| Lists catalogs associated with a vendor. | [list-catalogs-for-vendor](#list-catalogs-for-vendor) |
| Creates a new catalog based on information provided in the request. | [create-catalog](#create-catalog) |
| Returns information about a particular catalog. | [get-catalog](#get-catalog) |
| Lists all the catalogs associated with a skill. | [list-catalogs-for-skill](#list-catalogs-for-skill) |
| Associate skill with catalog. | [associate-catalog-with-skill](#associate-catalog-with-skill) |
| Lists all the uploads for a particular catalog. | [list-uploads-for-catalog](#list-uploads-for-catalog) |
| Creates a new upload for a catalog and returns presigned upload parts for uploading the file. | [create-content-upload](#create-content-upload) |
| Gets detailed information about an upload which was created for a specific catalog. Includes the upload's ingestion steps and a url for downloading the file. | [get-content-upload-by-id](#get-content-upload-by-id) |
| Completes an upload. To be called after the file is uploaded to the backend data store using presigned url(s). | [complete-catalog-upload](#complete-catalog-upload) |
| Lists the subscribers for a particular vendor. | [list-subscribers-for-development-events](#list-subscribers-for-development-events) |
| Creates a new subscriber resource for a vendor. | [create-subscriber-for-development-events](#create-subscriber-for-development-events) |
| Returns information about specified subscriber. | [get-subscriber-for-development-events](#get-subscriber-for-development-events) |
| Updates the properties of a subscriber. | [set-subscriber-for-development-events](#set-subscriber-for-development-events) |
| Deletes a specified subscriber. | [delete-subscriber-for-development-events](#delete-subscriber-for-development-events) |
| Lists all the subscriptions for a vendor/subscriber depending on the query parameter. | [list-subscriptions-for-development-events](#list-subscriptions-for-development-events) |
| Creates a new subscription for a subscriber. This needs to be authorized by the client/vendor who created the subscriber and the vendor who publishes the event. | [create-subscription-for-development-events](#create-subscription-for-development-events) |
| Returns information about a particular subscription. Both, the vendor who created the subscriber and the vendor who publishes the event can retrieve this resource with appropriate authorization. | [get-subscription-for-development-events](#get-subscription-for-development-events) |
| Updates the mutable properties of a subscription. This needs to be authorized by the client/vendor who created the subscriber and the vendor who publishes the event. The subscriberId cannot be updated. | [set-subscription-for-development-events](#set-subscription-for-development-events) |
| Deletes a particular subscription. Both, the vendor who created the subscriber and the vendor who publishes the event can delete this resource with appropriate authorization. | [delete-subscription-for-development-events](#delete-subscription-for-development-events) |
| Generates preSigned urls to upload data. | [generate-catalog-upload-url](#generate-catalog-upload-url) |
| Creates a new upload for a catalog and returns location to track the upload process. | [create-catalog-upload](#create-catalog-upload) |
| Get the list of in-skill products for the vendor. | [get-isp-list-for-vendor](#get-isp-list-for-vendor) |
| Creates a new in-skill product for given vendorId. | [create-isp-for-vendor](#create-isp-for-vendor) |
| Get the list of in-skill products for the skillId. | [get-isp-list-for-skill-id](#get-isp-list-for-skill-id) |
| Returns the in-skill product definition for given productId. | [get-isp-definition](#get-isp-definition) |
| Updates in-skill product definition for given productId. Only development stage supported. | [update-isp-for-product](#update-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. | [delete-isp-for-product](#delete-isp-for-product) |
| Get the summary information for an in-skill product. | [get-isp-summary](#get-isp-summary) |
| Get the associated skills for the in-skill product. | [get-isp-associated-skills](#get-isp-associated-skills) |
| Associates an in-skill product with a skill. | [associate-isp-with-skill](#associate-isp-with-skill) |
| Disassociates an in-skill product from a skill. | [disassociate-isp-with-skill](#disassociate-isp-with-skill) |
| Resets the entitlement(s) of the Product for the current user. | [reset-entitlement-for-product](#reset-entitlement-for-product) |
| Get AccountLinking information for the skill. | [get-account-linking-info](#get-account-linking-info) |
| Create AccountLinking information for the skill. | [update-account-linking-info](#update-account-linking-info) |
| Delete AccountLinking information of a skill for the given stage. | [delete-account-linking-info](#delete-account-linking-info) |
| Generates hosted skill repository credentials to access the hosted skill repository. | [generate-credentials-for-alexa-hosted-skill](#generate-credentials-for-alexa-hosted-skill) |
| Get Alexa hosted skill's metadata. | [get-alexa-hosted-skill-metadata](#get-alexa-hosted-skill-metadata) |
| Get the current user permissions about Alexa hosted skill features. | [get-alexa-hosted-skill-user-permissions](#get-alexa-hosted-skill-user-permissions) |
| Get beta test for a given Alexa skill. | [get-beta-test](#get-beta-test) |
| Create a beta test for a given Alexa skill. | [create-beta-test](#create-beta-test) |
| Update a beta test for a given Alexa skill. | [update-beta-test](#update-beta-test) |
| Start a beta test for a given Alexa skill. System will send invitation emails to each tester in the test, and add entitlement on the acceptance. | [start-beta-test](#start-beta-test) |
| End a beta test for a given Alexa skill. System will revoke the entitlement of each tester and send access-end notification email to them. | [end-beta-test](#end-beta-test) |
| List all testers in a beta test for the given Alexa skill. | [get-list-of-testers](#get-list-of-testers) |
| Add testers to a beta test for the given Alexa skill.  System will send invitation email to each tester and add entitlement on the acceptance. | [add-testers-to-beta-test](#add-testers-to-beta-test) |
| Remove testers from a beta test for the given Alexa skill.  System will send access end email to each tester and remove entitlement for them. | [remove-testers-from-beta-test](#remove-testers-from-beta-test) |
| Send reminder to the testers in a beta test for the given Alexa skill.  System will send invitation email to each tester and add entitlement on the acceptance. | [send-reminder-to-testers](#send-reminder-to-testers) |
| Request feedback from the testers in a beta test for the given Alexa skill.  System will send notification emails to testers to request feedback. | [request-feedback-from-testers](#request-feedback-from-testers) |
| 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. | [get-certifications-list](#get-certifications-list) |
| 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 will return a 404 HTTP status code. | [get-certification-review](#get-certification-review) |
| Checks whether an enablement exist for given skillId/stage and customerId (retrieved from Auth token). | [get-skill-enablement-status](#get-skill-enablement-status) |
| Creates/Updates the enablement for given skillId/stage and customerId (retrieved from Auth token). | [set-skill-enablement](#set-skill-enablement) |
| Deletes the enablement for given skillId/stage and customerId (retrieved from Auth token). | [delete-skill-enablement](#delete-skill-enablement) |
| This is a synchronous API that profiles an utterance against interaction model. | [profile-nlu](#profile-nlu) |
|  | [get-utterance-data](#get-utterance-data) |
| Gets the `InteractionModel` for the skill in the given stage.
The path params 
**skillId**, **stage** and **locale** are required. | [get-interaction-model](#get-interaction-model) |
| Get the latest metadata for the interaction model resource for the given stage. | [get-interaction-model-metadata](#get-interaction-model-metadata) |
| Creates an `InteractionModel` for the skill. | [set-interaction-model](#set-interaction-model) |
| List all catalogs for the vendor. | [list-interaction-model-catalogs](#list-interaction-model-catalogs) |
| Create a new version of catalog within the given catalogId. | [create-interaction-model-catalog](#create-interaction-model-catalog) |
| get the catalog definition. | [get-interaction-model-catalog-definition](#get-interaction-model-catalog-definition) |
| Delete the catalog. | [delete-interaction-model-catalog](#delete-interaction-model-catalog) |
| Get the status of catalog resource and its sub-resources for a given catalogId. | [get-interaction-model-catalog-update-status](#get-interaction-model-catalog-update-status) |
| update description and vendorGuidance string for certain version of a catalog. | [update-interaction-model-catalog](#update-interaction-model-catalog) |
| This API returns the job status of conflict detection job for a specified interaction model. | [get-conflict-detection-job-status-for-interaction-model](#get-conflict-detection-job-status-for-interaction-model) |
| This is a paginated API that retrieves results of conflict detection job for a specified interaction model. | [get-conflicts-for-interaction-model](#get-conflicts-for-interaction-model) |
| List all the historical versions of the given catalogId. | [list-interaction-model-catalog-versions](#list-interaction-model-catalog-versions) |
| Create a new version of catalog entity for the given catalogId. | [create-interaction-model-catalog-version](#create-interaction-model-catalog-version) |
| Get catalog version data of given catalog version. | [get-interaction-model-catalog-version](#get-interaction-model-catalog-version) |
| Delete catalog version. | [delete-interaction-model-catalog-version](#delete-interaction-model-catalog-version) |
| Update description and vendorGuidance string for certain version of a catalog. | [update-interaction-model-catalog-version](#update-interaction-model-catalog-version) |
| Get catalog values from the given catalogId & version. | [get-interaction-model-catalog-values](#get-interaction-model-catalog-values) |
| Gets the specified version `InteractionModel` of a skill for the vendor. Use `~current` as version parameter to get the current version model. | [get-interaction-model-version](#get-interaction-model-version) |
| Get the list of interactionModel versions of a skill for the vendor. | [list-interaction-model-versions](#list-interaction-model-versions) |
| List all slot types for the vendor. | [list-interaction-model-slot-types](#list-interaction-model-slot-types) |
| Create a new version of slot type within the given slotTypeId. | [create-interaction-model-slot-type](#create-interaction-model-slot-type) |
| Get the slot type definition. | [get-interaction-model-slot-type-definition](#get-interaction-model-slot-type-definition) |
| Delete the slot type. | [delete-interaction-model-slot-type](#delete-interaction-model-slot-type) |
| Get the status of slot type resource and its sub-resources for a given slotTypeId. | [get-interaction-model-slot-type-build-status](#get-interaction-model-slot-type-build-status) |
| Update description and vendorGuidance string for certain version of a slot type. | [update-interaction-model-slot-type](#update-interaction-model-slot-type) |
| List all slot type versions for the slot type id. | [list-interaction-model-slot-type-versions](#list-interaction-model-slot-type-versions) |
| Create a new version of slot type entity for the given slotTypeId. | [create-interaction-model-slot-type-version](#create-interaction-model-slot-type-version) |
| Get slot type version data of given slot type version. | [get-interaction-model-slot-type-version](#get-interaction-model-slot-type-version) |
| Delete slot type version. | [delete-interaction-model-slot-type-version](#delete-interaction-model-slot-type-version) |
| Update description and vendorGuidance string for certain version of a slot type. | [update-interaction-model-slot-type-version](#update-interaction-model-slot-type-version) |
| This is a synchronous API that invokes the Lambda or third party HTTPS endpoint for a given skill. A successful response will contain information related to what endpoint was called, payload sent to and received from the endpoint. In cases where requests to this API results in an error, the response will contain an error code and a description of the problem. In cases where invoking the skill endpoint specifically fails, the response will contain a status attribute indicating that a failure occurred and details about what was sent to the endpoint. The skill must belong to and be enabled by the user of this API. Also, note that calls to the skill endpoint will timeout after 10 seconds. | [invoke-skill](#invoke-skill) |
| Returns the skill manifest for given skillId and stage. | [get-skill-manifest](#get-skill-manifest) |
| Updates skill manifest for given skillId and stage. | [update-skill-manifest](#update-skill-manifest) |
| Get analytic metrics report of skill usage. | [get-skill-metrics](#get-skill-metrics) |
| Add an id to the private distribution accounts. | [set-private-distribution-account-id](#set-private-distribution-account-id) |
| Remove an id from the private distribution accounts. | [delete-private-distribution-account-id](#delete-private-distribution-account-id) |
| List private distribution accounts. | [list-private-distribution-accounts](#list-private-distribution-accounts) |
| 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 will contain a header with the location of the simulation resource. In cases where requests to this API results in an error, the response will contain 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. | [simulate-skill](#simulate-skill) |
| This API gets the result of a previously executed simulation. A successful response will contain the status of the executed simulation. If the simulation successfully completed, the response will also contain information related to skill invocation. In cases where requests to this API results in an error, the response will contain an error code and a description of the problem. In cases where the simulation failed, the response will contain a status attribute indicating that a failure occurred and details about what was sent to the skill endpoint. Note that simulation results are stored for 10 minutes. A request for an expired simulation result will return a 404 HTTP status code. | [get-skill-simulation](#get-skill-simulation) |
| This is an asynchronous API which allows a skill developer to execute various validations against their skill. | [submit-skill-validation](#submit-skill-validation) |
| This API gets the result of a previously executed validation. A successful response will contain the status of the executed validation. If the validation successfully completed, the response will also contain information related to executed validations. In cases where requests to this API results in an error, the response will contain a description of the problem. In cases where the validation failed, the response will contain a status attribute indicating that a failure occurred. Note that validation results are stored for 60 minutes. A request for an expired validation result will return a 404 HTTP status code. | [get-skill-validations](#get-skill-validations) |
| Get the list of skills for the vendor. | [list-skills-for-vendor](#list-skills-for-vendor) |
| Creates a new skill for given vendorId. | [create-skill-for-vendor](#create-skill-for-vendor) |
| Delete the skill and model for given skillId. | [delete-skill](#delete-skill) |
| Get the status of skill resource and its sub-resources for a given skillId. | [get-skill-status](#get-skill-status) |
| Get the client credentials for the skill. | [get-skill-credentials](#get-skill-credentials) |
| Returns 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. | [get-ssl-certificates](#get-ssl-certificates) |
| Updates the ssl certificates associated with this skill. | [set-ssl-certificates](#set-ssl-certificates) |
| Submit the skill for certification. | [submit-skill-for-certification](#submit-skill-for-certification) |
| Withdraws the skill from certification. | [withdraw-skill-from-certification](#withdraw-skill-from-certification) |
| Creates a new export for a skill with given skillId and stage. | [create-export-request-for-skill](#create-export-request-for-skill) |
| Get status for given exportId. | [get-status-of-export-request](#get-status-of-export-request) |
| Creates a new import for a skill. | [create-skill-package](#create-skill-package) |
| Creates a new import for a skill with given skillId. | [import-skill-package](#import-skill-package) |
| Get status for given importId. | [get-import-status](#get-import-status) |
| Creates a new uploadUrl. | [create-upload-url](#create-upload-url) |
| Get the list of Vendor information. | [get-vendor-list](#get-vendor-list) |
| 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. | [query-development-audit-logs](#query-development-audit-logs) |
| API which requests recently run nlu evaluations started by a vendor for a skill. Returns the evaluation id and some of the parameters used to start the evaluation. Developers can filter the results using locale and stage. Supports paging of results. | [list-nlu-evaluations](#list-nlu-evaluations) |
| This is an asynchronous API that starts an evaluation against the NLU model built by the skill's interaction model.
The operation outputs an evaluationId which allows the retrieval of the current status of the operation and the results upon completion. This operation is unified, meaning both internal and external skill developers may use it evaluate NLU models. | [create-nlu-evaluations](#create-nlu-evaluations) |
| API which requests top level information about the evaluation like the current state of the job, status of the evaluation (if complete). Also returns data used to start the job, like the number of test cases, stage, locale, and start time. This should be considered the 'cheap' operation while getResultForNLUEvaluations is 'expensive'. | [get-nlu-evaluation](#get-nlu-evaluation) |
| Paginated API which returns the test case results of an evaluation. This should be considered the 'expensive' operation while getNluEvaluation is 'cheap'. | [get-result-for-nlu-evaluations](#get-result-for-nlu-evaluations) |
| API which requests all the NLU annotation sets for a skill. Returns the annotationId and properties for each NLU annotation set. Developers can filter the results using locale. Supports paging of results. | [list-nlu-annotation-sets](#list-nlu-annotation-sets) |
| This is an API that creates a new NLU annotation set with properties and returns the annotationId. | [create-nlu-annotation-set](#create-nlu-annotation-set) |
| Return the properties for an NLU annotation set. | [get-properties-for-nlu-annotation-sets](#get-properties-for-nlu-annotation-sets) |
| API which updates the NLU annotation set properties. Currently, the only data can be updated is annotation set name. | [update-properties-for-nlu-annotation-sets](#update-properties-for-nlu-annotation-sets) |
| API which deletes the NLU annotation set. Developers cannot get/list the deleted annotation set. | [delete-properties-for-nlu-annotation-sets](#delete-properties-for-nlu-annotation-sets) |
|  | [get-annotations-for-nlu-annotation-sets](#get-annotations-for-nlu-annotation-sets) |
| API which replaces the annotations in NLU annotation set. | [update-annotations-for-nlu-annotation-sets](#update-annotations-for-nlu-annotation-sets) |
| API which requests all the ASR annotation sets for a skill. Returns the annotation set id and properties for each ASR annotation set. Supports paging of results. | [list-asr-annotation-sets](#list-asr-annotation-sets) |
| This is an API that creates a new ASR annotation set with a name and returns the annotationSetId which can later be used to retrieve or reference the annotation set. | [create-asr-annotation-set](#create-asr-annotation-set) |
| Return the metadata for an ASR annotation set. | [get-asr-annotation-set](#get-asr-annotation-set) |
| API which updates the ASR annotation set properties. Currently, the only data can be updated is annotation set name. | [set-asr-annotation-set](#set-asr-annotation-set) |
| API which deletes the ASR annotation set. Developers cannot get/list the deleted annotation set. | [delete-asr-annotation-set](#delete-asr-annotation-set) |
|  | [get-annotations-for-asr-annotation-set](#get-annotations-for-asr-annotation-set) |
| API that updates the annotaions in the annotation set. | [set-annotations-for-asr-annotation-set](#set-annotations-for-asr-annotation-set) |
| API that allows developers to get historical ASR evaluations they run before. | [list-asr-evaluations](#list-asr-evaluations) |
| This is an asynchronous API that starts an evaluation against the ASR model built by the skill's interaction model. The operation outputs an evaluationId which allows the retrieval of the current status of the operation and the results upon completion. This operation is unified, meaning both internal and external skill developers may use it to evaluate ASR models. | [create-asr-evaluation](#create-asr-evaluation) |
| API which requests high level information about the evaluation like the current state of the job, status of the evaluation (if complete). Also returns the request used to start the job, like the number of total evaluations, number of completed evaluations, and start time. This should be considered the "cheap" operation while GetAsrEvaluationsResults is "expensive". | [get-asr-evaluation-status](#get-asr-evaluation-status) |
| API which enables the deletion of an evaluation. | [delete-asr-evaluation](#delete-asr-evaluation) |
| Paginated API which returns the test case results of an evaluation. This should be considered the "expensive" operation while GetAsrEvaluationsStatus is "cheap". | [list-asr-evaluations-results](#list-asr-evaluations-results) |
| This is a synchronous API that invokes the Lambda or third party HTTPS endpoint for a given skill. A successful response will contain information related to what endpoint was called, payload sent to and received from the endpoint. In cases where requests to this API results in an error, the response will contain an error code and a description of the problem. In cases where invoking the skill endpoint specifically fails, the response will contain a status attribute indicating that a failure occurred and details about what was sent to the endpoint. The skill must belong to and be enabled by the user of this API. Also,  note that calls to the skill endpoint will timeout after 10 seconds. This  API is currently designed in a way that allows extension to an asynchronous  API if a significantly bigger timeout is required. | [invoke-skill-end-point](#invoke-skill-end-point) |
| upload a file for the catalog. | [upload-catalog](#upload-catalog) |
| download the skill package to "skill-package" folder in current directory. | [export-package](#export-package) |
| Get the task definition details specified by the taskName and version. | [get-task](#get-task) |
| List the tasks summary information based on keywords or provider skillId. If both keywords and provider skillId are not specified, will list all the tasks summary information accessible by the skillId. | [search-task](#search-task) |

### list-catalogs-for-vendor

Lists catalogs associated with a vendor.

`list-catalogs-for-vendor` command format:

`$ ask smapi list-catalogs-for-vendor [--next-token <next-token>] [--max-results <max-results>] [-p| --profile <profile>] [--full-response] [--debug]`

**Options**

<dl>
    <dt>--next-token <next-token></dt>
    <dd markdown="span">[OPTIONAL] A token provided to continue returning results from a previous request which was partial.</dd>
    <dt>--max-results <max-results></dt>
    <dd markdown="span">[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 will never contain more. If there are additional results that satisfy the search criteria, but these results were not returned, the response contains isTruncated = true.</dd>
    <dt>-p, --profile <profile></dt>
    <dd markdown="span">Provides the ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.</dd>
    <dt>--full-response</dt>
    <dd markdown="span">Returns body, headers and status code of the response as one object.</dd>
    <dt>--debug</dt>
    <dd markdown="span">Enables the ASK CLI  to show debug messages in the output of the command.</dd>
</dl>

### create-catalog

Creates a new catalog based on information provided in the request.

`create-catalog` command format:

`$ ask smapi create-catalog <--title <title>> <--type <type>> <--usage <usage>> [-p| --profile <profile>] [--full-response] [--debug]`

**Options**

<dl>
    <dt>--title <title></dt>
    <dd markdown="span">[REQUIRED] Title of the catalog.</dd>
    <dt>--type <type></dt>
    <dd markdown="span">[REQUIRED] Type of catalog. 
[ENUM]: AMAZON.BroadcastChannel,AMAZON.Genre,AMAZON.MusicAlbum,AMAZON.MusicGroup,AMAZON.MusicPlaylist,AMAZON.MusicRecording,AMAZON.TerrestrialRadioChannel,AMAZON.AudioRecording.</dd>
    <dt>--usage <usage></dt>
    <dd markdown="span">[REQUIRED] Usage of the catalog. 
[ENUM]: AlexaMusic.Catalog.BroadcastChannel,AlexaMusic.Catalog.Genre,AlexaMusic.Catalog.MusicAlbum,AlexaMusic.Catalog.MusicGroup,AlexaMusic.Catalog.MusicPlaylist,AlexaMusic.Catalog.MusicRecording,AlexaMusic.Catalog.TerrestrialRadioChannel,AlexaTest.Catalog.AudioRecording.</dd>
    <dt>-p, --profile <profile></dt>
    <dd markdown="span">Provides the ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.</dd>
    <dt>--full-response</dt>
    <dd markdown="span">Returns body, headers and status code of the response as one object.</dd>
    <dt>--debug</dt>
    <dd markdown="span">Enables the ASK CLI  to show debug messages in the output of the command.</dd>
</dl>

### get-catalog

Returns information about a particular catalog.

`get-catalog` command format:

`$ ask smapi get-catalog <-c|--catalog-id <catalog-id>> [-p| --profile <profile>] [--full-response] [--debug]`

**Options**

<dl>
    <dt>-c,--catalog-id <catalog-id></dt>
    <dd markdown="span">[REQUIRED] Provides a unique identifier of the catalog.</dd>
    <dt>-p, --profile <profile></dt>
    <dd markdown="span">Provides the ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.</dd>
    <dt>--full-response</dt>
    <dd markdown="span">Returns body, headers and status code of the response as one object.</dd>
    <dt>--debug</dt>
    <dd markdown="span">Enables the ASK CLI  to show debug messages in the output of the command.</dd>
</dl>

### list-catalogs-for-skill

Lists all the catalogs associated with a skill.

`list-catalogs-for-skill` command format:

`$ ask smapi list-catalogs-for-skill [--next-token <next-token>] [--max-results <max-results>] <-s|--skill-id <skill-id>> [-p| --profile <profile>] [--full-response] [--debug]`

**Options**

<dl>
    <dt>--next-token <next-token></dt>
    <dd markdown="span">[OPTIONAL] A token provided to continue returning results from a previous request which was partial.</dd>
    <dt>--max-results <max-results></dt>
    <dd markdown="span">[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 will never contain more. If there are additional results that satisfy the search criteria, but these results were not returned, the response contains isTruncated = true.</dd>
    <dt>-s,--skill-id <skill-id></dt>
    <dd markdown="span">[REQUIRED] The skill ID.</dd>
    <dt>-p, --profile <profile></dt>
    <dd markdown="span">Provides the ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.</dd>
    <dt>--full-response</dt>
    <dd markdown="span">Returns body, headers and status code of the response as one object.</dd>
    <dt>--debug</dt>
    <dd markdown="span">Enables the ASK CLI  to show debug messages in the output of the command.</dd>
</dl>

### associate-catalog-with-skill

Associate skill with catalog.

`associate-catalog-with-skill` command format:

`$ ask smapi associate-catalog-with-skill <-s|--skill-id <skill-id>> <-c|--catalog-id <catalog-id>> [-p| --profile <profile>] [--full-response] [--debug]`

**Options**

<dl>
    <dt>-s,--skill-id <skill-id></dt>
    <dd markdown="span">[REQUIRED] The skill ID.</dd>
    <dt>-c,--catalog-id <catalog-id></dt>
    <dd markdown="span">[REQUIRED] Provides a unique identifier of the catalog.</dd>
    <dt>-p, --profile <profile></dt>
    <dd markdown="span">Provides the ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.</dd>
    <dt>--full-response</dt>
    <dd markdown="span">Returns body, headers and status code of the response as one object.</dd>
    <dt>--debug</dt>
    <dd markdown="span">Enables the ASK CLI  to show debug messages in the output of the command.</dd>
</dl>

### list-uploads-for-catalog

Lists all the uploads for a particular catalog.

`list-uploads-for-catalog` command format:

`$ ask smapi list-uploads-for-catalog [--next-token <next-token>] [--max-results <max-results>] <-c|--catalog-id <catalog-id>> [-p| --profile <profile>] [--full-response] [--debug]`

**Options**

<dl>
    <dt>--next-token <next-token></dt>
    <dd markdown="span">[OPTIONAL] A token provided to continue returning results from a previous request which was partial.</dd>
    <dt>--max-results <max-results></dt>
    <dd markdown="span">[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 will never contain more. If there are additional results that satisfy the search criteria, but these results were not returned, the response contains isTruncated = true.</dd>
    <dt>-c,--catalog-id <catalog-id></dt>
    <dd markdown="span">[REQUIRED] Provides a unique identifier of the catalog.</dd>
    <dt>-p, --profile <profile></dt>
    <dd markdown="span">Provides the ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.</dd>
    <dt>--full-response</dt>
    <dd markdown="span">Returns body, headers and status code of the response as one object.</dd>
    <dt>--debug</dt>
    <dd markdown="span">Enables the ASK CLI  to show debug messages in the output of the command.</dd>
</dl>

### create-content-upload

Creates a new upload for a catalog and returns presigned upload parts for uploading the file.

`create-content-upload` command format:

`$ ask smapi create-content-upload <-c|--catalog-id <catalog-id>> [--number-of-upload-parts <number-of-upload-parts>] [-p| --profile <profile>] [--full-response] [--debug]`

**Options**

<dl>
    <dt>-c,--catalog-id <catalog-id></dt>
    <dd markdown="span">[REQUIRED] Provides a unique identifier of the catalog.</dd>
    <dt>--number-of-upload-parts <number-of-upload-parts></dt>
    <dd markdown="span">[OPTIONAL] Provides the number of parts the file will be split into. An equal number of presigned upload urls are generated in response to facilitate each part's upload.</dd>
    <dt>-p, --profile <profile></dt>
    <dd markdown="span">Provides the ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.</dd>
    <dt>--full-response</dt>
    <dd markdown="span">Returns body, headers and status code of the response as one object.</dd>
    <dt>--debug</dt>
    <dd markdown="span">Enables the ASK CLI  to show debug messages in the output of the command.</dd>
</dl>

### get-content-upload-by-id

Gets detailed information about an upload which was created for a specific catalog. Includes the upload&#39;s ingestion steps and a url for downloading the file.

`get-content-upload-by-id` command format:

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

**Options**

<dl>
    <dt>-c,--catalog-id <catalog-id></dt>
    <dd markdown="span">[REQUIRED] Provides a unique identifier of the catalog.</dd>
    <dt>--upload-id <upload-id></dt>
    <dd markdown="span">[REQUIRED] Unique identifier of the upload.</dd>
    <dt>-p, --profile <profile></dt>
    <dd markdown="span">Provides the ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.</dd>
    <dt>--full-response</dt>
    <dd markdown="span">Returns body, headers and status code of the response as one object.</dd>
    <dt>--debug</dt>
    <dd markdown="span">Enables the ASK CLI  to show debug messages in the output of the command.</dd>
</dl>

### complete-catalog-upload

Completes an upload. To be called after the file is uploaded to the backend data store using presigned url(s).

`complete-catalog-upload` command format:

`$ ask smapi complete-catalog-upload <-c|--catalog-id <catalog-id>> <--upload-id <upload-id>> [--part-e-tags <part-e-tags>] [-p| --profile <profile>] [--full-response] [--debug]`

**Options**

<dl>
    <dt>-c,--catalog-id <catalog-id></dt>
    <dd markdown="span">[REQUIRED] Provides a unique identifier of the catalog.</dd>
    <dt>--upload-id <upload-id></dt>
    <dd markdown="span">[REQUIRED] Unique identifier of the upload.</dd>
    <dt>--part-e-tags <part-e-tags></dt>
    <dd markdown="span">[OPTIONAL] List of (eTag, part number) pairs for each part of the file uploaded. 
[JSON]: JSON string or a file. Example: "$(cat {filePath})" or "file:{filePath}", either absolute or relative path are supported.</dd>
    <dt>-p, --profile <profile></dt>
    <dd markdown="span">Provides the ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.</dd>
    <dt>--full-response</dt>
    <dd markdown="span">Returns body, headers and status code of the response as one object.</dd>
    <dt>--debug</dt>
    <dd markdown="span">Enables the ASK CLI  to show debug messages in the output of the command.</dd>
</dl>

### list-subscribers-for-development-events

Lists the subscribers for a particular vendor.

`list-subscribers-for-development-events` command format:

`$ ask smapi list-subscribers-for-development-events [--next-token <next-token>] [--max-results <max-results>] [-p| --profile <profile>] [--full-response] [--debug]`

**Options**

<dl>
    <dt>--next-token <next-token></dt>
    <dd markdown="span">[OPTIONAL] A token provided to continue returning results from a previous request which was partial.</dd>
    <dt>--max-results <max-results></dt>
    <dd markdown="span">[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 will never contain more. If there are additional results that satisfy the search criteria, but these results were not returned, the response contains isTruncated = true.</dd>
    <dt>-p, --profile <profile></dt>
    <dd markdown="span">Provides the ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.</dd>
    <dt>--full-response</dt>
    <dd markdown="span">Returns body, headers and status code of the response as one object.</dd>
    <dt>--debug</dt>
    <dd markdown="span">Enables the ASK CLI  to show debug messages in the output of the command.</dd>
</dl>

### create-subscriber-for-development-events

Creates a new subscriber resource for a vendor.

`create-subscriber-for-development-events` command format:

`$ ask smapi create-subscriber-for-development-events <--create-subscriber-request <create-subscriber-request>> [-p| --profile <profile>] [--full-response] [--debug]`

**Options**

<dl>
    <dt>--create-subscriber-request <create-subscriber-request></dt>
    <dd markdown="span">[REQUIRED] Defines the request body for createSubscriber API. 
[JSON]: JSON string or a file. Example: "$(cat {filePath})" or "file:{filePath}", either absolute or relative path are supported.</dd>
    <dt>-p, --profile <profile></dt>
    <dd markdown="span">Provides the ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.</dd>
    <dt>--full-response</dt>
    <dd markdown="span">Returns body, headers and status code of the response as one object.</dd>
    <dt>--debug</dt>
    <dd markdown="span">Enables the ASK CLI  to show debug messages in the output of the command.</dd>
</dl>

### get-subscriber-for-development-events

Returns information about specified subscriber.

`get-subscriber-for-development-events` command format:

`$ ask smapi get-subscriber-for-development-events <--subscriber-id <subscriber-id>> [-p| --profile <profile>] [--full-response] [--debug]`

**Options**

<dl>
    <dt>--subscriber-id <subscriber-id></dt>
    <dd markdown="span">[REQUIRED] Unique identifier of the subscriber.</dd>
    <dt>-p, --profile <profile></dt>
    <dd markdown="span">Provides the ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.</dd>
    <dt>--full-response</dt>
    <dd markdown="span">Returns body, headers and status code of the response as one object.</dd>
    <dt>--debug</dt>
    <dd markdown="span">Enables the ASK CLI  to show debug messages in the output of the command.</dd>
</dl>

### set-subscriber-for-development-events

Updates the properties of a subscriber.

`set-subscriber-for-development-events` command format:

`$ ask smapi set-subscriber-for-development-events <--subscriber-id <subscriber-id>> <--update-subscriber-request <update-subscriber-request>> [-p| --profile <profile>] [--full-response] [--debug]`

**Options**

<dl>
    <dt>--subscriber-id <subscriber-id></dt>
    <dd markdown="span">[REQUIRED] Unique identifier of the subscriber.</dd>
    <dt>--update-subscriber-request <update-subscriber-request></dt>
    <dd markdown="span">[REQUIRED] Defines the request body for updateSubscriber API. 
[JSON]: JSON string or a file. Example: "$(cat {filePath})" or "file:{filePath}", either absolute or relative path are supported.</dd>
    <dt>-p, --profile <profile></dt>
    <dd markdown="span">Provides the ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.</dd>
    <dt>--full-response</dt>
    <dd markdown="span">Returns body, headers and status code of the response as one object.</dd>
    <dt>--debug</dt>
    <dd markdown="span">Enables the ASK CLI  to show debug messages in the output of the command.</dd>
</dl>

### delete-subscriber-for-development-events

Deletes a specified subscriber.

`delete-subscriber-for-development-events` command format:

`$ ask smapi delete-subscriber-for-development-events <--subscriber-id <subscriber-id>> [-p| --profile <profile>] [--full-response] [--debug]`

**Options**

<dl>
    <dt>--subscriber-id <subscriber-id></dt>
    <dd markdown="span">[REQUIRED] Unique identifier of the subscriber.</dd>
    <dt>-p, --profile <profile></dt>
    <dd markdown="span">Provides the ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.</dd>
    <dt>--full-response</dt>
    <dd markdown="span">Returns body, headers and status code of the response as one object.</dd>
    <dt>--debug</dt>
    <dd markdown="span">Enables the ASK CLI  to show debug messages in the output of the command.</dd>
</dl>

### list-subscriptions-for-development-events

Lists all the subscriptions for a vendor&#x2F;subscriber depending on the query parameter.

`list-subscriptions-for-development-events` command format:

`$ ask smapi list-subscriptions-for-development-events [--next-token <next-token>] [--max-results <max-results>] [--subscriber-id <subscriber-id>] [-p| --profile <profile>] [--full-response] [--debug]`

**Options**

<dl>
    <dt>--next-token <next-token></dt>
    <dd markdown="span">[OPTIONAL] A token provided to continue returning results from a previous request which was partial.</dd>
    <dt>--max-results <max-results></dt>
    <dd markdown="span">[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 will never contain more. If there are additional results that satisfy the search criteria, but these results were not returned, the response contains isTruncated = true.</dd>
    <dt>--subscriber-id <subscriber-id></dt>
    <dd markdown="span">[OPTIONAL] Unique identifier of the subscriber. If this query parameter is provided, the list would be filtered by the owning subscriberId.</dd>
    <dt>-p, --profile <profile></dt>
    <dd markdown="span">Provides the ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.</dd>
    <dt>--full-response</dt>
    <dd markdown="span">Returns body, headers and status code of the response as one object.</dd>
    <dt>--debug</dt>
    <dd markdown="span">Enables the ASK CLI  to show debug messages in the output of the command.</dd>
</dl>

### create-subscription-for-development-events

Creates a new subscription for a subscriber. This needs to be authorized by the client&#x2F;vendor who created the subscriber and the vendor who publishes the event.

`create-subscription-for-development-events` command format:

`$ ask smapi create-subscription-for-development-events <--name <name>> <--events <events>> <--subscriber-id <subscriber-id>> [-p| --profile <profile>] [--full-response] [--debug]`

**Options**

<dl>
    <dt>--name <name></dt>
    <dd markdown="span">[REQUIRED] Name of the subscription.</dd>
    <dt>--events <events></dt>
    <dd markdown="span">[REQUIRED] The list of events that the subscriber should be notified for. 
[MULTIPLE]: Values can be separated by comma.</dd>
    <dt>--subscriber-id <subscriber-id></dt>
    <dd markdown="span">[REQUIRED] The id of the subscriber that would receive the events.</dd>
    <dt>-p, --profile <profile></dt>
    <dd markdown="span">Provides the ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.</dd>
    <dt>--full-response</dt>
    <dd markdown="span">Returns body, headers and status code of the response as one object.</dd>
    <dt>--debug</dt>
    <dd markdown="span">Enables the ASK CLI  to show debug messages in the output of the command.</dd>
</dl>

### get-subscription-for-development-events

Returns information about a particular subscription. Both, the vendor who created the subscriber and the vendor who publishes the event can retrieve this resource with appropriate authorization.

`get-subscription-for-development-events` command format:

`$ ask smapi get-subscription-for-development-events <--subscription-id <subscription-id>> [-p| --profile <profile>] [--full-response] [--debug]`

**Options**

<dl>
    <dt>--subscription-id <subscription-id></dt>
    <dd markdown="span">[REQUIRED] Unique identifier of the subscription.</dd>
    <dt>-p, --profile <profile></dt>
    <dd markdown="span">Provides the ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.</dd>
    <dt>--full-response</dt>
    <dd markdown="span">Returns body, headers and status code of the response as one object.</dd>
    <dt>--debug</dt>
    <dd markdown="span">Enables the ASK CLI  to show debug messages in the output of the command.</dd>
</dl>

### set-subscription-for-development-events

Updates the mutable properties of a subscription. This needs to be authorized by the client&#x2F;vendor who created the subscriber and the vendor who publishes the event. The subscriberId cannot be updated.

`set-subscription-for-development-events` command format:

`$ ask smapi set-subscription-for-development-events <--subscription-id <subscription-id>> <--name <name>> <--events <events>> [-p| --profile <profile>] [--full-response] [--debug]`

**Options**

<dl>
    <dt>--subscription-id <subscription-id></dt>
    <dd markdown="span">[REQUIRED] Unique identifier of the subscription.</dd>
    <dt>--name <name></dt>
    <dd markdown="span">[REQUIRED] Name of the subscription.</dd>
    <dt>--events <events></dt>
    <dd markdown="span">[REQUIRED] The list of events that the subscriber should be notified for. 
[MULTIPLE]: Values can be separated by comma.</dd>
    <dt>-p, --profile <profile></dt>
    <dd markdown="span">Provides the ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.</dd>
    <dt>--full-response</dt>
    <dd markdown="span">Returns body, headers and status code of the response as one object.</dd>
    <dt>--debug</dt>
    <dd markdown="span">Enables the ASK CLI  to show debug messages in the output of the command.</dd>
</dl>

### delete-subscription-for-development-events

Deletes a particular subscription. Both, the vendor who created the subscriber and the vendor who publishes the event can delete this resource with appropriate authorization.

`delete-subscription-for-development-events` command format:

`$ ask smapi delete-subscription-for-development-events <--subscription-id <subscription-id>> [-p| --profile <profile>] [--full-response] [--debug]`

**Options**

<dl>
    <dt>--subscription-id <subscription-id></dt>
    <dd markdown="span">[REQUIRED] Unique identifier of the subscription.</dd>
    <dt>-p, --profile <profile></dt>
    <dd markdown="span">Provides the ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.</dd>
    <dt>--full-response</dt>
    <dd markdown="span">Returns body, headers and status code of the response as one object.</dd>
    <dt>--debug</dt>
    <dd markdown="span">Enables the ASK CLI  to show debug messages in the output of the command.</dd>
</dl>

### generate-catalog-upload-url

Generates preSigned urls to upload data.

`generate-catalog-upload-url` command format:

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

**Options**

<dl>
    <dt>-c,--catalog-id <catalog-id></dt>
    <dd markdown="span">[REQUIRED] Provides a unique identifier of the catalog.</dd>
    <dt>--number-of-upload-parts <number-of-upload-parts></dt>
    <dd markdown="span">[REQUIRED] Provides the number of parts the file will be split into. An equal number of presigned upload urls are generated in response to facilitate each part's upload.</dd>
    <dt>-p, --profile <profile></dt>
    <dd markdown="span">Provides the ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.</dd>
    <dt>--full-response</dt>
    <dd markdown="span">Returns body, headers and status code of the response as one object.</dd>
    <dt>--debug</dt>
    <dd markdown="span">Enables the ASK CLI  to show debug messages in the output of the command.</dd>
</dl>

### create-catalog-upload

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

`create-catalog-upload` command format:

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

**Options**

<dl>