ask_smapi_model.services.skill_management package¶

Submodules¶

Note

Canonical imports have been added in the __init__.py of the package. This helps in importing the class directly from the package, than through the module.

For eg: if package a has module b with class C, you can do from a import C instead of from a.b import C.

ask_smapi_model.services.skill_management.skill_management_service_client module¶

class ask_smapi_model.services.skill_management.skill_management_service_client.SkillManagementServiceClient(api_configuration, authentication_configuration, lwa_client=None, custom_user_agent=None)¶

Bases: ask_sdk_model_runtime.base_service_client.BaseServiceClient

ServiceClient for calling the SkillManagementService APIs.

Parameters:	api_configuration (ask_sdk_model_runtime.api_configuration.ApiConfiguration) – Instance of ApiConfiguration

add_testers_to_beta_test_v1(skill_id, testers_request, **kwargs)¶

Add testers to an existing beta test. 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.

Parameters:

skill_id (str) – (required) The skill ID.
testers_request (ask_smapi_model.v1.skill.beta_test.testers.testers_list.TestersList) – (required) JSON object containing the email address of beta testers.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, ErrorV1, BadRequestErrorV1]

associate_catalog_with_skill_v0(skill_id, catalog_id, **kwargs)¶

Associate skill with catalog.

Parameters:	skill_id (str) – (required) The skill ID. catalog_id (str) – (required) Provides a unique identifier of the catalog full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, ErrorV0, BadRequestErrorV0]

associate_isp_with_skill_v1(product_id, skill_id, **kwargs)¶

Associates an in-skill product with a skill.

Parameters:	product_id (str) – (required) The in-skill product ID. skill_id (str) – (required) The skill ID. full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, ErrorV1, BadRequestErrorV1]

clone_locale_v1(skill_id, stage_v2, clone_locale_request, **kwargs)¶

Creates a new clone locale workflow for a skill with given skillId, source locale, and target locales. In a single workflow, a locale can be cloned to multiple target locales. However, only one such workflow can be started at any time.

Parameters:

skill_id (str) – (required) The skill ID.
stage_v2 (str) – (required) Stages of a skill on which locales can be cloned. Currently only development stage is supported. * development - skills which are currently in development corresponds to this stage.
clone_locale_request (ask_smapi_model.v1.skill.clone_locale_request.CloneLocaleRequest) – (required) Defines the request body for the cloneLocale API.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, StandardizedErrorV1, BadRequestErrorV1]

complete_catalog_upload_v0(catalog_id, upload_id, complete_upload_request_payload, **kwargs)¶

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

Parameters:

catalog_id (str) – (required) Provides a unique identifier of the catalog
upload_id (str) – (required) Unique identifier of the upload
complete_upload_request_payload (ask_smapi_model.v0.catalog.upload.complete_upload_request.CompleteUploadRequest) – (required) Request payload to complete an upload.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, ErrorV0, BadRequestErrorV0]

create_asr_annotation_set_v1(skill_id, create_asr_annotation_set_request, **kwargs)¶

Create a new ASR annotation set for a skill 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

Parameters:

skill_id (str) – (required) The skill ID.
create_asr_annotation_set_request (ask_smapi_model.v1.skill.asr.annotation_sets.create_asr_annotation_set_request_object.CreateAsrAnnotationSetRequestObject) – (required) Payload sent to the create ASR annotation set API.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, ErrorV1, BadRequestErrorV1, CreateAsrAnnotationSetResponseV1]

create_asr_evaluation_v1(post_asr_evaluations_request, skill_id, **kwargs)¶

Start an evaluation against the ASR model built by the skill’s interaction model. 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.

Parameters:

post_asr_evaluations_request (ask_smapi_model.v1.skill.asr.evaluations.post_asr_evaluations_request_object.PostAsrEvaluationsRequestObject) – (required) Payload sent to trigger evaluation run.
skill_id (str) – (required) The skill ID.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, ErrorV1, PostAsrEvaluationsResponseObjectV1, BadRequestErrorV1]

create_beta_test_v1(skill_id, **kwargs)¶

Create beta test. Create a beta test for a given Alexa skill.

Parameters:

skill_id (str) – (required) The skill ID.
create_test_body (ask_smapi_model.v1.skill.beta_test.test_body.TestBody) – JSON object containing the details of a beta test used to create the test.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, ErrorV1, BadRequestErrorV1]

create_catalog_upload_v1(catalog_id, catalog_upload_request_body, **kwargs)¶

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

Parameters:

catalog_id (str) – (required) Provides a unique identifier of the catalog
catalog_upload_request_body (ask_smapi_model.v1.catalog.upload.catalog_upload_base.CatalogUploadBase) – (required) Provides the request body for create content upload
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, ErrorV1, BadRequestErrorV1]

create_catalog_v0(create_catalog_request, **kwargs)¶

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

Parameters:	create_catalog_request (ask_smapi_model.v0.catalog.create_catalog_request.CreateCatalogRequest) – (required) Defines the request body for createCatalog API. full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, ErrorV0, CatalogDetailsV0, BadRequestErrorV0]

create_content_upload_v0(catalog_id, create_content_upload_request, **kwargs)¶

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

Parameters:

catalog_id (str) – (required) Provides a unique identifier of the catalog
create_content_upload_request (ask_smapi_model.v0.catalog.upload.create_content_upload_request.CreateContentUploadRequest) – (required) Defines the request body for updateCatalog API.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, ErrorV0, CreateContentUploadResponseV0, BadRequestErrorV0]

create_export_request_for_skill_v1(skill_id, stage, **kwargs)¶

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

Parameters:	skill_id (str) – (required) The skill ID. stage (str) – (required) Stage for skill. full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, StandardizedErrorV1]

create_interaction_model_catalog_v1(catalog, **kwargs)¶

Create a new version of catalog within the given catalogId.

Parameters:	catalog (ask_smapi_model.v1.skill.interaction_model.catalog.definition_data.DefinitionData) – (required) full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, CatalogResponseV1, StandardizedErrorV1, BadRequestErrorV1]

create_interaction_model_catalog_version_v1(catalog_id, catalog, **kwargs)¶

Create a new version of catalog entity for the given catalogId.

Parameters:

catalog_id (str) – (required) Provides a unique identifier of the catalog
catalog (ask_smapi_model.v1.skill.interaction_model.version.version_data.VersionData) – (required)
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, StandardizedErrorV1, BadRequestErrorV1]

create_interaction_model_slot_type_v1(slot_type, **kwargs)¶

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

Parameters:	slot_type (ask_smapi_model.v1.skill.interaction_model.model_type.definition_data.DefinitionData) – (required) full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, StandardizedErrorV1, SlotTypeResponseV1, BadRequestErrorV1]

create_interaction_model_slot_type_version_v1(slot_type_id, slot_type, **kwargs)¶

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

Parameters:

slot_type_id (str) – (required) The identifier for a slot type.
slot_type (ask_smapi_model.v1.skill.interaction_model.type_version.version_data.VersionData) – (required)
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, StandardizedErrorV1, BadRequestErrorV1]

create_isp_for_vendor_v1(create_in_skill_product_request, **kwargs)¶

Creates a new in-skill product for given vendorId.

Parameters:

create_in_skill_product_request (ask_smapi_model.v1.isp.create_in_skill_product_request.CreateInSkillProductRequest) – (required) defines the request body for createInSkillProduct API.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, ProductResponseV1, ErrorV1, BadRequestErrorV1]

create_nlu_annotation_set_v1(skill_id, create_nlu_annotation_set_request, **kwargs)¶

Create a new NLU annotation set for a skill which will generate a new annotationId. This is an API that creates a new NLU annotation set with properties and returns the annotationId.

