Amazon.LexModelsV2.Model

The active context used in the test execution.

Provides settings that enable advanced recognition settings for slot values.

The information about the agent turn in a test set execution.

The specification of an agent turn.

Filters responses returned by the ListAggregatedUtterances operation.

Specifies attributes for sorting a list of utterances.

Provides summary information for aggregated utterances. The ListAggregatedUtterances operations combines all instances of the same utterance into a single aggregated summary.

Specifies the allowed input types.

Contains the time metric, interval, and method by which to bin the analytics data.

An object containing the criterion by which to bin the results and the value that defines that bin.

Contains fields describing a condition by which to filter the intents. The expression may be understood as name operator values. For example:

• IntentName CO Book – The intent name contains the string "Book."

• BotVersion EQ 2 – The bot version is equal to two.

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.

Contains the category by which the intent analytics were grouped and a member of that category.

Contains the category by which to group the intents.

Contains the metric and the summary statistic you want to calculate, and the order in which to sort the results, for the intents in the bot.

An object containing the results for the intent metric you requested.

An object containing information about the requested path.

An object containing the results for the intent metrics you requested and the bin and/or group(s) they refer to, if applicable.

Contains fields describing a condition by which to filter the intent stages. The expression may be understood as name operator values. For example:

• IntentName CO Book – The intent name contains the string "Book."

• BotVersion EQ 2 – The bot version is equal to two.

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.

Contains the category by which the intent stage analytics and the values for that category were grouped.

Contains the category by which to group the intent stages.

Contains the metric and the summary statistic you want to calculate, and the order in which to sort the results, for the intent stages across the user sessions with the bot.

An object containing the results for an intent stage metric you requested.

An object containing the results for the intent stage metrics you requested and the bin and/or group they refer to, if applicable.

Contains fields describing a condition by which to filter the paths. The expression may be understood as name operator values. For example:

• LocaleId EQ en – The locale is "en".

• BotVersion EQ 2 – The bot version is equal to two.

The operators that each filter supports are listed below:

• BotAlias – EQ.

• BotVersion – EQ.

• LocaleId – EQ.

• Modality – EQ.

• Channel – EQ.

Contains fields describing a condition by which to filter the sessions. The expression may be understood as name operator values. For example:

• LocaleId EQ en – The locale is "en".

• Duration GT 200 – The duration is greater than 200 seconds.

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.

Contains the category by which the session analytics were grouped and a member of that category.

Contains the category by which to group the sessions.

Contains the metric and the summary statistic you want to calculate, and the order in which to sort the results, for the user sessions with the bot.

An object containing the results for a session metric you requested.

An object containing the results for the session metrics you requested and the bin and/or group(s) they refer to, if applicable.

An object that specifies the last used intent at the time of the utterance as an attribute to return.

An object containing the intent that the bot mapped the utterance to.

Contains fields describing a condition by which to filter the utterances. The expression may be understood as name operator values. For example:

• LocaleId EQ Book – The locale is the string "en".

• UtteranceText CO help – The text of the utterance contains the string "help".

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.

Contains the category by which the utterance analytics were grouped and the values for that category.

Contains the category by which to group the utterances.

Contains the metric and the summary statistic you want to calculate, and the order in which to sort the results, for the utterances across the user sessions with the bot.

An object containing the results for the utterance metric you requested.

An object containing the results for the utterance metrics you requested and the bin and/or group(s) they refer to, if applicable.

The object containing information that associates the recommended intent/slot type with a conversation.

Filters to search for the associated transcript.

Specifies the audio and DTMF input specification.

The location of audio log files collected when conversation logging is enabled for a bot.

Settings for logging audio of conversations between Amazon Lex and a user. You specify whether to log audio and the Amazon S3 bucket where the audio file is stored.

Specifies the audio input specifications.

Container for the parameters to the BatchCreateCustomVocabularyItem operation. Create a batch of custom vocabulary items for a given bot locale's custom vocabulary.

This is the response object from the BatchCreateCustomVocabularyItem operation.

Container for the parameters to the BatchDeleteCustomVocabularyItem operation. Delete a batch of custom vocabulary items for a given bot locale's custom vocabulary.

This is the response object from the BatchDeleteCustomVocabularyItem operation.

Container for the parameters to the BatchUpdateCustomVocabularyItem operation. Update a batch of custom vocabulary items for a given bot locale's custom vocabulary.

This is the response object from the BatchUpdateCustomVocabularyItem operation.

The details on the Bedrock guardrail configuration.

Contains details about the configuration of a Amazon Bedrock knowledge base.

The exact response fields given by the Bedrock knowledge store.

Contains information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.

Provides a record of an event that affects a bot alias. For example, when the version of a bot that the alias points to changes.

Specifies settings that are unique to a locale. For example, you can use different Lambda function depending on the bot's locale.

Contains information about all the aliases replication statuses applicable for global resiliency.

Summary information about bot aliases returned from the ListBotAliases operation.

The target Amazon S3 location for the test set execution using a bot alias.

Provides the identity of a the bot that was exported.

Filters the responses returned by the ListBots operation.

Provides the bot parameters required for importing a bot.

Provides the bot locale parameters required for exporting a bot locale.

Filters responses returned by the ListBotLocales operation.

Provides information about an event that occurred affecting the bot locale.

Provides the bot locale parameters required for importing a bot locale.

Specifies attributes for sorting a list of bot locales.

Summary information about bot locales returned by the ListBotLocales operation.

A bot that is a member of a network of bots.

The object representing the URL of the bot definition, the URL of the associated transcript, and a statistical summary of the bot recommendation results.

