AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Interface for accessing LexModelsV2

Inheritance Hierarchy

Amazon.LexModelsV2.IAmazonLexModelsV2

Namespace: Amazon.LexModelsV2
Assembly: AWSSDK.LexModelsV2.dll
Version: 3.x.y.z

Syntax

C#
public interface IAmazonLexModelsV2
         IAmazonService, IDisposable

The IAmazonLexModelsV2 type exposes the following members

Properties

NameTypeDescription
Public Property Paginators Amazon.LexModelsV2.Model.ILexModelsV2PaginatorFactory

Paginators for the service

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method BatchCreateCustomVocabularyItem(BatchCreateCustomVocabularyItemRequest)

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

Public Method BatchCreateCustomVocabularyItemAsync(BatchCreateCustomVocabularyItemRequest, CancellationToken)

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

Public Method BatchDeleteCustomVocabularyItem(BatchDeleteCustomVocabularyItemRequest)

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

Public Method BatchDeleteCustomVocabularyItemAsync(BatchDeleteCustomVocabularyItemRequest, CancellationToken)

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

Public Method BatchUpdateCustomVocabularyItem(BatchUpdateCustomVocabularyItemRequest)

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

Public Method BatchUpdateCustomVocabularyItemAsync(BatchUpdateCustomVocabularyItemRequest, CancellationToken)

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

Public Method BuildBotLocale(BuildBotLocaleRequest)

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.

Public Method BuildBotLocaleAsync(BuildBotLocaleRequest, CancellationToken)

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.

Public Method CreateBot(CreateBotRequest)

Creates an Amazon Lex conversational bot.

Public Method CreateBotAlias(CreateBotAliasRequest)

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.

Public Method CreateBotAliasAsync(CreateBotAliasRequest, CancellationToken)

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.

Public Method CreateBotAsync(CreateBotRequest, CancellationToken)

Creates an Amazon Lex conversational bot.

Public Method CreateBotLocale(CreateBotLocaleRequest)

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.

Public Method CreateBotLocaleAsync(CreateBotLocaleRequest, CancellationToken)

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.

Public Method CreateBotReplica(CreateBotReplicaRequest)

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

Public Method CreateBotReplicaAsync(CreateBotReplicaRequest, CancellationToken)

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

Public Method CreateBotVersion(CreateBotVersionRequest)

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.

Public Method CreateBotVersionAsync(CreateBotVersionRequest, CancellationToken)

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.

Public Method CreateExport(CreateExportRequest)

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

Public Method CreateExportAsync(CreateExportRequest, CancellationToken)

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

Public Method CreateIntent(CreateIntentRequest)

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

Public Method CreateIntentAsync(CreateIntentRequest, CancellationToken)

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

Public Method CreateResourcePolicy(CreateResourcePolicyRequest)

Creates a new resource policy with the specified policy statements.

Public Method CreateResourcePolicyAsync(CreateResourcePolicyRequest, CancellationToken)

Creates a new resource policy with the specified policy statements.

Public Method CreateResourcePolicyStatement(CreateResourcePolicyStatementRequest)

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.

Public Method CreateResourcePolicyStatementAsync(CreateResourcePolicyStatementRequest, CancellationToken)

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.

Public Method CreateSlot(CreateSlotRequest)

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.

Public Method CreateSlotAsync(CreateSlotRequest, CancellationToken)

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.

Public Method CreateSlotType(CreateSlotTypeRequest)

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.

Public Method CreateSlotTypeAsync(CreateSlotTypeRequest, CancellationToken)

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.

Public Method CreateTestSetDiscrepancyReport(CreateTestSetDiscrepancyReportRequest)

Create a report that describes the differences between the bot and the test set.

Public Method CreateTestSetDiscrepancyReportAsync(CreateTestSetDiscrepancyReportRequest, CancellationToken)

Create a report that describes the differences between the bot and the test set.

Public Method CreateUploadUrl(CreateUploadUrlRequest)

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

Public Method CreateUploadUrlAsync(CreateUploadUrlRequest, CancellationToken)

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

Public Method DeleteBot(DeleteBotRequest)

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.

