AmazonLexModelBuildingClient (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.lexmodelbuilding.AmazonLexModelBuildingClient

All Implemented Interfaces:

AmazonLexModelBuilding

Direct Known Subclasses:

AmazonLexModelBuildingAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonLexModelBuildingClient
extends AmazonWebServiceClient
implements AmazonLexModelBuilding
```
Client for accessing Amazon Lex Model Building Service. All service calls made using this client are blocking, and will not return until the service call completes.
Amazon Lex Build-Time Actions
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
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  LOGGING_AWS_REQUEST_METRIC
- Fields inherited from interface com.amazonaws.services.lexmodelbuilding.AmazonLexModelBuilding
  ENDPOINT_PREFIX

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static AmazonLexModelBuildingClientBuilder`	`builder()`
`CreateBotVersionResult`	`createBotVersion(CreateBotVersionRequest request)` Creates a new version of the bot based on the `$LATEST` version.
`CreateIntentVersionResult`	`createIntentVersion(CreateIntentVersionRequest request)` Creates a new version of an intent based on the `$LATEST` version of the intent.
`CreateSlotTypeVersionResult`	`createSlotTypeVersion(CreateSlotTypeVersionRequest request)` Creates a new version of a slot type based on the `$LATEST` version of the specified slot type.
`DeleteBotResult`	`deleteBot(DeleteBotRequest request)` Deletes all versions of the bot, including the `$LATEST` version.
`DeleteBotAliasResult`	`deleteBotAlias(DeleteBotAliasRequest request)` Deletes an alias for the specified bot.
`DeleteBotChannelAssociationResult`	`deleteBotChannelAssociation(DeleteBotChannelAssociationRequest request)` Deletes the association between an Amazon Lex bot and a messaging platform.
`DeleteBotVersionResult`	`deleteBotVersion(DeleteBotVersionRequest request)` Deletes a specific version of a bot.
`DeleteIntentResult`	`deleteIntent(DeleteIntentRequest request)` Deletes all versions of the intent, including the `$LATEST` version.
`DeleteIntentVersionResult`	`deleteIntentVersion(DeleteIntentVersionRequest request)` Deletes a specific version of an intent.
`DeleteSlotTypeResult`	`deleteSlotType(DeleteSlotTypeRequest request)` Deletes all versions of the slot type, including the `$LATEST` version.
`DeleteSlotTypeVersionResult`	`deleteSlotTypeVersion(DeleteSlotTypeVersionRequest request)` Deletes a specific version of a slot type.
`DeleteUtterancesResult`	`deleteUtterances(DeleteUtterancesRequest request)` Deletes stored utterances.
`GetBotResult`	`getBot(GetBotRequest request)` Returns metadata information for a specific bot.
`GetBotAliasResult`	`getBotAlias(GetBotAliasRequest request)` Returns information about an Amazon Lex bot alias.
`GetBotAliasesResult`	`getBotAliases(GetBotAliasesRequest request)` Returns a list of aliases for a specified Amazon Lex bot.
`GetBotChannelAssociationResult`	`getBotChannelAssociation(GetBotChannelAssociationRequest request)` Returns information about the association between an Amazon Lex bot and a messaging platform.
`GetBotChannelAssociationsResult`	`getBotChannelAssociations(GetBotChannelAssociationsRequest request)` Returns a list of all of the channels associated with the specified bot.
`GetBotsResult`	`getBots(GetBotsRequest request)` Returns bot information as follows:
`GetBotVersionsResult`	`getBotVersions(GetBotVersionsRequest request)` Gets information about all of the versions of a bot.
`GetBuiltinIntentResult`	`getBuiltinIntent(GetBuiltinIntentRequest request)` Returns information about a built-in intent.
`GetBuiltinIntentsResult`	`getBuiltinIntents(GetBuiltinIntentsRequest request)` Gets a list of built-in intents that meet the specified criteria.
`GetBuiltinSlotTypesResult`	`getBuiltinSlotTypes(GetBuiltinSlotTypesRequest request)` Gets a list of built-in slot types that meet the specified criteria.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
`GetExportResult`	`getExport(GetExportRequest request)` Exports the contents of a Amazon Lex resource in a specified format.
`GetIntentResult`	`getIntent(GetIntentRequest request)` Returns information about an intent.
`GetIntentsResult`	`getIntents(GetIntentsRequest request)` Returns intent information as follows:
`GetIntentVersionsResult`	`getIntentVersions(GetIntentVersionsRequest request)` Gets information about all of the versions of an intent.
`GetSlotTypeResult`	`getSlotType(GetSlotTypeRequest request)` Returns information about a specific version of a slot type.
`GetSlotTypesResult`	`getSlotTypes(GetSlotTypesRequest request)` Returns slot type information as follows:
`GetSlotTypeVersionsResult`	`getSlotTypeVersions(GetSlotTypeVersionsRequest request)` Gets information about all versions of a slot type.
`GetUtterancesViewResult`	`getUtterancesView(GetUtterancesViewRequest request)` Use the `GetUtterancesView` operation to get information about the utterances that your users have made to your bot.
`PutBotResult`	`putBot(PutBotRequest request)` Creates an Amazon Lex conversational bot or replaces an existing bot.
`PutBotAliasResult`	`putBotAlias(PutBotAliasRequest request)` Creates an alias for the specified version of the bot or replaces an alias for the specified bot.
`PutIntentResult`	`putIntent(PutIntentRequest request)` Creates an intent or replaces an existing intent.
`PutSlotTypeResult`	`putSlotType(PutSlotTypeRequest request)` Creates a custom slot type or replaces an existing custom slot type.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.lexmodelbuilding.AmazonLexModelBuilding
shutdown

- Method Detail
  - builder
```
public static AmazonLexModelBuildingClientBuilder builder()
```
  - createBotVersion
```
public CreateBotVersionResult createBotVersion(CreateBotVersionRequest request)
```
    Creates a new version of the bot based on the $LATEST version. If the $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 $LATEST version of the bot. You can't update the numbered versions that you create with the CreateBotVersion 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.
    
    Specified by:
    
    createBotVersion in interface AmazonLexModelBuilding
    
    Parameters:
    
    createBotVersionRequest -
    
    Returns:
    
    Result of the CreateBotVersion operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createIntentVersion
```
public CreateIntentVersionResult createIntentVersion(CreateIntentVersionRequest request)
```
    Creates a new version of an intent based on the $LATEST version of the intent. If the $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 $LATEST version of the intent. You can't update the numbered versions that you create with the CreateIntentVersion 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.
    
    Specified by:
    
    createIntentVersion in interface AmazonLexModelBuilding
    
    Parameters:
    
    createIntentVersionRequest -
    
    Returns:
    
    Result of the CreateIntentVersion operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createSlotTypeVersion
```
public CreateSlotTypeVersionResult createSlotTypeVersion(CreateSlotTypeVersionRequest request)
```
    Creates a new version of a slot type based on the $LATEST version of the specified slot type. If the $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 $LATEST version of a slot type. You can't update the numbered versions that you create with the CreateSlotTypeVersion 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.
    
    Specified by:
    
    createSlotTypeVersion in interface AmazonLexModelBuilding
    
    Parameters:
    
    createSlotTypeVersionRequest -
    
    Returns:
    
    Result of the CreateSlotTypeVersion operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteBot
```
public DeleteBotResult deleteBot(DeleteBotRequest request)
```
    Deletes all versions of the bot, including the $LATEST version. To delete a specific version of the bot, use the DeleteBotVersion operation.
    
    If a bot has an alias, you can't delete it. Instead, the DeleteBot operation returns a ResourceInUseException 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 the DeleteBot operation is successful.
    
    This operation requires permissions for the lex:DeleteBot action.
    
    Specified by:
    
    deleteBot in interface AmazonLexModelBuilding
    
    Parameters:
    
    deleteBotRequest -
    
    Returns:
    
    Result of the DeleteBot operation returned by the service.
    
    Throws:
    
    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 } }
    
    See Also:
    
    AWS API Documentation
  - deleteBotAlias
