Skip to content

Lex Runtime Classes

ActiveContextTimeToLiveTypeDef

timeToLiveInSeconds

  • Type: typing.Optional[int]

turnsToLive

  • Type: typing.Optional[int]

ActiveContextTypeDef

name

  • Type:
  • Required: Yes

timeToLive

  • Type:
  • Required: Yes

parameters

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

BaseValidatorModel

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

ButtonTypeDef

text

  • Type:
  • Required: Yes

value

  • Type:
  • Required: Yes

DeleteSessionRequestRequestTypeDef

botName

  • Type:
  • Required: Yes

botAlias

  • Type:
  • Required: Yes

userId

  • Type:
  • Required: Yes

DeleteSessionResponseTypeDef

botName

  • Type:
  • Required: Yes

botAlias

  • Type:
  • Required: Yes

userId

  • Type:
  • Required: Yes

sessionId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DialogActionTypeDef

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']]

GenericAttachmentTypeDef

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_classes.ButtonTypeDef]]

GetSessionRequestRequestTypeDef

botName

  • Type:
  • Required: Yes

botAlias

  • Type:
  • Required: Yes

userId

  • Type:
  • Required: Yes

checkpointLabelFilter

  • Type: typing.Optional[str]

GetSessionResponseTypeDef

recentIntentSummaryView

  • Type: typing.List[aws_resource_validator.pydantic_models.lex_runtime_classes.IntentSummaryTypeDef]
  • 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_classes.ActiveContextTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

IntentConfidenceTypeDef

score

  • Type: typing.Optional[float]

IntentSummaryTypeDef

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]

PostContentRequestRequestTypeDef

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]]
  • Required: Yes

sessionAttributes

  • Type: typing.Optional[str]

requestAttributes

  • Type: typing.Optional[str]

accept

  • Type: typing.Optional[str]

activeContexts

  • Type: typing.Optional[str]

PostContentResponseTypeDef

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

PostTextRequestRequestTypeDef

botName

  • Type:
  • Required: Yes

botAlias

  • Type:
  • Required: Yes

userId

  • Type:
  • Required: Yes

inputText

  • Type:
  • Required: Yes

sessionAttributes

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

requestAttributes

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

activeContexts

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.lex_runtime_classes.ActiveContextTypeDef]]

PostTextResponseTypeDef

intentName

  • Type:
  • Required: Yes

nluIntentConfidence

  • Type:
  • Required: Yes

alternativeIntents

  • Type: typing.List[aws_resource_validator.pydantic_models.lex_runtime_classes.PredictedIntentTypeDef]
  • 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_classes.ActiveContextTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

PredictedIntentTypeDef

intentName

  • Type: typing.Optional[str]

nluIntentConfidence

  • Type: typing.Optional[aws_resource_validator.pydantic_models.lex_runtime_classes.IntentConfidenceTypeDef]

slots

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

PutSessionRequestRequestTypeDef

botName

  • Type:
  • Required: Yes

botAlias

  • Type:
  • Required: Yes

userId

  • Type:
  • Required: Yes

sessionAttributes

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

dialogAction

  • Type: typing.Optional[aws_resource_validator.pydantic_models.lex_runtime_classes.DialogActionTypeDef]

recentIntentSummaryView

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.lex_runtime_classes.IntentSummaryTypeDef]]

accept

  • Type: typing.Optional[str]

activeContexts

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.lex_runtime_classes.ActiveContextTypeDef]]

PutSessionResponseTypeDef

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

ResponseCardTypeDef

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_classes.GenericAttachmentTypeDef]]

ResponseMetadataTypeDef

RequestId

  • Type:
  • Required: Yes

HostId

  • Type:
  • Required: Yes

HTTPStatusCode

  • Type:
  • Required: Yes

HTTPHeaders

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

RetryAttempts

  • Type:
  • Required: Yes

SentimentResponseTypeDef

sentimentLabel

  • Type: typing.Optional[str]

sentimentScore

  • Type: typing.Optional[str]