Skip to content

Lexv2 Runtime Classes

AccessDeniedException

message

  • Type:
  • Required: Yes

ActiveContext

name

  • Type:
  • Required: Yes

timeToLive

  • Type:
  • Required: Yes

contextAttributes

  • Type: typing.Dict[str, str]
  • Required: Yes

ActiveContextOutput

name

  • Type:
  • Required: Yes

timeToLive

  • Type:
  • Required: Yes

contextAttributes

  • Type: typing.Dict[str, str]
  • Required: Yes

ActiveContextTimeToLive

timeToLiveInSeconds

  • Type:
  • Required: Yes

turnsToLive

  • Type:
  • Required: Yes

AudioInputEvent

contentType

  • Type:
  • Required: Yes

audioChunk

  • Type: typing.Union[str, bytes, typing.IO[typing.Any], botocore.response.StreamingBody, NoneType]

eventId

  • Type: typing.Optional[str]

clientTimestampMillis

  • Type: typing.Optional[int]

AudioResponseEvent

audioChunk

  • Type: typing.Optional[bytes]

contentType

  • Type: typing.Optional[str]

eventId

  • Type: typing.Optional[str]

BadGatewayException

message

  • Type:
  • Required: Yes

BaseValidatorModel

Oops! This Pydantic model is currently empty. Stay tuned!

Button

text

  • Type:
  • Required: Yes

value

  • Type:
  • Required: Yes

ConfidenceScore

score

  • Type: typing.Optional[float]

ConfigurationEvent

responseContentType

  • Type:
  • Required: Yes

requestAttributes

  • Type: typing.Optional[typing.Dict[str, str]]

sessionState

  • Type: typing.Union[aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.SessionState, aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.SessionStateOutput, NoneType]

welcomeMessages

  • Type: typing.Optional[typing.List[typing.Union[aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.Message, aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.MessageOutput]]]

disablePlayback

  • Type: typing.Optional[bool]

eventId

  • Type: typing.Optional[str]

clientTimestampMillis

  • Type: typing.Optional[int]

ConflictException

message

  • Type:
  • Required: Yes

DTMFInputEvent

inputCharacter

  • Type:
  • Required: Yes

eventId

  • Type: typing.Optional[str]

clientTimestampMillis

  • Type: typing.Optional[int]

DeleteSessionRequest

botId

  • Type:
  • Required: Yes

botAliasId

  • Type:
  • Required: Yes

localeId

  • Type:
  • Required: Yes

sessionId

  • Type:
  • Required: Yes

DeleteSessionResponse

botId

  • Type:
  • Required: Yes

botAliasId

  • Type:
  • Required: Yes

localeId

  • Type:
  • Required: Yes

sessionId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DependencyFailedException

message

  • Type:
  • Required: Yes

DialogAction

type

  • Type: typing.Literal['Close', 'ConfirmIntent', 'Delegate', 'ElicitIntent', 'ElicitSlot', 'None']
  • Required: Yes

slotToElicit

  • Type: typing.Optional[str]

slotElicitationStyle

  • Type: typing.Optional[typing.Literal['Default', 'SpellByLetter', 'SpellByWord']]

subSlotToElicit

  • Type: typing.Union[aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.ElicitSubSlot, aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.ElicitSubSlotOutput, NoneType]

DialogActionOutput

type

  • Type: typing.Literal['Close', 'ConfirmIntent', 'Delegate', 'ElicitIntent', 'ElicitSlot', 'None']
  • Required: Yes

slotToElicit

  • Type: typing.Optional[str]

slotElicitationStyle

  • Type: typing.Optional[typing.Literal['Default', 'SpellByLetter', 'SpellByWord']]

subSlotToElicit

  • Type: typing.Optional[aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.ElicitSubSlotOutput]

DisconnectionEvent

eventId

  • Type: typing.Optional[str]

clientTimestampMillis

  • Type: typing.Optional[int]

ElicitSubSlot

name

  • Type:
  • Required: Yes

subSlotToElicit

  • Type: typing.Optional[typing.Dict[str, typing.Any]]

ElicitSubSlotOutput

name

  • Type:
  • Required: Yes

subSlotToElicit

  • Type: typing.Optional[typing.Dict[str, typing.Any]]

GetSessionRequest