A statistical summary of the bot recommendation results.

A summary of the bot recommendation.

Contains summary information about all the replication statuses applicable for global resiliency.

Specifies attributes for sorting a list of bots.

Summary information about a bot returned by the ListBots operation.

The version of a bot used for a bot locale.

The sort category for the version replicated bots.

Contains summary information for all the version replication statuses applicable for Global resiliency.

Specifies attributes for sorting a list of bot versions.

Summary information about a bot version returned by the ListBotVersions operation.

Container for the parameters to the BuildBotLocale operation. Builds a bot, its intents, and its slot types into a specific locale. A bot can be built into multiple locales. At runtime the locale is used to choose a specific build of the bot.

This is the response object from the BuildBotLocale operation.

Contains specifications about the Amazon Lex build time generative AI capabilities from Amazon Bedrock that you can turn on for your bot.

Specifies attributes for sorting a list of built-in intents.

Provides summary information about a built-in intent for the ListBuiltInIntents operation.

Specifies attributes for sorting a list of built-in slot types.

Provides summary information about a built-in slot type for the ListBuiltInSlotTypes operation.

Describes a button to use on a response card used to gather slot values from a user.

The Amazon CloudWatch Logs log group where the text and metadata logs are delivered. The log group must exist before you enable logging.

Contains information about code hooks that Amazon Lex calls during a conversation.

A composite slot is a combination of two or more slots that capture multiple pieces of information in a single user input.

Provides an expression that evaluates to true or false.

A set of actions that Amazon Lex should run if the condition is matched.

Provides a list of conditional branches. Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition.

The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

The item listing the evaluation of intent level success or failure.

The conversation level details of the conversation used in the test set.

The slots used for the slot resolution in the conversation.

The test result evaluation item at the conversation level.

The test set results data at the conversation level.

The selection to filter the test set results data at the conversation level.

The data source that uses conversation logs.

The selected data source to filter the conversation log.

Configures conversation logging that saves audio, text, and metadata for the conversations with your users.

Container for the parameters to the CreateBotAlias operation. Creates an alias for the specified version of a bot. Use an alias to enable you to change the version of a bot without updating applications that use the bot.

For example, you can create an alias called "PROD" that your applications use to call the Amazon Lex bot.

This is the response object from the CreateBotAlias operation.

Container for the parameters to the CreateBotLocale operation. Creates a locale in the bot. The locale contains the intents and slot types that the bot uses in conversations with users in the specified language and locale. You must add a locale to a bot before you can add intents and slot types to the bot.

This is the response object from the CreateBotLocale operation.

Container for the parameters to the CreateBotReplica operation. Action to create a replication of the source bot in the secondary region.

This is the response object from the CreateBotReplica operation.

Container for the parameters to the CreateBot operation. Creates an Amazon Lex conversational bot.

This is the response object from the CreateBot operation.

Container for the parameters to the CreateBotVersion operation. Creates an immutable version of the bot. When you create the first version of a bot, Amazon Lex sets the version number to 1. Subsequent bot versions increase in an increment of 1. The version number will always represent the total number of versions created of the bot, not the current number of versions. If a bot version is deleted, that bot version number will not be reused.

This is the response object from the CreateBotVersion operation.

Container for the parameters to the CreateExport operation. Creates a zip archive containing the contents of a bot or a bot locale. The archive contains a directory structure that contains JSON files that define the bot.

You can create an archive that contains the complete definition of a bot, or you can specify that the archive contain only the definition of a single bot locale.

For more information about exporting bots, and about the structure of the export archive, see Importing and exporting bots

This is the response object from the CreateExport operation.

Container for the parameters to the CreateIntent operation. Creates an intent.

To define the interaction between the user and your bot, you define one or more intents. For example, for a pizza ordering bot you would create an OrderPizza intent.

When you create an intent, you must provide a name. You can optionally provide the following:

• Sample utterances. For example, "I want to order a pizza" and "Can I order a pizza." You can't provide utterances for built-in intents.

• Information to be gathered. You specify slots for the information that you bot requests from the user. You can specify standard slot types, such as date and time, or custom slot types for your application.

• How the intent is fulfilled. You can provide a Lambda function or configure the intent to return the intent information to your client application. If you use a Lambda function, Amazon Lex invokes the function when all of the intent information is available.

• A confirmation prompt to send to the user to confirm an intent. For example, "Shall I order your pizza?"

• A conclusion statement to send to the user after the intent is fulfilled. For example, "I ordered your pizza."

• A follow-up prompt that asks the user for additional activity. For example, "Do you want a drink with your pizza?"

This is the response object from the CreateIntent operation.

Container for the parameters to the CreateResourcePolicy operation. Creates a new resource policy with the specified policy statements.

This is the response object from the CreateResourcePolicy operation.

Container for the parameters to the CreateResourcePolicyStatement operation. Adds a new resource policy statement to a bot or bot alias. If a resource policy exists, the statement is added to the current resource policy. If a policy doesn't exist, a new policy is created.

You can't create a resource policy statement that allows cross-account access.

You need to add the CreateResourcePolicy or UpdateResourcePolicy action to the bot role in order to call the API.

This is the response object from the CreateResourcePolicyStatement operation.

Container for the parameters to the CreateSlot operation. Creates a slot in an intent. A slot is a variable needed to fulfill an intent. For example, an OrderPizza intent might need slots for size, crust, and number of pizzas. For each slot, you define one or more utterances that Amazon Lex uses to elicit a response from the user.

This is the response object from the CreateSlot operation.

