Typed dictionaries

Index > PinpointSMSVoice > Typed dictionaries

Auto-generated documentation for PinpointSMSVoice type annotations stubs module mypy-boto3-sms-voice.

CallInstructionsMessageTypeTypeDef

# CallInstructionsMessageTypeTypeDef usage example

from mypy_boto3_sms_voice.type_defs import CallInstructionsMessageTypeTypeDef

def get_value() -> CallInstructionsMessageTypeTypeDef:
    return {
        "Text": ...,
    }

# CallInstructionsMessageTypeTypeDef definition

class CallInstructionsMessageTypeTypeDef(TypedDict):
    Text: NotRequired[str],

CloudWatchLogsDestinationTypeDef

# CloudWatchLogsDestinationTypeDef usage example

from mypy_boto3_sms_voice.type_defs import CloudWatchLogsDestinationTypeDef

def get_value() -> CloudWatchLogsDestinationTypeDef:
    return {
        "IamRoleArn": ...,
    }

# CloudWatchLogsDestinationTypeDef definition

class CloudWatchLogsDestinationTypeDef(TypedDict):
    IamRoleArn: NotRequired[str],
    LogGroupArn: NotRequired[str],

CreateConfigurationSetRequestRequestTypeDef

# CreateConfigurationSetRequestRequestTypeDef usage example

from mypy_boto3_sms_voice.type_defs import CreateConfigurationSetRequestRequestTypeDef

def get_value() -> CreateConfigurationSetRequestRequestTypeDef:
    return {
        "ConfigurationSetName": ...,
    }

# CreateConfigurationSetRequestRequestTypeDef definition

class CreateConfigurationSetRequestRequestTypeDef(TypedDict):
    ConfigurationSetName: NotRequired[str],

DeleteConfigurationSetEventDestinationRequestRequestTypeDef

# DeleteConfigurationSetEventDestinationRequestRequestTypeDef usage example

from mypy_boto3_sms_voice.type_defs import DeleteConfigurationSetEventDestinationRequestRequestTypeDef

def get_value() -> DeleteConfigurationSetEventDestinationRequestRequestTypeDef:
    return {
        "ConfigurationSetName": ...,
        "EventDestinationName": ...,
    }

# DeleteConfigurationSetEventDestinationRequestRequestTypeDef definition

class DeleteConfigurationSetEventDestinationRequestRequestTypeDef(TypedDict):
    ConfigurationSetName: str,
    EventDestinationName: str,

DeleteConfigurationSetRequestRequestTypeDef

# DeleteConfigurationSetRequestRequestTypeDef usage example

from mypy_boto3_sms_voice.type_defs import DeleteConfigurationSetRequestRequestTypeDef

def get_value() -> DeleteConfigurationSetRequestRequestTypeDef:
    return {
        "ConfigurationSetName": ...,
    }

# DeleteConfigurationSetRequestRequestTypeDef definition

class DeleteConfigurationSetRequestRequestTypeDef(TypedDict):
    ConfigurationSetName: str,

KinesisFirehoseDestinationTypeDef

# KinesisFirehoseDestinationTypeDef usage example

from mypy_boto3_sms_voice.type_defs import KinesisFirehoseDestinationTypeDef

def get_value() -> KinesisFirehoseDestinationTypeDef:
    return {
        "DeliveryStreamArn": ...,
    }

# KinesisFirehoseDestinationTypeDef definition

class KinesisFirehoseDestinationTypeDef(TypedDict):
    DeliveryStreamArn: NotRequired[str],
    IamRoleArn: NotRequired[str],

SnsDestinationTypeDef

# SnsDestinationTypeDef usage example

from mypy_boto3_sms_voice.type_defs import SnsDestinationTypeDef

def get_value() -> SnsDestinationTypeDef:
    return {
        "TopicArn": ...,
    }

# SnsDestinationTypeDef definition

class SnsDestinationTypeDef(TypedDict):
    TopicArn: NotRequired[str],

GetConfigurationSetEventDestinationsRequestRequestTypeDef

# GetConfigurationSetEventDestinationsRequestRequestTypeDef usage example

from mypy_boto3_sms_voice.type_defs import GetConfigurationSetEventDestinationsRequestRequestTypeDef

def get_value() -> GetConfigurationSetEventDestinationsRequestRequestTypeDef:
    return {
        "ConfigurationSetName": ...,
    }

# GetConfigurationSetEventDestinationsRequestRequestTypeDef definition