```
public DeleteBotAliasResult deleteBotAlias(DeleteBotAliasRequest request)
```
    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 a ResourceInUseException 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 the DeleteBotAlias operation is successful.
    
    Specified by:
    
    deleteBotAlias in interface AmazonLexModelBuilding
    
    Parameters:
    
    deleteBotAliasRequest -
    
    Returns:
    
    Result of the DeleteBotAlias operation returned by the service.
    
    Throws:
    
    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 } }
    
    See Also:
    
    AWS API Documentation
  - deleteBotChannelAssociation
```
public DeleteBotChannelAssociationResult deleteBotChannelAssociation(DeleteBotChannelAssociationRequest request)
```
    Deletes the association between an Amazon Lex bot and a messaging platform.
    
    This operation requires permission for the lex:DeleteBotChannelAssociation action.
    
    Specified by:
    
    deleteBotChannelAssociation in interface AmazonLexModelBuilding
    
    Parameters:
    
    deleteBotChannelAssociationRequest -
    
    Returns:
    
    Result of the DeleteBotChannelAssociation operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteBotVersion
```
public DeleteBotVersionResult deleteBotVersion(DeleteBotVersionRequest request)
```
    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.
    
    Specified by:
    
    deleteBotVersion in interface AmazonLexModelBuilding
    
    Parameters:
    
    deleteBotVersionRequest -
    
    Returns:
    
    Result of the DeleteBotVersion operation returned by the service.
    
    Throws:
    
    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 } }
    
    See Also:
    
    AWS API Documentation
  - deleteIntent
