Type definitions

Index > PinpointSMSVoice > Type definitions

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

CallInstructionsMessageTypeTypeDef

# CallInstructionsMessageTypeTypeDef TypedDict usage example

from mypy_boto3_pinpoint_sms_voice.type_defs import CallInstructionsMessageTypeTypeDef


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


# CallInstructionsMessageTypeTypeDef definition

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

CloudWatchLogsDestinationTypeDef

# CloudWatchLogsDestinationTypeDef TypedDict usage example

from mypy_boto3_pinpoint_sms_voice.type_defs import CloudWatchLogsDestinationTypeDef


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


# CloudWatchLogsDestinationTypeDef definition

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

CreateConfigurationSetRequestTypeDef

# CreateConfigurationSetRequestTypeDef TypedDict usage example

from mypy_boto3_pinpoint_sms_voice.type_defs import CreateConfigurationSetRequestTypeDef


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


# CreateConfigurationSetRequestTypeDef definition

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

DeleteConfigurationSetEventDestinationRequestTypeDef

# DeleteConfigurationSetEventDestinationRequestTypeDef TypedDict usage example

from mypy_boto3_pinpoint_sms_voice.type_defs import DeleteConfigurationSetEventDestinationRequestTypeDef


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


# DeleteConfigurationSetEventDestinationRequestTypeDef definition

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

DeleteConfigurationSetRequestTypeDef

# DeleteConfigurationSetRequestTypeDef TypedDict usage example

from mypy_boto3_pinpoint_sms_voice.type_defs import DeleteConfigurationSetRequestTypeDef


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


# DeleteConfigurationSetRequestTypeDef definition

class DeleteConfigurationSetRequestTypeDef(TypedDict):
    ConfigurationSetName: str,

KinesisFirehoseDestinationTypeDef

# KinesisFirehoseDestinationTypeDef TypedDict usage example

from mypy_boto3_pinpoint_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 TypedDict usage example

from mypy_boto3_pinpoint_sms_voice.type_defs import SnsDestinationTypeDef


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


# SnsDestinationTypeDef definition

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

GetConfigurationSetEventDestinationsRequestTypeDef

# GetConfigurationSetEventDestinationsRequestTypeDef TypedDict usage example

from mypy_boto3_pinpoint_sms_voice.type_defs import GetConfigurationSetEventDestinationsRequestTypeDef


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


# GetConfigurationSetEventDestinationsRequestTypeDef definition

class GetConfigurationSetEventDestinationsRequestTypeDef(TypedDict):
    ConfigurationSetName: str,

ResponseMetadataTypeDef

# ResponseMetadataTypeDef TypedDict usage example

from mypy_boto3_pinpoint_sms_voice.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],

PlainTextMessageTypeTypeDef

# PlainTextMessageTypeTypeDef TypedDict usage example

from mypy_boto3_pinpoint_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],

SSMLMessageTypeTypeDef

# SSMLMessageTypeTypeDef TypedDict usage example

from mypy_boto3_pinpoint_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],

EventDestinationDefinitionTypeDef

# EventDestinationDefinitionTypeDef TypedDict usage example

from mypy_boto3_pinpoint_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 Sequence[EventTypeType]
4. See SnsDestinationTypeDef

EventDestinationTypeDef

# EventDestinationTypeDef TypedDict usage example

from mypy_boto3_pinpoint_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 List[EventTypeType]
4. See SnsDestinationTypeDef

SendVoiceMessageResponseTypeDef

# SendVoiceMessageResponseTypeDef TypedDict usage example

from mypy_boto3_pinpoint_sms_voice.type_defs import SendVoiceMessageResponseTypeDef


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


# SendVoiceMessageResponseTypeDef definition

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

1. See ResponseMetadataTypeDef

VoiceMessageContentTypeDef

# VoiceMessageContentTypeDef TypedDict usage example

from mypy_boto3_pinpoint_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

CreateConfigurationSetEventDestinationRequestTypeDef

# CreateConfigurationSetEventDestinationRequestTypeDef TypedDict usage example

from mypy_boto3_pinpoint_sms_voice.type_defs import CreateConfigurationSetEventDestinationRequestTypeDef


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


# CreateConfigurationSetEventDestinationRequestTypeDef definition

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

1. See EventDestinationDefinitionTypeDef

UpdateConfigurationSetEventDestinationRequestTypeDef

# UpdateConfigurationSetEventDestinationRequestTypeDef TypedDict usage example

from mypy_boto3_pinpoint_sms_voice.type_defs import UpdateConfigurationSetEventDestinationRequestTypeDef


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


# UpdateConfigurationSetEventDestinationRequestTypeDef definition

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

1. See EventDestinationDefinitionTypeDef

GetConfigurationSetEventDestinationsResponseTypeDef

# GetConfigurationSetEventDestinationsResponseTypeDef TypedDict usage example

from mypy_boto3_pinpoint_sms_voice.type_defs import GetConfigurationSetEventDestinationsResponseTypeDef


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


# GetConfigurationSetEventDestinationsResponseTypeDef definition

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

1. See List[EventDestinationTypeDef]
2. See ResponseMetadataTypeDef

SendVoiceMessageRequestTypeDef

# SendVoiceMessageRequestTypeDef TypedDict usage example

from mypy_boto3_pinpoint_sms_voice.type_defs import SendVoiceMessageRequestTypeDef


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


# SendVoiceMessageRequestTypeDef definition

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

1. See VoiceMessageContentTypeDef