Icon

AWS Lex (Models) (version v1.*.*)

create_bot_version

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

Parameters

name (required)

The name of the bot that you want to create a new version of. The name is case sensitive.

Type: string

$body

Type: object

{
"checksum" : "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."
}

create_intent_version

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

Parameters

name (required)

The name of the intent that you want to create a new version of. The name is case sensitive.

Type: string

$body

Type: object

{
"checksum" : "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."
}

create_slot_type_version

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

Parameters

name (required)

The name of the slot type that you want to create a new version for. The name is case sensitive.

Type: string

$body

Type: object

{
"checksum" : "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."
}

delete_bot

Deletes all versions of the bot, including the $LATEST version. To delete a specific version of the bot, use the DeleteBotVersion operation.
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.

Parameters

name (required)

The name of the bot. The name is case sensitive.

Type: string

delete_bot_alias

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.

Parameters

botName (required)

The name of the bot that the alias points to.

Type: string

name (required)

The name of the alias to delete. The name is case sensitive.

Type: string

delete_bot_channel_association

Deletes the association between an Amazon Lex bot and a messaging platform.
This operation requires permission for the lex:DeleteBotChannelAssociation action.

Parameters

aliasName (required)

An alias that points to the specific version of the Amazon Lex bot to which this association is being made.

Type: string

botName (required)

The name of the Amazon Lex bot.

Type: string

name (required)

The name of the association. The name is case sensitive.

Type: string

delete_bot_version

Deletes a specific version of a bot. To delete all versions of a bot, use the DeleteBot operation.
This operation requires permissions for the lex:DeleteBotVersion action.

Parameters

name (required)

The name of the bot.

Type: string

version (required)

The version of the bot to delete. You cannot delete the $LATEST version of the bot. To delete the $LATEST version, use the DeleteBot operation.

Type: string

delete_intent

Deletes all versions of the intent, including the $LATEST version. To delete a specific version of the intent, use the DeleteIntentVersion operation.
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.
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.

Parameters

name (required)

The name of the intent. The name is case sensitive.

Type: string

delete_intent_version

Deletes a specific version of an intent. To delete all versions of a intent, use the DeleteIntent operation.
This operation requires permissions for the lex:DeleteIntentVersion action.

Parameters

name (required)

The name of the intent.

Type: string

version (required)

The version of the intent to delete. You cannot delete the $LATEST version of the intent. To delete the $LATEST version, use the DeleteIntent operation.

Type: string

delete_slot_type

Deletes all versions of the slot type, including the $LATEST version. To delete a specific version of the slot type, use the DeleteSlotTypeVersion operation.
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.
If you get the ResourceInUseException 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 slot type again, repeat until the slot type has no references and the DeleteSlotType call is successful.
This operation requires permission for the lex:DeleteSlotType action.

Parameters

name (required)

The name of the slot type. The name is case sensitive.

Type: string

delete_slot_type_version

Deletes a specific version of a slot type. To delete all versions of a slot type, use the DeleteSlotType operation.
This operation requires permissions for the lex:DeleteSlotTypeVersion action.

Parameters

name (required)

The name of the slot type.

Type: string

version (required)

The version of the slot type to delete. You cannot delete the $LATEST version of the slot type. To delete the $LATEST version, use the DeleteSlotType operation.

Type: string

delete_utterances

Deletes stored utterances.
Amazon Lex stores the utterances that users send to your bot. Utterances are stored for 15 days for use with the GetUtterancesView operation, and then stored indefinitely for use in improving the ability of your bot to respond to user input.
Use the DeleteStoredUtterances operation to manually delete stored utterances for a specific user.
This operation requires permissions for the lex:DeleteUtterances action.

Parameters

botName (required)

The name of the bot that stored the utterances.

Type: string

userId (required)

The unique identifier for the user that made the utterances. This is the user ID that was sent in the PostContent or PostText operation request that contained the utterance.

Type: string

get_bot