```
public DeleteIntentResult deleteIntent(DeleteIntentRequest request)
```
    Deletes all versions of the intent, including the $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 to DeleteIntent is successful.
    
    This operation requires permission for the lex:DeleteIntent action.
    
    Specified by:
    
    deleteIntent in interface AmazonLexModelBuilding
    
    Parameters:
    
    deleteIntentRequest -
    
    Returns:
    
    Result of the DeleteIntent operation returned by the service.
    
    Throws:
    
    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 } }
    
    See Also:
    
    AWS API Documentation
  - deleteIntentVersion
```
public DeleteIntentVersionResult deleteIntentVersion(DeleteIntentVersionRequest request)
```
    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.
    
    Specified by:
    
    deleteIntentVersion in interface AmazonLexModelBuilding
    
    Parameters:
    
    deleteIntentVersionRequest -
    
    Returns:
    
    Result of the DeleteIntentVersion operation returned by the service.
    
    Throws:
    
    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 } }
    
    See Also:
    
    AWS API Documentation
  - deleteSlotType
```
public DeleteSlotTypeResult deleteSlotType(DeleteSlotTypeRequest request)
```
    Deletes all versions of the slot type, including the $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 the DeleteSlotType call is successful.
    
    This operation requires permission for the lex:DeleteSlotType action.
    
    Specified by:
    
    deleteSlotType in interface AmazonLexModelBuilding
    
    Parameters:
    
    deleteSlotTypeRequest -
    
    Returns:
    
    Result of the DeleteSlotType operation returned by the service.
    
    Throws:
    
    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 } }
    
    See Also:
    
    AWS API Documentation
  - deleteSlotTypeVersion
```
public DeleteSlotTypeVersionResult deleteSlotTypeVersion(DeleteSlotTypeVersionRequest request)
```
    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.
    
    Specified by:
    
    deleteSlotTypeVersion in interface AmazonLexModelBuilding
    
    Parameters:
    
    deleteSlotTypeVersionRequest -
    
    Returns:
    
    Result of the DeleteSlotTypeVersion operation returned by the service.
    
    Throws:
    
    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 } }
    
    See Also:
    
    AWS API Documentation
  - deleteUtterances
```
public DeleteUtterancesResult deleteUtterances(DeleteUtterancesRequest request)
```
    Deletes stored utterances.
    
    Amazon Lex stores the utterances that users send to your bot unless the childDirected field in the bot is set to true. Utterances are stored for 15 days for use with the GetUtterancesView operation, and then stored indefinately for use in improving the ability of your bot to respond to user input.
    
    Use the DeleteStoredUtterances operation to manually delete stored utterances for a specific user.
    
    This operation requires permissions for the lex:DeleteUtterances action.
    
    Specified by:
    
    deleteUtterances in interface AmazonLexModelBuilding
    
    Parameters:
    
    deleteUtterancesRequest -
    
    Returns:
    
    Result of the DeleteUtterances operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getBot
