Skip to content

Type definitions#

Index > LexRuntimeV2 > Type definitions

Auto-generated documentation for LexRuntimeV2 type annotations stubs module mypy-boto3-lexv2-runtime.

BlobTypeDef#

# BlobTypeDef Union usage example

from mypy_boto3_lexv2_runtime.type_defs import BlobTypeDef


def get_value() -> BlobTypeDef:
    return ...


# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    botocore.response.StreamingBody,
]

ElicitSubSlotUnionTypeDef#

# ElicitSubSlotUnionTypeDef Union usage example

from mypy_boto3_lexv2_runtime.type_defs import ElicitSubSlotUnionTypeDef


def get_value() -> ElicitSubSlotUnionTypeDef:
    return ...


# ElicitSubSlotUnionTypeDef definition

ElicitSubSlotUnionTypeDef = Union[
    ElicitSubSlotTypeDef,  # (1)
    ElicitSubSlotOutputTypeDef,  # (2)
]
  1. See ElicitSubSlotTypeDef
  2. See ElicitSubSlotOutputTypeDef

ValueUnionTypeDef#

# ValueUnionTypeDef Union usage example

from mypy_boto3_lexv2_runtime.type_defs import ValueUnionTypeDef


def get_value() -> ValueUnionTypeDef:
    return ...


# ValueUnionTypeDef definition

ValueUnionTypeDef = Union[
    ValueTypeDef,  # (1)
    ValueOutputTypeDef,  # (2)
]
  1. See ValueTypeDef
  2. See ValueOutputTypeDef

ActiveContextUnionTypeDef#

# ActiveContextUnionTypeDef Union usage example

from mypy_boto3_lexv2_runtime.type_defs import ActiveContextUnionTypeDef


def get_value() -> ActiveContextUnionTypeDef:
    return ...


# ActiveContextUnionTypeDef definition

ActiveContextUnionTypeDef = Union[
    ActiveContextTypeDef,  # (1)
    ActiveContextOutputTypeDef,  # (2)
]
  1. See ActiveContextTypeDef
  2. See ActiveContextOutputTypeDef

ImageResponseCardUnionTypeDef#

# ImageResponseCardUnionTypeDef Union usage example

from mypy_boto3_lexv2_runtime.type_defs import ImageResponseCardUnionTypeDef


def get_value() -> ImageResponseCardUnionTypeDef:
    return ...


# ImageResponseCardUnionTypeDef definition

ImageResponseCardUnionTypeDef = Union[
    ImageResponseCardTypeDef,  # (1)
    ImageResponseCardOutputTypeDef,  # (2)
]
  1. See ImageResponseCardTypeDef
  2. See ImageResponseCardOutputTypeDef

RuntimeHintDetailsUnionTypeDef#

# RuntimeHintDetailsUnionTypeDef Union usage example

from mypy_boto3_lexv2_runtime.type_defs import RuntimeHintDetailsUnionTypeDef


def get_value() -> RuntimeHintDetailsUnionTypeDef:
    return ...


# RuntimeHintDetailsUnionTypeDef definition

RuntimeHintDetailsUnionTypeDef = Union[
    RuntimeHintDetailsTypeDef,  # (1)
    RuntimeHintDetailsOutputTypeDef,  # (2)
]
  1. See RuntimeHintDetailsTypeDef
  2. See RuntimeHintDetailsOutputTypeDef

DialogActionUnionTypeDef#

# DialogActionUnionTypeDef Union usage example

from mypy_boto3_lexv2_runtime.type_defs import DialogActionUnionTypeDef


def get_value() -> DialogActionUnionTypeDef:
    return ...


# DialogActionUnionTypeDef definition

DialogActionUnionTypeDef = Union[
    DialogActionTypeDef,  # (1)
    DialogActionOutputTypeDef,  # (2)
]
  1. See DialogActionTypeDef
  2. See DialogActionOutputTypeDef

SlotUnionTypeDef#

# SlotUnionTypeDef Union usage example

from mypy_boto3_lexv2_runtime.type_defs import SlotUnionTypeDef


def get_value() -> SlotUnionTypeDef:
    return ...


# SlotUnionTypeDef definition

SlotUnionTypeDef = Union[
    SlotTypeDef,  # (1)
    SlotOutputTypeDef,  # (2)
]
  1. See SlotTypeDef
  2. See SlotOutputTypeDef

MessageUnionTypeDef#

# MessageUnionTypeDef Union usage example

from mypy_boto3_lexv2_runtime.type_defs import MessageUnionTypeDef


def get_value() -> MessageUnionTypeDef:
    return ...


# MessageUnionTypeDef definition

MessageUnionTypeDef = Union[
    MessageTypeDef,  # (1)
    MessageOutputTypeDef,  # (2)
]
  1. See MessageTypeDef
  2. See MessageOutputTypeDef

RuntimeHintsUnionTypeDef#

# RuntimeHintsUnionTypeDef Union usage example

from mypy_boto3_lexv2_runtime.type_defs import RuntimeHintsUnionTypeDef


def get_value() -> RuntimeHintsUnionTypeDef:
    return ...


# RuntimeHintsUnionTypeDef definition

