com.amazonaws.services.lexruntimev2

Class AmazonLexRuntimeV2AsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.lexruntimev2.AmazonLexRuntimeV2Client

com.amazonaws.services.lexruntimev2.AmazonLexRuntimeV2AsyncClient

All Implemented Interfaces:

AmazonLexRuntimeV2, AmazonLexRuntimeV2Async

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonLexRuntimeV2AsyncClient
extends AmazonLexRuntimeV2Client
implements AmazonLexRuntimeV2Async

Client for accessing Lex Runtime V2 asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

This section contains documentation for the Amazon Lex V2 Runtime V2 API operations.

Field Summary

Fields inherited from class com.amazonaws.services.lexruntimev2.AmazonLexRuntimeV2Client

configFactory

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Fields inherited from interface com.amazonaws.services.lexruntimev2.AmazonLexRuntimeV2

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonLexRuntimeV2AsyncClientBuilder	asyncBuilder()
Future<DeleteSessionResult>	deleteSessionAsync(DeleteSessionRequest request) Removes session information for a specified bot, alias, and user ID.
Future<DeleteSessionResult>	deleteSessionAsync(DeleteSessionRequest request, AsyncHandler<DeleteSessionRequest,DeleteSessionResult> asyncHandler) Removes session information for a specified bot, alias, and user ID.
ExecutorService	getExecutorService() Returns the executor service used by this client to execute async requests.
Future<GetSessionResult>	getSessionAsync(GetSessionRequest request) Returns session information for a specified bot, alias, and user.
Future<GetSessionResult>	getSessionAsync(GetSessionRequest request, AsyncHandler<GetSessionRequest,GetSessionResult> asyncHandler) Returns session information for a specified bot, alias, and user.
Future<PutSessionResult>	putSessionAsync(PutSessionRequest request) Creates a new session or modifies an existing session with an Amazon Lex V2 bot.
Future<PutSessionResult>	putSessionAsync(PutSessionRequest request, AsyncHandler<PutSessionRequest,PutSessionResult> asyncHandler) Creates a new session or modifies an existing session with an Amazon Lex V2 bot.
Future<RecognizeTextResult>	recognizeTextAsync(RecognizeTextRequest request) Sends user input to Amazon Lex V2.
Future<RecognizeTextResult>	recognizeTextAsync(RecognizeTextRequest request, AsyncHandler<RecognizeTextRequest,RecognizeTextResult> asyncHandler) Sends user input to Amazon Lex V2.
Future<RecognizeUtteranceResult>	recognizeUtteranceAsync(RecognizeUtteranceRequest request) Sends user input to Amazon Lex V2.
Future<RecognizeUtteranceResult>	recognizeUtteranceAsync(RecognizeUtteranceRequest request, AsyncHandler<RecognizeUtteranceRequest,RecognizeUtteranceResult> asyncHandler) Sends user input to Amazon Lex V2.
void	shutdown() Shuts down the client, releasing all managed resources.

Methods inherited from class com.amazonaws.services.lexruntimev2.AmazonLexRuntimeV2Client

builder, deleteSession, getCachedResponseMetadata, getSession, putSession, recognizeText, recognizeUtterance

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.lexruntimev2.AmazonLexRuntimeV2

deleteSession, getCachedResponseMetadata, getSession, putSession, recognizeText, recognizeUtterance

Method Detail

asyncBuilder

public static AmazonLexRuntimeV2AsyncClientBuilder asyncBuilder()

getExecutorService

public ExecutorService getExecutorService()

Returns the executor service used by this client to execute async requests.

Returns:

The executor service used by this client to execute async requests.

deleteSessionAsync

public Future<DeleteSessionResult> deleteSessionAsync(DeleteSessionRequest request)

Description copied from interface: AmazonLexRuntimeV2Async

Removes session information for a specified bot, alias, and user ID.

You can use this operation to restart a conversation with a bot. When you remove a session, the entire history of the session is removed so that you can start again.

You don't need to delete a session. Sessions have a time limit and will expire. Set the session time limit when you create the bot. The default is 5 minutes, but you can specify anything between 1 minute and 24 hours.

If you specify a bot or alias ID that doesn't exist, you receive a BadRequestException.

If the locale doesn't exist in the bot, or if the locale hasn't been enables for the alias, you receive a BadRequestException.

Specified by:

deleteSessionAsync in interface AmazonLexRuntimeV2Async

Returns:

A Java Future containing the result of the DeleteSession operation returned by the service.

See Also:

AWS API Documentation

deleteSessionAsync

public Future<DeleteSessionResult> deleteSessionAsync(DeleteSessionRequest request,
                                                      AsyncHandler<DeleteSessionRequest,DeleteSessionResult> asyncHandler)