```
public GetBotResult getBot(GetBotRequest request)
```
    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.
    
    Specified by:
    
    getBot in interface AmazonLexModelBuilding
    
    Parameters:
    
    getBotRequest -
    
    Returns:
    
    Result of the GetBot operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getBotAlias
```
public GetBotAliasResult getBotAlias(GetBotAliasRequest request)
```
    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.
    
    Specified by:
    
    getBotAlias in interface AmazonLexModelBuilding
    
    Parameters:
    
    getBotAliasRequest -
    
    Returns:
    
    Result of the GetBotAlias operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getBotAliases
```
public GetBotAliasesResult getBotAliases(GetBotAliasesRequest request)
```
    Returns a list of aliases for a specified Amazon Lex bot.
    
    This operation requires permissions for the lex:GetBotAliases action.
    
    Specified by:
    
    getBotAliases in interface AmazonLexModelBuilding
    
    Parameters:
    
    getBotAliasesRequest -
    
    Returns:
    
    Result of the GetBotAliases operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getBotChannelAssociation
```
public GetBotChannelAssociationResult getBotChannelAssociation(GetBotChannelAssociationRequest request)
```
    Returns information about the association between an Amazon Lex bot and a messaging platform.
    
    This operation requires permissions for the lex:GetBotChannelAssociation action.
    
    Specified by:
    
    getBotChannelAssociation in interface AmazonLexModelBuilding
    
    Parameters:
    
    getBotChannelAssociationRequest -
    
    Returns:
    
    Result of the GetBotChannelAssociation operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getBotChannelAssociations
```
public GetBotChannelAssociationsResult getBotChannelAssociations(GetBotChannelAssociationsRequest request)
```
    Returns a list of all of the channels associated with the specified bot.
    
    The GetBotChannelAssociations operation requires permissions for the lex:GetBotChannelAssociations action.
    
    Specified by:
    
    getBotChannelAssociations in interface AmazonLexModelBuilding
    
    Parameters:
    
    getBotChannelAssociationsRequest -
    
    Returns:
    
    Result of the GetBotChannelAssociations operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getBotVersions
```
public GetBotVersionsResult getBotVersions(GetBotVersionsRequest request)
```
    Gets information about all of the versions of a bot.
    
    The GetBotVersions operation returns a BotMetadata object for each version of a bot. For example, if a bot has three numbered versions, the GetBotVersions operation returns four BotMetadata objects in the response, one for each numbered version and one for the $LATEST version.
    
    The GetBotVersions operation always returns at least one version, the $LATEST version.
    
    This operation requires permissions for the lex:GetBotVersions action.
    
    Specified by:
    
    getBotVersions in interface AmazonLexModelBuilding
    
    Parameters:
    
    getBotVersionsRequest -
    
    Returns:
    
    Result of the GetBotVersions operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getBots
```
public GetBotsResult getBots(GetBotsRequest request)
```
    Returns bot information as follows:
    - If you provide the nameContains field, the response includes information for the $LATEST version of all bots whose name contains the specified string.
    - If you don't specify the nameContains field, the operation returns information about the $LATEST version of all of your bots.
    This operation requires permission for the lex:GetBots action.
    Specified by:
    
    getBots in interface AmazonLexModelBuilding
    
    Parameters:
    
    getBotsRequest -
    
    Returns:
    
    Result of the GetBots operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getBuiltinIntent
```
public GetBuiltinIntentResult getBuiltinIntent(GetBuiltinIntentRequest request)
```
    Returns information about a built-in intent.
    
    This operation requires permission for the lex:GetBuiltinIntent action.
    
    Specified by:
    
    getBuiltinIntent in interface AmazonLexModelBuilding
    
    Parameters:
    
    getBuiltinIntentRequest -
    
    Returns:
    
    Result of the GetBuiltinIntent operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getBuiltinIntents
```
public GetBuiltinIntentsResult getBuiltinIntents(GetBuiltinIntentsRequest request)
```
    Gets a list of built-in intents that meet the specified criteria.
    
    This operation requires permission for the lex:GetBuiltinIntents action.
    
    Specified by:
    
    getBuiltinIntents in interface AmazonLexModelBuilding
    
    Parameters:
    
    getBuiltinIntentsRequest -
    
    Returns:
    
    Result of the GetBuiltinIntents operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getBuiltinSlotTypes
```
public GetBuiltinSlotTypesResult getBuiltinSlotTypes(GetBuiltinSlotTypesRequest request)
```
    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.
    
    Specified by:
    
    getBuiltinSlotTypes in interface AmazonLexModelBuilding
    
    Parameters:
    
    getBuiltinSlotTypesRequest -
    
    Returns:
    
    Result of the GetBuiltinSlotTypes operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getExport
```
public GetExportResult getExport(GetExportRequest request)
```
    Exports the contents of a Amazon Lex resource in a specified format.
    
    Specified by:
    
    getExport in interface AmazonLexModelBuilding
    
    Parameters:
    
    getExportRequest -
    
    Returns:
    
    Result of the GetExport operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getIntent
```
public GetIntentResult getIntent(GetIntentRequest request)
```
    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.
    
    Specified by:
    
    getIntent in interface AmazonLexModelBuilding
    
    Parameters:
    
    getIntentRequest -
    
    Returns:
    
    Result of the GetIntent operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getIntentVersions
```
public GetIntentVersionsResult getIntentVersions(GetIntentVersionsRequest request)
```
    Gets information about all of the versions of an intent.
    
    The GetIntentVersions operation returns an IntentMetadata object for each version of an intent. For example, if an intent has three numbered versions, the GetIntentVersions operation returns four IntentMetadata objects in the response, one for each numbered version and one for the $LATEST version.
    
    The GetIntentVersions operation always returns at least one version, the $LATEST version.
    
    This operation requires permissions for the lex:GetIntentVersions action.
    
    Specified by:
    
    getIntentVersions in interface AmazonLexModelBuilding
    
    Parameters:
    
    getIntentVersionsRequest -
    
    Returns:
    
    Result of the GetIntentVersions operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getIntents
```
public GetIntentsResult getIntents(GetIntentsRequest request)
```
    Returns intent information as follows:
    - If you specify the nameContains field, returns the $LATEST version of all intents that contain the specified string.
    - If you don't specify the nameContains field, returns information about the $LATEST version of all intents.
    The operation requires permission for the lex:GetIntents action.
    Specified by:
    
    getIntents in interface AmazonLexModelBuilding
    
    Parameters:
    
    getIntentsRequest -
    
    Returns:
    
    Result of the GetIntents operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getSlotType
```
public GetSlotTypeResult getSlotType(GetSlotTypeRequest request)
```
    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.
    
    Specified by:
    
    getSlotType in interface AmazonLexModelBuilding
    
    Parameters:
    
    getSlotTypeRequest -
    
    Returns:
    
    Result of the GetSlotType operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getSlotTypeVersions
```
public GetSlotTypeVersionsResult getSlotTypeVersions(GetSlotTypeVersionsRequest request)
```
    Gets information about all versions of a slot type.
    
    The GetSlotTypeVersions operation returns a SlotTypeMetadata object for each version of a slot type. For example, if a slot type has three numbered versions, the GetSlotTypeVersions operation returns four SlotTypeMetadata objects in the response, one for each numbered version and one for the $LATEST version.
    
    The GetSlotTypeVersions operation always returns at least one version, the $LATEST version.
    
    This operation requires permissions for the lex:GetSlotTypeVersions action.
    
    Specified by:
    
    getSlotTypeVersions in interface AmazonLexModelBuilding
    
    Parameters:
    
    getSlotTypeVersionsRequest -
    
    Returns:
    
    Result of the GetSlotTypeVersions operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getSlotTypes