RuntimeHintsUnionTypeDef = Union[
    RuntimeHintsTypeDef,  # (1)
    RuntimeHintsOutputTypeDef,  # (2)
]
  1. See RuntimeHintsTypeDef
  2. See RuntimeHintsOutputTypeDef

IntentUnionTypeDef#

# IntentUnionTypeDef Union usage example

from mypy_boto3_lexv2_runtime.type_defs import IntentUnionTypeDef


def get_value() -> IntentUnionTypeDef:
    return ...


# IntentUnionTypeDef definition

IntentUnionTypeDef = Union[
    IntentTypeDef,  # (1)
    IntentOutputTypeDef,  # (2)
]
  1. See IntentTypeDef
  2. See IntentOutputTypeDef

SessionStateUnionTypeDef#

# SessionStateUnionTypeDef Union usage example

from mypy_boto3_lexv2_runtime.type_defs import SessionStateUnionTypeDef


def get_value() -> SessionStateUnionTypeDef:
    return ...


# SessionStateUnionTypeDef definition

SessionStateUnionTypeDef = Union[
    SessionStateTypeDef,  # (1)
    SessionStateOutputTypeDef,  # (2)
]
  1. See SessionStateTypeDef
  2. See SessionStateOutputTypeDef

AccessDeniedExceptionTypeDef#

# AccessDeniedExceptionTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import AccessDeniedExceptionTypeDef


def get_value() -> AccessDeniedExceptionTypeDef:
    return {
        "message": ...,
    }


# AccessDeniedExceptionTypeDef definition

class AccessDeniedExceptionTypeDef(TypedDict):
    message: str,

ActiveContextTimeToLiveTypeDef#

# ActiveContextTimeToLiveTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import ActiveContextTimeToLiveTypeDef


def get_value() -> ActiveContextTimeToLiveTypeDef:
    return {
        "timeToLiveInSeconds": ...,
    }


# ActiveContextTimeToLiveTypeDef definition

class ActiveContextTimeToLiveTypeDef(TypedDict):
    timeToLiveInSeconds: int,
    turnsToLive: int,

AudioResponseEventTypeDef#

# AudioResponseEventTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import AudioResponseEventTypeDef


def get_value() -> AudioResponseEventTypeDef:
    return {
        "audioChunk": ...,
    }


# AudioResponseEventTypeDef definition

class AudioResponseEventTypeDef(TypedDict):
    audioChunk: NotRequired[bytes],
    contentType: NotRequired[str],
    eventId: NotRequired[str],

BadGatewayExceptionTypeDef#

# BadGatewayExceptionTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import BadGatewayExceptionTypeDef


def get_value() -> BadGatewayExceptionTypeDef:
    return {
        "message": ...,
    }


# BadGatewayExceptionTypeDef definition

class BadGatewayExceptionTypeDef(TypedDict):
    message: str,

ButtonTypeDef#

# ButtonTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import ButtonTypeDef


def get_value() -> ButtonTypeDef:
    return {
        "text": ...,
    }


# ButtonTypeDef definition

class ButtonTypeDef(TypedDict):
    text: str,
    value: str,

ConfidenceScoreTypeDef#

# ConfidenceScoreTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import ConfidenceScoreTypeDef


def get_value() -> ConfidenceScoreTypeDef:
    return {
        "score": ...,
    }


# ConfidenceScoreTypeDef definition

class ConfidenceScoreTypeDef(TypedDict):
    score: NotRequired[float],

ConflictExceptionTypeDef#

# ConflictExceptionTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import ConflictExceptionTypeDef


def get_value() -> ConflictExceptionTypeDef:
    return {
        "message": ...,
    }


# ConflictExceptionTypeDef definition

class ConflictExceptionTypeDef(TypedDict):
    message: str,

DTMFInputEventTypeDef#

# DTMFInputEventTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import DTMFInputEventTypeDef


def get_value() -> DTMFInputEventTypeDef:
    return {
        "inputCharacter": ...,
    }


# DTMFInputEventTypeDef definition

class DTMFInputEventTypeDef(TypedDict):
    inputCharacter: str,
    eventId: NotRequired[str],
    clientTimestampMillis: NotRequired[int],

DeleteSessionRequestTypeDef#

# DeleteSessionRequestTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import DeleteSessionRequestTypeDef


def get_value() -> DeleteSessionRequestTypeDef:
    return {
        "botId": ...,
    }


# DeleteSessionRequestTypeDef definition

class DeleteSessionRequestTypeDef(TypedDict):
    botId: str,
    botAliasId: str,
    localeId: str,
    sessionId: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import ResponseMetadataTypeDef


def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
    }


# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

DependencyFailedExceptionTypeDef#

# DependencyFailedExceptionTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import DependencyFailedExceptionTypeDef


def get_value() -> DependencyFailedExceptionTypeDef:
    return {
        "message": ...,
    }


# DependencyFailedExceptionTypeDef definition

class DependencyFailedExceptionTypeDef(TypedDict):
    message: str,

ElicitSubSlotOutputTypeDef#

# ElicitSubSlotOutputTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import ElicitSubSlotOutputTypeDef


def get_value() -> ElicitSubSlotOutputTypeDef:
    return {
        "name": ...,
    }


# ElicitSubSlotOutputTypeDef definition

