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.

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)

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:
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