Interface LexModelBuildingAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any
SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may
perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API
call.
Amazon Lex is an AWS service for building conversational voice and text interfaces. Use these actions to create, update, and delete conversational bots for new and existing client applications.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Create a builder that can be used to configure and create aLexModelBuildingAsyncClient
.static LexModelBuildingAsyncClient
create()
Create aLexModelBuildingAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createBotVersion
(Consumer<CreateBotVersionRequest.Builder> createBotVersionRequest) Creates a new version of the bot based on theinvalid input: '$'LATEST
version.createBotVersion
(CreateBotVersionRequest createBotVersionRequest) Creates a new version of the bot based on theinvalid input: '$'LATEST
version.createIntentVersion
(Consumer<CreateIntentVersionRequest.Builder> createIntentVersionRequest) Creates a new version of an intent based on theinvalid input: '$'LATEST
version of the intent.createIntentVersion
(CreateIntentVersionRequest createIntentVersionRequest) Creates a new version of an intent based on theinvalid input: '$'LATEST
version of the intent.createSlotTypeVersion
(Consumer<CreateSlotTypeVersionRequest.Builder> createSlotTypeVersionRequest) Creates a new version of a slot type based on theinvalid input: '$'LATEST
version of the specified slot type.createSlotTypeVersion
(CreateSlotTypeVersionRequest createSlotTypeVersionRequest) Creates a new version of a slot type based on theinvalid input: '$'LATEST
version of the specified slot type.default CompletableFuture
<DeleteBotResponse> deleteBot
(Consumer<DeleteBotRequest.Builder> deleteBotRequest) Deletes all versions of the bot, including theinvalid input: '$'LATEST
version.default CompletableFuture
<DeleteBotResponse> deleteBot
(DeleteBotRequest deleteBotRequest) Deletes all versions of the bot, including theinvalid input: '$'LATEST
version.default CompletableFuture
<DeleteBotAliasResponse> deleteBotAlias
(Consumer<DeleteBotAliasRequest.Builder> deleteBotAliasRequest) Deletes an alias for the specified bot.default CompletableFuture
<DeleteBotAliasResponse> deleteBotAlias
(DeleteBotAliasRequest deleteBotAliasRequest) Deletes an alias for the specified bot.deleteBotChannelAssociation
(Consumer<DeleteBotChannelAssociationRequest.Builder> deleteBotChannelAssociationRequest) Deletes the association between an Amazon Lex bot and a messaging platform.deleteBotChannelAssociation
(DeleteBotChannelAssociationRequest deleteBotChannelAssociationRequest) Deletes the association between an Amazon Lex bot and a messaging platform.deleteBotVersion
(Consumer<DeleteBotVersionRequest.Builder> deleteBotVersionRequest) Deletes a specific version of a bot.deleteBotVersion
(DeleteBotVersionRequest deleteBotVersionRequest) Deletes a specific version of a bot.default CompletableFuture
<DeleteIntentResponse> deleteIntent
(Consumer<DeleteIntentRequest.Builder> deleteIntentRequest) Deletes all versions of the intent, including theinvalid input: '$'LATEST
version.default CompletableFuture
<DeleteIntentResponse> deleteIntent
(DeleteIntentRequest deleteIntentRequest) Deletes all versions of the intent, including theinvalid input: '$'LATEST
version.deleteIntentVersion
(Consumer<DeleteIntentVersionRequest.Builder> deleteIntentVersionRequest) Deletes a specific version of an intent.deleteIntentVersion
(DeleteIntentVersionRequest deleteIntentVersionRequest) Deletes a specific version of an intent.default CompletableFuture
<DeleteSlotTypeResponse> deleteSlotType
(Consumer<DeleteSlotTypeRequest.Builder> deleteSlotTypeRequest) Deletes all versions of the slot type, including theinvalid input: '$'LATEST
version.default CompletableFuture
<DeleteSlotTypeResponse> deleteSlotType
(DeleteSlotTypeRequest deleteSlotTypeRequest) Deletes all versions of the slot type, including theinvalid input: '$'LATEST
version.deleteSlotTypeVersion
(Consumer<DeleteSlotTypeVersionRequest.Builder> deleteSlotTypeVersionRequest) Deletes a specific version of a slot type.deleteSlotTypeVersion
(DeleteSlotTypeVersionRequest deleteSlotTypeVersionRequest) Deletes a specific version of a slot type.deleteUtterances
(Consumer<DeleteUtterancesRequest.Builder> deleteUtterancesRequest) Deletes stored utterances.deleteUtterances
(DeleteUtterancesRequest deleteUtterancesRequest) Deletes stored utterances.default CompletableFuture
<GetBotResponse> getBot
(Consumer<GetBotRequest.Builder> getBotRequest) Returns metadata information for a specific bot.default CompletableFuture
<GetBotResponse> getBot
(GetBotRequest getBotRequest) Returns metadata information for a specific bot.default CompletableFuture
<GetBotAliasResponse> getBotAlias
(Consumer<GetBotAliasRequest.Builder> getBotAliasRequest) Returns information about an Amazon Lex bot alias.default CompletableFuture
<GetBotAliasResponse> getBotAlias
(GetBotAliasRequest getBotAliasRequest) Returns information about an Amazon Lex bot alias.default CompletableFuture
<GetBotAliasesResponse> getBotAliases
(Consumer<GetBotAliasesRequest.Builder> getBotAliasesRequest) Returns a list of aliases for a specified Amazon Lex bot.default CompletableFuture
<GetBotAliasesResponse> getBotAliases
(GetBotAliasesRequest getBotAliasesRequest) Returns a list of aliases for a specified Amazon Lex bot.default GetBotAliasesPublisher
getBotAliasesPaginator
(Consumer<GetBotAliasesRequest.Builder> getBotAliasesRequest) This is a variant ofgetBotAliases(software.amazon.awssdk.services.lexmodelbuilding.model.GetBotAliasesRequest)
operation.default GetBotAliasesPublisher
getBotAliasesPaginator
(GetBotAliasesRequest getBotAliasesRequest) This is a variant ofgetBotAliases(software.amazon.awssdk.services.lexmodelbuilding.model.GetBotAliasesRequest)
operation.getBotChannelAssociation
(Consumer<GetBotChannelAssociationRequest.Builder> getBotChannelAssociationRequest) Returns information about the association between an Amazon Lex bot and a messaging platform.getBotChannelAssociation
(GetBotChannelAssociationRequest getBotChannelAssociationRequest) Returns information about the association between an Amazon Lex bot and a messaging platform.getBotChannelAssociations
(Consumer<GetBotChannelAssociationsRequest.Builder> getBotChannelAssociationsRequest) Returns a list of all of the channels associated with the specified bot.getBotChannelAssociations
(GetBotChannelAssociationsRequest getBotChannelAssociationsRequest) Returns a list of all of the channels associated with the specified bot.getBotChannelAssociationsPaginator
(Consumer<GetBotChannelAssociationsRequest.Builder> getBotChannelAssociationsRequest) This is a variant ofgetBotChannelAssociations(software.amazon.awssdk.services.lexmodelbuilding.model.GetBotChannelAssociationsRequest)
operation.getBotChannelAssociationsPaginator
(GetBotChannelAssociationsRequest getBotChannelAssociationsRequest) This is a variant ofgetBotChannelAssociations(software.amazon.awssdk.services.lexmodelbuilding.model.GetBotChannelAssociationsRequest)
operation.default CompletableFuture
<GetBotsResponse> getBots()
Returns bot information as follows:default CompletableFuture
<GetBotsResponse> getBots
(Consumer<GetBotsRequest.Builder> getBotsRequest) Returns bot information as follows:default CompletableFuture
<GetBotsResponse> getBots
(GetBotsRequest getBotsRequest) Returns bot information as follows:default GetBotsPublisher
This is a variant ofgetBots(software.amazon.awssdk.services.lexmodelbuilding.model.GetBotsRequest)
operation.default GetBotsPublisher
getBotsPaginator
(Consumer<GetBotsRequest.Builder> getBotsRequest) This is a variant ofgetBots(software.amazon.awssdk.services.lexmodelbuilding.model.GetBotsRequest)
operation.default GetBotsPublisher
getBotsPaginator
(GetBotsRequest getBotsRequest) This is a variant ofgetBots(software.amazon.awssdk.services.lexmodelbuilding.model.GetBotsRequest)
operation.default CompletableFuture
<GetBotVersionsResponse> getBotVersions
(Consumer<GetBotVersionsRequest.Builder> getBotVersionsRequest) Gets information about all of the versions of a bot.default CompletableFuture
<GetBotVersionsResponse> getBotVersions
(GetBotVersionsRequest getBotVersionsRequest) Gets information about all of the versions of a bot.default GetBotVersionsPublisher
getBotVersionsPaginator
(Consumer<GetBotVersionsRequest.Builder> getBotVersionsRequest) This is a variant ofgetBotVersions(software.amazon.awssdk.services.lexmodelbuilding.model.GetBotVersionsRequest)
operation.default GetBotVersionsPublisher
getBotVersionsPaginator
(GetBotVersionsRequest getBotVersionsRequest) This is a variant ofgetBotVersions(software.amazon.awssdk.services.lexmodelbuilding.model.GetBotVersionsRequest)
operation.getBuiltinIntent
(Consumer<GetBuiltinIntentRequest.Builder> getBuiltinIntentRequest) Returns information about a built-in intent.getBuiltinIntent
(GetBuiltinIntentRequest getBuiltinIntentRequest) Returns information about a built-in intent.Gets a list of built-in intents that meet the specified criteria.getBuiltinIntents
(Consumer<GetBuiltinIntentsRequest.Builder> getBuiltinIntentsRequest) Gets a list of built-in intents that meet the specified criteria.getBuiltinIntents
(GetBuiltinIntentsRequest getBuiltinIntentsRequest) Gets a list of built-in intents that meet the specified criteria.default GetBuiltinIntentsPublisher
This is a variant ofgetBuiltinIntents(software.amazon.awssdk.services.lexmodelbuilding.model.GetBuiltinIntentsRequest)
operation.default GetBuiltinIntentsPublisher
getBuiltinIntentsPaginator
(Consumer<GetBuiltinIntentsRequest.Builder> getBuiltinIntentsRequest) This is a variant ofgetBuiltinIntents(software.amazon.awssdk.services.lexmodelbuilding.model.GetBuiltinIntentsRequest)
operation.default GetBuiltinIntentsPublisher
getBuiltinIntentsPaginator
(GetBuiltinIntentsRequest getBuiltinIntentsRequest) This is a variant ofgetBuiltinIntents(software.amazon.awssdk.services.lexmodelbuilding.model.GetBuiltinIntentsRequest)
operation.Gets a list of built-in slot types that meet the specified criteria.getBuiltinSlotTypes
(Consumer<GetBuiltinSlotTypesRequest.Builder> getBuiltinSlotTypesRequest) Gets a list of built-in slot types that meet the specified criteria.getBuiltinSlotTypes
(GetBuiltinSlotTypesRequest getBuiltinSlotTypesRequest) Gets a list of built-in slot types that meet the specified criteria.default GetBuiltinSlotTypesPublisher
This is a variant ofgetBuiltinSlotTypes(software.amazon.awssdk.services.lexmodelbuilding.model.GetBuiltinSlotTypesRequest)
operation.default GetBuiltinSlotTypesPublisher
getBuiltinSlotTypesPaginator
(Consumer<GetBuiltinSlotTypesRequest.Builder> getBuiltinSlotTypesRequest) This is a variant ofgetBuiltinSlotTypes(software.amazon.awssdk.services.lexmodelbuilding.model.GetBuiltinSlotTypesRequest)
operation.default GetBuiltinSlotTypesPublisher
getBuiltinSlotTypesPaginator
(GetBuiltinSlotTypesRequest getBuiltinSlotTypesRequest) This is a variant ofgetBuiltinSlotTypes(software.amazon.awssdk.services.lexmodelbuilding.model.GetBuiltinSlotTypesRequest)
operation.default CompletableFuture
<GetExportResponse> getExport
(Consumer<GetExportRequest.Builder> getExportRequest) Exports the contents of a Amazon Lex resource in a specified format.default CompletableFuture
<GetExportResponse> getExport
(GetExportRequest getExportRequest) Exports the contents of a Amazon Lex resource in a specified format.default CompletableFuture
<GetImportResponse> getImport
(Consumer<GetImportRequest.Builder> getImportRequest) Gets information about an import job started with theStartImport
operation.default CompletableFuture
<GetImportResponse> getImport
(GetImportRequest getImportRequest) Gets information about an import job started with theStartImport
operation.default CompletableFuture
<GetIntentResponse> getIntent
(Consumer<GetIntentRequest.Builder> getIntentRequest) Returns information about an intent.default CompletableFuture
<GetIntentResponse> getIntent
(GetIntentRequest getIntentRequest) Returns information about an intent.default CompletableFuture
<GetIntentsResponse> Returns intent information as follows:default CompletableFuture
<GetIntentsResponse> getIntents
(Consumer<GetIntentsRequest.Builder> getIntentsRequest) Returns intent information as follows:default CompletableFuture
<GetIntentsResponse> getIntents
(GetIntentsRequest getIntentsRequest) Returns intent information as follows:default GetIntentsPublisher
This is a variant ofgetIntents(software.amazon.awssdk.services.lexmodelbuilding.model.GetIntentsRequest)
operation.default GetIntentsPublisher
getIntentsPaginator
(Consumer<GetIntentsRequest.Builder> getIntentsRequest) This is a variant ofgetIntents(software.amazon.awssdk.services.lexmodelbuilding.model.GetIntentsRequest)
operation.default GetIntentsPublisher
getIntentsPaginator
(GetIntentsRequest getIntentsRequest) This is a variant ofgetIntents(software.amazon.awssdk.services.lexmodelbuilding.model.GetIntentsRequest)
operation.getIntentVersions
(Consumer<GetIntentVersionsRequest.Builder> getIntentVersionsRequest) Gets information about all of the versions of an intent.getIntentVersions
(GetIntentVersionsRequest getIntentVersionsRequest) Gets information about all of the versions of an intent.default GetIntentVersionsPublisher
getIntentVersionsPaginator
(Consumer<GetIntentVersionsRequest.Builder> getIntentVersionsRequest) This is a variant ofgetIntentVersions(software.amazon.awssdk.services.lexmodelbuilding.model.GetIntentVersionsRequest)
operation.default GetIntentVersionsPublisher
getIntentVersionsPaginator
(GetIntentVersionsRequest getIntentVersionsRequest) This is a variant ofgetIntentVersions(software.amazon.awssdk.services.lexmodelbuilding.model.GetIntentVersionsRequest)
operation.default CompletableFuture
<GetMigrationResponse> getMigration
(Consumer<GetMigrationRequest.Builder> getMigrationRequest) Provides details about an ongoing or complete migration from an Amazon Lex V1 bot to an Amazon Lex V2 bot.default CompletableFuture
<GetMigrationResponse> getMigration
(GetMigrationRequest getMigrationRequest) Provides details about an ongoing or complete migration from an Amazon Lex V1 bot to an Amazon Lex V2 bot.default CompletableFuture
<GetMigrationsResponse> getMigrations
(Consumer<GetMigrationsRequest.Builder> getMigrationsRequest) Gets a list of migrations between Amazon Lex V1 and Amazon Lex V2.default CompletableFuture
<GetMigrationsResponse> getMigrations
(GetMigrationsRequest getMigrationsRequest) Gets a list of migrations between Amazon Lex V1 and Amazon Lex V2.default GetMigrationsPublisher
getMigrationsPaginator
(Consumer<GetMigrationsRequest.Builder> getMigrationsRequest) This is a variant ofgetMigrations(software.amazon.awssdk.services.lexmodelbuilding.model.GetMigrationsRequest)
operation.default GetMigrationsPublisher
getMigrationsPaginator
(GetMigrationsRequest getMigrationsRequest) This is a variant ofgetMigrations(software.amazon.awssdk.services.lexmodelbuilding.model.GetMigrationsRequest)
operation.default CompletableFuture
<GetSlotTypeResponse> getSlotType
(Consumer<GetSlotTypeRequest.Builder> getSlotTypeRequest) Returns information about a specific version of a slot type.default CompletableFuture
<GetSlotTypeResponse> getSlotType
(GetSlotTypeRequest getSlotTypeRequest) Returns information about a specific version of a slot type.default CompletableFuture
<GetSlotTypesResponse> Returns slot type information as follows:default CompletableFuture
<GetSlotTypesResponse> getSlotTypes
(Consumer<GetSlotTypesRequest.Builder> getSlotTypesRequest) Returns slot type information as follows:default CompletableFuture
<GetSlotTypesResponse> getSlotTypes
(GetSlotTypesRequest getSlotTypesRequest) Returns slot type information as follows:default GetSlotTypesPublisher
This is a variant ofgetSlotTypes(software.amazon.awssdk.services.lexmodelbuilding.model.GetSlotTypesRequest)
operation.default GetSlotTypesPublisher
getSlotTypesPaginator
(Consumer<GetSlotTypesRequest.Builder> getSlotTypesRequest) This is a variant ofgetSlotTypes(software.amazon.awssdk.services.lexmodelbuilding.model.GetSlotTypesRequest)
operation.default GetSlotTypesPublisher
getSlotTypesPaginator
(GetSlotTypesRequest getSlotTypesRequest) This is a variant ofgetSlotTypes(software.amazon.awssdk.services.lexmodelbuilding.model.GetSlotTypesRequest)
operation.getSlotTypeVersions
(Consumer<GetSlotTypeVersionsRequest.Builder> getSlotTypeVersionsRequest) Gets information about all versions of a slot type.getSlotTypeVersions
(GetSlotTypeVersionsRequest getSlotTypeVersionsRequest) Gets information about all versions of a slot type.default GetSlotTypeVersionsPublisher
getSlotTypeVersionsPaginator
(Consumer<GetSlotTypeVersionsRequest.Builder> getSlotTypeVersionsRequest) This is a variant ofgetSlotTypeVersions(software.amazon.awssdk.services.lexmodelbuilding.model.GetSlotTypeVersionsRequest)
operation.default GetSlotTypeVersionsPublisher
getSlotTypeVersionsPaginator
(GetSlotTypeVersionsRequest getSlotTypeVersionsRequest) This is a variant ofgetSlotTypeVersions(software.amazon.awssdk.services.lexmodelbuilding.model.GetSlotTypeVersionsRequest)
operation.getUtterancesView
(Consumer<GetUtterancesViewRequest.Builder> getUtterancesViewRequest) Use theGetUtterancesView
operation to get information about the utterances that your users have made to your bot.getUtterancesView
(GetUtterancesViewRequest getUtterancesViewRequest) Use theGetUtterancesView
operation to get information about the utterances that your users have made to your bot.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Gets a list of tags associated with the specified resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Gets a list of tags associated with the specified resource.default CompletableFuture
<PutBotResponse> putBot
(Consumer<PutBotRequest.Builder> putBotRequest) Creates an Amazon Lex conversational bot or replaces an existing bot.default CompletableFuture
<PutBotResponse> putBot
(PutBotRequest putBotRequest) Creates an Amazon Lex conversational bot or replaces an existing bot.default CompletableFuture
<PutBotAliasResponse> putBotAlias
(Consumer<PutBotAliasRequest.Builder> putBotAliasRequest) Creates an alias for the specified version of the bot or replaces an alias for the specified bot.default CompletableFuture
<PutBotAliasResponse> putBotAlias
(PutBotAliasRequest putBotAliasRequest) Creates an alias for the specified version of the bot or replaces an alias for the specified bot.default CompletableFuture
<PutIntentResponse> putIntent
(Consumer<PutIntentRequest.Builder> putIntentRequest) Creates an intent or replaces an existing intent.default CompletableFuture
<PutIntentResponse> putIntent
(PutIntentRequest putIntentRequest) Creates an intent or replaces an existing intent.default CompletableFuture
<PutSlotTypeResponse> putSlotType
(Consumer<PutSlotTypeRequest.Builder> putSlotTypeRequest) Creates a custom slot type or replaces an existing custom slot type.default CompletableFuture
<PutSlotTypeResponse> putSlotType
(PutSlotTypeRequest putSlotTypeRequest) Creates a custom slot type or replaces an existing custom slot type.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture
<StartImportResponse> startImport
(Consumer<StartImportRequest.Builder> startImportRequest) Starts a job to import a resource to Amazon Lex.default CompletableFuture
<StartImportResponse> startImport
(StartImportRequest startImportRequest) Starts a job to import a resource to Amazon Lex.default CompletableFuture
<StartMigrationResponse> startMigration
(Consumer<StartMigrationRequest.Builder> startMigrationRequest) Starts migrating a bot from Amazon Lex V1 to Amazon Lex V2.default CompletableFuture
<StartMigrationResponse> startMigration
(StartMigrationRequest startMigrationRequest) Starts migrating a bot from Amazon Lex V1 to Amazon Lex V2.default CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds the specified tags to the specified resource.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Adds the specified tags to the specified resource.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes tags from a bot, bot alias or bot channel.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Removes tags from a bot, bot alias or bot channel.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
createBotVersion
default CompletableFuture<CreateBotVersionResponse> createBotVersion(CreateBotVersionRequest createBotVersionRequest) Creates a new version of the bot based on the
invalid input: '$'LATEST
version. If theinvalid input: '$'LATEST
version of this resource hasn't changed since you created the last version, Amazon Lex doesn't create a new version. It returns the last created version.You can update only the
invalid input: '$'LATEST
version of the bot. You can't update the numbered versions that you create with theCreateBotVersion
operation.When you create the first version of a bot, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see versioning-intro.
This operation requires permission for the
lex:CreateBotVersion
action.- Parameters:
createBotVersionRequest
-- Returns:
- A Java Future containing the result of the CreateBotVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- ConflictException There was a conflict processing the request. Try your request again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- PreconditionFailedException The checksum of the resource that you are trying to change does not match the checksum in the request. Check the resource's checksum and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createBotVersion
default CompletableFuture<CreateBotVersionResponse> createBotVersion(Consumer<CreateBotVersionRequest.Builder> createBotVersionRequest) Creates a new version of the bot based on the
invalid input: '$'LATEST
version. If theinvalid input: '$'LATEST
version of this resource hasn't changed since you created the last version, Amazon Lex doesn't create a new version. It returns the last created version.You can update only the
invalid input: '$'LATEST
version of the bot. You can't update the numbered versions that you create with theCreateBotVersion
operation.When you create the first version of a bot, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see versioning-intro.
This operation requires permission for the
lex:CreateBotVersion
action.
This is a convenience which creates an instance of the
CreateBotVersionRequest.Builder
avoiding the need to create one manually viaCreateBotVersionRequest.builder()
- Parameters:
createBotVersionRequest
- AConsumer
that will call methods onCreateBotVersionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateBotVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- ConflictException There was a conflict processing the request. Try your request again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- PreconditionFailedException The checksum of the resource that you are trying to change does not match the checksum in the request. Check the resource's checksum and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createIntentVersion
default CompletableFuture<CreateIntentVersionResponse> createIntentVersion(CreateIntentVersionRequest createIntentVersionRequest) Creates a new version of an intent based on the
invalid input: '$'LATEST
version of the intent. If theinvalid input: '$'LATEST
version of this intent hasn't changed since you last updated it, Amazon Lex doesn't create a new version. It returns the last version you created.You can update only the
invalid input: '$'LATEST
version of the intent. You can't update the numbered versions that you create with theCreateIntentVersion
operation.When you create a version of an intent, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see versioning-intro.
This operation requires permissions to perform the
lex:CreateIntentVersion
action.- Parameters:
createIntentVersionRequest
-- Returns:
- A Java Future containing the result of the CreateIntentVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- ConflictException There was a conflict processing the request. Try your request again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- PreconditionFailedException The checksum of the resource that you are trying to change does not match the checksum in the request. Check the resource's checksum and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createIntentVersion
default CompletableFuture<CreateIntentVersionResponse> createIntentVersion(Consumer<CreateIntentVersionRequest.Builder> createIntentVersionRequest) Creates a new version of an intent based on the
invalid input: '$'LATEST
version of the intent. If theinvalid input: '$'LATEST
version of this intent hasn't changed since you last updated it, Amazon Lex doesn't create a new version. It returns the last version you created.You can update only the
invalid input: '$'LATEST
version of the intent. You can't update the numbered versions that you create with theCreateIntentVersion
operation.When you create a version of an intent, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see versioning-intro.
This operation requires permissions to perform the
lex:CreateIntentVersion
action.
This is a convenience which creates an instance of the
CreateIntentVersionRequest.Builder
avoiding the need to create one manually viaCreateIntentVersionRequest.builder()
- Parameters:
createIntentVersionRequest
- AConsumer
that will call methods onCreateIntentVersionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateIntentVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- ConflictException There was a conflict processing the request. Try your request again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- PreconditionFailedException The checksum of the resource that you are trying to change does not match the checksum in the request. Check the resource's checksum and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createSlotTypeVersion
default CompletableFuture<CreateSlotTypeVersionResponse> createSlotTypeVersion(CreateSlotTypeVersionRequest createSlotTypeVersionRequest) Creates a new version of a slot type based on the
invalid input: '$'LATEST
version of the specified slot type. If theinvalid input: '$'LATEST
version of this resource has not changed since the last version that you created, Amazon Lex doesn't create a new version. It returns the last version that you created.You can update only the
invalid input: '$'LATEST
version of a slot type. You can't update the numbered versions that you create with theCreateSlotTypeVersion
operation.When you create a version of a slot type, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see versioning-intro.
This operation requires permissions for the
lex:CreateSlotTypeVersion
action.- Parameters:
createSlotTypeVersionRequest
-- Returns:
- A Java Future containing the result of the CreateSlotTypeVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- ConflictException There was a conflict processing the request. Try your request again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- PreconditionFailedException The checksum of the resource that you are trying to change does not match the checksum in the request. Check the resource's checksum and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createSlotTypeVersion
default CompletableFuture<CreateSlotTypeVersionResponse> createSlotTypeVersion(Consumer<CreateSlotTypeVersionRequest.Builder> createSlotTypeVersionRequest) Creates a new version of a slot type based on the
invalid input: '$'LATEST
version of the specified slot type. If theinvalid input: '$'LATEST
version of this resource has not changed since the last version that you created, Amazon Lex doesn't create a new version. It returns the last version that you created.You can update only the
invalid input: '$'LATEST
version of a slot type. You can't update the numbered versions that you create with theCreateSlotTypeVersion
operation.When you create a version of a slot type, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see versioning-intro.
This operation requires permissions for the
lex:CreateSlotTypeVersion
action.
This is a convenience which creates an instance of the
CreateSlotTypeVersionRequest.Builder
avoiding the need to create one manually viaCreateSlotTypeVersionRequest.builder()
- Parameters:
createSlotTypeVersionRequest
- AConsumer
that will call methods onCreateSlotTypeVersionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateSlotTypeVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- ConflictException There was a conflict processing the request. Try your request again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- PreconditionFailedException The checksum of the resource that you are trying to change does not match the checksum in the request. Check the resource's checksum and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteBot
Deletes all versions of the bot, including the
invalid input: '$'LATEST
version. To delete a specific version of the bot, use the DeleteBotVersion operation. TheDeleteBot
operation doesn't immediately remove the bot schema. Instead, it is marked for deletion and removed later.Amazon Lex stores utterances indefinitely for improving the ability of your bot to respond to user inputs. These utterances are not removed when the bot is deleted. To remove the utterances, use the DeleteUtterances operation.
If a bot has an alias, you can't delete it. Instead, the
DeleteBot
operation returns aResourceInUseException
exception that includes a reference to the alias that refers to the bot. To remove the reference to the bot, delete the alias. If you get the same exception again, delete the referring alias until theDeleteBot
operation is successful.This operation requires permissions for the
lex:DeleteBot
action.- Parameters:
deleteBotRequest
-- Returns:
- A Java Future containing the result of the DeleteBot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- ConflictException There was a conflict processing the request. Try your request again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- ResourceInUseException The resource that you are attempting to delete is referred to by another
resource. Use this information to remove references to the resource that you are trying to delete.
The body of the exception contains a JSON object that describes the resource.
{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,
"resourceReference": {
"name": string, "version": string } }
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteBot
default CompletableFuture<DeleteBotResponse> deleteBot(Consumer<DeleteBotRequest.Builder> deleteBotRequest) Deletes all versions of the bot, including the
invalid input: '$'LATEST
version. To delete a specific version of the bot, use the DeleteBotVersion operation. TheDeleteBot
operation doesn't immediately remove the bot schema. Instead, it is marked for deletion and removed later.Amazon Lex stores utterances indefinitely for improving the ability of your bot to respond to user inputs. These utterances are not removed when the bot is deleted. To remove the utterances, use the DeleteUtterances operation.
If a bot has an alias, you can't delete it. Instead, the
DeleteBot
operation returns aResourceInUseException
exception that includes a reference to the alias that refers to the bot. To remove the reference to the bot, delete the alias. If you get the same exception again, delete the referring alias until theDeleteBot
operation is successful.This operation requires permissions for the
lex:DeleteBot
action.
This is a convenience which creates an instance of the
DeleteBotRequest.Builder
avoiding the need to create one manually viaDeleteBotRequest.builder()
- Parameters:
deleteBotRequest
- AConsumer
that will call methods onDeleteBotRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteBot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- ConflictException There was a conflict processing the request. Try your request again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- ResourceInUseException The resource that you are attempting to delete is referred to by another
resource. Use this information to remove references to the resource that you are trying to delete.
The body of the exception contains a JSON object that describes the resource.
{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,
"resourceReference": {
"name": string, "version": string } }
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteBotAlias
default CompletableFuture<DeleteBotAliasResponse> deleteBotAlias(DeleteBotAliasRequest deleteBotAliasRequest) Deletes an alias for the specified bot.
You can't delete an alias that is used in the association between a bot and a messaging channel. If an alias is used in a channel association, the
DeleteBot
operation returns aResourceInUseException
exception that includes a reference to the channel association that refers to the bot. You can remove the reference to the alias by deleting the channel association. If you get the same exception again, delete the referring association until theDeleteBotAlias
operation is successful.- Parameters:
deleteBotAliasRequest
-- Returns:
- A Java Future containing the result of the DeleteBotAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- ConflictException There was a conflict processing the request. Try your request again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- ResourceInUseException The resource that you are attempting to delete is referred to by another
resource. Use this information to remove references to the resource that you are trying to delete.
The body of the exception contains a JSON object that describes the resource.
{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,
"resourceReference": {
"name": string, "version": string } }
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteBotAlias
default CompletableFuture<DeleteBotAliasResponse> deleteBotAlias(Consumer<DeleteBotAliasRequest.Builder> deleteBotAliasRequest) Deletes an alias for the specified bot.
You can't delete an alias that is used in the association between a bot and a messaging channel. If an alias is used in a channel association, the
DeleteBot
operation returns aResourceInUseException
exception that includes a reference to the channel association that refers to the bot. You can remove the reference to the alias by deleting the channel association. If you get the same exception again, delete the referring association until theDeleteBotAlias
operation is successful.
This is a convenience which creates an instance of the
DeleteBotAliasRequest.Builder
avoiding the need to create one manually viaDeleteBotAliasRequest.builder()
- Parameters:
deleteBotAliasRequest
- AConsumer
that will call methods onDeleteBotAliasRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteBotAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- ConflictException There was a conflict processing the request. Try your request again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- ResourceInUseException The resource that you are attempting to delete is referred to by another
resource. Use this information to remove references to the resource that you are trying to delete.
The body of the exception contains a JSON object that describes the resource.
{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,
"resourceReference": {
"name": string, "version": string } }
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteBotChannelAssociation
default CompletableFuture<DeleteBotChannelAssociationResponse> deleteBotChannelAssociation(DeleteBotChannelAssociationRequest deleteBotChannelAssociationRequest) Deletes the association between an Amazon Lex bot and a messaging platform.
This operation requires permission for the
lex:DeleteBotChannelAssociation
action.- Parameters:
deleteBotChannelAssociationRequest
-- Returns:
- A Java Future containing the result of the DeleteBotChannelAssociation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- ConflictException There was a conflict processing the request. Try your request again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteBotChannelAssociation
default CompletableFuture<DeleteBotChannelAssociationResponse> deleteBotChannelAssociation(Consumer<DeleteBotChannelAssociationRequest.Builder> deleteBotChannelAssociationRequest) Deletes the association between an Amazon Lex bot and a messaging platform.
This operation requires permission for the
lex:DeleteBotChannelAssociation
action.
This is a convenience which creates an instance of the
DeleteBotChannelAssociationRequest.Builder
avoiding the need to create one manually viaDeleteBotChannelAssociationRequest.builder()
- Parameters:
deleteBotChannelAssociationRequest
- AConsumer
that will call methods onDeleteBotChannelAssociationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteBotChannelAssociation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- ConflictException There was a conflict processing the request. Try your request again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteBotVersion
default CompletableFuture<DeleteBotVersionResponse> deleteBotVersion(DeleteBotVersionRequest deleteBotVersionRequest) Deletes a specific version of a bot. To delete all versions of a bot, use the DeleteBot operation.
This operation requires permissions for the
lex:DeleteBotVersion
action.- Parameters:
deleteBotVersionRequest
-- Returns:
- A Java Future containing the result of the DeleteBotVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- ConflictException There was a conflict processing the request. Try your request again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- ResourceInUseException The resource that you are attempting to delete is referred to by another
resource. Use this information to remove references to the resource that you are trying to delete.
The body of the exception contains a JSON object that describes the resource.
{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,
"resourceReference": {
"name": string, "version": string } }
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteBotVersion
default CompletableFuture<DeleteBotVersionResponse> deleteBotVersion(Consumer<DeleteBotVersionRequest.Builder> deleteBotVersionRequest) Deletes a specific version of a bot. To delete all versions of a bot, use the DeleteBot operation.
This operation requires permissions for the
lex:DeleteBotVersion
action.
This is a convenience which creates an instance of the
DeleteBotVersionRequest.Builder
avoiding the need to create one manually viaDeleteBotVersionRequest.builder()
- Parameters:
deleteBotVersionRequest
- AConsumer
that will call methods onDeleteBotVersionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteBotVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- ConflictException There was a conflict processing the request. Try your request again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- ResourceInUseException The resource that you are attempting to delete is referred to by another
resource. Use this information to remove references to the resource that you are trying to delete.
The body of the exception contains a JSON object that describes the resource.
{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,
"resourceReference": {
"name": string, "version": string } }
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteIntent
default CompletableFuture<DeleteIntentResponse> deleteIntent(DeleteIntentRequest deleteIntentRequest) Deletes all versions of the intent, including the
invalid input: '$'LATEST
version. To delete a specific version of the intent, use the DeleteIntentVersion operation.You can delete a version of an intent only if it is not referenced. To delete an intent that is referred to in one or more bots (see how-it-works), you must remove those references first.
If you get the
ResourceInUseException
exception, it provides an example reference that shows where the intent is referenced. To remove the reference to the intent, either update the bot or delete it. If you get the same exception when you attempt to delete the intent again, repeat until the intent has no references and the call toDeleteIntent
is successful.This operation requires permission for the
lex:DeleteIntent
action.- Parameters:
deleteIntentRequest
-- Returns:
- A Java Future containing the result of the DeleteIntent operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- ConflictException There was a conflict processing the request. Try your request again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- ResourceInUseException The resource that you are attempting to delete is referred to by another
resource. Use this information to remove references to the resource that you are trying to delete.
The body of the exception contains a JSON object that describes the resource.
{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,
"resourceReference": {
"name": string, "version": string } }
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteIntent
default CompletableFuture<DeleteIntentResponse> deleteIntent(Consumer<DeleteIntentRequest.Builder> deleteIntentRequest) Deletes all versions of the intent, including the
invalid input: '$'LATEST
version. To delete a specific version of the intent, use the DeleteIntentVersion operation.You can delete a version of an intent only if it is not referenced. To delete an intent that is referred to in one or more bots (see how-it-works), you must remove those references first.
If you get the
ResourceInUseException
exception, it provides an example reference that shows where the intent is referenced. To remove the reference to the intent, either update the bot or delete it. If you get the same exception when you attempt to delete the intent again, repeat until the intent has no references and the call toDeleteIntent
is successful.This operation requires permission for the
lex:DeleteIntent
action.
This is a convenience which creates an instance of the
DeleteIntentRequest.Builder
avoiding the need to create one manually viaDeleteIntentRequest.builder()
- Parameters:
deleteIntentRequest
- AConsumer
that will call methods onDeleteIntentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteIntent operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- ConflictException There was a conflict processing the request. Try your request again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- ResourceInUseException The resource that you are attempting to delete is referred to by another
resource. Use this information to remove references to the resource that you are trying to delete.
The body of the exception contains a JSON object that describes the resource.
{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,
"resourceReference": {
"name": string, "version": string } }
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteIntentVersion
default CompletableFuture<DeleteIntentVersionResponse> deleteIntentVersion(DeleteIntentVersionRequest deleteIntentVersionRequest) Deletes a specific version of an intent. To delete all versions of a intent, use the DeleteIntent operation.
This operation requires permissions for the
lex:DeleteIntentVersion
action.- Parameters:
deleteIntentVersionRequest
-- Returns:
- A Java Future containing the result of the DeleteIntentVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- ConflictException There was a conflict processing the request. Try your request again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- ResourceInUseException The resource that you are attempting to delete is referred to by another
resource. Use this information to remove references to the resource that you are trying to delete.
The body of the exception contains a JSON object that describes the resource.
{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,
"resourceReference": {
"name": string, "version": string } }
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteIntentVersion
default CompletableFuture<DeleteIntentVersionResponse> deleteIntentVersion(Consumer<DeleteIntentVersionRequest.Builder> deleteIntentVersionRequest) Deletes a specific version of an intent. To delete all versions of a intent, use the DeleteIntent operation.
This operation requires permissions for the
lex:DeleteIntentVersion
action.
This is a convenience which creates an instance of the
DeleteIntentVersionRequest.Builder
avoiding the need to create one manually viaDeleteIntentVersionRequest.builder()
- Parameters:
deleteIntentVersionRequest
- AConsumer
that will call methods onDeleteIntentVersionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteIntentVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- ConflictException There was a conflict processing the request. Try your request again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- ResourceInUseException The resource that you are attempting to delete is referred to by another
resource. Use this information to remove references to the resource that you are trying to delete.
The body of the exception contains a JSON object that describes the resource.
{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,
"resourceReference": {
"name": string, "version": string } }
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteSlotType
default CompletableFuture<DeleteSlotTypeResponse> deleteSlotType(DeleteSlotTypeRequest deleteSlotTypeRequest) Deletes all versions of the slot type, including the
invalid input: '$'LATEST
version. To delete a specific version of the slot type, use the DeleteSlotTypeVersion operation.You can delete a version of a slot type only if it is not referenced. To delete a slot type that is referred to in one or more intents, you must remove those references first.
If you get the
ResourceInUseException
exception, the exception provides an example reference that shows the intent where the slot type is referenced. To remove the reference to the slot type, either update the intent or delete it. If you get the same exception when you attempt to delete the slot type again, repeat until the slot type has no references and theDeleteSlotType
call is successful.This operation requires permission for the
lex:DeleteSlotType
action.- Parameters:
deleteSlotTypeRequest
-- Returns:
- A Java Future containing the result of the DeleteSlotType operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- ConflictException There was a conflict processing the request. Try your request again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- ResourceInUseException The resource that you are attempting to delete is referred to by another
resource. Use this information to remove references to the resource that you are trying to delete.
The body of the exception contains a JSON object that describes the resource.
{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,
"resourceReference": {
"name": string, "version": string } }
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteSlotType
default CompletableFuture<DeleteSlotTypeResponse> deleteSlotType(Consumer<DeleteSlotTypeRequest.Builder> deleteSlotTypeRequest) Deletes all versions of the slot type, including the
invalid input: '$'LATEST
version. To delete a specific version of the slot type, use the DeleteSlotTypeVersion operation.You can delete a version of a slot type only if it is not referenced. To delete a slot type that is referred to in one or more intents, you must remove those references first.
If you get the
ResourceInUseException
exception, the exception provides an example reference that shows the intent where the slot type is referenced. To remove the reference to the slot type, either update the intent or delete it. If you get the same exception when you attempt to delete the slot type again, repeat until the slot type has no references and theDeleteSlotType
call is successful.This operation requires permission for the
lex:DeleteSlotType
action.
This is a convenience which creates an instance of the
DeleteSlotTypeRequest.Builder
avoiding the need to create one manually viaDeleteSlotTypeRequest.builder()
- Parameters:
deleteSlotTypeRequest
- AConsumer
that will call methods onDeleteSlotTypeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteSlotType operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- ConflictException There was a conflict processing the request. Try your request again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- ResourceInUseException The resource that you are attempting to delete is referred to by another
resource. Use this information to remove references to the resource that you are trying to delete.
The body of the exception contains a JSON object that describes the resource.
{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,
"resourceReference": {
"name": string, "version": string } }
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteSlotTypeVersion
default CompletableFuture<DeleteSlotTypeVersionResponse> deleteSlotTypeVersion(DeleteSlotTypeVersionRequest deleteSlotTypeVersionRequest) Deletes a specific version of a slot type. To delete all versions of a slot type, use the DeleteSlotType operation.
This operation requires permissions for the
lex:DeleteSlotTypeVersion
action.- Parameters:
deleteSlotTypeVersionRequest
-- Returns:
- A Java Future containing the result of the DeleteSlotTypeVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- ConflictException There was a conflict processing the request. Try your request again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- ResourceInUseException The resource that you are attempting to delete is referred to by another
resource. Use this information to remove references to the resource that you are trying to delete.
The body of the exception contains a JSON object that describes the resource.
{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,
"resourceReference": {
"name": string, "version": string } }
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteSlotTypeVersion
default CompletableFuture<DeleteSlotTypeVersionResponse> deleteSlotTypeVersion(Consumer<DeleteSlotTypeVersionRequest.Builder> deleteSlotTypeVersionRequest) Deletes a specific version of a slot type. To delete all versions of a slot type, use the DeleteSlotType operation.
This operation requires permissions for the
lex:DeleteSlotTypeVersion
action.
This is a convenience which creates an instance of the
DeleteSlotTypeVersionRequest.Builder
avoiding the need to create one manually viaDeleteSlotTypeVersionRequest.builder()
- Parameters:
deleteSlotTypeVersionRequest
- AConsumer
that will call methods onDeleteSlotTypeVersionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteSlotTypeVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- ConflictException There was a conflict processing the request. Try your request again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- ResourceInUseException The resource that you are attempting to delete is referred to by another
resource. Use this information to remove references to the resource that you are trying to delete.
The body of the exception contains a JSON object that describes the resource.
{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,
"resourceReference": {
"name": string, "version": string } }
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteUtterances
default CompletableFuture<DeleteUtterancesResponse> deleteUtterances(DeleteUtterancesRequest deleteUtterancesRequest) Deletes stored utterances.
Amazon Lex stores the utterances that users send to your bot. Utterances are stored for 15 days for use with the GetUtterancesView 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 stored utterances for a specific user. When you use theDeleteUtterances
operation, utterances stored for improving your bot's ability to respond to user input are deleted immediately. Utterances stored for use with theGetUtterancesView
operation are deleted after 15 days.This operation requires permissions for the
lex:DeleteUtterances
action.- Parameters:
deleteUtterancesRequest
-- Returns:
- A Java Future containing the result of the DeleteUtterances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteUtterances
default CompletableFuture<DeleteUtterancesResponse> deleteUtterances(Consumer<DeleteUtterancesRequest.Builder> deleteUtterancesRequest) Deletes stored utterances.
Amazon Lex stores the utterances that users send to your bot. Utterances are stored for 15 days for use with the GetUtterancesView 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 stored utterances for a specific user. When you use theDeleteUtterances
operation, utterances stored for improving your bot's ability to respond to user input are deleted immediately. Utterances stored for use with theGetUtterancesView
operation are deleted after 15 days.This operation requires permissions for the
lex:DeleteUtterances
action.
This is a convenience which creates an instance of the
DeleteUtterancesRequest.Builder
avoiding the need to create one manually viaDeleteUtterancesRequest.builder()
- Parameters:
deleteUtterancesRequest
- AConsumer
that will call methods onDeleteUtterancesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteUtterances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBot
Returns metadata information for a specific bot. You must provide the bot name and the bot version or alias.
This operation requires permissions for the
lex:GetBot
action.- Parameters:
getBotRequest
-- Returns:
- A Java Future containing the result of the GetBot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBot
Returns metadata information for a specific bot. You must provide the bot name and the bot version or alias.
This operation requires permissions for the
lex:GetBot
action.
This is a convenience which creates an instance of the
GetBotRequest.Builder
avoiding the need to create one manually viaGetBotRequest.builder()
- Parameters:
getBotRequest
- AConsumer
that will call methods onGetBotRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetBot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBotAlias
Returns information about an Amazon Lex bot alias. For more information about aliases, see versioning-aliases.
This operation requires permissions for the
lex:GetBotAlias
action.- Parameters:
getBotAliasRequest
-- Returns:
- A Java Future containing the result of the GetBotAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBotAlias
default CompletableFuture<GetBotAliasResponse> getBotAlias(Consumer<GetBotAliasRequest.Builder> getBotAliasRequest) Returns information about an Amazon Lex bot alias. For more information about aliases, see versioning-aliases.
This operation requires permissions for the
lex:GetBotAlias
action.
This is a convenience which creates an instance of the
GetBotAliasRequest.Builder
avoiding the need to create one manually viaGetBotAliasRequest.builder()
- Parameters:
getBotAliasRequest
- AConsumer
that will call methods onGetBotAliasRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetBotAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBotAliases
default CompletableFuture<GetBotAliasesResponse> getBotAliases(GetBotAliasesRequest getBotAliasesRequest) Returns a list of aliases for a specified Amazon Lex bot.
This operation requires permissions for the
lex:GetBotAliases
action.- Parameters:
getBotAliasesRequest
-- Returns:
- A Java Future containing the result of the GetBotAliases operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBotAliases
default CompletableFuture<GetBotAliasesResponse> getBotAliases(Consumer<GetBotAliasesRequest.Builder> getBotAliasesRequest) Returns a list of aliases for a specified Amazon Lex bot.
This operation requires permissions for the
lex:GetBotAliases
action.
This is a convenience which creates an instance of the
GetBotAliasesRequest.Builder
avoiding the need to create one manually viaGetBotAliasesRequest.builder()
- Parameters:
getBotAliasesRequest
- AConsumer
that will call methods onGetBotAliasesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetBotAliases operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBotAliasesPaginator
This is a variant of
getBotAliases(software.amazon.awssdk.services.lexmodelbuilding.model.GetBotAliasesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.lexmodelbuilding.paginators.GetBotAliasesPublisher publisher = client.getBotAliasesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.lexmodelbuilding.paginators.GetBotAliasesPublisher publisher = client.getBotAliasesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lexmodelbuilding.model.GetBotAliasesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lexmodelbuilding.model.GetBotAliasesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getBotAliases(software.amazon.awssdk.services.lexmodelbuilding.model.GetBotAliasesRequest)
operation.- Parameters:
getBotAliasesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBotAliasesPaginator
default GetBotAliasesPublisher getBotAliasesPaginator(Consumer<GetBotAliasesRequest.Builder> getBotAliasesRequest) This is a variant of
getBotAliases(software.amazon.awssdk.services.lexmodelbuilding.model.GetBotAliasesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.lexmodelbuilding.paginators.GetBotAliasesPublisher publisher = client.getBotAliasesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.lexmodelbuilding.paginators.GetBotAliasesPublisher publisher = client.getBotAliasesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lexmodelbuilding.model.GetBotAliasesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lexmodelbuilding.model.GetBotAliasesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getBotAliases(software.amazon.awssdk.services.lexmodelbuilding.model.GetBotAliasesRequest)
operation.
This is a convenience which creates an instance of the
GetBotAliasesRequest.Builder
avoiding the need to create one manually viaGetBotAliasesRequest.builder()
- Parameters:
getBotAliasesRequest
- AConsumer
that will call methods onGetBotAliasesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBotChannelAssociation
default CompletableFuture<GetBotChannelAssociationResponse> getBotChannelAssociation(GetBotChannelAssociationRequest getBotChannelAssociationRequest) Returns information about the association between an Amazon Lex bot and a messaging platform.
This operation requires permissions for the
lex:GetBotChannelAssociation
action.- Parameters:
getBotChannelAssociationRequest
-- Returns:
- A Java Future containing the result of the GetBotChannelAssociation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBotChannelAssociation
default CompletableFuture<GetBotChannelAssociationResponse> getBotChannelAssociation(Consumer<GetBotChannelAssociationRequest.Builder> getBotChannelAssociationRequest) Returns information about the association between an Amazon Lex bot and a messaging platform.
This operation requires permissions for the
lex:GetBotChannelAssociation
action.
This is a convenience which creates an instance of the
GetBotChannelAssociationRequest.Builder
avoiding the need to create one manually viaGetBotChannelAssociationRequest.builder()
- Parameters:
getBotChannelAssociationRequest
- AConsumer
that will call methods onGetBotChannelAssociationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetBotChannelAssociation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBotChannelAssociations
default CompletableFuture<GetBotChannelAssociationsResponse> getBotChannelAssociations(GetBotChannelAssociationsRequest getBotChannelAssociationsRequest) Returns a list of all of the channels associated with the specified bot.
The
GetBotChannelAssociations
operation requires permissions for thelex:GetBotChannelAssociations
action.- Parameters:
getBotChannelAssociationsRequest
-- Returns:
- A Java Future containing the result of the GetBotChannelAssociations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBotChannelAssociations
default CompletableFuture<GetBotChannelAssociationsResponse> getBotChannelAssociations(Consumer<GetBotChannelAssociationsRequest.Builder> getBotChannelAssociationsRequest) Returns a list of all of the channels associated with the specified bot.
The
GetBotChannelAssociations
operation requires permissions for thelex:GetBotChannelAssociations
action.
This is a convenience which creates an instance of the
GetBotChannelAssociationsRequest.Builder
avoiding the need to create one manually viaGetBotChannelAssociationsRequest.builder()
- Parameters:
getBotChannelAssociationsRequest
- AConsumer
that will call methods onGetBotChannelAssociationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetBotChannelAssociations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBotChannelAssociationsPaginator
default GetBotChannelAssociationsPublisher getBotChannelAssociationsPaginator(GetBotChannelAssociationsRequest getBotChannelAssociationsRequest) This is a variant of
getBotChannelAssociations(software.amazon.awssdk.services.lexmodelbuilding.model.GetBotChannelAssociationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.lexmodelbuilding.paginators.GetBotChannelAssociationsPublisher publisher = client.getBotChannelAssociationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.lexmodelbuilding.paginators.GetBotChannelAssociationsPublisher publisher = client.getBotChannelAssociationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lexmodelbuilding.model.GetBotChannelAssociationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lexmodelbuilding.model.GetBotChannelAssociationsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getBotChannelAssociations(software.amazon.awssdk.services.lexmodelbuilding.model.GetBotChannelAssociationsRequest)
operation.- Parameters:
getBotChannelAssociationsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBotChannelAssociationsPaginator
default GetBotChannelAssociationsPublisher getBotChannelAssociationsPaginator(Consumer<GetBotChannelAssociationsRequest.Builder> getBotChannelAssociationsRequest) This is a variant of
getBotChannelAssociations(software.amazon.awssdk.services.lexmodelbuilding.model.GetBotChannelAssociationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.lexmodelbuilding.paginators.GetBotChannelAssociationsPublisher publisher = client.getBotChannelAssociationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.lexmodelbuilding.paginators.GetBotChannelAssociationsPublisher publisher = client.getBotChannelAssociationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lexmodelbuilding.model.GetBotChannelAssociationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lexmodelbuilding.model.GetBotChannelAssociationsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getBotChannelAssociations(software.amazon.awssdk.services.lexmodelbuilding.model.GetBotChannelAssociationsRequest)
operation.
This is a convenience which creates an instance of the
GetBotChannelAssociationsRequest.Builder
avoiding the need to create one manually viaGetBotChannelAssociationsRequest.builder()
- Parameters:
getBotChannelAssociationsRequest
- AConsumer
that will call methods onGetBotChannelAssociationsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBotVersions
default CompletableFuture<GetBotVersionsResponse> getBotVersions(GetBotVersionsRequest getBotVersionsRequest) Gets information about all of the versions of a bot.
The
GetBotVersions
operation returns aBotMetadata
object for each version of a bot. For example, if a bot has three numbered versions, theGetBotVersions
operation returns fourBotMetadata
objects in the response, one for each numbered version and one for theinvalid input: '$'LATEST
version.The
GetBotVersions
operation always returns at least one version, theinvalid input: '$'LATEST
version.This operation requires permissions for the
lex:GetBotVersions
action.- Parameters:
getBotVersionsRequest
-- Returns:
- A Java Future containing the result of the GetBotVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBotVersions
default CompletableFuture<GetBotVersionsResponse> getBotVersions(Consumer<GetBotVersionsRequest.Builder> getBotVersionsRequest) Gets information about all of the versions of a bot.
The
GetBotVersions
operation returns aBotMetadata
object for each version of a bot. For example, if a bot has three numbered versions, theGetBotVersions
operation returns fourBotMetadata
objects in the response, one for each numbered version and one for theinvalid input: '$'LATEST
version.The
GetBotVersions
operation always returns at least one version, theinvalid input: '$'LATEST
version.This operation requires permissions for the
lex:GetBotVersions
action.
This is a convenience which creates an instance of the
GetBotVersionsRequest.Builder
avoiding the need to create one manually viaGetBotVersionsRequest.builder()
- Parameters:
getBotVersionsRequest
- AConsumer
that will call methods onGetBotVersionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetBotVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBotVersionsPaginator
default GetBotVersionsPublisher getBotVersionsPaginator(GetBotVersionsRequest getBotVersionsRequest) This is a variant of
getBotVersions(software.amazon.awssdk.services.lexmodelbuilding.model.GetBotVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.lexmodelbuilding.paginators.GetBotVersionsPublisher publisher = client.getBotVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.lexmodelbuilding.paginators.GetBotVersionsPublisher publisher = client.getBotVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lexmodelbuilding.model.GetBotVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lexmodelbuilding.model.GetBotVersionsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getBotVersions(software.amazon.awssdk.services.lexmodelbuilding.model.GetBotVersionsRequest)
operation.- Parameters:
getBotVersionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBotVersionsPaginator
default GetBotVersionsPublisher getBotVersionsPaginator(Consumer<GetBotVersionsRequest.Builder> getBotVersionsRequest) This is a variant of
getBotVersions(software.amazon.awssdk.services.lexmodelbuilding.model.GetBotVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.lexmodelbuilding.paginators.GetBotVersionsPublisher publisher = client.getBotVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.lexmodelbuilding.paginators.GetBotVersionsPublisher publisher = client.getBotVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lexmodelbuilding.model.GetBotVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lexmodelbuilding.model.GetBotVersionsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getBotVersions(software.amazon.awssdk.services.lexmodelbuilding.model.GetBotVersionsRequest)
operation.
This is a convenience which creates an instance of the
GetBotVersionsRequest.Builder
avoiding the need to create one manually viaGetBotVersionsRequest.builder()
- Parameters:
getBotVersionsRequest
- AConsumer
that will call methods onGetBotVersionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBots
Returns bot information as follows:
-
If you provide the
nameContains
field, the response includes information for theinvalid input: '$'LATEST
version of all bots whose name contains the specified string. -
If you don't specify the
nameContains
field, the operation returns information about theinvalid input: '$'LATEST
version of all of your bots.
This operation requires permission for the
lex:GetBots
action.- Parameters:
getBotsRequest
-- Returns:
- A Java Future containing the result of the GetBots operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
getBots
Returns bot information as follows:
-
If you provide the
nameContains
field, the response includes information for theinvalid input: '$'LATEST
version of all bots whose name contains the specified string. -
If you don't specify the
nameContains
field, the operation returns information about theinvalid input: '$'LATEST
version of all of your bots.
This operation requires permission for the
lex:GetBots
action.
This is a convenience which creates an instance of the
GetBotsRequest.Builder
avoiding the need to create one manually viaGetBotsRequest.builder()
- Parameters:
getBotsRequest
- AConsumer
that will call methods onGetBotsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetBots operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
getBots
Returns bot information as follows:
-
If you provide the
nameContains
field, the response includes information for theinvalid input: '$'LATEST
version of all bots whose name contains the specified string. -
If you don't specify the
nameContains
field, the operation returns information about theinvalid input: '$'LATEST
version of all of your bots.
This operation requires permission for the
lex:GetBots
action.- Returns:
- A Java Future containing the result of the GetBots operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
getBotsPaginator
This is a variant of
getBots(software.amazon.awssdk.services.lexmodelbuilding.model.GetBotsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.lexmodelbuilding.paginators.GetBotsPublisher publisher = client.getBotsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.lexmodelbuilding.paginators.GetBotsPublisher publisher = client.getBotsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lexmodelbuilding.model.GetBotsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lexmodelbuilding.model.GetBotsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getBots(software.amazon.awssdk.services.lexmodelbuilding.model.GetBotsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBotsPaginator
This is a variant of
getBots(software.amazon.awssdk.services.lexmodelbuilding.model.GetBotsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.lexmodelbuilding.paginators.GetBotsPublisher publisher = client.getBotsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.lexmodelbuilding.paginators.GetBotsPublisher publisher = client.getBotsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lexmodelbuilding.model.GetBotsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lexmodelbuilding.model.GetBotsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getBots(software.amazon.awssdk.services.lexmodelbuilding.model.GetBotsRequest)
operation.- Parameters:
getBotsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBotsPaginator
This is a variant of
getBots(software.amazon.awssdk.services.lexmodelbuilding.model.GetBotsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.lexmodelbuilding.paginators.GetBotsPublisher publisher = client.getBotsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.lexmodelbuilding.paginators.GetBotsPublisher publisher = client.getBotsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lexmodelbuilding.model.GetBotsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lexmodelbuilding.model.GetBotsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getBots(software.amazon.awssdk.services.lexmodelbuilding.model.GetBotsRequest)
operation.
This is a convenience which creates an instance of the
GetBotsRequest.Builder
avoiding the need to create one manually viaGetBotsRequest.builder()
- Parameters:
getBotsRequest
- AConsumer
that will call methods onGetBotsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBuiltinIntent
default CompletableFuture<GetBuiltinIntentResponse> getBuiltinIntent(GetBuiltinIntentRequest getBuiltinIntentRequest) Returns information about a built-in intent.
This operation requires permission for the
lex:GetBuiltinIntent
action.- Parameters:
getBuiltinIntentRequest
-- Returns:
- A Java Future containing the result of the GetBuiltinIntent operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBuiltinIntent
default CompletableFuture<GetBuiltinIntentResponse> getBuiltinIntent(Consumer<GetBuiltinIntentRequest.Builder> getBuiltinIntentRequest) Returns information about a built-in intent.
This operation requires permission for the
lex:GetBuiltinIntent
action.
This is a convenience which creates an instance of the
GetBuiltinIntentRequest.Builder
avoiding the need to create one manually viaGetBuiltinIntentRequest.builder()
- Parameters:
getBuiltinIntentRequest
- AConsumer
that will call methods onGetBuiltinIntentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetBuiltinIntent operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBuiltinIntents
default CompletableFuture<GetBuiltinIntentsResponse> getBuiltinIntents(GetBuiltinIntentsRequest getBuiltinIntentsRequest) Gets a list of built-in intents that meet the specified criteria.
This operation requires permission for the
lex:GetBuiltinIntents
action.- Parameters:
getBuiltinIntentsRequest
-- Returns:
- A Java Future containing the result of the GetBuiltinIntents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBuiltinIntents
default CompletableFuture<GetBuiltinIntentsResponse> getBuiltinIntents(Consumer<GetBuiltinIntentsRequest.Builder> getBuiltinIntentsRequest) Gets a list of built-in intents that meet the specified criteria.
This operation requires permission for the
lex:GetBuiltinIntents
action.
This is a convenience which creates an instance of the
GetBuiltinIntentsRequest.Builder
avoiding the need to create one manually viaGetBuiltinIntentsRequest.builder()
- Parameters:
getBuiltinIntentsRequest
- AConsumer
that will call methods onGetBuiltinIntentsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetBuiltinIntents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBuiltinIntents
Gets a list of built-in intents that meet the specified criteria.
This operation requires permission for the
lex:GetBuiltinIntents
action.- Returns:
- A Java Future containing the result of the GetBuiltinIntents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBuiltinIntentsPaginator
This is a variant of
getBuiltinIntents(software.amazon.awssdk.services.lexmodelbuilding.model.GetBuiltinIntentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.lexmodelbuilding.paginators.GetBuiltinIntentsPublisher publisher = client.getBuiltinIntentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.lexmodelbuilding.paginators.GetBuiltinIntentsPublisher publisher = client.getBuiltinIntentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lexmodelbuilding.model.GetBuiltinIntentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lexmodelbuilding.model.GetBuiltinIntentsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getBuiltinIntents(software.amazon.awssdk.services.lexmodelbuilding.model.GetBuiltinIntentsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBuiltinIntentsPaginator
default GetBuiltinIntentsPublisher getBuiltinIntentsPaginator(GetBuiltinIntentsRequest getBuiltinIntentsRequest) This is a variant of
getBuiltinIntents(software.amazon.awssdk.services.lexmodelbuilding.model.GetBuiltinIntentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.lexmodelbuilding.paginators.GetBuiltinIntentsPublisher publisher = client.getBuiltinIntentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.lexmodelbuilding.paginators.GetBuiltinIntentsPublisher publisher = client.getBuiltinIntentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lexmodelbuilding.model.GetBuiltinIntentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lexmodelbuilding.model.GetBuiltinIntentsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getBuiltinIntents(software.amazon.awssdk.services.lexmodelbuilding.model.GetBuiltinIntentsRequest)
operation.- Parameters:
getBuiltinIntentsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBuiltinIntentsPaginator
default GetBuiltinIntentsPublisher getBuiltinIntentsPaginator(Consumer<GetBuiltinIntentsRequest.Builder> getBuiltinIntentsRequest) This is a variant of
getBuiltinIntents(software.amazon.awssdk.services.lexmodelbuilding.model.GetBuiltinIntentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.lexmodelbuilding.paginators.GetBuiltinIntentsPublisher publisher = client.getBuiltinIntentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.lexmodelbuilding.paginators.GetBuiltinIntentsPublisher publisher = client.getBuiltinIntentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lexmodelbuilding.model.GetBuiltinIntentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lexmodelbuilding.model.GetBuiltinIntentsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getBuiltinIntents(software.amazon.awssdk.services.lexmodelbuilding.model.GetBuiltinIntentsRequest)
operation.
This is a convenience which creates an instance of the
GetBuiltinIntentsRequest.Builder
avoiding the need to create one manually viaGetBuiltinIntentsRequest.builder()
- Parameters:
getBuiltinIntentsRequest
- AConsumer
that will call methods onGetBuiltinIntentsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBuiltinSlotTypes
default CompletableFuture<GetBuiltinSlotTypesResponse> getBuiltinSlotTypes(GetBuiltinSlotTypesRequest getBuiltinSlotTypesRequest) Gets a list of built-in slot types that meet the specified criteria.
For a list of built-in slot types, see Slot Type Reference in the Alexa Skills Kit.
This operation requires permission for the
lex:GetBuiltInSlotTypes
action.- Parameters:
getBuiltinSlotTypesRequest
-- Returns:
- A Java Future containing the result of the GetBuiltinSlotTypes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBuiltinSlotTypes
default CompletableFuture<GetBuiltinSlotTypesResponse> getBuiltinSlotTypes(Consumer<GetBuiltinSlotTypesRequest.Builder> getBuiltinSlotTypesRequest) Gets a list of built-in slot types that meet the specified criteria.
For a list of built-in slot types, see Slot Type Reference in the Alexa Skills Kit.
This operation requires permission for the
lex:GetBuiltInSlotTypes
action.
This is a convenience which creates an instance of the
GetBuiltinSlotTypesRequest.Builder
avoiding the need to create one manually viaGetBuiltinSlotTypesRequest.builder()
- Parameters:
getBuiltinSlotTypesRequest
- AConsumer
that will call methods onGetBuiltinSlotTypesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetBuiltinSlotTypes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBuiltinSlotTypes
Gets a list of built-in slot types that meet the specified criteria.
For a list of built-in slot types, see Slot Type Reference in the Alexa Skills Kit.
This operation requires permission for the
lex:GetBuiltInSlotTypes
action.- Returns:
- A Java Future containing the result of the GetBuiltinSlotTypes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBuiltinSlotTypesPaginator
This is a variant of
getBuiltinSlotTypes(software.amazon.awssdk.services.lexmodelbuilding.model.GetBuiltinSlotTypesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.lexmodelbuilding.paginators.GetBuiltinSlotTypesPublisher publisher = client.getBuiltinSlotTypesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.lexmodelbuilding.paginators.GetBuiltinSlotTypesPublisher publisher = client.getBuiltinSlotTypesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lexmodelbuilding.model.GetBuiltinSlotTypesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lexmodelbuilding.model.GetBuiltinSlotTypesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getBuiltinSlotTypes(software.amazon.awssdk.services.lexmodelbuilding.model.GetBuiltinSlotTypesRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBuiltinSlotTypesPaginator
default GetBuiltinSlotTypesPublisher getBuiltinSlotTypesPaginator(GetBuiltinSlotTypesRequest getBuiltinSlotTypesRequest) This is a variant of
getBuiltinSlotTypes(software.amazon.awssdk.services.lexmodelbuilding.model.GetBuiltinSlotTypesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.lexmodelbuilding.paginators.GetBuiltinSlotTypesPublisher publisher = client.getBuiltinSlotTypesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.lexmodelbuilding.paginators.GetBuiltinSlotTypesPublisher publisher = client.getBuiltinSlotTypesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lexmodelbuilding.model.GetBuiltinSlotTypesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lexmodelbuilding.model.GetBuiltinSlotTypesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getBuiltinSlotTypes(software.amazon.awssdk.services.lexmodelbuilding.model.GetBuiltinSlotTypesRequest)
operation.- Parameters:
getBuiltinSlotTypesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBuiltinSlotTypesPaginator
default GetBuiltinSlotTypesPublisher getBuiltinSlotTypesPaginator(Consumer<GetBuiltinSlotTypesRequest.Builder> getBuiltinSlotTypesRequest) This is a variant of
getBuiltinSlotTypes(software.amazon.awssdk.services.lexmodelbuilding.model.GetBuiltinSlotTypesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.lexmodelbuilding.paginators.GetBuiltinSlotTypesPublisher publisher = client.getBuiltinSlotTypesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.lexmodelbuilding.paginators.GetBuiltinSlotTypesPublisher publisher = client.getBuiltinSlotTypesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lexmodelbuilding.model.GetBuiltinSlotTypesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lexmodelbuilding.model.GetBuiltinSlotTypesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getBuiltinSlotTypes(software.amazon.awssdk.services.lexmodelbuilding.model.GetBuiltinSlotTypesRequest)
operation.
This is a convenience which creates an instance of the
GetBuiltinSlotTypesRequest.Builder
avoiding the need to create one manually viaGetBuiltinSlotTypesRequest.builder()
- Parameters:
getBuiltinSlotTypesRequest
- AConsumer
that will call methods onGetBuiltinSlotTypesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getExport
Exports the contents of a Amazon Lex resource in a specified format.
- Parameters:
getExportRequest
-- Returns:
- A Java Future containing the result of the GetExport operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getExport
default CompletableFuture<GetExportResponse> getExport(Consumer<GetExportRequest.Builder> getExportRequest) Exports the contents of a Amazon Lex resource in a specified format.
This is a convenience which creates an instance of the
GetExportRequest.Builder
avoiding the need to create one manually viaGetExportRequest.builder()
- Parameters:
getExportRequest
- AConsumer
that will call methods onGetExportRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetExport operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getImport
Gets information about an import job started with the
StartImport
operation.- Parameters:
getImportRequest
-- Returns:
- A Java Future containing the result of the GetImport operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getImport
default CompletableFuture<GetImportResponse> getImport(Consumer<GetImportRequest.Builder> getImportRequest) Gets information about an import job started with the
StartImport
operation.
This is a convenience which creates an instance of the
GetImportRequest.Builder
avoiding the need to create one manually viaGetImportRequest.builder()
- Parameters:
getImportRequest
- AConsumer
that will call methods onGetImportRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetImport operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getIntent
Returns information about an intent. In addition to the intent name, you must specify the intent version.
This operation requires permissions to perform the
lex:GetIntent
action.- Parameters:
getIntentRequest
-- Returns:
- A Java Future containing the result of the GetIntent operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getIntent
default CompletableFuture<GetIntentResponse> getIntent(Consumer<GetIntentRequest.Builder> getIntentRequest) Returns information about an intent. In addition to the intent name, you must specify the intent version.
This operation requires permissions to perform the
lex:GetIntent
action.
This is a convenience which creates an instance of the
GetIntentRequest.Builder
avoiding the need to create one manually viaGetIntentRequest.builder()
- Parameters:
getIntentRequest
- AConsumer
that will call methods onGetIntentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetIntent operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getIntentVersions
default CompletableFuture<GetIntentVersionsResponse> getIntentVersions(GetIntentVersionsRequest getIntentVersionsRequest) Gets information about all of the versions of an intent.
The
GetIntentVersions
operation returns anIntentMetadata
object for each version of an intent. For example, if an intent has three numbered versions, theGetIntentVersions
operation returns fourIntentMetadata
objects in the response, one for each numbered version and one for theinvalid input: '$'LATEST
version.The
GetIntentVersions
operation always returns at least one version, theinvalid input: '$'LATEST
version.This operation requires permissions for the
lex:GetIntentVersions
action.- Parameters:
getIntentVersionsRequest
-- Returns:
- A Java Future containing the result of the GetIntentVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getIntentVersions
default CompletableFuture<GetIntentVersionsResponse> getIntentVersions(Consumer<GetIntentVersionsRequest.Builder> getIntentVersionsRequest) Gets information about all of the versions of an intent.
The
GetIntentVersions
operation returns anIntentMetadata
object for each version of an intent. For example, if an intent has three numbered versions, theGetIntentVersions
operation returns fourIntentMetadata
objects in the response, one for each numbered version and one for theinvalid input: '$'LATEST
version.The
GetIntentVersions
operation always returns at least one version, theinvalid input: '$'LATEST
version.This operation requires permissions for the
lex:GetIntentVersions
action.
This is a convenience which creates an instance of the
GetIntentVersionsRequest.Builder
avoiding the need to create one manually viaGetIntentVersionsRequest.builder()
- Parameters:
getIntentVersionsRequest
- AConsumer
that will call methods onGetIntentVersionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetIntentVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getIntentVersionsPaginator
default GetIntentVersionsPublisher getIntentVersionsPaginator(GetIntentVersionsRequest getIntentVersionsRequest) This is a variant of
getIntentVersions(software.amazon.awssdk.services.lexmodelbuilding.model.GetIntentVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.lexmodelbuilding.paginators.GetIntentVersionsPublisher publisher = client.getIntentVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.lexmodelbuilding.paginators.GetIntentVersionsPublisher publisher = client.getIntentVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lexmodelbuilding.model.GetIntentVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lexmodelbuilding.model.GetIntentVersionsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getIntentVersions(software.amazon.awssdk.services.lexmodelbuilding.model.GetIntentVersionsRequest)
operation.- Parameters:
getIntentVersionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getIntentVersionsPaginator
default GetIntentVersionsPublisher getIntentVersionsPaginator(Consumer<GetIntentVersionsRequest.Builder> getIntentVersionsRequest) This is a variant of
getIntentVersions(software.amazon.awssdk.services.lexmodelbuilding.model.GetIntentVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.lexmodelbuilding.paginators.GetIntentVersionsPublisher publisher = client.getIntentVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.lexmodelbuilding.paginators.GetIntentVersionsPublisher publisher = client.getIntentVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lexmodelbuilding.model.GetIntentVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lexmodelbuilding.model.GetIntentVersionsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getIntentVersions(software.amazon.awssdk.services.lexmodelbuilding.model.GetIntentVersionsRequest)
operation.
This is a convenience which creates an instance of the
GetIntentVersionsRequest.Builder
avoiding the need to create one manually viaGetIntentVersionsRequest.builder()
- Parameters:
getIntentVersionsRequest
- AConsumer
that will call methods onGetIntentVersionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getIntents
Returns intent information as follows:
-
If you specify the
nameContains
field, returns theinvalid input: '$'LATEST
version of all intents that contain the specified string. -
If you don't specify the
nameContains
field, returns information about theinvalid input: '$'LATEST
version of all intents.
The operation requires permission for the
lex:GetIntents
action.- Parameters:
getIntentsRequest
-- Returns:
- A Java Future containing the result of the GetIntents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
getIntents
default CompletableFuture<GetIntentsResponse> getIntents(Consumer<GetIntentsRequest.Builder> getIntentsRequest) Returns intent information as follows:
-
If you specify the
nameContains
field, returns theinvalid input: '$'LATEST
version of all intents that contain the specified string. -
If you don't specify the
nameContains
field, returns information about theinvalid input: '$'LATEST
version of all intents.
The operation requires permission for the
lex:GetIntents
action.
This is a convenience which creates an instance of the
GetIntentsRequest.Builder
avoiding the need to create one manually viaGetIntentsRequest.builder()
- Parameters:
getIntentsRequest
- AConsumer
that will call methods onGetIntentsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetIntents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
getIntents
Returns intent information as follows:
-
If you specify the
nameContains
field, returns theinvalid input: '$'LATEST
version of all intents that contain the specified string. -
If you don't specify the
nameContains
field, returns information about theinvalid input: '$'LATEST
version of all intents.
The operation requires permission for the
lex:GetIntents
action.- Returns:
- A Java Future containing the result of the GetIntents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
getIntentsPaginator
This is a variant of
getIntents(software.amazon.awssdk.services.lexmodelbuilding.model.GetIntentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.lexmodelbuilding.paginators.GetIntentsPublisher publisher = client.getIntentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.lexmodelbuilding.paginators.GetIntentsPublisher publisher = client.getIntentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lexmodelbuilding.model.GetIntentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lexmodelbuilding.model.GetIntentsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getIntents(software.amazon.awssdk.services.lexmodelbuilding.model.GetIntentsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getIntentsPaginator
This is a variant of
getIntents(software.amazon.awssdk.services.lexmodelbuilding.model.GetIntentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.lexmodelbuilding.paginators.GetIntentsPublisher publisher = client.getIntentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.lexmodelbuilding.paginators.GetIntentsPublisher publisher = client.getIntentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lexmodelbuilding.model.GetIntentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lexmodelbuilding.model.GetIntentsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getIntents(software.amazon.awssdk.services.lexmodelbuilding.model.GetIntentsRequest)
operation.- Parameters:
getIntentsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getIntentsPaginator
default GetIntentsPublisher getIntentsPaginator(Consumer<GetIntentsRequest.Builder> getIntentsRequest) This is a variant of
getIntents(software.amazon.awssdk.services.lexmodelbuilding.model.GetIntentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.lexmodelbuilding.paginators.GetIntentsPublisher publisher = client.getIntentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.lexmodelbuilding.paginators.GetIntentsPublisher publisher = client.getIntentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lexmodelbuilding.model.GetIntentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lexmodelbuilding.model.GetIntentsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getIntents(software.amazon.awssdk.services.lexmodelbuilding.model.GetIntentsRequest)
operation.
This is a convenience which creates an instance of the
GetIntentsRequest.Builder
avoiding the need to create one manually viaGetIntentsRequest.builder()
- Parameters:
getIntentsRequest
- AConsumer
that will call methods onGetIntentsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMigration
default CompletableFuture<GetMigrationResponse> getMigration(GetMigrationRequest getMigrationRequest) Provides details about an ongoing or complete migration from an Amazon Lex V1 bot to an Amazon Lex V2 bot. Use this operation to view the migration alerts and warnings related to the migration.
- Parameters:
getMigrationRequest
-- Returns:
- A Java Future containing the result of the GetMigration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMigration
default CompletableFuture<GetMigrationResponse> getMigration(Consumer<GetMigrationRequest.Builder> getMigrationRequest) Provides details about an ongoing or complete migration from an Amazon Lex V1 bot to an Amazon Lex V2 bot. Use this operation to view the migration alerts and warnings related to the migration.
This is a convenience which creates an instance of the
GetMigrationRequest.Builder
avoiding the need to create one manually viaGetMigrationRequest.builder()
- Parameters:
getMigrationRequest
- AConsumer
that will call methods onGetMigrationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetMigration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMigrations
default CompletableFuture<GetMigrationsResponse> getMigrations(GetMigrationsRequest getMigrationsRequest) Gets a list of migrations between Amazon Lex V1 and Amazon Lex V2.
- Parameters:
getMigrationsRequest
-- Returns:
- A Java Future containing the result of the GetMigrations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMigrations
default CompletableFuture<GetMigrationsResponse> getMigrations(Consumer<GetMigrationsRequest.Builder> getMigrationsRequest) Gets a list of migrations between Amazon Lex V1 and Amazon Lex V2.
This is a convenience which creates an instance of the
GetMigrationsRequest.Builder
avoiding the need to create one manually viaGetMigrationsRequest.builder()
- Parameters:
getMigrationsRequest
- AConsumer
that will call methods onGetMigrationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetMigrations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMigrationsPaginator
This is a variant of
getMigrations(software.amazon.awssdk.services.lexmodelbuilding.model.GetMigrationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.lexmodelbuilding.paginators.GetMigrationsPublisher publisher = client.getMigrationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.lexmodelbuilding.paginators.GetMigrationsPublisher publisher = client.getMigrationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lexmodelbuilding.model.GetMigrationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lexmodelbuilding.model.GetMigrationsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getMigrations(software.amazon.awssdk.services.lexmodelbuilding.model.GetMigrationsRequest)
operation.- Parameters:
getMigrationsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMigrationsPaginator
default GetMigrationsPublisher getMigrationsPaginator(Consumer<GetMigrationsRequest.Builder> getMigrationsRequest) This is a variant of
getMigrations(software.amazon.awssdk.services.lexmodelbuilding.model.GetMigrationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.lexmodelbuilding.paginators.GetMigrationsPublisher publisher = client.getMigrationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.lexmodelbuilding.paginators.GetMigrationsPublisher publisher = client.getMigrationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lexmodelbuilding.model.GetMigrationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lexmodelbuilding.model.GetMigrationsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getMigrations(software.amazon.awssdk.services.lexmodelbuilding.model.GetMigrationsRequest)
operation.
This is a convenience which creates an instance of the
GetMigrationsRequest.Builder
avoiding the need to create one manually viaGetMigrationsRequest.builder()
- Parameters:
getMigrationsRequest
- AConsumer
that will call methods onGetMigrationsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSlotType
Returns information about a specific version of a slot type. In addition to specifying the slot type name, you must specify the slot type version.
This operation requires permissions for the
lex:GetSlotType
action.- Parameters:
getSlotTypeRequest
-- Returns:
- A Java Future containing the result of the GetSlotType operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSlotType
default CompletableFuture<GetSlotTypeResponse> getSlotType(Consumer<GetSlotTypeRequest.Builder> getSlotTypeRequest) Returns information about a specific version of a slot type. In addition to specifying the slot type name, you must specify the slot type version.
This operation requires permissions for the
lex:GetSlotType
action.
This is a convenience which creates an instance of the
GetSlotTypeRequest.Builder
avoiding the need to create one manually viaGetSlotTypeRequest.builder()
- Parameters:
getSlotTypeRequest
- AConsumer
that will call methods onGetSlotTypeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetSlotType operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSlotTypeVersions
default CompletableFuture<GetSlotTypeVersionsResponse> getSlotTypeVersions(GetSlotTypeVersionsRequest getSlotTypeVersionsRequest) Gets information about all versions of a slot type.
The
GetSlotTypeVersions
operation returns aSlotTypeMetadata
object for each version of a slot type. For example, if a slot type has three numbered versions, theGetSlotTypeVersions
operation returns fourSlotTypeMetadata
objects in the response, one for each numbered version and one for theinvalid input: '$'LATEST
version.The
GetSlotTypeVersions
operation always returns at least one version, theinvalid input: '$'LATEST
version.This operation requires permissions for the
lex:GetSlotTypeVersions
action.- Parameters:
getSlotTypeVersionsRequest
-- Returns:
- A Java Future containing the result of the GetSlotTypeVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSlotTypeVersions
default CompletableFuture<GetSlotTypeVersionsResponse> getSlotTypeVersions(Consumer<GetSlotTypeVersionsRequest.Builder> getSlotTypeVersionsRequest) Gets information about all versions of a slot type.
The
GetSlotTypeVersions
operation returns aSlotTypeMetadata
object for each version of a slot type. For example, if a slot type has three numbered versions, theGetSlotTypeVersions
operation returns fourSlotTypeMetadata
objects in the response, one for each numbered version and one for theinvalid input: '$'LATEST
version.The
GetSlotTypeVersions
operation always returns at least one version, theinvalid input: '$'LATEST
version.This operation requires permissions for the
lex:GetSlotTypeVersions
action.
This is a convenience which creates an instance of the
GetSlotTypeVersionsRequest.Builder
avoiding the need to create one manually viaGetSlotTypeVersionsRequest.builder()
- Parameters:
getSlotTypeVersionsRequest
- AConsumer
that will call methods onGetSlotTypeVersionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetSlotTypeVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSlotTypeVersionsPaginator
default GetSlotTypeVersionsPublisher getSlotTypeVersionsPaginator(GetSlotTypeVersionsRequest getSlotTypeVersionsRequest) This is a variant of
getSlotTypeVersions(software.amazon.awssdk.services.lexmodelbuilding.model.GetSlotTypeVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.lexmodelbuilding.paginators.GetSlotTypeVersionsPublisher publisher = client.getSlotTypeVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.lexmodelbuilding.paginators.GetSlotTypeVersionsPublisher publisher = client.getSlotTypeVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lexmodelbuilding.model.GetSlotTypeVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lexmodelbuilding.model.GetSlotTypeVersionsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getSlotTypeVersions(software.amazon.awssdk.services.lexmodelbuilding.model.GetSlotTypeVersionsRequest)
operation.- Parameters:
getSlotTypeVersionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSlotTypeVersionsPaginator
default GetSlotTypeVersionsPublisher getSlotTypeVersionsPaginator(Consumer<GetSlotTypeVersionsRequest.Builder> getSlotTypeVersionsRequest) This is a variant of
getSlotTypeVersions(software.amazon.awssdk.services.lexmodelbuilding.model.GetSlotTypeVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.lexmodelbuilding.paginators.GetSlotTypeVersionsPublisher publisher = client.getSlotTypeVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.lexmodelbuilding.paginators.GetSlotTypeVersionsPublisher publisher = client.getSlotTypeVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lexmodelbuilding.model.GetSlotTypeVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lexmodelbuilding.model.GetSlotTypeVersionsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getSlotTypeVersions(software.amazon.awssdk.services.lexmodelbuilding.model.GetSlotTypeVersionsRequest)
operation.
This is a convenience which creates an instance of the
GetSlotTypeVersionsRequest.Builder
avoiding the need to create one manually viaGetSlotTypeVersionsRequest.builder()
- Parameters:
getSlotTypeVersionsRequest
- AConsumer
that will call methods onGetSlotTypeVersionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSlotTypes
default CompletableFuture<GetSlotTypesResponse> getSlotTypes(GetSlotTypesRequest getSlotTypesRequest) Returns slot type information as follows:
-
If you specify the
nameContains
field, returns theinvalid input: '$'LATEST
version of all slot types that contain the specified string. -
If you don't specify the
nameContains
field, returns information about theinvalid input: '$'LATEST
version of all slot types.
The operation requires permission for the
lex:GetSlotTypes
action.- Parameters:
getSlotTypesRequest
-- Returns:
- A Java Future containing the result of the GetSlotTypes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
getSlotTypes
default CompletableFuture<GetSlotTypesResponse> getSlotTypes(Consumer<GetSlotTypesRequest.Builder> getSlotTypesRequest) Returns slot type information as follows:
-
If you specify the
nameContains
field, returns theinvalid input: '$'LATEST
version of all slot types that contain the specified string. -
If you don't specify the
nameContains
field, returns information about theinvalid input: '$'LATEST
version of all slot types.
The operation requires permission for the
lex:GetSlotTypes
action.
This is a convenience which creates an instance of the
GetSlotTypesRequest.Builder
avoiding the need to create one manually viaGetSlotTypesRequest.builder()
- Parameters:
getSlotTypesRequest
- AConsumer
that will call methods onGetSlotTypesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetSlotTypes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
getSlotTypes
Returns slot type information as follows:
-
If you specify the
nameContains
field, returns theinvalid input: '$'LATEST
version of all slot types that contain the specified string. -
If you don't specify the
nameContains
field, returns information about theinvalid input: '$'LATEST
version of all slot types.
The operation requires permission for the
lex:GetSlotTypes
action.- Returns:
- A Java Future containing the result of the GetSlotTypes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
getSlotTypesPaginator
This is a variant of
getSlotTypes(software.amazon.awssdk.services.lexmodelbuilding.model.GetSlotTypesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.lexmodelbuilding.paginators.GetSlotTypesPublisher publisher = client.getSlotTypesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.lexmodelbuilding.paginators.GetSlotTypesPublisher publisher = client.getSlotTypesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lexmodelbuilding.model.GetSlotTypesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lexmodelbuilding.model.GetSlotTypesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getSlotTypes(software.amazon.awssdk.services.lexmodelbuilding.model.GetSlotTypesRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSlotTypesPaginator
This is a variant of
getSlotTypes(software.amazon.awssdk.services.lexmodelbuilding.model.GetSlotTypesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.lexmodelbuilding.paginators.GetSlotTypesPublisher publisher = client.getSlotTypesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.lexmodelbuilding.paginators.GetSlotTypesPublisher publisher = client.getSlotTypesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lexmodelbuilding.model.GetSlotTypesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lexmodelbuilding.model.GetSlotTypesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getSlotTypes(software.amazon.awssdk.services.lexmodelbuilding.model.GetSlotTypesRequest)
operation.- Parameters:
getSlotTypesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSlotTypesPaginator
default GetSlotTypesPublisher getSlotTypesPaginator(Consumer<GetSlotTypesRequest.Builder> getSlotTypesRequest) This is a variant of
getSlotTypes(software.amazon.awssdk.services.lexmodelbuilding.model.GetSlotTypesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.lexmodelbuilding.paginators.GetSlotTypesPublisher publisher = client.getSlotTypesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.lexmodelbuilding.paginators.GetSlotTypesPublisher publisher = client.getSlotTypesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lexmodelbuilding.model.GetSlotTypesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lexmodelbuilding.model.GetSlotTypesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getSlotTypes(software.amazon.awssdk.services.lexmodelbuilding.model.GetSlotTypesRequest)
operation.
This is a convenience which creates an instance of the
GetSlotTypesRequest.Builder
avoiding the need to create one manually viaGetSlotTypesRequest.builder()
- Parameters:
getSlotTypesRequest
- AConsumer
that will call methods onGetSlotTypesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getUtterancesView
default CompletableFuture<GetUtterancesViewResponse> getUtterancesView(GetUtterancesViewRequest getUtterancesViewRequest) Use the
GetUtterancesView
operation to get information about the utterances that your users have made to your bot. You can use this list to tune the utterances that your bot responds to.For example, say that you have created a bot to order flowers. After your users have used your bot for a while, use the
GetUtterancesView
operation to see the requests that they have made and whether they have been successful. You might find that the utterance "I want flowers" is not being recognized. You could add this utterance to theOrderFlowers
intent so that your bot recognizes that utterance.After you publish a new version of a bot, you can get information about the old version and the new so that you can compare the performance across the two versions.
Utterance statistics are generated once a day. Data is available for the last 15 days. You can request information for up to 5 versions of your bot in each request. Amazon Lex returns the most frequent utterances received by the bot in the last 15 days. The response contains information about a maximum of 100 utterances for each version.
If you set
childDirected
field to true when you created your bot, if you are using slot obfuscation with one or more slots, or if you opted out of participating in improving Amazon Lex, utterances are not available.This operation requires permissions for the
lex:GetUtterancesView
action.- Parameters:
getUtterancesViewRequest
-- Returns:
- A Java Future containing the result of the GetUtterancesView operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getUtterancesView
default CompletableFuture<GetUtterancesViewResponse> getUtterancesView(Consumer<GetUtterancesViewRequest.Builder> getUtterancesViewRequest) Use the
GetUtterancesView
operation to get information about the utterances that your users have made to your bot. You can use this list to tune the utterances that your bot responds to.For example, say that you have created a bot to order flowers. After your users have used your bot for a while, use the
GetUtterancesView
operation to see the requests that they have made and whether they have been successful. You might find that the utterance "I want flowers" is not being recognized. You could add this utterance to theOrderFlowers
intent so that your bot recognizes that utterance.After you publish a new version of a bot, you can get information about the old version and the new so that you can compare the performance across the two versions.
Utterance statistics are generated once a day. Data is available for the last 15 days. You can request information for up to 5 versions of your bot in each request. Amazon Lex returns the most frequent utterances received by the bot in the last 15 days. The response contains information about a maximum of 100 utterances for each version.
If you set
childDirected
field to true when you created your bot, if you are using slot obfuscation with one or more slots, or if you opted out of participating in improving Amazon Lex, utterances are not available.This operation requires permissions for the
lex:GetUtterancesView
action.
This is a convenience which creates an instance of the
GetUtterancesViewRequest.Builder
avoiding the need to create one manually viaGetUtterancesViewRequest.builder()
- Parameters:
getUtterancesViewRequest
- AConsumer
that will call methods onGetUtterancesViewRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetUtterancesView operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Gets a list of tags associated with the specified resource. Only bots, bot aliases, and bot channels can have tags associated with them.
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- LimitExceededException The request exceeded a limit. Try your request again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Gets a list of tags associated with the specified resource. Only bots, bot aliases, and bot channels can have tags associated with them.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- LimitExceededException The request exceeded a limit. Try your request again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putBot
Creates an Amazon Lex conversational bot or replaces an existing bot. When you create or update a bot you are only required to specify a name, a locale, and whether the bot is directed toward children under age 13. You can use this to add intents later, or to remove intents from an existing bot. When you create a bot with the minimum information, the bot is created or updated but Amazon Lex returns the
response
FAILED
. You can build the bot after you add one or more intents. For more information about Amazon Lex bots, see how-it-works.If you specify the name of an existing bot, the fields in the request replace the existing values in the
invalid input: '$'LATEST
version of the bot. Amazon Lex removes any fields that you don't provide values for in the request, except for theidleTTLInSeconds
andprivacySettings
fields, which are set to their default values. If you don't specify values for required fields, Amazon Lex throws an exception.This operation requires permissions for the
lex:PutBot
action. For more information, see security-iam.- Parameters:
putBotRequest
-- Returns:
- A Java Future containing the result of the PutBot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ConflictException There was a conflict processing the request. Try your request again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- PreconditionFailedException The checksum of the resource that you are trying to change does not match the checksum in the request. Check the resource's checksum and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putBot
Creates an Amazon Lex conversational bot or replaces an existing bot. When you create or update a bot you are only required to specify a name, a locale, and whether the bot is directed toward children under age 13. You can use this to add intents later, or to remove intents from an existing bot. When you create a bot with the minimum information, the bot is created or updated but Amazon Lex returns the
response
FAILED
. You can build the bot after you add one or more intents. For more information about Amazon Lex bots, see how-it-works.If you specify the name of an existing bot, the fields in the request replace the existing values in the
invalid input: '$'LATEST
version of the bot. Amazon Lex removes any fields that you don't provide values for in the request, except for theidleTTLInSeconds
andprivacySettings
fields, which are set to their default values. If you don't specify values for required fields, Amazon Lex throws an exception.This operation requires permissions for the
lex:PutBot
action. For more information, see security-iam.
This is a convenience which creates an instance of the
PutBotRequest.Builder
avoiding the need to create one manually viaPutBotRequest.builder()
- Parameters:
putBotRequest
- AConsumer
that will call methods onPutBotRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutBot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ConflictException There was a conflict processing the request. Try your request again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- PreconditionFailedException The checksum of the resource that you are trying to change does not match the checksum in the request. Check the resource's checksum and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putBotAlias
Creates an alias for the specified version of the bot or replaces an alias for the specified bot. To change the version of the bot that the alias points to, replace the alias. For more information about aliases, see versioning-aliases.
This operation requires permissions for the
lex:PutBotAlias
action.- Parameters:
putBotAliasRequest
-- Returns:
- A Java Future containing the result of the PutBotAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ConflictException There was a conflict processing the request. Try your request again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- PreconditionFailedException The checksum of the resource that you are trying to change does not match the checksum in the request. Check the resource's checksum and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putBotAlias
default CompletableFuture<PutBotAliasResponse> putBotAlias(Consumer<PutBotAliasRequest.Builder> putBotAliasRequest) Creates an alias for the specified version of the bot or replaces an alias for the specified bot. To change the version of the bot that the alias points to, replace the alias. For more information about aliases, see versioning-aliases.
This operation requires permissions for the
lex:PutBotAlias
action.
This is a convenience which creates an instance of the
PutBotAliasRequest.Builder
avoiding the need to create one manually viaPutBotAliasRequest.builder()
- Parameters:
putBotAliasRequest
- AConsumer
that will call methods onPutBotAliasRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutBotAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ConflictException There was a conflict processing the request. Try your request again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- PreconditionFailedException The checksum of the resource that you are trying to change does not match the checksum in the request. Check the resource's checksum and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putIntent
Creates an intent or replaces an existing intent.
To define the interaction between the user and your bot, you use one or more intents. For a pizza ordering bot, for example, you would create an
OrderPizza
intent.To create an intent or replace an existing intent, you must provide the following:
-
Intent name. For example,
OrderPizza
. -
Sample utterances. For example, "Can I order a pizza, please." and "I want to order a pizza."
-
Information to be gathered. You specify slot types for the information that your bot will request from the user. You can specify standard slot types, such as a date or a time, or custom slot types such as the size and crust of a pizza.
-
How the intent will be fulfilled. You can provide a Lambda function or configure the intent to return the intent information to the client application. If you use a Lambda function, when all of the intent information is available, Amazon Lex invokes your Lambda function. If you configure your intent to return the intent information to the client application.
You can specify other optional information in the request, such as:
-
A confirmation prompt to ask the user to confirm an intent. For example, "Shall I order your pizza?"
-
A conclusion statement to send to the user after the intent has been fulfilled. For example, "I placed your pizza order."
-
A follow-up prompt that asks the user for additional activity. For example, asking "Do you want to order a drink with your pizza?"
If you specify an existing intent name to update the intent, Amazon Lex replaces the values in the
invalid input: '$'LATEST
version of the intent with the values in the request. Amazon Lex removes fields that you don't provide in the request. If you don't specify the required fields, Amazon Lex throws an exception. When you update theinvalid input: '$'LATEST
version of an intent, thestatus
field of any bot that uses theinvalid input: '$'LATEST
version of the intent is set toNOT_BUILT
.For more information, see how-it-works.
This operation requires permissions for the
lex:PutIntent
action.- Parameters:
putIntentRequest
-- Returns:
- A Java Future containing the result of the PutIntent operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ConflictException There was a conflict processing the request. Try your request again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- PreconditionFailedException The checksum of the resource that you are trying to change does not match the checksum in the request. Check the resource's checksum and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
putIntent
default CompletableFuture<PutIntentResponse> putIntent(Consumer<PutIntentRequest.Builder> putIntentRequest) Creates an intent or replaces an existing intent.
To define the interaction between the user and your bot, you use one or more intents. For a pizza ordering bot, for example, you would create an
OrderPizza
intent.To create an intent or replace an existing intent, you must provide the following:
-
Intent name. For example,
OrderPizza
. -
Sample utterances. For example, "Can I order a pizza, please." and "I want to order a pizza."
-
Information to be gathered. You specify slot types for the information that your bot will request from the user. You can specify standard slot types, such as a date or a time, or custom slot types such as the size and crust of a pizza.
-
How the intent will be fulfilled. You can provide a Lambda function or configure the intent to return the intent information to the client application. If you use a Lambda function, when all of the intent information is available, Amazon Lex invokes your Lambda function. If you configure your intent to return the intent information to the client application.
You can specify other optional information in the request, such as:
-
A confirmation prompt to ask the user to confirm an intent. For example, "Shall I order your pizza?"
-
A conclusion statement to send to the user after the intent has been fulfilled. For example, "I placed your pizza order."
-
A follow-up prompt that asks the user for additional activity. For example, asking "Do you want to order a drink with your pizza?"
If you specify an existing intent name to update the intent, Amazon Lex replaces the values in the
invalid input: '$'LATEST
version of the intent with the values in the request. Amazon Lex removes fields that you don't provide in the request. If you don't specify the required fields, Amazon Lex throws an exception. When you update theinvalid input: '$'LATEST
version of an intent, thestatus
field of any bot that uses theinvalid input: '$'LATEST
version of the intent is set toNOT_BUILT
.For more information, see how-it-works.
This operation requires permissions for the
lex:PutIntent
action.
This is a convenience which creates an instance of the
PutIntentRequest.Builder
avoiding the need to create one manually viaPutIntentRequest.builder()
- Parameters:
putIntentRequest
- AConsumer
that will call methods onPutIntentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutIntent operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ConflictException There was a conflict processing the request. Try your request again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- PreconditionFailedException The checksum of the resource that you are trying to change does not match the checksum in the request. Check the resource's checksum and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
putSlotType
Creates a custom slot type or replaces an existing custom slot type.
To create a custom slot type, specify a name for the slot type and a set of enumeration values, which are the values that a slot of this type can assume. For more information, see how-it-works.
If you specify the name of an existing slot type, the fields in the request replace the existing values in the
invalid input: '$'LATEST
version of the slot type. Amazon Lex removes the fields that you don't provide in the request. If you don't specify required fields, Amazon Lex throws an exception. When you update theinvalid input: '$'LATEST
version of a slot type, if a bot uses theinvalid input: '$'LATEST
version of an intent that contains the slot type, the bot'sstatus
field is set toNOT_BUILT
.This operation requires permissions for the
lex:PutSlotType
action.- Parameters:
putSlotTypeRequest
-- Returns:
- A Java Future containing the result of the PutSlotType operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ConflictException There was a conflict processing the request. Try your request again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- PreconditionFailedException The checksum of the resource that you are trying to change does not match the checksum in the request. Check the resource's checksum and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putSlotType
default CompletableFuture<PutSlotTypeResponse> putSlotType(Consumer<PutSlotTypeRequest.Builder> putSlotTypeRequest) Creates a custom slot type or replaces an existing custom slot type.
To create a custom slot type, specify a name for the slot type and a set of enumeration values, which are the values that a slot of this type can assume. For more information, see how-it-works.
If you specify the name of an existing slot type, the fields in the request replace the existing values in the
invalid input: '$'LATEST
version of the slot type. Amazon Lex removes the fields that you don't provide in the request. If you don't specify required fields, Amazon Lex throws an exception. When you update theinvalid input: '$'LATEST
version of a slot type, if a bot uses theinvalid input: '$'LATEST
version of an intent that contains the slot type, the bot'sstatus
field is set toNOT_BUILT
.This operation requires permissions for the
lex:PutSlotType
action.
This is a convenience which creates an instance of the
PutSlotTypeRequest.Builder
avoiding the need to create one manually viaPutSlotTypeRequest.builder()
- Parameters:
putSlotTypeRequest
- AConsumer
that will call methods onPutSlotTypeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutSlotType operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ConflictException There was a conflict processing the request. Try your request again.
- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- PreconditionFailedException The checksum of the resource that you are trying to change does not match the checksum in the request. Check the resource's checksum and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startImport
Starts a job to import a resource to Amazon Lex.
- Parameters:
startImportRequest
-- Returns:
- A Java Future containing the result of the StartImport operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startImport
default CompletableFuture<StartImportResponse> startImport(Consumer<StartImportRequest.Builder> startImportRequest) Starts a job to import a resource to Amazon Lex.
This is a convenience which creates an instance of the
StartImportRequest.Builder
avoiding the need to create one manually viaStartImportRequest.builder()
- Parameters:
startImportRequest
- AConsumer
that will call methods onStartImportRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartImport operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startMigration
default CompletableFuture<StartMigrationResponse> startMigration(StartMigrationRequest startMigrationRequest) Starts migrating a bot from Amazon Lex V1 to Amazon Lex V2. Migrate your bot when you want to take advantage of the new features of Amazon Lex V2.
For more information, see Migrating a bot in the Amazon Lex developer guide.
- Parameters:
startMigrationRequest
-- Returns:
- A Java Future containing the result of the StartMigration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- AccessDeniedException Your IAM user or role does not have permission to call the Amazon Lex V2 APIs required to migrate your bot.
- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startMigration
default CompletableFuture<StartMigrationResponse> startMigration(Consumer<StartMigrationRequest.Builder> startMigrationRequest) Starts migrating a bot from Amazon Lex V1 to Amazon Lex V2. Migrate your bot when you want to take advantage of the new features of Amazon Lex V2.
For more information, see Migrating a bot in the Amazon Lex developer guide.
This is a convenience which creates an instance of the
StartMigrationRequest.Builder
avoiding the need to create one manually viaStartMigrationRequest.builder()
- Parameters:
startMigrationRequest
- AConsumer
that will call methods onStartMigrationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartMigration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LimitExceededException The request exceeded a limit. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- AccessDeniedException Your IAM user or role does not have permission to call the Amazon Lex V2 APIs required to migrate your bot.
- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
Adds the specified tags to the specified resource. If a tag key already exists, the existing value is replaced with the new value.
- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- ConflictException There was a conflict processing the request. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- LimitExceededException The request exceeded a limit. Try your request again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds the specified tags to the specified resource. If a tag key already exists, the existing value is replaced with the new value.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- ConflictException There was a conflict processing the request. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- LimitExceededException The request exceeded a limit. Try your request again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes tags from a bot, bot alias or bot channel.
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- ConflictException There was a conflict processing the request. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- LimitExceededException The request exceeded a limit. Try your request again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes tags from a bot, bot alias or bot channel.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource specified in the request was not found. Check the resource and try again.
- BadRequestException The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
- ConflictException There was a conflict processing the request. Try your request again.
- InternalFailureException An internal Amazon Lex error occurred. Try your request again.
- LimitExceededException The request exceeded a limit. Try your request again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LexModelBuildingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aLexModelBuildingAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aLexModelBuildingAsyncClient
.
-