class ElicitSubSlotOutputTypeDef(TypedDict):
    name: str,
    subSlotToElicit: NotRequired[Dict[str, Any]],

DisconnectionEventTypeDef#

# DisconnectionEventTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import DisconnectionEventTypeDef


def get_value() -> DisconnectionEventTypeDef:
    return {
        "eventId": ...,
    }


# DisconnectionEventTypeDef definition

class DisconnectionEventTypeDef(TypedDict):
    eventId: NotRequired[str],
    clientTimestampMillis: NotRequired[int],

ElicitSubSlotTypeDef#

# ElicitSubSlotTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import ElicitSubSlotTypeDef


def get_value() -> ElicitSubSlotTypeDef:
    return {
        "name": ...,
    }


# ElicitSubSlotTypeDef definition

class ElicitSubSlotTypeDef(TypedDict):
    name: str,
    subSlotToElicit: NotRequired[Mapping[str, Any]],

GetSessionRequestTypeDef#

# GetSessionRequestTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import GetSessionRequestTypeDef


def get_value() -> GetSessionRequestTypeDef:
    return {
        "botId": ...,
    }


# GetSessionRequestTypeDef definition

class GetSessionRequestTypeDef(TypedDict):
    botId: str,
    botAliasId: str,
    localeId: str,
    sessionId: str,

HeartbeatEventTypeDef#

# HeartbeatEventTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import HeartbeatEventTypeDef


def get_value() -> HeartbeatEventTypeDef:
    return {
        "eventId": ...,
    }


# HeartbeatEventTypeDef definition

class HeartbeatEventTypeDef(TypedDict):
    eventId: NotRequired[str],

RecognizedBotMemberTypeDef#

# RecognizedBotMemberTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import RecognizedBotMemberTypeDef


def get_value() -> RecognizedBotMemberTypeDef:
    return {
        "botId": ...,
    }


# RecognizedBotMemberTypeDef definition

class RecognizedBotMemberTypeDef(TypedDict):
    botId: str,
    botName: NotRequired[str],

InternalServerExceptionTypeDef#

# InternalServerExceptionTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import InternalServerExceptionTypeDef


def get_value() -> InternalServerExceptionTypeDef:
    return {
        "message": ...,
    }


# InternalServerExceptionTypeDef definition

class InternalServerExceptionTypeDef(TypedDict):
    message: str,

PlaybackCompletionEventTypeDef#

# PlaybackCompletionEventTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import PlaybackCompletionEventTypeDef


def get_value() -> PlaybackCompletionEventTypeDef:
    return {
        "eventId": ...,
    }


# PlaybackCompletionEventTypeDef definition

class PlaybackCompletionEventTypeDef(TypedDict):
    eventId: NotRequired[str],
    clientTimestampMillis: NotRequired[int],

PlaybackInterruptionEventTypeDef#

# PlaybackInterruptionEventTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import PlaybackInterruptionEventTypeDef


def get_value() -> PlaybackInterruptionEventTypeDef:
    return {
        "eventReason": ...,
    }


# PlaybackInterruptionEventTypeDef definition

class PlaybackInterruptionEventTypeDef(TypedDict):
    eventReason: NotRequired[PlaybackInterruptionReasonType],  # (1)
    causedByEventId: NotRequired[str],
    eventId: NotRequired[str],
  1. See PlaybackInterruptionReasonType

ResourceNotFoundExceptionTypeDef#

# ResourceNotFoundExceptionTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import ResourceNotFoundExceptionTypeDef


def get_value() -> ResourceNotFoundExceptionTypeDef:
    return {
        "message": ...,
    }


# ResourceNotFoundExceptionTypeDef definition

class ResourceNotFoundExceptionTypeDef(TypedDict):
    message: str,

RuntimeHintValueTypeDef#

# RuntimeHintValueTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import RuntimeHintValueTypeDef


def get_value() -> RuntimeHintValueTypeDef:
    return {
        "phrase": ...,
    }


# RuntimeHintValueTypeDef definition

class RuntimeHintValueTypeDef(TypedDict):
    phrase: str,

SentimentScoreTypeDef#

# SentimentScoreTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import SentimentScoreTypeDef


def get_value() -> SentimentScoreTypeDef:
    return {
        "positive": ...,
    }


# SentimentScoreTypeDef definition

class SentimentScoreTypeDef(TypedDict):
    positive: NotRequired[float],
    negative: NotRequired[float],
    neutral: NotRequired[float],
    mixed: NotRequired[float],

ValueOutputTypeDef#

# ValueOutputTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import ValueOutputTypeDef


def get_value() -> ValueOutputTypeDef:
    return {
        "originalValue": ...,
    }


# ValueOutputTypeDef definition

class ValueOutputTypeDef(TypedDict):
    interpretedValue: str,
    originalValue: NotRequired[str],
    resolvedValues: NotRequired[List[str]],

TextInputEventTypeDef#

# TextInputEventTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import TextInputEventTypeDef


def get_value() -> TextInputEventTypeDef:
    return {
        "text": ...,
    }


# TextInputEventTypeDef definition

class TextInputEventTypeDef(TypedDict):
    text: str,
    eventId: NotRequired[str],
    clientTimestampMillis: NotRequired[int],

