Skip to content

Type definitions#

Index > PinpointSMSVoice > Type definitions

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

CallInstructionsMessageTypeTypeDef#

# CallInstructionsMessageTypeTypeDef definition

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

CloudWatchLogsDestinationTypeDef#

# CloudWatchLogsDestinationTypeDef definition

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

CreateConfigurationSetRequestRequestTypeDef#

# CreateConfigurationSetRequestRequestTypeDef definition

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

DeleteConfigurationSetEventDestinationRequestRequestTypeDef#

# DeleteConfigurationSetEventDestinationRequestRequestTypeDef definition

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

DeleteConfigurationSetRequestRequestTypeDef#

# DeleteConfigurationSetRequestRequestTypeDef definition

class DeleteConfigurationSetRequestRequestTypeDef(TypedDict):
    ConfigurationSetName: str,

KinesisFirehoseDestinationTypeDef#

# KinesisFirehoseDestinationTypeDef definition

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

SnsDestinationTypeDef#

# SnsDestinationTypeDef definition

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

GetConfigurationSetEventDestinationsRequestRequestTypeDef#

# GetConfigurationSetEventDestinationsRequestRequestTypeDef definition

class GetConfigurationSetEventDestinationsRequestRequestTypeDef(TypedDict):
    ConfigurationSetName: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

PlainTextMessageTypeTypeDef#

# PlainTextMessageTypeTypeDef definition

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

SSMLMessageTypeTypeDef#

# SSMLMessageTypeTypeDef definition

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

EventDestinationDefinitionTypeDef#

# 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 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

SendVoiceMessageResponseTypeDef#

# SendVoiceMessageResponseTypeDef definition

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

VoiceMessageContentTypeDef#

# 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 definition

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

UpdateConfigurationSetEventDestinationRequestRequestTypeDef#

# UpdateConfigurationSetEventDestinationRequestRequestTypeDef definition

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

GetConfigurationSetEventDestinationsResponseTypeDef#

# GetConfigurationSetEventDestinationsResponseTypeDef definition

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

SendVoiceMessageRequestRequestTypeDef#

# SendVoiceMessageRequestRequestTypeDef definition

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