2017/04/19 - Amazon Lex Model Building Service - 30 new api methods
Gets a list of built-in slot types that meet the specified criteria.
For a list of built-in slot types, see Slot Type Reference in the Alexa Skills Kit .
This operation requires permission for the lex:GetBuiltInSlotTypes action.
See also: AWS API Documentation
Request Syntax
client.get_builtin_slot_types(
locale='en-US',
signatureContains='string',
nextToken='string',
maxResults=123
)
string
A list of locales that the slot type supports.
string
Substring to match in built-in slot type signatures. A slot type will be returned if any part of its signature matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz."
string
A pagination token that fetches the next page of slot types. If the response to this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of slot types, specify the pagination token in the next request.
integer
The maximum number of slot types to return in the response. The default is 10.
dict
Response Syntax
{
'slotTypes': [
{
'signature': 'string',
'supportedLocales': [
'en-US',
]
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
slotTypes (list) --
An array of BuiltInSlotTypeMetadata objects, one entry for each slot type returned.
(dict) --
Provides information about a built in slot type.
signature (string) --
A unique identifier for the built-in slot type. To find the signature for a slot type, see Slot Type Reference in the Alexa Skills Kit .
supportedLocales (list) --
A list of target locales for the slot.
(string) --
nextToken (string) --
If the response is truncated, the response includes a pagination token that you can use in your next request to fetch the next page of slot types.
Creates a custom slot type or replaces an existing custom slot type.
To create a custom slot type, specify a name for the slot type and a set of enumeration values, which are the values that a slot of this type can assume. For more information, see how-it-works .
If you specify the name of an existing slot type, the fields in the request replace the existing values in the $LATEST version of the slot type. Amazon Lex removes the fields that you don't provide in the request. If you don't specify required fields, Amazon Lex throws an exception.
This operation requires permissions for the lex:PutSlotType action.
See also: AWS API Documentation
Request Syntax
client.put_slot_type(
name='string',
description='string',
enumerationValues=[
{
'value': 'string'
},
],
checksum='string'
)
string
[REQUIRED]
The name of the slot type. The name is not case sensitive.
The name can't match a built-in slot type name, or a built-in slot type name with "AMAZON." removed. For example, because there is a built-in slot type called AMAZON.DATE , you can't create a custom slot type called DATE .
For a list of built-in slot types, see Slot Type Reference in the Alexa Skills Kit .
string
A description of the slot type.
list
A list of EnumerationValue objects that defines the values that the slot type can take.
(dict) --
Each slot type can have a set of values. Each enumeration value represents a value the slot type can take.
For example, a pizza ordering bot could have a slot type that specifies the type of crust that the pizza should have. The slot type could include the values
thick
thin
stuffed
value (string) -- [REQUIRED]
The value of the slot type.
string
Identifies a specific revision of the $LATEST version.
When you create a new slot type, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception.
When you want to update a slot type, set the checksum field to the checksum of the most recent revision of the $LATEST version. If you don't specify the checksum field, or if the checksum does not match the $LATEST version, you get a PreconditionFailedException exception.
dict
Response Syntax
{
'name': 'string',
'description': 'string',
'enumerationValues': [
{
'value': 'string'
},
],
'lastUpdatedDate': datetime(2015, 1, 1),
'createdDate': datetime(2015, 1, 1),
'version': 'string',
'checksum': 'string'
}
Response Structure
(dict) --
name (string) --
The name of the slot type.
description (string) --
A description of the slot type.
enumerationValues (list) --
A list of EnumerationValue objects that defines the values that the slot type can take.
(dict) --
Each slot type can have a set of values. Each enumeration value represents a value the slot type can take.
For example, a pizza ordering bot could have a slot type that specifies the type of crust that the pizza should have. The slot type could include the values
thick
thin
stuffed
value (string) --
The value of the slot type.
lastUpdatedDate (datetime) --
The date that the slot type was updated. When you create a slot type, the creation date and last update date are the same.
createdDate (datetime) --
The date that the slot type was created.
version (string) --
The version of the slot type. For a new slot type, the version is always $LATEST .
checksum (string) --
Checksum of the $LATEST version of the slot type.
Deletes a bot. If you specify a bot version in the request, the API deletes only the specified bot version. If you don't specify a version, the API deletes all versions of the bot, including the $LATEST version.
If a bot has an alias, you can't delete it. Instead, the DeleteBot operation returns a ResourceInUseException exception that includes a reference to the alias that refers to the bot. To remove the reference to the bot, delete the alias. If you get the same exception again, delete the referring alias until the DeleteBot operation is successful.
This operation requires permissions for the lex:DeleteBot action.
See also: AWS API Documentation
Request Syntax
client.delete_bot(
name='string',
version='string'
)
string
[REQUIRED]
The name of the bot. The name is case sensitive.
string
The version of the bot.
None
Creates a new version of a slot type based on the $LATEST version of the specified slot type. If the $LATEST version of this resource has not changed since the last version that you created, Amazon Lex doesn't create a new version. It returns the last version that you created.
Note
You can update only the $LATEST version of a slot type. You can't update the numbered versions that you create with the CreateSlotTypeVersion operation.
When you create a version of a slot type, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see versioning-intro .
This operation requires permissions for the lex:CreateSlotTypeVersion action.
See also: AWS API Documentation
Request Syntax
client.create_slot_type_version(
name='string',
checksum='string'
)
string
[REQUIRED]
The name of the slot type that you want to create a new version for. The name is case sensitive.
string
Checksum for the $LATEST version of the slot type that you want to publish. If you specify a checksum and the $LATEST version of the slot type has a different checksum, Amazon Lex returns a PreconditionFailedException exception and doesn't publish the new version. If you don't specify a checksum, Amazon Lex publishes the $LATEST version.
dict
Response Syntax
{
'name': 'string',
'description': 'string',
'enumerationValues': [
{
'value': 'string'
},
],
'lastUpdatedDate': datetime(2015, 1, 1),
'createdDate': datetime(2015, 1, 1),
'version': 'string',
'checksum': 'string'
}
Response Structure
(dict) --
name (string) --
The name of the slot type.
description (string) --
A description of the slot type.
enumerationValues (list) --
A list of EnumerationValue objects that defines the values that the slot type can take.
(dict) --
Each slot type can have a set of values. Each enumeration value represents a value the slot type can take.
For example, a pizza ordering bot could have a slot type that specifies the type of crust that the pizza should have. The slot type could include the values
thick
thin
stuffed
value (string) --
The value of the slot type.
lastUpdatedDate (datetime) --
The date that the slot type was updated. When you create a resource, the creation date and last update date are the same.
createdDate (datetime) --
The date that the slot type was created.
version (string) --
The version assigned to the new slot type version.
checksum (string) --
Checksum of the $LATEST version of the slot type.
Deletes an alias for the specified bot.
You can't delete an alias that is used in the association between a bot and a messaging channel. If an alias is used in a channel association, the DeleteBot operation returns a ResourceInUseException exception that includes a reference to the channel association that refers to the bot. You can remove the reference to the alias by deleting the channel association. If you get the same exception again, delete the referring association until the DeleteBotAlias operation is successful.
See also: AWS API Documentation
Request Syntax
client.delete_bot_alias(
name='string',
botName='string'
)
string
[REQUIRED]
The name of the alias to delete. The name is case sensitive.
string
[REQUIRED]
The name of the bot that the alias points to.
None
Returns information about an intent. In addition to the intent name, you must specify the intent version.
This operation requires permissions to perform the lex:GetIntent action.
See also: AWS API Documentation
Request Syntax
client.get_intent(
name='string',
version='string'
)
string
[REQUIRED]
The name of the intent. The name is case sensitive.
string
[REQUIRED]
The version of the intent.
dict
Response Syntax
{
'name': 'string',
'description': 'string',
'slots': [
{
'name': 'string',
'description': 'string',
'slotConstraint': 'Required'|'Optional',
'slotType': 'string',
'slotTypeVersion': 'string',
'valueElicitationPrompt': {
'messages': [
{
'contentType': 'PlainText'|'SSML',
'content': 'string'
},
],
'maxAttempts': 123,
'responseCard': 'string'
},
'priority': 123,
'sampleUtterances': [
'string',
],
'responseCard': 'string'
},
],
'sampleUtterances': [
'string',
],
'confirmationPrompt': {
'messages': [
{
'contentType': 'PlainText'|'SSML',
'content': 'string'
},
],
'maxAttempts': 123,
'responseCard': 'string'
},
'rejectionStatement': {
'messages': [
{
'contentType': 'PlainText'|'SSML',
'content': 'string'
},
],
'responseCard': 'string'
},
'followUpPrompt': {
'prompt': {
'messages': [
{
'contentType': 'PlainText'|'SSML',
'content': 'string'
},
],
'maxAttempts': 123,
'responseCard': 'string'
},
'rejectionStatement': {
'messages': [
{
'contentType': 'PlainText'|'SSML',
'content': 'string'
},
],
'responseCard': 'string'
}
},
'conclusionStatement': {
'messages': [
{
'contentType': 'PlainText'|'SSML',
'content': 'string'
},
],
'responseCard': 'string'
},
'dialogCodeHook': {
'uri': 'string',
'messageVersion': 'string'
},
'fulfillmentActivity': {
'type': 'ReturnIntent'|'CodeHook',
'codeHook': {
'uri': 'string',
'messageVersion': 'string'
}
},
'parentIntentSignature': 'string',
'lastUpdatedDate': datetime(2015, 1, 1),
'createdDate': datetime(2015, 1, 1),
'version': 'string',
'checksum': 'string'
}
Response Structure
(dict) --
name (string) --
The name of the intent.
description (string) --
A description of the intent.
slots (list) --
An array of intent slots configured for the intent.
(dict) --
Identifies the version of a specific slot.
name (string) --
The name of the slot.
description (string) --
A description of the slot.
slotConstraint (string) --
Specifies whether the slot is required or optional.
slotType (string) --
The type of the slot, either a custom slot type that you defined or one of the built-in slot types.
slotTypeVersion (string) --
The version of the slot type.
valueElicitationPrompt (dict) --
The prompt that Amazon Lex uses to elicit the slot value from the user.
messages (list) --
An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).
(dict) --
The message object that provides the message text and its type.
contentType (string) --
The content type of the message string.
content (string) --
The text of the message.
maxAttempts (integer) --
The number of times to prompt the user for information.
responseCard (string) --
A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card .
priority (integer) --
Specifies the order in which to elicit slot values from the user. For example, if the intent has two slots with priorities 1 and 2, AWS Amazon Lex first elicits a value for the slot with priority 1.
If multiple slots share the same priority, the order in which Amazon Lex elicits values is arbitrary.
sampleUtterances (list) --
If you know a specific pattern with which users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of understanding user utterances.
(string) --
responseCard (string) --
A set of possible responses for the slot type used by text-based clients. A user chooses an option from the response card, instead of using text to reply.
sampleUtterances (list) --
An array of sample utterances configured for the intent.
(string) --
confirmationPrompt (dict) --
If defined in the bot, Amazon Lex uses prompt to confirm the intent before fulfilling the user's request. For more information, see .
messages (list) --
An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).
(dict) --
The message object that provides the message text and its type.
contentType (string) --
The content type of the message string.
content (string) --
The text of the message.
maxAttempts (integer) --
The number of times to prompt the user for information.
responseCard (string) --
A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card .
rejectionStatement (dict) --
If the user answers "no" to the question defined in confirmationPrompt , Amazon Lex responds with this statement to acknowledge that the intent was canceled.
messages (list) --
A collection of message objects.
(dict) --
The message object that provides the message text and its type.
contentType (string) --
The content type of the message string.
content (string) --
The text of the message.
responseCard (string) --
At runtime, if the client is using the API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.
followUpPrompt (dict) --
If defined in the bot, Amazon Lex uses this prompt to solicit additional user activity after the intent is fulfilled. For more information, see .
prompt (dict) --
Obtains information from the user.
messages (list) --
An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).
(dict) --
The message object that provides the message text and its type.
contentType (string) --
The content type of the message string.
content (string) --
The text of the message.
maxAttempts (integer) --
The number of times to prompt the user for information.
responseCard (string) --
A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card .
rejectionStatement (dict) --
If the user answers "no" to the question defined in confirmationPrompt , Amazon Lex responds with this statement to acknowledge that the intent was canceled.
messages (list) --
A collection of message objects.
(dict) --
The message object that provides the message text and its type.
contentType (string) --
The content type of the message string.
content (string) --
The text of the message.
responseCard (string) --
At runtime, if the client is using the API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.
conclusionStatement (dict) --
After the Lambda function specified in the fulfillmentActivity element fulfills the intent, Amazon Lex conveys this statement to the user.
messages (list) --
A collection of message objects.
(dict) --
The message object that provides the message text and its type.
contentType (string) --
The content type of the message string.
content (string) --
The text of the message.
responseCard (string) --
At runtime, if the client is using the API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.
dialogCodeHook (dict) --
If defined in the bot, Amazon Amazon Lex invokes this Lambda function for each user input. For more information, see .
uri (string) --
The Amazon Resource Name (ARN) of the Lambda function.
messageVersion (string) --
The version of the request-response that you want Amazon Lex to use to invoke your Lambda function. For more information, see using-lambda .
fulfillmentActivity (dict) --
Describes how the intent is fulfilled. For more information, see .
type (string) --
How the intent should be fulfilled, either by running a Lambda function or by returning the slot data to the client application.
codeHook (dict) --
A description of the Lambda function that is run to fulfill the intent.
uri (string) --
The Amazon Resource Name (ARN) of the Lambda function.
messageVersion (string) --
The version of the request-response that you want Amazon Lex to use to invoke your Lambda function. For more information, see using-lambda .
parentIntentSignature (string) --
A unique identifier for a built-in intent.
lastUpdatedDate (datetime) --
The date that the intent was updated. When you create a resource, the creation date and the last updated date are the same.
createdDate (datetime) --
The date that the intent was created.
version (string) --
The version of the intent.
checksum (string) --
Checksum of the intent.
Gets information about all versions of a slot type.
The GetSlotTypeVersions operation returns a SlotTypeMetadata object for each version of a slot type. For example, if a slot type has three numbered versions, the GetSlotTypeVersions operation returns four SlotTypeMetadata objects in the response, one for each numbered version and one for the $LATEST version.
The GetSlotTypeVersions operation always returns at least one version, the $LATEST version.
See also: AWS API Documentation
Request Syntax
client.get_slot_type_versions(
name='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The name of the slot type for which versions should be returned.
string
A pagination token for fetching the next page of slot type versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request.
integer
The maximum number of slot type versions to return in the response. The default is 10.
dict
Response Syntax
{
'slotTypes': [
{
'name': 'string',
'description': 'string',
'lastUpdatedDate': datetime(2015, 1, 1),
'createdDate': datetime(2015, 1, 1),
'version': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
slotTypes (list) --
An array of SlotTypeMetadata objects, one for each numbered version of the slot type plus one for the $LATEST version.
(dict) --
Provides information about a slot type..
name (string) --
The name of the slot type.
description (string) --
A description of the slot type.
lastUpdatedDate (datetime) --
The date that the slot type was updated. When you create a resource, the creation date and last updated date are the same.
createdDate (datetime) --
The date that the slot type was created.
version (string) --
The version of the slot type.
nextToken (string) --
A pagination token for fetching the next page of slot type versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request.
Gets information about all of the versions of a bot.
The GetBotVersions operation returns a BotMetadata object for each version of a bot. For example, if a bot has three numbered versions, the GetBotVersions operation returns four BotMetadata objects in the response, one for each numbered version and one for the $LATEST version.
The GetBotVersions operation always returns at least one version, the $LATEST version.
See also: AWS API Documentation
Request Syntax
client.get_bot_versions(
name='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The name of the bot for which versions should be returned.
string
A pagination token for fetching the next page of bot versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request.
integer
The maximum number of bot versions to return in the response. The default is 10.
dict
Response Syntax
{
'bots': [
{
'name': 'string',
'description': 'string',
'status': 'BUILDING'|'READY'|'FAILED'|'NOT_BUILT',
'lastUpdatedDate': datetime(2015, 1, 1),
'createdDate': datetime(2015, 1, 1),
'version': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
bots (list) --
An array of BotMetadata objects, one for each numbered version of the bot plus one for the $LATEST version.
(dict) --
Provides information about a bot. .
name (string) --
The name of the bot.
description (string) --
A description of the bot.
status (string) --
The status of the bot.
lastUpdatedDate (datetime) --
The date that the bot was updated. When you create a bot, the creation date and last updated date are the same.
createdDate (datetime) --
The date that the bot was created.
version (string) --
The version of the bot. For a new bot, the version is always $LATEST .
nextToken (string) --
A pagination token for fetching the next page of bot versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request.
Returns a list of all of the channels associated with the specified bot.
See also: AWS API Documentation
Request Syntax
client.get_bot_channel_associations(
botName='string',
botAlias='string',
nextToken='string',
maxResults=123,
nameContains='string'
)
string
[REQUIRED]
The name of the Amazon Lex bot in the association.
string
[REQUIRED]
An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.
string
A pagination token for fetching the next page of associations. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of associations, specify the pagination token in the next request.
integer
The maximum number of associations to return in the response. The default is 50.
string
Substring to match in channel association names. An association will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz."
dict
Response Syntax
{
'botChannelAssociations': [
{
'name': 'string',
'description': 'string',
'botAlias': 'string',
'botName': 'string',
'createdDate': datetime(2015, 1, 1),
'type': 'Facebook'|'Slack'|'Twilio-Sms',
'botConfiguration': {
'string': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
botChannelAssociations (list) --
An array of objects, one for each association, that provides information about the Amazon Lex bot and its association with the channel.
(dict) --
Represents an association between an Amazon Lex bot and an external messaging platform.
name (string) --
The name of the association between the bot and the channel.
description (string) --
A text description of the association you are creating.
botAlias (string) --
An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.
botName (string) --
The name of the Amazon Lex bot to which this association is being made.
Note
Currently, Amazon Lex supports associations with Facebook and Slack, and Twilio.
createdDate (datetime) --
The date that the association between the Amazon Lex bot and the channel was created.
type (string) --
Specifies the type of association by indicating the type of channel being established between the Amazon Lex bot and the external messaging platform.
botConfiguration (dict) --
Provides information necessary to communicate with the messaging platform.
(string) --
(string) --
nextToken (string) --
A pagination token that fetches the next page of associations. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of associations, specify the pagination token in the next request.
Returns information about an Amazon Lex bot alias. For more information about aliases, see versioning-aliases .
See also: AWS API Documentation
Request Syntax
client.get_bot_alias(
name='string',
botName='string'
)
string
[REQUIRED]
The name of the bot alias. The name is case sensitive.
string
[REQUIRED]
The name of the bot.
dict
Response Syntax
{
'name': 'string',
'description': 'string',
'botVersion': 'string',
'botName': 'string',
'lastUpdatedDate': datetime(2015, 1, 1),
'createdDate': datetime(2015, 1, 1),
'checksum': 'string'
}
Response Structure
(dict) --
name (string) --
The name of the bot alias.
description (string) --
A description of the bot alias.
botVersion (string) --
The version of the bot that the alias points to.
botName (string) --
The name of the bot that the alias points to.
lastUpdatedDate (datetime) --
The date that the bot alias was updated. When you create a resource, the creation date and the last updated date are the same.
createdDate (datetime) --
The date that the bot alias was created.
checksum (string) --
Checksum of the bot alias.
Returns information about a specific version of a slot type. In addition to specifying the slot type name, you must specify the slot type version.
This operation requires permissions for the lex:GetSlotType action.
See also: AWS API Documentation
Request Syntax
client.get_slot_type(
name='string',
version='string'
)
string
[REQUIRED]
The name of the slot type. The name is case sensitive.
string
[REQUIRED]
The version of the slot type.
dict
Response Syntax
{
'name': 'string',
'description': 'string',
'enumerationValues': [
{
'value': 'string'
},
],
'lastUpdatedDate': datetime(2015, 1, 1),
'createdDate': datetime(2015, 1, 1),
'version': 'string',
'checksum': 'string'
}
Response Structure
(dict) --
name (string) --
The name of the slot type.
description (string) --
A description of the slot type.
enumerationValues (list) --
A list of EnumerationValue objects that defines the values that the slot type can take.
(dict) --
Each slot type can have a set of values. Each enumeration value represents a value the slot type can take.
For example, a pizza ordering bot could have a slot type that specifies the type of crust that the pizza should have. The slot type could include the values
thick
thin
stuffed
value (string) --
The value of the slot type.
lastUpdatedDate (datetime) --
The date that the slot type was updated. When you create a resource, the creation date and last update date are the same.
createdDate (datetime) --
The date that the slot type was created.
version (string) --
The version of the slot type.
checksum (string) --
Checksum of the $LATEST version of the slot type.
Use the GetUtterancesView operation to get information about the utterances that your users have made to your bot. You can use this list to tune the utterances that your bot responds to.
For example, say that you have created a bot to order flowers. After your users have used your bot for a while, use the GetUtterancesView operation to see the requests that they have made and whether they have been successful. You might find that the utterance "I want flowers" is not being recognized. You could add this utterance to the OrderFlowers intent so that your bot recognizes that utterance.
After you publish a new version of a bot, you can get information about the old version and the new so that you can compare the performance across the two versions.
You can request information for up to 5 versions in each request. The response contains information about a maximum of 100 utterances for each version.
See also: AWS API Documentation
Request Syntax
client.get_utterances_view(
botName='string',
botVersions=[
'string',
],
statusType='Detected'|'Missed'
)
string
[REQUIRED]
The name of the bot for which utterance information should be returned.
list
[REQUIRED]
An array of bot versions for which utterance information should be returned. The limit is 5 versions per request.
(string) --
string
[REQUIRED]
To return utterances that were recognized and handled, use``Detected`` . To return utterances that were not recognized, use Missed .
dict
Response Syntax
{
'botName': 'string',
'utterances': [
{
'botVersion': 'string',
'utterances': [
{
'utteranceString': 'string',
'count': 123,
'distinctUsers': 123,
'firstUtteredDate': datetime(2015, 1, 1),
'lastUtteredDate': datetime(2015, 1, 1)
},
]
},
]
}
Response Structure
(dict) --
botName (string) --
The name of the bot for which utterance information was returned.
utterances (list) --
An array of objects, each containing a list of objects describing the utterances that were processed by your bot. The response contains a maximum of 100 UtteranceData objects for each version.
(dict) --
Provides a list of utterances that have been made to a specific version of your bot. The list contains a maximum of 100 utterances.
botVersion (string) --
The version of the bot that processed the list.
utterances (list) --
One or more objects that contain information about the utterances that have been made to a bot. The maximum number of object is 100.
(dict) --
Provides information about a single utterance that was made to your bot.
utteranceString (string) --
The text that was entered by the user or the text representation of an audio clip.
count (integer) --
The number of times that the utterance was processed.
distinctUsers (integer) --
The total number of individuals that used the utterance.
firstUtteredDate (datetime) --
The date that the utterance was first recorded.
lastUtteredDate (datetime) --
The date that the utterance was last recorded.
Gets information about all of the versions of an intent.
The GetIntentVersions operation returns an IntentMetadata object for each version of an intent. For example, if an intent has three numbered versions, the GetIntentVersions operation returns four IntentMetadata objects in the response, one for each numbered version and one for the $LATEST version.
The GetIntentVersions operation always returns at least one version, the $LATEST version.
See also: AWS API Documentation
Request Syntax
client.get_intent_versions(
name='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The name of the intent for which versions should be returned.
string
A pagination token for fetching the next page of intent versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request.
integer
The maximum number of intent versions to return in the response. The default is 10.
dict
Response Syntax
{
'intents': [
{
'name': 'string',
'description': 'string',
'lastUpdatedDate': datetime(2015, 1, 1),
'createdDate': datetime(2015, 1, 1),
'version': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
intents (list) --
An array of IntentMetadata objects, one for each numbered version of the intent plus one for the $LATEST version.
(dict) --
Provides information about an intent.
name (string) --
The name of the intent.
description (string) --
A description of the intent.
lastUpdatedDate (datetime) --
The date that the intent was updated. When you create an intent, the creation date and last updated date are the same.
createdDate (datetime) --
The date that the intent was created.
version (string) --
The version of the intent.
nextToken (string) --
A pagination token for fetching the next page of intent versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request.
Creates an Amazon Lex conversational bot or replaces an existing bot. When you create or update an intent you only required to specify a name. You can use this to add intents later, or to remove intents from an existing bot. When you create a bot with a name only, the bot is created or updated but Amazon Lex returns the response FAILED . You can build the bot after you add one or more intents. For more information about Amazon Lex bots, see how-it-works .
If you specify the name of an existing bot, the fields in the request replace the existing values in the $LATEST version of the bot. Amazon Lex removes any fields that you don't provide values for in the request, except for the idleTTLInSeconds and privacySettings fields, which are set to their default values. If you don't specify values for required fields, Amazon Lex throws an exception.
This operation requires permissions for the lex:PutBot action. For more information, see auth-and-access-control .
See also: AWS API Documentation
Request Syntax
client.put_bot(
name='string',
description='string',
intents=[
{
'intentName': 'string',
'intentVersion': 'string'
},
],
clarificationPrompt={
'messages': [
{
'contentType': 'PlainText'|'SSML',
'content': 'string'
},
],
'maxAttempts': 123,
'responseCard': 'string'
},
abortStatement={
'messages': [
{
'contentType': 'PlainText'|'SSML',
'content': 'string'
},
],
'responseCard': 'string'
},
idleSessionTTLInSeconds=123,
voiceId='string',
checksum='string',
processBehavior='SAVE'|'BUILD',
locale='en-US',
childDirected=True|False
)
string
[REQUIRED]
The name of the bot. The name is not case sensitive.
string
A description of the bot.
list
An array of Intent objects. Each intent represents a command that a user can express. For example, a pizza ordering bot might support an OrderPizza intent. For more information, see how-it-works .
(dict) --
Identifies the specific version of an intent.
intentName (string) -- [REQUIRED]
The name of the intent.
intentVersion (string) -- [REQUIRED]
The version of the intent.
dict
When Amazon Lex doesn't understand the user's intent, it uses one of these messages to get clarification. For example, "Sorry, I didn't understand. Please repeat." Amazon Lex repeats the clarification prompt the number of times specified in maxAttempts . If Amazon Lex still can't understand, it sends the message specified in abortStatement .
messages (list) -- [REQUIRED]
An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).
(dict) --
The message object that provides the message text and its type.
contentType (string) -- [REQUIRED]
The content type of the message string.
content (string) -- [REQUIRED]
The text of the message.
maxAttempts (integer) -- [REQUIRED]
The number of times to prompt the user for information.
responseCard (string) --
A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card .
dict
When Amazon Lex can't understand the user's input in context, it tries to elicit the information a few times. After that, Amazon Lex sends the message defined in abortStatement to the user, and then aborts the conversation. To set the number of retries, use the valueElicitationPrompt field for the slot type.
For example, in a pizza ordering bot, Amazon Lex might ask a user "What type of crust would you like?" If the user's response is not one of the expected responses (for example, "thin crust, "deep dish," etc.), Amazon Lex tries to elicit a correct response a few more times.
For example, in a pizza ordering application, OrderPizza might be one of the intents. This intent might require the CrustType slot. You specify the valueElicitationPrompt field when you create the CrustType slot.
messages (list) -- [REQUIRED]
A collection of message objects.
(dict) --
The message object that provides the message text and its type.
contentType (string) -- [REQUIRED]
The content type of the message string.
content (string) -- [REQUIRED]
The text of the message.
responseCard (string) --
At runtime, if the client is using the API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.
integer
The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.
A user interaction session remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.
For example, suppose that a user chooses the OrderPizza intent, but gets sidetracked halfway through placing an order. If the user doesn't complete the order within the specified time, Amazon Lex discards the slot information that it gathered, and the user must start over.
If you don't include the idleSessionTTLInSeconds element in a PutBot operation request, Amazon Lex uses the default value. This is also true if the request replaces an existing bot.
The default is 300 seconds (5 minutes).
string
The Amazon Parrot voice ID that you want Amazon Lex to use for voice interactions with the user. The locale configured for the voice must match the locale of the bot. For more information, see Voice in the Amazon Polly Developer Guide .
string
Identifies a specific revision of the $LATEST version.
When you create a new bot, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception.
When you want to update a bot, set the checksum field to the checksum of the most recent revision of the $LATEST version. If you don't specify the checksum field, or if the checksum does not match the $LATEST version, you get a PreconditionFailedException exception.
string
If you set the processBehavior element to Build , Amazon Lex builds the bot so that it can be run. If you set the element to Save Amazon Lex saves the bot, but doesn't build it.
If you don't specify this value, the default value is Save .
string
[REQUIRED]
Specifies the target locale for the bot. Any intent used in the bot must be compatible with the locale of the bot.
The default is en-US .
boolean
[REQUIRED]
For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA.
If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.
dict
Response Syntax
{
'name': 'string',
'description': 'string',
'intents': [
{
'intentName': 'string',
'intentVersion': 'string'
},
],
'clarificationPrompt': {
'messages': [
{
'contentType': 'PlainText'|'SSML',
'content': 'string'
},
],
'maxAttempts': 123,
'responseCard': 'string'
},
'abortStatement': {
'messages': [
{
'contentType': 'PlainText'|'SSML',
'content': 'string'
},
],
'responseCard': 'string'
},
'status': 'BUILDING'|'READY'|'FAILED'|'NOT_BUILT',
'failureReason': 'string',
'lastUpdatedDate': datetime(2015, 1, 1),
'createdDate': datetime(2015, 1, 1),
'idleSessionTTLInSeconds': 123,
'voiceId': 'string',
'checksum': 'string',
'version': 'string',
'locale': 'en-US',
'childDirected': True|False
}
Response Structure
(dict) --
name (string) --
The name of the bot.
description (string) --
A description of the bot.
intents (list) --
An array of Intent objects. For more information, see .
(dict) --
Identifies the specific version of an intent.
intentName (string) --
The name of the intent.
intentVersion (string) --
The version of the intent.
clarificationPrompt (dict) --
The prompts that Amazon Lex uses when it doesn't understand the user's intent. For more information, see .
messages (list) --
An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).
(dict) --
The message object that provides the message text and its type.
contentType (string) --
The content type of the message string.
content (string) --
The text of the message.
maxAttempts (integer) --
The number of times to prompt the user for information.
responseCard (string) --
A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card .
abortStatement (dict) --
The message that Amazon Lex uses to abort a conversation. For more information, see .
messages (list) --
A collection of message objects.
(dict) --
The message object that provides the message text and its type.
contentType (string) --
The content type of the message string.
content (string) --
The text of the message.
responseCard (string) --
At runtime, if the client is using the API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.
status (string) --
When you send a request to create a bot with processBehavior set to BUILD , Amazon Lex sets the status response element to BUILDING . After Amazon Lex builds the bot, it sets status to READY . If Amazon Lex can't build the bot, Amazon Lex sets status to FAILED . Amazon Lex returns the reason for the failure in the failureReason response element.
When you set processBehavior to SAVE , Amazon Lex sets the status code to NOT BUILT .
failureReason (string) --
If status is FAILED , Amazon Lex provides the reason that it failed to build the bot.
lastUpdatedDate (datetime) --
The date that the bot was updated. When you create a resource, the creation date and last updated date are the same.
createdDate (datetime) --
The date that the bot was created.
idleSessionTTLInSeconds (integer) --
The maximum length of time that Amazon Lex retains the data gathered in a conversation. For more information, see .
voiceId (string) --
The Amazon Parrot voice ID that Amazon Lex uses for voice interaction with the user. For more information, see .
checksum (string) --
Checksum of the bot that you created.
version (string) --
The version of the bot. For a new bot, the version is always $LATEST .
locale (string) --
The target locale for the bot.
childDirected (boolean) --
For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA.
If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.
Gets a list of built-in intents that meet the specified criteria.
This operation requires permission for the lex:GetBuiltinIntents action.
See also: AWS API Documentation
Request Syntax
client.get_builtin_intents(
locale='en-US',
signatureContains='string',
nextToken='string',
maxResults=123
)
string
A list of locales that the intent supports.
string
Substring to match in built-in intent signatures. An intent will be returned if any part of its signature matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz." To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit .
string
A pagination token that fetches the next page of intents. If this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of intents, use the pagination token in the next request.
integer
The maximum number of intents to return in the response. The default is 10.
dict
Response Syntax
{
'intents': [
{
'signature': 'string',
'supportedLocales': [
'en-US',
]
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
intents (list) --
An array of builtinIntentMetadata objects, one for each intent in the response.
(dict) --
Provides metadata for a built-in intent.
signature (string) --
A unique identifier for the built-in intent. To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit .
supportedLocales (list) --
A list of identifiers for the locales that the intent supports.
(string) --
nextToken (string) --
A pagination token that fetches the next page of intents. If the response to this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of intents, specify the pagination token in the next request.
Returns information about a built-in intent.
This operation requires permission for the lex:GetBuiltinIntent action.
See also: AWS API Documentation
Request Syntax
client.get_builtin_intent(
signature='string'
)
string
[REQUIRED]
The unique identifier for a built-in intent. To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit .
dict
Response Syntax
{
'signature': 'string',
'supportedLocales': [
'en-US',
],
'slots': [
{
'name': 'string'
},
]
}
Response Structure
(dict) --
signature (string) --
The unique identifier for a built-in intent.
supportedLocales (list) --
A list of locales that the intent supports.
(string) --
slots (list) --
An array of BuiltinIntentSlot objects, one entry for each slot type in the intent.
(dict) --
Provides information about a slot used in a built-in intent.
name (string) --
A list of the slots defined for the intent.
Deletes a slot type. If you specify a version in the request, the API deletes the specific version. If you don't specify a version in the request, the API deletes all versions of the slot type, including the $LATEST version.
You can delete a version of a slot type only if it is not referenced. To delete a slot type that is referred to in one or more intents, you must remove those references first.
Note
If you get the SlotTypeInUse exception, the exception provides an example reference that shows the intent where the slot type is referenced. To remove the reference to the slot type, either update the intent or delete it. If you get the same exception when you attempt to delete the intent again, repeat until the intent has no references and the DeleteSlotType call is successful.
This operation requires permission for the lex:DeleteSlotType action.
See also: AWS API Documentation
Request Syntax
client.delete_slot_type(
name='string',
version='string'
)
string
[REQUIRED]
The name of the slot type. The name is case sensitive.
string
The version of the slot type.
None
Returns a list of aliases for a specified Amazon Lex bot.
See also: AWS API Documentation
Request Syntax
client.get_bot_aliases(
botName='string',
nextToken='string',
maxResults=123,
nameContains='string'
)
string
[REQUIRED]
The name of the bot.
string
A pagination token for fetching the next page of aliases. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of aliases, specify the pagination token in the next request.
integer
The maximum number of aliases to return in the response. The default is 50. .
string
Substring to match in bot alias names. An alias will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz."
dict
Response Syntax
{
'BotAliases': [
{
'name': 'string',
'description': 'string',
'botVersion': 'string',
'botName': 'string',
'lastUpdatedDate': datetime(2015, 1, 1),
'createdDate': datetime(2015, 1, 1),
'checksum': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
BotAliases (list) --
An array of BotAliasMetadata objects, each describing a bot alias.
(dict) --
Provides information about a bot alias.
name (string) --
The name of the bot alias.
description (string) --
A description of the bot alias.
botVersion (string) --
The version of the Amazon Lex bot to which the alias points.
botName (string) --
The name of the bot to which the alias points.
lastUpdatedDate (datetime) --
The date that the bot alias was updated. When you create a resource, the creation date and last updated date are the same.
createdDate (datetime) --
The date that the bot alias was created.
checksum (string) --
Checksum of the bot alias.
nextToken (string) --
A pagination token for fetching next page of aliases. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of aliases, specify the pagination token in the next request.
Creates a new version of an intent based on the $LATEST version of the intent. If the $LATEST version of this intent hasn't changed since you last updated it, Amazon Lex doesn't create a new version. It returns the last version you created.
Note
You can update only the $LATEST version of the intent. You can't update the numbered versions that you create with the CreateIntentVersion operation.
When you create a version of an intent, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see versioning-intro .
This operation requires permissions to perform the lex:CreateIntentVersion action.
See also: AWS API Documentation
Request Syntax
client.create_intent_version(
name='string',
checksum='string'
)
string
[REQUIRED]
The name of the intent that you want to create a new version of. The name is case sensitive.
string
Checksum of the $LATEST version of the intent that should be used to create the new version. If you specify a checksum and the $LATEST version of the intent has a different checksum, Amazon Lex returns a PreconditionFailedException exception and doesn't publish a new version. If you don't specify a checksum, Amazon Lex publishes the $LATEST version.
dict
Response Syntax
{
'name': 'string',
'description': 'string',
'slots': [
{
'name': 'string',
'description': 'string',
'slotConstraint': 'Required'|'Optional',
'slotType': 'string',
'slotTypeVersion': 'string',
'valueElicitationPrompt': {
'messages': [
{
'contentType': 'PlainText'|'SSML',
'content': 'string'
},
],
'maxAttempts': 123,
'responseCard': 'string'
},
'priority': 123,
'sampleUtterances': [
'string',
],
'responseCard': 'string'
},
],
'sampleUtterances': [
'string',
],
'confirmationPrompt': {
'messages': [
{
'contentType': 'PlainText'|'SSML',
'content': 'string'
},
],
'maxAttempts': 123,
'responseCard': 'string'
},
'rejectionStatement': {
'messages': [
{
'contentType': 'PlainText'|'SSML',
'content': 'string'
},
],
'responseCard': 'string'
},
'followUpPrompt': {
'prompt': {
'messages': [
{
'contentType': 'PlainText'|'SSML',
'content': 'string'
},
],
'maxAttempts': 123,
'responseCard': 'string'
},
'rejectionStatement': {
'messages': [
{
'contentType': 'PlainText'|'SSML',
'content': 'string'
},
],
'responseCard': 'string'
}
},
'conclusionStatement': {
'messages': [
{
'contentType': 'PlainText'|'SSML',
'content': 'string'
},
],
'responseCard': 'string'
},
'dialogCodeHook': {
'uri': 'string',
'messageVersion': 'string'
},
'fulfillmentActivity': {
'type': 'ReturnIntent'|'CodeHook',
'codeHook': {
'uri': 'string',
'messageVersion': 'string'
}
},
'parentIntentSignature': 'string',
'lastUpdatedDate': datetime(2015, 1, 1),
'createdDate': datetime(2015, 1, 1),
'version': 'string',
'checksum': 'string'
}
Response Structure
(dict) --
name (string) --
The name of the intent.
description (string) --
A description of the intent.
slots (list) --
An array of slot types that defines the information required to fulfill the intent.
(dict) --
Identifies the version of a specific slot.
name (string) --
The name of the slot.
description (string) --
A description of the slot.
slotConstraint (string) --
Specifies whether the slot is required or optional.
slotType (string) --
The type of the slot, either a custom slot type that you defined or one of the built-in slot types.
slotTypeVersion (string) --
The version of the slot type.
valueElicitationPrompt (dict) --
The prompt that Amazon Lex uses to elicit the slot value from the user.
messages (list) --
An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).
(dict) --
The message object that provides the message text and its type.
contentType (string) --
The content type of the message string.
content (string) --
The text of the message.
maxAttempts (integer) --
The number of times to prompt the user for information.
responseCard (string) --
A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card .
priority (integer) --
Specifies the order in which to elicit slot values from the user. For example, if the intent has two slots with priorities 1 and 2, AWS Amazon Lex first elicits a value for the slot with priority 1.
If multiple slots share the same priority, the order in which Amazon Lex elicits values is arbitrary.
sampleUtterances (list) --
If you know a specific pattern with which users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of understanding user utterances.
(string) --
responseCard (string) --
A set of possible responses for the slot type used by text-based clients. A user chooses an option from the response card, instead of using text to reply.
sampleUtterances (list) --
An array of sample utterances configured for the intent.
(string) --
confirmationPrompt (dict) --
If defined, the prompt that Amazon Lex uses to confirm the user's intent before fulfilling it.
messages (list) --
An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).
(dict) --
The message object that provides the message text and its type.
contentType (string) --
The content type of the message string.
content (string) --
The text of the message.
maxAttempts (integer) --
The number of times to prompt the user for information.
responseCard (string) --
A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card .
rejectionStatement (dict) --
If the user answers "no" to the question defined in confirmationPrompt , Amazon Lex responds with this statement to acknowledge that the intent was canceled.
messages (list) --
A collection of message objects.
(dict) --
The message object that provides the message text and its type.
contentType (string) --
The content type of the message string.
content (string) --
The text of the message.
responseCard (string) --
At runtime, if the client is using the API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.
followUpPrompt (dict) --
If defined, Amazon Lex uses this prompt to solicit additional user activity after the intent is fulfilled.
prompt (dict) --
Obtains information from the user.
messages (list) --
An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).
(dict) --
The message object that provides the message text and its type.
contentType (string) --
The content type of the message string.
content (string) --
The text of the message.
maxAttempts (integer) --
The number of times to prompt the user for information.
responseCard (string) --
A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card .
rejectionStatement (dict) --
If the user answers "no" to the question defined in confirmationPrompt , Amazon Lex responds with this statement to acknowledge that the intent was canceled.
messages (list) --
A collection of message objects.
(dict) --
The message object that provides the message text and its type.
contentType (string) --
The content type of the message string.
content (string) --
The text of the message.
responseCard (string) --
At runtime, if the client is using the API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.
conclusionStatement (dict) --
After the Lambda function specified in the fulfillmentActivity field fulfills the intent, Amazon Lex conveys this statement to the user.
messages (list) --
A collection of message objects.
(dict) --
The message object that provides the message text and its type.
contentType (string) --
The content type of the message string.
content (string) --
The text of the message.
responseCard (string) --
At runtime, if the client is using the API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.
dialogCodeHook (dict) --
If defined, Amazon Lex invokes this Lambda function for each user input.
uri (string) --
The Amazon Resource Name (ARN) of the Lambda function.
messageVersion (string) --
The version of the request-response that you want Amazon Lex to use to invoke your Lambda function. For more information, see using-lambda .
fulfillmentActivity (dict) --
Describes how the intent is fulfilled.
type (string) --
How the intent should be fulfilled, either by running a Lambda function or by returning the slot data to the client application.
codeHook (dict) --
A description of the Lambda function that is run to fulfill the intent.
uri (string) --
The Amazon Resource Name (ARN) of the Lambda function.
messageVersion (string) --
The version of the request-response that you want Amazon Lex to use to invoke your Lambda function. For more information, see using-lambda .
parentIntentSignature (string) --
A unique identifier for a built-in intent.
lastUpdatedDate (datetime) --
The date that the intent was updated.
createdDate (datetime) --
The date that the intent was created.
version (string) --
The version number assigned to the new version of the intent.
checksum (string) --
Checksum of the intent version created.
Returns metadata information for a specific bot. You must provide the bot name and the bot version or alias.
The GetBot operation requires permissions for the lex:GetBot action.
See also: AWS API Documentation
Request Syntax
client.get_bot(
name='string',
versionOrAlias='string'
)
string
[REQUIRED]
The name of the bot. The name is case sensitive.
string
[REQUIRED]
The version or alias of the bot.
dict
Response Syntax
{
'name': 'string',
'description': 'string',
'intents': [
{
'intentName': 'string',
'intentVersion': 'string'
},
],
'clarificationPrompt': {
'messages': [
{
'contentType': 'PlainText'|'SSML',
'content': 'string'
},
],
'maxAttempts': 123,
'responseCard': 'string'
},
'abortStatement': {
'messages': [
{
'contentType': 'PlainText'|'SSML',
'content': 'string'
},
],
'responseCard': 'string'
},
'status': 'BUILDING'|'READY'|'FAILED'|'NOT_BUILT',
'failureReason': 'string',
'lastUpdatedDate': datetime(2015, 1, 1),
'createdDate': datetime(2015, 1, 1),
'idleSessionTTLInSeconds': 123,
'voiceId': 'string',
'checksum': 'string',
'version': 'string',
'locale': 'en-US',
'childDirected': True|False
}
Response Structure
(dict) --
name (string) --
The name of the bot.
description (string) --
A description of the bot.
intents (list) --
An array of intent objects. For more information, see .
(dict) --
Identifies the specific version of an intent.
intentName (string) --
The name of the intent.
intentVersion (string) --
The version of the intent.
clarificationPrompt (dict) --
The message Amazon Lex uses when it doesn't understand the user's request. For more information, see .
messages (list) --
An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).
(dict) --
The message object that provides the message text and its type.
contentType (string) --
The content type of the message string.
content (string) --
The text of the message.
maxAttempts (integer) --
The number of times to prompt the user for information.
responseCard (string) --
A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card .
abortStatement (dict) --
The message that Amazon Lex returns when the user elects to end the conversation without completing it. For more information, see .
messages (list) --
A collection of message objects.
(dict) --
The message object that provides the message text and its type.
contentType (string) --
The content type of the message string.
content (string) --
The text of the message.
responseCard (string) --
At runtime, if the client is using the API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.
status (string) --
The status of the bot. If the bot is ready to run, the status is READY . If there was a problem with building the bot, the status is FAILED and the failureReason explains why the bot did not build. If the bot was saved but not built, the status is NOT BUILT .
failureReason (string) --
If status is FAILED , Amazon Lex explains why it failed to build the bot.
lastUpdatedDate (datetime) --
The date that the bot was updated. When you create a resource, the creation date and last updated date are the same.
createdDate (datetime) --
The date that the bot was created.
idleSessionTTLInSeconds (integer) --
The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For more information, see .
voiceId (string) --
The Amazon Parrot voice ID that Amazon Lex uses for voice interaction with the user. For more information, see .
checksum (string) --
Checksum of the bot used to identify a specific revision of the bot's $LATEST version.
version (string) --
The version of the bot. For a new bot, the version is always $LATEST .
locale (string) --
The target locale for the bot.
childDirected (boolean) --
For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA.
If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.
Creates an intent or replaces an existing intent.
To define the interaction between the user and your bot, you use one or more intents. For a pizza ordering bot, for example, you would create an OrderPizza intent.
To create an intent or replace an existing intent, you must provide the following:
Intent name. For example, OrderPizza .
Sample utterances. For example, "Can I order a pizza, please." and "I want to order a pizza."
Information to be gathered. You specify slot types for the information that your bot will request from the user. You can specify standard slot types, such as a date or a time, or custom slot types such as the size and crust of a pizza.
How the intent will be fulfilled. You can provide a Lambda function or configure the intent to return the intent information to the client application. If you use a Lambda function, when all of the intent information is available, Amazon Lex invokes your Lambda function. If you configure your intent to return the intent information to the client application.
You can specify other optional information in the request, such as:
A confirmation prompt to ask the user to confirm an intent. For example, "Shall I order your pizza?"
A conclusion statement to send to the user after the intent has been fulfilled. For example, "I placed your pizza order."
A follow-up prompt that asks the user for additional activity. For example, asking "Do you want to order a drink with your pizza?"
If you specify an existing intent name to update the intent, Amazon Lex replaces the values in the $LATEST version of the slot type with the values in the request. Amazon Lex removes fields that you don't provide in the request. If you don't specify the required fields, Amazon Lex throws an exception.
For more information, see how-it-works .
This operation requires permissions for the lex:PutIntent action. For more information, see auth-and-access-control .
See also: AWS API Documentation
Request Syntax
client.put_intent(
name='string',
description='string',
slots=[
{
'name': 'string',
'description': 'string',
'slotConstraint': 'Required'|'Optional',
'slotType': 'string',
'slotTypeVersion': 'string',
'valueElicitationPrompt': {
'messages': [
{
'contentType': 'PlainText'|'SSML',
'content': 'string'
},
],
'maxAttempts': 123,
'responseCard': 'string'
},
'priority': 123,
'sampleUtterances': [
'string',
],
'responseCard': 'string'
},
],
sampleUtterances=[
'string',
],
confirmationPrompt={
'messages': [
{
'contentType': 'PlainText'|'SSML',
'content': 'string'
},
],
'maxAttempts': 123,
'responseCard': 'string'
},
rejectionStatement={
'messages': [
{
'contentType': 'PlainText'|'SSML',
'content': 'string'
},
],
'responseCard': 'string'
},
followUpPrompt={
'prompt': {
'messages': [
{
'contentType': 'PlainText'|'SSML',
'content': 'string'
},
],
'maxAttempts': 123,
'responseCard': 'string'
},
'rejectionStatement': {
'messages': [
{
'contentType': 'PlainText'|'SSML',
'content': 'string'
},
],
'responseCard': 'string'
}
},
conclusionStatement={
'messages': [
{
'contentType': 'PlainText'|'SSML',
'content': 'string'
},
],
'responseCard': 'string'
},
dialogCodeHook={
'uri': 'string',
'messageVersion': 'string'
},
fulfillmentActivity={
'type': 'ReturnIntent'|'CodeHook',
'codeHook': {
'uri': 'string',
'messageVersion': 'string'
}
},
parentIntentSignature='string',
checksum='string'
)
string
[REQUIRED]
The name of the intent. The name is not case sensitive.
The name can't match a built-in intent name, or a built-in intent name with "AMAZON." removed. For example, because there is a built-in intent called AMAZON.HelpIntent , you can't create a custom intent called HelpIntent .
For a list of built-in intents, see Standard Built-in Intents in the Alexa Skills Kit .
string
A description of the intent.
list
An array of intent slots. At runtime, Amazon Lex elicits required slot values from the user using prompts defined in the slots. For more information, see <xref linkend="how-it-works"/>.
(dict) --
Identifies the version of a specific slot.
name (string) -- [REQUIRED]
The name of the slot.
description (string) --
A description of the slot.
slotConstraint (string) -- [REQUIRED]
Specifies whether the slot is required or optional.
slotType (string) --
The type of the slot, either a custom slot type that you defined or one of the built-in slot types.
slotTypeVersion (string) --
The version of the slot type.
valueElicitationPrompt (dict) --
The prompt that Amazon Lex uses to elicit the slot value from the user.
messages (list) -- [REQUIRED]
An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).
(dict) --
The message object that provides the message text and its type.
contentType (string) -- [REQUIRED]
The content type of the message string.
content (string) -- [REQUIRED]
The text of the message.
maxAttempts (integer) -- [REQUIRED]
The number of times to prompt the user for information.
responseCard (string) --
A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card .
priority (integer) --
Specifies the order in which to elicit slot values from the user. For example, if the intent has two slots with priorities 1 and 2, AWS Amazon Lex first elicits a value for the slot with priority 1.
If multiple slots share the same priority, the order in which Amazon Lex elicits values is arbitrary.
sampleUtterances (list) --
If you know a specific pattern with which users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of understanding user utterances.
(string) --
responseCard (string) --
A set of possible responses for the slot type used by text-based clients. A user chooses an option from the response card, instead of using text to reply.
list
An array of utterances (strings) that a user might say to signal the intent. For example, "I want {PizzaSize} pizza", "Order {Quantity} {PizzaSize} pizzas".
In each utterance, a slot name is enclosed in curly braces.
(string) --
dict
Prompts the user to confirm the intent. This question should have a yes or no answer.
Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the OrderPizza intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information.
Note
You you must provide both the rejectionStatement and the confirmationPrompt , or neither.
messages (list) -- [REQUIRED]
An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).
(dict) --
The message object that provides the message text and its type.
contentType (string) -- [REQUIRED]
The content type of the message string.
content (string) -- [REQUIRED]
The text of the message.
maxAttempts (integer) -- [REQUIRED]
The number of times to prompt the user for information.
responseCard (string) --
A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card .
dict
When the user answers "no" to the question defined in confirmationPrompt , Amazon Lex responds with this statement to acknowledge that the intent was canceled.
Note
You must provide both the rejectionStatement and the confirmationPrompt , or neither.
messages (list) -- [REQUIRED]
A collection of message objects.
(dict) --
The message object that provides the message text and its type.
contentType (string) -- [REQUIRED]
The content type of the message string.
content (string) -- [REQUIRED]
The text of the message.
responseCard (string) --
At runtime, if the client is using the API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.
dict
A user prompt for additional activity after an intent is fulfilled. For example, after the OrderPizza intent is fulfilled (your Lambda function placed an order with a pizzeria), you might prompt the user to find if they want to order a drink (assuming that you have defined an OrderDrink intent in your bot).
Note
The followUpPrompt and conclusionStatement are mutually exclusive. You can specify only one. For example, your bot may not solicit both the following:
Follow up prompt - "$session.FirstName , your pizza order has been placed. Would you like to order a drink or a dessert?"
Conclusion statement - "$session.FirstName , your pizza order has been placed."
prompt (dict) -- [REQUIRED]
Obtains information from the user.
messages (list) -- [REQUIRED]
An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).
(dict) --
The message object that provides the message text and its type.
contentType (string) -- [REQUIRED]
The content type of the message string.
content (string) -- [REQUIRED]
The text of the message.
maxAttempts (integer) -- [REQUIRED]
The number of times to prompt the user for information.
responseCard (string) --
A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card .
rejectionStatement (dict) -- [REQUIRED]
If the user answers "no" to the question defined in confirmationPrompt , Amazon Lex responds with this statement to acknowledge that the intent was canceled.
messages (list) -- [REQUIRED]
A collection of message objects.
(dict) --
The message object that provides the message text and its type.
contentType (string) -- [REQUIRED]
The content type of the message string.
content (string) -- [REQUIRED]
The text of the message.
responseCard (string) --
At runtime, if the client is using the API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.
dict
The statement that you want Amazon Lex to convey to the user after the intent is successfully fulfilled by the Lambda function.
This element is relevant only if you provide a Lambda function in the fulfillmentActivity . If you return the intent to the client application, you can't specify this element.
Note
The followUpPrompt and conclusionStatement are mutually exclusive. You can specify only one.
messages (list) -- [REQUIRED]
A collection of message objects.
(dict) --
The message object that provides the message text and its type.
contentType (string) -- [REQUIRED]
The content type of the message string.
content (string) -- [REQUIRED]
The text of the message.
responseCard (string) --
At runtime, if the client is using the API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.
dict
Specifies a Lambda function to invoke for each user input. You can invoke this Lambda function to personalize user interaction.
For example, suppose your bot determines that the user is John. Your Lambda function might retrieve John's information from a backend database and prepopulate some of the values. For example, if you find that John is gluten intolerant, you might set the corresponding intent slot, GlutenIntolerant , to true. You might find John's phone number and set the corresponding session attribute.
uri (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Lambda function.
messageVersion (string) -- [REQUIRED]
The version of the request-response that you want Amazon Lex to use to invoke your Lambda function. For more information, see using-lambda .
dict
Describes how the intent is fulfilled. For example, after a user provides all of the information for a pizza order, fulfillmentActivity defines how the bot places an order with a local pizza store.
You might configure Amazon Lex to return all of the intent information to the client application, or direct it to invoke a Lambda function that can process the intent (for example, place an order with a pizzeria).
type (string) -- [REQUIRED]
How the intent should be fulfilled, either by running a Lambda function or by returning the slot data to the client application.
codeHook (dict) --
A description of the Lambda function that is run to fulfill the intent.
uri (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Lambda function.
messageVersion (string) -- [REQUIRED]
The version of the request-response that you want Amazon Lex to use to invoke your Lambda function. For more information, see using-lambda .
string
A unique identifier for the built-in intent to base this intent on. To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit .
string
Identifies a specific revision of the $LATEST version.
When you create a new intent, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception.
When you want to update a intent, set the checksum field to the checksum of the most recent revision of the $LATEST version. If you don't specify the checksum field, or if the checksum does not match the $LATEST version, you get a PreconditionFailedException exception.
dict
Response Syntax
{
'name': 'string',
'description': 'string',
'slots': [
{
'name': 'string',
'description': 'string',
'slotConstraint': 'Required'|'Optional',
'slotType': 'string',
'slotTypeVersion': 'string',
'valueElicitationPrompt': {
'messages': [
{
'contentType': 'PlainText'|'SSML',
'content': 'string'
},
],
'maxAttempts': 123,
'responseCard': 'string'
},
'priority': 123,
'sampleUtterances': [
'string',
],
'responseCard': 'string'
},
],
'sampleUtterances': [
'string',
],
'confirmationPrompt': {
'messages': [
{
'contentType': 'PlainText'|'SSML',
'content': 'string'
},
],
'maxAttempts': 123,
'responseCard': 'string'
},
'rejectionStatement': {
'messages': [
{
'contentType': 'PlainText'|'SSML',
'content': 'string'
},
],
'responseCard': 'string'
},
'followUpPrompt': {
'prompt': {
'messages': [
{
'contentType': 'PlainText'|'SSML',
'content': 'string'
},
],
'maxAttempts': 123,
'responseCard': 'string'
},
'rejectionStatement': {
'messages': [
{
'contentType': 'PlainText'|'SSML',
'content': 'string'
},
],
'responseCard': 'string'
}
},
'conclusionStatement': {
'messages': [
{
'contentType': 'PlainText'|'SSML',
'content': 'string'
},
],
'responseCard': 'string'
},
'dialogCodeHook': {
'uri': 'string',
'messageVersion': 'string'
},
'fulfillmentActivity': {
'type': 'ReturnIntent'|'CodeHook',
'codeHook': {
'uri': 'string',
'messageVersion': 'string'
}
},
'parentIntentSignature': 'string',
'lastUpdatedDate': datetime(2015, 1, 1),
'createdDate': datetime(2015, 1, 1),
'version': 'string',
'checksum': 'string'
}
Response Structure
(dict) --
name (string) --
The name of the intent.
description (string) --
A description of the intent.
slots (list) --
An array of intent slots that are configured for the intent.
(dict) --
Identifies the version of a specific slot.
name (string) --
The name of the slot.
description (string) --
A description of the slot.
slotConstraint (string) --
Specifies whether the slot is required or optional.
slotType (string) --
The type of the slot, either a custom slot type that you defined or one of the built-in slot types.
slotTypeVersion (string) --
The version of the slot type.
valueElicitationPrompt (dict) --
The prompt that Amazon Lex uses to elicit the slot value from the user.
messages (list) --
An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).
(dict) --
The message object that provides the message text and its type.
contentType (string) --
The content type of the message string.
content (string) --
The text of the message.
maxAttempts (integer) --
The number of times to prompt the user for information.
responseCard (string) --
A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card .
priority (integer) --
Specifies the order in which to elicit slot values from the user. For example, if the intent has two slots with priorities 1 and 2, AWS Amazon Lex first elicits a value for the slot with priority 1.
If multiple slots share the same priority, the order in which Amazon Lex elicits values is arbitrary.
sampleUtterances (list) --
If you know a specific pattern with which users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of understanding user utterances.
(string) --
responseCard (string) --
A set of possible responses for the slot type used by text-based clients. A user chooses an option from the response card, instead of using text to reply.
sampleUtterances (list) --
An array of sample utterances that are configured for the intent.
(string) --
confirmationPrompt (dict) --
If defined in the intent, Amazon Lex prompts the user to confirm the intent before fulfilling it.
messages (list) --
An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).
(dict) --
The message object that provides the message text and its type.
contentType (string) --
The content type of the message string.
content (string) --
The text of the message.
maxAttempts (integer) --
The number of times to prompt the user for information.
responseCard (string) --
A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card .
rejectionStatement (dict) --
If the user answers "no" to the question defined in confirmationPrompt Amazon Lex responds with this statement to acknowledge that the intent was canceled.
messages (list) --
A collection of message objects.
(dict) --
The message object that provides the message text and its type.
contentType (string) --
The content type of the message string.
content (string) --
The text of the message.
responseCard (string) --
At runtime, if the client is using the API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.
followUpPrompt (dict) --
If defined in the intent, Amazon Lex uses this prompt to solicit additional user activity after the intent is fulfilled.
prompt (dict) --
Obtains information from the user.
messages (list) --
An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).
(dict) --
The message object that provides the message text and its type.
contentType (string) --
The content type of the message string.
content (string) --
The text of the message.
maxAttempts (integer) --
The number of times to prompt the user for information.
responseCard (string) --
A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card .
rejectionStatement (dict) --
If the user answers "no" to the question defined in confirmationPrompt , Amazon Lex responds with this statement to acknowledge that the intent was canceled.
messages (list) --
A collection of message objects.
(dict) --
The message object that provides the message text and its type.
contentType (string) --
The content type of the message string.
content (string) --
The text of the message.
responseCard (string) --
At runtime, if the client is using the API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.
conclusionStatement (dict) --
After the Lambda function specified in the``fulfillmentActivity`` intent fulfills the intent, Amazon Lex conveys this statement to the user.
messages (list) --
A collection of message objects.
(dict) --
The message object that provides the message text and its type.
contentType (string) --
The content type of the message string.
content (string) --
The text of the message.
responseCard (string) --
At runtime, if the client is using the API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.
dialogCodeHook (dict) --
If defined in the intent, Amazon Lex invokes this Lambda function for each user input.
uri (string) --
The Amazon Resource Name (ARN) of the Lambda function.
messageVersion (string) --
The version of the request-response that you want Amazon Lex to use to invoke your Lambda function. For more information, see using-lambda .
fulfillmentActivity (dict) --
If defined in the intent, Amazon Lex invokes this Lambda function to fulfill the intent after the user provides all of the information required by the intent.
type (string) --
How the intent should be fulfilled, either by running a Lambda function or by returning the slot data to the client application.
codeHook (dict) --
A description of the Lambda function that is run to fulfill the intent.
uri (string) --
The Amazon Resource Name (ARN) of the Lambda function.
messageVersion (string) --
The version of the request-response that you want Amazon Lex to use to invoke your Lambda function. For more information, see using-lambda .
parentIntentSignature (string) --
A unique identifier for the built-in intent that this intent is based on.
lastUpdatedDate (datetime) --
The date that the intent was updated. When you create a resource, the creation date and last update dates are the same.
createdDate (datetime) --
The date that the intent was created.
version (string) --
The version of the intent. For a new intent, the version is always $LATEST .
checksum (string) --
Checksum of the $LATEST version of the intent created or updated.
Deletes an intent. If you specify a version in the request, the API deletes only the specified version of the intent. If you don't specify a version in the request, the API deletes all of the versions of the intent, including the $LATEST version.
You can delete a version of an intent only if it is not referenced. To delete an intent that is referred to in one or more bots (see how-it-works ), you must remove those references first.
Note
If you get the ResourceInUseException exception, it provides an example reference that shows where the intent is referenced. To remove the reference to the intent, either update the bot or delete it. If you get the same exception when you attempt to delete the intent again, repeat until the intent has no references and the call to DeleteIntent is successful.
This operation requires permission for the lex:DeleteIntent action.
See also: AWS API Documentation
Request Syntax
client.delete_intent(
name='string',
version='string'
)
string
[REQUIRED]
The name of the intent. The name is case sensitive.
string
The version of the intent.
None
Returns intent information as follows:
If you specify the nameContains field, returns the $LATEST version of all intents that contain the specified string.
If you don't specify the nameContains field, returns information about the $LATEST version of all intents.
The operation requires permission for the lex:GetIntents action.
See also: AWS API Documentation
Request Syntax
client.get_intents(
nextToken='string',
maxResults=123,
nameContains='string'
)
string
A pagination token that fetches the next page of intents. If the response to this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of intents, specify the pagination token in the next request.
integer
The maximum number of intents to return in the response. The default is 10.
string
Substring to match in intent names. An intent will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz."
dict
Response Syntax
{
'intents': [
{
'name': 'string',
'description': 'string',
'lastUpdatedDate': datetime(2015, 1, 1),
'createdDate': datetime(2015, 1, 1),
'version': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
intents (list) --
An array of Intent objects. For more information, see .
(dict) --
Provides information about an intent.
name (string) --
The name of the intent.
description (string) --
A description of the intent.
lastUpdatedDate (datetime) --
The date that the intent was updated. When you create an intent, the creation date and last updated date are the same.
createdDate (datetime) --
The date that the intent was created.
version (string) --
The version of the intent.
nextToken (string) --
If the response is truncated, the response includes a pagination token that you can specify in your next request to fetch the next page of intents.
Returns bot information as follows:
If you provide the nameContains field, the response includes information for the $LATEST version of all bots whose name contains the specified string.
If you don't specify the nameContains field, the operation returns information about the $LATEST version of all of your bots.
This operation requires permission for the lex:GetBots action.
See also: AWS API Documentation
Request Syntax
client.get_bots(
nextToken='string',
maxResults=123,
nameContains='string'
)
string
A pagination token that fetches the next page of bots. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of bots, specify the pagination token in the next request.
integer
The maximum number of bots to return in the response that the request will return. The default is 10.
string
Substring to match in bot names. A bot will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz."
dict
Response Syntax
{
'bots': [
{
'name': 'string',
'description': 'string',
'status': 'BUILDING'|'READY'|'FAILED'|'NOT_BUILT',
'lastUpdatedDate': datetime(2015, 1, 1),
'createdDate': datetime(2015, 1, 1),
'version': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
bots (list) --
An array of botMetadata objects, with one entry for each bot.
(dict) --
Provides information about a bot. .
name (string) --
The name of the bot.
description (string) --
A description of the bot.
status (string) --
The status of the bot.
lastUpdatedDate (datetime) --
The date that the bot was updated. When you create a bot, the creation date and last updated date are the same.
createdDate (datetime) --
The date that the bot was created.
version (string) --
The version of the bot. For a new bot, the version is always $LATEST .
nextToken (string) --
If the response is truncated, it includes a pagination token that you can specify in your next request to fetch the next page of bots.
Creates a new version of the bot based on the $LATEST version. If the $LATEST version of this resource hasn't changed since you created the last version, Amazon Lex doesn't create a new version. It returns the last created version.
Note
You can update only the $LATEST version of the bot. You can't update the numbered versions that you create with the CreateBotVersion operation.
When you create the first version of a bot, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see versioning-intro .
This operation requires permission for the lex:CreateBotVersion action.
See also: AWS API Documentation
Request Syntax
client.create_bot_version(
name='string',
checksum='string'
)
string
[REQUIRED]
The name of the bot that you want to create a new version of. The name is case sensitive.
string
Identifies a specific revision of the $LATEST version of the bot. If you specify a checksum and the $LATEST version of the bot has a different checksum, a PreconditionFailedException exception is returned and Amazon Lex doesn't publish a new version. If you don't specify a checksum, Amazon Lex publishes the $LATEST version.
dict
Response Syntax
{
'name': 'string',
'description': 'string',
'intents': [
{
'intentName': 'string',
'intentVersion': 'string'
},
],
'clarificationPrompt': {
'messages': [
{
'contentType': 'PlainText'|'SSML',
'content': 'string'
},
],
'maxAttempts': 123,
'responseCard': 'string'
},
'abortStatement': {
'messages': [
{
'contentType': 'PlainText'|'SSML',
'content': 'string'
},
],
'responseCard': 'string'
},
'status': 'BUILDING'|'READY'|'FAILED'|'NOT_BUILT',
'failureReason': 'string',
'lastUpdatedDate': datetime(2015, 1, 1),
'createdDate': datetime(2015, 1, 1),
'idleSessionTTLInSeconds': 123,
'voiceId': 'string',
'checksum': 'string',
'version': 'string',
'locale': 'en-US',
'childDirected': True|False
}
Response Structure
(dict) --
name (string) --
The name of the bot.
description (string) --
A description of the bot.
intents (list) --
An array of Intent objects. For more information, see .
(dict) --
Identifies the specific version of an intent.
intentName (string) --
The name of the intent.
intentVersion (string) --
The version of the intent.
clarificationPrompt (dict) --
The message that Amazon Lex uses when it doesn't understand the user's request. For more information, see .
messages (list) --
An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).
(dict) --
The message object that provides the message text and its type.
contentType (string) --
The content type of the message string.
content (string) --
The text of the message.
maxAttempts (integer) --
The number of times to prompt the user for information.
responseCard (string) --
A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card .
abortStatement (dict) --
The message that Amazon Lex uses to abort a conversation. For more information, see .
messages (list) --
A collection of message objects.
(dict) --
The message object that provides the message text and its type.
contentType (string) --
The content type of the message string.
content (string) --
The text of the message.
responseCard (string) --
At runtime, if the client is using the API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.
status (string) --
When you send a request to create or update a bot, Amazon Lex sets the status response element to BUILDING . After Amazon Lex builds the bot, it sets status to READY . If Amazon Lex can't build the bot, it sets status to FAILED . Amazon Lex returns the reason for the failure in the failureReason response element.
failureReason (string) --
If status is FAILED , Amazon Lex provides the reason that it failed to build the bot.
lastUpdatedDate (datetime) --
The date when the $LATEST version of this bot was updated.
createdDate (datetime) --
The date when the bot version was created.
idleSessionTTLInSeconds (integer) --
The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For more information, see .
voiceId (string) --
The Amazon Parrot voice ID that Amazon Lex uses for voice interactions with the user.
checksum (string) --
Checksum identifying the version of the boat that was created.
version (string) --
The version of the bot.
locale (string) --
Specifies the target locale for the bot.
childDirected (boolean) --
For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA.
If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.
Returns slot type information as follows:
If you specify the nameContains field, returns the $LATEST version of all slot types that contain the specified string.
If you don't specify the nameContains field, returns information about the $LATEST version of all slot types.
The operation requires permission for the lex:GetSlotTypes action.
See also: AWS API Documentation
Request Syntax
client.get_slot_types(
nextToken='string',
maxResults=123,
nameContains='string'
)
string
A pagination token that fetches the next page of slot types. If the response to this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch next page of slot types, specify the pagination token in the next request.
integer
The maximum number of slot types to return in the response. The default is 10.
string
Substring to match in slot type names. A slot type will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz."
dict
Response Syntax
{
'slotTypes': [
{
'name': 'string',
'description': 'string',
'lastUpdatedDate': datetime(2015, 1, 1),
'createdDate': datetime(2015, 1, 1),
'version': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
slotTypes (list) --
An array of objects, one for each slot type, that provides information such as the name of the slot type, the version, and a description.
(dict) --
Provides information about a slot type..
name (string) --
The name of the slot type.
description (string) --
A description of the slot type.
lastUpdatedDate (datetime) --
The date that the slot type was updated. When you create a resource, the creation date and last updated date are the same.
createdDate (datetime) --
The date that the slot type was created.
version (string) --
The version of the slot type.
nextToken (string) --
If the response is truncated, it includes a pagination token that you can specify in your next request to fetch the next page of slot types.
Returns information about the association between an Amazon Lex bot and a messaging platform.
See also: AWS API Documentation
Request Syntax
client.get_bot_channel_association(
name='string',
botName='string',
botAlias='string'
)
string
[REQUIRED]
The name of the association between the bot and the channel. The name is case sensitive.
string
[REQUIRED]
The name of the Amazon Lex bot.
string
[REQUIRED]
An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.
dict
Response Syntax
{
'name': 'string',
'description': 'string',
'botAlias': 'string',
'botName': 'string',
'createdDate': datetime(2015, 1, 1),
'type': 'Facebook'|'Slack'|'Twilio-Sms',
'botConfiguration': {
'string': 'string'
}
}
Response Structure
(dict) --
name (string) --
The name of the association between the bot and the channel.
description (string) --
A description of the association between the bot and the channel.
botAlias (string) --
An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.
botName (string) --
The name of the Amazon Lex bot.
createdDate (datetime) --
The date that the association between the bot and the channel was created.
type (string) --
The type of the messaging platform.
botConfiguration (dict) --
Provides information that the messaging platform needs to communicate with the Amazon Lex bot.
(string) --
(string) --
Creates an alias for the specified version of the bot or replaces an alias for the specified bot. To change the version of the bot that the alias points to, replace the alias. For more information about aliases, see versioning-aliases .
This operation requires permissions for the lex:PutBotAlias action.
See also: AWS API Documentation
Request Syntax
client.put_bot_alias(
name='string',
description='string',
botVersion='string',
botName='string',
checksum='string'
)
string
[REQUIRED]
The name of the alias. The name is not case sensitive.
string
A description of the alias.
string
[REQUIRED]
The version of the bot.
string
[REQUIRED]
The name of the bot.
string
Identifies a specific revision of the $LATEST version.
When you create a new bot alias, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception.
When you want to update a bot alias, set the checksum field to the checksum of the most recent revision of the $LATEST version. If you don't specify the checksum field, or if the checksum does not match the $LATEST version, you get a PreconditionFailedException exception.
dict
Response Syntax
{
'name': 'string',
'description': 'string',
'botVersion': 'string',
'botName': 'string',
'lastUpdatedDate': datetime(2015, 1, 1),
'createdDate': datetime(2015, 1, 1),
'checksum': 'string'
}
Response Structure
(dict) --
name (string) --
The name of the alias.
description (string) --
A description of the alias.
botVersion (string) --
The version of the bot that the alias points to.
botName (string) --
The name of the bot that the alias points to.
lastUpdatedDate (datetime) --
The date that the bot alias was updated. When you create a resource, the creation date and the last updated date are the same.
createdDate (datetime) --
The date that the bot alias was created.
checksum (string) --
The checksum for the current version of the alias.
Deletes the association between an Amazon Lex bot and a messaging platform.
This operation requires permission for the lex:DeleteBotChannelAssociation action.
See also: AWS API Documentation
Request Syntax
client.delete_bot_channel_association(
name='string',
botName='string',
botAlias='string'
)
string
[REQUIRED]
The name of the association. The name is case sensitive.
string
[REQUIRED]
The name of the Amazon Lex bot.
string
[REQUIRED]
An alias that points to the specific version of the Amazon Lex bot to which this association is being made.
None
Deletes stored utterances.
When you create or update a bot using the operation, configure your bot to store user utterances by setting privacySetting to STORE_UTTERANCES . Use DeleteUtterances to remove the stored utterances for a specific user .
This operation requires permissions for the lex:DeleteUtterances action.
See also: AWS API Documentation
Request Syntax
client.delete_utterances(
botName='string',
userId='string'
)
string
[REQUIRED]
The name of the bot that stored the utterances.
string
[REQUIRED]
The unique identifier for the user that made the utterances. This is the user ID that was sent in the or operation request that contained the utterance.
None