botId

  • Type:
  • Required: Yes

botAliasId

  • Type:
  • Required: Yes

localeId

  • Type:
  • Required: Yes

sessionId

  • Type:
  • Required: Yes

GetSessionResponse

sessionId

  • Type:
  • Required: Yes

messages

  • Type: typing.List[aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.MessageOutput]
  • Required: Yes

interpretations

  • Type: typing.List[aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.Interpretation]
  • Required: Yes

sessionState

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

HeartbeatEvent

eventId

  • Type: typing.Optional[str]

ImageResponseCard

title

  • Type:
  • Required: Yes

subtitle

  • Type: typing.Optional[str]

imageUrl

  • Type: typing.Optional[str]

buttons

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.Button]]

ImageResponseCardOutput

title

  • Type:
  • Required: Yes

subtitle

  • Type: typing.Optional[str]

imageUrl

  • Type: typing.Optional[str]

buttons

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.Button]]

Intent

name

  • Type:
  • Required: Yes

slots

  • Type: typing.Optional[typing.Dict[str, typing.Union[aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.Slot, aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.SlotOutput]]]

state

  • Type: typing.Optional[typing.Literal['Failed', 'Fulfilled', 'FulfillmentInProgress', 'InProgress', 'ReadyForFulfillment', 'Waiting']]

confirmationState

  • Type: typing.Optional[typing.Literal['Confirmed', 'Denied', 'None']]

IntentOutput

name

  • Type:
  • Required: Yes

slots

  • Type: typing.Optional[typing.Dict[str, aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.SlotOutput]]

state

  • Type: typing.Optional[typing.Literal['Failed', 'Fulfilled', 'FulfillmentInProgress', 'InProgress', 'ReadyForFulfillment', 'Waiting']]

confirmationState

  • Type: typing.Optional[typing.Literal['Confirmed', 'Denied', 'None']]

IntentResultEvent

inputMode

  • Type: typing.Optional[typing.Literal['DTMF', 'Speech', 'Text']]

interpretations

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.Interpretation]]

sessionState

  • Type: typing.Optional[aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.SessionStateOutput]

requestAttributes

  • Type: typing.Optional[typing.Dict[str, str]]

sessionId

  • Type: typing.Optional[str]

eventId

  • Type: typing.Optional[str]

recognizedBotMember

  • Type: typing.Optional[aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.RecognizedBotMember]

InternalServerException

message

  • Type:
  • Required: Yes

Interpretation

nluConfidence

  • Type: typing.Optional[aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.ConfidenceScore]

sentimentResponse

  • Type: typing.Optional[aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.SentimentResponse]

intent

  • Type: typing.Optional[aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.IntentOutput]

interpretationSource

  • Type: typing.Optional[typing.Literal['Bedrock', 'Lex']]

Message

contentType

  • Type: typing.Literal['CustomPayload', 'ImageResponseCard', 'PlainText', 'SSML']
  • Required: Yes

content

  • Type: typing.Optional[str]

imageResponseCard

  • Type: typing.Union[aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.ImageResponseCard, aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.ImageResponseCardOutput, NoneType]

MessageOutput

contentType

  • Type: typing.Literal['CustomPayload', 'ImageResponseCard', 'PlainText', 'SSML']
  • Required: Yes

content

  • Type: typing.Optional[str]

imageResponseCard

  • Type: typing.Optional[aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.ImageResponseCardOutput]

PlaybackCompletionEvent

eventId

  • Type: typing.Optional[str]

clientTimestampMillis

  • Type: typing.Optional[int]

PlaybackInterruptionEvent

eventReason

  • Type: typing.Optional[typing.Literal['DTMF_START_DETECTED', 'TEXT_DETECTED', 'VOICE_START_DETECTED']]

causedByEventId

  • Type: typing.Optional[str]

eventId

  • Type: typing.Optional[str]

PutSessionRequest

botId

  • Type:
  • Required: Yes

botAliasId

  • Type:
  • Required: Yes

localeId

  • Type:
  • Required: Yes

sessionId

  • Type:
  • Required: Yes

sessionState

  • Type: typing.Union[aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.SessionState, aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.SessionStateOutput]
  • Required: Yes

messages

  • Type: typing.Optional[typing.List[typing.Union[aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.Message, aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.MessageOutput]]]