Parameters:

skill_id (str) – (required) The skill ID.
create_nlu_annotation_set_request (ask_smapi_model.v1.skill.nlu.annotation_sets.create_nlu_annotation_set_request.CreateNLUAnnotationSetRequest) – (required) Payload sent to the create NLU annotation set API.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, CreateNLUAnnotationSetResponseV1, ErrorV1, BadRequestErrorV1]

create_nlu_evaluations_v1(evaluate_nlu_request, skill_id, **kwargs)¶

Start an evaluation against the NLU model built by the skill’s interaction model. 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.

Parameters:

evaluate_nlu_request (ask_smapi_model.v1.skill.nlu.evaluations.evaluate_nlu_request.EvaluateNLURequest) – (required) Payload sent to the evaluate NLU API.
skill_id (str) – (required) The skill ID.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, EvaluateResponseV1, ErrorV1, BadRequestErrorV1]

create_skill_for_vendor_v1(create_skill_request, **kwargs)¶

Creates a new skill for given vendorId.

Parameters:	create_skill_request (ask_smapi_model.v1.skill.create_skill_request.CreateSkillRequest) – (required) Defines the request body for createSkill API. full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, StandardizedErrorV1, CreateSkillResponseV1, BadRequestErrorV1]

create_skill_package_v1(create_skill_with_package_request, **kwargs)¶

Creates a new import for a skill.

Parameters:

create_skill_with_package_request (ask_smapi_model.v1.skill.create_skill_with_package_request.CreateSkillWithPackageRequest) – (required) Defines the request body for createPackage API.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, StandardizedErrorV1, BadRequestErrorV1]

create_subscriber_for_development_events_v0(create_subscriber_request, **kwargs)¶

Creates a new subscriber resource for a vendor.

Parameters:

create_subscriber_request (ask_smapi_model.v0.development_events.subscriber.create_subscriber_request.CreateSubscriberRequest) – (required) Defines the request body for createSubscriber API.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, ErrorV0, BadRequestErrorV0]

create_subscription_for_development_events_v0(**kwargs)¶

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.

Parameters:

create_subscription_request (ask_smapi_model.v0.development_events.subscription.create_subscription_request.CreateSubscriptionRequest) – Request body for createSubscription API.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, ErrorV0, BadRequestErrorV0]

create_upload_url_v1(**kwargs)¶

Creates a new uploadUrl.

Parameters:	full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, StandardizedErrorV1, UploadResponseV1]

delete_account_linking_info_v1(skill_id, stage_v2, **kwargs)¶

Delete AccountLinking information of a skill for the given stage.

Parameters:

skill_id (str) – (required) The skill ID.
stage_v2 (str) – (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.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, StandardizedErrorV1, BadRequestErrorV1]

delete_asr_annotation_set_v1(skill_id, annotation_set_id, **kwargs)¶

Delete the ASR annotation set API which deletes the ASR annotation set. Developers cannot get/list the deleted annotation set.

Parameters:	skill_id (str) – (required) The skill ID. annotation_set_id (str) – (required) Identifier of the ASR annotation set. full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, ErrorV1, BadRequestErrorV1]

delete_asr_evaluation_v1(skill_id, evaluation_id, **kwargs)¶

Delete an evaluation. API which enables the deletion of an evaluation.

Parameters:	skill_id (str) – (required) The skill ID. evaluation_id (str) – (required) Identifier of the evaluation. full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, ErrorV1, BadRequestErrorV1]

delete_interaction_model_catalog_v1(catalog_id, **kwargs)¶

Delete the catalog.

Parameters:	catalog_id (str) – (required) Provides a unique identifier of the catalog full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, StandardizedErrorV1, BadRequestErrorV1]

delete_interaction_model_catalog_version_v1(catalog_id, version, **kwargs)¶

Delete catalog version.

Parameters:	catalog_id (str) – (required) Provides a unique identifier of the catalog version (str) – (required) Version for interaction model. full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, StandardizedErrorV1, BadRequestErrorV1]

delete_interaction_model_slot_type_v1(slot_type_id, **kwargs)¶

Delete the slot type.

Parameters:	slot_type_id (str) – (required) The identifier for a slot type. full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, StandardizedErrorV1, BadRequestErrorV1]

delete_interaction_model_slot_type_version_v1(slot_type_id, version, **kwargs)¶

Delete slot type version.

Parameters:	slot_type_id (str) – (required) The identifier for a slot type. version (str) – (required) Version for interaction model. full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, StandardizedErrorV1, BadRequestErrorV1]

delete_isp_for_product_v1(product_id, stage, **kwargs)¶

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.

Parameters:

product_id (str) – (required) The in-skill product ID.
stage (str) – (required) Stage for skill.
if_match (str) – Request header that specified an entity tag. The server will update the resource only if the eTag matches with the resource’s current eTag.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, ErrorV1, BadRequestErrorV1]

delete_private_distribution_account_id_v1(skill_id, stage, id, **kwargs)¶

Remove an id from the private distribution accounts.

Parameters:

skill_id (str) – (required) The skill ID.
stage (str) – (required) Stage for skill.
id (str) – (required) ARN that a skill can be privately distributed to.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, StandardizedErrorV1, BadRequestErrorV1]

delete_properties_for_nlu_annotation_sets_v1(skill_id, annotation_id, **kwargs)¶

Delete the NLU annotation set API which deletes the NLU annotation set. Developers cannot get/list the deleted annotation set.

Parameters:	skill_id (str) – (required) The skill ID. annotation_id (str) – (required) Identifier of the NLU annotation set. full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, ErrorV1, BadRequestErrorV1]

delete_skill_enablement_v1(skill_id, stage, **kwargs)¶

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

Parameters:	skill_id (str) – (required) The skill ID. stage (str) – (required) Stage for skill. full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, StandardizedErrorV1, BadRequestErrorV1]

delete_skill_v1(skill_id, **kwargs)¶

Delete the skill and model for given skillId.

Parameters:	skill_id (str) – (required) The skill ID. full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, StandardizedErrorV1, BadRequestErrorV1]

delete_subscriber_for_development_events_v0(subscriber_id, **kwargs)¶

Deletes a specified subscriber.

Parameters:	subscriber_id (str) – (required) Unique identifier of the subscriber. full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, ErrorV0, BadRequestErrorV0]

delete_subscription_for_development_events_v0(subscription_id, **kwargs)¶

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.

Parameters:	subscription_id (str) – (required) Unique identifier of the subscription. full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, ErrorV0, BadRequestErrorV0]

disassociate_isp_with_skill_v1(product_id, skill_id, **kwargs)¶

Disassociates an in-skill product from a skill.

Parameters:	product_id (str) – (required) The in-skill product ID. skill_id (str) – (required) The skill ID. full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, ErrorV1, BadRequestErrorV1]

end_beta_test_v1(skill_id, **kwargs)¶

End 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.

Parameters:	skill_id (str) – (required) The skill ID. full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, ErrorV1, BadRequestErrorV1]

generate_catalog_upload_url_v1(catalog_id, generate_catalog_upload_url_request_body, **kwargs)¶

Generates preSigned urls to upload data

Parameters:

catalog_id (str) – (required) Provides a unique identifier of the catalog
generate_catalog_upload_url_request_body (ask_smapi_model.v1.catalog.create_content_upload_url_request.CreateContentUploadUrlRequest) – (required) Request body to generate catalog upload url
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, ErrorV1, CreateContentUploadUrlResponseV1, BadRequestErrorV1]

generate_credentials_for_alexa_hosted_skill_v1(skill_id, hosted_skill_repository_credentials_request, **kwargs)¶

Generates hosted skill repository credentials to access the hosted skill repository.

Parameters:

skill_id (str) – (required) The skill ID.
hosted_skill_repository_credentials_request (ask_smapi_model.v1.skill.alexa_hosted.hosted_skill_repository_credentials_request.HostedSkillRepositoryCredentialsRequest) – (required) defines the request body for hosted skill repository credentials
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, HostedSkillRepositoryCredentialsListV1, StandardizedErrorV1, BadRequestErrorV1]

get_account_linking_info_v1(skill_id, stage_v2, **kwargs)¶

Get AccountLinking information for the skill.

Parameters:

skill_id (str) – (required) The skill ID.
stage_v2 (str) – (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.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, StandardizedErrorV1, AccountLinkingResponseV1, BadRequestErrorV1]

get_alexa_hosted_skill_metadata_v1(skill_id, **kwargs)¶

Get Alexa hosted skill’s metadata

Parameters:	skill_id (str) – (required) The skill ID. full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, StandardizedErrorV1, HostedSkillMetadataV1, BadRequestErrorV1]

get_alexa_hosted_skill_user_permissions_v1(vendor_id, permission, **kwargs)¶

Get the current user permissions about Alexa hosted skill features.

Parameters:	vendor_id (str) – (required) vendorId permission (str) – (required) The permission of a hosted skill feature that customer needs to check. full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, HostedSkillPermissionV1, StandardizedErrorV1, BadRequestErrorV1]

get_annotations_for_asr_annotation_set_v1(skill_id, annotation_set_id, accept, **kwargs)¶

Download the annotation set contents.

Parameters:

skill_id (str) – (required) The skill ID.
annotation_set_id (str) – (required) Identifier of the ASR annotation set.
accept (str) – (required) - application/json: indicate to download annotation set contents in JSON format - text/csv: indicate to download annotation set contents in CSV format
next_token (str) – 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 (float) – Sets the maximum number of results returned in the response body. Defaults to 1000. If more results are present, the response will contain a paginationContext.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, GetAsrAnnotationSetAnnotationsResponseV1, ErrorV1, BadRequestErrorV1]

get_annotations_for_nlu_annotation_sets_v1(skill_id, annotation_id, accept, **kwargs)¶

Get the annotations of an NLU annotation set

Parameters:

skill_id (str) – (required) The skill ID.
annotation_id (str) – (required) Identifier of the NLU annotation set.
accept (str) – (required) Standard HTTP. Pass application/json or test/csv for GET calls.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, ErrorV1, BadRequestErrorV1]

get_asr_annotation_set_v1(skill_id, annotation_set_id, **kwargs)¶

Get the metadata of an ASR annotation set Return the metadata for an ASR annotation set.

Parameters:	skill_id (str) – (required) The skill ID. annotation_set_id (str) – (required) Identifier of the ASR annotation set. full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, GetASRAnnotationSetsPropertiesResponseV1, ErrorV1, BadRequestErrorV1]

get_asr_evaluation_status_v1(skill_id, evaluation_id, **kwargs)¶

Get high level information and status of a 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”.

Parameters:	skill_id (str) – (required) The skill ID. evaluation_id (str) – (required) Identifier of the evaluation. full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, ErrorV1, BadRequestErrorV1, GetAsrEvaluationStatusResponseObjectV1]

get_beta_test_v1(skill_id, **kwargs)¶

Get beta test. Get beta test for a given Alexa skill.

Parameters:	skill_id (str) – (required) The skill ID. full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, ErrorV1, BadRequestErrorV1, BetaTestV1]

get_catalog_v0(catalog_id, **kwargs)¶

Returns information about a particular catalog.

Parameters:	catalog_id (str) – (required) Provides a unique identifier of the catalog full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, ErrorV0, CatalogDetailsV0, BadRequestErrorV0]

get_certification_review_v1(skill_id, certification_id, **kwargs)¶

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.

Parameters:

skill_id (str) – (required) The skill ID.
certification_id (str) – (required) Id of the certification. Reserved word identifier of mostRecent can be used to get the most recent certification for the skill. Note that the behavior of the API in this case would be the same as when the actual certification id of the most recent certification is used in the request.
accept_language (str) – User’s locale/language in context.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, CertificationResponseV1, ErrorV1]

get_certifications_list_v1(skill_id, **kwargs)¶

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.

Parameters:

skill_id (str) – (required) The skill ID.
next_token (str) – 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 (float) – 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.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, ErrorV1, ListCertificationsResponseV1, BadRequestErrorV1]

get_clone_locale_status_v1(skill_id, stage_v2, clone_locale_request_id, **kwargs)¶

Returns the status of a clone locale workflow associated with the unique identifier of cloneLocaleRequestId.

Parameters:

skill_id (str) – (required) The skill ID.
stage_v2 (str) – (required) Stages of a skill on which locales can be cloned. Currently only development stage is supported. * development - skills which are currently in development corresponds to this stage.
clone_locale_request_id (str) – (required) Defines the identifier for a clone locale workflow. If set to ~latest, request returns the status of the latest clone locale workflow.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, StandardizedErrorV1, CloneLocaleStatusResponseV1, BadRequestErrorV1]

get_conflict_detection_job_status_for_interaction_model_v1(skill_id, locale, stage, version, **kwargs)¶

Retrieve conflict detection job status for skill. This API returns the job status of conflict detection job for a specified interaction model.

Parameters:

skill_id (str) – (required) The skill ID.
locale (str) – (required) The locale for the model requested e.g. en-GB, en-US, de-DE.
stage (str) – (required) Stage of the interaction model.
version (str) – (required) Version of interaction model. Use “~current” to get the model of the current version.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, StandardizedErrorV1, GetConflictDetectionJobStatusResponseV1, BadRequestErrorV1]

get_conflicts_for_interaction_model_v1(skill_id, locale, stage, version, **kwargs)¶

Retrieve conflict detection results for a specified interaction model. This is a paginated API that retrieves results of conflict detection job for a specified interaction model.

Parameters:

skill_id (str) – (required) The skill ID.
locale (str) – (required) The locale for the model requested e.g. en-GB, en-US, de-DE.
stage (str) – (required) Stage of the interaction model.
version (str) – (required) Version of interaction model. Use “~current” to get the model of the current version.
next_token (str) – 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 (float) – Sets the maximum number of results returned in the response body. Defaults to 100. If more results are present, the response will contain a nextToken and a _link.next href.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, StandardizedErrorV1, GetConflictsResponseV1, BadRequestErrorV1]

get_content_upload_by_id_v0(catalog_id, upload_id, **kwargs)¶

Gets detailed information about an upload which was created for a specific catalog. Includes the upload’s ingestion steps and a presigned url for downloading the file.

Parameters:	catalog_id (str) – (required) Provides a unique identifier of the catalog upload_id (str) – (required) Unique identifier of the upload full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, ErrorV0, GetContentUploadResponseV0, BadRequestErrorV0]

get_content_upload_by_id_v1(catalog_id, upload_id, **kwargs)¶

Get 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.

Parameters:	catalog_id (str) – (required) Provides a unique identifier of the catalog upload_id (str) – (required) Unique identifier of the upload full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, ErrorV1, GetContentUploadResponseV1, BadRequestErrorV1]

get_import_status_v1(import_id, **kwargs)¶

Get status for given importId.

Parameters:	import_id (str) – (required) The Import ID. full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, StandardizedErrorV1, ImportResponseV1]

get_interaction_model_catalog_definition_v1(catalog_id, **kwargs)¶

get the catalog definition

Parameters:	catalog_id (str) – (required) Provides a unique identifier of the catalog full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, StandardizedErrorV1, CatalogDefinitionOutputV1, BadRequestErrorV1]

get_interaction_model_catalog_update_status_v1(catalog_id, update_request_id, **kwargs)¶

