View Source aws_lex_models_v2 (aws v1.0.4)

Summary

Functions

Create a batch of custom vocabulary items for a given bot locale's custom vocabulary.
Delete a batch of custom vocabulary items for a given bot locale's custom vocabulary.
Update a batch of custom vocabulary items for a given bot locale's custom vocabulary.

Builds a bot, its intents, and its slot types into a specific locale.

Creates an Amazon Lex conversational bot.

Creates an alias for the specified version of a bot.

Action to create a replication of the source bot in the secondary region.

Creates an immutable version of the bot.

Creates a zip archive containing the contents of a bot or a bot locale.

Creates a new resource policy with the specified policy statements.

Adds a new resource policy statement to a bot or bot alias.

Create a report that describes the differences between the bot and the test set.
Gets a pre-signed S3 write URL that you use to upload the zip archive when importing a bot or a bot locale.

Deletes all versions of a bot, including the Draft version.

Deletes the specified bot alias.
The action to delete the replicated bot in the secondary region.

Deletes a specific version of a bot.

Removes a custom vocabulary from the specified locale in the specified bot.
Removes a previous export and the associated files stored in an S3 bucket.
Removes a previous import and the associated file stored in an S3 bucket.

Removes an existing policy from a bot or bot alias.

Deletes a policy statement from a resource policy.

The action to delete the selected test set.

Deletes stored utterances.

Provides metadata information about a bot.
Get information about a specific bot alias.
Describes the settings that a bot has for a specific locale.

Provides metadata information about a bot recommendation.

Monitors the bot replication status through the UI console.

Returns information about a request to generate a bot through natural language description, made through the StartBotResource API.

Provides metadata about a version of a bot.
Provides metadata information about a custom vocabulary.
Gets information about a specific export.
Gets information about a specific import.
Gets the resource policy and policy revision for a bot or bot alias.
Gets metadata information about a slot type.
Gets metadata information about the test execution.
Gets metadata information about the test set.
Gets metadata information about the test set discrepancy report.
Gets metadata information about the test set generation.
Generates sample utterances for an intent.
The pre-signed Amazon S3 URL to download the test execution result artifacts.

Provides a list of utterances that users have sent to the bot.

The action to list the replicated bots created from the source bot alias.
Gets a list of aliases for the specified bot.
Gets a list of locales for the specified bot.
Get a list of bot recommendations that meet the specified criteria.
The action to list the replicated bots.
Lists the generation requests made for a bot locale.
Contains information about all the versions replication statuses applicable for Global Resiliency.

Gets information about all of the versions of a bot.

Gets a list of available bots.

Gets a list of built-in intents provided by Amazon Lex that you can use in your bot.

Gets a list of built-in slot types that meet the specified criteria.
Paginated list of custom vocabulary items for a given bot locale's custom vocabulary.

Lists the exports for a bot, bot locale, or custom vocabulary.

Lists the imports for a bot, bot locale, or custom vocabulary.

Retrieves summary metrics for the intents in your bot.

Retrieves summary statistics for a path of intents that users take over sessions with your bot.

Retrieves summary metrics for the stages within intents in your bot.

Get a list of intents that meet the specified criteria.

Gets a list of recommended intents provided by the bot recommendation that you can use in your bot.

Retrieves a list of metadata for individual user sessions with your bot.

Retrieves summary metrics for the user sessions with your bot.

Gets a list of slot types that match the specified criteria.
Gets a list of slots that match the specified criteria.

Gets a list of tags associated with a resource.

Gets a list of test execution result items.
The list of test set executions.
The list of test set records.
The list of the test sets

To use this API operation, your IAM role must have permissions to perform the ListAggregatedUtterances: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListAggregatedUtterances.html operation, which provides access to utterance-related analytics.

To use this API operation, your IAM role must have permissions to perform the ListAggregatedUtterances: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListAggregatedUtterances.html operation, which provides access to utterance-related analytics.

Search for associated transcripts that meet the specified criteria.
Use this to provide your transcript data, and to start the bot recommendation process.

Starts a request for the descriptive bot builder to generate a bot locale configuration based on the prompt you provide it.

Starts importing a bot, bot locale, or custom vocabulary from a zip archive that you uploaded to an S3 bucket.
The action to start test set execution.
The action to start the generation of test set.

Adds the specified tags to the specified resource.

Removes tags from a bot, bot alias, or bot channel.
Updates the configuration of an existing bot.
Updates the configuration of an existing bot alias.
Updates the settings that a bot has for a specific locale.

Updates the password used to protect an export zip archive.

Replaces the existing resource policy for a bot or bot alias with a new one.

Updates the configuration of an existing slot type.
The action to update the test set.

Functions

Link to this function

batch_create_custom_vocabulary_item(Client, BotId, BotVersion, LocaleId, Input)

View Source
Create a batch of custom vocabulary items for a given bot locale's custom vocabulary.
Link to this function

batch_create_custom_vocabulary_item(Client, BotId, BotVersion, LocaleId, Input0, Options0)

View Source
Link to this function

batch_delete_custom_vocabulary_item(Client, BotId, BotVersion, LocaleId, Input)

View Source
Delete a batch of custom vocabulary items for a given bot locale's custom vocabulary.
Link to this function

batch_delete_custom_vocabulary_item(Client, BotId, BotVersion, LocaleId, Input0, Options0)

View Source
Link to this function

batch_update_custom_vocabulary_item(Client, BotId, BotVersion, LocaleId, Input)

View Source
Update a batch of custom vocabulary items for a given bot locale's custom vocabulary.
Link to this function

batch_update_custom_vocabulary_item(Client, BotId, BotVersion, LocaleId, Input0, Options0)

View Source
Link to this function

build_bot_locale(Client, BotId, BotVersion, LocaleId, Input)

View Source

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.
Link to this function

build_bot_locale(Client, BotId, BotVersion, LocaleId, Input0, Options0)

View Source
Link to this function

create_bot(Client, Input)

View Source
Creates an Amazon Lex conversational bot.
Link to this function

create_bot(Client, Input0, Options0)

View Source
Link to this function

create_bot_alias(Client, BotId, Input)

View Source

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.
Link to this function

create_bot_alias(Client, BotId, Input0, Options0)

View Source
Link to this function

create_bot_locale(Client, BotId, BotVersion, Input)

View Source

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.
Link to this function

create_bot_locale(Client, BotId, BotVersion, Input0, Options0)

View Source
Link to this function

create_bot_replica(Client, BotId, Input)

View Source
Action to create a replication of the source bot in the secondary region.
Link to this function

create_bot_replica(Client, BotId, Input0, Options0)

View Source
Link to this function

create_bot_version(Client, BotId, Input)

View Source

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.
Link to this function

create_bot_version(Client, BotId, Input0, Options0)

View Source
Link to this function

create_export(Client, Input)

View Source

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 : https://docs.aws.amazon.com/lexv2/latest/dg/importing-exporting.html
Link to this function

create_export(Client, Input0, Options0)

View Source
Link to this function

create_intent(Client, BotId, BotVersion, LocaleId, Input)

View Source

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

Link to this function

create_intent(Client, BotId, BotVersion, LocaleId, Input0, Options0)

View Source
Link to this function

create_resource_policy(Client, ResourceArn, Input)

View Source
Creates a new resource policy with the specified policy statements.
Link to this function

create_resource_policy(Client, ResourceArn, Input0, Options0)

View Source
Link to this function

create_resource_policy_statement(Client, ResourceArn, Input)

View Source

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.
Link to this function

create_resource_policy_statement(Client, ResourceArn, Input0, Options0)

View Source
Link to this function

create_slot(Client, BotId, BotVersion, IntentId, LocaleId, Input)

View Source

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.
Link to this function