class GetConfigurationSetEventDestinationsRequestRequestTypeDef(TypedDict):
    ConfigurationSetName: str,

ListConfigurationSetsRequestRequestTypeDef

# ListConfigurationSetsRequestRequestTypeDef usage example

from mypy_boto3_sms_voice.type_defs import ListConfigurationSetsRequestRequestTypeDef

def get_value() -> ListConfigurationSetsRequestRequestTypeDef:
    return {
        "NextToken": ...,
    }

# ListConfigurationSetsRequestRequestTypeDef definition

class ListConfigurationSetsRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    PageSize: NotRequired[str],

ListConfigurationSetsResponseTypeDef

# ListConfigurationSetsResponseTypeDef usage example

from mypy_boto3_sms_voice.type_defs import ListConfigurationSetsResponseTypeDef

def get_value() -> ListConfigurationSetsResponseTypeDef:
    return {
        "ConfigurationSets": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

# ListConfigurationSetsResponseTypeDef definition

class ListConfigurationSetsResponseTypeDef(TypedDict):
    ConfigurationSets: List[str],
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

PlainTextMessageTypeTypeDef

# PlainTextMessageTypeTypeDef usage example

from mypy_boto3_sms_voice.type_defs import PlainTextMessageTypeTypeDef

def get_value() -> PlainTextMessageTypeTypeDef:
    return {
        "LanguageCode": ...,
    }

# PlainTextMessageTypeTypeDef definition

class PlainTextMessageTypeTypeDef(TypedDict):
    LanguageCode: NotRequired[str],
    Text: NotRequired[str],
    VoiceId: NotRequired[str],

ResponseMetadataTypeDef

# ResponseMetadataTypeDef usage example

from mypy_boto3_sms_voice.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }

# ResponseMetadataTypeDef definition

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

SSMLMessageTypeTypeDef

# SSMLMessageTypeTypeDef usage example

from mypy_boto3_sms_voice.type_defs import SSMLMessageTypeTypeDef

def get_value() -> SSMLMessageTypeTypeDef:
    return {
        "LanguageCode": ...,
    }

# SSMLMessageTypeTypeDef definition

class SSMLMessageTypeTypeDef(TypedDict):
    LanguageCode: NotRequired[str],
    Text: NotRequired[str],
    VoiceId: NotRequired[str],

SendVoiceMessageResponseTypeDef

# SendVoiceMessageResponseTypeDef usage example

from mypy_boto3_sms_voice.type_defs import SendVoiceMessageResponseTypeDef

def get_value() -> SendVoiceMessageResponseTypeDef:
    return {
        "MessageId": ...,
        "ResponseMetadata": ...,
    }

# SendVoiceMessageResponseTypeDef definition

class SendVoiceMessageResponseTypeDef(TypedDict):
    MessageId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

EventDestinationDefinitionTypeDef

# EventDestinationDefinitionTypeDef usage example

from mypy_boto3_sms_voice.type_defs import EventDestinationDefinitionTypeDef

def get_value() -> EventDestinationDefinitionTypeDef:
    return {
        "CloudWatchLogsDestination": ...,
    }

# EventDestinationDefinitionTypeDef definition

class EventDestinationDefinitionTypeDef(TypedDict):
    CloudWatchLogsDestination: NotRequired[CloudWatchLogsDestinationTypeDef],  # (1)
    Enabled: NotRequired[bool],
    KinesisFirehoseDestination: NotRequired[KinesisFirehoseDestinationTypeDef],  # (2)
    MatchingEventTypes: NotRequired[Sequence[EventTypeType]],  # (3)
    SnsDestination: NotRequired[SnsDestinationTypeDef],  # (4)

1. See CloudWatchLogsDestinationTypeDef
2. See KinesisFirehoseDestinationTypeDef
3. See EventTypeType
4. See SnsDestinationTypeDef

EventDestinationTypeDef

# EventDestinationTypeDef usage example

from mypy_boto3_sms_voice.type_defs import EventDestinationTypeDef

def get_value() -> EventDestinationTypeDef:
    return {
        "CloudWatchLogsDestination": ...,
    }

# EventDestinationTypeDef definition

class EventDestinationTypeDef(TypedDict):
    CloudWatchLogsDestination: NotRequired[CloudWatchLogsDestinationTypeDef],  # (1)
    Enabled: NotRequired[bool],
    KinesisFirehoseDestination: NotRequired[KinesisFirehoseDestinationTypeDef],  # (2)
    MatchingEventTypes: NotRequired[List[EventTypeType]],  # (3)
    Name: NotRequired[str],
    SnsDestination: NotRequired[SnsDestinationTypeDef],  # (4)