Get the status of catalog resource and its sub-resources for a given catalogId.

Parameters:

catalog_id (str) – (required) Provides a unique identifier of the catalog
update_request_id (str) – (required) The identifier for slotType version creation process
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, CatalogStatusV1, StandardizedErrorV1, BadRequestErrorV1]

get_interaction_model_catalog_values_v1(catalog_id, version, **kwargs)¶

Get catalog values from the given catalogId & version.

Parameters:

catalog_id (str) – (required) Provides a unique identifier of the catalog
version (str) – (required) Version for interaction model.
max_results (float) – 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.
next_token (str) – 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.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, StandardizedErrorV1, CatalogValuesV1, BadRequestErrorV1]

get_interaction_model_catalog_version_v1(catalog_id, version, **kwargs)¶

Get catalog version data of given catalog version.

Parameters:	catalog_id (str) – (required) Provides a unique identifier of the catalog version (str) – (required) Version for interaction model. full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, StandardizedErrorV1, CatalogVersionDataV1, BadRequestErrorV1]

get_interaction_model_metadata_v1(skill_id, stage_v2, locale, **kwargs)¶

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

Parameters:

skill_id (str) – (required) The skill ID.
stage_v2 (str) – (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 (str) – (required) The locale for the model requested e.g. en-GB, en-US, de-DE.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, StandardizedErrorV1, BadRequestErrorV1]

get_interaction_model_slot_type_build_status_v1(slot_type_id, update_request_id, **kwargs)¶

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

Parameters:	slot_type_id (str) – (required) The identifier for a slot type. update_request_id (str) – (required) The identifier for slotType version creation process full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, StandardizedErrorV1, SlotTypeStatusV1, BadRequestErrorV1]

get_interaction_model_slot_type_definition_v1(slot_type_id, **kwargs)¶

Get the slot type definition.

Parameters:	slot_type_id (str) – (required) The identifier for a slot type. full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, StandardizedErrorV1, SlotTypeDefinitionOutputV1, BadRequestErrorV1]

get_interaction_model_slot_type_version_v1(slot_type_id, version, **kwargs)¶

Get slot type version data of given slot type version.

Parameters:	slot_type_id (str) – (required) The identifier for a slot type. version (str) – (required) Version for interaction model. full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, StandardizedErrorV1, SlotTypeVersionDataV1, BadRequestErrorV1]

get_interaction_model_v1(skill_id, stage_v2, locale, **kwargs)¶

Gets the InteractionModel for the skill in the given stage. The path params skillId, stage and locale are required.

Parameters:

skill_id (str) – (required) The skill ID.
stage_v2 (str) – (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 (str) – (required) The locale for the model requested e.g. en-GB, en-US, de-DE.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, StandardizedErrorV1, InteractionModelDataV1, BadRequestErrorV1]

get_interaction_model_version_v1(skill_id, stage_v2, locale, version, **kwargs)¶

Gets the specified version InteractionModel of a skill for the vendor. Use ~current as version parameter to get the current version model.

Parameters:

skill_id (str) – (required) The skill ID.
stage_v2 (str) – (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 (str) – (required) The locale for the model requested e.g. en-GB, en-US, de-DE.
version (str) – (required) Version for interaction model.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, StandardizedErrorV1, InteractionModelDataV1, BadRequestErrorV1]

get_isp_associated_skills_v1(product_id, stage, **kwargs)¶

Get the associated skills for the in-skill product.

Parameters:

product_id (str) – (required) The in-skill product ID.
stage (str) – (required) Stage for skill.
next_token (str) – 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 (float) – 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.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, ErrorV1, AssociatedSkillResponseV1]

get_isp_definition_v1(product_id, stage, **kwargs)¶

Returns the in-skill product definition for given productId.

Parameters:	product_id (str) – (required) The in-skill product ID. stage (str) – (required) Stage for skill. full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, ErrorV1, BadRequestErrorV1, InSkillProductDefinitionResponseV1]

get_isp_list_for_skill_id_v1(skill_id, stage, **kwargs)¶

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

Parameters:

skill_id (str) – (required) The skill ID.
stage (str) – (required) Stage for skill.
next_token (str) – 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 (float) – 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.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, ErrorV1, ListInSkillProductResponseV1, BadRequestErrorV1]

get_isp_list_for_vendor_v1(vendor_id, **kwargs)¶

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

Parameters:

vendor_id (str) – (required) The vendor ID.
next_token (str) – 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 (float) – 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.
product_id (list[str]) – The list of in-skill product IDs that you wish to get the summary for. A maximum of 50 in-skill product IDs can be specified in a single listInSkillProducts call. Please note that this parameter must not be used with ‘nextToken’ and/or ‘maxResults’ parameter.
stage (str) – Filter in-skill products by specified stage.
object_type (str) – Type of in-skill product to filter on.
reference_name (str) – Filter in-skill products by reference name.
status (str) – Status of in-skill product.
is_associated_with_skill (str) – Filter in-skill products by whether or not they are associated to a skill.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, ErrorV1, ListInSkillProductResponseV1, BadRequestErrorV1]

get_isp_summary_v1(product_id, stage, **kwargs)¶

Get the summary information for an in-skill product.

Parameters:	product_id (str) – (required) The in-skill product ID. stage (str) – (required) Stage for skill. full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, ErrorV1, InSkillProductSummaryResponseV1]

get_list_of_testers_v1(skill_id, **kwargs)¶

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

Parameters:

skill_id (str) – (required) The skill ID.
next_token (str) – 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 (float) – 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.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, ErrorV1, ListTestersResponseV1, BadRequestErrorV1]

get_nlu_evaluation_v1(skill_id, evaluation_id, **kwargs)¶

Get top level information and status of a nlu evaluation. 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’.

Parameters:	skill_id (str) – (required) The skill ID. evaluation_id (str) – (required) Identifier of the evaluation. full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, ErrorV1, BadRequestErrorV1, GetNLUEvaluationResponseV1]

get_properties_for_nlu_annotation_sets_v1(skill_id, annotation_id, **kwargs)¶

Get the properties of an NLU annotation set Return the properties for an NLU annotation set.

Parameters:	skill_id (str) – (required) The skill ID. annotation_id (str) – (required) Identifier of the NLU annotation set. full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, ErrorV1, GetNLUAnnotationSetPropertiesResponseV1, BadRequestErrorV1]

get_result_for_nlu_evaluations_v1(skill_id, evaluation_id, **kwargs)¶

Get test case results for a completed Evaluation. Paginated API which returns the test case results of an evaluation. This should be considered the ‘expensive’ operation while getNluEvaluation is ‘cheap’.

Parameters:

skill_id (str) – (required) The skill ID.
evaluation_id (str) – (required) Identifier of the evaluation.
sort_field (str) –
test_case_status (str) – only returns test cases with this status
actual_intent_name (str) – only returns test cases with intents which resolve to this intent
expected_intent_name (str) – only returns test cases with intents which are expected to be this intent
next_token (str) – 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 (float) – Sets the maximum number of results returned in the response body. Defaults to 1000. If more results are present, the response will contain a nextToken and a _link.next href.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, ErrorV1, GetNLUEvaluationResultsResponseV1, BadRequestErrorV1]

get_rollback_for_skill_v1(skill_id, rollback_request_id, **kwargs)¶

Get the rollback status of a skill given an associated rollbackRequestId. Use ~latest in place of rollbackRequestId to get the latest rollback status.

Parameters:

skill_id (str) – (required) The skill ID.
rollback_request_id (str) – (required) Defines the identifier for a rollback request. If set to ~latest, request returns the status of the latest rollback request.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, StandardizedErrorV1, RollbackRequestStatusV1, BadRequestErrorV1]