Container for the parameters to the CreateSlotType operation. Creates a custom slot type

To create a custom slot type, specify a name for the slot type and a set of enumeration values, the values that a slot of this type can assume.

This is the response object from the CreateSlotType operation.

Container for the parameters to the CreateTestSetDiscrepancyReport operation. Create a report that describes the differences between the bot and the test set.

This is the response object from the CreateTestSetDiscrepancyReport operation.

Container for the parameters to the CreateUploadUrl operation. Gets a pre-signed S3 write URL that you use to upload the zip archive when importing a bot or a bot locale.

This is the response object from the CreateUploadUrl operation.

A custom response string that Amazon Lex sends to your application. You define the content and structure the string.

The unique entry identifier for the custom vocabulary items.

Provides the parameters required for exporting a custom vocabulary.

Provides the parameters required for importing a custom vocabulary.

The unique custom vocabulary item from the custom vocabulary list.

By default, data stored by Amazon Lex is encrypted. The DataPrivacy structure provides settings that determine how Amazon Lex handles special cases of securing the data for your bot.

Contains details about the configuration of the knowledge store used for the AMAZON.QnAIntent. You must have already created the knowledge store and indexed the documents within it.

The object used for specifying the data range that the customer wants Amazon Lex to read through in the input transcripts.

A set of actions that Amazon Lex should run if none of the other conditions are met.

Container for the parameters to the DeleteBotAlias operation. Deletes the specified bot alias.

This is the response object from the DeleteBotAlias operation.

Container for the parameters to the DeleteBotLocale operation. Removes a locale from a bot.

When you delete a locale, all intents, slots, and slot types defined for the locale are also deleted.

This is the response object from the DeleteBotLocale operation.

Container for the parameters to the DeleteBotReplica operation. The action to delete the replicated bot in the secondary region.

This is the response object from the DeleteBotReplica operation.

Container for the parameters to the DeleteBot operation. Deletes all versions of a bot, including the Draft version. To delete a specific version, use the DeleteBotVersion operation.

When you delete a bot, all of the resources contained in the bot are also deleted. Deleting a bot removes all locales, intents, slot, and slot types defined for the bot.

If a bot has an alias, the DeleteBot operation returns a ResourceInUseException exception. If you want to delete the bot and the alias, set the skipResourceInUseCheck parameter to true.

This is the response object from the DeleteBot operation.

Container for the parameters to the DeleteBotVersion operation. Deletes a specific version of a bot. To delete all versions of a bot, use the DeleteBot operation.

This is the response object from the DeleteBotVersion operation.

Container for the parameters to the DeleteCustomVocabulary operation. Removes a custom vocabulary from the specified locale in the specified bot.

This is the response object from the DeleteCustomVocabulary operation.

Container for the parameters to the DeleteExport operation. Removes a previous export and the associated files stored in an S3 bucket.

This is the response object from the DeleteExport operation.

Container for the parameters to the DeleteImport operation. Removes a previous import and the associated file stored in an S3 bucket.

This is the response object from the DeleteImport operation.

Container for the parameters to the DeleteIntent operation. Removes the specified intent.

Deleting an intent also deletes the slots associated with the intent.

This is the response object from the DeleteIntent operation.

Container for the parameters to the DeleteResourcePolicy operation. Removes an existing policy from a bot or bot alias. If the resource doesn't have a policy attached, Amazon Lex returns an exception.

This is the response object from the DeleteResourcePolicy operation.

Container for the parameters to the DeleteResourcePolicyStatement operation. Deletes a policy statement from a resource policy. If you delete the last statement from a policy, the policy is deleted. If you specify a statement ID that doesn't exist in the policy, or if the bot or bot alias doesn't have a policy attached, Amazon Lex returns an exception.

You need to add the DeleteResourcePolicy or UpdateResourcePolicy action to the bot role in order to call the API.

This is the response object from the DeleteResourcePolicyStatement operation.

Container for the parameters to the DeleteSlot operation. Deletes the specified slot from an intent.

This is the response object from the DeleteSlot operation.

Container for the parameters to the DeleteSlotType operation. Deletes a slot type from a bot locale.

If a slot is using the slot type, Amazon Lex throws a ResourceInUseException exception. To avoid the exception, set the skipResourceInUseCheck parameter to true.

This is the response object from the DeleteSlotType operation.

Container for the parameters to the DeleteTestSet operation. The action to delete the selected test set.

This is the response object from the DeleteTestSet operation.

Container for the parameters to the DeleteUtterances operation. Deletes stored utterances.

Amazon Lex stores the utterances that users send to your bot. Utterances are stored for 15 days for use with the ListAggregatedUtterances operation, and then stored indefinitely for use in improving the ability of your bot to respond to user input..

Use the DeleteUtterances operation to manually delete utterances for a specific session. When you use the DeleteUtterances operation, utterances stored for improving your bot's ability to respond to user input are deleted immediately. Utterances stored for use with the ListAggregatedUtterances operation are deleted after 15 days.

This is the response object from the DeleteUtterances operation.

Container for the parameters to the DescribeBotAlias operation. Get information about a specific bot alias.

This is the response object from the DescribeBotAlias operation.

Container for the parameters to the DescribeBotLocale operation. Describes the settings that a bot has for a specific locale.

This is the response object from the DescribeBotLocale operation.

Container for the parameters to the DescribeBotRecommendation operation. Provides metadata information about a bot recommendation. This information will enable you to get a description on the request inputs, to download associated transcripts after processing is complete, and to download intents and slot-types generated by the bot recommendation.

This is the response object from the DescribeBotRecommendation operation.