ThrottlingExceptionTypeDef#

# ThrottlingExceptionTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import ThrottlingExceptionTypeDef


def get_value() -> ThrottlingExceptionTypeDef:
    return {
        "message": ...,
    }


# ThrottlingExceptionTypeDef definition

class ThrottlingExceptionTypeDef(TypedDict):
    message: str,

TranscriptEventTypeDef#

# TranscriptEventTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import TranscriptEventTypeDef


def get_value() -> TranscriptEventTypeDef:
    return {
        "transcript": ...,
    }


# TranscriptEventTypeDef definition

class TranscriptEventTypeDef(TypedDict):
    transcript: NotRequired[str],
    eventId: NotRequired[str],

ValidationExceptionTypeDef#

# ValidationExceptionTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import ValidationExceptionTypeDef


def get_value() -> ValidationExceptionTypeDef:
    return {
        "message": ...,
    }


# ValidationExceptionTypeDef definition

class ValidationExceptionTypeDef(TypedDict):
    message: str,

ValueTypeDef#

# ValueTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import ValueTypeDef


def get_value() -> ValueTypeDef:
    return {
        "originalValue": ...,
    }


# ValueTypeDef definition

class ValueTypeDef(TypedDict):
    interpretedValue: str,
    originalValue: NotRequired[str],
    resolvedValues: NotRequired[Sequence[str]],

ActiveContextOutputTypeDef#

# ActiveContextOutputTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import ActiveContextOutputTypeDef


def get_value() -> ActiveContextOutputTypeDef:
    return {
        "name": ...,
    }


# ActiveContextOutputTypeDef definition

class ActiveContextOutputTypeDef(TypedDict):
    name: str,
    timeToLive: ActiveContextTimeToLiveTypeDef,  # (1)
    contextAttributes: Dict[str, str],
  1. See ActiveContextTimeToLiveTypeDef

ActiveContextTypeDef#

# ActiveContextTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import ActiveContextTypeDef


def get_value() -> ActiveContextTypeDef:
    return {
        "name": ...,
    }


# ActiveContextTypeDef definition

class ActiveContextTypeDef(TypedDict):
    name: str,
    timeToLive: ActiveContextTimeToLiveTypeDef,  # (1)
    contextAttributes: Mapping[str, str],
  1. See ActiveContextTimeToLiveTypeDef

AudioInputEventTypeDef#

# AudioInputEventTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import AudioInputEventTypeDef


def get_value() -> AudioInputEventTypeDef:
    return {
        "audioChunk": ...,
    }


# AudioInputEventTypeDef definition

class AudioInputEventTypeDef(TypedDict):
    contentType: str,
    audioChunk: NotRequired[BlobTypeDef],
    eventId: NotRequired[str],
    clientTimestampMillis: NotRequired[int],

RecognizeUtteranceRequestTypeDef#

# RecognizeUtteranceRequestTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import RecognizeUtteranceRequestTypeDef


def get_value() -> RecognizeUtteranceRequestTypeDef:
    return {
        "botId": ...,
    }


# RecognizeUtteranceRequestTypeDef definition

class RecognizeUtteranceRequestTypeDef(TypedDict):
    botId: str,
    botAliasId: str,
    localeId: str,
    sessionId: str,
    requestContentType: str,
    sessionState: NotRequired[str],
    requestAttributes: NotRequired[str],
    responseContentType: NotRequired[str],
    inputStream: NotRequired[BlobTypeDef],

ImageResponseCardOutputTypeDef#

# ImageResponseCardOutputTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import ImageResponseCardOutputTypeDef


def get_value() -> ImageResponseCardOutputTypeDef:
    return {
        "title": ...,
    }


# ImageResponseCardOutputTypeDef definition

class ImageResponseCardOutputTypeDef(TypedDict):
    title: str,
    subtitle: NotRequired[str],
    imageUrl: NotRequired[str],
    buttons: NotRequired[List[ButtonTypeDef]],  # (1)
  1. See List[ButtonTypeDef]

ImageResponseCardTypeDef#

# ImageResponseCardTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import ImageResponseCardTypeDef


def get_value() -> ImageResponseCardTypeDef:
    return {
        "title": ...,
    }


# ImageResponseCardTypeDef definition

class ImageResponseCardTypeDef(TypedDict):
    title: str,
    subtitle: NotRequired[str],
    imageUrl: NotRequired[str],
    buttons: NotRequired[Sequence[ButtonTypeDef]],  # (1)
  1. See Sequence[ButtonTypeDef]

DeleteSessionResponseTypeDef#

# DeleteSessionResponseTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import DeleteSessionResponseTypeDef


def get_value() -> DeleteSessionResponseTypeDef:
    return {
        "botId": ...,
    }


# DeleteSessionResponseTypeDef definition

class DeleteSessionResponseTypeDef(TypedDict):
    botId: str,
    botAliasId: str,
    localeId: str,
    sessionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

PutSessionResponseTypeDef#

# PutSessionResponseTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import PutSessionResponseTypeDef


def get_value() -> PutSessionResponseTypeDef:
    return {
        "contentType": ...,
    }


# PutSessionResponseTypeDef definition