1. See CloudWatchLogsDestinationTypeDef
2. See KinesisFirehoseDestinationTypeDef
3. See EventTypeType
4. See SnsDestinationTypeDef

VoiceMessageContentTypeDef

# VoiceMessageContentTypeDef usage example

from mypy_boto3_sms_voice.type_defs import VoiceMessageContentTypeDef

def get_value() -> VoiceMessageContentTypeDef:
    return {
        "CallInstructionsMessage": ...,
    }

# VoiceMessageContentTypeDef definition

class VoiceMessageContentTypeDef(TypedDict):
    CallInstructionsMessage: NotRequired[CallInstructionsMessageTypeTypeDef],  # (1)
    PlainTextMessage: NotRequired[PlainTextMessageTypeTypeDef],  # (2)
    SSMLMessage: NotRequired[SSMLMessageTypeTypeDef],  # (3)

1. See CallInstructionsMessageTypeTypeDef
2. See PlainTextMessageTypeTypeDef
3. See SSMLMessageTypeTypeDef

CreateConfigurationSetEventDestinationRequestRequestTypeDef

# CreateConfigurationSetEventDestinationRequestRequestTypeDef usage example

from mypy_boto3_sms_voice.type_defs import CreateConfigurationSetEventDestinationRequestRequestTypeDef

def get_value() -> CreateConfigurationSetEventDestinationRequestRequestTypeDef:
    return {
        "ConfigurationSetName": ...,
    }

# CreateConfigurationSetEventDestinationRequestRequestTypeDef definition

class CreateConfigurationSetEventDestinationRequestRequestTypeDef(TypedDict):
    ConfigurationSetName: str,
    EventDestination: NotRequired[EventDestinationDefinitionTypeDef],  # (1)
    EventDestinationName: NotRequired[str],

1. See EventDestinationDefinitionTypeDef

UpdateConfigurationSetEventDestinationRequestRequestTypeDef

# UpdateConfigurationSetEventDestinationRequestRequestTypeDef usage example

from mypy_boto3_sms_voice.type_defs import UpdateConfigurationSetEventDestinationRequestRequestTypeDef

def get_value() -> UpdateConfigurationSetEventDestinationRequestRequestTypeDef:
    return {
        "ConfigurationSetName": ...,
        "EventDestinationName": ...,
    }

# UpdateConfigurationSetEventDestinationRequestRequestTypeDef definition

class UpdateConfigurationSetEventDestinationRequestRequestTypeDef(TypedDict):
    ConfigurationSetName: str,
    EventDestinationName: str,
    EventDestination: NotRequired[EventDestinationDefinitionTypeDef],  # (1)

1. See EventDestinationDefinitionTypeDef

GetConfigurationSetEventDestinationsResponseTypeDef

# GetConfigurationSetEventDestinationsResponseTypeDef usage example

from mypy_boto3_sms_voice.type_defs import GetConfigurationSetEventDestinationsResponseTypeDef

def get_value() -> GetConfigurationSetEventDestinationsResponseTypeDef:
    return {
        "EventDestinations": ...,
        "ResponseMetadata": ...,
    }

# GetConfigurationSetEventDestinationsResponseTypeDef definition

class GetConfigurationSetEventDestinationsResponseTypeDef(TypedDict):
    EventDestinations: List[EventDestinationTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See EventDestinationTypeDef
2. See ResponseMetadataTypeDef

SendVoiceMessageRequestRequestTypeDef

# SendVoiceMessageRequestRequestTypeDef usage example

from mypy_boto3_sms_voice.type_defs import SendVoiceMessageRequestRequestTypeDef

def get_value() -> SendVoiceMessageRequestRequestTypeDef:
    return {
        "CallerId": ...,
    }

# SendVoiceMessageRequestRequestTypeDef definition

class SendVoiceMessageRequestRequestTypeDef(TypedDict):
    CallerId: NotRequired[str],
    ConfigurationSetName: NotRequired[str],
    Content: NotRequired[VoiceMessageContentTypeDef],  # (1)
    DestinationPhoneNumber: NotRequired[str],
    OriginationPhoneNumber: NotRequired[str],

1. See VoiceMessageContentTypeDef