Container for the parameters to the DescribeBotReplica operation. Monitors the bot replication status through the UI console.

This is the response object from the DescribeBotReplica operation.

Container for the parameters to the DescribeBot operation. Provides metadata information about a bot.

Container for the parameters to the DescribeBotResourceGeneration operation. Returns information about a request to generate a bot through natural language description, made through the StartBotResource API. Use the generatedBotLocaleUrl to retrieve the Amazon S3 object containing the bot locale configuration. You can then modify and import this configuration.

This is the response object from the DescribeBotResourceGeneration operation.

This is the response object from the DescribeBot operation.

Container for the parameters to the DescribeBotVersion operation. Provides metadata about a version of a bot.

This is the response object from the DescribeBotVersion operation.

Container for the parameters to the DescribeCustomVocabularyMetadata operation. Provides metadata information about a custom vocabulary.

This is the response object from the DescribeCustomVocabularyMetadata operation.

Container for the parameters to the DescribeExport operation. Gets information about a specific export.

This is the response object from the DescribeExport operation.

Container for the parameters to the DescribeImport operation. Gets information about a specific import.

This is the response object from the DescribeImport operation.

Container for the parameters to the DescribeIntent operation. Returns metadata about an intent.

This is the response object from the DescribeIntent operation.

Container for the parameters to the DescribeResourcePolicy operation. Gets the resource policy and policy revision for a bot or bot alias.

This is the response object from the DescribeResourcePolicy operation.

Container for the parameters to the DescribeSlot operation. Gets metadata information about a slot.

This is the response object from the DescribeSlot operation.

Container for the parameters to the DescribeSlotType operation. Gets metadata information about a slot type.

This is the response object from the DescribeSlotType operation.

Container for the parameters to the DescribeTestExecution operation. Gets metadata information about the test execution.

This is the response object from the DescribeTestExecution operation.

Container for the parameters to the DescribeTestSetDiscrepancyReport operation. Gets metadata information about the test set discrepancy report.

This is the response object from the DescribeTestSetDiscrepancyReport operation.

Container for the parameters to the DescribeTestSetGeneration operation. Gets metadata information about the test set generation.

This is the response object from the DescribeTestSetGeneration operation.

Container for the parameters to the DescribeTestSet operation. Gets metadata information about the test set.

This is the response object from the DescribeTestSet operation.

Contains specifications for the descriptive bot building feature.

Defines the action that the bot executes at runtime when the conversation reaches this step.

Settings that specify the dialog code hook that is called by Amazon Lex at a step of the conversation.

Settings that determine the Lambda function that Amazon Lex uses for processing user responses.

The current state of the conversation with the user.

Specifies the DTMF input specifications.

Settings that specify the dialog code hook that is called by Amazon Lex between eliciting slot values.

The object representing the passwords that were used to encrypt the data related to the bot recommendation, as well as the KMS key ARN used to encrypt the associated metadata.

Contains the names of the fields used for an exact response to the user.

Details about an error in an execution of a test set.

Filters the response form the ListExports operation

Provides information about the bot or bot locale that you want to export. You can specify the botExportSpecification or the botLocaleExportSpecification, but not both.

Provides information about sorting a list of exports.

Provides summary information about an export in an export list.

Provides information about the external source of the slot type's definition.

The unique failed custom vocabulary item from the custom vocabulary list.

Determines if a Lambda function should be invoked for a specific intent.

Provides settings for a message that is sent to the user when a fulfillment Lambda function starts running.

Provides settings for a message that is sent periodically to the user while a fulfillment Lambda function is running.

Provides information for updating the user on the progress of fulfilling an intent.

Container for the parameters to the GenerateBotElement operation. Generates sample utterances for an intent.

This is the response object from the GenerateBotElement operation.

Specifies the attribute and method by which to sort the generation request information.

Contains information about a generation request made for the bot locale.

Contains specifications about the generative AI capabilities from Amazon Bedrock that you can turn on for your bot.

Container for the parameters to the GetTestExecutionArtifactsUrl operation. The pre-signed Amazon S3 URL to download the test execution result artifacts.

This is the response object from the GetTestExecutionArtifactsUrl operation.

Settings requried for a slot type based on a grammar that you provide.

Describes the Amazon S3 bucket name and location for the grammar that is the source for the slot type.

A card that is shown to the user by a messaging platform. You define the contents of the card, the card is displayed by the platform.

When you use a response card, the response from the user is constrained to the text associated with a button on the card.

Filters the response from the ListImports operation.

Provides information about the bot or bot locale that you want to import. You can specify the botImportSpecification or the botLocaleImportSpecification, but not both.

Provides information for sorting a list of imports.

Provides summary information about an import in an import list.

Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots.

A context that must be active for an intent to be selected by Amazon Lex.

Specifications for the current state of the dialog between the user and the bot in the test set.

Information for an intent that is classified by the test workbench.

The number of items in the intent classification test.

Information for the results of the intent classification test.

Provides a statement the Amazon Lex conveys to the user when the intent is successfully fulfilled.

Provides a prompt for making sure that the user is ready for the intent to be fulfilled.

Filters the response from the ListIntents operation.

Information about intent-level slot resolution in a test result.

Indicates the success or failure of slots at the intent level.

Override settings to configure the intent state.

Specifies attributes for sorting a list of intents.

The object that contains the statistical summary of recommended intents associated with the bot recommendation.

Summary information about an intent returned by the ListIntents operation.

The service encountered an unexpected condition. Try your request again.

An object containing the name of an intent that was invoked.