class PutSessionResponseTypeDef(TypedDict):
    contentType: str,
    messages: str,
    sessionState: str,
    requestAttributes: str,
    sessionId: str,
    audioStream: botocore.response.StreamingBody,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

RecognizeUtteranceResponseTypeDef#

# RecognizeUtteranceResponseTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import RecognizeUtteranceResponseTypeDef


def get_value() -> RecognizeUtteranceResponseTypeDef:
    return {
        "inputMode": ...,
    }


# RecognizeUtteranceResponseTypeDef definition

class RecognizeUtteranceResponseTypeDef(TypedDict):
    inputMode: str,
    contentType: str,
    messages: str,
    interpretations: str,
    sessionState: str,
    requestAttributes: str,
    sessionId: str,
    inputTranscript: str,
    audioStream: botocore.response.StreamingBody,
    recognizedBotMember: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DialogActionOutputTypeDef#

# DialogActionOutputTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import DialogActionOutputTypeDef


def get_value() -> DialogActionOutputTypeDef:
    return {
        "type": ...,
    }


# DialogActionOutputTypeDef definition

class DialogActionOutputTypeDef(TypedDict):
    type: DialogActionTypeType,  # (1)
    slotToElicit: NotRequired[str],
    slotElicitationStyle: NotRequired[StyleTypeType],  # (2)
    subSlotToElicit: NotRequired[ElicitSubSlotOutputTypeDef],  # (3)
  1. See DialogActionTypeType
  2. See StyleTypeType
  3. See ElicitSubSlotOutputTypeDef

RuntimeHintDetailsOutputTypeDef#

# RuntimeHintDetailsOutputTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import RuntimeHintDetailsOutputTypeDef


def get_value() -> RuntimeHintDetailsOutputTypeDef:
    return {
        "runtimeHintValues": ...,
    }


# RuntimeHintDetailsOutputTypeDef definition

class RuntimeHintDetailsOutputTypeDef(TypedDict):
    runtimeHintValues: NotRequired[List[RuntimeHintValueTypeDef]],  # (1)
    subSlotHints: NotRequired[Dict[str, Dict[str, Any]]],
  1. See List[RuntimeHintValueTypeDef]

RuntimeHintDetailsTypeDef#

# RuntimeHintDetailsTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import RuntimeHintDetailsTypeDef


def get_value() -> RuntimeHintDetailsTypeDef:
    return {
        "runtimeHintValues": ...,
    }


# RuntimeHintDetailsTypeDef definition

class RuntimeHintDetailsTypeDef(TypedDict):
    runtimeHintValues: NotRequired[Sequence[RuntimeHintValueTypeDef]],  # (1)
    subSlotHints: NotRequired[Mapping[str, Mapping[str, Any]]],
  1. See Sequence[RuntimeHintValueTypeDef]

SentimentResponseTypeDef#

# SentimentResponseTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import SentimentResponseTypeDef


def get_value() -> SentimentResponseTypeDef:
    return {
        "sentiment": ...,
    }


# SentimentResponseTypeDef definition

class SentimentResponseTypeDef(TypedDict):
    sentiment: NotRequired[SentimentTypeType],  # (1)
    sentimentScore: NotRequired[SentimentScoreTypeDef],  # (2)
  1. See SentimentTypeType
  2. See SentimentScoreTypeDef

SlotOutputTypeDef#

# SlotOutputTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import SlotOutputTypeDef


def get_value() -> SlotOutputTypeDef:
    return {
        "value": ...,
    }


# SlotOutputTypeDef definition

class SlotOutputTypeDef(TypedDict):
    value: NotRequired[ValueOutputTypeDef],  # (1)
    shape: NotRequired[ShapeType],  # (2)
    values: NotRequired[List[Dict[str, Any]]],
    subSlots: NotRequired[Dict[str, Dict[str, Any]]],
  1. See ValueOutputTypeDef
  2. See ShapeType

MessageOutputTypeDef#

# MessageOutputTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import MessageOutputTypeDef


def get_value() -> MessageOutputTypeDef:
    return {
        "content": ...,
    }


# MessageOutputTypeDef definition

class MessageOutputTypeDef(TypedDict):
    contentType: MessageContentTypeType,  # (1)
    content: NotRequired[str],
    imageResponseCard: NotRequired[ImageResponseCardOutputTypeDef],  # (2)
  1. See MessageContentTypeType
  2. See ImageResponseCardOutputTypeDef

DialogActionTypeDef#

# DialogActionTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import DialogActionTypeDef


def get_value() -> DialogActionTypeDef:
    return {
        "type": ...,
    }


# DialogActionTypeDef definition

class DialogActionTypeDef(TypedDict):
    type: DialogActionTypeType,  # (1)
    slotToElicit: NotRequired[str],
    slotElicitationStyle: NotRequired[StyleTypeType],  # (2)
    subSlotToElicit: NotRequired[ElicitSubSlotUnionTypeDef],  # (3)
  1. See DialogActionTypeType
  2. See StyleTypeType
  3. See ElicitSubSlotUnionTypeDef

RuntimeHintsOutputTypeDef#

# RuntimeHintsOutputTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import RuntimeHintsOutputTypeDef


def get_value() -> RuntimeHintsOutputTypeDef:
    return {
        "slotHints": ...,
    }


