StartConversationResponseEventStream - Amazon Lex

StartConversationResponseEventStream

Represents a stream of events between Amazon Lex V2 and your application.

Contents

AccessDeniedException

Exception thrown when the credentials passed with the request are invalid or expired. Also thrown when the credentials in the request do not have permission to access the StartConversation operation.

Type: Exception

HTTP Status Code: 403

Required: No

AudioResponseEvent

An event sent from Amazon Lex V2 to your client application containing audio to play to the user.

Type: AudioResponseEvent object

Required: No

BadGatewayException

Type: Exception

HTTP Status Code: 502

Required: No

ConflictException

Exception thrown when two clients are using the same AWS account, Amazon Lex V2 bot, and session ID.

Type: Exception

HTTP Status Code: 409

Required: No

DependencyFailedException

Type: Exception

HTTP Status Code: 424

Required: No

HeartbeatEvent

Event that Amazon Lex V2 sends to indicate that the stream is still open between the client application and Amazon Lex V2

Type: HeartbeatEvent object

Required: No

IntentResultEvent

Event sent from Amazon Lex V2 to the client application containing the current state of the conversation between the user and Amazon Lex V2.

Type: IntentResultEvent object

Required: No

InternalServerException

An error occurred with Amazon Lex V2.

Type: Exception

HTTP Status Code: 500

Required: No

PlaybackInterruptionEvent

Event sent from Amazon Lex V2 to indicate to the client application should stop playback of audio. For example, if the client is playing a prompt that asks for the user's telephone number, the user might start to say the phone number before the prompt is complete. Amazon Lex V2 sends this event to the client application to indicate that the user is responding and that Amazon Lex V2 is processing their input.

Type: PlaybackInterruptionEvent object

Required: No

ResourceNotFoundException

Exception thrown if one of the input parameters points to a resource that does not exist. For example, if the bot ID specified does not exist.

Type: Exception

HTTP Status Code: 404

Required: No

TextResponseEvent

The event sent from Amazon Lex V2 to your application with text to present to the user.

Type: TextResponseEvent object

Required: No

ThrottlingException

Exception thrown when your application exceeds the maximum number of concurrent requests.

Type: Exception

HTTP Status Code: 429

Required: No

TranscriptEvent

Event sent from Amazon Lex V2 to your client application that contains a transcript of voice audio.

Type: TranscriptEvent object

Required: No

ValidationException

Exception thrown when one or more parameters could not be validated. The message contains the name of the field that isn't valid.

Type: Exception

HTTP Status Code: 400

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: