Alexa Skills Kit SDK for Python

The ASK SDK for Python makes it easier for you to build highly engaging skills, by allowing you to spend more time on implementing features and less on writing boiler-plate code.

The SDK documentation has been moved to developer docs. Please check here for the latest documentation.

Runtime

Request Dispatch Components

Abstract Classes

class ask_sdk_runtime.dispatch.AbstractRequestDispatcher

Bases: object

Dispatcher which handles dispatching input request to the corresponding handler.

User needs to implement the dispatch method, to handle the processing of the incoming request in the handler input. A response may be expected out of the dispatch method.

dispatch(handler_input)

Dispatches an incoming request to the appropriate request handler and returns the output.

Parameters:handler_input (Input) – generic input to the dispatcher Returns:generic output returned by handler in the dispatcher Return type:Union[None, Output]

class ask_sdk_runtime.dispatch_components.request_components.AbstractRequestHandler

Bases: typing.Generic

Request Handlers are responsible for processing dispatch inputs and generating output.

Custom request handlers needs to implement can_handle and handle methods. can_handle returns True if the handler can handle the current input. handle processes the input and may return a output.

can_handle(handler_input)

Returns true if Request Handler can handle the dispatch input.

Parameters:handler_input (Input) – Generic input passed to the dispatcher. Returns:Boolean value that tells the dispatcher if the current input can be handled by this handler. Return type:bool

handle(handler_input)

Handles the dispatch input and provides an output for dispatcher to return.

Parameters:handler_input (Input) – Generic input passed to the dispatcher. Returns:Generic Output for the dispatcher to return or None Return type:Union[Output, None]

class ask_sdk_runtime.dispatch_components.request_components.AbstractRequestInterceptor

Bases: typing.Generic

Interceptor that runs before the handler is called.

The process method has to be implemented, to run custom logic on the input, before it is handled by the Handler.

process(handler_input)

Process the input before the Handler is run.

Parameters:handler_input (Input) – Generic input passed to the dispatcher. Return type:None

class ask_sdk_runtime.dispatch_components.request_components.AbstractResponseInterceptor

Bases: typing.Generic

Interceptor that runs after the handler is called.

The process method has to be implemented, to run custom logic on the input and the dispatch output generated after the handler is executed on the input.

process(handler_input, response)

Process the input and the output after the Handler is run.

Parameters:

• handler_input (Input) – Generic input passed to the dispatcher.
• response (Union[None, Output]) – Execution result of the Handler on dispatch input.

Return type:

None

class ask_sdk_runtime.dispatch_components.request_components.AbstractRequestHandlerChain

Bases: object

Abstract class containing Request Handler and corresponding Interceptors.

request_handler()

Returns:Registered Request Handler instance. Return type:object

request_interceptors()

Returns:List of registered Request Interceptors. Return type:list( ask_sdk_runtime.dispatch_components.request_components.AbstractRequestInterceptor)

response_interceptors()

Returns:List of registered Response Interceptors. Return type:list( ask_sdk_runtime.dispatch_components.request_components.AbstractResponseInterceptor)

class ask_sdk_runtime.dispatch_components.request_components.AbstractRequestMapper

Bases: object

Class for request routing to the appropriate handler chain.

User needs to implement get_request_handler_chain method, to provide a routing mechanism of the input to the appropriate request handler chain containing the handler and the interceptors.

get_request_handler_chain(handler_input)

Get the handler chain that can process the handler input.

Parameters:handler_input (Input) – Generic input passed to the dispatcher. Returns:Handler Chain that can handle the request under dispatch input. Return type:AbstractRequestHandlerChain

class ask_sdk_runtime.dispatch_components.request_components.AbstractHandlerAdapter

Bases: object

Abstracts handling of a request for specific handler types.

supports(handler)

Returns true if adapter supports the handler.

This method checks if the adapter supports the handler execution. This is usually checked by the type of the handler.

Parameters:handler (object) – Request Handler instance. Returns:Boolean denoting whether the adapter supports the handler. Return type:bool

execute(handler_input, handler)

Executes the handler with the provided dispatch input.

Parameters:

• handler_input (Input) – Generic input passed to the dispatcher.
• handler (object) – Request Handler instance.

Returns:

Result executed by passing handler_input to handler.

Return type:

Union[None, Output]

class ask_sdk_runtime.dispatch_components.exception_components.AbstractExceptionHandler

Bases: typing.Generic

Handles exception types and optionally produce an output.

The abstract class is similar to Request Handler, with methods can_handle and handle. The can_handle method checks if the handler can support the input and the exception. The handle method processes the input and exception, to optionally produce an output.

can_handle(handler_input, exception)

Checks if the handler can support the exception raised during dispatch.

Parameters:

• handler_input (Input) – Generic input passed to the dispatcher.
• exception (Exception) – Exception raised during dispatch.

Returns:

Boolean whether handler can handle exception or not.

Return type:

bool

handle(handler_input, exception)

Process the dispatch input and exception.

Parameters:

• handler_input (Input) – Generic input passed to the dispatcher.
• exception (Exception) – Exception raised during dispatch.

Returns:

Optional output object to serve as dispatch return.

Return type:

Union[None, Output]

class ask_sdk_runtime.dispatch_components.exception_components.AbstractExceptionMapper

Bases: typing.Generic

Mapper to register custom Exception Handler instances.

The exception mapper is used by ask_sdk_runtime.dispatch.GenericRequestDispatcher dispatch method, to handle exceptions. The mapper can contain one or more exception handlers. Handlers are accessed through the mapper to attempt to find a handler that is compatible with the current exception.

get_handler(handler_input, exception)

Returns a suitable exception handler to dispatch the specified exception, if one exists.

Parameters:

• handler_input (Input) – Generic input passed to the dispatcher.
• exception (Exception) – Exception thrown by ask_sdk_runtime.dispatch.GenericRequestDispatcher dispatch method.

Returns:

Exception Handler that can handle the input or None.

Return type:

Union[None, AbstractExceptionHandler]

Implementations

class ask_sdk_runtime.dispatch.GenericRequestDispatcher(options)

Bases: ask_sdk_runtime.dispatch.AbstractRequestDispatcher

Generic implementation of AbstractRequestDispatcher.

The runtime configuration contains the components required for the dispatcher, which is passed during initialization.

When the dispatch method is invoked, using a list of ask_sdk_runtime.dispatch_components.request_components.RequestMapper , the Dispatcher finds a handler for the request and delegates the invocation to the supported ask_sdk_runtime.dispatch_components.request_components.HandlerAdapter . If the handler raises any exception, it is delegated to ask_sdk_runtime.dispatch_components.exception_components.ExceptionMapper to handle or raise it to the upper stack.

dispatch(handler_input)

Dispatches an incoming request to the appropriate request handler and returns the output.

Before running the request on the appropriate request handler, dispatcher runs any predefined global request interceptors. On successful response returned from request handler, dispatcher runs predefined global response interceptors, before returning the response.

Parameters:handler_input (Input) – generic input to the dispatcher Returns:generic output handled by the handler, optionally containing a response Return type:Union[None, Output] Raises:ask_sdk_runtime.exceptions.DispatchException

class ask_sdk_runtime.dispatch_components.request_components.GenericRequestHandlerChain(request_handler, request_interceptors=None, response_interceptors=None)

Bases: ask_sdk_runtime.dispatch_components.request_components.AbstractRequestHandlerChain

Generic implementation of AbstractRequestHandlerChain.

Generic Request Handler Chain accepts request handler of any type.

Parameters:

• request_handler (ask_sdk_runtime.dispatch_components.request_components.AbstractRequestHandler) – Registered Request Handler instance of generic type.
• request_interceptors (list( ask_sdk_runtime.dispatch_components.request_components.AbstractRequestInterceptor)) – List of registered Request Interceptors.
• response_interceptors (list( ask_sdk_runtime.dispatch_components.request_components.AbstractResponseInterceptor)) – List of registered Response Interceptors.

request_handler

Returns:Registered Request Handler instance. Return type:object

request_interceptors

Returns:List of registered Request Interceptors. Return type:list( ask_sdk_runtime.dispatch_components.request_components.AbstractRequestInterceptor)

response_interceptors

Returns:List of registered Response Interceptors. Return type:list( ask_sdk_runtime.dispatch_components.request_components.AbstractResponseInterceptor)

add_request_interceptor(interceptor)

Add interceptor to Request Interceptors list.

Parameters:interceptor (ask_sdk_runtime.dispatch_components.request_components.AbstractRequestInterceptor) – Request Interceptor instance.

add_response_interceptor(interceptor)

Add interceptor to Response Interceptors list.

Parameters:interceptor (ask_sdk_runtime.dispatch_components.request_components.AbstractResponseInterceptor) – Response Interceptor instance.

class ask_sdk_runtime.dispatch_components.request_components.GenericRequestMapper(request_handler_chains)

Bases: ask_sdk_runtime.dispatch_components.request_components.AbstractRequestMapper

Implementation of AbstractRequestMapper that registers RequestHandlerChain.

The class accepts request handler chains of type GenericRequestHandlerChain only. The get_request_handler_chain method returns the GenericRequestHandlerChain instance that can handle the request in the handler input.

Parameters:request_handler_chains (list(GenericRequestHandlerChain)) – List of GenericRequestHandlerChain instances.

request_handler_chains

Returns:List of GenericRequestHandlerChain instances. Return type:list(GenericRequestHandlerChain)

add_request_handler_chain(request_handler_chain)

Checks the type before adding it to the request_handler_chains instance variable.

Parameters:request_handler_chain (RequestHandlerChain) – Request Handler Chain instance. Raises:ask_sdk_runtime.exceptions.DispatchException if a null input is provided or if the input is of invalid type

get_request_handler_chain(handler_input)

Get the request handler chain that can handle the dispatch input.

Parameters:handler_input (Input) – Generic input passed to the dispatcher. Returns:Handler Chain that can handle the input. Return type:Union[None, GenericRequestHandlerChain]

class ask_sdk_runtime.dispatch_components.request_components.GenericHandlerAdapter

Bases: ask_sdk_runtime.dispatch_components.request_components.AbstractHandlerAdapter

GenericHandler Adapter for handlers of type ask_sdk_runtime.dispatch_components.request_components.AbstractRequestHandler.

supports(handler)

Returns true if handler is ask_sdk_runtime.dispatch_components.request_components.AbstractRequestHandler instance.

Parameters:handler (ask_sdk_runtime.dispatch_components.request_components.AbstractRequestHandler) – Request Handler instance Returns:Boolean denoting whether the adapter supports the handler. Return type:bool

execute(handler_input, handler)

Executes the handler with the provided handler input.

Parameters:

• handler_input (Input) – Generic input passed to the dispatcher.
• handler (object) – Request Handler instance.

Returns:

Result executed by passing handler_input to handler.

Return type:

Union[None, Output]

class ask_sdk_runtime.dispatch_components.exception_components.GenericExceptionMapper(exception_handlers)

Bases: ask_sdk_runtime.dispatch_components.exception_components.AbstractExceptionMapper

Generic Implementation of exception mapper, to register AbstractExceptionHandler instances.

The class accepts exception handlers of type AbstractExceptionHandler only. The get_handler method returns the AbstractExceptionHandler instance that can handle the dispatch input and the exception raised from the dispatch method.

Parameters:exception_handlers (list( ask_sdk_runtime.dispatch_components.exception_components.AbstractExceptionHandler)) – List of ask_sdk_runtime.dispatch_components.exception_components.AbstractExceptionHandler instances.

exception_handlers

Returns:List of ask_sdk_runtime.dispatch_components.exception_components.AbstractExceptionHandler instances. Return type:list( ask_sdk_runtime.dispatch_components.exception_components.AbstractExceptionHandler)

add_exception_handler(exception_handler)

Checks the type before adding it to the exception_handlers instance variable.

Parameters:exception_handler (ask_sdk_runtime.dispatch_components.exception_components.AbstractExceptionHandler) – Exception Handler instance. Raises:ask_sdk_runtime.exceptions.DispatchException if a null input is provided or if the input is of invalid type

get_handler(handler_input, exception)

Get the exception handler that can handle the input and exception.

Parameters:

• handler_input (Input) – Generic input passed to the dispatcher.
• exception (Exception) – Exception thrown by ask_sdk_runtime.dispatch.GenericRequestDispatcher dispatch method.

Returns:

Exception Handler that can handle the input or None.

Return type:

Union[None, ask_sdk_runtime.dispatch_components.exception_components.AbstractExceptionHandler]

Skill Components

class ask_sdk_runtime.skill.RuntimeConfiguration(request_mappers, handler_adapters, request_interceptors=None, response_interceptors=None, exception_mapper=None, loaders=None, renderer=None)

Bases: object

Configuration Object that represents standard components needed to build the dispatcher in the AbstractSkill.

Parameters:

• request_mappers (list(GenericRequestMapper)) – List of request mapper instances.
• handler_adapters (list(GenericHandlerAdapter)) – List of handler adapter instances.
• request_interceptors (list(AbstractRequestInterceptor)) – List of request interceptor instances.
• response_interceptors (list(AbstractResponseInterceptor)) – List of response interceptor instances.
• exception_mapper (GenericExceptionMapper) – Exception mapper instance.

class ask_sdk_runtime.skill.RuntimeConfigurationBuilder

Bases: object

Builder class for creating a runtime configuration object, from base dispatch components.

add_request_handler(request_handler)

Register input to the request handlers list.

Parameters:request_handler (AbstractRequestHandler) – Request Handler instance to be registered. Returns:None

add_request_handlers(request_handlers)

Register input to the request handlers list.

Parameters:request_handlers (list(AbstractRequestHandler)) – List of Request Handler instances to be registered. Returns:None

add_exception_handler(exception_handler)

Register input to the exception handlers list.

Parameters:exception_handler (AbstractExceptionHandler) – Exception Handler instance to be registered. Returns:None

add_global_request_interceptor(request_interceptor)

Register input to the global request interceptors list.

Parameters:request_interceptor (AbstractRequestInterceptor) – Request Interceptor instance to be registered. Returns:None

add_global_response_interceptor(response_interceptor)

Register input to the global response interceptors list.

Parameters:response_interceptor (AbstractResponseInterceptor) – Response Interceptor instance to be registered. Returns:None

add_loader(loader)

Register input to the loaders list.

Parameters:loader (ask_sdk_runtime.view_resolvers.AbstractTemplateLoader) – Loader to load the template

add_loaders(loaders)

Register input to the loaders list.

Parameters:loaders (ask_sdk_runtime.view_resolvers.AbstractTemplateLoader) – List of loaders

add_renderer(renderer)

Register input to the renderer.

Parameters:renderer (ask_sdk_runtime.view_resolvers.AbstractTemplateRenderer) – Renderer to render the template

get_runtime_configuration()

Build the runtime configuration object from the registered components.

Returns:Runtime Configuration Object Return type:RuntimeConfiguration

class ask_sdk_runtime.skill.AbstractSkill

Bases: typing.Generic

Abstract class that acts as entry level container for skill invocation.

Domain SDKs should implement the supports and invoke methods.

supports(event, context)

Check if the skill supports the corresponding input.

Parameters:

• event (SkillInput) – input instance containing request information.
• context (Any) – Context passed during invocation

Returns:

boolean if this type of request can be handled by this skill.

Return type:

bool

invoke(event, context)

Invokes the dispatcher, to handle the skill input and return a skill output.

Parameters:

• event (SkillInput) – input instance containing request information.
• context (Any) – Context passed during invocation

Returns:

output generated by handling the request.

Return type:

SkillOutput

class ask_sdk_runtime.skill_builder.AbstractSkillBuilder

Bases: object

Abstract Skill Builder with helper functions for building ask_sdk_runtime.skill.AbstractSkill object.

Domain SDKs has to implement the create method that returns an instance of the skill implementation for the domain type.

add_request_handler(request_handler)

Register input to the request handlers list.

Parameters:request_handler (ask_sdk_runtime.dispatch_components.request_components.AbstractRequestHandler) – Request Handler instance to be registered. Returns:None

add_exception_handler(exception_handler)

Register input to the exception handlers list.

Parameters:exception_handler (ask_sdk_runtime.dispatch_components.request_components.AbstractExceptionHandler) – Exception Handler instance to be registered. Returns:None

add_global_request_interceptor(request_interceptor)

Register input to the global request interceptors list.

Parameters:request_interceptor (ask_sdk_runtime.dispatch_components.request_components.AbstractRequestInterceptor) – Request Interceptor instance to be registered. Returns:None

add_global_response_interceptor(response_interceptor)

Register input to the global response interceptors list.

Parameters:response_interceptor (ask_sdk_runtime.dispatch_components.request_components.AbstractResponseInterceptor) – Response Interceptor instance to be registered. Returns:None

add_loaders(loaders)

Register input to the loaders list.

Parameters:loaders (ask_sdk_runtime.view_resolvers.AbstractTemplateLoader) – List of loaders

add_loader(loader)

Register input to loaders list.

Parameters:loader (ask_sdk_runtime.view_resolvers.AbstractTemplateLoader) – Loader to load template from a specific data source

add_renderer(renderer)

Register renderer to generate template responses.

Parameters:renderer (ask_sdk_runtime.view_resolvers.AbstractTemplateRenderer) – Renderer to render the template

request_handler(can_handle_func)

Decorator that can be used to add request handlers easily to the builder.

The can_handle_func has to be a Callable instance, which takes a single parameter and no varargs or kwargs. This is because of the RequestHandler class signature restrictions. The returned wrapper function can be applied as a decorator on any function that returns a response object by the skill. The function should follow the signature of the handle function in ask_sdk_runtime.dispatch_components.request_components.AbstractRequestHandler class.

Parameters:can_handle_func (Callable[[Input], bool]) – The function that validates if the request can be handled. Returns:Wrapper function that can be decorated on a handle function.

exception_handler(can_handle_func)

Decorator that can be used to add exception handlers easily to the builder.

The can_handle_func has to be a Callable instance, which takes two parameters and no varargs or kwargs. This is because of the ExceptionHandler class signature restrictions. The returned wrapper function can be applied as a decorator on any function that processes the exception raised during dispatcher and returns a response object by the skill. The function should follow the signature of the handle function in ask_sdk_runtime.dispatch_components.exception_components.AbstractExceptionHandler class.

Parameters:can_handle_func (Callable[[Input, Exception], bool]) – The function that validates if the exception can be handled. Returns:Wrapper function that can be decorated on a handle function.

global_request_interceptor()

Decorator that can be used to add global request interceptors easily to the builder.

The returned wrapper function can be applied as a decorator on any function that processes the input. The function should follow the signature of the process function in ask_sdk_runtime.dispatch_components.request_components.AbstractRequestInterceptor class.

Returns:Wrapper function that can be decorated on a interceptor process function.

global_response_interceptor()

Decorator that can be used to add global response interceptors easily to the builder.

The returned wrapper function can be applied as a decorator on any function that processes the input and the response generated by the request handler. The function should follow the signature of the process function in ask_sdk_runtime.dispatch_components.request_components.AbstractResponseInterceptor class.

Returns:Wrapper function that can be decorated on a interceptor process function.

create()

Create a skill object using the registered components.

Returns:a skill object that can be used for invocation. Return type:AbstractSkill

SDK Exceptions

exception ask_sdk_runtime.exceptions.AskSdkException

Bases: Exception

Base class for exceptions raised by the SDK.

exception ask_sdk_runtime.exceptions.DispatchException

Bases: ask_sdk_runtime.exceptions.AskSdkException

Class for exceptions raised during dispatch logic.

exception ask_sdk_runtime.exceptions.SerializationException

Bases: ask_sdk_runtime.exceptions.AskSdkException

Class for exceptions raised during serialization/deserialization.

exception ask_sdk_runtime.exceptions.SkillBuilderException

Bases: ask_sdk_runtime.exceptions.AskSdkException

Base exception class for Skill Builder exceptions.

exception ask_sdk_runtime.exceptions.RuntimeConfigException

Bases: ask_sdk_runtime.exceptions.AskSdkException

Base exception class for Runtime Configuration Builder exceptions.

Core

Handler Input

class ask_sdk_core.handler_input.HandlerInput(request_envelope, attributes_manager=None, context=None, service_client_factory=None, template_factory=None)

Bases: object

Input to Request Handler, Exception Handler and Interceptors.

Handler Input instantiations are passed to the registered instances of AbstractRequestHandler and AbstractExceptionHandler , during skill invocation. The class provides a AttributesManager and a ResponseFactory instance, apart from RequestEnvelope, Context and ServiceClientFactory instances, to utilize during the lifecycle of skill.

Parameters:

• request_envelope (ask_sdk_model.request_envelope.RequestEnvelope) – Request Envelope passed from Alexa Service
• attributes_manager (ask_sdk_core.attributes_manager.AttributesManager) – Attribute Manager instance for managing attributes across skill lifecycle
• context (object) – Context object passed from Lambda service
• service_client_factory (ask_sdk_model.services.service_client_factory.ServiceClientFactory) – Service Client Factory instance for calling Alexa services
• template_factory (ask_sdk_core.view_resolver.TemplateFactory) – Template Factory to chain loaders and renderer

service_client_factory

Service Client Factory instance for calling Alexa services.

To use the Alexa services, one need to configure the API Client in the skill builder object, before creating the skill.

generate_template_response(template_name, data_map, **kwargs)

Generate response using skill response template and injecting data.

Parameters:

• template_name (str) – name of response template
• data_map (Dict[str, object]) – map contains injecting data
• kwargs – Additional keyword arguments for loader and renderer.

Returns:

Skill Response output

Return type:

ask_sdk_model.response.Response

Request Dispatch Components

Abstract Classes

class ask_sdk_core.dispatch_components.request_components.AbstractRequestHandler

Bases: ask_sdk_runtime.dispatch_components.request_components.AbstractRequestHandler

Request Handlers are responsible for processing Request inside the Handler Input and generating Response.

Custom request handlers needs to implement can_handle and handle methods. can_handle returns True if the handler can handle the current request. handle processes the Request and may return a Response.

can_handle(handler_input)

Returns true if Request Handler can handle the Request inside Handler Input.

Parameters:handler_input (HandlerInput) – Handler Input instance with Request Envelope containing Request. Returns:Boolean value that tells the dispatcher if the current request can be handled by this handler. Return type:bool

handle(handler_input)

Handles the Request inside handler input and provides a Response for dispatcher to return.

Parameters:handler_input (HandlerInput) – Handler Input instance with Request Envelope containing Request. Returns:Response for the dispatcher to return or None Return type:Union[Response, None]

class ask_sdk_core.dispatch_components.request_components.AbstractRequestInterceptor

Bases: ask_sdk_runtime.dispatch_components.request_components.AbstractRequestInterceptor

Interceptor that runs before the handler is called.

The process method has to be implemented, to run custom logic on the input, before it is handled by the Handler.

process(handler_input)

Process the input before the Handler is run.

Parameters:handler_input (HandlerInput) – Handler Input instance. Return type:None

class ask_sdk_core.dispatch_components.request_components.AbstractResponseInterceptor

Bases: ask_sdk_runtime.dispatch_components.request_components.AbstractResponseInterceptor

Interceptor that runs after the handler is called.

The process method has to be implemented, to run custom logic on the input and the response generated after the handler is executed on the input.

process(handler_input, response)

Process the input and the response after the Handler is run.

Parameters:

• handler_input (HandlerInput) – Handler Input instance.
• response (Union[None, ask_sdk_model.response.Response]) – Execution result of the Handler on handler input.

Return type:

None

class ask_sdk_core.dispatch_components.exception_components.AbstractExceptionHandler

Bases: ask_sdk_runtime.dispatch_components.exception_components.AbstractExceptionHandler

Handles exception types and optionally produce a response.

The abstract class is similar to Request Handler, with methods can_handle and handle. The can_handle method checks if the handler can support the input and the exception. The handle method processes the input and exception, to optionally produce a response.

can_handle(handler_input, exception)

Checks if the handler can support the exception raised during dispatch.

Parameters:

• handler_input (HandlerInput) – Handler Input instance.
• exception (Exception) – Exception raised during dispatch.

Returns:

Boolean whether handler can handle exception or not.

Return type:

bool

handle(handler_input, exception)

Process the handler input and exception.

Parameters:

• handler_input (HandlerInput) – Handler Input instance.
• exception (Exception) – Exception raised during dispatch.

Returns:

Optional response object to serve as dispatch return.

Return type:

Union[None, Response]

Response Builder Components

ask_sdk_core.response_helper.PLAIN_TEXT_TYPE = 'PlainText'

str: Helper variable for plain text type.

ask_sdk_core.response_helper.RICH_TEXT_TYPE = 'RichText'

str: Helper variable for rich text type.

class ask_sdk_core.response_helper.ResponseFactory

Bases: object

ResponseFactory is class which provides helper functions to help building a response.

speak(speech, play_behavior=None)

Say the provided speech to the user.

Parameters:

• speech (str) – the output speech sent back to the user.
• play_behavior (ask_sdk_model.ui.play_behavior.PlayBehavior) – attribute to control alexa’s speech interruption

Returns:

response factory with partial response being built and access from self.response.

Return type:

ResponseFactory

ask(reprompt, play_behavior=None)

Provide reprompt speech to the user, if no response for 8 seconds.

The should_end_session value will be set to false except when the video app launch directive is present in directives.

Parameters:

• reprompt (str) – the output speech to reprompt.
• play_behavior (ask_sdk_model.ui.play_behavior.PlayBehavior) – attribute to control alexa’s speech interruption

Returns:

response factory with partial response being built and access from self.response.

Return type:

ResponseFactory

set_card(card)

Renders a card within the response.

For more information about card object in response, click here: https://developer.amazon.com/docs/custom-skills/request-and-response-json-reference.html#card-object.

Parameters:card (ask_sdk_model.ui.card.Card) – card object in response sent back to user. Returns:response factory with partial response being built and access from self.response. Return type:ResponseFactory

add_directive(directive)

Adds directive to response.

Parameters:directive (ask_sdk_model.directive.Directive) – the directive sent back to Alexa device. Returns:response factory with partial response being built and access from self.response. Return type:ResponseFactory

set_should_end_session(should_end_session)

Sets shouldEndSession value to null/false/true.

Parameters:should_end_session (bool) – value to show if the session should be ended or not. Returns:response factory with partial response being built and access from self.response. Return type:ResponseFactory

set_can_fulfill_intent(can_fulfill_intent)

Sets CanFulfill intent to the response.

For more information on CanFulfillIntent, check the name-free interaction doc here: https://developer.amazon.com/docs/custom-skills/understand-name-free-interaction-for-custom-skills.html

Parameters:can_fulfill_intent (CanFulfillIntent) – CanFulfill Intent sent back in response. Returns:response factory with partial response being built and access from self.response. Return type:ResponseFactory

ask_sdk_core.response_helper.get_plain_text_content(primary_text=None, secondary_text=None, tertiary_text=None)

Responsible for building plain text content object using ask-sdk-model in Alexa skills kit display interface. https://developer.amazon.com/docs/custom-skills/display-interface-reference.html#textcontent-object-specifications.

Parameters:

• primary_text ((optional) str) – Text for primary_text field
• secondary_text ((optional) str) – Text for secondary_text field
• tertiary_text ((optional) str) – Text for tertiary_text field

Returns:

Text Content instance with primary, secondary and tertiary text set as Plain Text objects.

Return type:

TextContent

Raises:

ValueError

ask_sdk_core.response_helper.get_rich_text_content(primary_text=None, secondary_text=None, tertiary_text=None)

Responsible for building plain text content object using ask-sdk-model in Alexa skills kit display interface. https://developer.amazon.com/docs/custom-skills/display-interface-reference.html#textcontent-object-specifications.

Parameters:

• primary_text ((optional) str) – Text for primary_text field
• secondary_text ((optional) str) – Text for secondary_text field
• tertiary_text ((optional) str) – Text for tertiary_text field

Returns:

Text Content instance with primary, secondary and tertiary text set as Rich Text objects.

Return type:

TextContent

Raises:

ValueError

ask_sdk_core.response_helper.get_text_content(primary_text=None, primary_text_type='PlainText', secondary_text=None, secondary_text_type='PlainText', tertiary_text=None, tertiary_text_type='PlainText')

Responsible for building text content object using ask-sdk-model in Alexa skills kit display interface. https://developer.amazon.com/docs/custom-skills/display-interface-reference.html#textcontent-object-specifications.

Parameters:

• primary_text ((optional) str) – Text for primary_text field
• primary_text_type ((optional) str) – Type of the primary text field. Allowed values are PlainText and RichText. Defaulted to PlainText.
• secondary_text ((optional) str) – Text for secondary_text field
• secondary_text_type – Type of the secondary text field. Allowed values are PlainText and RichText. Defaulted to PlainText.
• tertiary_text ((optional) str) – Text for tertiary_text field
• tertiary_text_type – Type of the tertiary text field. Allowed values are PlainText and RichText. Defaulted to PlainText.

Returns:

Text Content instance with primary, secondary and tertiary text set.

Return type:

TextContent

Raises:

ValueError

Skill Components

class ask_sdk_core.skill.SkillConfiguration(request_mappers, handler_adapters, request_interceptors=None, response_interceptors=None, exception_mapper=None, persistence_adapter=None, api_client=None, custom_user_agent=None, skill_id=None)

Bases: ask_sdk_runtime.skill.RuntimeConfiguration

Configuration Object that represents standard components needed to build Skill.

Parameters:

• request_mappers (list(GenericRequestMapper)) – List of request mapper instances.
• handler_adapters (list(GenericHandlerAdapter)) – List of handler adapter instances.
• request_interceptors (list( ask_sdk_core.dispatch_components.request_components.AbstractRequestInterceptor)) – List of request interceptor instances.
• response_interceptors (list( ask_sdk_core.dispatch_components.request_components.AbstractResponseInterceptor)) – List of response interceptor instances.
• exception_mapper (GenericExceptionMapper) – Exception mapper instance.
• persistence_adapter (AbstractPersistenceAdapter) – Persistence adapter instance.
• api_client (ask_sdk_model.services.api_client.ApiClient) – Api Client instance.
• custom_user_agent (str) – Custom User Agent string
• skill_id (str) – ID of the skill.

class ask_sdk_core.skill.CustomSkill(skill_configuration)

Bases: ask_sdk_runtime.skill.AbstractSkill

Top level container for Request Dispatcher, Persistence Adapter and Api Client.

Parameters:skill_configuration (SkillConfiguration) – Configuration object that holds information about different components needed to build the skill object.

supports(request_envelope, context)

Check if request envelope is of the expected skill format.

Parameters:

• request_envelope (Dict[str, Any]) – input instance containing request information.
• context (Any) – Context passed during invocation

Returns:

boolean if this type of request can be handled by this skill.

Return type:

bool

invoke(request_envelope, context)

Invokes the dispatcher, to handle the request envelope and return a response envelope.

Parameters:

• request_envelope (RequestEnvelope) – Request Envelope instance containing request information
• context (Any) – Context passed during invocation

Returns:

Response Envelope generated by handling the request

Return type:

ResponseEnvelope

class ask_sdk_core.skill_builder.SkillBuilder

Bases: ask_sdk_runtime.skill_builder.AbstractSkillBuilder

Skill Builder with helper functions for building ask_sdk_core.skill.Skill object.

skill_configuration

Create the skill configuration object using the registered components.

create()

Create a skill object using the registered components.

Returns:a skill object that can be used for invocation. Return type:Skill

lambda_handler()

Create a handler function that can be used as handler in AWS Lambda console.

The lambda handler provides a handler function, that acts as an entry point to the AWS Lambda console. Users can set the lambda_handler output to a variable and set the variable as AWS Lambda Handler on the console.

As mentioned in the AWS Lambda Handler docs, the handler function receives the event attribute as a str representing the input request envelope JSON from Alexa service, which is deserialized to ask_sdk_model.request_envelope.RequestEnvelope, before invoking the skill. The output from the handler function would be the serialized ask_sdk_model.response_envelope.ResponseEnvelope class from the appropriate skill handler.

Returns:Handler function to tag on AWS Lambda console.

add_custom_user_agent(user_agent)

Adds the user agent to the skill instance.

This method adds the passed in user_agent to the skill, which is reflected in the skill’s response envelope.

Parameters:user_agent (str) – Custom User Agent string provided by the developer. Return type:None

add_renderer(renderer)

Register renderer to generate template responses.

Parameters:renderer (ask_sdk_runtime.view_resolvers.AbstractTemplateRenderer) – Renderer to render the template

add_exception_handler(exception_handler)

Register input to the exception handlers list.

Parameters:exception_handler (ask_sdk_runtime.dispatch_components.request_components.AbstractExceptionHandler) – Exception Handler instance to be registered. Returns:None

add_global_request_interceptor(request_interceptor)

Register input to the global request interceptors list.

Parameters:request_interceptor (ask_sdk_runtime.dispatch_components.request_components.AbstractRequestInterceptor) – Request Interceptor instance to be registered. Returns:None

add_global_response_interceptor(response_interceptor)

Register input to the global response interceptors list.

Parameters:response_interceptor (ask_sdk_runtime.dispatch_components.request_components.AbstractResponseInterceptor) – Response Interceptor instance to be registered. Returns:None

add_loader(loader)

Register input to loaders list.

Parameters:loader (ask_sdk_runtime.view_resolvers.AbstractTemplateLoader) – Loader to load template from a specific data source

add_loaders(loaders)

Register input to the loaders list.

Parameters:loaders (ask_sdk_runtime.view_resolvers.AbstractTemplateLoader) – List of loaders

add_request_handler(request_handler)

Register input to the request handlers list.

Parameters:request_handler (ask_sdk_runtime.dispatch_components.request_components.AbstractRequestHandler) – Request Handler instance to be registered. Returns:None

exception_handler(can_handle_func)

Decorator that can be used to add exception handlers easily to the builder.

The can_handle_func has to be a Callable instance, which takes two parameters and no varargs or kwargs. This is because of the ExceptionHandler class signature restrictions. The returned wrapper function can be applied as a decorator on any function that processes the exception raised during dispatcher and returns a response object by the skill. The function should follow the signature of the handle function in ask_sdk_runtime.dispatch_components.exception_components.AbstractExceptionHandler class.

Parameters:can_handle_func (Callable[[Input, Exception], bool]) – The function that validates if the exception can be handled. Returns:Wrapper function that can be decorated on a handle function.

global_request_interceptor()

Decorator that can be used to add global request interceptors easily to the builder.

The returned wrapper function can be applied as a decorator on any function that processes the input. The function should follow the signature of the process function in ask_sdk_runtime.dispatch_components.request_components.AbstractRequestInterceptor class.

Returns:Wrapper function that can be decorated on a interceptor process function.

global_response_interceptor()

Decorator that can be used to add global response interceptors easily to the builder.

The returned wrapper function can be applied as a decorator on any function that processes the input and the response generated by the request handler. The function should follow the signature of the process function in ask_sdk_runtime.dispatch_components.request_components.AbstractResponseInterceptor class.

Returns:Wrapper function that can be decorated on a interceptor process function.

request_handler(can_handle_func)

Decorator that can be used to add request handlers easily to the builder.

The can_handle_func has to be a Callable instance, which takes a single parameter and no varargs or kwargs. This is because of the RequestHandler class signature restrictions. The returned wrapper function can be applied as a decorator on any function that returns a response object by the skill. The function should follow the signature of the handle function in ask_sdk_runtime.dispatch_components.request_components.AbstractRequestHandler class.

Parameters:can_handle_func (Callable[[Input], bool]) – The function that validates if the request can be handled. Returns:Wrapper function that can be decorated on a handle function.

class ask_sdk_core.skill_builder.CustomSkillBuilder(persistence_adapter=None, api_client=None)

Bases: ask_sdk_core.skill_builder.SkillBuilder

Skill Builder with api client and persistence adapter setter functions.

skill_configuration

Create the skill configuration object using the registered components.

add_custom_user_agent(user_agent)

Adds the user agent to the skill instance.

This method adds the passed in user_agent to the skill, which is reflected in the skill’s response envelope.

Parameters:user_agent (str) – Custom User Agent string provided by the developer. Return type:None

add_exception_handler(exception_handler)

Register input to the exception handlers list.

Parameters:exception_handler (ask_sdk_runtime.dispatch_components.request_components.AbstractExceptionHandler) – Exception Handler instance to be registered. Returns:None

add_global_request_interceptor(request_interceptor)

Register input to the global request interceptors list.

Parameters:request_interceptor (ask_sdk_runtime.dispatch_components.request_components.AbstractRequestInterceptor) – Request Interceptor instance to be registered. Returns:None

add_global_response_interceptor(response_interceptor)

Register input to the global response interceptors list.

Parameters:response_interceptor (ask_sdk_runtime.dispatch_components.request_components.AbstractResponseInterceptor) – Response Interceptor instance to be registered. Returns:None

add_loader(loader)

Register input to loaders list.

Parameters:loader (ask_sdk_runtime.view_resolvers.AbstractTemplateLoader) – Loader to load template from a specific data source

add_loaders(loaders)

Register input to the loaders list.

Parameters:loaders (ask_sdk_runtime.view_resolvers.AbstractTemplateLoader) – List of loaders

add_renderer(renderer)

Register renderer to generate template responses.

Parameters:renderer (ask_sdk_runtime.view_resolvers.AbstractTemplateRenderer) – Renderer to render the template

add_request_handler(request_handler)

Register input to the request handlers list.

Parameters:request_handler (ask_sdk_runtime.dispatch_components.request_components.AbstractRequestHandler) – Request Handler instance to be registered. Returns:None

create()

Create a skill object using the registered components.

Returns:a skill object that can be used for invocation. Return type:Skill

exception_handler(can_handle_func)

Decorator that can be used to add exception handlers easily to the builder.

The can_handle_func has to be a Callable instance, which takes two parameters and no varargs or kwargs. This is because of the ExceptionHandler class signature restrictions. The returned wrapper function can be applied as a decorator on any function that processes the exception raised during dispatcher and returns a response object by the skill. The function should follow the signature of the handle function in ask_sdk_runtime.dispatch_components.exception_components.AbstractExceptionHandler class.

Parameters:can_handle_func (Callable[[Input, Exception], bool]) – The function that validates if the exception can be handled. Returns:Wrapper function that can be decorated on a handle function.

global_request_interceptor()

Decorator that can be used to add global request interceptors easily to the builder.

The returned wrapper function can be applied as a decorator on any function that processes the input. The function should follow the signature of the process function in ask_sdk_runtime.dispatch_components.request_components.AbstractRequestInterceptor class.

Returns:Wrapper function that can be decorated on a interceptor process function.

global_response_interceptor()

Decorator that can be used to add global response interceptors easily to the builder.

The returned wrapper function can be applied as a decorator on any function that processes the input and the response generated by the request handler. The function should follow the signature of the process function in ask_sdk_runtime.dispatch_components.request_components.AbstractResponseInterceptor class.

Returns:Wrapper function that can be decorated on a interceptor process function.

lambda_handler()

Create a handler function that can be used as handler in AWS Lambda console.

The lambda handler provides a handler function, that acts as an entry point to the AWS Lambda console. Users can set the lambda_handler output to a variable and set the variable as AWS Lambda Handler on the console.

As mentioned in the AWS Lambda Handler docs, the handler function receives the event attribute as a str representing the input request envelope JSON from Alexa service, which is deserialized to ask_sdk_model.request_envelope.RequestEnvelope, before invoking the skill. The output from the handler function would be the serialized ask_sdk_model.response_envelope.ResponseEnvelope class from the appropriate skill handler.

Returns:Handler function to tag on AWS Lambda console.

request_handler(can_handle_func)

Decorator that can be used to add request handlers easily to the builder.

The can_handle_func has to be a Callable instance, which takes a single parameter and no varargs or kwargs. This is because of the RequestHandler class signature restrictions. The returned wrapper function can be applied as a decorator on any function that returns a response object by the skill. The function should follow the signature of the handle function in ask_sdk_runtime.dispatch_components.request_components.AbstractRequestHandler class.

Parameters:can_handle_func (Callable[[Input], bool]) – The function that validates if the request can be handled. Returns:Wrapper function that can be decorated on a handle function.

Skill Attribute Components

class ask_sdk_core.attributes_manager.AttributesManager(request_envelope, persistence_adapter=None)

Bases: object

AttributesManager is a class that handles three level attributes: request, session and persistence.

Parameters:

• request_envelope (RequestEnvelope) – request envelope.
• persistence_adapter (AbstractPersistenceAdapter) – class used for storing and retrieving persistent attributes from persistence tier

request_attributes

Attributes stored at the Request level of the skill lifecycle.

Returns:request attributes for the request life cycle Return type:Dict[str, object]

session_attributes

Attributes stored at the Session level of the skill lifecycle.

Returns:session attributes extracted from request envelope Return type:Dict[str, object]

persistent_attributes

Attributes stored at the Persistence level of the skill lifecycle.

Returns:persistent_attributes retrieved from persistence adapter Return type:Dict[str, object] Raises:ask_sdk_core.exceptions.AttributesManagerException if trying to get persistent attributes without persistence adapter

save_persistent_attributes()

Save persistent attributes to the persistence layer if a persistence adapter is provided.

Return type:None Raises:ask_sdk_core.exceptions.AttributesManagerException if trying to save persistence attributes without persistence adapter

delete_persistent_attributes()

Deletes the persistent attributes from the persistence layer.

Return type:None Raises::py:class: ask_sdk_core.exceptions.AttributesManagerException if trying to delete persistence attributes without persistence adapter

Abstract Classes

class ask_sdk_core.attributes_manager.AbstractPersistenceAdapter

Bases: object

Abstract class for storing and retrieving persistent attributes from persistence tier given request envelope.

User needs to implement get_attributes method to get attributes from persistent tier and save_attributes method to save attributes to persistent tier.

get_attributes(request_envelope)

Get attributes from persistent tier.

Parameters:request_envelope (RequestEnvelope) – Request Envelope from Alexa service Returns:A dictionary of attributes retrieved from persistent tier Return type:Dict[str, object]

save_attributes(request_envelope, attributes)

Save attributes to persistent tier.

Parameters:

• request_envelope (RequestEnvelope) – request envelope.
• attributes (Dict[str, object]) – attributes to be saved to persistent tier

Return type:

None

delete_attributes(request_envelope)

Delete attributes from persistent tier.

Parameters:request_envelope (RequestEnvelope) – request envelope. Return type:None

API Client

class ask_sdk_core.api_client.DefaultApiClient

Bases: ask_sdk_model.services.api_client.ApiClient

Default ApiClient implementation of ask_sdk_model.services.api_client.ApiClient using the requests library.

invoke(request)

Dispatches a request to an API endpoint described in the request.

Resolves the method from input request object, converts the list of header tuples to the required format (dict) for the requests lib call and invokes the method with corresponding parameters on requests library. The response from the call is wrapped under the ApiClientResponse object and the responsibility of translating a response code and response/ error lies with the caller.

Parameters:request (ApiClientRequest) – Request to dispatch to the ApiClient Returns:Response from the client call Return type:ApiClientResponse Raises:ask_sdk_core.exceptions.ApiClientException

SDK Exceptions

exception ask_sdk_core.exceptions.AttributesManagerException

Bases: ask_sdk_runtime.exceptions.AskSdkException

Class for exceptions raised during handling attributes logic

exception ask_sdk_core.exceptions.SerializationException

Bases: ask_sdk_runtime.exceptions.AskSdkException

Class for exceptions raised during serialization/deserialization.

exception ask_sdk_core.exceptions.PersistenceException

Bases: ask_sdk_runtime.exceptions.AskSdkException

Exception class for Persistence Adapter processing.

exception ask_sdk_core.exceptions.ApiClientException

Bases: ask_sdk_runtime.exceptions.AskSdkException

Exception class for ApiClient Adapter processing.

exception ask_sdk_core.exceptions.TemplateLoaderException

Bases: ask_sdk_runtime.exceptions.AskSdkException

Exception class for Template Loaders

exception ask_sdk_core.exceptions.TemplateRendererException

Bases: ask_sdk_runtime.exceptions.AskSdkException

Exception class for Template Renderer

Default Serializer

class ask_sdk_core.serialize.DefaultSerializer

Bases: ask_sdk_model.services.serializer.Serializer

serialize(obj)

Builds a serialized object.

• If obj is None, return None.
• If obj is str, int, long, float, bool, return directly.
• If obj is datetime.datetime, datetime.date convert to string in iso8601 format.
• If obj is list, serialize each element in the list.
• If obj is dict, return the dict with serialized values.
• If obj is ask sdk model, return the dict with keys resolved from the union of model’s attribute_map and deserialized_types and values serialized based on deserialized_types.
• If obj is a generic class instance, return the dict with keys from instance’s deserialized_types and values serialized based on deserialized_types.

Parameters:obj (object) – The data to serialize. Returns:The serialized form of data. Return type:Union[Dict[str, Any], List, Tuple, str, int, float, bytes, None]

deserialize(payload, obj_type)

Deserializes payload into an instance of provided obj_type.

The obj_type parameter can be a primitive type, a generic model object or a list / dict of model objects.

The list or dict object type has to be provided as a string format. For eg:

• 'list[a.b.C]' if the payload is a list of instances of class a.b.C.
• 'dict(str, a.b.C)' if the payload is a dict containing mappings of str : a.b.C class instance types.

The method looks for a deserialized_types dict in the model class, that mentions which payload values has to be deserialized. In case the payload key names are different than the model attribute names, the corresponding mapping can be provided in another special dict attribute_map. The model class should also have the __init__ method with default values for arguments. Check ask_sdk_model.request_envelope.RequestEnvelope source code for an example implementation.

Parameters:

• payload (str) – data to be deserialized.
• obj_type (Union[object, str]) – resolved class name for deserialized object

Returns:

deserialized object

Return type:

object

Raises:

ask_sdk_core.exceptions.SerializationException

General Utilities

ask_sdk_core.utils.predicate.is_canfulfill_intent_name(name)

A predicate function returning a boolean, when name matches the intent name in a CanFulfill Intent Request.

The function can be applied on a ask_sdk_core.handler_input.HandlerInput, to check if the input is of ask_sdk_model.intent_request.CanFulfillIntentRequest type and if the name of the request matches with the passed name.

Parameters:name (str) – Name to be matched with the CanFulfill Intent Request Name Returns:Predicate function that can be used to check name of the request Return type:Callable[[HandlerInput], bool]

ask_sdk_core.utils.predicate.is_intent_name(name)

A predicate function returning a boolean, when name matches the name in Intent Request.

The function can be applied on a ask_sdk_core.handler_input.HandlerInput, to check if the input is of ask_sdk_model.intent_request.IntentRequest type and if the name of the request matches with the passed name.

Parameters:name (str) – Name to be matched with the Intent Request Name Returns:Predicate function that can be used to check name of the request Return type:Callable[[HandlerInput], bool]

ask_sdk_core.utils.predicate.is_request_type(request_type)

A predicate function returning a boolean, when request type is the passed-in type.

The function can be applied on a ask_sdk_core.handler_input.HandlerInput, to check if the input request type is the passed in request type.

Parameters:request_type (str) – request type to be matched with the input’s request Returns:Predicate function that can be used to check the type of the request Return type:Callable[[HandlerInput], bool]

class ask_sdk_core.utils.viewport.OrderedEnum

Bases: enum.Enum

An enumeration.

class ask_sdk_core.utils.viewport.Density

Bases: ask_sdk_core.utils.viewport.OrderedEnum

An enumeration.

XLOW = 0

LOW = 1

MEDIUM = 2

HIGH = 3

XHIGH = 4

XXHIGH = 5

class ask_sdk_core.utils.viewport.Orientation

Bases: ask_sdk_core.utils.viewport.OrderedEnum

An enumeration.

LANDSCAPE = 0

EQUAL = 1

PORTRAIT = 2

class ask_sdk_core.utils.viewport.Size

Bases: ask_sdk_core.utils.viewport.OrderedEnum

An enumeration.

XSMALL = 0

SMALL = 1

MEDIUM = 2

LARGE = 3

XLARGE = 4

class ask_sdk_core.utils.viewport.ViewportProfile

Bases: enum.Enum

An enumeration.

HUB_ROUND_SMALL = 'HUB_ROUND_SMALL'

HUB_LANDSCAPE_SMALL = 'HUB_LANDSCAPE_SMALL'

HUB_LANDSCAPE_MEDIUM = 'HUB_LANDSCAPE_MEDIUM'

HUB_LANDSCAPE_LARGE = 'HUB_LANDSCAPE_LARGE'

MOBILE_LANDSCAPE_SMALL = 'MOBILE_LANDSCAPE_SMALL'

MOBILE_PORTRAIT_SMALL = 'MOBILE_PORTRAIT_SMALL'

MOBILE_LANDSCAPE_MEDIUM = 'MOBILE_LANDSCAPE_MEDIUM'

MOBILE_PORTRAIT_MEDIUM = 'MOBILE_PORTRAIT_MEDIUM'

TV_LANDSCAPE_XLARGE = 'TV_LANDSCAPE_XLARGE'

TV_PORTRAIT_MEDIUM = 'TV_PORTRAIT_MEDIUM'

TV_LANDSCAPE_MEDIUM = 'TV_LANDSCAPE_MEDIUM'

UNKNOWN_VIEWPORT_PROFILE = 'UNKNOWN_VIEWPORT_PROFILE'

ask_sdk_core.utils.viewport.get_orientation(width, height)

Get viewport orientation from given width and height.

Returns:viewport orientation enum Return type:Orientation

ask_sdk_core.utils.viewport.get_size(size)

Get viewport size from given size.

Returns:viewport size enum Return type:Size

ask_sdk_core.utils.viewport.get_dpi_group(dpi)

Get viewport density group from given dpi.

Returns:viewport density group enum Return type:Density

ask_sdk_core.utils.viewport.get_viewport_profile(request_envelope)

Utility method, to get viewport profile.

The viewport profile is calculated using the shape, current pixel width and height, along with the dpi.

If there is no viewport value in request_envelope.context, then an ViewportProfile.UNKNOWN_VIEWPORT_PROFILE is returned.

Parameters:request_envelope (ask_sdk_model.request_envelope.RequestEnvelope) – The alexa request envelope object Returns:Calculated Viewport Profile enum Return type:ViewportProfile

ask_sdk_core.utils.request_util.get_locale(handler_input)

Return locale value from input request.

The method returns the locale value present in the request. More information about the locale can be found here : https://developer.amazon.com/docs/custom-skills/request-and-response-json-reference.html#request-locale

Parameters:handler_input (ask_sdk_core.handler_input.HandlerInput) – The handler input instance that is generally passed in the sdk’s request and exception components Returns:Locale value from the request Return type:str

ask_sdk_core.utils.request_util.get_request_type(handler_input)

Return the type of the input request.

The method retrieves the request type of the input request. More information about the different request types are mentioned here : https://developer.amazon.com/docs/custom-skills/request-and-response-json-reference.html#request-body-parameters

Parameters:handler_input (ask_sdk_core.handler_input.HandlerInput) – The handler input instance that is generally passed in the sdk’s request and exception components Returns:Type value of the input request Return type:str

ask_sdk_core.utils.request_util.get_intent_name(handler_input)

Return the name of the intent request.

The method retrieves the intent name from the input request, only if the input request is an ask_sdk_model.intent_request.IntentRequest. If the input is not an IntentRequest, a TypeError is raised.

Parameters:handler_input (ask_sdk_core.handler_input.HandlerInput) – The handler input instance that is generally passed in the sdk’s request and exception components Returns:Name of the intent request Return type:str Raises:TypeError

ask_sdk_core.utils.request_util.get_account_linking_access_token(handler_input)

Return the access token in the request.

The method retrieves the user’s accessToken from the input request. Once a user successfully enables a skill and links their Alexa account to the skill, the input request will have the user’s access token. A None value is returned if there is no access token in the input request. More information on this can be found here : https://developer.amazon.com/docs/account-linking/add-account-linking-logic-custom-skill.html

Parameters:handler_input (ask_sdk_core.handler_input.HandlerInput) – The handler input instance that is generally passed in the sdk’s request and exception components Returns:User account linked access token if available. None if not available Return type:Optional[str]

ask_sdk_core.utils.request_util.get_api_access_token(handler_input)

Return the api access token in the request.

The method retrieves the apiAccessToken from the input request, which has the encapsulated information of permissions granted by the user. This token can be used to call Alexa-specific APIs. More information about this can be found here : https://developer.amazon.com/docs/custom-skills/request-and-response-json-reference.html#system-object

The SDK already includes this token in the API calls done through the service_client_factory in ask_sdk_core.handler_input.HandlerInput.

Parameters:handler_input (ask_sdk_core.handler_input.HandlerInput) – The handler input instance that is generally passed in the sdk’s request and exception components Returns:Api access token from the input request, which encapsulates any permissions consented by the user Return type:str

ask_sdk_core.utils.request_util.get_device_id(handler_input)

Return the device id from the input request.

The method retrieves the deviceId property from the input request. This value uniquely identifies the device and is generally used as input for some Alexa-specific API calls. More information about this can be found here : https://developer.amazon.com/docs/custom-skills/request-and-response-json-reference.html#system-object

If there is no device information in the input request, then a None is returned.

Parameters:handler_input (ask_sdk_core.handler_input.HandlerInput) – The handler input instance that is generally passed in the sdk’s request and exception components Returns:Unique device id of the device used to send the alexa request or None if device information is not present Return type:Optional[str]

ask_sdk_core.utils.request_util.get_dialog_state(handler_input)

Return the dialog state enum from the intent request.

The method retrieves the dialogState from the intent request, if the skill’s interaction model includes a dialog model. This can be used to determine the current status of user conversation and return the appropriate dialog directives if the conversation is not yet complete. More information on dialog management can be found here : https://developer.amazon.com/docs/custom-skills/define-the-dialog-to-collect-and-confirm-required-information.html

The method returns a None if there is no dialog model added or if the intent doesn’t have dialog management. The method raises a TypeError if the input is not an IntentRequest.

Parameters:handler_input (ask_sdk_core.handler_input.HandlerInput) – The handler input instance that is generally passed in the sdk’s request and exception components. Returns:State of the dialog model from the intent request. Return type:Optional[ask_sdk_model.dialog_state.DialogState] Raises:TypeError if the input is not an IntentRequest

ask_sdk_core.utils.request_util.get_slot(handler_input, slot_name)

Return the slot information from intent request.

The method retrieves the slot information ask_sdk_model.slot.Slot from the input intent request for the given slot_name. More information on the slots can be found here : https://developer.amazon.com/docs/custom-skills/request-types-reference.html#slot-object

If there is no such slot, then a None is returned. If the input request is not an ask_sdk_model.intent_request.IntentRequest, a TypeError is raised.

Parameters:

• handler_input (ask_sdk_core.handler_input.HandlerInput) – The handler input instance that is generally passed in the sdk’s request and exception components
• slot_name (str) – Name of the slot that needs to be retrieved

Returns:

Slot information for the provided slot name if it exists, or a None value

Return type:

Optional[ask_sdk_model.slot.Slot]

Raises:

TypeError if the input is not an IntentRequest

ask_sdk_core.utils.request_util.get_slot_value(handler_input, slot_name)

Return the slot value from intent request.

The method retrieves the slot value from the input intent request for the given slot_name. More information on the slots can be found here : https://developer.amazon.com/docs/custom-skills/request-types-reference.html#slot-object

If the input request is not an ask_sdk_model.intent_request.IntentRequest, a TypeError is raised.

Parameters:

• handler_input (ask_sdk_core.handler_input.HandlerInput) – The handler input instance that is generally passed in the sdk’s request and exception components
• slot_name (str) – Name of the slot for which the value has to be retrieved

Returns:

Slot value for the provided slot if it exists

Return type:

str

Raises:

TypeError if the input is not an IntentRequest.

ask_sdk_core.utils.request_util.get_supported_interfaces(handler_input)

Retrieves the supported interfaces from input request.

The method returns an ask_sdk_model.supported_interfaces.SupportedInterfaces object instance listing each interface that the device supports. For example, if supported_interfaces includes audio_player, then you know that the device supports streaming audio using the AudioPlayer interface. More information on supportedInterfaces can be found here : https://developer.amazon.com/docs/custom-skills/request-and-response-json-reference.html#system-object

Parameters:handler_input (ask_sdk_core.handler_input.HandlerInput) – The handler input instance that is generally passed in the sdk’s request and exception components Returns:Instance of ask_sdk_model.supported_interfaces.SupportedInterfaces mentioning which all interfaces the device supports Return type:ask_sdk_model.supported_interfaces.SupportedInterfaces

ask_sdk_core.utils.request_util.is_new_session(handler_input)

Return if the session is new for the input request.

The method retrieves the new value from the input request’s session, which indicates if it’s a new session or not. The ask_sdk_model.session.Session is only included on all standard requests except AudioPlayer, VideoApp and PlaybackController requests. More information can be found here : https://developer.amazon.com/docs/custom-skills/request-and-response-json-reference.html#session-object

A TypeError is raised if the input request doesn’t have the session information.

Parameters:handler_input (ask_sdk_core.handler_input.HandlerInput) – The handler input instance that is generally passed in the sdk’s request and exception components Returns:Boolean if the session is new for the input request Return type:bool Raises:TypeError if the input request doesn’t have a session

ask_sdk_core.utils.request_util.get_user_id(handler_input)

Return the userId in the request.

The method retrieves the userId from the input request. This value uniquely identifies the user and is generally used as input for some Alexa-specific API calls. More information about this can be found here: https://developer.amazon.com/docs/custom-skills/request-and-response-json-reference.html#system-object :param handler_input: The handler input instance that is generally

passed in the sdk’s request and exception components

Returns:Users userId or None if not available Return type:Optional[str]

DynamoDb Persistence Adapter

DynamoDb Persistence Adapter

class ask_sdk_dynamodb.adapter.DynamoDbAdapter(table_name, partition_key_name='id', attribute_name='attributes', create_table=False, partition_keygen=<function user_id_partition_keygen>, dynamodb_resource=dynamodb.ServiceResource())

Bases: ask_sdk_core.attributes_manager.AbstractPersistenceAdapter

Persistence Adapter implementation using Amazon DynamoDb.

Amazon DynamoDb based persistence adapter implementation. This internally uses the AWS Python SDK (boto3) to process the dynamodb operations. The adapter tries to create the table if create_table is set, during initialization.

Parameters:

• table_name (str) – Name of the table to be created or used
• partition_key_name (str) – Partition key name to be used. Defaulted to ‘id’
• attribute_name (str) – Attribute name for storing and retrieving attributes from dynamodb. Defaulted to ‘attributes’
• create_table (bool) – Should the adapter try to create the table if it doesn’t exist. Defaulted to False
• partition_keygen (Callable[[RequestEnvelope], str]) – Callable function that takes a request envelope and provides a unique partition key value. Defaulted to user id keygen function
• dynamodb_resource (boto3.resources.base.ServiceResource) – Resource to be used, to perform dynamo operations. Defaulted to resource generated from boto3

delete_attributes(request_envelope)

Deletes attributes from table in Dynamodb resource.

Deletes the attributes from Dynamodb table. Raises PersistenceException if table doesn’t exist or delete_item fails on the table.

Parameters:request_envelope (ask_sdk_model.RequestEnvelope) – Request Envelope passed during skill invocation Return type:None Raises:ask_sdk_core.exceptions.PersistenceException

get_attributes(request_envelope)

Get attributes from table in Dynamodb resource.

Retrieves the attributes from Dynamodb table. If the table doesn’t exist, returns an empty dict if the create_table variable is set as True, else it raises PersistenceException. Raises PersistenceException if get_item fails on the table.

Parameters:request_envelope (ask_sdk_model.RequestEnvelope) – Request Envelope passed during skill invocation Returns:Attributes stored under the partition keygen mapping in the table Return type:Dict[str, object] Raises:ask_sdk_core.exceptions.PersistenceException

save_attributes(request_envelope, attributes)

Saves attributes to table in Dynamodb resource.

Saves the attributes into Dynamodb table. Raises PersistenceException if table doesn’t exist or put_item fails on the table.

Parameters:

• request_envelope (ask_sdk_model.RequestEnvelope) – Request Envelope passed during skill invocation
• attributes (Dict[str, object]) – Attributes stored under the partition keygen mapping in the table

Return type:

None

Raises:

ask_sdk_core.exceptions.PersistenceException

Partition Key Generator Functions

ask_sdk_dynamodb.partition_keygen.device_id_partition_keygen(request_envelope)

Retrieve device id from request envelope, to use as partition key.

Parameters:request_envelope (ask_sdk_model.RequestEnvelope) – Request Envelope passed during skill invocation Returns:Device Id retrieved from request envelope Return type:str Raises:ask_sdk_core.exceptions.PersistenceException

ask_sdk_dynamodb.partition_keygen.person_id_partition_keygen(request_envelope)

Retrieve person id from request envelope, to use as object key.

This method retrieves the person id specific to a voice profile from the request envelope if it exists, to be used as an object key. If it doesn’t exist, then the user id is returned instead.

Parameters:request_envelope (ask_sdk_model.RequestEnvelope) – Request Envelope passed during skill invocation Returns:person Id retrieved from request envelope if exists, else fall back on User Id Return type:str Raises:ask_sdk_core.exceptions.PersistenceException

ask_sdk_dynamodb.partition_keygen.user_id_partition_keygen(request_envelope)

Retrieve user id from request envelope, to use as partition key.

Parameters:request_envelope (ask_sdk_model.RequestEnvelope) – Request Envelope passed during skill invocation Returns:User Id retrieved from request envelope Return type:str Raises:ask_sdk_core.exceptions.PersistenceException

Standard

Standard Skill Builder

class ask_sdk.standard.StandardSkillBuilder(table_name=None, auto_create_table=None, partition_keygen=None, dynamodb_client=None)

Bases: ask_sdk_core.skill_builder.SkillBuilder

Skill Builder with api client and db adapter coupling to Skill.

Standard Skill Builder is an implementation of ask_sdk_core.skill_builder.SkillBuilder with coupling of DynamoDb Persistence Adapter settings and a Default Api Client added to the ask_sdk_core.skill.Skill.

Parameters:

• table_name (str) – Name of the table to be created or used
• auto_create_table (bool) – Should the adapter try to create the table if it doesn’t exist.
• partition_keygen (Callable[[RequestEnvelope], str]) – Callable function that takes a request envelope and provides a unique partition key value.
• dynamodb_client (boto3.resources.base.ServiceResource) – Resource to be used, to perform dynamo operations.

add_custom_user_agent(user_agent)

Adds the user agent to the skill instance.

This method adds the passed in user_agent to the skill, which is reflected in the skill’s response envelope.

Parameters:user_agent (str) – Custom User Agent string provided by the developer. Return type:None

add_exception_handler(exception_handler)

Register input to the exception handlers list.

Parameters:exception_handler (ask_sdk_runtime.dispatch_components.request_components.AbstractExceptionHandler) – Exception Handler instance to be registered. Returns:None

add_global_request_interceptor(request_interceptor)

Register input to the global request interceptors list.

Parameters:request_interceptor (ask_sdk_runtime.dispatch_components.request_components.AbstractRequestInterceptor) – Request Interceptor instance to be registered. Returns:None

add_global_response_interceptor(response_interceptor)

Register input to the global response interceptors list.

Parameters:response_interceptor (ask_sdk_runtime.dispatch_components.request_components.AbstractResponseInterceptor) – Response Interceptor instance to be registered. Returns:None

add_loader(loader)

Register input to loaders list.

Parameters:loader (ask_sdk_runtime.view_resolvers.AbstractTemplateLoader) – Loader to load template from a specific data source

add_loaders(loaders)

Register input to the loaders list.

Parameters:loaders (ask_sdk_runtime.view_resolvers.AbstractTemplateLoader) – List of loaders

add_renderer(renderer)

Register renderer to generate template responses.

Parameters:renderer (ask_sdk_runtime.view_resolvers.AbstractTemplateRenderer) – Renderer to render the template

add_request_handler(request_handler)

Register input to the request handlers list.

Parameters:request_handler (ask_sdk_runtime.dispatch_components.request_components.AbstractRequestHandler) – Request Handler instance to be registered. Returns:None

create()

Create a skill object using the registered components.

Returns:a skill object that can be used for invocation. Return type:Skill

exception_handler(can_handle_func)

Decorator that can be used to add exception handlers easily to the builder.

The can_handle_func has to be a Callable instance, which takes two parameters and no varargs or kwargs. This is because of the ExceptionHandler class signature restrictions. The returned wrapper function can be applied as a decorator on any function that processes the exception raised during dispatcher and returns a response object by the skill. The function should follow the signature of the handle function in ask_sdk_runtime.dispatch_components.exception_components.AbstractExceptionHandler class.

Parameters:can_handle_func (Callable[[Input, Exception], bool]) – The function that validates if the exception can be handled. Returns:Wrapper function that can be decorated on a handle function.

global_request_interceptor()

Decorator that can be used to add global request interceptors easily to the builder.

The returned wrapper function can be applied as a decorator on any function that processes the input. The function should follow the signature of the process function in ask_sdk_runtime.dispatch_components.request_components.AbstractRequestInterceptor class.

Returns:Wrapper function that can be decorated on a interceptor process function.

global_response_interceptor()

Decorator that can be used to add global response interceptors easily to the builder.

The returned wrapper function can be applied as a decorator on any function that processes the input and the response generated by the request handler. The function should follow the signature of the process function in ask_sdk_runtime.dispatch_components.request_components.AbstractResponseInterceptor class.

Returns:Wrapper function that can be decorated on a interceptor process function.

lambda_handler()

Create a handler function that can be used as handler in AWS Lambda console.

The lambda handler provides a handler function, that acts as an entry point to the AWS Lambda console. Users can set the lambda_handler output to a variable and set the variable as AWS Lambda Handler on the console.

As mentioned in the AWS Lambda Handler docs, the handler function receives the event attribute as a str representing the input request envelope JSON from Alexa service, which is deserialized to ask_sdk_model.request_envelope.RequestEnvelope, before invoking the skill. The output from the handler function would be the serialized ask_sdk_model.response_envelope.ResponseEnvelope class from the appropriate skill handler.

Returns:Handler function to tag on AWS Lambda console.

request_handler(can_handle_func)

Decorator that can be used to add request handlers easily to the builder.

The can_handle_func has to be a Callable instance, which takes a single parameter and no varargs or kwargs. This is because of the RequestHandler class signature restrictions. The returned wrapper function can be applied as a decorator on any function that returns a response object by the skill. The function should follow the signature of the handle function in ask_sdk_runtime.dispatch_components.request_components.AbstractRequestHandler class.

Parameters:can_handle_func (Callable[[Input], bool]) – The function that validates if the request can be handled. Returns:Wrapper function that can be decorated on a handle function.

skill_configuration

Create the skill configuration object using the registered components.

Webservice Support and Framework Adapters

ask-sdk-webservice-support package

ask_sdk_webservice_support.verifier_constants module

ask_sdk_webservice_support.verifier_constants.SIGNATURE_CERT_CHAIN_URL_HEADER = 'SignatureCertChainUrl'

Header key to be used, to retrieve request header that contains the URL for the certificate chain needed to verify the request signature. For more info, check link.

ask_sdk_webservice_support.verifier_constants.SIGNATURE_HEADER = 'Signature'

Header key to be used, to retrieve request header that contains the request signature. For more info, check link.

ask_sdk_webservice_support.verifier_constants.CERT_CHAIN_URL_PROTOCOL = 'https'

Case insensitive protocol to be checked on signature certificate url. For more info, check link.

ask_sdk_webservice_support.verifier_constants.CERT_CHAIN_URL_HOSTNAME = 's3.amazonaws.com'

Case insensitive hostname to be checked on signature certificate url. For more info, check link.

ask_sdk_webservice_support.verifier_constants.CERT_CHAIN_URL_STARTPATH = '/echo.api/'

Path presence to be checked on signature certificate url. For more info, check link.

ask_sdk_webservice_support.verifier_constants.CERT_CHAIN_URL_PORT = 443

Port to be checked on signature certificate url. For more info, check link.

ask_sdk_webservice_support.verifier_constants.CERT_CHAIN_DOMAIN = 'echo-api.amazon.com'

Domain presence check in Subject Alternative Names (SANs) of signing certificate. For more info, check link.

ask_sdk_webservice_support.verifier_constants.CHARACTER_ENCODING = 'utf-8'

Character encoding used in the request.

ask_sdk_webservice_support.verifier_constants.DEFAULT_TIMESTAMP_TOLERANCE_IN_MILLIS = 150000

Default allowable tolerance in request timestamp. For more info, check link.

ask_sdk_webservice_support.verifier_constants.MAX_TIMESTAMP_TOLERANCE_IN_MILLIS = 3600000

Maximum allowable tolerance in request timestamp. For more info, check link.

ask_sdk_webservice_support.verifier module

exception ask_sdk_webservice_support.verifier.VerificationException

Bases: ask_sdk_runtime.exceptions.AskSdkException

Class for exceptions raised during Request verification.

args

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

class ask_sdk_webservice_support.verifier.AbstractVerifier

Bases: object

Abstract verifier class for implementing custom verifiers.

verify(headers, serialized_request_env, deserialized_request_env)

Abstract verify method that verifies and validates inputs.

Custom verifiers should implement this method, to validate the headers and body of the input POST request. The method returns a VerificationException if the validation fails, or succeeds silently.

Parameters:

• headers (Dict[str, Any]) – headers of the input POST request
• serialized_request_env (str) – raw request envelope in the input POST request
• deserialized_request_env (ask_sdk_model.request_envelope.RequestEnvelope) – deserialized request envelope instance of the input POST request

Raises:

VerificationException if verification fails

class ask_sdk_webservice_support.verifier.RequestVerifier(signature_cert_chain_url_key='SignatureCertChainUrl', signature_key='Signature', padding=<cryptography.hazmat.primitives.asymmetric.padding.PKCS1v15 object>, hash_algorithm=<cryptography.hazmat.primitives.hashes.SHA1 object>)

Bases: ask_sdk_webservice_support.verifier.AbstractVerifier

Verifier that performs request signature verification.

This is a concrete implementation of AbstractVerifier class, handling the request signature verification of the input request. This verifier uses the Cryptography module x509 functions to validate the signature chain in the input request. The verification follows the mechanism explained here : https://developer.amazon.com/docs/custom-skills/host-a-custom-skill-as-a-web-service.html#checking-the-signature-of-the-request

The constructor takes the header key names for retrieving Signature Certificate Chain and Signature. They are defaulted to the header names present in the ask_sdk_webservice_support.verifier_constants. Additionally, one can also provide the Padding and the Hash Algorithm function that is used to verify the input body.

The verify method retrieves the Signature Certificate Chain URL, validates the URL, retrieves the chain from the URL, validates the signing certificate, extract the public key, base64 decode the Signature and verifies if the hash value of the request body matches with the decrypted signature.

verify(headers, serialized_request_env, deserialized_request_env)

Verify if the input request signature and the body matches.

The verify method retrieves the Signature Certificate Chain URL, validates the URL, retrieves the chain from the URL, validates the signing certificate, extract the public key, base64 decode the Signature and verifies if the hash value of the request body matches with the decrypted signature.

Parameters:

• headers (Dict[str, Any]) – headers of the input POST request
• serialized_request_env (str) – raw request envelope in the input POST request
• deserialized_request_env (ask_sdk_model.request_envelope.RequestEnvelope) – deserialized request envelope instance of the input POST request

Raises:

VerificationException if headers doesn’t exist or verification fails

class ask_sdk_webservice_support.verifier.TimestampVerifier(tolerance_in_millis=150000)

Bases: ask_sdk_webservice_support.verifier.AbstractVerifier

Verifier that performs request timestamp verification.

This is a concrete implementation of AbstractVerifier class, handling the request timestamp verification of the input request. The verification follows the mechanism explained here : https://developer.amazon.com/docs/custom-skills/host-a-custom-skill-as-a-web-service.html#timestamp

The constructor takes the tolerance value in milliseconds, that is the maximum tolerance limit the input request can have, with the current timestamp.

The verify method retrieves the request timestamp and check if it falls in the limit set by the tolerance.

verify(headers, serialized_request_env, deserialized_request_env)

Verify if the input request timestamp is in tolerated limits.

The verify method retrieves the request timestamp and check if it falls in the limit set by the tolerance, by checking with the current timestamp in UTC.

Parameters:

• headers (Dict[str, Any]) – headers of the input POST request
• serialized_request_env (str) – raw request envelope in the input POST request
• deserialized_request_env (ask_sdk_model.request_envelope.RequestEnvelope) – deserialized request envelope instance of the input POST request

Raises:

VerificationException if difference between local timestamp and input request timestamp is more than specific tolerance limit

ask_sdk_webservice_support.webservice_handler module

class ask_sdk_webservice_support.webservice_handler.WebserviceSkillHandler(skill, verify_signature=True, verify_timestamp=True, verifiers=None)

Bases: object

Skill Handler for skill as webservice.

This class can be used by skill developers when they want their skills to be deployed as a web service, rather than using AWS Lambda.

The class constructor takes in a custom skill instance that is used for routing the input request. The boolean verify_signature variable configures if the request signature is verified for each input request. The boolean verify_timestamp configures if the request timestamp is verified for each input request. Additionally, an optional list of verifiers can also be provided, to be applied on the input request.

The verify_request_and_dispatch method provides the dispatch functionality that can be used as an entry point for skill invocation as web service.

verify_request_and_dispatch(http_request_headers, http_request_body)

Entry point for webservice skill invocation.

This method takes in the input request headers and request body, handles the deserialization of the input request to the ask_sdk_model.request_envelope.RequestEnvelope object, run the input through registered verifiers, invoke the skill and return the serialized response from the skill invocation.

Parameters:

• http_request_headers (Dict[str, Any]) – Request headers of the input request to the webservice
• http_request_body (str) – Raw request body of the input request to the webservice

Returns:

Serialized response object returned by the skill instance, when invoked with the input request

Return type:

str

Raises:

ask_sdk_core.exceptions.AskSdkException when skill deserialization, verification, invocation or serialization fails

---

flask-ask-sdk package

flask_ask_sdk.skill_adapter module

class flask_ask_sdk.skill_adapter.SkillAdapter(skill, skill_id, verifiers=None, app=None)

Bases: object

Provides a base interface to register skill and dispatch the request.

The class constructor takes a ask_sdk_core.skill.CustomSkill instance, the skill id, an optional list of ask_sdk_webservice_support.verifier.AbstractVerifier instances and an optional flask application. One can also use the init_app() method, to pass in a flask.Flask application instance, to instantiate the config values and the webservice handler.

The dispatch_request() function can be used to map the input request to the skill invocation. The register() function can also be used alternatively, to register the dispatch_request() function to the provided route.

By default, the ask_sdk_webservice_support.verifier.RequestVerifier and ask_sdk_webservice_support.verifier.TimestampVerifier instances are added to the skill verifier list. To disable this, set the VERIFY_SIGNATURE_APP_CONFIG and VERIFY_TIMESTAMP_APP_CONFIG app configuration values to False.

An instance of the extension is added to the application extensions mapping, under the key EXTENSION_NAME. Since multiple skills can be configured on different routes in the same application, through multiple extension instances, each extension is added as a skill id mapping under the app extensions EXTENSION_NAME dictionary.

For example, to use this class with a skill created using ask-sdk-core:

from flask import Flask
from ask_sdk_core.skill_builder import SkillBuilder
from flask_ask_sdk.skill_adapter import SkillAdapter

app = Flask(__name__)
skill_builder = SkillBuilder()
# Register your intent handlers to skill_builder object

skill_adapter = SkillAdapter(
    skill=skill_builder.create(), skill_id=<SKILL_ID>, app=app)

@app.route("/"):
def invoke_skill:
    return skill_adapter.dispatch_request()

Alternatively, you can also use the register method:

from flask import Flask
from ask_sdk_core.skill_builder import SkillBuilder
from flask_ask_sdk.skill_adapter import SkillAdapter

app = Flask(__name__)
skill_builder = SkillBuilder()
# Register your intent handlers to skill_builder object

skill_adapter = SkillAdapter(
    skill=skill_builder.create(), skill_id=<SKILL_ID>, app=app)

skill_adapter.register(app=app, route="/")

init_app(app)

Register the extension on the given Flask application.

Use this function only when no Flask application was provided in the app keyword argument to the constructor of this class.

The function sets True defaults for VERIFY_SIGNATURE_APP_CONFIG and VERIFY_TIMESTAMP_APP_CONFIG configurations. It adds the skill id: self instance mapping to the application extensions, and creates a ask_sdk_webservice_support.webservice_handler.WebserviceHandler instance, for request verification and dispatch.

Parameters:app (flask.Flask) – A flask.Flask application instance Return type:None

dispatch_request()

Method that handles request verification and routing.

This method can be used as a function to register on the URL rule. The request is verified through the registered list of verifiers, before invoking the request handlers. The method returns a JSON response for the Alexa service to respond to the request.

Returns:The skill response for the input request Return type:flask.Response Raises:werkzeug.exceptions.MethodNotAllowed if the method is invoked for other than HTTP POST request. werkzeug.exceptions.BadRequest if the verification fails. werkzeug.exceptions.InternalServerError for any internal exception.

register(app, route, endpoint=None)

Method to register the routing on the app at provided route.

This is a utility method, that can be used for registering the dispatch_request on the provided flask.Flask application at the provided URL route.

Parameters:

• app (flask.Flask) – A flask.Flask application instance
• route (str) – The URL rule where the skill dispatch has to be registered
• endpoint (str) – The endpoint for the registered URL rule. This can be used to set multiple skill endpoints on same app.

Return type:

None

Raises:

TypeError if app or route` is not provided or is of an invalid type

flask_ask_sdk.skill_adapter.EXTENSION_NAME = 'ASK_SDK_SKILL_ADAPTER'

Extension name used for saving extension instance in app.extensions

---

django-ask-sdk package

django_ask_sdk.skill_adapter module

class django_ask_sdk.skill_adapter.SkillAdapter(skill, verify_signature=True, verify_timestamp=True, verifiers=None)

Bases: django.views.generic.base.View

Provides a base interface to register skill and dispatch the request.

The class constructor takes a ask_sdk_core.skill.CustomSkill instance, an optional verify_request boolean, an optional verify_timestamp boolean and an optional list of ask_sdk_webservice_support.verifier.AbstractVerifier instances.

The post() function is the only available method on the view, that intakes the input POST request from Alexa, verifies the request and dispatch it to the skill.

By default, the ask_sdk_webservice_support.verifier.RequestVerifier and ask_sdk_webservice_support.verifier.TimestampVerifier instances are added to the skill verifier list. To disable this, set the verify_request and verify_timestamp input arguments to False respectively.

For example, if you developed a skill using an instance of ask_sdk_core.skill_builder.SkillBuilder or it’s subclasses, then to register it as an endpoint in your django app example, you can add the following in example.urls.py:

import skill
from django_ask_sdk.skill_response import SkillAdapter

view = SkillAdapter.as_view(skill=skill.sb.create())

urlpatterns = [
    path("/myskill", view, name='index')
]

skill = None

verify_signature = None

verify_timestamp = None

verifiers = None

dispatch(request, *args, **kwargs)

Inspect the HTTP method and delegate to the view method.

This is the default implementation of the django.views.View method, which will inspect the HTTP method in the input request and delegate it to the corresponding method in the view. The only allowed method on this view is post.

Parameters:request (django.http.HttpRequest) – The input request sent to the view Returns:The response from the view Return type:django.http.HttpResponse Raises:django.http.HttpResponseNotAllowed if the method is invoked for other than HTTP POST request. django.http.HttpResponseBadRequest if the request verification fails. django.http.HttpResponseServerError for any internal exception.

post(request, *args, **kwargs)

The method that handles HTTP POST request on the view.

This method is called when the view receives a HTTP POST request, which is generally the request sent from Alexa during skill invocation. The request is verified through the registered list of verifiers, before invoking the request handlers. The method returns a django.http.JsonResponse in case of successful skill invocation.

Parameters:request (django.http.HttpRequest) – The input request sent by Alexa to the skill Returns:The response from the skill to Alexa Return type:django.http.JsonResponse Raises:django.http.HttpResponseBadRequest if the request verification fails. django.http.HttpResponseServerError for any internal exception.

classmethod as_view(**initkwargs)

Main entry point for a request-response process.

http_method_names = ['get', 'post', 'put', 'patch', 'delete', 'head', 'options', 'trace']

http_method_not_allowed(request, *args, **kwargs)

options(request, *args, **kwargs)

Handle responding to requests for the OPTIONS HTTP verb.

setup(request, *args, **kwargs)

Initialize attributes shared by all view methods.

django_ask_sdk.skill_adapter.SIGNATURE_CERT_CHAIN_URL_KEY = 'HTTP_SIGNATURECERTCHAINURL'

Signature Certificate Chain URL header key in Django HTTP Headers. This is different from the header key provided by Alexa, because of Django’s HTTP Meta headers.

django_ask_sdk.skill_adapter.SIGNATURE_KEY = 'HTTP_SIGNATURE'

Signature header key in Django HTTP Headers. This is different from the header key provided by Alexa, because of Django’s HTTP Meta headers.

S3 Persistence Adapter

S3 Persistence Adapter

class ask_sdk_s3.adapter.S3Adapter(bucket_name, path_prefix=None, s3_client=None, object_keygen=<function user_id_keygen>)

Bases: ask_sdk_core.attributes_manager.AbstractPersistenceAdapter

Persistence Adapter implementation using AmazonS3.

Amazon S3 based persistence adapter implementation. This internally uses the AWS Python SDK (boto3) to process the s3 operations.

Parameters:

• bucket_name (str) – S3 bucket name to be used.
• path_prefix (str) – S3 path prefix
• s3_client (boto3.client) – S3 Client to be used. Defaulted to the s3 client generated from boto3.
• object_keygen (Callable[[ask_sdk_model.request_envelope.RequestEnvelope], str]) – Callable function that takes a request envelope and provides a unique key value. Defaulted to user id keygen function.

DEFAULT_PATH_PREFIX = ''

S3_CLIENT_NAME = 's3'

S3_OBJECT_BODY_NAME = 'Body'

delete_attributes(request_envelope)

Deletes attributes from s3 bucket.

Parameters:request_envelope (ask_sdk_model.request_envelope.RequestEnvelope) – Request Envelope passed during skill invocation Return type:None Raises:ask_sdk_core.exceptions.PersistenceException

get_attributes(request_envelope)

Retrieves the attributes from s3 bucket.

Parameters:request_envelope (ask_sdk_model.request_envelope.RequestEnvelope) – Request Envelope passed during skill invocation Returns:attributes in the s3 bucket Return type:Dict[str, object] Raises:ask_sdk_core.exceptions.PersistenceException

save_attributes(request_envelope, attributes)

Saves attributes to the s3 bucket.

Parameters:

• request_envelope (ask_sdk_model.request_envelope.RequestEnvelope) – Request Envelope passed during skill invocation
• attributes (Dict[str, object]) – attributes to store in s3

Return type:

None

Raises:

ask_sdk_core.exceptions.PersistenceException

Object Key Generator Functions

ask_sdk_s3.object_keygen.device_id_keygen(request_envelope)

Retrieve device id from request envelope.

Parameters:request_envelope (ask_sdk_model.RequestEnvelope) – Request Envelope passed during skill invocation Returns:Device Id retrieved from request envelope Return type:str Raises:ask_sdk_core.exceptions.PersistenceException

ask_sdk_s3.object_keygen.user_id_keygen(request_envelope)

Retrieve user id from request envelope, to use as object key.

Parameters:request_envelope (ask_sdk_model.RequestEnvelope) – Request Envelope passed during skill invocation Returns:User Id retrieved from request envelope Return type:str Raises:ask_sdk_core.exceptions.PersistenceException

SMAPI

SMAPI Builder Components

class ask_smapi_sdk.smapi_builder.SmapiClientBuilder

Bases: object

Abstract SmapiClient Builder for building ask_smapi_model.services.skill_management.SkillManagementServiceClient object.

api_endpoint

Returns the Endpoint to hit by the SMAPI Service.

Returns:Endpoint to hit by the SMAPI service client. Return type:str

client()

class ask_smapi_sdk.smapi_builder.StandardSmapiClientBuilder(client_id, client_secret, refresh_token)

Bases: ask_smapi_sdk.smapi_builder.SmapiClientBuilder

Standard SmapiClient Builder class used to generate ask_smapi_model.services.skill_management.SkillManagementServiceClient object with default Serializer and ApiClient implementations.

Parameters:

• client_id (str) – The ClientId value from LWA profiles.
• client_secret (str) – The ClientSecret value from LWA profiles.
• refresh_token (str) – Client refresh_token required to get access token for API calls.

client()

Creates the smapi client object using AuthenticationConfiguration and ApiConfiguration registered values.

Returns:A smapi object that can be used for making SMAPI method invocations. Return type:ask_smapi_model.services.skill_management.SkillManagementServiceClient

api_endpoint

Returns the Endpoint to hit by the SMAPI Service.

Returns:Endpoint to hit by the SMAPI service client. Return type:str

class ask_smapi_sdk.smapi_builder.CustomSmapiClientBuilder(client_id, client_secret, refresh_token, serializer=None, api_client=None)

Bases: ask_smapi_sdk.smapi_builder.SmapiClientBuilder

Smapi Custom Builder with serializer, api_client and api_endpoint setter functions.

This builder is used to create an instance of ask_smapi_model.services.skill_management.SkillManagementServiceClient with default Serializers and ApiClient implementations.

api_endpoint

Returns the Endpoint to hit by the SMAPI Service.

Returns:Endpoint to hit by the SMAPI service client. Return type:str

client()

Creates the smapi client object using AuthenticationConfiguration and ApiConfiguration registered values.

Returns:A smapi object that can be used for making SMAPI method invocations. Return type:ask_smapi_model.services.skill_management.SkillManagementServiceClient

General Utilities

ask_smapi_sdk.utils.get_header_value(header_list, key)

Filter the header_list with provided key value.

This method is used to parse through the header list obtained from the SMAPI response header object and retrieve list of specific tuple objects with keys like Location, RequestId etc if present.

Parameters:

• header_list – The list of response headers returned from Alexa SKill Management API calls.
• key – The field value which needs to be retrieved.

Type:

List[Tuple[str, str]]

Type:

str

Returns:

Returns the list field values if present, since there maybe multiple tuples with same key values.

Return type:

List[Union[None,str]]

Models Runtime :ask_sdk_model_runtime package

The Models Runtime classes contains the common models package by the Software Development Kit (SDK) team for Python that provides common implementations like Serializer, ApiClient BaseServiceClient, Authentication Configuration etc. that is used by the SDK models.

Subpackages

ask_sdk_model_runtime.lwa 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_sdk_model_runtime.lwa.access_token module

class ask_sdk_model_runtime.lwa.access_token.AccessToken(token=None, expiry=None)

Bases: object

Represents the access token provided by LWA (Login With Amazon).

This is a wrapper class over ask_sdk_model_runtime.lwa.access_token_response.AccessTokenResponse that retrieves and stores the access token, the expiry time from LWA response.

Parameters:

• token (str) – access token from LWA
• expiry (datetime) – exact timestamp in UTC datetime, which is the expiry time for this access token. This is set as the combined datetime of current system time when the LWA response is received and the expiry time in seconds, provided in the LWA response.

ask_sdk_model_runtime.lwa.access_token_request module

class ask_sdk_model_runtime.lwa.access_token_request.AccessTokenRequest(client_id=None, client_secret=None, scope=None, refresh_token=None)

Bases: object

Request for retrieving an access token from LWA.

Parameters:

• client_id (str) – The ClientId value from developer console
• client_secret (str) – The ClientSecret value from developer console
• scope (str) – The required scope for which the access token is requested for
• refresh_token (str) – Client refresh_token required to get access token for API calls.

attribute_map = {'client_id': 'client_id', 'client_secret': 'client_secret', 'refresh_token': 'refresh_token', 'scope': 'scope'}

deserialized_types = {'client_id': 'str', 'client_secret': 'str', 'refresh_token': 'str', 'scope': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model_runtime.lwa.access_token_response module

class ask_sdk_model_runtime.lwa.access_token_response.AccessTokenResponse(access_token=None, expires_in=None, scope=None, token_type=None)

Bases: object

LWA response for retrieving an access token.

Parameters:

• access_token (str) – The access token from LWA
• expires_in (int) – The duration in seconds of the access token lifetime
• scope (str) – The scope specified in the access token request
• token_type (str) – The type of token issued

attribute_map = {'access_token': 'access_token', 'expires_in': 'expires_in', 'scope': 'scope', 'token_type': 'token_type'}

deserialized_types = {'access_token': 'str', 'expires_in': 'int', 'scope': 'str', 'token_type': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model_runtime.lwa.error module

class ask_sdk_model_runtime.lwa.error.Error(error_description=None, error_type=None)

Bases: object

Error from LWA Client request.

Parameters:

• error_description ((optional) str) – Description of the error
• error_type ((optional) str) – Type of error

attribute_map = {'error_description': 'error_description', 'error_type': 'error'}

deserialized_types = {'error_description': 'str', 'error_type': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model_runtime.lwa.lwa_client module

class ask_sdk_model_runtime.lwa.lwa_client.LwaClient(api_configuration, authentication_configuration, grant_type=None)

Bases: ask_sdk_model_runtime.base_service_client.BaseServiceClient

Client to call Login with Amazon (LWA) to retrieve access tokens.

Parameters:

• api_configuration (ask_sdk_model_runtime.api_configuration.ApiConfiguration) – ApiConfiguration instance with valid Serializer and ApiClient. The authorization value and api endpoint is not used by the LWA Client.
• authentication_configuration (ask_sdk_model_runtime.authentication_configuration.AuthenticationConfiguration) – AuthenticationConfiguration instance with valid client id and client secret, for making LWA calls.
• grant_type ((optional) str) – The grant type which is used to make the HTTP request.

Raises:

ValueError if authentication configuration is not provided.

CLIENT_CREDENTIALS_GRANT_TYPE = 'client_credentials'

DEFAULT_LWA_ENDPOINT = 'https://api.amazon.com'

EXPIRY_OFFSET_IN_MILLIS = 60000

LWA_CREDENTIALS_GRANT_TYPE = 'refresh_token'

REFRESH_ACCESS_TOKEN = 'refresh_access_token'

get_access_token_for_scope(scope)

Retrieve access token for given scope.

Parameters:scope (str) – Target scope for the access token Returns:Retrieved access token for the given scope and configured client id, client secret Return type:str Raises:ValueError is no scope is passed.

get_access_token_from_refresh_token()

Retrieve access token for Skill Management API calls.

Returns:Retrieved access token for the given refresh_token and configured client id, client secret Return type:str

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_sdk_model_runtime.api_client module

class ask_sdk_model_runtime.api_client.ApiClient

Bases: object

Represents a basic contract for API request invocation.

invoke(request)

Dispatches a request to an API endpoint described in the request. The ApiClient is expected to resolve in the case an API returns a non-200 HTTP status code. The responsibility of translating a particular response code to an error lies with the caller. :param request: Request to dispatch to the ApiClient :type request: ApiClientRequest :return: Response from the client call :rtype: ApiClientResponse

class ask_sdk_model_runtime.api_client.DefaultApiClient

Bases: ask_sdk_model_runtime.api_client.ApiClient

Default ApiClient implementation of ask_sdk_model_runtime.api_client.ApiClient using the requests library.

invoke(request)

Dispatches a request to an API endpoint described in the request. Resolves the method from input request object, converts the list of header tuples to the required format (dict) for the requests lib call and invokes the method with corresponding parameters on requests library. The response from the call is wrapped under the ApiClientResponse object and the responsibility of translating a response code and response/ error lies with the caller. :param request: Request to dispatch to the ApiClient :type request: ApiClientRequest :return: Response from the client call :rtype: ApiClientResponse :raises: ask_sdk_model_runtime.exceptions.ApiClientException

ask_sdk_model_runtime.api_client_message module

class ask_sdk_model_runtime.api_client_message.ApiClientMessage(headers=None, body=None)

Bases: object

Represents the interface between ask_sdk_model_runtime.api_client.ApiClient implementation and a Service Client.

Parameters:

• headers (list[tuple[str, str]]) – List of header tuples
• body (str) – Body of the message

ask_sdk_model_runtime.api_client_request module

class ask_sdk_model_runtime.api_client_request.ApiClientRequest(headers=None, body=None, url=None, method=None)

Bases: ask_sdk_model_runtime.api_client_message.ApiClientMessage

Represents a request sent from Service Clients to an ask_sdk_model_runtime.api_client.ApiClient implementation.

Parameters:

• headers (list[tuple[str, str]]) – List of header tuples
• body (str) – Body of the message
• url (str) – Url of the request
• method (str) – Method called with the request

ask_sdk_model_runtime.api_client_response module

class ask_sdk_model_runtime.api_client_response.ApiClientResponse(headers=None, body=None, status_code=None)

Bases: ask_sdk_model_runtime.api_client_message.ApiClientMessage

Represents a response returned by ask_sdk_model_runtime.api_client.ApiClient implementation to a Service Client.

Parameters:

• headers (list[tuple[str, str]]) – List of header tuples
• body (str) – Body of the message
• status_code (int) – Status code of the response

ask_sdk_model_runtime.api_configuration module

class ask_sdk_model_runtime.api_configuration.ApiConfiguration(serializer=None, api_client=None, authorization_value=None, api_endpoint=None)

Bases: object

Represents a class that provides API configuration options needed by service clients.

Parameters:

• serializer ((optional) ask_sdk_model_runtime.serializer.Serializer) – serializer implementation for encoding/decoding JSON from/to Object models.
• api_client ((optional) ask_sdk_model_runtime.api_client.ApiClient) – API Client implementation
• authorization_value ((optional) str) – Authorization value to be used on any calls of the service client instance
• api_endpoint ((optional) str) – Endpoint to hit by the service client instance

ask_sdk_model_runtime.api_response module

class ask_sdk_model_runtime.api_response.ApiResponse(headers=None, body=None, status_code=None)

Bases: object

Represents a response returned by the Service Client.

Parameters:

• headers (list[tuple[str, str]]) – List of header tuples
• body (object) – Body of the response
• status_code (int) – Status code of the response

ask_sdk_model_runtime.authentication_configuration module

class ask_sdk_model_runtime.authentication_configuration.AuthenticationConfiguration(client_id=None, client_secret=None, refresh_token=None)

Bases: object

Represents a class that provides authentication configuration.

Parameters:

• client_id (str) – Client ID required for authentication.
• client_secret (str) – Client Secret required for authentication.
• refresh_token (str) – Client refresh_token required to get access token for API calls.

ask_sdk_model_runtime.base_service_client module

class ask_sdk_model_runtime.base_service_client.BaseServiceClient(api_configuration)

Bases: object

Class to be used as the base class for the generated service clients.

The class has to be implemented by the service clients and this class instantiation is not supported

Parameters:api_configuration (ask_sdk_model_runtime.api_configuration.ApiConfiguration) – ApiConfiguration implementation

invoke(method, endpoint, path, query_params, header_params, path_params, response_definitions, body, response_type)

Calls the ApiClient based on the ServiceClient specific data provided as well as handles the well-known responses from the Api.

Parameters:

• method (str) – Http method
• endpoint – Base endpoint to make the request to
• path (str) – Specific path to hit. It might contain variables to be interpolated with path_params
• query_params (list(tuple(str, str))) – Parameter values to be sent as part of query string
• header_params (list(tuple(str, str))) – Parameter values to be sent as headers
• path_params (dict(str, str)) – Parameter values to be interpolated in the path
• response_definitions (list(ask_sdk_model_runtime.service_client_response.ServiceClientResponse)) – Well-known expected responses by the ServiceClient
• body (object) – Request body
• response_type (class) – Type of the expected response if applicable

Returns:

ApiResponse object.

Return type:

ask_sdk_model_runtime.api_response.py

Raises:

ask_sdk_model_runtime.exceptions.ServiceException if service fails and ValueError if serializer or API Client is not configured in api_configuration # noqa: E501

ask_sdk_model_runtime.exceptions module

exception ask_sdk_model_runtime.exceptions.ApiClientException

Bases: Exception

Exception class for ApiClient Adapter processing.

exception ask_sdk_model_runtime.exceptions.SerializationException

Bases: Exception

Class for exceptions raised during serialization/deserialization.

exception ask_sdk_model_runtime.exceptions.ServiceException(message, status_code, headers, body)

Bases: Exception

Exception thrown by a Service client when an error response was received or some operation failed.

Parameters:

• message (str) – Description of the error
• status_code (int) – Status code of the HTTP Response
• headers (list(tuple(str, str))) – Headers of the Http response that return the failure
• body (object) – Body of the HTTP Response

ask_sdk_model_runtime.serializer module

class ask_sdk_model_runtime.serializer.DefaultSerializer

Bases: ask_sdk_model_runtime.serializer.Serializer

NATIVE_TYPES_MAPPING = {'bool': <class 'bool'>, 'date': <class 'datetime.date'>, 'datetime': <class 'datetime.datetime'>, 'float': <class 'float'>, 'int': <class 'int'>, 'long': <class 'int'>, 'object': <class 'object'>, 'str': <class 'str'>}

PRIMITIVE_TYPES = (<class 'float'>, <class 'bool'>, <class 'bytes'>, <class 'str'>, <class 'int'>)

deserialize(payload, obj_type)

Deserializes payload into an instance of provided obj_type.

The obj_type parameter can be a primitive type, a generic model object or a list / dict of model objects.

The list or dict object type has to be provided as a string format. For eg:

• 'list[a.b.C]' if the payload is a list of instances of class a.b.C.
• 'dict(str, a.b.C)' if the payload is a dict containing mappings of str : a.b.C class instance types.

The method looks for a deserialized_types dict in the model class, that mentions which payload values has to be deserialized. In case the payload key names are different than the model attribute names, the corresponding mapping can be provided in another special dict attribute_map. The model class should also have the __init__ method with default values for arguments. Check ask_sdk_model.request_envelope.RequestEnvelope source code for an example implementation.

Parameters:

• payload (str) – data to be deserialized.
• obj_type (Union[object, str]) – resolved class name for deserialized object

Returns:

deserialized object

Return type:

object

Raises:

ask_sdk_model_runtime.exceptions.SerializationException

serialize(obj)

Builds a serialized object.

• If obj is None, return None.
• If obj is str, int, long, float, bool, return directly.
• If obj is datetime.datetime, datetime.date convert to string in iso8601 format.
• If obj is list, serialize each element in the list.
• If obj is dict, return the dict with serialized values.
• If obj is ask sdk model, return the dict with keys resolved from the union of model’s attribute_map and deserialized_types and values serialized based on deserialized_types.
• If obj is a generic class instance, return the dict with keys from instance’s deserialized_types and values serialized based on deserialized_types.

Parameters:obj (object) – The data to serialize. Returns:The serialized form of data. Return type:Union[Dict[str, Any], List, Tuple, str, int, float, bytes, None]

class ask_sdk_model_runtime.serializer.Serializer

Bases: object

Represents an abstract object used for Serialization tasks.

deserialize(payload, obj_type)

Deserializes the payload to object of provided obj_type.

Parameters:

• payload (str) – String to deserialize
• obj_type (object) – Target type of deserialization

Returns:

Deserialized object

Return type:

object

serialize(obj)

Serializes an object into a string.

Parameters:obj – object to serialize Returns:serialized object in string format Return type:str

ask_sdk_model_runtime.service_client_response module

class ask_sdk_model_runtime.service_client_response.ServiceClientResponse(response_type, status_code, message)

Bases: object

Represents a well-known response object by Service Client.

Parameters:

• response_type (Response class) – Well-known representation of the response
• status_code (int) – Status code to be attached to the response
• message (str) – Message to be attached to the response

Models :ask_sdk_model package

The SDK works on model classes rather than native Alexa JSON requests and responses. These model classes are generated using the Request, Response JSON schemas from the developer docs. The source code for the model classes can be found here.

Subpackages

ask_sdk_model.canfulfill 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_sdk_model.canfulfill.can_fulfill_intent module

class ask_sdk_model.canfulfill.can_fulfill_intent.CanFulfillIntent(can_fulfill=None, slots=None)

Bases: object

CanFulfillIntent represents the response to canFulfillIntentRequest includes the details about whether the skill can understand and fulfill the intent request with detected slots.

Parameters:

• can_fulfill ((optional) ask_sdk_model.canfulfill.can_fulfill_intent_values.CanFulfillIntentValues) –
• slots ((optional) dict(str, ask_sdk_model.canfulfill.can_fulfill_slot.CanFulfillSlot)) – A map that represents skill's detailed response to each detected slot within the intent such as if skill can understand and fulfill the detected slot. This supplements the overall canFulfillIntent response and help Alexa make better ranking and arbitration decisions. The key is the name of the slot. The value is an object of type CanFulfillSlot.

attribute_map = {'can_fulfill': 'canFulfill', 'slots': 'slots'}

deserialized_types = {'can_fulfill': 'ask_sdk_model.canfulfill.can_fulfill_intent_values.CanFulfillIntentValues', 'slots': 'dict(str, ask_sdk_model.canfulfill.can_fulfill_slot.CanFulfillSlot)'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.canfulfill.can_fulfill_intent_request module

class ask_sdk_model.canfulfill.can_fulfill_intent_request.CanFulfillIntentRequest(request_id=None, timestamp=None, locale=None, dialog_state=None, intent=None)

Bases: ask_sdk_model.request.Request

An object that represents a request made to skill to query whether the skill can understand and fulfill the intent request with detected slots, before actually asking the skill to take action. Skill should be aware this is not to actually take action, skill should handle this request without causing side-effect, skill should not modify some state outside its scope or has an observable interaction with its calling functions or the outside world besides returning a value, such as playing sound,turning on/off lights, committing a transaction or a charge.

Parameters:

• request_id ((optional) str) – Represents the unique identifier for the specific request.
• timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
• locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
• dialog_state ((optional) ask_sdk_model.dialog_state.DialogState) –
• intent ((optional) ask_sdk_model.intent.Intent) –

attribute_map = {'dialog_state': 'dialogState', 'intent': 'intent', 'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp'}

deserialized_types = {'dialog_state': 'ask_sdk_model.dialog_state.DialogState', 'intent': 'ask_sdk_model.intent.Intent', 'locale': 'str', 'object_type': 'str', 'request_id': 'str', 'timestamp': 'datetime'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.canfulfill.can_fulfill_intent_values module

class ask_sdk_model.canfulfill.can_fulfill_intent_values.CanFulfillIntentValues

Bases: enum.Enum

Overall if skill can understand and fulfill the intent with detected slots. Respond YES when skill understands all slots, can fulfill all slots, and can fulfill the request in its entirety. Respond NO when skill either cannot understand the intent, cannot understand all the slots, or cannot fulfill all the slots. Respond MAYBE when skill can understand the intent, can partially or fully understand the slots, and can partially or fully fulfill the slots. The only cases where should respond MAYBE is when skill partially understand the request and can potentially complete the request if skill get more data, either through callbacks or through a multi-turn conversation with the user.

Allowed enum values: [YES, NO, MAYBE]

MAYBE = 'MAYBE'

NO = 'NO'

YES = 'YES'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.canfulfill.can_fulfill_slot module

class ask_sdk_model.canfulfill.can_fulfill_slot.CanFulfillSlot(can_understand=None, can_fulfill=None)

Bases: object

This represents skill's capability to understand and fulfill each detected slot.

Parameters:

• can_understand ((optional) ask_sdk_model.canfulfill.can_understand_slot_values.CanUnderstandSlotValues) –
• can_fulfill ((optional) ask_sdk_model.canfulfill.can_fulfill_slot_values.CanFulfillSlotValues) –

attribute_map = {'can_fulfill': 'canFulfill', 'can_understand': 'canUnderstand'}

deserialized_types = {'can_fulfill': 'ask_sdk_model.canfulfill.can_fulfill_slot_values.CanFulfillSlotValues', 'can_understand': 'ask_sdk_model.canfulfill.can_understand_slot_values.CanUnderstandSlotValues'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.canfulfill.can_fulfill_slot_values module

class ask_sdk_model.canfulfill.can_fulfill_slot_values.CanFulfillSlotValues

Bases: enum.Enum

This field indicates whether skill can fulfill relevant action for the slot, that has been partially or fully understood. The definition of fulfilling the slot is dependent on skill and skill is required to have logic in place to determine whether a slot value can be fulfilled in the context of skill or not. Return YES if Skill can certainly fulfill the relevant action for this slot value. Return NO if skill cannot fulfill the relevant action for this slot value. For specific recommendations to set the value refer to the developer docs for more details.

Allowed enum values: [YES, NO]

NO = 'NO'

YES = 'YES'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.canfulfill.can_understand_slot_values module

class ask_sdk_model.canfulfill.can_understand_slot_values.CanUnderstandSlotValues

Bases: enum.Enum

This field indicates whether skill has understood the slot value. In most typical cases, skills will do some form of entity resolution by looking up a catalog or list to determine whether they recognize the slot or not. Return YES if skill have a perfect match or high confidence match (for eg. synonyms) with catalog or list maintained by skill. Return NO if skill cannot understand or recognize the slot value. Return MAYBE if skill have partial confidence or partial match. This will be true when the slot value doesn’t exist as is, in the catalog, but a variation or a fuzzy match may exist. For specific recommendations to set the value refer to the developer docs for more details.

Allowed enum values: [YES, NO, MAYBE]

MAYBE = 'MAYBE'

NO = 'NO'

YES = 'YES'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.dialog 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_sdk_model.dialog.confirm_intent_directive module

class ask_sdk_model.dialog.confirm_intent_directive.ConfirmIntentDirective(updated_intent=None)

Bases: ask_sdk_model.directive.Directive

Parameters:updated_intent ((optional) ask_sdk_model.intent.Intent) –

attribute_map = {'object_type': 'type', 'updated_intent': 'updatedIntent'}

deserialized_types = {'object_type': 'str', 'updated_intent': 'ask_sdk_model.intent.Intent'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.dialog.confirm_slot_directive module

class ask_sdk_model.dialog.confirm_slot_directive.ConfirmSlotDirective(updated_intent=None, slot_to_confirm=None)

Bases: ask_sdk_model.directive.Directive

Parameters:

• updated_intent ((optional) ask_sdk_model.intent.Intent) –
• slot_to_confirm ((optional) str) –

attribute_map = {'object_type': 'type', 'slot_to_confirm': 'slotToConfirm', 'updated_intent': 'updatedIntent'}

deserialized_types = {'object_type': 'str', 'slot_to_confirm': 'str', 'updated_intent': 'ask_sdk_model.intent.Intent'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.dialog.delegate_directive module

class ask_sdk_model.dialog.delegate_directive.DelegateDirective(updated_intent=None)

Bases: ask_sdk_model.directive.Directive

Parameters:updated_intent ((optional) ask_sdk_model.intent.Intent) –

attribute_map = {'object_type': 'type', 'updated_intent': 'updatedIntent'}

deserialized_types = {'object_type': 'str', 'updated_intent': 'ask_sdk_model.intent.Intent'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.dialog.dynamic_entities_directive module

class ask_sdk_model.dialog.dynamic_entities_directive.DynamicEntitiesDirective(update_behavior=None, types=None)

Bases: ask_sdk_model.directive.Directive

Parameters:

• update_behavior ((optional) ask_sdk_model.er.dynamic.update_behavior.UpdateBehavior) –
• types ((optional) list[ask_sdk_model.er.dynamic.entity_list_item.EntityListItem]) –

attribute_map = {'object_type': 'type', 'types': 'types', 'update_behavior': 'updateBehavior'}

deserialized_types = {'object_type': 'str', 'types': 'list[ask_sdk_model.er.dynamic.entity_list_item.EntityListItem]', 'update_behavior': 'ask_sdk_model.er.dynamic.update_behavior.UpdateBehavior'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.dialog.elicit_slot_directive module

class ask_sdk_model.dialog.elicit_slot_directive.ElicitSlotDirective(updated_intent=None, slot_to_elicit=None)

Bases: ask_sdk_model.directive.Directive

Parameters:

• updated_intent ((optional) ask_sdk_model.intent.Intent) –
• slot_to_elicit ((optional) str) –

attribute_map = {'object_type': 'type', 'slot_to_elicit': 'slotToElicit', 'updated_intent': 'updatedIntent'}

deserialized_types = {'object_type': 'str', 'slot_to_elicit': 'str', 'updated_intent': 'ask_sdk_model.intent.Intent'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.er package

Subpackages

ask_sdk_model.er.dynamic 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_sdk_model.er.dynamic.entity module

class ask_sdk_model.er.dynamic.entity.Entity(id=None, name=None)

Bases: object

Represents an entity that the skill wants to store. An entity has an optional Id and the value and the synonyms for the entity

Parameters:

• id ((optional) str) – An unique id associated with the entity
• name ((optional) ask_sdk_model.er.dynamic.entity_value_and_synonyms.EntityValueAndSynonyms) –

attribute_map = {'id': 'id', 'name': 'name'}

deserialized_types = {'id': 'str', 'name': 'ask_sdk_model.er.dynamic.entity_value_and_synonyms.EntityValueAndSynonyms'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.er.dynamic.entity_list_item module

class ask_sdk_model.er.dynamic.entity_list_item.EntityListItem(name=None, values=None)

Bases: object

Represents an array of entities of a particular type.

Parameters:

• name ((optional) str) – The entity type. Must match the slot type as defined in the interaction model.
• values ((optional) list[ask_sdk_model.er.dynamic.entity.Entity]) – A list of dynamic entities which are of the same type

attribute_map = {'name': 'name', 'values': 'values'}

deserialized_types = {'name': 'str', 'values': 'list[ask_sdk_model.er.dynamic.entity.Entity]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.er.dynamic.entity_value_and_synonyms module

class ask_sdk_model.er.dynamic.entity_value_and_synonyms.EntityValueAndSynonyms(value=None, synonyms=None)

Bases: object

A container object with value and synomyms for the entity

Parameters:

• value ((optional) str) – The entity value
• synonyms ((optional) list[str]) – An array of synonyms for the entity

attribute_map = {'synonyms': 'synonyms', 'value': 'value'}

deserialized_types = {'synonyms': 'list[str]', 'value': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.er.dynamic.update_behavior module

class ask_sdk_model.er.dynamic.update_behavior.UpdateBehavior

Bases: enum.Enum

Replace the existing dynamic entities or clear them from the catalog

Allowed enum values: [REPLACE, CLEAR]

CLEAR = 'CLEAR'

REPLACE = 'REPLACE'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.events package

Subpackages

ask_sdk_model.events.skillevents 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_sdk_model.events.skillevents.account_linked_body module

class ask_sdk_model.events.skillevents.account_linked_body.AccountLinkedBody(access_token=None)

Bases: object

Parameters:access_token ((optional) str) –

attribute_map = {'access_token': 'accessToken'}

deserialized_types = {'access_token': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.events.skillevents.account_linked_request module

class ask_sdk_model.events.skillevents.account_linked_request.AccountLinkedRequest(request_id=None, timestamp=None, locale=None, body=None, event_creation_time=None, event_publishing_time=None)

Bases: ask_sdk_model.request.Request

This event indicates that a customer has linked an account in a third-party application with the Alexa app. This event is useful for an application that support out-of-session (non-voice) user interactions so that this application can be notified when the internal customer can be associated with the Alexa customer. This event is required for many applications that synchronize customer Alexa lists with application lists. During the account linking process, the Alexa app directs the user to the skill website where the customer logs in. When the customer logs in, the skill then provides an access token and a consent token to Alexa. The event includes the same access token and consent token.

Parameters:

• request_id ((optional) str) – Represents the unique identifier for the specific request.
• timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
• locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
• body ((optional) ask_sdk_model.events.skillevents.account_linked_body.AccountLinkedBody) –
• event_creation_time ((optional) datetime) –
• event_publishing_time ((optional) datetime) –

attribute_map = {'body': 'body', 'event_creation_time': 'eventCreationTime', 'event_publishing_time': 'eventPublishingTime', 'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp'}

deserialized_types = {'body': 'ask_sdk_model.events.skillevents.account_linked_body.AccountLinkedBody', 'event_creation_time': 'datetime', 'event_publishing_time': 'datetime', 'locale': 'str', 'object_type': 'str', 'request_id': 'str', 'timestamp': 'datetime'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.events.skillevents.permission module

class ask_sdk_model.events.skillevents.permission.Permission(scope=None)

Bases: object

Parameters:scope ((optional) str) –

attribute_map = {'scope': 'scope'}

deserialized_types = {'scope': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.events.skillevents.permission_accepted_request module

class ask_sdk_model.events.skillevents.permission_accepted_request.PermissionAcceptedRequest(request_id=None, timestamp=None, locale=None, body=None, event_creation_time=None, event_publishing_time=None)

Bases: ask_sdk_model.request.Request

Parameters:

• request_id ((optional) str) – Represents the unique identifier for the specific request.
• timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
• locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
• body ((optional) ask_sdk_model.events.skillevents.permission_body.PermissionBody) –
• event_creation_time ((optional) datetime) –
• event_publishing_time ((optional) datetime) –

attribute_map = {'body': 'body', 'event_creation_time': 'eventCreationTime', 'event_publishing_time': 'eventPublishingTime', 'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp'}

deserialized_types = {'body': 'ask_sdk_model.events.skillevents.permission_body.PermissionBody', 'event_creation_time': 'datetime', 'event_publishing_time': 'datetime', 'locale': 'str', 'object_type': 'str', 'request_id': 'str', 'timestamp': 'datetime'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.events.skillevents.permission_body module

class ask_sdk_model.events.skillevents.permission_body.PermissionBody(accepted_permissions=None)

Bases: object

Parameters:accepted_permissions ((optional) list[ask_sdk_model.events.skillevents.permission.Permission]) –

attribute_map = {'accepted_permissions': 'acceptedPermissions'}

deserialized_types = {'accepted_permissions': 'list[ask_sdk_model.events.skillevents.permission.Permission]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.events.skillevents.permission_changed_request module

class ask_sdk_model.events.skillevents.permission_changed_request.PermissionChangedRequest(request_id=None, timestamp=None, locale=None, body=None, event_creation_time=None, event_publishing_time=None)

Bases: ask_sdk_model.request.Request

Parameters:

• request_id ((optional) str) – Represents the unique identifier for the specific request.
• timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
• locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
• body ((optional) ask_sdk_model.events.skillevents.permission_body.PermissionBody) –
• event_creation_time ((optional) datetime) –
• event_publishing_time ((optional) datetime) –

attribute_map = {'body': 'body', 'event_creation_time': 'eventCreationTime', 'event_publishing_time': 'eventPublishingTime', 'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp'}

deserialized_types = {'body': 'ask_sdk_model.events.skillevents.permission_body.PermissionBody', 'event_creation_time': 'datetime', 'event_publishing_time': 'datetime', 'locale': 'str', 'object_type': 'str', 'request_id': 'str', 'timestamp': 'datetime'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.events.skillevents.proactive_subscription_changed_body module

class ask_sdk_model.events.skillevents.proactive_subscription_changed_body.ProactiveSubscriptionChangedBody(subscriptions=None)

Bases: object

Parameters:subscriptions ((optional) list[ask_sdk_model.events.skillevents.proactive_subscription_event.ProactiveSubscriptionEvent]) – The list of events that this customer is currently subscribed to. If a customer unsubscribes from an event, this list will contain remaining event types to which the customer is still subscribed to receive from your skill. If the list of subscriptions is empty, this customer has unsubscribed from all event types from your skill.

attribute_map = {'subscriptions': 'subscriptions'}

deserialized_types = {'subscriptions': 'list[ask_sdk_model.events.skillevents.proactive_subscription_event.ProactiveSubscriptionEvent]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.events.skillevents.proactive_subscription_changed_request module

class ask_sdk_model.events.skillevents.proactive_subscription_changed_request.ProactiveSubscriptionChangedRequest(request_id=None, timestamp=None, locale=None, body=None)

Bases: ask_sdk_model.request.Request

This event indicates a customer subscription to receive events from your skill and contains information for that user. You need this information to know the userId in order to send events to individual users. Note that these events can arrive out of order, so ensure that your skill service uses the timestamp in the event to correctly record the latest subscription state for a customer.

Parameters:

• request_id ((optional) str) – Represents the unique identifier for the specific request.
• timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
• locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
• body ((optional) ask_sdk_model.events.skillevents.proactive_subscription_changed_body.ProactiveSubscriptionChangedBody) –

attribute_map = {'body': 'body', 'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp'}

deserialized_types = {'body': 'ask_sdk_model.events.skillevents.proactive_subscription_changed_body.ProactiveSubscriptionChangedBody', 'locale': 'str', 'object_type': 'str', 'request_id': 'str', 'timestamp': 'datetime'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.events.skillevents.proactive_subscription_event module

class ask_sdk_model.events.skillevents.proactive_subscription_event.ProactiveSubscriptionEvent(event_name=None)

Bases: object

Parameters:event_name ((optional) str) –

attribute_map = {'event_name': 'eventName'}

deserialized_types = {'event_name': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.events.skillevents.skill_disabled_request module

class ask_sdk_model.events.skillevents.skill_disabled_request.SkillDisabledRequest(request_id=None, timestamp=None, locale=None, event_creation_time=None, event_publishing_time=None)

Bases: ask_sdk_model.request.Request

Parameters:

• request_id ((optional) str) – Represents the unique identifier for the specific request.
• timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
• locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
• event_creation_time ((optional) datetime) –
• event_publishing_time ((optional) datetime) –

attribute_map = {'event_creation_time': 'eventCreationTime', 'event_publishing_time': 'eventPublishingTime', 'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp'}

deserialized_types = {'event_creation_time': 'datetime', 'event_publishing_time': 'datetime', 'locale': 'str', 'object_type': 'str', 'request_id': 'str', 'timestamp': 'datetime'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.events.skillevents.skill_enabled_request module

class ask_sdk_model.events.skillevents.skill_enabled_request.SkillEnabledRequest(request_id=None, timestamp=None, locale=None, event_creation_time=None, event_publishing_time=None)

Bases: ask_sdk_model.request.Request

Parameters:

• request_id ((optional) str) – Represents the unique identifier for the specific request.
• timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
• locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
• event_creation_time ((optional) datetime) –
• event_publishing_time ((optional) datetime) –

attribute_map = {'event_creation_time': 'eventCreationTime', 'event_publishing_time': 'eventPublishingTime', 'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp'}

deserialized_types = {'event_creation_time': 'datetime', 'event_publishing_time': 'datetime', 'locale': 'str', 'object_type': 'str', 'request_id': 'str', 'timestamp': 'datetime'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces package

Subpackages

ask_sdk_model.interfaces.alexa package

Subpackages

ask_sdk_model.interfaces.alexa.presentation package

Subpackages

ask_sdk_model.interfaces.alexa.presentation.apl 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_sdk_model.interfaces.alexa.presentation.apl.alexa_presentation_apl_interface module

class ask_sdk_model.interfaces.alexa.presentation.apl.alexa_presentation_apl_interface.AlexaPresentationAplInterface(runtime=None)

Bases: object

Parameters:runtime ((optional) ask_sdk_model.interfaces.alexa.presentation.apl.runtime.Runtime) –

attribute_map = {'runtime': 'runtime'}

deserialized_types = {'runtime': 'ask_sdk_model.interfaces.alexa.presentation.apl.runtime.Runtime'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.apl.align module

class ask_sdk_model.interfaces.alexa.presentation.apl.align.Align

Bases: enum.Enum

The alignment of the item after scrolling. Defaults to visible.

Allowed enum values: [center, first, last, visible]

center = 'center'

first = 'first'

last = 'last'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

visible = 'visible'

ask_sdk_model.interfaces.alexa.presentation.apl.animate_item_command module

class ask_sdk_model.interfaces.alexa.presentation.apl.animate_item_command.AnimateItemCommand(delay=None, description=None, when=None, component_id=None, duration=None, easing='linear', repeat_count=None, repeat_mode=None, value=None)

Bases: ask_sdk_model.interfaces.alexa.presentation.apl.command.Command

Runs a fixed-duration animation sequence on one or more properties of a single component.

Parameters:

• delay ((optional) int) – The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
• description ((optional) str) – A user-provided description of this command.
• when ((optional) bool) – If false, the execution of the command is skipped. Defaults to true.
• component_id ((optional) str) – The ID of the animated component.
• duration ((optional) int) – The duration of the animation (in milliseconds).
• easing (str) – The easing curve.
• repeat_count ((optional) int) – Number of times to repeat.
• repeat_mode ((optional) ask_sdk_model.interfaces.alexa.presentation.apl.animate_item_repeat_mode.AnimateItemRepeatMode) –
• value ((optional) list[ask_sdk_model.interfaces.alexa.presentation.apl.animated_property.AnimatedProperty]) – An array of animated properties.

attribute_map = {'component_id': 'componentId', 'delay': 'delay', 'description': 'description', 'duration': 'duration', 'easing': 'easing', 'object_type': 'type', 'repeat_count': 'repeatCount', 'repeat_mode': 'repeatMode', 'value': 'value', 'when': 'when'}

deserialized_types = {'component_id': 'str', 'delay': 'int', 'description': 'str', 'duration': 'int', 'easing': 'str', 'object_type': 'str', 'repeat_count': 'int', 'repeat_mode': 'ask_sdk_model.interfaces.alexa.presentation.apl.animate_item_repeat_mode.AnimateItemRepeatMode', 'value': 'list[ask_sdk_model.interfaces.alexa.presentation.apl.animated_property.AnimatedProperty]', 'when': 'bool'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.apl.animate_item_repeat_mode module

class ask_sdk_model.interfaces.alexa.presentation.apl.animate_item_repeat_mode.AnimateItemRepeatMode

Bases: enum.Enum

How repeated animations will play.

Allowed enum values: [restart, reverse]

restart = 'restart'

reverse = 'reverse'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.apl.animated_opacity_property module

class ask_sdk_model.interfaces.alexa.presentation.apl.animated_opacity_property.AnimatedOpacityProperty(object_from=None, to=None)

Bases: ask_sdk_model.interfaces.alexa.presentation.apl.animated_property.AnimatedProperty

Parameters:

• object_from ((optional) float) – The starting value of the property.
• to ((optional) float) – The ending value of the property.

attribute_map = {'object_from': 'from', 'object_property': 'property', 'to': 'to'}

deserialized_types = {'object_from': 'float', 'object_property': 'str', 'to': 'float'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.apl.animated_property module

class ask_sdk_model.interfaces.alexa.presentation.apl.animated_property.AnimatedProperty(object_property=None)

Bases: object

Parameters:object_property ((optional) str) – The name of the property to animate

Note

This is an abstract class. Use the following mapping, to figure out the model class to be instantiated, that sets property variable.

opacity: ask_sdk_model.interfaces.alexa.presentation.apl.animated_opacity_property.AnimatedOpacityProperty,

transform: ask_sdk_model.interfaces.alexa.presentation.apl.animated_transform_property.AnimatedTransformProperty

attribute_map = {'object_property': 'property'}

deserialized_types = {'object_property': 'str'}

discriminator_value_class_map = {'opacity': 'ask_sdk_model.interfaces.alexa.presentation.apl.animated_opacity_property.AnimatedOpacityProperty', 'transform': 'ask_sdk_model.interfaces.alexa.presentation.apl.animated_transform_property.AnimatedTransformProperty'}

classmethod get_real_child_model(data)

Returns the real base class specified by the discriminator

json_discriminator_key = 'property'

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.apl.animated_transform_property module

class ask_sdk_model.interfaces.alexa.presentation.apl.animated_transform_property.AnimatedTransformProperty(object_from=None, to=None)

Bases: ask_sdk_model.interfaces.alexa.presentation.apl.animated_property.AnimatedProperty

Parameters:

• object_from ((optional) list[ask_sdk_model.interfaces.alexa.presentation.apl.transform_property.TransformProperty]) – The starting value of the property.
• to ((optional) list[ask_sdk_model.interfaces.alexa.presentation.apl.transform_property.TransformProperty]) – The ending value of the property.

attribute_map = {'object_from': 'from', 'object_property': 'property', 'to': 'to'}

deserialized_types = {'object_from': 'list[ask_sdk_model.interfaces.alexa.presentation.apl.transform_property.TransformProperty]', 'object_property': 'str', 'to': 'list[ask_sdk_model.interfaces.alexa.presentation.apl.transform_property.TransformProperty]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.apl.audio_track module

class ask_sdk_model.interfaces.alexa.presentation.apl.audio_track.AudioTrack

Bases: enum.Enum

The audio track to play on. Defaults to “foreground”

Allowed enum values: [foreground]

foreground = 'foreground'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.apl.auto_page_command module

class ask_sdk_model.interfaces.alexa.presentation.apl.auto_page_command.AutoPageCommand(delay=None, description=None, when=None, component_id=None, count=None, duration=None)

Bases: ask_sdk_model.interfaces.alexa.presentation.apl.command.Command

Automatically progress through a series of pages displayed in a Pager component. The AutoPage command finishes after the last page has been displayed for the requested time period.

Parameters:

• delay ((optional) int) – The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
• description ((optional) str) – A user-provided description of this command.
• when ((optional) bool) – If false, the execution of the command is skipped. Defaults to true.
• component_id ((optional) str) – The id of the Pager component.
• count ((optional) int) – Number of pages to display. Defaults to all of them.
• duration ((optional) int) – Time to wait between pages (in milliseconds). Defaults to 0.

attribute_map = {'component_id': 'componentId', 'count': 'count', 'delay': 'delay', 'description': 'description', 'duration': 'duration', 'object_type': 'type', 'when': 'when'}

deserialized_types = {'component_id': 'str', 'count': 'int', 'delay': 'int', 'description': 'str', 'duration': 'int', 'object_type': 'str', 'when': 'bool'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.apl.clear_focus_command module

class ask_sdk_model.interfaces.alexa.presentation.apl.clear_focus_command.ClearFocusCommand(delay=None, description=None, when=None)

Bases: ask_sdk_model.interfaces.alexa.presentation.apl.command.Command

Removes focus from the component that is currently in focus.

Parameters:

• delay ((optional) int) – The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
• description ((optional) str) – A user-provided description of this command.
• when ((optional) bool) – If false, the execution of the command is skipped. Defaults to true.

attribute_map = {'delay': 'delay', 'description': 'description', 'object_type': 'type', 'when': 'when'}

deserialized_types = {'delay': 'int', 'description': 'str', 'object_type': 'str', 'when': 'bool'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.apl.command module

class ask_sdk_model.interfaces.alexa.presentation.apl.command.Command(object_type=None, delay=None, description=None, when=None)

Bases: object

A message that can change the visual or audio presentation of the content on the screen.

Parameters:

• object_type ((optional) str) – Defines the command type and dictates which properties must/can be included.
• delay ((optional) int) – The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
• description ((optional) str) – A user-provided description of this command.
• when ((optional) bool) – If false, the execution of the command is skipped. Defaults to true.

Note

This is an abstract class. Use the following mapping, to figure out the model class to be instantiated, that sets type variable.

SetPage: ask_sdk_model.interfaces.alexa.presentation.apl.set_page_command.SetPageCommand,

ControlMedia: ask_sdk_model.interfaces.alexa.presentation.apl.control_media_command.ControlMediaCommand,

AutoPage: ask_sdk_model.interfaces.alexa.presentation.apl.auto_page_command.AutoPageCommand,

PlayMedia: ask_sdk_model.interfaces.alexa.presentation.apl.play_media_command.PlayMediaCommand,

Scroll: ask_sdk_model.interfaces.alexa.presentation.apl.scroll_command.ScrollCommand,

Idle: ask_sdk_model.interfaces.alexa.presentation.apl.idle_command.IdleCommand,

AnimateItem: ask_sdk_model.interfaces.alexa.presentation.apl.animate_item_command.AnimateItemCommand,

SendEvent: ask_sdk_model.interfaces.alexa.presentation.apl.send_event_command.SendEventCommand,

SpeakList: ask_sdk_model.interfaces.alexa.presentation.apl.speak_list_command.SpeakListCommand,

Sequential: ask_sdk_model.interfaces.alexa.presentation.apl.sequential_command.SequentialCommand,

SetState: ask_sdk_model.interfaces.alexa.presentation.apl.set_state_command.SetStateCommand,

SpeakItem: ask_sdk_model.interfaces.alexa.presentation.apl.speak_item_command.SpeakItemCommand,

Parallel: ask_sdk_model.interfaces.alexa.presentation.apl.parallel_command.ParallelCommand,

OpenURL: ask_sdk_model.interfaces.alexa.presentation.apl.open_url_command.OpenUrlCommand,

ClearFocus: ask_sdk_model.interfaces.alexa.presentation.apl.clear_focus_command.ClearFocusCommand,

ScrollToIndex: ask_sdk_model.interfaces.alexa.presentation.apl.scroll_to_index_command.ScrollToIndexCommand,

SetValue: ask_sdk_model.interfaces.alexa.presentation.apl.set_value_command.SetValueCommand,

SetFocus: ask_sdk_model.interfaces.alexa.presentation.apl.set_focus_command.SetFocusCommand

attribute_map = {'delay': 'delay', 'description': 'description', 'object_type': 'type', 'when': 'when'}

deserialized_types = {'delay': 'int', 'description': 'str', 'object_type': 'str', 'when': 'bool'}

discriminator_value_class_map = {'AnimateItem': 'ask_sdk_model.interfaces.alexa.presentation.apl.animate_item_command.AnimateItemCommand', 'AutoPage': 'ask_sdk_model.interfaces.alexa.presentation.apl.auto_page_command.AutoPageCommand', 'ClearFocus': 'ask_sdk_model.interfaces.alexa.presentation.apl.clear_focus_command.ClearFocusCommand', 'ControlMedia': 'ask_sdk_model.interfaces.alexa.presentation.apl.control_media_command.ControlMediaCommand', 'Idle': 'ask_sdk_model.interfaces.alexa.presentation.apl.idle_command.IdleCommand', 'OpenURL': 'ask_sdk_model.interfaces.alexa.presentation.apl.open_url_command.OpenUrlCommand', 'Parallel': 'ask_sdk_model.interfaces.alexa.presentation.apl.parallel_command.ParallelCommand', 'PlayMedia': 'ask_sdk_model.interfaces.alexa.presentation.apl.play_media_command.PlayMediaCommand', 'Scroll': 'ask_sdk_model.interfaces.alexa.presentation.apl.scroll_command.ScrollCommand', 'ScrollToIndex': 'ask_sdk_model.interfaces.alexa.presentation.apl.scroll_to_index_command.ScrollToIndexCommand', 'SendEvent': 'ask_sdk_model.interfaces.alexa.presentation.apl.send_event_command.SendEventCommand', 'Sequential': 'ask_sdk_model.interfaces.alexa.presentation.apl.sequential_command.SequentialCommand', 'SetFocus': 'ask_sdk_model.interfaces.alexa.presentation.apl.set_focus_command.SetFocusCommand', 'SetPage': 'ask_sdk_model.interfaces.alexa.presentation.apl.set_page_command.SetPageCommand', 'SetState': 'ask_sdk_model.interfaces.alexa.presentation.apl.set_state_command.SetStateCommand', 'SetValue': 'ask_sdk_model.interfaces.alexa.presentation.apl.set_value_command.SetValueCommand', 'SpeakItem': 'ask_sdk_model.interfaces.alexa.presentation.apl.speak_item_command.SpeakItemCommand', 'SpeakList': 'ask_sdk_model.interfaces.alexa.presentation.apl.speak_list_command.SpeakListCommand'}

classmethod get_real_child_model(data)

Returns the real base class specified by the discriminator

json_discriminator_key = 'type'

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.apl.component_entity module

class ask_sdk_model.interfaces.alexa.presentation.apl.component_entity.ComponentEntity(object_type=None, value=None, id=None)

Bases: object

The entity context data which was attached to an element.

Parameters:

• object_type ((optional) str) –
• value ((optional) str) –
• id ((optional) str) –

attribute_map = {'id': 'id', 'object_type': 'type', 'value': 'value'}

deserialized_types = {'id': 'str', 'object_type': 'str', 'value': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.apl.component_state module

class ask_sdk_model.interfaces.alexa.presentation.apl.component_state.ComponentState

Bases: enum.Enum

Component state.

Allowed enum values: [checked, disabled, focused]

checked = 'checked'

disabled = 'disabled'

focused = 'focused'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.apl.component_visible_on_screen module

class ask_sdk_model.interfaces.alexa.presentation.apl.component_visible_on_screen.ComponentVisibleOnScreen(children=None, entities=None, id=None, position=None, tags=None, transform=None, object_type=None, uid=None, visibility=None)

Bases: object

Definition of a visible APL element shown on screen.

Parameters:

• children ((optional) list[ask_sdk_model.interfaces.alexa.presentation.apl.component_visible_on_screen.ComponentVisibleOnScreen]) – All child elements of the displayed element.
• entities ((optional) list[ask_sdk_model.interfaces.alexa.presentation.apl.component_entity.ComponentEntity]) – The entities which were attached to the element.
• id ((optional) str) – The id of the element.
• position ((optional) str) – Global position of the element (as seen by the device user).
• tags ((optional) ask_sdk_model.interfaces.alexa.presentation.apl.component_visible_on_screen_tags.ComponentVisibleOnScreenTags) – The tags which were attached to the element.
• transform ((optional) list[float]) – The transform which was applied to the element's position, specified as a 6-element numeric array containing the 2D homogeneous transformation matrix. The center of the transformation coordinate system is the center of the component. The transformation array is ordered as [A,B,C,D,Tx,Ty]. For more information refer to the W3C's CSS transforms documentation.
• object_type ((optional) str) – The visual appearance of the element.
• uid ((optional) str) – The system-generated uid of the element.
• visibility ((optional) float) – The relative visibility of the element. 0 &#x3D; not visible, 1 &#x3D; fully visible on screen.

attribute_map = {'children': 'children', 'entities': 'entities', 'id': 'id', 'object_type': 'type', 'position': 'position', 'tags': 'tags', 'transform': 'transform', 'uid': 'uid', 'visibility': 'visibility'}

deserialized_types = {'children': 'list[ask_sdk_model.interfaces.alexa.presentation.apl.component_visible_on_screen.ComponentVisibleOnScreen]', 'entities': 'list[ask_sdk_model.interfaces.alexa.presentation.apl.component_entity.ComponentEntity]', 'id': 'str', 'object_type': 'str', 'position': 'str', 'tags': 'ask_sdk_model.interfaces.alexa.presentation.apl.component_visible_on_screen_tags.ComponentVisibleOnScreenTags', 'transform': 'list[float]', 'uid': 'str', 'visibility': 'float'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.apl.component_visible_on_screen_list_item_tag module

class ask_sdk_model.interfaces.alexa.presentation.apl.component_visible_on_screen_list_item_tag.ComponentVisibleOnScreenListItemTag(index=None)

Bases: object

An element in a scrolling list

Parameters:index ((optional) int) – The zero-based index of this item in its parent.

attribute_map = {'index': 'index'}

deserialized_types = {'index': 'int'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.apl.component_visible_on_screen_list_tag module

class ask_sdk_model.interfaces.alexa.presentation.apl.component_visible_on_screen_list_tag.ComponentVisibleOnScreenListTag(item_count=None, lowest_index_seen=None, highest_index_seen=None, lowest_ordinal_seen=None, highest_ordinal_seen=None)

Bases: object

An ordered list of items

Parameters:

• item_count ((optional) int) – The total number of items in the list.
• lowest_index_seen ((optional) int) – The index of the lowest item seen.
• highest_index_seen ((optional) int) – The index of the highest item seen.
• lowest_ordinal_seen ((optional) int) – The ordinal of the lowest ordinal-equipped item seen.
• highest_ordinal_seen ((optional) int) – The ordinal of the highest ordinal-equipped item seen.

attribute_map = {'highest_index_seen': 'highestIndexSeen', 'highest_ordinal_seen': 'highestOrdinalSeen', 'item_count': 'itemCount', 'lowest_index_seen': 'lowestIndexSeen', 'lowest_ordinal_seen': 'lowestOrdinalSeen'}

deserialized_types = {'highest_index_seen': 'int', 'highest_ordinal_seen': 'int', 'item_count': 'int', 'lowest_index_seen': 'int', 'lowest_ordinal_seen': 'int'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.apl.component_visible_on_screen_media_tag module

class ask_sdk_model.interfaces.alexa.presentation.apl.component_visible_on_screen_media_tag.ComponentVisibleOnScreenMediaTag(position_in_milliseconds=None, state=None, allow_adjust_seek_position_forward=None, allow_adjust_seek_position_backwards=None, allow_next=None, allow_previous=None, entities=None, url=None)

Bases: object

Media player

Parameters:

• position_in_milliseconds ((optional) int) – Current position of the play head from the start of the track.
• state ((optional) ask_sdk_model.interfaces.alexa.presentation.apl.component_visible_on_screen_media_tag_state_enum.ComponentVisibleOnScreenMediaTagStateEnum) –
• allow_adjust_seek_position_forward ((optional) bool) – Whether the user may seek forward relative to the current position.
• allow_adjust_seek_position_backwards ((optional) bool) – Whether the user may seek backwards relative to the current position.
• allow_next ((optional) bool) – Whether the user may move forward to the next track.
• allow_previous ((optional) bool) – Whether the user may move backward to the previous track.
• entities ((optional) list[ask_sdk_model.interfaces.alexa.presentation.apl.component_entity.ComponentEntity]) –
• url ((optional) str) – The URL of the current media track.

attribute_map = {'allow_adjust_seek_position_backwards': 'allowAdjustSeekPositionBackwards', 'allow_adjust_seek_position_forward': 'allowAdjustSeekPositionForward', 'allow_next': 'allowNext', 'allow_previous': 'allowPrevious', 'entities': 'entities', 'position_in_milliseconds': 'positionInMilliseconds', 'state': 'state', 'url': 'url'}

deserialized_types = {'allow_adjust_seek_position_backwards': 'bool', 'allow_adjust_seek_position_forward': 'bool', 'allow_next': 'bool', 'allow_previous': 'bool', 'entities': 'list[ask_sdk_model.interfaces.alexa.presentation.apl.component_entity.ComponentEntity]', 'position_in_milliseconds': 'int', 'state': 'ask_sdk_model.interfaces.alexa.presentation.apl.component_visible_on_screen_media_tag_state_enum.ComponentVisibleOnScreenMediaTagStateEnum', 'url': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.apl.component_visible_on_screen_media_tag_state_enum module

class ask_sdk_model.interfaces.alexa.presentation.apl.component_visible_on_screen_media_tag_state_enum.ComponentVisibleOnScreenMediaTagStateEnum

Bases: enum.Enum

Media player stage posible states

Allowed enum values: [idle, playing, paused]

idle = 'idle'

paused = 'paused'

playing = 'playing'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.apl.component_visible_on_screen_pager_tag module

class ask_sdk_model.interfaces.alexa.presentation.apl.component_visible_on_screen_pager_tag.ComponentVisibleOnScreenPagerTag(index=None, page_count=None, allow_forward=None, allow_backwards=None)

Bases: object

A collection of items that are displayed one at a time.

Parameters:

• index ((optional) int) – The index of the current page.
• page_count ((optional) int) – The total number of pages.
• allow_forward ((optional) bool) – Indicates whether the pager will accept a forward command.
• allow_backwards ((optional) bool) – Indicates whether the pager will accept a backward command.

attribute_map = {'allow_backwards': 'allowBackwards', 'allow_forward': 'allowForward', 'index': 'index', 'page_count': 'pageCount'}

deserialized_types = {'allow_backwards': 'bool', 'allow_forward': 'bool', 'index': 'int', 'page_count': 'int'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.apl.component_visible_on_screen_scrollable_tag module

class ask_sdk_model.interfaces.alexa.presentation.apl.component_visible_on_screen_scrollable_tag.ComponentVisibleOnScreenScrollableTag(direction=None, allow_forward=None, allow_backward=None)

Bases: object

A scrollable region.

Parameters:

• direction ((optional) ask_sdk_model.interfaces.alexa.presentation.apl.component_visible_on_screen_scrollable_tag_direction_enum.ComponentVisibleOnScreenScrollableTagDirectionEnum) –
• allow_forward ((optional) bool) – Whether scrolling forward is accepted.
• allow_backward ((optional) bool) – Whether scrolling backward is accepted.

attribute_map = {'allow_backward': 'allowBackward', 'allow_forward': 'allowForward', 'direction': 'direction'}

deserialized_types = {'allow_backward': 'bool', 'allow_forward': 'bool', 'direction': 'ask_sdk_model.interfaces.alexa.presentation.apl.component_visible_on_screen_scrollable_tag_direction_enum.ComponentVisibleOnScreenScrollableTagDirectionEnum'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.apl.component_visible_on_screen_scrollable_tag_direction_enum module

class ask_sdk_model.interfaces.alexa.presentation.apl.component_visible_on_screen_scrollable_tag_direction_enum.ComponentVisibleOnScreenScrollableTagDirectionEnum

Bases: enum.Enum

Scrolling direction

Allowed enum values: [horizontal, vertical]

horizontal = 'horizontal'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vertical = 'vertical'

ask_sdk_model.interfaces.alexa.presentation.apl.component_visible_on_screen_tags module

class ask_sdk_model.interfaces.alexa.presentation.apl.component_visible_on_screen_tags.ComponentVisibleOnScreenTags(checked=None, clickable=None, disabled=None, focused=None, list=None, list_item=None, media=None, ordinal=None, pager=None, scrollable=None, spoken=None, viewport=None)

Bases: object

The tags which were attached to an element.

Parameters:

• checked ((optional) bool) – The checked state of a component that has two states.
• clickable ((optional) bool) – A button or item that can be pressed.
• disabled ((optional) bool) – Whether the element is disabled.
• focused ((optional) bool) – The focused state of a component that can take focus.
• list ((optional) ask_sdk_model.interfaces.alexa.presentation.apl.component_visible_on_screen_list_tag.ComponentVisibleOnScreenListTag) – An ordered list of items.
• list_item ((optional) ask_sdk_model.interfaces.alexa.presentation.apl.component_visible_on_screen_list_item_tag.ComponentVisibleOnScreenListItemTag) – An element in a sequence.
• media ((optional) ask_sdk_model.interfaces.alexa.presentation.apl.component_visible_on_screen_media_tag.ComponentVisibleOnScreenMediaTag) – Media player
• ordinal ((optional) int) – A visibly numbered element.
• pager ((optional) ask_sdk_model.interfaces.alexa.presentation.apl.component_visible_on_screen_pager_tag.ComponentVisibleOnScreenPagerTag) – A collection of items that are displayed one at a time.
• scrollable ((optional) ask_sdk_model.interfaces.alexa.presentation.apl.component_visible_on_screen_scrollable_tag.ComponentVisibleOnScreenScrollableTag) – A scrolling region
• spoken ((optional) bool) – A region of the screen that can be read out by TTS
• viewport ((optional) ask_sdk_model.interfaces.alexa.presentation.apl.component_visible_on_screen_viewport_tag.ComponentVisibleOnScreenViewportTag) – The entire screen in which a document is rendered.

attribute_map = {'checked': 'checked', 'clickable': 'clickable', 'disabled': 'disabled', 'focused': 'focused', 'list': 'list', 'list_item': 'listItem', 'media': 'media', 'ordinal': 'ordinal', 'pager': 'pager', 'scrollable': 'scrollable', 'spoken': 'spoken', 'viewport': 'viewport'}

deserialized_types = {'checked': 'bool', 'clickable': 'bool', 'disabled': 'bool', 'focused': 'bool', 'list': 'ask_sdk_model.interfaces.alexa.presentation.apl.component_visible_on_screen_list_tag.ComponentVisibleOnScreenListTag', 'list_item': 'ask_sdk_model.interfaces.alexa.presentation.apl.component_visible_on_screen_list_item_tag.ComponentVisibleOnScreenListItemTag', 'media': 'ask_sdk_model.interfaces.alexa.presentation.apl.component_visible_on_screen_media_tag.ComponentVisibleOnScreenMediaTag', 'ordinal': 'int', 'pager': 'ask_sdk_model.interfaces.alexa.presentation.apl.component_visible_on_screen_pager_tag.ComponentVisibleOnScreenPagerTag', 'scrollable': 'ask_sdk_model.interfaces.alexa.presentation.apl.component_visible_on_screen_scrollable_tag.ComponentVisibleOnScreenScrollableTag', 'spoken': 'bool', 'viewport': 'ask_sdk_model.interfaces.alexa.presentation.apl.component_visible_on_screen_viewport_tag.ComponentVisibleOnScreenViewportTag'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.apl.component_visible_on_screen_viewport_tag module

class ask_sdk_model.interfaces.alexa.presentation.apl.component_visible_on_screen_viewport_tag.ComponentVisibleOnScreenViewportTag

Bases: object

The entire screen in which a document is rendered.

attribute_map = {}

deserialized_types = {}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.apl.control_media_command module

class ask_sdk_model.interfaces.alexa.presentation.apl.control_media_command.ControlMediaCommand(delay=None, description=None, when=None, command=None, component_id=None, value=None)

Bases: ask_sdk_model.interfaces.alexa.presentation.apl.command.Command

Control a media player to play, pause, change tracks, or perform some other common action.

Parameters:

• delay ((optional) int) – The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
• description ((optional) str) – A user-provided description of this command.
• when ((optional) bool) – If false, the execution of the command is skipped. Defaults to true.
• command ((optional) ask_sdk_model.interfaces.alexa.presentation.apl.media_command_type.MediaCommandType) – The command to issue on the media player
• component_id ((optional) str) – The name of the media playing component
• value ((optional) int) – Optional data value

attribute_map = {'command': 'command', 'component_id': 'componentId', 'delay': 'delay', 'description': 'description', 'object_type': 'type', 'value': 'value', 'when': 'when'}

deserialized_types = {'command': 'ask_sdk_model.interfaces.alexa.presentation.apl.media_command_type.MediaCommandType', 'component_id': 'str', 'delay': 'int', 'description': 'str', 'object_type': 'str', 'value': 'int', 'when': 'bool'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.apl.execute_commands_directive module

class ask_sdk_model.interfaces.alexa.presentation.apl.execute_commands_directive.ExecuteCommandsDirective(commands=None, token=None)

Bases: ask_sdk_model.directive.Directive

Alexa.Presentation.APL.ExecuteCommands directive used to send APL commands to a device.

Parameters:

• commands ((optional) list[ask_sdk_model.interfaces.alexa.presentation.apl.command.Command]) – List of Command instances
• token ((optional) str) – A skill defined token, unique for each presentation. Must match the token provided by the skill in the RenderDocument directive used to render the original APL document.

attribute_map = {'commands': 'commands', 'object_type': 'type', 'token': 'token'}

deserialized_types = {'commands': 'list[ask_sdk_model.interfaces.alexa.presentation.apl.command.Command]', 'object_type': 'str', 'token': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.apl.highlight_mode module

class ask_sdk_model.interfaces.alexa.presentation.apl.highlight_mode.HighlightMode

Bases: enum.Enum

How highlighting is applied: on a line-by-line basis, or to the entire block. Defaults to block.

Allowed enum values: [block, line]

block = 'block'

line = 'line'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.apl.idle_command module

class ask_sdk_model.interfaces.alexa.presentation.apl.idle_command.IdleCommand(delay=None, description=None, when=None)

Bases: ask_sdk_model.interfaces.alexa.presentation.apl.command.Command

The idle command does nothing. It may be a placeholder or used to insert a calculated delay in a longer series of commands.

Parameters:

• delay ((optional) int) – The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
• description ((optional) str) – A user-provided description of this command.
• when ((optional) bool) – If false, the execution of the command is skipped. Defaults to true.

attribute_map = {'delay': 'delay', 'description': 'description', 'object_type': 'type', 'when': 'when'}

deserialized_types = {'delay': 'int', 'description': 'str', 'object_type': 'str', 'when': 'bool'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.apl.media_command_type module

class ask_sdk_model.interfaces.alexa.presentation.apl.media_command_type.MediaCommandType

Bases: enum.Enum

The command enumerated value is the operation that should be performed on the media player.

Allowed enum values: [play, pause, next, previous, rewind, seek, setTrack]

next = 'next'

pause = 'pause'

play = 'play'

previous = 'previous'

rewind = 'rewind'

seek = 'seek'

setTrack = 'setTrack'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.apl.move_transform_property module

class ask_sdk_model.interfaces.alexa.presentation.apl.move_transform_property.MoveTransformProperty(translate_x=None, translate_y=None)

Bases: ask_sdk_model.interfaces.alexa.presentation.apl.transform_property.TransformProperty

Parameters:

• translate_x ((optional) str) – Distance to translate the object to the right.
• translate_y ((optional) str) – Distance to translate the object down.

attribute_map = {'translate_x': 'translateX', 'translate_y': 'translateY'}

deserialized_types = {'translate_x': 'str', 'translate_y': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.apl.open_url_command module

class ask_sdk_model.interfaces.alexa.presentation.apl.open_url_command.OpenUrlCommand(delay=None, description=None, when=None, source=None, on_fail=None)

Bases: ask_sdk_model.interfaces.alexa.presentation.apl.command.Command

Opens a url with web browser or other application on the device. The APL author is responsible for providing a suitable URL that works on the current device.

Parameters:

• delay ((optional) int) – The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
• description ((optional) str) – A user-provided description of this command.
• when ((optional) bool) – If false, the execution of the command is skipped. Defaults to true.
• source ((optional) str) – The URL to open
• on_fail ((optional) list[ask_sdk_model.interfaces.alexa.presentation.apl.command.Command]) – Commands to execute if the URL fails to open

attribute_map = {'delay': 'delay', 'description': 'description', 'object_type': 'type', 'on_fail': 'onFail', 'source': 'source', 'when': 'when'}

deserialized_types = {'delay': 'int', 'description': 'str', 'object_type': 'str', 'on_fail': 'list[ask_sdk_model.interfaces.alexa.presentation.apl.command.Command]', 'source': 'str', 'when': 'bool'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.apl.parallel_command module

class ask_sdk_model.interfaces.alexa.presentation.apl.parallel_command.ParallelCommand(delay=None, description=None, when=None, commands=None)

Bases: ask_sdk_model.interfaces.alexa.presentation.apl.command.Command

Execute a series of commands in parallel. The parallel command starts executing all child command simultaneously. The parallel command is considered finished when all of its child commands have finished. When the parallel command is terminated early, all currently executing commands are terminated.

Parameters:

• delay ((optional) int) – The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
• description ((optional) str) – A user-provided description of this command.
• when ((optional) bool) – If false, the execution of the command is skipped. Defaults to true.
• commands ((optional) list[ask_sdk_model.interfaces.alexa.presentation.apl.command.Command]) – An un-ordered array of commands to execute in parallel. Once all commands have finished executing the parallel command finishes. Please note that the delay of parallel command and the delay of each command are additive.

attribute_map = {'commands': 'commands', 'delay': 'delay', 'description': 'description', 'object_type': 'type', 'when': 'when'}

deserialized_types = {'commands': 'list[ask_sdk_model.interfaces.alexa.presentation.apl.command.Command]', 'delay': 'int', 'description': 'str', 'object_type': 'str', 'when': 'bool'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.apl.play_media_command module

class ask_sdk_model.interfaces.alexa.presentation.apl.play_media_command.PlayMediaCommand(delay=None, description=None, when=None, audio_track=None, component_id=None, source=None)

Bases: ask_sdk_model.interfaces.alexa.presentation.apl.command.Command

Plays media on a media player (currently only a Video player; audio may be added in the future). The media may be on the background audio track or may be sequenced with speak directives).

Parameters:

• delay ((optional) int) – The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
• description ((optional) str) – A user-provided description of this command.
• when ((optional) bool) – If false, the execution of the command is skipped. Defaults to true.
• audio_track ((optional) ask_sdk_model.interfaces.alexa.presentation.apl.audio_track.AudioTrack) – The command to issue on the media player
• component_id ((optional) str) – The name of the media playing component
• source ((optional) list[ask_sdk_model.interfaces.alexa.presentation.apl.video_source.VideoSource]) – The media source

attribute_map = {'audio_track': 'audioTrack', 'component_id': 'componentId', 'delay': 'delay', 'description': 'description', 'object_type': 'type', 'source': 'source', 'when': 'when'}

deserialized_types = {'audio_track': 'ask_sdk_model.interfaces.alexa.presentation.apl.audio_track.AudioTrack', 'component_id': 'str', 'delay': 'int', 'description': 'str', 'object_type': 'str', 'source': 'list[ask_sdk_model.interfaces.alexa.presentation.apl.video_source.VideoSource]', 'when': 'bool'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.apl.position module

class ask_sdk_model.interfaces.alexa.presentation.apl.position.Position

Bases: enum.Enum

Whether the value is a relative or absolute offset. Defaults to absolute.

Allowed enum values: [absolute, relative]

absolute = 'absolute'

relative = 'relative'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.apl.render_document_directive module

class ask_sdk_model.interfaces.alexa.presentation.apl.render_document_directive.RenderDocumentDirective(token=None, document=None, datasources=None, packages=None)

Bases: ask_sdk_model.directive.Directive

Parameters:

• token ((optional) str) – A unique identifier for the presentation.
• document ((optional) dict(str, object)) – Depending on the document type, it represents either an entire APL document or a reference Link to the document. In a Link object, the value of the 'src' should follow a URI format defined like 'doc://alexa/apl/documents/&lt;document_id&gt;'. The 'document_id' is a reference to the APL document that the developer stores through APL Authoring Tool.
• datasources ((optional) dict(str, object)) – Data sources to bind to the document when rendering.
• packages ((optional) list[object]) – A list of packages including layouts, styles, and images etc.

attribute_map = {'datasources': 'datasources', 'document': 'document', 'object_type': 'type', 'packages': 'packages', 'token': 'token'}

deserialized_types = {'datasources': 'dict(str, object)', 'document': 'dict(str, object)', 'object_type': 'str', 'packages': 'list[object]', 'token': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.apl.rendered_document_state module

class ask_sdk_model.interfaces.alexa.presentation.apl.rendered_document_state.RenderedDocumentState(token=None, version=None, components_visible_on_screen=None)

Bases: object

Provides context for any APL content shown on screen.

Parameters:

• token ((optional) str) – The token specified in the RenderDocument directive which rendered the content shown on screen.
• version ((optional) str) – The APL version of the document which rendered the content shown on screen.
• components_visible_on_screen ((optional) list[ask_sdk_model.interfaces.alexa.presentation.apl.component_visible_on_screen.ComponentVisibleOnScreen]) – List of the visible APL components currently shown on screen.

attribute_map = {'components_visible_on_screen': 'componentsVisibleOnScreen', 'token': 'token', 'version': 'version'}

deserialized_types = {'components_visible_on_screen': 'list[ask_sdk_model.interfaces.alexa.presentation.apl.component_visible_on_screen.ComponentVisibleOnScreen]', 'token': 'str', 'version': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.apl.rotate_transform_property module

class ask_sdk_model.interfaces.alexa.presentation.apl.rotate_transform_property.RotateTransformProperty(rotate=0.0)

Bases: ask_sdk_model.interfaces.alexa.presentation.apl.transform_property.TransformProperty

Parameters:rotate (float) – Rotation angle, in degrees. Positive angles rotate in the clockwise direction.

attribute_map = {'rotate': 'rotate'}

deserialized_types = {'rotate': 'float'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.apl.runtime module

class ask_sdk_model.interfaces.alexa.presentation.apl.runtime.Runtime(max_version=None)

Bases: object

Contains the runtime information for the interface.

Parameters:max_version ((optional) str) – Maximum APL version supported by the runtime.

attribute_map = {'max_version': 'maxVersion'}

deserialized_types = {'max_version': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.apl.scale_transform_property module

class ask_sdk_model.interfaces.alexa.presentation.apl.scale_transform_property.ScaleTransformProperty(scale=1.0, scale_x=1.0, scale_y=1.0)

Bases: ask_sdk_model.interfaces.alexa.presentation.apl.transform_property.TransformProperty

Parameters:

• scale (float) – Uniform scaling in both X and Y.
• scale_x (float) – Scaling in the X direction (overrides “scale” if in same group).
• scale_y (float) – Scaling in the Y direction (overrides “scale” if in same group).

attribute_map = {'scale': 'scale', 'scale_x': 'scaleX', 'scale_y': 'scaleY'}

deserialized_types = {'scale': 'float', 'scale_x': 'float', 'scale_y': 'float'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.apl.scroll_command module

class ask_sdk_model.interfaces.alexa.presentation.apl.scroll_command.ScrollCommand(delay=None, description=None, when=None, distance=None, component_id=None)

Bases: ask_sdk_model.interfaces.alexa.presentation.apl.command.Command

Scroll a ScrollView or Sequence forward or backward by a number of pages. The Scroll command has the following properties in addition to the regular command properties.

Parameters:

• delay ((optional) int) – The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
• description ((optional) str) – A user-provided description of this command.
• when ((optional) bool) – If false, the execution of the command is skipped. Defaults to true.
• distance ((optional) int) – The number of pages to scroll. Defaults to 1.
• component_id ((optional) str) – The id of the component.

attribute_map = {'component_id': 'componentId', 'delay': 'delay', 'description': 'description', 'distance': 'distance', 'object_type': 'type', 'when': 'when'}

deserialized_types = {'component_id': 'str', 'delay': 'int', 'description': 'str', 'distance': 'int', 'object_type': 'str', 'when': 'bool'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.apl.scroll_to_index_command module

class ask_sdk_model.interfaces.alexa.presentation.apl.scroll_to_index_command.ScrollToIndexCommand(delay=None, description=None, when=None, align=None, component_id=None, index=None)

Bases: ask_sdk_model.interfaces.alexa.presentation.apl.command.Command

Scroll forward or backward through a ScrollView or Sequence to ensure that a particular child component is in view.

Parameters:

• delay ((optional) int) – The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
• description ((optional) str) – A user-provided description of this command.
• when ((optional) bool) – If false, the execution of the command is skipped. Defaults to true.
• align ((optional) ask_sdk_model.interfaces.alexa.presentation.apl.align.Align) –
• component_id ((optional) str) – The id of the component.
• index ((optional) int) – The 0-based index of the child to display.

attribute_map = {'align': 'align', 'component_id': 'componentId', 'delay': 'delay', 'description': 'description', 'index': 'index', 'object_type': 'type', 'when': 'when'}

deserialized_types = {'align': 'ask_sdk_model.interfaces.alexa.presentation.apl.align.Align', 'component_id': 'str', 'delay': 'int', 'description': 'str', 'index': 'int', 'object_type': 'str', 'when': 'bool'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.apl.send_event_command module

class ask_sdk_model.interfaces.alexa.presentation.apl.send_event_command.SendEventCommand(delay=None, description=None, when=None, arguments=None, components=None)

Bases: ask_sdk_model.interfaces.alexa.presentation.apl.command.Command

The SendEvent command allows the APL author to generate and send an event to Alexa.

Parameters:

• delay ((optional) int) – The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
• description ((optional) str) – A user-provided description of this command.
• when ((optional) bool) – If false, the execution of the command is skipped. Defaults to true.
• arguments ((optional) list[str]) – An array of argument data to pass to Alexa.
• components ((optional) list[str]) – An array of components to extract value data from and provide to Alexa.

attribute_map = {'arguments': 'arguments', 'components': 'components', 'delay': 'delay', 'description': 'description', 'object_type': 'type', 'when': 'when'}

deserialized_types = {'arguments': 'list[str]', 'components': 'list[str]', 'delay': 'int', 'description': 'str', 'object_type': 'str', 'when': 'bool'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.apl.sequential_command module

class ask_sdk_model.interfaces.alexa.presentation.apl.sequential_command.SequentialCommand(delay=None, description=None, when=None, catch=None, commands=None, object_finally=None, repeat_count=None)

Bases: ask_sdk_model.interfaces.alexa.presentation.apl.command.Command

A sequential command executes a series of commands in order. The sequential command executes the command list in order, waiting for the previous command to finish before executing the next. The sequential command is finished when all of its child commands have finished. When the Sequential command is terminated early, the currently executing command is terminated and no further commands are executed.

Parameters:

• delay ((optional) int) – The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
• description ((optional) str) – A user-provided description of this command.
• when ((optional) bool) – If false, the execution of the command is skipped. Defaults to true.
• catch ((optional) list[ask_sdk_model.interfaces.alexa.presentation.apl.command.Command]) – An ordered list of commands to execute if this sequence is prematurely terminated.
• commands ((optional) list[ask_sdk_model.interfaces.alexa.presentation.apl.command.Command]) – An array of commands to execute. The commands execute in order; each command must finish before the next can begin. Please note that the delay of sequential command and the delay of the first command in the sequence are additive.
• object_finally ((optional) list[ask_sdk_model.interfaces.alexa.presentation.apl.command.Command]) – An ordered list of commands to execute after the normal commands and the catch commands.
• repeat_count ((optional) int) – The number of times to repeat this series of commands. Defaults to 0. Negative values will be ignored. Note that the delay assigned to overall sequential command only applies the first time. For example, in the sample sequential command below the first SendEvent fires at 3000 milliseconds, the second at 5000, the first SendEvent fires again at 7000 milliseconds, and so forth. {&quot;type&quot;: &quot;Sequential&quot;,&quot;delay&quot;: 1000,&quot;repeatCount&quot;: 2,&quot;commands&quot;: [{ &quot;type&quot;: &quot;SendEvent&quot;,&quot;delay&quot;: 2000},{&quot;type&quot;: &quot;SendEvent&quot;,&quot;delay&quot;: 2000}]}

attribute_map = {'catch': 'catch', 'commands': 'commands', 'delay': 'delay', 'description': 'description', 'object_finally': 'finally', 'object_type': 'type', 'repeat_count': 'repeatCount', 'when': 'when'}

deserialized_types = {'catch': 'list[ask_sdk_model.interfaces.alexa.presentation.apl.command.Command]', 'commands': 'list[ask_sdk_model.interfaces.alexa.presentation.apl.command.Command]', 'delay': 'int', 'description': 'str', 'object_finally': 'list[ask_sdk_model.interfaces.alexa.presentation.apl.command.Command]', 'object_type': 'str', 'repeat_count': 'int', 'when': 'bool'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.apl.set_focus_command module

class ask_sdk_model.interfaces.alexa.presentation.apl.set_focus_command.SetFocusCommand(delay=None, description=None, when=None, component_id=None)

Bases: ask_sdk_model.interfaces.alexa.presentation.apl.command.Command

Changes the actionable component that is in focus. Only one component may have focus at a time.

Parameters:

• delay ((optional) int) – The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
• description ((optional) str) – A user-provided description of this command.
• when ((optional) bool) – If false, the execution of the command is skipped. Defaults to true.
• component_id ((optional) str) – The ID of the component to set focus on.

attribute_map = {'component_id': 'componentId', 'delay': 'delay', 'description': 'description', 'object_type': 'type', 'when': 'when'}

deserialized_types = {'component_id': 'str', 'delay': 'int', 'description': 'str', 'object_type': 'str', 'when': 'bool'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.apl.set_page_command module

class ask_sdk_model.interfaces.alexa.presentation.apl.set_page_command.SetPageCommand(delay=None, description=None, when=None, component_id=None, position=None, value=None)

Bases: ask_sdk_model.interfaces.alexa.presentation.apl.command.Command

Change the page displayed in a Pager component. The SetPage command finishes when the item is fully in view.

Parameters:

• delay ((optional) int) – The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
• description ((optional) str) – A user-provided description of this command.
• when ((optional) bool) – If false, the execution of the command is skipped. Defaults to true.
• component_id ((optional) str) – The id of the Pager component.
• position ((optional) ask_sdk_model.interfaces.alexa.presentation.apl.position.Position) –
• value ((optional) int) – The distance to move. May be an absolute value or a relative value.

attribute_map = {'component_id': 'componentId', 'delay': 'delay', 'description': 'description', 'object_type': 'type', 'position': 'position', 'value': 'value', 'when': 'when'}

deserialized_types = {'component_id': 'str', 'delay': 'int', 'description': 'str', 'object_type': 'str', 'position': 'ask_sdk_model.interfaces.alexa.presentation.apl.position.Position', 'value': 'int', 'when': 'bool'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.apl.set_state_command module

class ask_sdk_model.interfaces.alexa.presentation.apl.set_state_command.SetStateCommand(delay=None, description=None, when=None, component_id=None, state=None, value=None)

Bases: ask_sdk_model.interfaces.alexa.presentation.apl.command.Command

The SetState command changes one of the component’s state settings. The SetState command can be used to change the checked, disabled, and focused states. The karaoke and pressed states may not be directly set; use the Select command or SpeakItem commands to change those states. Also, note that the focused state may only be set - it can’t be cleared.

Parameters:

• delay ((optional) int) – The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
• description ((optional) str) – A user-provided description of this command.
• when ((optional) bool) – If false, the execution of the command is skipped. Defaults to true.
• component_id ((optional) str) – The id of the component whose value should be set.
• state ((optional) ask_sdk_model.interfaces.alexa.presentation.apl.component_state.ComponentState) – The name of the state to set. Must be one of “checked”, “disabled”, and “focused”.
• value ((optional) bool) – The value to set on the property

attribute_map = {'component_id': 'componentId', 'delay': 'delay', 'description': 'description', 'object_type': 'type', 'state': 'state', 'value': 'value', 'when': 'when'}

deserialized_types = {'component_id': 'str', 'delay': 'int', 'description': 'str', 'object_type': 'str', 'state': 'ask_sdk_model.interfaces.alexa.presentation.apl.component_state.ComponentState', 'value': 'bool', 'when': 'bool'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.apl.set_value_command module

class ask_sdk_model.interfaces.alexa.presentation.apl.set_value_command.SetValueCommand(delay=None, description=None, when=None, component_id=None, object_property=None, value=None)

Bases: ask_sdk_model.interfaces.alexa.presentation.apl.command.Command

Change a dynamic property of a component without redrawing the screen.

Parameters:

• delay ((optional) int) – The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
• description ((optional) str) – A user-provided description of this command.
• when ((optional) bool) – If false, the execution of the command is skipped. Defaults to true.
• component_id ((optional) str) – The id of the component whose value to set.
• object_property ((optional) str) – The name of the property to set.
• value ((optional) str) – The property value to set.

attribute_map = {'component_id': 'componentId', 'delay': 'delay', 'description': 'description', 'object_property': 'property', 'object_type': 'type', 'value': 'value', 'when': 'when'}

deserialized_types = {'component_id': 'str', 'delay': 'int', 'description': 'str', 'object_property': 'str', 'object_type': 'str', 'value': 'str', 'when': 'bool'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.apl.skew_transform_property module

class ask_sdk_model.interfaces.alexa.presentation.apl.skew_transform_property.SkewTransformProperty(skew_x=1.0, skew_y=1.0)

Bases: ask_sdk_model.interfaces.alexa.presentation.apl.transform_property.TransformProperty

Parameters:

• skew_x (float) – Skew angle for the X-axis, in degrees. X-axis lines remain horizontal.
• skew_y (float) – Skew angle for the Y-axis, in degrees. Y-axis lines remain vertical.

attribute_map = {'skew_x': 'skewX', 'skew_y': 'skewY'}

deserialized_types = {'skew_x': 'float', 'skew_y': 'float'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.apl.speak_item_command module

class ask_sdk_model.interfaces.alexa.presentation.apl.speak_item_command.SpeakItemCommand(delay=None, description=None, when=None, align=None, component_id=None, highlight_mode=None, minimum_dwell_time=None)

Bases: ask_sdk_model.interfaces.alexa.presentation.apl.command.Command

Reads the contents of a single item on the screen. By default the item will be scrolled into view if it is not currently visible.

Parameters:

• delay ((optional) int) – The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
• description ((optional) str) – A user-provided description of this command.
• when ((optional) bool) – If false, the execution of the command is skipped. Defaults to true.
• align ((optional) ask_sdk_model.interfaces.alexa.presentation.apl.align.Align) –
• component_id ((optional) str) – The id of the component to speak.
• highlight_mode ((optional) ask_sdk_model.interfaces.alexa.presentation.apl.highlight_mode.HighlightMode) –
• minimum_dwell_time ((optional) int) – The minimum number of milliseconds that an item should be highlighted for. Defaults to 0.

attribute_map = {'align': 'align', 'component_id': 'componentId', 'delay': 'delay', 'description': 'description', 'highlight_mode': 'highlightMode', 'minimum_dwell_time': 'minimumDwellTime', 'object_type': 'type', 'when': 'when'}

deserialized_types = {'align': 'ask_sdk_model.interfaces.alexa.presentation.apl.align.Align', 'component_id': 'str', 'delay': 'int', 'description': 'str', 'highlight_mode': 'ask_sdk_model.interfaces.alexa.presentation.apl.highlight_mode.HighlightMode', 'minimum_dwell_time': 'int', 'object_type': 'str', 'when': 'bool'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.apl.speak_list_command module

class ask_sdk_model.interfaces.alexa.presentation.apl.speak_list_command.SpeakListCommand(delay=None, description=None, when=None, align=None, component_id=None, count=None, minimum_dwell_time=None, start=None)

Bases: ask_sdk_model.interfaces.alexa.presentation.apl.command.Command

Read the contents of a range of items inside a common container. Each item will scroll into view before speech. Each item should have a speech property, but it is not required.

Parameters:

• delay ((optional) int) – The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
• description ((optional) str) – A user-provided description of this command.
• when ((optional) bool) – If false, the execution of the command is skipped. Defaults to true.
• align ((optional) ask_sdk_model.interfaces.alexa.presentation.apl.align.Align) –
• component_id ((optional) str) – The id of the component to read.
• count ((optional) int) – The number of items to speak
• minimum_dwell_time ((optional) int) – The minimum number of milliseconds that an item will be highlighted for. Defaults to 0.
• start ((optional) int) – The 0-based index of the first item to speak

attribute_map = {'align': 'align', 'component_id': 'componentId', 'count': 'count', 'delay': 'delay', 'description': 'description', 'minimum_dwell_time': 'minimumDwellTime', 'object_type': 'type', 'start': 'start', 'when': 'when'}

deserialized_types = {'align': 'ask_sdk_model.interfaces.alexa.presentation.apl.align.Align', 'component_id': 'str', 'count': 'int', 'delay': 'int', 'description': 'str', 'minimum_dwell_time': 'int', 'object_type': 'str', 'start': 'int', 'when': 'bool'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.apl.transform_property module

class ask_sdk_model.interfaces.alexa.presentation.apl.transform_property.TransformProperty

Bases: object

Transform property to apply to a component.

attribute_map = {}

deserialized_types = {}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.apl.user_event module

class ask_sdk_model.interfaces.alexa.presentation.apl.user_event.UserEvent(request_id=None, timestamp=None, locale=None, token=None, arguments=None, source=None, components=None)

Bases: ask_sdk_model.request.Request

Parameters:

• request_id ((optional) str) – Represents the unique identifier for the specific request.
• timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
• locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
• token ((optional) str) – A unique token for the active presentation.
• arguments ((optional) list[object]) – The array of argument data to pass to Alexa.
• source ((optional) object) – Meta-information about what caused the event to be generated.
• components ((optional) object) – Components associated with the request.

attribute_map = {'arguments': 'arguments', 'components': 'components', 'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'source': 'source', 'timestamp': 'timestamp', 'token': 'token'}

deserialized_types = {'arguments': 'list[object]', 'components': 'object', 'locale': 'str', 'object_type': 'str', 'request_id': 'str', 'source': 'object', 'timestamp': 'datetime', 'token': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.apl.video_source module

class ask_sdk_model.interfaces.alexa.presentation.apl.video_source.VideoSource(description=None, duration=None, url=None, repeat_count=None, offset=None)

Bases: object

The source property holds the video clip or sequence of video clips to play.

Parameters:

• description ((optional) str) – Optional description of this source material
• duration ((optional) int) – Duration of time to play. If not set, defaults to the entire stream. Expressed in milliseconds.
• url ((optional) str) – Media source material
• repeat_count ((optional) int) – Number of times to loop the video. Defaults to 0.
• offset ((optional) int) – Offset to start playing at in the stream (defaults to 0).

attribute_map = {'description': 'description', 'duration': 'duration', 'offset': 'offset', 'repeat_count': 'repeatCount', 'url': 'url'}

deserialized_types = {'description': 'str', 'duration': 'int', 'offset': 'int', 'repeat_count': 'int', 'url': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.aplt 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_sdk_model.interfaces.alexa.presentation.aplt.alexa_presentation_aplt_interface module

class ask_sdk_model.interfaces.alexa.presentation.aplt.alexa_presentation_aplt_interface.AlexaPresentationApltInterface(runtime=None)

Bases: object

Parameters:runtime ((optional) ask_sdk_model.interfaces.alexa.presentation.aplt.runtime.Runtime) –

attribute_map = {'runtime': 'runtime'}

deserialized_types = {'runtime': 'ask_sdk_model.interfaces.alexa.presentation.aplt.runtime.Runtime'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.aplt.auto_page_command module

class ask_sdk_model.interfaces.alexa.presentation.aplt.auto_page_command.AutoPageCommand(delay=None, description=None, screen_lock=None, when=None, component_id=None, count=None, duration=None)

Bases: ask_sdk_model.interfaces.alexa.presentation.aplt.command.Command

Automatically progress through a series of pages displayed in a Pager component. The AutoPage command finishes after the last page has been displayed for the requested time period.

Parameters:

• delay ((optional) int) – The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
• description ((optional) str) – A user-provided description of this command.
• screen_lock ((optional) bool) – If true, disable the Interaction Timer.
• when ((optional) bool) – A conditional expression to be evaluated in device. If false, the execution of the command is skipped. Defaults to true.
• component_id ((optional) str) – The id of the Pager component.
• count ((optional) int) – Number of pages to display. Defaults to all of them.
• duration ((optional) int) – Time to wait between pages (in milliseconds). Defaults to 0.

attribute_map = {'component_id': 'componentId', 'count': 'count', 'delay': 'delay', 'description': 'description', 'duration': 'duration', 'object_type': 'type', 'screen_lock': 'screenLock', 'when': 'when'}

deserialized_types = {'component_id': 'str', 'count': 'int', 'delay': 'int', 'description': 'str', 'duration': 'int', 'object_type': 'str', 'screen_lock': 'bool', 'when': 'bool'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.aplt.command module

class ask_sdk_model.interfaces.alexa.presentation.aplt.command.Command(object_type=None, delay=None, description=None, screen_lock=None, when=None)

Bases: object

A message that can change the visual or audio presentation of the content on the screen.

Parameters:

• object_type ((optional) str) – Defines the command type and dictates which properties must/can be included.
• delay ((optional) int) – The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
• description ((optional) str) – A user-provided description of this command.
• screen_lock ((optional) bool) – If true, disable the Interaction Timer.
• when ((optional) bool) – A conditional expression to be evaluated in device. If false, the execution of the command is skipped. Defaults to true.

Note

This is an abstract class. Use the following mapping, to figure out the model class to be instantiated, that sets type variable.

SetValue: ask_sdk_model.interfaces.alexa.presentation.aplt.set_value_command.SetValueCommand,

Idle: ask_sdk_model.interfaces.alexa.presentation.aplt.idle_command.IdleCommand,

AutoPage: ask_sdk_model.interfaces.alexa.presentation.aplt.auto_page_command.AutoPageCommand,

Scroll: ask_sdk_model.interfaces.alexa.presentation.aplt.scroll_command.ScrollCommand,

SendEvent: ask_sdk_model.interfaces.alexa.presentation.aplt.send_event_command.SendEventCommand,

Parallel: ask_sdk_model.interfaces.alexa.presentation.aplt.parallel_command.ParallelCommand,

SetPage: ask_sdk_model.interfaces.alexa.presentation.aplt.set_page_command.SetPageCommand,

Sequential: ask_sdk_model.interfaces.alexa.presentation.aplt.sequential_command.SequentialCommand

attribute_map = {'delay': 'delay', 'description': 'description', 'object_type': 'type', 'screen_lock': 'screenLock', 'when': 'when'}

deserialized_types = {'delay': 'int', 'description': 'str', 'object_type': 'str', 'screen_lock': 'bool', 'when': 'bool'}

discriminator_value_class_map = {'AutoPage': 'ask_sdk_model.interfaces.alexa.presentation.aplt.auto_page_command.AutoPageCommand', 'Idle': 'ask_sdk_model.interfaces.alexa.presentation.aplt.idle_command.IdleCommand', 'Parallel': 'ask_sdk_model.interfaces.alexa.presentation.aplt.parallel_command.ParallelCommand', 'Scroll': 'ask_sdk_model.interfaces.alexa.presentation.aplt.scroll_command.ScrollCommand', 'SendEvent': 'ask_sdk_model.interfaces.alexa.presentation.aplt.send_event_command.SendEventCommand', 'Sequential': 'ask_sdk_model.interfaces.alexa.presentation.aplt.sequential_command.SequentialCommand', 'SetPage': 'ask_sdk_model.interfaces.alexa.presentation.aplt.set_page_command.SetPageCommand', 'SetValue': 'ask_sdk_model.interfaces.alexa.presentation.aplt.set_value_command.SetValueCommand'}

classmethod get_real_child_model(data)

Returns the real base class specified by the discriminator

json_discriminator_key = 'type'

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.aplt.execute_commands_directive module

class ask_sdk_model.interfaces.alexa.presentation.aplt.execute_commands_directive.ExecuteCommandsDirective(commands=None, token=None)

Bases: ask_sdk_model.directive.Directive

Alexa.Presentation.APLT.ExecuteCommands directive used to send APL-T commands to a device.

Parameters:

• commands ((optional) list[ask_sdk_model.interfaces.alexa.presentation.aplt.command.Command]) – List of Command instances
• token ((optional) str) – A skill defined token, unique for each presentation. Must match the token provided by the skill in the RenderDocument directive used to render the original APL document.

attribute_map = {'commands': 'commands', 'object_type': 'type', 'token': 'token'}

deserialized_types = {'commands': 'list[ask_sdk_model.interfaces.alexa.presentation.aplt.command.Command]', 'object_type': 'str', 'token': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.aplt.idle_command module

class ask_sdk_model.interfaces.alexa.presentation.aplt.idle_command.IdleCommand(delay=None, description=None, screen_lock=None, when=None)

Bases: ask_sdk_model.interfaces.alexa.presentation.aplt.command.Command

The idle command does nothing. It may be a placeholder or used to insert a calculated delay in a longer series of commands.

Parameters:

• delay ((optional) int) – The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
• description ((optional) str) – A user-provided description of this command.
• screen_lock ((optional) bool) – If true, disable the Interaction Timer.
• when ((optional) bool) – A conditional expression to be evaluated in device. If false, the execution of the command is skipped. Defaults to true.

attribute_map = {'delay': 'delay', 'description': 'description', 'object_type': 'type', 'screen_lock': 'screenLock', 'when': 'when'}

deserialized_types = {'delay': 'int', 'description': 'str', 'object_type': 'str', 'screen_lock': 'bool', 'when': 'bool'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.aplt.parallel_command module

class ask_sdk_model.interfaces.alexa.presentation.aplt.parallel_command.ParallelCommand(delay=None, description=None, screen_lock=None, when=None, commands=None)

Bases: ask_sdk_model.interfaces.alexa.presentation.aplt.command.Command

Execute a series of commands in parallel. The parallel command starts executing all child command simultaneously. The parallel command is considered finished when all of its child commands have finished. When the parallel command is terminated early, all currently executing commands are terminated.

Parameters:

• delay ((optional) int) – The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
• description ((optional) str) – A user-provided description of this command.
• screen_lock ((optional) bool) – If true, disable the Interaction Timer.
• when ((optional) bool) – A conditional expression to be evaluated in device. If false, the execution of the command is skipped. Defaults to true.
• commands ((optional) list[ask_sdk_model.interfaces.alexa.presentation.aplt.command.Command]) – An un-ordered array of commands to execute in parallel. Once all commands have finished executing the parallel command finishes. Please note that the delay of parallel command and the delay of each command are additive.

attribute_map = {'commands': 'commands', 'delay': 'delay', 'description': 'description', 'object_type': 'type', 'screen_lock': 'screenLock', 'when': 'when'}

deserialized_types = {'commands': 'list[ask_sdk_model.interfaces.alexa.presentation.aplt.command.Command]', 'delay': 'int', 'description': 'str', 'object_type': 'str', 'screen_lock': 'bool', 'when': 'bool'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.aplt.position module

class ask_sdk_model.interfaces.alexa.presentation.aplt.position.Position

Bases: enum.Enum

Whether the value is a relative or absolute offset. Defaults to absolute.

Allowed enum values: [absolute, relative]

absolute = 'absolute'

relative = 'relative'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.aplt.render_document_directive module

class ask_sdk_model.interfaces.alexa.presentation.aplt.render_document_directive.RenderDocumentDirective(token=None, target_profile=None, document=None, datasources=None)

Bases: ask_sdk_model.directive.Directive

Parameters:

• token ((optional) str) – A unique identifier for the presentation.
• target_profile ((optional) ask_sdk_model.interfaces.alexa.presentation.aplt.target_profile.TargetProfile) – One of supported profiles in character display. Default value is NONE.
• document ((optional) dict(str, object)) – Depending on the document type, it represents either an entire APLT document or a reference Link to the document. In a Link object, the value of the 'src' should follow a URI format defined like 'doc://alexa/aplt/documents/&lt;document_id&gt;'. The 'document_id' is a reference to the APLT document that the developer stores through APL Authoring Tool.
• datasources ((optional) dict(str, object)) – Data sources to bind to the document when rendering.

attribute_map = {'datasources': 'datasources', 'document': 'document', 'object_type': 'type', 'target_profile': 'targetProfile', 'token': 'token'}

deserialized_types = {'datasources': 'dict(str, object)', 'document': 'dict(str, object)', 'object_type': 'str', 'target_profile': 'ask_sdk_model.interfaces.alexa.presentation.aplt.target_profile.TargetProfile', 'token': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.aplt.runtime module

class ask_sdk_model.interfaces.alexa.presentation.aplt.runtime.Runtime(max_version=None)

Bases: object

Contains the runtime information for the interface.

Parameters:max_version ((optional) str) – Maximum APL-T version supported by the runtime.

attribute_map = {'max_version': 'maxVersion'}

deserialized_types = {'max_version': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.aplt.scroll_command module

class ask_sdk_model.interfaces.alexa.presentation.aplt.scroll_command.ScrollCommand(delay=None, description=None, screen_lock=None, when=None, distance=None, component_id=None)

Bases: ask_sdk_model.interfaces.alexa.presentation.aplt.command.Command

Scroll a ScrollView or Sequence forward or backward by a number of pages. The Scroll command has the following properties in addition to the regular command properties.

Parameters:

• delay ((optional) int) – The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
• description ((optional) str) – A user-provided description of this command.
• screen_lock ((optional) bool) – If true, disable the Interaction Timer.
• when ((optional) bool) – A conditional expression to be evaluated in device. If false, the execution of the command is skipped. Defaults to true.
• distance ((optional) int) – The number of pages to scroll. Defaults to 1.
• component_id ((optional) str) – The id of the component.

attribute_map = {'component_id': 'componentId', 'delay': 'delay', 'description': 'description', 'distance': 'distance', 'object_type': 'type', 'screen_lock': 'screenLock', 'when': 'when'}

deserialized_types = {'component_id': 'str', 'delay': 'int', 'description': 'str', 'distance': 'int', 'object_type': 'str', 'screen_lock': 'bool', 'when': 'bool'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.aplt.send_event_command module

class ask_sdk_model.interfaces.alexa.presentation.aplt.send_event_command.SendEventCommand(delay=None, description=None, screen_lock=None, when=None, arguments=None, components=None)

Bases: ask_sdk_model.interfaces.alexa.presentation.aplt.command.Command

The SendEvent command allows the APL author to generate and send an event to Alexa.

Parameters:

• delay ((optional) int) – The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
• description ((optional) str) – A user-provided description of this command.
• screen_lock ((optional) bool) – If true, disable the Interaction Timer.
• when ((optional) bool) – A conditional expression to be evaluated in device. If false, the execution of the command is skipped. Defaults to true.
• arguments ((optional) list[str]) – An array of argument data to pass to Alexa.
• components ((optional) list[str]) – An array of components to extract value data from and provide to Alexa.

attribute_map = {'arguments': 'arguments', 'components': 'components', 'delay': 'delay', 'description': 'description', 'object_type': 'type', 'screen_lock': 'screenLock', 'when': 'when'}

deserialized_types = {'arguments': 'list[str]', 'components': 'list[str]', 'delay': 'int', 'description': 'str', 'object_type': 'str', 'screen_lock': 'bool', 'when': 'bool'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.aplt.sequential_command module

class ask_sdk_model.interfaces.alexa.presentation.aplt.sequential_command.SequentialCommand(delay=None, description=None, screen_lock=None, when=None, catch=None, commands=None, object_finally=None, repeat_count=None)

Bases: ask_sdk_model.interfaces.alexa.presentation.aplt.command.Command

A sequential command executes a series of commands in order. The sequential command executes the command list in order, waiting for the previous command to finish before executing the next. The sequential command is finished when all of its child commands have finished. When the Sequential command is terminated early, the currently executing command is terminated and no further commands are executed.

Parameters:

• delay ((optional) int) – The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
• description ((optional) str) – A user-provided description of this command.
• screen_lock ((optional) bool) – If true, disable the Interaction Timer.
• when ((optional) bool) – A conditional expression to be evaluated in device. If false, the execution of the command is skipped. Defaults to true.
• catch ((optional) list[ask_sdk_model.interfaces.alexa.presentation.aplt.command.Command]) – An ordered list of commands to execute if this sequence is prematurely terminated.
• commands ((optional) list[ask_sdk_model.interfaces.alexa.presentation.aplt.command.Command]) – An array of commands to execute. The commands execute in order; each command must finish before the next can begin. Please note that the delay of sequential command and the delay of the first command in the sequence are additive.
• object_finally ((optional) list[ask_sdk_model.interfaces.alexa.presentation.aplt.command.Command]) – An ordered list of commands to execute after the normal commands and the catch commands.
• repeat_count ((optional) int) – The number of times to repeat this series of commands. Defaults to 0. Negative values will be ignored. Note that the delay assigned to overall sequential command only applies the first time. For example, in the sample sequential command below the first SendEvent fires at 3000 milliseconds, the second at 5000, the first SendEvent fires again at 7000 milliseconds, and so forth. {&quot;type&quot;: &quot;Sequential&quot;,&quot;delay&quot;: 1000,&quot;repeatCount&quot;: 2,&quot;commands&quot;: [{ &quot;type&quot;: &quot;SendEvent&quot;,&quot;delay&quot;: 2000},{&quot;type&quot;: &quot;SendEvent&quot;,&quot;delay&quot;: 2000}]}

attribute_map = {'catch': 'catch', 'commands': 'commands', 'delay': 'delay', 'description': 'description', 'object_finally': 'finally', 'object_type': 'type', 'repeat_count': 'repeatCount', 'screen_lock': 'screenLock', 'when': 'when'}

deserialized_types = {'catch': 'list[ask_sdk_model.interfaces.alexa.presentation.aplt.command.Command]', 'commands': 'list[ask_sdk_model.interfaces.alexa.presentation.aplt.command.Command]', 'delay': 'int', 'description': 'str', 'object_finally': 'list[ask_sdk_model.interfaces.alexa.presentation.aplt.command.Command]', 'object_type': 'str', 'repeat_count': 'int', 'screen_lock': 'bool', 'when': 'bool'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.aplt.set_page_command module

class ask_sdk_model.interfaces.alexa.presentation.aplt.set_page_command.SetPageCommand(delay=None, description=None, screen_lock=None, when=None, component_id=None, position=None, value=None)

Bases: ask_sdk_model.interfaces.alexa.presentation.aplt.command.Command

Change the page displayed in a Pager component. The SetPage command finishes when the item is fully in view.

Parameters:

• delay ((optional) int) – The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
• description ((optional) str) – A user-provided description of this command.
• screen_lock ((optional) bool) – If true, disable the Interaction Timer.
• when ((optional) bool) – A conditional expression to be evaluated in device. If false, the execution of the command is skipped. Defaults to true.
• component_id ((optional) str) – The id of the Pager component.
• position ((optional) ask_sdk_model.interfaces.alexa.presentation.aplt.position.Position) –
• value ((optional) int) – The distance to move. May be an absolute value or a relative value.

attribute_map = {'component_id': 'componentId', 'delay': 'delay', 'description': 'description', 'object_type': 'type', 'position': 'position', 'screen_lock': 'screenLock', 'value': 'value', 'when': 'when'}

deserialized_types = {'component_id': 'str', 'delay': 'int', 'description': 'str', 'object_type': 'str', 'position': 'ask_sdk_model.interfaces.alexa.presentation.aplt.position.Position', 'screen_lock': 'bool', 'value': 'int', 'when': 'bool'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.aplt.set_value_command module

class ask_sdk_model.interfaces.alexa.presentation.aplt.set_value_command.SetValueCommand(delay=None, description=None, screen_lock=None, when=None, component_id=None, object_property=None, value=None)

Bases: ask_sdk_model.interfaces.alexa.presentation.aplt.command.Command

Change a dynamic property of a component without redrawing the screen.

Parameters:

• delay ((optional) int) – The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
• description ((optional) str) – A user-provided description of this command.
• screen_lock ((optional) bool) – If true, disable the Interaction Timer.
• when ((optional) bool) – A conditional expression to be evaluated in device. If false, the execution of the command is skipped. Defaults to true.
• component_id ((optional) str) – The id of the component whose value to set.
• object_property ((optional) str) – The name of the property to set.
• value ((optional) str) – The property value to set.

attribute_map = {'component_id': 'componentId', 'delay': 'delay', 'description': 'description', 'object_property': 'property', 'object_type': 'type', 'screen_lock': 'screenLock', 'value': 'value', 'when': 'when'}

deserialized_types = {'component_id': 'str', 'delay': 'int', 'description': 'str', 'object_property': 'str', 'object_type': 'str', 'screen_lock': 'bool', 'value': 'str', 'when': 'bool'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.aplt.target_profile module

class ask_sdk_model.interfaces.alexa.presentation.aplt.target_profile.TargetProfile

Bases: enum.Enum

Name of a supported profile on character display.

Allowed enum values: [FOUR_CHARACTER_CLOCK, NONE]

FOUR_CHARACTER_CLOCK = 'FOUR_CHARACTER_CLOCK'

NONE = 'NONE'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.aplt.user_event module

class ask_sdk_model.interfaces.alexa.presentation.aplt.user_event.UserEvent(request_id=None, timestamp=None, locale=None, token=None, arguments=None, source=None)

Bases: ask_sdk_model.request.Request

Parameters:

• request_id ((optional) str) – Represents the unique identifier for the specific request.
• timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
• locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
• token ((optional) str) – A unique token for the active presentation.
• arguments ((optional) list[object]) – The array of argument data to pass to Alexa.
• source ((optional) object) – Meta-information about what caused the event to be generated.

attribute_map = {'arguments': 'arguments', 'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'source': 'source', 'timestamp': 'timestamp', 'token': 'token'}

deserialized_types = {'arguments': 'list[object]', 'locale': 'str', 'object_type': 'str', 'request_id': 'str', 'source': 'object', 'timestamp': 'datetime', 'token': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.html 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_sdk_model.interfaces.alexa.presentation.html.alexa_presentation_html_interface module

class ask_sdk_model.interfaces.alexa.presentation.html.alexa_presentation_html_interface.AlexaPresentationHtmlInterface(runtime=None)

Bases: object

Parameters:runtime ((optional) ask_sdk_model.interfaces.alexa.presentation.html.runtime.Runtime) –

attribute_map = {'runtime': 'runtime'}

deserialized_types = {'runtime': 'ask_sdk_model.interfaces.alexa.presentation.html.runtime.Runtime'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.html.configuration module

class ask_sdk_model.interfaces.alexa.presentation.html.configuration.Configuration(timeout_in_seconds=None)

Bases: object

Parameters:timeout_in_seconds ((optional) int) – The number of seconds the content can stay on the screen without user interaction. Default value is 30 seconds. Maximum allowed value is 5 minutes.

attribute_map = {'timeout_in_seconds': 'timeoutInSeconds'}

deserialized_types = {'timeout_in_seconds': 'int'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.html.handle_message_directive module

class ask_sdk_model.interfaces.alexa.presentation.html.handle_message_directive.HandleMessageDirective(message=None, transformers=None)

Bases: ask_sdk_model.directive.Directive

The HandleMessage directive sends a message to a skill's web application that runs on the device browser. To use this directive, [apply to participate](https://build.amazonalexadev.com/AlexaWebAPIforGamesDeveloperPreview_AlexaWebAPIforGames.html) in the Alexa Web API for Games developer preview.

Parameters:

• message ((optional) object) – A free-form object containing data to deliver to a skill's HTML application running the device. Maximum size 18 KB.
• transformers ((optional) list[ask_sdk_model.interfaces.alexa.presentation.html.transformer.Transformer]) – An array of objects for performing text-to-speech transformations with message data

attribute_map = {'message': 'message', 'object_type': 'type', 'transformers': 'transformers'}

deserialized_types = {'message': 'object', 'object_type': 'str', 'transformers': 'list[ask_sdk_model.interfaces.alexa.presentation.html.transformer.Transformer]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.html.message_request module

class ask_sdk_model.interfaces.alexa.presentation.html.message_request.MessageRequest(request_id=None, timestamp=None, locale=None, message=None)

Bases: ask_sdk_model.request.Request

The Message request sends a message to the skill lambda. To use this request, [apply to participate](https://build.amazonalexadev.com/AlexaWebAPIforGamesDeveloperPreview_AlexaWebAPIforGames.html) in the Alexa Web API for Games developer preview.

Parameters:

• request_id ((optional) str) – Represents the unique identifier for the specific request.
• timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
• locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
• message ((optional) object) – A free-form object containing data from a skill's HTML application to deliver to the Alexa cloud. Maximum size 18 KB.

attribute_map = {'locale': 'locale', 'message': 'message', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp'}

deserialized_types = {'locale': 'str', 'message': 'object', 'object_type': 'str', 'request_id': 'str', 'timestamp': 'datetime'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.html.runtime module

class ask_sdk_model.interfaces.alexa.presentation.html.runtime.Runtime(max_version=None)

Bases: object

Contains the runtime information for the interface.

Parameters:max_version ((optional) str) – The max version of the HTML runtime supported by the device.

attribute_map = {'max_version': 'maxVersion'}

deserialized_types = {'max_version': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.html.start_directive module

class ask_sdk_model.interfaces.alexa.presentation.html.start_directive.StartDirective(data=None, transformers=None, request=None, configuration=None)

Bases: ask_sdk_model.directive.Directive

The Start directive provides the data necessary to load an HTML page on the target device. To use this directive, [apply to participate](https://build.amazonalexadev.com/AlexaWebAPIforGamesDeveloperPreview_AlexaWebAPIforGames.html) in the Alexa Web API for Games developer preview.

Parameters:

• data ((optional) object) – Optional startup data which will be made available to the runtime for skill startup. Maximum size: 18 KB
• transformers ((optional) list[ask_sdk_model.interfaces.alexa.presentation.html.transformer.Transformer]) – An array of objects for performing text-to-speech transformations with message data
• request ((optional) ask_sdk_model.interfaces.alexa.presentation.html.start_request.StartRequest) –
• configuration ((optional) ask_sdk_model.interfaces.alexa.presentation.html.configuration.Configuration) –

attribute_map = {'configuration': 'configuration', 'data': 'data', 'object_type': 'type', 'request': 'request', 'transformers': 'transformers'}

deserialized_types = {'configuration': 'ask_sdk_model.interfaces.alexa.presentation.html.configuration.Configuration', 'data': 'object', 'object_type': 'str', 'request': 'ask_sdk_model.interfaces.alexa.presentation.html.start_request.StartRequest', 'transformers': 'list[ask_sdk_model.interfaces.alexa.presentation.html.transformer.Transformer]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.html.start_request module

class ask_sdk_model.interfaces.alexa.presentation.html.start_request.StartRequest(method=None, uri=None, headers=None)

Bases: object

Parameters:

• method ((optional) ask_sdk_model.interfaces.alexa.presentation.html.start_request_method.StartRequestMethod) –
• uri ((optional) str) – HTTPS URI of the HTML page to load. This URI must abide by the [URI RFC 3986](https://tools.ietf.org/html/rfc3986). The HTML runtime must perform secure requests, using the HTTPS schema. Maximum size 8000 characters
• headers ((optional) object) – HTTP headers that the HTML runtime requires to access resources. Only the Authorization header and custom headers are allowed

attribute_map = {'headers': 'headers', 'method': 'method', 'uri': 'uri'}

deserialized_types = {'headers': 'object', 'method': 'ask_sdk_model.interfaces.alexa.presentation.html.start_request_method.StartRequestMethod', 'uri': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.html.start_request_method module

class ask_sdk_model.interfaces.alexa.presentation.html.start_request_method.StartRequestMethod

Bases: enum.Enum

Allowed enum values: [GET]

GET = 'GET'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.html.transformer module

class ask_sdk_model.interfaces.alexa.presentation.html.transformer.Transformer(transformer=None, input_path=None, output_name=None)

Bases: object

Properties for performing text to speech transformations. These are the same properties that [APL transformers](https://developer.amazon.com/docs/alexa-presentation-language/apl-data-source.html#transformer-properties-and-conversion-rules) use.

Parameters:

• transformer ((optional) ask_sdk_model.interfaces.alexa.presentation.html.transformer_type.TransformerType) –
• input_path ((optional) str) – A JSON path that points to either a single entity in the message object, or a set of entities using wildcard or unresolved arrays. Examples 'family[*].name', 'address.street'. See [APL transformer properties](https://developer.amazon.com/docs/alexa-presentation-language/apl-data-source.html#transformer-properties-and-conversion-rules) for more details.
• output_name ((optional) str) – Name of the output property to add to the message object. For example, if the inputPath is &quot;address.street&quot;, the transformer output will be stored at &quot;address.outputName&quot;. If no outputName is supplied, the transformer output will override the value at inputPath.

attribute_map = {'input_path': 'inputPath', 'output_name': 'outputName', 'transformer': 'transformer'}

deserialized_types = {'input_path': 'str', 'output_name': 'str', 'transformer': 'ask_sdk_model.interfaces.alexa.presentation.html.transformer_type.TransformerType'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.html.transformer_type module

class ask_sdk_model.interfaces.alexa.presentation.html.transformer_type.TransformerType

Bases: enum.Enum

Allowed enum values: [ssmlToSpeech, textToSpeech, textToHint, ssmlToText]

ssmlToSpeech = 'ssmlToSpeech'

ssmlToText = 'ssmlToText'

textToHint = 'textToHint'

textToSpeech = 'textToSpeech'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay package

Subpackages

ask_sdk_model.interfaces.amazonpay.model package

Subpackages

ask_sdk_model.interfaces.amazonpay.model.request 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_sdk_model.interfaces.amazonpay.model.request.authorize_attributes module

class ask_sdk_model.interfaces.amazonpay.model.request.authorize_attributes.AuthorizeAttributes(authorization_reference_id=None, authorization_amount=None, transaction_timeout=None, seller_authorization_note=None, soft_descriptor=None, version=None)

Bases: ask_sdk_model.interfaces.amazonpay.model.request.base_amazon_pay_entity.BaseAmazonPayEntity

This is an object to set the attributes specified in the AuthorizeAttributes table. See the “AuthorizationDetails” section of the Amazon Pay API reference guide for details about this object.

Parameters:

• authorization_reference_id ((optional) str) – This is 3P seller's identifier for this authorization transaction. This identifier must be unique for all of your authorization transactions.
• authorization_amount ((optional) ask_sdk_model.interfaces.amazonpay.model.request.price.Price) –
• transaction_timeout ((optional) int) – The maximum number of minutes allocated for the Authorize operation call to be processed. After this the authorization is automatically declined and you cannot capture funds against the authorization. The default value for Alexa transactions is 0. In order to speed up checkout time for voice users we recommend to not change this value.
• seller_authorization_note ((optional) str) – A description for the transaction that is included in emails to the user. Appears only when AuthorizeAndCapture is chosen.
• soft_descriptor ((optional) str) – The description to be shown on the user's payment instrument statement if AuthorizeAndCapture is chosen. Format of soft descriptor sent to the payment processor is &quot;AMZ* &lt;soft descriptor specified here&gt;&quot;. Default is &quot;AMZ*&lt;SELLER_NAME&gt; amzn.com/ pmts WA&quot;. Maximum length can be 16 characters.
• version ((optional) str) – Version of the Amazon Pay Entity. Can be 1 or greater.

attribute_map = {'authorization_amount': 'authorizationAmount', 'authorization_reference_id': 'authorizationReferenceId', 'object_type': '@type', 'seller_authorization_note': 'sellerAuthorizationNote', 'soft_descriptor': 'softDescriptor', 'transaction_timeout': 'transactionTimeout', 'version': '@version'}

deserialized_types = {'authorization_amount': 'ask_sdk_model.interfaces.amazonpay.model.request.price.Price', 'authorization_reference_id': 'str', 'object_type': 'str', 'seller_authorization_note': 'str', 'soft_descriptor': 'str', 'transaction_timeout': 'int', 'version': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.request.base_amazon_pay_entity module

class ask_sdk_model.interfaces.amazonpay.model.request.base_amazon_pay_entity.BaseAmazonPayEntity(object_type=None, version=None)

Bases: object

Parameters:

• object_type ((optional) str) –
• version ((optional) str) – Version of the Amazon Pay Entity. Can be 1 or greater.

Note

This is an abstract class. Use the following mapping, to figure out the model class to be instantiated, that sets @type variable.

SellerBillingAgreementAttributes: ask_sdk_model.interfaces.amazonpay.model.request.seller_billing_agreement_attributes.SellerBillingAgreementAttributes,

Price: ask_sdk_model.interfaces.amazonpay.model.request.price.Price,

ChargeAmazonPayRequest: ask_sdk_model.interfaces.amazonpay.request.charge_amazon_pay_request.ChargeAmazonPayRequest,

BillingAgreementAttributes: ask_sdk_model.interfaces.amazonpay.model.request.billing_agreement_attributes.BillingAgreementAttributes,

SellerOrderAttributes: ask_sdk_model.interfaces.amazonpay.model.request.seller_order_attributes.SellerOrderAttributes,

ProviderAttributes: ask_sdk_model.interfaces.amazonpay.model.request.provider_attributes.ProviderAttributes,

AuthorizeAttributes: ask_sdk_model.interfaces.amazonpay.model.request.authorize_attributes.AuthorizeAttributes,

SetupAmazonPayRequest: ask_sdk_model.interfaces.amazonpay.request.setup_amazon_pay_request.SetupAmazonPayRequest,

ProviderCredit: ask_sdk_model.interfaces.amazonpay.model.request.provider_credit.ProviderCredit

attribute_map = {'object_type': '@type', 'version': '@version'}

deserialized_types = {'object_type': 'str', 'version': 'str'}

discriminator_value_class_map = {'AuthorizeAttributes': 'ask_sdk_model.interfaces.amazonpay.model.request.authorize_attributes.AuthorizeAttributes', 'BillingAgreementAttributes': 'ask_sdk_model.interfaces.amazonpay.model.request.billing_agreement_attributes.BillingAgreementAttributes', 'ChargeAmazonPayRequest': 'ask_sdk_model.interfaces.amazonpay.request.charge_amazon_pay_request.ChargeAmazonPayRequest', 'Price': 'ask_sdk_model.interfaces.amazonpay.model.request.price.Price', 'ProviderAttributes': 'ask_sdk_model.interfaces.amazonpay.model.request.provider_attributes.ProviderAttributes', 'ProviderCredit': 'ask_sdk_model.interfaces.amazonpay.model.request.provider_credit.ProviderCredit', 'SellerBillingAgreementAttributes': 'ask_sdk_model.interfaces.amazonpay.model.request.seller_billing_agreement_attributes.SellerBillingAgreementAttributes', 'SellerOrderAttributes': 'ask_sdk_model.interfaces.amazonpay.model.request.seller_order_attributes.SellerOrderAttributes', 'SetupAmazonPayRequest': 'ask_sdk_model.interfaces.amazonpay.request.setup_amazon_pay_request.SetupAmazonPayRequest'}

classmethod get_real_child_model(data)

Returns the real base class specified by the discriminator

json_discriminator_key = '@type'

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.request.billing_agreement_attributes module

class ask_sdk_model.interfaces.amazonpay.model.request.billing_agreement_attributes.BillingAgreementAttributes(platform_id=None, seller_note=None, seller_billing_agreement_attributes=None, billing_agreement_type=None, subscription_amount=None, version=None)

Bases: ask_sdk_model.interfaces.amazonpay.model.request.base_amazon_pay_entity.BaseAmazonPayEntity

The merchant can choose to set the attributes specified in the BillingAgreementAttributes.

Parameters:

• platform_id ((optional) str) – Represents the SellerId of the Solution Provider that developed the eCommerce platform. This value is only used by Solution Providers, for whom it is required. It should not be provided by merchants creating their own custom integration. Do not specify the SellerId of the merchant for this request parameter. If you are a merchant, do not enter a PlatformId.
• seller_note ((optional) str) – Represents a description of the billing agreement that is displayed in emails to the buyer.
• seller_billing_agreement_attributes ((optional) ask_sdk_model.interfaces.amazonpay.model.request.seller_billing_agreement_attributes.SellerBillingAgreementAttributes) –
• billing_agreement_type ((optional) ask_sdk_model.interfaces.amazonpay.model.request.billing_agreement_type.BillingAgreementType) –
• subscription_amount ((optional) ask_sdk_model.interfaces.amazonpay.model.request.price.Price) –
• version ((optional) str) – Version of the Amazon Pay Entity. Can be 1 or greater.

attribute_map = {'billing_agreement_type': 'billingAgreementType', 'object_type': '@type', 'platform_id': 'platformId', 'seller_billing_agreement_attributes': 'sellerBillingAgreementAttributes', 'seller_note': 'sellerNote', 'subscription_amount': 'subscriptionAmount', 'version': '@version'}

deserialized_types = {'billing_agreement_type': 'ask_sdk_model.interfaces.amazonpay.model.request.billing_agreement_type.BillingAgreementType', 'object_type': 'str', 'platform_id': 'str', 'seller_billing_agreement_attributes': 'ask_sdk_model.interfaces.amazonpay.model.request.seller_billing_agreement_attributes.SellerBillingAgreementAttributes', 'seller_note': 'str', 'subscription_amount': 'ask_sdk_model.interfaces.amazonpay.model.request.price.Price', 'version': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.request.billing_agreement_type module

class ask_sdk_model.interfaces.amazonpay.model.request.billing_agreement_type.BillingAgreementType

Bases: enum.Enum

• This is used to specify applicable billing agreement type. * CustomerInitiatedTransaction – customer is present at the time of processing payment for the order. * MerchantInitiatedTransaction – customer is not present at the time of processing payment for the order.

Allowed enum values: [CustomerInitiatedTransaction, MerchantInitiatedTransaction]

CustomerInitiatedTransaction = 'CustomerInitiatedTransaction'

MerchantInitiatedTransaction = 'MerchantInitiatedTransaction'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.request.payment_action module

class ask_sdk_model.interfaces.amazonpay.model.request.payment_action.PaymentAction

Bases: enum.Enum

• This is used to specify applicable payment action. * Authorize – you want to confirm the order and authorize a certain amount, but you do not want to capture at this time. * AuthorizeAndCapture – you want to confirm the order, authorize for the given amount, and capture the funds.

Allowed enum values: [Authorize, AuthorizeAndCapture]

Authorize = 'Authorize'

AuthorizeAndCapture = 'AuthorizeAndCapture'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.request.price module

class ask_sdk_model.interfaces.amazonpay.model.request.price.Price(amount=None, currency_code=None, version=None)

Bases: ask_sdk_model.interfaces.amazonpay.model.request.base_amazon_pay_entity.BaseAmazonPayEntity

This request object specifies amount and currency authorized/captured.

Parameters:

• amount ((optional) str) – Amount authorized/captured.
• currency_code ((optional) str) – Currency code for the amount.
• version ((optional) str) – Version of the Amazon Pay Entity. Can be 1 or greater.

attribute_map = {'amount': 'amount', 'currency_code': 'currencyCode', 'object_type': '@type', 'version': '@version'}

deserialized_types = {'amount': 'str', 'currency_code': 'str', 'object_type': 'str', 'version': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.request.provider_attributes module

class ask_sdk_model.interfaces.amazonpay.model.request.provider_attributes.ProviderAttributes(provider_id=None, provider_credit_list=None, version=None)

Bases: ask_sdk_model.interfaces.amazonpay.model.request.base_amazon_pay_entity.BaseAmazonPayEntity

This is required only for Ecommerce provider (Solution provider) use cases.

Parameters:

• provider_id ((optional) str) – Solution provider ID.
• provider_credit_list ((optional) list[ask_sdk_model.interfaces.amazonpay.model.request.provider_credit.ProviderCredit]) – List of provider credit.
• version ((optional) str) – Version of the Amazon Pay Entity. Can be 1 or greater.

attribute_map = {'object_type': '@type', 'provider_credit_list': 'providerCreditList', 'provider_id': 'providerId', 'version': '@version'}

deserialized_types = {'object_type': 'str', 'provider_credit_list': 'list[ask_sdk_model.interfaces.amazonpay.model.request.provider_credit.ProviderCredit]', 'provider_id': 'str', 'version': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.request.provider_credit module

class ask_sdk_model.interfaces.amazonpay.model.request.provider_credit.ProviderCredit(provider_id=None, credit=None, version=None)

Bases: ask_sdk_model.interfaces.amazonpay.model.request.base_amazon_pay_entity.BaseAmazonPayEntity

Parameters:

• provider_id ((optional) str) – This is required only for Ecommerce provider (Solution provider) use cases.
• credit ((optional) ask_sdk_model.interfaces.amazonpay.model.request.price.Price) –
• version ((optional) str) – Version of the Amazon Pay Entity. Can be 1 or greater.

attribute_map = {'credit': 'credit', 'object_type': '@type', 'provider_id': 'providerId', 'version': '@version'}

deserialized_types = {'credit': 'ask_sdk_model.interfaces.amazonpay.model.request.price.Price', 'object_type': 'str', 'provider_id': 'str', 'version': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.request.seller_billing_agreement_attributes module

class ask_sdk_model.interfaces.amazonpay.model.request.seller_billing_agreement_attributes.SellerBillingAgreementAttributes(seller_billing_agreement_id=None, store_name=None, custom_information=None, version=None)

Bases: ask_sdk_model.interfaces.amazonpay.model.request.base_amazon_pay_entity.BaseAmazonPayEntity

Provides more context about the billing agreement that is represented by this Billing Agreement object.

Parameters:

• seller_billing_agreement_id ((optional) str) – The merchant-specified identifier of this billing agreement. At least one request parameter must be specified. Amazon recommends that you use only the following characters:- lowercase a-z, uppercase A-Z, numbers 0-9, dash (-), underscore (_).
• store_name ((optional) str) – The identifier of the store from which the order was placed. This overrides the default value in Seller Central under Settings &gt; Account Settings. It is displayed to the buyer in their emails and transaction history on the Amazon Payments website.
• custom_information ((optional) str) – Any additional information that you wish to include with this billing agreement. At least one request parameter must be specified.
• version ((optional) str) – Version of the Amazon Pay Entity. Can be 1 or greater.

attribute_map = {'custom_information': 'customInformation', 'object_type': '@type', 'seller_billing_agreement_id': 'sellerBillingAgreementId', 'store_name': 'storeName', 'version': '@version'}

deserialized_types = {'custom_information': 'str', 'object_type': 'str', 'seller_billing_agreement_id': 'str', 'store_name': 'str', 'version': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.request.seller_order_attributes module

class ask_sdk_model.interfaces.amazonpay.model.request.seller_order_attributes.SellerOrderAttributes(seller_order_id=None, store_name=None, custom_information=None, seller_note=None, version=None)

Bases: ask_sdk_model.interfaces.amazonpay.model.request.base_amazon_pay_entity.BaseAmazonPayEntity

This object includes elements shown to buyers in emails and in their transaction history. See the “SellerOrderAttributes” section of the Amazon Pay API reference guide for details about this object.

Parameters:

• seller_order_id ((optional) str) – The merchant-specified identifier of this order. This is shown to the buyer in their emails and transaction history on the Amazon Pay website.
• store_name ((optional) str) – The identifier of the store from which the order was placed. This overrides the default value in Seller Central under Settings &gt; Account Settings. It is displayed to the buyer in their emails and transaction history on the Amazon Payments website.
• custom_information ((optional) str) – Any additional information that you want to include with this order reference.
• seller_note ((optional) str) – This represents a description of the order that is displayed in emails to the buyer.
• version ((optional) str) – Version of the Amazon Pay Entity. Can be 1 or greater.

attribute_map = {'custom_information': 'customInformation', 'object_type': '@type', 'seller_note': 'sellerNote', 'seller_order_id': 'sellerOrderId', 'store_name': 'storeName', 'version': '@version'}

deserialized_types = {'custom_information': 'str', 'object_type': 'str', 'seller_note': 'str', 'seller_order_id': 'str', 'store_name': 'str', 'version': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.response 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_sdk_model.interfaces.amazonpay.model.response.authorization_details module

class ask_sdk_model.interfaces.amazonpay.model.response.authorization_details.AuthorizationDetails(amazon_authorization_id=None, authorization_reference_id=None, seller_authorization_note=None, authorization_amount=None, captured_amount=None, authorization_fee=None, id_list=None, creation_timestamp=None, expiration_timestamp=None, authorization_status=None, soft_decline=None, capture_now=None, soft_descriptor=None, authorization_billing_address=None)

Bases: ask_sdk_model.interfaces.amazonpay.model.v1.authorization_details.AuthorizationDetails

This object encapsulates details about an Authorization object including the status, amount captured and fee charged.

Parameters:

• amazon_authorization_id ((optional) str) – This is AmazonPay generated identifier for this authorization transaction.
• authorization_reference_id ((optional) str) – This is 3P seller's identifier for this authorization transaction. This identifier must be unique for all of your authorization transactions.
• seller_authorization_note ((optional) str) – A description for the transaction that is included in emails to the user. Appears only when AuthorizeAndCapture is chosen.
• authorization_amount ((optional) ask_sdk_model.interfaces.amazonpay.model.response.price.Price) –
• captured_amount ((optional) ask_sdk_model.interfaces.amazonpay.model.response.price.Price) –
• authorization_fee ((optional) ask_sdk_model.interfaces.amazonpay.model.response.price.Price) –
• id_list ((optional) list[str]) – list of AmazonCaptureId identifiers that have been requested on this Authorization object.
• creation_timestamp ((optional) datetime) – This is the time at which the authorization was created.
• expiration_timestamp ((optional) datetime) – This is the time at which the authorization expires.
• authorization_status ((optional) ask_sdk_model.interfaces.amazonpay.model.response.authorization_status.AuthorizationStatus) –
• soft_decline ((optional) bool) – This indicates whether an authorization resulted in a soft decline.
• capture_now ((optional) bool) – This indicates whether a direct capture against the payment contract was specified.
• soft_descriptor ((optional) str) – This is the description to be shown on the buyer's payment instrument statement if AuthorizeAndCapture was chosen.
• authorization_billing_address ((optional) ask_sdk_model.interfaces.amazonpay.model.response.destination.Destination) –

attribute_map = {'amazon_authorization_id': 'amazonAuthorizationId', 'authorization_amount': 'authorizationAmount', 'authorization_billing_address': 'authorizationBillingAddress', 'authorization_fee': 'authorizationFee', 'authorization_reference_id': 'authorizationReferenceId', 'authorization_status': 'authorizationStatus', 'capture_now': 'captureNow', 'captured_amount': 'capturedAmount', 'creation_timestamp': 'creationTimestamp', 'expiration_timestamp': 'expirationTimestamp', 'id_list': 'idList', 'seller_authorization_note': 'sellerAuthorizationNote', 'soft_decline': 'softDecline', 'soft_descriptor': 'softDescriptor'}

deserialized_types = {'amazon_authorization_id': 'str', 'authorization_amount': 'ask_sdk_model.interfaces.amazonpay.model.response.price.Price', 'authorization_billing_address': 'ask_sdk_model.interfaces.amazonpay.model.response.destination.Destination', 'authorization_fee': 'ask_sdk_model.interfaces.amazonpay.model.response.price.Price', 'authorization_reference_id': 'str', 'authorization_status': 'ask_sdk_model.interfaces.amazonpay.model.response.authorization_status.AuthorizationStatus', 'capture_now': 'bool', 'captured_amount': 'ask_sdk_model.interfaces.amazonpay.model.response.price.Price', 'creation_timestamp': 'datetime', 'expiration_timestamp': 'datetime', 'id_list': 'list[str]', 'seller_authorization_note': 'str', 'soft_decline': 'bool', 'soft_descriptor': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.response.authorization_status module

class ask_sdk_model.interfaces.amazonpay.model.response.authorization_status.AuthorizationStatus(state=None, reason_code=None, reason_description=None, last_update_timestamp=None)

Bases: ask_sdk_model.interfaces.amazonpay.model.v1.authorization_status.AuthorizationStatus

Indicates the current status of an Authorization object, a Capture object, or a Refund object.

Parameters:

• state ((optional) ask_sdk_model.interfaces.amazonpay.model.response.state.State) –
• reason_code ((optional) str) – The reason that the Authorization object, Capture object, or Refund object is in the current state. For more information, see - https://pay.amazon.com/us/developer/documentation/apireference/201752950
• reason_description ((optional) str) – Reason desciption corresponding to the reason code
• last_update_timestamp ((optional) datetime) – A timestamp that indicates the time when the authorization, capture, or refund state was last updated. In ISO 8601 format

attribute_map = {'last_update_timestamp': 'lastUpdateTimestamp', 'reason_code': 'reasonCode', 'reason_description': 'reasonDescription', 'state': 'state'}

deserialized_types = {'last_update_timestamp': 'datetime', 'reason_code': 'str', 'reason_description': 'str', 'state': 'ask_sdk_model.interfaces.amazonpay.model.response.state.State'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.response.billing_agreement_details module

class ask_sdk_model.interfaces.amazonpay.model.response.billing_agreement_details.BillingAgreementDetails(billing_agreement_id=None, creation_timestamp=None, destination=None, checkout_language=None, release_environment=None, billing_agreement_status=None, billing_address=None)

Bases: ask_sdk_model.interfaces.amazonpay.model.v1.billing_agreement_details.BillingAgreementDetails

The result attributes from successful SetupAmazonPay call.

Parameters:

• billing_agreement_id ((optional) str) – Billing agreement id which can be used for one time and recurring purchases
• creation_timestamp ((optional) datetime) – Time at which billing agreement details created.
• destination ((optional) ask_sdk_model.interfaces.amazonpay.model.v1.destination.Destination) – The default shipping address of the buyer. Returned if needAmazonShippingAddress is set to true.
• checkout_language ((optional) str) – Merchant's preferred language of checkout.
• release_environment ((optional) ask_sdk_model.interfaces.amazonpay.model.response.release_environment.ReleaseEnvironment) –
• billing_agreement_status ((optional) ask_sdk_model.interfaces.amazonpay.model.v1.billing_agreement_status.BillingAgreementStatus) –
• billing_address ((optional) ask_sdk_model.interfaces.amazonpay.model.response.destination.Destination) – The Billing Address of the payment instrument associated with Billing Agreement.

attribute_map = {'billing_address': 'billingAddress', 'billing_agreement_id': 'billingAgreementId', 'billing_agreement_status': 'billingAgreementStatus', 'checkout_language': 'checkoutLanguage', 'creation_timestamp': 'creationTimestamp', 'destination': 'destination', 'release_environment': 'releaseEnvironment'}

deserialized_types = {'billing_address': 'ask_sdk_model.interfaces.amazonpay.model.response.destination.Destination', 'billing_agreement_id': 'str', 'billing_agreement_status': 'ask_sdk_model.interfaces.amazonpay.model.v1.billing_agreement_status.BillingAgreementStatus', 'checkout_language': 'str', 'creation_timestamp': 'datetime', 'destination': 'ask_sdk_model.interfaces.amazonpay.model.v1.destination.Destination', 'release_environment': 'ask_sdk_model.interfaces.amazonpay.model.response.release_environment.ReleaseEnvironment'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.response.destination module

class ask_sdk_model.interfaces.amazonpay.model.response.destination.Destination(name=None, company_name=None, address_line1=None, address_line2=None, address_line3=None, city=None, district_or_county=None, state_or_region=None, postal_code=None, country_code=None, phone=None)

Bases: ask_sdk_model.interfaces.amazonpay.model.v1.destination.Destination

Parameters:

• name ((optional) str) – The name or business name
• company_name ((optional) str) – The company name
• address_line1 ((optional) str) – The first line of the address. At least one AddressLine (AddressLine1, AddressLine2, or AddressLine3) is required.
• address_line2 ((optional) str) – The second line of the address. At least one AddressLine (AddressLine1, AddressLine2, or AddressLine3) is required.
• address_line3 ((optional) str) – The third line of the address. At least one AddressLine (AddressLine1, AddressLine2, or AddressLine3) is required.
• city ((optional) str) – The city
• district_or_county ((optional) str) – The district or County
• state_or_region ((optional) str) – The state or region. This element is free text and can be either a 2-character code, fully spelled out, or abbreviated. Required. Note :- This response element is returned only in the U.S.
• postal_code ((optional) str) – The postal code.
• country_code ((optional) str) – The country code, in ISO 3166 format
• phone ((optional) str) – The phone number

attribute_map = {'address_line1': 'addressLine1', 'address_line2': 'addressLine2', 'address_line3': 'addressLine3', 'city': 'city', 'company_name': 'companyName', 'country_code': 'countryCode', 'district_or_county': 'districtOrCounty', 'name': 'name', 'phone': 'phone', 'postal_code': 'postalCode', 'state_or_region': 'stateOrRegion'}

deserialized_types = {'address_line1': 'str', 'address_line2': 'str', 'address_line3': 'str', 'city': 'str', 'company_name': 'str', 'country_code': 'str', 'district_or_county': 'str', 'name': 'str', 'phone': 'str', 'postal_code': 'str', 'state_or_region': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.response.price module

class ask_sdk_model.interfaces.amazonpay.model.response.price.Price(amount=None, currency_code=None)

Bases: ask_sdk_model.interfaces.amazonpay.model.v1.price.Price

This response object specifies amount and currency authorized/captured.

Parameters:

• amount ((optional) str) – Amount authorized/captured.
• currency_code ((optional) str) – Currency code for the amount.

attribute_map = {'amount': 'amount', 'currency_code': 'currencyCode'}

deserialized_types = {'amount': 'str', 'currency_code': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.response.release_environment module

class ask_sdk_model.interfaces.amazonpay.model.response.release_environment.ReleaseEnvironment

Bases: enum.Enum

Indicates if the contract is for a Live (Production) or Sandbox environment.

Allowed enum values: [LIVE, SANDBOX]

LIVE = 'LIVE'

SANDBOX = 'SANDBOX'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.response.state module

class ask_sdk_model.interfaces.amazonpay.model.response.state.State

Bases: enum.Enum

Indicates the state that the Authorization object is in. For more information see “Authorization states and reason codes” under “States and reason codes” section in Amazon Pay API Reference Guide.

Allowed enum values: [Pending, Open, Declined, Closed]

Closed = 'Closed'

Declined = 'Declined'

Open = 'Open'

Pending = 'Pending'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.v1 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_sdk_model.interfaces.amazonpay.model.v1.authorization_details module

class ask_sdk_model.interfaces.amazonpay.model.v1.authorization_details.AuthorizationDetails(amazon_authorization_id=None, authorization_reference_id=None, seller_authorization_note=None, authorization_amount=None, captured_amount=None, authorization_fee=None, id_list=None, creation_timestamp=None, expiration_timestamp=None, authorization_status=None, soft_decline=None, capture_now=None, soft_descriptor=None)

Bases: object

This object encapsulates details about an Authorization object including the status, amount captured and fee charged.

Parameters:

• amazon_authorization_id ((optional) str) – This is AmazonPay generated identifier for this authorization transaction.
• authorization_reference_id ((optional) str) – This is 3P seller's identifier for this authorization transaction. This identifier must be unique for all of your authorization transactions.
• seller_authorization_note ((optional) str) – A description for the transaction that is included in emails to the user. Appears only when AuthorizeAndCapture is chosen.
• authorization_amount ((optional) ask_sdk_model.interfaces.amazonpay.model.v1.price.Price) –
• captured_amount ((optional) ask_sdk_model.interfaces.amazonpay.model.v1.price.Price) –
• authorization_fee ((optional) ask_sdk_model.interfaces.amazonpay.model.v1.price.Price) –
• id_list ((optional) list[str]) – list of AmazonCaptureId identifiers that have been requested on this Authorization object.
• creation_timestamp ((optional) datetime) – This is the time at which the authorization was created.
• expiration_timestamp ((optional) datetime) – This is the time at which the authorization expires.
• authorization_status ((optional) ask_sdk_model.interfaces.amazonpay.model.v1.authorization_status.AuthorizationStatus) –
• soft_decline ((optional) bool) – This indicates whether an authorization resulted in a soft decline.
• capture_now ((optional) bool) – This indicates whether a direct capture against the payment contract was specified.
• soft_descriptor ((optional) str) – This is the description to be shown on the buyer's payment instrument statement if AuthorizeAndCapture was chosen.

attribute_map = {'amazon_authorization_id': 'amazonAuthorizationId', 'authorization_amount': 'authorizationAmount', 'authorization_fee': 'authorizationFee', 'authorization_reference_id': 'authorizationReferenceId', 'authorization_status': 'authorizationStatus', 'capture_now': 'captureNow', 'captured_amount': 'capturedAmount', 'creation_timestamp': 'creationTimestamp', 'expiration_timestamp': 'expirationTimestamp', 'id_list': 'idList', 'seller_authorization_note': 'sellerAuthorizationNote', 'soft_decline': 'softDecline', 'soft_descriptor': 'softDescriptor'}

deserialized_types = {'amazon_authorization_id': 'str', 'authorization_amount': 'ask_sdk_model.interfaces.amazonpay.model.v1.price.Price', 'authorization_fee': 'ask_sdk_model.interfaces.amazonpay.model.v1.price.Price', 'authorization_reference_id': 'str', 'authorization_status': 'ask_sdk_model.interfaces.amazonpay.model.v1.authorization_status.AuthorizationStatus', 'capture_now': 'bool', 'captured_amount': 'ask_sdk_model.interfaces.amazonpay.model.v1.price.Price', 'creation_timestamp': 'datetime', 'expiration_timestamp': 'datetime', 'id_list': 'list[str]', 'seller_authorization_note': 'str', 'soft_decline': 'bool', 'soft_descriptor': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.v1.authorization_status module

class ask_sdk_model.interfaces.amazonpay.model.v1.authorization_status.AuthorizationStatus(state=None, reason_code=None, reason_description=None, last_update_timestamp=None)

Bases: object

Indicates the current status of an Authorization object, a Capture object, or a Refund object.

Parameters:

• state ((optional) ask_sdk_model.interfaces.amazonpay.model.v1.state.State) –
• reason_code ((optional) str) – The reason that the Authorization object, Capture object, or Refund object is in the current state. For more information, see - https://pay.amazon.com/us/developer/documentation/apireference/201752950
• reason_description ((optional) str) – Reason desciption corresponding to the reason code
• last_update_timestamp ((optional) datetime) – A timestamp that indicates the time when the authorization, capture, or refund state was last updated. In ISO 8601 format

attribute_map = {'last_update_timestamp': 'lastUpdateTimestamp', 'reason_code': 'reasonCode', 'reason_description': 'reasonDescription', 'state': 'state'}

deserialized_types = {'last_update_timestamp': 'datetime', 'reason_code': 'str', 'reason_description': 'str', 'state': 'ask_sdk_model.interfaces.amazonpay.model.v1.state.State'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.v1.authorize_attributes module

class ask_sdk_model.interfaces.amazonpay.model.v1.authorize_attributes.AuthorizeAttributes(authorization_reference_id=None, authorization_amount=None, transaction_timeout=None, seller_authorization_note=None, soft_descriptor=None)

Bases: object

This is an object to set the attributes specified in the AuthorizeAttributes table. See the “AuthorizationDetails” section of the Amazon Pay API reference guide for details about this object.

Parameters:

• authorization_reference_id ((optional) str) – This is 3P seller's identifier for this authorization transaction. This identifier must be unique for all of your authorization transactions.
• authorization_amount ((optional) ask_sdk_model.interfaces.amazonpay.model.v1.price.Price) –
• transaction_timeout ((optional) int) – The maximum number of minutes allocated for the Authorize operation call to be processed. After this the authorization is automatically declined and you cannot capture funds against the authorization. The default value for Alexa transactions is 0. In order to speed up checkout time for voice users we recommend to not change this value.
• seller_authorization_note ((optional) str) – A description for the transaction that is included in emails to the user. Appears only when AuthorizeAndCapture is chosen.
• soft_descriptor ((optional) str) – The description to be shown on the user's payment instrument statement if AuthorizeAndCapture is chosen. Format of soft descriptor sent to the payment processor is &quot;AMZ* &lt;soft descriptor specified here&gt;&quot;. Default is &quot;AMZ*&lt;SELLER_NAME&gt; amzn.com/ pmts WA&quot;. Maximum length can be 16 characters.

attribute_map = {'authorization_amount': 'authorizationAmount', 'authorization_reference_id': 'authorizationReferenceId', 'seller_authorization_note': 'sellerAuthorizationNote', 'soft_descriptor': 'softDescriptor', 'transaction_timeout': 'transactionTimeout'}

deserialized_types = {'authorization_amount': 'ask_sdk_model.interfaces.amazonpay.model.v1.price.Price', 'authorization_reference_id': 'str', 'seller_authorization_note': 'str', 'soft_descriptor': 'str', 'transaction_timeout': 'int'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.v1.billing_agreement_attributes module

class ask_sdk_model.interfaces.amazonpay.model.v1.billing_agreement_attributes.BillingAgreementAttributes(platform_id=None, seller_note=None, seller_billing_agreement_attributes=None, billing_agreement_type=None, subscription_amount=None)

Bases: object

The merchant can choose to set the attributes specified in the BillingAgreementAttributes.

Parameters:

• platform_id ((optional) str) – Represents the SellerId of the Solution Provider that developed the eCommerce platform. This value is only used by Solution Providers, for whom it is required. It should not be provided by merchants creating their own custom integration. Do not specify the SellerId of the merchant for this request parameter. If you are a merchant, do not enter a PlatformId.
• seller_note ((optional) str) – Represents a description of the billing agreement that is displayed in emails to the buyer.
• seller_billing_agreement_attributes ((optional) ask_sdk_model.interfaces.amazonpay.model.v1.seller_billing_agreement_attributes.SellerBillingAgreementAttributes) –
• billing_agreement_type ((optional) ask_sdk_model.interfaces.amazonpay.model.v1.billing_agreement_type.BillingAgreementType) –
• subscription_amount ((optional) ask_sdk_model.interfaces.amazonpay.model.v1.price.Price) –

attribute_map = {'billing_agreement_type': 'billingAgreementType', 'platform_id': 'platformId', 'seller_billing_agreement_attributes': 'sellerBillingAgreementAttributes', 'seller_note': 'sellerNote', 'subscription_amount': 'subscriptionAmount'}

deserialized_types = {'billing_agreement_type': 'ask_sdk_model.interfaces.amazonpay.model.v1.billing_agreement_type.BillingAgreementType', 'platform_id': 'str', 'seller_billing_agreement_attributes': 'ask_sdk_model.interfaces.amazonpay.model.v1.seller_billing_agreement_attributes.SellerBillingAgreementAttributes', 'seller_note': 'str', 'subscription_amount': 'ask_sdk_model.interfaces.amazonpay.model.v1.price.Price'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.v1.billing_agreement_details module

class ask_sdk_model.interfaces.amazonpay.model.v1.billing_agreement_details.BillingAgreementDetails(billing_agreement_id=None, creation_timestamp=None, destination=None, checkout_language=None, release_environment=None, billing_agreement_status=None)

Bases: object

The result attributes from successful SetupAmazonPay call.

Parameters:

• billing_agreement_id ((optional) str) – Billing agreement id which can be used for one time and recurring purchases
• creation_timestamp ((optional) datetime) – Time at which billing agreement details created.
• destination ((optional) ask_sdk_model.interfaces.amazonpay.model.v1.destination.Destination) – The default shipping address of the buyer. Returned if needAmazonShippingAddress is set to true.
• checkout_language ((optional) str) – Merchant's preferred language of checkout.
• release_environment ((optional) ask_sdk_model.interfaces.amazonpay.model.v1.release_environment.ReleaseEnvironment) –
• billing_agreement_status ((optional) ask_sdk_model.interfaces.amazonpay.model.v1.billing_agreement_status.BillingAgreementStatus) –

attribute_map = {'billing_agreement_id': 'billingAgreementId', 'billing_agreement_status': 'billingAgreementStatus', 'checkout_language': 'checkoutLanguage', 'creation_timestamp': 'creationTimestamp', 'destination': 'destination', 'release_environment': 'releaseEnvironment'}

deserialized_types = {'billing_agreement_id': 'str', 'billing_agreement_status': 'ask_sdk_model.interfaces.amazonpay.model.v1.billing_agreement_status.BillingAgreementStatus', 'checkout_language': 'str', 'creation_timestamp': 'datetime', 'destination': 'ask_sdk_model.interfaces.amazonpay.model.v1.destination.Destination', 'release_environment': 'ask_sdk_model.interfaces.amazonpay.model.v1.release_environment.ReleaseEnvironment'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.v1.billing_agreement_status module

class ask_sdk_model.interfaces.amazonpay.model.v1.billing_agreement_status.BillingAgreementStatus

Bases: enum.Enum

Indicates the current status of the billing agreement. For more information about the State and ReasonCode response elements, see Billing agreement states and reason codes - https://pay.amazon.com/us/developer/documentation/apireference/201752870

Allowed enum values: [CANCELED, CLOSED, DRAFT, OPEN, SUSPENDED]

CANCELED = 'CANCELED'

CLOSED = 'CLOSED'

DRAFT = 'DRAFT'

OPEN = 'OPEN'

SUSPENDED = 'SUSPENDED'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.v1.billing_agreement_type module

class ask_sdk_model.interfaces.amazonpay.model.v1.billing_agreement_type.BillingAgreementType

Bases: enum.Enum

• This is used to specify applicable billing agreement type. * CustomerInitiatedTransaction – customer is present at the time of processing payment for the order. * MerchantInitiatedTransaction – customer is not present at the time of processing payment for the order.

Allowed enum values: [CustomerInitiatedTransaction, MerchantInitiatedTransaction]

CustomerInitiatedTransaction = 'CustomerInitiatedTransaction'

MerchantInitiatedTransaction = 'MerchantInitiatedTransaction'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.v1.destination module

class ask_sdk_model.interfaces.amazonpay.model.v1.destination.Destination(name=None, company_name=None, address_line1=None, address_line2=None, address_line3=None, city=None, district_or_county=None, state_or_region=None, postal_code=None, country_code=None, phone=None)

Bases: object

Destination object containing the details of an Address.

Parameters:

• name ((optional) str) – The name or business name
• company_name ((optional) str) – The company name
• address_line1 ((optional) str) – The first line of the address. At least one AddressLine (AddressLine1, AddressLine2, or AddressLine3) is required.
• address_line2 ((optional) str) – The second line of the address. At least one AddressLine (AddressLine1, AddressLine2, or AddressLine3) is required.
• address_line3 ((optional) str) – The third line of the address. At least one AddressLine (AddressLine1, AddressLine2, or AddressLine3) is required.
• city ((optional) str) – The city
• district_or_county ((optional) str) – The district or County
• state_or_region ((optional) str) – The state or region. This element is free text and can be either a 2-character code, fully spelled out, or abbreviated. Required. Note :- This response element is returned only in the U.S.
• postal_code ((optional) str) – The postal code.
• country_code ((optional) str) – The country code, in ISO 3166 format
• phone ((optional) str) – The phone number

attribute_map = {'address_line1': 'addressLine1', 'address_line2': 'addressLine2', 'address_line3': 'addressLine3', 'city': 'city', 'company_name': 'companyName', 'country_code': 'countryCode', 'district_or_county': 'districtOrCounty', 'name': 'name', 'phone': 'phone', 'postal_code': 'postalCode', 'state_or_region': 'stateOrRegion'}

deserialized_types = {'address_line1': 'str', 'address_line2': 'str', 'address_line3': 'str', 'city': 'str', 'company_name': 'str', 'country_code': 'str', 'district_or_county': 'str', 'name': 'str', 'phone': 'str', 'postal_code': 'str', 'state_or_region': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.v1.payment_action module

class ask_sdk_model.interfaces.amazonpay.model.v1.payment_action.PaymentAction

Bases: enum.Enum

• This is used to specify applicable payment action. * Authorize – you want to confirm the order and authorize a certain amount, but you do not want to capture at this time. * AuthorizeAndCapture – you want to confirm the order, authorize for the given amount, and capture the funds.

Allowed enum values: [Authorize, AuthorizeAndCapture]

Authorize = 'Authorize'

AuthorizeAndCapture = 'AuthorizeAndCapture'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.v1.price module

class ask_sdk_model.interfaces.amazonpay.model.v1.price.Price(amount=None, currency_code=None)

Bases: object

This object specifies amount and currency authorized/captured.

Parameters:

• amount ((optional) str) – Amount authorized/captured.
• currency_code ((optional) str) – Currency code for the amount.

attribute_map = {'amount': 'amount', 'currency_code': 'currencyCode'}

deserialized_types = {'amount': 'str', 'currency_code': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.v1.provider_attributes module

class ask_sdk_model.interfaces.amazonpay.model.v1.provider_attributes.ProviderAttributes(provider_id=None, provider_credit_list=None)

Bases: object

This is required only for Ecommerce provider (Solution provider) use cases.

Parameters:

• provider_id ((optional) str) – Solution provider ID.
• provider_credit_list ((optional) list[ask_sdk_model.interfaces.amazonpay.model.v1.provider_credit.ProviderCredit]) – List of provider credit.

attribute_map = {'provider_credit_list': 'providerCreditList', 'provider_id': 'providerId'}

deserialized_types = {'provider_credit_list': 'list[ask_sdk_model.interfaces.amazonpay.model.v1.provider_credit.ProviderCredit]', 'provider_id': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.v1.provider_credit module

class ask_sdk_model.interfaces.amazonpay.model.v1.provider_credit.ProviderCredit(provider_id=None, credit=None)

Bases: object

Parameters:

• provider_id ((optional) str) – This is required only for Ecommerce provider (Solution provider) use cases.
• credit ((optional) ask_sdk_model.interfaces.amazonpay.model.v1.price.Price) –

attribute_map = {'credit': 'credit', 'provider_id': 'providerId'}

deserialized_types = {'credit': 'ask_sdk_model.interfaces.amazonpay.model.v1.price.Price', 'provider_id': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.v1.release_environment module

class ask_sdk_model.interfaces.amazonpay.model.v1.release_environment.ReleaseEnvironment

Bases: enum.Enum

Indicates if the order is for a Live (Production) or Sandbox environment.

Allowed enum values: [LIVE, SANDBOX]

LIVE = 'LIVE'

SANDBOX = 'SANDBOX'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.v1.seller_billing_agreement_attributes module

class ask_sdk_model.interfaces.amazonpay.model.v1.seller_billing_agreement_attributes.SellerBillingAgreementAttributes(seller_billing_agreement_id=None, store_name=None, custom_information=None)

Bases: object

Provides more context about the billing agreement that is represented by this Billing Agreement object.

Parameters:

• seller_billing_agreement_id ((optional) str) – The merchant-specified identifier of this billing agreement. At least one request parameter must be specified. Amazon recommends that you use only the following characters:- lowercase a-z, uppercase A-Z, numbers 0-9, dash (-), underscore (_).
• store_name ((optional) str) – The identifier of the store from which the order was placed. This overrides the default value in Seller Central under Settings &gt; Account Settings. It is displayed to the buyer in their emails and transaction history on the Amazon Payments website.
• custom_information ((optional) str) – Any additional information that you wish to include with this billing agreement. At least one request parameter must be specified.

attribute_map = {'custom_information': 'customInformation', 'seller_billing_agreement_id': 'sellerBillingAgreementId', 'store_name': 'storeName'}

deserialized_types = {'custom_information': 'str', 'seller_billing_agreement_id': 'str', 'store_name': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.v1.seller_order_attributes module

class ask_sdk_model.interfaces.amazonpay.model.v1.seller_order_attributes.SellerOrderAttributes(seller_order_id=None, store_name=None, custom_information=None, seller_note=None)

Bases: object

This object includes elements shown to buyers in emails and in their transaction history. See the “SellerOrderAttributes” section of the Amazon Pay API reference guide for details about this object.

Parameters:

• seller_order_id ((optional) str) – The merchant-specified identifier of this order. This is shown to the buyer in their emails and transaction history on the Amazon Pay website.
• store_name ((optional) str) – The identifier of the store from which the order was placed. This overrides the default value in Seller Central under Settings &gt; Account Settings. It is displayed to the buyer in their emails and transaction history on the Amazon Payments website.
• custom_information ((optional) str) – Any additional information that you want to include with this order reference.
• seller_note ((optional) str) – This represents a description of the order that is displayed in emails to the buyer.

attribute_map = {'custom_information': 'customInformation', 'seller_note': 'sellerNote', 'seller_order_id': 'sellerOrderId', 'store_name': 'storeName'}

deserialized_types = {'custom_information': 'str', 'seller_note': 'str', 'seller_order_id': 'str', 'store_name': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.v1.state module

class ask_sdk_model.interfaces.amazonpay.model.v1.state.State

Bases: enum.Enum

Indicates the state that the Authorization object, Capture object, or Refund object is in. For more information see - https://pay.amazon.com/us/developer/documentation/apireference/201752950

Allowed enum values: [Pending, Open, Declined, Closed, Completed]

Closed = 'Closed'

Completed = 'Completed'

Declined = 'Declined'

Open = 'Open'

Pending = 'Pending'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.request 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_sdk_model.interfaces.amazonpay.request.charge_amazon_pay_request module

class ask_sdk_model.interfaces.amazonpay.request.charge_amazon_pay_request.ChargeAmazonPayRequest(version=None, seller_id=None, billing_agreement_id=None, payment_action=None, authorize_attributes=None, seller_order_attributes=None, provider_attributes=None)

Bases: ask_sdk_model.interfaces.amazonpay.model.request.base_amazon_pay_entity.BaseAmazonPayEntity

Charge Amazon Pay Request Object.

Parameters:

• version ((optional) str) – Version of the Amazon Pay Entity. Can be 1 or greater.
• seller_id ((optional) str) – The seller ID (also known as merchant ID). If you are an Ecommerce Provider (Solution Provider), please specify the ID of the merchant, not your provider ID.
• billing_agreement_id ((optional) str) – The payment contract i.e. billing agreement created for the user.
• payment_action ((optional) ask_sdk_model.interfaces.amazonpay.model.request.payment_action.PaymentAction) –
• authorize_attributes ((optional) ask_sdk_model.interfaces.amazonpay.model.request.authorize_attributes.AuthorizeAttributes) –
• seller_order_attributes ((optional) ask_sdk_model.interfaces.amazonpay.model.request.seller_order_attributes.SellerOrderAttributes) –
• provider_attributes ((optional) ask_sdk_model.interfaces.amazonpay.model.request.provider_attributes.ProviderAttributes) –

attribute_map = {'authorize_attributes': 'authorizeAttributes', 'billing_agreement_id': 'billingAgreementId', 'object_type': '@type', 'payment_action': 'paymentAction', 'provider_attributes': 'providerAttributes', 'seller_id': 'sellerId', 'seller_order_attributes': 'sellerOrderAttributes', 'version': '@version'}

deserialized_types = {'authorize_attributes': 'ask_sdk_model.interfaces.amazonpay.model.request.authorize_attributes.AuthorizeAttributes', 'billing_agreement_id': 'str', 'object_type': 'str', 'payment_action': 'ask_sdk_model.interfaces.amazonpay.model.request.payment_action.PaymentAction', 'provider_attributes': 'ask_sdk_model.interfaces.amazonpay.model.request.provider_attributes.ProviderAttributes', 'seller_id': 'str', 'seller_order_attributes': 'ask_sdk_model.interfaces.amazonpay.model.request.seller_order_attributes.SellerOrderAttributes', 'version': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.request.setup_amazon_pay_request module

class ask_sdk_model.interfaces.amazonpay.request.setup_amazon_pay_request.SetupAmazonPayRequest(version=None, seller_id=None, country_of_establishment=None, ledger_currency=None, checkout_language=None, billing_agreement_attributes=None, need_amazon_shipping_address=False, sandbox_mode=False, sandbox_customer_email_id=None)

Bases: ask_sdk_model.interfaces.amazonpay.model.request.base_amazon_pay_entity.BaseAmazonPayEntity

Setup Amazon Pay Request Object.

Parameters:

• version ((optional) str) – Version of the Amazon Pay Entity. Can be 1 or greater.
• seller_id ((optional) str) – The seller ID (also known as merchant ID). If you are an Ecommerce Provider (Solution Provider), please specify the ID of the merchant, not your provider ID.
• country_of_establishment ((optional) str) – The country in which the merchant has registered, as an Amazon Payments legal entity.
• ledger_currency ((optional) str) – The currency of the merchant’s ledger account.
• checkout_language ((optional) str) – The merchant's preferred language for checkout.
• billing_agreement_attributes ((optional) ask_sdk_model.interfaces.amazonpay.model.request.billing_agreement_attributes.BillingAgreementAttributes) –
• need_amazon_shipping_address (bool) – To receive the default user shipping address in the response, set this parameter to true. Not required if a user shipping address is not required.
• sandbox_mode (bool) – To test in Sandbox mode, set this parameter to true.
• sandbox_customer_email_id ((optional) str) – Use this parameter to create a Sandbox payment object. In order to use this parameter, you first create a Sandbox user account in Seller Central. Then, pass the email address associated with that Sandbox user account.

attribute_map = {'billing_agreement_attributes': 'billingAgreementAttributes', 'checkout_language': 'checkoutLanguage', 'country_of_establishment': 'countryOfEstablishment', 'ledger_currency': 'ledgerCurrency', 'need_amazon_shipping_address': 'needAmazonShippingAddress', 'object_type': '@type', 'sandbox_customer_email_id': 'sandboxCustomerEmailId', 'sandbox_mode': 'sandboxMode', 'seller_id': 'sellerId', 'version': '@version'}

deserialized_types = {'billing_agreement_attributes': 'ask_sdk_model.interfaces.amazonpay.model.request.billing_agreement_attributes.BillingAgreementAttributes', 'checkout_language': 'str', 'country_of_establishment': 'str', 'ledger_currency': 'str', 'need_amazon_shipping_address': 'bool', 'object_type': 'str', 'sandbox_customer_email_id': 'str', 'sandbox_mode': 'bool', 'seller_id': 'str', 'version': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.response 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_sdk_model.interfaces.amazonpay.response.amazon_pay_error_response module

class ask_sdk_model.interfaces.amazonpay.response.amazon_pay_error_response.AmazonPayErrorResponse(error_code=None, error_message=None)

Bases: ask_sdk_model.interfaces.amazonpay.v1.amazon_pay_error_response.AmazonPayErrorResponse

Error response for SetupAmazonPay and ChargeAmazonPay calls.

Parameters:

• error_code ((optional) str) – Error code indicating the succinct cause of error
• error_message ((optional) str) – Description of the error.

attribute_map = {'error_code': 'errorCode', 'error_message': 'errorMessage'}

deserialized_types = {'error_code': 'str', 'error_message': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.response.charge_amazon_pay_result module

class ask_sdk_model.interfaces.amazonpay.response.charge_amazon_pay_result.ChargeAmazonPayResult(amazon_order_reference_id=None, authorization_details=None)

Bases: ask_sdk_model.interfaces.amazonpay.v1.charge_amazon_pay_result.ChargeAmazonPayResult

Charge Amazon Pay Result Object. It is sent as part of the response to ChargeAmazonPayRequest.

Parameters:

• amazon_order_reference_id ((optional) str) – The order reference identifier.
• authorization_details ((optional) ask_sdk_model.interfaces.amazonpay.model.response.authorization_details.AuthorizationDetails) –

attribute_map = {'amazon_order_reference_id': 'amazonOrderReferenceId', 'authorization_details': 'authorizationDetails'}

deserialized_types = {'amazon_order_reference_id': 'str', 'authorization_details': 'ask_sdk_model.interfaces.amazonpay.model.response.authorization_details.AuthorizationDetails'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.response.setup_amazon_pay_result module

class ask_sdk_model.interfaces.amazonpay.response.setup_amazon_pay_result.SetupAmazonPayResult(billing_agreement_details=None)

Bases: object

Setup Amazon Pay Result Object. It is sent as part of the response to SetupAmazonPayRequest.

Parameters:billing_agreement_details ((optional) ask_sdk_model.interfaces.amazonpay.model.response.billing_agreement_details.BillingAgreementDetails) –

attribute_map = {'billing_agreement_details': 'billingAgreementDetails'}

deserialized_types = {'billing_agreement_details': 'ask_sdk_model.interfaces.amazonpay.model.response.billing_agreement_details.BillingAgreementDetails'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.v1 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_sdk_model.interfaces.amazonpay.v1.amazon_pay_error_response module

class ask_sdk_model.interfaces.amazonpay.v1.amazon_pay_error_response.AmazonPayErrorResponse(error_code=None, error_message=None)

Bases: object

Error response for SetupAmazonPay and ChargeAmazonPay calls.

Parameters:

• error_code ((optional) str) – Error code indicating the succinct cause of error
• error_message ((optional) str) – Description of the error.

attribute_map = {'error_code': 'errorCode', 'error_message': 'errorMessage'}

deserialized_types = {'error_code': 'str', 'error_message': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.v1.charge_amazon_pay module

class ask_sdk_model.interfaces.amazonpay.v1.charge_amazon_pay.ChargeAmazonPay(consent_token=None, seller_id=None, billing_agreement_id=None, payment_action=None, authorize_attributes=None, seller_order_attributes=None, provider_attributes=None)

Bases: object

Charge Amazon Pay Request Object

Parameters:

• consent_token ((optional) str) – Authorization token that contains the permissions consented to by the user.
• seller_id ((optional) str) – The seller ID (also known as merchant ID). If you are an Ecommerce Provider (Solution Provider), please specify the ID of the merchant, not your provider ID.
• billing_agreement_id ((optional) str) – The payment contract i.e. billing agreement created for the user.
• payment_action ((optional) ask_sdk_model.interfaces.amazonpay.model.v1.payment_action.PaymentAction) –
• authorize_attributes ((optional) ask_sdk_model.interfaces.amazonpay.model.v1.authorize_attributes.AuthorizeAttributes) –
• seller_order_attributes ((optional) ask_sdk_model.interfaces.amazonpay.model.v1.seller_order_attributes.SellerOrderAttributes) –
• provider_attributes ((optional) ask_sdk_model.interfaces.amazonpay.model.v1.provider_attributes.ProviderAttributes) –

attribute_map = {'authorize_attributes': 'authorizeAttributes', 'billing_agreement_id': 'billingAgreementId', 'consent_token': 'consentToken', 'payment_action': 'paymentAction', 'provider_attributes': 'providerAttributes', 'seller_id': 'sellerId', 'seller_order_attributes': 'sellerOrderAttributes'}

deserialized_types = {'authorize_attributes': 'ask_sdk_model.interfaces.amazonpay.model.v1.authorize_attributes.AuthorizeAttributes', 'billing_agreement_id': 'str', 'consent_token': 'str', 'payment_action': 'ask_sdk_model.interfaces.amazonpay.model.v1.payment_action.PaymentAction', 'provider_attributes': 'ask_sdk_model.interfaces.amazonpay.model.v1.provider_attributes.ProviderAttributes', 'seller_id': 'str', 'seller_order_attributes': 'ask_sdk_model.interfaces.amazonpay.model.v1.seller_order_attributes.SellerOrderAttributes'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.v1.charge_amazon_pay_result module

class ask_sdk_model.interfaces.amazonpay.v1.charge_amazon_pay_result.ChargeAmazonPayResult(amazon_order_reference_id=None, authorization_details=None)

Bases: object

Charge Amazon Pay Result Object. It is sent as part of the reponse to ChargeAmazonPay request.

Parameters:

• amazon_order_reference_id ((optional) str) – The order reference identifier.
• authorization_details ((optional) ask_sdk_model.interfaces.amazonpay.model.v1.authorization_details.AuthorizationDetails) –

attribute_map = {'amazon_order_reference_id': 'amazonOrderReferenceId', 'authorization_details': 'authorizationDetails'}

deserialized_types = {'amazon_order_reference_id': 'str', 'authorization_details': 'ask_sdk_model.interfaces.amazonpay.model.v1.authorization_details.AuthorizationDetails'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.v1.setup_amazon_pay module

class ask_sdk_model.interfaces.amazonpay.v1.setup_amazon_pay.SetupAmazonPay(consent_token=None, seller_id=None, country_of_establishment=None, ledger_currency=None, checkout_language=None, billing_agreement_attributes=None, need_amazon_shipping_address=False, sandbox_mode=False, sandbox_customer_email_id=None)

Bases: object

Setup Amazon Pay Request Object

Parameters:

• consent_token ((optional) str) – Authorization token that contains the permissions consented to by the user.
• seller_id ((optional) str) – The seller ID (also known as merchant ID). If you are an Ecommerce Provider (Solution Provider), please specify the ID of the merchant, not your provider ID.
• country_of_establishment ((optional) str) – The country in which the merchant has registered, as an Amazon Payments legal entity.
• ledger_currency ((optional) str) – The currency of the merchant’s ledger account.
• checkout_language ((optional) str) – The merchant's preferred language for checkout.
• billing_agreement_attributes ((optional) ask_sdk_model.interfaces.amazonpay.model.v1.billing_agreement_attributes.BillingAgreementAttributes) –
• need_amazon_shipping_address (bool) – To receive the default user shipping address in the response, set this parameter to true. Not required if a user shipping address is not required.
• sandbox_mode (bool) – To test in Sandbox mode, set this parameter to true.
• sandbox_customer_email_id ((optional) str) – Use this parameter to create a Sandbox payment object. In order to use this parameter, you first create a Sandbox user account in Seller Central. Then, pass the email address associated with that Sandbox user account.

attribute_map = {'billing_agreement_attributes': 'billingAgreementAttributes', 'checkout_language': 'checkoutLanguage', 'consent_token': 'consentToken', 'country_of_establishment': 'countryOfEstablishment', 'ledger_currency': 'ledgerCurrency', 'need_amazon_shipping_address': 'needAmazonShippingAddress', 'sandbox_customer_email_id': 'sandboxCustomerEmailId', 'sandbox_mode': 'sandboxMode', 'seller_id': 'sellerId'}

deserialized_types = {'billing_agreement_attributes': 'ask_sdk_model.interfaces.amazonpay.model.v1.billing_agreement_attributes.BillingAgreementAttributes', 'checkout_language': 'str', 'consent_token': 'str', 'country_of_establishment': 'str', 'ledger_currency': 'str', 'need_amazon_shipping_address': 'bool', 'sandbox_customer_email_id': 'str', 'sandbox_mode': 'bool', 'seller_id': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.v1.setup_amazon_pay_result module

class ask_sdk_model.interfaces.amazonpay.v1.setup_amazon_pay_result.SetupAmazonPayResult(billing_agreement_details=None)

Bases: object

Setup Amazon Pay Result Object. It is sent as part of the reponse to SetupAmazonPay request.

Parameters:billing_agreement_details ((optional) ask_sdk_model.interfaces.amazonpay.model.v1.billing_agreement_details.BillingAgreementDetails) –

attribute_map = {'billing_agreement_details': 'billingAgreementDetails'}

deserialized_types = {'billing_agreement_details': 'ask_sdk_model.interfaces.amazonpay.model.v1.billing_agreement_details.BillingAgreementDetails'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.audioplayer 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_sdk_model.interfaces.audioplayer.audio_item module

class ask_sdk_model.interfaces.audioplayer.audio_item.AudioItem(stream=None, metadata=None)

Bases: object

Parameters:

• stream ((optional) ask_sdk_model.interfaces.audioplayer.stream.Stream) –
• metadata ((optional) ask_sdk_model.interfaces.audioplayer.audio_item_metadata.AudioItemMetadata) –

attribute_map = {'metadata': 'metadata', 'stream': 'stream'}

deserialized_types = {'metadata': 'ask_sdk_model.interfaces.audioplayer.audio_item_metadata.AudioItemMetadata', 'stream': 'ask_sdk_model.interfaces.audioplayer.stream.Stream'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.audioplayer.audio_item_metadata module

class ask_sdk_model.interfaces.audioplayer.audio_item_metadata.AudioItemMetadata(title=None, subtitle=None, art=None, background_image=None)

Bases: object

Encapsulates the metadata about an AudioItem.

Parameters:

• title ((optional) str) – An optional title of the audio item.
• subtitle ((optional) str) – An optional subtitle of the audio item.
• art ((optional) ask_sdk_model.interfaces.display.image.Image) – An optional cover art image for the audio item.
• background_image ((optional) ask_sdk_model.interfaces.display.image.Image) – An optional background image for the audio item.

attribute_map = {'art': 'art', 'background_image': 'backgroundImage', 'subtitle': 'subtitle', 'title': 'title'}

deserialized_types = {'art': 'ask_sdk_model.interfaces.display.image.Image', 'background_image': 'ask_sdk_model.interfaces.display.image.Image', 'subtitle': 'str', 'title': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.audioplayer.audio_player_interface module

class ask_sdk_model.interfaces.audioplayer.audio_player_interface.AudioPlayerInterface

Bases: object

attribute_map = {}

deserialized_types = {}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.audioplayer.audio_player_state module

class ask_sdk_model.interfaces.audioplayer.audio_player_state.AudioPlayerState(offset_in_milliseconds=None, token=None, player_activity=None)

Bases: object

Parameters:

• offset_in_milliseconds ((optional) int) –
• token ((optional) str) –
• player_activity ((optional) ask_sdk_model.interfaces.audioplayer.player_activity.PlayerActivity) –

attribute_map = {'offset_in_milliseconds': 'offsetInMilliseconds', 'player_activity': 'playerActivity', 'token': 'token'}

deserialized_types = {'offset_in_milliseconds': 'int', 'player_activity': 'ask_sdk_model.interfaces.audioplayer.player_activity.PlayerActivity', 'token': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.audioplayer.caption_data module

class ask_sdk_model.interfaces.audioplayer.caption_data.CaptionData(content=None, object_type=None)

Bases: object

Parameters:

• content ((optional) str) – This contains the caption text.
• object_type ((optional) ask_sdk_model.interfaces.audioplayer.caption_type.CaptionType) – Type of the caption source.

attribute_map = {'content': 'content', 'object_type': 'type'}

deserialized_types = {'content': 'str', 'object_type': 'ask_sdk_model.interfaces.audioplayer.caption_type.CaptionType'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.audioplayer.caption_type module

class ask_sdk_model.interfaces.audioplayer.caption_type.CaptionType

Bases: enum.Enum

Allowed enum values: [WEBVTT]

WEBVTT = 'WEBVTT'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.audioplayer.clear_behavior module

class ask_sdk_model.interfaces.audioplayer.clear_behavior.ClearBehavior

Bases: enum.Enum

Allowed enum values: [CLEAR_ALL, CLEAR_ENQUEUED]

CLEAR_ALL = 'CLEAR_ALL'

CLEAR_ENQUEUED = 'CLEAR_ENQUEUED'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.audioplayer.clear_queue_directive module

class ask_sdk_model.interfaces.audioplayer.clear_queue_directive.ClearQueueDirective(clear_behavior=None)

Bases: ask_sdk_model.directive.Directive

Parameters:clear_behavior ((optional) ask_sdk_model.interfaces.audioplayer.clear_behavior.ClearBehavior) –

attribute_map = {'clear_behavior': 'clearBehavior', 'object_type': 'type'}

deserialized_types = {'clear_behavior': 'ask_sdk_model.interfaces.audioplayer.clear_behavior.ClearBehavior', 'object_type': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.audioplayer.current_playback_state module

class ask_sdk_model.interfaces.audioplayer.current_playback_state.CurrentPlaybackState(offset_in_milliseconds=None, player_activity=None, token=None)

Bases: object

Parameters:

• offset_in_milliseconds ((optional) int) –
• player_activity ((optional) ask_sdk_model.interfaces.audioplayer.player_activity.PlayerActivity) –
• token ((optional) str) –

attribute_map = {'offset_in_milliseconds': 'offsetInMilliseconds', 'player_activity': 'playerActivity', 'token': 'token'}

deserialized_types = {'offset_in_milliseconds': 'int', 'player_activity': 'ask_sdk_model.interfaces.audioplayer.player_activity.PlayerActivity', 'token': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.audioplayer.error module

class ask_sdk_model.interfaces.audioplayer.error.Error(message=None, object_type=None)

Bases: object

Parameters:

• message ((optional) str) –
• object_type ((optional) ask_sdk_model.interfaces.audioplayer.error_type.ErrorType) –

attribute_map = {'message': 'message', 'object_type': 'type'}

deserialized_types = {'message': 'str', 'object_type': 'ask_sdk_model.interfaces.audioplayer.error_type.ErrorType'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.audioplayer.error_type module

class ask_sdk_model.interfaces.audioplayer.error_type.ErrorType

Bases: enum.Enum

Allowed enum values: [MEDIA_ERROR_INTERNAL_DEVICE_ERROR, MEDIA_ERROR_INTERNAL_SERVER_ERROR, MEDIA_ERROR_INVALID_REQUEST, MEDIA_ERROR_SERVICE_UNAVAILABLE, MEDIA_ERROR_UNKNOWN]

MEDIA_ERROR_INTERNAL_DEVICE_ERROR = 'MEDIA_ERROR_INTERNAL_DEVICE_ERROR'

MEDIA_ERROR_INTERNAL_SERVER_ERROR = 'MEDIA_ERROR_INTERNAL_SERVER_ERROR'

MEDIA_ERROR_INVALID_REQUEST = 'MEDIA_ERROR_INVALID_REQUEST'

MEDIA_ERROR_SERVICE_UNAVAILABLE = 'MEDIA_ERROR_SERVICE_UNAVAILABLE'

MEDIA_ERROR_UNKNOWN = 'MEDIA_ERROR_UNKNOWN'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.audioplayer.play_behavior module

class ask_sdk_model.interfaces.audioplayer.play_behavior.PlayBehavior

Bases: enum.Enum

Allowed enum values: [ENQUEUE, REPLACE_ALL, REPLACE_ENQUEUED]

ENQUEUE = 'ENQUEUE'

REPLACE_ALL = 'REPLACE_ALL'

REPLACE_ENQUEUED = 'REPLACE_ENQUEUED'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.audioplayer.play_directive module

class ask_sdk_model.interfaces.audioplayer.play_directive.PlayDirective(play_behavior=None, audio_item=None)

Bases: ask_sdk_model.directive.Directive

Parameters:

• play_behavior ((optional) ask_sdk_model.interfaces.audioplayer.play_behavior.PlayBehavior) –
• audio_item ((optional) ask_sdk_model.interfaces.audioplayer.audio_item.AudioItem) –

attribute_map = {'audio_item': 'audioItem', 'object_type': 'type', 'play_behavior': 'playBehavior'}

deserialized_types = {'audio_item': 'ask_sdk_model.interfaces.audioplayer.audio_item.AudioItem', 'object_type': 'str', 'play_behavior': 'ask_sdk_model.interfaces.audioplayer.play_behavior.PlayBehavior'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.audioplayer.playback_failed_request module

class ask_sdk_model.interfaces.audioplayer.playback_failed_request.PlaybackFailedRequest(request_id=None, timestamp=None, locale=None, current_playback_state=None, error=None, token=None)

Bases: ask_sdk_model.request.Request

Parameters:

• request_id ((optional) str) – Represents the unique identifier for the specific request.
• timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
• locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
• current_playback_state ((optional) ask_sdk_model.interfaces.audioplayer.current_playback_state.CurrentPlaybackState) –
• error ((optional) ask_sdk_model.interfaces.audioplayer.error.Error) –
• token ((optional) str) –

attribute_map = {'current_playback_state': 'currentPlaybackState', 'error': 'error', 'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp', 'token': 'token'}

deserialized_types = {'current_playback_state': 'ask_sdk_model.interfaces.audioplayer.current_playback_state.CurrentPlaybackState', 'error': 'ask_sdk_model.interfaces.audioplayer.error.Error', 'locale': 'str', 'object_type': 'str', 'request_id': 'str', 'timestamp': 'datetime', 'token': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.audioplayer.playback_finished_request module

class ask_sdk_model.interfaces.audioplayer.playback_finished_request.PlaybackFinishedRequest(request_id=None, timestamp=None, locale=None, offset_in_milliseconds=None, token=None)

Bases: ask_sdk_model.request.Request

Parameters:

• request_id ((optional) str) – Represents the unique identifier for the specific request.
• timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
• locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
• offset_in_milliseconds ((optional) int) –
• token ((optional) str) –

attribute_map = {'locale': 'locale', 'object_type': 'type', 'offset_in_milliseconds': 'offsetInMilliseconds', 'request_id': 'requestId', 'timestamp': 'timestamp', 'token': 'token'}

deserialized_types = {'locale': 'str', 'object_type': 'str', 'offset_in_milliseconds': 'int', 'request_id': 'str', 'timestamp': 'datetime', 'token': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.audioplayer.playback_nearly_finished_request module

class ask_sdk_model.interfaces.audioplayer.playback_nearly_finished_request.PlaybackNearlyFinishedRequest(request_id=None, timestamp=None, locale=None, offset_in_milliseconds=None, token=None)

Bases: ask_sdk_model.request.Request

Parameters:

• request_id ((optional) str) – Represents the unique identifier for the specific request.
• timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
• locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
• offset_in_milliseconds ((optional) int) –
• token ((optional) str) –

attribute_map = {'locale': 'locale', 'object_type': 'type', 'offset_in_milliseconds': 'offsetInMilliseconds', 'request_id': 'requestId', 'timestamp': 'timestamp', 'token': 'token'}

deserialized_types = {'locale': 'str', 'object_type': 'str', 'offset_in_milliseconds': 'int', 'request_id': 'str', 'timestamp': 'datetime', 'token': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.audioplayer.playback_started_request module

class ask_sdk_model.interfaces.audioplayer.playback_started_request.PlaybackStartedRequest(request_id=None, timestamp=None, locale=None, offset_in_milliseconds=None, token=None)

Bases: ask_sdk_model.request.Request

Parameters:

• request_id ((optional) str) – Represents the unique identifier for the specific request.
• timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
• locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
• offset_in_milliseconds ((optional) int) –
• token ((optional) str) –

attribute_map = {'locale': 'locale', 'object_type': 'type', 'offset_in_milliseconds': 'offsetInMilliseconds', 'request_id': 'requestId', 'timestamp': 'timestamp', 'token': 'token'}

deserialized_types = {'locale': 'str', 'object_type': 'str', 'offset_in_milliseconds': 'int', 'request_id': 'str', 'timestamp': 'datetime', 'token': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.audioplayer.playback_stopped_request module

class ask_sdk_model.interfaces.audioplayer.playback_stopped_request.PlaybackStoppedRequest(request_id=None, timestamp=None, locale=None, offset_in_milliseconds=None, token=None)

Bases: ask_sdk_model.request.Request

Parameters:

• request_id ((optional) str) – Represents the unique identifier for the specific request.
• timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
• locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
• offset_in_milliseconds ((optional) int) –
• token ((optional) str) –

attribute_map = {'locale': 'locale', 'object_type': 'type', 'offset_in_milliseconds': 'offsetInMilliseconds', 'request_id': 'requestId', 'timestamp': 'timestamp', 'token': 'token'}

deserialized_types = {'locale': 'str', 'object_type': 'str', 'offset_in_milliseconds': 'int', 'request_id': 'str', 'timestamp': 'datetime', 'token': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.audioplayer.player_activity module

class ask_sdk_model.interfaces.audioplayer.player_activity.PlayerActivity

Bases: enum.Enum

Allowed enum values: [PLAYING, PAUSED, FINISHED, BUFFER_UNDERRUN, IDLE, STOPPED]

BUFFER_UNDERRUN = 'BUFFER_UNDERRUN'

FINISHED = 'FINISHED'

IDLE = 'IDLE'

PAUSED = 'PAUSED'

PLAYING = 'PLAYING'

STOPPED = 'STOPPED'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.audioplayer.stop_directive module

class ask_sdk_model.interfaces.audioplayer.stop_directive.StopDirective

Bases: ask_sdk_model.directive.Directive

attribute_map = {'object_type': 'type'}

deserialized_types = {'object_type': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.audioplayer.stream module

class ask_sdk_model.interfaces.audioplayer.stream.Stream(expected_previous_token=None, token=None, url=None, offset_in_milliseconds=None, caption_data=None)

Bases: object

Parameters:

• expected_previous_token ((optional) str) –
• token ((optional) str) –
• url ((optional) str) –
• offset_in_milliseconds ((optional) int) –
• caption_data ((optional) ask_sdk_model.interfaces.audioplayer.caption_data.CaptionData) –

attribute_map = {'caption_data': 'captionData', 'expected_previous_token': 'expectedPreviousToken', 'offset_in_milliseconds': 'offsetInMilliseconds', 'token': 'token', 'url': 'url'}

deserialized_types = {'caption_data': 'ask_sdk_model.interfaces.audioplayer.caption_data.CaptionData', 'expected_previous_token': 'str', 'offset_in_milliseconds': 'int', 'token': 'str', 'url': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.automotive 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_sdk_model.interfaces.automotive.automotive_state module

class ask_sdk_model.interfaces.automotive.automotive_state.AutomotiveState

Bases: object

This object contains the automotive specific information of the device

attribute_map = {}

deserialized_types = {}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.connections package

Subpackages

ask_sdk_model.interfaces.connections.entities 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_sdk_model.interfaces.connections.entities.base_entity module

class ask_sdk_model.interfaces.connections.entities.base_entity.BaseEntity(object_type=None, version=None)

Bases: object

Parameters:

• object_type ((optional) str) –
• version ((optional) str) – version of the request

Note

This is an abstract class. Use the following mapping, to figure out the model class to be instantiated, that sets @type variable.

PostalAddress: ask_sdk_model.interfaces.connections.entities.postal_address.PostalAddress,

Restaurant: ask_sdk_model.interfaces.connections.entities.restaurant.Restaurant

attribute_map = {'object_type': '@type', 'version': '@version'}

deserialized_types = {'object_type': 'str', 'version': 'str'}

discriminator_value_class_map = {'PostalAddress': 'ask_sdk_model.interfaces.connections.entities.postal_address.PostalAddress', 'Restaurant': 'ask_sdk_model.interfaces.connections.entities.restaurant.Restaurant'}

classmethod get_real_child_model(data)

Returns the real base class specified by the discriminator

json_discriminator_key = '@type'

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.connections.entities.postal_address module

class ask_sdk_model.interfaces.connections.entities.postal_address.PostalAddress(version=None, street_address=None, locality=None, region=None, postal_code=None, country=None)

Bases: ask_sdk_model.interfaces.connections.entities.base_entity.BaseEntity

Postal Address

Parameters:

• version ((optional) str) – version of the request
• street_address ((optional) str) – street address
• locality ((optional) str) – locality/city
• region ((optional) str) – state/region
• postal_code ((optional) str) – postal/zip code
• country ((optional) str) – country

attribute_map = {'country': 'country', 'locality': 'locality', 'object_type': '@type', 'postal_code': 'postalCode', 'region': 'region', 'street_address': 'streetAddress', 'version': '@version'}

deserialized_types = {'country': 'str', 'locality': 'str', 'object_type': 'str', 'postal_code': 'str', 'region': 'str', 'street_address': 'str', 'version': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.connections.entities.restaurant module

class ask_sdk_model.interfaces.connections.entities.restaurant.Restaurant(version=None, name=None, location=None)

Bases: ask_sdk_model.interfaces.connections.entities.base_entity.BaseEntity

Restaurant entity

Parameters:

• version ((optional) str) – version of the request
• name ((optional) str) – name of the restaurant
• location ((optional) ask_sdk_model.interfaces.connections.entities.postal_address.PostalAddress) – location

attribute_map = {'location': 'location', 'name': 'name', 'object_type': '@type', 'version': '@version'}

deserialized_types = {'location': 'ask_sdk_model.interfaces.connections.entities.postal_address.PostalAddress', 'name': 'str', 'object_type': 'str', 'version': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.connections.requests 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_sdk_model.interfaces.connections.requests.base_request module

class ask_sdk_model.interfaces.connections.requests.base_request.BaseRequest(object_type=None, version=None)

Bases: object

Parameters:

• object_type ((optional) str) –
• version ((optional) str) – version of the request

Note

This is an abstract class. Use the following mapping, to figure out the model class to be instantiated, that sets @type variable.

ScheduleFoodEstablishmentReservationRequest: ask_sdk_model.interfaces.connections.requests.schedule_food_establishment_reservation_request.ScheduleFoodEstablishmentReservationRequest,

PrintImageRequest: ask_sdk_model.interfaces.connections.requests.print_image_request.PrintImageRequest,

PrintWebPageRequest: ask_sdk_model.interfaces.connections.requests.print_web_page_request.PrintWebPageRequest,

PrintPDFRequest: ask_sdk_model.interfaces.connections.requests.print_pdf_request.PrintPDFRequest,

ScheduleTaxiReservationRequest: ask_sdk_model.interfaces.connections.requests.schedule_taxi_reservation_request.ScheduleTaxiReservationRequest

attribute_map = {'object_type': '@type', 'version': '@version'}

deserialized_types = {'object_type': 'str', 'version': 'str'}

discriminator_value_class_map = {'PrintImageRequest': 'ask_sdk_model.interfaces.connections.requests.print_image_request.PrintImageRequest', 'PrintPDFRequest': 'ask_sdk_model.interfaces.connections.requests.print_pdf_request.PrintPDFRequest', 'PrintWebPageRequest': 'ask_sdk_model.interfaces.connections.requests.print_web_page_request.PrintWebPageRequest', 'ScheduleFoodEstablishmentReservationRequest': 'ask_sdk_model.interfaces.connections.requests.schedule_food_establishment_reservation_request.ScheduleFoodEstablishmentReservationRequest', 'ScheduleTaxiReservationRequest': 'ask_sdk_model.interfaces.connections.requests.schedule_taxi_reservation_request.ScheduleTaxiReservationRequest'}

classmethod get_real_child_model(data)

Returns the real base class specified by the discriminator

json_discriminator_key = '@type'

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.connections.requests.print_image_request module

class ask_sdk_model.interfaces.connections.requests.print_image_request.PrintImageRequest(version=None, title=None, url=None, description=None, image_type=None)

Bases: ask_sdk_model.interfaces.connections.requests.base_request.BaseRequest

Payload Request object for PrintImage

Parameters:

• version ((optional) str) – version of the request
• title ((optional) str) – title of the image
• url ((optional) str) – url of the image
• description ((optional) str) – description of the image
• image_type ((optional) str) – type of the image

attribute_map = {'description': 'description', 'image_type': 'imageType', 'object_type': '@type', 'title': 'title', 'url': 'url', 'version': '@version'}

deserialized_types = {'description': 'str', 'image_type': 'str', 'object_type': 'str', 'title': 'str', 'url': 'str', 'version': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.connections.requests.print_pdf_request module

class ask_sdk_model.interfaces.connections.requests.print_pdf_request.PrintPDFRequest(version=None, title=None, url=None, description=None)

Bases: ask_sdk_model.interfaces.connections.requests.base_request.BaseRequest

Payload Request object for PrintPDF

Parameters:

• version ((optional) str) – version of the request
• title ((optional) str) – title of the image
• url ((optional) str) – url of the image
• description ((optional) str) – description of the image

attribute_map = {'description': 'description', 'object_type': '@type', 'title': 'title', 'url': 'url', 'version': '@version'}

deserialized_types = {'description': 'str', 'object_type': 'str', 'title': 'str', 'url': 'str', 'version': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.connections.requests.print_web_page_request module

class ask_sdk_model.interfaces.connections.requests.print_web_page_request.PrintWebPageRequest(version=None, title=None, url=None, description=None)

Bases: ask_sdk_model.interfaces.connections.requests.base_request.BaseRequest

Payload Request object for PrintWebPage

Parameters:

• version ((optional) str) – version of the request
• title ((optional) str) – title of the image
• url ((optional) str) – url of the image
• description ((optional) str) – description of the image

attribute_map = {'description': 'description', 'object_type': '@type', 'title': 'title', 'url': 'url', 'version': '@version'}

deserialized_types = {'description': 'str', 'object_type': 'str', 'title': 'str', 'url': 'str', 'version': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.connections.requests.schedule_food_establishment_reservation_request module

class ask_sdk_model.interfaces.connections.requests.schedule_food_establishment_reservation_request.ScheduleFoodEstablishmentReservationRequest(version=None, start_time=None, party_size=None, restaurant=None)

Bases: ask_sdk_model.interfaces.connections.requests.base_request.BaseRequest

ScheduleFoodEstablishmentReservationRequest for booking restaurant reservation

Parameters:

• version ((optional) str) – version of the request
• start_time ((optional) str) – start time of the reservation
• party_size ((optional) str) – party size
• restaurant ((optional) ask_sdk_model.interfaces.connections.entities.restaurant.Restaurant) – restaurant

attribute_map = {'object_type': '@type', 'party_size': 'partySize', 'restaurant': 'restaurant', 'start_time': 'startTime', 'version': '@version'}

deserialized_types = {'object_type': 'str', 'party_size': 'str', 'restaurant': 'ask_sdk_model.interfaces.connections.entities.restaurant.Restaurant', 'start_time': 'str', 'version': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.connections.requests.schedule_taxi_reservation_request module

class ask_sdk_model.interfaces.connections.requests.schedule_taxi_reservation_request.ScheduleTaxiReservationRequest(version=None, pickup_time=None, party_size=None, pickup_location=None, drop_off_location=None)

Bases: ask_sdk_model.interfaces.connections.requests.base_request.BaseRequest

ScheduleTaxiReservationRequest for booking taxi reservation

Parameters:

• version ((optional) str) – version of the request
• pickup_time ((optional) str) – pickup time
• party_size ((optional) str) – party size
• pickup_location ((optional) ask_sdk_model.interfaces.connections.entities.postal_address.PostalAddress) – pick up location
• drop_off_location ((optional) ask_sdk_model.interfaces.connections.entities.postal_address.PostalAddress) – drop off location

attribute_map = {'drop_off_location': 'dropOffLocation', 'object_type': '@type', 'party_size': 'partySize', 'pickup_location': 'pickupLocation', 'pickup_time': 'pickupTime', 'version': '@version'}

deserialized_types = {'drop_off_location': 'ask_sdk_model.interfaces.connections.entities.postal_address.PostalAddress', 'object_type': 'str', 'party_size': 'str', 'pickup_location': 'ask_sdk_model.interfaces.connections.entities.postal_address.PostalAddress', 'pickup_time': 'str', 'version': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.connections.v1 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_sdk_model.interfaces.connections.v1.start_connection_directive module

class ask_sdk_model.interfaces.connections.v1.start_connection_directive.StartConnectionDirective(uri=None, input=None, token=None)

Bases: ask_sdk_model.directive.Directive

This is the directive that a skill can send as part of their response to a session based request to start a connection. A response will be returned to the skill when the connection is handled.

Parameters:

• uri ((optional) str) – This defines the name and version of connection that the requester is trying to send. The format of the uri should follow this pattern: connection://connectionName/connectionVersion. Invalid uri will cause an error which will be sent back to the requester.
• input ((optional) dict(str, object)) – This is the input to the connection that the requester is trying to send. It is predefined by the handler of the connection. If the input format is incorrect, an error will be sent to to the requester.
• token ((optional) str) – This is an echo back string that requester will receive it when it gets resumed. It is never sent to the handler of the connection.

attribute_map = {'input': 'input', 'object_type': 'type', 'token': 'token', 'uri': 'uri'}

deserialized_types = {'input': 'dict(str, object)', 'object_type': 'str', 'token': 'str', 'uri': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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_sdk_model.interfaces.connections.connections_request module

class ask_sdk_model.interfaces.connections.connections_request.ConnectionsRequest(request_id=None, timestamp=None, locale=None, name=None, payload=None)

Bases: ask_sdk_model.request.Request

This is the request object that a skill will receive as a result of Connections.SendRequest directive from sender skill.

Parameters:

• request_id ((optional) str) – Represents the unique identifier for the specific request.
• timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
• locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
• name ((optional) str) – Name of the action sent by the referrer skill.
• payload ((optional) dict(str, object)) – This is an object sent between the two skills for processing a ConnectionsRequest or ConnectionsResponse. This will always be a valid payload based on Action schema for the requester action.

attribute_map = {'locale': 'locale', 'name': 'name', 'object_type': 'type', 'payload': 'payload', 'request_id': 'requestId', 'timestamp': 'timestamp'}

deserialized_types = {'locale': 'str', 'name': 'str', 'object_type': 'str', 'payload': 'dict(str, object)', 'request_id': 'str', 'timestamp': 'datetime'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.connections.connections_response module

class ask_sdk_model.interfaces.connections.connections_response.ConnectionsResponse(request_id=None, timestamp=None, locale=None, status=None, name=None, payload=None, token=None)

Bases: ask_sdk_model.request.Request

This is the request object that a skill will receive as a result of Connections.SendResponse directive from referrer skill.

Parameters:

• request_id ((optional) str) – Represents the unique identifier for the specific request.
• timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
• locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
• status ((optional) ask_sdk_model.interfaces.connections.connections_status.ConnectionsStatus) –
• name ((optional) str) – Name of the action for which response is received.
• payload ((optional) dict(str, object)) – This is an object sent from referrer skill as is.
• token ((optional) str) – This is the token that the skill originally sent with the ConnectionsSendRequest directive.

attribute_map = {'locale': 'locale', 'name': 'name', 'object_type': 'type', 'payload': 'payload', 'request_id': 'requestId', 'status': 'status', 'timestamp': 'timestamp', 'token': 'token'}

deserialized_types = {'locale': 'str', 'name': 'str', 'object_type': 'str', 'payload': 'dict(str, object)', 'request_id': 'str', 'status': 'ask_sdk_model.interfaces.connections.connections_status.ConnectionsStatus', 'timestamp': 'datetime', 'token': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.connections.connections_status module

class ask_sdk_model.interfaces.connections.connections_status.ConnectionsStatus(code=None, message=None)

Bases: object

Connection Status indicates a high level understanding of the result of ConnectionsRequest.

Parameters:

• code ((optional) str) – This is a code signifying the status of the request sent by the skill. Protocol adheres to HTTP status codes.
• message ((optional) str) – This is a message that goes along with response code that can provide more information about what occurred

attribute_map = {'code': 'code', 'message': 'message'}

deserialized_types = {'code': 'str', 'message': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.connections.send_request_directive module

class ask_sdk_model.interfaces.connections.send_request_directive.SendRequestDirective(name=None, payload=None, token=None)

Bases: ask_sdk_model.directive.Directive

This is the directive that a skill can send as part of their response to a session based request to execute a predefined Connections. This will also return a result to the referring skill. (No Guarantee response will be returned)

Parameters:

• name ((optional) str) – This defines the name of the Connection skill is trying to execute. It must be a valid and supported Connection name.
• payload ((optional) dict(str, object)) – This is an object sent between the two skills for processing a ConnectionsRequest or ConnectionsResponse. The contract for the object is based on the schema of the Action used in the SendRequestDirective. Invalid payloads will result in errors sent back to the referrer.
• token ((optional) str) – This is an echo back string that skills send when during Connections.SendRequest directive. They will receive it when they get the ConnectionsResponse. It is never sent to the skill handling the request.

attribute_map = {'name': 'name', 'object_type': 'type', 'payload': 'payload', 'token': 'token'}

deserialized_types = {'name': 'str', 'object_type': 'str', 'payload': 'dict(str, object)', 'token': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.connections.send_response_directive module

class ask_sdk_model.interfaces.connections.send_response_directive.SendResponseDirective(status=None, payload=None)

Bases: ask_sdk_model.directive.Directive

This is the directive that a skill can send as part of their response to a session based request to return a response to ConnectionsRequest.

Parameters:

• status ((optional) ask_sdk_model.interfaces.connections.connections_status.ConnectionsStatus) –
• payload ((optional) dict(str, object)) – This is an object sent to referrer skill as is.

attribute_map = {'object_type': 'type', 'payload': 'payload', 'status': 'status'}

deserialized_types = {'object_type': 'str', 'payload': 'dict(str, object)', 'status': 'ask_sdk_model.interfaces.connections.connections_status.ConnectionsStatus'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.custom_interface_controller 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_sdk_model.interfaces.custom_interface_controller.endpoint module

class ask_sdk_model.interfaces.custom_interface_controller.endpoint.Endpoint(endpoint_id=None)

Bases: object

The endpoint of a gadget.

Parameters:endpoint_id ((optional) str) – The endpoint ID of the gadget.

attribute_map = {'endpoint_id': 'endpointId'}

deserialized_types = {'endpoint_id': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.custom_interface_controller.event module

class ask_sdk_model.interfaces.custom_interface_controller.event.Event(header=None, payload=None, endpoint=None)

Bases: object

An Event object defining a single event sent by an endpoint

Parameters:

• header ((optional) ask_sdk_model.interfaces.custom_interface_controller.header.Header) – The object that contains the header of the event.
• payload ((optional) object) – The free form JSON object.
• endpoint ((optional) ask_sdk_model.interfaces.custom_interface_controller.endpoint.Endpoint) – Identifies where the event orginated from.

attribute_map = {'endpoint': 'endpoint', 'header': 'header', 'payload': 'payload'}

deserialized_types = {'endpoint': 'ask_sdk_model.interfaces.custom_interface_controller.endpoint.Endpoint', 'header': 'ask_sdk_model.interfaces.custom_interface_controller.header.Header', 'payload': 'object'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.custom_interface_controller.event_filter module

class ask_sdk_model.interfaces.custom_interface_controller.event_filter.EventFilter(filter_expression=None, filter_match_action=None)

Bases: object

Defines the Jsonlogic event filter expression and its corresponding match action. This filter is applied to all events during the event handler's duration. Events that are rejected by the filter expression are not sent to the skill.

Parameters:

• filter_expression ((optional) object) – The JSON object that represents the Jsonlogic expression against which the events are evaluated. If this expression is satisfied, the corresponding match action is performed.
• filter_match_action ((optional) ask_sdk_model.interfaces.custom_interface_controller.filter_match_action.FilterMatchAction) –

attribute_map = {'filter_expression': 'filterExpression', 'filter_match_action': 'filterMatchAction'}

deserialized_types = {'filter_expression': 'object', 'filter_match_action': 'ask_sdk_model.interfaces.custom_interface_controller.filter_match_action.FilterMatchAction'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.custom_interface_controller.events_received_request module

class ask_sdk_model.interfaces.custom_interface_controller.events_received_request.EventsReceivedRequest(request_id=None, timestamp=None, locale=None, token=None, events=None)

Bases: ask_sdk_model.request.Request

Skill receives this type of event when an event meets the filter conditions provided in the StartEventHandlerDirective.

Parameters:

• request_id ((optional) str) – Represents the unique identifier for the specific request.
• timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
• locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
• token ((optional) str) – Unique identifier associated with the Event Handler that dispatched this event.
• events ((optional) list[ask_sdk_model.interfaces.custom_interface_controller.event.Event]) – A list of events that meet the filter criteria.

attribute_map = {'events': 'events', 'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp', 'token': 'token'}

deserialized_types = {'events': 'list[ask_sdk_model.interfaces.custom_interface_controller.event.Event]', 'locale': 'str', 'object_type': 'str', 'request_id': 'str', 'timestamp': 'datetime', 'token': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.custom_interface_controller.expiration module

class ask_sdk_model.interfaces.custom_interface_controller.expiration.Expiration(duration_in_milliseconds=None, expiration_payload=None)

Bases: object

This object defines the duration of the Event Handler and the optional JSON payload that is delivered to the skill when the timer expires.

Parameters:

• duration_in_milliseconds ((optional) int) – The length of time, in milliseconds, for which events from connected gadgets will be passed to the skill. Your skill will continue to receive events until this duration expires or the event handler is otherwise stopped.
• expiration_payload ((optional) object) – The payload that was defined in the StartEventHandlerDirective. The skill will receive if and only if the Event Handler duration expired.

attribute_map = {'duration_in_milliseconds': 'durationInMilliseconds', 'expiration_payload': 'expirationPayload'}

deserialized_types = {'duration_in_milliseconds': 'int', 'expiration_payload': 'object'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.custom_interface_controller.expired_request module

class ask_sdk_model.interfaces.custom_interface_controller.expired_request.ExpiredRequest(request_id=None, timestamp=None, locale=None, token=None, expiration_payload=None)

Bases: ask_sdk_model.request.Request

This is the event received by the skill at expiry of an Event Handler.

Parameters:

• request_id ((optional) str) – Represents the unique identifier for the specific request.
• timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
• locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
• token ((optional) str) – The unique token specified by the StartEventHandlerDirective.
• expiration_payload ((optional) object) – The free form JSON object that the skill will receive if and only if the Event Handler duration expired.

attribute_map = {'expiration_payload': 'expirationPayload', 'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp', 'token': 'token'}

deserialized_types = {'expiration_payload': 'object', 'locale': 'str', 'object_type': 'str', 'request_id': 'str', 'timestamp': 'datetime', 'token': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.custom_interface_controller.filter_match_action module

class ask_sdk_model.interfaces.custom_interface_controller.filter_match_action.FilterMatchAction

Bases: enum.Enum

The behavior to be performed by the platform on a successful filter expression match.

Allowed enum values: [SEND_AND_TERMINATE, SEND]

SEND = 'SEND'

SEND_AND_TERMINATE = 'SEND_AND_TERMINATE'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.custom_interface_controller.header module

class ask_sdk_model.interfaces.custom_interface_controller.header.Header(namespace=None, name=None)

Bases: object

Endpoint Event header

Parameters:

• namespace ((optional) str) – The developer-defined namespace for the custom interface.
• name ((optional) str) – The developer-defined name of the custom interface.

attribute_map = {'name': 'name', 'namespace': 'namespace'}

deserialized_types = {'name': 'str', 'namespace': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.custom_interface_controller.send_directive_directive module

class ask_sdk_model.interfaces.custom_interface_controller.send_directive_directive.SendDirectiveDirective(header=None, payload=None, endpoint=None)

Bases: ask_sdk_model.directive.Directive

The directive to be delivered to the gadgets. Each directive is targeted to one gadget (that is, one endpointId). To target the same directive to multiple gadgets, include one directive for each gadget in the response.

Parameters:

• header ((optional) ask_sdk_model.interfaces.custom_interface_controller.header.Header) – The object that contains the header of the directive.
• payload ((optional) object) – The free form JSON object.
• endpoint ((optional) ask_sdk_model.interfaces.custom_interface_controller.endpoint.Endpoint) – Identifies the gadget where the directive should be sent to. Each directive is targeted to one gadget (that is, one endpointId). If the same directive is be sent to multiple gadgets, include one directive for each gadget in the response.

attribute_map = {'endpoint': 'endpoint', 'header': 'header', 'object_type': 'type', 'payload': 'payload'}

deserialized_types = {'endpoint': 'ask_sdk_model.interfaces.custom_interface_controller.endpoint.Endpoint', 'header': 'ask_sdk_model.interfaces.custom_interface_controller.header.Header', 'object_type': 'str', 'payload': 'object'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.custom_interface_controller.start_event_handler_directive module

class ask_sdk_model.interfaces.custom_interface_controller.start_event_handler_directive.StartEventHandlerDirective(token=None, event_filter=None, expiration=None)

Bases: ask_sdk_model.directive.Directive

This directive configures and starts an event handler. This will enable the skill to receive Custom Events. A skill can only have one active Event Handler at a time.

Parameters:

• token ((optional) str) – A unique string to identify the Event Handler. This identifier is associated with all events dispatched by the Event Handler while it is active.
• event_filter ((optional) ask_sdk_model.interfaces.custom_interface_controller.event_filter.EventFilter) –
• expiration ((optional) ask_sdk_model.interfaces.custom_interface_controller.expiration.Expiration) –

attribute_map = {'event_filter': 'eventFilter', 'expiration': 'expiration', 'object_type': 'type', 'token': 'token'}

deserialized_types = {'event_filter': 'ask_sdk_model.interfaces.custom_interface_controller.event_filter.EventFilter', 'expiration': 'ask_sdk_model.interfaces.custom_interface_controller.expiration.Expiration', 'object_type': 'str', 'token': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.custom_interface_controller.stop_event_handler_directive module

class ask_sdk_model.interfaces.custom_interface_controller.stop_event_handler_directive.StopEventHandlerDirective(token=None)

Bases: ask_sdk_model.directive.Directive

This directive stops a running Event Handler associated with the provided token. The Expiration payload will not be sent if this executed before the Event Handler duration expired.

Parameters:token ((optional) str) – Unique identifier required to close the Event Handler. This token must match the token used in the StartEventHandlerDirective.

attribute_map = {'object_type': 'type', 'token': 'token'}

deserialized_types = {'object_type': 'str', 'token': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.display 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_sdk_model.interfaces.display.back_button_behavior module

class ask_sdk_model.interfaces.display.back_button_behavior.BackButtonBehavior

Bases: enum.Enum

Allowed enum values: [HIDDEN, VISIBLE]

HIDDEN = 'HIDDEN'

VISIBLE = 'VISIBLE'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.display.body_template1 module

class ask_sdk_model.interfaces.display.body_template1.BodyTemplate1(token=None, back_button=None, background_image=None, title=None, text_content=None)

Bases: ask_sdk_model.interfaces.display.template.Template

Parameters:

• token ((optional) str) –
• back_button ((optional) ask_sdk_model.interfaces.display.back_button_behavior.BackButtonBehavior) –
• background_image ((optional) ask_sdk_model.interfaces.display.image.Image) –
• title ((optional) str) –
• text_content ((optional) ask_sdk_model.interfaces.display.text_content.TextContent) –

attribute_map = {'back_button': 'backButton', 'background_image': 'backgroundImage', 'object_type': 'type', 'text_content': 'textContent', 'title': 'title', 'token': 'token'}

deserialized_types = {'back_button': 'ask_sdk_model.interfaces.display.back_button_behavior.BackButtonBehavior', 'background_image': 'ask_sdk_model.interfaces.display.image.Image', 'object_type': 'str', 'text_content': 'ask_sdk_model.interfaces.display.text_content.TextContent', 'title': 'str', 'token': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.display.body_template2 module

class ask_sdk_model.interfaces.display.body_template2.BodyTemplate2(token=None, back_button=None, background_image=None, image=None, title=None, text_content=None)

Bases: ask_sdk_model.interfaces.display.template.Template

Parameters:

• token ((optional) str) –
• back_button ((optional) ask_sdk_model.interfaces.display.back_button_behavior.BackButtonBehavior) –
• background_image ((optional) ask_sdk_model.interfaces.display.image.Image) –
• image ((optional) ask_sdk_model.interfaces.display.image.Image) –
• title ((optional) str) –
• text_content ((optional) ask_sdk_model.interfaces.display.text_content.TextContent) –

attribute_map = {'back_button': 'backButton', 'background_image': 'backgroundImage', 'image': 'image', 'object_type': 'type', 'text_content': 'textContent', 'title': 'title', 'token': 'token'}

deserialized_types = {'back_button': 'ask_sdk_model.interfaces.display.back_button_behavior.BackButtonBehavior', 'background_image': 'ask_sdk_model.interfaces.display.image.Image', 'image': 'ask_sdk_model.interfaces.display.image.Image', 'object_type': 'str', 'text_content': 'ask_sdk_model.interfaces.display.text_content.TextContent', 'title': 'str', 'token': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.display.body_template3 module

class ask_sdk_model.interfaces.display.body_template3.BodyTemplate3(token=None, back_button=None, background_image=None, image=None, title=None, text_content=None)

Bases: ask_sdk_model.interfaces.display.template.Template

Parameters:

• token ((optional) str) –
• back_button ((optional) ask_sdk_model.interfaces.display.back_button_behavior.BackButtonBehavior) –
• background_image ((optional) ask_sdk_model.interfaces.display.image.Image) –
• image ((optional) ask_sdk_model.interfaces.display.image.Image) –
• title ((optional) str) –
• text_content ((optional) ask_sdk_model.interfaces.display.text_content.TextContent) –

attribute_map = {'back_button': 'backButton', 'background_image': 'backgroundImage', 'image': 'image', 'object_type': 'type', 'text_content': 'textContent', 'title': 'title', 'token': 'token'}

deserialized_types = {'back_button': 'ask_sdk_model.interfaces.display.back_button_behavior.BackButtonBehavior', 'background_image': 'ask_sdk_model.interfaces.display.image.Image', 'image': 'ask_sdk_model.interfaces.display.image.Image', 'object_type': 'str', 'text_content': 'ask_sdk_model.interfaces.display.text_content.TextContent', 'title': 'str', 'token': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.display.body_template6 module

class ask_sdk_model.interfaces.display.body_template6.BodyTemplate6(token=None, back_button=None, background_image=None, text_content=None, image=None)

Bases: ask_sdk_model.interfaces.display.template.Template

Parameters:

• token ((optional) str) –
• back_button ((optional) ask_sdk_model.interfaces.display.back_button_behavior.BackButtonBehavior) –
• background_image ((optional) ask_sdk_model.interfaces.display.image.Image) –
• text_content ((optional) ask_sdk_model.interfaces.display.text_content.TextContent) –
• image ((optional) ask_sdk_model.interfaces.display.image.Image) –

attribute_map = {'back_button': 'backButton', 'background_image': 'backgroundImage', 'image': 'image', 'object_type': 'type', 'text_content': 'textContent', 'token': 'token'}

deserialized_types = {'back_button': 'ask_sdk_model.interfaces.display.back_button_behavior.BackButtonBehavior', 'background_image': 'ask_sdk_model.interfaces.display.image.Image', 'image': 'ask_sdk_model.interfaces.display.image.Image', 'object_type': 'str', 'text_content': 'ask_sdk_model.interfaces.display.text_content.TextContent', 'token': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.display.body_template7 module

class ask_sdk_model.interfaces.display.body_template7.BodyTemplate7(token=None, back_button=None, title=None, image=None, background_image=None)

Bases: ask_sdk_model.interfaces.display.template.Template

Parameters:

• token ((optional) str) –
• back_button ((optional) ask_sdk_model.interfaces.display.back_button_behavior.BackButtonBehavior) –
• title ((optional) str) –
• image ((optional) ask_sdk_model.interfaces.display.image.Image) –
• background_image ((optional) ask_sdk_model.interfaces.display.image.Image) –

attribute_map = {'back_button': 'backButton', 'background_image': 'backgroundImage', 'image': 'image', 'object_type': 'type', 'title': 'title', 'token': 'token'}

deserialized_types = {'back_button': 'ask_sdk_model.interfaces.display.back_button_behavior.BackButtonBehavior', 'background_image': 'ask_sdk_model.interfaces.display.image.Image', 'image': 'ask_sdk_model.interfaces.display.image.Image', 'object_type': 'str', 'title': 'str', 'token': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.display.display_interface module

class ask_sdk_model.interfaces.display.display_interface.DisplayInterface(template_version=None, markup_version=None)

Bases: object

Parameters:

• template_version ((optional) str) –
• markup_version ((optional) str) –

attribute_map = {'markup_version': 'markupVersion', 'template_version': 'templateVersion'}

deserialized_types = {'markup_version': 'str', 'template_version': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.display.display_state module

class ask_sdk_model.interfaces.display.display_state.DisplayState(token=None)

Bases: object

Parameters:token ((optional) str) –

attribute_map = {'token': 'token'}

deserialized_types = {'token': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.display.element_selected_request module

class ask_sdk_model.interfaces.display.element_selected_request.ElementSelectedRequest(request_id=None, timestamp=None, locale=None, token=None)

Bases: ask_sdk_model.request.Request

Parameters:

• request_id ((optional) str) – Represents the unique identifier for the specific request.
• timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
• locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
• token ((optional) str) –

attribute_map = {'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp', 'token': 'token'}

deserialized_types = {'locale': 'str', 'object_type': 'str', 'request_id': 'str', 'timestamp': 'datetime', 'token': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.display.hint module

class ask_sdk_model.interfaces.display.hint.Hint(object_type=None)

Bases: object

Parameters:object_type ((optional) str) –

Note

This is an abstract class. Use the following mapping, to figure out the model class to be instantiated, that sets type variable.

PlainText: ask_sdk_model.interfaces.display.plain_text_hint.PlainTextHint

attribute_map = {'object_type': 'type'}

deserialized_types = {'object_type': 'str'}

discriminator_value_class_map = {'PlainText': 'ask_sdk_model.interfaces.display.plain_text_hint.PlainTextHint'}

classmethod get_real_child_model(data)

Returns the real base class specified by the discriminator

json_discriminator_key = 'type'

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.display.hint_directive module

class ask_sdk_model.interfaces.display.hint_directive.HintDirective(hint=None)

Bases: ask_sdk_model.directive.Directive

Parameters:hint ((optional) ask_sdk_model.interfaces.display.hint.Hint) –

attribute_map = {'hint': 'hint', 'object_type': 'type'}

deserialized_types = {'hint': 'ask_sdk_model.interfaces.display.hint.Hint', 'object_type': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.display.image module

class ask_sdk_model.interfaces.display.image.Image(content_description=None, sources=None)

Bases: object

Parameters:

• content_description ((optional) str) –
• sources ((optional) list[ask_sdk_model.interfaces.display.image_instance.ImageInstance]) –

attribute_map = {'content_description': 'contentDescription', 'sources': 'sources'}

deserialized_types = {'content_description': 'str', 'sources': 'list[ask_sdk_model.interfaces.display.image_instance.ImageInstance]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.display.image_instance module

class ask_sdk_model.interfaces.display.image_instance.ImageInstance(url=None, size=None, width_pixels=None, height_pixels=None)

Bases: object

Parameters:

• url ((optional) str) –
• size ((optional) ask_sdk_model.interfaces.display.image_size.ImageSize) –
• width_pixels ((optional) int) –
• height_pixels ((optional) int) –

attribute_map = {'height_pixels': 'heightPixels', 'size': 'size', 'url': 'url', 'width_pixels': 'widthPixels'}

deserialized_types = {'height_pixels': 'int', 'size': 'ask_sdk_model.interfaces.display.image_size.ImageSize', 'url': 'str', 'width_pixels': 'int'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.display.image_size module

class ask_sdk_model.interfaces.display.image_size.ImageSize

Bases: enum.Enum

Allowed enum values: [X_SMALL, SMALL, MEDIUM, LARGE, X_LARGE]

LARGE = 'LARGE'

MEDIUM = 'MEDIUM'

SMALL = 'SMALL'

X_LARGE = 'X_LARGE'

X_SMALL = 'X_SMALL'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.display.list_item module

class ask_sdk_model.interfaces.display.list_item.ListItem(token=None, image=None, text_content=None)

Bases: object

Parameters:

• token ((optional) str) –
• image ((optional) ask_sdk_model.interfaces.display.image.Image) –
• text_content ((optional) ask_sdk_model.interfaces.display.text_content.TextContent) –

attribute_map = {'image': 'image', 'text_content': 'textContent', 'token': 'token'}

deserialized_types = {'image': 'ask_sdk_model.interfaces.display.image.Image', 'text_content': 'ask_sdk_model.interfaces.display.text_content.TextContent', 'token': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.display.list_template1 module

class ask_sdk_model.interfaces.display.list_template1.ListTemplate1(token=None, back_button=None, background_image=None, title=None, list_items=None)

Bases: ask_sdk_model.interfaces.display.template.Template

Parameters:

• token ((optional) str) –
• back_button ((optional) ask_sdk_model.interfaces.display.back_button_behavior.BackButtonBehavior) –
• background_image ((optional) ask_sdk_model.interfaces.display.image.Image) –
• title ((optional) str) –
• list_items ((optional) list[ask_sdk_model.interfaces.display.list_item.ListItem]) –

attribute_map = {'back_button': 'backButton', 'background_image': 'backgroundImage', 'list_items': 'listItems', 'object_type': 'type', 'title': 'title', 'token': 'token'}

deserialized_types = {'back_button': 'ask_sdk_model.interfaces.display.back_button_behavior.BackButtonBehavior', 'background_image': 'ask_sdk_model.interfaces.display.image.Image', 'list_items': 'list[ask_sdk_model.interfaces.display.list_item.ListItem]', 'object_type': 'str', 'title': 'str', 'token': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.display.list_template2 module

class ask_sdk_model.interfaces.display.list_template2.ListTemplate2(token=None, back_button=None, background_image=None, title=None, list_items=None)

Bases: ask_sdk_model.interfaces.display.template.Template

Parameters:

• token ((optional) str) –
• back_button ((optional) ask_sdk_model.interfaces.display.back_button_behavior.BackButtonBehavior) –
• background_image ((optional) ask_sdk_model.interfaces.display.image.Image) –
• title ((optional) str) –
• list_items ((optional) list[ask_sdk_model.interfaces.display.list_item.ListItem]) –

attribute_map = {'back_button': 'backButton', 'background_image': 'backgroundImage', 'list_items': 'listItems', 'object_type': 'type', 'title': 'title', 'token': 'token'}

deserialized_types = {'back_button': 'ask_sdk_model.interfaces.display.back_button_behavior.BackButtonBehavior', 'background_image': 'ask_sdk_model.interfaces.display.image.Image', 'list_items': 'list[ask_sdk_model.interfaces.display.list_item.ListItem]', 'object_type': 'str', 'title': 'str', 'token': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.display.plain_text module

class ask_sdk_model.interfaces.display.plain_text.PlainText(text=None)

Bases: ask_sdk_model.interfaces.display.text_field.TextField

Parameters:text ((optional) str) –

attribute_map = {'object_type': 'type', 'text': 'text'}

deserialized_types = {'object_type': 'str', 'text': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.display.plain_text_hint module

class ask_sdk_model.interfaces.display.plain_text_hint.PlainTextHint(text=None)

Bases: ask_sdk_model.interfaces.display.hint.Hint

Parameters:text ((optional) str) –

attribute_map = {'object_type': 'type', 'text': 'text'}

deserialized_types = {'object_type': 'str', 'text': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.display.render_template_directive module

class ask_sdk_model.interfaces.display.render_template_directive.RenderTemplateDirective(template=None)

Bases: ask_sdk_model.directive.Directive

Parameters:template ((optional) ask_sdk_model.interfaces.display.template.Template) –

attribute_map = {'object_type': 'type', 'template': 'template'}

deserialized_types = {'object_type': 'str', 'template': 'ask_sdk_model.interfaces.display.template.Template'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.display.rich_text module

class ask_sdk_model.interfaces.display.rich_text.RichText(text=None)

Bases: ask_sdk_model.interfaces.display.text_field.TextField

Parameters:text ((optional) str) –

attribute_map = {'object_type': 'type', 'text': 'text'}

deserialized_types = {'object_type': 'str', 'text': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.display.template module

class ask_sdk_model.interfaces.display.template.Template(object_type=None, token=None, back_button=None)

Bases: object

Parameters:

• object_type ((optional) str) –
• token ((optional) str) –
• back_button ((optional) ask_sdk_model.interfaces.display.back_button_behavior.BackButtonBehavior) –

Note

This is an abstract class. Use the following mapping, to figure out the model class to be instantiated, that sets type variable.

ListTemplate2: ask_sdk_model.interfaces.display.list_template2.ListTemplate2,

ListTemplate1: ask_sdk_model.interfaces.display.list_template1.ListTemplate1,

BodyTemplate7: ask_sdk_model.interfaces.display.body_template7.BodyTemplate7,

BodyTemplate6: ask_sdk_model.interfaces.display.body_template6.BodyTemplate6,

BodyTemplate3: ask_sdk_model.interfaces.display.body_template3.BodyTemplate3,

BodyTemplate2: ask_sdk_model.interfaces.display.body_template2.BodyTemplate2,

BodyTemplate1: ask_sdk_model.interfaces.display.body_template1.BodyTemplate1

attribute_map = {'back_button': 'backButton', 'object_type': 'type', 'token': 'token'}

deserialized_types = {'back_button': 'ask_sdk_model.interfaces.display.back_button_behavior.BackButtonBehavior', 'object_type': 'str', 'token': 'str'}

discriminator_value_class_map = {'BodyTemplate1': 'ask_sdk_model.interfaces.display.body_template1.BodyTemplate1', 'BodyTemplate2': 'ask_sdk_model.interfaces.display.body_template2.BodyTemplate2', 'BodyTemplate3': 'ask_sdk_model.interfaces.display.body_template3.BodyTemplate3', 'BodyTemplate6': 'ask_sdk_model.interfaces.display.body_template6.BodyTemplate6', 'BodyTemplate7': 'ask_sdk_model.interfaces.display.body_template7.BodyTemplate7', 'ListTemplate1': 'ask_sdk_model.interfaces.display.list_template1.ListTemplate1', 'ListTemplate2': 'ask_sdk_model.interfaces.display.list_template2.ListTemplate2'}

classmethod get_real_child_model(data)

Returns the real base class specified by the discriminator

json_discriminator_key = 'type'

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.display.text_content module

class ask_sdk_model.interfaces.display.text_content.TextContent(primary_text=None, secondary_text=None, tertiary_text=None)

Bases: object

Parameters:

• primary_text ((optional) ask_sdk_model.interfaces.display.text_field.TextField) –
• secondary_text ((optional) ask_sdk_model.interfaces.display.text_field.TextField) –
• tertiary_text ((optional) ask_sdk_model.interfaces.display.text_field.TextField) –

attribute_map = {'primary_text': 'primaryText', 'secondary_text': 'secondaryText', 'tertiary_text': 'tertiaryText'}

deserialized_types = {'primary_text': 'ask_sdk_model.interfaces.display.text_field.TextField', 'secondary_text': 'ask_sdk_model.interfaces.display.text_field.TextField', 'tertiary_text': 'ask_sdk_model.interfaces.display.text_field.TextField'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.display.text_field module

class ask_sdk_model.interfaces.display.text_field.TextField(object_type=None)

Bases: object

Parameters:object_type ((optional) str) –

Note

This is an abstract class. Use the following mapping, to figure out the model class to be instantiated, that sets type variable.

RichText: ask_sdk_model.interfaces.display.rich_text.RichText,

PlainText: ask_sdk_model.interfaces.display.plain_text.PlainText

attribute_map = {'object_type': 'type'}

deserialized_types = {'object_type': 'str'}

discriminator_value_class_map = {'PlainText': 'ask_sdk_model.interfaces.display.plain_text.PlainText', 'RichText': 'ask_sdk_model.interfaces.display.rich_text.RichText'}

classmethod get_real_child_model(data)

Returns the real base class specified by the discriminator

json_discriminator_key = 'type'

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.gadget_controller 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_sdk_model.interfaces.gadget_controller.set_light_directive module

class ask_sdk_model.interfaces.gadget_controller.set_light_directive.SetLightDirective(version=None, target_gadgets=None, parameters=None)

Bases: ask_sdk_model.directive.Directive

Sends Alexa a command to modify the behavior of connected Echo Buttons.

Parameters:

• version ((optional) int) – The version of the directive. Must be set to 1.
• target_gadgets ((optional) list[str]) – The gadget IDs that will receive the command. An empty array, or leaving this parameter out, signifies that all gadgets will receive the command.
• parameters ((optional) ask_sdk_model.services.gadget_controller.set_light_parameters.SetLightParameters) –

attribute_map = {'object_type': 'type', 'parameters': 'parameters', 'target_gadgets': 'targetGadgets', 'version': 'version'}

deserialized_types = {'object_type': 'str', 'parameters': 'ask_sdk_model.services.gadget_controller.set_light_parameters.SetLightParameters', 'target_gadgets': 'list[str]', 'version': 'int'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.game_engine 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_sdk_model.interfaces.game_engine.input_handler_event_request module

class ask_sdk_model.interfaces.game_engine.input_handler_event_request.InputHandlerEventRequest(request_id=None, timestamp=None, locale=None, originating_request_id=None, events=None)

Bases: ask_sdk_model.request.Request

Sent when the conditions of an Echo Button event that your skill defined were met.

Parameters:

• request_id ((optional) str) – Represents the unique identifier for the specific request.
• timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
• locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
• originating_request_id ((optional) str) – The corresponding identifier of the request that started the input handler.
• events ((optional) list[ask_sdk_model.services.game_engine.input_handler_event.InputHandlerEvent]) –

attribute_map = {'events': 'events', 'locale': 'locale', 'object_type': 'type', 'originating_request_id': 'originatingRequestId', 'request_id': 'requestId', 'timestamp': 'timestamp'}

deserialized_types = {'events': 'list[ask_sdk_model.services.game_engine.input_handler_event.InputHandlerEvent]', 'locale': 'str', 'object_type': 'str', 'originating_request_id': 'str', 'request_id': 'str', 'timestamp': 'datetime'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.game_engine.start_input_handler_directive module

class ask_sdk_model.interfaces.game_engine.start_input_handler_directive.StartInputHandlerDirective(timeout=None, proxies=None, recognizers=None, events=None)

Bases: ask_sdk_model.directive.Directive

Parameters:

• timeout ((optional) int) – The maximum run time for this Input Handler, in milliseconds. Although this parameter is required, you can specify events with conditions on which to end the Input Handler earlier.
• proxies ((optional) list[str]) – Names for unknown gadget IDs to use in recognizers, allocated on a first-come, first-served basis.
• recognizers ((optional) dict(str, ask_sdk_model.services.game_engine.recognizer.Recognizer)) – Conditions that, at any moment, are either true or false. You use recognizers when you specify the conditions under which your skill is notified of Echo Button input.
• events ((optional) dict(str, ask_sdk_model.services.game_engine.event.Event)) – The logic that determines when your skill is notified of Echo Button input. Events are listed here as object keys, where the keys specify the name of an event.

attribute_map = {'events': 'events', 'object_type': 'type', 'proxies': 'proxies', 'recognizers': 'recognizers', 'timeout': 'timeout'}

deserialized_types = {'events': 'dict(str, ask_sdk_model.services.game_engine.event.Event)', 'object_type': 'str', 'proxies': 'list[str]', 'recognizers': 'dict(str, ask_sdk_model.services.game_engine.recognizer.Recognizer)', 'timeout': 'int'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.game_engine.stop_input_handler_directive module

class ask_sdk_model.interfaces.game_engine.stop_input_handler_directive.StopInputHandlerDirective(originating_request_id=None)

Bases: ask_sdk_model.directive.Directive

Parameters:originating_request_id ((optional) str) – The &#x60;requestId&#x60; of the request that started the input handler.

attribute_map = {'object_type': 'type', 'originating_request_id': 'originatingRequestId'}

deserialized_types = {'object_type': 'str', 'originating_request_id': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.geolocation 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_sdk_model.interfaces.geolocation.access module

class ask_sdk_model.interfaces.geolocation.access.Access

Bases: enum.Enum

A string representing if Alexa has access to location services running on the hostOS of device.

Allowed enum values: [ENABLED, DISABLED, UNKNOWN]

DISABLED = 'DISABLED'

ENABLED = 'ENABLED'

UNKNOWN = 'UNKNOWN'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.geolocation.altitude module

class ask_sdk_model.interfaces.geolocation.altitude.Altitude(altitude_in_meters=None, accuracy_in_meters=None)

Bases: object

An object containing the altitude information of the device.

Parameters:

• altitude_in_meters ((optional) float) – A double representing the altitude of the device in meters.
• accuracy_in_meters ((optional) float) – A double representing the accuracy of the altitude measurement in meters.

attribute_map = {'accuracy_in_meters': 'accuracyInMeters', 'altitude_in_meters': 'altitudeInMeters'}

deserialized_types = {'accuracy_in_meters': 'float', 'altitude_in_meters': 'float'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.geolocation.coordinate module

class ask_sdk_model.interfaces.geolocation.coordinate.Coordinate(latitude_in_degrees=None, longitude_in_degrees=None, accuracy_in_meters=None)

Bases: object

An object containing the location information of the device.

Parameters:

• latitude_in_degrees ((optional) float) – A double representing the latitude in degrees of the device.
• longitude_in_degrees ((optional) float) – A double representing the longitude in degrees of the device.
• accuracy_in_meters ((optional) float) – A double representing the accuracy of geolocation data in meters.

attribute_map = {'accuracy_in_meters': 'accuracyInMeters', 'latitude_in_degrees': 'latitudeInDegrees', 'longitude_in_degrees': 'longitudeInDegrees'}

deserialized_types = {'accuracy_in_meters': 'float', 'latitude_in_degrees': 'float', 'longitude_in_degrees': 'float'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.geolocation.geolocation_interface module

class ask_sdk_model.interfaces.geolocation.geolocation_interface.GeolocationInterface

Bases: object

attribute_map = {}

deserialized_types = {}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.geolocation.geolocation_state module

class ask_sdk_model.interfaces.geolocation.geolocation_state.GeolocationState(timestamp=None, coordinate=None, altitude=None, heading=None, speed=None, location_services=None)

Bases: object

Parameters:

• timestamp ((optional) str) – Specifies the time when the geolocation data was last collected on the device.
• coordinate ((optional) ask_sdk_model.interfaces.geolocation.coordinate.Coordinate) –
• altitude ((optional) ask_sdk_model.interfaces.geolocation.altitude.Altitude) –
• heading ((optional) ask_sdk_model.interfaces.geolocation.heading.Heading) –
• speed ((optional) ask_sdk_model.interfaces.geolocation.speed.Speed) –
• location_services ((optional) ask_sdk_model.interfaces.geolocation.location_services.LocationServices) –

attribute_map = {'altitude': 'altitude', 'coordinate': 'coordinate', 'heading': 'heading', 'location_services': 'locationServices', 'speed': 'speed', 'timestamp': 'timestamp'}

deserialized_types = {'altitude': 'ask_sdk_model.interfaces.geolocation.altitude.Altitude', 'coordinate': 'ask_sdk_model.interfaces.geolocation.coordinate.Coordinate', 'heading': 'ask_sdk_model.interfaces.geolocation.heading.Heading', 'location_services': 'ask_sdk_model.interfaces.geolocation.location_services.LocationServices', 'speed': 'ask_sdk_model.interfaces.geolocation.speed.Speed', 'timestamp': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.geolocation.heading module

class ask_sdk_model.interfaces.geolocation.heading.Heading(direction_in_degrees=None, accuracy_in_degrees=None)

Bases: object

An object containing the heading direction information of the device.

Parameters:

• direction_in_degrees ((optional) float) – A double representing the direction of the device in degrees.
• accuracy_in_degrees ((optional) float) – A double representing the accuracy of the heading measurement in degrees.

attribute_map = {'accuracy_in_degrees': 'accuracyInDegrees', 'direction_in_degrees': 'directionInDegrees'}

deserialized_types = {'accuracy_in_degrees': 'float', 'direction_in_degrees': 'float'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.geolocation.location_services module

class ask_sdk_model.interfaces.geolocation.location_services.LocationServices(status=None, access=None)

Bases: object

An object containing status and access.

Parameters:

• status ((optional) ask_sdk_model.interfaces.geolocation.status.Status) – A string representing the status of whether location services is currently running or not on the host OS of device.
• access ((optional) ask_sdk_model.interfaces.geolocation.access.Access) – A string representing if Alexa has access to location services running on the hostOS of device.

attribute_map = {'access': 'access', 'status': 'status'}

deserialized_types = {'access': 'ask_sdk_model.interfaces.geolocation.access.Access', 'status': 'ask_sdk_model.interfaces.geolocation.status.Status'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.geolocation.speed module

class ask_sdk_model.interfaces.geolocation.speed.Speed(speed_in_meters_per_second=None, accuracy_in_meters_per_second=None)

Bases: object

An object containing the speed information of the device.

Parameters:

• speed_in_meters_per_second ((optional) float) – A double representing the speed of the device in meters.
• accuracy_in_meters_per_second ((optional) float) – A double representing the accuracy of the speed measurement in meters.

attribute_map = {'accuracy_in_meters_per_second': 'accuracyInMetersPerSecond', 'speed_in_meters_per_second': 'speedInMetersPerSecond'}

deserialized_types = {'accuracy_in_meters_per_second': 'float', 'speed_in_meters_per_second': 'float'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.geolocation.status module

class ask_sdk_model.interfaces.geolocation.status.Status

Bases: enum.Enum

A string representing the status of whether location services is currently running or not on the host OS of device.

Allowed enum values: [RUNNING, STOPPED]

RUNNING = 'RUNNING'

STOPPED = 'STOPPED'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.messaging 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_sdk_model.interfaces.messaging.message_received_request module

class ask_sdk_model.interfaces.messaging.message_received_request.MessageReceivedRequest(request_id=None, timestamp=None, locale=None, message=None)

Bases: ask_sdk_model.request.Request

Parameters:

• request_id ((optional) str) – Represents the unique identifier for the specific request.
• timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
• locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
• message ((optional) dict(str, object)) –

attribute_map = {'locale': 'locale', 'message': 'message', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp'}

deserialized_types = {'locale': 'str', 'message': 'dict(str, object)', 'object_type': 'str', 'request_id': 'str', 'timestamp': 'datetime'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.monetization package

Subpackages

ask_sdk_model.interfaces.monetization.v1 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_sdk_model.interfaces.monetization.v1.in_skill_product module

class ask_sdk_model.interfaces.monetization.v1.in_skill_product.InSkillProduct(product_id=None)

Bases: object

Entity to define In Skill Product over which actions will be performed.

Parameters:product_id ((optional) str) – The product ID of In Skill Product.

attribute_map = {'product_id': 'productId'}

deserialized_types = {'product_id': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.monetization.v1.purchase_result module

class ask_sdk_model.interfaces.monetization.v1.purchase_result.PurchaseResult

Bases: enum.Enum

Response from purchase directives: * ACCEPTED - User have accepted the offer to purchase the product * DECLINED - User have declined the offer to purchase the product * NOT_ENTITLED - User tries to cancel/return a product he/she is not entitled to. * ALREADY_PURCHASED - User has already purchased the product * ERROR - An internal error occurred

Allowed enum values: [ACCEPTED, DECLINED, NOT_ENTITLED, ERROR, ALREADY_PURCHASED]

ACCEPTED = 'ACCEPTED'

ALREADY_PURCHASED = 'ALREADY_PURCHASED'

DECLINED = 'DECLINED'

ERROR = 'ERROR'

NOT_ENTITLED = 'NOT_ENTITLED'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.navigation package

Subpackages

ask_sdk_model.interfaces.navigation.assistance 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_sdk_model.interfaces.navigation.assistance.announce_road_regulation module

class ask_sdk_model.interfaces.navigation.assistance.announce_road_regulation.AnnounceRoadRegulation

Bases: ask_sdk_model.directive.Directive

New directive that Alexa will send to navigation engine to query road regulations about the road segments that the user is on.

attribute_map = {'object_type': 'type'}

deserialized_types = {'object_type': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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_sdk_model.interfaces.navigation.navigation_interface module

class ask_sdk_model.interfaces.navigation.navigation_interface.NavigationInterface

Bases: object

attribute_map = {}

deserialized_types = {}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.playbackcontroller 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_sdk_model.interfaces.playbackcontroller.next_command_issued_request module

class ask_sdk_model.interfaces.playbackcontroller.next_command_issued_request.NextCommandIssuedRequest(request_id=None, timestamp=None, locale=None)

Bases: ask_sdk_model.request.Request

Parameters:

• request_id ((optional) str) – Represents the unique identifier for the specific request.
• timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
• locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.

attribute_map = {'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp'}

deserialized_types = {'locale': 'str', 'object_type': 'str', 'request_id': 'str', 'timestamp': 'datetime'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.playbackcontroller.pause_command_issued_request module

class ask_sdk_model.interfaces.playbackcontroller.pause_command_issued_request.PauseCommandIssuedRequest(request_id=None, timestamp=None, locale=None)

Bases: ask_sdk_model.request.Request

Parameters:

• request_id ((optional) str) – Represents the unique identifier for the specific request.
• timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
• locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.

attribute_map = {'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp'}

deserialized_types = {'locale': 'str', 'object_type': 'str', 'request_id': 'str', 'timestamp': 'datetime'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.playbackcontroller.play_command_issued_request module

class ask_sdk_model.interfaces.playbackcontroller.play_command_issued_request.PlayCommandIssuedRequest(request_id=None, timestamp=None, locale=None)

Bases: ask_sdk_model.request.Request

Parameters:

• request_id ((optional) str) – Represents the unique identifier for the specific request.
• timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
• locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.

attribute_map = {'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp'}

deserialized_types = {'locale': 'str', 'object_type': 'str', 'request_id': 'str', 'timestamp': 'datetime'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.playbackcontroller.previous_command_issued_request module

class ask_sdk_model.interfaces.playbackcontroller.previous_command_issued_request.PreviousCommandIssuedRequest(request_id=None, timestamp=None, locale=None)

Bases: ask_sdk_model.request.Request

Parameters:

• request_id ((optional) str) – Represents the unique identifier for the specific request.
• timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
• locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.

attribute_map = {'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp'}

deserialized_types = {'locale': 'str', 'object_type': 'str', 'request_id': 'str', 'timestamp': 'datetime'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.system 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_sdk_model.interfaces.system.error module

class ask_sdk_model.interfaces.system.error.Error(object_type=None, message=None)

Bases: object

Parameters:

• object_type ((optional) ask_sdk_model.interfaces.system.error_type.ErrorType) –
• message ((optional) str) –

attribute_map = {'message': 'message', 'object_type': 'type'}

deserialized_types = {'message': 'str', 'object_type': 'ask_sdk_model.interfaces.system.error_type.ErrorType'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.system.error_cause module

class ask_sdk_model.interfaces.system.error_cause.ErrorCause(request_id=None)

Bases: object

Parameters:request_id ((optional) str) –

attribute_map = {'request_id': 'requestId'}

deserialized_types = {'request_id': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.system.error_type module

class ask_sdk_model.interfaces.system.error_type.ErrorType

Bases: enum.Enum

Allowed enum values: [INVALID_RESPONSE, DEVICE_COMMUNICATION_ERROR, INTERNAL_SERVICE_ERROR]

DEVICE_COMMUNICATION_ERROR = 'DEVICE_COMMUNICATION_ERROR'

INTERNAL_SERVICE_ERROR = 'INTERNAL_SERVICE_ERROR'

INVALID_RESPONSE = 'INVALID_RESPONSE'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.system.exception_encountered_request module

class ask_sdk_model.interfaces.system.exception_encountered_request.ExceptionEncounteredRequest(request_id=None, timestamp=None, locale=None, error=None, cause=None)

Bases: ask_sdk_model.request.Request

Parameters:

• request_id ((optional) str) – Represents the unique identifier for the specific request.
• timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
• locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
• error ((optional) ask_sdk_model.interfaces.system.error.Error) –
• cause ((optional) ask_sdk_model.interfaces.system.error_cause.ErrorCause) –

attribute_map = {'cause': 'cause', 'error': 'error', 'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp'}

deserialized_types = {'cause': 'ask_sdk_model.interfaces.system.error_cause.ErrorCause', 'error': 'ask_sdk_model.interfaces.system.error.Error', 'locale': 'str', 'object_type': 'str', 'request_id': 'str', 'timestamp': 'datetime'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.system.system_state module

class ask_sdk_model.interfaces.system.system_state.SystemState(application=None, user=None, device=None, person=None, api_endpoint=None, api_access_token=None)

Bases: object

Parameters:

• application ((optional) ask_sdk_model.application.Application) –
• user ((optional) ask_sdk_model.user.User) –
• device ((optional) ask_sdk_model.device.Device) –
• person ((optional) ask_sdk_model.person.Person) –
• api_endpoint ((optional) str) – A string that references the correct base URI to refer to by region, for use with APIs such as the Device Location API and Progressive Response API.
• api_access_token ((optional) str) – A bearer token string that can be used by the skill (during the skill session) to access Alexa APIs resources of the registered Alexa customer and/or person who is making the request. This token encapsulates the permissions authorized under the registered Alexa account and device, and (optionally) the recognized person. Some resources, such as name or email, require explicit customer consent.&quot;

attribute_map = {'api_access_token': 'apiAccessToken', 'api_endpoint': 'apiEndpoint', 'application': 'application', 'device': 'device', 'person': 'person', 'user': 'user'}

deserialized_types = {'api_access_token': 'str', 'api_endpoint': 'str', 'application': 'ask_sdk_model.application.Application', 'device': 'ask_sdk_model.device.Device', 'person': 'ask_sdk_model.person.Person', 'user': 'ask_sdk_model.user.User'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.tasks 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_sdk_model.interfaces.tasks.complete_task_directive module

class ask_sdk_model.interfaces.tasks.complete_task_directive.CompleteTaskDirective(status=None, result=None)

Bases: ask_sdk_model.directive.Directive

This is the directive that a skill can send as part of their response to a session based request. The response will contain the result of the task that the skill is launched for.

Parameters:

• status ((optional) ask_sdk_model.status.Status) –
• result ((optional) dict(str, object)) – This is an object sent to the requester.

attribute_map = {'object_type': 'type', 'result': 'result', 'status': 'status'}

deserialized_types = {'object_type': 'str', 'result': 'dict(str, object)', 'status': 'ask_sdk_model.status.Status'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.videoapp 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_sdk_model.interfaces.videoapp.launch_directive module

class ask_sdk_model.interfaces.videoapp.launch_directive.LaunchDirective(video_item=None)

Bases: ask_sdk_model.directive.Directive

Parameters:video_item ((optional) ask_sdk_model.interfaces.videoapp.video_item.VideoItem) –

attribute_map = {'object_type': 'type', 'video_item': 'videoItem'}

deserialized_types = {'object_type': 'str', 'video_item': 'ask_sdk_model.interfaces.videoapp.video_item.VideoItem'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.videoapp.metadata module

class ask_sdk_model.interfaces.videoapp.metadata.Metadata(title=None, subtitle=None)

Bases: object

Parameters:

• title ((optional) str) –
• subtitle ((optional) str) –

attribute_map = {'subtitle': 'subtitle', 'title': 'title'}

deserialized_types = {'subtitle': 'str', 'title': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.videoapp.video_app_interface module

class ask_sdk_model.interfaces.videoapp.video_app_interface.VideoAppInterface

Bases: object

attribute_map = {}

deserialized_types = {}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.videoapp.video_item module

class ask_sdk_model.interfaces.videoapp.video_item.VideoItem(source=None, metadata=None)

Bases: object

Parameters:

• source ((optional) str) –
• metadata ((optional) ask_sdk_model.interfaces.videoapp.metadata.Metadata) –

attribute_map = {'metadata': 'metadata', 'source': 'source'}

deserialized_types = {'metadata': 'ask_sdk_model.interfaces.videoapp.metadata.Metadata', 'source': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.viewport package

Subpackages

ask_sdk_model.interfaces.viewport.apl 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_sdk_model.interfaces.viewport.apl.current_configuration module

class ask_sdk_model.interfaces.viewport.apl.current_configuration.CurrentConfiguration(mode=None, video=None, size=None, dialog=None)

Bases: object

The viewport configuration at the time of the request.

Parameters:

• mode ((optional) ask_sdk_model.interfaces.viewport.mode.Mode) –
• video ((optional) ask_sdk_model.interfaces.viewport.viewport_video.ViewportVideo) –
• size ((optional) ask_sdk_model.interfaces.viewport.size.viewport_size.ViewportSize) –
• dialog ((optional) ask_sdk_model.interfaces.viewport.dialog.Dialog) –

attribute_map = {'dialog': 'dialog', 'mode': 'mode', 'size': 'size', 'video': 'video'}

deserialized_types = {'dialog': 'ask_sdk_model.interfaces.viewport.dialog.Dialog', 'mode': 'ask_sdk_model.interfaces.viewport.mode.Mode', 'size': 'ask_sdk_model.interfaces.viewport.size.viewport_size.ViewportSize', 'video': 'ask_sdk_model.interfaces.viewport.viewport_video.ViewportVideo'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.viewport.apl.viewport_configuration module

class ask_sdk_model.interfaces.viewport.apl.viewport_configuration.ViewportConfiguration(current=None)

Bases: object

Parameters:current ((optional) ask_sdk_model.interfaces.viewport.apl.current_configuration.CurrentConfiguration) –

attribute_map = {'current': 'current'}

deserialized_types = {'current': 'ask_sdk_model.interfaces.viewport.apl.current_configuration.CurrentConfiguration'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.viewport.aplt 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_sdk_model.interfaces.viewport.aplt.character_format module

class ask_sdk_model.interfaces.viewport.aplt.character_format.CharacterFormat

Bases: enum.Enum

Supported character set on a text display * &#x60;SEVEN_SEGMENT&#x60; - 7-segment display

Allowed enum values: [SEVEN_SEGMENT]

SEVEN_SEGMENT = 'SEVEN_SEGMENT'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.viewport.aplt.inter_segment module

class ask_sdk_model.interfaces.viewport.aplt.inter_segment.InterSegment(x=None, y=None, characters=None)

Bases: object

Parameters:

• x ((optional) int) – horizontal position (0-based index) in characters
• y ((optional) int) – vertical position (0-based index) in rows
• characters ((optional) str) – list of characters that can be rendered

attribute_map = {'characters': 'characters', 'x': 'x', 'y': 'y'}

deserialized_types = {'characters': 'str', 'x': 'int', 'y': 'int'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.viewport.aplt.viewport_profile module

class ask_sdk_model.interfaces.viewport.aplt.viewport_profile.ViewportProfile

Bases: enum.Enum

name of viewport's profile

Allowed enum values: [FOUR_CHARACTER_CLOCK]

FOUR_CHARACTER_CLOCK = 'FOUR_CHARACTER_CLOCK'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.viewport.size 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_sdk_model.interfaces.viewport.size.continuous_viewport_size module

class ask_sdk_model.interfaces.viewport.size.continuous_viewport_size.ContinuousViewportSize(min_pixel_width=None, min_pixel_height=None, max_pixel_width=None, max_pixel_height=None)

Bases: ask_sdk_model.interfaces.viewport.size.viewport_size.ViewportSize

Defines range of size with minimum and maximum values for with and height.

Parameters:

• min_pixel_width ((optional) int) –
• min_pixel_height ((optional) int) –
• max_pixel_width ((optional) int) –
• max_pixel_height ((optional) int) –

attribute_map = {'max_pixel_height': 'maxPixelHeight', 'max_pixel_width': 'maxPixelWidth', 'min_pixel_height': 'minPixelHeight', 'min_pixel_width': 'minPixelWidth', 'object_type': 'type'}

deserialized_types = {'max_pixel_height': 'int', 'max_pixel_width': 'int', 'min_pixel_height': 'int', 'min_pixel_width': 'int', 'object_type': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.viewport.size.discrete_viewport_size module

class ask_sdk_model.interfaces.viewport.size.discrete_viewport_size.DiscreteViewportSize(pixel_width=None, pixel_height=None)

Bases: ask_sdk_model.interfaces.viewport.size.viewport_size.ViewportSize

Defines a fixed size of viewport.

Parameters:

• pixel_width ((optional) int) –
• pixel_height ((optional) int) –

attribute_map = {'object_type': 'type', 'pixel_height': 'pixelHeight', 'pixel_width': 'pixelWidth'}

deserialized_types = {'object_type': 'str', 'pixel_height': 'int', 'pixel_width': 'int'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.viewport.size.viewport_size module

class ask_sdk_model.interfaces.viewport.size.viewport_size.ViewportSize(object_type=None)

Bases: object

Information regarding the range of sizes for a configuration.

Parameters:object_type ((optional) str) – name of the type of a viewport object

Note

This is an abstract class. Use the following mapping, to figure out the model class to be instantiated, that sets type variable.

CONTINUOUS: ask_sdk_model.interfaces.viewport.size.continuous_viewport_size.ContinuousViewportSize,

DISCRETE: ask_sdk_model.interfaces.viewport.size.discrete_viewport_size.DiscreteViewportSize

attribute_map = {'object_type': 'type'}

deserialized_types = {'object_type': 'str'}

discriminator_value_class_map = {'CONTINUOUS': 'ask_sdk_model.interfaces.viewport.size.continuous_viewport_size.ContinuousViewportSize', 'DISCRETE': 'ask_sdk_model.interfaces.viewport.size.discrete_viewport_size.DiscreteViewportSize'}

classmethod get_real_child_model(data)

Returns the real base class specified by the discriminator

json_discriminator_key = 'type'

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.viewport.video 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_sdk_model.interfaces.viewport.video.codecs module

class ask_sdk_model.interfaces.viewport.video.codecs.Codecs

Bases: enum.Enum

A named bundle of codecs which are available for playing video on the viewport.

Allowed enum values: [H_264_41, H_264_42]

H_264_41 = 'H_264_41'

H_264_42 = 'H_264_42'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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_sdk_model.interfaces.viewport.apl_viewport_state module

class ask_sdk_model.interfaces.viewport.apl_viewport_state.APLViewportState(id=None, shape=None, dpi=None, presentation_type=None, can_rotate=None, configuration=None)

Bases: ask_sdk_model.interfaces.viewport.typed_viewport_state.TypedViewportState

This object contains the characteristics related to the APL device's viewport.

Parameters:

• id ((optional) str) – unique identifier of a viewport object
• shape ((optional) ask_sdk_model.interfaces.viewport.shape.Shape) –
• dpi ((optional) float) – The pixel density of the viewport.
• presentation_type ((optional) ask_sdk_model.interfaces.viewport.presentation_type.PresentationType) –
• can_rotate ((optional) bool) – Indicates if the viewport can be rotated through 90 degrees.
• configuration ((optional) ask_sdk_model.interfaces.viewport.apl.viewport_configuration.ViewportConfiguration) –

attribute_map = {'can_rotate': 'canRotate', 'configuration': 'configuration', 'dpi': 'dpi', 'id': 'id', 'object_type': 'type', 'presentation_type': 'presentationType', 'shape': 'shape'}

deserialized_types = {'can_rotate': 'bool', 'configuration': 'ask_sdk_model.interfaces.viewport.apl.viewport_configuration.ViewportConfiguration', 'dpi': 'float', 'id': 'str', 'object_type': 'str', 'presentation_type': 'ask_sdk_model.interfaces.viewport.presentation_type.PresentationType', 'shape': 'ask_sdk_model.interfaces.viewport.shape.Shape'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.viewport.aplt_viewport_state module

class ask_sdk_model.interfaces.viewport.aplt_viewport_state.APLTViewportState(id=None, supported_profiles=None, line_length=None, line_count=None, character_format=None, inter_segments=None)

Bases: ask_sdk_model.interfaces.viewport.typed_viewport_state.TypedViewportState

This object contains the characteristics related to the text device's viewport.

Parameters:

• id ((optional) str) – unique identifier of a viewport object
• supported_profiles ((optional) list[ask_sdk_model.interfaces.viewport.aplt.viewport_profile.ViewportProfile]) – List of profiles that device can emulate.
• line_length ((optional) int) – horizontal dimension of text display in number of characters
• line_count ((optional) int) – vertical dimension of text display in number of rows
• character_format ((optional) ask_sdk_model.interfaces.viewport.aplt.character_format.CharacterFormat) –
• inter_segments ((optional) list[ask_sdk_model.interfaces.viewport.aplt.inter_segment.InterSegment]) – list of inter-segment objects

attribute_map = {'character_format': 'characterFormat', 'id': 'id', 'inter_segments': 'interSegments', 'line_count': 'lineCount', 'line_length': 'lineLength', 'object_type': 'type', 'supported_profiles': 'supportedProfiles'}

deserialized_types = {'character_format': 'ask_sdk_model.interfaces.viewport.aplt.character_format.CharacterFormat', 'id': 'str', 'inter_segments': 'list[ask_sdk_model.interfaces.viewport.aplt.inter_segment.InterSegment]', 'line_count': 'int', 'line_length': 'int', 'object_type': 'str', 'supported_profiles': 'list[ask_sdk_model.interfaces.viewport.aplt.viewport_profile.ViewportProfile]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.viewport.experience module

class ask_sdk_model.interfaces.viewport.experience.Experience(arc_minute_width=None, arc_minute_height=None, can_rotate=None, can_resize=None)

Bases: object

An experience represents a viewing mode used to interact with the device.

Parameters:

• arc_minute_width ((optional) float) – The number of horizontal arc minutes the viewport occupies in the user's visual field when viewed within this experience.
• arc_minute_height ((optional) float) – The number of vertical arc minutes the viewport occupies in the user's visual field when viewed within this experience.
• can_rotate ((optional) bool) – Indicates if the viewport can be rotated through 90 degrees.
• can_resize ((optional) bool) – Indicates if the viewport can be resized, limiting the area which can be used to render the APL response.

attribute_map = {'arc_minute_height': 'arcMinuteHeight', 'arc_minute_width': 'arcMinuteWidth', 'can_resize': 'canResize', 'can_rotate': 'canRotate'}

deserialized_types = {'arc_minute_height': 'float', 'arc_minute_width': 'float', 'can_resize': 'bool', 'can_rotate': 'bool'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.viewport.keyboard module

class ask_sdk_model.interfaces.viewport.keyboard.Keyboard

Bases: enum.Enum

Represents a physical button input mechanism which can be used to interact with elements shown on the viewport.

Allowed enum values: [DIRECTION]

DIRECTION = 'DIRECTION'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.viewport.mode module

class ask_sdk_model.interfaces.viewport.mode.Mode

Bases: enum.Enum

The expected use case of the device's viewport, encapsulating the available input mechanisms and user viewing distance.

Allowed enum values: [AUTO, HUB, MOBILE, PC, TV]

AUTO = 'AUTO'

HUB = 'HUB'

MOBILE = 'MOBILE'

PC = 'PC'

TV = 'TV'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.viewport.presentation_type module

class ask_sdk_model.interfaces.viewport.presentation_type.PresentationType

Bases: enum.Enum

Type of the viewport. * &#x60;STANDARD&#x60; Indicates that this viewport occupies an exclusive area of the screen. * &#x60;OVERLAY&#x60; Indicates that the viewport is an overlay, sharing the screen with other experiences.

Allowed enum values: [STANDARD, OVERLAY]

OVERLAY = 'OVERLAY'

STANDARD = 'STANDARD'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.viewport.shape module

class ask_sdk_model.interfaces.viewport.shape.Shape

Bases: enum.Enum

The shape of the viewport.

Allowed enum values: [RECTANGLE, ROUND]

RECTANGLE = 'RECTANGLE'

ROUND = 'ROUND'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.viewport.touch module

class ask_sdk_model.interfaces.viewport.touch.Touch

Bases: enum.Enum

Represents a type of touch input suppported by the device.

Allowed enum values: [SINGLE]

SINGLE = 'SINGLE'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.viewport.typed_viewport_state module

class ask_sdk_model.interfaces.viewport.typed_viewport_state.TypedViewportState(id=None, object_type=None)

Bases: object

Parameters:

• id ((optional) str) – unique identifier of a viewport object
• object_type ((optional) str) – name of the type of a viewport object

Note

This is an abstract class. Use the following mapping, to figure out the model class to be instantiated, that sets type variable.

APL: ask_sdk_model.interfaces.viewport.apl_viewport_state.APLViewportState,

APLT: ask_sdk_model.interfaces.viewport.aplt_viewport_state.APLTViewportState

attribute_map = {'id': 'id', 'object_type': 'type'}

deserialized_types = {'id': 'str', 'object_type': 'str'}

discriminator_value_class_map = {'APL': 'ask_sdk_model.interfaces.viewport.apl_viewport_state.APLViewportState', 'APLT': 'ask_sdk_model.interfaces.viewport.aplt_viewport_state.APLTViewportState'}

classmethod get_real_child_model(data)

Returns the real base class specified by the discriminator

json_discriminator_key = 'type'

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.viewport.viewport_state module

class ask_sdk_model.interfaces.viewport.viewport_state.ViewportState(experiences=None, mode=None, shape=None, pixel_width=None, pixel_height=None, dpi=None, current_pixel_width=None, current_pixel_height=None, touch=None, keyboard=None, video=None)

Bases: object

This object contains the characteristics related to the device's viewport.

Parameters:

• experiences ((optional) list[ask_sdk_model.interfaces.viewport.experience.Experience]) – The experiences supported by the device, in descending order of arcMinuteWidth and arcMinuteHeight.
• mode ((optional) ask_sdk_model.interfaces.viewport.mode.Mode) –
• shape ((optional) ask_sdk_model.interfaces.viewport.shape.Shape) –
• pixel_width ((optional) float) – The number of pixels present in the viewport at its maximum width.
• pixel_height ((optional) float) – The number of pixels present in the viewport at its maximum height.
• dpi ((optional) float) – The pixel density of the viewport.
• current_pixel_width ((optional) float) – The number of horizontal pixels in the viewport that are currently available for Alexa to render an experience.
• current_pixel_height ((optional) float) – The number of vertical pixels in the viewport that are currently available for Alexa to render an experience.
• touch ((optional) list[ask_sdk_model.interfaces.viewport.touch.Touch]) – The types of touch supported by the device. An empty array indicates no touch support.
• keyboard ((optional) list[ask_sdk_model.interfaces.viewport.keyboard.Keyboard]) – The physical button input mechanisms supported by the device. An empty array indicates physical button input is unsupported.
• video ((optional) ask_sdk_model.interfaces.viewport.viewport_state_video.Video) –

attribute_map = {'current_pixel_height': 'currentPixelHeight', 'current_pixel_width': 'currentPixelWidth', 'dpi': 'dpi', 'experiences': 'experiences', 'keyboard': 'keyboard', 'mode': 'mode', 'pixel_height': 'pixelHeight', 'pixel_width': 'pixelWidth', 'shape': 'shape', 'touch': 'touch', 'video': 'video'}

deserialized_types = {'current_pixel_height': 'float', 'current_pixel_width': 'float', 'dpi': 'float', 'experiences': 'list[ask_sdk_model.interfaces.viewport.experience.Experience]', 'keyboard': 'list[ask_sdk_model.interfaces.viewport.keyboard.Keyboard]', 'mode': 'ask_sdk_model.interfaces.viewport.mode.Mode', 'pixel_height': 'float', 'pixel_width': 'float', 'shape': 'ask_sdk_model.interfaces.viewport.shape.Shape', 'touch': 'list[ask_sdk_model.interfaces.viewport.touch.Touch]', 'video': 'ask_sdk_model.interfaces.viewport.viewport_state_video.Video'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.viewport.viewport_state_video module

class ask_sdk_model.interfaces.viewport.viewport_state_video.Video(codecs=None)

Bases: object

Details of the technologies which are available for playing video on the device.

Parameters:codecs ((optional) list[ask_sdk_model.interfaces.viewport.video.codecs.Codecs]) – Codecs which are available for playing video on the device.

attribute_map = {'codecs': 'codecs'}

deserialized_types = {'codecs': 'list[ask_sdk_model.interfaces.viewport.video.codecs.Codecs]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.viewport.viewport_video module

class ask_sdk_model.interfaces.viewport.viewport_video.ViewportVideo(codecs=None)

Bases: object

Details of the technologies which are available for playing video on the device.

Parameters:codecs ((optional) list[ask_sdk_model.interfaces.viewport.video.codecs.Codecs]) – Codecs which are available for playing video on the device.

attribute_map = {'codecs': 'codecs'}

deserialized_types = {'codecs': 'list[ask_sdk_model.interfaces.viewport.video.codecs.Codecs]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services package

Subpackages

ask_sdk_model.services.device_address 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_sdk_model.services.device_address.address module

class ask_sdk_model.services.device_address.address.Address(address_line1=None, address_line2=None, address_line3=None, country_code=None, state_or_region=None, city=None, district_or_county=None, postal_code=None)

Bases: object

Represents the full address response from the service.

Parameters:

• address_line1 ((optional) str) –
• address_line2 ((optional) str) –
• address_line3 ((optional) str) –
• country_code ((optional) str) –
• state_or_region ((optional) str) –
• city ((optional) str) –
• district_or_county ((optional) str) –
• postal_code ((optional) str) –

attribute_map = {'address_line1': 'addressLine1', 'address_line2': 'addressLine2', 'address_line3': 'addressLine3', 'city': 'city', 'country_code': 'countryCode', 'district_or_county': 'districtOrCounty', 'postal_code': 'postalCode', 'state_or_region': 'stateOrRegion'}

deserialized_types = {'address_line1': 'str', 'address_line2': 'str', 'address_line3': 'str', 'city': 'str', 'country_code': 'str', 'district_or_county': 'str', 'postal_code': 'str', 'state_or_region': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.device_address.device_address_service_client module

class ask_sdk_model.services.device_address.device_address_service_client.DeviceAddressServiceClient(api_configuration, custom_user_agent=None)

Bases: ask_sdk_model.services.base_service_client.BaseServiceClient

ServiceClient for calling the DeviceAddressService APIs.

Parameters:api_configuration (ask_sdk_model.services.api_configuration.ApiConfiguration) – Instance of ApiConfiguration

get_country_and_postal_code(device_id, **kwargs)

Gets the country and postal code of a device

Parameters:

• device_id (str) – (required) The device Id for which to get the country and postal code
• 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, ShortAddress, Error]

get_full_address(device_id, **kwargs)

Gets the address of a device

Parameters:

• device_id (str) – (required) The device Id for which to get the address
• 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, Address, Error]

ask_sdk_model.services.device_address.error module

class ask_sdk_model.services.device_address.error.Error(object_type=None, message=None)

Bases: object

Parameters:

• object_type ((optional) str) – The corresponding type of the http status code being returned.
• message ((optional) str) – A human readable description of error.

attribute_map = {'message': 'message', 'object_type': 'type'}

deserialized_types = {'message': 'str', 'object_type': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.device_address.short_address module

class ask_sdk_model.services.device_address.short_address.ShortAddress(country_code=None, postal_code=None)

Bases: object

Parameters:

• country_code ((optional) str) –
• postal_code ((optional) str) –

attribute_map = {'country_code': 'countryCode', 'postal_code': 'postalCode'}

deserialized_types = {'country_code': 'str', 'postal_code': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.directive 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_sdk_model.services.directive.directive module

class ask_sdk_model.services.directive.directive.Directive(object_type=None)

Bases: object

Parameters:object_type ((optional) str) –

Note

This is an abstract class. Use the following mapping, to figure out the model class to be instantiated, that sets type variable.

VoicePlayer.Speak: ask_sdk_model.services.directive.speak_directive.SpeakDirective

attribute_map = {'object_type': 'type'}

deserialized_types = {'object_type': 'str'}

discriminator_value_class_map = {'VoicePlayer.Speak': 'ask_sdk_model.services.directive.speak_directive.SpeakDirective'}

classmethod get_real_child_model(data)

Returns the real base class specified by the discriminator

json_discriminator_key = 'type'

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.directive.directive_service_client module

class ask_sdk_model.services.directive.directive_service_client.DirectiveServiceClient(api_configuration, custom_user_agent=None)

Bases: ask_sdk_model.services.base_service_client.BaseServiceClient

ServiceClient for calling the DirectiveService APIs.

Parameters:api_configuration (ask_sdk_model.services.api_configuration.ApiConfiguration) – Instance of ApiConfiguration

enqueue(send_directive_request, **kwargs)

Send directives to Alexa.

Parameters:

• send_directive_request (ask_sdk_model.services.directive.send_directive_request.SendDirectiveRequest) – (required) Represents the request object to send in the payload.
• 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, Error]

ask_sdk_model.services.directive.error module

class ask_sdk_model.services.directive.error.Error(code=None, message=None)

Bases: object

Parameters:

• code ((optional) int) – error code to find more information in developer.amazon.com.
• message ((optional) str) – Readable description of error.

attribute_map = {'code': 'code', 'message': 'message'}

deserialized_types = {'code': 'int', 'message': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.directive.header module

class ask_sdk_model.services.directive.header.Header(request_id=None)

Bases: object

Parameters:request_id ((optional) str) – This represents the current requestId for what the skill/speechlet was invoked.

attribute_map = {'request_id': 'requestId'}

deserialized_types = {'request_id': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.directive.send_directive_request module

class ask_sdk_model.services.directive.send_directive_request.SendDirectiveRequest(header=None, directive=None)

Bases: object

Send Directive Request payload.

Parameters:

• header ((optional) ask_sdk_model.services.directive.header.Header) – contains the header attributes of the send directive request.
• directive ((optional) ask_sdk_model.services.directive.directive.Directive) – Directive Content.

attribute_map = {'directive': 'directive', 'header': 'header'}

deserialized_types = {'directive': 'ask_sdk_model.services.directive.directive.Directive', 'header': 'ask_sdk_model.services.directive.header.Header'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.directive.speak_directive module

class ask_sdk_model.services.directive.speak_directive.SpeakDirective(speech=None)

Bases: ask_sdk_model.services.directive.directive.Directive

Parameters:speech ((optional) str) –

attribute_map = {'object_type': 'type', 'speech': 'speech'}

deserialized_types = {'object_type': 'str', 'speech': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.endpoint_enumeration 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_sdk_model.services.endpoint_enumeration.endpoint_capability module

class ask_sdk_model.services.endpoint_enumeration.endpoint_capability.EndpointCapability(interface=None, object_type=None, version=None)

Bases: object

Parameters:

• interface ((optional) str) – The name of the capability interface.
• object_type ((optional) str) – The type of capability interface. This is usually AlexaInterface.
• version ((optional) str) – The version of the capability interface that the endpoint supports.

attribute_map = {'interface': 'interface', 'object_type': 'type', 'version': 'version'}

deserialized_types = {'interface': 'str', 'object_type': 'str', 'version': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.endpoint_enumeration.endpoint_enumeration_response module

class ask_sdk_model.services.endpoint_enumeration.endpoint_enumeration_response.EndpointEnumerationResponse(endpoints=None)

Bases: object

Contains the list of endpoints.

Parameters:endpoints ((optional) list[ask_sdk_model.services.endpoint_enumeration.endpoint_info.EndpointInfo]) – The list of endpoints.

attribute_map = {'endpoints': 'endpoints'}

deserialized_types = {'endpoints': 'list[ask_sdk_model.services.endpoint_enumeration.endpoint_info.EndpointInfo]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.endpoint_enumeration.endpoint_enumeration_service_client module

class ask_sdk_model.services.endpoint_enumeration.endpoint_enumeration_service_client.EndpointEnumerationServiceClient(api_configuration, custom_user_agent=None)

Bases: ask_sdk_model.services.base_service_client.BaseServiceClient

ServiceClient for calling the EndpointEnumerationService APIs.

Parameters:api_configuration (ask_sdk_model.services.api_configuration.ApiConfiguration) – Instance of ApiConfiguration

get_endpoints(**kwargs)

This API is invoked by the skill to retrieve endpoints connected to the Echo device.

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, EndpointEnumerationResponse, Error]

ask_sdk_model.services.endpoint_enumeration.endpoint_info module

class ask_sdk_model.services.endpoint_enumeration.endpoint_info.EndpointInfo(endpoint_id=None, friendly_name=None, capabilities=None)

Bases: object

Contains the list of connected endpoints and their declared capabilities.

Parameters:

• endpoint_id ((optional) str) – A unique identifier for the endpoint.
• friendly_name ((optional) str) – The name of the endpoint. Because this name might be changed by the user or the platform, it might be different than the Bluetooth friendly name.
• capabilities ((optional) list[ask_sdk_model.services.endpoint_enumeration.endpoint_capability.EndpointCapability]) – The list of endpoint capabilities.

attribute_map = {'capabilities': 'capabilities', 'endpoint_id': 'endpointId', 'friendly_name': 'friendlyName'}

deserialized_types = {'capabilities': 'list[ask_sdk_model.services.endpoint_enumeration.endpoint_capability.EndpointCapability]', 'endpoint_id': 'str', 'friendly_name': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.endpoint_enumeration.error module

class ask_sdk_model.services.endpoint_enumeration.error.Error(code=None, message=None)

Bases: object

Parameters:

• code ((optional) str) – Domain specific error code.
• message ((optional) str) – Detailed error message.

attribute_map = {'code': 'code', 'message': 'message'}

deserialized_types = {'code': 'str', 'message': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.gadget_controller 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_sdk_model.services.gadget_controller.animation_step module

class ask_sdk_model.services.gadget_controller.animation_step.AnimationStep(duration_ms=None, color=None, blend=None)

Bases: object

Parameters:

• duration_ms ((optional) int) – The duration in milliseconds to render this step.
• color ((optional) str) – The color to render specified in RGB hexadecimal values. There are a number of Node.js libraries available for working with color.
• blend ((optional) bool) – A boolean that indicates whether to interpolate from the previous color into this one over the course of this directive's durationMs.

attribute_map = {'blend': 'blend', 'color': 'color', 'duration_ms': 'durationMs'}

deserialized_types = {'blend': 'bool', 'color': 'str', 'duration_ms': 'int'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.gadget_controller.light_animation module

class ask_sdk_model.services.gadget_controller.light_animation.LightAnimation(repeat=None, target_lights=None, sequence=None)

Bases: object

Parameters:

• repeat ((optional) int) – The number of times to play this animation.
• target_lights ((optional) list[str]) – An array of strings that represent the light addresses on the target gadgets that this animation will be applied to. Because the Echo Button has one light only, use [&quot;1&quot;] to signify that this animation should be sent to light one.
• sequence ((optional) list[ask_sdk_model.services.gadget_controller.animation_step.AnimationStep]) – The animation steps to render in order. The maximum number of steps that you can define is 38. The minimum is 0. Each step must have the following fields, all of which are required.

attribute_map = {'repeat': 'repeat', 'sequence': 'sequence', 'target_lights': 'targetLights'}

deserialized_types = {'repeat': 'int', 'sequence': 'list[ask_sdk_model.services.gadget_controller.animation_step.AnimationStep]', 'target_lights': 'list[str]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.gadget_controller.set_light_parameters module

class ask_sdk_model.services.gadget_controller.set_light_parameters.SetLightParameters(trigger_event=None, trigger_event_time_ms=None, animations=None)

Bases: object

Arguments that pertain to animating the buttons.

Parameters:

• trigger_event ((optional) ask_sdk_model.services.gadget_controller.trigger_event_type.TriggerEventType) –
• trigger_event_time_ms ((optional) int) –
• animations ((optional) list[ask_sdk_model.services.gadget_controller.light_animation.LightAnimation]) –

attribute_map = {'animations': 'animations', 'trigger_event': 'triggerEvent', 'trigger_event_time_ms': 'triggerEventTimeMs'}

deserialized_types = {'animations': 'list[ask_sdk_model.services.gadget_controller.light_animation.LightAnimation]', 'trigger_event': 'ask_sdk_model.services.gadget_controller.trigger_event_type.TriggerEventType', 'trigger_event_time_ms': 'int'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.gadget_controller.trigger_event_type module

class ask_sdk_model.services.gadget_controller.trigger_event_type.TriggerEventType

Bases: enum.Enum

The action that triggers the animation. Possible values are as follows * &#x60;buttonDown&#x60; - Play the animation when the button is pressed. * &#x60;buttonUp&#x60; - Play the animation when the button is released. * &#x60;none&#x60; - Play the animation as soon as it arrives.

Allowed enum values: [buttonDown, buttonUp, none]

buttonDown = 'buttonDown'

buttonUp = 'buttonUp'

none = 'none'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.game_engine 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_sdk_model.services.game_engine.deviation_recognizer module

class ask_sdk_model.services.game_engine.deviation_recognizer.DeviationRecognizer(recognizer=None)

Bases: ask_sdk_model.services.game_engine.recognizer.Recognizer

The deviation recognizer returns true when another specified recognizer reports that the player has deviated from its expected pattern.

Parameters:recognizer ((optional) str) – The name of the recognizer that defines a pattern that must not be deviated from.

attribute_map = {'object_type': 'type', 'recognizer': 'recognizer'}

deserialized_types = {'object_type': 'str', 'recognizer': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.game_engine.event module

class ask_sdk_model.services.game_engine.event.Event(should_end_input_handler=None, meets=None, fails=None, reports=None, maximum_invocations=None, trigger_time_milliseconds=None)

Bases: object

The events object is where you define the conditions that must be met for your skill to be notified of Echo Button input. You must define at least one event.

Parameters:

• should_end_input_handler ((optional) bool) – Whether the Input Handler should end after this event fires. If true, the Input Handler will stop and no further events will be sent to your skill unless you call StartInputHandler again.
• meets ((optional) list[str]) –
• fails ((optional) list[str]) –
• reports ((optional) ask_sdk_model.services.game_engine.event_reporting_type.EventReportingType) –
• maximum_invocations ((optional) int) – Enables you to limit the number of times that the skill is notified about the same event during the course of the Input Handler. The default value is 1. This property is mutually exclusive with triggerTimeMilliseconds.
• trigger_time_milliseconds ((optional) int) – Adds a time constraint to the event. Instead of being considered whenever a raw button event occurs, an event that has this parameter will only be considered once at triggerTimeMilliseconds after the Input Handler has started. Because a time-triggered event can only fire once, the maximumInvocations value is ignored. Omit this property entirely if you do not want to time-constrain the event.

attribute_map = {'fails': 'fails', 'maximum_invocations': 'maximumInvocations', 'meets': 'meets', 'reports': 'reports', 'should_end_input_handler': 'shouldEndInputHandler', 'trigger_time_milliseconds': 'triggerTimeMilliseconds'}

deserialized_types = {'fails': 'list[str]', 'maximum_invocations': 'int', 'meets': 'list[str]', 'reports': 'ask_sdk_model.services.game_engine.event_reporting_type.EventReportingType', 'should_end_input_handler': 'bool', 'trigger_time_milliseconds': 'int'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.game_engine.event_reporting_type module

class ask_sdk_model.services.game_engine.event_reporting_type.EventReportingType

Bases: enum.Enum

Specifies what raw button presses to put in the inputEvents field of the event. * history - All button presses since this Input Handler was started. * matches - Just the button presses that contributed to this event (that is, were in the recognizers). To receive no raw button presses, leave this array empty or do not specify it at all.

Allowed enum values: [history, matches]

history = 'history'

matches = 'matches'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.game_engine.input_event module

class ask_sdk_model.services.game_engine.input_event.InputEvent(gadget_id=None, timestamp=None, action=None, color=None, feature=None)

Bases: object

Parameters:

• gadget_id ((optional) str) – The identifier of the Echo Button in question. It matches the gadgetId that you will have discovered in roll call.
• timestamp ((optional) str) – The event's original moment of occurrence, in ISO format.
• action ((optional) ask_sdk_model.services.game_engine.input_event_action_type.InputEventActionType) –
• color ((optional) str) – The hexadecimal RGB values of the button LED at the time of the event.
• feature ((optional) str) – For gadgets with multiple features, this is the feature that the event represents. Echo Buttons have one feature only, so this is always &#x60;press&#x60;.

attribute_map = {'action': 'action', 'color': 'color', 'feature': 'feature', 'gadget_id': 'gadgetId', 'timestamp': 'timestamp'}

deserialized_types = {'action': 'ask_sdk_model.services.game_engine.input_event_action_type.InputEventActionType', 'color': 'str', 'feature': 'str', 'gadget_id': 'str', 'timestamp': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.game_engine.input_event_action_type module

class ask_sdk_model.services.game_engine.input_event_action_type.InputEventActionType

Bases: enum.Enum

Either &quot;down&quot; for a button pressed or &quot;up&quot; for a button released.

Allowed enum values: [down, up]

down = 'down'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

up = 'up'

ask_sdk_model.services.game_engine.input_handler_event module

class ask_sdk_model.services.game_engine.input_handler_event.InputHandlerEvent(name=None, input_events=None)

Bases: object

Parameters:

• name ((optional) str) – The name of the event as you defined it in your GameEngine.StartInputHandler directive.
• input_events ((optional) list[ask_sdk_model.services.game_engine.input_event.InputEvent]) – A chronologically ordered report of the raw Button Events that contributed to this Input Handler Event.

attribute_map = {'input_events': 'inputEvents', 'name': 'name'}

deserialized_types = {'input_events': 'list[ask_sdk_model.services.game_engine.input_event.InputEvent]', 'name': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.game_engine.pattern module

class ask_sdk_model.services.game_engine.pattern.Pattern(gadget_ids=None, colors=None, action=None, repeat=None)

Bases: object

An object that provides all of the events that need to occur, in a specific order, for this recognizer to be true. Omitting any parameters in this object means &quot;match anything&quot;.

Parameters:

• gadget_ids ((optional) list[str]) – A whitelist of gadgetIds that are eligible for this match.
• colors ((optional) list[str]) – A whitelist of colors that are eligible for this match.
• action ((optional) ask_sdk_model.services.game_engine.input_event_action_type.InputEventActionType) –
• repeat ((optional) int) – The number of times that the specified action must occur to be considered complete.

attribute_map = {'action': 'action', 'colors': 'colors', 'gadget_ids': 'gadgetIds', 'repeat': 'repeat'}

deserialized_types = {'action': 'ask_sdk_model.services.game_engine.input_event_action_type.InputEventActionType', 'colors': 'list[str]', 'gadget_ids': 'list[str]', 'repeat': 'int'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.game_engine.pattern_recognizer module

class ask_sdk_model.services.game_engine.pattern_recognizer.PatternRecognizer(anchor=None, fuzzy=None, gadget_ids=None, actions=None, pattern=None)

Bases: ask_sdk_model.services.game_engine.recognizer.Recognizer

This recognizer is true when all of the specified events have occurred in the specified order.

Parameters:

• anchor ((optional) ask_sdk_model.services.game_engine.pattern_recognizer_anchor_type.PatternRecognizerAnchorType) –
• fuzzy ((optional) bool) – When true, the recognizer will ignore additional events that occur between the events specified in the pattern.
• gadget_ids ((optional) list[str]) – The gadget IDs of the Echo Buttons to consider in this pattern recognizer.
• actions ((optional) list[str]) – The actions to consider in this pattern recognizer. All other actions will be ignored.
• pattern ((optional) list[ask_sdk_model.services.game_engine.pattern.Pattern]) – An object that provides all of the events that need to occur, in a specific order, for this recognizer to be true. Omitting any parameters in this object means &quot;match anything&quot;.

attribute_map = {'actions': 'actions', 'anchor': 'anchor', 'fuzzy': 'fuzzy', 'gadget_ids': 'gadgetIds', 'object_type': 'type', 'pattern': 'pattern'}

deserialized_types = {'actions': 'list[str]', 'anchor': 'ask_sdk_model.services.game_engine.pattern_recognizer_anchor_type.PatternRecognizerAnchorType', 'fuzzy': 'bool', 'gadget_ids': 'list[str]', 'object_type': 'str', 'pattern': 'list[ask_sdk_model.services.game_engine.pattern.Pattern]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.game_engine.pattern_recognizer_anchor_type module

class ask_sdk_model.services.game_engine.pattern_recognizer_anchor_type.PatternRecognizerAnchorType

Bases: enum.Enum

Where the pattern must appear in the history of this input handler. * &#x60;start&#x60; - (Default) The first event in the pattern must be the first event in the history of raw Echo Button events. * &#x60;end&#x60; - The last event in the pattern must be the last event in the history of raw Echo Button events. * &#x60;anywhere&#x60; - The pattern may appear anywhere in the history of raw Echo Button events.

Allowed enum values: [start, end, anywhere]

anywhere = 'anywhere'

end = 'end'

start = 'start'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.game_engine.progress_recognizer module

class ask_sdk_model.services.game_engine.progress_recognizer.ProgressRecognizer(recognizer=None, completion=None)

Bases: ask_sdk_model.services.game_engine.recognizer.Recognizer

This recognizer consults another recognizer for the degree of completion, and is true if that degree is above the specified threshold. The completion parameter is specified as a decimal percentage.

Parameters:

• recognizer ((optional) str) – The name of a recognizer for which to track the progress.
• completion ((optional) float) – The completion threshold, as a decimal percentage, of the specified recognizer before which this recognizer becomes true.

attribute_map = {'completion': 'completion', 'object_type': 'type', 'recognizer': 'recognizer'}

deserialized_types = {'completion': 'float', 'object_type': 'str', 'recognizer': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.game_engine.recognizer module

class ask_sdk_model.services.game_engine.recognizer.Recognizer(object_type=None)

Bases: object

Recognizers are conditions that, at any moment, are either true or false, based on all the raw button events that the Input Handler has received in the time elapsed since the Input Handler session started.

Parameters:object_type ((optional) str) –

Note

This is an abstract class. Use the following mapping, to figure out the model class to be instantiated, that sets type variable.

match: ask_sdk_model.services.game_engine.pattern_recognizer.PatternRecognizer,

deviation: ask_sdk_model.services.game_engine.deviation_recognizer.DeviationRecognizer,

progress: ask_sdk_model.services.game_engine.progress_recognizer.ProgressRecognizer

attribute_map = {'object_type': 'type'}

deserialized_types = {'object_type': 'str'}

discriminator_value_class_map = {'deviation': 'ask_sdk_model.services.game_engine.deviation_recognizer.DeviationRecognizer', 'match': 'ask_sdk_model.services.game_engine.pattern_recognizer.PatternRecognizer', 'progress': 'ask_sdk_model.services.game_engine.progress_recognizer.ProgressRecognizer'}

classmethod get_real_child_model(data)

Returns the real base class specified by the discriminator

json_discriminator_key = 'type'

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.list_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_sdk_model.services.list_management.alexa_list module

class ask_sdk_model.services.list_management.alexa_list.AlexaList(list_id=None, name=None, state=None, version=None, items=None, links=None)

Bases: object

Parameters:

• list_id ((optional) str) –
• name ((optional) str) –
• state ((optional) ask_sdk_model.services.list_management.list_state.ListState) –
• version ((optional) int) –
• items ((optional) list[ask_sdk_model.services.list_management.alexa_list_item.AlexaListItem]) –
• links ((optional) ask_sdk_model.services.list_management.links.Links) –

attribute_map = {'items': 'items', 'links': 'links', 'list_id': 'listId', 'name': 'name', 'state': 'state', 'version': 'version'}

deserialized_types = {'items': 'list[ask_sdk_model.services.list_management.alexa_list_item.AlexaListItem]', 'links': 'ask_sdk_model.services.list_management.links.Links', 'list_id': 'str', 'name': 'str', 'state': 'ask_sdk_model.services.list_management.list_state.ListState', 'version': 'int'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.list_management.alexa_list_item module

class ask_sdk_model.services.list_management.alexa_list_item.AlexaListItem(id=None, version=None, value=None, status=None, created_time=None, updated_time=None, href=None)

Bases: object

Parameters:

• id ((optional) str) –
• version ((optional) int) –
• value ((optional) str) –
• status ((optional) ask_sdk_model.services.list_management.list_item_state.ListItemState) –
• created_time ((optional) str) –
• updated_time ((optional) str) –
• href ((optional) str) – URL to retrieve the item from.

attribute_map = {'created_time': 'createdTime', 'href': 'href', 'id': 'id', 'status': 'status', 'updated_time': 'updatedTime', 'value': 'value', 'version': 'version'}

deserialized_types = {'created_time': 'str', 'href': 'str', 'id': 'str', 'status': 'ask_sdk_model.services.list_management.list_item_state.ListItemState', 'updated_time': 'str', 'value': 'str', 'version': 'int'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.list_management.alexa_list_metadata module

class ask_sdk_model.services.list_management.alexa_list_metadata.AlexaListMetadata(list_id=None, name=None, state=None, version=None, status_map=None)

Bases: object

Parameters:

• list_id ((optional) str) –
• name ((optional) str) –
• state ((optional) ask_sdk_model.services.list_management.list_state.ListState) –
• version ((optional) int) –
• status_map ((optional) list[ask_sdk_model.services.list_management.status.Status]) –

attribute_map = {'list_id': 'listId', 'name': 'name', 'state': 'state', 'status_map': 'statusMap', 'version': 'version'}

deserialized_types = {'list_id': 'str', 'name': 'str', 'state': 'ask_sdk_model.services.list_management.list_state.ListState', 'status_map': 'list[ask_sdk_model.services.list_management.status.Status]', 'version': 'int'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.list_management.alexa_lists_metadata module

class ask_sdk_model.services.list_management.alexa_lists_metadata.AlexaListsMetadata(lists=None)

Bases: object

Parameters:lists ((optional) list[ask_sdk_model.services.list_management.alexa_list_metadata.AlexaListMetadata]) –

attribute_map = {'lists': 'lists'}

deserialized_types = {'lists': 'list[ask_sdk_model.services.list_management.alexa_list_metadata.AlexaListMetadata]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.list_management.create_list_item_request module

class ask_sdk_model.services.list_management.create_list_item_request.CreateListItemRequest(value=None, status=None)

Bases: object

Parameters:

• value ((optional) str) –
• status ((optional) ask_sdk_model.services.list_management.list_item_state.ListItemState) –

attribute_map = {'status': 'status', 'value': 'value'}

deserialized_types = {'status': 'ask_sdk_model.services.list_management.list_item_state.ListItemState', 'value': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.list_management.create_list_request module

class ask_sdk_model.services.list_management.create_list_request.CreateListRequest(name=None, state=None)

Bases: object

Parameters:

• name ((optional) str) –
• state ((optional) ask_sdk_model.services.list_management.list_state.ListState) –

attribute_map = {'name': 'name', 'state': 'state'}

deserialized_types = {'name': 'str', 'state': 'ask_sdk_model.services.list_management.list_state.ListState'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.list_management.error module

class ask_sdk_model.services.list_management.error.Error(object_type=None, message=None)

Bases: object

Parameters:

• object_type ((optional) str) –
• message ((optional) str) –

attribute_map = {'message': 'message', 'object_type': 'type'}

deserialized_types = {'message': 'str', 'object_type': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.list_management.forbidden_error module

class ask_sdk_model.services.list_management.forbidden_error.ForbiddenError(message=None)

Bases: object

Parameters:message ((optional) str) –

attribute_map = {'message': 'Message'}

deserialized_types = {'message': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.list_management.links module

class ask_sdk_model.services.list_management.links.Links(next=None)

Bases: object

Parameters:next ((optional) str) –

attribute_map = {'next': 'next'}

deserialized_types = {'next': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.list_management.list_body module

class ask_sdk_model.services.list_management.list_body.ListBody(list_id=None)

Bases: object

Parameters:list_id ((optional) str) –

attribute_map = {'list_id': 'listId'}

deserialized_types = {'list_id': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.list_management.list_created_event_request module

class ask_sdk_model.services.list_management.list_created_event_request.ListCreatedEventRequest(request_id=None, timestamp=None, locale=None, body=None, event_creation_time=None, event_publishing_time=None)

Bases: ask_sdk_model.request.Request

Parameters:

• request_id ((optional) str) – Represents the unique identifier for the specific request.
• timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
• locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
• body ((optional) ask_sdk_model.services.list_management.list_body.ListBody) –
• event_creation_time ((optional) datetime) –
• event_publishing_time ((optional) datetime) –

attribute_map = {'body': 'body', 'event_creation_time': 'eventCreationTime', 'event_publishing_time': 'eventPublishingTime', 'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp'}

deserialized_types = {'body': 'ask_sdk_model.services.list_management.list_body.ListBody', 'event_creation_time': 'datetime', 'event_publishing_time': 'datetime', 'locale': 'str', 'object_type': 'str', 'request_id': 'str', 'timestamp': 'datetime'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.list_management.list_deleted_event_request module

class ask_sdk_model.services.list_management.list_deleted_event_request.ListDeletedEventRequest(request_id=None, timestamp=None, locale=None, body=None, event_creation_time=None, event_publishing_time=None)

Bases: ask_sdk_model.request.Request

Parameters:

• request_id ((optional) str) – Represents the unique identifier for the specific request.
• timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
• locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
• body ((optional) ask_sdk_model.services.list_management.list_body.ListBody) –
• event_creation_time ((optional) datetime) –
• event_publishing_time ((optional) datetime) –

attribute_map = {'body': 'body', 'event_creation_time': 'eventCreationTime', 'event_publishing_time': 'eventPublishingTime', 'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp'}

deserialized_types = {'body': 'ask_sdk_model.services.list_management.list_body.ListBody', 'event_creation_time': 'datetime', 'event_publishing_time': 'datetime', 'locale': 'str', 'object_type': 'str', 'request_id': 'str', 'timestamp': 'datetime'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.list_management.list_item_body module

class ask_sdk_model.services.list_management.list_item_body.ListItemBody(list_id=None, list_item_ids=None)

Bases: object

Parameters:

• list_id ((optional) str) –
• list_item_ids ((optional) list[str]) –

attribute_map = {'list_id': 'listId', 'list_item_ids': 'listItemIds'}

deserialized_types = {'list_id': 'str', 'list_item_ids': 'list[str]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.list_management.list_item_state module

class ask_sdk_model.services.list_management.list_item_state.ListItemState

Bases: enum.Enum

Allowed enum values: [active, completed]

active = 'active'

completed = 'completed'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.list_management.list_items_created_event_request module

class ask_sdk_model.services.list_management.list_items_created_event_request.ListItemsCreatedEventRequest(request_id=None, timestamp=None, locale=None, body=None, event_creation_time=None, event_publishing_time=None)

Bases: ask_sdk_model.request.Request

Parameters:

• request_id ((optional) str) – Represents the unique identifier for the specific request.
• timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
• locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
• body ((optional) ask_sdk_model.services.list_management.list_item_body.ListItemBody) –
• event_creation_time ((optional) datetime) –
• event_publishing_time ((optional) datetime) –

attribute_map = {'body': 'body', 'event_creation_time': 'eventCreationTime', 'event_publishing_time': 'eventPublishingTime', 'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp'}

deserialized_types = {'body': 'ask_sdk_model.services.list_management.list_item_body.ListItemBody', 'event_creation_time': 'datetime', 'event_publishing_time': 'datetime', 'locale': 'str', 'object_type': 'str', 'request_id': 'str', 'timestamp': 'datetime'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.list_management.list_items_deleted_event_request module

class ask_sdk_model.services.list_management.list_items_deleted_event_request.ListItemsDeletedEventRequest(request_id=None, timestamp=None, locale=None, body=None, event_creation_time=None, event_publishing_time=None)

Bases: ask_sdk_model.request.Request

Parameters:

• request_id ((optional) str) – Represents the unique identifier for the specific request.
• timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
• locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
• body ((optional) ask_sdk_model.services.list_management.list_item_body.ListItemBody) –
• event_creation_time ((optional) datetime) –
• event_publishing_time ((optional) datetime) –

attribute_map = {'body': 'body', 'event_creation_time': 'eventCreationTime', 'event_publishing_time': 'eventPublishingTime', 'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp'}

deserialized_types = {'body': 'ask_sdk_model.services.list_management.list_item_body.ListItemBody', 'event_creation_time': 'datetime', 'event_publishing_time': 'datetime', 'locale': 'str', 'object_type': 'str', 'request_id': 'str', 'timestamp': 'datetime'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.list_management.list_items_updated_event_request module

class ask_sdk_model.services.list_management.list_items_updated_event_request.ListItemsUpdatedEventRequest(request_id=None, timestamp=None, locale=None, body=None, event_creation_time=None, event_publishing_time=None)

Bases: ask_sdk_model.request.Request

Parameters:

• request_id ((optional) str) – Represents the unique identifier for the specific request.
• timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
• locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
• body ((optional) ask_sdk_model.services.list_management.list_item_body.ListItemBody) –
• event_creation_time ((optional) datetime) –
• event_publishing_time ((optional) datetime) –

attribute_map = {'body': 'body', 'event_creation_time': 'eventCreationTime', 'event_publishing_time': 'eventPublishingTime', 'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp'}

deserialized_types = {'body': 'ask_sdk_model.services.list_management.list_item_body.ListItemBody', 'event_creation_time': 'datetime', 'event_publishing_time': 'datetime', 'locale': 'str', 'object_type': 'str', 'request_id': 'str', 'timestamp': 'datetime'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.list_management.list_management_service_client module

class ask_sdk_model.services.list_management.list_management_service_client.ListManagementServiceClient(api_configuration, custom_user_agent=None)

Bases: ask_sdk_model.services.base_service_client.BaseServiceClient

ServiceClient for calling the ListManagementService APIs.

Parameters:api_configuration (ask_sdk_model.services.api_configuration.ApiConfiguration) – Instance of ApiConfiguration

create_list(create_list_request, **kwargs)

This API creates a custom list. The new list name must be different than any existing list name.

Parameters:

• create_list_request (ask_sdk_model.services.list_management.create_list_request.CreateListRequest) – (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, Error, AlexaListMetadata]

create_list_item(list_id, create_list_item_request, **kwargs)

This API creates an item in an active list or in a default list.

Parameters:

• list_id (str) – (required) The customer’s listId retrieved from a getListsMetadata call.
• create_list_item_request (ask_sdk_model.services.list_management.create_list_item_request.CreateListItemRequest) – (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, AlexaListItem, Error]

delete_list(list_id, **kwargs)

This API deletes a customer custom list.

Parameters:

• list_id (str) – (required) Value of the customer’s listId retrieved from a getListsMetadata call
• 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, Error]

delete_list_item(list_id, item_id, **kwargs)

This API deletes an item in the specified list.

Parameters:

• list_id (str) – (required) The customer’s listId is retrieved from a getListsMetadata call.
• item_id (str) – (required) The customer’s itemId is retrieved from a GetList call.
• 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, Error]

get_list(list_id, status, **kwargs)

Retrieves the list metadata including the items in the list with requested status.

Parameters:

• list_id (str) – (required) Retrieved from a call to GetListsMetadata to specify the listId in the request path.
• status (str) – (required) Specify the status of the list.
• 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, AlexaList, Error]

get_list_item(list_id, item_id, **kwargs)

This API can be used to retrieve single item with in any list by listId and itemId. This API can read list items from an archived list. Attempting to read list items from a deleted list return an ObjectNotFound 404 error.

Parameters:

• list_id (str) – (required) Retrieved from a call to getListsMetadata
• item_id (str) – (required) itemId within a list is retrieved from a getList call
• 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, AlexaListItem, Error]

get_lists_metadata(**kwargs)

Retrieves the metadata for all customer lists, including the customer’s default lists.

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, ForbiddenError, Error, AlexaListsMetadata]

update_list(list_id, update_list_request, **kwargs)

This API updates a custom list. Only the list name or state can be updated. An Alexa customer can turn an archived list into an active one.

Parameters:

• list_id (str) – (required) Value of the customer’s listId retrieved from a getListsMetadata call.
• update_list_request (ask_sdk_model.services.list_management.update_list_request.UpdateListRequest) – (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, Error, AlexaListMetadata]

update_list_item(list_id, item_id, update_list_item_request, **kwargs)

API used to update an item value or item status.

Parameters:

• list_id (str) – (required) Customer’s listId
• item_id (str) – (required) itemId to be updated in the list
• update_list_item_request (ask_sdk_model.services.list_management.update_list_item_request.UpdateListItemRequest) – (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, AlexaListItem, Error]

ask_sdk_model.services.list_management.list_state module

class ask_sdk_model.services.list_management.list_state.ListState

Bases: enum.Enum

Allowed enum values: [active, archived]

active = 'active'

archived = 'archived'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.list_management.list_updated_event_request module

class ask_sdk_model.services.list_management.list_updated_event_request.ListUpdatedEventRequest(request_id=None, timestamp=None, locale=None, body=None, event_creation_time=None, event_publishing_time=None)

Bases: ask_sdk_model.request.Request

Parameters:

• request_id ((optional) str) – Represents the unique identifier for the specific request.
• timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
• locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
• body ((optional) ask_sdk_model.services.list_management.list_body.ListBody) –
• event_creation_time ((optional) datetime) –
• event_publishing_time ((optional) datetime) –

attribute_map = {'body': 'body', 'event_creation_time': 'eventCreationTime', 'event_publishing_time': 'eventPublishingTime', 'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp'}

deserialized_types = {'body': 'ask_sdk_model.services.list_management.list_body.ListBody', 'event_creation_time': 'datetime', 'event_publishing_time': 'datetime', 'locale': 'str', 'object_type': 'str', 'request_id': 'str', 'timestamp': 'datetime'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.list_management.status module

class ask_sdk_model.services.list_management.status.Status(url=None, status=None)

Bases: object

Parameters:

• url ((optional) str) –
• status ((optional) ask_sdk_model.services.list_management.list_item_state.ListItemState) –

attribute_map = {'status': 'status', 'url': 'url'}

deserialized_types = {'status': 'ask_sdk_model.services.list_management.list_item_state.ListItemState', 'url': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.list_management.update_list_item_request module

class ask_sdk_model.services.list_management.update_list_item_request.UpdateListItemRequest(value=None, status=None, version=None)

Bases: object

Parameters:

• value ((optional) str) – New item value
• status ((optional) ask_sdk_model.services.list_management.list_item_state.ListItemState) – Item Status
• version ((optional) int) – Item version when it was read.

attribute_map = {'status': 'status', 'value': 'value', 'version': 'version'}

deserialized_types = {'status': 'ask_sdk_model.services.list_management.list_item_state.ListItemState', 'value': 'str', 'version': 'int'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.list_management.update_list_request module

class ask_sdk_model.services.list_management.update_list_request.UpdateListRequest(name=None, state=None, version=None)

Bases: object

Parameters:

• name ((optional) str) –
• state ((optional) ask_sdk_model.services.list_management.list_state.ListState) –
• version ((optional) int) –

attribute_map = {'name': 'name', 'state': 'state', 'version': 'version'}

deserialized_types = {'name': 'str', 'state': 'ask_sdk_model.services.list_management.list_state.ListState', 'version': 'int'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.lwa 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_sdk_model.services.lwa.access_token module

class ask_sdk_model.services.lwa.access_token.AccessToken(token=None, expiry=None)

Bases: object

Represents the access token provided by LWA (Login With Amazon).

This is a wrapper class over ask_sdk_model.services.lwa.access_token_response.AccessTokenResponse that retrieves and stores the access token, the expiry time from LWA response.

Parameters:

• token (str) – access token from LWA
• expiry (datetime) – exact timestamp in UTC datetime, which is the expiry time for this access token. This is set as the combined datetime of current system time when the LWA response is received and the expiry time in seconds, provided in the LWA response.

ask_sdk_model.services.lwa.access_token_request module

class ask_sdk_model.services.lwa.access_token_request.AccessTokenRequest(client_id=None, client_secret=None, scope=None, refresh_token=None)

Bases: object

Request for retrieving an access token from LWA.

Parameters:

• client_id (str) – The ClientId value from developer console
• client_secret (str) – The ClientSecret value from developer console
• scope (str) – The required scope for which the access token is requested for
• refresh_token (str) – Client refresh_token required to get access token for API calls.

attribute_map = {'client_id': 'client_id', 'client_secret': 'client_secret', 'refresh_token': 'refresh_token', 'scope': 'scope'}

deserialized_types = {'client_id': 'str', 'client_secret': 'str', 'refresh_token': 'str', 'scope': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.lwa.access_token_response module

class ask_sdk_model.services.lwa.access_token_response.AccessTokenResponse(access_token=None, expires_in=None, scope=None, token_type=None)

Bases: object

LWA response for retrieving an access token.

Parameters:

• access_token (str) – The access token from LWA
• expires_in (int) – The duration in seconds of the access token lifetime
• scope (str) – The scope specified in the access token request
• token_type (str) – The type of token issued

attribute_map = {'access_token': 'access_token', 'expires_in': 'expires_in', 'scope': 'scope', 'token_type': 'token_type'}

deserialized_types = {'access_token': 'str', 'expires_in': 'int', 'scope': 'str', 'token_type': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.lwa.error module

class ask_sdk_model.services.lwa.error.Error(error_description=None, error_type=None)

Bases: object

Error from LWA Client request.

Parameters:

• error_description ((optional) str) – Description of the error
• error_type ((optional) str) – Type of error

attribute_map = {'error_description': 'error_description', 'error_type': 'error'}

deserialized_types = {'error_description': 'str', 'error_type': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.lwa.lwa_client module

class ask_sdk_model.services.lwa.lwa_client.LwaClient(api_configuration, authentication_configuration, grant_type=None)

Bases: ask_sdk_model.services.base_service_client.BaseServiceClient

Client to call Login with Amazon (LWA) to retrieve access tokens.

Parameters:

• api_configuration (ask_sdk_model.services.api_configuration.ApiConfiguration) – ApiConfiguration instance with valid Serializer and ApiClient. The authorization value and api endpoint is not used by the LWA Client.
• authentication_configuration (ask_sdk_model.services.authentication_configuration.AuthenticationConfiguration) – AuthenticationConfiguration instance with valid client id and client secret, for making LWA calls.
• grant_type ((optional) str) – The grant type which is used to make the HTTP request.

Raises:

ValueError if authentication configuration is not provided.

CLIENT_CREDENTIALS_GRANT_TYPE = 'client_credentials'

DEFAULT_LWA_ENDPOINT = 'https://api.amazon.com'

EXPIRY_OFFSET_IN_MILLIS = 60000

LWA_CREDENTIALS_GRANT_TYPE = 'refresh_token'

REFRESH_ACCESS_TOKEN = 'refresh_access_token'

get_access_token_for_scope(scope)

Retrieve access token for given scope.

Parameters:scope (str) – Target scope for the access token Returns:Retrieved access token for the given scope and configured client id, client secret Return type:str Raises:ValueError is no scope is passed.

get_access_token_from_refresh_token()

Retrieve access token for Skill Management API calls.

Returns:Retrieved access token for the given refresh_token and configured client id, client secret Return type:str

ask_sdk_model.services.monetization 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_sdk_model.services.monetization.entitled_state module

class ask_sdk_model.services.monetization.entitled_state.EntitledState

Bases: enum.Enum

State determining if the user is entitled to the product. Note - Any new values introduced later should be treated as 'NOT_ENTITLED'. * 'ENTITLED' - The user is entitled to the product. * 'NOT_ENTITLED' - The user is not entitled to the product.

Allowed enum values: [ENTITLED, NOT_ENTITLED]

ENTITLED = 'ENTITLED'

NOT_ENTITLED = 'NOT_ENTITLED'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.monetization.entitlement_reason module

class ask_sdk_model.services.monetization.entitlement_reason.EntitlementReason

Bases: enum.Enum

Reason for the entitlement status. * 'PURCHASED' - The user is entitled to the product because they purchased it. * 'NOT_PURCHASED' - The user is not entitled to the product because they have not purchased it. * 'AUTO_ENTITLED' - The user is auto entitled to the product because they have subscribed to a broader service.

Allowed enum values: [PURCHASED, NOT_PURCHASED, AUTO_ENTITLED]

AUTO_ENTITLED = 'AUTO_ENTITLED'

NOT_PURCHASED = 'NOT_PURCHASED'

PURCHASED = 'PURCHASED'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.monetization.error module

class ask_sdk_model.services.monetization.error.Error(message=None)

Bases: object

Describes error detail

Parameters:message ((optional) str) – Readable description of error

attribute_map = {'message': 'message'}

deserialized_types = {'message': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.monetization.in_skill_product module

class ask_sdk_model.services.monetization.in_skill_product.InSkillProduct(product_id=None, reference_name=None, name=None, object_type=None, summary=None, purchasable=None, entitled=None, entitlement_reason=None, active_entitlement_count=None, purchase_mode=None)

Bases: object

Parameters:

• product_id ((optional) str) – Product Id
• reference_name ((optional) str) – Developer selected in-skill product name. This is for developer reference only.
• name ((optional) str) – Name of the product in the language from the &quot;Accept-Language&quot; header
• object_type ((optional) ask_sdk_model.services.monetization.product_type.ProductType) –
• summary ((optional) str) – Product summary in the language from the &quot;Accept-Language&quot; header
• purchasable ((optional) ask_sdk_model.services.monetization.purchasable_state.PurchasableState) –
• entitled ((optional) ask_sdk_model.services.monetization.entitled_state.EntitledState) –
• entitlement_reason ((optional) ask_sdk_model.services.monetization.entitlement_reason.EntitlementReason) –
• active_entitlement_count ((optional) int) – Total active purchases of the product made by the user. Note - For ENTITLEMENT and SUBSCRIPTION product types, the value is either zero(NOT_ENTITLED) or one(ENTITLED). For CONSUMABLE product type the value is zero or more, as CONSUMABLE can be re-purchased.
• purchase_mode ((optional) ask_sdk_model.services.monetization.purchase_mode.PurchaseMode) –

attribute_map = {'active_entitlement_count': 'activeEntitlementCount', 'entitled': 'entitled', 'entitlement_reason': 'entitlementReason', 'name': 'name', 'object_type': 'type', 'product_id': 'productId', 'purchasable': 'purchasable', 'purchase_mode': 'purchaseMode', 'reference_name': 'referenceName', 'summary': 'summary'}

deserialized_types = {'active_entitlement_count': 'int', 'entitled': 'ask_sdk_model.services.monetization.entitled_state.EntitledState', 'entitlement_reason': 'ask_sdk_model.services.monetization.entitlement_reason.EntitlementReason', 'name': 'str', 'object_type': 'ask_sdk_model.services.monetization.product_type.ProductType', 'product_id': 'str', 'purchasable': 'ask_sdk_model.services.monetization.purchasable_state.PurchasableState', 'purchase_mode': 'ask_sdk_model.services.monetization.purchase_mode.PurchaseMode', 'reference_name': 'str', 'summary': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.monetization.in_skill_product_transactions_response module

class ask_sdk_model.services.monetization.in_skill_product_transactions_response.InSkillProductTransactionsResponse(results=None, metadata=None)

Bases: object

Parameters:

• results ((optional) list[ask_sdk_model.services.monetization.transactions.Transactions]) – List of transactions of in skill products purchases
• metadata ((optional) ask_sdk_model.services.monetization.metadata.Metadata) –

attribute_map = {'metadata': 'metadata', 'results': 'results'}

deserialized_types = {'metadata': 'ask_sdk_model.services.monetization.metadata.Metadata', 'results': 'list[ask_sdk_model.services.monetization.transactions.Transactions]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.monetization.in_skill_products_response module

class ask_sdk_model.services.monetization.in_skill_products_response.InSkillProductsResponse(in_skill_products=None, is_truncated=None, next_token=None)

Bases: object

Parameters:

• in_skill_products ((optional) list[ask_sdk_model.services.monetization.in_skill_product.InSkillProduct]) – List of In-Skill Products
• is_truncated ((optional) bool) –
• next_token ((optional) str) –

attribute_map = {'in_skill_products': 'inSkillProducts', 'is_truncated': 'isTruncated', 'next_token': 'nextToken'}

deserialized_types = {'in_skill_products': 'list[ask_sdk_model.services.monetization.in_skill_product.InSkillProduct]', 'is_truncated': 'bool', 'next_token': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.monetization.metadata module

class ask_sdk_model.services.monetization.metadata.Metadata(result_set=None)

Bases: object

Parameters:result_set ((optional) ask_sdk_model.services.monetization.result_set.ResultSet) –

attribute_map = {'result_set': 'resultSet'}

deserialized_types = {'result_set': 'ask_sdk_model.services.monetization.result_set.ResultSet'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.monetization.monetization_service_client module

class ask_sdk_model.services.monetization.monetization_service_client.MonetizationServiceClient(api_configuration, custom_user_agent=None)

Bases: ask_sdk_model.services.base_service_client.BaseServiceClient

ServiceClient for calling the MonetizationService APIs.

Parameters:api_configuration (ask_sdk_model.services.api_configuration.ApiConfiguration) – Instance of ApiConfiguration

get_in_skill_product(accept_language, product_id, **kwargs)

Get In-Skill Product information based on user context for the Skill.

Parameters:

• accept_language (str) – (required) User’s locale/language in context
• product_id (str) – (required) Product 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, Error, InSkillProduct]

get_in_skill_products(accept_language, **kwargs)

Gets In-Skill Products based on user’s context for the Skill.

Parameters:

• accept_language (str) – (required) User’s locale/language in context
• purchasable (str) – Filter products based on whether they are purchasable by the user or not. * ‘PURCHASABLE’ - Products that are purchasable by the user. * ‘NOT_PURCHASABLE’ - Products that are not purchasable by the user.
• entitled (str) – Filter products based on whether they are entitled to the user or not. * ‘ENTITLED’ - Products that the user is entitled to. * ‘NOT_ENTITLED’ - Products that the user is not entitled to.
• product_type (str) – Product type. * ‘SUBSCRIPTION’ - Once purchased, customers will own the content for the subscription period. * ‘ENTITLEMENT’ - Once purchased, customers will own the content forever. * ‘CONSUMABLE’ - Once purchased, customers will be entitled to the content until it is consumed. It can also be re-purchased.
• 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 which 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 In-Skill Products 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 100 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 because maxResults was exceeded, 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, Error, InSkillProductsResponse]

get_in_skill_products_transactions(accept_language, **kwargs)

Returns transactions of all in skill products purchases of the customer

Parameters:

• accept_language (str) – (required) User’s locale/language in context
• product_id (str) – Product Id.
• status (str) – Transaction status for in skill product purchases. * ‘PENDING_APPROVAL_BY_PARENT’ - The transaction is pending approval from parent. * ‘APPROVED_BY_PARENT’ - The transaction was approved by parent and fulfilled successfully.. * ‘DENIED_BY_PARENT’ - The transaction was declined by parent and hence not fulfilled. * ‘EXPIRED_NO_ACTION_BY_PARENT’ - The transaction was expired due to no response from parent and hence not fulfilled. * ‘ERROR’ - The transaction was not fullfiled as there was an error while processing the transaction.
• from_last_modified_time (datetime) – Filter transactions based on last modified time stamp, FROM duration in format (UTC ISO 8601) i.e. yyyy-MM-dd’T’HH:mm:ss.SSS’Z’
• to_last_modified_time (datetime) – Filter transactions based on last modified time stamp, TO duration in format (UTC ISO 8601) i.e. yyyy-MM-dd’T’HH:mm:ss.SSS’Z’
• next_token (str) – When response to this API call is truncated, the response also includes the nextToken in metadata, the value of which 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 In-Skill Products 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 100 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 because maxResults was exceeded, the response contains nextToken which can be used to fetch next set of result.
• 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, Error, InSkillProductTransactionsResponse]

get_voice_purchase_setting(**kwargs)

Returns whether or not voice purchasing is enabled for the skill

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, bool, Error]

ask_sdk_model.services.monetization.product_type module

class ask_sdk_model.services.monetization.product_type.ProductType

Bases: enum.Enum

Product type. * 'SUBSCRIPTION' - Once purchased, customers will own the content for the subscription period. * 'ENTITLEMENT' - Once purchased, customers will own the content forever. * 'CONSUMABLE' - Once purchased, customers will be entitled to the content until it is consumed. It can also be re-purchased.

Allowed enum values: [SUBSCRIPTION, ENTITLEMENT, CONSUMABLE]

CONSUMABLE = 'CONSUMABLE'

ENTITLEMENT = 'ENTITLEMENT'

SUBSCRIPTION = 'SUBSCRIPTION'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.monetization.purchasable_state module

class ask_sdk_model.services.monetization.purchasable_state.PurchasableState

Bases: enum.Enum

State determining if the product is purchasable by the user. Note - Any new values introduced later should be treated as 'NOT_PURCHASABLE'. * 'PURCHASABLE' - The product is purchasable by the user. * 'NOT_PURCHASABLE' - The product is not purchasable by the user.

Allowed enum values: [PURCHASABLE, NOT_PURCHASABLE]

NOT_PURCHASABLE = 'NOT_PURCHASABLE'

PURCHASABLE = 'PURCHASABLE'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.monetization.purchase_mode module

class ask_sdk_model.services.monetization.purchase_mode.PurchaseMode

Bases: enum.Enum

Indicates if the entitlements are for TEST or LIVE purchases. * 'TEST' - test purchases made by developers or beta testers. Purchase not sent to payment processing. * 'LIVE' - purchases made by live customers. Purchase sent to payment processing.

Allowed enum values: [TEST, LIVE]

LIVE = 'LIVE'

TEST = 'TEST'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.monetization.result_set module

class ask_sdk_model.services.monetization.result_set.ResultSet(next_token=None)

Bases: object

Parameters:next_token ((optional) str) –

attribute_map = {'next_token': 'nextToken'}

deserialized_types = {'next_token': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.monetization.status module

class ask_sdk_model.services.monetization.status.Status

Bases: enum.Enum

Transaction status for in skill product purchases. * 'PENDING_APPROVAL_BY_PARENT' - The transaction is pending approval from parent. * 'APPROVED_BY_PARENT' - The transaction was approved by parent and fulfilled successfully.. * 'DENIED_BY_PARENT' - The transaction was declined by parent and hence not fulfilled. * 'EXPIRED_NO_ACTION_BY_PARENT' - The transaction was expired due to no response from parent and hence not fulfilled. * 'ERROR' - The transaction was not fullfiled as there was an error while processing the transaction.

Allowed enum values: [PENDING_APPROVAL_BY_PARENT, APPROVED_BY_PARENT, DENIED_BY_PARENT, EXPIRED_NO_ACTION_BY_PARENT, ERROR]

APPROVED_BY_PARENT = 'APPROVED_BY_PARENT'

DENIED_BY_PARENT = 'DENIED_BY_PARENT'

ERROR = 'ERROR'

EXPIRED_NO_ACTION_BY_PARENT = 'EXPIRED_NO_ACTION_BY_PARENT'

PENDING_APPROVAL_BY_PARENT = 'PENDING_APPROVAL_BY_PARENT'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.monetization.transactions module

class ask_sdk_model.services.monetization.transactions.Transactions(status=None, product_id=None, created_time=None, last_modified_time=None)

Bases: object

Parameters:

• status ((optional) ask_sdk_model.services.monetization.status.Status) –
• product_id ((optional) str) – Product Id
• created_time ((optional) datetime) – Time at which transaction's was initiated in ISO 8601 format i.e. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
• last_modified_time ((optional) datetime) – Time at which transaction's status was last updated in ISO 8601 format i.e. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'

attribute_map = {'created_time': 'createdTime', 'last_modified_time': 'lastModifiedTime', 'product_id': 'productId', 'status': 'status'}

deserialized_types = {'created_time': 'datetime', 'last_modified_time': 'datetime', 'product_id': 'str', 'status': 'ask_sdk_model.services.monetization.status.Status'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.proactive_events 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_sdk_model.services.proactive_events.create_proactive_event_request module

class ask_sdk_model.services.proactive_events.create_proactive_event_request.CreateProactiveEventRequest(timestamp=None, reference_id=None, expiry_time=None, event=None, localized_attributes=None, relevant_audience=None)

Bases: object

Parameters:

• timestamp ((optional) datetime) – The date and time of the event associated with this request, in ISO 8601 format.
• reference_id ((optional) str) – Client-supplied ID for correlating the event with external entities. The allowed characters for the referenceId field are alphanumeric and ~, and the length of the referenceId field must be 1-100 characters.
• expiry_time ((optional) datetime) – The date and time, in ISO 8601 format, when the service will automatically delete the notification if it is still in the pending state.
• event ((optional) ask_sdk_model.services.proactive_events.event.Event) –
• localized_attributes ((optional) list[object]) – A list of items, each of which contains the set of event attributes that requires localization support.
• relevant_audience ((optional) ask_sdk_model.services.proactive_events.relevant_audience.RelevantAudience) –

attribute_map = {'event': 'event', 'expiry_time': 'expiryTime', 'localized_attributes': 'localizedAttributes', 'reference_id': 'referenceId', 'relevant_audience': 'relevantAudience', 'timestamp': 'timestamp'}

deserialized_types = {'event': 'ask_sdk_model.services.proactive_events.event.Event', 'expiry_time': 'datetime', 'localized_attributes': 'list[object]', 'reference_id': 'str', 'relevant_audience': 'ask_sdk_model.services.proactive_events.relevant_audience.RelevantAudience', 'timestamp': 'datetime'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.proactive_events.error module

class ask_sdk_model.services.proactive_events.error.Error(code=None, message=None)

Bases: object

Parameters:

• code ((optional) int) –
• message ((optional) str) –

attribute_map = {'code': 'code', 'message': 'message'}

deserialized_types = {'code': 'int', 'message': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.proactive_events.event module

class ask_sdk_model.services.proactive_events.event.Event(name=None, payload=None)

Bases: object

The event data to be sent to customers, conforming to the schema associated with this event.

Parameters:

• name ((optional) str) –
• payload ((optional) object) –

attribute_map = {'name': 'name', 'payload': 'payload'}

deserialized_types = {'name': 'str', 'payload': 'object'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.proactive_events.proactive_events_service_client module

class ask_sdk_model.services.proactive_events.proactive_events_service_client.ProactiveEventsServiceClient(api_configuration, authentication_configuration, lwa_client=None, custom_user_agent=None)

Bases: ask_sdk_model.services.base_service_client.BaseServiceClient

ServiceClient for calling the ProactiveEventsService APIs.

Parameters:api_configuration (ask_sdk_model.services.api_configuration.ApiConfiguration) – Instance of ApiConfiguration

create_proactive_event(create_proactive_event_request, stage, **kwargs)

Create a new proactive event in live stage.

Parameters:

• create_proactive_event_request (ask_sdk_model.services.proactive_events.create_proactive_event_request.CreateProactiveEventRequest) – (required) Request to create a new proactive event.
• 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, Error]

ask_sdk_model.services.proactive_events.relevant_audience module

class ask_sdk_model.services.proactive_events.relevant_audience.RelevantAudience(object_type=None, payload=None)

Bases: object

The audience for this event.

Parameters:

• object_type ((optional) ask_sdk_model.services.proactive_events.relevant_audience_type.RelevantAudienceType) –
• payload ((optional) object) – If relevantAudience.type is set to Multicast, then the payload object is empty. Otherwise, the userId value for which the event is targeted is required.

attribute_map = {'object_type': 'type', 'payload': 'payload'}

deserialized_types = {'object_type': 'ask_sdk_model.services.proactive_events.relevant_audience_type.RelevantAudienceType', 'payload': 'object'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.proactive_events.relevant_audience_type module

class ask_sdk_model.services.proactive_events.relevant_audience_type.RelevantAudienceType

Bases: enum.Enum

The audience for this event. Use Multicast to target information to all customers subscribed to that event, or use Unicast to target information containing the actual userId for individual events.

Allowed enum values: [Unicast, Multicast]

Multicast = 'Multicast'

Unicast = 'Unicast'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.proactive_events.skill_stage module

class ask_sdk_model.services.proactive_events.skill_stage.SkillStage

Bases: enum.Enum

Stage for creating Proactive events. Since proactive events can be created on the DEVELOPMENT and LIVE stages of the skill, this enum provides the stage values that can be used to pass to the service call.

Allowed enum values: [DEVELOPMENT, LIVE]

DEVELOPMENT = 'DEVELOPMENT'

LIVE = 'LIVE'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.reminder_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_sdk_model.services.reminder_management.alert_info module

class ask_sdk_model.services.reminder_management.alert_info.AlertInfo(spoken_info=None)

Bases: object

Alert info for VUI / GUI

Parameters:spoken_info ((optional) ask_sdk_model.services.reminder_management.alert_info_spoken_info.SpokenInfo) –

attribute_map = {'spoken_info': 'spokenInfo'}

deserialized_types = {'spoken_info': 'ask_sdk_model.services.reminder_management.alert_info_spoken_info.SpokenInfo'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.reminder_management.alert_info_spoken_info module

class ask_sdk_model.services.reminder_management.alert_info_spoken_info.SpokenInfo(content=None)

Bases: object

Parameters for VUI presentation of the reminder

Parameters:content ((optional) list[ask_sdk_model.services.reminder_management.spoken_text.SpokenText]) –

attribute_map = {'content': 'content'}

deserialized_types = {'content': 'list[ask_sdk_model.services.reminder_management.spoken_text.SpokenText]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.reminder_management.error module

class ask_sdk_model.services.reminder_management.error.Error(code=None, message=None)

Bases: object

Parameters:

• code ((optional) str) – Domain specific error code
• message ((optional) str) – Detailed error message

attribute_map = {'code': 'code', 'message': 'message'}

deserialized_types = {'code': 'str', 'message': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.reminder_management.event module

class ask_sdk_model.services.reminder_management.event.Event(status=None, alert_token=None)

Bases: object

Parameters:

• status ((optional) ask_sdk_model.services.reminder_management.status.Status) –
• alert_token ((optional) str) –

attribute_map = {'alert_token': 'alertToken', 'status': 'status'}

deserialized_types = {'alert_token': 'str', 'status': 'ask_sdk_model.services.reminder_management.status.Status'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.reminder_management.get_reminder_response module

class ask_sdk_model.services.reminder_management.get_reminder_response.GetReminderResponse(alert_token=None, created_time=None, updated_time=None, status=None, trigger=None, alert_info=None, push_notification=None, version=None)

Bases: ask_sdk_model.services.reminder_management.reminder.Reminder

Response object for get reminder request

Parameters:

• alert_token ((optional) str) – Unique id of this reminder alert
• created_time ((optional) datetime) – Valid ISO 8601 format - Creation time of this reminder alert
• updated_time ((optional) datetime) – Valid ISO 8601 format - Last updated time of this reminder alert
• status ((optional) ask_sdk_model.services.reminder_management.status.Status) –
• trigger ((optional) ask_sdk_model.services.reminder_management.trigger.Trigger) –
• alert_info ((optional) ask_sdk_model.services.reminder_management.alert_info.AlertInfo) –
• push_notification ((optional) ask_sdk_model.services.reminder_management.push_notification.PushNotification) –
• version ((optional) str) – Version of reminder alert

attribute_map = {'alert_info': 'alertInfo', 'alert_token': 'alertToken', 'created_time': 'createdTime', 'push_notification': 'pushNotification', 'status': 'status', 'trigger': 'trigger', 'updated_time': 'updatedTime', 'version': 'version'}

deserialized_types = {'alert_info': 'ask_sdk_model.services.reminder_management.alert_info.AlertInfo', 'alert_token': 'str', 'created_time': 'datetime', 'push_notification': 'ask_sdk_model.services.reminder_management.push_notification.PushNotification', 'status': 'ask_sdk_model.services.reminder_management.status.Status', 'trigger': 'ask_sdk_model.services.reminder_management.trigger.Trigger', 'updated_time': 'datetime', 'version': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.reminder_management.get_reminders_response module

class ask_sdk_model.services.reminder_management.get_reminders_response.GetRemindersResponse(total_count=None, alerts=None, links=None)

Bases: object

Response object for get reminders request

Parameters:

• total_count ((optional) str) – Total count of reminders returned
• alerts ((optional) list[ask_sdk_model.services.reminder_management.reminder.Reminder]) – List of reminders
• links ((optional) str) – Link to retrieve next set of alerts if total count is greater than max results

attribute_map = {'alerts': 'alerts', 'links': 'links', 'total_count': 'totalCount'}

deserialized_types = {'alerts': 'list[ask_sdk_model.services.reminder_management.reminder.Reminder]', 'links': 'str', 'total_count': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.reminder_management.push_notification module

class ask_sdk_model.services.reminder_management.push_notification.PushNotification(status=None)

Bases: object

Enable / disable reminders push notifications to Alexa mobile apps

Parameters:status ((optional) ask_sdk_model.services.reminder_management.push_notification_status.PushNotificationStatus) –

attribute_map = {'status': 'status'}

deserialized_types = {'status': 'ask_sdk_model.services.reminder_management.push_notification_status.PushNotificationStatus'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.reminder_management.push_notification_status module

class ask_sdk_model.services.reminder_management.push_notification_status.PushNotificationStatus

Bases: enum.Enum

Push notification status - Enabled/Disabled

Allowed enum values: [ENABLED, DISABLED]

DISABLED = 'DISABLED'

ENABLED = 'ENABLED'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.reminder_management.recurrence module

class ask_sdk_model.services.reminder_management.recurrence.Recurrence(freq=None, by_day=None, interval=None, start_date_time=None, end_date_time=None, recurrence_rules=None)

Bases: object

Recurring date/time using the RFC 5545 standard in JSON object form

Parameters:

• freq ((optional) ask_sdk_model.services.reminder_management.recurrence_freq.RecurrenceFreq) –
• by_day ((optional) list[ask_sdk_model.services.reminder_management.recurrence_day.RecurrenceDay]) –
• interval ((optional) int) – contains a positive integer representing at which intervals the recurrence rule repeats
• start_date_time ((optional) datetime) – Valid ISO 8601 format - optional start DateTime of recurrence.
• end_date_time ((optional) datetime) – Valid ISO 8601 format - optional end DateTime of recurrence
• recurrence_rules ((optional) list[str]) –

attribute_map = {'by_day': 'byDay', 'end_date_time': 'endDateTime', 'freq': 'freq', 'interval': 'interval', 'recurrence_rules': 'recurrenceRules', 'start_date_time': 'startDateTime'}

deserialized_types = {'by_day': 'list[ask_sdk_model.services.reminder_management.recurrence_day.RecurrenceDay]', 'end_date_time': 'datetime', 'freq': 'ask_sdk_model.services.reminder_management.recurrence_freq.RecurrenceFreq', 'interval': 'int', 'recurrence_rules': 'list[str]', 'start_date_time': 'datetime'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.reminder_management.recurrence_day module

class ask_sdk_model.services.reminder_management.recurrence_day.RecurrenceDay

Bases: enum.Enum

Day of recurrence. Deprecated.

Allowed enum values: [SU, MO, TU, WE, TH, FR, SA]

FR = 'FR'

MO = 'MO'

SA = 'SA'

SU = 'SU'

TH = 'TH'

TU = 'TU'

WE = 'WE'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.reminder_management.recurrence_freq module

class ask_sdk_model.services.reminder_management.recurrence_freq.RecurrenceFreq

Bases: enum.Enum

Frequency of recurrence. Deprecated.

Allowed enum values: [WEEKLY, DAILY]

DAILY = 'DAILY'

WEEKLY = 'WEEKLY'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.reminder_management.reminder module

class ask_sdk_model.services.reminder_management.reminder.Reminder(alert_token=None, created_time=None, updated_time=None, status=None, trigger=None, alert_info=None, push_notification=None, version=None)

Bases: object

Reminder object

Parameters:

• alert_token ((optional) str) – Unique id of this reminder alert
• created_time ((optional) datetime) – Valid ISO 8601 format - Creation time of this reminder alert
• updated_time ((optional) datetime) – Valid ISO 8601 format - Last updated time of this reminder alert
• status ((optional) ask_sdk_model.services.reminder_management.status.Status) –
• trigger ((optional) ask_sdk_model.services.reminder_management.trigger.Trigger) –
• alert_info ((optional) ask_sdk_model.services.reminder_management.alert_info.AlertInfo) –
• push_notification ((optional) ask_sdk_model.services.reminder_management.push_notification.PushNotification) –
• version ((optional) str) – Version of reminder alert

attribute_map = {'alert_info': 'alertInfo', 'alert_token': 'alertToken', 'created_time': 'createdTime', 'push_notification': 'pushNotification', 'status': 'status', 'trigger': 'trigger', 'updated_time': 'updatedTime', 'version': 'version'}

deserialized_types = {'alert_info': 'ask_sdk_model.services.reminder_management.alert_info.AlertInfo', 'alert_token': 'str', 'created_time': 'datetime', 'push_notification': 'ask_sdk_model.services.reminder_management.push_notification.PushNotification', 'status': 'ask_sdk_model.services.reminder_management.status.Status', 'trigger': 'ask_sdk_model.services.reminder_management.trigger.Trigger', 'updated_time': 'datetime', 'version': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.reminder_management.reminder_created_event_request module

class ask_sdk_model.services.reminder_management.reminder_created_event_request.ReminderCreatedEventRequest(request_id=None, timestamp=None, locale=None, body=None)

Bases: ask_sdk_model.request.Request

Parameters:

• request_id ((optional) str) – Represents the unique identifier for the specific request.
• timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
• locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
• body ((optional) ask_sdk_model.services.reminder_management.event.Event) –

attribute_map = {'body': 'body', 'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp'}

deserialized_types = {'body': 'ask_sdk_model.services.reminder_management.event.Event', 'locale': 'str', 'object_type': 'str', 'request_id': 'str', 'timestamp': 'datetime'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.reminder_management.reminder_deleted_event module

class ask_sdk_model.services.reminder_management.reminder_deleted_event.ReminderDeletedEvent(alert_tokens=None)

Bases: object

Parameters:alert_tokens ((optional) list[str]) –

attribute_map = {'alert_tokens': 'alertTokens'}

deserialized_types = {'alert_tokens': 'list[str]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.reminder_management.reminder_deleted_event_request module

class ask_sdk_model.services.reminder_management.reminder_deleted_event_request.ReminderDeletedEventRequest(request_id=None, timestamp=None, locale=None, body=None)

Bases: ask_sdk_model.request.Request

Parameters:

• request_id ((optional) str) – Represents the unique identifier for the specific request.
• timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
• locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
• body ((optional) ask_sdk_model.services.reminder_management.reminder_deleted_event.ReminderDeletedEvent) –

attribute_map = {'body': 'body', 'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp'}

deserialized_types = {'body': 'ask_sdk_model.services.reminder_management.reminder_deleted_event.ReminderDeletedEvent', 'locale': 'str', 'object_type': 'str', 'request_id': 'str', 'timestamp': 'datetime'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.reminder_management.reminder_management_service_client module

class ask_sdk_model.services.reminder_management.reminder_management_service_client.ReminderManagementServiceClient(api_configuration, custom_user_agent=None)

Bases: ask_sdk_model.services.base_service_client.BaseServiceClient

ServiceClient for calling the ReminderManagementService APIs.

Parameters:api_configuration (ask_sdk_model.services.api_configuration.ApiConfiguration) – Instance of ApiConfiguration

create_reminder(reminder_request, **kwargs)

This API is invoked by the skill to create a new reminder.

Parameters:

• reminder_request (ask_sdk_model.services.reminder_management.reminder_request.ReminderRequest) – (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, ReminderResponse, Error]

delete_reminder(alert_token, **kwargs)

This API is invoked by the skill to delete a single reminder.

Parameters:

• alert_token (str) – (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, Error]

get_reminder(alert_token, **kwargs)

This API is invoked by the skill to get a single reminder.

Parameters:

• alert_token (str) – (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, GetReminderResponse, Error]

get_reminders(**kwargs)

This API is invoked by the skill to get a all reminders created by the caller.

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, GetRemindersResponse, Error]

update_reminder(alert_token, reminder_request, **kwargs)

This API is invoked by the skill to update a reminder.

Parameters:

• alert_token (str) – (required)
• reminder_request (ask_sdk_model.services.reminder_management.reminder_request.ReminderRequest) – (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, ReminderResponse, Error]

ask_sdk_model.services.reminder_management.reminder_request module

class ask_sdk_model.services.reminder_management.reminder_request.ReminderRequest(request_time=None, trigger=None, alert_info=None, push_notification=None)

Bases: object

Input request for creating a reminder

Parameters:

• request_time ((optional) datetime) – Valid ISO 8601 format - Creation time of this reminder alert
• trigger ((optional) ask_sdk_model.services.reminder_management.trigger.Trigger) –
• alert_info ((optional) ask_sdk_model.services.reminder_management.alert_info.AlertInfo) –
• push_notification ((optional) ask_sdk_model.services.reminder_management.push_notification.PushNotification) –

attribute_map = {'alert_info': 'alertInfo', 'push_notification': 'pushNotification', 'request_time': 'requestTime', 'trigger': 'trigger'}

deserialized_types = {'alert_info': 'ask_sdk_model.services.reminder_management.alert_info.AlertInfo', 'push_notification': 'ask_sdk_model.services.reminder_management.push_notification.PushNotification', 'request_time': 'datetime', 'trigger': 'ask_sdk_model.services.reminder_management.trigger.Trigger'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.reminder_management.reminder_response module

class ask_sdk_model.services.reminder_management.reminder_response.ReminderResponse(alert_token=None, created_time=None, updated_time=None, status=None, version=None, href=None)

Bases: object

Response object for post/put/delete reminder request

Parameters:

• alert_token ((optional) str) – Unique id of this reminder alert
• created_time ((optional) str) – Valid ISO 8601 format - Creation time of this reminder alert
• updated_time ((optional) str) – Valid ISO 8601 format - Last updated time of this reminder alert
• status ((optional) ask_sdk_model.services.reminder_management.status.Status) –
• version ((optional) str) – Version of reminder alert
• href ((optional) str) – URI to retrieve the created alert

attribute_map = {'alert_token': 'alertToken', 'created_time': 'createdTime', 'href': 'href', 'status': 'status', 'updated_time': 'updatedTime', 'version': 'version'}

deserialized_types = {'alert_token': 'str', 'created_time': 'str', 'href': 'str', 'status': 'ask_sdk_model.services.reminder_management.status.Status', 'updated_time': 'str', 'version': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.reminder_management.reminder_started_event_request module

class ask_sdk_model.services.reminder_management.reminder_started_event_request.ReminderStartedEventRequest(request_id=None, timestamp=None, locale=None, body=None)

Bases: ask_sdk_model.request.Request

Parameters:

• request_id ((optional) str) – Represents the unique identifier for the specific request.
• timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
• locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
• body ((optional) ask_sdk_model.services.reminder_management.event.Event) –

attribute_map = {'body': 'body', 'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp'}

deserialized_types = {'body': 'ask_sdk_model.services.reminder_management.event.Event', 'locale': 'str', 'object_type': 'str', 'request_id': 'str', 'timestamp': 'datetime'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.reminder_management.reminder_status_changed_event_request module

class ask_sdk_model.services.reminder_management.reminder_status_changed_event_request.ReminderStatusChangedEventRequest(request_id=None, timestamp=None, locale=None, body=None)

Bases: ask_sdk_model.request.Request

Parameters:

• request_id ((optional) str) – Represents the unique identifier for the specific request.
• timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
• locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
• body ((optional) ask_sdk_model.services.reminder_management.event.Event) –

attribute_map = {'body': 'body', 'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp'}

deserialized_types = {'body': 'ask_sdk_model.services.reminder_management.event.Event', 'locale': 'str', 'object_type': 'str', 'request_id': 'str', 'timestamp': 'datetime'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.reminder_management.reminder_updated_event_request module

class ask_sdk_model.services.reminder_management.reminder_updated_event_request.ReminderUpdatedEventRequest(request_id=None, timestamp=None, locale=None, body=None)

Bases: ask_sdk_model.request.Request

Parameters:

• request_id ((optional) str) – Represents the unique identifier for the specific request.
• timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
• locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
• body ((optional) ask_sdk_model.services.reminder_management.event.Event) –

attribute_map = {'body': 'body', 'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp'}

deserialized_types = {'body': 'ask_sdk_model.services.reminder_management.event.Event', 'locale': 'str', 'object_type': 'str', 'request_id': 'str', 'timestamp': 'datetime'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.reminder_management.spoken_text module

class ask_sdk_model.services.reminder_management.spoken_text.SpokenText(locale=None, ssml=None, text=None)

Bases: object

Parameters:

• locale ((optional) str) – The locale in which the spoken text is rendered. e.g. en-US
• ssml ((optional) str) – Spoken text in SSML format.
• text ((optional) str) – Spoken text in plain text format.

attribute_map = {'locale': 'locale', 'ssml': 'ssml', 'text': 'text'}

deserialized_types = {'locale': 'str', 'ssml': 'str', 'text': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.reminder_management.status module

class ask_sdk_model.services.reminder_management.status.Status

Bases: enum.Enum

Status of reminder

Allowed enum values: [ON, COMPLETED]

COMPLETED = 'COMPLETED'

ON = 'ON'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.reminder_management.trigger module

class ask_sdk_model.services.reminder_management.trigger.Trigger(object_type=None, scheduled_time=None, offset_in_seconds=None, time_zone_id=None, recurrence=None)

Bases: object

Trigger information for Reminder

Parameters:

• object_type ((optional) ask_sdk_model.services.reminder_management.trigger_type.TriggerType) –
• scheduled_time ((optional) datetime) – Valid ISO 8601 format - Intended trigger time
• offset_in_seconds ((optional) int) – If reminder is set using relative time, use this field to specify the time after which reminder ll ring (in seconds)
• time_zone_id ((optional) str) – Intended reminder's timezone
• recurrence ((optional) ask_sdk_model.services.reminder_management.recurrence.Recurrence) –

attribute_map = {'object_type': 'type', 'offset_in_seconds': 'offsetInSeconds', 'recurrence': 'recurrence', 'scheduled_time': 'scheduledTime', 'time_zone_id': 'timeZoneId'}

deserialized_types = {'object_type': 'ask_sdk_model.services.reminder_management.trigger_type.TriggerType', 'offset_in_seconds': 'int', 'recurrence': 'ask_sdk_model.services.reminder_management.recurrence.Recurrence', 'scheduled_time': 'datetime', 'time_zone_id': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.reminder_management.trigger_type module

class ask_sdk_model.services.reminder_management.trigger_type.TriggerType

Bases: enum.Enum

Type of reminder - Absolute / Relative

Allowed enum values: [SCHEDULED_ABSOLUTE, SCHEDULED_RELATIVE]

SCHEDULED_ABSOLUTE = 'SCHEDULED_ABSOLUTE'

SCHEDULED_RELATIVE = 'SCHEDULED_RELATIVE'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.skill_messaging 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_sdk_model.services.skill_messaging.error module

class ask_sdk_model.services.skill_messaging.error.Error(code=None, message=None)

Bases: object

Parameters:

• code ((optional) int) –
• message ((optional) str) –

attribute_map = {'code': 'code', 'message': 'message'}

deserialized_types = {'code': 'int', 'message': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.skill_messaging.send_skill_messaging_request module

class ask_sdk_model.services.skill_messaging.send_skill_messaging_request.SendSkillMessagingRequest(data=None, expires_after_seconds=None)

Bases: object

The message that needs to be sent to the skill

Parameters:

• data ((optional) object) – The payload data to send with the message. The data must be in the form of JSON-formatted key-value pairs. Both keys and values must be of type String. The total size of the data cannot be greater than 6KB. For calculation purposes, this includes keys and values, the quotes that surround them, the &quot;:&quot; character that separates them, the commas that separate the pairs, and the opening and closing braces around the field. However, any whitespace between key/value pairs is not included in the calculation of the payload size. If the message does not include payload data, as in the case of a sync message, you can pass in an empty JSON object &quot;{}&quot;.
• expires_after_seconds ((optional) int) – The number of seconds that the message will be retained to retry if message delivery is not successful. Allowed values are from 60 (1 minute) to 86400 (1 day), inclusive. The default is 3600 (1 hour). Multiple retries may occur during this interval. The retry logic is exponential. The first retry executes after 30 seconds, and this time period doubles on every retry. The retries will end when the total time elapsed since the message was first sent has exceeded the value you provided for expiresAfterSeconds. Message expiry is rarely a problem if the message handler has been set up correctly. With a correct setup, you will receive the message once promptly. This mechanism for retries is provided as a safeguard in case your skill goes down during a message delivery.

attribute_map = {'data': 'data', 'expires_after_seconds': 'expiresAfterSeconds'}

deserialized_types = {'data': 'object', 'expires_after_seconds': 'int'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.skill_messaging.skill_messaging_service_client module

class ask_sdk_model.services.skill_messaging.skill_messaging_service_client.SkillMessagingServiceClient(api_configuration, authentication_configuration, lwa_client=None, custom_user_agent=None)

Bases: ask_sdk_model.services.base_service_client.BaseServiceClient

ServiceClient for calling the SkillMessagingService APIs.

Parameters:api_configuration (ask_sdk_model.services.api_configuration.ApiConfiguration) – Instance of ApiConfiguration

send_skill_message(user_id, send_skill_messaging_request, **kwargs)

Send a message request to a skill for a specified user.

Parameters:

• user_id (str) – (required) The user Id for the specific user to send the message
• send_skill_messaging_request (ask_sdk_model.services.skill_messaging.send_skill_messaging_request.SendSkillMessagingRequest) – (required) Message Request to be sent to the 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, Error]

ask_sdk_model.services.ups 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_sdk_model.services.ups.distance_units module

class ask_sdk_model.services.ups.distance_units.DistanceUnits

Bases: enum.Enum

Allowed enum values: [METRIC, IMPERIAL]

IMPERIAL = 'IMPERIAL'

METRIC = 'METRIC'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.ups.error module

class ask_sdk_model.services.ups.error.Error(code=None, message=None)

Bases: object

Parameters:

• code ((optional) ask_sdk_model.services.ups.error_code.ErrorCode) –
• message ((optional) str) – A human readable description of error.

attribute_map = {'code': 'code', 'message': 'message'}

deserialized_types = {'code': 'ask_sdk_model.services.ups.error_code.ErrorCode', 'message': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.ups.error_code module

class ask_sdk_model.services.ups.error_code.ErrorCode

Bases: enum.Enum

A more precise error code. Some of these codes may not apply to some APIs. - INVALID_KEY: the setting key is not supported - INVALID_VALUE: the setting value is not valid - INVALID_TOKEN: the token is invalid - INVALID_URI: the uri is invalid - DEVICE_UNREACHABLE: the device is offline - UNKNOWN_ERROR: internal service error

Allowed enum values: [INVALID_KEY, INVALID_VALUE, INVALID_TOKEN, INVALID_URI, DEVICE_UNREACHABLE, UNKNOWN_ERROR]

DEVICE_UNREACHABLE = 'DEVICE_UNREACHABLE'

INVALID_KEY = 'INVALID_KEY'

INVALID_TOKEN = 'INVALID_TOKEN'

INVALID_URI = 'INVALID_URI'

INVALID_VALUE = 'INVALID_VALUE'

UNKNOWN_ERROR = 'UNKNOWN_ERROR'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.ups.phone_number module

class ask_sdk_model.services.ups.phone_number.PhoneNumber(country_code=None, phone_number=None)

Bases: object

Parameters:

• country_code ((optional) str) –
• phone_number ((optional) str) –

attribute_map = {'country_code': 'countryCode', 'phone_number': 'phoneNumber'}

deserialized_types = {'country_code': 'str', 'phone_number': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.ups.temperature_unit module

class ask_sdk_model.services.ups.temperature_unit.TemperatureUnit

Bases: enum.Enum

Allowed enum values: [CELSIUS, FAHRENHEIT]

CELSIUS = 'CELSIUS'

FAHRENHEIT = 'FAHRENHEIT'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.ups.ups_service_client module

class ask_sdk_model.services.ups.ups_service_client.UpsServiceClient(api_configuration, custom_user_agent=None)

Bases: ask_sdk_model.services.base_service_client.BaseServiceClient

ServiceClient for calling the UpsService APIs.

Parameters:api_configuration (ask_sdk_model.services.api_configuration.ApiConfiguration) – Instance of ApiConfiguration

get_profile_email(**kwargs)

Gets the email address of the customer associated with the current enablement. Requires customer consent for scopes: [alexa::profile:email:read]

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, str, Error]

get_profile_given_name(**kwargs)

Gets the given name (first name) of the customer associated with the current enablement. Requires customer consent for scopes: [alexa::profile:given_name:read]

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, str, Error]

get_profile_mobile_number(**kwargs)

Gets the mobile phone number of the customer associated with the current enablement. Requires customer consent for scopes: [alexa::profile:mobile_number:read]

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, PhoneNumber, Error]

get_profile_name(**kwargs)

Gets the full name of the customer associated with the current enablement. Requires customer consent for scopes: [alexa::profile:name:read]

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, str, Error]

get_system_distance_units(device_id, **kwargs)

Gets the distance measurement unit of the device. Does not require explict customer consent.

Parameters:

• device_id (str) – (required) The device 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, Error, DistanceUnits]

get_system_temperature_unit(device_id, **kwargs)

Gets the temperature measurement units of the device. Does not require explict customer consent.

Parameters:

• device_id (str) – (required) The device 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, TemperatureUnit, Error]

get_system_time_zone(device_id, **kwargs)

Gets the time zone of the device. Does not require explict customer consent.

Parameters:

• device_id (str) – (required) The device 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, str, Error]

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_sdk_model.services.api_client module

class ask_sdk_model.services.api_client.ApiClient

Bases: object

Represents a basic contract for API request invocation.

invoke(request)

Dispatches a request to an API endpoint described in the request.

The ApiClient is expected to resolve in the case an API returns a non-200 HTTP status code. The responsibility of translating a particular response code to an error lies with the caller.

Parameters:request (ApiClientRequest) – Request to dispatch to the ApiClient Returns:Response from the client call Return type:ApiClientResponse

ask_sdk_model.services.api_client_message module

class ask_sdk_model.services.api_client_message.ApiClientMessage(headers=None, body=None)

Bases: object

Represents the interface between ask_sdk_model.services.api_client.ApiClient implementation and a Service Client.

Parameters:

• headers (list[tuple[str, str]]) – List of header tuples
• body (str) – Body of the message

ask_sdk_model.services.api_client_request module

class ask_sdk_model.services.api_client_request.ApiClientRequest(headers=None, body=None, url=None, method=None)

Bases: ask_sdk_model.services.api_client_message.ApiClientMessage

Represents a request sent from Service Clients to an ask_sdk_model.services.api_client.ApiClient implementation.

Parameters:

• headers (list[tuple[str, str]]) – List of header tuples
• body (str) – Body of the message
• url (str) – Url of the request
• method (str) – Method called with the request

ask_sdk_model.services.api_client_response module

class ask_sdk_model.services.api_client_response.ApiClientResponse(headers=None, body=None, status_code=None)

Bases: ask_sdk_model.services.api_client_message.ApiClientMessage

Represents a response returned by ask_sdk_model.services.api_client.ApiClient implementation to a Service Client.

Parameters:

• headers (list[tuple[str, str]]) – List of header tuples
• body (str) – Body of the message
• status_code (int) – Status code of the response

ask_sdk_model.services.api_configuration module

class ask_sdk_model.services.api_configuration.ApiConfiguration(serializer=None, api_client=None, authorization_value=None, api_endpoint=None)

Bases: object

Represents a class that provides API configuration options needed by service clients.

Parameters:

• serializer ((optional) ask_sdk_model.services.serializer.Serializer) – serializer implementation for encoding/decoding JSON from/to Object models.
• api_client ((optional) ask_sdk_model.services.api_client.ApiClient) – API Client implementation
• authorization_value ((optional) str) – Authorization value to be used on any calls of the service client instance
• api_endpoint ((optional) str) – Endpoint to hit by the service client instance

ask_sdk_model.services.api_response module

class ask_sdk_model.services.api_response.ApiResponse(headers=None, body=None, status_code=None)

Bases: object

Represents a response returned by the Service Client.

Parameters:

• headers (list[tuple[str, str]]) – List of header tuples
• body (object) – Body of the response
• status_code (int) – Status code of the response

ask_sdk_model.services.authentication_configuration module

class ask_sdk_model.services.authentication_configuration.AuthenticationConfiguration(client_id=None, client_secret=None, refresh_token=None)

Bases: object

Represents a class that provides authentication configuration.

Parameters:

• client_id (str) – Client ID required for authentication.
• client_secret (str) – Client Secret required for authentication.
• refresh_token (str) – Client refresh_token required to get access token for API calls.

ask_sdk_model.services.base_service_client module

class ask_sdk_model.services.base_service_client.BaseServiceClient(api_configuration)

Bases: object

Class to be used as the base class for the generated service clients.

The class has to be implemented by the service clients and this class instantiation is not supported

Parameters:api_configuration (ask_sdk_model.services.api_configuration.ApiConfiguration) – ApiConfiguration implementation

invoke(method, endpoint, path, query_params, header_params, path_params, response_definitions, body, response_type)

Calls the ApiClient based on the ServiceClient specific data provided as well as handles the well-known responses from the Api.

Parameters:

• method (str) – Http method
• endpoint – Base endpoint to make the request to
• path (str) – Specific path to hit. It might contain variables to be interpolated with path_params
• query_params (list(tuple(str, str))) – Parameter values to be sent as part of query string
• header_params (list(tuple(str, str))) – Parameter values to be sent as headers
• path_params (dict(str, str)) – Parameter values to be interpolated in the path
• response_definitions (list(ask_sdk_model.services.service_client_response.ServiceClientResponse)) – Well-known expected responses by the ServiceClient
• body (object) – Request body
• response_type (class) – Type of the expected response if applicable

Returns:

ApiResponse object.

Return type:

ask_sdk_model.services.api_response.py

Raises:

ask_sdk_model.services.service_exception.ServiceException if service fails and ValueError if serializer or API Client is not configured in api_configuration # noqa: E501

ask_sdk_model.services.serializer module

class ask_sdk_model.services.serializer.Serializer

Bases: object

Represents an abstract object used for Serialization tasks

deserialize(payload, obj_type)

Deserializes the payload to object of provided obj_type.

Parameters:

• payload (str) – String to deserialize
• obj_type (object) – Target type of deserialization

Returns:

Deserialized object

Return type:

object

serialize(obj)

Serializes an object into a string.

Parameters:obj – object to serialize Returns:serialized object in string format Return type:str

ask_sdk_model.services.service_client_factory module

class ask_sdk_model.services.service_client_factory.ServiceClientFactory(api_configuration)

Bases: object

ServiceClientFactory class to help build service clients.

Parameters:api_configuration (ask_sdk_model.services.api_configuration.ApiConfiguration) – API Configuration for calling services

get_device_address_service()

Get DeviceAddressServiceClient for device_address_service.

Returns:Client for calling the service Return type:DeviceAddressServiceClient Raises:ValueError

get_directive_service()

Get DirectiveServiceClient for directive_service.

Returns:Client for calling the service Return type:DirectiveServiceClient Raises:ValueError

get_endpoint_enumeration_service()

Get EndpointEnumerationServiceClient for endpoint_enumeration_service.

Returns:Client for calling the service Return type:EndpointEnumerationServiceClient Raises:ValueError

get_list_management_service()

Get ListManagementServiceClient for list_management_service.

Returns:Client for calling the service Return type:ListManagementServiceClient Raises:ValueError

get_monetization_service()

Get MonetizationServiceClient for monetization_service.

Returns:Client for calling the service Return type:MonetizationServiceClient Raises:ValueError

get_reminder_management_service()

Get ReminderManagementServiceClient for reminder_management_service.

Returns:Client for calling the service Return type:ReminderManagementServiceClient Raises:ValueError

get_timer_management_service()

Get TimerManagementServiceClient for timer_management_service.

Returns:Client for calling the service Return type:TimerManagementServiceClient Raises:ValueError

get_ups_service()

Get UpsServiceClient for ups_service.

Returns:Client for calling the service Return type:UpsServiceClient Raises:ValueError

ask_sdk_model.services.service_client_response module

class ask_sdk_model.services.service_client_response.ServiceClientResponse(response_type, status_code, message)

Bases: object

Represents a well-known response object by Service Client.

Parameters:

• response_type (Response class) – Well-known representation of the response
• status_code (int) – Status code to be attached to the response
• message (str) – Message to be attached to the response

ask_sdk_model.services.service_exception module

exception ask_sdk_model.services.service_exception.ServiceException(message, status_code, headers, body)

Bases: Exception

Exception thrown by a Service client when an error response was received or some operation failed.

Parameters:

• message (str) – Description of the error
• status_code (int) – Status code of the HTTP Response
• headers (list(tuple(str, str))) – Headers of the Http response that return the failure
• body (object) – Body of the HTTP Response

ask_sdk_model.slu package

Subpackages

ask_sdk_model.slu.entityresolution 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_sdk_model.slu.entityresolution.resolution module

class ask_sdk_model.slu.entityresolution.resolution.Resolution(authority=None, status=None, values=None)

Bases: object

Represents a possible authority for entity resolution

Parameters:

• authority ((optional) str) –
• status ((optional) ask_sdk_model.slu.entityresolution.status.Status) –
• values ((optional) list[ask_sdk_model.slu.entityresolution.value_wrapper.ValueWrapper]) –

attribute_map = {'authority': 'authority', 'status': 'status', 'values': 'values'}

deserialized_types = {'authority': 'str', 'status': 'ask_sdk_model.slu.entityresolution.status.Status', 'values': 'list[ask_sdk_model.slu.entityresolution.value_wrapper.ValueWrapper]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.slu.entityresolution.resolutions module

class ask_sdk_model.slu.entityresolution.resolutions.Resolutions(resolutions_per_authority=None)

Bases: object

Represents the results of resolving the words captured from the user's utterance. This is included for slots that use a custom slot type or a built-in slot type that you have extended with your own values. Note that resolutions is not included for built-in slot types that you have not extended.

Parameters:resolutions_per_authority ((optional) list[ask_sdk_model.slu.entityresolution.resolution.Resolution]) –

attribute_map = {'resolutions_per_authority': 'resolutionsPerAuthority'}

deserialized_types = {'resolutions_per_authority': 'list[ask_sdk_model.slu.entityresolution.resolution.Resolution]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.slu.entityresolution.status module

class ask_sdk_model.slu.entityresolution.status.Status(code=None)

Bases: object

Parameters:code ((optional) ask_sdk_model.slu.entityresolution.status_code.StatusCode) – Indication of the results of attempting to resolve the user utterance against the defined slot types.

attribute_map = {'code': 'code'}

deserialized_types = {'code': 'ask_sdk_model.slu.entityresolution.status_code.StatusCode'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.slu.entityresolution.status_code module

class ask_sdk_model.slu.entityresolution.status_code.StatusCode

Bases: enum.Enum

Indication of the results of attempting to resolve the user utterance against the defined slot types.

Allowed enum values: [ER_SUCCESS_MATCH, ER_SUCCESS_NO_MATCH, ER_ERROR_TIMEOUT, ER_ERROR_EXCEPTION]

ER_ERROR_EXCEPTION = 'ER_ERROR_EXCEPTION'

ER_ERROR_TIMEOUT = 'ER_ERROR_TIMEOUT'

ER_SUCCESS_MATCH = 'ER_SUCCESS_MATCH'

ER_SUCCESS_NO_MATCH = 'ER_SUCCESS_NO_MATCH'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.slu.entityresolution.value module

class ask_sdk_model.slu.entityresolution.value.Value(name=None, id=None)

Bases: object

Represents the resolved value for the slot, based on the user’s utterance and slot type definition.

Parameters:

• name ((optional) str) – The name for the resolution value.
• id ((optional) str) – The id for the resolution value.

attribute_map = {'id': 'id', 'name': 'name'}

deserialized_types = {'id': 'str', 'name': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.slu.entityresolution.value_wrapper module

class ask_sdk_model.slu.entityresolution.value_wrapper.ValueWrapper(value=None)

Bases: object

A wrapper class for an entity resolution value used for JSON serialization.

Parameters:value ((optional) ask_sdk_model.slu.entityresolution.value.Value) –

attribute_map = {'value': 'value'}

deserialized_types = {'value': 'ask_sdk_model.slu.entityresolution.value.Value'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.ui 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_sdk_model.ui.ask_for_permissions_consent_card module

class ask_sdk_model.ui.ask_for_permissions_consent_card.AskForPermissionsConsentCard(permissions=None)

Bases: ask_sdk_model.ui.card.Card

Parameters:permissions ((optional) list[str]) –

attribute_map = {'object_type': 'type', 'permissions': 'permissions'}

deserialized_types = {'object_type': 'str', 'permissions': 'list[str]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.ui.card module

class ask_sdk_model.ui.card.Card(object_type=None)

Bases: object

Parameters:object_type ((optional) str) –

Note

This is an abstract class. Use the following mapping, to figure out the model class to be instantiated, that sets type variable.

AskForPermissionsConsent: ask_sdk_model.ui.ask_for_permissions_consent_card.AskForPermissionsConsentCard,

LinkAccount: ask_sdk_model.ui.link_account_card.LinkAccountCard,

Standard: ask_sdk_model.ui.standard_card.StandardCard,

Simple: ask_sdk_model.ui.simple_card.SimpleCard

attribute_map = {'object_type': 'type'}

deserialized_types = {'object_type': 'str'}

discriminator_value_class_map = {'AskForPermissionsConsent': 'ask_sdk_model.ui.ask_for_permissions_consent_card.AskForPermissionsConsentCard', 'LinkAccount': 'ask_sdk_model.ui.link_account_card.LinkAccountCard', 'Simple': 'ask_sdk_model.ui.simple_card.SimpleCard', 'Standard': 'ask_sdk_model.ui.standard_card.StandardCard'}

classmethod get_real_child_model(data)

Returns the real base class specified by the discriminator

json_discriminator_key = 'type'

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.ui.image module

class ask_sdk_model.ui.image.Image(small_image_url=None, large_image_url=None)

Bases: object

Parameters:

• small_image_url ((optional) str) –
• large_image_url ((optional) str) –

attribute_map = {'large_image_url': 'largeImageUrl', 'small_image_url': 'smallImageUrl'}

deserialized_types = {'large_image_url': 'str', 'small_image_url': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.ui.link_account_card module

class ask_sdk_model.ui.link_account_card.LinkAccountCard

Bases: ask_sdk_model.ui.card.Card

attribute_map = {'object_type': 'type'}

deserialized_types = {'object_type': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.ui.output_speech module

class ask_sdk_model.ui.output_speech.OutputSpeech(object_type=None, play_behavior=None)

Bases: object

Parameters:

• object_type ((optional) str) –
• play_behavior ((optional) ask_sdk_model.ui.play_behavior.PlayBehavior) –

Note

This is an abstract class. Use the following mapping, to figure out the model class to be instantiated, that sets type variable.

SSML: ask_sdk_model.ui.ssml_output_speech.SsmlOutputSpeech,

PlainText: ask_sdk_model.ui.plain_text_output_speech.PlainTextOutputSpeech

attribute_map = {'object_type': 'type', 'play_behavior': 'playBehavior'}

deserialized_types = {'object_type': 'str', 'play_behavior': 'ask_sdk_model.ui.play_behavior.PlayBehavior'}

discriminator_value_class_map = {'PlainText': 'ask_sdk_model.ui.plain_text_output_speech.PlainTextOutputSpeech', 'SSML': 'ask_sdk_model.ui.ssml_output_speech.SsmlOutputSpeech'}

classmethod get_real_child_model(data)

Returns the real base class specified by the discriminator

json_discriminator_key = 'type'

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.ui.plain_text_output_speech module

class ask_sdk_model.ui.plain_text_output_speech.PlainTextOutputSpeech(play_behavior=None, text=None)

Bases: ask_sdk_model.ui.output_speech.OutputSpeech

Parameters:

• play_behavior ((optional) ask_sdk_model.ui.play_behavior.PlayBehavior) –
• text ((optional) str) –

attribute_map = {'object_type': 'type', 'play_behavior': 'playBehavior', 'text': 'text'}

deserialized_types = {'object_type': 'str', 'play_behavior': 'ask_sdk_model.ui.play_behavior.PlayBehavior', 'text': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.ui.play_behavior module

class ask_sdk_model.ui.play_behavior.PlayBehavior

Bases: enum.Enum

Determines whether Alexa will queue or play this output speech immediately interrupting other speech

Allowed enum values: [ENQUEUE, REPLACE_ALL, REPLACE_ENQUEUED]

ENQUEUE = 'ENQUEUE'

REPLACE_ALL = 'REPLACE_ALL'

REPLACE_ENQUEUED = 'REPLACE_ENQUEUED'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.ui.reprompt module

class ask_sdk_model.ui.reprompt.Reprompt(output_speech=None)

Bases: object

Parameters:output_speech ((optional) ask_sdk_model.ui.output_speech.OutputSpeech) –

attribute_map = {'output_speech': 'outputSpeech'}

deserialized_types = {'output_speech': 'ask_sdk_model.ui.output_speech.OutputSpeech'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.ui.simple_card module

class ask_sdk_model.ui.simple_card.SimpleCard(title=None, content=None)

Bases: ask_sdk_model.ui.card.Card

Parameters:

• title ((optional) str) –
• content ((optional) str) –

attribute_map = {'content': 'content', 'object_type': 'type', 'title': 'title'}

deserialized_types = {'content': 'str', 'object_type': 'str', 'title': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.ui.ssml_output_speech module

class ask_sdk_model.ui.ssml_output_speech.SsmlOutputSpeech(play_behavior=None, ssml=None)

Bases: ask_sdk_model.ui.output_speech.OutputSpeech

Parameters:

• play_behavior ((optional) ask_sdk_model.ui.play_behavior.PlayBehavior) –
• ssml ((optional) str) –

attribute_map = {'object_type': 'type', 'play_behavior': 'playBehavior', 'ssml': 'ssml'}

deserialized_types = {'object_type': 'str', 'play_behavior': 'ask_sdk_model.ui.play_behavior.PlayBehavior', 'ssml': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.ui.standard_card module

class ask_sdk_model.ui.standard_card.StandardCard(title=None, text=None, image=None)

Bases: ask_sdk_model.ui.card.Card

Parameters:

• title ((optional) str) –
• text ((optional) str) –
• image ((optional) ask_sdk_model.ui.image.Image) –

attribute_map = {'image': 'image', 'object_type': 'type', 'text': 'text', 'title': 'title'}

deserialized_types = {'image': 'ask_sdk_model.ui.image.Image', 'object_type': 'str', 'text': 'str', 'title': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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_sdk_model.application module

class ask_sdk_model.application.Application(application_id=None)

Bases: object

An object containing an application ID. This is used to verify that the request was intended for your service.

Parameters:application_id ((optional) str) – A string representing the application identifier for your skill.

attribute_map = {'application_id': 'applicationId'}

deserialized_types = {'application_id': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.cause module

class ask_sdk_model.cause.Cause(object_type=None)

Bases: object

Describes the type of the Cause.

Parameters:object_type ((optional) str) –

Note

This is an abstract class. Use the following mapping, to figure out the model class to be instantiated, that sets type variable.

ConnectionCompleted: ask_sdk_model.connection_completed.ConnectionCompleted

attribute_map = {'object_type': 'type'}

deserialized_types = {'object_type': 'str'}

discriminator_value_class_map = {'ConnectionCompleted': 'ask_sdk_model.connection_completed.ConnectionCompleted'}

classmethod get_real_child_model(data)

Returns the real base class specified by the discriminator

json_discriminator_key = 'type'

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.connection_completed module

class ask_sdk_model.connection_completed.ConnectionCompleted(token=None, status=None, result=None)

Bases: ask_sdk_model.cause.Cause

Represents the status and result needed to resume a skill's suspended session.

Parameters:

• token ((optional) str) – This is an echo back string that skills send when during Connections.StartConnection directive. They will receive it when they get the SessionResumedRequest. It is never sent to the skill handling the request.
• status ((optional) ask_sdk_model.status.Status) –
• result ((optional) object) – This is the result object to resume the skill's suspended session.

attribute_map = {'object_type': 'type', 'result': 'result', 'status': 'status', 'token': 'token'}

deserialized_types = {'object_type': 'str', 'result': 'object', 'status': 'ask_sdk_model.status.Status', 'token': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.context module

class ask_sdk_model.context.Context(system=None, alexa_presentation_apl=None, audio_player=None, automotive=None, display=None, geolocation=None, viewport=None, viewports=None)

Bases: object

Parameters:

• system ((optional) ask_sdk_model.interfaces.system.system_state.SystemState) – Provides information about the current state of the Alexa service and the device interacting with your skill.
• alexa_presentation_apl ((optional) ask_sdk_model.interfaces.alexa.presentation.apl.rendered_document_state.RenderedDocumentState) – Provides the current state for the Alexa.Presentation.APL interface.
• audio_player ((optional) ask_sdk_model.interfaces.audioplayer.audio_player_state.AudioPlayerState) – Provides the current state for the AudioPlayer interface.
• automotive ((optional) ask_sdk_model.interfaces.automotive.automotive_state.AutomotiveState) – Provides the automotive specific information of the device.
• display ((optional) ask_sdk_model.interfaces.display.display_state.DisplayState) – Provides the current state for the Display interface.
• geolocation ((optional) ask_sdk_model.interfaces.geolocation.geolocation_state.GeolocationState) – Provides the last gathered geolocation information of the device.
• viewport ((optional) ask_sdk_model.interfaces.viewport.viewport_state.ViewportState) – Provides the characteristics of a device's viewport.
• viewports ((optional) list[ask_sdk_model.interfaces.viewport.typed_viewport_state.TypedViewportState]) – This object contains a list of viewports characteristics related to the device's viewports.

attribute_map = {'alexa_presentation_apl': 'Alexa.Presentation.APL', 'audio_player': 'AudioPlayer', 'automotive': 'Automotive', 'display': 'Display', 'geolocation': 'Geolocation', 'system': 'System', 'viewport': 'Viewport', 'viewports': 'Viewports'}

deserialized_types = {'alexa_presentation_apl': 'ask_sdk_model.interfaces.alexa.presentation.apl.rendered_document_state.RenderedDocumentState', 'audio_player': 'ask_sdk_model.interfaces.audioplayer.audio_player_state.AudioPlayerState', 'automotive': 'ask_sdk_model.interfaces.automotive.automotive_state.AutomotiveState', 'display': 'ask_sdk_model.interfaces.display.display_state.DisplayState', 'geolocation': 'ask_sdk_model.interfaces.geolocation.geolocation_state.GeolocationState', 'system': 'ask_sdk_model.interfaces.system.system_state.SystemState', 'viewport': 'ask_sdk_model.interfaces.viewport.viewport_state.ViewportState', 'viewports': 'list[ask_sdk_model.interfaces.viewport.typed_viewport_state.TypedViewportState]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.device module

class ask_sdk_model.device.Device(device_id=None, supported_interfaces=None)

Bases: object

An object providing information about the device used to send the request. The device object contains both deviceId and supportedInterfaces properties. The deviceId property uniquely identifies the device. The supportedInterfaces property lists each interface that the device supports. For example, if supportedInterfaces includes AudioPlayer {}, then you know that the device supports streaming audio using the AudioPlayer interface.

Parameters:

• device_id ((optional) str) – The deviceId property uniquely identifies the device.
• supported_interfaces ((optional) ask_sdk_model.supported_interfaces.SupportedInterfaces) – Lists each interface that the device supports. For example, if supportedInterfaces includes AudioPlayer {}, then you know that the device supports streaming audio using the AudioPlayer interface

attribute_map = {'device_id': 'deviceId', 'supported_interfaces': 'supportedInterfaces'}

deserialized_types = {'device_id': 'str', 'supported_interfaces': 'ask_sdk_model.supported_interfaces.SupportedInterfaces'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.dialog_state module

class ask_sdk_model.dialog_state.DialogState

Bases: enum.Enum

Enumeration indicating the status of the multi-turn dialog. This property is included if the skill meets the requirements to use the Dialog directives. Note that COMPLETED is only possible when you use the Dialog.Delegate directive. If you use intent confirmation, dialogState is considered COMPLETED if the user denies the entire intent (for instance, by answering “no” when asked the confirmation prompt). Be sure to also check the confirmationStatus property on the Intent object before fulfilling the user’s request.

Allowed enum values: [STARTED, IN_PROGRESS, COMPLETED]

COMPLETED = 'COMPLETED'

IN_PROGRESS = 'IN_PROGRESS'

STARTED = 'STARTED'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.directive module

class ask_sdk_model.directive.Directive(object_type=None)

Bases: object

Parameters:object_type ((optional) str) –

Note

This is an abstract class. Use the following mapping, to figure out the model class to be instantiated, that sets type variable.

CustomInterfaceController.StopEventHandler: ask_sdk_model.interfaces.custom_interface_controller.stop_event_handler_directive.StopEventHandlerDirective,

Navigation.Assistance.AnnounceRoadRegulation: ask_sdk_model.interfaces.navigation.assistance.announce_road_regulation.AnnounceRoadRegulation,

Connections.SendRequest: ask_sdk_model.interfaces.connections.send_request_directive.SendRequestDirective,

Dialog.UpdateDynamicEntities: ask_sdk_model.dialog.dynamic_entities_directive.DynamicEntitiesDirective,

CustomInterfaceController.StartEventHandler: ask_sdk_model.interfaces.custom_interface_controller.start_event_handler_directive.StartEventHandlerDirective,

GadgetController.SetLight: ask_sdk_model.interfaces.gadget_controller.set_light_directive.SetLightDirective,

Alexa.Presentation.APL.SendIndexListData: ask_sdk_model.interfaces.alexa.presentation.apl.send_index_list_data_directive.SendIndexListDataDirective,

Dialog.Delegate: ask_sdk_model.dialog.delegate_directive.DelegateDirective,

Dialog.ConfirmIntent: ask_sdk_model.dialog.confirm_intent_directive.ConfirmIntentDirective,

CustomInterfaceController.SendDirective: ask_sdk_model.interfaces.custom_interface_controller.send_directive_directive.SendDirectiveDirective,

Alexa.Presentation.HTML.HandleMessage: ask_sdk_model.interfaces.alexa.presentation.html.handle_message_directive.HandleMessageDirective,

Dialog.ElicitSlot: ask_sdk_model.dialog.elicit_slot_directive.ElicitSlotDirective,

Alexa.Presentation.HTML.Start: ask_sdk_model.interfaces.alexa.presentation.html.start_directive.StartDirective,

AudioPlayer.Stop: ask_sdk_model.interfaces.audioplayer.stop_directive.StopDirective,

Dialog.ConfirmSlot: ask_sdk_model.dialog.confirm_slot_directive.ConfirmSlotDirective,

AudioPlayer.Play: ask_sdk_model.interfaces.audioplayer.play_directive.PlayDirective,

Alexa.Presentation.APL.ExecuteCommands: ask_sdk_model.interfaces.alexa.presentation.apl.execute_commands_directive.ExecuteCommandsDirective,

Display.RenderTemplate: ask_sdk_model.interfaces.display.render_template_directive.RenderTemplateDirective,

Hint: ask_sdk_model.interfaces.display.hint_directive.HintDirective,

Connections.StartConnection: ask_sdk_model.interfaces.connections.v1.start_connection_directive.StartConnectionDirective,

Alexa.Presentation.APLT.RenderDocument: ask_sdk_model.interfaces.alexa.presentation.aplt.render_document_directive.RenderDocumentDirective,

GameEngine.StartInputHandler: ask_sdk_model.interfaces.game_engine.start_input_handler_directive.StartInputHandlerDirective,

VideoApp.Launch: ask_sdk_model.interfaces.videoapp.launch_directive.LaunchDirective,

Alexa.Presentation.APLT.ExecuteCommands: ask_sdk_model.interfaces.alexa.presentation.aplt.execute_commands_directive.ExecuteCommandsDirective,

GameEngine.StopInputHandler: ask_sdk_model.interfaces.game_engine.stop_input_handler_directive.StopInputHandlerDirective,

Tasks.CompleteTask: ask_sdk_model.interfaces.tasks.complete_task_directive.CompleteTaskDirective,

Alexa.Presentation.APL.RenderDocument: ask_sdk_model.interfaces.alexa.presentation.apl.render_document_directive.RenderDocumentDirective,

Connections.SendResponse: ask_sdk_model.interfaces.connections.send_response_directive.SendResponseDirective,

AudioPlayer.ClearQueue: ask_sdk_model.interfaces.audioplayer.clear_queue_directive.ClearQueueDirective,

Alexa.Presentation.APL.UpdateIndexListData: ask_sdk_model.interfaces.alexa.presentation.apl.update_index_list_data_directive.UpdateIndexListDataDirective

attribute_map = {'object_type': 'type'}

deserialized_types = {'object_type': 'str'}

discriminator_value_class_map = {'Alexa.Presentation.APL.ExecuteCommands': 'ask_sdk_model.interfaces.alexa.presentation.apl.execute_commands_directive.ExecuteCommandsDirective', 'Alexa.Presentation.APL.RenderDocument': 'ask_sdk_model.interfaces.alexa.presentation.apl.render_document_directive.RenderDocumentDirective', 'Alexa.Presentation.APL.SendIndexListData': 'ask_sdk_model.interfaces.alexa.presentation.apl.send_index_list_data_directive.SendIndexListDataDirective', 'Alexa.Presentation.APL.UpdateIndexListData': 'ask_sdk_model.interfaces.alexa.presentation.apl.update_index_list_data_directive.UpdateIndexListDataDirective', 'Alexa.Presentation.APLT.ExecuteCommands': 'ask_sdk_model.interfaces.alexa.presentation.aplt.execute_commands_directive.ExecuteCommandsDirective', 'Alexa.Presentation.APLT.RenderDocument': 'ask_sdk_model.interfaces.alexa.presentation.aplt.render_document_directive.RenderDocumentDirective', 'Alexa.Presentation.HTML.HandleMessage': 'ask_sdk_model.interfaces.alexa.presentation.html.handle_message_directive.HandleMessageDirective', 'Alexa.Presentation.HTML.Start': 'ask_sdk_model.interfaces.alexa.presentation.html.start_directive.StartDirective', 'AudioPlayer.ClearQueue': 'ask_sdk_model.interfaces.audioplayer.clear_queue_directive.ClearQueueDirective', 'AudioPlayer.Play': 'ask_sdk_model.interfaces.audioplayer.play_directive.PlayDirective', 'AudioPlayer.Stop': 'ask_sdk_model.interfaces.audioplayer.stop_directive.StopDirective', 'Connections.SendRequest': 'ask_sdk_model.interfaces.connections.send_request_directive.SendRequestDirective', 'Connections.SendResponse': 'ask_sdk_model.interfaces.connections.send_response_directive.SendResponseDirective', 'Connections.StartConnection': 'ask_sdk_model.interfaces.connections.v1.start_connection_directive.StartConnectionDirective', 'CustomInterfaceController.SendDirective': 'ask_sdk_model.interfaces.custom_interface_controller.send_directive_directive.SendDirectiveDirective', 'CustomInterfaceController.StartEventHandler': 'ask_sdk_model.interfaces.custom_interface_controller.start_event_handler_directive.StartEventHandlerDirective', 'CustomInterfaceController.StopEventHandler': 'ask_sdk_model.interfaces.custom_interface_controller.stop_event_handler_directive.StopEventHandlerDirective', 'Dialog.ConfirmIntent': 'ask_sdk_model.dialog.confirm_intent_directive.ConfirmIntentDirective', 'Dialog.ConfirmSlot': 'ask_sdk_model.dialog.confirm_slot_directive.ConfirmSlotDirective', 'Dialog.Delegate': 'ask_sdk_model.dialog.delegate_directive.DelegateDirective', 'Dialog.ElicitSlot': 'ask_sdk_model.dialog.elicit_slot_directive.ElicitSlotDirective', 'Dialog.UpdateDynamicEntities': 'ask_sdk_model.dialog.dynamic_entities_directive.DynamicEntitiesDirective', 'Display.RenderTemplate': 'ask_sdk_model.interfaces.display.render_template_directive.RenderTemplateDirective', 'GadgetController.SetLight': 'ask_sdk_model.interfaces.gadget_controller.set_light_directive.SetLightDirective', 'GameEngine.StartInputHandler': 'ask_sdk_model.interfaces.game_engine.start_input_handler_directive.StartInputHandlerDirective', 'GameEngine.StopInputHandler': 'ask_sdk_model.interfaces.game_engine.stop_input_handler_directive.StopInputHandlerDirective', 'Hint': 'ask_sdk_model.interfaces.display.hint_directive.HintDirective', 'Navigation.Assistance.AnnounceRoadRegulation': 'ask_sdk_model.interfaces.navigation.assistance.announce_road_regulation.AnnounceRoadRegulation', 'Tasks.CompleteTask': 'ask_sdk_model.interfaces.tasks.complete_task_directive.CompleteTaskDirective', 'VideoApp.Launch': 'ask_sdk_model.interfaces.videoapp.launch_directive.LaunchDirective'}

classmethod get_real_child_model(data)

Returns the real base class specified by the discriminator

json_discriminator_key = 'type'

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.intent module

class ask_sdk_model.intent.Intent(name=None, slots=None, confirmation_status=None)

Bases: object

An object that represents what the user wants.

Parameters:

• name ((optional) str) – A string representing the name of the intent.
• slots ((optional) dict(str, ask_sdk_model.slot.Slot)) – A map of key-value pairs that further describes what the user meant based on a predefined intent schema. The map can be empty.
• confirmation_status ((optional) ask_sdk_model.intent_confirmation_status.IntentConfirmationStatus) –

attribute_map = {'confirmation_status': 'confirmationStatus', 'name': 'name', 'slots': 'slots'}

deserialized_types = {'confirmation_status': 'ask_sdk_model.intent_confirmation_status.IntentConfirmationStatus', 'name': 'str', 'slots': 'dict(str, ask_sdk_model.slot.Slot)'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.intent_confirmation_status module

class ask_sdk_model.intent_confirmation_status.IntentConfirmationStatus

Bases: enum.Enum

Indication of whether an intent or slot has been explicitly confirmed or denied by the user, or neither.

Allowed enum values: [NONE, DENIED, CONFIRMED]

CONFIRMED = 'CONFIRMED'

DENIED = 'DENIED'

NONE = 'NONE'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.intent_request module

class ask_sdk_model.intent_request.IntentRequest(request_id=None, timestamp=None, locale=None, dialog_state=None, intent=None)

Bases: ask_sdk_model.request.Request

An IntentRequest is an object that represents a request made to a skill based on what the user wants to do.

Parameters:

• request_id ((optional) str) – Represents the unique identifier for the specific request.
• timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
• locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
• dialog_state ((optional) ask_sdk_model.dialog_state.DialogState) – Enumeration indicating the status of the multi-turn dialog. This property is included if the skill meets the requirements to use the Dialog directives. Note that COMPLETED is only possible when you use the Dialog.Delegate directive. If you use intent confirmation, dialogState is considered COMPLETED if the user denies the entire intent (for instance, by answering “no” when asked the confirmation prompt). Be sure to also check the confirmationStatus property on the Intent object before fulfilling the user’s request.
• intent ((optional) ask_sdk_model.intent.Intent) – An object that represents what the user wants.

attribute_map = {'dialog_state': 'dialogState', 'intent': 'intent', 'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp'}

deserialized_types = {'dialog_state': 'ask_sdk_model.dialog_state.DialogState', 'intent': 'ask_sdk_model.intent.Intent', 'locale': 'str', 'object_type': 'str', 'request_id': 'str', 'timestamp': 'datetime'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.launch_request module

class ask_sdk_model.launch_request.LaunchRequest(request_id=None, timestamp=None, locale=None, task=None)

Bases: ask_sdk_model.request.Request

Represents that a user made a request to an Alexa skill, but did not provide a specific intent.

Parameters:

• request_id ((optional) str) – Represents the unique identifier for the specific request.
• timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
• locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
• task ((optional) ask_sdk_model.task.Task) –

attribute_map = {'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'task': 'task', 'timestamp': 'timestamp'}

deserialized_types = {'locale': 'str', 'object_type': 'str', 'request_id': 'str', 'task': 'ask_sdk_model.task.Task', 'timestamp': 'datetime'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.permission_status module

class ask_sdk_model.permission_status.PermissionStatus

Bases: enum.Enum

This denotes the status of the permission scope.

Allowed enum values: [GRANTED, DENIED]

DENIED = 'DENIED'

GRANTED = 'GRANTED'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.permissions module

class ask_sdk_model.permissions.Permissions(consent_token=None, scopes=None)

Bases: object

Contains a consentToken allowing the skill access to information that the customer has consented to provide, such as address information. Note that the consentToken is deprecated. Use the apiAccessToken available in the context object to determine the user’s permissions.

Parameters:

• consent_token ((optional) str) – A token listing all the permissions granted for this user.
• scopes ((optional) dict(str, ask_sdk_model.scope.Scope)) – A map where the key is a LoginWithAmazon(LWA) scope and value is a list of key:value pairs which describe the state of user actions on the LWA scope. For e.g. &quot;scopes&quot; :{ &quot;alexa::devices:all:geolocation:read&quot;:{&quot;status&quot;:&quot;GRANTED&quot;}} This value of &quot;alexa::devices:all:geolocation:read&quot; will determine if the Geolocation data access is granted by the user, or else it will show a card of type AskForPermissionsConsent to the user to get this permission.

attribute_map = {'consent_token': 'consentToken', 'scopes': 'scopes'}

deserialized_types = {'consent_token': 'str', 'scopes': 'dict(str, ask_sdk_model.scope.Scope)'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.person module

class ask_sdk_model.person.Person(person_id=None, access_token=None)

Bases: object

An object that describes the user (person) who is making the request.

Parameters:

• person_id ((optional) str) – A string that represents a unique identifier for the person who is making the request. The length of this identifier can vary, but is never more than 255 characters. It is generated when a recognized user makes a request to your skill.
• access_token ((optional) str) – A token identifying the user in another system. This is only provided if the recognized user has successfully linked their skill account with their Alexa profile. The accessToken field will not appear if null.

attribute_map = {'access_token': 'accessToken', 'person_id': 'personId'}

deserialized_types = {'access_token': 'str', 'person_id': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.request module

class ask_sdk_model.request.Request(object_type=None, request_id=None, timestamp=None, locale=None)

Bases: object

A request object that provides the details of the user’s request. The request body contains the parameters necessary for the service to perform its logic and generate a response.

Parameters:

• object_type ((optional) str) – Describes the type of the request.
• request_id ((optional) str) – Represents the unique identifier for the specific request.
• timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
• locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.

Note

This is an abstract class. Use the following mapping, to figure out the model class to be instantiated, that sets type variable.

AlexaSkillEvent.SkillEnabled: ask_sdk_model.events.skillevents.skill_enabled_request.SkillEnabledRequest,

AlexaHouseholdListEvent.ListUpdated: ask_sdk_model.services.list_management.list_updated_event_request.ListUpdatedEventRequest,

Alexa.Presentation.APL.UserEvent: ask_sdk_model.interfaces.alexa.presentation.apl.user_event.UserEvent,

AlexaSkillEvent.SkillDisabled: ask_sdk_model.events.skillevents.skill_disabled_request.SkillDisabledRequest,

AlexaHouseholdListEvent.ItemsCreated: ask_sdk_model.services.list_management.list_items_created_event_request.ListItemsCreatedEventRequest,

SessionResumedRequest: ask_sdk_model.session_resumed_request.SessionResumedRequest,

SessionEndedRequest: ask_sdk_model.session_ended_request.SessionEndedRequest,

Alexa.Presentation.APL.LoadIndexListData: ask_sdk_model.interfaces.alexa.presentation.apl.load_index_list_data_event.LoadIndexListDataEvent,

AudioPlayer.PlaybackFailed: ask_sdk_model.interfaces.audioplayer.playback_failed_request.PlaybackFailedRequest,

CanFulfillIntentRequest: ask_sdk_model.canfulfill.can_fulfill_intent_request.CanFulfillIntentRequest,

CustomInterfaceController.Expired: ask_sdk_model.interfaces.custom_interface_controller.expired_request.ExpiredRequest,

Alexa.Presentation.HTML.Message: ask_sdk_model.interfaces.alexa.presentation.html.message_request.MessageRequest,

LaunchRequest: ask_sdk_model.launch_request.LaunchRequest,

Reminders.ReminderCreated: ask_sdk_model.services.reminder_management.reminder_created_event_request.ReminderCreatedEventRequest,

Alexa.Presentation.APLT.UserEvent: ask_sdk_model.interfaces.alexa.presentation.aplt.user_event.UserEvent,

AlexaHouseholdListEvent.ItemsUpdated: ask_sdk_model.services.list_management.list_items_updated_event_request.ListItemsUpdatedEventRequest,

AlexaHouseholdListEvent.ListCreated: ask_sdk_model.services.list_management.list_created_event_request.ListCreatedEventRequest,

AudioPlayer.PlaybackStarted: ask_sdk_model.interfaces.audioplayer.playback_started_request.PlaybackStartedRequest,

AudioPlayer.PlaybackNearlyFinished: ask_sdk_model.interfaces.audioplayer.playback_nearly_finished_request.PlaybackNearlyFinishedRequest,

CustomInterfaceController.EventsReceived: ask_sdk_model.interfaces.custom_interface_controller.events_received_request.EventsReceivedRequest,

Reminders.ReminderStatusChanged: ask_sdk_model.services.reminder_management.reminder_status_changed_event_request.ReminderStatusChangedEventRequest,

AlexaHouseholdListEvent.ItemsDeleted: ask_sdk_model.services.list_management.list_items_deleted_event_request.ListItemsDeletedEventRequest,

Reminders.ReminderDeleted: ask_sdk_model.services.reminder_management.reminder_deleted_event_request.ReminderDeletedEventRequest,

Connections.Response: ask_sdk_model.interfaces.connections.connections_response.ConnectionsResponse,

AlexaHouseholdListEvent.ListDeleted: ask_sdk_model.services.list_management.list_deleted_event_request.ListDeletedEventRequest,

GameEngine.InputHandlerEvent: ask_sdk_model.interfaces.game_engine.input_handler_event_request.InputHandlerEventRequest,

PlaybackController.PauseCommandIssued: ask_sdk_model.interfaces.playbackcontroller.pause_command_issued_request.PauseCommandIssuedRequest,

PlaybackController.PlayCommandIssued: ask_sdk_model.interfaces.playbackcontroller.play_command_issued_request.PlayCommandIssuedRequest,

AudioPlayer.PlaybackFinished: ask_sdk_model.interfaces.audioplayer.playback_finished_request.PlaybackFinishedRequest,

AlexaSkillEvent.ProactiveSubscriptionChanged: ask_sdk_model.events.skillevents.proactive_subscription_changed_request.ProactiveSubscriptionChangedRequest,

Display.ElementSelected: ask_sdk_model.interfaces.display.element_selected_request.ElementSelectedRequest,

AlexaSkillEvent.SkillPermissionChanged: ask_sdk_model.events.skillevents.permission_changed_request.PermissionChangedRequest,

Reminders.ReminderUpdated: ask_sdk_model.services.reminder_management.reminder_updated_event_request.ReminderUpdatedEventRequest,

Alexa.Presentation.APL.RuntimeError: ask_sdk_model.interfaces.alexa.presentation.apl.runtime_error_event.RuntimeErrorEvent,

Alexa.Presentation.HTML.RuntimeError: ask_sdk_model.interfaces.alexa.presentation.html.runtime_error_request.RuntimeErrorRequest,

IntentRequest: ask_sdk_model.intent_request.IntentRequest,

Reminders.ReminderStarted: ask_sdk_model.services.reminder_management.reminder_started_event_request.ReminderStartedEventRequest,

AudioPlayer.PlaybackStopped: ask_sdk_model.interfaces.audioplayer.playback_stopped_request.PlaybackStoppedRequest,

PlaybackController.PreviousCommandIssued: ask_sdk_model.interfaces.playbackcontroller.previous_command_issued_request.PreviousCommandIssuedRequest,

AlexaSkillEvent.SkillAccountLinked: ask_sdk_model.events.skillevents.account_linked_request.AccountLinkedRequest,

Messaging.MessageReceived: ask_sdk_model.interfaces.messaging.message_received_request.MessageReceivedRequest,

Connections.Request: ask_sdk_model.interfaces.connections.connections_request.ConnectionsRequest,

System.ExceptionEncountered: ask_sdk_model.interfaces.system.exception_encountered_request.ExceptionEncounteredRequest,

AlexaSkillEvent.SkillPermissionAccepted: ask_sdk_model.events.skillevents.permission_accepted_request.PermissionAcceptedRequest,

PlaybackController.NextCommandIssued: ask_sdk_model.interfaces.playbackcontroller.next_command_issued_request.NextCommandIssuedRequest

attribute_map = {'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp'}

deserialized_types = {'locale': 'str', 'object_type': 'str', 'request_id': 'str', 'timestamp': 'datetime'}

discriminator_value_class_map = {'Alexa.Presentation.APL.LoadIndexListData': 'ask_sdk_model.interfaces.alexa.presentation.apl.load_index_list_data_event.LoadIndexListDataEvent', 'Alexa.Presentation.APL.RuntimeError': 'ask_sdk_model.interfaces.alexa.presentation.apl.runtime_error_event.RuntimeErrorEvent', 'Alexa.Presentation.APL.UserEvent': 'ask_sdk_model.interfaces.alexa.presentation.apl.user_event.UserEvent', 'Alexa.Presentation.APLT.UserEvent': 'ask_sdk_model.interfaces.alexa.presentation.aplt.user_event.UserEvent', 'Alexa.Presentation.HTML.Message': 'ask_sdk_model.interfaces.alexa.presentation.html.message_request.MessageRequest', 'Alexa.Presentation.HTML.RuntimeError': 'ask_sdk_model.interfaces.alexa.presentation.html.runtime_error_request.RuntimeErrorRequest', 'AlexaHouseholdListEvent.ItemsCreated': 'ask_sdk_model.services.list_management.list_items_created_event_request.ListItemsCreatedEventRequest', 'AlexaHouseholdListEvent.ItemsDeleted': 'ask_sdk_model.services.list_management.list_items_deleted_event_request.ListItemsDeletedEventRequest', 'AlexaHouseholdListEvent.ItemsUpdated': 'ask_sdk_model.services.list_management.list_items_updated_event_request.ListItemsUpdatedEventRequest', 'AlexaHouseholdListEvent.ListCreated': 'ask_sdk_model.services.list_management.list_created_event_request.ListCreatedEventRequest', 'AlexaHouseholdListEvent.ListDeleted': 'ask_sdk_model.services.list_management.list_deleted_event_request.ListDeletedEventRequest', 'AlexaHouseholdListEvent.ListUpdated': 'ask_sdk_model.services.list_management.list_updated_event_request.ListUpdatedEventRequest', 'AlexaSkillEvent.ProactiveSubscriptionChanged': 'ask_sdk_model.events.skillevents.proactive_subscription_changed_request.ProactiveSubscriptionChangedRequest', 'AlexaSkillEvent.SkillAccountLinked': 'ask_sdk_model.events.skillevents.account_linked_request.AccountLinkedRequest', 'AlexaSkillEvent.SkillDisabled': 'ask_sdk_model.events.skillevents.skill_disabled_request.SkillDisabledRequest', 'AlexaSkillEvent.SkillEnabled': 'ask_sdk_model.events.skillevents.skill_enabled_request.SkillEnabledRequest', 'AlexaSkillEvent.SkillPermissionAccepted': 'ask_sdk_model.events.skillevents.permission_accepted_request.PermissionAcceptedRequest', 'AlexaSkillEvent.SkillPermissionChanged': 'ask_sdk_model.events.skillevents.permission_changed_request.PermissionChangedRequest', 'AudioPlayer.PlaybackFailed': 'ask_sdk_model.interfaces.audioplayer.playback_failed_request.PlaybackFailedRequest', 'AudioPlayer.PlaybackFinished': 'ask_sdk_model.interfaces.audioplayer.playback_finished_request.PlaybackFinishedRequest', 'AudioPlayer.PlaybackNearlyFinished': 'ask_sdk_model.interfaces.audioplayer.playback_nearly_finished_request.PlaybackNearlyFinishedRequest', 'AudioPlayer.PlaybackStarted': 'ask_sdk_model.interfaces.audioplayer.playback_started_request.PlaybackStartedRequest', 'AudioPlayer.PlaybackStopped': 'ask_sdk_model.interfaces.audioplayer.playback_stopped_request.PlaybackStoppedRequest', 'CanFulfillIntentRequest': 'ask_sdk_model.canfulfill.can_fulfill_intent_request.CanFulfillIntentRequest', 'Connections.Request': 'ask_sdk_model.interfaces.connections.connections_request.ConnectionsRequest', 'Connections.Response': 'ask_sdk_model.interfaces.connections.connections_response.ConnectionsResponse', 'CustomInterfaceController.EventsReceived': 'ask_sdk_model.interfaces.custom_interface_controller.events_received_request.EventsReceivedRequest', 'CustomInterfaceController.Expired': 'ask_sdk_model.interfaces.custom_interface_controller.expired_request.ExpiredRequest', 'Display.ElementSelected': 'ask_sdk_model.interfaces.display.element_selected_request.ElementSelectedRequest', 'GameEngine.InputHandlerEvent': 'ask_sdk_model.interfaces.game_engine.input_handler_event_request.InputHandlerEventRequest', 'IntentRequest': 'ask_sdk_model.intent_request.IntentRequest', 'LaunchRequest': 'ask_sdk_model.launch_request.LaunchRequest', 'Messaging.MessageReceived': 'ask_sdk_model.interfaces.messaging.message_received_request.MessageReceivedRequest', 'PlaybackController.NextCommandIssued': 'ask_sdk_model.interfaces.playbackcontroller.next_command_issued_request.NextCommandIssuedRequest', 'PlaybackController.PauseCommandIssued': 'ask_sdk_model.interfaces.playbackcontroller.pause_command_issued_request.PauseCommandIssuedRequest', 'PlaybackController.PlayCommandIssued': 'ask_sdk_model.interfaces.playbackcontroller.play_command_issued_request.PlayCommandIssuedRequest', 'PlaybackController.PreviousCommandIssued': 'ask_sdk_model.interfaces.playbackcontroller.previous_command_issued_request.PreviousCommandIssuedRequest', 'Reminders.ReminderCreated': 'ask_sdk_model.services.reminder_management.reminder_created_event_request.ReminderCreatedEventRequest', 'Reminders.ReminderDeleted': 'ask_sdk_model.services.reminder_management.reminder_deleted_event_request.ReminderDeletedEventRequest', 'Reminders.ReminderStarted': 'ask_sdk_model.services.reminder_management.reminder_started_event_request.ReminderStartedEventRequest', 'Reminders.ReminderStatusChanged': 'ask_sdk_model.services.reminder_management.reminder_status_changed_event_request.ReminderStatusChangedEventRequest', 'Reminders.ReminderUpdated': 'ask_sdk_model.services.reminder_management.reminder_updated_event_request.ReminderUpdatedEventRequest', 'SessionEndedRequest': 'ask_sdk_model.session_ended_request.SessionEndedRequest', 'SessionResumedRequest': 'ask_sdk_model.session_resumed_request.SessionResumedRequest', 'System.ExceptionEncountered': 'ask_sdk_model.interfaces.system.exception_encountered_request.ExceptionEncounteredRequest'}

classmethod get_real_child_model(data)

Returns the real base class specified by the discriminator

json_discriminator_key = 'type'

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.request_envelope module

class ask_sdk_model.request_envelope.RequestEnvelope(version=None, session=None, context=None, request=None)

Bases: object

Request wrapper for all requests sent to your Skill.

Parameters:

• version ((optional) str) – The version specifier for the request.
• session ((optional) ask_sdk_model.session.Session) – The session object provides additional context associated with the request.
• context ((optional) ask_sdk_model.context.Context) – The context object provides your skill with information about the current state of the Alexa service and device at the time the request is sent to your service. This is included on all requests. For requests sent in the context of a session (LaunchRequest and IntentRequest), the context object duplicates the user and application information that is also available in the session.
• request ((optional) ask_sdk_model.request.Request) – A request object that provides the details of the user’s request.

attribute_map = {'context': 'context', 'request': 'request', 'session': 'session', 'version': 'version'}

deserialized_types = {'context': 'ask_sdk_model.context.Context', 'request': 'ask_sdk_model.request.Request', 'session': 'ask_sdk_model.session.Session', 'version': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.response module

class ask_sdk_model.response.Response(output_speech=None, card=None, reprompt=None, directives=None, should_end_session=None, can_fulfill_intent=None)

Bases: object

Parameters:

• output_speech ((optional) ask_sdk_model.ui.output_speech.OutputSpeech) –
• card ((optional) ask_sdk_model.ui.card.Card) –
• reprompt ((optional) ask_sdk_model.ui.reprompt.Reprompt) –
• directives ((optional) list[ask_sdk_model.directive.Directive]) –
• should_end_session ((optional) bool) –
• can_fulfill_intent ((optional) ask_sdk_model.canfulfill.can_fulfill_intent.CanFulfillIntent) –

attribute_map = {'can_fulfill_intent': 'canFulfillIntent', 'card': 'card', 'directives': 'directives', 'output_speech': 'outputSpeech', 'reprompt': 'reprompt', 'should_end_session': 'shouldEndSession'}

deserialized_types = {'can_fulfill_intent': 'ask_sdk_model.canfulfill.can_fulfill_intent.CanFulfillIntent', 'card': 'ask_sdk_model.ui.card.Card', 'directives': 'list[ask_sdk_model.directive.Directive]', 'output_speech': 'ask_sdk_model.ui.output_speech.OutputSpeech', 'reprompt': 'ask_sdk_model.ui.reprompt.Reprompt', 'should_end_session': 'bool'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.response_envelope module

class ask_sdk_model.response_envelope.ResponseEnvelope(version=None, session_attributes=None, user_agent=None, response=None)

Bases: object

Parameters:

• version ((optional) str) –
• session_attributes ((optional) dict(str, object)) –
• user_agent ((optional) str) –
• response ((optional) ask_sdk_model.response.Response) –

attribute_map = {'response': 'response', 'session_attributes': 'sessionAttributes', 'user_agent': 'userAgent', 'version': 'version'}

deserialized_types = {'response': 'ask_sdk_model.response.Response', 'session_attributes': 'dict(str, object)', 'user_agent': 'str', 'version': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.scope module

class ask_sdk_model.scope.Scope(status=None)

Bases: object

This is the value of LoginWithAmazon(LWA) consent scope. This object is used as in the key-value pairs that are provided in user.permissions.scopes object

Parameters:status ((optional) ask_sdk_model.permission_status.PermissionStatus) –

attribute_map = {'status': 'status'}

deserialized_types = {'status': 'ask_sdk_model.permission_status.PermissionStatus'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.session module

class ask_sdk_model.session.Session(new=None, session_id=None, user=None, attributes=None, application=None)

Bases: object

Represents a single execution of the alexa service

Parameters:

• new ((optional) bool) – A boolean value indicating whether this is a new session. Returns true for a new session or false for an existing session.
• session_id ((optional) str) – A string that represents a unique identifier per a user’s active session.
• user ((optional) ask_sdk_model.user.User) – An object that describes the user making the request.
• attributes ((optional) dict(str, object)) – A map of key-value pairs. The attributes map is empty for requests where a new session has started with the property new set to true. When returning your response, you can include data you need to persist during the session in the sessionAttributes property. The attributes you provide are then passed back to your skill on the next request.
• application ((optional) ask_sdk_model.application.Application) –

attribute_map = {'application': 'application', 'attributes': 'attributes', 'new': 'new', 'session_id': 'sessionId', 'user': 'user'}

deserialized_types = {'application': 'ask_sdk_model.application.Application', 'attributes': 'dict(str, object)', 'new': 'bool', 'session_id': 'str', 'user': 'ask_sdk_model.user.User'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.session_ended_error module

class ask_sdk_model.session_ended_error.SessionEndedError(object_type=None, message=None)

Bases: object

An error object providing more information about the error that occurred.

Parameters:

• object_type ((optional) ask_sdk_model.session_ended_error_type.SessionEndedErrorType) – A string indicating the type of error that occurred.
• message ((optional) str) – A string providing more information about the error.

attribute_map = {'message': 'message', 'object_type': 'type'}

deserialized_types = {'message': 'str', 'object_type': 'ask_sdk_model.session_ended_error_type.SessionEndedErrorType'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.session_ended_error_type module

class ask_sdk_model.session_ended_error_type.SessionEndedErrorType

Bases: enum.Enum

A string indicating the type of error that occurred.

Allowed enum values: [INVALID_RESPONSE, DEVICE_COMMUNICATION_ERROR, INTERNAL_SERVICE_ERROR, ENDPOINT_TIMEOUT]

DEVICE_COMMUNICATION_ERROR = 'DEVICE_COMMUNICATION_ERROR'

ENDPOINT_TIMEOUT = 'ENDPOINT_TIMEOUT'

INTERNAL_SERVICE_ERROR = 'INTERNAL_SERVICE_ERROR'

INVALID_RESPONSE = 'INVALID_RESPONSE'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.session_ended_reason module

class ask_sdk_model.session_ended_reason.SessionEndedReason

Bases: enum.Enum

The reason why session ended when not initiated from the Skill itself.

Allowed enum values: [USER_INITIATED, ERROR, EXCEEDED_MAX_REPROMPTS]

ERROR = 'ERROR'

EXCEEDED_MAX_REPROMPTS = 'EXCEEDED_MAX_REPROMPTS'

USER_INITIATED = 'USER_INITIATED'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.session_ended_request module

class ask_sdk_model.session_ended_request.SessionEndedRequest(request_id=None, timestamp=None, locale=None, reason=None, error=None)

Bases: ask_sdk_model.request.Request

A SessionEndedRequest is an object that represents a request made to an Alexa skill to notify that a session was ended. Your service receives a SessionEndedRequest when a currently open session is closed for one of the following reasons: &lt;ol&gt;&lt;li&gt;The user says “exit”&lt;/li&gt;&lt;li&gt;the user does not respond or says something that does not match an intent defined in your voice interface while the device is listening for the user’s response&lt;/li&gt;&lt;li&gt;an error occurs&lt;/li&gt;&lt;/ol&gt;

Parameters:

• request_id ((optional) str) – Represents the unique identifier for the specific request.
• timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
• locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
• reason ((optional) ask_sdk_model.session_ended_reason.SessionEndedReason) – Describes why the session ended.
• error ((optional) ask_sdk_model.session_ended_error.SessionEndedError) – An error object providing more information about the error that occurred.

attribute_map = {'error': 'error', 'locale': 'locale', 'object_type': 'type', 'reason': 'reason', 'request_id': 'requestId', 'timestamp': 'timestamp'}

deserialized_types = {'error': 'ask_sdk_model.session_ended_error.SessionEndedError', 'locale': 'str', 'object_type': 'str', 'reason': 'ask_sdk_model.session_ended_reason.SessionEndedReason', 'request_id': 'str', 'timestamp': 'datetime'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.session_resumed_request module

class ask_sdk_model.session_resumed_request.SessionResumedRequest(request_id=None, timestamp=None, locale=None, cause=None)

Bases: ask_sdk_model.request.Request

The request to resume a skill's session and tells the skill why it is resumed.

Parameters:

• request_id ((optional) str) – Represents the unique identifier for the specific request.
• timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
• locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
• cause ((optional) ask_sdk_model.cause.Cause) –

attribute_map = {'cause': 'cause', 'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp'}

deserialized_types = {'cause': 'ask_sdk_model.cause.Cause', 'locale': 'str', 'object_type': 'str', 'request_id': 'str', 'timestamp': 'datetime'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.slot module

class ask_sdk_model.slot.Slot(name=None, value=None, confirmation_status=None, resolutions=None)

Bases: object

Parameters:

• name ((optional) str) – A string that represents the name of the slot.
• value ((optional) str) – A string that represents the value the user spoke for the slot. This is the actual value the user spoke, not necessarily the canonical value or one of the synonyms defined for the entity. Note that AMAZON.LITERAL slot values sent to your service are always in all lower case.
• confirmation_status ((optional) ask_sdk_model.slot_confirmation_status.SlotConfirmationStatus) – Indication of whether an intent or slot has been explicitly confirmed or denied by the user, or neither.
• resolutions ((optional) ask_sdk_model.slu.entityresolution.resolutions.Resolutions) – Contains the results of entity resolution. These are organized by authority. An authority represents the source for the data provided for the slot. For a custom slot type, the authority is the slot type you defined.

attribute_map = {'confirmation_status': 'confirmationStatus', 'name': 'name', 'resolutions': 'resolutions', 'value': 'value'}

deserialized_types = {'confirmation_status': 'ask_sdk_model.slot_confirmation_status.SlotConfirmationStatus', 'name': 'str', 'resolutions': 'ask_sdk_model.slu.entityresolution.resolutions.Resolutions', 'value': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.slot_confirmation_status module

class ask_sdk_model.slot_confirmation_status.SlotConfirmationStatus

Bases: enum.Enum

An enumeration indicating whether the user has explicitly confirmed or denied the value of this slot.

Allowed enum values: [NONE, DENIED, CONFIRMED]

CONFIRMED = 'CONFIRMED'

DENIED = 'DENIED'

NONE = 'NONE'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.status module

class ask_sdk_model.status.Status(code=None, message=None)

Bases: object

Status indicates a high level understanding of the result of an execution.

Parameters:

• code ((optional) str) – This is a code signifying the status of the execution initiated by the skill. Protocol adheres to HTTP status codes.
• message ((optional) str) – This is a message that goes along with response code that can provide more information about what occurred.

attribute_map = {'code': 'code', 'message': 'message'}

deserialized_types = {'code': 'str', 'message': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.supported_interfaces module

class ask_sdk_model.supported_interfaces.SupportedInterfaces(alexa_presentation_apl=None, alexa_presentation_aplt=None, alexa_presentation_html=None, audio_player=None, display=None, video_app=None, geolocation=None, navigation=None)

Bases: object

An object listing each interface that the device supports. For example, if supportedInterfaces includes AudioPlayer {}, then you know that the device supports streaming audio using the AudioPlayer interface.

Parameters:

• alexa_presentation_apl ((optional) ask_sdk_model.interfaces.alexa.presentation.apl.alexa_presentation_apl_interface.AlexaPresentationAplInterface) –
• alexa_presentation_aplt ((optional) ask_sdk_model.interfaces.alexa.presentation.aplt.alexa_presentation_aplt_interface.AlexaPresentationApltInterface) –
• alexa_presentation_html ((optional) ask_sdk_model.interfaces.alexa.presentation.html.alexa_presentation_html_interface.AlexaPresentationHtmlInterface) –
• audio_player ((optional) ask_sdk_model.interfaces.audioplayer.audio_player_interface.AudioPlayerInterface) –
• display ((optional) ask_sdk_model.interfaces.display.display_interface.DisplayInterface) –
• video_app ((optional) ask_sdk_model.interfaces.videoapp.video_app_interface.VideoAppInterface) –
• geolocation ((optional) ask_sdk_model.interfaces.geolocation.geolocation_interface.GeolocationInterface) –
• navigation ((optional) ask_sdk_model.interfaces.navigation.navigation_interface.NavigationInterface) –

attribute_map = {'alexa_presentation_apl': 'Alexa.Presentation.APL', 'alexa_presentation_aplt': 'Alexa.Presentation.APLT', 'alexa_presentation_html': 'Alexa.Presentation.HTML', 'audio_player': 'AudioPlayer', 'display': 'Display', 'geolocation': 'Geolocation', 'navigation': 'Navigation', 'video_app': 'VideoApp'}

deserialized_types = {'alexa_presentation_apl': 'ask_sdk_model.interfaces.alexa.presentation.apl.alexa_presentation_apl_interface.AlexaPresentationAplInterface', 'alexa_presentation_aplt': 'ask_sdk_model.interfaces.alexa.presentation.aplt.alexa_presentation_aplt_interface.AlexaPresentationApltInterface', 'alexa_presentation_html': 'ask_sdk_model.interfaces.alexa.presentation.html.alexa_presentation_html_interface.AlexaPresentationHtmlInterface', 'audio_player': 'ask_sdk_model.interfaces.audioplayer.audio_player_interface.AudioPlayerInterface', 'display': 'ask_sdk_model.interfaces.display.display_interface.DisplayInterface', 'geolocation': 'ask_sdk_model.interfaces.geolocation.geolocation_interface.GeolocationInterface', 'navigation': 'ask_sdk_model.interfaces.navigation.navigation_interface.NavigationInterface', 'video_app': 'ask_sdk_model.interfaces.videoapp.video_app_interface.VideoAppInterface'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.task module

class ask_sdk_model.task.Task(name=None, version=None, input=None)

Bases: object

This object encapsulates a specific functionality.

Parameters:

• name ((optional) str) – Represents the name of the task.
• version ((optional) str) – Represents the version of the task.
• input ((optional) object) – Represents the input to handle the task.

attribute_map = {'input': 'input', 'name': 'name', 'version': 'version'}

deserialized_types = {'input': 'object', 'name': 'str', 'version': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.user module

class ask_sdk_model.user.User(user_id=None, access_token=None, permissions=None)

Bases: object

An object that describes the Amazon account for which the skill is enabled.

Parameters:

• user_id ((optional) str) – A string that represents a unique identifier for the user who made the request. The length of this identifier can vary, but is never more than 255 characters. The userId is automatically generated when a user enables the skill in the Alexa app. Note: Disabling and re-enabling a skill generates a new identifier.
• access_token ((optional) str) – A token identifying the user in another system. This is only provided if the user has successfully linked their skill account with their Amazon account.
• permissions ((optional) ask_sdk_model.permissions.Permissions) –

attribute_map = {'access_token': 'accessToken', 'permissions': 'permissions', 'user_id': 'userId'}

deserialized_types = {'access_token': 'str', 'permissions': 'ask_sdk_model.permissions.Permissions', 'user_id': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ASK SMAPI Models :ask_smapi_model package

The ASK SMAPI Model classes contain the model definitions for Skill Management APIs (SMAPI) by the Software Development Kit (SDK) team for Python. It allows Python developers to model the requests, responses and related JSON structures, as defined in SMAPI Documentation.

Subpackages

ask_smapi_model.services package

Subpackages

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]

ask_smapi_model.v1 package

Subpackages

ask_smapi_model.v1.catalog package

Subpackages

ask_smapi_model.v1.catalog.upload 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.v1.catalog.upload.catalog_upload_base module

class ask_smapi_model.v1.catalog.upload.catalog_upload_base.CatalogUploadBase

Bases: object

attribute_map = {}

deserialized_types = {}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.catalog.upload.content_upload_file_summary module

class ask_smapi_model.v1.catalog.upload.content_upload_file_summary.ContentUploadFileSummary(download_url=None, expires_at=None, status=None)

Bases: object

Parameters:

• download_url ((optional) str) – If the file is available for download, downloadUrl can be used to download the file.
• expires_at ((optional) datetime) –
• status ((optional) ask_smapi_model.v1.catalog.upload.file_upload_status.FileUploadStatus) –

attribute_map = {'download_url': 'downloadUrl', 'expires_at': 'expiresAt', 'status': 'status'}

deserialized_types = {'download_url': 'str', 'expires_at': 'datetime', 'status': 'ask_smapi_model.v1.catalog.upload.file_upload_status.FileUploadStatus'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.catalog.upload.file_upload_status module

class ask_smapi_model.v1.catalog.upload.file_upload_status.FileUploadStatus

Bases: enum.Enum

Value of status depends on if file is available for download or not.

Allowed enum values: [PENDING, AVAILABLE, PURGED, UNAVAILABLE]

AVAILABLE = 'AVAILABLE'

PENDING = 'PENDING'

PURGED = 'PURGED'

UNAVAILABLE = 'UNAVAILABLE'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.catalog.upload.get_content_upload_response module

class ask_smapi_model.v1.catalog.upload.get_content_upload_response.GetContentUploadResponse(id=None, catalog_id=None, status=None, created_date=None, last_updated_date=None, file=None, ingestion_steps=None)

Bases: object

Parameters:

• id ((optional) str) – Unique identifier of the upload
• catalog_id ((optional) str) – Unique identifier of the added catalog object
• status ((optional) ask_smapi_model.v1.catalog.upload.upload_status.UploadStatus) –
• created_date ((optional) datetime) –
• last_updated_date ((optional) datetime) –
• file ((optional) ask_smapi_model.v1.catalog.upload.content_upload_file_summary.ContentUploadFileSummary) –
• ingestion_steps ((optional) list[ask_smapi_model.v1.catalog.upload.upload_ingestion_step.UploadIngestionStep]) – List of different steps performed on the upload.

attribute_map = {'catalog_id': 'catalogId', 'created_date': 'createdDate', 'file': 'file', 'id': 'id', 'ingestion_steps': 'ingestionSteps', 'last_updated_date': 'lastUpdatedDate', 'status': 'status'}

deserialized_types = {'catalog_id': 'str', 'created_date': 'datetime', 'file': 'ask_smapi_model.v1.catalog.upload.content_upload_file_summary.ContentUploadFileSummary', 'id': 'str', 'ingestion_steps': 'list[ask_smapi_model.v1.catalog.upload.upload_ingestion_step.UploadIngestionStep]', 'last_updated_date': 'datetime', 'status': 'ask_smapi_model.v1.catalog.upload.upload_status.UploadStatus'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.catalog.upload.ingestion_status module

class ask_smapi_model.v1.catalog.upload.ingestion_status.IngestionStatus

Bases: enum.Enum

Allowed enum values: [PENDING, IN_PROGRESS, FAILED, SUCCEEDED, CANCELLED]

CANCELLED = 'CANCELLED'

FAILED = 'FAILED'

IN_PROGRESS = 'IN_PROGRESS'

PENDING = 'PENDING'

SUCCEEDED = 'SUCCEEDED'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.catalog.upload.ingestion_step_name module

class ask_smapi_model.v1.catalog.upload.ingestion_step_name.IngestionStepName

Bases: enum.Enum

Allowed enum values: [UPLOAD, SCHEMA_VALIDATION]

SCHEMA_VALIDATION = 'SCHEMA_VALIDATION'

UPLOAD = 'UPLOAD'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.catalog.upload.location module

class ask_smapi_model.v1.catalog.upload.location.Location(location=None)

Bases: ask_smapi_model.v1.catalog.upload.catalog_upload_base.CatalogUploadBase

Request body for self-hosted catalog uploads

Parameters:location ((optional) str) – self hosted url location.

attribute_map = {'location': 'location'}

deserialized_types = {'location': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.catalog.upload.pre_signed_url module

class ask_smapi_model.v1.catalog.upload.pre_signed_url.PreSignedUrl(url_id=None, part_e_tags=None)

Bases: ask_smapi_model.v1.catalog.upload.catalog_upload_base.CatalogUploadBase

Request body for self-hosted catalog uploads

Parameters:

• url_id ((optional) str) – Unique identifier for urls
• part_e_tags ((optional) list[ask_smapi_model.v1.catalog.upload.pre_signed_url_item.PreSignedUrlItem]) – List of (eTag, part number) pairs for each part of the file uploaded

attribute_map = {'part_e_tags': 'partETags', 'url_id': 'urlId'}

deserialized_types = {'part_e_tags': 'list[ask_smapi_model.v1.catalog.upload.pre_signed_url_item.PreSignedUrlItem]', 'url_id': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.catalog.upload.pre_signed_url_item module

class ask_smapi_model.v1.catalog.upload.pre_signed_url_item.PreSignedUrlItem(e_tag=None, part_number=None)

Bases: object

Parameters:

• e_tag ((optional) str) –
• part_number ((optional) int) –

attribute_map = {'e_tag': 'eTag', 'part_number': 'partNumber'}

deserialized_types = {'e_tag': 'str', 'part_number': 'int'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.catalog.upload.upload_ingestion_step module

class ask_smapi_model.v1.catalog.upload.upload_ingestion_step.UploadIngestionStep(name=None, status=None, log_url=None, violations=None)

Bases: object

Represents a single step in the multi-step ingestion process of a new upload.

Parameters:

• name ((optional) ask_smapi_model.v1.catalog.upload.ingestion_step_name.IngestionStepName) –
• status ((optional) ask_smapi_model.v1.catalog.upload.ingestion_status.IngestionStatus) –
• log_url ((optional) str) – Url for the file containing logs of ingestion step.
• violations ((optional) list[ask_smapi_model.v1.error.Error]) – This array will contain the violations occurred during the execution of step. Will be empty, if execution succeeded.

attribute_map = {'log_url': 'logUrl', 'name': 'name', 'status': 'status', 'violations': 'violations'}

deserialized_types = {'log_url': 'str', 'name': 'ask_smapi_model.v1.catalog.upload.ingestion_step_name.IngestionStepName', 'status': 'ask_smapi_model.v1.catalog.upload.ingestion_status.IngestionStatus', 'violations': 'list[ask_smapi_model.v1.error.Error]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.catalog.upload.upload_status module

class ask_smapi_model.v1.catalog.upload.upload_status.UploadStatus

Bases: enum.Enum

Status of the entire upload.

Allowed enum values: [PENDING, IN_PROGRESS, FAILED, SUCCEEDED]

FAILED = 'FAILED'

IN_PROGRESS = 'IN_PROGRESS'

PENDING = 'PENDING'

SUCCEEDED = 'SUCCEEDED'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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.v1.catalog.create_content_upload_url_request module

class ask_smapi_model.v1.catalog.create_content_upload_url_request.CreateContentUploadUrlRequest(number_of_upload_parts=None)

Bases: object

Parameters:number_of_upload_parts ((optional) int) – Provides the number of parts the file will be split into. An equal number of presigned upload urls are generated in response to facilitate each part's upload.

attribute_map = {'number_of_upload_parts': 'numberOfUploadParts'}

deserialized_types = {'number_of_upload_parts': 'int'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.catalog.create_content_upload_url_response module

class ask_smapi_model.v1.catalog.create_content_upload_url_response.CreateContentUploadUrlResponse(url_id=None, pre_signed_upload_parts=None)

Bases: object

Parameters:

• url_id ((optional) str) – Unique identifier for collection of generated urls.
• pre_signed_upload_parts ((optional) list[ask_smapi_model.v1.catalog.presigned_upload_part_items.PresignedUploadPartItems]) – Ordered list of presigned upload parts to perform a partitioned (multipart) file upload

attribute_map = {'pre_signed_upload_parts': 'preSignedUploadParts', 'url_id': 'urlId'}

deserialized_types = {'pre_signed_upload_parts': 'list[ask_smapi_model.v1.catalog.presigned_upload_part_items.PresignedUploadPartItems]', 'url_id': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.catalog.presigned_upload_part_items module

class ask_smapi_model.v1.catalog.presigned_upload_part_items.PresignedUploadPartItems(url=None, part_number=None, expires_at=None)

Bases: object

Parameters:

• url ((optional) str) –
• part_number ((optional) int) –
• expires_at ((optional) datetime) –

attribute_map = {'expires_at': 'expiresAt', 'part_number': 'partNumber', 'url': 'url'}

deserialized_types = {'expires_at': 'datetime', 'part_number': 'int', 'url': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.isp 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.v1.isp.associated_skill_response module

class ask_smapi_model.v1.isp.associated_skill_response.AssociatedSkillResponse(associated_skill_ids=None, links=None, is_truncated=None, next_token=None)

Bases: object

In-skill product skill association details.

Parameters:

• associated_skill_ids ((optional) list[str]) – List of skill IDs that correspond to the skills associated with the in-skill product. The associations are stage specific. A live association is created through successful skill certification.
• links ((optional) ask_smapi_model.v1.links.Links) –
• is_truncated ((optional) bool) –
• next_token ((optional) str) –

attribute_map = {'associated_skill_ids': 'associatedSkillIds', 'is_truncated': 'isTruncated', 'links': '_links', 'next_token': 'nextToken'}

deserialized_types = {'associated_skill_ids': 'list[str]', 'is_truncated': 'bool', 'links': 'ask_smapi_model.v1.links.Links', 'next_token': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.isp.create_in_skill_product_request module

class ask_smapi_model.v1.isp.create_in_skill_product_request.CreateInSkillProductRequest(vendor_id=None, in_skill_product_definition=None)

Bases: object

Parameters:

• vendor_id ((optional) str) – ID of the vendor owning the in-skill product.
• in_skill_product_definition ((optional) ask_smapi_model.v1.isp.in_skill_product_definition.InSkillProductDefinition) –

attribute_map = {'in_skill_product_definition': 'inSkillProductDefinition', 'vendor_id': 'vendorId'}

deserialized_types = {'in_skill_product_definition': 'ask_smapi_model.v1.isp.in_skill_product_definition.InSkillProductDefinition', 'vendor_id': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.isp.currency module

class ask_smapi_model.v1.isp.currency.Currency

Bases: enum.Enum

Currency to use for in-skill product.

Allowed enum values: [USD, GBP, EUR, JPY]

EUR = 'EUR'

GBP = 'GBP'

JPY = 'JPY'

USD = 'USD'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.isp.custom_product_prompts module

class ask_smapi_model.v1.isp.custom_product_prompts.CustomProductPrompts(purchase_prompt_description=None, bought_confirmation_prompt=None)

Bases: object

Custom prompts used for in-skill product purchasing options. Supports Speech Synthesis Markup Language (SSML), which can be used to control pronunciation, intonation, timing, and emotion.

Parameters:

• purchase_prompt_description ((optional) str) – Description of in-skill product heard before customer is prompted for purchase.
• bought_confirmation_prompt ((optional) str) – Confirmation of in-skill product purchase.

attribute_map = {'bought_confirmation_prompt': 'boughtConfirmationPrompt', 'purchase_prompt_description': 'purchasePromptDescription'}

deserialized_types = {'bought_confirmation_prompt': 'str', 'purchase_prompt_description': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.isp.distribution_countries module

class ask_smapi_model.v1.isp.distribution_countries.DistributionCountries

Bases: enum.Enum

Allowed enum values: [AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, HR, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IQ, IE, IM, IL, IT, CI, JM, JP, JE, JO, KZ, KE, KI, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SK, SI, SB, SO, ZA, GS, ES, LK, SR, SJ, SZ, SE, CH, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW]

AD = 'AD'

AE = 'AE'

AF = 'AF'

AG = 'AG'

AI = 'AI'

AL = 'AL'

AM = 'AM'

AN = 'AN'

AO = 'AO'

AQ = 'AQ'

AR = 'AR'

AS = 'AS'

AT = 'AT'

AU = 'AU'

AW = 'AW'

AX = 'AX'

AZ = 'AZ'

BA = 'BA'

BB = 'BB'

BD = 'BD'

BE = 'BE'

BF = 'BF'

BG = 'BG'

BH = 'BH'

BI = 'BI'

BJ = 'BJ'

BL = 'BL'

BM = 'BM'

BN = 'BN'

BO = 'BO'

BR = 'BR'

BS = 'BS'

BT = 'BT'

BV = 'BV'

BW = 'BW'

BY = 'BY'

BZ = 'BZ'

CA = 'CA'

CC = 'CC'

CD = 'CD'

CF = 'CF'

CG = 'CG'

CH = 'CH'

CI = 'CI'

CK = 'CK'

CL = 'CL'

CM = 'CM'

CN = 'CN'

CO = 'CO'

CR = 'CR'

CV = 'CV'

CX = 'CX'

CY = 'CY'

CZ = 'CZ'

DE = 'DE'

DJ = 'DJ'

DK = 'DK'

DM = 'DM'

DO = 'DO'

DZ = 'DZ'

EC = 'EC'

EE = 'EE'

EG = 'EG'

EH = 'EH'

ER = 'ER'

ES = 'ES'

ET = 'ET'

FI = 'FI'

FJ = 'FJ'

FK = 'FK'

FM = 'FM'

FO = 'FO'

FR = 'FR'

GA = 'GA'

GB = 'GB'

GD = 'GD'

GE = 'GE'

GF = 'GF'

GG = 'GG'

GH = 'GH'

GI = 'GI'

GL = 'GL'

GM = 'GM'

GN = 'GN'

GP = 'GP'

GQ = 'GQ'

GR = 'GR'

GS = 'GS'

GT = 'GT'

GU = 'GU'

GW = 'GW'

GY = 'GY'

HK = 'HK'

HM = 'HM'

HN = 'HN'

HR = 'HR'

HT = 'HT'

HU = 'HU'

ID = 'ID'

IE = 'IE'

IL = 'IL'

IM = 'IM'

IN = 'IN'

IO = 'IO'

IQ = 'IQ'

IS = 'IS'

IT = 'IT'

JE = 'JE'

JM = 'JM'

JO = 'JO'

JP = 'JP'

KE = 'KE'

KG = 'KG'

KH = 'KH'

KI = 'KI'

KM = 'KM'

KN = 'KN'

KR = 'KR'

KW = 'KW'

KY = 'KY'

KZ = 'KZ'

LA = 'LA'

LB = 'LB'

LC = 'LC'

LI = 'LI'

LK = 'LK'

LR = 'LR'

LS = 'LS'

LT = 'LT'

LU = 'LU'

LV = 'LV'

LY = 'LY'

MA = 'MA'

MC = 'MC'

MD = 'MD'

ME = 'ME'

MF = 'MF'

MG = 'MG'

MH = 'MH'

MK = 'MK'

ML = 'ML'

MM = 'MM'

MN = 'MN'

MO = 'MO'

MP = 'MP'

MQ = 'MQ'

MR = 'MR'

MS = 'MS'

MT = 'MT'

MU = 'MU'

MV = 'MV'

MW = 'MW'

MX = 'MX'

MY = 'MY'

MZ = 'MZ'

NA = 'NA'

NC = 'NC'

NE = 'NE'

NF = 'NF'

NG = 'NG'

NI = 'NI'

NL = 'NL'

NO = 'NO'

NP = 'NP'

NR = 'NR'

NU = 'NU'

NZ = 'NZ'

OM = 'OM'

PA = 'PA'

PE = 'PE'

PF = 'PF'

PG = 'PG'

PH = 'PH'

PK = 'PK'

PL = 'PL'

PM = 'PM'

PN = 'PN'

PR = 'PR'

PS = 'PS'

PT = 'PT'

PW = 'PW'

PY = 'PY'

QA = 'QA'

RE = 'RE'

RO = 'RO'

RS = 'RS'

RU = 'RU'

RW = 'RW'

SA = 'SA'

SB = 'SB'

SC = 'SC'

SE = 'SE'

SG = 'SG'

SH = 'SH'

SI = 'SI'

SJ = 'SJ'

SK = 'SK'

SL = 'SL'

SM = 'SM'

SN = 'SN'

SO = 'SO'

SR = 'SR'

ST = 'ST'

SV = 'SV'

SZ = 'SZ'

TC = 'TC'

TD = 'TD'

TF = 'TF'

TG = 'TG'

TH = 'TH'

TJ = 'TJ'

TK = 'TK'

TL = 'TL'

TM = 'TM'

TN = 'TN'

TO = 'TO'

TR = 'TR'

TT = 'TT'

TV = 'TV'

TW = 'TW'

TZ = 'TZ'

UA = 'UA'

UG = 'UG'

UM = 'UM'

US = 'US'

UY = 'UY'

UZ = 'UZ'

VA = 'VA'

VC = 'VC'

VE = 'VE'

VG = 'VG'

VI = 'VI'

VN = 'VN'

VU = 'VU'

WF = 'WF'

WS = 'WS'

YE = 'YE'

YT = 'YT'

ZA = 'ZA'

ZM = 'ZM'

ZW = 'ZW'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.isp.editable_state module

class ask_smapi_model.v1.isp.editable_state.EditableState

Bases: enum.Enum

Whether or not the in-skill product is editable.

Allowed enum values: [EDITABLE, NOT_EDITABLE]

EDITABLE = 'EDITABLE'

NOT_EDITABLE = 'NOT_EDITABLE'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.isp.in_skill_product_definition module

class ask_smapi_model.v1.isp.in_skill_product_definition.InSkillProductDefinition(version=None, object_type=None, reference_name=None, purchasable_state=None, subscription_information=None, publishing_information=None, privacy_and_compliance=None, testing_instructions=None)

Bases: object

Defines the structure for an in-skill product.

Parameters:

• version ((optional) str) – Version of in-skill product definition.
• object_type ((optional) ask_smapi_model.v1.isp.product_type.ProductType) –
• reference_name ((optional) str) – Developer selected in-skill product name. This is for developer reference only, it can be used to filter query results to identify a matching in-skill product.
• purchasable_state ((optional) ask_smapi_model.v1.isp.purchasable_state.PurchasableState) –
• subscription_information ((optional) ask_smapi_model.v1.isp.subscription_information.SubscriptionInformation) –
• publishing_information ((optional) ask_smapi_model.v1.isp.publishing_information.PublishingInformation) –
• privacy_and_compliance ((optional) ask_smapi_model.v1.isp.privacy_and_compliance.PrivacyAndCompliance) –
• testing_instructions ((optional) str) – Special instructions provided by the developer to test the in-skill product.

attribute_map = {'object_type': 'type', 'privacy_and_compliance': 'privacyAndCompliance', 'publishing_information': 'publishingInformation', 'purchasable_state': 'purchasableState', 'reference_name': 'referenceName', 'subscription_information': 'subscriptionInformation', 'testing_instructions': 'testingInstructions', 'version': 'version'}

deserialized_types = {'object_type': 'ask_smapi_model.v1.isp.product_type.ProductType', 'privacy_and_compliance': 'ask_smapi_model.v1.isp.privacy_and_compliance.PrivacyAndCompliance', 'publishing_information': 'ask_smapi_model.v1.isp.publishing_information.PublishingInformation', 'purchasable_state': 'ask_smapi_model.v1.isp.purchasable_state.PurchasableState', 'reference_name': 'str', 'subscription_information': 'ask_smapi_model.v1.isp.subscription_information.SubscriptionInformation', 'testing_instructions': 'str', 'version': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.isp.in_skill_product_definition_response module

class ask_smapi_model.v1.isp.in_skill_product_definition_response.InSkillProductDefinitionResponse(in_skill_product_definition=None)

Bases: object

Defines In-skill product response.

Parameters:in_skill_product_definition ((optional) ask_smapi_model.v1.isp.in_skill_product_definition.InSkillProductDefinition) –

attribute_map = {'in_skill_product_definition': 'inSkillProductDefinition'}

deserialized_types = {'in_skill_product_definition': 'ask_smapi_model.v1.isp.in_skill_product_definition.InSkillProductDefinition'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.isp.in_skill_product_summary module

class ask_smapi_model.v1.isp.in_skill_product_summary.InSkillProductSummary(object_type=None, product_id=None, reference_name=None, last_updated=None, name_by_locale=None, status=None, stage=None, editable_state=None, purchasable_state=None, links=None, pricing=None)

Bases: object

Information about the in-skill product that is not editable.

Parameters:

• object_type ((optional) ask_smapi_model.v1.isp.product_type.ProductType) –
• product_id ((optional) str) – primary identifier of in-skill product.
• reference_name ((optional) str) – Developer selected in-skill product name. This is for developer reference only, it can be used to filter query results to identify a matching in-skill product.
• last_updated ((optional) datetime) – Date of last update.
• name_by_locale ((optional) dict(str, str)) –
• status ((optional) ask_smapi_model.v1.isp.status.Status) –
• stage ((optional) ask_smapi_model.v1.isp.stage.Stage) –
• editable_state ((optional) ask_smapi_model.v1.isp.editable_state.EditableState) –
• purchasable_state ((optional) ask_smapi_model.v1.isp.purchasable_state.PurchasableState) –
• links ((optional) ask_smapi_model.v1.isp.isp_summary_links.IspSummaryLinks) –
• pricing ((optional) dict(str, ask_smapi_model.v1.isp.summary_marketplace_pricing.SummaryMarketplacePricing)) – In-skill product pricing information.

attribute_map = {'editable_state': 'editableState', 'last_updated': 'lastUpdated', 'links': '_links', 'name_by_locale': 'nameByLocale', 'object_type': 'type', 'pricing': 'pricing', 'product_id': 'productId', 'purchasable_state': 'purchasableState', 'reference_name': 'referenceName', 'stage': 'stage', 'status': 'status'}

deserialized_types = {'editable_state': 'ask_smapi_model.v1.isp.editable_state.EditableState', 'last_updated': 'datetime', 'links': 'ask_smapi_model.v1.isp.isp_summary_links.IspSummaryLinks', 'name_by_locale': 'dict(str, str)', 'object_type': 'ask_smapi_model.v1.isp.product_type.ProductType', 'pricing': 'dict(str, ask_smapi_model.v1.isp.summary_marketplace_pricing.SummaryMarketplacePricing)', 'product_id': 'str', 'purchasable_state': 'ask_smapi_model.v1.isp.purchasable_state.PurchasableState', 'reference_name': 'str', 'stage': 'ask_smapi_model.v1.isp.stage.Stage', 'status': 'ask_smapi_model.v1.isp.status.Status'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.isp.in_skill_product_summary_response module

class ask_smapi_model.v1.isp.in_skill_product_summary_response.InSkillProductSummaryResponse(in_skill_product_summary=None)

Bases: object

In-skill product summary response.

Parameters:in_skill_product_summary ((optional) ask_smapi_model.v1.isp.in_skill_product_summary.InSkillProductSummary) –

attribute_map = {'in_skill_product_summary': 'inSkillProductSummary'}

deserialized_types = {'in_skill_product_summary': 'ask_smapi_model.v1.isp.in_skill_product_summary.InSkillProductSummary'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.isp.isp_summary_links module

class ask_smapi_model.v1.isp.isp_summary_links.IspSummaryLinks(object_self=None)

Bases: object

Parameters:object_self ((optional) ask_smapi_model.v1.link.Link) –

attribute_map = {'object_self': 'self'}

deserialized_types = {'object_self': 'ask_smapi_model.v1.link.Link'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.isp.list_in_skill_product module

class ask_smapi_model.v1.isp.list_in_skill_product.ListInSkillProduct(links=None, in_skill_products=None, is_truncated=None, next_token=None)

Bases: object

List of in-skill products.

Parameters:

• links ((optional) ask_smapi_model.v1.links.Links) –
• in_skill_products ((optional) list[ask_smapi_model.v1.isp.in_skill_product_summary.InSkillProductSummary]) – Information for each in-skill product.
• is_truncated ((optional) bool) –
• next_token ((optional) str) –

attribute_map = {'in_skill_products': 'inSkillProducts', 'is_truncated': 'isTruncated', 'links': '_links', 'next_token': 'nextToken'}

deserialized_types = {'in_skill_products': 'list[ask_smapi_model.v1.isp.in_skill_product_summary.InSkillProductSummary]', 'is_truncated': 'bool', 'links': 'ask_smapi_model.v1.links.Links', 'next_token': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.isp.list_in_skill_product_response module

class ask_smapi_model.v1.isp.list_in_skill_product_response.ListInSkillProductResponse(in_skill_product_summary_list=None)

Bases: object

List of in-skill product response.

Parameters:in_skill_product_summary_list ((optional) ask_smapi_model.v1.isp.list_in_skill_product.ListInSkillProduct) –

attribute_map = {'in_skill_product_summary_list': 'inSkillProductSummaryList'}

deserialized_types = {'in_skill_product_summary_list': 'ask_smapi_model.v1.isp.list_in_skill_product.ListInSkillProduct'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.isp.localized_privacy_and_compliance module

class ask_smapi_model.v1.isp.localized_privacy_and_compliance.LocalizedPrivacyAndCompliance(privacy_policy_url=None)

Bases: object

Defines the structure for localized privacy and compliance.

Parameters:privacy_policy_url ((optional) str) – Link to the privacy policy that applies to this in-skill product.

attribute_map = {'privacy_policy_url': 'privacyPolicyUrl'}

deserialized_types = {'privacy_policy_url': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.isp.localized_publishing_information module

class ask_smapi_model.v1.isp.localized_publishing_information.LocalizedPublishingInformation(name=None, small_icon_uri=None, large_icon_uri=None, summary=None, description=None, example_phrases=None, keywords=None, custom_product_prompts=None)

Bases: object

Defines the structure for locale specific publishing information in the in-skill product definition.

Parameters:

• name ((optional) str) – Name of the in-skill product that is heard by customers and displayed in the Alexa app.
• small_icon_uri ((optional) str) – Uri for the small icon image of the in-skill product.
• large_icon_uri ((optional) str) – Uri for the large icon image of the in-skill product.
• summary ((optional) str) – Short description of the in-skill product that displays on the in-skill product list page in the Alexa App.
• description ((optional) str) – Description of the in-skill product's purpose and features, and how it works. Should describe any prerequisites like hardware or account requirements and detailed steps for the customer to get started. This description displays to customers on the in-skill product detail card in the Alexa app.
• example_phrases ((optional) list[str]) – Example phrases appear on the in-skill product detail page and are the key utterances that customers can say to interact directly with the in-skill product.
• keywords ((optional) list[str]) – Search terms that can be used to describe the in-skill product. This helps customers find an in-skill product.
• custom_product_prompts ((optional) ask_smapi_model.v1.isp.custom_product_prompts.CustomProductPrompts) –

attribute_map = {'custom_product_prompts': 'customProductPrompts', 'description': 'description', 'example_phrases': 'examplePhrases', 'keywords': 'keywords', 'large_icon_uri': 'largeIconUri', 'name': 'name', 'small_icon_uri': 'smallIconUri', 'summary': 'summary'}

deserialized_types = {'custom_product_prompts': 'ask_smapi_model.v1.isp.custom_product_prompts.CustomProductPrompts', 'description': 'str', 'example_phrases': 'list[str]', 'keywords': 'list[str]', 'large_icon_uri': 'str', 'name': 'str', 'small_icon_uri': 'str', 'summary': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.isp.marketplace_pricing module

class ask_smapi_model.v1.isp.marketplace_pricing.MarketplacePricing(release_date=None, default_price_listing=None)

Bases: object

In-skill product pricing information for a marketplace.

Parameters:

• release_date ((optional) datetime) – Date when in-skill product is available to customers for both purchase and use. Prior to this date the in-skill product will appear unavailable to customers and will not be purchasable.
• default_price_listing ((optional) ask_smapi_model.v1.isp.price_listing.PriceListing) –

attribute_map = {'default_price_listing': 'defaultPriceListing', 'release_date': 'releaseDate'}

deserialized_types = {'default_price_listing': 'ask_smapi_model.v1.isp.price_listing.PriceListing', 'release_date': 'datetime'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.isp.price_listing module

class ask_smapi_model.v1.isp.price_listing.PriceListing(price=None, currency=None)

Bases: object

Price listing information for in-skill product.

Parameters:

• price ((optional) float) – Defines the price of an in-skill product. The list price should be your suggested price, not including any VAT or similar taxes. Taxes are included in the final price to end users.
• currency ((optional) ask_smapi_model.v1.isp.currency.Currency) –

attribute_map = {'currency': 'currency', 'price': 'price'}

deserialized_types = {'currency': 'ask_smapi_model.v1.isp.currency.Currency', 'price': 'float'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.isp.privacy_and_compliance module

class ask_smapi_model.v1.isp.privacy_and_compliance.PrivacyAndCompliance(locales=None)

Bases: object

Defines the structure for privacy and compliance.

Parameters:locales ((optional) dict(str, ask_smapi_model.v1.isp.localized_privacy_and_compliance.LocalizedPrivacyAndCompliance)) – Defines the structure for locale specific privacy and compliance.

attribute_map = {'locales': 'locales'}

deserialized_types = {'locales': 'dict(str, ask_smapi_model.v1.isp.localized_privacy_and_compliance.LocalizedPrivacyAndCompliance)'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.isp.product_response module

class ask_smapi_model.v1.isp.product_response.ProductResponse(product_id=None)

Bases: object

Product ID information.

Parameters:product_id ((optional) str) – ID of the in-skill product created.

attribute_map = {'product_id': 'productId'}

deserialized_types = {'product_id': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.isp.product_type module

class ask_smapi_model.v1.isp.product_type.ProductType

Bases: enum.Enum

Type of in-skill product.

Allowed enum values: [SUBSCRIPTION, ENTITLEMENT, CONSUMABLE]

CONSUMABLE = 'CONSUMABLE'

ENTITLEMENT = 'ENTITLEMENT'

SUBSCRIPTION = 'SUBSCRIPTION'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.isp.publishing_information module

class ask_smapi_model.v1.isp.publishing_information.PublishingInformation(locales=None, distribution_countries=None, pricing=None, tax_information=None)

Bases: object

Defines the structure for in-skill product publishing information.

Parameters:

• locales ((optional) dict(str, ask_smapi_model.v1.isp.localized_publishing_information.LocalizedPublishingInformation)) – Defines the structure for locale specific publishing information for an in-skill product.
• distribution_countries ((optional) list[ask_smapi_model.v1.isp.distribution_countries.DistributionCountries]) – List of countries where the in-skill product is available.
• pricing ((optional) dict(str, ask_smapi_model.v1.isp.marketplace_pricing.MarketplacePricing)) – Defines the structure for in-skill product pricing.
• tax_information ((optional) ask_smapi_model.v1.isp.tax_information.TaxInformation) –

attribute_map = {'distribution_countries': 'distributionCountries', 'locales': 'locales', 'pricing': 'pricing', 'tax_information': 'taxInformation'}

deserialized_types = {'distribution_countries': 'list[ask_smapi_model.v1.isp.distribution_countries.DistributionCountries]', 'locales': 'dict(str, ask_smapi_model.v1.isp.localized_publishing_information.LocalizedPublishingInformation)', 'pricing': 'dict(str, ask_smapi_model.v1.isp.marketplace_pricing.MarketplacePricing)', 'tax_information': 'ask_smapi_model.v1.isp.tax_information.TaxInformation'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.isp.purchasable_state module

class ask_smapi_model.v1.isp.purchasable_state.PurchasableState

Bases: enum.Enum

Whether or not the in-skill product is purchasable by customers. A product that is not purchasable will prevent new customers from being prompted to purchase the product. Customers who already own the product will see no effect and continue to have access to the product features.

Allowed enum values: [PURCHASABLE, NOT_PURCHASABLE]

NOT_PURCHASABLE = 'NOT_PURCHASABLE'

PURCHASABLE = 'PURCHASABLE'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.isp.stage module

class ask_smapi_model.v1.isp.stage.Stage

Bases: enum.Enum

Stage of in-skill product.

Allowed enum values: [development, live]

development = 'development'

live = 'live'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.isp.status module

class ask_smapi_model.v1.isp.status.Status

Bases: enum.Enum

Current status of in-skill product.

Allowed enum values: [INCOMPLETE, COMPLETE, CERTIFICATION, PUBLISHED, SUPPRESSED]

CERTIFICATION = 'CERTIFICATION'

COMPLETE = 'COMPLETE'

INCOMPLETE = 'INCOMPLETE'

PUBLISHED = 'PUBLISHED'

SUPPRESSED = 'SUPPRESSED'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.isp.subscription_information module

class ask_smapi_model.v1.isp.subscription_information.SubscriptionInformation(subscription_payment_frequency=None, subscription_trial_period_days=None)

Bases: object

Defines the structure for in-skill product subscription information.

Parameters:

• subscription_payment_frequency ((optional) ask_smapi_model.v1.isp.subscription_payment_frequency.SubscriptionPaymentFrequency) –
• subscription_trial_period_days ((optional) int) – Days of free trial period for subscription. Max allowed is 365 days.

attribute_map = {'subscription_payment_frequency': 'subscriptionPaymentFrequency', 'subscription_trial_period_days': 'subscriptionTrialPeriodDays'}

deserialized_types = {'subscription_payment_frequency': 'ask_smapi_model.v1.isp.subscription_payment_frequency.SubscriptionPaymentFrequency', 'subscription_trial_period_days': 'int'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.isp.subscription_payment_frequency module

class ask_smapi_model.v1.isp.subscription_payment_frequency.SubscriptionPaymentFrequency

Bases: enum.Enum

The frequency in which payments are collected for the subscription.

Allowed enum values: [MONTHLY, YEARLY]

MONTHLY = 'MONTHLY'

YEARLY = 'YEARLY'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.isp.summary_marketplace_pricing module

class ask_smapi_model.v1.isp.summary_marketplace_pricing.SummaryMarketplacePricing(release_date=None, default_price_listing=None)

Bases: object

Localized in-skill product pricing information.

Parameters:

• release_date ((optional) datetime) – Date when in-skill product is available to customers for both purchase and use. Prior to this date the in-skill product will appear unavailable to customers and will not be purchasable.
• default_price_listing ((optional) ask_smapi_model.v1.isp.summary_price_listing.SummaryPriceListing) –

attribute_map = {'default_price_listing': 'defaultPriceListing', 'release_date': 'releaseDate'}

deserialized_types = {'default_price_listing': 'ask_smapi_model.v1.isp.summary_price_listing.SummaryPriceListing', 'release_date': 'datetime'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.isp.summary_price_listing module

class ask_smapi_model.v1.isp.summary_price_listing.SummaryPriceListing(price=None, prime_member_price=None, currency=None)

Bases: object

Price listing information for in-skill product.

Parameters:

• price ((optional) float) – The price of an in-skill product.
• prime_member_price ((optional) float) – The prime price of an in-skill product.
• currency ((optional) ask_smapi_model.v1.isp.currency.Currency) –

attribute_map = {'currency': 'currency', 'price': 'price', 'prime_member_price': 'primeMemberPrice'}

deserialized_types = {'currency': 'ask_smapi_model.v1.isp.currency.Currency', 'price': 'float', 'prime_member_price': 'float'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.isp.tax_information module

class ask_smapi_model.v1.isp.tax_information.TaxInformation(category=None)

Bases: object

Defines the structure for in-skill product tax information.

Parameters:category ((optional) ask_smapi_model.v1.isp.tax_information_category.TaxInformationCategory) –

attribute_map = {'category': 'category'}

deserialized_types = {'category': 'ask_smapi_model.v1.isp.tax_information_category.TaxInformationCategory'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.isp.tax_information_category module

class ask_smapi_model.v1.isp.tax_information_category.TaxInformationCategory

Bases: enum.Enum

Select tax category that best describes in-skill product. Choice will be validated during certification process.

Allowed enum values: [SOFTWARE, STREAMING_AUDIO, STREAMING_RADIO, INFORMATION_SERVICES, VIDEO, PERIODICALS, NEWSPAPERS]

INFORMATION_SERVICES = 'INFORMATION_SERVICES'

NEWSPAPERS = 'NEWSPAPERS'

PERIODICALS = 'PERIODICALS'

SOFTWARE = 'SOFTWARE'

STREAMING_AUDIO = 'STREAMING_AUDIO'

STREAMING_RADIO = 'STREAMING_RADIO'

VIDEO = 'VIDEO'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.isp.update_in_skill_product_request module

class ask_smapi_model.v1.isp.update_in_skill_product_request.UpdateInSkillProductRequest(in_skill_product_definition=None)

Bases: object

Parameters:in_skill_product_definition ((optional) ask_smapi_model.v1.isp.in_skill_product_definition.InSkillProductDefinition) –

attribute_map = {'in_skill_product_definition': 'inSkillProductDefinition'}

deserialized_types = {'in_skill_product_definition': 'ask_smapi_model.v1.isp.in_skill_product_definition.InSkillProductDefinition'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill package

Subpackages

ask_smapi_model.v1.skill.account_linking 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.v1.skill.account_linking.access_token_scheme_type module

class ask_smapi_model.v1.skill.account_linking.access_token_scheme_type.AccessTokenSchemeType

Bases: enum.Enum

The type of client authentication scheme.

Allowed enum values: [HTTP_BASIC, REQUEST_BODY_CREDENTIALS]

HTTP_BASIC = 'HTTP_BASIC'

REQUEST_BODY_CREDENTIALS = 'REQUEST_BODY_CREDENTIALS'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.account_linking.account_linking_request module

class ask_smapi_model.v1.skill.account_linking.account_linking_request.AccountLinkingRequest(object_type=None, authorization_url=None, domains=None, client_id=None, scopes=None, access_token_url=None, client_secret=None, access_token_scheme=None, default_token_expiration_in_seconds=None, reciprocal_access_token_url=None, redirect_urls=None, authorization_urls_by_platform=None)

Bases: object

The payload for creating the account linking partner.

Parameters:

• object_type ((optional) ask_smapi_model.v1.skill.account_linking.account_linking_type.AccountLinkingType) –
• authorization_url ((optional) str) – The url where customers will be redirected in the companion app to enter login credentials.
• domains ((optional) list[str]) – The list of domains that the authorization URL will fetch content from.
• client_id ((optional) str) – The unique public string used to identify the client requesting for authentication.
• scopes ((optional) list[str]) – The list of permissions which will be requested from the skill user.
• access_token_url ((optional) str) – The url used for access token and token refresh requests.
• client_secret ((optional) str) – The client secret provided by developer.
• access_token_scheme ((optional) ask_smapi_model.v1.skill.account_linking.access_token_scheme_type.AccessTokenSchemeType) –
• default_token_expiration_in_seconds ((optional) int) – The time in seconds for which access token is valid. If OAuth client returns &quot;expires_in&quot;, it will be overwrite this parameter.
• reciprocal_access_token_url ((optional) str) – Optional, if your skill requires reciprocal authorization, provide this additional access token url to handle reciprocal (Alexa) authorization codes that can be exchanged for Alexa access tokens.
• redirect_urls ((optional) list[str]) – The list of valid urls to redirect back to, when the linking process is initiated from a third party system.
• authorization_urls_by_platform ((optional) list[ask_smapi_model.v1.skill.account_linking.account_linking_platform_authorization_url.AccountLinkingPlatformAuthorizationUrl]) – The list of valid authorization urls for allowed platforms to initiate account linking.

attribute_map = {'access_token_scheme': 'accessTokenScheme', 'access_token_url': 'accessTokenUrl', 'authorization_url': 'authorizationUrl', 'authorization_urls_by_platform': 'authorizationUrlsByPlatform', 'client_id': 'clientId', 'client_secret': 'clientSecret', 'default_token_expiration_in_seconds': 'defaultTokenExpirationInSeconds', 'domains': 'domains', 'object_type': 'type', 'reciprocal_access_token_url': 'reciprocalAccessTokenUrl', 'redirect_urls': 'redirectUrls', 'scopes': 'scopes'}

deserialized_types = {'access_token_scheme': 'ask_smapi_model.v1.skill.account_linking.access_token_scheme_type.AccessTokenSchemeType', 'access_token_url': 'str', 'authorization_url': 'str', 'authorization_urls_by_platform': 'list[ask_smapi_model.v1.skill.account_linking.account_linking_platform_authorization_url.AccountLinkingPlatformAuthorizationUrl]', 'client_id': 'str', 'client_secret': 'str', 'default_token_expiration_in_seconds': 'int', 'domains': 'list[str]', 'object_type': 'ask_smapi_model.v1.skill.account_linking.account_linking_type.AccountLinkingType', 'reciprocal_access_token_url': 'str', 'redirect_urls': 'list[str]', 'scopes': 'list[str]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.account_linking.account_linking_response module

class ask_smapi_model.v1.skill.account_linking.account_linking_response.AccountLinkingResponse(object_type=None, authorization_url=None, domains=None, client_id=None, scopes=None, access_token_url=None, access_token_scheme=None, default_token_expiration_in_seconds=None, redirect_urls=None, authorization_urls_by_platform=None)

Bases: object

The account linking information of a skill.

Parameters:

• object_type ((optional) ask_smapi_model.v1.skill.account_linking.account_linking_type.AccountLinkingType) –
• authorization_url ((optional) str) – The url where customers will be redirected in the companion app to enter login credentials.
• domains ((optional) list[str]) – The list of domains that the authorization URL will fetch content from.
• client_id ((optional) str) – The unique public string used to identify the client requesting for authentication.
• scopes ((optional) list[str]) – The list of permissions which will be requested from the skill user.
• access_token_url ((optional) str) – The url used for access token and token refresh requests.
• access_token_scheme ((optional) ask_smapi_model.v1.skill.account_linking.access_token_scheme_type.AccessTokenSchemeType) –
• default_token_expiration_in_seconds ((optional) int) – The time in seconds for which access token is valid. If OAuth client returns &quot;expires_in&quot;, it will be overwrite this parameter.
• redirect_urls ((optional) list[str]) – The list of valid urls to redirect back to, when the linking process is initiated from a third party system.
• authorization_urls_by_platform ((optional) list[ask_smapi_model.v1.skill.account_linking.account_linking_platform_authorization_url.AccountLinkingPlatformAuthorizationUrl]) – The list of valid authorization urls for allowed platforms to initiate account linking.

attribute_map = {'access_token_scheme': 'accessTokenScheme', 'access_token_url': 'accessTokenUrl', 'authorization_url': 'authorizationUrl', 'authorization_urls_by_platform': 'authorizationUrlsByPlatform', 'client_id': 'clientId', 'default_token_expiration_in_seconds': 'defaultTokenExpirationInSeconds', 'domains': 'domains', 'object_type': 'type', 'redirect_urls': 'redirectUrls', 'scopes': 'scopes'}

deserialized_types = {'access_token_scheme': 'ask_smapi_model.v1.skill.account_linking.access_token_scheme_type.AccessTokenSchemeType', 'access_token_url': 'str', 'authorization_url': 'str', 'authorization_urls_by_platform': 'list[ask_smapi_model.v1.skill.account_linking.account_linking_platform_authorization_url.AccountLinkingPlatformAuthorizationUrl]', 'client_id': 'str', 'default_token_expiration_in_seconds': 'int', 'domains': 'list[str]', 'object_type': 'ask_smapi_model.v1.skill.account_linking.account_linking_type.AccountLinkingType', 'redirect_urls': 'list[str]', 'scopes': 'list[str]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.account_linking.account_linking_type module

class ask_smapi_model.v1.skill.account_linking.account_linking_type.AccountLinkingType

Bases: enum.Enum

The type of account linking.

Allowed enum values: [AUTH_CODE, IMPLICIT]

AUTH_CODE = 'AUTH_CODE'

IMPLICIT = 'IMPLICIT'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.alexa_hosted 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.v1.skill.alexa_hosted.hosted_skill_info module

class ask_smapi_model.v1.skill.alexa_hosted.hosted_skill_info.HostedSkillInfo(repository=None, runtime=None)

Bases: object

Parameters:

• repository ((optional) ask_smapi_model.v1.skill.alexa_hosted.hosted_skill_repository_info.HostedSkillRepositoryInfo) –
• runtime ((optional) ask_smapi_model.v1.skill.alexa_hosted.hosted_skill_runtime.HostedSkillRuntime) –

attribute_map = {'repository': 'repository', 'runtime': 'runtime'}

deserialized_types = {'repository': 'ask_smapi_model.v1.skill.alexa_hosted.hosted_skill_repository_info.HostedSkillRepositoryInfo', 'runtime': 'ask_smapi_model.v1.skill.alexa_hosted.hosted_skill_runtime.HostedSkillRuntime'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.alexa_hosted.hosted_skill_metadata module

class ask_smapi_model.v1.skill.alexa_hosted.hosted_skill_metadata.HostedSkillMetadata(alexa_hosted=None)

Bases: object

Alexa Hosted skill's metadata

Parameters:alexa_hosted ((optional) ask_smapi_model.v1.skill.alexa_hosted.hosted_skill_info.HostedSkillInfo) –

attribute_map = {'alexa_hosted': 'alexaHosted'}

deserialized_types = {'alexa_hosted': 'ask_smapi_model.v1.skill.alexa_hosted.hosted_skill_info.HostedSkillInfo'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.alexa_hosted.hosted_skill_permission module

class ask_smapi_model.v1.skill.alexa_hosted.hosted_skill_permission.HostedSkillPermission(permission=None, status=None, action_url=None)

Bases: object

Customer's permission about Hosted skill features.

Parameters:

• permission ((optional) ask_smapi_model.v1.skill.alexa_hosted.hosted_skill_permission_type.HostedSkillPermissionType) –
• status ((optional) ask_smapi_model.v1.skill.alexa_hosted.hosted_skill_permission_status.HostedSkillPermissionStatus) –
• action_url ((optional) str) –

attribute_map = {'action_url': 'actionUrl', 'permission': 'permission', 'status': 'status'}

deserialized_types = {'action_url': 'str', 'permission': 'ask_smapi_model.v1.skill.alexa_hosted.hosted_skill_permission_type.HostedSkillPermissionType', 'status': 'ask_smapi_model.v1.skill.alexa_hosted.hosted_skill_permission_status.HostedSkillPermissionStatus'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.alexa_hosted.hosted_skill_permission_status module

class ask_smapi_model.v1.skill.alexa_hosted.hosted_skill_permission_status.HostedSkillPermissionStatus

Bases: enum.Enum

Allowed enum values: [ALLOWED, NEW_USER_REGISTRATION_REQUIRED, RESOURCE_LIMIT_EXCEEDED, RATE_EXCEEDED]

ALLOWED = 'ALLOWED'

NEW_USER_REGISTRATION_REQUIRED = 'NEW_USER_REGISTRATION_REQUIRED'

RATE_EXCEEDED = 'RATE_EXCEEDED'

RESOURCE_LIMIT_EXCEEDED = 'RESOURCE_LIMIT_EXCEEDED'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.alexa_hosted.hosted_skill_permission_type module

class ask_smapi_model.v1.skill.alexa_hosted.hosted_skill_permission_type.HostedSkillPermissionType

Bases: enum.Enum

Allowed enum values: [NEW_SKILL]

NEW_SKILL = 'NEW_SKILL'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.alexa_hosted.hosted_skill_repository module

class ask_smapi_model.v1.skill.alexa_hosted.hosted_skill_repository.HostedSkillRepository

Bases: enum.Enum

Allowed enum values: [GIT]

GIT = 'GIT'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.alexa_hosted.hosted_skill_repository_credentials module

class ask_smapi_model.v1.skill.alexa_hosted.hosted_skill_repository_credentials.HostedSkillRepositoryCredentials(username=None, password=None, expires_at=None)

Bases: object

Parameters:

• username ((optional) str) – AWS Access Key ID used to access hosted skill repository
• password ((optional) str) – signed AWS Credentials used to access hosted skill repository
• expires_at ((optional) datetime) – expiration time for the credentials

attribute_map = {'expires_at': 'expiresAt', 'password': 'password', 'username': 'username'}

deserialized_types = {'expires_at': 'datetime', 'password': 'str', 'username': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.alexa_hosted.hosted_skill_repository_credentials_list module

class ask_smapi_model.v1.skill.alexa_hosted.hosted_skill_repository_credentials_list.HostedSkillRepositoryCredentialsList(repository_credentials=None)

Bases: object

defines the structure for the hosted skill repository credentials response

Parameters:repository_credentials ((optional) ask_smapi_model.v1.skill.alexa_hosted.hosted_skill_repository_credentials.HostedSkillRepositoryCredentials) –

attribute_map = {'repository_credentials': 'repositoryCredentials'}

deserialized_types = {'repository_credentials': 'ask_smapi_model.v1.skill.alexa_hosted.hosted_skill_repository_credentials.HostedSkillRepositoryCredentials'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.alexa_hosted.hosted_skill_repository_credentials_request module

class ask_smapi_model.v1.skill.alexa_hosted.hosted_skill_repository_credentials_request.HostedSkillRepositoryCredentialsRequest(repository=None)

Bases: object

Parameters:repository ((optional) ask_smapi_model.v1.skill.alexa_hosted.hosted_skill_repository_info.HostedSkillRepositoryInfo) –

attribute_map = {'repository': 'repository'}

deserialized_types = {'repository': 'ask_smapi_model.v1.skill.alexa_hosted.hosted_skill_repository_info.HostedSkillRepositoryInfo'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.alexa_hosted.hosted_skill_repository_info module

class ask_smapi_model.v1.skill.alexa_hosted.hosted_skill_repository_info.HostedSkillRepositoryInfo(url=None, object_type=None)

Bases: object

Alexa Hosted Skill's Repository Information

Parameters:

• url ((optional) str) –
• object_type ((optional) ask_smapi_model.v1.skill.alexa_hosted.hosted_skill_repository.HostedSkillRepository) –

attribute_map = {'object_type': 'type', 'url': 'url'}

deserialized_types = {'object_type': 'ask_smapi_model.v1.skill.alexa_hosted.hosted_skill_repository.HostedSkillRepository', 'url': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.alexa_hosted.hosted_skill_runtime module

class ask_smapi_model.v1.skill.alexa_hosted.hosted_skill_runtime.HostedSkillRuntime

Bases: enum.Enum

Hosted skill lambda runtime

Allowed enum values: [NODE_10_X, PYTHON_3_7]

NODE_10_X = 'NODE_10_X'

PYTHON_3_7 = 'PYTHON_3_7'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.beta_test package

Subpackages

ask_smapi_model.v1.skill.beta_test.testers 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.v1.skill.beta_test.testers.invitation_status module

class ask_smapi_model.v1.skill.beta_test.testers.invitation_status.InvitationStatus

Bases: enum.Enum

Indicates whether the tester has accepted the invitation.

Allowed enum values: [ACCEPTED, NOT_ACCEPTED]

ACCEPTED = 'ACCEPTED'

NOT_ACCEPTED = 'NOT_ACCEPTED'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.beta_test.testers.list_testers_response module

class ask_smapi_model.v1.skill.beta_test.testers.list_testers_response.ListTestersResponse(testers=None, is_truncated=None, next_token=None)

Bases: object

Parameters:

• testers ((optional) list[ask_smapi_model.v1.skill.beta_test.testers.tester_with_details.TesterWithDetails]) –
• is_truncated ((optional) bool) –
• next_token ((optional) str) –

attribute_map = {'is_truncated': 'isTruncated', 'next_token': 'nextToken', 'testers': 'testers'}

deserialized_types = {'is_truncated': 'bool', 'next_token': 'str', 'testers': 'list[ask_smapi_model.v1.skill.beta_test.testers.tester_with_details.TesterWithDetails]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.beta_test.testers.tester module

class ask_smapi_model.v1.skill.beta_test.testers.tester.Tester(email_id=None)

Bases: object

Parameters:email_id ((optional) str) – Email address of the tester.

attribute_map = {'email_id': 'emailId'}

deserialized_types = {'email_id': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.beta_test.testers.tester_with_details module

class ask_smapi_model.v1.skill.beta_test.testers.tester_with_details.TesterWithDetails(email_id=None, association_date=None, is_reminder_allowed=None, invitation_status=None)

Bases: object

Tester information.

Parameters:

• email_id ((optional) str) – Email address of the tester.
• association_date ((optional) datetime) – Date and time when the tester is added to the beta test.
• is_reminder_allowed ((optional) bool) – Indicates whether the tester is allowed to be sent reminder.
• invitation_status ((optional) ask_smapi_model.v1.skill.beta_test.testers.invitation_status.InvitationStatus) –

attribute_map = {'association_date': 'associationDate', 'email_id': 'emailId', 'invitation_status': 'invitationStatus', 'is_reminder_allowed': 'isReminderAllowed'}

deserialized_types = {'association_date': 'datetime', 'email_id': 'str', 'invitation_status': 'ask_smapi_model.v1.skill.beta_test.testers.invitation_status.InvitationStatus', 'is_reminder_allowed': 'bool'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.beta_test.testers.testers_list module

class ask_smapi_model.v1.skill.beta_test.testers.testers_list.TestersList(testers=None)

Bases: object

List of testers.

Parameters:testers ((optional) list[ask_smapi_model.v1.skill.beta_test.testers.tester.Tester]) – List of the email address of testers.

attribute_map = {'testers': 'testers'}

deserialized_types = {'testers': 'list[ask_smapi_model.v1.skill.beta_test.testers.tester.Tester]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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.v1.skill.beta_test.beta_test module

class ask_smapi_model.v1.skill.beta_test.beta_test.BetaTest(expiry_date=None, status=None, feedback_email=None, invitation_url=None, invites_remaining=None)

Bases: object

Beta test for an Alexa skill.

Parameters:

• expiry_date ((optional) datetime) – Expiry date of the beta test.
• status ((optional) ask_smapi_model.v1.skill.beta_test.status.Status) –
• feedback_email ((optional) str) – Email address for providing feedback
• invitation_url ((optional) str) – Deeplinking for getting authorized to the beta test.
• invites_remaining ((optional) float) – Remaining invite count for the beta test.

attribute_map = {'expiry_date': 'expiryDate', 'feedback_email': 'feedbackEmail', 'invitation_url': 'invitationUrl', 'invites_remaining': 'invitesRemaining', 'status': 'status'}

deserialized_types = {'expiry_date': 'datetime', 'feedback_email': 'str', 'invitation_url': 'str', 'invites_remaining': 'float', 'status': 'ask_smapi_model.v1.skill.beta_test.status.Status'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.beta_test.status module

class ask_smapi_model.v1.skill.beta_test.status.Status

Bases: enum.Enum

Status of the beta test.

Allowed enum values: [IN_DRAFT, STARTING, RUNNING, STOPPING, ENDED]

ENDED = 'ENDED'

IN_DRAFT = 'IN_DRAFT'

RUNNING = 'RUNNING'

STARTING = 'STARTING'

STOPPING = 'STOPPING'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.beta_test.test_body module

class ask_smapi_model.v1.skill.beta_test.test_body.TestBody(feedback_email=None)

Bases: object

Beta test meta-data.

Parameters:feedback_email ((optional) str) – Email address for providing feedback.

attribute_map = {'feedback_email': 'feedbackEmail'}

deserialized_types = {'feedback_email': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.certification 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.v1.skill.certification.certification_response module

class ask_smapi_model.v1.skill.certification.certification_response.CertificationResponse(id=None, status=None, skill_submission_timestamp=None, review_tracking_info=None, result=None)

Bases: object

Parameters:

• id ((optional) str) – Certification Id for the skill
• status ((optional) ask_smapi_model.v1.skill.certification.certification_status.CertificationStatus) –
• skill_submission_timestamp ((optional) datetime) – Timestamp for when the skill was submitted for certification.
• review_tracking_info ((optional) ask_smapi_model.v1.skill.certification.review_tracking_info.ReviewTrackingInfo) –
• result ((optional) ask_smapi_model.v1.skill.certification.certification_result.CertificationResult) –

attribute_map = {'id': 'id', 'result': 'result', 'review_tracking_info': 'reviewTrackingInfo', 'skill_submission_timestamp': 'skillSubmissionTimestamp', 'status': 'status'}

deserialized_types = {'id': 'str', 'result': 'ask_smapi_model.v1.skill.certification.certification_result.CertificationResult', 'review_tracking_info': 'ask_smapi_model.v1.skill.certification.review_tracking_info.ReviewTrackingInfo', 'skill_submission_timestamp': 'datetime', 'status': 'ask_smapi_model.v1.skill.certification.certification_status.CertificationStatus'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.certification.certification_result module

class ask_smapi_model.v1.skill.certification.certification_result.CertificationResult(distribution_info=None)

Bases: object

Structure for the result for the outcomes of certification review for the skill. Currently provides the distribution information of a skill if the certification SUCCEEDED.

Parameters:distribution_info ((optional) ask_smapi_model.v1.skill.certification.distribution_info.DistributionInfo) –

attribute_map = {'distribution_info': 'distributionInfo'}

deserialized_types = {'distribution_info': 'ask_smapi_model.v1.skill.certification.distribution_info.DistributionInfo'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.certification.certification_status module

class ask_smapi_model.v1.skill.certification.certification_status.CertificationStatus

Bases: enum.Enum

String that specifies the current status of skill's certification Possible values are &quot;IN_PROGRESS&quot;, &quot;SUCCEEDED&quot;, &quot;FAILED&quot; and &quot;CANCELLED&quot;

Allowed enum values: [IN_PROGRESS, SUCCEEDED, FAILED, CANCELLED]

CANCELLED = 'CANCELLED'

FAILED = 'FAILED'

IN_PROGRESS = 'IN_PROGRESS'

SUCCEEDED = 'SUCCEEDED'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.certification.certification_summary module

class ask_smapi_model.v1.skill.certification.certification_summary.CertificationSummary(id=None, status=None, skill_submission_timestamp=None, review_tracking_info=None)

Bases: object

Summary of the certification resource. This is a leaner view of the certification resource for the collections API.

Parameters:

• id ((optional) str) – Certification Id for the skill.
• status ((optional) ask_smapi_model.v1.skill.certification.certification_status.CertificationStatus) –
• skill_submission_timestamp ((optional) datetime) – Timestamp for when the skill was submitted for certification.
• review_tracking_info ((optional) ask_smapi_model.v1.skill.certification.review_tracking_info_summary.ReviewTrackingInfoSummary) –

attribute_map = {'id': 'id', 'review_tracking_info': 'reviewTrackingInfo', 'skill_submission_timestamp': 'skillSubmissionTimestamp', 'status': 'status'}

deserialized_types = {'id': 'str', 'review_tracking_info': 'ask_smapi_model.v1.skill.certification.review_tracking_info_summary.ReviewTrackingInfoSummary', 'skill_submission_timestamp': 'datetime', 'status': 'ask_smapi_model.v1.skill.certification.certification_status.CertificationStatus'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.certification.distribution_info module

class ask_smapi_model.v1.skill.certification.distribution_info.DistributionInfo(published_countries=None, publication_failures=None)

Bases: object

The distribution information for skill where Amazon distributed the skill

Parameters:

• published_countries ((optional) list[str]) – All countries where the skill was published in by Amazon.
• publication_failures ((optional) list[ask_smapi_model.v1.skill.certification.publication_failure.PublicationFailure]) –

attribute_map = {'publication_failures': 'publicationFailures', 'published_countries': 'publishedCountries'}

deserialized_types = {'publication_failures': 'list[ask_smapi_model.v1.skill.certification.publication_failure.PublicationFailure]', 'published_countries': 'list[str]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.certification.estimation_update module

class ask_smapi_model.v1.skill.certification.estimation_update.EstimationUpdate(original_estimated_completion_timestamp=None, revised_estimated_completion_timestamp=None, reason=None)

Bases: object

Structure for any updates to estimation completion time for certification review for the skill.

Parameters:

• original_estimated_completion_timestamp ((optional) datetime) – Timestamp for originally estimated completion of certification review for the skill.
• revised_estimated_completion_timestamp ((optional) datetime) – Timestamp for originally estimated completion of certification review for the skill.
• reason ((optional) str) – Reason for updates to estimates for certification review

attribute_map = {'original_estimated_completion_timestamp': 'originalEstimatedCompletionTimestamp', 'reason': 'reason', 'revised_estimated_completion_timestamp': 'revisedEstimatedCompletionTimestamp'}

deserialized_types = {'original_estimated_completion_timestamp': 'datetime', 'reason': 'str', 'revised_estimated_completion_timestamp': 'datetime'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.certification.list_certifications_response module

class ask_smapi_model.v1.skill.certification.list_certifications_response.ListCertificationsResponse(links=None, is_truncated=None, next_token=None, total_count=None, items=None)

Bases: object

List of certification summary for a skill.

Parameters:

• links ((optional) ask_smapi_model.v1.links.Links) –
• is_truncated ((optional) bool) – boolean value for if the response is truncated. isTruncated &#x3D; true if more than the assigned maxResults parameter value certification items are available for the skill. The results are then paginated and the remaining results can be retrieved in a similar paginated manner by using 'next' link in the _links or using the nextToken in a following request.
• next_token ((optional) str) – Encrypted token present when isTruncated is true.
• total_count ((optional) int) – Total number of certification results available for the skill.
• items ((optional) list[ask_smapi_model.v1.skill.certification.certification_summary.CertificationSummary]) – List of certifications available for a skill. The list of certifications is sorted in a default descending sort order on id field.

attribute_map = {'is_truncated': 'isTruncated', 'items': 'items', 'links': '_links', 'next_token': 'nextToken', 'total_count': 'totalCount'}

deserialized_types = {'is_truncated': 'bool', 'items': 'list[ask_smapi_model.v1.skill.certification.certification_summary.CertificationSummary]', 'links': 'ask_smapi_model.v1.links.Links', 'next_token': 'str', 'total_count': 'int'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.certification.publication_failure module

class ask_smapi_model.v1.skill.certification.publication_failure.PublicationFailure(reason=None, countries=None)

Bases: object

Information about why the skill was not published in certain countries.

Parameters:

• reason ((optional) str) – Reason why Amazon did not publish the skill in certain countries.
• countries ((optional) list[str]) – List of countries where Amazon did not publish the skill for a specific reason

attribute_map = {'countries': 'countries', 'reason': 'reason'}

deserialized_types = {'countries': 'list[str]', 'reason': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.certification.review_tracking_info module

class ask_smapi_model.v1.skill.certification.review_tracking_info.ReviewTrackingInfo(estimated_completion_timestamp=None, actual_completion_timestamp=None, last_updated=None, estimation_updates=None)

Bases: object

Structure for review tracking information of the skill.

Parameters:

• estimated_completion_timestamp ((optional) datetime) – Timestamp for estimated completion of certification review for the skill.
• actual_completion_timestamp ((optional) datetime) – Timestamp for actual completion of certification review for the skill.
• last_updated ((optional) datetime) – Timestamp for when the last update was made to review tracking info.
• estimation_updates ((optional) list[ask_smapi_model.v1.skill.certification.estimation_update.EstimationUpdate]) – List of updates to estimation completion time for certification review for the skill.

attribute_map = {'actual_completion_timestamp': 'actualCompletionTimestamp', 'estimated_completion_timestamp': 'estimatedCompletionTimestamp', 'estimation_updates': 'estimationUpdates', 'last_updated': 'lastUpdated'}

deserialized_types = {'actual_completion_timestamp': 'datetime', 'estimated_completion_timestamp': 'datetime', 'estimation_updates': 'list[ask_smapi_model.v1.skill.certification.estimation_update.EstimationUpdate]', 'last_updated': 'datetime'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.certification.review_tracking_info_summary module

class ask_smapi_model.v1.skill.certification.review_tracking_info_summary.ReviewTrackingInfoSummary(estimated_completion_timestamp=None, actual_completion_timestamp=None, last_updated=None)

Bases: object

Structure for summarised view of review tracking information of the skill. This does not have the estimationUpdates array field.

Parameters:

• estimated_completion_timestamp ((optional) datetime) – Timestamp for estimated completion of certification review for the skill.
• actual_completion_timestamp ((optional) datetime) – Timestamp for actual completion of certification review workflow for the skill.
• last_updated ((optional) datetime) – Timestamp for when the last update was made to review tracking info.

attribute_map = {'actual_completion_timestamp': 'actualCompletionTimestamp', 'estimated_completion_timestamp': 'estimatedCompletionTimestamp', 'last_updated': 'lastUpdated'}

deserialized_types = {'actual_completion_timestamp': 'datetime', 'estimated_completion_timestamp': 'datetime', 'last_updated': 'datetime'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.evaluations 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.v1.skill.evaluations.confirmation_status_type module

class ask_smapi_model.v1.skill.evaluations.confirmation_status_type.ConfirmationStatusType

Bases: enum.Enum

An enumeration indicating whether the user has explicitly confirmed or denied the entire intent. Possible values: &quot;NONE&quot;, &quot;CONFIRMED&quot;, &quot;DENIED&quot;.

Allowed enum values: [NONE, CONFIRMED, DENIED]

CONFIRMED = 'CONFIRMED'

DENIED = 'DENIED'

NONE = 'NONE'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.evaluations.dialog_act module

class ask_smapi_model.v1.skill.evaluations.dialog_act.DialogAct(object_type=None, target_slot=None)

Bases: object

A representation of question prompts to the user for multi-turn, which requires user to fill a slot value, or confirm a slot value, or confirm an intent.

Parameters:

• object_type ((optional) ask_smapi_model.v1.skill.evaluations.dialog_act_type.DialogActType) –
• target_slot ((optional) str) – The name of the target slot that needs to be filled or confirmed for a dialogAct

attribute_map = {'object_type': 'type', 'target_slot': 'targetSlot'}

deserialized_types = {'object_type': 'ask_smapi_model.v1.skill.evaluations.dialog_act_type.DialogActType', 'target_slot': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.evaluations.dialog_act_type module

class ask_smapi_model.v1.skill.evaluations.dialog_act_type.DialogActType

Bases: enum.Enum

Allowed enum values: [Dialog_ElicitSlot, Dialog_ConfirmSlot, Dialog_ConfirmIntent]

Dialog_ConfirmIntent = 'Dialog.ConfirmIntent'

Dialog_ConfirmSlot = 'Dialog.ConfirmSlot'

Dialog_ElicitSlot = 'Dialog.ElicitSlot'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.evaluations.intent module

class ask_smapi_model.v1.skill.evaluations.intent.Intent(name=None, confirmation_status=None, slots=None)

Bases: object

Parameters:

• name ((optional) str) –
• confirmation_status ((optional) ask_smapi_model.v1.skill.evaluations.confirmation_status_type.ConfirmationStatusType) –
• slots ((optional) dict(str, ask_smapi_model.v1.skill.evaluations.slot.Slot)) – A map of key-value pairs that further describes what the user meant based on a predefined intent schema. The map can be empty.

attribute_map = {'confirmation_status': 'confirmationStatus', 'name': 'name', 'slots': 'slots'}

deserialized_types = {'confirmation_status': 'ask_smapi_model.v1.skill.evaluations.confirmation_status_type.ConfirmationStatusType', 'name': 'str', 'slots': 'dict(str, ask_smapi_model.v1.skill.evaluations.slot.Slot)'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.evaluations.multi_turn module

class ask_smapi_model.v1.skill.evaluations.multi_turn.MultiTurn(dialog_act=None, token=None, prompt=None)

Bases: object

Included when the selected intent has dialog defined and the dialog is not completed. To continue the dialog, provide the value of the token in the multiTurnToken field in the next request.

Parameters:

• dialog_act ((optional) ask_smapi_model.v1.skill.evaluations.dialog_act.DialogAct) –
• token ((optional) str) – Opaque string which contains multi-turn related context.
• prompt ((optional) str) – A sample prompt defined in the dialog model for each DialogAct.

attribute_map = {'dialog_act': 'dialogAct', 'prompt': 'prompt', 'token': 'token'}

deserialized_types = {'dialog_act': 'ask_smapi_model.v1.skill.evaluations.dialog_act.DialogAct', 'prompt': 'str', 'token': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.evaluations.profile_nlu_request module

class ask_smapi_model.v1.skill.evaluations.profile_nlu_request.ProfileNluRequest(utterance=None, multi_turn_token=None)

Bases: object

Parameters:

• utterance ((optional) str) – Actual representation of user input to Alexa.
• multi_turn_token ((optional) str) – Opaque string which contains multi-turn related context.

attribute_map = {'multi_turn_token': 'multiTurnToken', 'utterance': 'utterance'}

deserialized_types = {'multi_turn_token': 'str', 'utterance': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.evaluations.profile_nlu_response module

class ask_smapi_model.v1.skill.evaluations.profile_nlu_response.ProfileNluResponse(session_ended=None, selected_intent=None, considered_intents=None, multi_turn=None)

Bases: object

Parameters:

• session_ended ((optional) bool) – Represents when an utterance results in the skill exiting. It would be true when NLU selects 1P ExitAppIntent or GoHomeIntent, and false otherwise.
• selected_intent ((optional) ask_smapi_model.v1.skill.evaluations.profile_nlu_selected_intent.ProfileNluSelectedIntent) –
• considered_intents ((optional) list[ask_smapi_model.v1.skill.evaluations.intent.Intent]) – All intents that Alexa considered for the utterance in the request, but did not select.
• multi_turn ((optional) ask_smapi_model.v1.skill.evaluations.multi_turn.MultiTurn) –

attribute_map = {'considered_intents': 'consideredIntents', 'multi_turn': 'multiTurn', 'selected_intent': 'selectedIntent', 'session_ended': 'sessionEnded'}

deserialized_types = {'considered_intents': 'list[ask_smapi_model.v1.skill.evaluations.intent.Intent]', 'multi_turn': 'ask_smapi_model.v1.skill.evaluations.multi_turn.MultiTurn', 'selected_intent': 'ask_smapi_model.v1.skill.evaluations.profile_nlu_selected_intent.ProfileNluSelectedIntent', 'session_ended': 'bool'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.evaluations.profile_nlu_selected_intent module

class ask_smapi_model.v1.skill.evaluations.profile_nlu_selected_intent.ProfileNluSelectedIntent(name=None, confirmation_status=None, slots=None)

Bases: ask_smapi_model.v1.skill.evaluations.intent.Intent

The intent that Alexa selected for the utterance in the request.

Parameters:

• name ((optional) str) –
• confirmation_status ((optional) ask_smapi_model.v1.skill.evaluations.confirmation_status_type.ConfirmationStatusType) –
• slots ((optional) dict(str, ask_smapi_model.v1.skill.evaluations.slot.Slot)) – A map of key-value pairs that further describes what the user meant based on a predefined intent schema. The map can be empty.

attribute_map = {'confirmation_status': 'confirmationStatus', 'name': 'name', 'slots': 'slots'}

deserialized_types = {'confirmation_status': 'ask_smapi_model.v1.skill.evaluations.confirmation_status_type.ConfirmationStatusType', 'name': 'str', 'slots': 'dict(str, ask_smapi_model.v1.skill.evaluations.slot.Slot)'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.evaluations.resolutions_per_authority_items module

class ask_smapi_model.v1.skill.evaluations.resolutions_per_authority_items.ResolutionsPerAuthorityItems(authority=None, status=None, values=None)

Bases: object

Parameters:

• authority ((optional) str) – The name of the authority for the slot values. For custom slot types, this authority label incorporates your skill ID and the slot type name.
• status ((optional) ask_smapi_model.v1.skill.evaluations.resolutions_per_authority_status.ResolutionsPerAuthorityStatus) –
• values ((optional) list[ask_smapi_model.v1.skill.evaluations.resolutions_per_authority_value_items.ResolutionsPerAuthorityValueItems]) – An array of resolved values for the slot.

attribute_map = {'authority': 'authority', 'status': 'status', 'values': 'values'}

deserialized_types = {'authority': 'str', 'status': 'ask_smapi_model.v1.skill.evaluations.resolutions_per_authority_status.ResolutionsPerAuthorityStatus', 'values': 'list[ask_smapi_model.v1.skill.evaluations.resolutions_per_authority_value_items.ResolutionsPerAuthorityValueItems]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.evaluations.resolutions_per_authority_status module

class ask_smapi_model.v1.skill.evaluations.resolutions_per_authority_status.ResolutionsPerAuthorityStatus(code=None)

Bases: object

An object representing the status of entity resolution for the slot.

Parameters:code ((optional) ask_smapi_model.v1.skill.evaluations.resolutions_per_authority_status_code.ResolutionsPerAuthorityStatusCode) –

attribute_map = {'code': 'code'}

deserialized_types = {'code': 'ask_smapi_model.v1.skill.evaluations.resolutions_per_authority_status_code.ResolutionsPerAuthorityStatusCode'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.evaluations.resolutions_per_authority_status_code module

class ask_smapi_model.v1.skill.evaluations.resolutions_per_authority_status_code.ResolutionsPerAuthorityStatusCode

Bases: enum.Enum

A code indicating the results of attempting to resolve the user utterance against the defined slot types. This can be one of the following: ER_SUCCESS_MATCH: The spoken value matched a value or synonym explicitly defined in your custom slot type. ER_SUCCESS_NO_MATCH: The spoken value did not match any values or synonyms explicitly defined in your custom slot type. ER_ERROR_TIMEOUT: An error occurred due to a timeout. ER_ERROR_EXCEPTION: An error occurred due to an exception during processing.

Allowed enum values: [ER_SUCCESS_MATCH, ER_SUCCESS_NO_MATCH, ER_ERROR_TIMEOUT, ER_ERROR_EXCEPTION]

ER_ERROR_EXCEPTION = 'ER_ERROR_EXCEPTION'

ER_ERROR_TIMEOUT = 'ER_ERROR_TIMEOUT'

ER_SUCCESS_MATCH = 'ER_SUCCESS_MATCH'

ER_SUCCESS_NO_MATCH = 'ER_SUCCESS_NO_MATCH'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.evaluations.resolutions_per_authority_value_items module

class ask_smapi_model.v1.skill.evaluations.resolutions_per_authority_value_items.ResolutionsPerAuthorityValueItems(name=None, id=None)

Bases: object

An object representing the resolved value for the slot, based on the user's utterance and the slot type definition.

Parameters:

• name ((optional) str) – The string for the resolved slot value.
• id ((optional) str) – The unique ID defined for the resolved slot value. This is based on the IDs defined in the slot type definition.

attribute_map = {'id': 'id', 'name': 'name'}

deserialized_types = {'id': 'str', 'name': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.evaluations.slot module

class ask_smapi_model.v1.skill.evaluations.slot.Slot(name=None, value=None, confirmation_status=None, resolutions=None)

Bases: object

Parameters:

• name ((optional) str) –
• value ((optional) str) –
• confirmation_status ((optional) ask_smapi_model.v1.skill.evaluations.confirmation_status_type.ConfirmationStatusType) –
• resolutions ((optional) ask_smapi_model.v1.skill.evaluations.slot_resolutions.SlotResolutions) –

attribute_map = {'confirmation_status': 'confirmationStatus', 'name': 'name', 'resolutions': 'resolutions', 'value': 'value'}

deserialized_types = {'confirmation_status': 'ask_smapi_model.v1.skill.evaluations.confirmation_status_type.ConfirmationStatusType', 'name': 'str', 'resolutions': 'ask_smapi_model.v1.skill.evaluations.slot_resolutions.SlotResolutions', 'value': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.evaluations.slot_resolutions module

class ask_smapi_model.v1.skill.evaluations.slot_resolutions.SlotResolutions(resolutions_per_authority=None)

Bases: object

A resolutions object representing the results of resolving the words captured from the user's utterance.

Parameters:resolutions_per_authority ((optional) list[ask_smapi_model.v1.skill.evaluations.resolutions_per_authority_items.ResolutionsPerAuthorityItems]) – An array of objects representing each possible authority for entity resolution. An authority represents the source for the data provided for the slot. For a custom slot type, the authority is the slot type you defined.

attribute_map = {'resolutions_per_authority': 'resolutionsPerAuthority'}

deserialized_types = {'resolutions_per_authority': 'list[ask_smapi_model.v1.skill.evaluations.resolutions_per_authority_items.ResolutionsPerAuthorityItems]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.history 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.v1.skill.history.confidence module

class ask_smapi_model.v1.skill.history.confidence.Confidence(bin=None)

Bases: object

The hypothesized confidence for this interaction.

Parameters:bin ((optional) ask_smapi_model.v1.skill.history.confidence_bin.ConfidenceBin) –

attribute_map = {'bin': 'bin'}

deserialized_types = {'bin': 'ask_smapi_model.v1.skill.history.confidence_bin.ConfidenceBin'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.history.confidence_bin module

class ask_smapi_model.v1.skill.history.confidence_bin.ConfidenceBin

Bases: enum.Enum

Intent confidence bin for this utterance. * &#x60;HIGH&#x60;: Intent was recognized with high confidence. * &#x60;MEDIUM&#x60;: Intent was recognized with medium confidence. * &#x60;LOW&#x60;: Intent was recognized with low confidence. Note: Low confidence intents are not sent to the skill.

Allowed enum values: [HIGH, MEDIUM, LOW]

HIGH = 'HIGH'

LOW = 'LOW'

MEDIUM = 'MEDIUM'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.history.dialog_act module

class ask_smapi_model.v1.skill.history.dialog_act.DialogAct(name=None)

Bases: object

The dialog act used in the interaction.

Parameters:name ((optional) ask_smapi_model.v1.skill.history.dialog_act_name.DialogActName) –

attribute_map = {'name': 'name'}

deserialized_types = {'name': 'ask_smapi_model.v1.skill.history.dialog_act_name.DialogActName'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.history.dialog_act_name module

class ask_smapi_model.v1.skill.history.dialog_act_name.DialogActName

Bases: enum.Enum

Dialog act directive name. * &#x60;Dialog.ElicitSlot&#x60;: Alexa asked the user for the value of a specific slot. (https://developer.amazon.com/docs/custom-skills/dialog-interface-reference.html#elicitslot) * &#x60;Dialog.ConfirmSlot&#x60;: 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) * &#x60;Dialog.ConfirmIntent&#x60;: 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)

Allowed enum values: [Dialog_ElicitSlot, Dialog_ConfirmSlot, Dialog_ConfirmIntent]

Dialog_ConfirmIntent = 'Dialog.ConfirmIntent'

Dialog_ConfirmSlot = 'Dialog.ConfirmSlot'

Dialog_ElicitSlot = 'Dialog.ElicitSlot'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.history.intent module

class ask_smapi_model.v1.skill.history.intent.Intent(name=None, confidence=None, slots=None)

Bases: object

Provides the intent name, slots and confidence of the intent used in this interaction.

Parameters:

• name ((optional) str) – The hypothesized intent for this utterance.
• confidence ((optional) ask_smapi_model.v1.skill.history.confidence.Confidence) –
• slots ((optional) dict(str, ask_smapi_model.v1.skill.history.slot.Slot)) – The hypothesized slot(s) for this interaction.

attribute_map = {'confidence': 'confidence', 'name': 'name', 'slots': 'slots'}

deserialized_types = {'confidence': 'ask_smapi_model.v1.skill.history.confidence.Confidence', 'name': 'str', 'slots': 'dict(str, ask_smapi_model.v1.skill.history.slot.Slot)'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.history.intent_confidence_bin module

class ask_smapi_model.v1.skill.history.intent_confidence_bin.IntentConfidenceBin

Bases: enum.Enum

A filter used to retrieve items where the intent confidence bin is equal to the given value. * &#x60;HIGH&#x60;: Intent was recognized with high confidence. * &#x60;MEDIUM&#x60;: Intent was recognized with medium confidence. * &#x60;LOW&#x60;: Intent was recognized with low confidence. Note: Low confidence intents are not sent to the skill.

Allowed enum values: [HIGH, MEDIUM, LOW]

HIGH = 'HIGH'

LOW = 'LOW'

MEDIUM = 'MEDIUM'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.history.intent_request module

class ask_smapi_model.v1.skill.history.intent_request.IntentRequest(dialog_act=None, intent=None, interaction_type=None, locale=None, publication_status=None, stage=None, utterance_text=None)

Bases: object

Parameters:

• dialog_act ((optional) ask_smapi_model.v1.skill.history.dialog_act.DialogAct) –
• intent ((optional) ask_smapi_model.v1.skill.history.intent.Intent) –
• interaction_type ((optional) ask_smapi_model.v1.skill.history.interaction_type.InteractionType) –
• locale ((optional) ask_smapi_model.v1.skill.history.intent_request_locales.IntentRequestLocales) –
• publication_status ((optional) ask_smapi_model.v1.skill.history.publication_status.PublicationStatus) –
• stage ((optional) ask_smapi_model.v1.stage_type.StageType) –
• utterance_text ((optional) str) – The transcribed user speech.

attribute_map = {'dialog_act': 'dialogAct', 'intent': 'intent', 'interaction_type': 'interactionType', 'locale': 'locale', 'publication_status': 'publicationStatus', 'stage': 'stage', 'utterance_text': 'utteranceText'}

deserialized_types = {'dialog_act': 'ask_smapi_model.v1.skill.history.dialog_act.DialogAct', 'intent': 'ask_smapi_model.v1.skill.history.intent.Intent', 'interaction_type': 'ask_smapi_model.v1.skill.history.interaction_type.InteractionType', 'locale': 'ask_smapi_model.v1.skill.history.intent_request_locales.IntentRequestLocales', 'publication_status': 'ask_smapi_model.v1.skill.history.publication_status.PublicationStatus', 'stage': 'ask_smapi_model.v1.stage_type.StageType', 'utterance_text': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.history.intent_request_locales module

class ask_smapi_model.v1.skill.history.intent_request_locales.IntentRequestLocales

Bases: enum.Enum

Skill locale in which this interaction occurred.

Allowed enum values: [en_US, en_GB, en_IN, en_CA, en_AU, de_DE, ja_JP]

de_DE = 'de-DE'

en_AU = 'en-AU'

en_CA = 'en-CA'

en_GB = 'en-GB'

en_IN = 'en-IN'

en_US = 'en-US'

ja_JP = 'ja-JP'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.history.intent_requests module

class ask_smapi_model.v1.skill.history.intent_requests.IntentRequests(links=None, next_token=None, is_truncated=None, total_count=None, start_index=None, skill_id=None, items=None)

Bases: object

Response to the GET Intent Request History API. It contains the collection of utterances for the skill, nextToken and other metadata related to the search query.

Parameters:

• links ((optional) ask_smapi_model.v1.links.Links) –
• next_token ((optional) str) – This token can be used to load the next page of the result.
• is_truncated ((optional) bool) – This property is true when all the results matching the search request haven't been returned, false otherwise.
• total_count ((optional) float) – Total number of records that matched the given search query.
• start_index ((optional) float) – Position of the current page in the result set.
• skill_id ((optional) str) – The Skill Id.
• items ((optional) list[ask_smapi_model.v1.skill.history.intent_request.IntentRequest]) – List of intent requests for the skill

attribute_map = {'is_truncated': 'isTruncated', 'items': 'items', 'links': '_links', 'next_token': 'nextToken', 'skill_id': 'skillId', 'start_index': 'startIndex', 'total_count': 'totalCount'}

deserialized_types = {'is_truncated': 'bool', 'items': 'list[ask_smapi_model.v1.skill.history.intent_request.IntentRequest]', 'links': 'ask_smapi_model.v1.links.Links', 'next_token': 'str', 'skill_id': 'str', 'start_index': 'float', 'total_count': 'float'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.history.interaction_type module

class ask_smapi_model.v1.skill.history.interaction_type.InteractionType

Bases: enum.Enum

Indicates if the utterance was executed as a &quot;ONE_SHOT&quot; interaction or &quot;MODAL&quot; interaction. * &#x60;ONE_SHOT&#x60;: The user invokes the skill and states their intent in a single phrase. * &#x60;MODAL&#x60;: The user first invokes the skill and then states their intent.

Allowed enum values: [ONE_SHOT, MODAL]

MODAL = 'MODAL'

ONE_SHOT = 'ONE_SHOT'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.history.locale_in_query module

class ask_smapi_model.v1.skill.history.locale_in_query.LocaleInQuery

Bases: enum.Enum

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

Allowed enum values: [en_US, en_GB, en_IN, en_CA, en_AU, de_DE, ja_JP]

de_DE = 'de-DE'

en_AU = 'en-AU'

en_CA = 'en-CA'

en_GB = 'en-GB'

en_IN = 'en-IN'

en_US = 'en-US'

ja_JP = 'ja-JP'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.history.publication_status module

class ask_smapi_model.v1.skill.history.publication_status.PublicationStatus

Bases: enum.Enum

The publication status of the skill when this interaction occurred

Allowed enum values: [Development, Certification]

Certification = 'Certification'

Development = 'Development'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.history.slot module

class ask_smapi_model.v1.skill.history.slot.Slot(name=None)

Bases: object

Parameters:name ((optional) str) – Name of the slot that was used in this interaction.

attribute_map = {'name': 'name'}

deserialized_types = {'name': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.history.sort_field_for_intent_request_type module

class ask_smapi_model.v1.skill.history.sort_field_for_intent_request_type.SortFieldForIntentRequestType

Bases: enum.Enum

Allowed enum values: [recordCount, intent_name, intent_confidence_bin, stage, dialogAct_name, locale, utteranceText, publicationStatus, interactionType]

dialogAct_name = 'dialogAct.name'

intent_confidence_bin = 'intent.confidence.bin'

intent_name = 'intent.name'

interactionType = 'interactionType'

locale = 'locale'

publicationStatus = 'publicationStatus'

recordCount = 'recordCount'

stage = 'stage'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

utteranceText = 'utteranceText'

ask_smapi_model.v1.skill.interaction_model package

Subpackages

ask_smapi_model.v1.skill.interaction_model.catalog 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.v1.skill.interaction_model.catalog.catalog_definition_output module

class ask_smapi_model.v1.skill.interaction_model.catalog.catalog_definition_output.CatalogDefinitionOutput(catalog=None, creation_time=None, total_versions=None)

Bases: object

Catalog request definitions.

Parameters:

• catalog ((optional) ask_smapi_model.v1.skill.interaction_model.catalog.catalog_entity.CatalogEntity) –
• creation_time ((optional) str) – Time of the catalog definition creation.
• total_versions ((optional) str) – Total number of versions.

attribute_map = {'catalog': 'catalog', 'creation_time': 'creationTime', 'total_versions': 'totalVersions'}

deserialized_types = {'catalog': 'ask_smapi_model.v1.skill.interaction_model.catalog.catalog_entity.CatalogEntity', 'creation_time': 'str', 'total_versions': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.interaction_model.catalog.catalog_entity module

class ask_smapi_model.v1.skill.interaction_model.catalog.catalog_entity.CatalogEntity(name=None, description=None)

Bases: object

Definition for catalog entity.

Parameters:

• name ((optional) str) – Name of the catalog.
• description ((optional) str) – Description string about the catalog.

attribute_map = {'description': 'description', 'name': 'name'}

deserialized_types = {'description': 'str', 'name': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.interaction_model.catalog.catalog_input module

class ask_smapi_model.v1.skill.interaction_model.catalog.catalog_input.CatalogInput(name=None, description=None)

Bases: object

Definition for catalog input.

Parameters:

• name ((optional) str) – Name of the catalog.
• description ((optional) str) – Description string about the catalog.

attribute_map = {'description': 'description', 'name': 'name'}

deserialized_types = {'description': 'str', 'name': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.interaction_model.catalog.catalog_item module

class ask_smapi_model.v1.skill.interaction_model.catalog.catalog_item.CatalogItem(name=None, description=None, catalog_id=None, links=None)

Bases: object

Definition for catalog entity.

Parameters:

• name ((optional) str) – Name of the catalog.
• description ((optional) str) – Description string about the catalog.
• catalog_id ((optional) str) – Identifier of the catalog, optional in get response as the request already has catalogId.
• links ((optional) ask_smapi_model.v1.links.Links) –

attribute_map = {'catalog_id': 'catalogId', 'description': 'description', 'links': '_links', 'name': 'name'}

deserialized_types = {'catalog_id': 'str', 'description': 'str', 'links': 'ask_smapi_model.v1.links.Links', 'name': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.interaction_model.catalog.catalog_response module

class ask_smapi_model.v1.skill.interaction_model.catalog.catalog_response.CatalogResponse(catalog_id=None)

Bases: object

CatalogId information.

Parameters:catalog_id ((optional) str) – ID of the catalog created.

attribute_map = {'catalog_id': 'catalogId'}

deserialized_types = {'catalog_id': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.interaction_model.catalog.catalog_status module

class ask_smapi_model.v1.skill.interaction_model.catalog.catalog_status.CatalogStatus(last_update_request=None)

Bases: object

Defines the structure for catalog status response.

Parameters:last_update_request ((optional) ask_smapi_model.v1.skill.interaction_model.catalog.last_update_request.LastUpdateRequest) –

attribute_map = {'last_update_request': 'lastUpdateRequest'}

deserialized_types = {'last_update_request': 'ask_smapi_model.v1.skill.interaction_model.catalog.last_update_request.LastUpdateRequest'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.interaction_model.catalog.catalog_status_type module

class ask_smapi_model.v1.skill.interaction_model.catalog.catalog_status_type.CatalogStatusType

Bases: enum.Enum

Status of last modification request for a resource.

Allowed enum values: [FAILED, IN_PROGRESS, SUCCEEDED]

FAILED = 'FAILED'

IN_PROGRESS = 'IN_PROGRESS'

SUCCEEDED = 'SUCCEEDED'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.interaction_model.catalog.definition_data module

class ask_smapi_model.v1.skill.interaction_model.catalog.definition_data.DefinitionData(catalog=None, vendor_id=None)

Bases: object

Catalog request definitions.

Parameters:

• catalog ((optional) ask_smapi_model.v1.skill.interaction_model.catalog.catalog_input.CatalogInput) –
• vendor_id ((optional) str) – The vendorId that the catalog should belong to.

attribute_map = {'catalog': 'catalog', 'vendor_id': 'vendorId'}

deserialized_types = {'catalog': 'ask_smapi_model.v1.skill.interaction_model.catalog.catalog_input.CatalogInput', 'vendor_id': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.interaction_model.catalog.last_update_request module

class ask_smapi_model.v1.skill.interaction_model.catalog.last_update_request.LastUpdateRequest(status=None, version=None, errors=None)

Bases: object

Contains attributes related to last modification request of a resource.

Parameters:

• status ((optional) ask_smapi_model.v1.skill.interaction_model.catalog.catalog_status_type.CatalogStatusType) –
• version ((optional) str) – The version id of the entity returned.
• errors ((optional) list[ask_smapi_model.v1.skill.standardized_error.StandardizedError]) –

attribute_map = {'errors': 'errors', 'status': 'status', 'version': 'version'}

deserialized_types = {'errors': 'list[ask_smapi_model.v1.skill.standardized_error.StandardizedError]', 'status': 'ask_smapi_model.v1.skill.interaction_model.catalog.catalog_status_type.CatalogStatusType', 'version': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.interaction_model.catalog.list_catalog_response module

class ask_smapi_model.v1.skill.interaction_model.catalog.list_catalog_response.ListCatalogResponse(links=None, catalogs=None, is_truncated=None, next_token=None, total_count=None)

Bases: object

List of catalog versions of a skill for the vendor.

Parameters:

• links ((optional) ask_smapi_model.v1.links.Links) –
• catalogs ((optional) list[ask_smapi_model.v1.skill.interaction_model.catalog.catalog_item.CatalogItem]) – List of catalogs.
• is_truncated ((optional) bool) –
• next_token ((optional) str) –
• total_count ((optional) int) –

attribute_map = {'catalogs': 'catalogs', 'is_truncated': 'isTruncated', 'links': '_links', 'next_token': 'nextToken', 'total_count': 'totalCount'}

deserialized_types = {'catalogs': 'list[ask_smapi_model.v1.skill.interaction_model.catalog.catalog_item.CatalogItem]', 'is_truncated': 'bool', 'links': 'ask_smapi_model.v1.links.Links', 'next_token': 'str', 'total_count': 'int'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.interaction_model.catalog.update_request module

class ask_smapi_model.v1.skill.interaction_model.catalog.update_request.UpdateRequest(name=None, description=None)

Bases: object

Catalog update request object.

Parameters:

• name ((optional) str) – The catalog name.
• description ((optional) str) – The catalog description with a 255 character maximum.

attribute_map = {'description': 'description', 'name': 'name'}

deserialized_types = {'description': 'str', 'name': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.interaction_model.version 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.v1.skill.interaction_model.version.catalog_update module

class ask_smapi_model.v1.skill.interaction_model.version.catalog_update.CatalogUpdate(description=None)

Bases: object

Catalog update description object.

Parameters:description ((optional) str) – The catalog description with a 255 character maximum.

attribute_map = {'description': 'description'}

deserialized_types = {'description': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.interaction_model.version.catalog_values module

class ask_smapi_model.v1.skill.interaction_model.version.catalog_values.CatalogValues(is_truncated=None, next_token=None, total_count=None, links=None, values=None)

Bases: object

List of catalog values.

Parameters:

• is_truncated ((optional) bool) –
• next_token ((optional) str) –
• total_count ((optional) int) – Total number of catalog values.
• links ((optional) ask_smapi_model.v1.links.Links) –
• values ((optional) list[ask_smapi_model.v1.skill.interaction_model.version.value_schema.ValueSchema]) –

attribute_map = {'is_truncated': 'isTruncated', 'links': '_links', 'next_token': 'nextToken', 'total_count': 'totalCount', 'values': 'values'}

deserialized_types = {'is_truncated': 'bool', 'links': 'ask_smapi_model.v1.links.Links', 'next_token': 'str', 'total_count': 'int', 'values': 'list[ask_smapi_model.v1.skill.interaction_model.version.value_schema.ValueSchema]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.interaction_model.version.catalog_version_data module

class ask_smapi_model.v1.skill.interaction_model.version.catalog_version_data.CatalogVersionData(source=None, description=None, version=None)

Bases: object

Catalog version data with metadata.

Parameters:

• source ((optional) ask_smapi_model.v1.skill.interaction_model.version.input_source.InputSource) –
• description ((optional) str) – Description string for specific catalog version.
• version ((optional) str) – Specific catalog version.

attribute_map = {'description': 'description', 'source': 'source', 'version': 'version'}

deserialized_types = {'description': 'str', 'source': 'ask_smapi_model.v1.skill.interaction_model.version.input_source.InputSource', 'version': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.interaction_model.version.input_source module

class ask_smapi_model.v1.skill.interaction_model.version.input_source.InputSource(object_type=None, url=None)

Bases: object

Definition for catalog version input data.

Parameters:

• object_type ((optional) str) – Type of catalog.
• url ((optional) str) – Url to the catalog reference.

attribute_map = {'object_type': 'type', 'url': 'url'}

deserialized_types = {'object_type': 'str', 'url': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.interaction_model.version.links module

class ask_smapi_model.v1.skill.interaction_model.version.links.Links(object_self=None)

Bases: object

Parameters:object_self ((optional) ask_smapi_model.v1.link.Link) –

attribute_map = {'object_self': 'self'}

deserialized_types = {'object_self': 'ask_smapi_model.v1.link.Link'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.interaction_model.version.list_response module

class ask_smapi_model.v1.skill.interaction_model.version.list_response.ListResponse(links=None, skill_model_versions=None, is_truncated=None, next_token=None)

Bases: object

List of interactionModel versions of a skill for the vendor

Parameters:

• links ((optional) ask_smapi_model.v1.links.Links) –
• skill_model_versions ((optional) list[ask_smapi_model.v1.skill.interaction_model.version.version_items.VersionItems]) – List of interaction model versions.
• is_truncated ((optional) bool) –
• next_token ((optional) str) –

attribute_map = {'is_truncated': 'isTruncated', 'links': '_links', 'next_token': 'nextToken', 'skill_model_versions': 'skillModelVersions'}

deserialized_types = {'is_truncated': 'bool', 'links': 'ask_smapi_model.v1.links.Links', 'next_token': 'str', 'skill_model_versions': 'list[ask_smapi_model.v1.skill.interaction_model.version.version_items.VersionItems]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.interaction_model.version.value_schema module

class ask_smapi_model.v1.skill.interaction_model.version.value_schema.ValueSchema(id=None, name=None)

Bases: object

The value schema in type object of interaction model.

Parameters:

• id ((optional) str) –
• name ((optional) ask_smapi_model.v1.skill.interaction_model.version.value_schema_name.ValueSchemaName) –

attribute_map = {'id': 'id', 'name': 'name'}

deserialized_types = {'id': 'str', 'name': 'ask_smapi_model.v1.skill.interaction_model.version.value_schema_name.ValueSchemaName'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.interaction_model.version.value_schema_name module

class ask_smapi_model.v1.skill.interaction_model.version.value_schema_name.ValueSchemaName(value=None, synonyms=None)

Bases: object

Parameters:

• value ((optional) str) –
• synonyms ((optional) list[str]) –

attribute_map = {'synonyms': 'synonyms', 'value': 'value'}

deserialized_types = {'synonyms': 'list[str]', 'value': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.interaction_model.version.version_data module

class ask_smapi_model.v1.skill.interaction_model.version.version_data.VersionData(source=None, description=None)

Bases: object

Catalog version specific data.

Parameters:

• source ((optional) ask_smapi_model.v1.skill.interaction_model.version.input_source.InputSource) –
• description ((optional) str) – Description string for specific catalog version.

attribute_map = {'description': 'description', 'source': 'source'}

deserialized_types = {'description': 'str', 'source': 'ask_smapi_model.v1.skill.interaction_model.version.input_source.InputSource'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.interaction_model.version.version_items module

class ask_smapi_model.v1.skill.interaction_model.version.version_items.VersionItems(version=None, creation_time=None, description=None, links=None)

Bases: object

Version metadata about the entity.

Parameters:

• version ((optional) str) –
• creation_time ((optional) str) –
• description ((optional) str) –
• links ((optional) ask_smapi_model.v1.skill.interaction_model.version.links.Links) –

attribute_map = {'creation_time': 'creationTime', 'description': 'description', 'links': '_links', 'version': 'version'}

deserialized_types = {'creation_time': 'str', 'description': 'str', 'links': 'ask_smapi_model.v1.skill.interaction_model.version.links.Links', 'version': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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.v1.skill.interaction_model.catalog_value_supplier module

class ask_smapi_model.v1.skill.interaction_model.catalog_value_supplier.CatalogValueSupplier(value_catalog=None)

Bases: ask_smapi_model.v1.skill.interaction_model.value_supplier.ValueSupplier

Supply slot values from catalog(s).

Parameters:value_catalog ((optional) ask_smapi_model.v1.skill.interaction_model.value_catalog.ValueCatalog) –

attribute_map = {'object_type': 'type', 'value_catalog': 'valueCatalog'}

deserialized_types = {'object_type': 'str', 'value_catalog': 'ask_smapi_model.v1.skill.interaction_model.value_catalog.ValueCatalog'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.interaction_model.delegation_strategy_type module

class ask_smapi_model.v1.skill.interaction_model.delegation_strategy_type.DelegationStrategyType

Bases: enum.Enum

Enumerates delegation strategies used to control automatic dialog management through the defined dialog model. When no delegation strategies are defined, the value SKILL_RESPONSE is assumed.

Allowed enum values: [ALWAYS, SKILL_RESPONSE]

ALWAYS = 'ALWAYS'

SKILL_RESPONSE = 'SKILL_RESPONSE'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.interaction_model.dialog module

class ask_smapi_model.v1.skill.interaction_model.dialog.Dialog(delegation_strategy=None, intents=None)

Bases: object

Defines dialog rules e.g. slot elicitation and validation, intent chaining etc.

Parameters:

• delegation_strategy ((optional) ask_smapi_model.v1.skill.interaction_model.delegation_strategy_type.DelegationStrategyType) – Defines a delegation strategy for the dialogs in this dialog model.
• intents ((optional) list[ask_smapi_model.v1.skill.interaction_model.dialog_intents.DialogIntents]) – List of intents that have dialog rules associated with them. Dialogs can also span multiple intents.

attribute_map = {'delegation_strategy': 'delegationStrategy', 'intents': 'intents'}

deserialized_types = {'delegation_strategy': 'ask_smapi_model.v1.skill.interaction_model.delegation_strategy_type.DelegationStrategyType', 'intents': 'list[ask_smapi_model.v1.skill.interaction_model.dialog_intents.DialogIntents]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.interaction_model.dialog_intents module

class ask_smapi_model.v1.skill.interaction_model.dialog_intents.DialogIntents(name=None, delegation_strategy=None, slots=None, confirmation_required=None, prompts=None)

Bases: object

Parameters:

• name ((optional) str) – Name of the intent that has a dialog specification.
• delegation_strategy ((optional) ask_smapi_model.v1.skill.interaction_model.delegation_strategy_type.DelegationStrategyType) – Defines an intent-specific delegation strategy for this dialog intent. Overrides dialog-level setting.
• slots ((optional) list[ask_smapi_model.v1.skill.interaction_model.dialog_slot_items.DialogSlotItems]) – List of slots that have dialog rules.
• confirmation_required ((optional) bool) – Describes whether confirmation of the intent is required.
• prompts ((optional) ask_smapi_model.v1.skill.interaction_model.dialog_intents_prompts.DialogIntentsPrompts) –

attribute_map = {'confirmation_required': 'confirmationRequired', 'delegation_strategy': 'delegationStrategy', 'name': 'name', 'prompts': 'prompts', 'slots': 'slots'}

deserialized_types = {'confirmation_required': 'bool', 'delegation_strategy': 'ask_smapi_model.v1.skill.interaction_model.delegation_strategy_type.DelegationStrategyType', 'name': 'str', 'prompts': 'ask_smapi_model.v1.skill.interaction_model.dialog_intents_prompts.DialogIntentsPrompts', 'slots': 'list[ask_smapi_model.v1.skill.interaction_model.dialog_slot_items.DialogSlotItems]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.interaction_model.dialog_intents_prompts module

class ask_smapi_model.v1.skill.interaction_model.dialog_intents_prompts.DialogIntentsPrompts(elicitation=None, confirmation=None)

Bases: object

Collection of prompts for this intent.

Parameters:

• elicitation ((optional) str) – Enum value in the dialog_slots map to reference the elicitation prompt id.
• confirmation ((optional) str) – Enum value in the dialog_slots map to reference the confirmation prompt id.

attribute_map = {'confirmation': 'confirmation', 'elicitation': 'elicitation'}

deserialized_types = {'confirmation': 'str', 'elicitation': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.interaction_model.dialog_prompts module

class ask_smapi_model.v1.skill.interaction_model.dialog_prompts.DialogPrompts(elicitation=None, confirmation=None)

Bases: object

Dialog prompts associated with this slot i.e. for elicitation and/or confirmation.

Parameters:

• elicitation ((optional) str) – Reference to a prompt-id to use If this slot value is missing.
• confirmation ((optional) str) – Reference to a prompt-id to use to confirm the slots value.

attribute_map = {'confirmation': 'confirmation', 'elicitation': 'elicitation'}

deserialized_types = {'confirmation': 'str', 'elicitation': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.interaction_model.dialog_slot_items module

class ask_smapi_model.v1.skill.interaction_model.dialog_slot_items.DialogSlotItems(name=None, object_type=None, elicitation_required=None, confirmation_required=None, prompts=None, validations=None)

Bases: object

Parameters:

• name ((optional) str) – The name of the slot that has dialog rules associated with it.
• object_type ((optional) str) – Type of the slot in the dialog intent.
• elicitation_required ((optional) bool) – Describes whether elicitation of the slot is required.
• confirmation_required ((optional) bool) – Describes whether confirmation of the slot is required.
• prompts ((optional) ask_smapi_model.v1.skill.interaction_model.dialog_prompts.DialogPrompts) –
• validations ((optional) list[ask_smapi_model.v1.skill.interaction_model.slot_validation.SlotValidation]) – List of validations for the slot. if validation fails, user will be prompted with the provided prompt.

attribute_map = {'confirmation_required': 'confirmationRequired', 'elicitation_required': 'elicitationRequired', 'name': 'name', 'object_type': 'type', 'prompts': 'prompts', 'validations': 'validations'}

deserialized_types = {'confirmation_required': 'bool', 'elicitation_required': 'bool', 'name': 'str', 'object_type': 'str', 'prompts': 'ask_smapi_model.v1.skill.interaction_model.dialog_prompts.DialogPrompts', 'validations': 'list[ask_smapi_model.v1.skill.interaction_model.slot_validation.SlotValidation]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.interaction_model.has_entity_resolution_match module

class ask_smapi_model.v1.skill.interaction_model.has_entity_resolution_match.HasEntityResolutionMatch(prompt=None)

Bases: ask_smapi_model.v1.skill.interaction_model.slot_validation.SlotValidation

The hasEntityResolutionMatch would allow Alexa to trigger a re-prompt when the status produced by ER is &quot;ER_SUCCESS_NO_MATCH&quot;.

Parameters:prompt ((optional) str) – The prompt id that should be used if validation fails.

attribute_map = {'object_type': 'type', 'prompt': 'prompt'}

deserialized_types = {'object_type': 'str', 'prompt': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.interaction_model.intent module

class ask_smapi_model.v1.skill.interaction_model.intent.Intent(name=None, slots=None, samples=None)

Bases: object

The set of intents your service can accept and process.

Parameters:

• name ((optional) str) – Name to identify the intent.
• slots ((optional) list[ask_smapi_model.v1.skill.interaction_model.slot_definition.SlotDefinition]) – List of slots within the intent.
• samples ((optional) list[str]) – Phrases the user can speak e.g. to trigger an intent or provide value for a slot elicitation.

attribute_map = {'name': 'name', 'samples': 'samples', 'slots': 'slots'}

deserialized_types = {'name': 'str', 'samples': 'list[str]', 'slots': 'list[ask_smapi_model.v1.skill.interaction_model.slot_definition.SlotDefinition]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.interaction_model.interaction_model_data module

class ask_smapi_model.v1.skill.interaction_model.interaction_model_data.InteractionModelData(version=None, description=None, interaction_model=None)

Bases: object

Parameters:

• version ((optional) str) –
• description ((optional) str) –
• interaction_model ((optional) ask_smapi_model.v1.skill.interaction_model.interaction_model_schema.InteractionModelSchema) –

attribute_map = {'description': 'description', 'interaction_model': 'interactionModel', 'version': 'version'}

deserialized_types = {'description': 'str', 'interaction_model': 'ask_smapi_model.v1.skill.interaction_model.interaction_model_schema.InteractionModelSchema', 'version': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.interaction_model.interaction_model_schema module

class ask_smapi_model.v1.skill.interaction_model.interaction_model_schema.InteractionModelSchema(language_model=None, dialog=None, prompts=None)

Bases: object

Parameters:

• language_model ((optional) ask_smapi_model.v1.skill.interaction_model.language_model.LanguageModel) –
• dialog ((optional) ask_smapi_model.v1.skill.interaction_model.dialog.Dialog) –
• prompts ((optional) list[ask_smapi_model.v1.skill.interaction_model.prompt.Prompt]) – List of prompts.

attribute_map = {'dialog': 'dialog', 'language_model': 'languageModel', 'prompts': 'prompts'}

deserialized_types = {'dialog': 'ask_smapi_model.v1.skill.interaction_model.dialog.Dialog', 'language_model': 'ask_smapi_model.v1.skill.interaction_model.language_model.LanguageModel', 'prompts': 'list[ask_smapi_model.v1.skill.interaction_model.prompt.Prompt]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.interaction_model.is_greater_than module

class ask_smapi_model.v1.skill.interaction_model.is_greater_than.IsGreaterThan(prompt=None, value=None)

Bases: ask_smapi_model.v1.skill.interaction_model.slot_validation.SlotValidation

Validates that slot value is greater than the specified value.

Parameters:

• prompt ((optional) str) – The prompt id that should be used if validation fails.
• value ((optional) str) – Value to compare to.

attribute_map = {'object_type': 'type', 'prompt': 'prompt', 'value': 'value'}

deserialized_types = {'object_type': 'str', 'prompt': 'str', 'value': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.interaction_model.is_greater_than_or_equal_to module

class ask_smapi_model.v1.skill.interaction_model.is_greater_than_or_equal_to.IsGreaterThanOrEqualTo(prompt=None, value=None)

Bases: ask_smapi_model.v1.skill.interaction_model.slot_validation.SlotValidation

Validates that slot value is greater than or equals to the specified value.

Parameters:

• prompt ((optional) str) – The prompt id that should be used if validation fails.
• value ((optional) str) – Value to compare to.

attribute_map = {'object_type': 'type', 'prompt': 'prompt', 'value': 'value'}

deserialized_types = {'object_type': 'str', 'prompt': 'str', 'value': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.interaction_model.is_in_duration module

class ask_smapi_model.v1.skill.interaction_model.is_in_duration.IsInDuration(prompt=None, start=None, end=None)

Bases: ask_smapi_model.v1.skill.interaction_model.slot_validation.SlotValidation

Validates that the given date or time (as a slot value) is in a given interval. Unlike other range validations, duration based validations lets the developer define a dynamic range of date or time using ISO_8601 Duration Format. Based on the given 'start' and 'end' parameters an interval is created. The slot value given by the skill's user at runtime is then validated inside this interval. Both 'start' and 'end' parameters are in reference to the current date/time. Here the current date/time refers to the date/time when the skill's user made the request.

Parameters:

• prompt ((optional) str) – The prompt id that should be used if validation fails.
• start ((optional) str) –
  • &#x60;AMAZON.DATE&#x60;: ISO 8601 Duration using Y, M or D components or ISO 8601 Calendar Date in YYYY-MM-DD format. * &#x60;AMAZON.TIME&#x60;: ISO 8601 Duration using H or M component or ISO 8601 24-Hour Clock Time in hh:mm format.
• end ((optional) str) –
  • &#x60;AMAZON.DATE&#x60;: ISO 8601 Duration using Y, M or D components or ISO 8601 Calendar Date in YYYY-MM-DD format. * &#x60;AMAZON.TIME&#x60;: ISO 8601 Duration using H or M component or ISO 8601 24-Hour Clock Time in hh:mm format.

attribute_map = {'end': 'end', 'object_type': 'type', 'prompt': 'prompt', 'start': 'start'}

deserialized_types = {'end': 'str', 'object_type': 'str', 'prompt': 'str', 'start': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.interaction_model.is_in_set module

class ask_smapi_model.v1.skill.interaction_model.is_in_set.IsInSet(prompt=None, values=None)

Bases: ask_smapi_model.v1.skill.interaction_model.slot_validation.SlotValidation

Validates if the slot is in the specified set of values.

Parameters:

• prompt ((optional) str) – The prompt id that should be used if validation fails.
• values ((optional) list[str]) – List of values to check.

attribute_map = {'object_type': 'type', 'prompt': 'prompt', 'values': 'values'}

deserialized_types = {'object_type': 'str', 'prompt': 'str', 'values': 'list[str]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.interaction_model.is_less_than module

class ask_smapi_model.v1.skill.interaction_model.is_less_than.IsLessThan(prompt=None, value=None)

Bases: ask_smapi_model.v1.skill.interaction_model.slot_validation.SlotValidation

Validates that slot value is less than or equals to the specified value.

Parameters:

• prompt ((optional) str) – The prompt id that should be used if validation fails.
• value ((optional) str) – Value to compare to.

attribute_map = {'object_type': 'type', 'prompt': 'prompt', 'value': 'value'}

deserialized_types = {'object_type': 'str', 'prompt': 'str', 'value': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.interaction_model.is_less_than_or_equal_to module

class ask_smapi_model.v1.skill.interaction_model.is_less_than_or_equal_to.IsLessThanOrEqualTo(prompt=None, value=None)

Bases: ask_smapi_model.v1.skill.interaction_model.slot_validation.SlotValidation

Validates that slot value is less than or equals to the specified value.

Parameters:

• prompt ((optional) str) – The prompt id that should be used if validation fails.
• value ((optional) str) – Value to compare to.

attribute_map = {'object_type': 'type', 'prompt': 'prompt', 'value': 'value'}

deserialized_types = {'object_type': 'str', 'prompt': 'str', 'value': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.interaction_model.is_not_in_duration module

class ask_smapi_model.v1.skill.interaction_model.is_not_in_duration.IsNotInDuration(prompt=None, start=None, end=None)

Bases: ask_smapi_model.v1.skill.interaction_model.slot_validation.SlotValidation

Validates that the given date or time (as a slot value) is not in a given interval. Unlike other range validations, duration based validations lets the developer define a dynamic range of date or time using ISO_8601 Duration Format. Based on the given 'start' and 'end' parameters an interval is created. The slot value given by the skill's user at runtime is then validated inside this interval. Both 'start' and 'end' parameters are in reference to the current date/time. Here the current date/time refers to the date/time when the skill's user made the request.

Parameters:

• prompt ((optional) str) – The prompt id that should be used if validation fails.
• start ((optional) str) –
  • &#x60;AMAZON.DATE&#x60;: ISO 8601 Duration using Y, M or D components or ISO 8601 Calendar Date in YYYY-MM-DD format. * &#x60;AMAZON.TIME&#x60;: ISO 8601 Duration using H or M component or ISO 8601 24-Hour Clock Time in hh:mm format.
• end ((optional) str) –
  • &#x60;AMAZON.DATE&#x60;: ISO 8601 Duration using Y, M or D components or ISO 8601 Calendar Date in YYYY-MM-DD format. * &#x60;AMAZON.TIME&#x60;: ISO 8601 Duration using H or M component or ISO 8601 24-Hour Clock Time in hh:mm format.

attribute_map = {'end': 'end', 'object_type': 'type', 'prompt': 'prompt', 'start': 'start'}

deserialized_types = {'end': 'str', 'object_type': 'str', 'prompt': 'str', 'start': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.interaction_model.is_not_in_set module

class ask_smapi_model.v1.skill.interaction_model.is_not_in_set.IsNotInSet(prompt=None, values=None)

Bases: ask_smapi_model.v1.skill.interaction_model.slot_validation.SlotValidation

Validates if the slot is not in the specified set of values.

Parameters:

• prompt ((optional) str) – The prompt id that should be used if validation fails.
• values ((optional) list[str]) – List of values to check.

attribute_map = {'object_type': 'type', 'prompt': 'prompt', 'values': 'values'}

deserialized_types = {'object_type': 'str', 'prompt': 'str', 'values': 'list[str]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.interaction_model.language_model module

class ask_smapi_model.v1.skill.interaction_model.language_model.LanguageModel(invocation_name=None, types=None, intents=None, model_configuration=None)

Bases: object

Define the language model.

Parameters:

• invocation_name ((optional) str) – Invocation name of the skill.
• types ((optional) list[ask_smapi_model.v1.skill.interaction_model.slot_type.SlotType]) –
• intents ((optional) list[ask_smapi_model.v1.skill.interaction_model.intent.Intent]) –
• model_configuration ((optional) ask_smapi_model.v1.skill.interaction_model.model_configuration.ModelConfiguration) –

attribute_map = {'intents': 'intents', 'invocation_name': 'invocationName', 'model_configuration': 'modelConfiguration', 'types': 'types'}

deserialized_types = {'intents': 'list[ask_smapi_model.v1.skill.interaction_model.intent.Intent]', 'invocation_name': 'str', 'model_configuration': 'ask_smapi_model.v1.skill.interaction_model.model_configuration.ModelConfiguration', 'types': 'list[ask_smapi_model.v1.skill.interaction_model.slot_type.SlotType]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.interaction_model.prompt module

class ask_smapi_model.v1.skill.interaction_model.prompt.Prompt(id=None, variations=None)

Bases: object

Parameters:

• id ((optional) str) – The prompt id, this id can be used from dialog definitions.
• variations ((optional) list[ask_smapi_model.v1.skill.interaction_model.prompt_items.PromptItems]) – List of variations of the prompt, each variation can be either a text string or a well defined ssml string depending on the type defined.

attribute_map = {'id': 'id', 'variations': 'variations'}

deserialized_types = {'id': 'str', 'variations': 'list[ask_smapi_model.v1.skill.interaction_model.prompt_items.PromptItems]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.interaction_model.prompt_items module

class ask_smapi_model.v1.skill.interaction_model.prompt_items.PromptItems(object_type=None, value=None)

Bases: object

Parameters:

• object_type ((optional) ask_smapi_model.v1.skill.interaction_model.prompt_items_type.PromptItemsType) –
• value ((optional) str) – Specifies the prompt.

attribute_map = {'object_type': 'type', 'value': 'value'}

deserialized_types = {'object_type': 'ask_smapi_model.v1.skill.interaction_model.prompt_items_type.PromptItemsType', 'value': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.interaction_model.prompt_items_type module

class ask_smapi_model.v1.skill.interaction_model.prompt_items_type.PromptItemsType

Bases: enum.Enum

Prompt can be specified in different formats e.g. text, ssml.

Allowed enum values: [SSML, PlainText]

PlainText = 'PlainText'

SSML = 'SSML'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.interaction_model.slot_definition module

class ask_smapi_model.v1.skill.interaction_model.slot_definition.SlotDefinition(name=None, object_type=None, multiple_values=None, samples=None)

Bases: object

Slot definition.

Parameters:

• name ((optional) str) – The name of the slot.
• object_type ((optional) str) – The type of the slot. It can be a built-in or custom type.
• multiple_values ((optional) ask_smapi_model.v1.skill.interaction_model.multiple_values_config.MultipleValuesConfig) – Configuration object for multiple values capturing behavior for this slot.
• samples ((optional) list[str]) – Phrases the user can speak e.g. to trigger an intent or provide value for a slot elicitation.

attribute_map = {'multiple_values': 'multipleValues', 'name': 'name', 'object_type': 'type', 'samples': 'samples'}

deserialized_types = {'multiple_values': 'ask_smapi_model.v1.skill.interaction_model.multiple_values_config.MultipleValuesConfig', 'name': 'str', 'object_type': 'str', 'samples': 'list[str]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.interaction_model.slot_type module

class ask_smapi_model.v1.skill.interaction_model.slot_type.SlotType(name=None, values=None, value_supplier=None)

Bases: object

Custom slot type to define a list of possible values for a slot. Used for items that are not covered by Amazon's built-in slot types.

Parameters:

• name ((optional) str) – The name of the custom slot type.
• values ((optional) list[ask_smapi_model.v1.skill.interaction_model.type_value.TypeValue]) – List of expected values. Values outside the list are still returned.
• value_supplier ((optional) ask_smapi_model.v1.skill.interaction_model.value_supplier.ValueSupplier) –

attribute_map = {'name': 'name', 'value_supplier': 'valueSupplier', 'values': 'values'}

deserialized_types = {'name': 'str', 'value_supplier': 'ask_smapi_model.v1.skill.interaction_model.value_supplier.ValueSupplier', 'values': 'list[ask_smapi_model.v1.skill.interaction_model.type_value.TypeValue]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.interaction_model.slot_validation module

class ask_smapi_model.v1.skill.interaction_model.slot_validation.SlotValidation(object_type=None, prompt=None)

Bases: object

Validation on a slot with support for prompt and confirmation.

Parameters:

• object_type ((optional) str) – The exact type of validation e.g. isLessThan,isGreaterThan etc.
• prompt ((optional) str) – The prompt id that should be used if validation fails.

Note

This is an abstract class. Use the following mapping, to figure out the model class to be instantiated, that sets type variable.

hasEntityResolutionMatch: ask_smapi_model.v1.skill.interaction_model.has_entity_resolution_match.HasEntityResolutionMatch,

isLessThanOrEqualTo: ask_smapi_model.v1.skill.interaction_model.is_less_than_or_equal_to.IsLessThanOrEqualTo,

isGreaterThan: ask_smapi_model.v1.skill.interaction_model.is_greater_than.IsGreaterThan,

isNotInSet: ask_smapi_model.v1.skill.interaction_model.is_not_in_set.IsNotInSet,

isInDuration: ask_smapi_model.v1.skill.interaction_model.is_in_duration.IsInDuration,

isLessThan: ask_smapi_model.v1.skill.interaction_model.is_less_than.IsLessThan,

isNotInDuration: ask_smapi_model.v1.skill.interaction_model.is_not_in_duration.IsNotInDuration,

isGreaterThanOrEqualTo: ask_smapi_model.v1.skill.interaction_model.is_greater_than_or_equal_to.IsGreaterThanOrEqualTo,

isInSet: ask_smapi_model.v1.skill.interaction_model.is_in_set.IsInSet

attribute_map = {'object_type': 'type', 'prompt': 'prompt'}

deserialized_types = {'object_type': 'str', 'prompt': 'str'}

discriminator_value_class_map = {'hasEntityResolutionMatch': 'ask_smapi_model.v1.skill.interaction_model.has_entity_resolution_match.HasEntityResolutionMatch', 'isGreaterThan': 'ask_smapi_model.v1.skill.interaction_model.is_greater_than.IsGreaterThan', 'isGreaterThanOrEqualTo': 'ask_smapi_model.v1.skill.interaction_model.is_greater_than_or_equal_to.IsGreaterThanOrEqualTo', 'isInDuration': 'ask_smapi_model.v1.skill.interaction_model.is_in_duration.IsInDuration', 'isInSet': 'ask_smapi_model.v1.skill.interaction_model.is_in_set.IsInSet', 'isLessThan': 'ask_smapi_model.v1.skill.interaction_model.is_less_than.IsLessThan', 'isLessThanOrEqualTo': 'ask_smapi_model.v1.skill.interaction_model.is_less_than_or_equal_to.IsLessThanOrEqualTo', 'isNotInDuration': 'ask_smapi_model.v1.skill.interaction_model.is_not_in_duration.IsNotInDuration', 'isNotInSet': 'ask_smapi_model.v1.skill.interaction_model.is_not_in_set.IsNotInSet'}

classmethod get_real_child_model(data)

Returns the real base class specified by the discriminator

json_discriminator_key = 'type'

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.interaction_model.value_catalog module

class ask_smapi_model.v1.skill.interaction_model.value_catalog.ValueCatalog(catalog_id=None, version=None)

Bases: object

Catalog reference to provide values.

Parameters:

• catalog_id ((optional) str) – CatalogId.
• version ((optional) str) – Catalog version.

attribute_map = {'catalog_id': 'catalogId', 'version': 'version'}

deserialized_types = {'catalog_id': 'str', 'version': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.interaction_model.value_supplier module

class ask_smapi_model.v1.skill.interaction_model.value_supplier.ValueSupplier(object_type=None)

Bases: object

Supplier object to provide slot values.

Parameters:object_type ((optional) str) – The exact type of validation e.g.CatalogValueSupplier etc.

Note

This is an abstract class. Use the following mapping, to figure out the model class to be instantiated, that sets type variable.

CatalogValueSupplier: ask_smapi_model.v1.skill.interaction_model.catalog_value_supplier.CatalogValueSupplier,

InlineValueSupplier: ask_smapi_model.v1.skill.interaction_model.inline_value_supplier.InlineValueSupplier

attribute_map = {'object_type': 'type'}

deserialized_types = {'object_type': 'str'}

discriminator_value_class_map = {'CatalogValueSupplier': 'ask_smapi_model.v1.skill.interaction_model.catalog_value_supplier.CatalogValueSupplier', 'InlineValueSupplier': 'ask_smapi_model.v1.skill.interaction_model.inline_value_supplier.InlineValueSupplier'}

classmethod get_real_child_model(data)

Returns the real base class specified by the discriminator

json_discriminator_key = 'type'

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest 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.v1.skill.manifest.alexa_for_business_apis module

class ask_smapi_model.v1.skill.manifest.alexa_for_business_apis.AlexaForBusinessApis(regions=None, endpoint=None, interfaces=None)

Bases: object

Defines the structure of alexaForBusiness api in the skill manifest.

Parameters:

• regions ((optional) dict(str, ask_smapi_model.v1.skill.manifest.region.Region)) – Contains an array of the supported &lt;region&gt; Objects.
• endpoint ((optional) ask_smapi_model.v1.skill.manifest.skill_manifest_endpoint.SkillManifestEndpoint) –
• interfaces ((optional) list[ask_smapi_model.v1.skill.manifest.alexa_for_business_interface.AlexaForBusinessInterface]) – Contains the list of supported interfaces.

attribute_map = {'endpoint': 'endpoint', 'interfaces': 'interfaces', 'regions': 'regions'}

deserialized_types = {'endpoint': 'ask_smapi_model.v1.skill.manifest.skill_manifest_endpoint.SkillManifestEndpoint', 'interfaces': 'list[ask_smapi_model.v1.skill.manifest.alexa_for_business_interface.AlexaForBusinessInterface]', 'regions': 'dict(str, ask_smapi_model.v1.skill.manifest.region.Region)'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.alexa_for_business_interface module

class ask_smapi_model.v1.skill.manifest.alexa_for_business_interface.AlexaForBusinessInterface(namespace=None, version=None, requests=None)

Bases: object

Parameters:

• namespace ((optional) str) – Name of the interface.
• version ((optional) ask_smapi_model.v1.skill.manifest.version.Version) –
• requests ((optional) list[ask_smapi_model.v1.skill.manifest.request.Request]) – Contains a list of requests/messages that skill can handle.

attribute_map = {'namespace': 'namespace', 'requests': 'requests', 'version': 'version'}

deserialized_types = {'namespace': 'str', 'requests': 'list[ask_smapi_model.v1.skill.manifest.request.Request]', 'version': 'ask_smapi_model.v1.skill.manifest.version.Version'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.alexa_presentation_apl_interface module

class ask_smapi_model.v1.skill.manifest.alexa_presentation_apl_interface.AlexaPresentationAplInterface(supported_viewports=None)

Bases: ask_smapi_model.v1.skill.manifest.interface.Interface

Used to declare that the skill uses the Alexa.Presentation.APL interface.

Parameters:supported_viewports ((optional) list[ask_smapi_model.v1.skill.manifest.viewport_specification.ViewportSpecification]) – List of supported viewports.

attribute_map = {'object_type': 'type', 'supported_viewports': 'supportedViewports'}

deserialized_types = {'object_type': 'str', 'supported_viewports': 'list[ask_smapi_model.v1.skill.manifest.viewport_specification.ViewportSpecification]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.audio_interface module

class ask_smapi_model.v1.skill.manifest.audio_interface.AudioInterface

Bases: ask_smapi_model.v1.skill.manifest.interface.Interface

attribute_map = {'object_type': 'type'}

deserialized_types = {'object_type': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.connections module

class ask_smapi_model.v1.skill.manifest.connections.Connections(name=None, payload=None)

Bases: object

Skill connection object.

Parameters:

• name ((optional) str) – Name of the connection.
• payload ((optional) ask_smapi_model.v1.skill.manifest.connections_payload.ConnectionsPayload) –

attribute_map = {'name': 'name', 'payload': 'payload'}

deserialized_types = {'name': 'str', 'payload': 'ask_smapi_model.v1.skill.manifest.connections_payload.ConnectionsPayload'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.connections_payload module

class ask_smapi_model.v1.skill.manifest.connections_payload.ConnectionsPayload(object_type=None, version=None)

Bases: object

Payload of the connection.

Parameters:

• object_type ((optional) str) – Type of the payload.
• version ((optional) str) – Version of the payload.

attribute_map = {'object_type': 'type', 'version': 'version'}

deserialized_types = {'object_type': 'str', 'version': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.critical_data_handling module

ask_smapi_model.v1.skill.manifest.custom_apis module

class ask_smapi_model.v1.skill.manifest.custom_apis.CustomApis(regions=None, endpoint=None, interfaces=None, tasks=None, connections=None)

Bases: object

Defines the structure for custom api of the skill.

Parameters:

• regions ((optional) dict(str, ask_smapi_model.v1.skill.manifest.region.Region)) – Contains an array of the supported &lt;region&gt; Objects.
• endpoint ((optional) ask_smapi_model.v1.skill.manifest.skill_manifest_endpoint.SkillManifestEndpoint) –
• interfaces ((optional) list[ask_smapi_model.v1.skill.manifest.interface.Interface]) – Defines the structure for interfaces supported by the custom api of the skill.
• tasks ((optional) list[ask_smapi_model.v1.skill.manifest.skill_manifest_custom_task.SkillManifestCustomTask]) – List of provided tasks.
• connections ((optional) ask_smapi_model.v1.skill.manifest.custom_connections.CustomConnections) –

attribute_map = {'connections': 'connections', 'endpoint': 'endpoint', 'interfaces': 'interfaces', 'regions': 'regions', 'tasks': 'tasks'}

deserialized_types = {'connections': 'ask_smapi_model.v1.skill.manifest.custom_connections.CustomConnections', 'endpoint': 'ask_smapi_model.v1.skill.manifest.skill_manifest_endpoint.SkillManifestEndpoint', 'interfaces': 'list[ask_smapi_model.v1.skill.manifest.interface.Interface]', 'regions': 'dict(str, ask_smapi_model.v1.skill.manifest.region.Region)', 'tasks': 'list[ask_smapi_model.v1.skill.manifest.skill_manifest_custom_task.SkillManifestCustomTask]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.custom_connections module

class ask_smapi_model.v1.skill.manifest.custom_connections.CustomConnections(requires=None, provides=None)

Bases: object

Supported connections.

Parameters:

• requires ((optional) list[ask_smapi_model.v1.skill.manifest.connections.Connections]) – List of required connections.
• provides ((optional) list[ask_smapi_model.v1.skill.manifest.connections.Connections]) – List of provided connections.

attribute_map = {'provides': 'provides', 'requires': 'requires'}

deserialized_types = {'provides': 'list[ask_smapi_model.v1.skill.manifest.connections.Connections]', 'requires': 'list[ask_smapi_model.v1.skill.manifest.connections.Connections]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.custom_interface module

class ask_smapi_model.v1.skill.manifest.custom_interface.CustomInterface

Bases: ask_smapi_model.v1.skill.manifest.interface.Interface

Skills using Custom Interfaces can send custom directives and receive custom events from custom endpoints such as Alexa gadgets.

attribute_map = {'object_type': 'type'}

deserialized_types = {'object_type': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.data_protection_provider module

ask_smapi_model.v1.skill.manifest.display_interface module

class ask_smapi_model.v1.skill.manifest.display_interface.DisplayInterface(minimum_template_version=None, minimum_apml_version=None)

Bases: ask_smapi_model.v1.skill.manifest.interface.Interface

Used to declare that the skill uses the Display interface. When a skill declares that it uses the Display interface the Display interface will be passed in the supportedInterfaces section of devices which meet any of the required minimum version attributes specified in the manifest. If the device does not meet any of the minimum versions specified in the manifest the Display interface will not be present in the supportedInterfaces section. If neither the minimumTemplateVersion nor the minimumApmlVersion attributes are specified in the manifes then the minimumTemplateVersion is defaulted to 1.0 and apmlVersion is omitted.

Parameters:

• minimum_template_version ((optional) ask_smapi_model.v1.skill.manifest.display_interface_template_version.DisplayInterfaceTemplateVersion) –
• minimum_apml_version ((optional) ask_smapi_model.v1.skill.manifest.display_interface_apml_version.DisplayInterfaceApmlVersion) –

attribute_map = {'minimum_apml_version': 'minimumApmlVersion', 'minimum_template_version': 'minimumTemplateVersion', 'object_type': 'type'}

deserialized_types = {'minimum_apml_version': 'ask_smapi_model.v1.skill.manifest.display_interface_apml_version.DisplayInterfaceApmlVersion', 'minimum_template_version': 'ask_smapi_model.v1.skill.manifest.display_interface_template_version.DisplayInterfaceTemplateVersion', 'object_type': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.display_interface_apml_version module

class ask_smapi_model.v1.skill.manifest.display_interface_apml_version.DisplayInterfaceApmlVersion

Bases: enum.Enum

The minimum version of the APML specification supported by the skill. If a device does not support a version greater than or equal to the version specified her then apmlVersion will not be passed inside the Display interface in the ASK request.

Allowed enum values: [_0_2]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.display_interface_template_version module

class ask_smapi_model.v1.skill.manifest.display_interface_template_version.DisplayInterfaceTemplateVersion

Bases: enum.Enum

The minimum version of pre-defined templates supported by the skill. If a device does not support a version greater than or equal to the version specified her then templateVersion will not be passed inside the Display interface in the ASK request.

Allowed enum values: [_1]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.distribution_countries module

class ask_smapi_model.v1.skill.manifest.distribution_countries.DistributionCountries

Bases: enum.Enum

Allowed enum values: [AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, HR, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IQ, IE, IM, IL, IT, CI, JM, JP, JE, JO, KZ, KE, KI, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SK, SI, SB, SO, ZA, GS, ES, LK, SR, SJ, SZ, SE, CH, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW]

AD = 'AD'

AE = 'AE'

AF = 'AF'

AG = 'AG'

AI = 'AI'

AL = 'AL'

AM = 'AM'

AN = 'AN'

AO = 'AO'

AQ = 'AQ'

AR = 'AR'

AS = 'AS'

AT = 'AT'

AU = 'AU'

AW = 'AW'

AX = 'AX'

AZ = 'AZ'

BA = 'BA'

BB = 'BB'

BD = 'BD'

BE = 'BE'

BF = 'BF'

BG = 'BG'

BH = 'BH'

BI = 'BI'

BJ = 'BJ'

BL = 'BL'

BM = 'BM'

BN = 'BN'

BO = 'BO'

BR = 'BR'

BS = 'BS'

BT = 'BT'

BV = 'BV'

BW = 'BW'

BY = 'BY'

BZ = 'BZ'

CA = 'CA'

CC = 'CC'

CD = 'CD'

CF = 'CF'

CG = 'CG'

CH = 'CH'

CI = 'CI'

CK = 'CK'

CL = 'CL'

CM = 'CM'

CN = 'CN'

CO = 'CO'

CR = 'CR'

CV = 'CV'

CX = 'CX'

CY = 'CY'

CZ = 'CZ'

DE = 'DE'

DJ = 'DJ'

DK = 'DK'

DM = 'DM'

DO = 'DO'

DZ = 'DZ'

EC = 'EC'

EE = 'EE'

EG = 'EG'

EH = 'EH'

ER = 'ER'

ES = 'ES'

ET = 'ET'

FI = 'FI'

FJ = 'FJ'

FK = 'FK'

FM = 'FM'

FO = 'FO'

FR = 'FR'

GA = 'GA'

GB = 'GB'

GD = 'GD'

GE = 'GE'

GF = 'GF'

GG = 'GG'

GH = 'GH'

GI = 'GI'

GL = 'GL'

GM = 'GM'

GN = 'GN'

GP = 'GP'

GQ = 'GQ'

GR = 'GR'

GS = 'GS'

GT = 'GT'

GU = 'GU'

GW = 'GW'

GY = 'GY'

HK = 'HK'

HM = 'HM'

HN = 'HN'

HR = 'HR'

HT = 'HT'

HU = 'HU'

ID = 'ID'

IE = 'IE'

IL = 'IL'

IM = 'IM'

IN = 'IN'

IO = 'IO'

IQ = 'IQ'

IS = 'IS'

IT = 'IT'

JE = 'JE'

JM = 'JM'

JO = 'JO'

JP = 'JP'

KE = 'KE'

KG = 'KG'

KH = 'KH'

KI = 'KI'

KM = 'KM'

KN = 'KN'

KR = 'KR'

KW = 'KW'

KY = 'KY'

KZ = 'KZ'

LA = 'LA'

LB = 'LB'

LC = 'LC'

LI = 'LI'

LK = 'LK'

LR = 'LR'

LS = 'LS'

LT = 'LT'

LU = 'LU'

LV = 'LV'

LY = 'LY'

MA = 'MA'

MC = 'MC'

MD = 'MD'

ME = 'ME'

MF = 'MF'

MG = 'MG'

MH = 'MH'

MK = 'MK'

ML = 'ML'

MM = 'MM'

MN = 'MN'

MO = 'MO'

MP = 'MP'

MQ = 'MQ'

MR = 'MR'

MS = 'MS'

MT = 'MT'

MU = 'MU'

MV = 'MV'

MW = 'MW'

MX = 'MX'

MY = 'MY'

MZ = 'MZ'

NA = 'NA'

NC = 'NC'

NE = 'NE'

NF = 'NF'

NG = 'NG'

NI = 'NI'

NL = 'NL'

NO = 'NO'

NP = 'NP'

NR = 'NR'

NU = 'NU'

NZ = 'NZ'

OM = 'OM'

PA = 'PA'

PE = 'PE'

PF = 'PF'

PG = 'PG'

PH = 'PH'

PK = 'PK'

PL = 'PL'

PM = 'PM'

PN = 'PN'

PR = 'PR'

PS = 'PS'

PT = 'PT'

PW = 'PW'

PY = 'PY'

QA = 'QA'

RE = 'RE'

RO = 'RO'

RS = 'RS'

RU = 'RU'

RW = 'RW'

SA = 'SA'

SB = 'SB'

SC = 'SC'

SE = 'SE'

SG = 'SG'

SH = 'SH'

SI = 'SI'

SJ = 'SJ'

SK = 'SK'

SL = 'SL'

SM = 'SM'

SN = 'SN'

SO = 'SO'

SR = 'SR'

ST = 'ST'

SV = 'SV'

SZ = 'SZ'

TC = 'TC'

TD = 'TD'

TF = 'TF'

TG = 'TG'

TH = 'TH'

TJ = 'TJ'

TK = 'TK'

TL = 'TL'

TM = 'TM'

TN = 'TN'

TO = 'TO'

TR = 'TR'

TT = 'TT'

TV = 'TV'

TW = 'TW'

TZ = 'TZ'

UA = 'UA'

UG = 'UG'

UM = 'UM'

US = 'US'

UY = 'UY'

UZ = 'UZ'

VA = 'VA'

VC = 'VC'

VE = 'VE'

VG = 'VG'

VI = 'VI'

VN = 'VN'

VU = 'VU'

WF = 'WF'

WS = 'WS'

YE = 'YE'

YT = 'YT'

ZA = 'ZA'

ZM = 'ZM'

ZW = 'ZW'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.distribution_mode module

class ask_smapi_model.v1.skill.manifest.distribution_mode.DistributionMode

Bases: enum.Enum

What audience the skill should be distributed to. &quot;PUBLIC&quot; - available to all users. Has ASIN and can be enabled. &quot;PRIVATE&quot; - available to entitled users. Has ASIN and can be enabled. &quot;INTERNAL&quot; - has no ASIN and cannot be enabled by users. Internally managed skills.

Allowed enum values: [PRIVATE, PUBLIC, INTERNAL]

INTERNAL = 'INTERNAL'

PRIVATE = 'PRIVATE'

PUBLIC = 'PUBLIC'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.event_name module

class ask_smapi_model.v1.skill.manifest.event_name.EventName(event_name=None)

Bases: object

Parameters:event_name ((optional) ask_smapi_model.v1.skill.manifest.event_name_type.EventNameType) –

attribute_map = {'event_name': 'eventName'}

deserialized_types = {'event_name': 'ask_smapi_model.v1.skill.manifest.event_name_type.EventNameType'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.event_name_type module

class ask_smapi_model.v1.skill.manifest.event_name_type.EventNameType

Bases: enum.Enum

Name of the event to be subscribed to.

Allowed enum values: [SKILL_ENABLED, SKILL_DISABLED, SKILL_PERMISSION_ACCEPTED, SKILL_PERMISSION_CHANGED, SKILL_ACCOUNT_LINKED, ITEMS_CREATED, ITEMS_UPDATED, ITEMS_DELETED, LIST_CREATED, LIST_UPDATED, LIST_DELETED, ALL_LISTS_CHANGED, REMINDER_STARTED, REMINDER_CREATED, REMINDER_UPDATED, REMINDER_DELETED, REMINDER_STATUS_CHANGED, AUDIO_ITEM_PLAYBACK_STARTED, AUDIO_ITEM_PLAYBACK_FINISHED, AUDIO_ITEM_PLAYBACK_STOPPED, AUDIO_ITEM_PLAYBACK_FAILED, SKILL_PROACTIVE_SUBSCRIPTION_CHANGED, IN_SKILL_PRODUCT_SUBSCRIPTION_STARTED, IN_SKILL_PRODUCT_SUBSCRIPTION_RENEWED, IN_SKILL_PRODUCT_SUBSCRIPTION_ENDED, Legacy_ActivityManager_ActivityContextRemovedEvent, Legacy_ActivityManager_ActivityInterrupted, Legacy_ActivityManager_FocusChanged, Legacy_AlertsController_DismissCommand, Legacy_AlertsController_SnoozeCommand, Legacy_AudioPlayer_AudioStutter, Legacy_AudioPlayer_InitialPlaybackProgressReport, Legacy_AudioPlayer_Metadata, Legacy_AudioPlayer_PeriodicPlaybackProgressReport, Legacy_AudioPlayer_PlaybackError, Legacy_AudioPlayer_PlaybackFinished, Legacy_AudioPlayer_PlaybackIdle, Legacy_AudioPlayer_PlaybackInterrupted, Legacy_AudioPlayer_PlaybackNearlyFinished, Legacy_AudioPlayer_PlaybackPaused, Legacy_AudioPlayer_PlaybackResumed, Legacy_AudioPlayer_PlaybackStarted, Legacy_AudioPlayer_PlaybackStutterFinished, Legacy_AudioPlayer_PlaybackStutterStarted, Legacy_AudioPlayerGui_ButtonClickedEvent, Legacy_AudioPlayerGui_LyricsViewedEvent, Legacy_AuxController_DirectionChanged, Legacy_AuxController_EnabledStateChanged, Legacy_AuxController_InputActivityStateChanged, Legacy_AuxController_PluggedStateChanged, Legacy_BluetoothNetwork_CancelPairingMode, Legacy_BluetoothNetwork_DeviceConnectedFailure, Legacy_BluetoothNetwork_DeviceConnectedSuccess, Legacy_BluetoothNetwork_DeviceDisconnectedFailure, Legacy_BluetoothNetwork_DeviceDisconnectedSuccess, Legacy_BluetoothNetwork_DevicePairFailure, Legacy_BluetoothNetwork_DevicePairSuccess, Legacy_BluetoothNetwork_DeviceUnpairFailure, Legacy_BluetoothNetwork_DeviceUnpairSuccess, Legacy_BluetoothNetwork_EnterPairingModeFailure, Legacy_BluetoothNetwork_EnterPairingModeSuccess, Legacy_BluetoothNetwork_MediaControlFailure, Legacy_BluetoothNetwork_MediaControlSuccess, Legacy_BluetoothNetwork_ScanDevicesReport, Legacy_BluetoothNetwork_SetDeviceCategoriesFailed, Legacy_BluetoothNetwork_SetDeviceCategoriesSucceeded, Legacy_ContentManager_ContentPlaybackTerminated, Legacy_DeviceNotification_DeleteNotificationFailed, Legacy_DeviceNotification_DeleteNotificationSucceeded, Legacy_DeviceNotification_NotificationEnteredBackground, Legacy_DeviceNotification_NotificationEnteredForground, Legacy_DeviceNotification_NotificationStarted, Legacy_DeviceNotification_NotificationStopped, Legacy_DeviceNotification_NotificationSync, Legacy_DeviceNotification_SetNotificationFailed, Legacy_DeviceNotification_SetNotificationSucceeded, Legacy_EqualizerController_EqualizerChanged, Legacy_ExternalMediaPlayer_AuthorizationComplete, Legacy_ExternalMediaPlayer_Error, Legacy_ExternalMediaPlayer_Event, Legacy_ExternalMediaPlayer_Login, Legacy_ExternalMediaPlayer_Logout, Legacy_ExternalMediaPlayer_ReportDiscoveredPlayers, Legacy_ExternalMediaPlayer_RequestToken, Legacy_FavoritesController_Error, Legacy_FavoritesController_Response, Legacy_GameEngine_GameInputEvent, Legacy_HomeAutoWifiController_DeviceReconnected, Legacy_HomeAutoWifiController_HttpNotified, Legacy_HomeAutoWifiController_SsdpDiscoveryFinished, Legacy_HomeAutoWifiController_SsdpServiceDiscovered, Legacy_HomeAutoWifiController_SsdpServiceTerminated, Legacy_ListModel_AddItemRequest, Legacy_ListModel_DeleteItemRequest, Legacy_ListModel_GetPageByOrdinalRequest, Legacy_ListModel_GetPageByTokenRequest, Legacy_ListModel_ListStateUpdateRequest, Legacy_ListModel_UpdateItemRequest, Legacy_ListRenderer_GetListPageByOrdinal, Legacy_ListRenderer_GetListPageByToken, Legacy_ListRenderer_ListItemEvent, Legacy_MediaGrouping_GroupChangeNotificationEvent, Legacy_MediaGrouping_GroupChangeResponseEvent, Legacy_MediaGrouping_GroupSyncEvent, Legacy_MediaPlayer_PlaybackError, Legacy_MediaPlayer_PlaybackFinished, Legacy_MediaPlayer_PlaybackIdle, Legacy_MediaPlayer_PlaybackNearlyFinished, Legacy_MediaPlayer_PlaybackPaused, Legacy_MediaPlayer_PlaybackResumed, Legacy_MediaPlayer_PlaybackStarted, Legacy_MediaPlayer_PlaybackStopped, Legacy_MediaPlayer_SequenceItemsRequested, Legacy_MediaPlayer_SequenceModified, Legacy_MeetingClientController_Event, Legacy_Microphone_AudioRecording, Legacy_PhoneCallController_Event, Legacy_PlaybackController_ButtonCommand, Legacy_PlaybackController_LyricsViewedEvent, Legacy_PlaybackController_NextCommand, Legacy_PlaybackController_PauseCommand, Legacy_PlaybackController_PlayCommand, Legacy_PlaybackController_PreviousCommand, Legacy_PlaybackController_ToggleCommand, Legacy_PlaylistController_ErrorResponse, Legacy_PlaylistController_Response, Legacy_Presentation_PresentationDismissedEvent, Legacy_Presentation_PresentationUserEvent, Legacy_SconeRemoteControl_Next, Legacy_SconeRemoteControl_PlayPause, Legacy_SconeRemoteControl_Previous, Legacy_SconeRemoteControl_VolumeDown, Legacy_SconeRemoteControl_VolumeUp, Legacy_SipClient_Event, Legacy_SoftwareUpdate_CheckSoftwareUpdateReport, Legacy_SoftwareUpdate_InitiateSoftwareUpdateReport, Legacy_Speaker_MuteChanged, Legacy_Speaker_VolumeChanged, Legacy_SpeechRecognizer_WakeWordChanged, Legacy_SpeechSynthesizer_SpeechFinished, Legacy_SpeechSynthesizer_SpeechInterrupted, Legacy_SpeechSynthesizer_SpeechStarted, Legacy_SpeechSynthesizer_SpeechSynthesizerError, Legacy_Spotify_Event, Legacy_System_UserInactivity, Legacy_UDPController_BroadcastResponse, LocalApplication_Alexa_Translation_LiveTranslation_Event, LocalApplication_AlexaNotifications_Event, LocalApplication_AlexaPlatformTestSpeechlet_Event, LocalApplication_AlexaVision_Event, LocalApplication_AlexaVoiceLayer_Event, LocalApplication_AvaPhysicalShopping_Event, LocalApplication_Calendar_Event, LocalApplication_Closet_Event, LocalApplication_Communications_Event, LocalApplication_DeviceMessaging_Event, LocalApplication_DigitalDash_Event, LocalApplication_FireflyShopping_Event, LocalApplication_Gallery_Event, LocalApplication_HHOPhotos_Event, LocalApplication_HomeAutomationMedia_Event, LocalApplication_KnightContacts_Event, LocalApplication_KnightHome_Event, LocalApplication_KnightHomeThingsToTry_Event, LocalApplication_LocalMediaPlayer_Event, LocalApplication_LocalVoiceUI_Event, LocalApplication_MShop_Event, LocalApplication_MShopPurchasing_Event, LocalApplication_NotificationsApp_Event, LocalApplication_Photos_Event, LocalApplication_Sentry_Event, LocalApplication_SipClient_Event, LocalApplication_SipUserAgent_Event, LocalApplication_todoRenderer_Event, LocalApplication_VideoExperienceService_Event, LocalApplication_WebVideoPlayer_Event, Alexa_Camera_PhotoCaptureController_CancelCaptureFailed, Alexa_Camera_PhotoCaptureController_CancelCaptureFinished, Alexa_Camera_PhotoCaptureController_CaptureFailed, Alexa_Camera_PhotoCaptureController_CaptureFinished, Alexa_Camera_VideoCaptureController_CancelCaptureFailed, Alexa_Camera_VideoCaptureController_CancelCaptureFinished, Alexa_Camera_VideoCaptureController_CaptureFailed, Alexa_Camera_VideoCaptureController_CaptureFinished, Alexa_Camera_VideoCaptureController_CaptureStarted, Alexa_FileManager_UploadController_CancelUploadFailed, Alexa_FileManager_UploadController_CancelUploadFinished, Alexa_FileManager_UploadController_UploadFailed, Alexa_FileManager_UploadController_UploadFinished, Alexa_FileManager_UploadController_UploadStarted, Alexa_Presentation_APL_UserEvent, Alexa_Presentation_HTML_Event, Alexa_Presentation_HTML_LifecycleStateChanged, Alexa_Presentation_PresentationDismissed, AudioPlayer_PlaybackFailed, AudioPlayer_PlaybackFinished, AudioPlayer_PlaybackNearlyFinished, AudioPlayer_PlaybackStarted, AudioPlayer_PlaybackStopped, CardRenderer_DisplayContentFinished, CardRenderer_DisplayContentStarted, CardRenderer_ReadContentFinished, CardRenderer_ReadContentStarted, CustomInterfaceController_EventsReceived, CustomInterfaceController_Expired, DeviceSetup_SetupCompleted, Display_ElementSelected, Display_UserEvent, FitnessSessionController_FitnessSessionEnded, FitnessSessionController_FitnessSessionError, FitnessSessionController_FitnessSessionPaused, FitnessSessionController_FitnessSessionResumed, FitnessSessionController_FitnessSessionStarted, GameEngine_InputHandlerEvent, Messaging_MessageReceived, MessagingController_UpdateConversationsStatus, MessagingController_UpdateMessagesStatusRequest, MessagingController_UpdateSendMessageStatusRequest, MessagingController_UploadConversations, PlaybackController_NextCommandIssued, PlaybackController_PauseCommandIssued, PlaybackController_PlayCommandIssued, PlaybackController_PreviousCommandIssued, EffectsController_RequestEffectChangeRequest, EffectsController_RequestGuiChangeRequest, EffectsController_StateReceiptChangeRequest, Alexa_Video_Xray_ShowDetailsSuccessful, Alexa_Video_Xray_ShowDetailsFailed]

ALL_LISTS_CHANGED = 'ALL_LISTS_CHANGED'

AUDIO_ITEM_PLAYBACK_FAILED = 'AUDIO_ITEM_PLAYBACK_FAILED'

AUDIO_ITEM_PLAYBACK_FINISHED = 'AUDIO_ITEM_PLAYBACK_FINISHED'

AUDIO_ITEM_PLAYBACK_STARTED = 'AUDIO_ITEM_PLAYBACK_STARTED'

AUDIO_ITEM_PLAYBACK_STOPPED = 'AUDIO_ITEM_PLAYBACK_STOPPED'

Alexa_Camera_PhotoCaptureController_CancelCaptureFailed = 'Alexa.Camera.PhotoCaptureController.CancelCaptureFailed'

Alexa_Camera_PhotoCaptureController_CancelCaptureFinished = 'Alexa.Camera.PhotoCaptureController.CancelCaptureFinished'

Alexa_Camera_PhotoCaptureController_CaptureFailed = 'Alexa.Camera.PhotoCaptureController.CaptureFailed'

Alexa_Camera_PhotoCaptureController_CaptureFinished = 'Alexa.Camera.PhotoCaptureController.CaptureFinished'

Alexa_Camera_VideoCaptureController_CancelCaptureFailed = 'Alexa.Camera.VideoCaptureController.CancelCaptureFailed'

Alexa_Camera_VideoCaptureController_CancelCaptureFinished = 'Alexa.Camera.VideoCaptureController.CancelCaptureFinished'

Alexa_Camera_VideoCaptureController_CaptureFailed = 'Alexa.Camera.VideoCaptureController.CaptureFailed'

Alexa_Camera_VideoCaptureController_CaptureFinished = 'Alexa.Camera.VideoCaptureController.CaptureFinished'

Alexa_Camera_VideoCaptureController_CaptureStarted = 'Alexa.Camera.VideoCaptureController.CaptureStarted'

Alexa_FileManager_UploadController_CancelUploadFailed = 'Alexa.FileManager.UploadController.CancelUploadFailed'

Alexa_FileManager_UploadController_CancelUploadFinished = 'Alexa.FileManager.UploadController.CancelUploadFinished'

Alexa_FileManager_UploadController_UploadFailed = 'Alexa.FileManager.UploadController.UploadFailed'

Alexa_FileManager_UploadController_UploadFinished = 'Alexa.FileManager.UploadController.UploadFinished'

Alexa_FileManager_UploadController_UploadStarted = 'Alexa.FileManager.UploadController.UploadStarted'

Alexa_Presentation_APL_UserEvent = 'Alexa.Presentation.APL.UserEvent'

Alexa_Presentation_HTML_Event = 'Alexa.Presentation.HTML.Event'

Alexa_Presentation_HTML_LifecycleStateChanged = 'Alexa.Presentation.HTML.LifecycleStateChanged'

Alexa_Presentation_PresentationDismissed = 'Alexa.Presentation.PresentationDismissed'

Alexa_Video_Xray_ShowDetailsFailed = 'Alexa.Video.Xray.ShowDetailsFailed'

Alexa_Video_Xray_ShowDetailsSuccessful = 'Alexa.Video.Xray.ShowDetailsSuccessful'

AudioPlayer_PlaybackFailed = 'AudioPlayer.PlaybackFailed'

AudioPlayer_PlaybackFinished = 'AudioPlayer.PlaybackFinished'

AudioPlayer_PlaybackNearlyFinished = 'AudioPlayer.PlaybackNearlyFinished'

AudioPlayer_PlaybackStarted = 'AudioPlayer.PlaybackStarted'

AudioPlayer_PlaybackStopped = 'AudioPlayer.PlaybackStopped'

CardRenderer_DisplayContentFinished = 'CardRenderer.DisplayContentFinished'

CardRenderer_DisplayContentStarted = 'CardRenderer.DisplayContentStarted'

CardRenderer_ReadContentFinished = 'CardRenderer.ReadContentFinished'

CardRenderer_ReadContentStarted = 'CardRenderer.ReadContentStarted'

CustomInterfaceController_EventsReceived = 'CustomInterfaceController.EventsReceived'

CustomInterfaceController_Expired = 'CustomInterfaceController.Expired'

DeviceSetup_SetupCompleted = 'DeviceSetup.SetupCompleted'

Display_ElementSelected = 'Display.ElementSelected'

Display_UserEvent = 'Display.UserEvent'

EffectsController_RequestEffectChangeRequest = 'EffectsController.RequestEffectChangeRequest'

EffectsController_RequestGuiChangeRequest = 'EffectsController.RequestGuiChangeRequest'

EffectsController_StateReceiptChangeRequest = 'EffectsController.StateReceiptChangeRequest'

FitnessSessionController_FitnessSessionEnded = 'FitnessSessionController.FitnessSessionEnded'

FitnessSessionController_FitnessSessionError = 'FitnessSessionController.FitnessSessionError'

FitnessSessionController_FitnessSessionPaused = 'FitnessSessionController.FitnessSessionPaused'

FitnessSessionController_FitnessSessionResumed = 'FitnessSessionController.FitnessSessionResumed'

FitnessSessionController_FitnessSessionStarted = 'FitnessSessionController.FitnessSessionStarted'

GameEngine_InputHandlerEvent = 'GameEngine.InputHandlerEvent'

IN_SKILL_PRODUCT_SUBSCRIPTION_ENDED = 'IN_SKILL_PRODUCT_SUBSCRIPTION_ENDED'

IN_SKILL_PRODUCT_SUBSCRIPTION_RENEWED = 'IN_SKILL_PRODUCT_SUBSCRIPTION_RENEWED'

IN_SKILL_PRODUCT_SUBSCRIPTION_STARTED = 'IN_SKILL_PRODUCT_SUBSCRIPTION_STARTED'

ITEMS_CREATED = 'ITEMS_CREATED'

ITEMS_DELETED = 'ITEMS_DELETED'

ITEMS_UPDATED = 'ITEMS_UPDATED'

LIST_CREATED = 'LIST_CREATED'

LIST_DELETED = 'LIST_DELETED'

LIST_UPDATED = 'LIST_UPDATED'

Legacy_ActivityManager_ActivityContextRemovedEvent = 'Legacy.ActivityManager.ActivityContextRemovedEvent'

Legacy_ActivityManager_ActivityInterrupted = 'Legacy.ActivityManager.ActivityInterrupted'

Legacy_ActivityManager_FocusChanged = 'Legacy.ActivityManager.FocusChanged'

Legacy_AlertsController_DismissCommand = 'Legacy.AlertsController.DismissCommand'

Legacy_AlertsController_SnoozeCommand = 'Legacy.AlertsController.SnoozeCommand'

Legacy_AudioPlayerGui_ButtonClickedEvent = 'Legacy.AudioPlayerGui.ButtonClickedEvent'

Legacy_AudioPlayerGui_LyricsViewedEvent = 'Legacy.AudioPlayerGui.LyricsViewedEvent'

Legacy_AudioPlayer_AudioStutter = 'Legacy.AudioPlayer.AudioStutter'

Legacy_AudioPlayer_InitialPlaybackProgressReport = 'Legacy.AudioPlayer.InitialPlaybackProgressReport'

Legacy_AudioPlayer_Metadata = 'Legacy.AudioPlayer.Metadata'

Legacy_AudioPlayer_PeriodicPlaybackProgressReport = 'Legacy.AudioPlayer.PeriodicPlaybackProgressReport'

Legacy_AudioPlayer_PlaybackError = 'Legacy.AudioPlayer.PlaybackError'

Legacy_AudioPlayer_PlaybackFinished = 'Legacy.AudioPlayer.PlaybackFinished'

Legacy_AudioPlayer_PlaybackIdle = 'Legacy.AudioPlayer.PlaybackIdle'

Legacy_AudioPlayer_PlaybackInterrupted = 'Legacy.AudioPlayer.PlaybackInterrupted'

Legacy_AudioPlayer_PlaybackNearlyFinished = 'Legacy.AudioPlayer.PlaybackNearlyFinished'

Legacy_AudioPlayer_PlaybackPaused = 'Legacy.AudioPlayer.PlaybackPaused'

Legacy_AudioPlayer_PlaybackResumed = 'Legacy.AudioPlayer.PlaybackResumed'

Legacy_AudioPlayer_PlaybackStarted = 'Legacy.AudioPlayer.PlaybackStarted'

Legacy_AudioPlayer_PlaybackStutterFinished = 'Legacy.AudioPlayer.PlaybackStutterFinished'

Legacy_AudioPlayer_PlaybackStutterStarted = 'Legacy.AudioPlayer.PlaybackStutterStarted'

Legacy_AuxController_DirectionChanged = 'Legacy.AuxController.DirectionChanged'

Legacy_AuxController_EnabledStateChanged = 'Legacy.AuxController.EnabledStateChanged'

Legacy_AuxController_InputActivityStateChanged = 'Legacy.AuxController.InputActivityStateChanged'

Legacy_AuxController_PluggedStateChanged = 'Legacy.AuxController.PluggedStateChanged'

Legacy_BluetoothNetwork_CancelPairingMode = 'Legacy.BluetoothNetwork.CancelPairingMode'

Legacy_BluetoothNetwork_DeviceConnectedFailure = 'Legacy.BluetoothNetwork.DeviceConnectedFailure'

Legacy_BluetoothNetwork_DeviceConnectedSuccess = 'Legacy.BluetoothNetwork.DeviceConnectedSuccess'

Legacy_BluetoothNetwork_DeviceDisconnectedFailure = 'Legacy.BluetoothNetwork.DeviceDisconnectedFailure'

Legacy_BluetoothNetwork_DeviceDisconnectedSuccess = 'Legacy.BluetoothNetwork.DeviceDisconnectedSuccess'

Legacy_BluetoothNetwork_DevicePairFailure = 'Legacy.BluetoothNetwork.DevicePairFailure'

Legacy_BluetoothNetwork_DevicePairSuccess = 'Legacy.BluetoothNetwork.DevicePairSuccess'

Legacy_BluetoothNetwork_DeviceUnpairFailure = 'Legacy.BluetoothNetwork.DeviceUnpairFailure'

Legacy_BluetoothNetwork_DeviceUnpairSuccess = 'Legacy.BluetoothNetwork.DeviceUnpairSuccess'

Legacy_BluetoothNetwork_EnterPairingModeFailure = 'Legacy.BluetoothNetwork.EnterPairingModeFailure'

Legacy_BluetoothNetwork_EnterPairingModeSuccess = 'Legacy.BluetoothNetwork.EnterPairingModeSuccess'

Legacy_BluetoothNetwork_MediaControlFailure = 'Legacy.BluetoothNetwork.MediaControlFailure'

Legacy_BluetoothNetwork_MediaControlSuccess = 'Legacy.BluetoothNetwork.MediaControlSuccess'

Legacy_BluetoothNetwork_ScanDevicesReport = 'Legacy.BluetoothNetwork.ScanDevicesReport'

Legacy_BluetoothNetwork_SetDeviceCategoriesFailed = 'Legacy.BluetoothNetwork.SetDeviceCategoriesFailed'

Legacy_BluetoothNetwork_SetDeviceCategoriesSucceeded = 'Legacy.BluetoothNetwork.SetDeviceCategoriesSucceeded'

Legacy_ContentManager_ContentPlaybackTerminated = 'Legacy.ContentManager.ContentPlaybackTerminated'

Legacy_DeviceNotification_DeleteNotificationFailed = 'Legacy.DeviceNotification.DeleteNotificationFailed'

Legacy_DeviceNotification_DeleteNotificationSucceeded = 'Legacy.DeviceNotification.DeleteNotificationSucceeded'

Legacy_DeviceNotification_NotificationEnteredBackground = 'Legacy.DeviceNotification.NotificationEnteredBackground'

Legacy_DeviceNotification_NotificationEnteredForground = 'Legacy.DeviceNotification.NotificationEnteredForground'

Legacy_DeviceNotification_NotificationStarted = 'Legacy.DeviceNotification.NotificationStarted'

Legacy_DeviceNotification_NotificationStopped = 'Legacy.DeviceNotification.NotificationStopped'

Legacy_DeviceNotification_NotificationSync = 'Legacy.DeviceNotification.NotificationSync'

Legacy_DeviceNotification_SetNotificationFailed = 'Legacy.DeviceNotification.SetNotificationFailed'

Legacy_DeviceNotification_SetNotificationSucceeded = 'Legacy.DeviceNotification.SetNotificationSucceeded'

Legacy_EqualizerController_EqualizerChanged = 'Legacy.EqualizerController.EqualizerChanged'

Legacy_ExternalMediaPlayer_AuthorizationComplete = 'Legacy.ExternalMediaPlayer.AuthorizationComplete'

Legacy_ExternalMediaPlayer_Error = 'Legacy.ExternalMediaPlayer.Error'

Legacy_ExternalMediaPlayer_Event = 'Legacy.ExternalMediaPlayer.Event'

Legacy_ExternalMediaPlayer_Login = 'Legacy.ExternalMediaPlayer.Login'

Legacy_ExternalMediaPlayer_Logout = 'Legacy.ExternalMediaPlayer.Logout'

Legacy_ExternalMediaPlayer_ReportDiscoveredPlayers = 'Legacy.ExternalMediaPlayer.ReportDiscoveredPlayers'

Legacy_ExternalMediaPlayer_RequestToken = 'Legacy.ExternalMediaPlayer.RequestToken'

Legacy_FavoritesController_Error = 'Legacy.FavoritesController.Error'

Legacy_FavoritesController_Response = 'Legacy.FavoritesController.Response'

Legacy_GameEngine_GameInputEvent = 'Legacy.GameEngine.GameInputEvent'

Legacy_HomeAutoWifiController_DeviceReconnected = 'Legacy.HomeAutoWifiController.DeviceReconnected'

Legacy_HomeAutoWifiController_HttpNotified = 'Legacy.HomeAutoWifiController.HttpNotified'

Legacy_HomeAutoWifiController_SsdpDiscoveryFinished = 'Legacy.HomeAutoWifiController.SsdpDiscoveryFinished'

Legacy_HomeAutoWifiController_SsdpServiceDiscovered = 'Legacy.HomeAutoWifiController.SsdpServiceDiscovered'

Legacy_HomeAutoWifiController_SsdpServiceTerminated = 'Legacy.HomeAutoWifiController.SsdpServiceTerminated'

Legacy_ListModel_AddItemRequest = 'Legacy.ListModel.AddItemRequest'

Legacy_ListModel_DeleteItemRequest = 'Legacy.ListModel.DeleteItemRequest'

Legacy_ListModel_GetPageByOrdinalRequest = 'Legacy.ListModel.GetPageByOrdinalRequest'

Legacy_ListModel_GetPageByTokenRequest = 'Legacy.ListModel.GetPageByTokenRequest'

Legacy_ListModel_ListStateUpdateRequest = 'Legacy.ListModel.ListStateUpdateRequest'

Legacy_ListModel_UpdateItemRequest = 'Legacy.ListModel.UpdateItemRequest'

Legacy_ListRenderer_GetListPageByOrdinal = 'Legacy.ListRenderer.GetListPageByOrdinal'

Legacy_ListRenderer_GetListPageByToken = 'Legacy.ListRenderer.GetListPageByToken'

Legacy_ListRenderer_ListItemEvent = 'Legacy.ListRenderer.ListItemEvent'

Legacy_MediaGrouping_GroupChangeNotificationEvent = 'Legacy.MediaGrouping.GroupChangeNotificationEvent'

Legacy_MediaGrouping_GroupChangeResponseEvent = 'Legacy.MediaGrouping.GroupChangeResponseEvent'

Legacy_MediaGrouping_GroupSyncEvent = 'Legacy.MediaGrouping.GroupSyncEvent'

Legacy_MediaPlayer_PlaybackError = 'Legacy.MediaPlayer.PlaybackError'

Legacy_MediaPlayer_PlaybackFinished = 'Legacy.MediaPlayer.PlaybackFinished'

Legacy_MediaPlayer_PlaybackIdle = 'Legacy.MediaPlayer.PlaybackIdle'

Legacy_MediaPlayer_PlaybackNearlyFinished = 'Legacy.MediaPlayer.PlaybackNearlyFinished'

Legacy_MediaPlayer_PlaybackPaused = 'Legacy.MediaPlayer.PlaybackPaused'

Legacy_MediaPlayer_PlaybackResumed = 'Legacy.MediaPlayer.PlaybackResumed'

Legacy_MediaPlayer_PlaybackStarted = 'Legacy.MediaPlayer.PlaybackStarted'

Legacy_MediaPlayer_PlaybackStopped = 'Legacy.MediaPlayer.PlaybackStopped'

Legacy_MediaPlayer_SequenceItemsRequested = 'Legacy.MediaPlayer.SequenceItemsRequested'

Legacy_MediaPlayer_SequenceModified = 'Legacy.MediaPlayer.SequenceModified'

Legacy_MeetingClientController_Event = 'Legacy.MeetingClientController.Event'

Legacy_Microphone_AudioRecording = 'Legacy.Microphone.AudioRecording'

Legacy_PhoneCallController_Event = 'Legacy.PhoneCallController.Event'

Legacy_PlaybackController_ButtonCommand = 'Legacy.PlaybackController.ButtonCommand'

Legacy_PlaybackController_LyricsViewedEvent = 'Legacy.PlaybackController.LyricsViewedEvent'

Legacy_PlaybackController_NextCommand = 'Legacy.PlaybackController.NextCommand'

Legacy_PlaybackController_PauseCommand = 'Legacy.PlaybackController.PauseCommand'

Legacy_PlaybackController_PlayCommand = 'Legacy.PlaybackController.PlayCommand'

Legacy_PlaybackController_PreviousCommand = 'Legacy.PlaybackController.PreviousCommand'

Legacy_PlaybackController_ToggleCommand = 'Legacy.PlaybackController.ToggleCommand'

Legacy_PlaylistController_ErrorResponse = 'Legacy.PlaylistController.ErrorResponse'

Legacy_PlaylistController_Response = 'Legacy.PlaylistController.Response'

Legacy_Presentation_PresentationDismissedEvent = 'Legacy.Presentation.PresentationDismissedEvent'

Legacy_Presentation_PresentationUserEvent = 'Legacy.Presentation.PresentationUserEvent'

Legacy_SconeRemoteControl_Next = 'Legacy.SconeRemoteControl.Next'

Legacy_SconeRemoteControl_PlayPause = 'Legacy.SconeRemoteControl.PlayPause'

Legacy_SconeRemoteControl_Previous = 'Legacy.SconeRemoteControl.Previous'

Legacy_SconeRemoteControl_VolumeDown = 'Legacy.SconeRemoteControl.VolumeDown'

Legacy_SconeRemoteControl_VolumeUp = 'Legacy.SconeRemoteControl.VolumeUp'

Legacy_SipClient_Event = 'Legacy.SipClient.Event'

Legacy_SoftwareUpdate_CheckSoftwareUpdateReport = 'Legacy.SoftwareUpdate.CheckSoftwareUpdateReport'

Legacy_SoftwareUpdate_InitiateSoftwareUpdateReport = 'Legacy.SoftwareUpdate.InitiateSoftwareUpdateReport'

Legacy_Speaker_MuteChanged = 'Legacy.Speaker.MuteChanged'

Legacy_Speaker_VolumeChanged = 'Legacy.Speaker.VolumeChanged'

Legacy_SpeechRecognizer_WakeWordChanged = 'Legacy.SpeechRecognizer.WakeWordChanged'

Legacy_SpeechSynthesizer_SpeechFinished = 'Legacy.SpeechSynthesizer.SpeechFinished'

Legacy_SpeechSynthesizer_SpeechInterrupted = 'Legacy.SpeechSynthesizer.SpeechInterrupted'

Legacy_SpeechSynthesizer_SpeechStarted = 'Legacy.SpeechSynthesizer.SpeechStarted'

Legacy_SpeechSynthesizer_SpeechSynthesizerError = 'Legacy.SpeechSynthesizer.SpeechSynthesizerError'

Legacy_Spotify_Event = 'Legacy.Spotify.Event'

Legacy_System_UserInactivity = 'Legacy.System.UserInactivity'

Legacy_UDPController_BroadcastResponse = 'Legacy.UDPController.BroadcastResponse'

LocalApplication_AlexaNotifications_Event = 'LocalApplication.AlexaNotifications.Event'

LocalApplication_AlexaPlatformTestSpeechlet_Event = 'LocalApplication.AlexaPlatformTestSpeechlet.Event'

LocalApplication_AlexaVision_Event = 'LocalApplication.AlexaVision.Event'

LocalApplication_AlexaVoiceLayer_Event = 'LocalApplication.AlexaVoiceLayer.Event'

LocalApplication_Alexa_Translation_LiveTranslation_Event = 'LocalApplication.Alexa.Translation.LiveTranslation.Event'

LocalApplication_AvaPhysicalShopping_Event = 'LocalApplication.AvaPhysicalShopping.Event'

LocalApplication_Calendar_Event = 'LocalApplication.Calendar.Event'

LocalApplication_Closet_Event = 'LocalApplication.Closet.Event'

LocalApplication_Communications_Event = 'LocalApplication.Communications.Event'

LocalApplication_DeviceMessaging_Event = 'LocalApplication.DeviceMessaging.Event'

LocalApplication_DigitalDash_Event = 'LocalApplication.DigitalDash.Event'

LocalApplication_FireflyShopping_Event = 'LocalApplication.FireflyShopping.Event'

LocalApplication_Gallery_Event = 'LocalApplication.Gallery.Event'

LocalApplication_HHOPhotos_Event = 'LocalApplication.HHOPhotos.Event'

LocalApplication_HomeAutomationMedia_Event = 'LocalApplication.HomeAutomationMedia.Event'

LocalApplication_KnightContacts_Event = 'LocalApplication.KnightContacts.Event'

LocalApplication_KnightHomeThingsToTry_Event = 'LocalApplication.KnightHomeThingsToTry.Event'

LocalApplication_KnightHome_Event = 'LocalApplication.KnightHome.Event'

LocalApplication_LocalMediaPlayer_Event = 'LocalApplication.LocalMediaPlayer.Event'

LocalApplication_LocalVoiceUI_Event = 'LocalApplication.LocalVoiceUI.Event'

LocalApplication_MShopPurchasing_Event = 'LocalApplication.MShopPurchasing.Event'

LocalApplication_MShop_Event = 'LocalApplication.MShop.Event'

LocalApplication_NotificationsApp_Event = 'LocalApplication.NotificationsApp.Event'

LocalApplication_Photos_Event = 'LocalApplication.Photos.Event'

LocalApplication_Sentry_Event = 'LocalApplication.Sentry.Event'

LocalApplication_SipClient_Event = 'LocalApplication.SipClient.Event'

LocalApplication_SipUserAgent_Event = 'LocalApplication.SipUserAgent.Event'

LocalApplication_VideoExperienceService_Event = 'LocalApplication.VideoExperienceService.Event'

LocalApplication_WebVideoPlayer_Event = 'LocalApplication.WebVideoPlayer.Event'

LocalApplication_todoRenderer_Event = 'LocalApplication.todoRenderer.Event'

MessagingController_UpdateConversationsStatus = 'MessagingController.UpdateConversationsStatus'

MessagingController_UpdateMessagesStatusRequest = 'MessagingController.UpdateMessagesStatusRequest'

MessagingController_UpdateSendMessageStatusRequest = 'MessagingController.UpdateSendMessageStatusRequest'

MessagingController_UploadConversations = 'MessagingController.UploadConversations'

Messaging_MessageReceived = 'Messaging.MessageReceived'

PlaybackController_NextCommandIssued = 'PlaybackController.NextCommandIssued'

PlaybackController_PauseCommandIssued = 'PlaybackController.PauseCommandIssued'

PlaybackController_PlayCommandIssued = 'PlaybackController.PlayCommandIssued'

PlaybackController_PreviousCommandIssued = 'PlaybackController.PreviousCommandIssued'

REMINDER_CREATED = 'REMINDER_CREATED'

REMINDER_DELETED = 'REMINDER_DELETED'

REMINDER_STARTED = 'REMINDER_STARTED'

REMINDER_STATUS_CHANGED = 'REMINDER_STATUS_CHANGED'

REMINDER_UPDATED = 'REMINDER_UPDATED'

SKILL_ACCOUNT_LINKED = 'SKILL_ACCOUNT_LINKED'

SKILL_DISABLED = 'SKILL_DISABLED'

SKILL_ENABLED = 'SKILL_ENABLED'

SKILL_PERMISSION_ACCEPTED = 'SKILL_PERMISSION_ACCEPTED'

SKILL_PERMISSION_CHANGED = 'SKILL_PERMISSION_CHANGED'

SKILL_PROACTIVE_SUBSCRIPTION_CHANGED = 'SKILL_PROACTIVE_SUBSCRIPTION_CHANGED'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.event_publications module

class ask_smapi_model.v1.skill.manifest.event_publications.EventPublications(event_name=None)

Bases: object

Parameters:event_name ((optional) str) – Name of the event to publish.

attribute_map = {'event_name': 'eventName'}

deserialized_types = {'event_name': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.flash_briefing_apis module

class ask_smapi_model.v1.skill.manifest.flash_briefing_apis.FlashBriefingApis(locales=None)

Bases: object

Defines the structure for flash briefing api of the skill.

Parameters:locales ((optional) dict(str, ask_smapi_model.v1.skill.manifest.localized_flash_briefing_info.LocalizedFlashBriefingInfo)) – Defines the structure for locale specific flash briefing api information.

attribute_map = {'locales': 'locales'}

deserialized_types = {'locales': 'dict(str, ask_smapi_model.v1.skill.manifest.localized_flash_briefing_info.LocalizedFlashBriefingInfo)'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.flash_briefing_content_type module

class ask_smapi_model.v1.skill.manifest.flash_briefing_content_type.FlashBriefingContentType

Bases: enum.Enum

format of the feed content.

Allowed enum values: [TEXT, AUDIO, AUDIO_AND_VIDEO]

AUDIO = 'AUDIO'

AUDIO_AND_VIDEO = 'AUDIO_AND_VIDEO'

TEXT = 'TEXT'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.flash_briefing_genre module

class ask_smapi_model.v1.skill.manifest.flash_briefing_genre.FlashBriefingGenre

Bases: enum.Enum

Type or subject of the content in the feed.

Allowed enum values: [HEADLINE_NEWS, BUSINESS, POLITICS, ENTERTAINMENT, TECHNOLOGY, HUMOR, LIFESTYLE, SPORTS, SCIENCE, HEALTH_AND_FITNESS, ARTS_AND_CULTURE, PRODUCTIVITY_AND_UTILITIES, OTHER]

ARTS_AND_CULTURE = 'ARTS_AND_CULTURE'

BUSINESS = 'BUSINESS'

ENTERTAINMENT = 'ENTERTAINMENT'

HEADLINE_NEWS = 'HEADLINE_NEWS'

HEALTH_AND_FITNESS = 'HEALTH_AND_FITNESS'

HUMOR = 'HUMOR'

LIFESTYLE = 'LIFESTYLE'

OTHER = 'OTHER'

POLITICS = 'POLITICS'

PRODUCTIVITY_AND_UTILITIES = 'PRODUCTIVITY_AND_UTILITIES'

SCIENCE = 'SCIENCE'

SPORTS = 'SPORTS'

TECHNOLOGY = 'TECHNOLOGY'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.flash_briefing_update_frequency module

class ask_smapi_model.v1.skill.manifest.flash_briefing_update_frequency.FlashBriefingUpdateFrequency

Bases: enum.Enum

Tells how often the feed has new content.

Allowed enum values: [HOURLY, DAILY, WEEKLY, UNKNOWN]

DAILY = 'DAILY'

HOURLY = 'HOURLY'

UNKNOWN = 'UNKNOWN'

WEEKLY = 'WEEKLY'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.gadget_controller_interface module

class ask_smapi_model.v1.skill.manifest.gadget_controller_interface.GadgetControllerInterface

Bases: ask_smapi_model.v1.skill.manifest.interface.Interface

Skills using Gadget Controller can send directives to Echo Buttons. This is a legacy interface specific to Echo Buttons.

attribute_map = {'object_type': 'type'}

deserialized_types = {'object_type': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.gadget_support module

class ask_smapi_model.v1.skill.manifest.gadget_support.GadgetSupport

Bases: enum.Enum

Specifies if gadget support is required/optional for this skill to work.

Allowed enum values: [REQUIRED, OPTIONAL]

OPTIONAL = 'OPTIONAL'

REQUIRED = 'REQUIRED'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.game_engine_interface module

class ask_smapi_model.v1.skill.manifest.game_engine_interface.GameEngineInterface

Bases: ask_smapi_model.v1.skill.manifest.interface.Interface

attribute_map = {'object_type': 'type'}

deserialized_types = {'object_type': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.health_alias module

class ask_smapi_model.v1.skill.manifest.health_alias.HealthAlias(name=None)

Bases: object

Parameters:name ((optional) str) – Name of alias to use when invoking a health skill.

attribute_map = {'name': 'name'}

deserialized_types = {'name': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.health_apis module

class ask_smapi_model.v1.skill.manifest.health_apis.HealthApis(regions=None, endpoint=None, protocol_version=None, interfaces=None)

Bases: object

Defines the structure of health api in the skill manifest.

Parameters:

• regions ((optional) dict(str, ask_smapi_model.v1.skill.manifest.region.Region)) – Contains an array of the supported &lt;region&gt; Objects.
• endpoint ((optional) ask_smapi_model.v1.skill.manifest.skill_manifest_endpoint.SkillManifestEndpoint) –
• protocol_version ((optional) ask_smapi_model.v1.skill.manifest.health_protocol_version.HealthProtocolVersion) –
• interfaces ((optional) ask_smapi_model.v1.skill.manifest.health_interface.HealthInterface) –

attribute_map = {'endpoint': 'endpoint', 'interfaces': 'interfaces', 'protocol_version': 'protocolVersion', 'regions': 'regions'}

deserialized_types = {'endpoint': 'ask_smapi_model.v1.skill.manifest.skill_manifest_endpoint.SkillManifestEndpoint', 'interfaces': 'ask_smapi_model.v1.skill.manifest.health_interface.HealthInterface', 'protocol_version': 'ask_smapi_model.v1.skill.manifest.health_protocol_version.HealthProtocolVersion', 'regions': 'dict(str, ask_smapi_model.v1.skill.manifest.region.Region)'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.health_interface module

class ask_smapi_model.v1.skill.manifest.health_interface.HealthInterface(namespace=None, version=None, requests=None, locales=None)

Bases: object

Parameters:

• namespace ((optional) str) – Name of the interface.
• version ((optional) ask_smapi_model.v1.skill.manifest.version.Version) –
• requests ((optional) list[ask_smapi_model.v1.skill.manifest.health_request.HealthRequest]) – Defines the details of requests that a health skill is capable of handling.
• locales ((optional) dict(str, ask_smapi_model.v1.skill.manifest.localized_health_info.LocalizedHealthInfo)) – Defines the list for health skill locale specific publishing information in the skill manifest.

attribute_map = {'locales': 'locales', 'namespace': 'namespace', 'requests': 'requests', 'version': 'version'}

deserialized_types = {'locales': 'dict(str, ask_smapi_model.v1.skill.manifest.localized_health_info.LocalizedHealthInfo)', 'namespace': 'str', 'requests': 'list[ask_smapi_model.v1.skill.manifest.health_request.HealthRequest]', 'version': 'ask_smapi_model.v1.skill.manifest.version.Version'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.health_protocol_version module

class ask_smapi_model.v1.skill.manifest.health_protocol_version.HealthProtocolVersion

Bases: enum.Enum

Allowed enum values: [_1, _2]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.health_request module

class ask_smapi_model.v1.skill.manifest.health_request.HealthRequest(name=None)

Bases: object

Parameters:name ((optional) str) – Defines the name of request, each request has their own payload format.

attribute_map = {'name': 'name'}

deserialized_types = {'name': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.house_hold_list module

class ask_smapi_model.v1.skill.manifest.house_hold_list.HouseHoldList

Bases: object

Defines the structure of household list api in the skill manifest.

attribute_map = {}

deserialized_types = {}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.interface module

class ask_smapi_model.v1.skill.manifest.interface.Interface(object_type=None)

Bases: object

Parameters:object_type ((optional) str) –

Note

This is an abstract class. Use the following mapping, to figure out the model class to be instantiated, that sets type variable.

ALEXA_PRESENTATION_APL: ask_smapi_model.v1.skill.manifest.alexa_presentation_apl_interface.AlexaPresentationAplInterface,

CUSTOM_INTERFACE: ask_smapi_model.v1.skill.manifest.custom_interface.CustomInterface,

ALEXA_PRESENTATION_HTML: ask_smapi_model.v1.skill.manifest.alexa_presentation_html_interface.AlexaPresentationHtmlInterface,

AUDIO_PLAYER: ask_smapi_model.v1.skill.manifest.audio_interface.AudioInterface,

GAME_ENGINE: ask_smapi_model.v1.skill.manifest.game_engine_interface.GameEngineInterface,

RENDER_TEMPLATE: ask_smapi_model.v1.skill.manifest.display_interface.DisplayInterface,

GADGET_CONTROLLER: ask_smapi_model.v1.skill.manifest.gadget_controller_interface.GadgetControllerInterface,

VIDEO_APP: ask_smapi_model.v1.skill.manifest.video_app_interface.VideoAppInterface

attribute_map = {'object_type': 'type'}

deserialized_types = {'object_type': 'str'}

discriminator_value_class_map = {'ALEXA_PRESENTATION_APL': 'ask_smapi_model.v1.skill.manifest.alexa_presentation_apl_interface.AlexaPresentationAplInterface', 'ALEXA_PRESENTATION_HTML': 'ask_smapi_model.v1.skill.manifest.alexa_presentation_html_interface.AlexaPresentationHtmlInterface', 'AUDIO_PLAYER': 'ask_smapi_model.v1.skill.manifest.audio_interface.AudioInterface', 'CUSTOM_INTERFACE': 'ask_smapi_model.v1.skill.manifest.custom_interface.CustomInterface', 'GADGET_CONTROLLER': 'ask_smapi_model.v1.skill.manifest.gadget_controller_interface.GadgetControllerInterface', 'GAME_ENGINE': 'ask_smapi_model.v1.skill.manifest.game_engine_interface.GameEngineInterface', 'RENDER_TEMPLATE': 'ask_smapi_model.v1.skill.manifest.display_interface.DisplayInterface', 'VIDEO_APP': 'ask_smapi_model.v1.skill.manifest.video_app_interface.VideoAppInterface'}

classmethod get_real_child_model(data)

Returns the real base class specified by the discriminator

json_discriminator_key = 'type'

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.lambda_endpoint module

class ask_smapi_model.v1.skill.manifest.lambda_endpoint.LambdaEndpoint(uri=None)

Bases: object

Contains the uri field. This sets the global default endpoint.

Parameters:uri ((optional) str) – Amazon Resource Name (ARN) of the skill's Lambda function or HTTPS URL.

attribute_map = {'uri': 'uri'}

deserialized_types = {'uri': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.lambda_region module

class ask_smapi_model.v1.skill.manifest.lambda_region.LambdaRegion(endpoint=None)

Bases: object

Defines the structure of a regional information.

Parameters:endpoint ((optional) ask_smapi_model.v1.skill.manifest.lambda_endpoint.LambdaEndpoint) –

attribute_map = {'endpoint': 'endpoint'}

deserialized_types = {'endpoint': 'ask_smapi_model.v1.skill.manifest.lambda_endpoint.LambdaEndpoint'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.localized_flash_briefing_info module

class ask_smapi_model.v1.skill.manifest.localized_flash_briefing_info.LocalizedFlashBriefingInfo(feeds=None, custom_error_message=None)

Bases: object

Defines the localized flash briefing api information.

Parameters:

• feeds ((optional) list[ask_smapi_model.v1.skill.manifest.localized_flash_briefing_info_items.LocalizedFlashBriefingInfoItems]) – Defines the structure for a feed information in the skill manifest.
• custom_error_message ((optional) str) – Alexa says this to the customer if the skill fails to render the content.

attribute_map = {'custom_error_message': 'customErrorMessage', 'feeds': 'feeds'}

deserialized_types = {'custom_error_message': 'str', 'feeds': 'list[ask_smapi_model.v1.skill.manifest.localized_flash_briefing_info_items.LocalizedFlashBriefingInfoItems]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.localized_flash_briefing_info_items module

class ask_smapi_model.v1.skill.manifest.localized_flash_briefing_info_items.LocalizedFlashBriefingInfoItems(logical_name=None, name=None, url=None, image_uri=None, content_type=None, genre=None, update_frequency=None, vui_preamble=None, is_default=None)

Bases: object

Parameters:

• logical_name ((optional) str) – Logical name of the feed. This is used to signify relation among feeds across different locales. Example If you have &quot;weather&quot; feed in multiple locale then consider naming it &quot;weather_update&quot; and we will make sure to play the right feed if customer changes the language on device.
• name ((optional) str) – Name that identifies this feed.
• url ((optional) str) – Url for the feed
• image_uri ((optional) str) – Uri for the feed image
• content_type ((optional) ask_smapi_model.v1.skill.manifest.flash_briefing_content_type.FlashBriefingContentType) –
• genre ((optional) ask_smapi_model.v1.skill.manifest.flash_briefing_genre.FlashBriefingGenre) –
• update_frequency ((optional) ask_smapi_model.v1.skill.manifest.flash_briefing_update_frequency.FlashBriefingUpdateFrequency) –
• vui_preamble ((optional) str) – A short introduction for the feed that Alexa reads to the customer before the feed contents. Should start with &quot;In&quot; or &quot;From&quot;.
• is_default ((optional) bool) – True if this should be the default feed to be enabled when customer enables the skill false otherwise.

attribute_map = {'content_type': 'contentType', 'genre': 'genre', 'image_uri': 'imageUri', 'is_default': 'isDefault', 'logical_name': 'logicalName', 'name': 'name', 'update_frequency': 'updateFrequency', 'url': 'url', 'vui_preamble': 'vuiPreamble'}

deserialized_types = {'content_type': 'ask_smapi_model.v1.skill.manifest.flash_briefing_content_type.FlashBriefingContentType', 'genre': 'ask_smapi_model.v1.skill.manifest.flash_briefing_genre.FlashBriefingGenre', 'image_uri': 'str', 'is_default': 'bool', 'logical_name': 'str', 'name': 'str', 'update_frequency': 'ask_smapi_model.v1.skill.manifest.flash_briefing_update_frequency.FlashBriefingUpdateFrequency', 'url': 'str', 'vui_preamble': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.localized_health_info module

class ask_smapi_model.v1.skill.manifest.localized_health_info.LocalizedHealthInfo(prompt_name=None, aliases=None)

Bases: object

Defines the structure for health skill locale specific publishing information in the skill manifest.

Parameters:

• prompt_name ((optional) str) – SSML supported name to use when Alexa renders the health skill name in a prompt to the user.
• aliases ((optional) list[ask_smapi_model.v1.skill.manifest.health_alias.HealthAlias]) – Defines the names to use when a user tries to invoke the health skill.

attribute_map = {'aliases': 'aliases', 'prompt_name': 'promptName'}

deserialized_types = {'aliases': 'list[ask_smapi_model.v1.skill.manifest.health_alias.HealthAlias]', 'prompt_name': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.localized_music_info module

class ask_smapi_model.v1.skill.manifest.localized_music_info.LocalizedMusicInfo(prompt_name=None, aliases=None, features=None, wordmark_logos=None)

Bases: object

Defines the structure of localized music information in the skill manifest.

Parameters:

• prompt_name ((optional) str) – Name to be used when Alexa renders the music skill name.
• aliases ((optional) list[ask_smapi_model.v1.skill.manifest.music_alias.MusicAlias]) –
• features ((optional) list[ask_smapi_model.v1.skill.manifest.music_feature.MusicFeature]) –
• wordmark_logos ((optional) list[ask_smapi_model.v1.skill.manifest.music_wordmark.MusicWordmark]) –

attribute_map = {'aliases': 'aliases', 'features': 'features', 'prompt_name': 'promptName', 'wordmark_logos': 'wordmarkLogos'}

deserialized_types = {'aliases': 'list[ask_smapi_model.v1.skill.manifest.music_alias.MusicAlias]', 'features': 'list[ask_smapi_model.v1.skill.manifest.music_feature.MusicFeature]', 'prompt_name': 'str', 'wordmark_logos': 'list[ask_smapi_model.v1.skill.manifest.music_wordmark.MusicWordmark]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.manifest_gadget_support module

class ask_smapi_model.v1.skill.manifest.manifest_gadget_support.ManifestGadgetSupport(requirement=None, min_gadget_buttons=None, max_gadget_buttons=None, num_players_max=None, num_players_min=None)

Bases: object

Defines the structure for gadget buttons support in the skill manifest.

Parameters:

• requirement ((optional) ask_smapi_model.v1.skill.manifest.gadget_support.GadgetSupport) –
• min_gadget_buttons ((optional) int) – Minimum number of gadget buttons required.
• max_gadget_buttons ((optional) int) – Maximum number of gadget buttons required.
• num_players_max ((optional) int) – Maximum number of players in the game.
• num_players_min ((optional) int) – Minimum number of players in the game.

attribute_map = {'max_gadget_buttons': 'maxGadgetButtons', 'min_gadget_buttons': 'minGadgetButtons', 'num_players_max': 'numPlayersMax', 'num_players_min': 'numPlayersMin', 'requirement': 'requirement'}

deserialized_types = {'max_gadget_buttons': 'int', 'min_gadget_buttons': 'int', 'num_players_max': 'int', 'num_players_min': 'int', 'requirement': 'ask_smapi_model.v1.skill.manifest.gadget_support.GadgetSupport'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.music_alias module

class ask_smapi_model.v1.skill.manifest.music_alias.MusicAlias(name=None)

Bases: object

Parameters:name ((optional) str) – Alias name to be associated with the music skill.

attribute_map = {'name': 'name'}

deserialized_types = {'name': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.music_apis module

class ask_smapi_model.v1.skill.manifest.music_apis.MusicApis(regions=None, endpoint=None, capabilities=None, interfaces=None, locales=None, content_types=None)

Bases: object

Defines the structure of music api in the skill manifest.

Parameters:

• regions ((optional) dict(str, ask_smapi_model.v1.skill.manifest.lambda_region.LambdaRegion)) – Contains an array of the supported &lt;region&gt; Objects.
• endpoint ((optional) ask_smapi_model.v1.skill.manifest.lambda_endpoint.LambdaEndpoint) –
• capabilities ((optional) list[ask_smapi_model.v1.skill.manifest.music_capability.MusicCapability]) – Defines the structure of music capabilities information in the skill manifest.
• interfaces ((optional) ask_smapi_model.v1.skill.manifest.music_interfaces.MusicInterfaces) –
• locales ((optional) dict(str, ask_smapi_model.v1.skill.manifest.localized_music_info.LocalizedMusicInfo)) – Defines the structure of locale specific music information in the skill manifest.
• content_types ((optional) list[ask_smapi_model.v1.skill.manifest.music_content_type.MusicContentType]) – List of the type of content to be provided by the music skill.

attribute_map = {'capabilities': 'capabilities', 'content_types': 'contentTypes', 'endpoint': 'endpoint', 'interfaces': 'interfaces', 'locales': 'locales', 'regions': 'regions'}

deserialized_types = {'capabilities': 'list[ask_smapi_model.v1.skill.manifest.music_capability.MusicCapability]', 'content_types': 'list[ask_smapi_model.v1.skill.manifest.music_content_type.MusicContentType]', 'endpoint': 'ask_smapi_model.v1.skill.manifest.lambda_endpoint.LambdaEndpoint', 'interfaces': 'ask_smapi_model.v1.skill.manifest.music_interfaces.MusicInterfaces', 'locales': 'dict(str, ask_smapi_model.v1.skill.manifest.localized_music_info.LocalizedMusicInfo)', 'regions': 'dict(str, ask_smapi_model.v1.skill.manifest.lambda_region.LambdaRegion)'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.music_capability module

class ask_smapi_model.v1.skill.manifest.music_capability.MusicCapability(namespace=None, name=None, version=None)

Bases: object

Parameters:

• namespace ((optional) str) – Namespace of music skill api.
• name ((optional) str) – Name of music skill api.
• version ((optional) str) – Version of music skill api.

attribute_map = {'name': 'name', 'namespace': 'namespace', 'version': 'version'}

deserialized_types = {'name': 'str', 'namespace': 'str', 'version': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.music_content_name module

class ask_smapi_model.v1.skill.manifest.music_content_name.MusicContentName

Bases: enum.Enum

Name of the content type that's supported for the music skill.

Allowed enum values: [ON_DEMAND, RADIO, PODCAST]

ON_DEMAND = 'ON_DEMAND'

PODCAST = 'PODCAST'

RADIO = 'RADIO'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.music_content_type module

class ask_smapi_model.v1.skill.manifest.music_content_type.MusicContentType(name=None)

Bases: object

Defines the structure for content that can be provided by a music skill.

Parameters:name ((optional) ask_smapi_model.v1.skill.manifest.music_content_name.MusicContentName) –

attribute_map = {'name': 'name'}

deserialized_types = {'name': 'ask_smapi_model.v1.skill.manifest.music_content_name.MusicContentName'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.music_feature module

class ask_smapi_model.v1.skill.manifest.music_feature.MusicFeature(name=None)

Bases: object

Parameters:name ((optional) str) – Feature name to be associated with the music skill.

attribute_map = {'name': 'name'}

deserialized_types = {'name': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.music_interfaces module

class ask_smapi_model.v1.skill.manifest.music_interfaces.MusicInterfaces(namespace=None, version=None, requests=None)

Bases: object

Parameters:

• namespace ((optional) str) – Name of the interface.
• version ((optional) str) – Version of the interface.
• requests ((optional) list[ask_smapi_model.v1.skill.manifest.music_request.MusicRequest]) – Contains a list of requests/messages that skill can handle.

attribute_map = {'namespace': 'namespace', 'requests': 'requests', 'version': 'version'}

deserialized_types = {'namespace': 'str', 'requests': 'list[ask_smapi_model.v1.skill.manifest.music_request.MusicRequest]', 'version': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.music_request module

class ask_smapi_model.v1.skill.manifest.music_request.MusicRequest(name=None)

Bases: object

Parameters:name ((optional) str) – Name of the request.

attribute_map = {'name': 'name'}

deserialized_types = {'name': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.music_wordmark module

class ask_smapi_model.v1.skill.manifest.music_wordmark.MusicWordmark(uri=None)

Bases: object

Parameters:uri ((optional) str) – Wordmark logo to be used by devices with displays.

attribute_map = {'uri': 'uri'}

deserialized_types = {'uri': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.permission_items module

class ask_smapi_model.v1.skill.manifest.permission_items.PermissionItems(name=None)

Bases: object

Parameters:name ((optional) ask_smapi_model.v1.skill.manifest.permission_name.PermissionName) –

attribute_map = {'name': 'name'}

deserialized_types = {'name': 'ask_smapi_model.v1.skill.manifest.permission_name.PermissionName'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.permission_name module

class ask_smapi_model.v1.skill.manifest.permission_name.PermissionName

Bases: enum.Enum

Name of the required permission.

Allowed enum values: [payments_autopay_consent, alexa_async_event_write, avs_distributed_audio, alexa_devices_all_address_full_read, alexa_devices_all_address_country_and_postal_code_read, alexa_devices_all_geolocation_read, alexa_health_profile_write, alexa_household_lists_read, alexa_household_lists_write, alexa_personality_explicit_read, alexa_personality_explicit_write, alexa_profile_name_read, alexa_profile_email_read, alexa_profile_mobile_number_read, alexa_profile_given_name_read, alexa_customer_id_read, alexa_person_id_read, alexa_raw_person_id_read, alexa_utterance_id_read, alexa_devices_all_notifications_write, alexa_devices_all_notifications_urgent_write, alexa_alerts_reminders_skill_readwrite, alexa_alerts_timers_skill_readwrite, alexa_skill_cds_monetization, alexa_music_cast, alexa_skill_products_entitlements, alexa_skill_proactive_enablement, alexa_authenticate_2_mandatory, alexa_authenticate_2_optional, alexa_user_experience_guidance_read, alexa_device_id_read, alexa_device_type_read]

alexa_alerts_reminders_skill_readwrite = 'alexa::alerts:reminders:skill:readwrite'

alexa_alerts_timers_skill_readwrite = 'alexa::alerts:timers:skill:readwrite'

alexa_async_event_write = 'alexa::async_event:write'

alexa_authenticate_2_mandatory = 'alexa::authenticate:2:mandatory'

alexa_authenticate_2_optional = 'alexa::authenticate:2:optional'

alexa_customer_id_read = 'alexa::customer_id:read'

alexa_device_id_read = 'alexa::device_id:read'

alexa_device_type_read = 'alexa::device_type:read'

alexa_devices_all_address_country_and_postal_code_read = 'alexa:devices:all:address:country_and_postal_code:read'

alexa_devices_all_address_full_read = 'alexa::devices:all:address:full:read'

alexa_devices_all_geolocation_read = 'alexa::devices:all:geolocation:read'

alexa_devices_all_notifications_urgent_write = 'alexa::devices:all:notifications:urgent:write'

alexa_devices_all_notifications_write = 'alexa::devices:all:notifications:write'

alexa_health_profile_write = 'alexa::health:profile:write'

alexa_household_lists_read = 'alexa::household:lists:read'

alexa_household_lists_write = 'alexa::household:lists:write'

alexa_music_cast = 'alexa::music:cast'

alexa_person_id_read = 'alexa::person_id:read'

alexa_personality_explicit_read = 'alexa::personality:explicit:read'

alexa_personality_explicit_write = 'alexa::personality:explicit:write'

alexa_profile_email_read = 'alexa::profile:email:read'

alexa_profile_given_name_read = 'alexa::profile:given_name:read'

alexa_profile_mobile_number_read = 'alexa::profile:mobile_number:read'

alexa_profile_name_read = 'alexa::profile:name:read'

alexa_raw_person_id_read = 'alexa::raw_person_id:read'

alexa_skill_cds_monetization = 'alexa::skill:cds:monetization'

alexa_skill_proactive_enablement = 'alexa::skill:proactive_enablement'

alexa_skill_products_entitlements = 'alexa::skill:products:entitlements'

alexa_user_experience_guidance_read = 'alexa::user_experience_guidance:read'

alexa_utterance_id_read = 'alexa::utterance_id:read'

avs_distributed_audio = 'avs::distributed_audio'

payments_autopay_consent = 'payments:autopay_consent'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.region module

class ask_smapi_model.v1.skill.manifest.region.Region(endpoint=None)

Bases: object

Defines the structure for regional information.

Parameters:endpoint ((optional) ask_smapi_model.v1.skill.manifest.skill_manifest_endpoint.SkillManifestEndpoint) –

attribute_map = {'endpoint': 'endpoint'}

deserialized_types = {'endpoint': 'ask_smapi_model.v1.skill.manifest.skill_manifest_endpoint.SkillManifestEndpoint'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.request module

class ask_smapi_model.v1.skill.manifest.request.Request(name=None)

Bases: object

Parameters:name ((optional) ask_smapi_model.v1.skill.manifest.request_name.RequestName) –

attribute_map = {'name': 'name'}

deserialized_types = {'name': 'ask_smapi_model.v1.skill.manifest.request_name.RequestName'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.request_name module

class ask_smapi_model.v1.skill.manifest.request_name.RequestName

Bases: enum.Enum

Name of the request.

Allowed enum values: [Search, Create, Update]

Create = 'Create'

Search = 'Search'

Update = 'Update'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.skill_manifest module

class ask_smapi_model.v1.skill.manifest.skill_manifest.SkillManifest(manifest_version=None, publishing_information=None, privacy_and_compliance=None, events=None, permissions=None, apis=None)

Bases: object

Defines the structure for a skill's metadata.

Parameters:

• manifest_version ((optional) str) – Version of the skill manifest.
• publishing_information ((optional) ask_smapi_model.v1.skill.manifest.skill_manifest_publishing_information.SkillManifestPublishingInformation) –
• privacy_and_compliance ((optional) ask_smapi_model.v1.skill.manifest.skill_manifest_privacy_and_compliance.SkillManifestPrivacyAndCompliance) –
• events ((optional) ask_smapi_model.v1.skill.manifest.skill_manifest_events.SkillManifestEvents) –
• permissions ((optional) list[ask_smapi_model.v1.skill.manifest.permission_items.PermissionItems]) – Defines the structure for required permissions information in the skill manifest.
• apis ((optional) ask_smapi_model.v1.skill.manifest.skill_manifest_apis.SkillManifestApis) –

attribute_map = {'apis': 'apis', 'events': 'events', 'manifest_version': 'manifestVersion', 'permissions': 'permissions', 'privacy_and_compliance': 'privacyAndCompliance', 'publishing_information': 'publishingInformation'}

deserialized_types = {'apis': 'ask_smapi_model.v1.skill.manifest.skill_manifest_apis.SkillManifestApis', 'events': 'ask_smapi_model.v1.skill.manifest.skill_manifest_events.SkillManifestEvents', 'manifest_version': 'str', 'permissions': 'list[ask_smapi_model.v1.skill.manifest.permission_items.PermissionItems]', 'privacy_and_compliance': 'ask_smapi_model.v1.skill.manifest.skill_manifest_privacy_and_compliance.SkillManifestPrivacyAndCompliance', 'publishing_information': 'ask_smapi_model.v1.skill.manifest.skill_manifest_publishing_information.SkillManifestPublishingInformation'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.skill_manifest_apis module

class ask_smapi_model.v1.skill.manifest.skill_manifest_apis.SkillManifestApis(flash_briefing=None, custom=None, smart_home=None, video=None, alexa_for_business=None, health=None, household_list=None, music=None)

Bases: object

Defines the structure for implemented apis information in the skill manifest.

Parameters:

• flash_briefing ((optional) ask_smapi_model.v1.skill.manifest.flash_briefing_apis.FlashBriefingApis) –
• custom ((optional) ask_smapi_model.v1.skill.manifest.custom_apis.CustomApis) –
• smart_home ((optional) ask_smapi_model.v1.skill.manifest.smart_home_apis.SmartHomeApis) –
• video ((optional) ask_smapi_model.v1.skill.manifest.video_apis.VideoApis) –
• alexa_for_business ((optional) ask_smapi_model.v1.skill.manifest.alexa_for_business_apis.AlexaForBusinessApis) –
• health ((optional) ask_smapi_model.v1.skill.manifest.health_apis.HealthApis) –
• household_list ((optional) ask_smapi_model.v1.skill.manifest.house_hold_list.HouseHoldList) –
• music ((optional) ask_smapi_model.v1.skill.manifest.music_apis.MusicApis) –

attribute_map = {'alexa_for_business': 'alexaForBusiness', 'custom': 'custom', 'flash_briefing': 'flashBriefing', 'health': 'health', 'household_list': 'householdList', 'music': 'music', 'smart_home': 'smartHome', 'video': 'video'}

deserialized_types = {'alexa_for_business': 'ask_smapi_model.v1.skill.manifest.alexa_for_business_apis.AlexaForBusinessApis', 'custom': 'ask_smapi_model.v1.skill.manifest.custom_apis.CustomApis', 'flash_briefing': 'ask_smapi_model.v1.skill.manifest.flash_briefing_apis.FlashBriefingApis', 'health': 'ask_smapi_model.v1.skill.manifest.health_apis.HealthApis', 'household_list': 'ask_smapi_model.v1.skill.manifest.house_hold_list.HouseHoldList', 'music': 'ask_smapi_model.v1.skill.manifest.music_apis.MusicApis', 'smart_home': 'ask_smapi_model.v1.skill.manifest.smart_home_apis.SmartHomeApis', 'video': 'ask_smapi_model.v1.skill.manifest.video_apis.VideoApis'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.skill_manifest_custom_task module

class ask_smapi_model.v1.skill.manifest.skill_manifest_custom_task.SkillManifestCustomTask(name=None, version=None)

Bases: object

Defines the name and version of the task that the skill wants to handle.

Parameters:

• name ((optional) str) – Name of the task.
• version ((optional) str) – Version of the task.

attribute_map = {'name': 'name', 'version': 'version'}

deserialized_types = {'name': 'str', 'version': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.skill_manifest_endpoint module

class ask_smapi_model.v1.skill.manifest.skill_manifest_endpoint.SkillManifestEndpoint(uri=None, ssl_certificate_type=None)

Bases: object

Defines the structure for endpoint information in the skill manifest.

Parameters:

• uri ((optional) str) – Amazon Resource Name (ARN) of the skill's Lambda function or HTTPS URL.
• ssl_certificate_type ((optional) ask_smapi_model.v1.skill.manifest.ssl_certificate_type.SSLCertificateType) –

attribute_map = {'ssl_certificate_type': 'sslCertificateType', 'uri': 'uri'}

deserialized_types = {'ssl_certificate_type': 'ask_smapi_model.v1.skill.manifest.ssl_certificate_type.SSLCertificateType', 'uri': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.skill_manifest_envelope module

class ask_smapi_model.v1.skill.manifest.skill_manifest_envelope.SkillManifestEnvelope(manifest=None)

Bases: object

Parameters:manifest ((optional) ask_smapi_model.v1.skill.manifest.skill_manifest.SkillManifest) –

attribute_map = {'manifest': 'manifest'}

deserialized_types = {'manifest': 'ask_smapi_model.v1.skill.manifest.skill_manifest.SkillManifest'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.skill_manifest_events module

class ask_smapi_model.v1.skill.manifest.skill_manifest_events.SkillManifestEvents(subscriptions=None, publications=None, regions=None, endpoint=None)

Bases: object

Defines the structure for subscribed events information in the skill manifest.

Parameters:

• subscriptions ((optional) list[ask_smapi_model.v1.skill.manifest.event_name.EventName]) – Contains an array of eventName object each of which contains the name of a skill event.
• publications ((optional) list[ask_smapi_model.v1.skill.manifest.event_publications.EventPublications]) –
• regions ((optional) dict(str, ask_smapi_model.v1.skill.manifest.region.Region)) – Contains an array of the supported &lt;region&gt; Objects.
• endpoint ((optional) ask_smapi_model.v1.skill.manifest.skill_manifest_endpoint.SkillManifestEndpoint) –

attribute_map = {'endpoint': 'endpoint', 'publications': 'publications', 'regions': 'regions', 'subscriptions': 'subscriptions'}

deserialized_types = {'endpoint': 'ask_smapi_model.v1.skill.manifest.skill_manifest_endpoint.SkillManifestEndpoint', 'publications': 'list[ask_smapi_model.v1.skill.manifest.event_publications.EventPublications]', 'regions': 'dict(str, ask_smapi_model.v1.skill.manifest.region.Region)', 'subscriptions': 'list[ask_smapi_model.v1.skill.manifest.event_name.EventName]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.skill_manifest_localized_privacy_and_compliance module

class ask_smapi_model.v1.skill.manifest.skill_manifest_localized_privacy_and_compliance.SkillManifestLocalizedPrivacyAndCompliance(privacy_policy_url=None, terms_of_use_url=None)

Bases: object

Defines the structure for locale specific privacy &amp; compliance information in the skill manifest.

Parameters:

• privacy_policy_url ((optional) str) – Link to the privacy policy that applies to this skill.
• terms_of_use_url ((optional) str) – link to the terms of use document for this skill

attribute_map = {'privacy_policy_url': 'privacyPolicyUrl', 'terms_of_use_url': 'termsOfUseUrl'}

deserialized_types = {'privacy_policy_url': 'str', 'terms_of_use_url': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.skill_manifest_localized_publishing_information module

class ask_smapi_model.v1.skill.manifest.skill_manifest_localized_publishing_information.SkillManifestLocalizedPublishingInformation(name=None, small_icon_uri=None, large_icon_uri=None, summary=None, description=None, updates_description=None, example_phrases=None, keywords=None)

Bases: object

Defines the structure for locale specific publishing information in the skill manifest.

Parameters:

• name ((optional) str) – Name of the skill that is displayed to customers in the Alexa app.
• small_icon_uri ((optional) str) – URL to a small icon for the skill, which is shown in the list of skills (108x108px).
• large_icon_uri ((optional) str) – URL to a large icon that represents this skill (512x512px).
• summary ((optional) str) – Summary description of the skill, which is shown when viewing the list of skills.
• description ((optional) str) – A full description explaining the skill’s core functionality and any prerequisites to using it (such as additional hardware, software, or accounts). For a Flash Briefing skill, you must list the feeds for the skill.
• updates_description ((optional) str) – Updates description of the skill's new features and fixes in the version. Should describe changes in the revisions of the skill.
• example_phrases ((optional) list[str]) – Three example phrases that illustrate how users can invoke your skill. For accuracy, these phrases must come directly from your sample utterances.
• keywords ((optional) list[str]) – Sample keyword phrases that describe the skill.

attribute_map = {'description': 'description', 'example_phrases': 'examplePhrases', 'keywords': 'keywords', 'large_icon_uri': 'largeIconUri', 'name': 'name', 'small_icon_uri': 'smallIconUri', 'summary': 'summary', 'updates_description': 'updatesDescription'}

deserialized_types = {'description': 'str', 'example_phrases': 'list[str]', 'keywords': 'list[str]', 'large_icon_uri': 'str', 'name': 'str', 'small_icon_uri': 'str', 'summary': 'str', 'updates_description': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.skill_manifest_privacy_and_compliance module

class ask_smapi_model.v1.skill.manifest.skill_manifest_privacy_and_compliance.SkillManifestPrivacyAndCompliance(locales=None, allows_purchases=None, uses_personal_info=None, is_child_directed=None, is_export_compliant=None, contains_ads=None, uses_health_info=None)

Bases: object

Defines the structure for privacy &amp; compliance information in the skill manifest.

Parameters:

• locales ((optional) dict(str, ask_smapi_model.v1.skill.manifest.skill_manifest_localized_privacy_and_compliance.SkillManifestLocalizedPrivacyAndCompliance)) – Defines the structure for locale specific privacy &amp; compliance information in the skill manifest.
• allows_purchases ((optional) bool) – True if the skill allows users to make purchases or spend real money false otherwise.
• uses_personal_info ((optional) bool) – True if the skill collects users' personal information false otherwise.
• is_child_directed ((optional) bool) – True if the skill is directed to or targets children under the age of 13/16 false otherwise.
• is_export_compliant ((optional) bool) – True if it is certified that the skill may be imported to and exported from the United States and all other countries and regions in which Amazon operate its program or in which skill owner have authorized sales to end users (without the need for Amazon to obtain any license or clearance or take any other action) and is in full compliance with all applicable laws and regulations governing imports and export including those applicable to software that makes use of encryption technology.
• contains_ads ((optional) bool) – True if the skill contains advertising false otherwise.
• uses_health_info ((optional) bool) – True if the skill developer is a Covered Entity (CE) or Business Associate (BA) as defined by the Health Insurance Portability And Accountability Act (HIPAA) and the skill requires Amazon to process PHI on their behalf, false otherwise. This is an optional property and treated as false if not set.

attribute_map = {'allows_purchases': 'allowsPurchases', 'contains_ads': 'containsAds', 'is_child_directed': 'isChildDirected', 'is_export_compliant': 'isExportCompliant', 'locales': 'locales', 'uses_health_info': 'usesHealthInfo', 'uses_personal_info': 'usesPersonalInfo'}

deserialized_types = {'allows_purchases': 'bool', 'contains_ads': 'bool', 'is_child_directed': 'bool', 'is_export_compliant': 'bool', 'locales': 'dict(str, ask_smapi_model.v1.skill.manifest.skill_manifest_localized_privacy_and_compliance.SkillManifestLocalizedPrivacyAndCompliance)', 'uses_health_info': 'bool', 'uses_personal_info': 'bool'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.skill_manifest_publishing_information module

class ask_smapi_model.v1.skill.manifest.skill_manifest_publishing_information.SkillManifestPublishingInformation(name=None, description=None, locales=None, is_available_worldwide=None, distribution_mode=None, gadget_support=None, testing_instructions=None, category=None, distribution_countries=None)

Bases: object

Defines the structure for publishing information in the skill manifest.

Parameters:

• name ((optional) str) – Name of the skill that is displayed to customers in the Alexa app.
• description ((optional) str) – Description of the skill's purpose and feature and how it works. Should describe any prerequisites like hardware or account requirements and detailed steps for the customer to get started. For Flash Briefing skill list the feeds offered within the skill. Use a conversational tone and correct grammar and punctuation. This description displays to customers on the skill detail card in the Alexa app.
• locales ((optional) dict(str, ask_smapi_model.v1.skill.manifest.skill_manifest_localized_publishing_information.SkillManifestLocalizedPublishingInformation)) – Defines the structure for locale specific publishing information in the skill manifest.
• is_available_worldwide ((optional) bool) – True if the skill should be distributed in all countries where Amazon distributes skill false otherwise.
• distribution_mode ((optional) ask_smapi_model.v1.skill.manifest.distribution_mode.DistributionMode) –
• gadget_support ((optional) ask_smapi_model.v1.skill.manifest.manifest_gadget_support.ManifestGadgetSupport) –
• testing_instructions ((optional) str) – Special instructions provided by the developer to test the skill.
• category ((optional) str) – Category that best describes a skill. Indicates the filter category for the skill in the Alexa App.
• distribution_countries ((optional) list[ask_smapi_model.v1.skill.manifest.distribution_countries.DistributionCountries]) – Selected list of countries provided by the skill owner where Amazon can distribute the skill.

attribute_map = {'category': 'category', 'description': 'description', 'distribution_countries': 'distributionCountries', 'distribution_mode': 'distributionMode', 'gadget_support': 'gadgetSupport', 'is_available_worldwide': 'isAvailableWorldwide', 'locales': 'locales', 'name': 'name', 'testing_instructions': 'testingInstructions'}

deserialized_types = {'category': 'str', 'description': 'str', 'distribution_countries': 'list[ask_smapi_model.v1.skill.manifest.distribution_countries.DistributionCountries]', 'distribution_mode': 'ask_smapi_model.v1.skill.manifest.distribution_mode.DistributionMode', 'gadget_support': 'ask_smapi_model.v1.skill.manifest.manifest_gadget_support.ManifestGadgetSupport', 'is_available_worldwide': 'bool', 'locales': 'dict(str, ask_smapi_model.v1.skill.manifest.skill_manifest_localized_publishing_information.SkillManifestLocalizedPublishingInformation)', 'name': 'str', 'testing_instructions': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.smart_home_apis module

class ask_smapi_model.v1.skill.manifest.smart_home_apis.SmartHomeApis(regions=None, endpoint=None, protocol_version=None)

Bases: object

Defines the structure for smart home api of the skill.

Parameters:

• regions ((optional) dict(str, ask_smapi_model.v1.skill.manifest.lambda_region.LambdaRegion)) – Contains an array of the supported &lt;region&gt; Objects.
• endpoint ((optional) ask_smapi_model.v1.skill.manifest.lambda_endpoint.LambdaEndpoint) –
• protocol_version ((optional) ask_smapi_model.v1.skill.manifest.smart_home_protocol.SmartHomeProtocol) –

attribute_map = {'endpoint': 'endpoint', 'protocol_version': 'protocolVersion', 'regions': 'regions'}

deserialized_types = {'endpoint': 'ask_smapi_model.v1.skill.manifest.lambda_endpoint.LambdaEndpoint', 'protocol_version': 'ask_smapi_model.v1.skill.manifest.smart_home_protocol.SmartHomeProtocol', 'regions': 'dict(str, ask_smapi_model.v1.skill.manifest.lambda_region.LambdaRegion)'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.smart_home_protocol module

class ask_smapi_model.v1.skill.manifest.smart_home_protocol.SmartHomeProtocol

Bases: enum.Enum

Version of the Smart Home API. Default and recommended value is '3'. You may create a skill with version '2' for testing migration to version '3', but a skill submission using version '2' will not be certified.

Allowed enum values: [_1, _2, _2_5, _2_9, _3]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.ssl_certificate_type module

class ask_smapi_model.v1.skill.manifest.ssl_certificate_type.SSLCertificateType

Bases: enum.Enum

The SSL certificate type of the skill's HTTPS endpoint. Only valid for HTTPS endpoint not for AWS Lambda ARN.

Allowed enum values: [SelfSigned, Wildcard, Trusted]

SelfSigned = 'SelfSigned'

Trusted = 'Trusted'

Wildcard = 'Wildcard'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.up_channel_items module

class ask_smapi_model.v1.skill.manifest.up_channel_items.UpChannelItems(object_type=None, uri=None)

Bases: object

Parameters:

• object_type ((optional) str) – Use \&quot;SNS\&quot; for this field.
• uri ((optional) str) – SNS Amazon Resource Name (ARN) for video skill through which video partner can send events to Alexa.

attribute_map = {'object_type': 'type', 'uri': 'uri'}

deserialized_types = {'object_type': 'str', 'uri': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.version module

class ask_smapi_model.v1.skill.manifest.version.Version

Bases: enum.Enum

Version of the interface.

Allowed enum values: [_1]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.video_apis module

class ask_smapi_model.v1.skill.manifest.video_apis.VideoApis(regions=None, locales=None, endpoint=None, countries=None)

Bases: object

Defines the structure for video api of the skill.

Parameters:

• regions ((optional) dict(str, ask_smapi_model.v1.skill.manifest.video_region.VideoRegion)) – Defines the structure for region information.
• locales ((optional) dict(str, ask_smapi_model.v1.skill.manifest.video_apis_locale.VideoApisLocale)) – Defines the structure for the locale specific video api information.
• endpoint ((optional) ask_smapi_model.v1.skill.manifest.lambda_endpoint.LambdaEndpoint) –
• countries ((optional) dict(str, ask_smapi_model.v1.skill.manifest.video_country_info.VideoCountryInfo)) – Object that contains &lt;country&gt; Objects for each supported country.

attribute_map = {'countries': 'countries', 'endpoint': 'endpoint', 'locales': 'locales', 'regions': 'regions'}

deserialized_types = {'countries': 'dict(str, ask_smapi_model.v1.skill.manifest.video_country_info.VideoCountryInfo)', 'endpoint': 'ask_smapi_model.v1.skill.manifest.lambda_endpoint.LambdaEndpoint', 'locales': 'dict(str, ask_smapi_model.v1.skill.manifest.video_apis_locale.VideoApisLocale)', 'regions': 'dict(str, ask_smapi_model.v1.skill.manifest.video_region.VideoRegion)'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.video_apis_locale module

class ask_smapi_model.v1.skill.manifest.video_apis_locale.VideoApisLocale(video_provider_targeting_names=None, video_provider_logo_uri=None, catalog_information=None)

Bases: object

Defines the structure for localized video api information.

Parameters:

• video_provider_targeting_names ((optional) list[str]) – Defines the video provider's targeting name.
• video_provider_logo_uri ((optional) str) –
• catalog_information ((optional) list[ask_smapi_model.v1.skill.manifest.video_catalog_info.VideoCatalogInfo]) –

attribute_map = {'catalog_information': 'catalogInformation', 'video_provider_logo_uri': 'videoProviderLogoUri', 'video_provider_targeting_names': 'videoProviderTargetingNames'}

deserialized_types = {'catalog_information': 'list[ask_smapi_model.v1.skill.manifest.video_catalog_info.VideoCatalogInfo]', 'video_provider_logo_uri': 'str', 'video_provider_targeting_names': 'list[str]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.video_app_interface module

class ask_smapi_model.v1.skill.manifest.video_app_interface.VideoAppInterface

Bases: ask_smapi_model.v1.skill.manifest.interface.Interface

attribute_map = {'object_type': 'type'}

deserialized_types = {'object_type': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.video_catalog_info module

class ask_smapi_model.v1.skill.manifest.video_catalog_info.VideoCatalogInfo(source_id=None)

Bases: object

Parameters:source_id ((optional) str) –

attribute_map = {'source_id': 'sourceId'}

deserialized_types = {'source_id': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.video_country_info module

class ask_smapi_model.v1.skill.manifest.video_country_info.VideoCountryInfo(catalog_information=None)

Bases: object

Defines the structure of per-country video info in the skill manifest.

Parameters:catalog_information ((optional) list[ask_smapi_model.v1.skill.manifest.video_catalog_info.VideoCatalogInfo]) –

attribute_map = {'catalog_information': 'catalogInformation'}

deserialized_types = {'catalog_information': 'list[ask_smapi_model.v1.skill.manifest.video_catalog_info.VideoCatalogInfo]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.video_region module

class ask_smapi_model.v1.skill.manifest.video_region.VideoRegion(endpoint=None, upchannel=None)

Bases: object

Defines the structure for endpoint information.

Parameters:

• endpoint ((optional) ask_smapi_model.v1.skill.manifest.lambda_endpoint.LambdaEndpoint) –
• upchannel ((optional) list[ask_smapi_model.v1.skill.manifest.up_channel_items.UpChannelItems]) – The channel through which the partner skill can communicate to Alexa.

attribute_map = {'endpoint': 'endpoint', 'upchannel': 'upchannel'}

deserialized_types = {'endpoint': 'ask_smapi_model.v1.skill.manifest.lambda_endpoint.LambdaEndpoint', 'upchannel': 'list[ask_smapi_model.v1.skill.manifest.up_channel_items.UpChannelItems]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.viewport_mode module

class ask_smapi_model.v1.skill.manifest.viewport_mode.ViewportMode

Bases: enum.Enum

Defines the mode of viewport that comply with this specification. E.g. HUB TV.

Allowed enum values: [HUB, TV]

HUB = 'HUB'

TV = 'TV'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.viewport_shape module

class ask_smapi_model.v1.skill.manifest.viewport_shape.ViewportShape

Bases: enum.Enum

Defines the shape of the device's viewport.

Allowed enum values: [RECTANGLE, ROUND]

RECTANGLE = 'RECTANGLE'

ROUND = 'ROUND'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.manifest.viewport_specification module

class ask_smapi_model.v1.skill.manifest.viewport_specification.ViewportSpecification(mode=None, shape=None, min_width=None, max_width=None, min_height=None, max_height=None)

Bases: object

Defines a viewport specification.

Parameters:

• mode ((optional) ask_smapi_model.v1.skill.manifest.viewport_mode.ViewportMode) –
• shape ((optional) ask_smapi_model.v1.skill.manifest.viewport_shape.ViewportShape) –
• min_width ((optional) int) – Defines the minimum width of viewport that comply with this specification.
• max_width ((optional) int) – Defines the maximum width of viewport that comply with this specification.
• min_height ((optional) int) – Defines the minimum height of viewport that comply with this specification.
• max_height ((optional) int) – Defines the maximum height of viewport that comply with this specification.

attribute_map = {'max_height': 'maxHeight', 'max_width': 'maxWidth', 'min_height': 'minHeight', 'min_width': 'minWidth', 'mode': 'mode', 'shape': 'shape'}

deserialized_types = {'max_height': 'int', 'max_width': 'int', 'min_height': 'int', 'min_width': 'int', 'mode': 'ask_smapi_model.v1.skill.manifest.viewport_mode.ViewportMode', 'shape': 'ask_smapi_model.v1.skill.manifest.viewport_shape.ViewportShape'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.metrics 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.v1.skill.metrics.get_metric_data_response module

class ask_smapi_model.v1.skill.metrics.get_metric_data_response.GetMetricDataResponse(metric=None, timestamps=None, values=None, next_token=None)

Bases: object

Response object for the API call which contains metrics data.

Parameters:

• metric ((optional) str) – The name of metric which customer requested.
• timestamps ((optional) list[datetime]) – The timestamps for the data points.
• values ((optional) list[float]) – The data points for the metric corresponding to Timestamps.
• next_token ((optional) str) – A token that marks the next batch of returned results.

attribute_map = {'metric': 'metric', 'next_token': 'nextToken', 'timestamps': 'timestamps', 'values': 'values'}

deserialized_types = {'metric': 'str', 'next_token': 'str', 'timestamps': 'list[datetime]', 'values': 'list[float]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.metrics.metric module

class ask_smapi_model.v1.skill.metrics.metric.Metric

Bases: enum.Enum

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

Allowed enum values: [uniqueCustomers, totalEnablements, totalUtterances, successfulUtterances, failedUtterances, totalSessions, successfulSessions, incompleteSessions, userEndedSessions, skillEndedSessions]

failedUtterances = 'failedUtterances'

incompleteSessions = 'incompleteSessions'

skillEndedSessions = 'skillEndedSessions'

successfulSessions = 'successfulSessions'

successfulUtterances = 'successfulUtterances'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

totalEnablements = 'totalEnablements'

totalSessions = 'totalSessions'

totalUtterances = 'totalUtterances'

uniqueCustomers = 'uniqueCustomers'

userEndedSessions = 'userEndedSessions'

ask_smapi_model.v1.skill.metrics.period module

class ask_smapi_model.v1.skill.metrics.period.Period

Bases: enum.Enum

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

Allowed enum values: [SINGLE, PT15M, PT1H, P1D]

P1D = 'P1D'

PT15M = 'PT15M'

PT1H = 'PT1H'

SINGLE = 'SINGLE'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.metrics.skill_type module

class ask_smapi_model.v1.skill.metrics.skill_type.SkillType

Bases: enum.Enum

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

Allowed enum values: [custom, smartHome, flashBriefing]

custom = 'custom'

flashBriefing = 'flashBriefing'

smartHome = 'smartHome'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.metrics.stage_for_metric module

class ask_smapi_model.v1.skill.metrics.stage_for_metric.StageForMetric

Bases: enum.Enum

The stage of the skill (live, development).

Allowed enum values: [live, development]

development = 'development'

live = 'live'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.private 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.v1.skill.private.accept_status module

class ask_smapi_model.v1.skill.private.accept_status.AcceptStatus

Bases: enum.Enum

Enterprise IT administrators' action on the private distribution.

Allowed enum values: [ACCEPTED, PENDING]

ACCEPTED = 'ACCEPTED'

PENDING = 'PENDING'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.private.list_private_distribution_accounts_response module

class ask_smapi_model.v1.skill.private.list_private_distribution_accounts_response.ListPrivateDistributionAccountsResponse(links=None, private_distribution_accounts=None, next_token=None)

Bases: object

Response of ListPrivateDistributionAccounts.

Parameters:

• links ((optional) ask_smapi_model.v1.links.Links) –
• private_distribution_accounts ((optional) list[ask_smapi_model.v1.skill.private.private_distribution_account.PrivateDistributionAccount]) – List of PrivateDistributionAccounts.
• next_token ((optional) str) –

attribute_map = {'links': '_links', 'next_token': 'nextToken', 'private_distribution_accounts': 'privateDistributionAccounts'}

deserialized_types = {'links': 'ask_smapi_model.v1.links.Links', 'next_token': 'str', 'private_distribution_accounts': 'list[ask_smapi_model.v1.skill.private.private_distribution_account.PrivateDistributionAccount]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.private.private_distribution_account module

class ask_smapi_model.v1.skill.private.private_distribution_account.PrivateDistributionAccount(principal=None, accept_status=None)

Bases: object

Contains information of the private distribution account with given id.

Parameters:

• principal ((optional) str) – 12-digit numerical account ID for AWS account holders.
• accept_status ((optional) ask_smapi_model.v1.skill.private.accept_status.AcceptStatus) –

attribute_map = {'accept_status': 'acceptStatus', 'principal': 'principal'}

deserialized_types = {'accept_status': 'ask_smapi_model.v1.skill.private.accept_status.AcceptStatus', 'principal': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.simulations 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.v1.skill.simulations.alexa_execution_info module

class ask_smapi_model.v1.skill.simulations.alexa_execution_info.AlexaExecutionInfo(alexa_responses=None)

Bases: object

Parameters:alexa_responses ((optional) list[ask_smapi_model.v1.skill.simulations.alexa_response.AlexaResponse]) –

attribute_map = {'alexa_responses': 'alexaResponses'}

deserialized_types = {'alexa_responses': 'list[ask_smapi_model.v1.skill.simulations.alexa_response.AlexaResponse]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.simulations.alexa_response module

class ask_smapi_model.v1.skill.simulations.alexa_response.AlexaResponse(object_type=None, content=None)

Bases: object

Parameters:

• object_type ((optional) str) – The type of Alexa response
• content ((optional) ask_smapi_model.v1.skill.simulations.alexa_response_content.AlexaResponseContent) – The detail information needs to exposed in this type of Alexa response.

attribute_map = {'content': 'content', 'object_type': 'type'}

deserialized_types = {'content': 'ask_smapi_model.v1.skill.simulations.alexa_response_content.AlexaResponseContent', 'object_type': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.simulations.alexa_response_content module

class ask_smapi_model.v1.skill.simulations.alexa_response_content.AlexaResponseContent(caption=None)

Bases: object

Parameters:caption ((optional) str) – The plain text get from Alexa speech response

attribute_map = {'caption': 'caption'}

deserialized_types = {'caption': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.simulations.device module

class ask_smapi_model.v1.skill.simulations.device.Device(locale=None)

Bases: object

Model of a virtual device used for simulation. This device object emulates attributes associated with a real Alexa enabled device.

Parameters:locale ((optional) str) – A valid locale (e.g &quot;en-US&quot;) for the virtual device used in simulation.

attribute_map = {'locale': 'locale'}

deserialized_types = {'locale': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.simulations.input module

class ask_smapi_model.v1.skill.simulations.input.Input(content=None)

Bases: object

Parameters:content ((optional) str) – A string corresponding to the utterance text of what a customer would say to Alexa.

attribute_map = {'content': 'content'}

deserialized_types = {'content': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.simulations.invocation_request module

class ask_smapi_model.v1.skill.simulations.invocation_request.InvocationRequest(endpoint=None, body=None)

Bases: object

Parameters:

• endpoint ((optional) str) – Skill's Lambda or HTTPS endpoint.
• body ((optional) dict(str, object)) – JSON payload that was sent to the skill's Lambda or HTTPS endpoint.

attribute_map = {'body': 'body', 'endpoint': 'endpoint'}

deserialized_types = {'body': 'dict(str, object)', 'endpoint': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.simulations.invocation_response module

class ask_smapi_model.v1.skill.simulations.invocation_response.InvocationResponse(body=None)

Bases: object

Parameters:body ((optional) dict(str, object)) – Payload that was returned by the skill's Lambda or HTTPS endpoint.

attribute_map = {'body': 'body'}

deserialized_types = {'body': 'dict(str, object)'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.simulations.invocations module

ask_smapi_model.v1.skill.simulations.metrics module

class ask_smapi_model.v1.skill.simulations.metrics.Metrics(skill_execution_time_in_milliseconds=None)

Bases: object

Parameters:skill_execution_time_in_milliseconds ((optional) int) – How long, in milliseconds, it took the skill's Lambda or HTTPS endpoint to process the request.

attribute_map = {'skill_execution_time_in_milliseconds': 'skillExecutionTimeInMilliseconds'}

deserialized_types = {'skill_execution_time_in_milliseconds': 'int'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.simulations.session module

class ask_smapi_model.v1.skill.simulations.session.Session(mode=None)

Bases: object

Session settings for running current simulation.

Parameters:mode ((optional) ask_smapi_model.v1.skill.simulations.session_mode.SessionMode) –

attribute_map = {'mode': 'mode'}

deserialized_types = {'mode': 'ask_smapi_model.v1.skill.simulations.session_mode.SessionMode'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.simulations.session_mode module

class ask_smapi_model.v1.skill.simulations.session_mode.SessionMode

Bases: enum.Enum

Indicate the session mode of the current simulation is using.

Allowed enum values: [DEFAULT, FORCE_NEW_SESSION]

DEFAULT = 'DEFAULT'

FORCE_NEW_SESSION = 'FORCE_NEW_SESSION'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.simulations.simulation_result module

class ask_smapi_model.v1.skill.simulations.simulation_result.SimulationResult(alexa_execution_info=None, skill_execution_info=None, error=None)

Bases: object

Parameters:

• alexa_execution_info ((optional) ask_smapi_model.v1.skill.simulations.alexa_execution_info.AlexaExecutionInfo) –
• skill_execution_info ((optional) ask_smapi_model.v1.skill.simulations.invocation.Invocation) –
• error ((optional) ask_smapi_model.v1.error.Error) –

attribute_map = {'alexa_execution_info': 'alexaExecutionInfo', 'error': 'error', 'skill_execution_info': 'skillExecutionInfo'}

deserialized_types = {'alexa_execution_info': 'ask_smapi_model.v1.skill.simulations.alexa_execution_info.AlexaExecutionInfo', 'error': 'ask_smapi_model.v1.error.Error', 'skill_execution_info': 'ask_smapi_model.v1.skill.simulations.invocation.Invocation'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.simulations.simulations_api_request module

class ask_smapi_model.v1.skill.simulations.simulations_api_request.SimulationsApiRequest(input=None, device=None, session=None)

Bases: object

Parameters:

• input ((optional) ask_smapi_model.v1.skill.simulations.input.Input) –
• device ((optional) ask_smapi_model.v1.skill.simulations.device.Device) –
• session ((optional) ask_smapi_model.v1.skill.simulations.session.Session) –

attribute_map = {'device': 'device', 'input': 'input', 'session': 'session'}

deserialized_types = {'device': 'ask_smapi_model.v1.skill.simulations.device.Device', 'input': 'ask_smapi_model.v1.skill.simulations.input.Input', 'session': 'ask_smapi_model.v1.skill.simulations.session.Session'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.simulations.simulations_api_response module

class ask_smapi_model.v1.skill.simulations.simulations_api_response.SimulationsApiResponse(id=None, status=None, result=None)

Bases: object

Parameters:

• id ((optional) str) – Id of the simulation resource.
• status ((optional) ask_smapi_model.v1.skill.simulations.simulations_api_response_status.SimulationsApiResponseStatus) –
• result ((optional) ask_smapi_model.v1.skill.simulations.simulation_result.SimulationResult) –

attribute_map = {'id': 'id', 'result': 'result', 'status': 'status'}

deserialized_types = {'id': 'str', 'result': 'ask_smapi_model.v1.skill.simulations.simulation_result.SimulationResult', 'status': 'ask_smapi_model.v1.skill.simulations.simulations_api_response_status.SimulationsApiResponseStatus'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.simulations.simulations_api_response_status module

class ask_smapi_model.v1.skill.simulations.simulations_api_response_status.SimulationsApiResponseStatus

Bases: enum.Enum

String that specifies the current status of the simulation. Possible values are &quot;IN_PROGRESS&quot;, &quot;SUCCESSFUL&quot;, and &quot;FAILED&quot;.

Allowed enum values: [IN_PROGRESS, SUCCESSFUL, FAILED]

FAILED = 'FAILED'

IN_PROGRESS = 'IN_PROGRESS'

SUCCESSFUL = 'SUCCESSFUL'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.validations 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.v1.skill.validations.response_validation module

class ask_smapi_model.v1.skill.validations.response_validation.ResponseValidation(title=None, description=None, category=None, locale=None, importance=None, status=None)

Bases: object

Parameters:

• title ((optional) str) – Short, human readable title of the validation performed.
• description ((optional) str) – Human readable description of the validation performed. May include instructions to address validation failure.
• category ((optional) str) – Dot-delimited category.
• locale ((optional) str) – Locale of the validation.
• importance ((optional) ask_smapi_model.v1.skill.validations.response_validation_importance.ResponseValidationImportance) –
• status ((optional) ask_smapi_model.v1.skill.validations.response_validation_status.ResponseValidationStatus) –

attribute_map = {'category': 'category', 'description': 'description', 'importance': 'importance', 'locale': 'locale', 'status': 'status', 'title': 'title'}

deserialized_types = {'category': 'str', 'description': 'str', 'importance': 'ask_smapi_model.v1.skill.validations.response_validation_importance.ResponseValidationImportance', 'locale': 'str', 'status': 'ask_smapi_model.v1.skill.validations.response_validation_status.ResponseValidationStatus', 'title': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.validations.response_validation_importance module

class ask_smapi_model.v1.skill.validations.response_validation_importance.ResponseValidationImportance

Bases: enum.Enum

String that specifies importance of the validation. Possible values are &quot;REQUIRED&quot; and &quot;RECOMMENDED&quot;

Allowed enum values: [REQUIRED, RECOMMENDED]

RECOMMENDED = 'RECOMMENDED'

REQUIRED = 'REQUIRED'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.validations.response_validation_status module

class ask_smapi_model.v1.skill.validations.response_validation_status.ResponseValidationStatus

Bases: enum.Enum

String that specifies status of the validation. Possible values are &quot;SUCCESSFUL&quot; and &quot;FAILED&quot;

Allowed enum values: [SUCCESSFUL, FAILED]

FAILED = 'FAILED'

SUCCESSFUL = 'SUCCESSFUL'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.validations.validations_api_request module

class ask_smapi_model.v1.skill.validations.validations_api_request.ValidationsApiRequest(locales=None)

Bases: object

Parameters:locales ((optional) list[str]) –

attribute_map = {'locales': 'locales'}

deserialized_types = {'locales': 'list[str]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.validations.validations_api_response module

class ask_smapi_model.v1.skill.validations.validations_api_response.ValidationsApiResponse(id=None, status=None, result=None)

Bases: object

Parameters:

• id ((optional) str) – Id of the validation resource.
• status ((optional) ask_smapi_model.v1.skill.validations.validations_api_response_status.ValidationsApiResponseStatus) –
• result ((optional) ask_smapi_model.v1.skill.validations.validations_api_response_result.ValidationsApiResponseResult) –

attribute_map = {'id': 'id', 'result': 'result', 'status': 'status'}

deserialized_types = {'id': 'str', 'result': 'ask_smapi_model.v1.skill.validations.validations_api_response_result.ValidationsApiResponseResult', 'status': 'ask_smapi_model.v1.skill.validations.validations_api_response_status.ValidationsApiResponseStatus'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.validations.validations_api_response_result module

class ask_smapi_model.v1.skill.validations.validations_api_response_result.ValidationsApiResponseResult(validations=None, error=None)

Bases: object

Parameters:

• validations ((optional) list[ask_smapi_model.v1.skill.validations.response_validation.ResponseValidation]) –
• error ((optional) ask_smapi_model.v1.error.Error) –

attribute_map = {'error': 'error', 'validations': 'validations'}

deserialized_types = {'error': 'ask_smapi_model.v1.error.Error', 'validations': 'list[ask_smapi_model.v1.skill.validations.response_validation.ResponseValidation]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.validations.validations_api_response_status module

class ask_smapi_model.v1.skill.validations.validations_api_response_status.ValidationsApiResponseStatus

Bases: enum.Enum

String that specifies the current status of validation execution. Possible values are &quot;IN_PROGRESS&quot;, &quot;SUCCESSFUL&quot;, and &quot;FAILED&quot;.

Allowed enum values: [IN_PROGRESS, SUCCESSFUL, FAILED]

FAILED = 'FAILED'

IN_PROGRESS = 'IN_PROGRESS'

SUCCESSFUL = 'SUCCESSFUL'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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.v1.skill.action module

class ask_smapi_model.v1.skill.action.Action

Bases: enum.Enum

Action of a resource.

Allowed enum values: [CREATE, UPDATE, ASSOCIATE, DISASSOCIATE]

ASSOCIATE = 'ASSOCIATE'

CREATE = 'CREATE'

DISASSOCIATE = 'DISASSOCIATE'

UPDATE = 'UPDATE'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.agreement_type module

class ask_smapi_model.v1.skill.agreement_type.AgreementType

Bases: enum.Enum

Type of the agreement that the customer must be compliant to.

Allowed enum values: [EXPORT_COMPLIANCE]

EXPORT_COMPLIANCE = 'EXPORT_COMPLIANCE'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.build_details module

class ask_smapi_model.v1.skill.build_details.BuildDetails(steps=None)

Bases: object

Contains array which describes steps involved in a build. Elements (or build steps) are added to this array as they become IN_PROGRESS.

Parameters:steps ((optional) list[ask_smapi_model.v1.skill.build_step.BuildStep]) – An array where each element represents a build step.

attribute_map = {'steps': 'steps'}

deserialized_types = {'steps': 'list[ask_smapi_model.v1.skill.build_step.BuildStep]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.build_step module

class ask_smapi_model.v1.skill.build_step.BuildStep(name=None, status=None, errors=None)

Bases: object

Describes the status of a build step.

Parameters:

• name ((optional) ask_smapi_model.v1.skill.build_step_name.BuildStepName) –
• status ((optional) ask_smapi_model.v1.skill.status.Status) –
• errors ((optional) list[ask_smapi_model.v1.skill.standardized_error.StandardizedError]) –

attribute_map = {'errors': 'errors', 'name': 'name', 'status': 'status'}

deserialized_types = {'errors': 'list[ask_smapi_model.v1.skill.standardized_error.StandardizedError]', 'name': 'ask_smapi_model.v1.skill.build_step_name.BuildStepName', 'status': 'ask_smapi_model.v1.skill.status.Status'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.build_step_name module

class ask_smapi_model.v1.skill.build_step_name.BuildStepName

Bases: enum.Enum

Name of the build step. Possible values - * &#x60;DIALOG_MODEL_BUILD&#x60; - Build status for dialog model. * &#x60;LANGUAGE_MODEL_QUICK_BUILD&#x60; - Build status for FST model. * &#x60;LANGUAGE_MODEL_FULL_BUILD&#x60; - Build status for statistical model.

Allowed enum values: [DIALOG_MODEL_BUILD, LANGUAGE_MODEL_QUICK_BUILD, LANGUAGE_MODEL_FULL_BUILD]

DIALOG_MODEL_BUILD = 'DIALOG_MODEL_BUILD'

LANGUAGE_MODEL_FULL_BUILD = 'LANGUAGE_MODEL_FULL_BUILD'

LANGUAGE_MODEL_QUICK_BUILD = 'LANGUAGE_MODEL_QUICK_BUILD'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.create_skill_request module

class ask_smapi_model.v1.skill.create_skill_request.CreateSkillRequest(vendor_id=None, manifest=None, hosting=None)

Bases: object

Parameters:

• vendor_id ((optional) str) – ID of the vendor owning the skill.
• manifest ((optional) ask_smapi_model.v1.skill.manifest.skill_manifest.SkillManifest) –
• hosting ((optional) ask_smapi_model.v1.skill.alexa_hosted.hosting_configuration.HostingConfiguration) –

attribute_map = {'hosting': 'hosting', 'manifest': 'manifest', 'vendor_id': 'vendorId'}

deserialized_types = {'hosting': 'ask_smapi_model.v1.skill.alexa_hosted.hosting_configuration.HostingConfiguration', 'manifest': 'ask_smapi_model.v1.skill.manifest.skill_manifest.SkillManifest', 'vendor_id': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.create_skill_response module

class ask_smapi_model.v1.skill.create_skill_response.CreateSkillResponse(skill_id=None)

Bases: object

SkillId information.

Parameters:skill_id ((optional) str) – ID of the skill created.

attribute_map = {'skill_id': 'skillId'}

deserialized_types = {'skill_id': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.create_skill_with_package_request module

class ask_smapi_model.v1.skill.create_skill_with_package_request.CreateSkillWithPackageRequest(vendor_id=None, location=None)

Bases: object

Parameters:

• vendor_id ((optional) str) – ID of the vendor owning the skill.
• location ((optional) str) – The URL for the skill package.

attribute_map = {'location': 'location', 'vendor_id': 'vendorId'}

deserialized_types = {'location': 'str', 'vendor_id': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.export_response module

class ask_smapi_model.v1.skill.export_response.ExportResponse(status=None, skill=None)

Bases: object

Parameters:

• status ((optional) ask_smapi_model.v1.skill.response_status.ResponseStatus) –
• skill ((optional) ask_smapi_model.v1.skill.export_response_skill.ExportResponseSkill) –

attribute_map = {'skill': 'skill', 'status': 'status'}

deserialized_types = {'skill': 'ask_smapi_model.v1.skill.export_response_skill.ExportResponseSkill', 'status': 'ask_smapi_model.v1.skill.response_status.ResponseStatus'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.export_response_skill module

class ask_smapi_model.v1.skill.export_response_skill.ExportResponseSkill(e_tag=None, location=None, expires_at=None)

Bases: object

Defines the structure of the GetExport response.

Parameters:

• e_tag ((optional) str) –
• location ((optional) str) –
• expires_at ((optional) str) – ExpiresAt timestamp in milliseconds.

attribute_map = {'e_tag': 'eTag', 'expires_at': 'expiresAt', 'location': 'location'}

deserialized_types = {'e_tag': 'str', 'expires_at': 'str', 'location': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.image_attributes module

class ask_smapi_model.v1.skill.image_attributes.ImageAttributes(dimension=None, size=None)

Bases: object

Set of properties of the image provided by the customer.

Parameters:

• dimension ((optional) ask_smapi_model.v1.skill.image_dimension.ImageDimension) –
• size ((optional) ask_smapi_model.v1.skill.image_size.ImageSize) –

attribute_map = {'dimension': 'dimension', 'size': 'size'}

deserialized_types = {'dimension': 'ask_smapi_model.v1.skill.image_dimension.ImageDimension', 'size': 'ask_smapi_model.v1.skill.image_size.ImageSize'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.image_dimension module

class ask_smapi_model.v1.skill.image_dimension.ImageDimension(width_in_pixels=None, height_in_pixels=None)

Bases: object

Dimensions of an image.

Parameters:

• width_in_pixels ((optional) int) – Width of the image in pixels.
• height_in_pixels ((optional) int) – Height of the image in pixels.

attribute_map = {'height_in_pixels': 'heightInPixels', 'width_in_pixels': 'widthInPixels'}

deserialized_types = {'height_in_pixels': 'int', 'width_in_pixels': 'int'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.image_size module

class ask_smapi_model.v1.skill.image_size.ImageSize(value=None, unit=None)

Bases: object

On disk storage size of image.

Parameters:

• value ((optional) float) – Value measuring the size of the image.
• unit ((optional) ask_smapi_model.v1.skill.image_size_unit.ImageSizeUnit) –

attribute_map = {'unit': 'unit', 'value': 'value'}

deserialized_types = {'unit': 'ask_smapi_model.v1.skill.image_size_unit.ImageSizeUnit', 'value': 'float'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.image_size_unit module

class ask_smapi_model.v1.skill.image_size_unit.ImageSizeUnit

Bases: enum.Enum

Unit of measurement for size of image.

Allowed enum values: [MB]

MB = 'MB'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.import_response module

class ask_smapi_model.v1.skill.import_response.ImportResponse(status=None, errors=None, warnings=None, skill=None)

Bases: object

Parameters:

• status ((optional) ask_smapi_model.v1.skill.response_status.ResponseStatus) –
• errors ((optional) list[ask_smapi_model.v1.skill.standardized_error.StandardizedError]) –
• warnings ((optional) list[ask_smapi_model.v1.skill.standardized_error.StandardizedError]) –
• skill ((optional) ask_smapi_model.v1.skill.import_response_skill.ImportResponseSkill) –

attribute_map = {'errors': 'errors', 'skill': 'skill', 'status': 'status', 'warnings': 'warnings'}

deserialized_types = {'errors': 'list[ask_smapi_model.v1.skill.standardized_error.StandardizedError]', 'skill': 'ask_smapi_model.v1.skill.import_response_skill.ImportResponseSkill', 'status': 'ask_smapi_model.v1.skill.response_status.ResponseStatus', 'warnings': 'list[ask_smapi_model.v1.skill.standardized_error.StandardizedError]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.import_response_skill module

class ask_smapi_model.v1.skill.import_response_skill.ImportResponseSkill(skill_id=None, e_tag=None, resources=None)

Bases: object

Parameters:

• skill_id ((optional) str) –
• e_tag ((optional) str) –
• resources ((optional) list[ask_smapi_model.v1.skill.resource_import_status.ResourceImportStatus]) –

attribute_map = {'e_tag': 'eTag', 'resources': 'resources', 'skill_id': 'skillId'}

deserialized_types = {'e_tag': 'str', 'resources': 'list[ask_smapi_model.v1.skill.resource_import_status.ResourceImportStatus]', 'skill_id': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.instance module

class ask_smapi_model.v1.skill.instance.Instance(property_path=None, data_type=None, value=None)

Bases: object

Structure representing properties of an instance of data. Definition will be either one of a booleanInstance, stringInstance, integerInstance, or compoundInstance.

Parameters:

• property_path ((optional) str) – Path that uniquely identifies the instance in the resource.
• data_type ((optional) ask_smapi_model.v1.skill.validation_data_types.ValidationDataTypes) –
• value ((optional) str) – String value of the instance. Incase of null, object or array the value field would be null or not present. Incase of string, boolean or integer dataType it will be the corresponding String value.

attribute_map = {'data_type': 'dataType', 'property_path': 'propertyPath', 'value': 'value'}

deserialized_types = {'data_type': 'ask_smapi_model.v1.skill.validation_data_types.ValidationDataTypes', 'property_path': 'str', 'value': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.interface_definition module

ask_smapi_model.v1.skill.interface_intent module

ask_smapi_model.v1.skill.last_update_request module

ask_smapi_model.v1.skill.list_skill_response module

class ask_smapi_model.v1.skill.list_skill_response.ListSkillResponse(links=None, skills=None, is_truncated=None, next_token=None)

Bases: object

List of skills for the vendor.

Parameters:

• links ((optional) ask_smapi_model.v1.links.Links) –
• skills ((optional) list[ask_smapi_model.v1.skill.skill_summary.SkillSummary]) – List of skill summaries. List might contain either one, two or three entries for a given skillId depending on the skill's publication history and the publication method. &#x60;Skill containing certified stage&#x60; * If a skill was never published to live, this list will contain two entries &#x60;:&#x60; one with stage 'development' and another with stage 'certified'. Both of these summaries will have same skillId. * For any skill that has been published to 'live', this list will contain three entries &#x60;:&#x60; one with stage 'development', one with stage &#x60;certified&#x60; and one with stage 'live'. All of these summaries will have same skillId. &#x60;Skill without certified stage&#x60; * If a skill was never published to live, this list will contain only one entry for the skill with stage as 'development'. * For any skill that has been published to 'live', this list will contain two entries &#x60;:&#x60; one with stage 'development' and another with stage 'live'. Both of these summaries will have same skillId.
• is_truncated ((optional) bool) –
• next_token ((optional) str) –

attribute_map = {'is_truncated': 'isTruncated', 'links': '_links', 'next_token': 'nextToken', 'skills': 'skills'}

deserialized_types = {'is_truncated': 'bool', 'links': 'ask_smapi_model.v1.links.Links', 'next_token': 'str', 'skills': 'list[ask_smapi_model.v1.skill.skill_summary.SkillSummary]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.publication_method module

class ask_smapi_model.v1.skill.publication_method.PublicationMethod

Bases: enum.Enum

Determines if the skill should be submitted only for certification and manually publish later or publish immediately after the skill is certified. Omitting the publication method will default to auto publishing.

Allowed enum values: [MANUAL_PUBLISHING, AUTO_PUBLISHING]

AUTO_PUBLISHING = 'AUTO_PUBLISHING'

MANUAL_PUBLISHING = 'MANUAL_PUBLISHING'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.reason module

class ask_smapi_model.v1.skill.reason.Reason

Bases: enum.Enum

The reason to withdraw.

Allowed enum values: [TEST_SKILL, MORE_FEATURES, DISCOVERED_ISSUE, NOT_RECEIVED_CERTIFICATION_FEEDBACK, NOT_INTEND_TO_PUBLISH, OTHER]

DISCOVERED_ISSUE = 'DISCOVERED_ISSUE'

MORE_FEATURES = 'MORE_FEATURES'

NOT_INTEND_TO_PUBLISH = 'NOT_INTEND_TO_PUBLISH'

NOT_RECEIVED_CERTIFICATION_FEEDBACK = 'NOT_RECEIVED_CERTIFICATION_FEEDBACK'

OTHER = 'OTHER'

TEST_SKILL = 'TEST_SKILL'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.regional_ssl_certificate module

class ask_smapi_model.v1.skill.regional_ssl_certificate.RegionalSSLCertificate(ssl_certificate=None)

Bases: object

Parameters:ssl_certificate ((optional) str) –

attribute_map = {'ssl_certificate': 'sslCertificate'}

deserialized_types = {'ssl_certificate': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.resource_import_status module

class ask_smapi_model.v1.skill.resource_import_status.ResourceImportStatus(name=None, status=None, action=None, errors=None, warnings=None)

Bases: object

Defines the structure for a resource deployment status.

Parameters:

• name ((optional) str) – Resource name. eg. manifest, interactionModels.en_US and so on.
• status ((optional) ask_smapi_model.v1.skill.response_status.ResponseStatus) –
• action ((optional) ask_smapi_model.v1.skill.action.Action) –
• errors ((optional) list[ask_smapi_model.v1.skill.standardized_error.StandardizedError]) –
• warnings ((optional) list[ask_smapi_model.v1.skill.standardized_error.StandardizedError]) –

attribute_map = {'action': 'action', 'errors': 'errors', 'name': 'name', 'status': 'status', 'warnings': 'warnings'}

deserialized_types = {'action': 'ask_smapi_model.v1.skill.action.Action', 'errors': 'list[ask_smapi_model.v1.skill.standardized_error.StandardizedError]', 'name': 'str', 'status': 'ask_smapi_model.v1.skill.response_status.ResponseStatus', 'warnings': 'list[ask_smapi_model.v1.skill.standardized_error.StandardizedError]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.resource_status module

ask_smapi_model.v1.skill.response_status module

class ask_smapi_model.v1.skill.response_status.ResponseStatus

Bases: enum.Enum

Status for a Response resource.

Allowed enum values: [FAILED, IN_PROGRESS, SUCCEEDED, ROLLBACK_SUCCEEDED, ROLLBACK_FAILED, SKIPPED]

FAILED = 'FAILED'

IN_PROGRESS = 'IN_PROGRESS'

ROLLBACK_FAILED = 'ROLLBACK_FAILED'

ROLLBACK_SUCCEEDED = 'ROLLBACK_SUCCEEDED'

SKIPPED = 'SKIPPED'

SUCCEEDED = 'SUCCEEDED'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.skill_interaction_model module

ask_smapi_model.v1.skill.skill_interaction_model_status module

class ask_smapi_model.v1.skill.skill_interaction_model_status.SkillInteractionModelStatus(last_update_request=None, e_tag=None, version=None)

Bases: object

Defines the structure for interaction model build status.

Parameters:

• last_update_request ((optional) ask_smapi_model.v1.skill.interaction_model_last_update_request.InteractionModelLastUpdateRequest) –
• e_tag ((optional) str) – An opaque identifier for last successfully updated resource.
• version ((optional) str) – Version for last successfully built model.

attribute_map = {'e_tag': 'eTag', 'last_update_request': 'lastUpdateRequest', 'version': 'version'}

deserialized_types = {'e_tag': 'str', 'last_update_request': 'ask_smapi_model.v1.skill.interaction_model_last_update_request.InteractionModelLastUpdateRequest', 'version': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.skill_status module

class ask_smapi_model.v1.skill.skill_status.SkillStatus(manifest=None, interaction_model=None, hosted_skill_deployment=None, hosted_skill_provisioning=None)

Bases: object

Defines the structure for skill status response.

Parameters:

• manifest ((optional) ask_smapi_model.v1.skill.manifest_status.ManifestStatus) –
• interaction_model ((optional) dict(str, ask_smapi_model.v1.skill.skill_interaction_model_status.SkillInteractionModelStatus)) – Status for available interaction models, keyed by locale.
• hosted_skill_deployment ((optional) ask_smapi_model.v1.skill.hosted_skill_deployment_status.HostedSkillDeploymentStatus) –
• hosted_skill_provisioning ((optional) ask_smapi_model.v1.skill.hosted_skill_provisioning_status.HostedSkillProvisioningStatus) –

attribute_map = {'hosted_skill_deployment': 'hostedSkillDeployment', 'hosted_skill_provisioning': 'hostedSkillProvisioning', 'interaction_model': 'interactionModel', 'manifest': 'manifest'}

deserialized_types = {'hosted_skill_deployment': 'ask_smapi_model.v1.skill.hosted_skill_deployment_status.HostedSkillDeploymentStatus', 'hosted_skill_provisioning': 'ask_smapi_model.v1.skill.hosted_skill_provisioning_status.HostedSkillProvisioningStatus', 'interaction_model': 'dict(str, ask_smapi_model.v1.skill.skill_interaction_model_status.SkillInteractionModelStatus)', 'manifest': 'ask_smapi_model.v1.skill.manifest_status.ManifestStatus'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.skill_summary module

class ask_smapi_model.v1.skill.skill_summary.SkillSummary(skill_id=None, apis=None, publication_status=None, last_updated=None, name_by_locale=None, asin=None, links=None)

Bases: object

Information about the skills.

Parameters:

• skill_id ((optional) str) –
• apis ((optional) list[ask_smapi_model.v1.skill.skill_summary_apis.SkillSummaryApis]) – List of APIs currently implemented by the skill.
• publication_status ((optional) ask_smapi_model.v1.skill.publication_status.PublicationStatus) –
• last_updated ((optional) datetime) –
• name_by_locale ((optional) dict(str, str)) – Name of the skill in skill locales (keys are locale names (e.g. 'en-US') whereas values are name of the skill in that locale.
• asin ((optional) str) – Amazon Standard Identification Number (ASIN) is unique blocks of 10 letters and/or numbers that identify items. More info about ASIN can be found here: https://www.amazon.com/gp/seller/asin-upc-isbn-info.html ASIN is available for those skills only, that have been published, at least once.
• links ((optional) ask_smapi_model.v1.links.Links) –

attribute_map = {'apis': 'apis', 'asin': 'asin', 'last_updated': 'lastUpdated', 'links': '_links', 'name_by_locale': 'nameByLocale', 'publication_status': 'publicationStatus', 'skill_id': 'skillId'}

deserialized_types = {'apis': 'list[ask_smapi_model.v1.skill.skill_summary_apis.SkillSummaryApis]', 'asin': 'str', 'last_updated': 'datetime', 'links': 'ask_smapi_model.v1.links.Links', 'name_by_locale': 'dict(str, str)', 'publication_status': 'ask_smapi_model.v1.skill.publication_status.PublicationStatus', 'skill_id': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.skill_summary_apis module

class ask_smapi_model.v1.skill.skill_summary_apis.SkillSummaryApis

Bases: enum.Enum

Allowed enum values: [custom, smartHome, flashBriefing, video, music, householdList, health, alexaForBusiness]

alexaForBusiness = 'alexaForBusiness'

custom = 'custom'

flashBriefing = 'flashBriefing'

health = 'health'

householdList = 'householdList'

music = 'music'

smartHome = 'smartHome'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

video = 'video'

ask_smapi_model.v1.skill.ssl_certificate_payload module

class ask_smapi_model.v1.skill.ssl_certificate_payload.SSLCertificatePayload(ssl_certificate=None, regions=None)

Bases: object

Parameters:

• ssl_certificate ((optional) str) – The default ssl certificate for the skill. If a request is made for a region without an explicit ssl certificate, this certificate will be used.
• regions ((optional) dict(str, ask_smapi_model.v1.skill.regional_ssl_certificate.RegionalSSLCertificate)) – A map of region to ssl certificate. Keys are string region codes (https://developer.amazon.com/docs/smapi/skill-manifest.html#regions), values are regional ssl certificate objects which contain the ssl certificate blobs as strings.

attribute_map = {'regions': 'regions', 'ssl_certificate': 'sslCertificate'}

deserialized_types = {'regions': 'dict(str, ask_smapi_model.v1.skill.regional_ssl_certificate.RegionalSSLCertificate)', 'ssl_certificate': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.standardized_error module

class ask_smapi_model.v1.skill.standardized_error.StandardizedError(validation_details=None, code=None, message=None)

Bases: ask_smapi_model.v1.error.Error

Standardized structure which wraps machine parsable and human readable information about an error.

Parameters:

• validation_details ((optional) ask_smapi_model.v1.skill.validation_details.ValidationDetails) – Standardized, machine readable structure that wraps all the information about a specific occurrence of an error of the type specified by the code.
• code ((optional) str) – Error code that maps to an error message. Developers with different locales should be able to lookup the error description based on this code.
• message ((optional) str) – Readable description of error. If standardized, this is generated from the error code and validation details.

attribute_map = {'code': 'code', 'message': 'message', 'validation_details': 'validationDetails'}

deserialized_types = {'code': 'str', 'message': 'str', 'validation_details': 'ask_smapi_model.v1.skill.validation_details.ValidationDetails'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.standardized_error_code module

ask_smapi_model.v1.skill.status module

class ask_smapi_model.v1.skill.status.Status

Bases: enum.Enum

Status of a resource.

Allowed enum values: [FAILED, IN_PROGRESS, SUCCEEDED]

FAILED = 'FAILED'

IN_PROGRESS = 'IN_PROGRESS'

SUCCEEDED = 'SUCCEEDED'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.submit_skill_for_certification_request module

class ask_smapi_model.v1.skill.submit_skill_for_certification_request.SubmitSkillForCertificationRequest(publication_method=None, version_message=None)

Bases: object

Parameters:

• publication_method ((optional) ask_smapi_model.v1.skill.publication_method.PublicationMethod) –
• version_message ((optional) str) – Description of the version (limited to 300 characters).

attribute_map = {'publication_method': 'publicationMethod', 'version_message': 'versionMessage'}

deserialized_types = {'publication_method': 'ask_smapi_model.v1.skill.publication_method.PublicationMethod', 'version_message': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.update_skill_with_package_request module

class ask_smapi_model.v1.skill.update_skill_with_package_request.UpdateSkillWithPackageRequest(location=None)

Bases: object

Parameters:location ((optional) str) – The URL for the skill package.

attribute_map = {'location': 'location'}

deserialized_types = {'location': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.upload_response module

class ask_smapi_model.v1.skill.upload_response.UploadResponse(upload_url=None, expires_at=None)

Bases: object

Defines the structure for skill upload response.

Parameters:

• upload_url ((optional) str) – The upload URL to upload a skill package.
• expires_at ((optional) datetime) –

attribute_map = {'expires_at': 'expiresAt', 'upload_url': 'uploadUrl'}

deserialized_types = {'expires_at': 'datetime', 'upload_url': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.validation_data_types module

class ask_smapi_model.v1.skill.validation_data_types.ValidationDataTypes

Bases: enum.Enum

Allowed enum values: [object, boolean, integer, array, string, null]

array = 'array'

boolean = 'boolean'

integer = 'integer'

null = 'null'

object = 'object'

string = 'string'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.validation_details module

class ask_smapi_model.v1.skill.validation_details.ValidationDetails(actual_image_attributes=None, actual_number_of_items=None, actual_string_length=None, allowed_content_types=None, allowed_data_types=None, allowed_image_attributes=None, conflicting_instance=None, expected_format=None, expected_instance=None, expected_regex_pattern=None, agreement_type=None, feature=None, inconsistent_endpoint=None, minimum_integer_value=None, minimum_number_of_items=None, minimum_string_length=None, maximum_integer_value=None, maximum_number_of_items=None, maximum_string_length=None, original_endpoint=None, original_instance=None, reason=None, required_property=None, unexpected_property=None)

Bases: object

Standardized, machine readable structure that wraps all the information about a specific occurrence of an error of the type specified by the code.

Parameters:

• actual_image_attributes ((optional) ask_smapi_model.v1.skill.image_attributes.ImageAttributes) – Set of properties of the image provided by the customer.
• actual_number_of_items ((optional) int) – Number of items in an array provided by the customer.
• actual_string_length ((optional) int) – Number of characters in a string provided by the customer.
• allowed_content_types ((optional) list[str]) – List of allowed content types for a resource.
• allowed_data_types ((optional) list[ask_smapi_model.v1.skill.validation_data_types.ValidationDataTypes]) – List of allowed data types for an instance.
• allowed_image_attributes ((optional) list[ask_smapi_model.v1.skill.image_attributes.ImageAttributes]) – List of set of properties representing all possible allowed images.
• conflicting_instance ((optional) ask_smapi_model.v1.skill.instance.Instance) – Instance conflicting with another instance.
• expected_format ((optional) ask_smapi_model.v1.skill.format.Format) – Format in which instance value is expected in.
• expected_instance ((optional) ask_smapi_model.v1.skill.instance.Instance) – Instance that is expected by a related instance.
• expected_regex_pattern ((optional) str) – Regular expression that a string instance is expected to match.
• agreement_type ((optional) ask_smapi_model.v1.skill.agreement_type.AgreementType) – Type of the agreement that the customer must be compliant to.
• feature ((optional) ask_smapi_model.v1.skill.validation_feature.ValidationFeature) – Properties of a publicly known feature that has restricted access.
• inconsistent_endpoint ((optional) ask_smapi_model.v1.skill.validation_endpoint.ValidationEndpoint) – Endpoint which has a different value for property named type when compared to original endpoint.
• minimum_integer_value ((optional) int) – Minimum allowed value of an integer instance.
• minimum_number_of_items ((optional) int) – Minimum allowed number of items in an array.
• minimum_string_length ((optional) int) – Minimum allowed number of characters in a string.
• maximum_integer_value ((optional) int) – Maximum allowed value of an integer instance.
• maximum_number_of_items ((optional) int) – Maximum allowed number of items in an array.
• maximum_string_length ((optional) int) – Maximum allowed number of characters in a string.
• original_endpoint ((optional) ask_smapi_model.v1.skill.validation_endpoint.ValidationEndpoint) – An Endpoint instance
• original_instance ((optional) ask_smapi_model.v1.skill.instance.Instance) – An Instance
• reason ((optional) ask_smapi_model.v1.skill.validation_failure_reason.ValidationFailureReason) – Represents what is wrong in the request.
• required_property ((optional) str) – Property required but missing in the object.
• unexpected_property ((optional) str) – Property not expected but present in the object.

attribute_map = {'actual_image_attributes': 'actualImageAttributes', 'actual_number_of_items': 'actualNumberOfItems', 'actual_string_length': 'actualStringLength', 'agreement_type': 'agreementType', 'allowed_content_types': 'allowedContentTypes', 'allowed_data_types': 'allowedDataTypes', 'allowed_image_attributes': 'allowedImageAttributes', 'conflicting_instance': 'conflictingInstance', 'expected_format': 'expectedFormat', 'expected_instance': 'expectedInstance', 'expected_regex_pattern': 'expectedRegexPattern', 'feature': 'feature', 'inconsistent_endpoint': 'inconsistentEndpoint', 'maximum_integer_value': 'maximumIntegerValue', 'maximum_number_of_items': 'maximumNumberOfItems', 'maximum_string_length': 'maximumStringLength', 'minimum_integer_value': 'minimumIntegerValue', 'minimum_number_of_items': 'minimumNumberOfItems', 'minimum_string_length': 'minimumStringLength', 'original_endpoint': 'originalEndpoint', 'original_instance': 'originalInstance', 'reason': 'reason', 'required_property': 'requiredProperty', 'unexpected_property': 'unexpectedProperty'}

deserialized_types = {'actual_image_attributes': 'ask_smapi_model.v1.skill.image_attributes.ImageAttributes', 'actual_number_of_items': 'int', 'actual_string_length': 'int', 'agreement_type': 'ask_smapi_model.v1.skill.agreement_type.AgreementType', 'allowed_content_types': 'list[str]', 'allowed_data_types': 'list[ask_smapi_model.v1.skill.validation_data_types.ValidationDataTypes]', 'allowed_image_attributes': 'list[ask_smapi_model.v1.skill.image_attributes.ImageAttributes]', 'conflicting_instance': 'ask_smapi_model.v1.skill.instance.Instance', 'expected_format': 'ask_smapi_model.v1.skill.format.Format', 'expected_instance': 'ask_smapi_model.v1.skill.instance.Instance', 'expected_regex_pattern': 'str', 'feature': 'ask_smapi_model.v1.skill.validation_feature.ValidationFeature', 'inconsistent_endpoint': 'ask_smapi_model.v1.skill.validation_endpoint.ValidationEndpoint', 'maximum_integer_value': 'int', 'maximum_number_of_items': 'int', 'maximum_string_length': 'int', 'minimum_integer_value': 'int', 'minimum_number_of_items': 'int', 'minimum_string_length': 'int', 'original_endpoint': 'ask_smapi_model.v1.skill.validation_endpoint.ValidationEndpoint', 'original_instance': 'ask_smapi_model.v1.skill.instance.Instance', 'reason': 'ask_smapi_model.v1.skill.validation_failure_reason.ValidationFailureReason', 'required_property': 'str', 'unexpected_property': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.validation_endpoint module

class ask_smapi_model.v1.skill.validation_endpoint.ValidationEndpoint(property_path=None, object_type=None, value=None)

Bases: object

Structure representing an endpoint.

Parameters:

• property_path ((optional) str) – Path to the endpoint URI in the resource.
• object_type ((optional) str) – Type of the endpoint (https, http, arn etc).
• value ((optional) str) – Full URI of the endpoint.

attribute_map = {'object_type': 'type', 'property_path': 'propertyPath', 'value': 'value'}

deserialized_types = {'object_type': 'str', 'property_path': 'str', 'value': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.validation_feature module

class ask_smapi_model.v1.skill.validation_feature.ValidationFeature(name=None, contact=None)

Bases: object

Structure representing a public feature.

Parameters:

• name ((optional) str) – Name of the feature.
• contact ((optional) str) – Contact URL or email for the feature.

attribute_map = {'contact': 'contact', 'name': 'name'}

deserialized_types = {'contact': 'str', 'name': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.withdraw_request module

class ask_smapi_model.v1.skill.withdraw_request.WithdrawRequest(reason=None, message=None)

Bases: object

The payload for the withdraw operation.

Parameters:

• reason ((optional) ask_smapi_model.v1.skill.reason.Reason) –
• message ((optional) str) – The message only in case the reason in OTHER.

attribute_map = {'message': 'message', 'reason': 'reason'}

deserialized_types = {'message': 'str', 'reason': 'ask_smapi_model.v1.skill.reason.Reason'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.vendor_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.v1.vendor_management.vendor module

class ask_smapi_model.v1.vendor_management.vendor.Vendor(name=None, id=None, roles=None)

Bases: object

Vendor Response Object.

Parameters:

• name ((optional) str) – Name of vendor.
• id ((optional) str) – Unique identifier of vendor associated with the API caller account.
• roles ((optional) list[str]) – Roles that user has for this vendor.

attribute_map = {'id': 'id', 'name': 'name', 'roles': 'roles'}

deserialized_types = {'id': 'str', 'name': 'str', 'roles': 'list[str]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.vendor_management.vendors module

class ask_smapi_model.v1.vendor_management.vendors.Vendors(vendors=None)

Bases: object

List of Vendors.

Parameters:vendors ((optional) list[ask_smapi_model.v1.vendor_management.vendor.Vendor]) –

attribute_map = {'vendors': 'vendors'}

deserialized_types = {'vendors': 'list[ask_smapi_model.v1.vendor_management.vendor.Vendor]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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.v1.bad_request_error module

class ask_smapi_model.v1.bad_request_error.BadRequestError(message=None, violations=None)

Bases: object

Parameters:

• message ((optional) str) – Human readable description of error.
• violations ((optional) list[ask_smapi_model.v1.error.Error]) – An array of violation messages.

attribute_map = {'message': 'message', 'violations': 'violations'}

deserialized_types = {'message': 'str', 'violations': 'list[ask_smapi_model.v1.error.Error]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.error module

class ask_smapi_model.v1.error.Error(code=None, message=None)

Bases: object

Parameters:

• code ((optional) str) – Error code that maps to an error message. Developers with different locales should be able to lookup the error description based on this code.
• message ((optional) str) – Readable description of error. If standardized, this is generated from the error code and validation details.

attribute_map = {'code': 'code', 'message': 'message'}

deserialized_types = {'code': 'str', 'message': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.link module

class ask_smapi_model.v1.link.Link(href=None)

Bases: object

Parameters:href ((optional) str) –

attribute_map = {'href': 'href'}

deserialized_types = {'href': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.links module

class ask_smapi_model.v1.links.Links(object_self=None, next=None)

Bases: object

Links for the API navigation.

Parameters:

• object_self ((optional) ask_smapi_model.v1.link.Link) –
• next ((optional) ask_smapi_model.v1.link.Link) –

attribute_map = {'next': 'next', 'object_self': 'self'}

deserialized_types = {'next': 'ask_smapi_model.v1.link.Link', 'object_self': 'ask_smapi_model.v1.link.Link'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.stage_type module

class ask_smapi_model.v1.stage_type.StageType

Bases: enum.Enum

Allowed enum values: [development, live]

development = 'development'

live = 'live'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.stage_v2_type module

class ask_smapi_model.v1.stage_v2_type.StageV2Type

Bases: enum.Enum

Allowed enum values: [live, certified, development]

certified = 'certified'

development = 'development'

live = 'live'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Got Feedback?

• We would like to hear about your bugs, feature requests, questions or quick feedback. Please search for existing issues before opening a new one. It would also be helpful if you follow the templates for issue and pull request creation. Please follow the contributing guidelines for pull requests!!
• Request and vote for Alexa features!

Additional Resources

Community

• Amazon Developer Forums : Join the conversation!
• Hackster.io - See what others are building with Alexa.

Tutorials & Guides

• Voice Design Guide - A great resource for learning conversational and voice user interface design.

Indices and tables

• Index
• Module Index