String name
The name of active context.
String audioRecognitionStrategy
Enables using the slot values as a custom vocabulary for recognizing user utterances.
String expectedAgentPrompt
The expected agent prompt for the agent turn in a test set execution.
String actualAgentPrompt
The actual agent prompt for the agent turn in a test set execution.
ExecutionErrorDetails errorDetails
String actualElicitedSlot
The actual elicited slot for the agent turn in a test set execution.
String actualIntent
The actual intent for the agent turn in a test set execution.
String agentPrompt
The agent prompt for the agent turn in a test set.
String name
The name of the field to filter the utterance list.
List<E> values
The value to use for filtering the list of bots.
String operator
The operator to use for the filter. Specify EQ when the ListAggregatedUtterances
operation should return only utterances that equal the specified value. Specify CO when the
ListAggregatedUtterances operation should return utterances that contain the specified value.
String utterance
The text of the utterance. If the utterance was used with the RecognizeUtterance operation, the text
is the transcription of the audio utterance.
Integer hitCount
The number of times that the utterance was detected by Amazon Lex during the time period. When an utterance is detected, it activates an intent or a slot.
Integer missedCount
The number of times that the utterance was missed by Amazon Lex An utterance is missed when it doesn't activate an intent or slot.
Date utteranceFirstRecordedInAggregationDuration
The date and time that the utterance was first recorded in the time window for aggregation. An utterance may have been sent to Amazon Lex before that time, but only utterances within the time window are counted.
Date utteranceLastRecordedInAggregationDuration
The last date and time that an utterance was recorded in the time window for aggregation. An utterance may be sent to Amazon Lex after that time, but only utterances within the time window are counted.
Boolean containsDataFromDeletedResources
Aggregated utterance data may contain utterances from versions of your bot that have since been deleted. When the aggregated contains this kind of data, this field is set to true.
String name
Specifies the time metric by which to bin the analytics data.
String interval
Specifies the interval of time by which to bin the analytics data.
String order
Specifies whether to bin the analytics data in ascending or descending order. If this field is left blank, the default order is by the key of the bin in descending order.
String name
The category by which to filter the intents. The descriptions for each option are as follows:
BotAlias – The name of the bot alias.
BotVersion – The version of the bot.
LocaleId – The locale of the bot.
Modality – The modality of the session with the bot (audio, DTMF, or text).
Channel – The channel that the bot is integrated with.
SessionId – The identifier of the session with the bot.
OriginatingRequestId – The identifier of the first request in a session.
IntentName – The name of the intent.
IntentEndState – The final state of the intent.
String operator
The operation by which to filter the category. The following operations are possible:
CO – Contains
EQ – Equals
GT – Greater than
LT – Less than
The operators that each filter supports are listed below:
BotAlias – EQ.
BotVersion – EQ.
LocaleId – EQ.
Modality – EQ.
Channel – EQ.
SessionId – EQ.
OriginatingRequestId – EQ.
IntentName – EQ, CO.
IntentEndState – EQ, CO.
List<E> values
An array containing the values of the category by which to apply the operator to filter the results. You can
provide multiple values if the operator is EQ or CO. If you provide multiple values,
you filter for results that equal/contain any of the values. For example, if the name,
operator, and values fields are Modality, EQ, and
[Speech, Text], the operation filters for results where the modality was either Speech
or Text.
String name
Specifies whether to group the intent stages by their name or their end state.
String name
The metric for which you want to get intent summary statistics.
Count – The number of times the intent was invoked.
Success – The number of times the intent succeeded.
Failure – The number of times the intent failed.
Switched – The number of times there was a switch to a different intent.
Dropped – The number of times the user dropped the intent.
String statistic
The summary statistic to calculate.
Sum – The total count for the category you provide in name.
Average – The total count divided by the number of intents in the category you provide in
name.
Max – The highest count in the category you provide in name.
String order
Specifies whether to sort the results in ascending or descending order.
String name
The metric that you requested. See Key definitions for more details about these metrics.
Count – The number of times the intent was invoked.
Success – The number of times the intent succeeded.
Failure – The number of times the intent failed.
Switched – The number of times there was a switch to a different intent.
Dropped – The number of times the user dropped the intent.
String statistic
The statistic that you requested to calculate.
Sum – The total count for the category you provide in name.
Average – The total count divided by the number of intents in the category you provide in
name.
Max – The highest count in the category you provide in name.
Double value
The value of the summary statistic for the metric that you requested.
String intentName
The name of the intent at the end of the requested path.
String intentPath
The path.
Integer intentCount
The total number of sessions that follow the given path to the given intent.
Integer intentLevel
The number of intents up to and including the requested path.
String nodeType
Specifies whether the node is the end of a path (Exit) or not (Inner).
List<E> binKeys
A list of objects containing the criteria you requested for binning results and the values of the bins.
List<E> groupByKeys
A list of objects containing the criteria you requested for grouping results and the values of the groups.
List<E> metricsResults
A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
String name
The category by which to filter the intent stages. The descriptions for each option are as follows:
BotAlias – The name of the bot alias.
BotVersion – The version of the bot.
LocaleId – The locale of the bot.
Modality – The modality of the session with the bot (audio, DTMF, or text).
Channel – The channel that the bot is integrated with.
SessionId – The identifier of the session with the bot.
OriginatingRequestId – The identifier of the first request in a session.
IntentName – The name of the intent.
IntentStageName – The stage in the intent.
String operator
The operation by which to filter the category. The following operations are possible:
CO – Contains
EQ – Equals
GT – Greater than
LT – Less than
The operators that each filter supports are listed below:
BotAlias – EQ.
BotVersion – EQ.
LocaleId – EQ.
Modality – EQ.
Channel – EQ.
SessionId – EQ.
OriginatingRequestId – EQ.
IntentName – EQ, CO.
IntentStageName – EQ, CO.
List<E> values
An array containing the values of the category by which to apply the operator to filter the results. You can
provide multiple values if the operator is EQ or CO. If you provide multiple values,
you filter for results that equal/contain any of the values. For example, if the name,
operator, and values fields are Modality, EQ, and
[Speech, Text], the operation filters for results where the modality was either Speech
or Text.
String name
Specifies whether to group the intent stages by their name or the intent to which the session was switched.
String name
The metric for which you want to get intent stage summary statistics. See Key definitions for more details about these metrics.
Count – The number of times the intent stage occurred.
Success – The number of times the intent stage succeeded.
Failure – The number of times the intent stage failed.
Dropped – The number of times the user dropped the intent stage.
Retry – The number of times the bot tried to elicit a response from the user at this stage.
String statistic
The summary statistic to calculate.
Sum – The total count for the category you provide in name.
Average – The total count divided by the number of intent stages in the category you provide in
name.
Max – The highest count in the category you provide in name.
String order
Specifies whether to sort the results in ascending or descending order of the summary statistic (
value in the response).
String name
The metric that you requested.
Count – The number of times the intent stage occurred.
Success – The number of times the intent stage succeeded.
Failure – The number of times the intent stage failed.
Dropped – The number of times the user dropped the intent stage.
Retry – The number of times the bot tried to elicit a response from the user at this stage.
String statistic
The summary statistic that you requested to calculate.
Sum – The total count for the category you provide in name.
Average – The total count divided by the number of intent stages in the category you provide in
name.
Max – The highest count in the category you provide in name.
Double value
The value of the summary statistic for the metric that you requested.
List<E> binKeys
A list of objects containing the criteria you requested for binning results and the values of the bins.
List<E> groupByKeys
A list of objects containing the criteria you requested for grouping results and the values of the bins.
List<E> metricsResults
A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
String name
The category by which to filter the intent paths. The descriptions for each option are as follows:
BotAlias – The name of the bot alias.
BotVersion – The version of the bot.
LocaleId – The locale of the bot.
Modality – The modality of the session with the bot (audio, DTMF, or text).
Channel – The channel that the bot is integrated with.
String operator
The operation by which to filter the category. The following operations are possible:
CO – Contains
EQ – Equals
GT – Greater than
LT – Less than
The operators that each filter supports are listed below:
BotAlias – EQ.
BotVersion – EQ.
LocaleId – EQ.
Modality – EQ.
Channel – EQ.
List<E> values
An array containing the values of the category by which to apply the operator to filter the results. You can
provide multiple values if the operator is EQ or CO. If you provide multiple values,
you filter for results that equal/contain any of the values. For example, if the name,
operator, and values fields are Modality, EQ, and
[Speech, Text], the operation filters for results where the modality was either Speech
or Text.
String name
The category by which to filter the sessions. The descriptions for each option are as follows:
BotAlias – The name of the bot alias.
BotVersion – The version of the bot.
LocaleId – The locale of the bot.
Modality – The modality of the session with the bot (audio, DTMF, or text).
Channel – The channel that the bot is integrated with.
Duration – The duration of the session.
conversationEndState – The final state of the session.
SessionId – The identifier of the session with the bot.
OriginatingRequestId – The identifier of the first request in a session.
IntentPath – The order of intents taken in a session.
String operator
The operation by which to filter the category. The following operations are possible:
CO – Contains
EQ – Equals
GT – Greater than
LT – Less than
The operators that each filter supports are listed below:
BotAlias – EQ.
BotVersion – EQ.
LocaleId – EQ.
Modality – EQ.
Channel – EQ.
Duration – EQ, GT, LT.
conversationEndState – EQ, CO.
SessionId – EQ.
OriginatingRequestId – EQ.
IntentPath – EQ.
List<E> values
An array containing the values of the category by which to apply the operator to filter the results. You can
provide multiple values if the operator is EQ or CO. If you provide multiple values,
you filter for results that equal/contain any of the values. For example, if the name,
operator, and values fields are Modality, EQ, and
[Speech, Text], the operation filters for results where the modality was either Speech
or Text.
String name
Specifies whether to group the session by their end state or their locale.
String name
The metric for which you want to get session summary statistics.
Count – The number of sessions.
Success – The number of sessions that succeeded.
Failure – The number of sessions that failed.
Dropped – The number of sessions that the user dropped.
Duration – The duration of sessions.
TurnsPerSession – The number of turns in the sessions.
Concurrency – The number of sessions occurring in the same period of time.
String statistic
The summary statistic to calculate.
Sum – The total count for the category you provide in name.
Average – The total count divided by the number of sessions in the category you provide in
name.
Max – The highest count in the category you provide in name.
String order
Specifies whether to sort the results in ascending or descending order.
String name
The metric that you requested.
Count – The number of sessions.
Success – The number of sessions that succeeded.
Failure – The number of sessions that failed.
Dropped – The number of sessions that the user dropped.
Duration – The duration of sessions.
TurnPersession – The number of turns in the sessions.
Concurrency – The number of sessions occurring in the same period of time.
String statistic
The summary statistic that you requested to calculate.
Sum – The total count for the category you provide in name.
Average – The total count divided by the number of sessions in the category you provide in
name.
Max – The highest count in the category you provide in name.
Double value
The value of the summary statistic for the metric that you requested.
List<E> binKeys
A list of objects containing the criteria you requested for binning results and the values of the bins.
List<E> groupByKeys
A list of objects containing the criteria you requested for grouping results and the values of the bins.
List<E> metricsResults
A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
String name
An attribute to return. The only available attribute is the intent that the bot mapped the utterance to.
String lastUsedIntent
The intent that the bot mapped the utterance to.
String name
The category by which to filter the utterances. The descriptions for each option are as follows:
BotAlias – The name of the bot alias.
BotVersion – The version of the bot.
LocaleId – The locale of the bot.
Modality – The modality of the session with the bot (audio, DTMF, or text).
Channel – The channel that the bot is integrated with.
SessionId – The identifier of the session with the bot.
OriginatingRequestId – The identifier of the first request in a session.
UtteranceState – The state of the utterance.
UtteranceText – The text in the utterance.
String operator
The operation by which to filter the category. The following operations are possible:
CO – Contains
EQ – Equals
GT – Greater than
LT – Less than
The operators that each filter supports are listed below:
BotAlias – EQ.
BotVersion – EQ.
LocaleId – EQ.
Modality – EQ.
Channel – EQ.
SessionId – EQ.
OriginatingRequestId – EQ.
UtteranceState – EQ.
UtteranceText – EQ, CO.
List<E> values
An array containing the values of the category by which to apply the operator to filter the results. You can
provide multiple values if the operator is EQ or CO. If you provide multiple values,
you filter for results that equal/contain any of the values. For example, if the name,
operator, and values fields are Modality, EQ, and
[Speech, Text], the operation filters for results where the modality was either Speech
or Text.
String name
Specifies whether to group the utterances by their text or their state.
String name
The metric for which you want to get utterance summary statistics.
Count – The number of utterances.
Missed – The number of utterances that Amazon Lex failed to recognize.
Detected – The number of utterances that Amazon Lex managed to detect.
UtteranceTimestamp – The date and time of the utterance.
String statistic
The summary statistic to calculate.
Sum – The total count for the category you provide in name.
Average – The total count divided by the number of utterances in the category you provide in
name.
Max – The highest count in the category you provide in name.
String order
Specifies whether to sort the results in ascending or descending order.
String name
The metric that you requested.
Count – The number of utterances.
Missed – The number of utterances that Amazon Lex failed to recognize.
Detected – The number of utterances that Amazon Lex managed to detect.
UtteranceTimestamp – The date and time of the utterance.
String statistic
The summary statistic that you requested to calculate.
Sum – The total count for the category you provide in name.
Average – The total count divided by the number of utterances in the category you provide in
name.
Max – The highest count in the category you provide in name.
Double value
The value of the summary statistic for the metric that you requested.
List<E> binKeys
A list of objects containing the criteria you requested for binning results and the values of the bins.
List<E> groupByKeys
A list of objects containing the criteria you requested for grouping results and the values of the bins.
List<E> metricsResults
A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
List<E> attributeResults
A list of objects containing information about the last used intent at the time of an utterance.
String transcript
The content of the transcript that meets the search filter criteria. For the JSON format of the transcript, see Output transcript format.
Integer startTimeoutMs
Time for which a bot waits before assuming that the customer isn't going to speak or press a key. This timeout is shared between Audio and DTMF inputs.
AudioSpecification audioSpecification
Specifies the settings on audio input.
DTMFSpecification dtmfSpecification
Specifies the settings on DTMF input.
S3BucketLogDestination s3Bucket
The Amazon S3 bucket where the audio log files are stored. The IAM role specified in the roleArn
parameter of the CreateBot
operation must have permission to write to this bucket.
Boolean enabled
Determines whether audio logging in enabled for the bot.
AudioLogDestination destination
Boolean selectiveLoggingEnabled
The option to enable selective conversation log capture for audio.
String botId
The identifier of the bot associated with this custom vocabulary.
String botVersion
The identifier of the version of the bot associated with this custom vocabulary.
String localeId
The identifier of the language and locale where this custom vocabulary is used. The string must match one of the supported locales. For more information, see Supported Languages .
List<E> customVocabularyItemList
A list of new custom vocabulary items. Each entry must contain a phrase and can optionally contain a displayAs and/or a weight.
String botId
The identifier of the bot associated with this custom vocabulary.
String botVersion
The identifier of the version of the bot associated with this custom vocabulary.
String localeId
The identifier of the language and locale where this custom vocabulary is used. The string must match one of the supported locales. For more information, see Supported Languages .
List<E> errors
A list of custom vocabulary items that failed to create during the operation. The reason for the error is contained within each error object.
List<E> resources
A list of custom vocabulary items that were successfully created during the operation.
String botId
The identifier of the bot associated with this custom vocabulary.
String botVersion
The identifier of the version of the bot associated with this custom vocabulary.
String localeId
The identifier of the language and locale where this custom vocabulary is used. The string must match one of the supported locales. For more information, see Supported Languages .
List<E> customVocabularyItemList
A list of custom vocabulary items requested to be deleted. Each entry must contain the unique custom vocabulary entry identifier.
String botId
The identifier of the bot associated with this custom vocabulary.
String botVersion
The identifier of the version of the bot associated with this custom vocabulary.
String localeId
The identifier of the language and locale where this custom vocabulary is used. The string must match one of the supported locales. For more information, see Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).
List<E> errors
A list of custom vocabulary items that failed to delete during the operation. The reason for the error is contained within each error object.
List<E> resources
A list of custom vocabulary items that were successfully deleted during the operation.
String botId
The identifier of the bot associated with this custom vocabulary
String botVersion
The identifier of the version of the bot associated with this custom vocabulary.
String localeId
The identifier of the language and locale where this custom vocabulary is used. The string must match one of the supported locales. For more information, see Supported Languages .
List<E> customVocabularyItemList
A list of custom vocabulary items with updated fields. Each entry must contain a phrase and can optionally contain a displayAs and/or a weight.
String botId
The identifier of the bot associated with this custom vocabulary.
String botVersion
The identifier of the version of the bot associated with this custom vocabulary.
String localeId
The identifier of the language and locale where this custom vocabulary is used. The string must match one of the supported locales. For more information, see Supported Languages .
List<E> errors
A list of custom vocabulary items that failed to update during the operation. The reason for the error is contained within each error object.
List<E> resources
A list of custom vocabulary items that were successfully updated during the operation.
String modelArn
The ARN of the foundation model used in descriptive bot building.
Boolean enabled
Determines whether the locale is enabled for the bot. If the value is false, the locale isn't
available for use.
CodeHookSpecification codeHookSpecification
Specifies the Lambda function that should be used in the locale.
String botAliasId
The unique identifier assigned to the bot alias. You can use this ID to get detailed information about the alias using the DescribeBotAlias operation.
String botAliasName
The name of the bot alias.
String description
The description of the bot alias.
String botVersion
The version of the bot that the bot alias references.
String botAliasStatus
The current state of the bot alias. If the status is Available, the alias is ready for use.
Date creationDateTime
A timestamp of the date and time that the bot alias was created.
Date lastUpdatedDateTime
A timestamp of the date and time that the bot alias was last updated.
String name
The name of the field to filter the list of bots.
List<E> values
The value to use for filtering the list of bots.
String operator
The operator to use for the filter. Specify EQ when the ListBots operation should
return only aliases that equal the specified value. Specify CO when the ListBots
operation should return aliases that contain the specified value.
String botName
The name that Amazon Lex should use for the bot.
String roleArn
The Amazon Resource Name (ARN) of the IAM role used to build and run the bot.
DataPrivacy dataPrivacy
Integer idleSessionTTLInSeconds
The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.
A user interaction 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.
You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.
Map<K,V> botTags
A list of tags to add to the bot. You can only add tags when you import a bot. You can't use the
UpdateBot operation to update tags. To update tags, use the TagResource operation.
Map<K,V> testBotAliasTags
A list of tags to add to the test alias for a bot. You can only add tags when you import a bot. You can't use the
UpdateAlias operation to update tags. To update tags on the test alias, use the
TagResource operation.
String name
The name of the field to filter the list of bots.
List<E> values
The value to use for filtering the list of bots.
String operator
The operator to use for the filter. Specify EQ when the ListBotLocales operation should
return only aliases that equal the specified value. Specify CO when the ListBotLocales
operation should return aliases that contain the specified value.
String botId
The identifier of the bot to import the locale to.
String botVersion
The version of the bot to import the locale to. This can only be the DRAFT version of the bot.
String localeId
The identifier of the language and locale that the bot will be used in. The string must match one of the supported locales. All of the intents, slot types, and slots used in the bot must have the same locale. For more information, see Supported languages.
Double nluIntentConfidenceThreshold
Determines the threshold where Amazon Lex will insert the AMAZON.FallbackIntent,
AMAZON.KendraSearchIntent, or both when returning alternative intents.
AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they are
configured for the bot.
For example, suppose a bot is configured with the confidence threshold of 0.80 and the
AMAZON.FallbackIntent. Amazon Lex returns three alternative intents with the following confidence
scores: IntentA (0.70), IntentB (0.60), IntentC (0.50). The response from the PostText operation
would be:
AMAZON.FallbackIntent
IntentA
IntentB
IntentC
VoiceSettings voiceSettings
String localeId
The language and locale of the bot locale.
String localeName
The name of the bot locale.
String description
The description of the bot locale.
String botLocaleStatus
The current status of the bot locale. When the status is Built the locale is ready for use.
Date lastUpdatedDateTime
A timestamp of the date and time that the bot locale was last updated.
Date lastBuildSubmittedDateTime
A timestamp of the date and time that the bot locale was last built.
String botMemberId
The unique ID of a bot that is a member of this network of bots.
String botMemberName
The unique name of a bot that is a member of this network of bots.
String botMemberAliasId
The alias ID of a bot that is a member of this network of bots.
String botMemberAliasName
The alias name of a bot that is a member of this network of bots.
String botMemberVersion
The version of a bot that is a member of this network of bots.
String botLocaleExportUrl
The presigned URL link of the recommended bot definition.
String associatedTranscriptsUrl
The presigned url link of the associated transcript.
BotRecommendationResultStatistics statistics
The statistical summary of the bot recommendation results.
IntentStatistics intents
Statistical information about about the intents associated with the bot recommendation results.
SlotTypeStatistics slotTypes
Statistical information about the slot types associated with the bot recommendation results.
String botRecommendationStatus
The status of the bot recommendation.
If the status is Failed, then the reasons for the failure are listed in the failureReasons field.
String botRecommendationId
The unique identifier of the bot recommendation to be updated.
Date creationDateTime
A timestamp of the date and time that the bot recommendation was created.
Date lastUpdatedDateTime
A timestamp of the date and time that the bot recommendation was last updated.
String botId
The unique identifier assigned to the bot. Use this ID to get detailed information about the bot with the DescribeBot operation.
String botName
The name of the bot.
String description
The description of the bot.
String botStatus
The current status of the bot. When the status is Available the bot is ready for use.
String latestBotVersion
The latest numerical version in use for the bot.
Date lastUpdatedDateTime
The date and time that the bot was last updated.
String botType
The type of the bot.
String sourceBotVersion
The version of a bot used for a bot locale.
String botName
The name of the bot associated with the version.
String botVersion
The numeric version of the bot, or DRAFT to indicate that this is the version of the bot that can be
updated..
String description
The description of the version.
String botStatus
The status of the bot. When the status is available, the version of the bot is ready for use.
Date creationDateTime
A timestamp of the date and time that the version was created.
String botId
The identifier of the bot to build. The identifier is returned in the response from the CreateBot operation.
String botVersion
The version of the bot to build. This can only be the draft version of the bot.
String localeId
The identifier of the language and locale that the bot will be used in. The string must match one of the supported locales. All of the intents, slot types, and slots used in the bot must have the same locale. For more information, see Supported languages.
String botId
The identifier of the specified bot.
String botVersion
The version of the bot that was built. This is only the draft version of the bot.
String localeId
The language and locale specified of where the bot can be used.
String botLocaleStatus
The bot's build status. When the status is ReadyExpressTesting you can test the bot using the
utterances defined for the intents and slot types. When the status is Built, the bot is ready for
use and can be tested using any utterance.
Date lastBuildSubmittedDateTime
A timestamp indicating the date and time that the bot was last built for this locale.
DescriptiveBotBuilderSpecification descriptiveBotBuilder
An object containing specifications for the descriptive bot building feature.
SampleUtteranceGenerationSpecification sampleUtteranceGeneration
LambdaCodeHook lambdaCodeHook
String expressionString
The expression string that is evaluated.
String name
The name of the branch.
Condition condition
Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
DialogState nextStep
The next step in the conversation.
ResponseSpecification response
Boolean active
Determines whether a conditional branch is active. When active is false, the conditions are not
evaluated.
List<E> conditionalBranches
A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
DefaultConditionalBranch defaultBranch
The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
String intentName
The intents used in the slots list for the slot resolution details.
String slotName
The slot name in the slots list for the slot resolution details.
String matchResult
The number of matching slots used in the slots listings for the slot resolution evaluation.
String conversationId
The conversation Id of the test result evaluation item.
String endToEndResult
The end-to-end success or failure of the test result evaluation item.
String speechTranscriptionResult
The speech transcription success or failure of the test result evaluation item.
List<E> intentClassificationResults
The intent classification of the test result evaluation item.
List<E> slotResolutionResults
The slot success or failure of the test result evaluation item.
String endToEndResult
The selection of matched or mismatched end-to-end status to filter test set results data at the conversation level.
String botId
The bot Id from the conversation logs.
String botAliasId
The bot alias Id from the conversation logs.
String localeId
The locale Id of the conversation log.
ConversationLogsDataSourceFilterBy filter
The filter for the data source of the conversation log.
String botAliasName
The alias to create. The name must be unique for the bot.
String description
A description of the alias. Use this description to help identify the alias.
String botVersion
The version of the bot that this alias points to. You can use the UpdateBotAlias operation to change the bot version associated with the alias.
Map<K,V> botAliasLocaleSettings
Maps configuration information to a specific locale. You can use this parameter to specify a specific Lambda function to run different functions in different locales.
ConversationLogSettings conversationLogSettings
Specifies whether Amazon Lex logs text and audio for a conversation with the bot. When you enable conversation logs, text logs store text input, transcripts of audio input, and associated metadata in Amazon CloudWatch Logs. Audio logs store audio input in Amazon S3.
SentimentAnalysisSettings sentimentAnalysisSettings
String botId
The unique identifier of the bot that the alias applies to.
Map<K,V> tags
A list of tags to add to the bot alias. You can only add tags when you create an alias, you can't use the
UpdateBotAlias operation to update the tags on a bot alias. To update tags, use the
TagResource operation.
String botAliasId
The unique identifier of the bot alias.
String botAliasName
The name specified for the bot alias.
String description
The description specified for the bot alias.
String botVersion
The version of the bot associated with this alias.
Map<K,V> botAliasLocaleSettings
Configuration information for a specific locale.
ConversationLogSettings conversationLogSettings
The conversation log settings specified for the alias.
SentimentAnalysisSettings sentimentAnalysisSettings
String botAliasStatus
The current status of the alias. The alias is first put into the Creating state. When the alias is
ready to be used, it is put into the Available state. You can use the DescribeBotAlias
operation to get the current state of an alias.
String botId
The unique identifier of the bot that this alias applies to.
Date creationDateTime
A Unix timestamp indicating the date and time that the bot alias was created.
Map<K,V> tags
A list of tags associated with the bot alias.
String botId
The identifier of the bot to create the locale for.
String botVersion
The version of the bot to create the locale for. This can only be the draft version of the bot.
String localeId
The identifier of the language and locale that the bot will be used in. The string must match one of the supported locales. All of the intents, slot types, and slots used in the bot must have the same locale. For more information, see Supported languages.
String description
A description of the bot locale. Use this to help identify the bot locale in lists.
Double nluIntentConfidenceThreshold
Determines the threshold where Amazon Lex will insert the AMAZON.FallbackIntent,
AMAZON.KendraSearchIntent, or both when returning alternative intents.
AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they are
configured for the bot.
For example, suppose a bot is configured with the confidence threshold of 0.80 and the
AMAZON.FallbackIntent. Amazon Lex returns three alternative intents with the following confidence
scores: IntentA (0.70), IntentB (0.60), IntentC (0.50). The response from the RecognizeText
operation would be:
AMAZON.FallbackIntent
IntentA
IntentB
IntentC
VoiceSettings voiceSettings
The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user.
GenerativeAISettings generativeAISettings
String botId
The specified bot identifier.
String botVersion
The specified bot version.
String localeName
The specified locale name.
String localeId
The specified locale identifier.
String description
The specified description of the bot locale.
Double nluIntentConfidenceThreshold
The specified confidence threshold for inserting the AMAZON.FallbackIntent and
AMAZON.KendraSearchIntent intents.
VoiceSettings voiceSettings
The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user.
String botLocaleStatus
The status of the bot.
When the status is Creating the bot locale is being configured. When the status is
Building Amazon Lex is building the bot for testing and use.
If the status of the bot is ReadyExpressTesting, you can test the bot using the exact utterances
specified in the bots' intents. When the bot is ready for full testing or to run, the status is
Built.
If there was a problem with building the bot, the status is Failed. If the bot was saved but not
built, the status is NotBuilt.
Date creationDateTime
A timestamp specifying the date and time that the bot locale was created.
GenerativeAISettings generativeAISettings
String botName
The name of the bot. The bot name must be unique in the account that creates the bot.
String description
A description of the bot. It appears in lists to help you identify a particular bot.
String roleArn
The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot.
DataPrivacy dataPrivacy
Provides information on additional privacy protections Amazon Lex should use with the bot's data.
Integer idleSessionTTLInSeconds
The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.
A user interaction 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.
You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.
Map<K,V> botTags
A list of tags to add to the bot. You can only add tags when you create a bot. You can't use the
UpdateBot operation to update tags. To update tags, use the TagResource operation.
Map<K,V> testBotAliasTags
A list of tags to add to the test alias for a bot. You can only add tags when you create a bot. You can't use the
UpdateAlias operation to update tags. To update tags on the test alias, use the
TagResource operation.
String botType
The type of a bot to create.
List<E> botMembers
The list of bot members in a network to be created.
String botId
A unique identifier for a particular bot. You use this to identify the bot when you call other Amazon Lex API operations.
String botName
The name specified for the bot.
String description
The description specified for the bot.
String roleArn
The IAM role specified for the bot.
DataPrivacy dataPrivacy
The data privacy settings specified for the bot.
Integer idleSessionTTLInSeconds
The session idle time specified for the bot.
String botStatus
Shows the current status of the bot. The bot is first in the Creating status. Once the bot is read
for use, it changes to the Available status. After the bot is created, you can use the
DRAFT version of the bot.
Date creationDateTime
A timestamp indicating the date and time that the bot was created.
Map<K,V> botTags
A list of tags associated with the bot.
Map<K,V> testBotAliasTags
A list of tags associated with the test alias for the bot.
String botType
The type of a bot that was created.
List<E> botMembers
The list of bots in a network that was created.
String botId
The identifier of the bot to create the version for.
String description
A description of the version. Use the description to help identify the version in lists.
Map<K,V> botVersionLocaleSpecification
Specifies the locales that Amazon Lex adds to this version. You can choose the Draft version or any
other previously published version for each locale. When you specify a source version, the locale data is copied
from the source version to the new version.
String botId
The bot identifier specified in the request.
String description
The description of the version specified in the request.
String botVersion
The version number assigned to the version.
Map<K,V> botVersionLocaleSpecification
The source versions used for each locale in the new version.
String botStatus
When you send a request to create or update a bot, Amazon Lex sets the status response element to
Creating. After Amazon Lex builds the bot, it sets status to Available. If Amazon Lex
can't build the bot, it sets status to Failed.
Date creationDateTime
A timestamp of the date and time that the version was created.
ExportResourceSpecification resourceSpecification
Specifies the type of resource to export, either a bot or a bot locale. You can only specify one type of resource to export.
String fileFormat
The file format of the bot or bot locale definition files.
String filePassword
An password to use to encrypt the exported archive. Using a password is optional, but you should encrypt the archive to protect the data in transit between Amazon Lex and your local computer.
String exportId
An identifier for a specific request to create an export.
ExportResourceSpecification resourceSpecification
A description of the type of resource that was exported, either a bot or a bot locale.
String fileFormat
The file format used for the bot or bot locale definition files.
String exportStatus
The status of the export. When the status is Completed, you can use the DescribeExport operation
to get the pre-signed S3 URL link to your exported bot or bot locale.
Date creationDateTime
The date and time that the request to export a bot was created.
String intentName
The name of the intent. Intent names must be unique in the locale that contains the intent and cannot match the name of any built-in intent.
String description
A description of the intent. Use the description to help identify the intent in lists.
String parentIntentSignature
A unique identifier for the built-in intent to base this intent on.
List<E> sampleUtterances
An array of strings that a user might say to signal the intent. For example, "I want a pizza", or "I want a {PizzaSize} pizza".
In an utterance, slot names are enclosed in curly braces ("{", "}") to indicate where they should be displayed in the utterance shown to the user..
DialogCodeHookSettings dialogCodeHook
Specifies that Amazon Lex invokes the alias Lambda function for each user input. You can invoke this Lambda function to personalize user interaction.
For example, suppose that your bot determines that the user's name is John. You 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.
FulfillmentCodeHookSettings fulfillmentCodeHook
Specifies that Amazon Lex invokes the alias Lambda function when the intent is ready for fulfillment. You can invoke this function to complete the bot's transaction with the user.
For example, in a pizza ordering bot, the Lambda function can look up the closest pizza restaurant to the customer's location and then place an order on the customer's behalf.
IntentConfirmationSetting intentConfirmationSetting
Provides prompts that Amazon Lex sends to the user to confirm the completion of an intent. If the user answers "no," the settings contain a statement that is sent to the user to end the intent.
IntentClosingSetting intentClosingSetting
Sets the response that Amazon Lex sends to the user when the intent is closed.
List<E> inputContexts
A list of contexts that must be active for this intent to be considered by Amazon Lex.
When an intent has an input context list, Amazon Lex only considers using the intent in an interaction with the user when the specified contexts are included in the active context list for the session. If the contexts are not active, then Amazon Lex will not use the intent.
A context can be automatically activated using the outputContexts property or it can be set at
runtime.
For example, if there are two intents with different input contexts that respond to the same utterances, only the intent with the active context will respond.
An intent may have up to 5 input contexts. If an intent has multiple input contexts, all of the contexts must be active to consider the intent.
List<E> outputContexts
A lists of contexts that the intent activates when it is fulfilled.
You can use an output context to indicate the intents that Amazon Lex should consider for the next turn of the conversation with a customer.
When you use the outputContextsList property, all of the contexts specified in the list are
activated when the intent is fulfilled. You can set up to 10 output contexts. You can also set the number of
conversation turns that the context should be active, or the length of time that the context should be active.
KendraConfiguration kendraConfiguration
Configuration information required to use the AMAZON.KendraSearchIntent intent to connect to an
Amazon Kendra index. The AMAZON.KendraSearchIntent intent is called when Amazon Lex can't determine
another intent to invoke.
String botId
The identifier of the bot associated with this intent.
String botVersion
The version of the bot associated with this intent.
String localeId
The identifier of the language and locale where this intent is used. All of the bots, slot types, and slots used by the intent must have the same locale. For more information, see Supported languages.
InitialResponseSetting initialResponseSetting
Configuration settings for the response that is sent to the user at the beginning of a conversation, before eliciting slot values.
String intentId
A unique identifier for the intent.
String intentName
The name specified for the intent.
String description
The description specified for the intent.
String parentIntentSignature
The signature of the parent intent specified for the intent.
List<E> sampleUtterances
The sample utterances specified for the intent.
DialogCodeHookSettings dialogCodeHook
The dialog Lambda function specified for the intent.
FulfillmentCodeHookSettings fulfillmentCodeHook
The fulfillment Lambda function specified for the intent.
IntentConfirmationSetting intentConfirmationSetting
The confirmation setting specified for the intent.
IntentClosingSetting intentClosingSetting
The closing setting specified for the intent.
List<E> inputContexts
The list of input contexts specified for the intent.
List<E> outputContexts
The list of output contexts specified for the intent.
KendraConfiguration kendraConfiguration
Configuration for searching a Amazon Kendra index specified for the intent.
String botId
The identifier of the bot associated with the intent.
String botVersion
The version of the bot associated with the intent.
String localeId
The locale that the intent is specified to use.
Date creationDateTime
A timestamp of the date and time that the intent was created.
InitialResponseSetting initialResponseSetting
Configuration settings for the response that is sent to the user at the beginning of a conversation, before eliciting slot values.
String resourceArn
The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.
String policy
A resource policy to add to the resource. The policy is a JSON structure that contains one or more statements that define the policy. The policy must follow the IAM syntax. For more information about the contents of a JSON policy document, see IAM JSON policy reference .
If the policy isn't valid, Amazon Lex returns a validation exception.
String resourceArn
The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy was attached to.
String revisionId
The current revision of the resource policy. Use the revision ID to make sure that you are updating the most current version of a resource policy when you add a policy statement to a resource, delete a resource, or update a resource.
String resourceArn
The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.
String statementId
The name of the statement. The ID is the same as the Sid IAM property. The statement name must be
unique within the policy. For more information, see IAM JSON policy
elements: Sid.
String effect
Determines whether the statement allows or denies access to the resource.
List<E> principal
An IAM principal, such as an IAM user, IAM role, or Amazon Web Services services that is allowed or denied access to a resource. For more information, see Amazon Web Services JSON policy elements: Principal.
List<E> action
The Amazon Lex action that this policy either allows or denies. The action must apply to the resource type of the specified ARN. For more information, see Actions, resources, and condition keys for Amazon Lex V2.
Map<K,V> condition
Specifies a condition when the policy is in effect. If the principal of the policy is a service principal, you must provide two condition blocks, one with a SourceAccount global condition key and one with a SourceArn global condition key.
For more information, see IAM JSON policy elements: Condition .
String expectedRevisionId
The identifier of the revision of the policy to edit. If this revision ID doesn't match the current revision ID, Amazon Lex throws an exception.
If you don't specify a revision, Amazon Lex overwrites the contents of the policy with the new values.
String resourceArn
The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.
String revisionId
The current revision of the resource policy. Use the revision ID to make sure that you are updating the most current version of a resource policy when you add a policy statement to a resource, delete a resource, or update a resource.
String slotName
The name of the slot. Slot names must be unique within the bot that contains the slot.
String description
A description of the slot. Use this to help identify the slot in lists.
String slotTypeId
The unique identifier for the slot type associated with this slot. The slot type determines the values that can be entered into the slot.
SlotValueElicitationSetting valueElicitationSetting
Specifies prompts that Amazon Lex sends to the user to elicit a response that provides the value for the slot.
ObfuscationSetting obfuscationSetting
Determines how slot values are used in Amazon CloudWatch logs. If the value of the
obfuscationSetting parameter is DefaultObfuscation, slot values are obfuscated in the
log output. If the value is None, the actual value is present in the log output.
The default is to obfuscate values in the CloudWatch logs.
String botId
The identifier of the bot associated with the slot.
String botVersion
The version of the bot associated with the slot.
String localeId
The identifier of the language and locale that the slot will be used in. The string must match one of the supported locales. All of the bots, intents, slot types used by the slot must have the same locale. For more information, see Supported languages.
String intentId
The identifier of the intent that contains the slot.
MultipleValuesSetting multipleValuesSetting
Indicates whether the slot returns multiple values in one response. Multi-value slots are only available in the
en-US locale. If you set this value to true in any other locale, Amazon Lex throws a
ValidationException.
If the multipleValuesSetting is not set, the default value is false.
SubSlotSetting subSlotSetting
Specifications for the constituent sub slots and the expression for the composite slot.
String slotId
The unique identifier associated with the slot. Use this to identify the slot when you update or delete it.
String slotName
The name specified for the slot.
String description
The description associated with the slot.
String slotTypeId
The unique identifier of the slot type associated with this slot.
SlotValueElicitationSetting valueElicitationSetting
The value elicitation settings specified for the slot.
ObfuscationSetting obfuscationSetting
Indicates whether the slot is configured to obfuscate values in Amazon CloudWatch logs.
String botId
The unique identifier of the bot associated with the slot.
String botVersion
The version of the bot associated with the slot.
String localeId
The language and local specified for the slot.
String intentId
The unique identifier of the intent associated with the slot.
Date creationDateTime
The timestamp of the date and time that the slot was created.
MultipleValuesSetting multipleValuesSetting
Indicates whether the slot returns multiple values in one response.
SubSlotSetting subSlotSetting
Specifications for the constituent sub slots and the expression for the composite slot.
String slotTypeName
The name for the slot. A slot type name must be unique within the intent.
String description
A description of the slot type. Use the description to help identify the slot type in lists.
List<E> slotTypeValues
A list of SlotTypeValue objects that defines the values that the slot type can take. Each value can
have a list of synonyms, additional values that help train the machine learning model about the values that it
resolves for a slot.
SlotValueSelectionSetting valueSelectionSetting
Determines the strategy that Amazon Lex uses to select a value from the list of possible 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. If there is no resolution list, return null.
If you don't specify the valueSelectionSetting parameter, the default is ORIGINAL_VALUE
.
String parentSlotTypeSignature
The built-in slot type used as a parent of this slot type. When you define a parent slot type, the new slot type has the configuration of the parent slot type.
Only AMAZON.AlphaNumeric is supported.
String botId
The identifier of the bot associated with this slot type.
String botVersion
The identifier of the bot version associated with this slot type.
String localeId
The identifier of the language and locale that the slot type will be used in. The string must match one of the supported locales. All of the bots, intents, and slots used by the slot type must have the same locale. For more information, see Supported languages.
ExternalSourceSetting externalSourceSetting
Sets the type of external information used to create the slot type.
CompositeSlotTypeSetting compositeSlotTypeSetting
Specifications for a composite slot type.
String slotTypeId
The unique identifier assigned to the slot type. Use this to identify the slot type in the
UpdateSlotType and DeleteSlotType operations.
String slotTypeName
The name specified for the slot type.
String description
The description specified for the slot type.
List<E> slotTypeValues
The list of values that the slot type can assume.
SlotValueSelectionSetting valueSelectionSetting
The strategy that Amazon Lex uses to select a value from the list of possible values.
String parentSlotTypeSignature
The signature of the base slot type specified for the slot type.
String botId
The identifier for the bot associated with the slot type.
String botVersion
The version of the bot associated with the slot type.
String localeId
The specified language and local specified for the slot type.
Date creationDateTime
A timestamp of the date and time that the slot type was created.
ExternalSourceSetting externalSourceSetting
The type of external information used to create the slot type.
CompositeSlotTypeSetting compositeSlotTypeSetting
Specifications for a composite slot type.
String testSetId
The test set Id for the test set discrepancy report.
TestSetDiscrepancyReportResourceTarget target
The target bot for the test set discrepancy report.
String testSetDiscrepancyReportId
The unique identifier of the test set discrepancy report to describe.
Date creationDateTime
The creation date and time for the test set discrepancy report.
String testSetId
The test set Id for the test set discrepancy report.
TestSetDiscrepancyReportResourceTarget target
The target bot for the test set discrepancy report.
String importId
An identifier for a unique import job. Use it when you call the StartImport operation.
String uploadUrl
A pre-signed S3 write URL. Upload the zip archive file that contains the definition of your bot or bot locale.
String value
The string that is sent to your application.
String itemId
The unique item identifier for the custom vocabulary items.
String itemId
The unique item identifer for the custom vocabulary item from the custom vocabulary list.
String phrase
The unique phrase for the custom vocabulary item from the custom vocabulary list.
Integer weight
The weight assigned for the custom vocabulary item from the custom vocabulary list.
String displayAs
The DisplayAs value for the custom vocabulary item from the custom vocabulary list.
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.
DialogState nextStep
The next step in the conversation.
ResponseSpecification response
String botAliasId
The unique identifier of the bot alias to delete.
String botId
The unique identifier of the bot associated with the alias to delete.
Boolean skipResourceInUseCheck
By default, Amazon Lex checks if any other resource, such as a bot network, is using the bot alias before it is
deleted and throws a ResourceInUseException exception if the alias is being used by another
resource. Set this parameter to true to skip this check and remove the alias even if it is being
used by another resource.
String botAliasId
The unique identifier of the bot alias to delete.
String botId
The unique identifier of the bot that contains the alias to delete.
String botAliasStatus
The current status of the alias. The status is Deleting while the alias is in the process of being
deleted. Once the alias is deleted, it will no longer appear in the list of aliases returned by the
ListBotAliases operation.
String botId
The unique identifier of the bot that contains the locale.
String botVersion
The version of the bot that contains the locale.
String localeId
The identifier of the language and locale that will be deleted. The string must match one of the supported locales. For more information, see Supported languages.
String botId
The identifier of the bot that contained the deleted locale.
String botVersion
The version of the bot that contained the deleted locale.
String localeId
The language and locale of the deleted locale.
String botLocaleStatus
The status of deleting the bot locale. The locale first enters the Deleting status. Once the locale
is deleted it no longer appears in the list of locales for the bot.
String botId
The identifier of the bot to delete.
Boolean skipResourceInUseCheck
By default, Amazon Lex checks if any other resource, such as an alias or bot network, is using the bot version
before it is deleted and throws a ResourceInUseException exception if the bot is being used by
another resource. Set this parameter to true to skip this check and remove the bot even if it is
being used by another resource.
String botId
The identifier of the bot that contains the version.
String botVersion
The version of the bot to delete.
Boolean skipResourceInUseCheck
By default, Amazon Lex checks if any other resource, such as an alias or bot network, is using the bot version
before it is deleted and throws a ResourceInUseException exception if the version is being used by
another resource. Set this parameter to true to skip this check and remove the version even if it is
being used by another resource.
String botId
The identifier of the bot that the custom vocabulary was removed from.
String botVersion
The version of the bot that the custom vocabulary was removed from.
String localeId
The locale identifier for the locale that the custom vocabulary was removed from.
String customVocabularyStatus
The status of removing the custom vocabulary.
String exportId
The unique identifier of the export to delete.
String exportId
The unique identifier of the deleted export.
String exportStatus
The current status of the deletion. When the deletion is complete, the export will no longer be returned by the ListExports operation and calls to the DescribeExport operation with the export identifier will fail.
String importId
The unique identifier of the import to delete.
String importId
The unique identifier of the deleted import.
String importStatus
The current status of the deletion. When the deletion is complete, the import will no longer be returned by the ListImports operation and calls to the DescribeImport operation with the import identifier will fail.
String intentId
The unique identifier of the intent to delete.
String botId
The identifier of the bot associated with the intent.
String botVersion
The version of the bot associated with the intent.
String localeId
The identifier of the language and locale where the bot will be deleted. The string must match one of the supported locales. For more information, see Supported languages.
String resourceArn
The Amazon Resource Name (ARN) of the bot or bot alias that has the resource policy attached.
String expectedRevisionId
The identifier of the revision to edit. If this ID doesn't match the current revision number, Amazon Lex returns an exception
If you don't specify a revision ID, Amazon Lex will delete the current policy.
String resourceArn
The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy was deleted from.
String revisionId
The current revision of the resource policy. Use the revision ID to make sure that you are updating the most current version of a resource policy when you add a policy statement to a resource, delete a resource, or update a resource.
String resourceArn
The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.
String statementId
The name of the statement (SID) to delete from the policy.
String expectedRevisionId
The identifier of the revision of the policy to delete the statement from. If this revision ID doesn't match the current revision ID, Amazon Lex throws an exception.
If you don't specify a revision, Amazon Lex removes the current contents of the statement.
String resourceArn
The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy statement was removed from.
String revisionId
The current revision of the resource policy. Use the revision ID to make sure that you are updating the most current version of a resource policy when you add a policy statement to a resource, delete a resource, or update a resource.
String slotId
The identifier of the slot to delete.
String botId
The identifier of the bot associated with the slot to delete.
String botVersion
The version of the bot associated with the slot to delete.
String localeId
The identifier of the language and locale that the slot will be deleted from. The string must match one of the supported locales. For more information, see Supported languages.
String intentId
The identifier of the intent associated with the slot.
String slotTypeId
The identifier of the slot type to delete.
String botId
The identifier of the bot associated with the slot type.
String botVersion
The version of the bot associated with the slot type.
String localeId
The identifier of the language and locale that the slot type will be deleted from. The string must match one of the supported locales. For more information, see Supported languages.
Boolean skipResourceInUseCheck
By default, the DeleteSlotType operations throws a ResourceInUseException exception if
you try to delete a slot type used by a slot. Set the skipResourceInUseCheck parameter to
true to skip this check and remove the slot type even if a slot uses it.
String testSetId
The test set Id of the test set to be deleted.
String botId
The unique identifier of the bot that contains the utterances.
String localeId
The identifier of the language and locale where the utterances were collected. The string must match one of the supported locales. For more information, see Supported languages.
String sessionId
The unique identifier of the session with the user. The ID is returned in the response from the RecognizeText and RecognizeUtterance operations.
String botAliasId
The identifier of the bot alias.
String botAliasName
The name of the bot alias.
String description
The description of the bot alias.
String botVersion
The version of the bot associated with the bot alias.
Map<K,V> botAliasLocaleSettings
The locale settings that are unique to the alias.
ConversationLogSettings conversationLogSettings
Specifics of how Amazon Lex logs text and audio conversations with the bot associated with the alias.
SentimentAnalysisSettings sentimentAnalysisSettings
List<E> botAliasHistoryEvents
A list of events that affect a bot alias. For example, an event is recorded when the version that the alias points to changes.
String botAliasStatus
The current status of the alias. When the alias is Available, the alias is ready for use with your
bot.
String botId
The identifier of the bot associated with the bot alias.
Date creationDateTime
A timestamp of the date and time that the alias was created.
Date lastUpdatedDateTime
A timestamp of the date and time that the alias was last updated.
List<E> parentBotNetworks
A list of the networks to which the bot alias you described belongs.
String botId
The identifier of the bot associated with the locale.
String botVersion
The version of the bot associated with the locale.
String localeId
The unique identifier of the locale to describe. The string must match one of the supported locales. For more information, see Supported languages.
String botId
The identifier of the bot associated with the locale.
String botVersion
The version of the bot associated with the locale.
String localeId
The unique identifier of the described locale.
String localeName
The name of the locale.
String description
The description of the locale.
Double nluIntentConfidenceThreshold
The confidence threshold where Amazon Lex inserts the AMAZON.FallbackIntent and
AMAZON.KendraSearchIntent intents in the list of possible intents for an utterance.
VoiceSettings voiceSettings
The Amazon Polly voice Amazon Lex uses for voice interaction with the user.
Integer intentsCount
The number of intents defined for the locale.
Integer slotTypesCount
The number of slot types defined for the locale.
String botLocaleStatus
The status of the bot. If the status is Failed, the reasons for the failure are listed in the
failureReasons field.
List<E> failureReasons
if botLocaleStatus is Failed, Amazon Lex explains why it failed to build the bot.
Date creationDateTime
The date and time that the locale was created.
Date lastUpdatedDateTime
The date and time that the locale was last updated.
Date lastBuildSubmittedDateTime
The date and time that the locale was last submitted for building.
List<E> botLocaleHistoryEvents
History of changes, such as when a locale is used in an alias, that have taken place for the locale.
List<E> recommendedActions
Recommended actions to take to resolve an error in the failureReasons field.
GenerativeAISettings generativeAISettings
Contains settings for Amazon Bedrock's generative AI features for your bot locale.
String botId
The unique identifier of the bot associated with the bot recommendation.
String botVersion
The version of the bot associated with the bot recommendation.
String localeId
The identifier of the language and locale of the bot recommendation to describe. The string must match one of the supported locales. For more information, see Supported languages.
String botRecommendationId
The identifier of the bot recommendation to describe.
String botId
The identifier of the bot associated with the bot recommendation.
String botVersion
The version of the bot associated with the bot recommendation.
String localeId
The identifier of the language and locale of the bot recommendation to describe.
String botRecommendationStatus
The status of the bot recommendation. If the status is Failed, then the reasons for the failure are listed in the failureReasons field.
String botRecommendationId
The identifier of the bot recommendation being described.
List<E> failureReasons
If botRecommendationStatus is Failed, Amazon Lex explains why.
Date creationDateTime
The date and time that the bot recommendation was created.
Date lastUpdatedDateTime
The date and time that the bot recommendation was last updated.
TranscriptSourceSetting transcriptSourceSetting
The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.
EncryptionSetting encryptionSetting
The object representing the passwords that were used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.
BotRecommendationResults botRecommendationResults
The object representing the URL of the bot definition, the URL of the associated transcript and a statistical summary of the bot recommendation results.
String botId
The unique identifier of the bot to describe.
String botId
The unique identifier of the bot for which to return the generation details.
String botVersion
The version of the bot for which to return the generation details.
String localeId
The locale of the bot for which to return the generation details.
String generationId
The unique identifier of the generation request for which to return the generation details.
String botId
The unique identifier of the bot for which the generation request was made.
String botVersion
The version of the bot for which the generation request was made.
String localeId
The locale of the bot for which the generation request was made.
String generationId
The generation ID for which to return the generation details.
List<E> failureReasons
A list of reasons why the generation of bot resources through natural language description failed.
String generationStatus
The status of the generation request.
String generationInputPrompt
The prompt used in the generation request.
String generatedBotLocaleUrl
The Amazon S3 location of the generated bot locale configuration.
Date creationDateTime
The date and time at which the item was generated.
String modelArn
The ARN of the model used to generate the bot resources.
Date lastUpdatedDateTime
The date and time at which the generated item was updated.
String botId
The unique identifier of the bot.
String botName
The name of the bot.
String description
The description of the bot.
String roleArn
The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot.
DataPrivacy dataPrivacy
Settings for managing data privacy of the bot and its conversations with users.
Integer idleSessionTTLInSeconds
The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.
String botStatus
The current status of the bot. When the status is Available the bot is ready to be used in
conversations with users.
Date creationDateTime
A timestamp of the date and time that the bot was created.
Date lastUpdatedDateTime
A timestamp of the date and time that the bot was last updated.
String botType
The type of the bot that was described.
List<E> botMembers
The list of bots in the network that was described.
List<E> failureReasons
If the botStatus is Failed, this contains a list of reasons that the bot couldn't be
built.
String botId
The identifier of the bot that contains the version.
String botName
The name of the bot that contains the version.
String botVersion
The version of the bot that was described.
String description
The description specified for the bot.
String roleArn
The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot version.
DataPrivacy dataPrivacy
Data privacy settings for the bot version.
Integer idleSessionTTLInSeconds
The number of seconds that a session with the bot remains active before it is discarded by Amazon Lex.
String botStatus
The current status of the bot. When the status is Available, the bot version is ready for use.
List<E> failureReasons
If the botStatus is Failed, this contains a list of reasons that the version couldn't
be built.
Date creationDateTime
A timestamp of the date and time that the bot version was created.
List<E> parentBotNetworks
A list of the networks to which the bot version you described belongs.
String botType
The type of the bot in the version that was described.
List<E> botMembers
The members of bot network in the version that was described.
String botId
The identifier of the bot that contains the custom vocabulary.
String botVersion
The version of the bot that contains the custom vocabulary to describe.
String localeId
The locale that contains the custom vocabulary to describe.
String customVocabularyStatus
The status of the custom vocabulary. If the status is Ready the custom vocabulary is ready to use.
Date creationDateTime
The date and time that the custom vocabulary was created.
Date lastUpdatedDateTime
The date and time that the custom vocabulary was last updated.
String exportId
The unique identifier of the export to describe.
String exportId
The unique identifier of the described export.
ExportResourceSpecification resourceSpecification
The bot, bot ID, and optional locale ID of the exported bot or bot locale.
String fileFormat
The file format used in the files that describe the resource.
String exportStatus
The status of the export. When the status is Complete the export archive file is available for
download.
List<E> failureReasons
If the exportStatus is failed, contains one or more reasons why the export could not be completed.
String downloadUrl
A pre-signed S3 URL that points to the bot or bot locale archive. The URL is only available for 5 minutes after
calling the DescribeExport operation.
Date creationDateTime
The date and time that the export was created.
Date lastUpdatedDateTime
The last date and time that the export was updated.
String importId
The unique identifier of the import to describe.
String importId
The unique identifier of the described import.
ImportResourceSpecification resourceSpecification
The specifications of the imported bot, bot locale, or custom vocabulary.
String importedResourceId
The unique identifier that Amazon Lex assigned to the resource created by the import.
String importedResourceName
The name of the imported resource.
String mergeStrategy
The strategy used when there was a name conflict between the imported resource and an existing resource. When the
merge strategy is FailOnConflict existing resources are not overwritten and the import fails.
String importStatus
The status of the import process. When the status is Completed the resource is imported and ready
for use.
List<E> failureReasons
If the importStatus field is Failed, this provides one or more reasons for the failure.
Date creationDateTime
The date and time that the import was created.
Date lastUpdatedDateTime
The date and time that the import was last updated.
String intentId
The identifier of the intent to describe.
String botId
The identifier of the bot associated with the intent.
String botVersion
The version of the bot associated with the intent.
String localeId
The identifier of the language and locale of the intent to describe. The string must match one of the supported locales. For more information, see Supported languages.
String intentId
The unique identifier assigned to the intent when it was created.
String intentName
The name specified for the intent.
String description
The description of the intent.
String parentIntentSignature
The identifier of the built-in intent that this intent is derived from, if any.
List<E> sampleUtterances
User utterances that trigger this intent.
DialogCodeHookSettings dialogCodeHook
The Lambda function called during each turn of a conversation with the intent.
FulfillmentCodeHookSettings fulfillmentCodeHook
The Lambda function called when the intent is complete and ready for fulfillment.
List<E> slotPriorities
The list that determines the priority that slots should be elicited from the user.
IntentConfirmationSetting intentConfirmationSetting
Prompts that Amazon Lex sends to the user to confirm completion of an intent.
IntentClosingSetting intentClosingSetting
The response that Amazon Lex sends to when the intent is closed.
List<E> inputContexts
A list of contexts that must be active for the intent to be considered for sending to the user.
List<E> outputContexts
A list of contexts that are activated when the intent is fulfilled.
KendraConfiguration kendraConfiguration
Configuration information required to use the AMAZON.KendraSearchIntent intent.
String botId
The identifier of the bot associated with the intent.
String botVersion
The version of the bot associated with the intent.
String localeId
The language and locale specified for the intent.
Date creationDateTime
A timestamp of the date and time that the intent was created.
Date lastUpdatedDateTime
A timestamp of the date and time that the intent was last updated.
InitialResponseSetting initialResponseSetting
Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots.
String resourceArn
The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.
String resourceArn
The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.
String policy
The JSON structure that contains the resource policy. For more information about the contents of a JSON policy document, see IAM JSON policy reference .
String revisionId
The current revision of the resource policy. Use the revision ID to make sure that you are updating the most current version of a resource policy when you add a policy statement to a resource, delete a resource, or update a resource.
String slotId
The unique identifier for the slot.
String botId
The identifier of the bot associated with the slot.
String botVersion
The version of the bot associated with the slot.
String localeId
The identifier of the language and locale of the slot to describe. The string must match one of the supported locales. For more information, see Supported languages.
String intentId
The identifier of the intent that contains the slot.
String slotId
The unique identifier generated for the slot.
String slotName
The name specified for the slot.
String description
The description specified for the slot.
String slotTypeId
The identifier of the slot type that determines the values entered into the slot.
SlotValueElicitationSetting valueElicitationSetting
Prompts that Amazon Lex uses to elicit a value for the slot.
ObfuscationSetting obfuscationSetting
Whether slot values are shown in Amazon CloudWatch logs. If the value is None, the actual value of
the slot is shown in logs.
String botId
The identifier of the bot associated with the slot.
String botVersion
The version of the bot associated with the slot.
String localeId
The language and locale specified for the slot.
String intentId
The identifier of the intent associated with the slot.
Date creationDateTime
A timestamp of the date and time that the slot was created.
Date lastUpdatedDateTime
A timestamp of the date and time that the slot was last updated.
MultipleValuesSetting multipleValuesSetting
Indicates whether the slot accepts multiple values in a single utterance.
If the multipleValuesSetting is not set, the default value is false.
SubSlotSetting subSlotSetting
Specifications for the constituent sub slots and the expression for the composite slot.
String slotTypeId
The identifier of the slot type.
String botId
The identifier of the bot associated with the slot type.
String botVersion
The version of the bot associated with the slot type.
String localeId
The identifier of the language and locale of the slot type to describe. The string must match one of the supported locales. For more information, see Supported languages.
String slotTypeId
The unique identifier for the slot type.
String slotTypeName
The name specified for the slot type.
String description
The description specified for the slot type.
List<E> slotTypeValues
The values that the slot type can take. Includes any synonyms for the slot type values.
SlotValueSelectionSetting valueSelectionSetting
The strategy that Amazon Lex uses to choose a value from a list of possible values.
String parentSlotTypeSignature
The built in slot type used as a parent to this slot type.
String botId
The identifier of the bot associated with the slot type.
String botVersion
The version of the bot associated with the slot type.
String localeId
The language and locale specified for the slot type.
Date creationDateTime
A timestamp of the date and time that the slot type was created.
Date lastUpdatedDateTime
A timestamp of the date and time that the slot type was last updated.
ExternalSourceSetting externalSourceSetting
CompositeSlotTypeSetting compositeSlotTypeSetting
Specifications for a composite slot type.
String testExecutionId
The execution Id of the test set execution.
String testExecutionId
The execution Id for the test set execution.
Date creationDateTime
The execution creation date and time for the test set execution.
Date lastUpdatedDateTime
The date and time of the last update for the execution.
String testExecutionStatus
The test execution status for the test execution.
String testSetId
The test set Id for the test set execution.
String testSetName
The test set name of the test set execution.
TestExecutionTarget target
The target bot for the test set execution details.
String apiMode
Indicates whether we use streaming or non-streaming APIs are used for the test set execution. For streaming,
StartConversation Amazon Lex Runtime API is used. Whereas for non-streaming,
RecognizeUtterance and RecognizeText Amazon Lex Runtime API is used.
String testExecutionModality
Indicates whether test set is audio or text.
List<E> failureReasons
Reasons for the failure of the test set execution.
String testSetDiscrepancyReportId
The unique identifier of the test set discrepancy report.
String testSetDiscrepancyReportId
The unique identifier of the test set discrepancy report to describe.
String testSetId
The test set Id for the test set discrepancy report.
Date creationDateTime
The time and date of creation for the test set discrepancy report.
TestSetDiscrepancyReportResourceTarget target
The target bot location for the test set discrepancy report.
String testSetDiscrepancyReportStatus
The status for the test set discrepancy report.
Date lastUpdatedDataTime
The date and time of the last update for the test set discrepancy report.
TestSetDiscrepancyErrors testSetDiscrepancyTopErrors
The top 200 error results from the test set discrepancy report.
String testSetDiscrepancyRawOutputUrl
Pre-signed Amazon S3 URL to download the test set discrepancy report.
List<E> failureReasons
The failure report for the test set discrepancy report generation action.
String testSetGenerationId
The unique identifier of the test set generation.
String testSetGenerationId
The unique identifier of the test set generation.
String testSetGenerationStatus
The status for the test set generation.
List<E> failureReasons
The reasons the test set generation failed.
String testSetId
The unique identifier for the test set created for the generated test set.
String testSetName
The test set name for the generated test set.
String description
The test set description for the test set generation.
TestSetStorageLocation storageLocation
The Amazon S3 storage location for the test set generation.
TestSetGenerationDataSource generationDataSource
The data source of the test set used for the test set generation.
String roleArn
The roleARN of the test set used for the test set generation.
Date creationDateTime
The creation date and time for the test set generation.
Date lastUpdatedDateTime
The date and time of the last update for the test set generation.
String testSetId
The test set Id for the test set request.
String testSetId
The test set Id for the test set response.
String testSetName
The test set name of the test set.
String description
The description of the test set.
String modality
Indicates whether the test set is audio or text data.
String status
The status of the test set.
String roleArn
The roleARN used for any operation in the test set to access resources in the Amazon Web Services account.
Integer numTurns
The total number of agent and user turn in the test set.
TestSetStorageLocation storageLocation
The Amazon S3 storage location for the test set data.
Date creationDateTime
The creation date and time for the test set data.
Date lastUpdatedDateTime
The date and time for the last update of the test set data.
Boolean enabled
Specifies whether the descriptive bot building feature is activated or not.
BedrockModelSpecification bedrockModelSpecification
An object containing information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.
Boolean enableCodeHookInvocation
Indicates whether a Lambda function should be invoked for the dialog.
Boolean active
Determines whether a dialog code hook is used when the intent is activated.
String invocationLabel
A label that indicates the dialog step from which the dialog code hook is happening.
PostDialogCodeHookInvocationSpecification postCodeHookSpecification
Contains the responses and actions that Amazon Lex takes after the Lambda function is complete.
Boolean enabled
Enables the dialog code hook so that it processes user requests.
DialogAction dialogAction
IntentOverride intent
Map<K,V> sessionAttributes
Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
Integer maxLength
The maximum number of DTMF digits allowed in an utterance.
Integer endTimeoutMs
How long the bot should wait after the last DTMF character input before assuming that the input has concluded.
String deletionCharacter
The DTMF character that clears the accumulated DTMF digits and immediately ends the input.
String endCharacter
The DTMF character that immediately ends input. If the user does not press this character, the input ends after the end timeout.
String kmsKeyArn
The KMS key ARN used to encrypt the metadata associated with the bot recommendation.
String botLocaleExportPassword
The password used to encrypt the recommended bot recommendation file.
String associatedTranscriptsPassword
The password used to encrypt the associated transcript file.
String name
The name of the field to use for filtering.
List<E> values
The values to use to filter the response. The values must be Bot, BotLocale, or
CustomVocabulary.
String operator
The operator to use for the filter. Specify EQ when the ListExports operation should return only
resource types that equal the specified value. Specify CO when the ListExports operation should
return resource types that contain the specified value.
BotExportSpecification botExportSpecification
Parameters for exporting a bot.
BotLocaleExportSpecification botLocaleExportSpecification
Parameters for exporting a bot locale.
CustomVocabularyExportSpecification customVocabularyExportSpecification
The parameters required to export a custom vocabulary.
TestSetExportSpecification testSetExportSpecification
Specifications for the test set that is exported as a resource.
String exportId
The unique identifier that Amazon Lex assigned to the export.
ExportResourceSpecification resourceSpecification
Information about the bot or bot locale that was exported.
String fileFormat
The file format used in the export files.
String exportStatus
The status of the export. When the status is Completed the export is ready to download.
Date creationDateTime
The date and time that the export was created.
Date lastUpdatedDateTime
The date and time that the export was last updated.
GrammarSlotTypeSetting grammarSlotTypeSetting
Settings required for a slot type based on a grammar that you provide.
String itemId
The unique item identifer for the failed custom vocabulary item from the custom vocabulary list.
String errorMessage
The error message for the failed custom vocabulary item from the custom vocabulary list.
String errorCode
The unique error code for the failed custom vocabulary item from the custom vocabulary list.
Boolean enabled
Indicates whether a Lambda function should be invoked to fulfill a specific intent.
PostFulfillmentStatusSpecification postFulfillmentStatusSpecification
Provides settings for messages sent to the user for after the Lambda fulfillment function completes. Post-fulfillment messages can be sent for both streaming and non-streaming conversations.
FulfillmentUpdatesSpecification fulfillmentUpdatesSpecification
Provides settings for update messages sent to the user for long-running Lambda fulfillment functions. Fulfillment updates can be used only with streaming conversations.
Boolean active
Determines whether the fulfillment code hook is used. When active is false, the code hook doesn't
run.
Integer delayInSeconds
The delay between when the Lambda fulfillment function starts running and the start message is played. If the Lambda function returns before the delay is over, the start message isn't played.
List<E> messageGroups
1 - 5 message groups that contain start messages. Amazon Lex chooses one of the messages to play to the user.
Boolean allowInterrupt
Determines whether the user can interrupt the start message while it is playing.
Integer frequencyInSeconds
The frequency that a message is sent to the user. When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user. If the fulfillment Lambda returns before the first period ends, an update message is not played to the user.
List<E> messageGroups
1 - 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.
Boolean allowInterrupt
Determines whether the user can interrupt an update message while it is playing.
Boolean active
Determines whether fulfillment updates are sent to the user. When this field is true, updates are sent.
If the active field is set to true, the startResponse, updateResponse, and
timeoutInSeconds fields are required.
FulfillmentStartResponseSpecification startResponse
Provides configuration information for the message sent to users when the fulfillment Lambda functions starts running.
FulfillmentUpdateResponseSpecification updateResponse
Provides configuration information for messages sent periodically to the user while the fulfillment Lambda function is running.
Integer timeoutInSeconds
The length of time that the fulfillment Lambda function should run before it times out.
String intentId
The intent unique Id for the bot request to generate utterances.
String botId
The bot unique Id for the bot request to generate utterances.
String botVersion
The bot version for the bot request to generate utterances.
String localeId
The unique locale Id for the bot request to generate utterances.
String botId
The unique bot Id for the bot which received the response.
String botVersion
The unique bot version for the bot which received the response.
String localeId
The unique locale Id for the bot which received the response.
String intentId
The unique intent Id for the bot which received the response.
List<E> sampleUtterances
The sample utterances for the bot which received the response.
String attribute
The attribute by which to sort the generation request information. You can sort by the following attributes.
creationStartTime – The time at which the generation request was created.
lastUpdatedTime – The time at which the generation request was last updated.
String order
The order by which to sort the generation request information.
String generationId
The unique identifier of the generation request.
String generationStatus
The status of the generation request.
Date creationDateTime
The date and time at which the generation request was made.
Date lastUpdatedDateTime
The date and time at which the generation request was last updated.
RuntimeSettings runtimeSettings
BuildtimeSettings buildtimeSettings
String testExecutionId
The unique identifier of the completed test execution.
GrammarSlotTypeSource source
The source of the grammar used to create the slot type.
String title
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
String subtitle
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
String imageUrl
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
List<E> buttons
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
String name
The name of the field to use for filtering.
List<E> values
The values to use to filter the response. The values must be Bot, BotLocale, or
CustomVocabulary.
String operator
The operator to use for the filter. Specify EQ when the ListImports operation should return only
resource types that equal the specified value. Specify CO when the ListImports operation should
return resource types that contain the specified value.
BotImportSpecification botImportSpecification
Parameters for importing a bot.
BotLocaleImportSpecification botLocaleImportSpecification
Parameters for importing a bot locale.
CustomVocabularyImportSpecification customVocabularyImportSpecification
TestSetImportResourceSpecification testSetImportResourceSpecification
Specifications for the test set that is imported.
String importId
The unique identifier that Amazon Lex assigned to the import.
String importedResourceId
The unique identifier that Amazon Lex assigned to the imported resource.
String importedResourceName
The name that you gave the imported resource.
String importStatus
The status of the resource. When the status is Completed the resource is ready to build.
String mergeStrategy
The strategy used to merge existing bot or bot locale definitions with the imported definition.
Date creationDateTime
The date and time that the import was created.
Date lastUpdatedDateTime
The date and time that the import was last updated.
String importedResourceType
The type of resource that was imported.
ResponseSpecification initialResponse
DialogState nextStep
The next step in the conversation.
ConditionalSpecification conditional
DialogCodeHookInvocationSetting codeHook
String name
The name of the context.
String intentName
The name of the intent.
Boolean multiTurnConversation
Indicates whether the conversation involves multiple turns or not.
IntentClassificationTestResultItemCounts resultCounts
The result of the intent classification test.
Integer totalResultCount
The total number of results in the intent classification test.
Map<K,V> speechTranscriptionResultCounts
The number of matched, mismatched, and execution error results for speech transcription for the intent.
Map<K,V> intentMatchResultCounts
The number of matched and mismatched results for intent recognition for the intent.
ResponseSpecification closingResponse
The response that Amazon Lex sends to the user when the intent is complete.
Boolean active
Specifies whether an intent's closing response is used. When this field is false, the closing response isn't sent
to the user. If the active field isn't specified, the default is true.
DialogState nextStep
Specifies the next step that the bot executes after playing the intent's closing response.
ConditionalSpecification conditional
A list of conditional branches associated with the intent's closing response. These branches are executed when
the nextStep attribute is set to EvalutateConditional.
PromptSpecification promptSpecification
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.
ResponseSpecification declinationResponse
When the user answers "no" to the question defined in promptSpecification, Amazon Lex responds with
this response to acknowledge that the intent was canceled.
Boolean active
Specifies whether the intent's confirmation is sent to the user. When this field is false, confirmation and
declination responses aren't sent. If the active field isn't specified, the default is true.
ResponseSpecification confirmationResponse
DialogState confirmationNextStep
Specifies the next step that the bot executes when the customer confirms the intent.
ConditionalSpecification confirmationConditional
A list of conditional branches to evaluate after the intent is closed.
DialogState declinationNextStep
Specifies the next step that the bot executes when the customer declines the intent.
ConditionalSpecification declinationConditional
A list of conditional branches to evaluate after the intent is declined.
ResponseSpecification failureResponse
DialogState failureNextStep
The next step to take in the conversation if the confirmation step fails.
ConditionalSpecification failureConditional
DialogCodeHookInvocationSetting codeHook
The DialogCodeHookInvocationSetting object associated with intent's confirmation step. The dialog
code hook is triggered based on these invocation settings when the confirmation next step or declination next
step or failure next step is InvokeDialogCodeHook.
ElicitationCodeHookInvocationSetting elicitationCodeHook
The DialogCodeHookInvocationSetting used when the code hook is invoked during confirmation prompt
retries.
String name
The name of the field to use for the filter.
List<E> values
The value to use for the filter.
String operator
The operator to use for the filter. Specify EQ when the ListIntents operation should
return only aliases that equal the specified value. Specify CO when the ListIntents
operation should return aliases that contain the specified value.
String intentName
The name of the intent that was recognized.
Boolean multiTurnConversation
Indicates whether the conversation involves multiple turns or not.
List<E> slotResolutionResults
The results for the slot resolution in the test execution result.
Integer discoveredIntentCount
The number of recommended intents associated with the bot recommendation.
String intentId
The unique identifier assigned to the intent. Use this ID to get detailed information about the intent with the
DescribeIntent operation.
String intentName
The name of the intent.
String description
The description of the intent.
String parentIntentSignature
If this intent is derived from a built-in intent, the name of the parent intent.
List<E> inputContexts
The input contexts that must be active for this intent to be considered for recognition.
List<E> outputContexts
The output contexts that are activated when this intent is fulfilled.
Date lastUpdatedDateTime
The timestamp of the date and time that the intent was last updated.
String intentName
The name of an intent that was invoked.
String kendraIndex
The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the
AMAZON.KendraSearchIntent intent to search. The index must be in the same account and Region as the
Amazon Lex bot.
Boolean queryFilterStringEnabled
Determines whether the AMAZON.KendraSearchIntent intent uses a custom query string to query the
Amazon Kendra index.
String queryFilterString
A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query. The filter is in the format defined by Amazon Kendra. For more information, see Filtering queries.
DateRangeFilter dateRangeFilter
The object that contains a date range filter that will be applied to the transcript. Specify this object if you want Amazon Lex to only read the files that are within the date range.
String botId
The unique identifier of the bot associated with this request.
String botAliasId
The identifier of the bot alias associated with this request. If you specify the bot alias, you can't specify the bot version.
String botVersion
The identifier of the bot version associated with this request. If you specify the bot version, you can't specify the bot alias.
String localeId
The identifier of the language and locale where the utterances were collected. For more information, see Supported languages.
UtteranceAggregationDuration aggregationDuration
The time window for aggregating the utterance information. You can specify a time between one hour and two weeks.
AggregatedUtterancesSortBy sortBy
Specifies sorting parameters for the list of utterances. You can sort by the hit count, the missed count, or the number of distinct sessions the utterance appeared in.
List<E> filters
Provides the specification of a filter used to limit the utterances in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.
Integer maxResults
The maximum number of utterances to return in each page of results. If there are fewer results than the maximum
page size, only the actual number of results are returned. If you don't specify the maxResults
parameter, 1,000 results are returned.
String nextToken
If the response from the ListAggregatedUtterances operation contains more results that specified in
the maxResults parameter, a token is returned in the response. Use that token in the
nextToken parameter to return the next page of results.
String botId
The identifier of the bot that contains the utterances.
String botAliasId
The identifier of the bot alias that contains the utterances. If you specified the bot version, the bot alias ID isn't returned.
String botVersion
The identifier of the bot version that contains the utterances. If you specified the bot alias, the bot version isn't returned.
String localeId
The identifier of the language and locale that the utterances are in.
UtteranceAggregationDuration aggregationDuration
The time period used to aggregate the utterance data.
Date aggregationWindowStartTime
The date and time that the aggregation window begins. Only data collected after this time is returned in the results.
Date aggregationWindowEndTime
The date and time that the aggregation window ends. Only data collected between the start time and the end time are returned in the results.
Date aggregationLastRefreshedDateTime
The last date and time that the aggregated data was collected. The time period depends on the length of the aggregation window.
Hours - for 1 hour time window, every half hour; otherwise every hour.
Days - every 6 hours
Weeks - for a one week time window, every 12 hours; otherwise, every day
List<E> aggregatedUtterancesSummaries
Summaries of the aggregated utterance data. Each response contains information about the number of times that the utterance was seen during the time period, whether it was detected or missed, and when it was seen during the time period.
String nextToken
A token that indicates whether there are more results to return in a response to the
ListAggregatedUtterances operation. If the nextToken field is present, you send the
contents as the nextToken parameter of a ListAggregatedUtterances operation request to
get the next page of results.
String botId
The identifier of the bot to list aliases for.
Integer maxResults
The maximum number of aliases to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
String nextToken
If the response from the ListBotAliases operation contains more results than specified in the
maxResults parameter, a token is returned in the response. Use that token in the
nextToken parameter to return the next page of results.
List<E> botAliasSummaries
Summary information for the bot aliases that meet the filter criteria specified in the request. The length of the
list is specified in the maxResults parameter of the request. If there are more aliases available,
the nextToken field contains a token to get the next page of results.
String nextToken
A token that indicates whether there are more results to return in a response to the ListBotAliases
operation. If the nextToken field is present, you send the contents as the nextToken
parameter of a ListBotAliases operation request to get the next page of results.
String botId
The identifier of the bot associated with the aliases.
String botId
The identifier of the bot to list locales for.
String botVersion
The version of the bot to list locales for.
BotLocaleSortBy sortBy
Specifies sorting parameters for the list of locales. You can sort by locale name in ascending or descending order.
List<E> filters
Provides the specification for a filter used to limit the response to only those locales that match the filter specification. You can only specify one filter and one value to filter on.
Integer maxResults
The maximum number of aliases to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
String nextToken
If the response from the ListBotLocales operation contains more results than specified in the
maxResults parameter, a token is returned in the response. Use that token as the
nextToken parameter to return the next page of results.
String botId
The identifier of the bot to list locales for.
String botVersion
The version of the bot.
String nextToken
A token that indicates whether there are more results to return in a response to the ListBotLocales
operation. If the nextToken field is present, you send the contents as the nextToken
parameter of a ListBotLocales operation request to get the next page of results.
List<E> botLocaleSummaries
Summary information for the locales that meet the filter criteria specified in the request. The length of the
list is specified in the maxResults parameter of the request. If there are more locales available,
the nextToken field contains a token to get the next page of results.
String botId
The unique identifier of the bot that contains the bot recommendation list.
String botVersion
The version of the bot that contains the bot recommendation list.
String localeId
The identifier of the language and locale of the bot recommendation list.
Integer maxResults
The maximum number of bot recommendations to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
String nextToken
If the response from the ListBotRecommendation operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.
String botId
The unique identifier of the bot that contains the bot recommendation list.
String botVersion
The version of the bot that contains the bot recommendation list.
String localeId
The identifier of the language and locale of the bot recommendation list.
List<E> botRecommendationSummaries
Summary information for the bot recommendations that meet the filter specified in this request. The length of the list is specified in the maxResults parameter of the request. If there are more bot recommendations available, the nextToken field contains a token to get the next page of results.
String nextToken
A token that indicates whether there are more results to return in a response to the ListBotRecommendations operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListBotRecommendations operation request to get the next page of results.
String botId
The unique identifier of the bot whose generation requests you want to view.
String botVersion
The version of the bot whose generation requests you want to view.
String localeId
The locale of the bot whose generation requests you want to view.
GenerationSortBy sortBy
An object containing information about the attribute and the method by which to sort the results
Integer maxResults
The maximum number of results to return in the response.
String nextToken
If the total number of results is greater than the number specified in the maxResults, the response
returns a token in the nextToken field. Use this token when making a request to return the next
batch of results.
String botId
The unique identifier of the bot for which the generation requests were made.
String botVersion
The version of the bot for which the generation requests were made.
String localeId
The locale of the bot for which the generation requests were made.
List<E> generationSummaries
A list of objects, each containing information about a generation request for the bot locale.
String nextToken
If the total number of results is greater than the number specified in the maxResults, the response
returns a token in the nextToken field. Use this token when making a request to return the next
batch of results.
BotSortBy sortBy
Specifies sorting parameters for the list of bots. You can specify that the list be sorted by bot name in ascending or descending order.
List<E> filters
Provides the specification of a filter used to limit the bots in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.
Integer maxResults
The maximum number of bots to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.
String nextToken
If the response from the ListBots operation contains more results than specified in the
maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListBots request to return the
next page of results. For a complete set of results, call the ListBots operation until the
nextToken returned in the response is null.
List<E> botSummaries
Summary information for the bots that meet the filter criteria specified in the request. The length of the list
is specified in the maxResults parameter of the request. If there are more bots available, the
nextToken field contains a token to the next page of results.
String nextToken
A token that indicates whether there are more results to return in a response to the ListBots
operation. If the nextToken field is present, you send the contents as the nextToken
parameter of a ListBots operation request to get the next page of results.
String botId
The identifier of the bot to list versions for.
BotVersionSortBy sortBy
Specifies sorting parameters for the list of versions. You can specify that the list be sorted by version name in either ascending or descending order.
Integer maxResults
The maximum number of versions to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
String nextToken
If the response to the ListBotVersion operation contains more results than specified in the
maxResults parameter, a token is returned in the response. Use that token in the
nextToken parameter to return the next page of results.
String botId
The identifier of the bot to list versions for.
List<E> botVersionSummaries
Summary information for the bot versions that meet the filter criteria specified in the request. The length of
the list is specified in the maxResults parameter of the request. If there are more versions
available, the nextToken field contains a token to get the next page of results.
String nextToken
A token that indicates whether there are more results to return in a response to the ListBotVersions
operation. If the nextToken field is present, you send the contents as the nextToken
parameter of a ListBotAliases operation request to get the next page of results.
String localeId
The identifier of the language and locale of the intents to list. The string must match one of the supported locales. For more information, see Supported languages.
BuiltInIntentSortBy sortBy
Specifies sorting parameters for the list of built-in intents. You can specify that the list be sorted by the built-in intent signature in either ascending or descending order.
Integer maxResults
The maximum number of built-in intents to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
String nextToken
If the response from the ListBuiltInIntents operation contains more results than specified in the
maxResults parameter, a token is returned in the response. Use that token in the
nextToken parameter to return the next page of results.
List<E> builtInIntentSummaries
Summary information for the built-in intents that meet the filter criteria specified in the request. The length
of the list is specified in the maxResults parameter of the request. If there are more intents
available, the nextToken field contains a token to get the next page of results.
String nextToken
A token that indicates whether there are more results to return in a response to the
ListBuiltInIntents operation. If the nextToken field is present, you send the contents
as the nextToken parameter of a ListBotAliases operation request to get the next page
of results.
String localeId
The language and locale of the intents in the list.
String localeId
The identifier of the language and locale of the slot types to list. The string must match one of the supported locales. For more information, see Supported languages.
BuiltInSlotTypeSortBy sortBy
Determines the sort order for the response from the ListBuiltInSlotTypes operation. You can choose
to sort by the slot type signature in either ascending or descending order.
Integer maxResults
The maximum number of built-in slot types to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
String nextToken
If the response from the ListBuiltInSlotTypes operation contains more results than specified in the
maxResults parameter, a token is returned in the response. Use that token in the
nextToken parameter to return the next page of results.
List<E> builtInSlotTypeSummaries
Summary information for the built-in slot types that meet the filter criteria specified in the request. The
length of the list is specified in the maxResults parameter of the request. If there are more slot
types available, the nextToken field contains a token to get the next page of results.
String nextToken
A token that indicates whether there are more results to return in a response to the
ListBuiltInSlotTypes operation. If the nextToken field is present, you send the
contents as the nextToken parameter of a LIstBuiltInSlotTypes operation request to get
the next page of results.
String localeId
The language and locale of the slot types in the list.
String botId
The identifier of the version of the bot associated with this custom vocabulary.
String botVersion
The bot version of the bot to the list custom vocabulary request.
String localeId
The identifier of the language and locale where this custom vocabulary is used. The string must match one of the supported locales. For more information, see Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).
Integer maxResults
The maximum number of items returned by the list operation.
String nextToken
The nextToken identifier to the list custom vocabulary request.
String botId
The identifier of the bot associated with this custom vocabulary.
String botVersion
The identifier of the version of the bot associated with this custom vocabulary.
String localeId
The identifier of the language and locale where this custom vocabulary is used. The string must match one of the supported locales. For more information, see Supported Languages .
List<E> customVocabularyItems
The custom vocabulary items from the list custom vocabulary response.
String nextToken
The nextToken identifier to the list custom vocabulary response.
String botId
The unique identifier that Amazon Lex assigned to the bot.
String botVersion
The version of the bot to list exports for.
ExportSortBy sortBy
Determines the field that the list of exports is sorted by. You can sort by the LastUpdatedDateTime
field in ascending or descending order.
List<E> filters
Provides the specification of a filter used to limit the exports in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.
Integer maxResults
The maximum number of exports to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
String nextToken
If the response from the ListExports operation contains more results that specified in the
maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListExports request to return
the next page of results. For a complete set of results, call the ListExports operation until the
nextToken returned in the response is null.
String localeId
Specifies the resources that should be exported. If you don't specify a resource type in the filters
parameter, both bot locales and custom vocabularies are exported.
String botId
The unique identifier assigned to the bot by Amazon Lex.
String botVersion
The version of the bot that was exported.
List<E> exportSummaries
Summary information for the exports that meet the filter criteria specified in the request. The length of the
list is specified in the maxResults parameter. If there are more exports available, the
nextToken field contains a token to get the next page of results.
String nextToken
A token that indicates whether there are more results to return in a response to the ListExports
operation. If the nextToken field is present, you send the contents as the nextToken
parameter of a ListExports operation request to get the next page of results.
String localeId
The locale specified in the request.
String botId
The unique identifier that Amazon Lex assigned to the bot.
String botVersion
The version of the bot to list imports for.
ImportSortBy sortBy
Determines the field that the list of imports is sorted by. You can sort by the LastUpdatedDateTime
field in ascending or descending order.
List<E> filters
Provides the specification of a filter used to limit the bots in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.
Integer maxResults
The maximum number of imports to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
String nextToken
If the response from the ListImports operation contains more results than specified in the
maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListImports request to return
the next page of results. For a complete set of results, call the ListImports operation until the
nextToken returned in the response is null.
String localeId
Specifies the locale that should be present in the list. If you don't specify a resource type in the
filters parameter, the list contains both bot locales and custom vocabularies.
String botId
The unique identifier assigned by Amazon Lex to the bot.
String botVersion
The version of the bot that was imported. It will always be DRAFT.
List<E> importSummaries
Summary information for the imports that meet the filter criteria specified in the request. The length of the
list is specified in the maxResults parameter. If there are more imports available, the
nextToken field contains a token to get the next page of results.
String nextToken
A token that indicates whether there are more results to return in a response to the ListImports
operation. If the nextToken field is present, you send the contents as the nextToken
parameter of a ListImports operation request to get the next page of results.
String localeId
The locale specified in the request.
String botId
The identifier for the bot for which you want to retrieve intent metrics.
Date startDateTime
The timestamp that marks the beginning of the range of time for which you want to see intent metrics.
Date endDateTime
The date and time that marks the end of the range of time for which you want to see intent metrics.
List<E> metrics
A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the order by which to organize the results.
List<E> binBy
A list of objects, each of which contains specifications for organizing the results by time.
List<E> groupBy
A list of objects, each of which specifies how to group the results. You can group by the following criteria:
IntentName – The name of the intent.
IntentEndState – The final state of the intent. The possible end states are detailed in Key definitions in the user guide.
List<E> filters
A list of objects, each of which describes a condition by which you want to filter the results.
Integer maxResults
The maximum number of results to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.
String nextToken
If the response from the ListIntentMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListIntentMetrics request to return the next page of results. For a complete set of results, call the ListIntentMetrics operation until the nextToken returned in the response is null.
String botId
The identifier for the bot for which you retrieved intent metrics.
List<E> results
The results for the intent metrics.
String nextToken
If the response from the ListIntentMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListIntentMetrics request to return the next page of results. For a complete set of results, call the ListIntentMetrics operation until the nextToken returned in the response is null.
String botId
The identifier for the bot for which you want to retrieve intent path metrics.
Date startDateTime
The date and time that marks the beginning of the range of time for which you want to see intent path metrics.
Date endDateTime
The date and time that marks the end of the range of time for which you want to see intent path metrics.
String intentPath
The intent path for which you want to retrieve metrics. Use a forward slash to separate intents in the path. For example:
/BookCar
/BookCar/BookHotel
/BookHotel/BookCar
List<E> filters
A list of objects, each describes a condition by which you want to filter the results.
String botId
The unique identifier of the bot that contains the intent.
String botVersion
The version of the bot that contains the intent.
String localeId
The identifier of the language and locale of the intents to list. The string must match one of the supported locales. For more information, see Supported languages.
IntentSortBy sortBy
Determines the sort order for the response from the ListIntents operation. You can choose to sort by
the intent name or last updated date in either ascending or descending order.
List<E> filters
Provides the specification of a filter used to limit the intents in the response to only those that match the filter specification. You can only specify one filter and only one string to filter on.
Integer maxResults
The maximum number of intents to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
String nextToken
If the response from the ListIntents operation contains more results than specified in the
maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListIntents request to return
the next page of results. For a complete set of results, call the ListIntents operation until the
nextToken returned in the response is null.
String botId
The identifier of the bot that contains the intent.
String botVersion
The version of the bot that contains the intent.
String localeId
The language and locale of the intents in the list.
List<E> intentSummaries
Summary information for the intents that meet the filter criteria specified in the request. The length of the
list is specified in the maxResults parameter of the request. If there are more intents available,
the nextToken field contains a token to get the next page of results.
String nextToken
A token that indicates whether there are more results to return in a response to the ListIntents
operation. If the nextToken field is present, you send the contents as the nextToken
parameter of a ListIntents operation request to get the next page of results.
String botId
The identifier for the bot for which you want to retrieve intent stage metrics.
Date startDateTime
The date and time that marks the beginning of the range of time for which you want to see intent stage metrics.
Date endDateTime
The date and time that marks the end of the range of time for which you want to see intent stage metrics.
List<E> metrics
A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
List<E> binBy
A list of objects, each of which contains specifications for organizing the results by time.
List<E> groupBy
A list of objects, each of which specifies how to group the results. You can group by the following criteria:
IntentStageName – The name of the intent stage.
SwitchedToIntent – The intent to which the conversation was switched (if any).
List<E> filters
A list of objects, each of which describes a condition by which you want to filter the results.
Integer maxResults
The maximum number of results to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.
String nextToken
If the response from the ListIntentStageMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListIntentStageMetrics request to return the next page of results. For a complete set of results, call the ListIntentStageMetrics operation until the nextToken returned in the response is null.
String botId
The identifier for the bot for which you retrieved intent stage metrics.
List<E> results
The results for the intent stage metrics.
String nextToken
If the response from the ListIntentStageMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListIntentStageMetrics request to return the next page of results. For a complete set of results, call the ListIntentStageMetrics operation until the nextToken returned in the response is null.
String botId
The unique identifier of the bot associated with the recommended intents.
String botVersion
The version of the bot that contains the recommended intents.
String localeId
The identifier of the language and locale of the recommended intents.
String botRecommendationId
The identifier of the bot recommendation that contains the recommended intents.
String nextToken
If the response from the ListRecommendedIntents operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.
Integer maxResults
The maximum number of bot recommendations to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
String botId
The unique identifier of the bot associated with the recommended intent.
String botVersion
The version of the bot that contains the intent.
String localeId
The identifier of the language and locale of the intents to list. The string must match one of the supported locales. For more information, see Supported languages.
String botRecommendationId
The identifier of the bot recommendation that contains the recommended intent.
List<E> summaryList
Summary information for the intents that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter of the request. If there are more intents available, the nextToken field contains a token to get the next page of results.
String nextToken
A token that indicates whether there are more results to return in a response to the ListRecommendedIntents operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListRecommendedIntents operation request to get the next page of results.
String botId
The identifier for the bot for which you want to retrieve session analytics.
Date startDateTime
The date and time that marks the beginning of the range of time for which you want to see session analytics.
Date endDateTime
The date and time that marks the end of the range of time for which you want to see session analytics.
SessionDataSortBy sortBy
An object specifying the measure and method by which to sort the session analytics data.
List<E> filters
A list of objects, each of which describes a condition by which you want to filter the results.
Integer maxResults
The maximum number of results to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.
String nextToken
If the response from the ListSessionAnalyticsData operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListSessionAnalyticsData request to return the next page of results. For a complete set of results, call the ListSessionAnalyticsData operation until the nextToken returned in the response is null.
String botId
The unique identifier of the bot that the sessions belong to.
String nextToken
If the response from the ListSessionAnalyticsData operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListSessionAnalyticsData request to return the next page of results. For a complete set of results, call the ListSessionAnalyticsData operation until the nextToken returned in the response is null.
List<E> sessions
A list of objects, each of which contains information about a session with the bot.
String botId
The identifier for the bot for which you want to retrieve session metrics.
Date startDateTime
The date and time that marks the beginning of the range of time for which you want to see session metrics.
Date endDateTime
The date and time that marks the end of the range of time for which you want to see session metrics.
List<E> metrics
A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
List<E> binBy
A list of objects, each of which contains specifications for organizing the results by time.
List<E> groupBy
A list of objects, each of which specifies how to group the results. You can group by the following criteria:
ConversationEndState – The final state of the conversation. The possible end states are detailed in
Key definitions in the user
guide.
LocaleId – The unique identifier of the bot locale.
List<E> filters
A list of objects, each of which describes a condition by which you want to filter the results.
Integer maxResults
The maximum number of results to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.
String nextToken
If the response from the ListSessionMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListSessionMetrics request to return the next page of results. For a complete set of results, call the ListSessionMetrics operation until the nextToken returned in the response is null.
String botId
The identifier for the bot for which you retrieved session metrics.
List<E> results
The results for the session metrics.
String nextToken
If the response from the ListSessionMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListSessionMetrics request to return the next page of results. For a complete set of results, call the ListSessionMetrics operation until the nextToken returned in the response is null.
String botId
The identifier of the bot that contains the slot.
String botVersion
The version of the bot that contains the slot.
String localeId
The identifier of the language and locale of the slots to list. The string must match one of the supported locales. For more information, see Supported languages.
String intentId
The unique identifier of the intent that contains the slot.
SlotSortBy sortBy
Determines the sort order for the response from the ListSlots operation. You can choose to sort by
the slot name or last updated date in either ascending or descending order.
List<E> filters
Provides the specification of a filter used to limit the slots in the response to only those that match the filter specification. You can only specify one filter and only one string to filter on.
Integer maxResults
The maximum number of slots to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
String nextToken
If the response from the ListSlots operation contains more results than specified in the
maxResults parameter, a token is returned in the response. Use that token in the
nextToken parameter to return the next page of results.
String botId
The identifier of the bot that contains the slots.
String botVersion
The version of the bot that contains the slots.
String localeId
The language and locale of the slots in the list.
String intentId
The identifier of the intent that contains the slots.
List<E> slotSummaries
Summary information for the slots that meet the filter criteria specified in the request. The length of the list
is specified in the maxResults parameter of the request. If there are more slots available, the
nextToken field contains a token to get the next page of results.
String nextToken
A token that indicates whether there are more results to return in a response to the ListSlots
operation. If the nextToken field is present, you send the contents as the nextToken
parameter of a ListSlots operation request to get the next page of results.
String botId
The unique identifier of the bot that contains the slot types.
String botVersion
The version of the bot that contains the slot type.
String localeId
The identifier of the language and locale of the slot types to list. The string must match one of the supported locales. For more information, see Supported languages.
SlotTypeSortBy sortBy
Determines the sort order for the response from the ListSlotTypes operation. You can choose to sort
by the slot type name or last updated date in either ascending or descending order.
List<E> filters
Provides the specification of a filter used to limit the slot types in the response to only those that match the filter specification. You can only specify one filter and only one string to filter on.
Integer maxResults
The maximum number of slot types to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
String nextToken
If the response from the ListSlotTypes operation contains more results than specified in the
maxResults parameter, a token is returned in the response. Use that token in the
nextToken parameter to return the next page of results.
String botId
The identifier of the bot that contains the slot types.
String botVersion
The version of the bot that contains the slot types.
String localeId
The language and local of the slot types in the list.
List<E> slotTypeSummaries
Summary information for the slot types that meet the filter criteria specified in the request. The length of the
list is specified in the maxResults parameter of the request. If there are more slot types
available, the nextToken field contains a token to get the next page of results.
String nextToken
A token that indicates whether there are more results to return in a response to the ListSlotTypes
operation. If the nextToken field is present, you send the contents as the nextToken
parameter of a ListSlotTypes operation request to get the next page of results.
String resourceARN
The Amazon Resource Name (ARN) of the resource to get a list of tags for.
String testExecutionId
The unique identifier of the test execution to list the result items.
TestExecutionResultFilterBy resultFilterBy
The filter for the list of results from the test set execution.
Integer maxResults
The maximum number of test execution result items to return in each page. If there are fewer results than the max page size, only the actual number of results are returned.
String nextToken
If the response from the ListTestExecutionResultItems operation contains more results than specified
in the maxResults parameter, a token is returned in the response. Use that token in the
nextToken parameter to return the next page of results.
TestExecutionResultItems testExecutionResults
The list of results from the test execution.
String nextToken
A token that indicates whether there are more results to return in a response to the
ListTestExecutionResultItems operation. If the nextToken field is present, you send the
contents as the nextToken parameter of a ListTestExecutionResultItems operation request
to get the next page of results.
TestExecutionSortBy sortBy
The sort order of the test set executions.
Integer maxResults
The maximum number of test executions to return in each page. If there are fewer results than the max page size, only the actual number of results are returned.
String nextToken
If the response from the ListTestExecutions operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.
List<E> testExecutions
The list of test executions.
String nextToken
A token that indicates whether there are more results to return in a response to the ListTestExecutions operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListTestExecutions operation request to get the next page of results.
String testSetId
The identifier of the test set to list its test set records.
Integer maxResults
The maximum number of test set records to return in each page. If there are fewer records than the max page size, only the actual number of records are returned.
String nextToken
If the response from the ListTestSetRecords operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.
List<E> testSetRecords
The list of records from the test set.
String nextToken
A token that indicates whether there are more records to return in a response to the ListTestSetRecords operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListTestSetRecords operation request to get the next page of records.
TestSetSortBy sortBy
The sort order for the list of test sets.
Integer maxResults
The maximum number of test sets to return in each page. If there are fewer results than the max page size, only the actual number of results are returned.
String nextToken
If the response from the ListTestSets operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.
List<E> testSets
The selected test sets in a list of test sets.
String nextToken
A token that indicates whether there are more results to return in a response to the ListTestSets operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListTestSets operation request to get the next page of results.
String botId
The identifier for the bot for which you want to retrieve utterance analytics.
Date startDateTime
The date and time that marks the beginning of the range of time for which you want to see utterance analytics.
Date endDateTime
The date and time that marks the end of the range of time for which you want to see utterance analytics.
UtteranceDataSortBy sortBy
An object specifying the measure and method by which to sort the utterance analytics data.
List<E> filters
A list of objects, each of which describes a condition by which you want to filter the results.
Integer maxResults
The maximum number of results to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.
String nextToken
If the response from the ListUtteranceAnalyticsData operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListUtteranceAnalyticsData request to return the next page of results. For a complete set of results, call the ListUtteranceAnalyticsData operation until the nextToken returned in the response is null.
String botId
The unique identifier of the bot that the utterances belong to.
String nextToken
If the response from the ListUtteranceAnalyticsData operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListUtteranceAnalyticsData request to return the next page of results. For a complete set of results, call the ListUtteranceAnalyticsData operation until the nextToken returned in the response is null.
List<E> utterances
A list of objects, each of which contains information about an utterance in a user session with your bot.
String botId
The identifier for the bot for which you want to retrieve utterance metrics.
Date startDateTime
The date and time that marks the beginning of the range of time for which you want to see utterance metrics.
Date endDateTime
The date and time that marks the end of the range of time for which you want to see utterance metrics.
List<E> metrics
A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
List<E> binBy
A list of objects, each of which contains specifications for organizing the results by time.
List<E> groupBy
A list of objects, each of which specifies how to group the results. You can group by the following criteria:
UtteranceText – The transcription of the utterance.
UtteranceState – The state of the utterance. The possible states are detailed in Key definitions in the user guide.
List<E> attributes
A list containing attributes related to the utterance that you want the response to return. The following attributes are possible:
LastUsedIntent – The last used intent at the time of the utterance.
List<E> filters
A list of objects, each of which describes a condition by which you want to filter the results.
Integer maxResults
The maximum number of results to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.
String nextToken
If the response from the ListUtteranceMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListUtteranceMetrics request to return the next page of results. For a complete set of results, call the ListUtteranceMetrics operation until the nextToken returned in the response is null.
String botId
The identifier for the bot for which you retrieved utterance metrics.
List<E> results
The results for the utterance metrics.
String nextToken
If the response from the ListUtteranceMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListUtteranceMetrics request to return the next page of results. For a complete set of results, call the ListUtteranceMetrics operation until the nextToken returned in the response is null.
PlainTextMessage plainTextMessage
A message in plain text format.
CustomPayload customPayload
A message in a custom format defined by the client application.
SSMLMessage ssmlMessage
A message in Speech Synthesis Markup Language (SSML).
ImageResponseCard imageResponseCard
A message that defines a response card that the client application can show to the user.
Boolean allowMultipleValues
Indicates whether a slot can return multiple values. When true, the slot may return more than one
value in a response. When false, the slot returns only a single value.
Multi-value slots are only available in the en-US locale. If you set this value to true in any other
locale, Amazon Lex throws a ValidationException.
If the allowMutlipleValues is not set, the default value is false.
String phrase
The unique phrase for the new custom vocabulary item from the custom vocabulary list.
Integer weight
The weight assigned to the new custom vocabulary item from the custom vocabulary list.
String displayAs
The display as value assigned to the new custom vocabulary item from the custom vocabulary list.
String obfuscationSettingType
Value that determines whether Amazon Lex obscures slot values in conversation logs. The default is to obscure the values.
String name
The name of the output context.
Integer timeToLiveInSeconds
The amount of time, in seconds, that the output context should remain active. The time is figured from the first time the context is sent to the user.
Integer turnsToLive
The number of conversation turns that the output context should remain active. The number of turns is counted from the first time that the context is sent to the user.
Boolean multiTurnConversation
Indicates whether the conversation contains multiple turns or not.
Integer totalResultCount
The total number of overall results in the result of the test execution.
Map<K,V> speechTranscriptionResultCounts
The number of speech transcription results in the overall test.
Map<K,V> endToEndResultCounts
The number of results that succeeded.
String value
The message to send to the user.
ResponseSpecification successResponse
DialogState successNextStep
Specifics the next step the bot runs after the dialog code hook finishes successfully.
ConditionalSpecification successConditional
A list of conditional branches to evaluate after the dialog code hook finishes successfully.
ResponseSpecification failureResponse
DialogState failureNextStep
Specifies the next step the bot runs after the dialog code hook throws an exception or returns with the
State field of the Intent object set to Failed.
ConditionalSpecification failureConditional
A list of conditional branches to evaluate after the dialog code hook throws an exception or returns with the
State field of the Intent object set to Failed.
ResponseSpecification timeoutResponse
DialogState timeoutNextStep
Specifies the next step that the bot runs when the code hook times out.
ConditionalSpecification timeoutConditional
A list of conditional branches to evaluate if the code hook times out.
ResponseSpecification successResponse
ResponseSpecification failureResponse
ResponseSpecification timeoutResponse
DialogState successNextStep
Specifies the next step in the conversation that Amazon Lex invokes when the fulfillment code hook completes successfully.
ConditionalSpecification successConditional
A list of conditional branches to evaluate after the fulfillment code hook finishes successfully.
DialogState failureNextStep
Specifies the next step the bot runs after the fulfillment code hook throws an exception or returns with the
State field of the Intent object set to Failed.
ConditionalSpecification failureConditional
A list of conditional branches to evaluate after the fulfillment code hook throws an exception or returns with
the State field of the Intent object set to Failed.
DialogState timeoutNextStep
Specifies the next step that the bot runs when the fulfillment code hook times out.
ConditionalSpecification timeoutConditional
A list of conditional branches to evaluate if the fulfillment code hook times out.
Boolean allowInterrupt
Indicates whether the user can interrupt a speech prompt attempt from the bot.
AllowedInputTypes allowedInputTypes
Indicates the allowed input types of the prompt attempt.
AudioAndDTMFInputSpecification audioAndDTMFInputSpecification
Specifies the settings on audio and DTMF input.
TextInputSpecification textInputSpecification
Specifies the settings on text input.
List<E> messageGroups
A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.
Integer maxRetries
The maximum number of times the bot tries to elicit a response from the user using this prompt.
Boolean allowInterrupt
Indicates whether the user can interrupt a speech prompt from the bot.
String messageSelectionStrategy
Indicates how a message is selected from a message group among retries.
Map<K,V> promptAttemptsSpecification
Specifies the advanced settings on each attempt of the prompt.
String intentId
The unique identifier of a recommended intent associated with the bot recommendation.
String intentName
The name of a recommended intent associated with the bot recommendation.
Integer sampleUtterancesCount
The count of sample utterances of a recommended intent that is associated with a bot recommendation.
List<E> runtimeHintValues
One or more strings that Amazon Lex should look for in the input to the bot. Each phrase is given preference when deciding on slot values.
Map<K,V> subSlotHints
A map of constituent sub slot names inside a composite slot in the intent and the phrases that should be added for each sub slot. Inside each composite slot hints, this structure provides a mechanism to add granular sub slot phrases. Only sub slot hints are supported for composite slots. The intent name, composite slot name and the constituent sub slot names must exist.
Map<K,V> slotHints
A list of the slots in the intent that should have runtime hints added, and the phrases that should be added for each slot.
The first level of the slotHints map is the name of the intent. The second level is the name of the
slot within the intent. For more information, see Using hints to improve accuracy.
The intent name and slot name must exist.
String phrase
The phrase that Amazon Lex should look for in the user's input to the bot.
SlotResolutionImprovementSpecification slotResolutionImprovement
An object containing specifications for the assisted slot resolution feature.
String kmsKeyArn
The Amazon Resource Name (ARN) of an Amazon Web Services Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket.
String s3BucketArn
The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.
String logPrefix
The S3 prefix to assign to audio log files.
String s3BucketName
The name of the bucket containing the transcript and the associated metadata.
PathFormat pathFormat
The object that contains a path format that will be applied when Amazon Lex reads the transcript file in the bucket you provide. Specify this object if you only want Lex to read a subset of files in your Amazon S3 bucket.
String transcriptFormat
The format of the transcript content. Currently, Genie only supports the Amazon Lex transcript format.
TranscriptFilter transcriptFilter
The object that contains the filter which will be applied when Amazon Lex reads through the Amazon S3 bucket. Specify this object if you want Amazon Lex to read only a subset of the Amazon S3 bucket based on the filter you provide.
String kmsKeyArn
The ARN of the KMS key that customer use to encrypt their Amazon S3 bucket. Only use this field if your bucket is encrypted using a customer managed KMS key.
String utterance
The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.
Boolean enabled
Specifies whether to enable sample utterance generation or not.
BedrockModelSpecification bedrockModelSpecification
String value
The value that can be used for a slot type.
String botId
The unique identifier of the bot associated with the transcripts that you are searching.
String botVersion
The version of the bot containing the transcripts that you are searching.
String localeId
The identifier of the language and locale of the transcripts to search. The string must match one of the supported locales. For more information, see Supported languages
String botRecommendationId
The unique identifier of the bot recommendation associated with the transcripts to search.
String searchOrder
How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.
List<E> filters
A list of filter objects.
Integer maxResults
The maximum number of bot recommendations to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
Integer nextIndex
If the response from the SearchAssociatedTranscriptsRequest operation contains more results than specified in the maxResults parameter, an index is returned in the response. Use that index in the nextIndex parameter to return the next page of results.
String botId
The unique identifier of the bot associated with the transcripts that you are searching.
String botVersion
The version of the bot containing the transcripts that you are searching.
String localeId
The identifier of the language and locale of the transcripts to search. The string must match one of the supported locales. For more information, see Supported languages
String botRecommendationId
The unique identifier of the bot recommendation associated with the transcripts to search.
Integer nextIndex
A index that indicates whether there are more results to return in a response to the SearchAssociatedTranscripts operation. If the nextIndex field is present, you send the contents as the nextIndex parameter of a SearchAssociatedTranscriptsRequest operation to get the next page of results.
List<E> associatedTranscripts
The object that contains the associated transcript that meet the criteria you specified.
Integer totalResults
The total number of transcripts returned by the search.
Boolean detectSentiment
Sets whether Amazon Lex uses Amazon Comprehend to detect the sentiment of user utterances.
String name
The measure by which to sort the session analytics data.
conversationStartTime – The date and time when the conversation began. A conversation is defined as
a unique combination of a sessionId and an originatingRequestId.
numberOfTurns – The number of turns that the session took.
conversationDurationSeconds – The duration of the conversation in seconds.
String order
Specifies whether to sort the results in ascending or descending order.
String botAliasId
The identifier of the alias of the bot that the session was held with.
String botVersion
The version of the bot that the session was held with.
String localeId
The locale of the bot that the session was held with.
String channel
The channel that is integrated with the bot that the session was held with.
String sessionId
The identifier of the session.
Date conversationStartTime
The date and time when the conversation began. A conversation is defined as a unique combination of a
sessionId and an originatingRequestId.
Date conversationEndTime
The date and time when the conversation ended. A conversation is defined as a unique combination of a
sessionId and an originatingRequestId.
Long conversationDurationSeconds
The duration of the conversation in seconds. A conversation is defined as a unique combination of a
sessionId and an originatingRequestId.
String conversationEndState
The final state of the conversation. A conversation is defined as a unique combination of a
sessionId and an originatingRequestId.
String mode
The mode of the session. The possible values are as follows:
Speech – The session was spoken.
Text – The session was written.
DTMF – The session used a touch-tone keypad (Dual Tone Multi-Frequency).
MultiMode – The session used multiple modes.
Long numberOfTurns
The number of turns that the session took.
List<E> invokedIntentSamples
A list of objects containing the name of an intent that was invoked.
String originatingRequestId
The identifier of the first request in a session.
ResponseSpecification captureResponse
DialogState captureNextStep
Specifies the next step that the bot runs when the slot value is captured before the code hook times out.
ConditionalSpecification captureConditional
A list of conditional branches to evaluate after the slot value is captured.
ResponseSpecification failureResponse
DialogState failureNextStep
Specifies the next step that the bot runs when the slot value code is not recognized.
ConditionalSpecification failureConditional
A list of conditional branches to evaluate when the slot value isn't captured.
DialogCodeHookInvocationSetting codeHook
Code hook called after Amazon Lex successfully captures a slot value.
ElicitationCodeHookInvocationSetting elicitationCodeHook
Code hook called when Amazon Lex doesn't capture a slot value.
String defaultValue
The default value to use when a user doesn't provide a value for a slot.
String name
The name of the field to use for filtering.
List<E> values
The value to use to filter the response.
String operator
The operator to use for the filter. Specify EQ when the ListSlots operation should
return only aliases that equal the specified value. Specify CO when the ListSlots
operation should return aliases that contain the specified value.
Boolean enabled
Specifies whether assisted slot resolution is turned on or off.
BedrockModelSpecification bedrockModelSpecification
An object containing information about the Amazon Bedrock model used to assist slot resolution.
String slotResolutionStrategy
Specifies whether assisted slot resolution is turned on for the slot or not. If the value is
EnhancedFallback, assisted slot resolution is activated when Amazon Lex defaults to the
AMAZON.FallbackIntent. If the value is Default, assisted slot resolution is turned off.
String slotName
The name of the slot.
SlotResolutionTestResultItemCounts resultCounts
A result for slot resolution in the results of a test execution.
Integer totalResultCount
The total number of results.
Map<K,V> speechTranscriptionResultCounts
The number of matched, mismatched and execution error results for speech transcription for the slot.
Map<K,V> slotMatchResultCounts
The number of matched and mismatched results for slot resolution for the slot.
String slotId
The unique identifier of the slot.
String slotName
The name given to the slot.
String description
The description of the slot.
String slotConstraint
Whether the slot is required or optional. An intent is complete when all required slots are filled.
String slotTypeId
The unique identifier for the slot type that defines the values for the slot.
PromptSpecification valueElicitationPromptSpecification
Prompts that are sent to the user to elicit a value for the slot.
Date lastUpdatedDateTime
The timestamp of the last date and time that the slot was updated.
String name
The name of the field to use for filtering.
List<E> values
The value to use to filter the response.
String operator
The operator to use for the filter. Specify EQ when the ListSlotTypes operation should
return only aliases that equal the specified value. Specify CO when the ListSlotTypes
operation should return aliases that contain the specified value.
Integer discoveredSlotTypeCount
The number of recommended slot types associated with the bot recommendation.
String slotTypeId
The unique identifier assigned to the slot type.
String slotTypeName
The name of the slot type.
String description
The description of the slot type.
String parentSlotTypeSignature
If the slot type is derived from a built-on slot type, the name of the parent slot type.
Date lastUpdatedDateTime
A timestamp of the date and time that the slot type was last updated.
String slotTypeCategory
Indicates the type of the slot type.
Custom - A slot type that you created using custom values. For more information, see Creating custom slot types.
Extended - A slot type created by extending the AMAZON.AlphaNumeric built-in slot type.
For more information, see
AMAZON.AlphaNumeric .
ExternalGrammar - A slot type using a custom GRXML grammar to define values. For more information,
see Using a custom grammar slot
type.
SampleValue sampleValue
The value of the slot type entry.
List<E> synonyms
Additional values related to the slot type entry.
String interpretedValue
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection
strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the
first value in the resolvedValues list.
SlotDefaultValueSpecification defaultValueSpecification
A list of default values for a slot. Default values are used when Amazon Lex hasn't determined a value for a slot. You can specify default values from context variables, session attributes, and defined values.
String slotConstraint
Specifies whether the slot is required or optional.
PromptSpecification promptSpecification
The prompt that Amazon Lex uses to elicit the slot value from the user.
List<E> sampleUtterances
If you know a specific pattern that 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.
WaitAndContinueSpecification waitAndContinueSpecification
SlotCaptureSetting slotCaptureSetting
Specifies the settings that Amazon Lex uses when a slot value is successfully entered by a user.
SlotResolutionSetting slotResolutionSetting
An object containing information about whether assisted slot resolution is turned on for the slot or not.
String shape
When the shape value is List, it indicates that the values field contains a list of
slot values. When the value is Scalar, it indicates that the value field contains a
single value.
SlotValue value
The current value of the slot.
List<E> values
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
String pattern
A regular expression used to validate the value of a slot.
Use a standard regular expression. Amazon Lex supports the following characters in the regular expression:
A-Z, a-z
0-9
Unicode characters ("\u<Unicode>")
Represent Unicode characters with four digits, for example "\u0041" or "\u005A".
The following regular expression operators are not supported:
Infinite repeaters: *, +, or {x,} with no upper bound.
Wild card (.)
String resolutionStrategy
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.
SlotValueRegexFilter regexFilter
A regular expression used to validate the value of a slot.
AdvancedRecognitionSetting advancedRecognitionSetting
Provides settings that enable advanced recognition settings for slot values. You can use this to enable using slot values as a custom vocabulary for recognizing user utterances.
String slotTypeId
The unique identifier assigned to the slot type.
SubSlotValueElicitationSetting valueElicitationSetting
Specifies the elicitation setting details for constituent sub slots of a composite slot.
String value
The SSML text that defines the prompt.
String botId
The unique identifier of the bot containing the bot recommendation.
String botVersion
The version of the bot containing the bot recommendation.
String localeId
The identifier of the language and locale of the bot recommendation to start. The string must match one of the supported locales. For more information, see Supported languages
TranscriptSourceSetting transcriptSourceSetting
The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.
EncryptionSetting encryptionSetting
The object representing the passwords that will be used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.
String botId
The unique identifier of the bot containing the bot recommendation.
String botVersion
The version of the bot containing the bot recommendation.
String localeId
The identifier of the language and locale of the bot recommendation to start. The string must match one of the supported locales. For more information, see Supported languages
String botRecommendationStatus
The status of the bot recommendation.
If the status is Failed, then the reasons for the failure are listed in the failureReasons field.
String botRecommendationId
The identifier of the bot recommendation that you have created.
Date creationDateTime
A timestamp of the date and time that the bot recommendation was created.
TranscriptSourceSetting transcriptSourceSetting
The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.
EncryptionSetting encryptionSetting
The object representing the passwords that were used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.
String generationInputPrompt
The prompt to generate intents and slot types for the bot locale. Your description should be both detailed and precise to help generate appropriate and sufficient intents for your bot. Include a list of actions to improve the intent creation process.
String botId
The unique identifier of the bot for which to generate intents and slot types.
String botVersion
The version of the bot for which to generate intents and slot types.
String localeId
The locale of the bot for which to generate intents and slot types.
String generationInputPrompt
The prompt that was used generate intents and slot types for the bot locale.
String generationId
The unique identifier of the generation request.
String botId
The unique identifier of the bot for which the generation request was made.
String botVersion
The version of the bot for which the generation request was made.
String localeId
The locale of the bot for which the generation request was made.
String generationStatus
The status of the generation request.
Date creationDateTime
The date and time at which the generation request was made.
String importId
The unique identifier for the import. It is included in the response from the CreateUploadUrl operation.
ImportResourceSpecification resourceSpecification
Parameters for creating the bot, bot locale or custom vocabulary.
String mergeStrategy
The strategy to use when there is a name conflict between the imported resource and an existing resource. When
the merge strategy is FailOnConflict existing resources are not overwritten and the import fails.
String filePassword
The password used to encrypt the zip archive that contains the resource definition. You should always encrypt the zip archive to protect it during transit between your site and Amazon Lex.
String importId
A unique identifier for the import.
ImportResourceSpecification resourceSpecification
The parameters used when importing the resource.
String mergeStrategy
The strategy used when there was a name conflict between the imported resource and an existing resource. When the
merge strategy is FailOnConflict existing resources are not overwritten and the import fails.
String importStatus
The current status of the import. When the status is Complete the bot, bot alias, or custom
vocabulary is ready to use.
Date creationDateTime
The date and time that the import request was created.
String testSetId
The test set Id for the test set execution.
TestExecutionTarget target
The target bot for the test set execution.
String apiMode
Indicates whether we use streaming or non-streaming APIs for the test set execution. For streaming, StartConversation Runtime API is used. Whereas, for non-streaming, RecognizeUtterance and RecognizeText Amazon Lex Runtime API are used.
String testExecutionModality
Indicates whether audio or text is used.
String testExecutionId
The unique identifier of the test set execution.
Date creationDateTime
The creation date and time for the test set execution.
String testSetId
The test set Id for the test set execution.
TestExecutionTarget target
The target bot for the test set execution.
String apiMode
Indicates whether we use streaming or non-streaming APIs for the test set execution. For streaming, StartConversation Amazon Lex Runtime API is used. Whereas for non-streaming, RecognizeUtterance and RecognizeText Amazon Lex Runtime API are used.
String testExecutionModality
Indicates whether audio or text is used.
String testSetName
The test set name for the test set generation request.
String description
The test set description for the test set generation request.
TestSetStorageLocation storageLocation
The Amazon S3 storage location for the test set generation.
TestSetGenerationDataSource generationDataSource
The data source for the test set generation.
String roleArn
The roleARN used for any operation in the test set to access resources in the Amazon Web Services account.
Map<K,V> testSetTags
A list of tags to add to the test set. You can only add tags when you import/generate a new test set. You can't
use the UpdateTestSet operation to update tags. To update tags, use the TagResource
operation.
String testSetGenerationId
The unique identifier of the test set generation to describe.
Date creationDateTime
The creation date and time for the test set generation.
String testSetGenerationStatus
The status for the test set generation.
String testSetName
The test set name used for the test set generation.
String description
The description used for the test set generation.
TestSetStorageLocation storageLocation
The Amazon S3 storage location for the test set generation.
TestSetGenerationDataSource generationDataSource
The data source for the test set generation.
String roleArn
The roleARN used for any operation in the test set to access resources in the Amazon Web Services account.
Map<K,V> testSetTags
A list of tags that was used for the test set that is being generated.
List<E> messageGroups
One or more message groups, each containing one or more messages, that define the prompts that Amazon Lex sends to the user.
Integer frequencyInSeconds
How often a message should be sent to the user. Minimum of 1 second, maximum of 5 minutes.
Integer timeoutInSeconds
If Amazon Lex waits longer than this length of time for a response, it will stop sending messages.
Boolean allowInterrupt
Indicates that the user can interrupt the response by speaking while the message is being played.
String botId
The unique identifier of the bot containing the bot recommendation to be stopped.
String botVersion
The version of the bot containing the bot recommendation.
String localeId
The identifier of the language and locale of the bot recommendation to stop. The string must match one of the supported locales. For more information, see Supported languages
String botRecommendationId
The unique identifier of the bot recommendation to be stopped.
String botId
The unique identifier of the bot containing the bot recommendation that is being stopped.
String botVersion
The version of the bot containing the recommendation that is being stopped.
String localeId
The identifier of the language and locale of the bot response to stop. The string must match one of the supported locales. For more information, see Supported languages
String botRecommendationStatus
The status of the bot recommendation. If the status is Failed, then the reasons for the failure are listed in the failureReasons field.
String botRecommendationId
The unique identifier of the bot recommendation that is being stopped.
SlotDefaultValueSpecification defaultValueSpecification
PromptSpecification promptSpecification
List<E> sampleUtterances
If you know a specific pattern that users might respond to an Amazon Lex request for a sub slot value, you can
provide those utterances to improve accuracy. This is optional. In most cases Amazon Lex is capable of
understanding user utterances. This is similar to SampleUtterances for slots.
WaitAndContinueSpecification waitAndContinueSpecification
String resultTypeFilter
Specifies which results to filter. See Test result details">Test results details for details about different types of results.
ConversationLevelTestResultsFilterBy conversationLevelTestResultsFilterBy
Contains information about the method for filtering Conversation level test results.
OverallTestResults overallTestResults
Overall results for the test execution, including the breakdown of conversations and single-input utterances.
ConversationLevelTestResults conversationLevelTestResults
Results related to conversations in the test set, including metrics about success and failure of conversations and intent and slot failures.
IntentClassificationTestResults intentClassificationTestResults
Intent recognition results aggregated by intent name. The aggregated results contain success and failure rates of intent recognition, speech transcriptions, and end-to-end conversations.
IntentLevelSlotResolutionTestResults intentLevelSlotResolutionTestResults
Slot resolution results aggregated by intent and slot name. The aggregated results contain success and failure rates of slot resolution, speech transcriptions, and end-to-end conversations
UtteranceLevelTestResults utteranceLevelTestResults
Results related to utterances in the test set.
String testExecutionId
The unique identifier of the test execution.
Date creationDateTime
The date and time at which the test execution was created.
Date lastUpdatedDateTime
The date and time at which the test execution was last updated.
String testExecutionStatus
The current status of the test execution.
String testSetId
The unique identifier of the test set used in the test execution.
String testSetName
The name of the test set used in the test execution.
TestExecutionTarget target
Contains information about the bot used for the test execution..
String apiMode
Specifies whether the API mode for the test execution is streaming or non-streaming.
String testExecutionModality
Specifies whether the data used for the test execution is written or spoken.
BotAliasTestExecutionTarget botAliasTarget
Contains information about the bot alias used for the test execution.
TestSetDiscrepancyReportBotAliasTarget botAliasTarget
Contains information about the bot alias used as the resource for the test set discrepancy report.
String testSetId
The unique identifier of the test set.
ConversationLogsDataSource conversationLogsDataSource
Contains information about the bot from which the conversation logs are sourced.
String testSetName
The name of the test set.
String description
The description of the test set.
String roleArn
The Amazon Resource Name (ARN) of an IAM role that has permission to access the test set.
TestSetStorageLocation storageLocation
Contains information about the location that Amazon Lex uses to store the test-set.
TestSetImportInputLocation importInputLocation
Contains information about the input location from where test-set should be imported.
String modality
Specifies whether the test-set being imported contains written or spoken data.
Map<K,V> testSetTags
A list of tags to add to the test set. You can only add tags when you import/generate a new test set. You can't
use the UpdateTestSet operation to update tags. To update tags, use the TagResource
operation.
String s3BucketName
The name of the Amazon S3 bucket in which the test set is stored.
String s3Path
The path inside the Amazon S3 bucket where the test set is stored.
String kmsKeyArn
The Amazon Resource Name (ARN) of an Amazon Web Services Key Management Service (KMS) key for encrypting the test set.
String testSetId
The unique identifier of the test set.
String testSetName
The name of the test set.
String description
The description of the test set.
String modality
Specifies whether the test set contains written or spoken data.
String status
The status of the test set.
String roleArn
The Amazon Resource Name (ARN) of an IAM role that has permission to access the test set.
Integer numTurns
The number of turns in the test set.
TestSetStorageLocation storageLocation
Contains information about the location at which the test set is stored.
Date creationDateTime
The date and time at which the test set was created.
Date lastUpdatedDateTime
The date and time at which the test set was last updated.
Long recordNumber
The record number associated with the turn.
String conversationId
The unique identifier for the conversation associated with the turn.
Integer turnNumber
The number of turns that has elapsed up to that turn.
TurnSpecification turnSpecification
Contains information about the agent or user turn depending upon type of turn.
AgentTurnResult agent
Contains information about the agent messages in the turn.
UserTurnResult user
Contains information about the user messages in the turn.
Integer startTimeoutMs
Time for which a bot waits before re-prompting a customer for text input.
CloudWatchLogGroupLogDestination cloudWatch
Defines the Amazon CloudWatch Logs log group where text and metadata logs are delivered.
Boolean enabled
Determines whether conversation logs should be stored for an alias.
TextLogDestination destination
Boolean selectiveLoggingEnabled
The option to enable selective conversation log capture for text.
Integer retryAfterSeconds
The number of seconds after which the user can invoke the API again.
LexTranscriptFilter lexTranscriptFilter
The object representing the filter that Amazon Lex will use to select the appropriate transcript when the transcript format is the Amazon Lex format.
S3BucketTranscriptSource s3BucketTranscriptSource
Indicates the setting of the Amazon S3 bucket where the transcript is stored.
AgentTurnSpecification agentTurn
Contains information about the agent messages in the turn.
UserTurnSpecification userTurn
Contains information about the user messages in the turn.
String botAliasId
The unique identifier of the bot alias.
String botAliasName
The new name to assign to the bot alias.
String description
The new description to assign to the bot alias.
String botVersion
The new bot version to assign to the bot alias.
Map<K,V> botAliasLocaleSettings
The new Lambda functions to use in each locale for the bot alias.
ConversationLogSettings conversationLogSettings
The new settings for storing conversation logs in Amazon CloudWatch Logs and Amazon S3 buckets.
SentimentAnalysisSettings sentimentAnalysisSettings
String botId
The identifier of the bot with the updated alias.
String botAliasId
The identifier of the updated bot alias.
String botAliasName
The updated name of the bot alias.
String description
The updated description of the bot alias.
String botVersion
The updated version of the bot that the alias points to.
Map<K,V> botAliasLocaleSettings
The updated Lambda functions to use in each locale for the bot alias.
ConversationLogSettings conversationLogSettings
The updated settings for storing conversation logs in Amazon CloudWatch Logs and Amazon S3 buckets.
SentimentAnalysisSettings sentimentAnalysisSettings
String botAliasStatus
The current status of the bot alias. When the status is Available the alias is ready for use.
String botId
The identifier of the bot with the updated alias.
Date creationDateTime
A timestamp of the date and time that the bot was created.
Date lastUpdatedDateTime
A timestamp of the date and time that the bot was last updated.
String botId
The unique identifier of the bot that contains the locale.
String botVersion
The version of the bot that contains the locale to be updated. The version can only be the DRAFT
version.
String localeId
The identifier of the language and locale to update. The string must match one of the supported locales. For more information, see Supported languages.
String description
The new description of the locale.
Double nluIntentConfidenceThreshold
The new confidence threshold where Amazon Lex inserts the AMAZON.FallbackIntent and
AMAZON.KendraSearchIntent intents in the list of possible intents for an utterance.
VoiceSettings voiceSettings
The new Amazon Polly voice Amazon Lex should use for voice interaction with the user.
GenerativeAISettings generativeAISettings
Contains settings for generative AI features powered by Amazon Bedrock for your bot locale. Use this object to turn generative AI features on and off. Pricing may differ if you turn a feature on. For more information, see LINK.
String botId
The identifier of the bot that contains the updated locale.
String botVersion
The version of the bot that contains the updated locale.
String localeId
The language and locale of the updated bot locale.
String localeName
The updated locale name for the locale.
String description
The updated description of the locale.
Double nluIntentConfidenceThreshold
The updated confidence threshold for inserting the AMAZON.FallbackIntent and
AMAZON.KendraSearchIntent intents in the list of possible intents for an utterance.
VoiceSettings voiceSettings
The updated Amazon Polly voice to use for voice interaction with the user.
String botLocaleStatus
The current status of the locale. When the bot status is Built the locale is ready for use.
List<E> failureReasons
If the botLocaleStatus is Failed, the failureReasons field lists the
errors that occurred while building the bot.
Date creationDateTime
A timestamp of the date and time that the locale was created.
Date lastUpdatedDateTime
A timestamp of the date and time that the locale was last updated.
List<E> recommendedActions
Recommended actions to take to resolve an error in the failureReasons field.
GenerativeAISettings generativeAISettings
Contains settings for generative AI features powered by Amazon Bedrock for your bot locale.
String botId
The unique identifier of the bot containing the bot recommendation to be updated.
String botVersion
The version of the bot containing the bot recommendation to be updated.
String localeId
The identifier of the language and locale of the bot recommendation to update. The string must match one of the supported locales. For more information, see Supported languages
String botRecommendationId
The unique identifier of the bot recommendation to be updated.
EncryptionSetting encryptionSetting
The object representing the passwords that will be used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.
String botId
The unique identifier of the bot containing the bot recommendation that has been updated.
String botVersion
The version of the bot containing the bot recommendation that has been updated.
String localeId
The identifier of the language and locale of the bot recommendation to update. The string must match one of the supported locales. For more information, see Supported languages
String botRecommendationStatus
The status of the bot recommendation.
If the status is Failed, then the reasons for the failure are listed in the failureReasons field.
String botRecommendationId
The unique identifier of the bot recommendation to be updated.
Date creationDateTime
A timestamp of the date and time that the bot recommendation was created.
Date lastUpdatedDateTime
A timestamp of the date and time that the bot recommendation was last updated.
TranscriptSourceSetting transcriptSourceSetting
The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.
EncryptionSetting encryptionSetting
The object representing the passwords that were used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.
String botId
The unique identifier of the bot to update. This identifier is returned by the CreateBot operation.
String botName
The new name of the bot. The name must be unique in the account that creates the bot.
String description
A description of the bot.
String roleArn
The Amazon Resource Name (ARN) of an IAM role that has permissions to access the bot.
DataPrivacy dataPrivacy
Provides information on additional privacy protections Amazon Lex should use with the bot's data.
Integer idleSessionTTLInSeconds
The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.
A user interaction 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.
You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.
String botType
The type of the bot to be updated.
List<E> botMembers
The list of bot members in the network associated with the update action.
String botId
The unique identifier of the bot that was updated.
String botName
The name of the bot after the update.
String description
The description of the bot after the update.
String roleArn
The Amazon Resource Name (ARN) of the IAM role used by the bot after the update.
DataPrivacy dataPrivacy
The data privacy settings for the bot after the update.
Integer idleSessionTTLInSeconds
The session timeout, in seconds, for the bot after the update.
String botStatus
Shows the current status of the bot. The bot is first in the Creating status. Once the bot is read
for use, it changes to the Available status. After the bot is created, you can use the
DRAFT version of the bot.
Date creationDateTime
A timestamp of the date and time that the bot was created.
Date lastUpdatedDateTime
A timestamp of the date and time that the bot was last updated.
String botType
The type of the bot that was updated.
List<E> botMembers
The list of bot members in the network that was updated.
String exportId
The unique identifier Amazon Lex assigned to the export.
ExportResourceSpecification resourceSpecification
A description of the type of resource that was exported, either a bot or a bot locale.
String fileFormat
The file format used for the files that define the resource. The TSV format is required to export a
custom vocabulary only; otherwise use LexJson format.
String exportStatus
The status of the export. When the status is Completed the export archive is available for download.
Date creationDateTime
The date and time that the export was created.
Date lastUpdatedDateTime
The date and time that the export was last updated.
String intentId
The unique identifier of the intent to update.
String intentName
The new name for the intent.
String description
The new description of the intent.
String parentIntentSignature
The signature of the new built-in intent to use as the parent of this intent.
List<E> sampleUtterances
New utterances used to invoke the intent.
DialogCodeHookSettings dialogCodeHook
The new Lambda function to use between each turn of the conversation with the bot.
FulfillmentCodeHookSettings fulfillmentCodeHook
The new Lambda function to call when all of the intents required slots are provided and the intent is ready for fulfillment.
List<E> slotPriorities
A new list of slots and their priorities that are contained by the intent.
IntentConfirmationSetting intentConfirmationSetting
New prompts that Amazon Lex sends to the user to confirm the completion of an intent.
IntentClosingSetting intentClosingSetting
The new response that Amazon Lex sends the user when the intent is closed.
List<E> inputContexts
A new list of contexts that must be active in order for Amazon Lex to consider the intent.
List<E> outputContexts
A new list of contexts that Amazon Lex activates when the intent is fulfilled.
KendraConfiguration kendraConfiguration
New configuration settings for connecting to an Amazon Kendra index.
String botId
The identifier of the bot that contains the intent.
String botVersion
The version of the bot that contains the intent. Must be DRAFT.
String localeId
The identifier of the language and locale where this intent is used. The string must match one of the supported locales. For more information, see Supported languages.
InitialResponseSetting initialResponseSetting
Configuration settings for a response sent to the user before Amazon Lex starts eliciting slots.
String intentId
The identifier of the intent that was updated.
String intentName
The updated name of the intent.
String description
The updated description of the intent.
String parentIntentSignature
The updated built-in intent that is the parent of this intent.
List<E> sampleUtterances
The updated list of sample utterances for the intent.
DialogCodeHookSettings dialogCodeHook
The updated Lambda function called during each turn of the conversation with the user.
FulfillmentCodeHookSettings fulfillmentCodeHook
The updated Lambda function called when the intent is ready for fulfillment.
List<E> slotPriorities
The updated list of slots and their priorities that are elicited from the user for the intent.
IntentConfirmationSetting intentConfirmationSetting
The updated prompts that Amazon Lex sends to the user to confirm the completion of an intent.
IntentClosingSetting intentClosingSetting
The updated response that Amazon Lex sends the user when the intent is closed.
List<E> inputContexts
The updated list of contexts that must be active for the intent to be considered by Amazon Lex.
List<E> outputContexts
The updated list of contexts that Amazon Lex activates when the intent is fulfilled.
KendraConfiguration kendraConfiguration
The updated configuration for connecting to an Amazon Kendra index with the
AMAZON.KendraSearchIntent intent.
String botId
The identifier of the bot that contains the intent.
String botVersion
The version of the bot that contains the intent. Will always be DRAFT.
String localeId
The updated language and locale of the intent.
Date creationDateTime
A timestamp of when the intent was created.
Date lastUpdatedDateTime
A timestamp of the last time that the intent was modified.
InitialResponseSetting initialResponseSetting
Configuration settings for a response sent to the user before Amazon Lex starts eliciting slots.
String resourceArn
The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.
String policy
A resource policy to add to the resource. The policy is a JSON structure that contains one or more statements that define the policy. The policy must follow the IAM syntax. For more information about the contents of a JSON policy document, see IAM JSON policy reference .
If the policy isn't valid, Amazon Lex returns a validation exception.
String expectedRevisionId
The identifier of the revision of the policy to update. If this revision ID doesn't match the current revision ID, Amazon Lex throws an exception.
If you don't specify a revision, Amazon Lex overwrites the contents of the policy with the new values.
String resourceArn
The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.
String revisionId
The current revision of the resource policy. Use the revision ID to make sure that you are updating the most current version of a resource policy when you add a policy statement to a resource, delete a resource, or update a resource.
String slotId
The unique identifier for the slot to update.
String slotName
The new name for the slot.
String description
The new description for the slot.
String slotTypeId
The unique identifier of the new slot type to associate with this slot.
SlotValueElicitationSetting valueElicitationSetting
A new set of prompts that Amazon Lex sends to the user to elicit a response the provides a value for the slot.
ObfuscationSetting obfuscationSetting
New settings that determine how slot values are formatted in Amazon CloudWatch logs.
String botId
The unique identifier of the bot that contains the slot.
String botVersion
The version of the bot that contains the slot. Must always be DRAFT.
String localeId
The identifier of the language and locale that contains the slot. The string must match one of the supported locales. For more information, see Supported languages.
String intentId
The identifier of the intent that contains the slot.
MultipleValuesSetting multipleValuesSetting
Determines whether the slot accepts multiple values in one response. Multiple value slots are only available in
the en-US locale. If you set this value to true in any other locale, Amazon Lex throws a
ValidationException.
If the multipleValuesSetting is not set, the default value is false.
SubSlotSetting subSlotSetting
Specifications for the constituent sub slots and the expression for the composite slot.
String slotId
The unique identifier of the slot that was updated.
String slotName
The updated name of the slot.
String description
The updated description of the bot.
String slotTypeId
The updated identifier of the slot type that provides values for the slot.
SlotValueElicitationSetting valueElicitationSetting
The updated prompts that Amazon Lex sends to the user to elicit a response that provides a value for the slot.
ObfuscationSetting obfuscationSetting
The updated setting that determines whether the slot value is obfuscated in the Amazon CloudWatch logs.
String botId
The identifier of the bot that contains the slot.
String botVersion
The version of the bot that contains the slot. Will always be DRAFT.
String localeId
The locale that contains the slot.
String intentId
The intent that contains the slot.
Date creationDateTime
The timestamp of the date and time that the slot was created.
Date lastUpdatedDateTime
The timestamp of the date and time that the slot was last updated.
MultipleValuesSetting multipleValuesSetting
Indicates whether the slot accepts multiple values in one response.
SubSlotSetting subSlotSetting
Specifications for the constituent sub slots and the expression for the composite slot.
String slotTypeId
The unique identifier of the slot type to update.
String slotTypeName
The new name of the slot type.
String description
The new description of the slot type.
List<E> slotTypeValues
A new list of values and their optional synonyms that define the values that the slot type can take.
SlotValueSelectionSetting valueSelectionSetting
The strategy that Amazon Lex should use when deciding on a value from the list of slot type values.
String parentSlotTypeSignature
The new built-in slot type that should be used as the parent of this slot type.
String botId
The identifier of the bot that contains the slot type.
String botVersion
The version of the bot that contains the slot type. Must be DRAFT.
String localeId
The identifier of the language and locale that contains the slot type. The string must match one of the supported locales. For more information, see Supported languages.
ExternalSourceSetting externalSourceSetting
CompositeSlotTypeSetting compositeSlotTypeSetting
Specifications for a composite slot type.
String slotTypeId
The unique identifier of the updated slot type.
String slotTypeName
The updated name of the slot type.
String description
The updated description of the slot type.
List<E> slotTypeValues
The updated values that the slot type provides.
SlotValueSelectionSetting valueSelectionSetting
The updated strategy that Amazon Lex uses to determine which value to select from the slot type.
String parentSlotTypeSignature
The updated signature of the built-in slot type that is the parent of this slot type.
String botId
The identifier of the bot that contains the slot type.
String botVersion
The version of the bot that contains the slot type. This is always DRAFT.
String localeId
The language and locale of the updated slot type.
Date creationDateTime
The timestamp of the date and time that the slot type was created.
Date lastUpdatedDateTime
A timestamp of the date and time that the slot type was last updated.
ExternalSourceSetting externalSourceSetting
CompositeSlotTypeSetting compositeSlotTypeSetting
Specifications for a composite slot type.
String testSetId
The test set Id for which update test operation to be performed.
String testSetName
The test set name for the updated test set.
String description
The test set description for the updated test set.
String modality
Indicates whether audio or text is used for the updated test set.
String status
The status for the updated test set.
String roleArn
The roleARN used for any operation in the test set to access resources in the Amazon Web Services account.
Integer numTurns
The number of conversation turns from the updated test set.
TestSetStorageLocation storageLocation
The Amazon S3 storage location for the updated test set.
Date creationDateTime
The creation date and time for the updated test set.
Date lastUpdatedDateTime
The date and time of the last update for the updated test set.
UtteranceInputSpecification utteranceInput
The utterance input in the user turn.
Map<K,V> requestAttributes
Request attributes of the user turn.
InputSessionStateSpecification sessionState
Contains information about the session state in the input.
UserTurnIntentOutput intent
Contains information about the intent.
List<E> activeContexts
The contexts that are active in the turn.
String transcript
The transcript that is output for the user turn by the test execution.
UserTurnInputSpecification input
Contains information about the user messages in the turn in the input.
UserTurnOutputSpecification expectedOutput
Contains information about the expected output for the user turn.
UserTurnOutputSpecification actualOutput
Contains information about the actual output for the user turn.
ExecutionErrorDetails errorDetails
String endToEndResult
Specifies whether the expected and actual outputs match or not, or if there is an error in execution.
String intentMatchResult
Specifies whether the expected and actual intents match or not.
String slotMatchResult
Specifies whether the expected and actual slots match or not.
String speechTranscriptionResult
Specifies whether the expected and actual speech transcriptions match or not, or if there is an error in execution.
ConversationLevelResultDetail conversationLevelResult
Contains information about the results related to the conversation associated with the user turn.
UserTurnInputSpecification input
Contains information about the user messages in the turn in the input.
UserTurnOutputSpecification expected
Contains results about the expected output for the user turn.
RelativeAggregationDuration relativeAggregationDuration
The desired time window for aggregating utterances.
String audioFileS3Location
Amazon S3 file pointing to the audio.
String content
The text of the response to the utterance from the bot.
String contentType
The type of the response. The following values are possible:
PlainText – A plain text string.
CustomPayload – A response string that you can customize to include data or metadata for your
application.
SSML – A string that includes Speech Synthesis Markup Language to customize the audio response.
ImageResponseCard – An image with buttons that the customer can select. See ImageResponseCard for more information.
ImageResponseCard imageResponseCard
String textInput
A text input transcription of the utterance. It is only applicable for test-sets containing text data.
UtteranceAudioInputSpecification audioInput
Contains information about the audio input for an utterance.
Long recordNumber
The record number of the result.
String conversationId
The unique identifier for the conversation associated with the result.
TestSetTurnResult turnResult
Contains information about the turn associated with the result.
String botAliasId
The identifier of the alias of the bot that the utterance was made to.
String botVersion
The version of the bot that the utterance was made to.
String localeId
The locale of the bot that the utterance was made to.
String sessionId
The identifier of the session that the utterance was made in.
String channel
The channel that is integrated with the bot that the utterance was made to.
String mode
The mode of the session. The possible values are as follows:
Speech – The session consisted of spoken dialogue.
Text – The session consisted of written dialogue.
DTMF – The session consisted of touch-tone keypad (Dual Tone Multi-Frequency) key presses.
MultiMode – The session consisted of multiple modes.
Date conversationStartTime
The date and time when the conversation in which the utterance took place began. A conversation is defined as a
unique combination of a sessionId and an originatingRequestId.
Date conversationEndTime
The date and time when the conversation in which the utterance took place ended. A conversation is defined as a
unique combination of a sessionId and an originatingRequestId.
String utterance
The text of the utterance.
Date utteranceTimestamp
The date and time when the utterance took place.
Long audioVoiceDurationMillis
The duration in milliseconds of the audio associated with the utterance.
Boolean utteranceUnderstood
Specifies whether the bot understood the utterance or not.
String inputType
The input type of the utterance. The possible values are as follows:
PCM format: audio data must be in little-endian byte order.
audio/l16; rate=16000; channels=1
audio/x-l16; sample-rate=16000; channel-count=1
audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false
Opus format
audio/x-cbr-opus-with-preamble;preamble-size=0;bit-rate=256000;frame-size-milliseconds=4
Text format
text/plain; charset=utf-8
String outputType
The output type of the utterance. The possible values are as follows:
audio/mpeg
audio/ogg
audio/pcm (16 KHz)
audio/ (defaults to mpeg)
text/plain; charset=utf-8
String associatedIntentName
The name of the intent that the utterance is associated to.
String associatedSlotName
The name of the slot that the utterance is associated to.
String intentState
The state of the intent that the utterance is associated to.
String dialogActionType
The type of dialog action that the utterance is associated to. See the type field in DialogAction for
more information.
String botResponseAudioVoiceId
The identifier for the audio of the bot response.
String slotsFilledInSession
The slots that have been filled in the session by the time of the utterance.
String utteranceRequestId
The identifier of the request associated with the utterance.
List<E> botResponses
A list of objects containing information about the bot response to the utterance.
String voiceId
The identifier of the Amazon Polly voice to use.
String engine
Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more
information, see the
engine parameter of the SynthesizeSpeech operation in the Amazon Polly developer
guide.
If you do not specify a value, the default is standard.
ResponseSpecification waitingResponse
The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue.
ResponseSpecification continueResponse
The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation.
StillWaitingResponseSpecification stillWaitingResponse
A response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user.
Boolean active
Specifies whether the bot will wait for a user to respond. When this field is false, wait and continue responses
for a slot aren't used. If the active field isn't specified, the default is true.
Copyright © 2024. All rights reserved.