@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonLexModelsV2
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonLexModelsV2
instead.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
BatchCreateCustomVocabularyItemResult |
batchCreateCustomVocabularyItem(BatchCreateCustomVocabularyItemRequest batchCreateCustomVocabularyItemRequest)
Create a batch of custom vocabulary items for a given bot locale's custom vocabulary.
|
BatchDeleteCustomVocabularyItemResult |
batchDeleteCustomVocabularyItem(BatchDeleteCustomVocabularyItemRequest batchDeleteCustomVocabularyItemRequest)
Delete a batch of custom vocabulary items for a given bot locale's custom vocabulary.
|
BatchUpdateCustomVocabularyItemResult |
batchUpdateCustomVocabularyItem(BatchUpdateCustomVocabularyItemRequest batchUpdateCustomVocabularyItemRequest)
Update a batch of custom vocabulary items for a given bot locale's custom vocabulary.
|
BuildBotLocaleResult |
buildBotLocale(BuildBotLocaleRequest buildBotLocaleRequest)
Builds a bot, its intents, and its slot types into a specific locale.
|
CreateBotResult |
createBot(CreateBotRequest createBotRequest)
Creates an Amazon Lex conversational bot.
|
CreateBotAliasResult |
createBotAlias(CreateBotAliasRequest createBotAliasRequest)
Creates an alias for the specified version of a bot.
|
CreateBotLocaleResult |
createBotLocale(CreateBotLocaleRequest createBotLocaleRequest)
Creates a locale in the bot.
|
CreateBotReplicaResult |
createBotReplica(CreateBotReplicaRequest createBotReplicaRequest)
Action to create a replication of the source bot in the secondary region.
|
CreateBotVersionResult |
createBotVersion(CreateBotVersionRequest createBotVersionRequest)
Creates an immutable version of the bot.
|
CreateExportResult |
createExport(CreateExportRequest createExportRequest)
Creates a zip archive containing the contents of a bot or a bot locale.
|
CreateIntentResult |
createIntent(CreateIntentRequest createIntentRequest)
Creates an intent.
|
CreateResourcePolicyResult |
createResourcePolicy(CreateResourcePolicyRequest createResourcePolicyRequest)
Creates a new resource policy with the specified policy statements.
|
CreateResourcePolicyStatementResult |
createResourcePolicyStatement(CreateResourcePolicyStatementRequest createResourcePolicyStatementRequest)
Adds a new resource policy statement to a bot or bot alias.
|
CreateSlotResult |
createSlot(CreateSlotRequest createSlotRequest)
Creates a slot in an intent.
|
CreateSlotTypeResult |
createSlotType(CreateSlotTypeRequest createSlotTypeRequest)
Creates a custom slot type
|
CreateTestSetDiscrepancyReportResult |
createTestSetDiscrepancyReport(CreateTestSetDiscrepancyReportRequest createTestSetDiscrepancyReportRequest)
Create a report that describes the differences between the bot and the test set.
|
CreateUploadUrlResult |
createUploadUrl(CreateUploadUrlRequest createUploadUrlRequest)
Gets a pre-signed S3 write URL that you use to upload the zip archive when importing a bot or a bot locale.
|
DeleteBotResult |
deleteBot(DeleteBotRequest deleteBotRequest)
Deletes all versions of a bot, including the
Draft version. |
DeleteBotAliasResult |
deleteBotAlias(DeleteBotAliasRequest deleteBotAliasRequest)
Deletes the specified bot alias.
|
DeleteBotLocaleResult |
deleteBotLocale(DeleteBotLocaleRequest deleteBotLocaleRequest)
Removes a locale from a bot.
|
DeleteBotReplicaResult |
deleteBotReplica(DeleteBotReplicaRequest deleteBotReplicaRequest)
The action to delete the replicated bot in the secondary region.
|
DeleteBotVersionResult |
deleteBotVersion(DeleteBotVersionRequest deleteBotVersionRequest)
Deletes a specific version of a bot.
|
DeleteCustomVocabularyResult |
deleteCustomVocabulary(DeleteCustomVocabularyRequest deleteCustomVocabularyRequest)
Removes a custom vocabulary from the specified locale in the specified bot.
|
DeleteExportResult |
deleteExport(DeleteExportRequest deleteExportRequest)
Removes a previous export and the associated files stored in an S3 bucket.
|
DeleteImportResult |
deleteImport(DeleteImportRequest deleteImportRequest)
Removes a previous import and the associated file stored in an S3 bucket.
|
DeleteIntentResult |
deleteIntent(DeleteIntentRequest deleteIntentRequest)
Removes the specified intent.
|
DeleteResourcePolicyResult |
deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest)
Removes an existing policy from a bot or bot alias.
|
DeleteResourcePolicyStatementResult |
deleteResourcePolicyStatement(DeleteResourcePolicyStatementRequest deleteResourcePolicyStatementRequest)
Deletes a policy statement from a resource policy.
|
DeleteSlotResult |
deleteSlot(DeleteSlotRequest deleteSlotRequest)
Deletes the specified slot from an intent.
|
DeleteSlotTypeResult |
deleteSlotType(DeleteSlotTypeRequest deleteSlotTypeRequest)
Deletes a slot type from a bot locale.
|
DeleteTestSetResult |
deleteTestSet(DeleteTestSetRequest deleteTestSetRequest)
The action to delete the selected test set.
|
DeleteUtterancesResult |
deleteUtterances(DeleteUtterancesRequest deleteUtterancesRequest)
Deletes stored utterances.
|
DescribeBotResult |
describeBot(DescribeBotRequest describeBotRequest)
Provides metadata information about a bot.
|
DescribeBotAliasResult |
describeBotAlias(DescribeBotAliasRequest describeBotAliasRequest)
Get information about a specific bot alias.
|
DescribeBotLocaleResult |
describeBotLocale(DescribeBotLocaleRequest describeBotLocaleRequest)
Describes the settings that a bot has for a specific locale.
|
DescribeBotRecommendationResult |
describeBotRecommendation(DescribeBotRecommendationRequest describeBotRecommendationRequest)
Provides metadata information about a bot recommendation.
|
DescribeBotReplicaResult |
describeBotReplica(DescribeBotReplicaRequest describeBotReplicaRequest)
Monitors the bot replication status through the UI console.
|
DescribeBotResourceGenerationResult |
describeBotResourceGeneration(DescribeBotResourceGenerationRequest describeBotResourceGenerationRequest)
Returns information about a request to generate a bot through natural language description, made through the
StartBotResource API. |
DescribeBotVersionResult |
describeBotVersion(DescribeBotVersionRequest describeBotVersionRequest)
Provides metadata about a version of a bot.
|
DescribeCustomVocabularyMetadataResult |
describeCustomVocabularyMetadata(DescribeCustomVocabularyMetadataRequest describeCustomVocabularyMetadataRequest)
Provides metadata information about a custom vocabulary.
|
DescribeExportResult |
describeExport(DescribeExportRequest describeExportRequest)
Gets information about a specific export.
|
DescribeImportResult |
describeImport(DescribeImportRequest describeImportRequest)
Gets information about a specific import.
|
DescribeIntentResult |
describeIntent(DescribeIntentRequest describeIntentRequest)
Returns metadata about an intent.
|
DescribeResourcePolicyResult |
describeResourcePolicy(DescribeResourcePolicyRequest describeResourcePolicyRequest)
Gets the resource policy and policy revision for a bot or bot alias.
|
DescribeSlotResult |
describeSlot(DescribeSlotRequest describeSlotRequest)
Gets metadata information about a slot.
|
DescribeSlotTypeResult |
describeSlotType(DescribeSlotTypeRequest describeSlotTypeRequest)
Gets metadata information about a slot type.
|
DescribeTestExecutionResult |
describeTestExecution(DescribeTestExecutionRequest describeTestExecutionRequest)
Gets metadata information about the test execution.
|
DescribeTestSetResult |
describeTestSet(DescribeTestSetRequest describeTestSetRequest)
Gets metadata information about the test set.
|
DescribeTestSetDiscrepancyReportResult |
describeTestSetDiscrepancyReport(DescribeTestSetDiscrepancyReportRequest describeTestSetDiscrepancyReportRequest)
Gets metadata information about the test set discrepancy report.
|
DescribeTestSetGenerationResult |
describeTestSetGeneration(DescribeTestSetGenerationRequest describeTestSetGenerationRequest)
Gets metadata information about the test set generation.
|
GenerateBotElementResult |
generateBotElement(GenerateBotElementRequest generateBotElementRequest)
Generates sample utterances for an intent.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetTestExecutionArtifactsUrlResult |
getTestExecutionArtifactsUrl(GetTestExecutionArtifactsUrlRequest getTestExecutionArtifactsUrlRequest)
The pre-signed Amazon S3 URL to download the test execution result artifacts.
|
ListAggregatedUtterancesResult |
listAggregatedUtterances(ListAggregatedUtterancesRequest listAggregatedUtterancesRequest)
Provides a list of utterances that users have sent to the bot.
|
ListBotAliasesResult |
listBotAliases(ListBotAliasesRequest listBotAliasesRequest)
Gets a list of aliases for the specified bot.
|
ListBotAliasReplicasResult |
listBotAliasReplicas(ListBotAliasReplicasRequest listBotAliasReplicasRequest)
The action to list the replicated bots created from the source bot alias.
|
ListBotLocalesResult |
listBotLocales(ListBotLocalesRequest listBotLocalesRequest)
Gets a list of locales for the specified bot.
|
ListBotRecommendationsResult |
listBotRecommendations(ListBotRecommendationsRequest listBotRecommendationsRequest)
Get a list of bot recommendations that meet the specified criteria.
|
ListBotReplicasResult |
listBotReplicas(ListBotReplicasRequest listBotReplicasRequest)
The action to list the replicated bots.
|
ListBotResourceGenerationsResult |
listBotResourceGenerations(ListBotResourceGenerationsRequest listBotResourceGenerationsRequest)
Lists the generation requests made for a bot locale.
|
ListBotsResult |
listBots(ListBotsRequest listBotsRequest)
Gets a list of available bots.
|
ListBotVersionReplicasResult |
listBotVersionReplicas(ListBotVersionReplicasRequest listBotVersionReplicasRequest)
Contains information about all the versions replication statuses applicable for Global Resiliency.
|
ListBotVersionsResult |
listBotVersions(ListBotVersionsRequest listBotVersionsRequest)
Gets information about all of the versions of a bot.
|
ListBuiltInIntentsResult |
listBuiltInIntents(ListBuiltInIntentsRequest listBuiltInIntentsRequest)
Gets a list of built-in intents provided by Amazon Lex that you can use in your bot.
|
ListBuiltInSlotTypesResult |
listBuiltInSlotTypes(ListBuiltInSlotTypesRequest listBuiltInSlotTypesRequest)
Gets a list of built-in slot types that meet the specified criteria.
|
ListCustomVocabularyItemsResult |
listCustomVocabularyItems(ListCustomVocabularyItemsRequest listCustomVocabularyItemsRequest)
Paginated list of custom vocabulary items for a given bot locale's custom vocabulary.
|
ListExportsResult |
listExports(ListExportsRequest listExportsRequest)
Lists the exports for a bot, bot locale, or custom vocabulary.
|
ListImportsResult |
listImports(ListImportsRequest listImportsRequest)
Lists the imports for a bot, bot locale, or custom vocabulary.
|
ListIntentMetricsResult |
listIntentMetrics(ListIntentMetricsRequest listIntentMetricsRequest)
Retrieves summary metrics for the intents in your bot.
|
ListIntentPathsResult |
listIntentPaths(ListIntentPathsRequest listIntentPathsRequest)
Retrieves summary statistics for a path of intents that users take over sessions with your bot.
|
ListIntentsResult |
listIntents(ListIntentsRequest listIntentsRequest)
Get a list of intents that meet the specified criteria.
|
ListIntentStageMetricsResult |
listIntentStageMetrics(ListIntentStageMetricsRequest listIntentStageMetricsRequest)
Retrieves summary metrics for the stages within intents in your bot.
|
ListRecommendedIntentsResult |
listRecommendedIntents(ListRecommendedIntentsRequest listRecommendedIntentsRequest)
Gets a list of recommended intents provided by the bot recommendation that you can use in your bot.
|
ListSessionAnalyticsDataResult |
listSessionAnalyticsData(ListSessionAnalyticsDataRequest listSessionAnalyticsDataRequest)
Retrieves a list of metadata for individual user sessions with your bot.
|
ListSessionMetricsResult |
listSessionMetrics(ListSessionMetricsRequest listSessionMetricsRequest)
Retrieves summary metrics for the user sessions with your bot.
|
ListSlotsResult |
listSlots(ListSlotsRequest listSlotsRequest)
Gets a list of slots that match the specified criteria.
|
ListSlotTypesResult |
listSlotTypes(ListSlotTypesRequest listSlotTypesRequest)
Gets a list of slot types that match the specified criteria.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Gets a list of tags associated with a resource.
|
ListTestExecutionResultItemsResult |
listTestExecutionResultItems(ListTestExecutionResultItemsRequest listTestExecutionResultItemsRequest)
Gets a list of test execution result items.
|
ListTestExecutionsResult |
listTestExecutions(ListTestExecutionsRequest listTestExecutionsRequest)
The list of test set executions.
|
ListTestSetRecordsResult |
listTestSetRecords(ListTestSetRecordsRequest listTestSetRecordsRequest)
The list of test set records.
|
ListTestSetsResult |
listTestSets(ListTestSetsRequest listTestSetsRequest)
The list of the test sets
|
ListUtteranceAnalyticsDataResult |
listUtteranceAnalyticsData(ListUtteranceAnalyticsDataRequest listUtteranceAnalyticsDataRequest)
|
ListUtteranceMetricsResult |
listUtteranceMetrics(ListUtteranceMetricsRequest listUtteranceMetricsRequest)
|
SearchAssociatedTranscriptsResult |
searchAssociatedTranscripts(SearchAssociatedTranscriptsRequest searchAssociatedTranscriptsRequest)
Search for associated transcripts that meet the specified criteria.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartBotRecommendationResult |
startBotRecommendation(StartBotRecommendationRequest startBotRecommendationRequest)
Use this to provide your transcript data, and to start the bot recommendation process.
|
StartBotResourceGenerationResult |
startBotResourceGeneration(StartBotResourceGenerationRequest startBotResourceGenerationRequest)
Starts a request for the descriptive bot builder to generate a bot locale configuration based on the prompt you
provide it.
|
StartImportResult |
startImport(StartImportRequest startImportRequest)
Starts importing a bot, bot locale, or custom vocabulary from a zip archive that you uploaded to an S3 bucket.
|
StartTestExecutionResult |
startTestExecution(StartTestExecutionRequest startTestExecutionRequest)
The action to start test set execution.
|
StartTestSetGenerationResult |
startTestSetGeneration(StartTestSetGenerationRequest startTestSetGenerationRequest)
The action to start the generation of test set.
|
StopBotRecommendationResult |
stopBotRecommendation(StopBotRecommendationRequest stopBotRecommendationRequest)
Stop an already running Bot Recommendation request.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Adds the specified tags to the specified resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from a bot, bot alias, or bot channel.
|
UpdateBotResult |
updateBot(UpdateBotRequest updateBotRequest)
Updates the configuration of an existing bot.
|
UpdateBotAliasResult |
updateBotAlias(UpdateBotAliasRequest updateBotAliasRequest)
Updates the configuration of an existing bot alias.
|
UpdateBotLocaleResult |
updateBotLocale(UpdateBotLocaleRequest updateBotLocaleRequest)
Updates the settings that a bot has for a specific locale.
|
UpdateBotRecommendationResult |
updateBotRecommendation(UpdateBotRecommendationRequest updateBotRecommendationRequest)
Updates an existing bot recommendation request.
|
UpdateExportResult |
updateExport(UpdateExportRequest updateExportRequest)
Updates the password used to protect an export zip archive.
|
UpdateIntentResult |
updateIntent(UpdateIntentRequest updateIntentRequest)
Updates the settings for an intent.
|
UpdateResourcePolicyResult |
updateResourcePolicy(UpdateResourcePolicyRequest updateResourcePolicyRequest)
Replaces the existing resource policy for a bot or bot alias with a new one.
|
UpdateSlotResult |
updateSlot(UpdateSlotRequest updateSlotRequest)
Updates the settings for a slot.
|
UpdateSlotTypeResult |
updateSlotType(UpdateSlotTypeRequest updateSlotTypeRequest)
Updates the configuration of an existing slot type.
|
UpdateTestSetResult |
updateTestSet(UpdateTestSetRequest updateTestSetRequest)
The action to update the test set.
|
AmazonLexModelsV2Waiters |
waiters() |
static final String ENDPOINT_PREFIX
BatchCreateCustomVocabularyItemResult batchCreateCustomVocabularyItem(BatchCreateCustomVocabularyItemRequest batchCreateCustomVocabularyItemRequest)
Create a batch of custom vocabulary items for a given bot locale's custom vocabulary.
batchCreateCustomVocabularyItemRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.ResourceNotFoundException
- You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try
again.InternalServerException
- The service encountered an unexpected condition. Try your request again.BatchDeleteCustomVocabularyItemResult batchDeleteCustomVocabularyItem(BatchDeleteCustomVocabularyItemRequest batchDeleteCustomVocabularyItemRequest)
Delete a batch of custom vocabulary items for a given bot locale's custom vocabulary.
batchDeleteCustomVocabularyItemRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.ResourceNotFoundException
- You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try
again.InternalServerException
- The service encountered an unexpected condition. Try your request again.BatchUpdateCustomVocabularyItemResult batchUpdateCustomVocabularyItem(BatchUpdateCustomVocabularyItemRequest batchUpdateCustomVocabularyItemRequest)
Update a batch of custom vocabulary items for a given bot locale's custom vocabulary.
batchUpdateCustomVocabularyItemRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.ResourceNotFoundException
- You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try
again.InternalServerException
- The service encountered an unexpected condition. Try your request again.BuildBotLocaleResult buildBotLocale(BuildBotLocaleRequest 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.
buildBotLocaleRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.PreconditionFailedException
- Your request couldn't be completed because one or more request fields aren't valid. Check the fields in
your request and try again.ConflictException
- The action that you tried to perform couldn't be completed because the resource is in a conflicting
state. For example, deleting a bot that is in the CREATING state. Try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.CreateBotResult createBot(CreateBotRequest createBotRequest)
Creates an Amazon Lex conversational bot.
createBotRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.PreconditionFailedException
- Your request couldn't be completed because one or more request fields aren't valid. Check the fields in
your request and try again.ConflictException
- The action that you tried to perform couldn't be completed because the resource is in a conflicting
state. For example, deleting a bot that is in the CREATING state. Try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.CreateBotAliasResult createBotAlias(CreateBotAliasRequest 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.
createBotAliasRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.PreconditionFailedException
- Your request couldn't be completed because one or more request fields aren't valid. Check the fields in
your request and try again.ConflictException
- The action that you tried to perform couldn't be completed because the resource is in a conflicting
state. For example, deleting a bot that is in the CREATING state. Try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.CreateBotLocaleResult createBotLocale(CreateBotLocaleRequest 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.
createBotLocaleRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.PreconditionFailedException
- Your request couldn't be completed because one or more request fields aren't valid. Check the fields in
your request and try again.ConflictException
- The action that you tried to perform couldn't be completed because the resource is in a conflicting
state. For example, deleting a bot that is in the CREATING state. Try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.CreateBotReplicaResult createBotReplica(CreateBotReplicaRequest createBotReplicaRequest)
Action to create a replication of the source bot in the secondary region.
createBotReplicaRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.PreconditionFailedException
- Your request couldn't be completed because one or more request fields aren't valid. Check the fields in
your request and try again.ConflictException
- The action that you tried to perform couldn't be completed because the resource is in a conflicting
state. For example, deleting a bot that is in the CREATING state. Try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.CreateBotVersionResult createBotVersion(CreateBotVersionRequest 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.
createBotVersionRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.PreconditionFailedException
- Your request couldn't be completed because one or more request fields aren't valid. Check the fields in
your request and try again.ConflictException
- The action that you tried to perform couldn't be completed because the resource is in a conflicting
state. For example, deleting a bot that is in the CREATING state. Try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.CreateExportResult createExport(CreateExportRequest 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
createExportRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.ResourceNotFoundException
- You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try
again.ConflictException
- The action that you tried to perform couldn't be completed because the resource is in a conflicting
state. For example, deleting a bot that is in the CREATING state. Try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.CreateIntentResult createIntent(CreateIntentRequest 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?"
createIntentRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.PreconditionFailedException
- Your request couldn't be completed because one or more request fields aren't valid. Check the fields in
your request and try again.ConflictException
- The action that you tried to perform couldn't be completed because the resource is in a conflicting
state. For example, deleting a bot that is in the CREATING state. Try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.CreateResourcePolicyResult createResourcePolicy(CreateResourcePolicyRequest createResourcePolicyRequest)
Creates a new resource policy with the specified policy statements.
createResourcePolicyRequest
- ResourceNotFoundException
- You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try
again.ServiceQuotaExceededException
- You have reached a quota for your bot.PreconditionFailedException
- Your request couldn't be completed because one or more request fields aren't valid. Check the fields in
your request and try again.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.CreateResourcePolicyStatementResult createResourcePolicyStatement(CreateResourcePolicyStatementRequest 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.
createResourcePolicyStatementRequest
- ResourceNotFoundException
- You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try
again.ConflictException
- The action that you tried to perform couldn't be completed because the resource is in a conflicting
state. For example, deleting a bot that is in the CREATING state. Try your request again.ServiceQuotaExceededException
- You have reached a quota for your bot.PreconditionFailedException
- Your request couldn't be completed because one or more request fields aren't valid. Check the fields in
your request and try again.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.CreateSlotResult createSlot(CreateSlotRequest 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.
createSlotRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.PreconditionFailedException
- Your request couldn't be completed because one or more request fields aren't valid. Check the fields in
your request and try again.ConflictException
- The action that you tried to perform couldn't be completed because the resource is in a conflicting
state. For example, deleting a bot that is in the CREATING state. Try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.CreateSlotTypeResult createSlotType(CreateSlotTypeRequest 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.
createSlotTypeRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.PreconditionFailedException
- Your request couldn't be completed because one or more request fields aren't valid. Check the fields in
your request and try again.ConflictException
- The action that you tried to perform couldn't be completed because the resource is in a conflicting
state. For example, deleting a bot that is in the CREATING state. Try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.CreateTestSetDiscrepancyReportResult createTestSetDiscrepancyReport(CreateTestSetDiscrepancyReportRequest createTestSetDiscrepancyReportRequest)
Create a report that describes the differences between the bot and the test set.
createTestSetDiscrepancyReportRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.ConflictException
- The action that you tried to perform couldn't be completed because the resource is in a conflicting
state. For example, deleting a bot that is in the CREATING state. Try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.ResourceNotFoundException
- You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try
again.CreateUploadUrlResult createUploadUrl(CreateUploadUrlRequest createUploadUrlRequest)
Gets a pre-signed S3 write URL that you use to upload the zip archive when importing a bot or a bot locale.
createUploadUrlRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.ResourceNotFoundException
- You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try
again.ConflictException
- The action that you tried to perform couldn't be completed because the resource is in a conflicting
state. For example, deleting a bot that is in the CREATING state. Try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.DeleteBotResult deleteBot(DeleteBotRequest 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
.
deleteBotRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.ConflictException
- The action that you tried to perform couldn't be completed because the resource is in a conflicting
state. For example, deleting a bot that is in the CREATING state. Try your request again.PreconditionFailedException
- Your request couldn't be completed because one or more request fields aren't valid. Check the fields in
your request and try again.InternalServerException
- The service encountered an unexpected condition. Try your request again.DeleteBotAliasResult deleteBotAlias(DeleteBotAliasRequest deleteBotAliasRequest)
Deletes the specified bot alias.
deleteBotAliasRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.ConflictException
- The action that you tried to perform couldn't be completed because the resource is in a conflicting
state. For example, deleting a bot that is in the CREATING state. Try your request again.PreconditionFailedException
- Your request couldn't be completed because one or more request fields aren't valid. Check the fields in
your request and try again.InternalServerException
- The service encountered an unexpected condition. Try your request again.DeleteBotLocaleResult deleteBotLocale(DeleteBotLocaleRequest 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.
deleteBotLocaleRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.PreconditionFailedException
- Your request couldn't be completed because one or more request fields aren't valid. Check the fields in
your request and try again.ConflictException
- The action that you tried to perform couldn't be completed because the resource is in a conflicting
state. For example, deleting a bot that is in the CREATING state. Try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.DeleteBotReplicaResult deleteBotReplica(DeleteBotReplicaRequest deleteBotReplicaRequest)
The action to delete the replicated bot in the secondary region.
deleteBotReplicaRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.PreconditionFailedException
- Your request couldn't be completed because one or more request fields aren't valid. Check the fields in
your request and try again.ConflictException
- The action that you tried to perform couldn't be completed because the resource is in a conflicting
state. For example, deleting a bot that is in the CREATING state. Try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.DeleteBotVersionResult deleteBotVersion(DeleteBotVersionRequest deleteBotVersionRequest)
Deletes a specific version of a bot. To delete all versions of a bot, use the DeleteBot operation.
deleteBotVersionRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.ConflictException
- The action that you tried to perform couldn't be completed because the resource is in a conflicting
state. For example, deleting a bot that is in the CREATING state. Try your request again.PreconditionFailedException
- Your request couldn't be completed because one or more request fields aren't valid. Check the fields in
your request and try again.InternalServerException
- The service encountered an unexpected condition. Try your request again.DeleteCustomVocabularyResult deleteCustomVocabulary(DeleteCustomVocabularyRequest deleteCustomVocabularyRequest)
Removes a custom vocabulary from the specified locale in the specified bot.
deleteCustomVocabularyRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.PreconditionFailedException
- Your request couldn't be completed because one or more request fields aren't valid. Check the fields in
your request and try again.ConflictException
- The action that you tried to perform couldn't be completed because the resource is in a conflicting
state. For example, deleting a bot that is in the CREATING state. Try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.DeleteExportResult deleteExport(DeleteExportRequest deleteExportRequest)
Removes a previous export and the associated files stored in an S3 bucket.
deleteExportRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.PreconditionFailedException
- Your request couldn't be completed because one or more request fields aren't valid. Check the fields in
your request and try again.InternalServerException
- The service encountered an unexpected condition. Try your request again.DeleteImportResult deleteImport(DeleteImportRequest deleteImportRequest)
Removes a previous import and the associated file stored in an S3 bucket.
deleteImportRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.PreconditionFailedException
- Your request couldn't be completed because one or more request fields aren't valid. Check the fields in
your request and try again.InternalServerException
- The service encountered an unexpected condition. Try your request again.DeleteIntentResult deleteIntent(DeleteIntentRequest deleteIntentRequest)
Removes the specified intent.
Deleting an intent also deletes the slots associated with the intent.
deleteIntentRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.ConflictException
- The action that you tried to perform couldn't be completed because the resource is in a conflicting
state. For example, deleting a bot that is in the CREATING state. Try your request again.PreconditionFailedException
- Your request couldn't be completed because one or more request fields aren't valid. Check the fields in
your request and try again.InternalServerException
- The service encountered an unexpected condition. Try your request again.DeleteResourcePolicyResult deleteResourcePolicy(DeleteResourcePolicyRequest 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.
deleteResourcePolicyRequest
- ResourceNotFoundException
- You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try
again.PreconditionFailedException
- Your request couldn't be completed because one or more request fields aren't valid. Check the fields in
your request and try again.InternalServerException
- The service encountered an unexpected condition. Try your request again.ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.DeleteResourcePolicyStatementResult deleteResourcePolicyStatement(DeleteResourcePolicyStatementRequest 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.
deleteResourcePolicyStatementRequest
- ResourceNotFoundException
- You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try
again.PreconditionFailedException
- Your request couldn't be completed because one or more request fields aren't valid. Check the fields in
your request and try again.InternalServerException
- The service encountered an unexpected condition. Try your request again.ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.DeleteSlotResult deleteSlot(DeleteSlotRequest deleteSlotRequest)
Deletes the specified slot from an intent.
deleteSlotRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.ConflictException
- The action that you tried to perform couldn't be completed because the resource is in a conflicting
state. For example, deleting a bot that is in the CREATING state. Try your request again.PreconditionFailedException
- Your request couldn't be completed because one or more request fields aren't valid. Check the fields in
your request and try again.InternalServerException
- The service encountered an unexpected condition. Try your request again.DeleteSlotTypeResult deleteSlotType(DeleteSlotTypeRequest 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
.
deleteSlotTypeRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.ConflictException
- The action that you tried to perform couldn't be completed because the resource is in a conflicting
state. For example, deleting a bot that is in the CREATING state. Try your request again.PreconditionFailedException
- Your request couldn't be completed because one or more request fields aren't valid. Check the fields in
your request and try again.InternalServerException
- The service encountered an unexpected condition. Try your request again.DeleteTestSetResult deleteTestSet(DeleteTestSetRequest deleteTestSetRequest)
The action to delete the selected test set.
deleteTestSetRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.ConflictException
- The action that you tried to perform couldn't be completed because the resource is in a conflicting
state. For example, deleting a bot that is in the CREATING state. Try your request again.PreconditionFailedException
- Your request couldn't be completed because one or more request fields aren't valid. Check the fields in
your request and try again.InternalServerException
- The service encountered an unexpected condition. Try your request again.DeleteUtterancesResult deleteUtterances(DeleteUtterancesRequest 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.
deleteUtterancesRequest
- ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.InternalServerException
- The service encountered an unexpected condition. Try your request again.DescribeBotResult describeBot(DescribeBotRequest describeBotRequest)
Provides metadata information about a bot.
describeBotRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.ResourceNotFoundException
- You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try
again.InternalServerException
- The service encountered an unexpected condition. Try your request again.DescribeBotAliasResult describeBotAlias(DescribeBotAliasRequest describeBotAliasRequest)
Get information about a specific bot alias.
describeBotAliasRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.ResourceNotFoundException
- You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try
again.InternalServerException
- The service encountered an unexpected condition. Try your request again.DescribeBotLocaleResult describeBotLocale(DescribeBotLocaleRequest describeBotLocaleRequest)
Describes the settings that a bot has for a specific locale.
describeBotLocaleRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.ResourceNotFoundException
- You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try
again.InternalServerException
- The service encountered an unexpected condition. Try your request again.DescribeBotRecommendationResult describeBotRecommendation(DescribeBotRecommendationRequest 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.
describeBotRecommendationRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.ResourceNotFoundException
- You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try
again.InternalServerException
- The service encountered an unexpected condition. Try your request again.DescribeBotReplicaResult describeBotReplica(DescribeBotReplicaRequest describeBotReplicaRequest)
Monitors the bot replication status through the UI console.
describeBotReplicaRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.ResourceNotFoundException
- You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try
again.InternalServerException
- The service encountered an unexpected condition. Try your request again.DescribeBotResourceGenerationResult describeBotResourceGeneration(DescribeBotResourceGenerationRequest 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.
describeBotResourceGenerationRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.ResourceNotFoundException
- You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try
again.InternalServerException
- The service encountered an unexpected condition. Try your request again.DescribeBotVersionResult describeBotVersion(DescribeBotVersionRequest describeBotVersionRequest)
Provides metadata about a version of a bot.
describeBotVersionRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.ResourceNotFoundException
- You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try
again.InternalServerException
- The service encountered an unexpected condition. Try your request again.DescribeCustomVocabularyMetadataResult describeCustomVocabularyMetadata(DescribeCustomVocabularyMetadataRequest describeCustomVocabularyMetadataRequest)
Provides metadata information about a custom vocabulary.
describeCustomVocabularyMetadataRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.ResourceNotFoundException
- You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try
again.InternalServerException
- The service encountered an unexpected condition. Try your request again.DescribeExportResult describeExport(DescribeExportRequest describeExportRequest)
Gets information about a specific export.
describeExportRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.ResourceNotFoundException
- You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try
again.InternalServerException
- The service encountered an unexpected condition. Try your request again.DescribeImportResult describeImport(DescribeImportRequest describeImportRequest)
Gets information about a specific import.
describeImportRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.ResourceNotFoundException
- You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try
again.InternalServerException
- The service encountered an unexpected condition. Try your request again.DescribeIntentResult describeIntent(DescribeIntentRequest describeIntentRequest)
Returns metadata about an intent.
describeIntentRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.ResourceNotFoundException
- You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try
again.InternalServerException
- The service encountered an unexpected condition. Try your request again.DescribeResourcePolicyResult describeResourcePolicy(DescribeResourcePolicyRequest describeResourcePolicyRequest)
Gets the resource policy and policy revision for a bot or bot alias.
describeResourcePolicyRequest
- ResourceNotFoundException
- You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try
again.InternalServerException
- The service encountered an unexpected condition. Try your request again.ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.DescribeSlotResult describeSlot(DescribeSlotRequest describeSlotRequest)
Gets metadata information about a slot.
describeSlotRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.ResourceNotFoundException
- You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try
again.InternalServerException
- The service encountered an unexpected condition. Try your request again.DescribeSlotTypeResult describeSlotType(DescribeSlotTypeRequest describeSlotTypeRequest)
Gets metadata information about a slot type.
describeSlotTypeRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.ResourceNotFoundException
- You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try
again.InternalServerException
- The service encountered an unexpected condition. Try your request again.DescribeTestExecutionResult describeTestExecution(DescribeTestExecutionRequest describeTestExecutionRequest)
Gets metadata information about the test execution.
describeTestExecutionRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.ResourceNotFoundException
- You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try
again.InternalServerException
- The service encountered an unexpected condition. Try your request again.DescribeTestSetResult describeTestSet(DescribeTestSetRequest describeTestSetRequest)
Gets metadata information about the test set.
describeTestSetRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.ResourceNotFoundException
- You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try
again.InternalServerException
- The service encountered an unexpected condition. Try your request again.DescribeTestSetDiscrepancyReportResult describeTestSetDiscrepancyReport(DescribeTestSetDiscrepancyReportRequest describeTestSetDiscrepancyReportRequest)
Gets metadata information about the test set discrepancy report.
describeTestSetDiscrepancyReportRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.ResourceNotFoundException
- You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try
again.InternalServerException
- The service encountered an unexpected condition. Try your request again.DescribeTestSetGenerationResult describeTestSetGeneration(DescribeTestSetGenerationRequest describeTestSetGenerationRequest)
Gets metadata information about the test set generation.
describeTestSetGenerationRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.ResourceNotFoundException
- You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try
again.InternalServerException
- The service encountered an unexpected condition. Try your request again.GenerateBotElementResult generateBotElement(GenerateBotElementRequest generateBotElementRequest)
Generates sample utterances for an intent.
generateBotElementRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.ResourceNotFoundException
- You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try
again.ConflictException
- The action that you tried to perform couldn't be completed because the resource is in a conflicting
state. For example, deleting a bot that is in the CREATING state. Try your request again.PreconditionFailedException
- Your request couldn't be completed because one or more request fields aren't valid. Check the fields in
your request and try again.ConflictException
- The action that you tried to perform couldn't be completed because the resource is in a conflicting
state. For example, deleting a bot that is in the CREATING state. Try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.GetTestExecutionArtifactsUrlResult getTestExecutionArtifactsUrl(GetTestExecutionArtifactsUrlRequest getTestExecutionArtifactsUrlRequest)
The pre-signed Amazon S3 URL to download the test execution result artifacts.
getTestExecutionArtifactsUrlRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.ResourceNotFoundException
- You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try
again.InternalServerException
- The service encountered an unexpected condition. Try your request again.ListAggregatedUtterancesResult listAggregatedUtterances(ListAggregatedUtterancesRequest 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.
listAggregatedUtterancesRequest
- ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.PreconditionFailedException
- Your request couldn't be completed because one or more request fields aren't valid. Check the fields in
your request and try again.ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.InternalServerException
- The service encountered an unexpected condition. Try your request again.ListBotAliasReplicasResult listBotAliasReplicas(ListBotAliasReplicasRequest listBotAliasReplicasRequest)
The action to list the replicated bots created from the source bot alias.
listBotAliasReplicasRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.ListBotAliasesResult listBotAliases(ListBotAliasesRequest listBotAliasesRequest)
Gets a list of aliases for the specified bot.
listBotAliasesRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.ListBotLocalesResult listBotLocales(ListBotLocalesRequest listBotLocalesRequest)
Gets a list of locales for the specified bot.
listBotLocalesRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.ListBotRecommendationsResult listBotRecommendations(ListBotRecommendationsRequest listBotRecommendationsRequest)
Get a list of bot recommendations that meet the specified criteria.
listBotRecommendationsRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.ResourceNotFoundException
- You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try
again.ListBotReplicasResult listBotReplicas(ListBotReplicasRequest listBotReplicasRequest)
The action to list the replicated bots.
listBotReplicasRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.ListBotResourceGenerationsResult listBotResourceGenerations(ListBotResourceGenerationsRequest listBotResourceGenerationsRequest)
Lists the generation requests made for a bot locale.
listBotResourceGenerationsRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.ResourceNotFoundException
- You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try
again.ListBotVersionReplicasResult listBotVersionReplicas(ListBotVersionReplicasRequest listBotVersionReplicasRequest)
Contains information about all the versions replication statuses applicable for Global Resiliency.
listBotVersionReplicasRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.ListBotVersionsResult listBotVersions(ListBotVersionsRequest 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.
listBotVersionsRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.ListBotsResult listBots(ListBotsRequest listBotsRequest)
Gets a list of available bots.
listBotsRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.ListBuiltInIntentsResult listBuiltInIntents(ListBuiltInIntentsRequest 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.
listBuiltInIntentsRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.ListBuiltInSlotTypesResult listBuiltInSlotTypes(ListBuiltInSlotTypesRequest listBuiltInSlotTypesRequest)
Gets a list of built-in slot types that meet the specified criteria.
listBuiltInSlotTypesRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.ListCustomVocabularyItemsResult listCustomVocabularyItems(ListCustomVocabularyItemsRequest listCustomVocabularyItemsRequest)
Paginated list of custom vocabulary items for a given bot locale's custom vocabulary.
listCustomVocabularyItemsRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.ResourceNotFoundException
- You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try
again.InternalServerException
- The service encountered an unexpected condition. Try your request again.ListExportsResult listExports(ListExportsRequest listExportsRequest)
Lists the exports for a bot, bot locale, or custom vocabulary. Exports are kept in the list for 7 days.
listExportsRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.ListImportsResult listImports(ListImportsRequest listImportsRequest)
Lists the imports for a bot, bot locale, or custom vocabulary. Imports are kept in the list for 7 days.
listImportsRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.ListIntentMetricsResult listIntentMetrics(ListIntentMetricsRequest 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.
listIntentMetricsRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.PreconditionFailedException
- Your request couldn't be completed because one or more request fields aren't valid. Check the fields in
your request and try again.ServiceQuotaExceededException
- You have reached a quota for your bot.InternalServerException
- The service encountered an unexpected condition. Try your request again.ListIntentPathsResult listIntentPaths(ListIntentPathsRequest 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.
listIntentPathsRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.PreconditionFailedException
- Your request couldn't be completed because one or more request fields aren't valid. Check the fields in
your request and try again.ServiceQuotaExceededException
- You have reached a quota for your bot.InternalServerException
- The service encountered an unexpected condition. Try your request again.ListIntentStageMetricsResult listIntentStageMetrics(ListIntentStageMetricsRequest 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.
listIntentStageMetricsRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.PreconditionFailedException
- Your request couldn't be completed because one or more request fields aren't valid. Check the fields in
your request and try again.ServiceQuotaExceededException
- You have reached a quota for your bot.InternalServerException
- The service encountered an unexpected condition. Try your request again.ListIntentsResult listIntents(ListIntentsRequest listIntentsRequest)
Get a list of intents that meet the specified criteria.
listIntentsRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.ListRecommendedIntentsResult listRecommendedIntents(ListRecommendedIntentsRequest 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.
listRecommendedIntentsRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.ResourceNotFoundException
- You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try
again.ListSessionAnalyticsDataResult listSessionAnalyticsData(ListSessionAnalyticsDataRequest 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.
listSessionAnalyticsDataRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.PreconditionFailedException
- Your request couldn't be completed because one or more request fields aren't valid. Check the fields in
your request and try again.ServiceQuotaExceededException
- You have reached a quota for your bot.InternalServerException
- The service encountered an unexpected condition. Try your request again.ListSessionMetricsResult listSessionMetrics(ListSessionMetricsRequest 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.
listSessionMetricsRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.PreconditionFailedException
- Your request couldn't be completed because one or more request fields aren't valid. Check the fields in
your request and try again.ServiceQuotaExceededException
- You have reached a quota for your bot.InternalServerException
- The service encountered an unexpected condition. Try your request again.ListSlotTypesResult listSlotTypes(ListSlotTypesRequest listSlotTypesRequest)
Gets a list of slot types that match the specified criteria.
listSlotTypesRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.ListSlotsResult listSlots(ListSlotsRequest listSlotsRequest)
Gets a list of slots that match the specified criteria.
listSlotsRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Gets a list of tags associated with a resource. Only bots, bot aliases, and bot channels can have tags associated with them.
listTagsForResourceRequest
- InternalServerException
- The service encountered an unexpected condition. Try your request again.ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ResourceNotFoundException
- You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try
again.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.ListTestExecutionResultItemsResult listTestExecutionResultItems(ListTestExecutionResultItemsRequest listTestExecutionResultItemsRequest)
Gets a list of test execution result items.
listTestExecutionResultItemsRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.ResourceNotFoundException
- You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try
again.InternalServerException
- The service encountered an unexpected condition. Try your request again.ListTestExecutionsResult listTestExecutions(ListTestExecutionsRequest listTestExecutionsRequest)
The list of test set executions.
listTestExecutionsRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.ListTestSetRecordsResult listTestSetRecords(ListTestSetRecordsRequest listTestSetRecordsRequest)
The list of test set records.
listTestSetRecordsRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.ResourceNotFoundException
- You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try
again.InternalServerException
- The service encountered an unexpected condition. Try your request again.ListTestSetsResult listTestSets(ListTestSetsRequest listTestSetsRequest)
The list of the test sets
listTestSetsRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.ListUtteranceAnalyticsDataResult listUtteranceAnalyticsData(ListUtteranceAnalyticsDataRequest 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.
listUtteranceAnalyticsDataRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.PreconditionFailedException
- Your request couldn't be completed because one or more request fields aren't valid. Check the fields in
your request and try again.ServiceQuotaExceededException
- You have reached a quota for your bot.InternalServerException
- The service encountered an unexpected condition. Try your request again.ListUtteranceMetricsResult listUtteranceMetrics(ListUtteranceMetricsRequest 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.
listUtteranceMetricsRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.PreconditionFailedException
- Your request couldn't be completed because one or more request fields aren't valid. Check the fields in
your request and try again.ServiceQuotaExceededException
- You have reached a quota for your bot.InternalServerException
- The service encountered an unexpected condition. Try your request again.SearchAssociatedTranscriptsResult searchAssociatedTranscripts(SearchAssociatedTranscriptsRequest searchAssociatedTranscriptsRequest)
Search for associated transcripts that meet the specified criteria.
searchAssociatedTranscriptsRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.ResourceNotFoundException
- You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try
again.StartBotRecommendationResult startBotRecommendation(StartBotRecommendationRequest startBotRecommendationRequest)
Use this to provide your transcript data, and to start the bot recommendation process.
startBotRecommendationRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.ResourceNotFoundException
- You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try
again.ConflictException
- The action that you tried to perform couldn't be completed because the resource is in a conflicting
state. For example, deleting a bot that is in the CREATING state. Try your request again.PreconditionFailedException
- Your request couldn't be completed because one or more request fields aren't valid. Check the fields in
your request and try again.ConflictException
- The action that you tried to perform couldn't be completed because the resource is in a conflicting
state. For example, deleting a bot that is in the CREATING state. Try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.StartBotResourceGenerationResult startBotResourceGeneration(StartBotResourceGenerationRequest 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.
startBotResourceGenerationRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.PreconditionFailedException
- Your request couldn't be completed because one or more request fields aren't valid. Check the fields in
your request and try again.ConflictException
- The action that you tried to perform couldn't be completed because the resource is in a conflicting
state. For example, deleting a bot that is in the CREATING state. Try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.StartImportResult startImport(StartImportRequest startImportRequest)
Starts importing a bot, bot locale, or custom vocabulary from a zip archive that you uploaded to an S3 bucket.
startImportRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.ResourceNotFoundException
- You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try
again.ConflictException
- The action that you tried to perform couldn't be completed because the resource is in a conflicting
state. For example, deleting a bot that is in the CREATING state. Try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.StartTestExecutionResult startTestExecution(StartTestExecutionRequest startTestExecutionRequest)
The action to start test set execution.
startTestExecutionRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ResourceNotFoundException
- You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try
again.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.ConflictException
- The action that you tried to perform couldn't be completed because the resource is in a conflicting
state. For example, deleting a bot that is in the CREATING state. Try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.StartTestSetGenerationResult startTestSetGeneration(StartTestSetGenerationRequest startTestSetGenerationRequest)
The action to start the generation of test set.
startTestSetGenerationRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.ConflictException
- The action that you tried to perform couldn't be completed because the resource is in a conflicting
state. For example, deleting a bot that is in the CREATING state. Try your request again.ResourceNotFoundException
- You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try
again.InternalServerException
- The service encountered an unexpected condition. Try your request again.StopBotRecommendationResult stopBotRecommendation(StopBotRecommendationRequest stopBotRecommendationRequest)
Stop an already running Bot Recommendation request.
stopBotRecommendationRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.ResourceNotFoundException
- You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try
again.ConflictException
- The action that you tried to perform couldn't be completed because the resource is in a conflicting
state. For example, deleting a bot that is in the CREATING state. Try your request again.PreconditionFailedException
- Your request couldn't be completed because one or more request fields aren't valid. Check the fields in
your request and try again.ConflictException
- The action that you tried to perform couldn't be completed because the resource is in a conflicting
state. For example, deleting a bot that is in the CREATING state. Try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Adds the specified tags to the specified resource. If a tag key already exists, the existing value is replaced with the new value.
tagResourceRequest
- InternalServerException
- The service encountered an unexpected condition. Try your request again.ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ResourceNotFoundException
- You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try
again.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from a bot, bot alias, or bot channel.
untagResourceRequest
- InternalServerException
- The service encountered an unexpected condition. Try your request again.ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ResourceNotFoundException
- You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try
again.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.UpdateBotResult updateBot(UpdateBotRequest updateBotRequest)
Updates the configuration of an existing bot.
updateBotRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.PreconditionFailedException
- Your request couldn't be completed because one or more request fields aren't valid. Check the fields in
your request and try again.ConflictException
- The action that you tried to perform couldn't be completed because the resource is in a conflicting
state. For example, deleting a bot that is in the CREATING state. Try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.UpdateBotAliasResult updateBotAlias(UpdateBotAliasRequest updateBotAliasRequest)
Updates the configuration of an existing bot alias.
updateBotAliasRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.PreconditionFailedException
- Your request couldn't be completed because one or more request fields aren't valid. Check the fields in
your request and try again.ConflictException
- The action that you tried to perform couldn't be completed because the resource is in a conflicting
state. For example, deleting a bot that is in the CREATING state. Try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.UpdateBotLocaleResult updateBotLocale(UpdateBotLocaleRequest updateBotLocaleRequest)
Updates the settings that a bot has for a specific locale.
updateBotLocaleRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.PreconditionFailedException
- Your request couldn't be completed because one or more request fields aren't valid. Check the fields in
your request and try again.ConflictException
- The action that you tried to perform couldn't be completed because the resource is in a conflicting
state. For example, deleting a bot that is in the CREATING state. Try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.UpdateBotRecommendationResult updateBotRecommendation(UpdateBotRecommendationRequest updateBotRecommendationRequest)
Updates an existing bot recommendation request.
updateBotRecommendationRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.ResourceNotFoundException
- You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try
again.ConflictException
- The action that you tried to perform couldn't be completed because the resource is in a conflicting
state. For example, deleting a bot that is in the CREATING state. Try your request again.PreconditionFailedException
- Your request couldn't be completed because one or more request fields aren't valid. Check the fields in
your request and try again.ConflictException
- The action that you tried to perform couldn't be completed because the resource is in a conflicting
state. For example, deleting a bot that is in the CREATING state. Try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.UpdateExportResult updateExport(UpdateExportRequest 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.
updateExportRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.ResourceNotFoundException
- You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try
again.ConflictException
- The action that you tried to perform couldn't be completed because the resource is in a conflicting
state. For example, deleting a bot that is in the CREATING state. Try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.UpdateIntentResult updateIntent(UpdateIntentRequest updateIntentRequest)
Updates the settings for an intent.
updateIntentRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.PreconditionFailedException
- Your request couldn't be completed because one or more request fields aren't valid. Check the fields in
your request and try again.ConflictException
- The action that you tried to perform couldn't be completed because the resource is in a conflicting
state. For example, deleting a bot that is in the CREATING state. Try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.UpdateResourcePolicyResult updateResourcePolicy(UpdateResourcePolicyRequest 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.
updateResourcePolicyRequest
- ResourceNotFoundException
- You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try
again.ServiceQuotaExceededException
- You have reached a quota for your bot.PreconditionFailedException
- Your request couldn't be completed because one or more request fields aren't valid. Check the fields in
your request and try again.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.UpdateSlotResult updateSlot(UpdateSlotRequest updateSlotRequest)
Updates the settings for a slot.
updateSlotRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.PreconditionFailedException
- Your request couldn't be completed because one or more request fields aren't valid. Check the fields in
your request and try again.ConflictException
- The action that you tried to perform couldn't be completed because the resource is in a conflicting
state. For example, deleting a bot that is in the CREATING state. Try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.UpdateSlotTypeResult updateSlotType(UpdateSlotTypeRequest updateSlotTypeRequest)
Updates the configuration of an existing slot type.
updateSlotTypeRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.PreconditionFailedException
- Your request couldn't be completed because one or more request fields aren't valid. Check the fields in
your request and try again.ConflictException
- The action that you tried to perform couldn't be completed because the resource is in a conflicting
state. For example, deleting a bot that is in the CREATING state. Try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.UpdateTestSetResult updateTestSet(UpdateTestSetRequest updateTestSetRequest)
The action to update the test set.
updateTestSetRequest
- ThrottlingException
- Your request rate is too high. Reduce the frequency of requests.ServiceQuotaExceededException
- You have reached a quota for your bot.ValidationException
- One of the input parameters in your request isn't valid. Check the parameters and try your request again.PreconditionFailedException
- Your request couldn't be completed because one or more request fields aren't valid. Check the fields in
your request and try again.ConflictException
- The action that you tried to perform couldn't be completed because the resource is in a conflicting
state. For example, deleting a bot that is in the CREATING state. Try your request again.InternalServerException
- The service encountered an unexpected condition. Try your request again.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request
- The originally executed request.AmazonLexModelsV2Waiters waiters()