get_skill_credentials_v1(skill_id, **kwargs)¶

Get the client credentials for the skill.

Parameters:	skill_id (str) – (required) The skill ID. full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, StandardizedErrorV1, SkillCredentialsV1]

get_skill_enablement_status_v1(skill_id, stage, **kwargs)¶

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

Parameters:	skill_id (str) – (required) The skill ID. stage (str) – (required) Stage for skill. full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, StandardizedErrorV1, BadRequestErrorV1]

get_skill_manifest_v1(skill_id, stage_v2, **kwargs)¶

Returns the skill manifest for given skillId and stage.

Parameters:

skill_id (str) – (required) The skill ID.
stage_v2 (str) – (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.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, StandardizedErrorV1, BadRequestErrorV1, SkillManifestEnvelopeV1]

get_skill_metrics_v1(skill_id, start_time, end_time, period, metric, stage, skill_type, **kwargs)¶

Get analytic metrics report of skill usage.

Parameters:

skill_id (str) – (required) The skill ID.
start_time (datetime) – (required) The start time of query.
end_time (datetime) – (required) The end time of query (The maximum time duration is 1 week)
period (str) – (required) The aggregation period to use when retrieving the metric, follows ISO_8601#Durations format.
metric (str) – (required) A distinct set of logic which predictably returns a set of data.
stage (str) – (required) The stage of the skill (live, development).
skill_type (str) – (required) The type of the skill (custom, smartHome and flashBriefing).
intent (str) – The intent of the skill.
locale (str) – The locale for the skill. e.g. en-GB, en-US, de-DE and etc.
max_results (float) – 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.
next_token (str) – 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.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, StandardizedErrorV1, BadRequestErrorV1, GetMetricDataResponseV1]

get_skill_simulation_v1(skill_id, simulation_id, **kwargs)¶

Get the result of a previously executed simulation. 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.

Parameters:	skill_id (str) – (required) The skill ID. simulation_id (str) – (required) Id of the simulation. full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, ErrorV1, BadRequestErrorV1, SimulationsApiResponseV1]

get_skill_simulation_v2(skill_id, stage, simulation_id, **kwargs)¶

Get the result of a previously executed simulation. 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.

Parameters:	skill_id (str) – (required) The skill ID. stage (str) – (required) Stage for skill. simulation_id (str) – (required) Id of the simulation. full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, ErrorV2, BadRequestErrorV2, SimulationsApiResponseV2]

get_skill_status_v1(skill_id, **kwargs)¶

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

Parameters:

skill_id (str) – (required) The skill ID.
resource (str) – Resource name for which status information is desired. It is an optional, filtering parameter and can be used more than once, to retrieve status for all the desired (sub)resources only, in single API call. If this parameter is not specified, status for all the resources/sub-resources will be returned.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, StandardizedErrorV1, SkillStatusV1, BadRequestErrorV1]

get_skill_validations_v1(skill_id, validation_id, stage, **kwargs)¶

Get the result of a previously executed 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.

Parameters:

skill_id (str) – (required) The skill ID.
validation_id (str) – (required) Id of the validation. Reserved word identifier of mostRecent can be used to get the most recent validation for the skill and stage. Note that the behavior of the API in this case would be the same as when the actual validation id of the most recent validation is used in the request.
stage (str) – (required) Stage for skill.
accept_language (str) – User’s locale/language in context.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, ValidationsApiResponseV1, ErrorV1, BadRequestErrorV1]

get_ssl_certificates_v1(skill_id, **kwargs)¶

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.

Parameters:	skill_id (str) – (required) The skill ID. full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, StandardizedErrorV1, SSLCertificatePayloadV1]

get_status_of_export_request_v1(export_id, **kwargs)¶

Get status for given exportId

Parameters:	export_id (str) – (required) The Export ID. full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, ExportResponseV1, StandardizedErrorV1]

get_subscriber_for_development_events_v0(subscriber_id, **kwargs)¶

Returns information about specified subscriber.

Parameters:	subscriber_id (str) – (required) Unique identifier of the subscriber. full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, ErrorV0, BadRequestErrorV0, SubscriberInfoV0]

get_subscription_for_development_events_v0(subscription_id, **kwargs)¶

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.

Parameters:	subscription_id (str) – (required) Unique identifier of the subscription. full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, SubscriptionInfoV0, ErrorV0, BadRequestErrorV0]

get_utterance_data_v1(skill_id, **kwargs)¶

The Intent Request History API provides customers with the aggregated and anonymized transcription of user speech data and intent request details for their skills.

Parameters:

skill_id (str) – (required) The skill ID.
next_token (str) – 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 (float) – 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.
sort_direction (str) – 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 (str) – Sets the field on which the sorting would be applied.
stage (list[ask_smapi_model.v1.stage_type.StageType]) – A filter used to retrieve items where the stage is equal to the given value.
locale (list[ask_smapi_model.v1.skill.history.locale_in_query.LocaleInQuery]) –
dialog_act_name (list[ask_smapi_model.v1.skill.history.dialog_act_name.DialogActName]) – A filter used to retrieve items where the dialogAct name is equal to the given value. * Dialog.ElicitSlot: Alexa asked the user for the value of a specific slot. (https://developer.amazon.com/docs/custom-skills/dialog-interface-reference.html#elicitslot) * Dialog.ConfirmSlot: Alexa confirmed the value of a specific slot before continuing with the dialog. (https://developer.amazon.com/docs/custom-skills/dialog-interface-reference.html#confirmslot) * Dialog.ConfirmIntent: Alexa confirmed the all the information the user has provided for the intent before the skill took action. (https://developer.amazon.com/docs/custom-skills/dialog-interface-reference.html#confirmintent)
intent_confidence_bin (list[ask_smapi_model.v1.skill.history.intent_confidence_bin.IntentConfidenceBin]) –
intent_name (list[str]) – A filter used to retrieve items where the intent name is equal to the given value.
intent_slots_name (list[str]) – A filter used to retrieve items where the one of the slot names is equal to the given value.
interaction_type (list[ask_smapi_model.v1.skill.history.interaction_type.InteractionType]) –
publication_status (list[ask_smapi_model.v1.skill.history.publication_status.PublicationStatus]) –
utterance_text (list[str]) – 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.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, IntentRequestsV1, StandardizedErrorV1, BadRequestErrorV1]

get_vendor_list_v1(**kwargs)¶

Get the list of Vendor information.

Parameters:	full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, VendorsV1, ErrorV1]

import_skill_package_v1(update_skill_with_package_request, skill_id, **kwargs)¶

Creates a new import for a skill with given skillId.

Parameters:

update_skill_with_package_request (ask_smapi_model.v1.skill.update_skill_with_package_request.UpdateSkillWithPackageRequest) – (required) Defines the request body for updatePackage API.
skill_id (str) – (required) The skill ID.
if_match (str) – Request header that specified an entity tag. The server will update the resource only if the eTag matches with the resource’s current eTag.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, StandardizedErrorV1, BadRequestErrorV1]

invoke_skill_end_point_v2(skill_id, stage, invocations_api_request, **kwargs)¶

Invokes the Lambda or third party HTTPS endpoint for the given skill against a given stage. 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.

Parameters:

skill_id (str) – (required) The skill ID.
stage (str) – (required) Stage for skill.
invocations_api_request (ask_smapi_model.v2.skill.invocations.invocations_api_request.InvocationsApiRequest) – (required) Payload sent to the skill invocation API.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, ErrorV2, BadRequestErrorV2, InvocationsApiResponseV2]

invoke_skill_v1(skill_id, invoke_skill_request, **kwargs)¶

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.

Parameters:

skill_id (str) – (required) The skill ID.
invoke_skill_request (ask_smapi_model.v1.skill.invocations.invoke_skill_request.InvokeSkillRequest) – (required) Payload sent to the skill invocation API.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, InvokeSkillResponseV1, StandardizedErrorV1, BadRequestErrorV1]

list_asr_annotation_sets_v1(skill_id, **kwargs)¶

List ASR annotation sets metadata for a given skill. 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.

Parameters:

skill_id (str) – (required) The skill ID.
next_token (str) – 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 (float) – Sets the maximum number of results returned in the response body. Defaults to 1000. If more results are present, the response will contain a paginationContext.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, ErrorV1, ListASRAnnotationSetsResponseV1, BadRequestErrorV1]

list_asr_evaluations_results_v1(skill_id, evaluation_id, **kwargs)¶

List results for a completed Evaluation. Paginated API which returns the test case results of an evaluation. This should be considered the “expensive” operation while GetAsrEvaluationsStatus is “cheap”.

Parameters:

skill_id (str) – (required) The skill ID.
evaluation_id (str) – (required) Identifier of the evaluation.
next_token (str) – 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 (float) – Sets the maximum number of results returned in the response body. Defaults to 1000. If more results are present, the response will contain a nextToken.
status (str) – query parameter used to filter evaluation result status. * PASSED - filter evaluation result status of PASSED * FAILED - filter evaluation result status of FAILED
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, ErrorV1, GetAsrEvaluationsResultsResponseV1, BadRequestErrorV1]

list_asr_evaluations_v1(skill_id, **kwargs)¶

List asr evaluations run for a skill. API that allows developers to get historical ASR evaluations they run before.

Parameters:

skill_id (str) – (required) The skill ID.
next_token (str) – 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.
locale (str) – locale in bcp 47 format. Used to filter results with the specified locale. If omitted, the response would include all evaluations regardless of what locale was used in the evaluation
stage (str) – Query parameter used to filter evaluations with specified skill stage. * development - skill in development stage * live - skill in live stage
annotation_set_id (str) – filter to evaluations started using this annotationSetId
max_results (float) – Sets the maximum number of results returned in the response body. Defaults to 1000. If more results are present, the response will contain a nextToken.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, ErrorV1, ListAsrEvaluationsResponseV1, BadRequestErrorV1]

list_catalogs_for_skill_v0(skill_id, **kwargs)¶

Lists all the catalogs associated with a skill.

Parameters:

skill_id (str) – (required) The skill ID.
next_token (str) – 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 (float) – 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.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, ErrorV0, ListCatalogsResponseV0, BadRequestErrorV0]

list_catalogs_for_vendor_v0(vendor_id, **kwargs)¶

Lists catalogs associated with a vendor.

Parameters:

vendor_id (str) – (required) The vendor ID.
next_token (str) – 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 (float) – 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.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, ErrorV0, ListCatalogsResponseV0, BadRequestErrorV0]

list_interaction_model_catalog_versions_v1(catalog_id, **kwargs)¶

List all the historical versions of the given catalogId.

Parameters:

catalog_id (str) – (required) Provides a unique identifier of the catalog
max_results (float) – 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.
next_token (str) – 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 (str) – 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 (str) – Sets the field on which the sorting would be applied.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, StandardizedErrorV1, ListCatalogEntityVersionsResponseV1, BadRequestErrorV1]

list_interaction_model_catalogs_v1(vendor_id, **kwargs)¶

List all catalogs for the vendor.

Parameters:

vendor_id (str) – (required) The vendor ID.
max_results (float) – 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.
next_token (str) – 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 (str) – 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.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, ListCatalogResponseV1, StandardizedErrorV1, BadRequestErrorV1]

list_interaction_model_slot_type_versions_v1(slot_type_id, **kwargs)¶

List all slot type versions for the slot type id.

Parameters:

slot_type_id (str) – (required) The identifier for a slot type.
max_results (float) – 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.
next_token (str) – 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 (str) – 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.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, ListSlotTypeVersionResponseV1, StandardizedErrorV1, BadRequestErrorV1]

list_interaction_model_slot_types_v1(vendor_id, **kwargs)¶

List all slot types for the vendor.

Parameters:

vendor_id (str) – (required) The vendor ID.
max_results (float) – 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.
next_token (str) – 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 (str) – 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.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, StandardizedErrorV1, ListSlotTypeResponseV1, BadRequestErrorV1]

list_interaction_model_versions_v1(skill_id, stage_v2, locale, **kwargs)¶

Get the list of interactionModel versions of a skill for the vendor.

Parameters:

skill_id (str) – (required) The skill ID.
stage_v2 (str) – (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 (str) – (required) The locale for the model requested e.g. en-GB, en-US, de-DE.
next_token (str) – 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 (float) – 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.
sort_direction (str) – 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 (str) – Sets the field on which the sorting would be applied.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, ListResponseV1, StandardizedErrorV1, BadRequestErrorV1]

list_nlu_annotation_sets_v1(skill_id, **kwargs)¶

List NLU annotation sets for a given skill. 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.

Parameters:

skill_id (str) – (required) The skill ID.
locale (str) – filter to NLU annotation set created using this locale
next_token (str) – 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 (float) – Sets the maximum number of results returned in the response body. Defaults to 10. If more results are present, the response will contain a nextToken and a _link.next href.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, ErrorV1, ListNLUAnnotationSetsResponseV1, BadRequestErrorV1]

list_nlu_evaluations_v1(skill_id, **kwargs)¶

List nlu evaluations run for a skill. 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.

Parameters:

skill_id (str) – (required) The skill ID.
locale (str) – filter to evaluations started using this locale
stage (str) – filter to evaluations started using this stage
annotation_id (str) – filter to evaluations started using this annotationId
next_token (str) – 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 (float) – Sets the maximum number of results returned in the response body. Defaults to 10. If more results are present, the response will contain a nextToken and a _link.next href.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, ListNLUEvaluationsResponseV1, ErrorV1, BadRequestErrorV1]

list_private_distribution_accounts_v1(skill_id, stage, **kwargs)¶

List private distribution accounts.

Parameters:

skill_id (str) – (required) The skill ID.
stage (str) – (required) Stage for skill.
next_token (str) – 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 (float) – 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.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, StandardizedErrorV1, ListPrivateDistributionAccountsResponseV1, BadRequestErrorV1]

list_skills_for_vendor_v1(vendor_id, **kwargs)¶

Get the list of skills for the vendor.

Parameters:

vendor_id (str) – (required) The vendor ID.
next_token (str) – 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 (float) – 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.
skill_id (list[str]) – The list of skillIds that you wish to get the summary for. A maximum of 10 skillIds can be specified to get the skill summary in single listSkills call. Please note that this parameter must not be used with ‘nextToken’ or/and ‘maxResults’ parameter.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, StandardizedErrorV1, ListSkillResponseV1, BadRequestErrorV1]

list_subscribers_for_development_events_v0(vendor_id, **kwargs)¶

Lists the subscribers for a particular vendor.

Parameters:

vendor_id (str) – (required) The vendor ID.
next_token (str) – 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 (float) – 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.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, ErrorV0, BadRequestErrorV0, ListSubscribersResponseV0]

list_subscriptions_for_development_events_v0(vendor_id, **kwargs)¶

Lists all the subscriptions for a vendor/subscriber depending on the query parameter.

Parameters:

vendor_id (str) – (required) The vendor ID.
next_token (str) – 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 (float) – 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.
subscriber_id (str) – Unique identifier of the subscriber. If this query parameter is provided, the list would be filtered by the owning subscriberId.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, ListSubscriptionsResponseV0, ErrorV0, BadRequestErrorV0]