Provides configuration information for the AMAZON.KendraSearchIntent intent. When you use this intent, Amazon Lex searches the specified Amazon Kendra index and returns documents from the index that match the user's utterance.

Specifies a Lambda function that verifies requests to a bot or fulfills the user's request to a bot.

Paginators for the LexModelsV2 service

The object that contains transcript filter details that are associated with a bot recommendation.

Container for the parameters to the ListAggregatedUtterances operation. Provides a list of utterances that users have sent to the bot.

Utterances are aggregated by the text of the utterance. For example, all instances where customers used the phrase "I want to order pizza" are aggregated into the same line in the response.

You can see both detected utterances and missed utterances. A detected utterance is where the bot properly recognized the utterance and activated the associated intent. A missed utterance was not recognized by the bot and didn't activate an intent.

Utterances can be aggregated for a bot alias or for a bot version, but not both at the same time.

Utterances statistics are not generated under the following conditions:

• The childDirected field was set to true when the bot was created.

• You are using slot obfuscation with one or more slots.

• You opted out of participating in improving Amazon Lex.

This is the response object from the ListAggregatedUtterances operation.

Container for the parameters to the ListBotAliases operation. Gets a list of aliases for the specified bot.

This is the response object from the ListBotAliases operation.

Container for the parameters to the ListBotAliasReplicas operation. The action to list the replicated bots created from the source bot alias.

This is the response object from the ListBotAliasReplicas operation.

Container for the parameters to the ListBotLocales operation. Gets a list of locales for the specified bot.

This is the response object from the ListBotLocales operation.

Container for the parameters to the ListBotRecommendations operation. Get a list of bot recommendations that meet the specified criteria.

This is the response object from the ListBotRecommendations operation.

Container for the parameters to the ListBotReplicas operation. The action to list the replicated bots.

This is the response object from the ListBotReplicas operation.

Container for the parameters to the ListBotResourceGenerations operation. Lists the generation requests made for a bot locale.

This is the response object from the ListBotResourceGenerations operation.

Container for the parameters to the ListBots operation. Gets a list of available bots.

This is the response object from the ListBots operation.

Container for the parameters to the ListBotVersionReplicas operation. Contains information about all the versions replication statuses applicable for Global Resiliency.

This is the response object from the ListBotVersionReplicas operation.

Container for the parameters to the ListBotVersions operation. Gets information about all of the versions of a bot.

The ListBotVersions operation returns a summary of each version of a bot. For example, if a bot has three numbered versions, the ListBotVersions operation returns for summaries, one for each numbered version and one for the DRAFT version.

The ListBotVersions operation always returns at least one version, the DRAFT version.

This is the response object from the ListBotVersions operation.

Container for the parameters to the ListBuiltInIntents operation. Gets a list of built-in intents provided by Amazon Lex that you can use in your bot.

To use a built-in intent as a the base for your own intent, include the built-in intent signature in the parentIntentSignature parameter when you call the CreateIntent operation. For more information, see CreateIntent.

This is the response object from the ListBuiltInIntents operation.

Container for the parameters to the ListBuiltInSlotTypes operation. Gets a list of built-in slot types that meet the specified criteria.

This is the response object from the ListBuiltInSlotTypes operation.

Container for the parameters to the ListCustomVocabularyItems operation. Paginated list of custom vocabulary items for a given bot locale's custom vocabulary.

This is the response object from the ListCustomVocabularyItems operation.

Container for the parameters to the ListExports operation. Lists the exports for a bot, bot locale, or custom vocabulary. Exports are kept in the list for 7 days.

This is the response object from the ListExports operation.

Container for the parameters to the ListImports operation. Lists the imports for a bot, bot locale, or custom vocabulary. Imports are kept in the list for 7 days.

This is the response object from the ListImports operation.

Container for the parameters to the ListIntentMetrics operation. Retrieves summary metrics for the intents in your bot. The following fields are required:

• metrics – A list of AnalyticsIntentMetric objects. In each object, use the name field to specify the metric to calculate, the statistic field to specify whether to calculate the Sum, Average, or Max number, and the order field to specify whether to sort the results in Ascending or Descending order.

• startDateTime and endDateTime – Define a time range for which you want to retrieve results.

Of the optional fields, you can organize the results in the following ways:

• Use the filters field to filter the results, the groupBy field to specify categories by which to group the results, and the binBy field to specify time intervals by which to group the results.

• Use the maxResults field to limit the number of results to return in a single response and the nextToken field to return the next batch of results if the response does not return the full set of results.

Note that an order field exists in both binBy and metrics. You can specify only one order in a given request.

This is the response object from the ListIntentMetrics operation.

Container for the parameters to the ListIntentPaths operation. Retrieves summary statistics for a path of intents that users take over sessions with your bot. The following fields are required:

• startDateTime and endDateTime – Define a time range for which you want to retrieve results.

• intentPath – Define an order of intents for which you want to retrieve metrics. Separate intents in the path with a forward slash. For example, populate the intentPath field with /BookCar/BookHotel to see details about how many times users invoked the BookCar and BookHotel intents in that order.

Use the optional filters field to filter the results.

This is the response object from the ListIntentPaths operation.

Container for the parameters to the ListIntents operation. Get a list of intents that meet the specified criteria.

This is the response object from the ListIntents operation.

Container for the parameters to the ListIntentStageMetrics operation. Retrieves summary metrics for the stages within intents in your bot. The following fields are required:

• metrics – A list of AnalyticsIntentStageMetric objects. In each object, use the name field to specify the metric to calculate, the statistic field to specify whether to calculate the Sum, Average, or Max number, and the order field to specify whether to sort the results in Ascending or Descending order.