# RuntimeHintsOutputTypeDef definition

class RuntimeHintsOutputTypeDef(TypedDict):
    slotHints: NotRequired[Dict[str, Dict[str, RuntimeHintDetailsOutputTypeDef]]],  # (1)
  1. See Dict[str, Dict[str, RuntimeHintDetailsOutputTypeDef]]

IntentOutputTypeDef#

# IntentOutputTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import IntentOutputTypeDef


def get_value() -> IntentOutputTypeDef:
    return {
        "name": ...,
    }


# IntentOutputTypeDef definition

class IntentOutputTypeDef(TypedDict):
    name: str,
    slots: NotRequired[Dict[str, SlotOutputTypeDef]],  # (1)
    state: NotRequired[IntentStateType],  # (2)
    confirmationState: NotRequired[ConfirmationStateType],  # (3)
  1. See Dict[str, SlotOutputTypeDef]
  2. See IntentStateType
  3. See ConfirmationStateType

SlotTypeDef#

# SlotTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import SlotTypeDef


def get_value() -> SlotTypeDef:
    return {
        "value": ...,
    }


# SlotTypeDef definition

class SlotTypeDef(TypedDict):
    value: NotRequired[ValueUnionTypeDef],  # (1)
    shape: NotRequired[ShapeType],  # (2)
    values: NotRequired[Sequence[Mapping[str, Any]]],
    subSlots: NotRequired[Mapping[str, Mapping[str, Any]]],
  1. See ValueUnionTypeDef
  2. See ShapeType

TextResponseEventTypeDef#

# TextResponseEventTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import TextResponseEventTypeDef


def get_value() -> TextResponseEventTypeDef:
    return {
        "messages": ...,
    }


# TextResponseEventTypeDef definition

class TextResponseEventTypeDef(TypedDict):
    messages: NotRequired[List[MessageOutputTypeDef]],  # (1)
    eventId: NotRequired[str],
  1. See List[MessageOutputTypeDef]

MessageTypeDef#

# MessageTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import MessageTypeDef


def get_value() -> MessageTypeDef:
    return {
        "content": ...,
    }


# MessageTypeDef definition

class MessageTypeDef(TypedDict):
    contentType: MessageContentTypeType,  # (1)
    content: NotRequired[str],
    imageResponseCard: NotRequired[ImageResponseCardUnionTypeDef],  # (2)
  1. See MessageContentTypeType
  2. See ImageResponseCardUnionTypeDef

RuntimeHintsTypeDef#

# RuntimeHintsTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import RuntimeHintsTypeDef


def get_value() -> RuntimeHintsTypeDef:
    return {
        "slotHints": ...,
    }


# RuntimeHintsTypeDef definition

class RuntimeHintsTypeDef(TypedDict):
    slotHints: NotRequired[Mapping[str, Mapping[str, RuntimeHintDetailsUnionTypeDef]]],  # (1)
  1. See Mapping[str, Mapping[str, RuntimeHintDetailsUnionTypeDef]]

InterpretationTypeDef#

# InterpretationTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import InterpretationTypeDef


def get_value() -> InterpretationTypeDef:
    return {
        "nluConfidence": ...,
    }


# InterpretationTypeDef definition

class InterpretationTypeDef(TypedDict):
    nluConfidence: NotRequired[ConfidenceScoreTypeDef],  # (1)
    sentimentResponse: NotRequired[SentimentResponseTypeDef],  # (2)
    intent: NotRequired[IntentOutputTypeDef],  # (3)
    interpretationSource: NotRequired[InterpretationSourceType],  # (4)
  1. See ConfidenceScoreTypeDef
  2. See SentimentResponseTypeDef
  3. See IntentOutputTypeDef
  4. See InterpretationSourceType

SessionStateOutputTypeDef#

# SessionStateOutputTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import SessionStateOutputTypeDef


def get_value() -> SessionStateOutputTypeDef:
    return {
        "dialogAction": ...,
    }


# SessionStateOutputTypeDef definition

class SessionStateOutputTypeDef(TypedDict):
    dialogAction: NotRequired[DialogActionOutputTypeDef],  # (1)
    intent: NotRequired[IntentOutputTypeDef],  # (2)
    activeContexts: NotRequired[List[ActiveContextOutputTypeDef]],  # (3)
    sessionAttributes: NotRequired[Dict[str, str]],
    originatingRequestId: NotRequired[str],
    runtimeHints: NotRequired[RuntimeHintsOutputTypeDef],  # (4)
  1. See DialogActionOutputTypeDef
  2. See IntentOutputTypeDef
  3. See List[ActiveContextOutputTypeDef]
  4. See RuntimeHintsOutputTypeDef

GetSessionResponseTypeDef#

# GetSessionResponseTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import GetSessionResponseTypeDef


def get_value() -> GetSessionResponseTypeDef:
    return {
        "sessionId": ...,
    }


# GetSessionResponseTypeDef definition

class GetSessionResponseTypeDef(TypedDict):
    sessionId: str,
    messages: List[MessageOutputTypeDef],  # (1)
    interpretations: List[InterpretationTypeDef],  # (2)
    sessionState: SessionStateOutputTypeDef,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See List[MessageOutputTypeDef]
  2. See List[InterpretationTypeDef]
  3. See SessionStateOutputTypeDef
  4. See ResponseMetadataTypeDef