list_uploads_for_catalog_v0(catalog_id, **kwargs)¶

Lists all the uploads for a particular catalog.

Parameters:

catalog_id (str) – (required) Provides a unique identifier of the catalog
next_token (str) – 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 (float) – 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.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, ListUploadsResponseV0, ErrorV0, BadRequestErrorV0]

list_versions_for_skill_v1(skill_id, **kwargs)¶

Retrieve a list of all skill versions associated with this skill id

Parameters:

skill_id (str) – (required) The skill ID.
next_token (str) – 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 (float) – 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.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, StandardizedErrorV1, ListSkillVersionsResponseV1, BadRequestErrorV1]

profile_nlu_v1(profile_nlu_request, skill_id, stage, locale, **kwargs)¶

Profile a test utterance. This is a synchronous API that profiles an utterance against interaction model.

Parameters:

profile_nlu_request (ask_smapi_model.v1.skill.evaluations.profile_nlu_request.ProfileNluRequest) – (required) Payload sent to the profile nlu API.
skill_id (str) – (required) The skill ID.
stage (str) – (required) Stage for skill.
locale (str) – (required) The locale for the model requested e.g. en-GB, en-US, de-DE.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, ErrorV1, ProfileNluResponseV1, BadRequestErrorV1]

query_development_audit_logs_v1(get_audit_logs_request, **kwargs)¶

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.

Parameters:

get_audit_logs_request (ask_smapi_model.v1.audit_logs.audit_logs_request.AuditLogsRequest) – (required) Request object encompassing vendorId, optional request filters and optional pagination context.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, ErrorV1, AuditLogsResponseV1, BadRequestErrorV1]

remove_testers_from_beta_test_v1(skill_id, testers_request, **kwargs)¶

Remove testers from an existing 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.

Parameters:

skill_id (str) – (required) The skill ID.
testers_request (ask_smapi_model.v1.skill.beta_test.testers.testers_list.TestersList) – (required) JSON object containing the email address of beta testers.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, ErrorV1, BadRequestErrorV1]

request_feedback_from_testers_v1(skill_id, testers_request, **kwargs)¶

Request feedback from 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.

Parameters:

skill_id (str) – (required) The skill ID.
testers_request (ask_smapi_model.v1.skill.beta_test.testers.testers_list.TestersList) – (required) JSON object containing the email address of beta testers.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, ErrorV1, BadRequestErrorV1]

reset_entitlement_for_product_v1(product_id, stage, **kwargs)¶

Resets the entitlement(s) of the Product for the current user.

Parameters:	product_id (str) – (required) The in-skill product ID. stage (str) – (required) Stage for skill. full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, ErrorV1, BadRequestErrorV1]

rollback_skill_v1(skill_id, create_rollback_request, **kwargs)¶

Submit a target skill version to rollback to. Only one rollback or publish operation can be outstanding for a given skillId.

Parameters:

skill_id (str) – (required) The skill ID.
create_rollback_request (ask_smapi_model.v1.skill.create_rollback_request.CreateRollbackRequest) – (required) defines the request body to create a rollback request
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, StandardizedErrorV1, CreateRollbackResponseV1, BadRequestErrorV1]

send_reminder_to_testers_v1(skill_id, testers_request, **kwargs)¶

Send reminder to testers in a 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.

Parameters:

skill_id (str) – (required) The skill ID.
testers_request (ask_smapi_model.v1.skill.beta_test.testers.testers_list.TestersList) – (required) JSON object containing the email address of beta testers.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, ErrorV1, BadRequestErrorV1]

set_annotations_for_asr_annotation_set_v1(skill_id, annotation_set_id, update_asr_annotation_set_contents_request, **kwargs)¶

Update the annotations in the annotation set API that updates the annotaions in the annotation set

Parameters:

skill_id (str) – (required) The skill ID.
annotation_set_id (str) – (required) Identifier of the ASR annotation set.
update_asr_annotation_set_contents_request (ask_smapi_model.v1.skill.asr.annotation_sets.update_asr_annotation_set_contents_payload.UpdateAsrAnnotationSetContentsPayload) – (required) Payload containing annotation set contents. Two formats are accepted here: - application/json: Annotation set payload in JSON format. - text/csv: Annotation set payload in CSV format. Note that for CSV format, the first row should describe the column attributes. Columns should be delimited by comma. The subsequent rows should describe annotation data and each annotation attributes has to follow the strict ordering defined in the first row. Each annotation fields should be delimited by comma.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, ErrorV1, BadRequestErrorV1]

set_asr_annotation_set_v1(skill_id, annotation_set_id, update_asr_annotation_set_properties_request_v1, **kwargs)¶

update the ASR annotation set properties. API which updates the ASR annotation set properties. Currently, the only data can be updated is annotation set name.

Parameters:

skill_id (str) – (required) The skill ID.
annotation_set_id (str) – (required) Identifier of the ASR annotation set.
update_asr_annotation_set_properties_request_v1 (ask_smapi_model.v1.skill.asr.annotation_sets.update_asr_annotation_set_properties_request_object.UpdateAsrAnnotationSetPropertiesRequestObject) – (required) Payload sent to the update ASR annotation set properties API.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, ErrorV1, BadRequestErrorV1]

set_interaction_model_v1(skill_id, stage_v2, locale, interaction_model, **kwargs)¶

Creates an InteractionModel for the skill.

Parameters:

skill_id (str) – (required) The skill ID.
stage_v2 (str) – (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 (str) – (required) The locale for the model requested e.g. en-GB, en-US, de-DE.
interaction_model (ask_smapi_model.v1.skill.interaction_model.interaction_model_data.InteractionModelData) – (required)
if_match (str) – Request header that specified an entity tag. The server will update the resource only if the eTag matches with the resource’s current eTag.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, StandardizedErrorV1, BadRequestErrorV1]

set_private_distribution_account_id_v1(skill_id, stage, id, **kwargs)¶

Add an id to the private distribution accounts.

Parameters:

skill_id (str) – (required) The skill ID.
stage (str) – (required) Stage for skill.
id (str) – (required) ARN that a skill can be privately distributed to.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, StandardizedErrorV1, BadRequestErrorV1]

set_skill_enablement_v1(skill_id, stage, **kwargs)¶

Creates/Updates the enablement for given skillId/stage and customerId (retrieved from Auth token)

Parameters:	skill_id (str) – (required) The skill ID. stage (str) – (required) Stage for skill. full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, StandardizedErrorV1, BadRequestErrorV1]

set_ssl_certificates_v1(skill_id, ssl_certificate_payload, **kwargs)¶

Updates the ssl certificates associated with this skill.

Parameters:

skill_id (str) – (required) The skill ID.
ssl_certificate_payload (ask_smapi_model.v1.skill.ssl_certificate_payload.SSLCertificatePayload) – (required) Defines the input/output of the ssl certificates api for a skill.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, StandardizedErrorV1, BadRequestErrorV1]

set_subscriber_for_development_events_v0(subscriber_id, update_subscriber_request, **kwargs)¶

Updates the properties of a subscriber.

Parameters:

subscriber_id (str) – (required) Unique identifier of the subscriber.
update_subscriber_request (ask_smapi_model.v0.development_events.subscriber.update_subscriber_request.UpdateSubscriberRequest) – (required) Defines the request body for updateSubscriber API.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, ErrorV0, BadRequestErrorV0]

set_subscription_for_development_events_v0(subscription_id, **kwargs)¶

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.

Parameters:

subscription_id (str) – (required) Unique identifier of the subscription.
update_subscription_request (ask_smapi_model.v0.development_events.subscription.update_subscription_request.UpdateSubscriptionRequest) – Request body for updateSubscription API.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, ErrorV0, BadRequestErrorV0]

