Skip to content

Lex Runtime Classes

ActiveContext

name

  • Type:
  • Required: Yes

timeToLive

  • Type:
  • Required: Yes

parameters

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

ActiveContextOutput

name

  • Type:
  • Required: Yes

timeToLive

  • Type:
  • Required: Yes

parameters

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

ActiveContextTimeToLive

timeToLiveInSeconds

  • Type: typing.Optional[int]

turnsToLive

  • Type: typing.Optional[int]

BaseValidatorModel

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

Button

text

  • Type:
  • Required: Yes

value

  • Type:
  • Required: Yes

DeleteSessionRequest

botName

  • Type:
  • Required: Yes

botAlias

  • Type:
  • Required: Yes

userId

  • Type:
  • Required: Yes

DeleteSessionResponse

botName

  • Type:
  • Required: Yes

botAlias

  • Type:
  • Required: Yes

userId

  • Type:
  • Required: Yes

sessionId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DialogAction

type

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

intentName

  • Type: typing.Optional[str]

slots

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

slotToElicit

  • Type: typing.Optional[str]

fulfillmentState

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

message

  • Type: typing.Optional[str]

messageFormat

  • Type: typing.Optional[typing.Literal['Composite', 'CustomPayload', 'PlainText', 'SSML']]

DialogActionOutput

type

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

intentName

  • Type: typing.Optional[str]

slots

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

slotToElicit

  • Type: typing.Optional[str]

fulfillmentState

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

message

  • Type: typing.Optional[str]

messageFormat

  • Type: typing.Optional[typing.Literal['Composite', 'CustomPayload', 'PlainText', 'SSML']]

GenericAttachment

title

  • Type: typing.Optional[str]

subTitle

  • Type: typing.Optional[str]

attachmentLinkUrl

  • Type: typing.Optional[str]

imageUrl

  • Type: typing.Optional[str]

buttons

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.lex_runtime.lex_runtime_classes.Button]]

GetSessionRequest

botName

  • Type:
  • Required: Yes

botAlias

  • Type:
  • Required: Yes

userId

  • Type:
  • Required: Yes

checkpointLabelFilter

  • Type: typing.Optional[str]

GetSessionResponse

recentIntentSummaryView

  • Type: typing.List[aws_resource_validator.pydantic_models.lex_runtime.lex_runtime_classes.IntentSummaryOutput]
  • Required: Yes

sessionAttributes

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

sessionId

  • Type:
  • Required: Yes

dialogAction

  • Type:
  • Required: Yes

activeContexts

  • Type: typing.List[aws_resource_validator.pydantic_models.lex_runtime.lex_runtime_classes.ActiveContextOutput]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

IntentConfidence

score

  • Type: typing.Optional[float]

IntentSummary

dialogActionType

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

intentName

  • Type: typing.Optional[str]

checkpointLabel

  • Type: typing.Optional[str]

slots

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

confirmationStatus

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

fulfillmentState

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

slotToElicit

  • Type: typing.Optional[str]

IntentSummaryOutput

dialogActionType

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

intentName

  • Type: typing.Optional[str]

checkpointLabel

  • Type: typing.Optional[str]

slots

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

confirmationStatus

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

fulfillmentState

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

slotToElicit

  • Type: typing.Optional[str]

PostContentRequest

botName

  • Type:
  • Required: Yes

botAlias

  • Type:
  • Required: Yes

userId

  • Type:
  • Required: Yes

contentType

  • Type:
  • Required: Yes

inputStream

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

sessionAttributes

  • Type: typing.Optional[str]

requestAttributes

  • Type: typing.Optional[str]

accept

  • Type: typing.Optional[str]

activeContexts

  • Type: typing.Optional[str]

PostContentResponse

contentType

  • Type:
  • Required: Yes

intentName

  • Type:
  • Required: Yes

nluIntentConfidence

  • Type:
  • Required: Yes

alternativeIntents

  • Type:
  • Required: Yes

slots

  • Type:
  • Required: Yes

sessionAttributes

  • Type:
  • Required: Yes

sentimentResponse

  • Type:
  • Required: Yes

message

  • Type:
  • Required: Yes

encodedMessage

  • Type:
  • Required: Yes

messageFormat

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

dialogState

  • Type: typing.Literal['ConfirmIntent', 'ElicitIntent', 'ElicitSlot', 'Failed', 'Fulfilled', 'ReadyForFulfillment']
  • Required: Yes

slotToElicit

  • Type:
  • Required: Yes

inputTranscript

  • Type:
  • Required: Yes

encodedInputTranscript

  • Type:
  • Required: Yes

audioStream

  • Type:
  • Required: Yes

botVersion

  • Type:
  • Required: Yes

sessionId

  • Type:
  • Required: Yes

activeContexts

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

PostTextRequest

botName

  • Type:
  • Required: Yes

botAlias

  • Type:
  • Required: Yes

userId

  • Type:
  • Required: Yes

inputText

  • Type:
  • Required: Yes

sessionAttributes

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

requestAttributes

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

activeContexts

  • Type: typing.Optional[typing.List[typing.Union[aws_resource_validator.pydantic_models.lex_runtime.lex_runtime_classes.ActiveContext, aws_resource_validator.pydantic_models.lex_runtime.lex_runtime_classes.ActiveContextOutput]]]

PostTextResponse

intentName

  • Type:
  • Required: Yes

nluIntentConfidence

  • Type:
  • Required: Yes

alternativeIntents

  • Type: typing.List[aws_resource_validator.pydantic_models.lex_runtime.lex_runtime_classes.PredictedIntent]
  • Required: Yes

slots

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

sessionAttributes

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

message

  • Type:
  • Required: Yes

sentimentResponse

  • Type:
  • Required: Yes

messageFormat

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

dialogState

  • Type: typing.Literal['ConfirmIntent', 'ElicitIntent', 'ElicitSlot', 'Failed', 'Fulfilled', 'ReadyForFulfillment']
  • Required: Yes

slotToElicit

  • Type:
  • Required: Yes

responseCard

  • Type:
  • Required: Yes

sessionId

  • Type:
  • Required: Yes

botVersion

  • Type:
  • Required: Yes

activeContexts

  • Type: typing.List[aws_resource_validator.pydantic_models.lex_runtime.lex_runtime_classes.ActiveContextOutput]
  • Required: Yes

PredictedIntent

intentName

  • Type: typing.Optional[str]

nluIntentConfidence

  • Type: typing.Optional[aws_resource_validator.pydantic_models.lex_runtime.lex_runtime_classes.IntentConfidence]

slots

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

PutSessionRequest

botName

  • Type:
  • Required: Yes

botAlias

  • Type:
  • Required: Yes

userId

  • Type:
  • Required: Yes

sessionAttributes

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

dialogAction

  • Type: typing.Union[aws_resource_validator.pydantic_models.lex_runtime.lex_runtime_classes.DialogAction, aws_resource_validator.pydantic_models.lex_runtime.lex_runtime_classes.DialogActionOutput, NoneType]

recentIntentSummaryView

  • Type: typing.Optional[typing.List[typing.Union[aws_resource_validator.pydantic_models.lex_runtime.lex_runtime_classes.IntentSummary, aws_resource_validator.pydantic_models.lex_runtime.lex_runtime_classes.IntentSummaryOutput]]]

accept

  • Type: typing.Optional[str]

activeContexts

  • Type: typing.Optional[typing.List[typing.Union[aws_resource_validator.pydantic_models.lex_runtime.lex_runtime_classes.ActiveContext, aws_resource_validator.pydantic_models.lex_runtime.lex_runtime_classes.ActiveContextOutput]]]

PutSessionResponse

contentType

  • Type:
  • Required: Yes

intentName

  • Type:
  • Required: Yes

slots

  • Type:
  • Required: Yes

sessionAttributes

  • Type:
  • Required: Yes

message

  • Type:
  • Required: Yes

encodedMessage

  • Type:
  • Required: Yes

messageFormat

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

dialogState

  • Type: typing.Literal['ConfirmIntent', 'ElicitIntent', 'ElicitSlot', 'Failed', 'Fulfilled', 'ReadyForFulfillment']
  • Required: Yes

slotToElicit

  • Type:
  • Required: Yes

audioStream

  • Type:
  • Required: Yes

sessionId

  • Type:
  • Required: Yes

activeContexts

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ResponseCard

version

  • Type: typing.Optional[str]

contentType

  • Type: typing.Optional[typing.Literal['application/vnd.amazonaws.card.generic']]

genericAttachments

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.lex_runtime.lex_runtime_classes.GenericAttachment]]

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]

SentimentResponse

sentimentLabel

  • Type: typing.Optional[str]

sentimentScore

  • Type: typing.Optional[str]