Returns metadata information for a specific bot. You must provide the bot name and the bot version or alias.
This operation requires permissions for the lex:GetBot action.

Parameters

name (required)

The name of the bot. The name is case sensitive.

Type: string

versionoralias (required)

The version or alias of the bot.

Type: string

get_bot_alias

Returns information about an Amazon Lex bot alias. For more information about aliases, see versioning-aliases.
This operation requires permissions for the lex:GetBotAlias action.

Parameters

botName (required)

The name of the bot.

Type: string

name (required)

The name of the bot alias. The name is case sensitive.

Type: string

get_bot_aliases

Returns a list of aliases for a specified Amazon Lex bot.
This operation requires permissions for the lex:GetBotAliases action.

Parameters

botName (required)

The name of the bot.

Type: string

nameContains

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

Type: string

get_bot_channel_association

Returns information about the association between an Amazon Lex bot and a messaging platform.
This operation requires permissions for the lex:GetBotChannelAssociation action.

Parameters

aliasName (required)

An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.

Type: string

botName (required)

The name of the Amazon Lex bot.

Type: string

name (required)

The name of the association between the bot and the channel. The name is case sensitive.

Type: string

get_bot_channel_associations

Returns a list of all of the channels associated with the specified bot.
The GetBotChannelAssociations operation requires permissions for the lex:GetBotChannelAssociations action.

Parameters

aliasName (required)

An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.

Type: string

botName (required)

The name of the Amazon Lex bot in the association.

Type: string

nameContains

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." To return all bot channel associations, use a hyphen ("-") as the nameContains parameter.

Type: string

get_bot_versions

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.
This operation requires permissions for the lex:GetBotVersions action.

Parameters

name (required)

The name of the bot for which versions should be returned.

Type: string

get_bots

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.

Parameters

nameContains

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

Type: string

get_builtin_intent

Returns information about a built-in intent.
This operation requires permission for the lex:GetBuiltinIntent action.

Parameters