• startDateTime and endDateTime – Define a time range for which you want to retrieve results.

Of the optional fields, you can organize the results in the following ways:

• Use the filters field to filter the results, the groupBy field to specify categories by which to group the results, and the binBy field to specify time intervals by which to group the results.

• Use the maxResults field to limit the number of results to return in a single response and the nextToken field to return the next batch of results if the response does not return the full set of results.

Note that an order field exists in both binBy and metrics. You can only specify one order in a given request.

This is the response object from the ListIntentStageMetrics operation.

Container for the parameters to the ListRecommendedIntents operation. Gets a list of recommended intents provided by the bot recommendation that you can use in your bot. Intents in the response are ordered by relevance.

This is the response object from the ListRecommendedIntents operation.

Container for the parameters to the ListSessionAnalyticsData operation. Retrieves a list of metadata for individual user sessions with your bot. The startDateTime and endDateTime fields are required. These fields define a time range for which you want to retrieve results. Of the optional fields, you can organize the results in the following ways:

• Use the filters field to filter the results and the sortBy field to specify the values by which to sort the results.

• Use the maxResults field to limit the number of results to return in a single response and the nextToken field to return the next batch of results if the response does not return the full set of results.

This is the response object from the ListSessionAnalyticsData operation.

Container for the parameters to the ListSessionMetrics operation. Retrieves summary metrics for the user sessions with your bot. The following fields are required:

• metrics – A list of AnalyticsSessionMetric objects. In each object, use the name field to specify the metric to calculate, the statistic field to specify whether to calculate the Sum, Average, or Max number, and the order field to specify whether to sort the results in Ascending or Descending order.

• startDateTime and endDateTime – Define a time range for which you want to retrieve results.

Of the optional fields, you can organize the results in the following ways:

• Use the filters field to filter the results, the groupBy field to specify categories by which to group the results, and the binBy field to specify time intervals by which to group the results.

• Use the maxResults field to limit the number of results to return in a single response and the nextToken field to return the next batch of results if the response does not return the full set of results.

Note that an order field exists in both binBy and metrics. Currently, you can specify it in either field, but not in both.

This is the response object from the ListSessionMetrics operation.

Container for the parameters to the ListSlots operation. Gets a list of slots that match the specified criteria.

This is the response object from the ListSlots operation.

Container for the parameters to the ListSlotTypes operation. Gets a list of slot types that match the specified criteria.

This is the response object from the ListSlotTypes operation.

Container for the parameters to the ListTagsForResource operation. Gets a list of tags associated with a resource. Only bots, bot aliases, and bot channels can have tags associated with them.

This is the response object from the ListTagsForResource operation.

Container for the parameters to the ListTestExecutionResultItems operation. Gets a list of test execution result items.

This is the response object from the ListTestExecutionResultItems operation.

Container for the parameters to the ListTestExecutions operation. The list of test set executions.

This is the response object from the ListTestExecutions operation.

Container for the parameters to the ListTestSetRecords operation. The list of test set records.

This is the response object from the ListTestSetRecords operation.

Container for the parameters to the ListTestSets operation. The list of the test sets

This is the response object from the ListTestSets operation.

Container for the parameters to the ListUtteranceAnalyticsData operation.

To use this API operation, your IAM role must have permissions to perform the ListAggregatedUtterances operation, which provides access to utterance-related analytics. See Viewing utterance statistics for the IAM policy to apply to the IAM role.

Retrieves a list of metadata for individual user utterances to your bot. The following fields are required:

• startDateTime and endDateTime – Define a time range for which you want to retrieve results.

Of the optional fields, you can organize the results in the following ways:

• Use the filters field to filter the results and the sortBy field to specify the values by which to sort the results.

• Use the maxResults field to limit the number of results to return in a single response and the nextToken field to return the next batch of results if the response does not return the full set of results.

This is the response object from the ListUtteranceAnalyticsData operation.

Container for the parameters to the ListUtteranceMetrics operation.

To use this API operation, your IAM role must have permissions to perform the ListAggregatedUtterances operation, which provides access to utterance-related analytics. See Viewing utterance statistics for the IAM policy to apply to the IAM role.

Retrieves summary metrics for the utterances in your bot. The following fields are required:

• metrics – A list of AnalyticsUtteranceMetric objects. In each object, use the name field to specify the metric to calculate, the statistic field to specify whether to calculate the Sum, Average, or Max number, and the order field to specify whether to sort the results in Ascending or Descending order.

• startDateTime and endDateTime – Define a time range for which you want to retrieve results.

Of the optional fields, you can organize the results in the following ways:

• Use the filters field to filter the results, the groupBy field to specify categories by which to group the results, and the binBy field to specify time intervals by which to group the results.

• Use the maxResults field to limit the number of results to return in a single response and the nextToken field to return the next batch of results if the response does not return the full set of results.

Note that an order field exists in both binBy and metrics. Currently, you can specify it in either field, but not in both.

This is the response object from the ListUtteranceMetrics operation.

The object that provides message text and its type.

Provides one or more messages that Amazon Lex should send to the user.

Indicates whether a slot can return multiple values.

The new custom vocabulary item from the custom vocabulary list.

Determines whether Amazon Lex obscures slot values in conversation logs.

Contains details about the configuration of the Amazon OpenSearch Service database used for the AMAZON.QnAIntent.

Describes a session context that is activated when an intent is fulfilled.

Information about the overall results for a test execution result.

Information about the overall test results.

A network of bots.

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.