Public Method DeleteBotAlias(DeleteBotAliasRequest)

Deletes the specified bot alias.

Public Method DeleteBotAliasAsync(DeleteBotAliasRequest, CancellationToken)

Deletes the specified bot alias.

Public Method DeleteBotAsync(DeleteBotRequest, CancellationToken)

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.

Public Method DeleteBotLocale(DeleteBotLocaleRequest)

Removes a locale from a bot.

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

Public Method DeleteBotLocaleAsync(DeleteBotLocaleRequest, CancellationToken)

Removes a locale from a bot.

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

Public Method DeleteBotReplica(DeleteBotReplicaRequest)

The action to delete the replicated bot in the secondary region.

Public Method DeleteBotReplicaAsync(DeleteBotReplicaRequest, CancellationToken)

The action to delete the replicated bot in the secondary region.

Public Method DeleteBotVersion(DeleteBotVersionRequest)

Deletes a specific version of a bot. To delete all versions of a bot, use the DeleteBot operation.

Public Method DeleteBotVersionAsync(DeleteBotVersionRequest, CancellationToken)

Deletes a specific version of a bot. To delete all versions of a bot, use the DeleteBot operation.

Public Method DeleteCustomVocabulary(DeleteCustomVocabularyRequest)

Removes a custom vocabulary from the specified locale in the specified bot.

Public Method DeleteCustomVocabularyAsync(DeleteCustomVocabularyRequest, CancellationToken)

Removes a custom vocabulary from the specified locale in the specified bot.

Public Method DeleteExport(DeleteExportRequest)

Removes a previous export and the associated files stored in an S3 bucket.

Public Method DeleteExportAsync(DeleteExportRequest, CancellationToken)

Removes a previous export and the associated files stored in an S3 bucket.

Public Method DeleteImport(DeleteImportRequest)

Removes a previous import and the associated file stored in an S3 bucket.

Public Method DeleteImportAsync(DeleteImportRequest, CancellationToken)

Removes a previous import and the associated file stored in an S3 bucket.

Public Method DeleteIntent(DeleteIntentRequest)

Removes the specified intent.

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

Public Method DeleteIntentAsync(DeleteIntentRequest, CancellationToken)

Removes the specified intent.

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

Public Method DeleteResourcePolicy(DeleteResourcePolicyRequest)

Removes an existing policy from a bot or bot alias. If the resource doesn't have a policy attached, Amazon Lex returns an exception.

Public Method DeleteResourcePolicyAsync(DeleteResourcePolicyRequest, CancellationToken)

Removes an existing policy from a bot or bot alias. If the resource doesn't have a policy attached, Amazon Lex returns an exception.

Public Method DeleteResourcePolicyStatement(DeleteResourcePolicyStatementRequest)

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.

Public Method DeleteResourcePolicyStatementAsync(DeleteResourcePolicyStatementRequest, CancellationToken)

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.

Public Method DeleteSlot(DeleteSlotRequest)

Deletes the specified slot from an intent.

Public Method DeleteSlotAsync(DeleteSlotRequest, CancellationToken)

Deletes the specified slot from an intent.

Public Method DeleteSlotType(DeleteSlotTypeRequest)

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.

Public Method DeleteSlotTypeAsync(DeleteSlotTypeRequest, CancellationToken)

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.

Public Method DeleteTestSet(DeleteTestSetRequest)

The action to delete the selected test set.

Public Method DeleteTestSetAsync(DeleteTestSetRequest, CancellationToken)

The action to delete the selected test set.

Public Method DeleteUtterances(DeleteUtterancesRequest)

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.

Public Method DeleteUtterancesAsync(DeleteUtterancesRequest, CancellationToken)

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.

Public Method DescribeBot(DescribeBotRequest)

Provides metadata information about a bot.

Public Method DescribeBotAlias(DescribeBotAliasRequest)

Get information about a specific bot alias.

Public Method DescribeBotAliasAsync(DescribeBotAliasRequest, CancellationToken)

Get information about a specific bot alias.

Public Method DescribeBotAsync(DescribeBotRequest, CancellationToken)