simulate_skill_v1(skill_id, simulations_api_request, **kwargs)¶

Simulate executing a skill with the given id. 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 be in development stage, and it must also belong to and be enabled by the user of this API. Concurrent requests per user is currently not supported.

Parameters:

skill_id (str) – (required) The skill ID.
simulations_api_request (ask_smapi_model.v1.skill.simulations.simulations_api_request.SimulationsApiRequest) – (required) Payload sent to the skill simulation API.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, ErrorV1, BadRequestErrorV1, SimulationsApiResponseV1]

simulate_skill_v2(skill_id, stage, simulations_api_request, **kwargs)¶

Simulate executing a skill with the given id against a given stage. 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.

Parameters:

skill_id (str) – (required) The skill ID.
stage (str) – (required) Stage for skill.
simulations_api_request (ask_smapi_model.v2.skill.simulations.simulations_api_request.SimulationsApiRequest) – (required) Payload sent to the skill simulation API.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, ErrorV2, BadRequestErrorV2, SimulationsApiResponseV2]

start_beta_test_v1(skill_id, **kwargs)¶

Start 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.

Parameters:	skill_id (str) – (required) The skill ID. full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:	Union[ApiResponse, ErrorV1, BadRequestErrorV1]

submit_skill_for_certification_v1(skill_id, **kwargs)¶

Submit the skill for certification.

Parameters:

skill_id (str) – (required) The skill ID.
submit_skill_for_certification_request (ask_smapi_model.v1.skill.submit_skill_for_certification_request.SubmitSkillForCertificationRequest) – Defines the request body for submitSkillForCertification API.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, StandardizedErrorV1, BadRequestErrorV1]

submit_skill_validation_v1(validations_api_request, skill_id, stage, **kwargs)¶

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

Parameters:

validations_api_request (ask_smapi_model.v1.skill.validations.validations_api_request.ValidationsApiRequest) – (required) Payload sent to the skill validation API.
skill_id (str) – (required) The skill ID.
stage (str) – (required) Stage for skill.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, ValidationsApiResponseV1, ErrorV1, BadRequestErrorV1]

update_account_linking_info_v1(skill_id, stage_v2, account_linking_request, **kwargs)¶

Create AccountLinking information for the skill.

Parameters:

skill_id (str) – (required) The skill ID.
stage_v2 (str) – (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 (ask_smapi_model.v1.skill.account_linking.account_linking_request.AccountLinkingRequest) – (required) The fields required to create accountLinking partner.
if_match (str) – Request header that specified an entity tag. The server will update the resource only if the eTag matches with the resource’s current eTag.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, StandardizedErrorV1, BadRequestErrorV1]

update_annotations_for_nlu_annotation_sets_v1(skill_id, annotation_id, content_type, update_nlu_annotation_set_annotations_request, **kwargs)¶

Replace the annotations in NLU annotation set. API which replaces the annotations in NLU annotation set.

Parameters:

skill_id (str) – (required) The skill ID.
annotation_id (str) – (required) Identifier of the NLU annotation set.
content_type (str) – (required) Standard HTTP. Pass application/json or test/csv for POST calls with a json/csv body.
update_nlu_annotation_set_annotations_request (ask_smapi_model.v1.skill.nlu.annotation_sets.update_nlu_annotation_set_annotations_request.UpdateNLUAnnotationSetAnnotationsRequest) – (required) Payload sent to the update NLU annotation set API.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, ErrorV1, BadRequestErrorV1]

update_beta_test_v1(skill_id, **kwargs)¶

Update beta test. Update a beta test for a given Alexa skill.

Parameters:

skill_id (str) – (required) The skill ID.
create_test_body (ask_smapi_model.v1.skill.beta_test.test_body.TestBody) – JSON object containing the details of a beta test used to create the test.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, ErrorV1, BadRequestErrorV1]

update_interaction_model_catalog_v1(catalog_id, update_request, **kwargs)¶

update description and vendorGuidance string for certain version of a catalog.

Parameters:

catalog_id (str) – (required) Provides a unique identifier of the catalog
update_request (ask_smapi_model.v1.skill.interaction_model.catalog.update_request.UpdateRequest) – (required)
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, StandardizedErrorV1, BadRequestErrorV1]

update_interaction_model_catalog_version_v1(catalog_id, version, **kwargs)¶

Update description and vendorGuidance string for certain version of a catalog.

Parameters:

catalog_id (str) – (required) Provides a unique identifier of the catalog
version (str) – (required) Version for interaction model.
catalog_update (ask_smapi_model.v1.skill.interaction_model.version.catalog_update.CatalogUpdate) –
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, StandardizedErrorV1, BadRequestErrorV1]

update_interaction_model_slot_type_v1(slot_type_id, update_request, **kwargs)¶

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

Parameters:

slot_type_id (str) – (required) The identifier for a slot type.
update_request (ask_smapi_model.v1.skill.interaction_model.model_type.update_request.UpdateRequest) – (required)
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, StandardizedErrorV1, BadRequestErrorV1]

update_interaction_model_slot_type_version_v1(slot_type_id, version, slot_type_update, **kwargs)¶

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

Parameters:

slot_type_id (str) – (required) The identifier for a slot type.
version (str) – (required) Version for interaction model.
slot_type_update (ask_smapi_model.v1.skill.interaction_model.type_version.slot_type_update.SlotTypeUpdate) – (required)
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, StandardizedErrorV1, BadRequestErrorV1]

update_isp_for_product_v1(product_id, stage, update_in_skill_product_request, **kwargs)¶

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

Parameters:

product_id (str) – (required) The in-skill product ID.
stage (str) – (required) Stage for skill.
update_in_skill_product_request (ask_smapi_model.v1.isp.update_in_skill_product_request.UpdateInSkillProductRequest) – (required) defines the request body for updateInSkillProduct API.
if_match (str) – Request header that specified an entity tag. The server will update the resource only if the eTag matches with the resource’s current eTag.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, ErrorV1, BadRequestErrorV1]

update_properties_for_nlu_annotation_sets_v1(skill_id, annotation_id, update_nlu_annotation_set_properties_request, **kwargs)¶

update the NLU annotation set properties. API which updates the NLU annotation set properties. Currently, the only data can be updated is annotation set name.

Parameters:

skill_id (str) – (required) The skill ID.
annotation_id (str) – (required) Identifier of the NLU annotation set.
update_nlu_annotation_set_properties_request (ask_smapi_model.v1.skill.nlu.annotation_sets.update_nlu_annotation_set_properties_request.UpdateNLUAnnotationSetPropertiesRequest) – (required) Payload sent to the update NLU annotation set properties API.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, ErrorV1, BadRequestErrorV1]

update_skill_manifest_v1(skill_id, stage_v2, update_skill_request, **kwargs)¶

Updates skill manifest for given skillId and stage.

Parameters:

skill_id (str) – (required) The skill ID.
stage_v2 (str) – (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.
update_skill_request (ask_smapi_model.v1.skill.manifest.skill_manifest_envelope.SkillManifestEnvelope) – (required) Defines the request body for updateSkill API.
if_match (str) – Request header that specified an entity tag. The server will update the resource only if the eTag matches with the resource’s current eTag.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, StandardizedErrorV1, BadRequestErrorV1]

withdraw_skill_from_certification_v1(skill_id, withdraw_request, **kwargs)¶

Withdraws the skill from certification.

Parameters:

skill_id (str) – (required) The skill ID.
withdraw_request (ask_smapi_model.v1.skill.withdraw_request.WithdrawRequest) – (required) The reason and message (in case of OTHER) to withdraw a skill.
full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.

Return type:

Union[ApiResponse, StandardizedErrorV1, BadRequestErrorV1]