All Implemented Interfaces:

AmazonLexRuntimeV2

Direct Known Subclasses:

AmazonLexRuntimeV2AsyncClient

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

• Field Summary

  • Fields inherited from class com.amazonaws.AmazonWebServiceClient

    LOGGING_AWS_REQUEST_METRIC

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

    ENDPOINT_PREFIX

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  static AmazonLexRuntimeV2ClientBuilder	builder ()
  DeleteSessionResult	deleteSession (DeleteSessionRequest request) Removes session information for a specified bot, alias, and user ID.
  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.
  GetSessionResult	getSession (GetSessionRequest request) Returns session information for a specified bot, alias, and user.
  PutSessionResult	putSession (PutSessionRequest request) Creates a new session or modifies an existing session with an Amazon Lex V2 bot.
  RecognizeTextResult	recognizeText (RecognizeTextRequest request) Sends user input to Amazon Lex V2.
  RecognizeUtteranceResult	recognizeUtterance (RecognizeUtteranceRequest request) Sends user input to Amazon Lex V2.
  void	shutdown () Shuts down this client object, releasing any resources that might be held open.

  • Methods inherited from class com.amazonaws.AmazonWebServiceClient

    addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

  • Methods inherited from class java.lang.Object

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

• Method Detail

  • builder

    public static AmazonLexRuntimeV2ClientBuilder builder()

  • deleteSession

    public DeleteSessionResult deleteSession(DeleteSessionRequest request)

    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:

    deleteSession in interface AmazonLexRuntimeV2

    Parameters:

    deleteSessionRequest -

    Returns:

    Result of the DeleteSession operation returned by the service.

    Throws:

    AccessDeniedException

    ResourceNotFoundException

    ValidationException

    ThrottlingException

    InternalServerException

    ConflictException

    See Also:

    AWS API Documentation

  • getSession

    public GetSessionResult getSession(GetSessionRequest request)

    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:

    getSession in interface AmazonLexRuntimeV2

    Parameters:

    getSessionRequest -

    Returns:

    Result of the GetSession operation returned by the service.

    Throws:

    AccessDeniedException

    ResourceNotFoundException

    ValidationException

    ThrottlingException

    InternalServerException

    See Also:

    AWS API Documentation

  • putSession

    public PutSessionResult putSession(PutSessionRequest request)

    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:

    putSession in interface AmazonLexRuntimeV2

    Parameters:

    putSessionRequest -

    Returns:

    Result of the PutSession operation returned by the service.

    Throws:

    AccessDeniedException

    ResourceNotFoundException

    ValidationException

    ThrottlingException

    InternalServerException

    ConflictException

    DependencyFailedException

    BadGatewayException

    See Also:

    AWS API Documentation

  • recognizeText

    public RecognizeTextResult recognizeText(RecognizeTextRequest request)

    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:

    recognizeText in interface AmazonLexRuntimeV2

    Parameters:

    recognizeTextRequest -

    Returns:

    Result of the RecognizeText operation returned by the service.

    Throws:

    AccessDeniedException

    ResourceNotFoundException

    ValidationException

    ThrottlingException

    InternalServerException

    ConflictException

    DependencyFailedException

    BadGatewayException

    See Also:

    AWS API Documentation

  • recognizeUtterance

    public RecognizeUtteranceResult recognizeUtterance(RecognizeUtteranceRequest request)

    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:

    recognizeUtterance in interface AmazonLexRuntimeV2

    Parameters:

    recognizeUtteranceRequest -

    Returns:

    Result of the RecognizeUtterance operation returned by the service.

    Throws:

    AccessDeniedException

    ResourceNotFoundException

    ValidationException

    ThrottlingException

    InternalServerException

    ConflictException

    DependencyFailedException

    BadGatewayException

    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 AmazonLexRuntimeV2

    Parameters:

    request - The originally executed request

    Returns:

    The response metadata for the specified request, or null if none is available.

  • shutdown

    public void shutdown()

    Description copied from class: AmazonWebServiceClient
    Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

    Specified by:

    shutdown in interface AmazonLexRuntimeV2

    Overrides:

    shutdown in class AmazonWebServiceClient