Provides metadata information about a bot.

Public Method DescribeBotLocale(DescribeBotLocaleRequest)

Describes the settings that a bot has for a specific locale.

Public Method DescribeBotLocaleAsync(DescribeBotLocaleRequest, CancellationToken)

Describes the settings that a bot has for a specific locale.

Public Method DescribeBotRecommendation(DescribeBotRecommendationRequest)

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.

Public Method DescribeBotRecommendationAsync(DescribeBotRecommendationRequest, CancellationToken)

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.

Public Method DescribeBotReplica(DescribeBotReplicaRequest)

Monitors the bot replication status through the UI console.

Public Method DescribeBotReplicaAsync(DescribeBotReplicaRequest, CancellationToken)

Monitors the bot replication status through the UI console.

Public Method DescribeBotResourceGeneration(DescribeBotResourceGenerationRequest)

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.

Public Method DescribeBotResourceGenerationAsync(DescribeBotResourceGenerationRequest, CancellationToken)

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.

Public Method DescribeBotVersion(DescribeBotVersionRequest)

Provides metadata about a version of a bot.

Public Method DescribeBotVersionAsync(DescribeBotVersionRequest, CancellationToken)

Provides metadata about a version of a bot.

Public Method DescribeCustomVocabularyMetadata(DescribeCustomVocabularyMetadataRequest)

Provides metadata information about a custom vocabulary.

Public Method DescribeCustomVocabularyMetadataAsync(DescribeCustomVocabularyMetadataRequest, CancellationToken)

Provides metadata information about a custom vocabulary.

Public Method DescribeExport(DescribeExportRequest)

Gets information about a specific export.

Public Method DescribeExportAsync(DescribeExportRequest, CancellationToken)

Gets information about a specific export.

Public Method DescribeImport(DescribeImportRequest)

Gets information about a specific import.

Public Method DescribeImportAsync(DescribeImportRequest, CancellationToken)

Gets information about a specific import.

Public Method DescribeIntent(DescribeIntentRequest)

Returns metadata about an intent.

Public Method DescribeIntentAsync(DescribeIntentRequest, CancellationToken)

Returns metadata about an intent.

Public Method DescribeResourcePolicy(DescribeResourcePolicyRequest)

Gets the resource policy and policy revision for a bot or bot alias.

Public Method DescribeResourcePolicyAsync(DescribeResourcePolicyRequest, CancellationToken)

Gets the resource policy and policy revision for a bot or bot alias.

Public Method DescribeSlot(DescribeSlotRequest)

Gets metadata information about a slot.

Public Method DescribeSlotAsync(DescribeSlotRequest, CancellationToken)

Gets metadata information about a slot.

Public Method DescribeSlotType(DescribeSlotTypeRequest)

Gets metadata information about a slot type.

Public Method DescribeSlotTypeAsync(DescribeSlotTypeRequest, CancellationToken)

Gets metadata information about a slot type.

Public Method DescribeTestExecution(DescribeTestExecutionRequest)

Gets metadata information about the test execution.

Public Method DescribeTestExecutionAsync(DescribeTestExecutionRequest, CancellationToken)

Gets metadata information about the test execution.

Public Method DescribeTestSet(DescribeTestSetRequest)

Gets metadata information about the test set.

Public Method DescribeTestSetAsync(DescribeTestSetRequest, CancellationToken)

Gets metadata information about the test set.

Public Method DescribeTestSetDiscrepancyReport(DescribeTestSetDiscrepancyReportRequest)

Gets metadata information about the test set discrepancy report.

Public Method DescribeTestSetDiscrepancyReportAsync(DescribeTestSetDiscrepancyReportRequest, CancellationToken)

Gets metadata information about the test set discrepancy report.

Public Method DescribeTestSetGeneration(DescribeTestSetGenerationRequest)

Gets metadata information about the test set generation.

Public Method DescribeTestSetGenerationAsync(DescribeTestSetGenerationRequest, CancellationToken)

Gets metadata information about the test set generation.

Public Method DetermineServiceOperationEndpoint(AmazonWebServiceRequest)

