ConfigurationEvent - Amazon Lex

ConfigurationEvent

The initial event sent from the application to Amazon Lex V2 to configure the conversation, including session and request attributes and the response content type.

Contents

clientTimestampMillis

A timestamp set by the client of the date and time that the event was sent to Amazon Lex V2.

Type: Long

Required: No

disablePlayback

Determines whether Amazon Lex V2 should send audio responses to the client application.

Set this field to false when the client is operating in a playback mode where audio responses are played to the user. If the client isn't operating in playback mode, such as a text chat application, set this to true so that Amazon Lex V2 doesn't wait for the prompt to finish playing on the client.

Type: Boolean

Required: No

eventId

A unique identifier that your application assigns to the event. You can use this to identify events in logs.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 100.

Pattern: [0-9a-zA-Z._:-]+

Required: No

requestAttributes

Request-specific information passed between the client application and Amazon Lex V2.

The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes for prefix x-amz-lex:.

Type: String to string map

Key Length Constraints: Minimum length of 1.

Required: No

responseContentType

The message that Amazon Lex V2 returns in the response can be either text or speech based on the responseContentType value.

  • If the value is text/plain;charset=utf-8, Amazon Lex V2 returns text in the response.

  • If the value begins with audio/, Amazon Lex V2 returns speech in the response. Amazon Lex V2 uses Amazon Polly to generate the speech using the configuration that you specified in the requestContentType parameter. For example, if you specify audio/mpeg as the value, Amazon Lex V2 returns speech in the MPEG format.

  • If the value is audio/pcm, the speech returned is audio/pcm in 16-bit, little-endian format.

  • The following are the accepted values:

    • audio/mpeg

    • audio/ogg

    • audio/pcm

    • audio/* (defaults to mpeg)

    • text/plain; charset=utf-8

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

sessionState

The state of the user's session with Amazon Lex V2.

Type: SessionState object

Required: No

welcomeMessages

A list of messages to send to the user.

Type: Array of Message objects

Array Members: Maximum number of 10 items.

Required: No

See Also

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