requestAttributes

  • Type: typing.Optional[typing.Dict[str, str]]

responseContentType

  • Type: typing.Optional[str]

PutSessionResponse

contentType

  • Type:
  • Required: Yes

messages

  • Type:
  • Required: Yes

sessionState

  • Type:
  • Required: Yes

requestAttributes

  • Type:
  • Required: Yes

sessionId

  • Type:
  • Required: Yes

audioStream

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

RecognizeTextRequest

botId

  • Type:
  • Required: Yes

botAliasId

  • Type:
  • Required: Yes

localeId

  • Type:
  • Required: Yes

sessionId

  • Type:
  • Required: Yes

text

  • Type:
  • Required: Yes

sessionState

  • Type: typing.Union[aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.SessionState, aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.SessionStateOutput, NoneType]

requestAttributes

  • Type: typing.Optional[typing.Dict[str, str]]

RecognizeTextResponse

messages

  • Type: typing.List[aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.MessageOutput]
  • Required: Yes

sessionState

  • Type:
  • Required: Yes

interpretations

  • Type: typing.List[aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.Interpretation]
  • Required: Yes

requestAttributes

  • Type: typing.Dict[str, str]
  • Required: Yes

sessionId

  • Type:
  • Required: Yes

recognizedBotMember

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

RecognizeUtteranceRequest

botId

  • Type:
  • Required: Yes

botAliasId

  • Type:
  • Required: Yes

localeId

  • Type:
  • Required: Yes

sessionId

  • Type:
  • Required: Yes

requestContentType

  • Type:
  • Required: Yes

sessionState

  • Type: typing.Optional[str]

requestAttributes

  • Type: typing.Optional[str]

responseContentType

  • Type: typing.Optional[str]

inputStream

  • Type: typing.Union[str, bytes, typing.IO[typing.Any], botocore.response.StreamingBody, NoneType]

RecognizeUtteranceResponse

inputMode

  • Type:
  • Required: Yes

contentType

  • Type:
  • Required: Yes

messages

  • Type:
  • Required: Yes

interpretations

  • Type:
  • Required: Yes

sessionState

  • Type:
  • Required: Yes

requestAttributes

  • Type:
  • Required: Yes

sessionId

  • Type:
  • Required: Yes

inputTranscript

  • Type:
  • Required: Yes

audioStream

  • Type:
  • Required: Yes

recognizedBotMember

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

RecognizedBotMember

botId

  • Type:
  • Required: Yes

botName

  • Type: typing.Optional[str]

ResourceNotFoundException

message

  • Type:
  • Required: Yes

ResponseMetadata

RequestId

  • Type:
  • Required: Yes

HTTPStatusCode

  • Type:
  • Required: Yes

HTTPHeaders

  • Type: typing.Dict[str, str]
  • Required: Yes

RetryAttempts

  • Type:
  • Required: Yes

HostId

  • Type: typing.Optional[str]

RuntimeHintDetails

runtimeHintValues

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.RuntimeHintValue]]

subSlotHints

  • Type: typing.Optional[typing.Dict[str, typing.Dict[str, typing.Any]]]

RuntimeHintDetailsOutput

runtimeHintValues

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.RuntimeHintValue]]

subSlotHints

  • Type: typing.Optional[typing.Dict[str, typing.Dict[str, typing.Any]]]

RuntimeHintValue

phrase

  • Type:
  • Required: Yes

RuntimeHints

slotHints

  • Type: typing.Optional[typing.Dict[str, typing.Dict[str, typing.Union[aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.RuntimeHintDetails, aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.RuntimeHintDetailsOutput]]]]

RuntimeHintsOutput

slotHints

  • Type: typing.Optional[typing.Dict[str, typing.Dict[str, aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.RuntimeHintDetailsOutput]]]

SentimentResponse

sentiment

  • Type: typing.Optional[typing.Literal['MIXED', 'NEGATIVE', 'NEUTRAL', 'POSITIVE']]

sentimentScore

  • Type: typing.Optional[aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.SentimentScore]

SentimentScore

positive

  • Type: typing.Optional[float]

negative

  • Type: typing.Optional[float]

neutral

  • Type: typing.Optional[float]

mixed

  • Type: typing.Optional[float]

SessionState

dialogAction

  • Type: typing.Union[aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.DialogAction, aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.DialogActionOutput, NoneType]

intent

  • Type: typing.Union[aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.Intent, aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.IntentOutput, NoneType]

activeContexts

  • Type: typing.Optional[typing.List[typing.Union[aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.ActiveContext, aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.ActiveContextOutput]]]

sessionAttributes

  • Type: typing.Optional[typing.Dict[str, str]]

originatingRequestId

  • Type: typing.Optional[str]

runtimeHints

  • Type: typing.Union[aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.RuntimeHints, aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.RuntimeHintsOutput, NoneType]

SessionStateOutput

dialogAction

  • Type: typing.Optional[aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.DialogActionOutput]

intent

  • Type: typing.Optional[aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.IntentOutput]

activeContexts

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.ActiveContextOutput]]

sessionAttributes

  • Type: typing.Optional[typing.Dict[str, str]]

originatingRequestId

  • Type: typing.Optional[str]

runtimeHints

  • Type: typing.Optional[aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.RuntimeHintsOutput]

Slot

value

  • Type: typing.Union[aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.Value, aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.ValueOutput, NoneType]

shape

  • Type: typing.Optional[typing.Literal['Composite', 'List', 'Scalar']]

values

  • Type: typing.Optional[typing.List[typing.Dict[str, typing.Any]]]

subSlots

  • Type: typing.Optional[typing.Dict[str, typing.Dict[str, typing.Any]]]

SlotOutput

value

  • Type: typing.Optional[aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.ValueOutput]

shape

  • Type: typing.Optional[typing.Literal['Composite', 'List', 'Scalar']]

values

  • Type: typing.Optional[typing.List[typing.Dict[str, typing.Any]]]

subSlots

  • Type: typing.Optional[typing.Dict[str, typing.Dict[str, typing.Any]]]

StartConversationRequest

botId

  • Type:
  • Required: Yes

botAliasId

  • Type:
  • Required: Yes

localeId

  • Type:
  • Required: Yes

sessionId

  • Type:
  • Required: Yes

requestEventStream

  • Type: aws_resource_validator.pydantic_models.base_validator_model.EventStream[aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.StartConversationRequestEventStream]
  • Required: Yes

conversationMode

  • Type: typing.Optional[typing.Literal['AUDIO', 'TEXT']]

StartConversationRequestEventStream

ConfigurationEvent

  • Type:

AudioInputEvent

  • Type:

DTMFInputEvent

  • Type:

TextInputEvent

  • Type:

PlaybackCompletionEvent

  • Type:

DisconnectionEvent

  • Type:

StartConversationResponse

responseEventStream

  • Type: aws_resource_validator.pydantic_models.base_validator_model.EventStream[aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.StartConversationResponseEventStream]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

StartConversationResponseEventStream

PlaybackInterruptionEvent

  • Type:

TranscriptEvent

  • Type:

IntentResultEvent

  • Type:

TextResponseEvent

  • Type:

AudioResponseEvent

  • Type:

HeartbeatEvent

  • Type:

AccessDeniedException

  • Type:

ResourceNotFoundException

  • Type:

ValidationException

  • Type:

ThrottlingException

  • Type:

InternalServerException

  • Type:

ConflictException

  • Type:

DependencyFailedException

  • Type:

BadGatewayException

  • Type:

TextInputEvent

text

  • Type:
  • Required: Yes

eventId

  • Type: typing.Optional[str]

clientTimestampMillis

  • Type: typing.Optional[int]

TextResponseEvent

messages

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.lexv2_runtime.lexv2_runtime_classes.MessageOutput]]

eventId

  • Type: typing.Optional[str]

ThrottlingException

message

  • Type:
  • Required: Yes

TranscriptEvent

transcript

  • Type: typing.Optional[str]

eventId

  • Type: typing.Optional[str]

ValidationException

message

  • Type:
  • Required: Yes

Value

interpretedValue

  • Type:
  • Required: Yes

originalValue

  • Type: typing.Optional[str]

resolvedValues

  • Type: typing.Optional[typing.List[str]]

ValueOutput

interpretedValue

  • Type:
  • Required: Yes

originalValue

  • Type: typing.Optional[str]

resolvedValues

  • Type: typing.Optional[typing.List[str]]