Returns the endpoint that will be used for a particular request.

Public Method GenerateBotElement(GenerateBotElementRequest)

Generates sample utterances for an intent.

Public Method GenerateBotElementAsync(GenerateBotElementRequest, CancellationToken)

Generates sample utterances for an intent.

Public Method GetTestExecutionArtifactsUrl(GetTestExecutionArtifactsUrlRequest)

The pre-signed Amazon S3 URL to download the test execution result artifacts.

Public Method GetTestExecutionArtifactsUrlAsync(GetTestExecutionArtifactsUrlRequest, CancellationToken)

The pre-signed Amazon S3 URL to download the test execution result artifacts.

Public Method ListAggregatedUtterances(ListAggregatedUtterancesRequest)

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.

Public Method ListAggregatedUtterancesAsync(ListAggregatedUtterancesRequest, CancellationToken)

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.

Public Method ListBotAliases(ListBotAliasesRequest)

Gets a list of aliases for the specified bot.

Public Method ListBotAliasesAsync(ListBotAliasesRequest, CancellationToken)

Gets a list of aliases for the specified bot.

Public Method ListBotAliasReplicas(ListBotAliasReplicasRequest)

The action to list the replicated bots created from the source bot alias.

Public Method ListBotAliasReplicasAsync(ListBotAliasReplicasRequest, CancellationToken)

The action to list the replicated bots created from the source bot alias.

Public Method ListBotLocales(ListBotLocalesRequest)

Gets a list of locales for the specified bot.

Public Method ListBotLocalesAsync(ListBotLocalesRequest, CancellationToken)

Gets a list of locales for the specified bot.

Public Method ListBotRecommendations(ListBotRecommendationsRequest)

Get a list of bot recommendations that meet the specified criteria.

Public Method ListBotRecommendationsAsync(ListBotRecommendationsRequest, CancellationToken)

Get a list of bot recommendations that meet the specified criteria.

Public Method ListBotReplicas(ListBotReplicasRequest)

The action to list the replicated bots.

Public Method ListBotReplicasAsync(ListBotReplicasRequest, CancellationToken)

The action to list the replicated bots.

Public Method ListBotResourceGenerations(ListBotResourceGenerationsRequest)

Lists the generation requests made for a bot locale.

Public Method ListBotResourceGenerationsAsync(ListBotResourceGenerationsRequest, CancellationToken)

Lists the generation requests made for a bot locale.

Public Method ListBots(ListBotsRequest)

Gets a list of available bots.

Public Method ListBotsAsync(ListBotsRequest, CancellationToken)

Gets a list of available bots.

Public Method ListBotVersionReplicas(ListBotVersionReplicasRequest)

Contains information about all the versions replication statuses applicable for Global Resiliency.

Public Method ListBotVersionReplicasAsync(ListBotVersionReplicasRequest, CancellationToken)

Contains information about all the versions replication statuses applicable for Global Resiliency.

Public Method ListBotVersions(ListBotVersionsRequest)

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.

Public Method ListBotVersionsAsync(ListBotVersionsRequest, CancellationToken)

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.

Public Method ListBuiltInIntents(ListBuiltInIntentsRequest)

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.

Public Method ListBuiltInIntentsAsync(ListBuiltInIntentsRequest, CancellationToken)

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.

Public Method ListBuiltInSlotTypes(ListBuiltInSlotTypesRequest)

Gets a list of built-in slot types that meet the specified criteria.

Public Method ListBuiltInSlotTypesAsync(ListBuiltInSlotTypesRequest, CancellationToken)

Gets a list of built-in slot types that meet the specified criteria.

Public Method ListCustomVocabularyItems(ListCustomVocabularyItemsRequest)

Paginated list of custom vocabulary items for a given bot locale's custom vocabulary.

Public Method ListCustomVocabularyItemsAsync(ListCustomVocabularyItemsRequest, CancellationToken)

Paginated list of custom vocabulary items for a given bot locale's custom vocabulary.

Public Method ListExports(ListExportsRequest)

Lists the exports for a bot, bot locale, or custom vocabulary. Exports are kept in the list for 7 days.

