@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface LexRuntimeClient extends AwsClient
builder()
method.
Amazon Lex provides both build and runtime endpoints. Each endpoint provides a set of operations (API). Your conversational bot uses the runtime API to understand user utterances (user input text or voice). For example, suppose a user says "I want pizza", your bot sends this input to Amazon Lex using the runtime API. Amazon Lex recognizes that the user request is for the OrderPizza intent (one of the intents defined in the bot). Then Amazon Lex engages in user conversation on behalf of the bot to elicit required information (slot values, such as pizza size and crust type), and then performs fulfillment activity (that you configured when you created the bot). You use the build-time API to create and manage your Amazon Lex bot. For a list of build-time operations, see the build-time API, .
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static LexRuntimeClientBuilder |
builder()
Create a builder that can be used to configure and create a
LexRuntimeClient. |
static LexRuntimeClient |
create()
Create a
LexRuntimeClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default DeleteSessionResponse |
deleteSession(Consumer<DeleteSessionRequest.Builder> deleteSessionRequest)
Removes session information for a specified bot, alias, and user ID.
|
default DeleteSessionResponse |
deleteSession(DeleteSessionRequest deleteSessionRequest)
Removes session information for a specified bot, alias, and user ID.
|
default GetSessionResponse |
getSession(Consumer<GetSessionRequest.Builder> getSessionRequest)
Returns session information for a specified bot, alias, and user ID.
|
default GetSessionResponse |
getSession(GetSessionRequest getSessionRequest)
Returns session information for a specified bot, alias, and user ID.
|
default PostContentResponse |
postContent(Consumer<PostContentRequest.Builder> postContentRequest,
Path sourcePath,
Path destinationPath)
Sends user input (text or speech) to Amazon Lex.
|
default <ReturnT> ReturnT |
postContent(Consumer<PostContentRequest.Builder> postContentRequest,
RequestBody requestBody,
ResponseTransformer<PostContentResponse,ReturnT> responseTransformer)
Sends user input (text or speech) to Amazon Lex.
|
default PostContentResponse |
postContent(PostContentRequest postContentRequest,
Path sourcePath,
Path destinationPath)
Sends user input (text or speech) to Amazon Lex.
|
default <ReturnT> ReturnT |
postContent(PostContentRequest postContentRequest,
RequestBody requestBody,
ResponseTransformer<PostContentResponse,ReturnT> responseTransformer)
Sends user input (text or speech) to Amazon Lex.
|
default PostTextResponse |
postText(Consumer<PostTextRequest.Builder> postTextRequest)
Sends user input to Amazon Lex.
|
default PostTextResponse |
postText(PostTextRequest postTextRequest)
Sends user input to Amazon Lex.
|
default ResponseInputStream<PutSessionResponse> |
putSession(Consumer<PutSessionRequest.Builder> putSessionRequest)
Creates a new session or modifies an existing session with an Amazon Lex bot.
|
default PutSessionResponse |
putSession(Consumer<PutSessionRequest.Builder> putSessionRequest,
Path destinationPath)
Creates a new session or modifies an existing session with an Amazon Lex bot.
|
default <ReturnT> ReturnT |
putSession(Consumer<PutSessionRequest.Builder> putSessionRequest,
ResponseTransformer<PutSessionResponse,ReturnT> responseTransformer)
Creates a new session or modifies an existing session with an Amazon Lex bot.
|
default ResponseInputStream<PutSessionResponse> |
putSession(PutSessionRequest putSessionRequest)
Creates a new session or modifies an existing session with an Amazon Lex bot.
|
default PutSessionResponse |
putSession(PutSessionRequest putSessionRequest,
Path destinationPath)
Creates a new session or modifies an existing session with an Amazon Lex bot.
|
default <ReturnT> ReturnT |
putSession(PutSessionRequest putSessionRequest,
ResponseTransformer<PutSessionResponse,ReturnT> responseTransformer)
Creates a new session or modifies an existing session with an Amazon Lex bot.
|
default ResponseBytes<PutSessionResponse> |
putSessionAsBytes(Consumer<PutSessionRequest.Builder> putSessionRequest)
Creates a new session or modifies an existing session with an Amazon Lex bot.
|
default ResponseBytes<PutSessionResponse> |
putSessionAsBytes(PutSessionRequest putSessionRequest)
Creates a new session or modifies an existing session with an Amazon Lex bot.
|
default LexRuntimeServiceClientConfiguration |
serviceClientConfiguration() |
static ServiceMetadata |
serviceMetadata() |
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default DeleteSessionResponse deleteSession(DeleteSessionRequest deleteSessionRequest) throws NotFoundException, BadRequestException, LimitExceededException, InternalFailureException, ConflictException, AwsServiceException, SdkClientException, LexRuntimeException
Removes session information for a specified bot, alias, and user ID.
deleteSessionRequest - NotFoundException - The resource (such as the Amazon Lex bot or an alias) that is referred to is not found.BadRequestException - Request validation failed, there is no usable message in the context, or the bot build failed, is still
in progress, or contains unbuilt changes.LimitExceededException - Exceeded a limit.InternalFailureException - Internal service error. Retry the call.ConflictException - Two clients are using the same AWS account, Amazon Lex bot, and user ID.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.LexRuntimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteSessionResponse deleteSession(Consumer<DeleteSessionRequest.Builder> deleteSessionRequest) throws NotFoundException, BadRequestException, LimitExceededException, InternalFailureException, ConflictException, AwsServiceException, SdkClientException, LexRuntimeException
Removes session information for a specified bot, alias, and user ID.
This is a convenience which creates an instance of the DeleteSessionRequest.Builder avoiding the need to
create one manually via DeleteSessionRequest.builder()
deleteSessionRequest - A Consumer that will call methods on DeleteSessionRequest.Builder to create a request.NotFoundException - The resource (such as the Amazon Lex bot or an alias) that is referred to is not found.BadRequestException - Request validation failed, there is no usable message in the context, or the bot build failed, is still
in progress, or contains unbuilt changes.LimitExceededException - Exceeded a limit.InternalFailureException - Internal service error. Retry the call.ConflictException - Two clients are using the same AWS account, Amazon Lex bot, and user ID.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.LexRuntimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetSessionResponse getSession(GetSessionRequest getSessionRequest) throws NotFoundException, BadRequestException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, LexRuntimeException
Returns session information for a specified bot, alias, and user ID.
getSessionRequest - NotFoundException - The resource (such as the Amazon Lex bot or an alias) that is referred to is not found.BadRequestException - Request validation failed, there is no usable message in the context, or the bot build failed, is still
in progress, or contains unbuilt changes.LimitExceededException - Exceeded a limit.InternalFailureException - Internal service error. Retry the call.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.LexRuntimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetSessionResponse getSession(Consumer<GetSessionRequest.Builder> getSessionRequest) throws NotFoundException, BadRequestException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, LexRuntimeException
Returns session information for a specified bot, alias, and user ID.
This is a convenience which creates an instance of the GetSessionRequest.Builder avoiding the need to
create one manually via GetSessionRequest.builder()
getSessionRequest - A Consumer that will call methods on GetSessionRequest.Builder to create a request.NotFoundException - The resource (such as the Amazon Lex bot or an alias) that is referred to is not found.BadRequestException - Request validation failed, there is no usable message in the context, or the bot build failed, is still
in progress, or contains unbuilt changes.LimitExceededException - Exceeded a limit.InternalFailureException - Internal service error. Retry the call.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.LexRuntimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault <ReturnT> ReturnT postContent(PostContentRequest postContentRequest, RequestBody requestBody, ResponseTransformer<PostContentResponse,ReturnT> responseTransformer) throws NotFoundException, BadRequestException, LimitExceededException, InternalFailureException, ConflictException, UnsupportedMediaTypeException, NotAcceptableException, RequestTimeoutException, DependencyFailedException, BadGatewayException, LoopDetectedException, AwsServiceException, SdkClientException, LexRuntimeException
Sends user input (text or speech) to Amazon Lex. Clients use this API to send text and audio requests to Amazon Lex at runtime. Amazon Lex interprets the user input using the machine learning model that it built for the bot.
The PostContent operation supports audio input at 8kHz and 16kHz. You can use 8kHz audio to achieve
higher speech recognition accuracy in telephone audio applications.
In response, Amazon Lex returns the next message to convey to the user. Consider the following example messages:
For a user input "I would like a pizza," Amazon Lex might return a response with a message eliciting slot data
(for example, PizzaSize): "What size pizza would you like?".
After the user provides all of the pizza order information, Amazon Lex might return a response with a message to get user confirmation: "Order the pizza?".
After the user replies "Yes" to the confirmation prompt, Amazon Lex might return a conclusion statement: "Thank you, your cheese pizza has been ordered.".
Not all Amazon Lex messages require a response from the user. For example, conclusion statements do not require a
response. Some messages require only a yes or no response. In addition to the message, Amazon Lex
provides additional context about the message in the response that you can use to enhance client behavior, such
as displaying the appropriate client user interface. Consider the following examples:
If the message is to elicit slot data, Amazon Lex returns the following context information:
x-amz-lex-dialog-state header set to ElicitSlot
x-amz-lex-intent-name header set to the intent name in the current context
x-amz-lex-slot-to-elicit header set to the slot name for which the message is eliciting
information
x-amz-lex-slots header set to a map of slots configured for the intent with their current values
If the message is a confirmation prompt, the x-amz-lex-dialog-state header is set to
Confirmation and the x-amz-lex-slot-to-elicit header is omitted.
If the message is a clarification prompt configured for the intent, indicating that the user intent is not
understood, the x-amz-dialog-state header is set to ElicitIntent and the
x-amz-slot-to-elicit header is omitted.
In addition, Amazon Lex also returns your application-specific sessionAttributes. For more
information, see Managing Conversation
Context.
postContentRequest - requestBody - The content to send to the service. A RequestBody can be created using one of several factory
methods for various sources of data. For example, to create a request body from a file you can do the
following.
RequestBody.fromFile(new File("myfile.txt"))
See documentation in RequestBody for additional details and which sources of data are supported.
The service documentation for the request content is as follows '
User input in PCM or Opus audio format or text format as described in the Content-Type HTTP
header.
You can stream audio data to Amazon Lex or you can create a local buffer that captures all of the audio data before sending. In general, you get better performance if you stream audio data rather than buffering the data locally.
'responseTransformer - Functional interface for processing the streamed response content. The unmarshalled PostContentResponse
and an InputStream to the response content are provided as parameters to the callback. The callback may
return a transformed type which will be the return value of this method. See
ResponseTransformer for details on implementing this interface
and for links to pre-canned implementations for common scenarios like downloading to a file. The service
documentation for the response content is as follows '
The prompt (or statement) to convey to the user. This is based on the bot configuration and context. For
example, if Amazon Lex did not understand the user intent, it sends the clarificationPrompt
configured for the bot. If the intent requires confirmation before taking the fulfillment action, it sends
the confirmationPrompt. Another example: Suppose that the Lambda function successfully
fulfilled the intent, and sent a message to convey to the user. Then Amazon Lex sends that message in the
response.
NotFoundException - The resource (such as the Amazon Lex bot or an alias) that is referred to is not found.BadRequestException - Request validation failed, there is no usable message in the context, or the bot build failed, is still
in progress, or contains unbuilt changes.LimitExceededException - Exceeded a limit.InternalFailureException - Internal service error. Retry the call.ConflictException - Two clients are using the same AWS account, Amazon Lex bot, and user ID.UnsupportedMediaTypeException - The Content-Type header (PostContent API) has an invalid value.NotAcceptableException - The accept header in the request does not have a valid value.RequestTimeoutException - The input speech is too long.DependencyFailedException - One of the dependencies, such as AWS Lambda or Amazon Polly, threw an exception. For example,
If Amazon Lex does not have sufficient permissions to call a Lambda function.
If a Lambda function takes longer than 30 seconds to execute.
If a fulfillment Lambda function returns a Delegate dialog action without removing any slot
values.
BadGatewayException - Either the Amazon Lex bot is still building, or one of the dependent services (Amazon Polly, AWS Lambda)
failed with an internal service error.LoopDetectedException - This exception is not used.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.LexRuntimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault <ReturnT> ReturnT postContent(Consumer<PostContentRequest.Builder> postContentRequest, RequestBody requestBody, ResponseTransformer<PostContentResponse,ReturnT> responseTransformer) throws NotFoundException, BadRequestException, LimitExceededException, InternalFailureException, ConflictException, UnsupportedMediaTypeException, NotAcceptableException, RequestTimeoutException, DependencyFailedException, BadGatewayException, LoopDetectedException, AwsServiceException, SdkClientException, LexRuntimeException
Sends user input (text or speech) to Amazon Lex. Clients use this API to send text and audio requests to Amazon Lex at runtime. Amazon Lex interprets the user input using the machine learning model that it built for the bot.
The PostContent operation supports audio input at 8kHz and 16kHz. You can use 8kHz audio to achieve
higher speech recognition accuracy in telephone audio applications.
In response, Amazon Lex returns the next message to convey to the user. Consider the following example messages:
For a user input "I would like a pizza," Amazon Lex might return a response with a message eliciting slot data
(for example, PizzaSize): "What size pizza would you like?".
After the user provides all of the pizza order information, Amazon Lex might return a response with a message to get user confirmation: "Order the pizza?".
After the user replies "Yes" to the confirmation prompt, Amazon Lex might return a conclusion statement: "Thank you, your cheese pizza has been ordered.".
Not all Amazon Lex messages require a response from the user. For example, conclusion statements do not require a
response. Some messages require only a yes or no response. In addition to the message, Amazon Lex
provides additional context about the message in the response that you can use to enhance client behavior, such
as displaying the appropriate client user interface. Consider the following examples:
If the message is to elicit slot data, Amazon Lex returns the following context information:
x-amz-lex-dialog-state header set to ElicitSlot
x-amz-lex-intent-name header set to the intent name in the current context
x-amz-lex-slot-to-elicit header set to the slot name for which the message is eliciting
information
x-amz-lex-slots header set to a map of slots configured for the intent with their current values
If the message is a confirmation prompt, the x-amz-lex-dialog-state header is set to
Confirmation and the x-amz-lex-slot-to-elicit header is omitted.
If the message is a clarification prompt configured for the intent, indicating that the user intent is not
understood, the x-amz-dialog-state header is set to ElicitIntent and the
x-amz-slot-to-elicit header is omitted.
In addition, Amazon Lex also returns your application-specific sessionAttributes. For more
information, see Managing Conversation
Context.
This is a convenience which creates an instance of the PostContentRequest.Builder avoiding the need to
create one manually via PostContentRequest.builder()
postContentRequest - A Consumer that will call methods on PostContentRequest.Builder to create a request.requestBody - The content to send to the service. A RequestBody can be created using one of several factory
methods for various sources of data. For example, to create a request body from a file you can do the
following.
RequestBody.fromFile(new File("myfile.txt"))
See documentation in RequestBody for additional details and which sources of data are supported.
The service documentation for the request content is as follows '
User input in PCM or Opus audio format or text format as described in the Content-Type HTTP
header.
You can stream audio data to Amazon Lex or you can create a local buffer that captures all of the audio data before sending. In general, you get better performance if you stream audio data rather than buffering the data locally.
'responseTransformer - Functional interface for processing the streamed response content. The unmarshalled PostContentResponse
and an InputStream to the response content are provided as parameters to the callback. The callback may
return a transformed type which will be the return value of this method. See
ResponseTransformer for details on implementing this interface
and for links to pre-canned implementations for common scenarios like downloading to a file. The service
documentation for the response content is as follows '
The prompt (or statement) to convey to the user. This is based on the bot configuration and context. For
example, if Amazon Lex did not understand the user intent, it sends the clarificationPrompt
configured for the bot. If the intent requires confirmation before taking the fulfillment action, it sends
the confirmationPrompt. Another example: Suppose that the Lambda function successfully
fulfilled the intent, and sent a message to convey to the user. Then Amazon Lex sends that message in the
response.
NotFoundException - The resource (such as the Amazon Lex bot or an alias) that is referred to is not found.BadRequestException - Request validation failed, there is no usable message in the context, or the bot build failed, is still
in progress, or contains unbuilt changes.LimitExceededException - Exceeded a limit.InternalFailureException - Internal service error. Retry the call.ConflictException - Two clients are using the same AWS account, Amazon Lex bot, and user ID.UnsupportedMediaTypeException - The Content-Type header (PostContent API) has an invalid value.NotAcceptableException - The accept header in the request does not have a valid value.RequestTimeoutException - The input speech is too long.DependencyFailedException - One of the dependencies, such as AWS Lambda or Amazon Polly, threw an exception. For example,
If Amazon Lex does not have sufficient permissions to call a Lambda function.
If a Lambda function takes longer than 30 seconds to execute.
If a fulfillment Lambda function returns a Delegate dialog action without removing any slot
values.
BadGatewayException - Either the Amazon Lex bot is still building, or one of the dependent services (Amazon Polly, AWS Lambda)
failed with an internal service error.LoopDetectedException - This exception is not used.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.LexRuntimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PostContentResponse postContent(PostContentRequest postContentRequest, Path sourcePath, Path destinationPath) throws NotFoundException, BadRequestException, LimitExceededException, InternalFailureException, ConflictException, UnsupportedMediaTypeException, NotAcceptableException, RequestTimeoutException, DependencyFailedException, BadGatewayException, LoopDetectedException, AwsServiceException, SdkClientException, LexRuntimeException
Sends user input (text or speech) to Amazon Lex. Clients use this API to send text and audio requests to Amazon Lex at runtime. Amazon Lex interprets the user input using the machine learning model that it built for the bot.
The PostContent operation supports audio input at 8kHz and 16kHz. You can use 8kHz audio to achieve
higher speech recognition accuracy in telephone audio applications.
In response, Amazon Lex returns the next message to convey to the user. Consider the following example messages:
For a user input "I would like a pizza," Amazon Lex might return a response with a message eliciting slot data
(for example, PizzaSize): "What size pizza would you like?".
After the user provides all of the pizza order information, Amazon Lex might return a response with a message to get user confirmation: "Order the pizza?".
After the user replies "Yes" to the confirmation prompt, Amazon Lex might return a conclusion statement: "Thank you, your cheese pizza has been ordered.".
Not all Amazon Lex messages require a response from the user. For example, conclusion statements do not require a
response. Some messages require only a yes or no response. In addition to the message, Amazon Lex
provides additional context about the message in the response that you can use to enhance client behavior, such
as displaying the appropriate client user interface. Consider the following examples:
If the message is to elicit slot data, Amazon Lex returns the following context information:
x-amz-lex-dialog-state header set to ElicitSlot
x-amz-lex-intent-name header set to the intent name in the current context
x-amz-lex-slot-to-elicit header set to the slot name for which the message is eliciting
information
x-amz-lex-slots header set to a map of slots configured for the intent with their current values
If the message is a confirmation prompt, the x-amz-lex-dialog-state header is set to
Confirmation and the x-amz-lex-slot-to-elicit header is omitted.
If the message is a clarification prompt configured for the intent, indicating that the user intent is not
understood, the x-amz-dialog-state header is set to ElicitIntent and the
x-amz-slot-to-elicit header is omitted.
In addition, Amazon Lex also returns your application-specific sessionAttributes. For more
information, see Managing Conversation
Context.
postContentRequest - sourcePath - Path to file containing data to send to the service. File will be read entirely and may be read
multiple times in the event of a retry. If the file does not exist or the current user does not have
access to read it then an exception will be thrown. The service documentation for the request content is
as follows '
User input in PCM or Opus audio format or text format as described in the Content-Type HTTP
header.
You can stream audio data to Amazon Lex or you can create a local buffer that captures all of the audio data before sending. In general, you get better performance if you stream audio data rather than buffering the data locally.
'destinationPath - Path to file that response contents will be written to. The file must not exist or this method
will throw an exception. If the file is not writable by the current user then an exception will be thrown.
The service documentation for the response content is as follows '
The prompt (or statement) to convey to the user. This is based on the bot configuration and context. For
example, if Amazon Lex did not understand the user intent, it sends the clarificationPrompt
configured for the bot. If the intent requires confirmation before taking the fulfillment action, it sends
the confirmationPrompt. Another example: Suppose that the Lambda function successfully
fulfilled the intent, and sent a message to convey to the user. Then Amazon Lex sends that message in the
response.
NotFoundException - The resource (such as the Amazon Lex bot or an alias) that is referred to is not found.BadRequestException - Request validation failed, there is no usable message in the context, or the bot build failed, is still
in progress, or contains unbuilt changes.LimitExceededException - Exceeded a limit.InternalFailureException - Internal service error. Retry the call.ConflictException - Two clients are using the same AWS account, Amazon Lex bot, and user ID.UnsupportedMediaTypeException - The Content-Type header (PostContent API) has an invalid value.NotAcceptableException - The accept header in the request does not have a valid value.RequestTimeoutException - The input speech is too long.DependencyFailedException - One of the dependencies, such as AWS Lambda or Amazon Polly, threw an exception. For example,
If Amazon Lex does not have sufficient permissions to call a Lambda function.
If a Lambda function takes longer than 30 seconds to execute.
If a fulfillment Lambda function returns a Delegate dialog action without removing any slot
values.
BadGatewayException - Either the Amazon Lex bot is still building, or one of the dependent services (Amazon Polly, AWS Lambda)
failed with an internal service error.LoopDetectedException - This exception is not used.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.LexRuntimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException#postContent(PostContentRequest, RequestBody),
#postContent(PostContentRequest, ResponseTransformer),
AWS API
Documentationdefault PostContentResponse postContent(Consumer<PostContentRequest.Builder> postContentRequest, Path sourcePath, Path destinationPath) throws NotFoundException, BadRequestException, LimitExceededException, InternalFailureException, ConflictException, UnsupportedMediaTypeException, NotAcceptableException, RequestTimeoutException, DependencyFailedException, BadGatewayException, LoopDetectedException, AwsServiceException, SdkClientException, LexRuntimeException
Sends user input (text or speech) to Amazon Lex. Clients use this API to send text and audio requests to Amazon Lex at runtime. Amazon Lex interprets the user input using the machine learning model that it built for the bot.
The PostContent operation supports audio input at 8kHz and 16kHz. You can use 8kHz audio to achieve
higher speech recognition accuracy in telephone audio applications.
In response, Amazon Lex returns the next message to convey to the user. Consider the following example messages:
For a user input "I would like a pizza," Amazon Lex might return a response with a message eliciting slot data
(for example, PizzaSize): "What size pizza would you like?".
After the user provides all of the pizza order information, Amazon Lex might return a response with a message to get user confirmation: "Order the pizza?".
After the user replies "Yes" to the confirmation prompt, Amazon Lex might return a conclusion statement: "Thank you, your cheese pizza has been ordered.".
Not all Amazon Lex messages require a response from the user. For example, conclusion statements do not require a
response. Some messages require only a yes or no response. In addition to the message, Amazon Lex
provides additional context about the message in the response that you can use to enhance client behavior, such
as displaying the appropriate client user interface. Consider the following examples:
If the message is to elicit slot data, Amazon Lex returns the following context information:
x-amz-lex-dialog-state header set to ElicitSlot
x-amz-lex-intent-name header set to the intent name in the current context
x-amz-lex-slot-to-elicit header set to the slot name for which the message is eliciting
information
x-amz-lex-slots header set to a map of slots configured for the intent with their current values
If the message is a confirmation prompt, the x-amz-lex-dialog-state header is set to
Confirmation and the x-amz-lex-slot-to-elicit header is omitted.
If the message is a clarification prompt configured for the intent, indicating that the user intent is not
understood, the x-amz-dialog-state header is set to ElicitIntent and the
x-amz-slot-to-elicit header is omitted.
In addition, Amazon Lex also returns your application-specific sessionAttributes. For more
information, see Managing Conversation
Context.
This is a convenience which creates an instance of the PostContentRequest.Builder avoiding the need to
create one manually via PostContentRequest.builder()
postContentRequest - A Consumer that will call methods on PostContentRequest.Builder to create a request.sourcePath - Path to file containing data to send to the service. File will be read entirely and may be read
multiple times in the event of a retry. If the file does not exist or the current user does not have
access to read it then an exception will be thrown. The service documentation for the request content is
as follows '
User input in PCM or Opus audio format or text format as described in the Content-Type HTTP
header.
You can stream audio data to Amazon Lex or you can create a local buffer that captures all of the audio data before sending. In general, you get better performance if you stream audio data rather than buffering the data locally.
'destinationPath - Path to file that response contents will be written to. The file must not exist or this method
will throw an exception. If the file is not writable by the current user then an exception will be thrown.
The service documentation for the response content is as follows '
The prompt (or statement) to convey to the user. This is based on the bot configuration and context. For
example, if Amazon Lex did not understand the user intent, it sends the clarificationPrompt
configured for the bot. If the intent requires confirmation before taking the fulfillment action, it sends
the confirmationPrompt. Another example: Suppose that the Lambda function successfully
fulfilled the intent, and sent a message to convey to the user. Then Amazon Lex sends that message in the
response.
NotFoundException - The resource (such as the Amazon Lex bot or an alias) that is referred to is not found.BadRequestException - Request validation failed, there is no usable message in the context, or the bot build failed, is still
in progress, or contains unbuilt changes.LimitExceededException - Exceeded a limit.InternalFailureException - Internal service error. Retry the call.ConflictException - Two clients are using the same AWS account, Amazon Lex bot, and user ID.UnsupportedMediaTypeException - The Content-Type header (PostContent API) has an invalid value.NotAcceptableException - The accept header in the request does not have a valid value.RequestTimeoutException - The input speech is too long.DependencyFailedException - One of the dependencies, such as AWS Lambda or Amazon Polly, threw an exception. For example,
If Amazon Lex does not have sufficient permissions to call a Lambda function.
If a Lambda function takes longer than 30 seconds to execute.
If a fulfillment Lambda function returns a Delegate dialog action without removing any slot
values.
BadGatewayException - Either the Amazon Lex bot is still building, or one of the dependent services (Amazon Polly, AWS Lambda)
failed with an internal service error.LoopDetectedException - This exception is not used.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.LexRuntimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException#postContent(PostContentRequest, RequestBody),
#postContent(PostContentRequest, ResponseTransformer),
AWS API
Documentationdefault PostTextResponse postText(PostTextRequest postTextRequest) throws NotFoundException, BadRequestException, LimitExceededException, InternalFailureException, ConflictException, DependencyFailedException, BadGatewayException, LoopDetectedException, AwsServiceException, SdkClientException, LexRuntimeException
Sends user input to Amazon Lex. Client applications can use this API to send requests to Amazon Lex at runtime. Amazon Lex then interprets the user input using the machine learning model it built for the bot.
In response, Amazon Lex returns the next message to convey to the user an optional
responseCard to display. Consider the following example messages:
For a user input "I would like a pizza", Amazon Lex might return a response with a message eliciting slot data (for example, PizzaSize): "What size pizza would you like?"
After the user provides all of the pizza order information, Amazon Lex might return a response with a message to obtain user confirmation "Proceed with the pizza order?".
After the user replies to a confirmation prompt with a "yes", Amazon Lex might return a conclusion statement: "Thank you, your cheese pizza has been ordered.".
Not all Amazon Lex messages require a user response. For example, a conclusion statement does not require a
response. Some messages require only a "yes" or "no" user response. In addition to the message,
Amazon Lex provides additional context about the message in the response that you might use to enhance client
behavior, for example, to display the appropriate client user interface. These are the slotToElicit,
dialogState, intentName, and slots fields in the response. Consider the
following examples:
If the message is to elicit slot data, Amazon Lex returns the following context information:
dialogState set to ElicitSlot
intentName set to the intent name in the current context
slotToElicit set to the slot name for which the message is eliciting information
slots set to a map of slots, configured for the intent, with currently known values
If the message is a confirmation prompt, the dialogState is set to ConfirmIntent and
SlotToElicit is set to null.
If the message is a clarification prompt (configured for the intent) that indicates that user intent is not
understood, the dialogState is set to ElicitIntent and slotToElicit is set to null.
In addition, Amazon Lex also returns your application-specific sessionAttributes. For more
information, see Managing Conversation
Context.
postTextRequest - NotFoundException - The resource (such as the Amazon Lex bot or an alias) that is referred to is not found.BadRequestException - Request validation failed, there is no usable message in the context, or the bot build failed, is still
in progress, or contains unbuilt changes.LimitExceededException - Exceeded a limit.InternalFailureException - Internal service error. Retry the call.ConflictException - Two clients are using the same AWS account, Amazon Lex bot, and user ID.DependencyFailedException - One of the dependencies, such as AWS Lambda or Amazon Polly, threw an exception. For example,
If Amazon Lex does not have sufficient permissions to call a Lambda function.
If a Lambda function takes longer than 30 seconds to execute.
If a fulfillment Lambda function returns a Delegate dialog action without removing any slot
values.
BadGatewayException - Either the Amazon Lex bot is still building, or one of the dependent services (Amazon Polly, AWS Lambda)
failed with an internal service error.LoopDetectedException - This exception is not used.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.LexRuntimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PostTextResponse postText(Consumer<PostTextRequest.Builder> postTextRequest) throws NotFoundException, BadRequestException, LimitExceededException, InternalFailureException, ConflictException, DependencyFailedException, BadGatewayException, LoopDetectedException, AwsServiceException, SdkClientException, LexRuntimeException
Sends user input to Amazon Lex. Client applications can use this API to send requests to Amazon Lex at runtime. Amazon Lex then interprets the user input using the machine learning model it built for the bot.
In response, Amazon Lex returns the next message to convey to the user an optional
responseCard to display. Consider the following example messages:
For a user input "I would like a pizza", Amazon Lex might return a response with a message eliciting slot data (for example, PizzaSize): "What size pizza would you like?"
After the user provides all of the pizza order information, Amazon Lex might return a response with a message to obtain user confirmation "Proceed with the pizza order?".
After the user replies to a confirmation prompt with a "yes", Amazon Lex might return a conclusion statement: "Thank you, your cheese pizza has been ordered.".
Not all Amazon Lex messages require a user response. For example, a conclusion statement does not require a
response. Some messages require only a "yes" or "no" user response. In addition to the message,
Amazon Lex provides additional context about the message in the response that you might use to enhance client
behavior, for example, to display the appropriate client user interface. These are the slotToElicit,
dialogState, intentName, and slots fields in the response. Consider the
following examples:
If the message is to elicit slot data, Amazon Lex returns the following context information:
dialogState set to ElicitSlot
intentName set to the intent name in the current context
slotToElicit set to the slot name for which the message is eliciting information
slots set to a map of slots, configured for the intent, with currently known values
If the message is a confirmation prompt, the dialogState is set to ConfirmIntent and
SlotToElicit is set to null.
If the message is a clarification prompt (configured for the intent) that indicates that user intent is not
understood, the dialogState is set to ElicitIntent and slotToElicit is set to null.
In addition, Amazon Lex also returns your application-specific sessionAttributes. For more
information, see Managing Conversation
Context.
This is a convenience which creates an instance of the PostTextRequest.Builder avoiding the need to
create one manually via PostTextRequest.builder()
postTextRequest - A Consumer that will call methods on PostTextRequest.Builder to create a request.NotFoundException - The resource (such as the Amazon Lex bot or an alias) that is referred to is not found.BadRequestException - Request validation failed, there is no usable message in the context, or the bot build failed, is still
in progress, or contains unbuilt changes.LimitExceededException - Exceeded a limit.InternalFailureException - Internal service error. Retry the call.ConflictException - Two clients are using the same AWS account, Amazon Lex bot, and user ID.DependencyFailedException - One of the dependencies, such as AWS Lambda or Amazon Polly, threw an exception. For example,
If Amazon Lex does not have sufficient permissions to call a Lambda function.
If a Lambda function takes longer than 30 seconds to execute.
If a fulfillment Lambda function returns a Delegate dialog action without removing any slot
values.
BadGatewayException - Either the Amazon Lex bot is still building, or one of the dependent services (Amazon Polly, AWS Lambda)
failed with an internal service error.LoopDetectedException - This exception is not used.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.LexRuntimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault <ReturnT> ReturnT putSession(PutSessionRequest putSessionRequest, ResponseTransformer<PutSessionResponse,ReturnT> responseTransformer) throws NotFoundException, BadRequestException, LimitExceededException, InternalFailureException, ConflictException, NotAcceptableException, DependencyFailedException, BadGatewayException, AwsServiceException, SdkClientException, LexRuntimeException
Creates a new session or modifies an existing session with an Amazon Lex bot. Use this operation to enable your application to set the state of the bot.
For more information, see Managing Sessions.
putSessionRequest - responseTransformer - Functional interface for processing the streamed response content. The unmarshalled PutSessionResponse and
an InputStream to the response content are provided as parameters to the callback. The callback may return
a transformed type which will be the return value of this method. See
ResponseTransformer for details on implementing this interface
and for links to pre-canned implementations for common scenarios like downloading to a file. The service
documentation for the response content is as follows '
The audio version of the message to convey to the user.
'.NotFoundException - The resource (such as the Amazon Lex bot or an alias) that is referred to is not found.BadRequestException - Request validation failed, there is no usable message in the context, or the bot build failed, is still
in progress, or contains unbuilt changes.LimitExceededException - Exceeded a limit.InternalFailureException - Internal service error. Retry the call.ConflictException - Two clients are using the same AWS account, Amazon Lex bot, and user ID.NotAcceptableException - The accept header in the request does not have a valid value.DependencyFailedException - One of the dependencies, such as AWS Lambda or Amazon Polly, threw an exception. For example,
If Amazon Lex does not have sufficient permissions to call a Lambda function.
If a Lambda function takes longer than 30 seconds to execute.
If a fulfillment Lambda function returns a Delegate dialog action without removing any slot
values.
BadGatewayException - Either the Amazon Lex bot is still building, or one of the dependent services (Amazon Polly, AWS Lambda)
failed with an internal service error.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.LexRuntimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault <ReturnT> ReturnT putSession(Consumer<PutSessionRequest.Builder> putSessionRequest, ResponseTransformer<PutSessionResponse,ReturnT> responseTransformer) throws NotFoundException, BadRequestException, LimitExceededException, InternalFailureException, ConflictException, NotAcceptableException, DependencyFailedException, BadGatewayException, AwsServiceException, SdkClientException, LexRuntimeException
Creates a new session or modifies an existing session with an Amazon Lex bot. Use this operation to enable your application to set the state of the bot.
For more information, see Managing Sessions.
This is a convenience which creates an instance of the PutSessionRequest.Builder avoiding the need to
create one manually via PutSessionRequest.builder()
putSessionRequest - A Consumer that will call methods on PutSessionRequest.Builder to create a request.responseTransformer - Functional interface for processing the streamed response content. The unmarshalled PutSessionResponse and
an InputStream to the response content are provided as parameters to the callback. The callback may return
a transformed type which will be the return value of this method. See
ResponseTransformer for details on implementing this interface
and for links to pre-canned implementations for common scenarios like downloading to a file. The service
documentation for the response content is as follows '
The audio version of the message to convey to the user.
'.NotFoundException - The resource (such as the Amazon Lex bot or an alias) that is referred to is not found.BadRequestException - Request validation failed, there is no usable message in the context, or the bot build failed, is still
in progress, or contains unbuilt changes.LimitExceededException - Exceeded a limit.InternalFailureException - Internal service error. Retry the call.ConflictException - Two clients are using the same AWS account, Amazon Lex bot, and user ID.NotAcceptableException - The accept header in the request does not have a valid value.DependencyFailedException - One of the dependencies, such as AWS Lambda or Amazon Polly, threw an exception. For example,
If Amazon Lex does not have sufficient permissions to call a Lambda function.
If a Lambda function takes longer than 30 seconds to execute.
If a fulfillment Lambda function returns a Delegate dialog action without removing any slot
values.
BadGatewayException - Either the Amazon Lex bot is still building, or one of the dependent services (Amazon Polly, AWS Lambda)
failed with an internal service error.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.LexRuntimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutSessionResponse putSession(PutSessionRequest putSessionRequest, Path destinationPath) throws NotFoundException, BadRequestException, LimitExceededException, InternalFailureException, ConflictException, NotAcceptableException, DependencyFailedException, BadGatewayException, AwsServiceException, SdkClientException, LexRuntimeException
Creates a new session or modifies an existing session with an Amazon Lex bot. Use this operation to enable your application to set the state of the bot.
For more information, see Managing Sessions.
putSessionRequest - destinationPath - Path to file that response contents will be written to. The file must not exist or this method
will throw an exception. If the file is not writable by the current user then an exception will be thrown.
The service documentation for the response content is as follows '
The audio version of the message to convey to the user.
'.NotFoundException - The resource (such as the Amazon Lex bot or an alias) that is referred to is not found.BadRequestException - Request validation failed, there is no usable message in the context, or the bot build failed, is still
in progress, or contains unbuilt changes.LimitExceededException - Exceeded a limit.InternalFailureException - Internal service error. Retry the call.ConflictException - Two clients are using the same AWS account, Amazon Lex bot, and user ID.NotAcceptableException - The accept header in the request does not have a valid value.DependencyFailedException - One of the dependencies, such as AWS Lambda or Amazon Polly, threw an exception. For example,
If Amazon Lex does not have sufficient permissions to call a Lambda function.
If a Lambda function takes longer than 30 seconds to execute.
If a fulfillment Lambda function returns a Delegate dialog action without removing any slot
values.
BadGatewayException - Either the Amazon Lex bot is still building, or one of the dependent services (Amazon Polly, AWS Lambda)
failed with an internal service error.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.LexRuntimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionputSession(PutSessionRequest, ResponseTransformer),
AWS API
Documentationdefault PutSessionResponse putSession(Consumer<PutSessionRequest.Builder> putSessionRequest, Path destinationPath) throws NotFoundException, BadRequestException, LimitExceededException, InternalFailureException, ConflictException, NotAcceptableException, DependencyFailedException, BadGatewayException, AwsServiceException, SdkClientException, LexRuntimeException
Creates a new session or modifies an existing session with an Amazon Lex bot. Use this operation to enable your application to set the state of the bot.
For more information, see Managing Sessions.
This is a convenience which creates an instance of the PutSessionRequest.Builder avoiding the need to
create one manually via PutSessionRequest.builder()
putSessionRequest - A Consumer that will call methods on PutSessionRequest.Builder to create a request.destinationPath - Path to file that response contents will be written to. The file must not exist or this method
will throw an exception. If the file is not writable by the current user then an exception will be thrown.
The service documentation for the response content is as follows '
The audio version of the message to convey to the user.
'.NotFoundException - The resource (such as the Amazon Lex bot or an alias) that is referred to is not found.BadRequestException - Request validation failed, there is no usable message in the context, or the bot build failed, is still
in progress, or contains unbuilt changes.LimitExceededException - Exceeded a limit.InternalFailureException - Internal service error. Retry the call.ConflictException - Two clients are using the same AWS account, Amazon Lex bot, and user ID.NotAcceptableException - The accept header in the request does not have a valid value.DependencyFailedException - One of the dependencies, such as AWS Lambda or Amazon Polly, threw an exception. For example,
If Amazon Lex does not have sufficient permissions to call a Lambda function.
If a Lambda function takes longer than 30 seconds to execute.
If a fulfillment Lambda function returns a Delegate dialog action without removing any slot
values.
BadGatewayException - Either the Amazon Lex bot is still building, or one of the dependent services (Amazon Polly, AWS Lambda)
failed with an internal service error.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.LexRuntimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionputSession(PutSessionRequest, ResponseTransformer),
AWS API
Documentationdefault ResponseInputStream<PutSessionResponse> putSession(PutSessionRequest putSessionRequest) throws NotFoundException, BadRequestException, LimitExceededException, InternalFailureException, ConflictException, NotAcceptableException, DependencyFailedException, BadGatewayException, AwsServiceException, SdkClientException, LexRuntimeException
Creates a new session or modifies an existing session with an Amazon Lex bot. Use this operation to enable your application to set the state of the bot.
For more information, see Managing Sessions.
putSessionRequest - ResponseInputStream containing data streamed from service. Note that this is an unmanaged
reference to the underlying HTTP connection so great care must be taken to ensure all data if fully read
from the input stream and that it is properly closed. Failure to do so may result in sub-optimal behavior
and exhausting connections in the connection pool. The unmarshalled response object can be obtained via
ResponseInputStream.response(). The service documentation for the response content is as follows
'
The audio version of the message to convey to the user.
'.NotFoundException - The resource (such as the Amazon Lex bot or an alias) that is referred to is not found.BadRequestException - Request validation failed, there is no usable message in the context, or the bot build failed, is still
in progress, or contains unbuilt changes.LimitExceededException - Exceeded a limit.InternalFailureException - Internal service error. Retry the call.ConflictException - Two clients are using the same AWS account, Amazon Lex bot, and user ID.NotAcceptableException - The accept header in the request does not have a valid value.DependencyFailedException - One of the dependencies, such as AWS Lambda or Amazon Polly, threw an exception. For example,
If Amazon Lex does not have sufficient permissions to call a Lambda function.
If a Lambda function takes longer than 30 seconds to execute.
If a fulfillment Lambda function returns a Delegate dialog action without removing any slot
values.
BadGatewayException - Either the Amazon Lex bot is still building, or one of the dependent services (Amazon Polly, AWS Lambda)
failed with an internal service error.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.LexRuntimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException#getObject(putSession, ResponseTransformer),
AWS API
Documentationdefault ResponseInputStream<PutSessionResponse> putSession(Consumer<PutSessionRequest.Builder> putSessionRequest) throws NotFoundException, BadRequestException, LimitExceededException, InternalFailureException, ConflictException, NotAcceptableException, DependencyFailedException, BadGatewayException, AwsServiceException, SdkClientException, LexRuntimeException
Creates a new session or modifies an existing session with an Amazon Lex bot. Use this operation to enable your application to set the state of the bot.
For more information, see Managing Sessions.
This is a convenience which creates an instance of the PutSessionRequest.Builder avoiding the need to
create one manually via PutSessionRequest.builder()
putSessionRequest - A Consumer that will call methods on PutSessionRequest.Builder to create a request.ResponseInputStream containing data streamed from service. Note that this is an unmanaged
reference to the underlying HTTP connection so great care must be taken to ensure all data if fully read
from the input stream and that it is properly closed. Failure to do so may result in sub-optimal behavior
and exhausting connections in the connection pool. The unmarshalled response object can be obtained via
ResponseInputStream.response(). The service documentation for the response content is as follows
'
The audio version of the message to convey to the user.
'.NotFoundException - The resource (such as the Amazon Lex bot or an alias) that is referred to is not found.BadRequestException - Request validation failed, there is no usable message in the context, or the bot build failed, is still
in progress, or contains unbuilt changes.LimitExceededException - Exceeded a limit.InternalFailureException - Internal service error. Retry the call.ConflictException - Two clients are using the same AWS account, Amazon Lex bot, and user ID.NotAcceptableException - The accept header in the request does not have a valid value.DependencyFailedException - One of the dependencies, such as AWS Lambda or Amazon Polly, threw an exception. For example,
If Amazon Lex does not have sufficient permissions to call a Lambda function.
If a Lambda function takes longer than 30 seconds to execute.
If a fulfillment Lambda function returns a Delegate dialog action without removing any slot
values.
BadGatewayException - Either the Amazon Lex bot is still building, or one of the dependent services (Amazon Polly, AWS Lambda)
failed with an internal service error.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.LexRuntimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException#getObject(putSession, ResponseTransformer),
AWS API
Documentationdefault ResponseBytes<PutSessionResponse> putSessionAsBytes(PutSessionRequest putSessionRequest) throws NotFoundException, BadRequestException, LimitExceededException, InternalFailureException, ConflictException, NotAcceptableException, DependencyFailedException, BadGatewayException, AwsServiceException, SdkClientException, LexRuntimeException
Creates a new session or modifies an existing session with an Amazon Lex bot. Use this operation to enable your application to set the state of the bot.
For more information, see Managing Sessions.
putSessionRequest - ResponseBytes that loads the data streamed from the service into memory and exposes it in
convenient in-memory representations like a byte buffer or string. The unmarshalled response object can
be obtained via ResponseBytes.response(). The service documentation for the response content is
as follows '
The audio version of the message to convey to the user.
'.NotFoundException - The resource (such as the Amazon Lex bot or an alias) that is referred to is not found.BadRequestException - Request validation failed, there is no usable message in the context, or the bot build failed, is still
in progress, or contains unbuilt changes.LimitExceededException - Exceeded a limit.InternalFailureException - Internal service error. Retry the call.ConflictException - Two clients are using the same AWS account, Amazon Lex bot, and user ID.NotAcceptableException - The accept header in the request does not have a valid value.DependencyFailedException - One of the dependencies, such as AWS Lambda or Amazon Polly, threw an exception. For example,
If Amazon Lex does not have sufficient permissions to call a Lambda function.
If a Lambda function takes longer than 30 seconds to execute.
If a fulfillment Lambda function returns a Delegate dialog action without removing any slot
values.
BadGatewayException - Either the Amazon Lex bot is still building, or one of the dependent services (Amazon Polly, AWS Lambda)
failed with an internal service error.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.LexRuntimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException#getObject(putSession, ResponseTransformer),
AWS API
Documentationdefault ResponseBytes<PutSessionResponse> putSessionAsBytes(Consumer<PutSessionRequest.Builder> putSessionRequest) throws NotFoundException, BadRequestException, LimitExceededException, InternalFailureException, ConflictException, NotAcceptableException, DependencyFailedException, BadGatewayException, AwsServiceException, SdkClientException, LexRuntimeException
Creates a new session or modifies an existing session with an Amazon Lex bot. Use this operation to enable your application to set the state of the bot.
For more information, see Managing Sessions.
This is a convenience which creates an instance of the PutSessionRequest.Builder avoiding the need to
create one manually via PutSessionRequest.builder()
putSessionRequest - A Consumer that will call methods on PutSessionRequest.Builder to create a request.ResponseBytes that loads the data streamed from the service into memory and exposes it in
convenient in-memory representations like a byte buffer or string. The unmarshalled response object can
be obtained via ResponseBytes.response(). The service documentation for the response content is
as follows '
The audio version of the message to convey to the user.
'.NotFoundException - The resource (such as the Amazon Lex bot or an alias) that is referred to is not found.BadRequestException - Request validation failed, there is no usable message in the context, or the bot build failed, is still
in progress, or contains unbuilt changes.LimitExceededException - Exceeded a limit.InternalFailureException - Internal service error. Retry the call.ConflictException - Two clients are using the same AWS account, Amazon Lex bot, and user ID.NotAcceptableException - The accept header in the request does not have a valid value.DependencyFailedException - One of the dependencies, such as AWS Lambda or Amazon Polly, threw an exception. For example,
If Amazon Lex does not have sufficient permissions to call a Lambda function.
If a Lambda function takes longer than 30 seconds to execute.
If a fulfillment Lambda function returns a Delegate dialog action without removing any slot
values.
BadGatewayException - Either the Amazon Lex bot is still building, or one of the dependent services (Amazon Polly, AWS Lambda)
failed with an internal service error.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.LexRuntimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException#getObject(putSession, ResponseTransformer),
AWS API
Documentationstatic LexRuntimeClient create()
LexRuntimeClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static LexRuntimeClientBuilder builder()
LexRuntimeClient.static ServiceMetadata serviceMetadata()
default LexRuntimeServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientCopyright © 2023. All rights reserved.