```
public GetSlotTypesResult getSlotTypes(GetSlotTypesRequest request)
```
    Returns slot type information as follows:
    - If you specify the nameContains field, returns the $LATEST version of all slot types that contain the specified string.
    - If you don't specify the nameContains field, returns information about the $LATEST version of all slot types.
    The operation requires permission for the lex:GetSlotTypes action.
    Specified by:
    
    getSlotTypes in interface AmazonLexModelBuilding
    
    Parameters:
    
    getSlotTypesRequest -
    
    Returns:
    
    Result of the GetSlotTypes operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getUtterancesView
```
public GetUtterancesViewResult getUtterancesView(GetUtterancesViewRequest request)
```
    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 the OrderFlowers 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.
    
    Data is available for the last 15 days. You can request information for up to 5 versions in each request. The response contains information about a maximum of 100 utterances for each version.
    
    If the bot's childDirected field is set to true, utterances for the bot are not stored and cannot be retrieved with the GetUtterancesView operation. For more information, see PutBot.
    
    This operation requires permissions for the lex:GetUtterancesView action.
    
    Specified by:
    
    getUtterancesView in interface AmazonLexModelBuilding
    
    Parameters:
    
    getUtterancesViewRequest -
    
    Returns:
    
    Result of the GetUtterancesView operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - putBot
```
public PutBotResult putBot(PutBotRequest request)
```
    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. You can use this to add intents later, or to remove intents from an existing bot. When you create a bot with a name only, 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 $LATEST version of the bot. Amazon Lex removes any fields that you don't provide values for in the request, except for the idleTTLInSeconds and privacySettings 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 auth-and-access-control.
    Specified by: putBot in interface AmazonLexModelBuilding Parameters: putBotRequest - Returns: Result of the PutBot operation returned by the service. Throws: 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. See Also: AWS API Documentation
  putBotAlias public PutBotAliasResult putBotAlias(PutBotAliasRequest request) 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. Specified by: putBotAlias in interface AmazonLexModelBuilding Parameters: putBotAliasRequest - Returns: Result of the PutBotAlias operation returned by the service. Throws: 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. See Also: AWS API Documentation putIntent public PutIntentResult putIntent(PutIntentRequest request) 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 $LATEST version of the slot type 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. For more information, see how-it-works. This operation requires permissions for the lex:PutIntent action. Specified by: putIntent in interface AmazonLexModelBuilding Parameters: putIntentRequest - Returns: Result of the PutIntent operation returned by the service. Throws: 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. See Also: AWS API Documentation putSlotType public PutSlotTypeResult putSlotType(PutSlotTypeRequest request) 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 $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. This operation requires permissions for the lex:PutSlotType action. Specified by: putSlotType in interface AmazonLexModelBuilding Parameters: putSlotTypeRequest - Returns: Result of the PutSlotType operation returned by the service. Throws: 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. See Also: AWS API Documentation getCachedResponseMetadata public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface. Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request. Specified by: getCachedResponseMetadata in interface AmazonLexModelBuilding Parameters: request - The originally executed request Returns: The response metadata for the specified request, or null if none is available.

Did this page help you?

Class AmazonLexModelBuildingClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.lexmodelbuilding.AmazonLexModelBuilding

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Methods inherited from interface com.amazonaws.services.lexmodelbuilding.AmazonLexModelBuilding

Method Detail

builder

createBotVersion

createIntentVersion

createSlotTypeVersion

deleteBot

deleteBotAlias

deleteBotChannelAssociation

deleteBotVersion

deleteIntent

deleteIntentVersion

deleteSlotType

deleteSlotTypeVersion

deleteUtterances

getBot

getBotAlias

getBotAliases

getBotChannelAssociation

getBotChannelAssociations

getBotVersions

getBots

getBuiltinIntent

getBuiltinIntents

getBuiltinSlotTypes

getExport

getIntent

getIntentVersions

getIntents

getSlotType

getSlotTypeVersions

getSlotTypes

getUtterancesView

putBot

putBotAlias

putIntent

putSlotType

getCachedResponseMetadata