SessionSpecification - Amazon Lex API Reference
ContentsSee Also

SessionSpecification

An object containing information about a specific session.

Contents

botAliasId

The identifier of the alias of the bot that the session was held with.

Type: String

Length Constraints: Fixed length of 10.

Pattern: ^(\bTSTALIASID\b|[0-9a-zA-Z]+)$

Required: No

botVersion

The version of the bot that the session was held with.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 5.

Pattern: ^[0-9]+$

Required: No

channel

The channel that is integrated with the bot that the session was held with.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 50.

Required: No

conversationDurationSeconds

The duration of the conversation in seconds. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.

Type: Long

Required: No

conversationEndState

The final state of the conversation. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.

Type: String

Valid Values: Success | Failure | Dropped

Required: No

conversationEndTime

The date and time when the conversation ended. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.

Type: Timestamp

Required: No

conversationStartTime

The date and time when the conversation began. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.

Type: Timestamp

Required: No

invokedIntentSamples

A list of objects containing the name of an intent that was invoked.

Type: Array of InvokedIntentSample objects

Required: No

localeId

The locale of the bot that the session was held with.

Type: String

Required: No

mode

The mode of the session. The possible values are as follows:

  • Speech – The session was spoken.

  • Text – The session was written.

  • DTMF – The session used a touch-tone keypad (Dual Tone Multi-Frequency).

  • MultiMode – The session used multiple modes.

Type: String

Valid Values: Speech | Text | DTMF | MultiMode

Required: No

numberOfTurns

The number of turns that the session took.

Type: Long

Required: No

originatingRequestId

The identifier of the first request in a session.

Type: String

Required: No

sessionId

The identifier of the session.

Type: String

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

Required: No

See Also

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