IntentResultEventTypeDef#

# IntentResultEventTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import IntentResultEventTypeDef


def get_value() -> IntentResultEventTypeDef:
    return {
        "inputMode": ...,
    }


# IntentResultEventTypeDef definition

class IntentResultEventTypeDef(TypedDict):
    inputMode: NotRequired[InputModeType],  # (1)
    interpretations: NotRequired[List[InterpretationTypeDef]],  # (2)
    sessionState: NotRequired[SessionStateOutputTypeDef],  # (3)
    requestAttributes: NotRequired[Dict[str, str]],
    sessionId: NotRequired[str],
    eventId: NotRequired[str],
    recognizedBotMember: NotRequired[RecognizedBotMemberTypeDef],  # (4)
  1. See InputModeType
  2. See List[InterpretationTypeDef]
  3. See SessionStateOutputTypeDef
  4. See RecognizedBotMemberTypeDef

RecognizeTextResponseTypeDef#

# RecognizeTextResponseTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import RecognizeTextResponseTypeDef


def get_value() -> RecognizeTextResponseTypeDef:
    return {
        "messages": ...,
    }


# RecognizeTextResponseTypeDef definition

class RecognizeTextResponseTypeDef(TypedDict):
    messages: List[MessageOutputTypeDef],  # (1)
    sessionState: SessionStateOutputTypeDef,  # (2)
    interpretations: List[InterpretationTypeDef],  # (3)
    requestAttributes: Dict[str, str],
    sessionId: str,
    recognizedBotMember: RecognizedBotMemberTypeDef,  # (4)
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See List[MessageOutputTypeDef]
  2. See SessionStateOutputTypeDef
  3. See List[InterpretationTypeDef]
  4. See RecognizedBotMemberTypeDef
  5. See ResponseMetadataTypeDef

IntentTypeDef#

# IntentTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import IntentTypeDef


def get_value() -> IntentTypeDef:
    return {
        "name": ...,
    }


# IntentTypeDef definition

class IntentTypeDef(TypedDict):
    name: str,
    slots: NotRequired[Mapping[str, SlotUnionTypeDef]],  # (1)
    state: NotRequired[IntentStateType],  # (2)
    confirmationState: NotRequired[ConfirmationStateType],  # (3)
  1. See Mapping[str, SlotUnionTypeDef]
  2. See IntentStateType
  3. See ConfirmationStateType

StartConversationResponseEventStreamTypeDef#

# StartConversationResponseEventStreamTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import StartConversationResponseEventStreamTypeDef


def get_value() -> StartConversationResponseEventStreamTypeDef:
    return {
        "PlaybackInterruptionEvent": ...,
    }


# StartConversationResponseEventStreamTypeDef definition

class StartConversationResponseEventStreamTypeDef(TypedDict):
    PlaybackInterruptionEvent: NotRequired[PlaybackInterruptionEventTypeDef],  # (1)
    TranscriptEvent: NotRequired[TranscriptEventTypeDef],  # (2)
    IntentResultEvent: NotRequired[IntentResultEventTypeDef],  # (3)
    TextResponseEvent: NotRequired[TextResponseEventTypeDef],  # (4)
    AudioResponseEvent: NotRequired[AudioResponseEventTypeDef],  # (5)
    HeartbeatEvent: NotRequired[HeartbeatEventTypeDef],  # (6)
    AccessDeniedException: NotRequired[AccessDeniedExceptionTypeDef],  # (7)
    ResourceNotFoundException: NotRequired[ResourceNotFoundExceptionTypeDef],  # (8)
    ValidationException: NotRequired[ValidationExceptionTypeDef],  # (9)
    ThrottlingException: NotRequired[ThrottlingExceptionTypeDef],  # (10)
    InternalServerException: NotRequired[InternalServerExceptionTypeDef],  # (11)
    ConflictException: NotRequired[ConflictExceptionTypeDef],  # (12)
    DependencyFailedException: NotRequired[DependencyFailedExceptionTypeDef],  # (13)
    BadGatewayException: NotRequired[BadGatewayExceptionTypeDef],  # (14)
  1. See PlaybackInterruptionEventTypeDef
  2. See TranscriptEventTypeDef
  3. See IntentResultEventTypeDef
  4. See TextResponseEventTypeDef
  5. See AudioResponseEventTypeDef
  6. See HeartbeatEventTypeDef
  7. See AccessDeniedExceptionTypeDef
  8. See ResourceNotFoundExceptionTypeDef
  9. See ValidationExceptionTypeDef
  10. See ThrottlingExceptionTypeDef
  11. See InternalServerExceptionTypeDef
  12. See ConflictExceptionTypeDef
  13. See DependencyFailedExceptionTypeDef
  14. See BadGatewayExceptionTypeDef

StartConversationResponseTypeDef#

# StartConversationResponseTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import StartConversationResponseTypeDef


def get_value() -> StartConversationResponseTypeDef:
    return {
        "responseEventStream": ...,
    }


# StartConversationResponseTypeDef definition