signature (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.

Type: string

get_builtin_intents

Gets a list of built-in intents that meet the specified criteria.
This operation requires permission for the lex:GetBuiltinIntents action.

Parameters

locale

A list of locales that the intent supports.

Type: string

Potential values: en-US, en-GB, de-DE

signatureContains

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.

Type: string

get_builtin_slot_types

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.

Parameters

locale

A list of locales that the slot type supports.

Type: string

Potential values: en-US, en-GB, de-DE

signatureContains

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

Type: string

get_export

Exports the contents of a Amazon Lex resource in a specified format.

Parameters

exportType (required)

The format of the exported data.

Type: string

Potential values: ALEXA_SKILLS_KIT, LEX

name (required)

The name of the bot to export.

Type: string

resourceType (required)

The type of resource to export.

Type: string

Potential values: BOT, INTENT, SLOT_TYPE

version (required)

The version of the bot to export.

Type: string

get_import

Gets information about an import job started with the StartImport operation.

Parameters

importId (required)

The identifier of the import job information to return.

Type: string

get_intent

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.

Parameters

name (required)

The name of the intent. The name is case sensitive.

Type: string

version (required)

The version of the intent.

Type: string

get_intent_versions

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.
This operation requires permissions for the lex:GetIntentVersions action.

Parameters

name (required)

The name of the intent for which versions should be returned.

Type: string

get_intents

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.

Parameters

nameContains

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

Type: string

get_slot_type

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.

Parameters

name (required)

The name of the slot type. The name is case sensitive.

Type: string

version (required)

The version of the slot type.

Type: string

get_slot_type_versions

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.
This operation requires permissions for the lex:GetSlotTypeVersions action.

Parameters

name (required)

The name of the slot type for which versions should be returned.

Type: string

get_slot_types

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.

Parameters

nameContains

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

Type: string

get_utterances_view

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.
Utterance statistics are generated once a day. Data is available for the last 15 days. 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.
This operation requires permissions for the lex:GetUtterancesView action.

Parameters

bot_versions (required)

An array of bot versions for which utterance information should be returned. The limit is 5 versions per request.

Type: array

[ "string" ]

botname (required)

The name of the bot for which utterance information should be returned.

Type: string

status_type (required)

To return utterances that were recognized and handled, useDetected. To return utterances that were not recognized, use Missed.

Type: string

Potential values: Detected, Missed

put_bot

Creates an Amazon Lex conversational bot or replaces an existing bot. When you create or update a bot you are only required to specify a name, a locale, and whether the bot is directed toward children under age 13. You can use this to add intents later, or to remove intents from an existing bot. When you create a bot with the minimum information, 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.

Parameters

name (required)

The name of the bot. The name is not case sensitive.

Type: string

$body

Type: object

{
"createVersion" : "boolean",
"intents" : [ {
"intentName" : "The name of the intent.",
"intentVersion" : "The version of the intent."
} ],
"voiceId" : "The Amazon Polly 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 Available Voices in the Amazon Polly Developer Guide.",
"clarificationPrompt" : {
"maxAttempts" : "The number of times to prompt the user for information.",
"responseCard" : "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. ",
"messages" : [ {
"contentType" : "The content type of the message string.",
"groupNumber" : "Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.",
"content" : "The text of the message."
} ]
},
"processBehavior" : "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. \nIf you don't specify this value, the default value is BUILD.",
"checksum" : "Identifies a specific revision of the $LATEST version. \nWhen you create a new bot, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception. \nWhen 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.",
"description" : "A description of the bot.",
"idleSessionTTLInSeconds" : "The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. \nA 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. \nFor 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. \nIf 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. \nThe default is 300 seconds (5 minutes).",
"childDirected" : "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. \nIf 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. ",
"locale" : " Specifies the target locale for the bot. Any intent used in the bot must be compatible with the locale of the bot. \nThe default is en-US.",
"abortStatement" : {
"responseCard" : " At runtime, if the client is using the PostText 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. ",
"messages" : [ {
"contentType" : "The content type of the message string.",
"groupNumber" : "Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.",
"content" : "The text of the message."
} ]
}
}

put_bot_alias

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.

Parameters

botName (required)

The name of the bot.

Type: string

name (required)

The name of the alias. The name is not case sensitive.

Type: string

$body

Type: object

{
"checksum" : "Identifies a specific revision of the $LATEST version. \nWhen you create a new bot alias, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception. \nWhen 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.",
"description" : "A description of the alias.",
"botVersion" : "The version of the bot."
}

put_intent

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 intent 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. When you update the $LATEST version of an intent, the status field of any bot that uses the $LATEST version of the intent is set to NOT_BUILT.
For more information, see how-it-works.
This operation requires permissions for the lex:PutIntent action.

Parameters

name (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.

Type: string

$body

Type: object

{
"createVersion" : "boolean",
"sampleUtterances" : [ "string" ],
"slots" : [ {
"valueElicitationPrompt" : {
"maxAttempts" : "The number of times to prompt the user for information.",
"responseCard" : "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. ",
"messages" : [ {
"contentType" : "The content type of the message string.",
"groupNumber" : "Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.",
"content" : "The text of the message."
} ]
},
"sampleUtterances" : [ "string" ],
"responseCard" : " 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. ",
"slotConstraint" : "Specifies whether the slot is required or optional. ",
"slotType" : "The type of the slot, either a custom slot type that you defined or one of the built-in slot types.",
"slotTypeVersion" : "The version of the slot type.",
"name" : "The name of the slot.",
"description" : "A description of the slot.",
"priority" : " Directs Lex the order in which to elicit this slot value from the user. For example, if the intent has two slots with priorities 1 and 2, AWS Lex first elicits a value for the slot with priority 1. \nIf multiple slots share the same priority, the order in which Lex elicits values is arbitrary."
} ],
"rejectionStatement" : {
"responseCard" : " At runtime, if the client is using the PostText 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. ",
"messages" : [ {
"contentType" : "The content type of the message string.",
"groupNumber" : "Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.",
"content" : "The text of the message."
} ]
},
"parentIntentSignature" : "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.",
"conclusionStatement" : {
"responseCard" : " At runtime, if the client is using the PostText 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. ",
"messages" : [ {
"contentType" : "The content type of the message string.",
"groupNumber" : "Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.",
"content" : "The text of the message."
} ]
},
"confirmationPrompt" : {
"maxAttempts" : "The number of times to prompt the user for information.",
"responseCard" : "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. ",
"messages" : [ {
"contentType" : "The content type of the message string.",
"groupNumber" : "Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.",
"content" : "The text of the message."
} ]
},
"checksum" : "Identifies a specific revision of the $LATEST version. \nWhen you create a new intent, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception. \nWhen 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.",
"description" : "A description of the intent.",
"dialogCodeHook" : {
"messageVersion" : "The version of the request-response that you want Amazon Lex to use to invoke your Lambda function. For more information, see using-lambda.",
"uri" : "The Amazon Resource Name (ARN) of the Lambda function."
},
"followUpPrompt" : {
"rejectionStatement" : {
"responseCard" : " At runtime, if the client is using the PostText 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. ",
"messages" : [ {
"contentType" : "The content type of the message string.",
"groupNumber" : "Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.",
"content" : "The text of the message."
} ]
},
"prompt" : {
"maxAttempts" : "The number of times to prompt the user for information.",
"responseCard" : "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. ",
"messages" : [ {
"contentType" : "The content type of the message string.",
"groupNumber" : "Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.",
"content" : "The text of the message."
} ]
}
},
"fulfillmentActivity" : {
"type" : " How the intent should be fulfilled, either by running a Lambda function or by returning the slot data to the client application. ",
"codeHook" : {
"messageVersion" : "The version of the request-response that you want Amazon Lex to use to invoke your Lambda function. For more information, see using-lambda.",
"uri" : "The Amazon Resource Name (ARN) of the Lambda function."
}
}
}

put_slot_type

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. When you update the $LATEST version of a slot type, if a bot uses the $LATEST version of an intent that contains the slot type, the bot's status field is set to NOT_BUILT.
This operation requires permissions for the lex:PutSlotType action.

Parameters

name (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.

Type: string

$body

Type: object

{
"valueSelectionStrategy" : "Determines the slot resolution strategy that Amazon Lex uses to return slot type values. The field can be set to one of the following values: \n ORIGINAL_VALUE - Returns the value entered by the user, if the user value is similar to the slot value. \n TOP_RESOLUTION - If there is a resolution list for the slot, return the first value in the resolution list as the slot type value. If there is no resolution list, null is returned. \nIf you don't specify the valueSelectionStrategy, the default is ORIGINAL_VALUE.",
"createVersion" : "boolean",
"checksum" : "Identifies a specific revision of the $LATEST version. \nWhen you create a new slot type, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception. \nWhen 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.",
"description" : "A description of the slot type.",
"enumerationValues" : [ {
"synonyms" : [ "string" ],
"value" : "The value of the slot type."
} ]
}

start_import

Starts a job to import a resource to Amazon Lex.

Parameters

$body

Type: object

{
"payload" : "A zip archive in binary format. The archive should contain one file, a JSON file containing the resource to import. The resource should match the type specified in the resourceType field.",
"mergeStrategy" : "Specifies the action that the StartImport operation should take when there is an existing resource with the same name. \n FAIL_ON_CONFLICT - The import operation is stopped on the first conflict between a resource in the import file and an existing resource. The name of the resource causing the conflict is in the failureReason field of the response to the GetImport operation. OVERWRITE_LATEST - The import operation proceeds even if there is a conflict with an existing resource. The $LASTEST version of the existing resource is overwritten with the data from the import file. ",
"resourceType" : "Specifies the type of resource to export. Each resource also exports any resources that it depends on. \n A bot exports dependent intents. \n An intent exports dependent slot types. "
}