Description copied from interface: AmazonLexRuntimeV2Async

Removes session information for a specified bot, alias, and user ID.

You can use this operation to restart a conversation with a bot. When you remove a session, the entire history of the session is removed so that you can start again.

You don't need to delete a session. Sessions have a time limit and will expire. Set the session time limit when you create the bot. The default is 5 minutes, but you can specify anything between 1 minute and 24 hours.

If you specify a bot or alias ID that doesn't exist, you receive a BadRequestException.

If the locale doesn't exist in the bot, or if the locale hasn't been enables for the alias, you receive a BadRequestException.

Specified by:

deleteSessionAsync in interface AmazonLexRuntimeV2Async

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DeleteSession operation returned by the service.

See Also:

AWS API Documentation

getSessionAsync

public Future<GetSessionResult> getSessionAsync(GetSessionRequest request)

Description copied from interface: AmazonLexRuntimeV2Async

Returns session information for a specified bot, alias, and user.

For example, you can use this operation to retrieve session information for a user that has left a long-running session in use.

If the bot, alias, or session identifier doesn't exist, Amazon Lex V2 returns a BadRequestException. If the locale doesn't exist or is not enabled for the alias, you receive a BadRequestException.

Specified by:

getSessionAsync in interface AmazonLexRuntimeV2Async

Returns:

A Java Future containing the result of the GetSession operation returned by the service.

See Also:

AWS API Documentation

getSessionAsync

public Future<GetSessionResult> getSessionAsync(GetSessionRequest request,
                                                AsyncHandler<GetSessionRequest,GetSessionResult> asyncHandler)

Description copied from interface: AmazonLexRuntimeV2Async

Returns session information for a specified bot, alias, and user.

For example, you can use this operation to retrieve session information for a user that has left a long-running session in use.

If the bot, alias, or session identifier doesn't exist, Amazon Lex V2 returns a BadRequestException. If the locale doesn't exist or is not enabled for the alias, you receive a BadRequestException.

Specified by:

getSessionAsync in interface AmazonLexRuntimeV2Async

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the GetSession operation returned by the service.

See Also:

AWS API Documentation

putSessionAsync

public Future<PutSessionResult> putSessionAsync(PutSessionRequest request)

Description copied from interface: AmazonLexRuntimeV2Async

Creates a new session or modifies an existing session with an Amazon Lex V2 bot. Use this operation to enable your application to set the state of the bot.

Specified by:

putSessionAsync in interface AmazonLexRuntimeV2Async

Returns:

A Java Future containing the result of the PutSession operation returned by the service.

See Also:

AWS API Documentation

putSessionAsync

public Future<PutSessionResult> putSessionAsync(PutSessionRequest request,
                                                AsyncHandler<PutSessionRequest,PutSessionResult> asyncHandler)

Description copied from interface: AmazonLexRuntimeV2Async

Creates a new session or modifies an existing session with an Amazon Lex V2 bot. Use this operation to enable your application to set the state of the bot.

Specified by:

putSessionAsync in interface AmazonLexRuntimeV2Async

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the PutSession operation returned by the service.

See Also:

AWS API Documentation

recognizeTextAsync

public Future<RecognizeTextResult> recognizeTextAsync(RecognizeTextRequest request)

Description copied from interface: AmazonLexRuntimeV2Async

Sends user input to Amazon Lex V2. Client applications use this API to send requests to Amazon Lex V2 at runtime. Amazon Lex V2 then interprets the user input using the machine learning model that it build for the bot.

In response, Amazon Lex V2 returns the next message to convey to the user and an optional response card to display.

If the optional post-fulfillment response is specified, the messages are returned as follows. For more information, see PostFulfillmentStatusSpecification.

• Success message - Returned if the Lambda function completes successfully and the intent state is fulfilled or ready fulfillment if the message is present.

• Failed message - The failed message is returned if the Lambda function throws an exception or if the Lambda function returns a failed intent state without a message.

• Timeout message - If you don't configure a timeout message and a timeout, and the Lambda function doesn't return within 30 seconds, the timeout message is returned. If you configure a timeout, the timeout message is returned when the period times out.

For more information, see Completion message.

Specified by:

recognizeTextAsync in interface AmazonLexRuntimeV2Async

Returns:

A Java Future containing the result of the RecognizeText operation returned by the service.

See Also:

AWS API Documentation

recognizeTextAsync

public Future<RecognizeTextResult> recognizeTextAsync(RecognizeTextRequest request,
                                                      AsyncHandler<RecognizeTextRequest,RecognizeTextResult> asyncHandler)

Description copied from interface: AmazonLexRuntimeV2Async

Sends user input to Amazon Lex V2. Client applications use this API to send requests to Amazon Lex V2 at runtime. Amazon Lex V2 then interprets the user input using the machine learning model that it build for the bot.

In response, Amazon Lex V2 returns the next message to convey to the user and an optional response card to display.

If the optional post-fulfillment response is specified, the messages are returned as follows. For more information, see PostFulfillmentStatusSpecification.

• Success message - Returned if the Lambda function completes successfully and the intent state is fulfilled or ready fulfillment if the message is present.

• Failed message - The failed message is returned if the Lambda function throws an exception or if the Lambda function returns a failed intent state without a message.

• Timeout message - If you don't configure a timeout message and a timeout, and the Lambda function doesn't return within 30 seconds, the timeout message is returned. If you configure a timeout, the timeout message is returned when the period times out.

For more information, see Completion message.

Specified by:

recognizeTextAsync in interface AmazonLexRuntimeV2Async

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the RecognizeText operation returned by the service.

See Also:

AWS API Documentation

recognizeUtteranceAsync

public Future<RecognizeUtteranceResult> recognizeUtteranceAsync(RecognizeUtteranceRequest request)

Description copied from interface: AmazonLexRuntimeV2Async

Sends user input to Amazon Lex V2. You can send text or speech. Clients use this API to send text and audio requests to Amazon Lex V2 at runtime. Amazon Lex V2 interprets the user input using the machine learning model built for the bot.

The following request fields must be compressed with gzip and then base64 encoded before you send them to Amazon Lex V2.

• requestAttributes

• sessionState

The following response fields are compressed using gzip and then base64 encoded by Amazon Lex V2. Before you can use these fields, you must decode and decompress them.

• inputTranscript

• interpretations

• messages

• requestAttributes

• sessionState

The example contains a Java application that compresses and encodes a Java object to send to Amazon Lex V2, and a second that decodes and decompresses a response from Amazon Lex V2.

If the optional post-fulfillment response is specified, the messages are returned as follows. For more information, see PostFulfillmentStatusSpecification.

• Success message - Returned if the Lambda function completes successfully and the intent state is fulfilled or ready fulfillment if the message is present.

• Failed message - The failed message is returned if the Lambda function throws an exception or if the Lambda function returns a failed intent state without a message.

• Timeout message - If you don't configure a timeout message and a timeout, and the Lambda function doesn't return within 30 seconds, the timeout message is returned. If you configure a timeout, the timeout message is returned when the period times out.

For more information, see Completion message.

Specified by:

recognizeUtteranceAsync in interface AmazonLexRuntimeV2Async

Returns:

A Java Future containing the result of the RecognizeUtterance operation returned by the service.

See Also:

AWS API Documentation

recognizeUtteranceAsync

public Future<RecognizeUtteranceResult> recognizeUtteranceAsync(RecognizeUtteranceRequest request,
                                                                AsyncHandler<RecognizeUtteranceRequest,RecognizeUtteranceResult> asyncHandler)

Description copied from interface: AmazonLexRuntimeV2Async

Sends user input to Amazon Lex V2. You can send text or speech. Clients use this API to send text and audio requests to Amazon Lex V2 at runtime. Amazon Lex V2 interprets the user input using the machine learning model built for the bot.

The following request fields must be compressed with gzip and then base64 encoded before you send them to Amazon Lex V2.

• requestAttributes

• sessionState

The following response fields are compressed using gzip and then base64 encoded by Amazon Lex V2. Before you can use these fields, you must decode and decompress them.

• inputTranscript

• interpretations

• messages

• requestAttributes

• sessionState

The example contains a Java application that compresses and encodes a Java object to send to Amazon Lex V2, and a second that decodes and decompresses a response from Amazon Lex V2.

If the optional post-fulfillment response is specified, the messages are returned as follows. For more information, see PostFulfillmentStatusSpecification.

• Success message - Returned if the Lambda function completes successfully and the intent state is fulfilled or ready fulfillment if the message is present.

• Failed message - The failed message is returned if the Lambda function throws an exception or if the Lambda function returns a failed intent state without a message.

• Timeout message - If you don't configure a timeout message and a timeout, and the Lambda function doesn't return within 30 seconds, the timeout message is returned. If you configure a timeout, the timeout message is returned when the period times out.

For more information, see Completion message.

Specified by:

recognizeUtteranceAsync in interface AmazonLexRuntimeV2Async

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the RecognizeUtterance operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.

Specified by:

shutdown in interface AmazonLexRuntimeV2

Overrides:

shutdown in class AmazonLexRuntimeV2Client