Defines an ASCII text message to send to the user.

Specifies next steps to run after the dialog code hook finishes.

Provides a setting that determines whether the post-fulfillment response is sent to the user. For more information, see https://docs.aws.amazon.com/lexv2/latest/dg/streaming-progress.html#progress-complete

Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

The IAM principal that you allowing or denying access to an Amazon Lex action. You must provide a service or an arn, but not both in the same statement. For more information, see AWS JSON policy elements: Principal .

Specifies the settings on a prompt attempt.

Specifies a list of message groups that Amazon Lex sends to a user to elicit a response.

Details about the the configuration of the built-in Amazon.QnAIntent.

Contains details about the configuration of the Amazon Kendra index used for the AMAZON.QnAIntent.

An object that contains a summary of a recommended intent.

Specifies the time window that utterance statistics are returned for. The time window is always relative to the last time that the that utterances were aggregated. For example, if the ListAggregatedUtterances operation is called at 1600, the time window is set to 1 hour, and the last refresh time was 1530, only utterances made between 1430 and 1530 are returned.

You can choose the time window that statistics should be returned for.

• Hours - You can request utterance statistics for 1, 3, 6, 12, or 24 hour time windows. Statistics are refreshed every half hour for 1 hour time windows, and hourly for the other time windows.

• Days - You can request utterance statistics for 3 days. Statistics are refreshed every 6 hours.

• Weeks - You can see statistics for one or two weeks. Statistics are refreshed every 12 hours for one week time windows, and once per day for two week time windows.

You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.

Specifies a list of message groups that Amazon Lex uses to respond the user input.

Provides an array of phrases that should be given preference when resolving values for a slot.

You can provide Amazon Lex with hints to the phrases that a customer is likely to use for a slot. When a slot with hints is resolved, the phrases in the runtime hints are preferred in the resolution. You can provide hints for a maximum of 100 intents. You can provide a maximum of 100 slots.

Before you can use runtime hints with an existing bot, you must first rebuild the bot.

For more information, see Using runtime hints to improve recognition of slot values.

Provides the phrase that Amazon Lex should look for in the user's input to the bot.

Contains specifications about the Amazon Lex runtime generative AI capabilities from Amazon Bedrock that you can turn on for your bot.

Specifies an Amazon S3 bucket for logging audio conversations

The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.

A sample utterance that invokes an intent or respond to a slot elicitation prompt.

Contains specifications for the sample utterance generation feature.

Defines one of the values for a slot type.

Container for the parameters to the SearchAssociatedTranscripts operation. Search for associated transcripts that meet the specified criteria.

This is the response object from the SearchAssociatedTranscripts operation.

Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.

You have reached a quota for your bot.

An object specifying the measure and method by which to sort the session analytics data.

An object containing information about a specific session.

Settings used when Amazon Lex successfully captures a slot value from a user.

Specifies the default value to use when a user doesn't provide a value for a slot.

Defines a list of values that Amazon Lex should use as the default value for a slot.

Filters the response from the ListSlots operation.

Sets the priority that Amazon Lex should use when eliciting slot values from a user.

Contains specifications for the assisted slot resolution feature.

Contains information about whether assisted slot resolution is turned on for the slot or not.

Information about the success and failure rate of slot resolution in the results of a test execution.

Information about the counts for a slot resolution in the results of a test execution.

Specifies attributes for sorting a list of bots.

Summary information about a slot, a value that the bot elicits from the user.

Filters the response from the ListSlotTypes operation.

Specifies attributes for sorting a list of slot types.

The object that contains the statistical summary of the recommended slot type associated with the bot recommendation.

Provides summary information about a slot type.

Each slot type can have a set of values. Each SlotTypeValue represents a value that the slot type can take.

The value to set in a slot.

Specifies the elicitation setting details eliciting a slot.

The slot values that Amazon Lex uses when it sets slot values in a dialog step.

Provides a regular expression used to validate the value of a slot.

Contains settings used by Amazon Lex to select a slot value.

Subslot specifications.

Defines a Speech Synthesis Markup Language (SSML) prompt.

Container for the parameters to the StartBotRecommendation operation. Use this to provide your transcript data, and to start the bot recommendation process.

This is the response object from the StartBotRecommendation operation.

Container for the parameters to the StartBotResourceGeneration operation. Starts a request for the descriptive bot builder to generate a bot locale configuration based on the prompt you provide it. After you make this call, use the DescribeBotResourceGeneration operation to check on the status of the generation and for the generatedBotLocaleUrl when the generation is complete. Use that value to retrieve the Amazon S3 object containing the bot locale configuration. You can then modify and import this configuration.

This is the response object from the StartBotResourceGeneration operation.

Container for the parameters to the StartImport operation. Starts importing a bot, bot locale, or custom vocabulary from a zip archive that you uploaded to an S3 bucket.

This is the response object from the StartImport operation.

Container for the parameters to the StartTestExecution operation. The action to start test set execution.

This is the response object from the StartTestExecution operation.

Container for the parameters to the StartTestSetGeneration operation. The action to start the generation of test set.

This is the response object from the StartTestSetGeneration operation.

Defines the messages that Amazon Lex sends to a user to remind them that the bot is waiting for a response.

Container for the parameters to the StopBotRecommendation operation. Stop an already running Bot Recommendation request.

This is the response object from the StopBotRecommendation operation.

Specifications for the constituent sub slots and the expression for the composite slot.

Subslot type composition.

Subslot elicitation settings.

DefaultValueSpecification is a list of default values for a constituent sub slot in a composite 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. This is similar to DefaultValueSpecification for slots.