class StartConversationResponseTypeDef(TypedDict):
    responseEventStream: botocore.eventstream.EventStream[StartConversationResponseEventStreamTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EventStream[StartConversationResponseEventStreamTypeDef]
  2. See ResponseMetadataTypeDef

SessionStateTypeDef#

# SessionStateTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import SessionStateTypeDef


def get_value() -> SessionStateTypeDef:
    return {
        "dialogAction": ...,
    }


# SessionStateTypeDef definition

class SessionStateTypeDef(TypedDict):
    dialogAction: NotRequired[DialogActionUnionTypeDef],  # (1)
    intent: NotRequired[IntentUnionTypeDef],  # (2)
    activeContexts: NotRequired[Sequence[ActiveContextUnionTypeDef]],  # (3)
    sessionAttributes: NotRequired[Mapping[str, str]],
    originatingRequestId: NotRequired[str],
    runtimeHints: NotRequired[RuntimeHintsUnionTypeDef],  # (4)
  1. See DialogActionUnionTypeDef
  2. See IntentUnionTypeDef
  3. See Sequence[ActiveContextUnionTypeDef]
  4. See RuntimeHintsUnionTypeDef

ConfigurationEventTypeDef#

# ConfigurationEventTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import ConfigurationEventTypeDef


def get_value() -> ConfigurationEventTypeDef:
    return {
        "requestAttributes": ...,
    }


# ConfigurationEventTypeDef definition

class ConfigurationEventTypeDef(TypedDict):
    responseContentType: str,
    requestAttributes: NotRequired[Mapping[str, str]],
    sessionState: NotRequired[SessionStateUnionTypeDef],  # (1)
    welcomeMessages: NotRequired[Sequence[MessageUnionTypeDef]],  # (2)
    disablePlayback: NotRequired[bool],
    eventId: NotRequired[str],
    clientTimestampMillis: NotRequired[int],
  1. See SessionStateUnionTypeDef
  2. See Sequence[MessageUnionTypeDef]

PutSessionRequestTypeDef#

# PutSessionRequestTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import PutSessionRequestTypeDef


def get_value() -> PutSessionRequestTypeDef:
    return {
        "botId": ...,
    }


# PutSessionRequestTypeDef definition

class PutSessionRequestTypeDef(TypedDict):
    botId: str,
    botAliasId: str,
    localeId: str,
    sessionId: str,
    sessionState: SessionStateUnionTypeDef,  # (1)
    messages: NotRequired[Sequence[MessageUnionTypeDef]],  # (2)
    requestAttributes: NotRequired[Mapping[str, str]],
    responseContentType: NotRequired[str],
  1. See SessionStateUnionTypeDef
  2. See Sequence[MessageUnionTypeDef]

RecognizeTextRequestTypeDef#

# RecognizeTextRequestTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import RecognizeTextRequestTypeDef


def get_value() -> RecognizeTextRequestTypeDef:
    return {
        "botId": ...,
    }


# RecognizeTextRequestTypeDef definition

class RecognizeTextRequestTypeDef(TypedDict):
    botId: str,
    botAliasId: str,
    localeId: str,
    sessionId: str,
    text: str,
    sessionState: NotRequired[SessionStateUnionTypeDef],  # (1)
    requestAttributes: NotRequired[Mapping[str, str]],
  1. See SessionStateUnionTypeDef

StartConversationRequestEventStreamTypeDef#

# StartConversationRequestEventStreamTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import StartConversationRequestEventStreamTypeDef


def get_value() -> StartConversationRequestEventStreamTypeDef:
    return {
        "ConfigurationEvent": ...,
    }


# StartConversationRequestEventStreamTypeDef definition

class StartConversationRequestEventStreamTypeDef(TypedDict):
    ConfigurationEvent: NotRequired[ConfigurationEventTypeDef],  # (1)
    AudioInputEvent: NotRequired[AudioInputEventTypeDef],  # (2)
    DTMFInputEvent: NotRequired[DTMFInputEventTypeDef],  # (3)
    TextInputEvent: NotRequired[TextInputEventTypeDef],  # (4)
    PlaybackCompletionEvent: NotRequired[PlaybackCompletionEventTypeDef],  # (5)
    DisconnectionEvent: NotRequired[DisconnectionEventTypeDef],  # (6)
  1. See ConfigurationEventTypeDef
  2. See AudioInputEventTypeDef
  3. See DTMFInputEventTypeDef
  4. See TextInputEventTypeDef
  5. See PlaybackCompletionEventTypeDef
  6. See DisconnectionEventTypeDef

StartConversationRequestTypeDef#

# StartConversationRequestTypeDef TypedDict usage example

from mypy_boto3_lexv2_runtime.type_defs import StartConversationRequestTypeDef


def get_value() -> StartConversationRequestTypeDef:
    return {
        "botId": ...,
    }


# StartConversationRequestTypeDef definition

class StartConversationRequestTypeDef(TypedDict):
    botId: str,
    botAliasId: str,
    localeId: str,
    sessionId: str,
    requestEventStream: botocore.eventstream.EventStream[StartConversationRequestEventStreamTypeDef],  # (1)
    conversationMode: NotRequired[ConversationModeType],  # (2)
  1. See EventStream[StartConversationRequestEventStreamTypeDef]
  2. See ConversationModeType