String name
The name of the bot alias.
String description
A description of the bot alias.
String botVersion
The version of the Amazon Lex bot to which the alias points.
String botName
The name of the bot to which the alias points.
Date lastUpdatedDate
The date that the bot alias was updated. When you create a resource, the creation date and last updated date are the same.
Date createdDate
The date that the bot alias was created.
String checksum
Checksum of the bot alias.
ConversationLogsResponse conversationLogs
Settings that determine how Amazon Lex uses conversation logs for the alias.
String name
The name of the association between the bot and the channel.
String description
A text description of the association you are creating.
String botAlias
An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.
String botName
The name of the Amazon Lex bot to which this association is being made.
Currently, Amazon Lex supports associations with Facebook and Slack, and Twilio.
Date createdDate
The date that the association between the Amazon Lex bot and the channel was created.
String type
Specifies the type of association by indicating the type of channel being established between the Amazon Lex bot and the external messaging platform.
Map<K,V> botConfiguration
Provides information necessary to communicate with the messaging platform.
String status
The status of the bot channel.
CREATED - The channel has been created and is ready for use.
IN_PROGRESS - Channel creation is in progress.
FAILED - There was an error creating the channel. For information about the reason for the failure,
see the failureReason field.
String failureReason
If status is FAILED, Amazon Lex provides the reason that it failed to create the
association.
String name
The name of the bot.
String description
A description of the bot.
String status
The status of the bot.
Date lastUpdatedDate
The date that the bot was updated. When you create a bot, the creation date and last updated date are the same.
Date createdDate
The date that the bot was created.
String version
The version of the bot. For a new bot, the version is always $LATEST.
String signature
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.
List<E> supportedLocales
A list of identifiers for the locales that the intent supports.
String name
A list of the slots defined for the intent.
String signature
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.
List<E> supportedLocales
A list of target locales for the slot.
String uri
The Amazon Resource Name (ARN) of the Lambda function.
String 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.
List<E> logSettings
The settings for your conversation logs. You can log the conversation text, conversation audio, or both.
String iamRoleArn
The Amazon Resource Name (ARN) of an IAM role with permission to write to your CloudWatch Logs for text logs and your S3 bucket for audio logs. If audio encryption is enabled, this role also provides access permission for the AWS KMS key used for encrypting audio logs. For more information, see Creating an IAM Role and Policy for Conversation Logs.
String name
The name of the bot that you want to create a new version of. The name is case sensitive.
String 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.
String name
The name of the bot.
String description
A description of the bot.
List<E> intents
An array of Intent objects. For more information, see PutBot.
Prompt clarificationPrompt
The message that Amazon Lex uses when it doesn't understand the user's request. For more information, see PutBot.
Statement abortStatement
The message that Amazon Lex uses to abort a conversation. For more information, see PutBot.
String status
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.
String failureReason
If status is FAILED, Amazon Lex provides the reason that it failed to build the bot.
Date lastUpdatedDate
The date when the $LATEST version of this bot was updated.
Date createdDate
The date when the bot version was created.
Integer idleSessionTTLInSeconds
The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot.
String voiceId
The Amazon Polly voice ID that Amazon Lex uses for voice interactions with the user.
String checksum
Checksum identifying the version of the bot that was created.
String version
The version of the bot.
String locale
Specifies the target locale for the bot.
Boolean 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.
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.
Boolean detectSentiment
Indicates whether utterances entered by the user should be sent to Amazon Comprehend for sentiment analysis.
String name
The name of the intent that you want to create a new version of. The name is case sensitive.
String 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.
String name
The name of the intent.
String description
A description of the intent.
List<E> slots
An array of slot types that defines the information required to fulfill the intent.
List<E> sampleUtterances
An array of sample utterances configured for the intent.
Prompt confirmationPrompt
If defined, the prompt that Amazon Lex uses to confirm the user's intent before fulfilling it.
Statement rejectionStatement
If the user answers "no" to the question defined in confirmationPrompt, Amazon Lex responds with
this statement to acknowledge that the intent was canceled.
FollowUpPrompt followUpPrompt
If defined, Amazon Lex uses this prompt to solicit additional user activity after the intent is fulfilled.
Statement conclusionStatement
After the Lambda function specified in the fulfillmentActivity field fulfills the intent, Amazon Lex
conveys this statement to the user.
CodeHook dialogCodeHook
If defined, Amazon Lex invokes this Lambda function for each user input.
FulfillmentActivity fulfillmentActivity
Describes how the intent is fulfilled.
String parentIntentSignature
A unique identifier for a built-in intent.
Date lastUpdatedDate
The date that the intent was updated.
Date createdDate
The date that the intent was created.
String version
The version number assigned to the new version of the intent.
String checksum
Checksum of the intent version created.
String name
The name of the slot type that you want to create a new version for. The name is case sensitive.
String 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.
String name
The name of the slot type.
String description
A description of the slot type.
List<E> enumerationValues
A list of EnumerationValue objects that defines the values that the slot type can take.
Date lastUpdatedDate
The date that the slot type was updated. When you create a resource, the creation date and last update date are the same.
Date createdDate
The date that the slot type was created.
String version
The version assigned to the new slot type version.
String checksum
Checksum of the $LATEST version of the slot type.
String valueSelectionStrategy
The strategy that Amazon Lex uses to determine the value of the slot. For more information, see PutSlotType.
String name
The name of the bot. The name is case sensitive.
String name
The name of the intent. The name is case sensitive.
String name
The name of the intent.
String version
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.
String name
The name of the slot type. The name is case sensitive.
String name
The name of the slot type.
String version
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.
String botName
The name of the bot that stored the utterances.
String userId
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.
String botName
The name of the bot.
String nextToken
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 maxResults
The maximum number of aliases to return in the response. The default is 50. .
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."
List<E> botAliases
An array of BotAliasMetadata objects, each describing a bot alias.
String nextToken
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.
String name
The name of the bot alias.
String description
A description of the bot alias.
String botVersion
The version of the bot that the alias points to.
String botName
The name of the bot that the alias points to.
Date lastUpdatedDate
The date that the bot alias was updated. When you create a resource, the creation date and the last updated date are the same.
Date createdDate
The date that the bot alias was created.
String checksum
Checksum of the bot alias.
ConversationLogsResponse conversationLogs
The settings that determine how Amazon Lex uses conversation logs for the alias.
String name
The name of the association between the bot and the channel.
String description
A description of the association between the bot and the channel.
String botAlias
An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.
String botName
The name of the Amazon Lex bot.
Date createdDate
The date that the association between the bot and the channel was created.
String type
The type of the messaging platform.
Map<K,V> botConfiguration
Provides information that the messaging platform needs to communicate with the Amazon Lex bot.
String status
The status of the bot channel.
CREATED - The channel has been created and is ready for use.
IN_PROGRESS - Channel creation is in progress.
FAILED - There was an error creating the channel. For information about the reason for the failure,
see the failureReason field.
String failureReason
If status is FAILED, Amazon Lex provides the reason that it failed to create the
association.
String botName
The name of the Amazon Lex bot in the association.
String botAlias
An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.
String nextToken
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 maxResults
The maximum number of associations to return in the response. The default is 50.
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.
List<E> botChannelAssociations
An array of objects, one for each association, that provides information about the Amazon Lex bot and its association with the channel.
String nextToken
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.
String name
The name of the bot.
String description
A description of the bot.
List<E> intents
An array of intent objects. For more information, see PutBot.
Prompt clarificationPrompt
The message Amazon Lex uses when it doesn't understand the user's request. For more information, see PutBot.
Statement abortStatement
The message that Amazon Lex returns when the user elects to end the conversation without completing it. For more information, see PutBot.
String status
The status of the bot.
When the status is BUILDING Amazon Lex is building the bot for testing and use.
If the status of the bot is READY_BASIC_TESTING, you can test the bot using the exact utterances
specified in the bot's intents. When the bot is ready for full testing or to run, the status is
READY.
If there was a problem with building the bot, the status is FAILED and the
failureReason field explains why the bot did not build.
If the bot was saved but not built, the status is NOT_BUILT.
String failureReason
If status is FAILED, Amazon Lex explains why it failed to build the bot.
Date lastUpdatedDate
The date that the bot was updated. When you create a resource, the creation date and last updated date are the same.
Date createdDate
The date that the bot was created.
Integer idleSessionTTLInSeconds
The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot.
String voiceId
The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see PutBot.
String checksum
Checksum of the bot used to identify a specific revision of the bot's $LATEST version.
String version
The version of the bot. For a new bot, the version is always $LATEST.
String locale
The target locale for the bot.
Boolean 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.
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.
Boolean detectSentiment
Indicates whether user utterances should be sent to Amazon Comprehend for sentiment analysis.
String nextToken
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 maxResults
The maximum number of bots to return in the response that the request will return. The default is 10.
String 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."
String name
The name of the bot for which versions should be returned.
String nextToken
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 maxResults
The maximum number of bot versions to return in the response. The default is 10.
List<E> bots
An array of BotMetadata objects, one for each numbered version of the bot plus one for the
$LATEST version.
String nextToken
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.
String signature
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.
String locale
A list of locales that the intent supports.
String 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.
String nextToken
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 maxResults
The maximum number of intents to return in the response. The default is 10.
List<E> intents
An array of builtinIntentMetadata objects, one for each intent in the response.
String nextToken
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.
String locale
A list of locales that the slot type supports.
String 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."
String nextToken
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 maxResults
The maximum number of slot types to return in the response. The default is 10.
String name
The name of the bot being exported.
String version
The version of the bot being exported.
String resourceType
The type of the exported resource.
String exportType
The format of the exported data.
String exportStatus
The status of the export.
IN_PROGRESS - The export is in progress.
READY - The export is complete.
FAILED - The export could not be completed.
String failureReason
If status is FAILED, Amazon Lex provides the reason that it failed to export the
resource.
String url
An S3 pre-signed URL that provides the location of the exported resource. The exported resource is a ZIP archive that contains the exported resource in JSON format. The structure of the archive may change. Your code should not rely on the archive structure.
String importId
The identifier of the import job information to return.
String name
The name given to the import job.
String resourceType
The type of resource imported.
String mergeStrategy
The action taken when there was a conflict between an existing resource and a resource in the import file.
String importId
The identifier for the specific import job.
String importStatus
The status of the import job. If the status is FAILED, you can get the reason for the failure from
the failureReason field.
List<E> failureReason
A string that describes why an import job failed to complete.
Date createdDate
A timestamp for the date and time that the import job was created.
String name
The name of the intent.
String description
A description of the intent.
List<E> slots
An array of intent slots configured for the intent.
List<E> sampleUtterances
An array of sample utterances configured for the intent.
Prompt confirmationPrompt
If defined in the bot, Amazon Lex uses prompt to confirm the intent before fulfilling the user's request. For more information, see PutIntent.
Statement rejectionStatement
If the user answers "no" to the question defined in confirmationPrompt, Amazon Lex responds with
this statement to acknowledge that the intent was canceled.
FollowUpPrompt followUpPrompt
If defined in the bot, Amazon Lex uses this prompt to solicit additional user activity after the intent is fulfilled. For more information, see PutIntent.
Statement conclusionStatement
After the Lambda function specified in the fulfillmentActivity element fulfills the intent, Amazon
Lex conveys this statement to the user.
CodeHook dialogCodeHook
If defined in the bot, Amazon Amazon Lex invokes this Lambda function for each user input. For more information, see PutIntent.
FulfillmentActivity fulfillmentActivity
Describes how the intent is fulfilled. For more information, see PutIntent.
String parentIntentSignature
A unique identifier for a built-in intent.
Date lastUpdatedDate
The date that the intent was updated. When you create a resource, the creation date and the last updated date are the same.
Date createdDate
The date that the intent was created.
String version
The version of the intent.
String checksum
Checksum of the intent.
String nextToken
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 maxResults
The maximum number of intents to return in the response. The default is 10.
String 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."
String name
The name of the intent for which versions should be returned.
String nextToken
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 maxResults
The maximum number of intent versions to return in the response. The default is 10.
List<E> intents
An array of IntentMetadata objects, one for each numbered version of the intent plus one for the
$LATEST version.
String nextToken
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.
String name
The name of the slot type.
String description
A description of the slot type.
List<E> enumerationValues
A list of EnumerationValue objects that defines the values that the slot type can take.
Date lastUpdatedDate
The date that the slot type was updated. When you create a resource, the creation date and last update date are the same.
Date createdDate
The date that the slot type was created.
String version
The version of the slot type.
String checksum
Checksum of the $LATEST version of the slot type.
String valueSelectionStrategy
The strategy that Amazon Lex uses to determine the value of the slot. For more information, see PutSlotType.
String nextToken
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 maxResults
The maximum number of slot types to return in the response. The default is 10.
String 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."
List<E> slotTypes
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.
String nextToken
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.
String name
The name of the slot type for which versions should be returned.
String nextToken
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 maxResults
The maximum number of slot type versions to return in the response. The default is 10.
List<E> slotTypes
An array of SlotTypeMetadata objects, one for each numbered version of the slot type plus one for
the $LATEST version.
String nextToken
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.
String botName
The name of the bot for which utterance information should be returned.
List<E> botVersions
An array of bot versions for which utterance information should be returned. The limit is 5 versions per request.
String statusType
To return utterances that were recognized and handled, use Detected. To return utterances that were
not recognized, use Missed.
String botName
The name of the bot for which utterance information was returned.
List<E> utterances
An array of UtteranceList objects, each containing a list of UtteranceData objects describing the
utterances that were processed by your bot. The response contains a maximum of 100 UtteranceData
objects for each version. Amazon Lex returns the most frequent utterances received by the bot in the last 15
days.
String name
The name of the intent.
String description
A description of the intent.
Date lastUpdatedDate
The date that the intent was updated. When you create an intent, the creation date and last updated date are the same.
Date createdDate
The date that the intent was created.
String version
The version of the intent.
String retryAfterSeconds
String logType
The type of logging to enable. Text logs are delivered to a CloudWatch Logs log group. Audio logs are delivered to an S3 bucket.
String destination
Where the logs will be delivered. Text logs are delivered to a CloudWatch Logs log group. Audio logs are delivered to an S3 bucket.
String kmsKeyArn
The Amazon Resource Name (ARN) of the AWS KMS customer managed key for encrypting audio logs delivered to an S3 bucket. The key does not apply to CloudWatch Logs and is optional for S3 buckets.
String resourceArn
The Amazon Resource Name (ARN) of the CloudWatch Logs log group or S3 bucket where the logs should be delivered.
String logType
The type of logging that is enabled.
String destination
The destination where logs are delivered.
String kmsKeyArn
The Amazon Resource Name (ARN) of the key used to encrypt audio logs in an S3 bucket.
String resourceArn
The Amazon Resource Name (ARN) of the CloudWatch Logs log group or S3 bucket where the logs are delivered.
String resourcePrefix
The resource prefix is the first part of the S3 object key within the S3 bucket that you specified to contain audio logs. For CloudWatch Logs it is the prefix of the log stream name within the log group that you specified.
String contentType
The content type of the message string.
String content
The text of the message.
Integer 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.
List<E> messages
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).
Integer maxAttempts
The number of times to prompt the user for information.
String 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.
String name
The name of the alias. The name is not case sensitive.
String description
A description of the alias.
String botVersion
The version of the bot.
String botName
The name of the bot.
String checksum
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.
ConversationLogsRequest conversationLogs
Settings for conversation logs for the alias.
String name
The name of the alias.
String description
A description of the alias.
String botVersion
The version of the bot that the alias points to.
String botName
The name of the bot that the alias points to.
Date lastUpdatedDate
The date that the bot alias was updated. When you create a resource, the creation date and the last updated date are the same.
Date createdDate
The date that the bot alias was created.
String checksum
The checksum for the current version of the alias.
ConversationLogsResponse conversationLogs
The settings that determine how Amazon Lex uses conversation logs for the alias.
String name
The name of the bot. The name is not case sensitive.
String description
A description of the bot.
List<E> intents
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.
Prompt clarificationPrompt
When Amazon Lex doesn't understand the user's intent, it uses this message to get clarification. To specify how
many times Amazon Lex should repeat the clarification prompt, use the maxAttempts field. If Amazon
Lex still doesn't understand, it sends the message in the abortStatement field.
When you create a clarification prompt, make sure that it suggests the correct response from the user. for example, for a bot that orders pizza and drinks, you might create this clarification prompt: "What would you like to do? You can say 'Order a pizza' or 'Order a drink.'"
If you have defined a fallback intent, it will be invoked if the clarification prompt is repeated the number of
times defined in the maxAttempts field. For more information, see AMAZON.FallbackIntent.
If you don't define a clarification prompt, at runtime Amazon Lex will return a 400 Bad Request exception in three cases:
Follow-up prompt - When the user responds to a follow-up prompt but does not provide an intent. For example, in response to a follow-up prompt that says "Would you like anything else today?" the user says "Yes." Amazon Lex will return a 400 Bad Request exception because it does not have a clarification prompt to send to the user to get an intent.
Lambda function - When using a Lambda function, you return an ElicitIntent dialog type. Since Amazon
Lex does not have a clarification prompt to get an intent from the user, it returns a 400 Bad Request exception.
PutSession operation - When using the PutSession operation, you send an ElicitIntent
dialog type. Since Amazon Lex does not have a clarification prompt to get an intent from the user, it returns a
400 Bad Request exception.
Statement abortStatement
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.
If you have defined a fallback intent the abort statement will not be sent to the user, the fallback intent is used instead. For more information, see AMAZON.FallbackIntent.
Integer idleSessionTTLInSeconds
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 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 Voices in Amazon Polly in the Amazon Polly Developer Guide.
String checksum
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 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.
If you don't specify this value, the default value is BUILD.
String locale
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 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.
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.
Boolean detectSentiment
When set to true user utterances are sent to Amazon Comprehend for sentiment analysis. If you don't
specify detectSentiment, the default is false.
Boolean createVersion
When set to true a new numbered version of the bot is created. This is the same as calling the
CreateBotVersion operation. If you don't specify createVersion, the default is
false.
String name
The name of the bot.
String description
A description of the bot.
List<E> intents
An array of Intent objects. For more information, see PutBot.
Prompt clarificationPrompt
The prompts that Amazon Lex uses when it doesn't understand the user's intent. For more information, see PutBot.
Statement abortStatement
The message that Amazon Lex uses to abort a conversation. For more information, see PutBot.
String status
When you send a request to create a bot with processBehavior set to BUILD, Amazon Lex
sets the status response element to BUILDING.
In the READY_BASIC_TESTING state you can test the bot with user inputs that exactly match the
utterances configured for the bot's intents and values in the slot types.
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.
When the bot is in the READY state you can test and publish the bot.
String failureReason
If status is FAILED, Amazon Lex provides the reason that it failed to build the bot.
Date lastUpdatedDate
The date that the bot was updated. When you create a resource, the creation date and last updated date are the same.
Date createdDate
The date that the bot was created.
Integer idleSessionTTLInSeconds
The maximum length of time that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot.
String voiceId
The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see PutBot.
String checksum
Checksum of the bot that you created.
String version
The version of the bot. For a new bot, the version is always $LATEST.
String locale
The target locale for the bot.
Boolean 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.
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.
Boolean createVersion
True if a new version of the bot was created. If the createVersion field was not
specified in the request, the createVersion field is set to false in the response.
Boolean detectSentiment
true if the bot is configured to send user utterances to Amazon Comprehend for sentiment analysis.
If the detectSentiment field was not specified in the request, the detectSentiment
field is false in the response.
String name
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 description
A description of the intent.
List<E> slots
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 how-it-works.
List<E> sampleUtterances
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.
Prompt confirmationPrompt
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.
You you must provide both the rejectionStatement and the confirmationPrompt, or
neither.
Statement rejectionStatement
When the user answers "no" to the question defined in confirmationPrompt, Amazon Lex responds with
this statement to acknowledge that the intent was canceled.
You must provide both the rejectionStatement and the confirmationPrompt, or neither.
FollowUpPrompt followUpPrompt
Amazon Lex uses this prompt to solicit additional activity after fulfilling an intent. For example, after the
OrderPizza intent is fulfilled, you might prompt the user to order a drink.
The action that Amazon Lex takes depends on the user's response, as follows:
If the user says "Yes" it responds with the clarification prompt that is configured for the bot.
if the user says "Yes" and continues with an utterance that triggers an intent it starts a conversation for the intent.
If the user says "No" it responds with the rejection statement configured for the the follow-up prompt.
If it doesn't recognize the utterance it repeats the follow-up prompt again.
The followUpPrompt field and the conclusionStatement field are mutually exclusive. You
can specify only one.
Statement conclusionStatement
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.
The followUpPrompt and conclusionStatement are mutually exclusive. You can specify only
one.
CodeHook dialogCodeHook
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.
FulfillmentActivity fulfillmentActivity
Required. 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).
String 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.
String checksum
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.
Boolean createVersion
When set to true a new numbered version of the intent is created. This is the same as calling the
CreateIntentVersion operation. If you do not specify createVersion, the default is
false.
String name
The name of the intent.
String description
A description of the intent.
List<E> slots
An array of intent slots that are configured for the intent.
List<E> sampleUtterances
An array of sample utterances that are configured for the intent.
Prompt confirmationPrompt
If defined in the intent, Amazon Lex prompts the user to confirm the intent before fulfilling it.
Statement rejectionStatement
If the user answers "no" to the question defined in confirmationPrompt Amazon Lex responds with this
statement to acknowledge that the intent was canceled.
FollowUpPrompt followUpPrompt
If defined in the intent, Amazon Lex uses this prompt to solicit additional user activity after the intent is fulfilled.
Statement conclusionStatement
After the Lambda function specified in thefulfillmentActivityintent fulfills the intent, Amazon Lex
conveys this statement to the user.
CodeHook dialogCodeHook
If defined in the intent, Amazon Lex invokes this Lambda function for each user input.
FulfillmentActivity fulfillmentActivity
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.
String parentIntentSignature
A unique identifier for the built-in intent that this intent is based on.
Date lastUpdatedDate
The date that the intent was updated. When you create a resource, the creation date and last update dates are the same.
Date createdDate
The date that the intent was created.
String version
The version of the intent. For a new intent, the version is always $LATEST.
String checksum
Checksum of the $LATESTversion of the intent created or updated.
Boolean createVersion
True if a new version of the intent was created. If the createVersion field was not
specified in the request, the createVersion field is set to false in the response.
String name
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 description
A description of the slot type.
List<E> enumerationValues
A list of EnumerationValue objects that defines the values that the slot type can take. Each value
can have a list of synonyms, which are additional values that help train the machine learning model
about the values that it resolves for a slot.
When Amazon Lex resolves a slot value, it generates a resolution list that contains up to five possible values
for the slot. If you are using a Lambda function, this resolution list is passed to the function. If you are not
using a Lambda function you can choose to return the value that the user entered or the first value in the
resolution list as the slot value. The valueSelectionStrategy field indicates the option to use.
String checksum
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.
String 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:
ORIGINAL_VALUE - Returns the value entered by the user, if the user value is similar to the slot
value.
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.
If you don't specify the valueSelectionStrategy, the default is ORIGINAL_VALUE.
Boolean createVersion
When set to true a new numbered version of the slot type is created. This is the same as calling the
CreateSlotTypeVersion operation. If you do not specify createVersion, the default is
false.
String name
The name of the slot type.
String description
A description of the slot type.
List<E> enumerationValues
A list of EnumerationValue objects that defines the values that the slot type can take.
Date lastUpdatedDate
The date that the slot type was updated. When you create a slot type, the creation date and last update date are the same.
Date createdDate
The date that the slot type was created.
String version
The version of the slot type. For a new slot type, the version is always $LATEST.
String checksum
Checksum of the $LATEST version of the slot type.
String valueSelectionStrategy
The slot resolution strategy that Amazon Lex uses to determine the value of the slot. For more information, see PutSlotType.
Boolean createVersion
True if a new version of the slot type was created. If the createVersion field was not
specified in the request, the createVersion field is set to false in the response.
String referenceType
ResourceReference exampleReference
String name
The name of the slot.
String description
A description of the slot.
String slotConstraint
Specifies whether the slot is required or optional.
String slotType
The type of the slot, either a custom slot type that you defined or one of the built-in slot types.
String slotTypeVersion
The version of the slot type.
Prompt valueElicitationPrompt
The prompt that Amazon Lex uses to elicit the slot value from the user.
Integer 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.
If multiple slots share the same priority, the order in which Lex elicits values is arbitrary.
List<E> sampleUtterances
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
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.
String obfuscationSetting
Determines whether a slot is obfuscated in conversation logs and stored utterances. When you obfuscate a slot, the value is replaced by the slot name in curly braces ({}). For example, if the slot name is "full_name", obfuscated values are replaced with "{full_name}". For more information, see Slot Obfuscation .
String name
The name of the slot type.
String description
A description of the slot type.
Date lastUpdatedDate
The date that the slot type was updated. When you create a resource, the creation date and last updated date are the same.
Date createdDate
The date that the slot type was created.
String version
The version of the slot type.
ByteBuffer 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.
String resourceType
Specifies the type of resource to export. Each resource also exports any resources that it depends on.
A bot exports dependent intents.
An intent exports dependent slot types.
String mergeStrategy
Specifies the action that the StartImport operation should take when there is an existing resource
with the same name.
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.
String name
The name given to the import job.
String resourceType
The type of resource to import.
String mergeStrategy
The action to take when there is a merge conflict.
String importId
The identifier for the specific import job.
String importStatus
The status of the import job. If the status is FAILED, you can get the reason for the failure using
the GetImport operation.
Date createdDate
A timestamp for the date and time that the import job was requested.
String utteranceString
The text that was entered by the user or the text representation of an audio clip.
Integer count
The number of times that the utterance was processed.
Integer distinctUsers
The total number of individuals that used the utterance.
Date firstUtteredDate
The date that the utterance was first recorded.
Date lastUtteredDate
The date that the utterance was last recorded.
String botVersion
The version of the bot that processed the list.
List<E> utterances
One or more UtteranceData objects that contain information about the utterances that have been made to a bot. The maximum number of object is 100.
Copyright © 2020. All rights reserved.