@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonLexModelsV2Client extends AmazonWebServiceClient implements AmazonLexModelsV2
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
BatchCreateCustomVocabularyItemResult |
batchCreateCustomVocabularyItem(BatchCreateCustomVocabularyItemRequest request)
Create a batch of custom vocabulary items for a given bot locale's custom vocabulary.
|
BatchDeleteCustomVocabularyItemResult |
batchDeleteCustomVocabularyItem(BatchDeleteCustomVocabularyItemRequest request)
Delete a batch of custom vocabulary items for a given bot locale's custom vocabulary.
|
BatchUpdateCustomVocabularyItemResult |
batchUpdateCustomVocabularyItem(BatchUpdateCustomVocabularyItemRequest request)
Update a batch of custom vocabulary items for a given bot locale's custom vocabulary.
|
BuildBotLocaleResult |
buildBotLocale(BuildBotLocaleRequest request)
Builds a bot, its intents, and its slot types into a specific locale.
|
static AmazonLexModelsV2ClientBuilder |
builder() |
CreateBotResult |
createBot(CreateBotRequest request)
Creates an Amazon Lex conversational bot.
|
CreateBotAliasResult |
createBotAlias(CreateBotAliasRequest request)
Creates an alias for the specified version of a bot.
|
CreateBotLocaleResult |
createBotLocale(CreateBotLocaleRequest request)
Creates a locale in the bot.
|
CreateBotReplicaResult |
createBotReplica(CreateBotReplicaRequest request)
Action to create a replication of the source bot in the secondary region.
|
CreateBotVersionResult |
createBotVersion(CreateBotVersionRequest request)
Creates an immutable version of the bot.
|
CreateExportResult |
createExport(CreateExportRequest request)
Creates a zip archive containing the contents of a bot or a bot locale.
|
CreateIntentResult |
createIntent(CreateIntentRequest request)
Creates an intent.
|
CreateResourcePolicyResult |
createResourcePolicy(CreateResourcePolicyRequest request)
Creates a new resource policy with the specified policy statements.
|
CreateResourcePolicyStatementResult |
createResourcePolicyStatement(CreateResourcePolicyStatementRequest request)
Adds a new resource policy statement to a bot or bot alias.
|
CreateSlotResult |
createSlot(CreateSlotRequest request)
Creates a slot in an intent.
|
CreateSlotTypeResult |
createSlotType(CreateSlotTypeRequest request)
Creates a custom slot type
|
CreateTestSetDiscrepancyReportResult |
createTestSetDiscrepancyReport(CreateTestSetDiscrepancyReportRequest request)
Create a report that describes the differences between the bot and the test set.
|
CreateUploadUrlResult |
createUploadUrl(CreateUploadUrlRequest request)
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 request)
Deletes all versions of a bot, including the
Draft version. |
DeleteBotAliasResult |
deleteBotAlias(DeleteBotAliasRequest request)
Deletes the specified bot alias.
|
DeleteBotLocaleResult |
deleteBotLocale(DeleteBotLocaleRequest request)
Removes a locale from a bot.
|
DeleteBotReplicaResult |
deleteBotReplica(DeleteBotReplicaRequest request)
The action to delete the replicated bot in the secondary region.
|
DeleteBotVersionResult |
deleteBotVersion(DeleteBotVersionRequest request)
Deletes a specific version of a bot.
|
DeleteCustomVocabularyResult |
deleteCustomVocabulary(DeleteCustomVocabularyRequest request)
Removes a custom vocabulary from the specified locale in the specified bot.
|
DeleteExportResult |
deleteExport(DeleteExportRequest request)
Removes a previous export and the associated files stored in an S3 bucket.
|
DeleteImportResult |
deleteImport(DeleteImportRequest request)
Removes a previous import and the associated file stored in an S3 bucket.
|
DeleteIntentResult |
deleteIntent(DeleteIntentRequest request)
Removes the specified intent.
|
DeleteResourcePolicyResult |
deleteResourcePolicy(DeleteResourcePolicyRequest request)
Removes an existing policy from a bot or bot alias.
|
DeleteResourcePolicyStatementResult |
deleteResourcePolicyStatement(DeleteResourcePolicyStatementRequest request)
Deletes a policy statement from a resource policy.
|
DeleteSlotResult |
deleteSlot(DeleteSlotRequest request)
Deletes the specified slot from an intent.
|
DeleteSlotTypeResult |
deleteSlotType(DeleteSlotTypeRequest request)
Deletes a slot type from a bot locale.
|
DeleteTestSetResult |
deleteTestSet(DeleteTestSetRequest request)
The action to delete the selected test set.
|
DeleteUtterancesResult |
deleteUtterances(DeleteUtterancesRequest request)
Deletes stored utterances.
|
DescribeBotResult |
describeBot(DescribeBotRequest request)
Provides metadata information about a bot.
|
DescribeBotAliasResult |
describeBotAlias(DescribeBotAliasRequest request)
Get information about a specific bot alias.
|
DescribeBotLocaleResult |
describeBotLocale(DescribeBotLocaleRequest request)
Describes the settings that a bot has for a specific locale.
|
DescribeBotRecommendationResult |
describeBotRecommendation(DescribeBotRecommendationRequest request)
Provides metadata information about a bot recommendation.
|
DescribeBotReplicaResult |
describeBotReplica(DescribeBotReplicaRequest request)
Monitors the bot replication status through the UI console.
|
DescribeBotResourceGenerationResult |
describeBotResourceGeneration(DescribeBotResourceGenerationRequest request)
Returns information about a request to generate a bot through natural language description, made through the
StartBotResource API. |
DescribeBotVersionResult |
describeBotVersion(DescribeBotVersionRequest request)
Provides metadata about a version of a bot.
|
DescribeCustomVocabularyMetadataResult |
describeCustomVocabularyMetadata(DescribeCustomVocabularyMetadataRequest request)
Provides metadata information about a custom vocabulary.
|
DescribeExportResult |
describeExport(DescribeExportRequest request)
Gets information about a specific export.
|
DescribeImportResult |
describeImport(DescribeImportRequest request)
Gets information about a specific import.
|
DescribeIntentResult |
describeIntent(DescribeIntentRequest request)
Returns metadata about an intent.
|
DescribeResourcePolicyResult |
describeResourcePolicy(DescribeResourcePolicyRequest request)
Gets the resource policy and policy revision for a bot or bot alias.
|
DescribeSlotResult |
describeSlot(DescribeSlotRequest request)
Gets metadata information about a slot.
|
DescribeSlotTypeResult |
describeSlotType(DescribeSlotTypeRequest request)
Gets metadata information about a slot type.
|
DescribeTestExecutionResult |
describeTestExecution(DescribeTestExecutionRequest request)
Gets metadata information about the test execution.
|
DescribeTestSetResult |
describeTestSet(DescribeTestSetRequest request)
Gets metadata information about the test set.
|
DescribeTestSetDiscrepancyReportResult |
describeTestSetDiscrepancyReport(DescribeTestSetDiscrepancyReportRequest request)
Gets metadata information about the test set discrepancy report.
|
DescribeTestSetGenerationResult |
describeTestSetGeneration(DescribeTestSetGenerationRequest request)
Gets metadata information about the test set generation.
|
GenerateBotElementResult |
generateBotElement(GenerateBotElementRequest request)
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 request)
The pre-signed Amazon S3 URL to download the test execution result artifacts.
|
ListAggregatedUtterancesResult |
listAggregatedUtterances(ListAggregatedUtterancesRequest request)
Provides a list of utterances that users have sent to the bot.
|
ListBotAliasesResult |
listBotAliases(ListBotAliasesRequest request)
Gets a list of aliases for the specified bot.
|
ListBotAliasReplicasResult |
listBotAliasReplicas(ListBotAliasReplicasRequest request)
The action to list the replicated bots created from the source bot alias.
|
ListBotLocalesResult |
listBotLocales(ListBotLocalesRequest request)
Gets a list of locales for the specified bot.
|
ListBotRecommendationsResult |
listBotRecommendations(ListBotRecommendationsRequest request)
Get a list of bot recommendations that meet the specified criteria.
|
ListBotReplicasResult |
listBotReplicas(ListBotReplicasRequest request)
The action to list the replicated bots.
|
ListBotResourceGenerationsResult |
listBotResourceGenerations(ListBotResourceGenerationsRequest request)
Lists the generation requests made for a bot locale.
|
ListBotsResult |
listBots(ListBotsRequest request)
Gets a list of available bots.
|
ListBotVersionReplicasResult |
listBotVersionReplicas(ListBotVersionReplicasRequest request)
Contains information about all the versions replication statuses applicable for Global Resiliency.
|
ListBotVersionsResult |
listBotVersions(ListBotVersionsRequest request)
Gets information about all of the versions of a bot.
|
ListBuiltInIntentsResult |
listBuiltInIntents(ListBuiltInIntentsRequest request)
Gets a list of built-in intents provided by Amazon Lex that you can use in your bot.
|
ListBuiltInSlotTypesResult |
listBuiltInSlotTypes(ListBuiltInSlotTypesRequest request)
Gets a list of built-in slot types that meet the specified criteria.
|
ListCustomVocabularyItemsResult |
listCustomVocabularyItems(ListCustomVocabularyItemsRequest request)
Paginated list of custom vocabulary items for a given bot locale's custom vocabulary.
|
ListExportsResult |
listExports(ListExportsRequest request)
Lists the exports for a bot, bot locale, or custom vocabulary.
|
ListImportsResult |
listImports(ListImportsRequest request)
Lists the imports for a bot, bot locale, or custom vocabulary.
|
ListIntentMetricsResult |
listIntentMetrics(ListIntentMetricsRequest request)
Retrieves summary metrics for the intents in your bot.
|
ListIntentPathsResult |
listIntentPaths(ListIntentPathsRequest request)
Retrieves summary statistics for a path of intents that users take over sessions with your bot.
|
ListIntentsResult |
listIntents(ListIntentsRequest request)
Get a list of intents that meet the specified criteria.
|
ListIntentStageMetricsResult |
listIntentStageMetrics(ListIntentStageMetricsRequest request)
Retrieves summary metrics for the stages within intents in your bot.
|
ListRecommendedIntentsResult |
listRecommendedIntents(ListRecommendedIntentsRequest request)
Gets a list of recommended intents provided by the bot recommendation that you can use in your bot.
|
ListSessionAnalyticsDataResult |
listSessionAnalyticsData(ListSessionAnalyticsDataRequest request)
Retrieves a list of metadata for individual user sessions with your bot.
|
ListSessionMetricsResult |
listSessionMetrics(ListSessionMetricsRequest request)
Retrieves summary metrics for the user sessions with your bot.
|
ListSlotsResult |
listSlots(ListSlotsRequest request)
Gets a list of slots that match the specified criteria.
|
ListSlotTypesResult |
listSlotTypes(ListSlotTypesRequest request)
Gets a list of slot types that match the specified criteria.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Gets a list of tags associated with a resource.
|
ListTestExecutionResultItemsResult |
listTestExecutionResultItems(ListTestExecutionResultItemsRequest request)
Gets a list of test execution result items.
|
ListTestExecutionsResult |
listTestExecutions(ListTestExecutionsRequest request)
The list of test set executions.
|
ListTestSetRecordsResult |
listTestSetRecords(ListTestSetRecordsRequest request)
The list of test set records.
|
ListTestSetsResult |
listTestSets(ListTestSetsRequest request)
The list of the test sets
|
ListUtteranceAnalyticsDataResult |
listUtteranceAnalyticsData(ListUtteranceAnalyticsDataRequest request)
|
ListUtteranceMetricsResult |
listUtteranceMetrics(ListUtteranceMetricsRequest request)
|
SearchAssociatedTranscriptsResult |
searchAssociatedTranscripts(SearchAssociatedTranscriptsRequest request)
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 request)
Use this to provide your transcript data, and to start the bot recommendation process.
|
StartBotResourceGenerationResult |
startBotResourceGeneration(StartBotResourceGenerationRequest request)
Starts a request for the descriptive bot builder to generate a bot locale configuration based on the prompt you
provide it.
|
StartImportResult |
startImport(StartImportRequest request)
Starts importing a bot, bot locale, or custom vocabulary from a zip archive that you uploaded to an S3 bucket.
|
StartTestExecutionResult |
startTestExecution(StartTestExecutionRequest request)
The action to start test set execution.
|
StartTestSetGenerationResult |
startTestSetGeneration(StartTestSetGenerationRequest request)
The action to start the generation of test set.
|
StopBotRecommendationResult |
stopBotRecommendation(StopBotRecommendationRequest request)
Stop an already running Bot Recommendation request.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds the specified tags to the specified resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes tags from a bot, bot alias, or bot channel.
|
UpdateBotResult |
updateBot(UpdateBotRequest request)
Updates the configuration of an existing bot.
|
UpdateBotAliasResult |
updateBotAlias(UpdateBotAliasRequest request)
Updates the configuration of an existing bot alias.
|
UpdateBotLocaleResult |
updateBotLocale(UpdateBotLocaleRequest request)
Updates the settings that a bot has for a specific locale.
|
UpdateBotRecommendationResult |
updateBotRecommendation(UpdateBotRecommendationRequest request)
Updates an existing bot recommendation request.
|
UpdateExportResult |
updateExport(UpdateExportRequest request)
Updates the password used to protect an export zip archive.
|
UpdateIntentResult |
updateIntent(UpdateIntentRequest request)
Updates the settings for an intent.
|
UpdateResourcePolicyResult |
updateResourcePolicy(UpdateResourcePolicyRequest request)
Replaces the existing resource policy for a bot or bot alias with a new one.
|
UpdateSlotResult |
updateSlot(UpdateSlotRequest request)
Updates the settings for a slot.
|
UpdateSlotTypeResult |
updateSlotType(UpdateSlotTypeRequest request)
Updates the configuration of an existing slot type.
|
UpdateTestSetResult |
updateTestSet(UpdateTestSetRequest request)
The action to update the test set.
|
AmazonLexModelsV2Waiters |
waiters() |
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
public static AmazonLexModelsV2ClientBuilder builder()
public BatchCreateCustomVocabularyItemResult batchCreateCustomVocabularyItem(BatchCreateCustomVocabularyItemRequest request)
Create a batch of custom vocabulary items for a given bot locale's custom vocabulary.
batchCreateCustomVocabularyItem
in interface AmazonLexModelsV2
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.public BatchDeleteCustomVocabularyItemResult batchDeleteCustomVocabularyItem(BatchDeleteCustomVocabularyItemRequest request)
Delete a batch of custom vocabulary items for a given bot locale's custom vocabulary.
batchDeleteCustomVocabularyItem
in interface AmazonLexModelsV2
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.public BatchUpdateCustomVocabularyItemResult batchUpdateCustomVocabularyItem(BatchUpdateCustomVocabularyItemRequest request)
Update a batch of custom vocabulary items for a given bot locale's custom vocabulary.
batchUpdateCustomVocabularyItem
in interface AmazonLexModelsV2
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.public BuildBotLocaleResult buildBotLocale(BuildBotLocaleRequest request)
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.
buildBotLocale
in interface AmazonLexModelsV2
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.public CreateBotResult createBot(CreateBotRequest request)
Creates an Amazon Lex conversational bot.
createBot
in interface AmazonLexModelsV2
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.public CreateBotAliasResult createBotAlias(CreateBotAliasRequest request)
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.
createBotAlias
in interface AmazonLexModelsV2
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.public CreateBotLocaleResult createBotLocale(CreateBotLocaleRequest request)
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.
createBotLocale
in interface AmazonLexModelsV2
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.public CreateBotReplicaResult createBotReplica(CreateBotReplicaRequest request)
Action to create a replication of the source bot in the secondary region.
createBotReplica
in interface AmazonLexModelsV2
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.public CreateBotVersionResult createBotVersion(CreateBotVersionRequest request)
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.
createBotVersion
in interface AmazonLexModelsV2
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.public CreateExportResult createExport(CreateExportRequest request)
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
createExport
in interface AmazonLexModelsV2
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.public CreateIntentResult createIntent(CreateIntentRequest request)
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?"
createIntent
in interface AmazonLexModelsV2
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.public CreateResourcePolicyResult createResourcePolicy(CreateResourcePolicyRequest request)
Creates a new resource policy with the specified policy statements.
createResourcePolicy
in interface AmazonLexModelsV2
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.public CreateResourcePolicyStatementResult createResourcePolicyStatement(CreateResourcePolicyStatementRequest request)
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.
createResourcePolicyStatement
in interface AmazonLexModelsV2
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.public CreateSlotResult createSlot(CreateSlotRequest request)
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.
createSlot
in interface AmazonLexModelsV2
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.public CreateSlotTypeResult createSlotType(CreateSlotTypeRequest request)
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.
createSlotType
in interface AmazonLexModelsV2
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.public CreateTestSetDiscrepancyReportResult createTestSetDiscrepancyReport(CreateTestSetDiscrepancyReportRequest request)
Create a report that describes the differences between the bot and the test set.
createTestSetDiscrepancyReport
in interface AmazonLexModelsV2
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.public CreateUploadUrlResult createUploadUrl(CreateUploadUrlRequest request)
Gets a pre-signed S3 write URL that you use to upload the zip archive when importing a bot or a bot locale.
createUploadUrl
in interface AmazonLexModelsV2
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.public DeleteBotResult deleteBot(DeleteBotRequest request)
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
.
deleteBot
in interface AmazonLexModelsV2
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.public DeleteBotAliasResult deleteBotAlias(DeleteBotAliasRequest request)
Deletes the specified bot alias.
deleteBotAlias
in interface AmazonLexModelsV2
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.public DeleteBotLocaleResult deleteBotLocale(DeleteBotLocaleRequest request)
Removes a locale from a bot.
When you delete a locale, all intents, slots, and slot types defined for the locale are also deleted.
deleteBotLocale
in interface AmazonLexModelsV2
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.public DeleteBotReplicaResult deleteBotReplica(DeleteBotReplicaRequest request)
The action to delete the replicated bot in the secondary region.
deleteBotReplica
in interface AmazonLexModelsV2
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.public DeleteBotVersionResult deleteBotVersion(DeleteBotVersionRequest request)
Deletes a specific version of a bot. To delete all versions of a bot, use the DeleteBot operation.
deleteBotVersion
in interface AmazonLexModelsV2
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.public DeleteCustomVocabularyResult deleteCustomVocabulary(DeleteCustomVocabularyRequest request)
Removes a custom vocabulary from the specified locale in the specified bot.
deleteCustomVocabulary
in interface AmazonLexModelsV2
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.public DeleteExportResult deleteExport(DeleteExportRequest request)
Removes a previous export and the associated files stored in an S3 bucket.
deleteExport
in interface AmazonLexModelsV2
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.public DeleteImportResult deleteImport(DeleteImportRequest request)
Removes a previous import and the associated file stored in an S3 bucket.
deleteImport
in interface AmazonLexModelsV2
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.public DeleteIntentResult deleteIntent(DeleteIntentRequest request)
Removes the specified intent.
Deleting an intent also deletes the slots associated with the intent.
deleteIntent
in interface AmazonLexModelsV2
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.public DeleteResourcePolicyResult deleteResourcePolicy(DeleteResourcePolicyRequest request)
Removes an existing policy from a bot or bot alias. If the resource doesn't have a policy attached, Amazon Lex returns an exception.
deleteResourcePolicy
in interface AmazonLexModelsV2
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.public DeleteResourcePolicyStatementResult deleteResourcePolicyStatement(DeleteResourcePolicyStatementRequest request)
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.
deleteResourcePolicyStatement
in interface AmazonLexModelsV2
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.public DeleteSlotResult deleteSlot(DeleteSlotRequest request)
Deletes the specified slot from an intent.
deleteSlot
in interface AmazonLexModelsV2
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.public DeleteSlotTypeResult deleteSlotType(DeleteSlotTypeRequest request)
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
.
deleteSlotType
in interface AmazonLexModelsV2
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.public DeleteTestSetResult deleteTestSet(DeleteTestSetRequest request)
The action to delete the selected test set.
deleteTestSet
in interface AmazonLexModelsV2
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.public DeleteUtterancesResult deleteUtterances(DeleteUtterancesRequest request)
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.
deleteUtterances
in interface AmazonLexModelsV2
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.public DescribeBotResult describeBot(DescribeBotRequest request)
Provides metadata information about a bot.
describeBot
in interface AmazonLexModelsV2
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.public DescribeBotAliasResult describeBotAlias(DescribeBotAliasRequest request)
Get information about a specific bot alias.
describeBotAlias
in interface AmazonLexModelsV2
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.public DescribeBotLocaleResult describeBotLocale(DescribeBotLocaleRequest request)
Describes the settings that a bot has for a specific locale.
describeBotLocale
in interface AmazonLexModelsV2
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.public DescribeBotRecommendationResult describeBotRecommendation(DescribeBotRecommendationRequest request)
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.
describeBotRecommendation
in interface AmazonLexModelsV2
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.public DescribeBotReplicaResult describeBotReplica(DescribeBotReplicaRequest request)
Monitors the bot replication status through the UI console.
describeBotReplica
in interface AmazonLexModelsV2
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.public DescribeBotResourceGenerationResult describeBotResourceGeneration(DescribeBotResourceGenerationRequest request)
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.
describeBotResourceGeneration
in interface AmazonLexModelsV2
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.public DescribeBotVersionResult describeBotVersion(DescribeBotVersionRequest request)
Provides metadata about a version of a bot.
describeBotVersion
in interface AmazonLexModelsV2
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.public DescribeCustomVocabularyMetadataResult describeCustomVocabularyMetadata(DescribeCustomVocabularyMetadataRequest request)
Provides metadata information about a custom vocabulary.
describeCustomVocabularyMetadata
in interface AmazonLexModelsV2
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.public DescribeExportResult describeExport(DescribeExportRequest request)
Gets information about a specific export.
describeExport
in interface AmazonLexModelsV2
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.public DescribeImportResult describeImport(DescribeImportRequest request)
Gets information about a specific import.
describeImport
in interface AmazonLexModelsV2
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.public DescribeIntentResult describeIntent(DescribeIntentRequest request)
Returns metadata about an intent.
describeIntent
in interface AmazonLexModelsV2
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.public DescribeResourcePolicyResult describeResourcePolicy(DescribeResourcePolicyRequest request)
Gets the resource policy and policy revision for a bot or bot alias.
describeResourcePolicy
in interface AmazonLexModelsV2
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.public DescribeSlotResult describeSlot(DescribeSlotRequest request)
Gets metadata information about a slot.
describeSlot
in interface AmazonLexModelsV2
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.public DescribeSlotTypeResult describeSlotType(DescribeSlotTypeRequest request)
Gets metadata information about a slot type.
describeSlotType
in interface AmazonLexModelsV2
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.public DescribeTestExecutionResult describeTestExecution(DescribeTestExecutionRequest request)
Gets metadata information about the test execution.
describeTestExecution
in interface AmazonLexModelsV2
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.public DescribeTestSetResult describeTestSet(DescribeTestSetRequest request)
Gets metadata information about the test set.
describeTestSet
in interface AmazonLexModelsV2
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.public DescribeTestSetDiscrepancyReportResult describeTestSetDiscrepancyReport(DescribeTestSetDiscrepancyReportRequest request)
Gets metadata information about the test set discrepancy report.
describeTestSetDiscrepancyReport
in interface AmazonLexModelsV2
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.public DescribeTestSetGenerationResult describeTestSetGeneration(DescribeTestSetGenerationRequest request)
Gets metadata information about the test set generation.
describeTestSetGeneration
in interface AmazonLexModelsV2
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.public GenerateBotElementResult generateBotElement(GenerateBotElementRequest request)
Generates sample utterances for an intent.
generateBotElement
in interface AmazonLexModelsV2
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.public GetTestExecutionArtifactsUrlResult getTestExecutionArtifactsUrl(GetTestExecutionArtifactsUrlRequest request)
The pre-signed Amazon S3 URL to download the test execution result artifacts.
getTestExecutionArtifactsUrl
in interface AmazonLexModelsV2
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.public ListAggregatedUtterancesResult listAggregatedUtterances(ListAggregatedUtterancesRequest request)
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.
listAggregatedUtterances
in interface AmazonLexModelsV2
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.public ListBotAliasReplicasResult listBotAliasReplicas(ListBotAliasReplicasRequest request)
The action to list the replicated bots created from the source bot alias.
listBotAliasReplicas
in interface AmazonLexModelsV2
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.public ListBotAliasesResult listBotAliases(ListBotAliasesRequest request)
Gets a list of aliases for the specified bot.
listBotAliases
in interface AmazonLexModelsV2
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.public ListBotLocalesResult listBotLocales(ListBotLocalesRequest request)
Gets a list of locales for the specified bot.
listBotLocales
in interface AmazonLexModelsV2
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.public ListBotRecommendationsResult listBotRecommendations(ListBotRecommendationsRequest request)
Get a list of bot recommendations that meet the specified criteria.
listBotRecommendations
in interface AmazonLexModelsV2
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.public ListBotReplicasResult listBotReplicas(ListBotReplicasRequest request)
The action to list the replicated bots.
listBotReplicas
in interface AmazonLexModelsV2
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.public ListBotResourceGenerationsResult listBotResourceGenerations(ListBotResourceGenerationsRequest request)
Lists the generation requests made for a bot locale.
listBotResourceGenerations
in interface AmazonLexModelsV2
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.public ListBotVersionReplicasResult listBotVersionReplicas(ListBotVersionReplicasRequest request)
Contains information about all the versions replication statuses applicable for Global Resiliency.
listBotVersionReplicas
in interface AmazonLexModelsV2
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.public ListBotVersionsResult listBotVersions(ListBotVersionsRequest request)
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.
listBotVersions
in interface AmazonLexModelsV2
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.public ListBotsResult listBots(ListBotsRequest request)
Gets a list of available bots.
listBots
in interface AmazonLexModelsV2
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.public ListBuiltInIntentsResult listBuiltInIntents(ListBuiltInIntentsRequest request)
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.
listBuiltInIntents
in interface AmazonLexModelsV2
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.public ListBuiltInSlotTypesResult listBuiltInSlotTypes(ListBuiltInSlotTypesRequest request)
Gets a list of built-in slot types that meet the specified criteria.
listBuiltInSlotTypes
in interface AmazonLexModelsV2
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.public ListCustomVocabularyItemsResult listCustomVocabularyItems(ListCustomVocabularyItemsRequest request)
Paginated list of custom vocabulary items for a given bot locale's custom vocabulary.
listCustomVocabularyItems
in interface AmazonLexModelsV2
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.public ListExportsResult listExports(ListExportsRequest request)
Lists the exports for a bot, bot locale, or custom vocabulary. Exports are kept in the list for 7 days.
listExports
in interface AmazonLexModelsV2
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.public ListImportsResult listImports(ListImportsRequest request)
Lists the imports for a bot, bot locale, or custom vocabulary. Imports are kept in the list for 7 days.
listImports
in interface AmazonLexModelsV2
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.public ListIntentMetricsResult listIntentMetrics(ListIntentMetricsRequest request)
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.
listIntentMetrics
in interface AmazonLexModelsV2
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.public ListIntentPathsResult listIntentPaths(ListIntentPathsRequest request)
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.
listIntentPaths
in interface AmazonLexModelsV2
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.public ListIntentStageMetricsResult listIntentStageMetrics(ListIntentStageMetricsRequest request)
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.
listIntentStageMetrics
in interface AmazonLexModelsV2
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.public ListIntentsResult listIntents(ListIntentsRequest request)
Get a list of intents that meet the specified criteria.
listIntents
in interface AmazonLexModelsV2
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.public ListRecommendedIntentsResult listRecommendedIntents(ListRecommendedIntentsRequest request)
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.
listRecommendedIntents
in interface AmazonLexModelsV2
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.public ListSessionAnalyticsDataResult listSessionAnalyticsData(ListSessionAnalyticsDataRequest request)
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.
listSessionAnalyticsData
in interface AmazonLexModelsV2
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.public ListSessionMetricsResult listSessionMetrics(ListSessionMetricsRequest request)
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.
listSessionMetrics
in interface AmazonLexModelsV2
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.public ListSlotTypesResult listSlotTypes(ListSlotTypesRequest request)
Gets a list of slot types that match the specified criteria.
listSlotTypes
in interface AmazonLexModelsV2
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.public ListSlotsResult listSlots(ListSlotsRequest request)
Gets a list of slots that match the specified criteria.
listSlots
in interface AmazonLexModelsV2
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.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Gets a list of tags associated with a resource. Only bots, bot aliases, and bot channels can have tags associated with them.
listTagsForResource
in interface AmazonLexModelsV2
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.public ListTestExecutionResultItemsResult listTestExecutionResultItems(ListTestExecutionResultItemsRequest request)
Gets a list of test execution result items.
listTestExecutionResultItems
in interface AmazonLexModelsV2
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.public ListTestExecutionsResult listTestExecutions(ListTestExecutionsRequest request)
The list of test set executions.
listTestExecutions
in interface AmazonLexModelsV2
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.public ListTestSetRecordsResult listTestSetRecords(ListTestSetRecordsRequest request)
The list of test set records.
listTestSetRecords
in interface AmazonLexModelsV2
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.public ListTestSetsResult listTestSets(ListTestSetsRequest request)
The list of the test sets
listTestSets
in interface AmazonLexModelsV2
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.public ListUtteranceAnalyticsDataResult listUtteranceAnalyticsData(ListUtteranceAnalyticsDataRequest request)
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.
listUtteranceAnalyticsData
in interface AmazonLexModelsV2
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.public ListUtteranceMetricsResult listUtteranceMetrics(ListUtteranceMetricsRequest request)
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.
listUtteranceMetrics
in interface AmazonLexModelsV2
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.public SearchAssociatedTranscriptsResult searchAssociatedTranscripts(SearchAssociatedTranscriptsRequest request)
Search for associated transcripts that meet the specified criteria.
searchAssociatedTranscripts
in interface AmazonLexModelsV2
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.public StartBotRecommendationResult startBotRecommendation(StartBotRecommendationRequest request)
Use this to provide your transcript data, and to start the bot recommendation process.
startBotRecommendation
in interface AmazonLexModelsV2
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.public StartBotResourceGenerationResult startBotResourceGeneration(StartBotResourceGenerationRequest request)
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.
startBotResourceGeneration
in interface AmazonLexModelsV2
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.public StartImportResult startImport(StartImportRequest request)
Starts importing a bot, bot locale, or custom vocabulary from a zip archive that you uploaded to an S3 bucket.
startImport
in interface AmazonLexModelsV2
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.public StartTestExecutionResult startTestExecution(StartTestExecutionRequest request)
The action to start test set execution.
startTestExecution
in interface AmazonLexModelsV2
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.public StartTestSetGenerationResult startTestSetGeneration(StartTestSetGenerationRequest request)
The action to start the generation of test set.
startTestSetGeneration
in interface AmazonLexModelsV2
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.public StopBotRecommendationResult stopBotRecommendation(StopBotRecommendationRequest request)
Stop an already running Bot Recommendation request.
stopBotRecommendation
in interface AmazonLexModelsV2
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.public TagResourceResult tagResource(TagResourceRequest request)
Adds the specified tags to the specified resource. If a tag key already exists, the existing value is replaced with the new value.
tagResource
in interface AmazonLexModelsV2
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.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes tags from a bot, bot alias, or bot channel.
untagResource
in interface AmazonLexModelsV2
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.public UpdateBotResult updateBot(UpdateBotRequest request)
Updates the configuration of an existing bot.
updateBot
in interface AmazonLexModelsV2
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.public UpdateBotAliasResult updateBotAlias(UpdateBotAliasRequest request)
Updates the configuration of an existing bot alias.
updateBotAlias
in interface AmazonLexModelsV2
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.public UpdateBotLocaleResult updateBotLocale(UpdateBotLocaleRequest request)
Updates the settings that a bot has for a specific locale.
updateBotLocale
in interface AmazonLexModelsV2
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.public UpdateBotRecommendationResult updateBotRecommendation(UpdateBotRecommendationRequest request)
Updates an existing bot recommendation request.
updateBotRecommendation
in interface AmazonLexModelsV2
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.public UpdateExportResult updateExport(UpdateExportRequest request)
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.
updateExport
in interface AmazonLexModelsV2
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.public UpdateIntentResult updateIntent(UpdateIntentRequest request)
Updates the settings for an intent.
updateIntent
in interface AmazonLexModelsV2
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.public UpdateResourcePolicyResult updateResourcePolicy(UpdateResourcePolicyRequest request)
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.
updateResourcePolicy
in interface AmazonLexModelsV2
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.public UpdateSlotResult updateSlot(UpdateSlotRequest request)
Updates the settings for a slot.
updateSlot
in interface AmazonLexModelsV2
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.public UpdateSlotTypeResult updateSlotType(UpdateSlotTypeRequest request)
Updates the configuration of an existing slot type.
updateSlotType
in interface AmazonLexModelsV2
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.public UpdateTestSetResult updateTestSet(UpdateTestSetRequest request)
The action to update the test set.
updateTestSet
in interface AmazonLexModelsV2
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.public 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 the request.
getCachedResponseMetadata
in interface AmazonLexModelsV2
request
- The originally executed requestpublic AmazonLexModelsV2Waiters waiters()
waiters
in interface AmazonLexModelsV2
public void shutdown()
AmazonWebServiceClient
shutdown
in interface AmazonLexModelsV2
shutdown
in class AmazonWebServiceClient