PromptSpecification is the prompt that Amazon Lex uses to elicit the sub slot value from the user. This is similar to PromptSpecification for slots.

Container for the parameters to the TagResource operation. Adds the specified tags to the specified resource. If a tag key already exists, the existing value is replaced with the new value.

This is the response object from the TagResource operation.

Contains information about the method by which to filter the results of the test execution.

Contains the results of the test execution, grouped by type of results. See Test result details">Test results details for details about different types of results.

Contains information about the method by which to sort the instances of test executions you have carried out.

Summarizes metadata about the test execution.

Contains information about the bot used for the test execution.

Contains details about the errors in the test set discrepancy report

Contains information about the bot alias used for the test set discrepancy report.

Contains information about the resource used for the test set discrepancy report.

Contains information about the test set that is exported.

Contains information about the data source from which the test set is generated.

Contains information about the Amazon S3 location from which the test set is imported.

Contains information about the test set that is imported.

Contains information about discrepancy in an intent information between the test set and the bot.

Contains information about discrepancy in a slot information between the test set and the bot.

Contains information about the methods by which to sort the test set.

Contains information about the location in which the test set is stored.

Contains summary information about the test set.

Contains information about a turn in a test set.

Contains information about the results of the analysis of a turn in the test set.

Specifies the text input specifications.

Defines the Amazon CloudWatch Logs destination log group for conversation text logs.

Defines settings to enable text conversation logs.

Your request rate is too high. Reduce the frequency of requests.

The object representing the filter that Amazon Lex will use to select the appropriate transcript.

Indicates the setting of the location where the transcript is stored.

Contains information about the messages in the turn.

Container for the parameters to the UntagResource operation. Removes tags from a bot, bot alias, or bot channel.

This is the response object from the UntagResource operation.

Container for the parameters to the UpdateBotAlias operation. Updates the configuration of an existing bot alias.

This is the response object from the UpdateBotAlias operation.

Container for the parameters to the UpdateBotLocale operation. Updates the settings that a bot has for a specific locale.

This is the response object from the UpdateBotLocale operation.

Container for the parameters to the UpdateBotRecommendation operation. Updates an existing bot recommendation request.

This is the response object from the UpdateBotRecommendation operation.

Container for the parameters to the UpdateBot operation. Updates the configuration of an existing bot.

This is the response object from the UpdateBot operation.

Container for the parameters to the UpdateExport operation. Updates the password used to protect an export zip archive.

The password is not required. If you don't supply a password, Amazon Lex generates a zip file that is not protected by a password. This is the archive that is available at the pre-signed S3 URL provided by the DescribeExport operation.

This is the response object from the UpdateExport operation.

Container for the parameters to the UpdateIntent operation. Updates the settings for an intent.

This is the response object from the UpdateIntent operation.

Container for the parameters to the UpdateResourcePolicy operation. Replaces the existing resource policy for a bot or bot alias with a new one. If the policy doesn't exist, Amazon Lex returns an exception.

This is the response object from the UpdateResourcePolicy operation.

Container for the parameters to the UpdateSlot operation. Updates the settings for a slot.

This is the response object from the UpdateSlot operation.

Container for the parameters to the UpdateSlotType operation. Updates the configuration of an existing slot type.

This is the response object from the UpdateSlotType operation.

Container for the parameters to the UpdateTestSet operation. The action to update the test set.

This is the response object from the UpdateTestSet operation.

Contains information about the user messages in the turn in the input.

Contains information about the intent that is output for the turn by the test execution.

Contains results that are output for the user turn by the test execution.

Contains the results for the user turn by the test execution.

Contains information about a slot output by the test set execution.

Contains information about the expected and input values for the user turn.

Provides parameters for setting the time window and duration for aggregating utterance data.

Contains information about the audio for an utterance.

An object that contains a response to the utterance from the bot.

An object specifying the measure and method by which to sort the utterance data.

Contains information about input of an utterance.

Contains information about multiple utterances in the results of a test set execution.

Contains information about the utterances in the results of the test set execution.

An object containing information about a specific utterance.

One of the input parameters in your request isn't valid. Check the parameters and try your request again.

Defines settings for using an Amazon Polly voice to communicate with a user.

Valid values include:

• standard

• neural

• long-form

• generative

Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.

Paginators for the LexModelsV2 service

Paginator for the ListAggregatedUtterances operation

Paginator for the ListBotAliases operation

Paginator for the ListBotAliasReplicas operation

Paginator for the ListBotLocales operation

Paginator for the ListBotRecommendations operation

Paginator for the ListBotResourceGenerations operation

Paginator for the ListBots operation

Paginator for the ListBotVersionReplicas operation

Paginator for the ListBotVersions operation

Paginator for the ListBuiltInIntents operation

Paginator for the ListBuiltInSlotTypes operation

Paginator for the ListCustomVocabularyItems operation

Paginator for the ListExports operation

Paginator for the ListImports operation

Paginator for the ListIntentMetrics operation

Paginator for the ListIntents operation

Paginator for the ListIntentStageMetrics operation

Paginator for the ListRecommendedIntents operation

Paginator for the ListSessionAnalyticsData operation

Paginator for the ListSessionMetrics operation

Paginator for the ListSlots operation

Paginator for the ListSlotTypes operation

Paginator for the ListTestExecutionResultItems operation

Paginator for the ListTestExecutions operation

Paginator for the ListTestSetRecords operation

Paginator for the ListTestSets operation

Paginator for the ListUtteranceAnalyticsData operation

Paginator for the ListUtteranceMetrics operation