create_slot(Client, BotId, BotVersion, IntentId, LocaleId, Input0, Options0)

View Source
Link to this function

create_slot_type(Client, BotId, BotVersion, LocaleId, Input)

View Source

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.
Link to this function

create_slot_type(Client, BotId, BotVersion, LocaleId, Input0, Options0)

View Source
Link to this function

create_test_set_discrepancy_report(Client, TestSetId, Input)

View Source
Create a report that describes the differences between the bot and the test set.
Link to this function

create_test_set_discrepancy_report(Client, TestSetId, Input0, Options0)

View Source
Link to this function

create_upload_url(Client, Input)

View Source
Gets a pre-signed S3 write URL that you use to upload the zip archive when importing a bot or a bot locale.
Link to this function

create_upload_url(Client, Input0, Options0)

View Source
Link to this function

delete_bot(Client, BotId, Input)

View Source

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.
Link to this function

delete_bot(Client, BotId, Input0, Options0)

View Source
Link to this function

delete_bot_alias(Client, BotAliasId, BotId, Input)

View Source
Deletes the specified bot alias.
Link to this function

delete_bot_alias(Client, BotAliasId, BotId, Input0, Options0)

View Source
Link to this function

delete_bot_locale(Client, BotId, BotVersion, LocaleId, Input)

View Source

Removes a locale from a bot.

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

delete_bot_locale(Client, BotId, BotVersion, LocaleId, Input0, Options0)

View Source
Link to this function

delete_bot_replica(Client, BotId, ReplicaRegion, Input)

View Source
The action to delete the replicated bot in the secondary region.
Link to this function

delete_bot_replica(Client, BotId, ReplicaRegion, Input0, Options0)

View Source
Link to this function

delete_bot_version(Client, BotId, BotVersion, Input)

View Source

Deletes a specific version of a bot.

To delete all versions of a bot, use the DeleteBot: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DeleteBot.html operation.
Link to this function

delete_bot_version(Client, BotId, BotVersion, Input0, Options0)

View Source
Link to this function

delete_custom_vocabulary(Client, BotId, BotVersion, LocaleId, Input)

View Source
Removes a custom vocabulary from the specified locale in the specified bot.
Link to this function

delete_custom_vocabulary(Client, BotId, BotVersion, LocaleId, Input0, Options0)

View Source
Link to this function

delete_export(Client, ExportId, Input)

View Source
Removes a previous export and the associated files stored in an S3 bucket.
Link to this function

delete_export(Client, ExportId, Input0, Options0)

View Source
Link to this function

delete_import(Client, ImportId, Input)

View Source
Removes a previous import and the associated file stored in an S3 bucket.
Link to this function

delete_import(Client, ImportId, Input0, Options0)

View Source
Link to this function

delete_intent(Client, BotId, BotVersion, IntentId, LocaleId, Input)

View Source

Removes the specified intent.

Deleting an intent also deletes the slots associated with the intent.
Link to this function

delete_intent(Client, BotId, BotVersion, IntentId, LocaleId, Input0, Options0)

View Source
Link to this function

delete_resource_policy(Client, ResourceArn, Input)

View Source

Removes an existing policy from a bot or bot alias.

If the resource doesn't have a policy attached, Amazon Lex returns an exception.
Link to this function

delete_resource_policy(Client, ResourceArn, Input0, Options0)

View Source
Link to this function

delete_resource_policy_statement(Client, ResourceArn, StatementId, Input)

View Source

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.
Link to this function

delete_resource_policy_statement(Client, ResourceArn, StatementId, Input0, Options0)

View Source
Link to this function

delete_slot(Client, BotId, BotVersion, IntentId, LocaleId, SlotId, Input)

View Source
Deletes the specified slot from an intent.
Link to this function

delete_slot(Client, BotId, BotVersion, IntentId, LocaleId, SlotId, Input0, Options0)

View Source
Link to this function