Public Method ListExportsAsync(ListExportsRequest, CancellationToken)

Lists the exports for a bot, bot locale, or custom vocabulary. Exports are kept in the list for 7 days.

Public Method ListImports(ListImportsRequest)

Lists the imports for a bot, bot locale, or custom vocabulary. Imports are kept in the list for 7 days.

Public Method ListImportsAsync(ListImportsRequest, CancellationToken)

Lists the imports for a bot, bot locale, or custom vocabulary. Imports are kept in the list for 7 days.

Public Method ListIntentMetrics(ListIntentMetricsRequest)

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.

Public Method ListIntentMetricsAsync(ListIntentMetricsRequest, CancellationToken)

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.

Public Method ListIntentPaths(ListIntentPathsRequest)

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.

Public Method ListIntentPathsAsync(ListIntentPathsRequest, CancellationToken)

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.

Public Method ListIntents(ListIntentsRequest)

Get a list of intents that meet the specified criteria.

Public Method ListIntentsAsync(ListIntentsRequest, CancellationToken)

Get a list of intents that meet the specified criteria.

Public Method ListIntentStageMetrics(ListIntentStageMetricsRequest)

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.

Public Method ListIntentStageMetricsAsync(ListIntentStageMetricsRequest, CancellationToken)

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.

Public Method ListRecommendedIntents(ListRecommendedIntentsRequest)

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.

Public Method ListRecommendedIntentsAsync(ListRecommendedIntentsRequest, CancellationToken)

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.

Public Method ListSessionAnalyticsData(ListSessionAnalyticsDataRequest)

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.

Public Method ListSessionAnalyticsDataAsync(ListSessionAnalyticsDataRequest, CancellationToken)

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.

Public Method ListSessionMetrics(ListSessionMetricsRequest)

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.

Public Method ListSessionMetricsAsync(ListSessionMetricsRequest, CancellationToken)

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.

Public Method ListSlots(ListSlotsRequest)

Gets a list of slots that match the specified criteria.

Public Method ListSlotsAsync(ListSlotsRequest, CancellationToken)

Gets a list of slots that match the specified criteria.

Public Method ListSlotTypes(ListSlotTypesRequest)

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

Public Method ListSlotTypesAsync(ListSlotTypesRequest, CancellationToken)

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

Public Method ListTagsForResource(ListTagsForResourceRequest)

Gets a list of tags associated with a resource. Only bots, bot aliases, and bot channels can have tags associated with them.

Public Method ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken)

Gets a list of tags associated with a resource. Only bots, bot aliases, and bot channels can have tags associated with them.

Public Method ListTestExecutionResultItems(ListTestExecutionResultItemsRequest)

Gets a list of test execution result items.

Public Method ListTestExecutionResultItemsAsync(ListTestExecutionResultItemsRequest, CancellationToken)

Gets a list of test execution result items.

Public Method ListTestExecutions(ListTestExecutionsRequest)

The list of test set executions.

Public Method ListTestExecutionsAsync(ListTestExecutionsRequest, CancellationToken)

The list of test set executions.

Public Method ListTestSetRecords(ListTestSetRecordsRequest)

The list of test set records.

Public Method ListTestSetRecordsAsync(ListTestSetRecordsRequest, CancellationToken)

The list of test set records.

Public Method ListTestSets(ListTestSetsRequest)

The list of the test sets

Public Method ListTestSetsAsync(ListTestSetsRequest, CancellationToken)

The list of the test sets

Public Method ListUtteranceAnalyticsData(ListUtteranceAnalyticsDataRequest)

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.

Public Method ListUtteranceAnalyticsDataAsync(ListUtteranceAnalyticsDataRequest, CancellationToken)

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.

Public Method ListUtteranceMetrics(ListUtteranceMetricsRequest)

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.

Public Method ListUtteranceMetricsAsync(ListUtteranceMetricsRequest, CancellationToken)

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.

Public Method SearchAssociatedTranscripts(SearchAssociatedTranscriptsRequest)

Search for associated transcripts that meet the specified criteria.

Public Method SearchAssociatedTranscriptsAsync(SearchAssociatedTranscriptsRequest, CancellationToken)

Search for associated transcripts that meet the specified criteria.

Public Method StartBotRecommendation(StartBotRecommendationRequest)

Use this to provide your transcript data, and to start the bot recommendation process.

Public Method StartBotRecommendationAsync(StartBotRecommendationRequest, CancellationToken)

Use this to provide your transcript data, and to start the bot recommendation process.

Public Method StartBotResourceGeneration(StartBotResourceGenerationRequest)

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.

Public Method StartBotResourceGenerationAsync(StartBotResourceGenerationRequest, CancellationToken)

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.

Public Method StartImport(StartImportRequest)

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

Public Method StartImportAsync(StartImportRequest, CancellationToken)

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

Public Method StartTestExecution(StartTestExecutionRequest)

The action to start test set execution.

Public Method StartTestExecutionAsync(StartTestExecutionRequest, CancellationToken)

The action to start test set execution.

Public Method StartTestSetGeneration(StartTestSetGenerationRequest)

The action to start the generation of test set.

Public Method StartTestSetGenerationAsync(StartTestSetGenerationRequest, CancellationToken)

The action to start the generation of test set.

Public Method StopBotRecommendation(StopBotRecommendationRequest)

Stop an already running Bot Recommendation request.

Public Method StopBotRecommendationAsync(StopBotRecommendationRequest, CancellationToken)

Stop an already running Bot Recommendation request.

Public Method TagResource(TagResourceRequest)

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

Public Method TagResourceAsync(TagResourceRequest, CancellationToken)

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

Public Method UntagResource(UntagResourceRequest)

Removes tags from a bot, bot alias, or bot channel.

Public Method UntagResourceAsync(UntagResourceRequest, CancellationToken)

Removes tags from a bot, bot alias, or bot channel.

Public Method UpdateBot(UpdateBotRequest)

Updates the configuration of an existing bot.

Public Method UpdateBotAlias(UpdateBotAliasRequest)

Updates the configuration of an existing bot alias.

Public Method UpdateBotAliasAsync(UpdateBotAliasRequest, CancellationToken)

Updates the configuration of an existing bot alias.

Public Method UpdateBotAsync(UpdateBotRequest, CancellationToken)

Updates the configuration of an existing bot.

Public Method UpdateBotLocale(UpdateBotLocaleRequest)

Updates the settings that a bot has for a specific locale.

Public Method UpdateBotLocaleAsync(UpdateBotLocaleRequest, CancellationToken)

Updates the settings that a bot has for a specific locale.

Public Method UpdateBotRecommendation(UpdateBotRecommendationRequest)

Updates an existing bot recommendation request.

Public Method UpdateBotRecommendationAsync(UpdateBotRecommendationRequest, CancellationToken)

Updates an existing bot recommendation request.

Public Method UpdateExport(UpdateExportRequest)

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.

Public Method UpdateExportAsync(UpdateExportRequest, CancellationToken)

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.

Public Method UpdateIntent(UpdateIntentRequest)

Updates the settings for an intent.

Public Method UpdateIntentAsync(UpdateIntentRequest, CancellationToken)

Updates the settings for an intent.

Public Method UpdateResourcePolicy(UpdateResourcePolicyRequest)

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.

Public Method UpdateResourcePolicyAsync(UpdateResourcePolicyRequest, CancellationToken)

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.

Public Method UpdateSlot(UpdateSlotRequest)

Updates the settings for a slot.

Public Method UpdateSlotAsync(UpdateSlotRequest, CancellationToken)

Updates the settings for a slot.

Public Method UpdateSlotType(UpdateSlotTypeRequest)

Updates the configuration of an existing slot type.

Public Method UpdateSlotTypeAsync(UpdateSlotTypeRequest, CancellationToken)

Updates the configuration of an existing slot type.

Public Method UpdateTestSet(UpdateTestSetRequest)

The action to update the test set.

Public Method UpdateTestSetAsync(UpdateTestSetRequest, CancellationToken)

The action to update the test set.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5