delete_slot_type(Client, BotId, BotVersion, LocaleId, SlotTypeId, Input)

View Source

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.
Link to this function

delete_slot_type(Client, BotId, BotVersion, LocaleId, SlotTypeId, Input0, Options0)

View Source
Link to this function

delete_test_set(Client, TestSetId, Input)

View Source
The action to delete the selected test set.
Link to this function

delete_test_set(Client, TestSetId, Input0, Options0)

View Source
Link to this function

delete_utterances(Client, BotId, Input)

View Source

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: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListAggregatedUtterances.html 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.
Link to this function

delete_utterances(Client, BotId, Input0, Options0)

View Source
Link to this function

describe_bot(Client, BotId)

View Source
Provides metadata information about a bot.
Link to this function

describe_bot(Client, BotId, QueryMap, HeadersMap)

View Source
Link to this function

describe_bot(Client, BotId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

describe_bot_alias(Client, BotAliasId, BotId)

View Source
Get information about a specific bot alias.
Link to this function

describe_bot_alias(Client, BotAliasId, BotId, QueryMap, HeadersMap)

View Source
Link to this function

describe_bot_alias(Client, BotAliasId, BotId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

describe_bot_locale(Client, BotId, BotVersion, LocaleId)

View Source
Describes the settings that a bot has for a specific locale.
Link to this function

describe_bot_locale(Client, BotId, BotVersion, LocaleId, QueryMap, HeadersMap)

View Source
Link to this function

describe_bot_locale(Client, BotId, BotVersion, LocaleId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

describe_bot_recommendation(Client, BotId, BotRecommendationId, BotVersion, LocaleId)

View Source

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.
Link to this function

describe_bot_recommendation(Client, BotId, BotRecommendationId, BotVersion, LocaleId, QueryMap, HeadersMap)

View Source
Link to this function

describe_bot_recommendation(Client, BotId, BotRecommendationId, BotVersion, LocaleId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

describe_bot_replica(Client, BotId, ReplicaRegion)

View Source
Monitors the bot replication status through the UI console.
Link to this function

describe_bot_replica(Client, BotId, ReplicaRegion, QueryMap, HeadersMap)

View Source
Link to this function

describe_bot_replica(Client, BotId, ReplicaRegion, QueryMap, HeadersMap, Options0)

View Source
Link to this function

describe_bot_resource_generation(Client, BotId, BotVersion, GenerationId, LocaleId)

View Source

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.
Link to this function

describe_bot_resource_generation(Client, BotId, BotVersion, GenerationId, LocaleId, QueryMap, HeadersMap)

View Source
Link to this function

describe_bot_resource_generation(Client, BotId, BotVersion, GenerationId, LocaleId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

describe_bot_version(Client, BotId, BotVersion)

View Source
Provides metadata about a version of a bot.
Link to this function

describe_bot_version(Client, BotId, BotVersion, QueryMap, HeadersMap)

View Source
Link to this function

describe_bot_version(Client, BotId, BotVersion, QueryMap, HeadersMap, Options0)

View Source
Link to this function

describe_custom_vocabulary_metadata(Client, BotId, BotVersion, LocaleId)

View Source
Provides metadata information about a custom vocabulary.
Link to this function

describe_custom_vocabulary_metadata(Client, BotId, BotVersion, LocaleId, QueryMap, HeadersMap)

View Source
Link to this function

describe_custom_vocabulary_metadata(Client, BotId, BotVersion, LocaleId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

describe_export(Client, ExportId)

View Source
Gets information about a specific export.
Link to this function

describe_export(Client, ExportId, QueryMap, HeadersMap)

View Source
Link to this function

describe_export(Client, ExportId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

describe_import(Client, ImportId)

View Source
Gets information about a specific import.
Link to this function

describe_import(Client, ImportId, QueryMap, HeadersMap)

View Source
Link to this function

describe_import(Client, ImportId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

describe_intent(Client, BotId, BotVersion, IntentId, LocaleId)

View Source
Returns metadata about an intent.
Link to this function

describe_intent(Client, BotId, BotVersion, IntentId, LocaleId, QueryMap, HeadersMap)

View Source
Link to this function

describe_intent(Client, BotId, BotVersion, IntentId, LocaleId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

describe_resource_policy(Client, ResourceArn)

View Source
Gets the resource policy and policy revision for a bot or bot alias.
Link to this function

describe_resource_policy(Client, ResourceArn, QueryMap, HeadersMap)

View Source
Link to this function

describe_resource_policy(Client, ResourceArn, QueryMap, HeadersMap, Options0)

View Source
Link to this function

describe_slot(Client, BotId, BotVersion, IntentId, LocaleId, SlotId)

View Source
Gets metadata information about a slot.
Link to this function

describe_slot(Client, BotId, BotVersion, IntentId, LocaleId, SlotId, QueryMap, HeadersMap)

View Source
Link to this function

describe_slot(Client, BotId, BotVersion, IntentId, LocaleId, SlotId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

describe_slot_type(Client, BotId, BotVersion, LocaleId, SlotTypeId)

View Source
Gets metadata information about a slot type.
Link to this function

describe_slot_type(Client, BotId, BotVersion, LocaleId, SlotTypeId, QueryMap, HeadersMap)

View Source
Link to this function

describe_slot_type(Client, BotId, BotVersion, LocaleId, SlotTypeId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

describe_test_execution(Client, TestExecutionId)

View Source
Gets metadata information about the test execution.
Link to this function

describe_test_execution(Client, TestExecutionId, QueryMap, HeadersMap)

View Source
Link to this function

describe_test_execution(Client, TestExecutionId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

describe_test_set(Client, TestSetId)

View Source
Gets metadata information about the test set.
Link to this function

describe_test_set(Client, TestSetId, QueryMap, HeadersMap)

View Source
Link to this function

describe_test_set(Client, TestSetId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

describe_test_set_discrepancy_report(Client, TestSetDiscrepancyReportId)

View Source
Gets metadata information about the test set discrepancy report.
Link to this function

describe_test_set_discrepancy_report(Client, TestSetDiscrepancyReportId, QueryMap, HeadersMap)

View Source
Link to this function

describe_test_set_discrepancy_report(Client, TestSetDiscrepancyReportId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

describe_test_set_generation(Client, TestSetGenerationId)

View Source
Gets metadata information about the test set generation.
Link to this function

describe_test_set_generation(Client, TestSetGenerationId, QueryMap, HeadersMap)

View Source
Link to this function

describe_test_set_generation(Client, TestSetGenerationId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

generate_bot_element(Client, BotId, BotVersion, LocaleId, Input)

View Source
Generates sample utterances for an intent.
Link to this function

generate_bot_element(Client, BotId, BotVersion, LocaleId, Input0, Options0)

View Source
Link to this function

get_test_execution_artifacts_url(Client, TestExecutionId)

View Source
The pre-signed Amazon S3 URL to download the test execution result artifacts.
Link to this function

get_test_execution_artifacts_url(Client, TestExecutionId, QueryMap, HeadersMap)

View Source
Link to this function

get_test_execution_artifacts_url(Client, TestExecutionId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_aggregated_utterances(Client, BotId, Input)

View Source

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.

Link to this function

list_aggregated_utterances(Client, BotId, Input0, Options0)

View Source
Link to this function

list_bot_alias_replicas(Client, BotId, ReplicaRegion, Input)

View Source
The action to list the replicated bots created from the source bot alias.
Link to this function

list_bot_alias_replicas(Client, BotId, ReplicaRegion, Input0, Options0)

View Source
Link to this function

list_bot_aliases(Client, BotId, Input)

View Source
Gets a list of aliases for the specified bot.
Link to this function

list_bot_aliases(Client, BotId, Input0, Options0)

View Source
Link to this function

list_bot_locales(Client, BotId, BotVersion, Input)

View Source
Gets a list of locales for the specified bot.
Link to this function

list_bot_locales(Client, BotId, BotVersion, Input0, Options0)

View Source
Link to this function

list_bot_recommendations(Client, BotId, BotVersion, LocaleId, Input)

View Source
Get a list of bot recommendations that meet the specified criteria.
Link to this function

list_bot_recommendations(Client, BotId, BotVersion, LocaleId, Input0, Options0)

View Source
Link to this function

list_bot_replicas(Client, BotId, Input)

View Source
The action to list the replicated bots.
Link to this function

list_bot_replicas(Client, BotId, Input0, Options0)

View Source
Link to this function

list_bot_resource_generations(Client, BotId, BotVersion, LocaleId, Input)

View Source
Lists the generation requests made for a bot locale.
Link to this function

list_bot_resource_generations(Client, BotId, BotVersion, LocaleId, Input0, Options0)

View Source
Link to this function

list_bot_version_replicas(Client, BotId, ReplicaRegion, Input)

View Source
Contains information about all the versions replication statuses applicable for Global Resiliency.
Link to this function

list_bot_version_replicas(Client, BotId, ReplicaRegion, Input0, Options0)

View Source
Link to this function

list_bot_versions(Client, BotId, Input)

View Source

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.
Link to this function

list_bot_versions(Client, BotId, Input0, Options0)

View Source
Link to this function

list_bots(Client, Input)

View Source
Gets a list of available bots.
Link to this function

list_bots(Client, Input0, Options0)

View Source
Link to this function

list_built_in_intents(Client, LocaleId, Input)

View Source

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: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_CreateIntent.html.
Link to this function

list_built_in_intents(Client, LocaleId, Input0, Options0)

View Source
Link to this function

list_built_in_slot_types(Client, LocaleId, Input)

View Source
Gets a list of built-in slot types that meet the specified criteria.
Link to this function

list_built_in_slot_types(Client, LocaleId, Input0, Options0)

View Source
Link to this function

list_custom_vocabulary_items(Client, BotId, BotVersion, LocaleId, Input)

View Source
Paginated list of custom vocabulary items for a given bot locale's custom vocabulary.
Link to this function

list_custom_vocabulary_items(Client, BotId, BotVersion, LocaleId, Input0, Options0)

View Source
Link to this function

list_exports(Client, Input)

View Source

Lists the exports for a bot, bot locale, or custom vocabulary.

Exports are kept in the list for 7 days.
Link to this function

list_exports(Client, Input0, Options0)

View Source
Link to this function

list_imports(Client, Input)

View Source

Lists the imports for a bot, bot locale, or custom vocabulary.

Imports are kept in the list for 7 days.
Link to this function

list_imports(Client, Input0, Options0)

View Source
Link to this function

list_intent_metrics(Client, BotId, Input)

View Source

Retrieves summary metrics for the intents in your bot.

The following fields are required:

  • metrics – A list of AnalyticsIntentMetric: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_AnalyticsIntentMetric.html 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.
Link to this function

list_intent_metrics(Client, BotId, Input0, Options0)

View Source
Link to this function

list_intent_paths(Client, BotId, Input)

View Source

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.
Link to this function

list_intent_paths(Client, BotId, Input0, Options0)

View Source
Link to this function

list_intent_stage_metrics(Client, BotId, Input)

View Source

Retrieves summary metrics for the stages within intents in your bot.

The following fields are required:

  • metrics – A list of AnalyticsIntentStageMetric: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_AnalyticsIntentStageMetric.html 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.
Link to this function

list_intent_stage_metrics(Client, BotId, Input0, Options0)

View Source
Link to this function

list_intents(Client, BotId, BotVersion, LocaleId, Input)

View Source
Get a list of intents that meet the specified criteria.
Link to this function

list_intents(Client, BotId, BotVersion, LocaleId, Input0, Options0)

View Source
Link to this function

list_session_analytics_data(Client, BotId, Input)

View Source

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.

Link to this function

list_session_analytics_data(Client, BotId, Input0, Options0)

View Source
Link to this function

list_session_metrics(Client, BotId, Input)

View Source

Retrieves summary metrics for the user sessions with your bot.

The following fields are required:

  • metrics – A list of AnalyticsSessionMetric: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_AnalyticsSessionMetric.html 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.
Link to this function

list_session_metrics(Client, BotId, Input0, Options0)

View Source
Link to this function

list_slot_types(Client, BotId, BotVersion, LocaleId, Input)

View Source
Gets a list of slot types that match the specified criteria.
Link to this function

list_slot_types(Client, BotId, BotVersion, LocaleId, Input0, Options0)

View Source
Link to this function

list_slots(Client, BotId, BotVersion, IntentId, LocaleId, Input)

View Source
Gets a list of slots that match the specified criteria.
Link to this function

list_slots(Client, BotId, BotVersion, IntentId, LocaleId, Input0, Options0)

View Source
Link to this function

list_tags_for_resource(Client, ResourceARN)

View Source

Gets a list of tags associated with a resource.

Only bots, bot aliases, and bot channels can have tags associated with them.
Link to this function

list_tags_for_resource(Client, ResourceARN, QueryMap, HeadersMap)

View Source
Link to this function

list_tags_for_resource(Client, ResourceARN, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_test_execution_result_items(Client, TestExecutionId, Input)

View Source
Gets a list of test execution result items.
Link to this function

list_test_execution_result_items(Client, TestExecutionId, Input0, Options0)

View Source
Link to this function

list_test_executions(Client, Input)

View Source
The list of test set executions.
Link to this function

list_test_executions(Client, Input0, Options0)

View Source
Link to this function

list_test_set_records(Client, TestSetId, Input)

View Source
The list of test set records.
Link to this function

list_test_set_records(Client, TestSetId, Input0, Options0)

View Source
Link to this function

list_test_sets(Client, Input)

View Source
The list of the test sets
Link to this function

list_test_sets(Client, Input0, Options0)

View Source
Link to this function

list_utterance_analytics_data(Client, BotId, Input)

View Source

To use this API operation, your IAM role must have permissions to perform the ListAggregatedUtterances: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListAggregatedUtterances.html operation, which provides access to utterance-related analytics.

See Viewing utterance statistics: https://docs.aws.amazon.com/lexv2/latest/dg/monitoring-utterances.html 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.

Link to this function

list_utterance_analytics_data(Client, BotId, Input0, Options0)

View Source
Link to this function

list_utterance_metrics(Client, BotId, Input)

View Source

To use this API operation, your IAM role must have permissions to perform the ListAggregatedUtterances: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListAggregatedUtterances.html operation, which provides access to utterance-related analytics.

See Viewing utterance statistics: https://docs.aws.amazon.com/lexv2/latest/dg/monitoring-utterances.html 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: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_AnalyticsUtteranceMetric.html 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.
Link to this function

list_utterance_metrics(Client, BotId, Input0, Options0)

View Source
Link to this function

search_associated_transcripts(Client, BotId, BotRecommendationId, BotVersion, LocaleId, Input)

View Source
Search for associated transcripts that meet the specified criteria.
Link to this function

search_associated_transcripts(Client, BotId, BotRecommendationId, BotVersion, LocaleId, Input0, Options0)

View Source
Link to this function

start_bot_recommendation(Client, BotId, BotVersion, LocaleId, Input)

View Source
Use this to provide your transcript data, and to start the bot recommendation process.
Link to this function

start_bot_recommendation(Client, BotId, BotVersion, LocaleId, Input0, Options0)

View Source
Link to this function

start_bot_resource_generation(Client, BotId, BotVersion, LocaleId, Input)

View Source

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.
Link to this function

start_bot_resource_generation(Client, BotId, BotVersion, LocaleId, Input0, Options0)

View Source
Link to this function

start_import(Client, Input)

View Source
Starts importing a bot, bot locale, or custom vocabulary from a zip archive that you uploaded to an S3 bucket.
Link to this function

start_import(Client, Input0, Options0)

View Source
Link to this function

start_test_execution(Client, TestSetId, Input)

View Source
The action to start test set execution.
Link to this function

start_test_execution(Client, TestSetId, Input0, Options0)

View Source
Link to this function

start_test_set_generation(Client, Input)

View Source
The action to start the generation of test set.
Link to this function

start_test_set_generation(Client, Input0, Options0)

View Source
Link to this function

stop_bot_recommendation(Client, BotId, BotRecommendationId, BotVersion, LocaleId, Input)

View Source
Stop an already running Bot Recommendation request.
Link to this function

stop_bot_recommendation(Client, BotId, BotRecommendationId, BotVersion, LocaleId, Input0, Options0)

View Source
Link to this function

tag_resource(Client, ResourceARN, Input)

View Source

Adds the specified tags to the specified resource.

If a tag key already exists, the existing value is replaced with the new value.
Link to this function

tag_resource(Client, ResourceARN, Input0, Options0)

View Source
Link to this function

untag_resource(Client, ResourceARN, Input)

View Source
Removes tags from a bot, bot alias, or bot channel.
Link to this function

untag_resource(Client, ResourceARN, Input0, Options0)

View Source
Link to this function

update_bot(Client, BotId, Input)

View Source
Updates the configuration of an existing bot.
Link to this function

update_bot(Client, BotId, Input0, Options0)

View Source
Link to this function

update_bot_alias(Client, BotAliasId, BotId, Input)

View Source
Updates the configuration of an existing bot alias.
Link to this function

update_bot_alias(Client, BotAliasId, BotId, Input0, Options0)

View Source
Link to this function

update_bot_locale(Client, BotId, BotVersion, LocaleId, Input)

View Source
Updates the settings that a bot has for a specific locale.
Link to this function

update_bot_locale(Client, BotId, BotVersion, LocaleId, Input0, Options0)

View Source
Link to this function

update_bot_recommendation(Client, BotId, BotRecommendationId, BotVersion, LocaleId, Input)

View Source
Updates an existing bot recommendation request.
Link to this function

update_bot_recommendation(Client, BotId, BotRecommendationId, BotVersion, LocaleId, Input0, Options0)

View Source
Link to this function

update_export(Client, ExportId, Input)

View Source

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: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeExport.html operation.
Link to this function

update_export(Client, ExportId, Input0, Options0)

View Source
Link to this function

update_intent(Client, BotId, BotVersion, IntentId, LocaleId, Input)

View Source
Updates the settings for an intent.
Link to this function

update_intent(Client, BotId, BotVersion, IntentId, LocaleId, Input0, Options0)

View Source
Link to this function

update_resource_policy(Client, ResourceArn, Input)

View Source

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.
Link to this function

update_resource_policy(Client, ResourceArn, Input0, Options0)

View Source
Link to this function

update_slot(Client, BotId, BotVersion, IntentId, LocaleId, SlotId, Input)

View Source
Updates the settings for a slot.
Link to this function

update_slot(Client, BotId, BotVersion, IntentId, LocaleId, SlotId, Input0, Options0)

View Source
Link to this function

update_slot_type(Client, BotId, BotVersion, LocaleId, SlotTypeId, Input)

View Source
Updates the configuration of an existing slot type.
Link to this function

update_slot_type(Client, BotId, BotVersion, LocaleId, SlotTypeId, Input0, Options0)

View Source
Link to this function

update_test_set(Client, TestSetId, Input)

View Source
The action to update the test set.
Link to this function

update_test_set(Client, TestSetId, Input0, Options0)

View Source