Skip to content

Type definitions#

Index > PinpointSMSVoiceV2 > Type definitions

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

AccountAttributeTypeDef#

# AccountAttributeTypeDef definition

class AccountAttributeTypeDef(TypedDict):
    Name: AccountAttributeNameType,  # (1)
    Value: str,
  1. See AccountAttributeNameType

AccountLimitTypeDef#

# AccountLimitTypeDef definition

class AccountLimitTypeDef(TypedDict):
    Name: AccountLimitNameType,  # (1)
    Used: int,
    Max: int,
  1. See AccountLimitNameType

AssociateOriginationIdentityRequestRequestTypeDef#

# AssociateOriginationIdentityRequestRequestTypeDef definition

class AssociateOriginationIdentityRequestRequestTypeDef(TypedDict):
    PoolId: str,
    OriginationIdentity: str,
    IsoCountryCode: str,
    ClientToken: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

CloudWatchLogsDestinationTypeDef#

# CloudWatchLogsDestinationTypeDef definition

class CloudWatchLogsDestinationTypeDef(TypedDict):
    IamRoleArn: str,
    LogGroupArn: str,

ConfigurationSetFilterTypeDef#

# ConfigurationSetFilterTypeDef definition

class ConfigurationSetFilterTypeDef(TypedDict):
    Name: ConfigurationSetFilterNameType,  # (1)
    Values: Sequence[str],
  1. See ConfigurationSetFilterNameType

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

KinesisFirehoseDestinationTypeDef#

# KinesisFirehoseDestinationTypeDef definition

class KinesisFirehoseDestinationTypeDef(TypedDict):
    IamRoleArn: str,
    DeliveryStreamArn: str,

SnsDestinationTypeDef#

# SnsDestinationTypeDef definition

class SnsDestinationTypeDef(TypedDict):
    TopicArn: str,

DeleteConfigurationSetRequestRequestTypeDef#

# DeleteConfigurationSetRequestRequestTypeDef definition

class DeleteConfigurationSetRequestRequestTypeDef(TypedDict):
    ConfigurationSetName: str,

DeleteDefaultMessageTypeRequestRequestTypeDef#

# DeleteDefaultMessageTypeRequestRequestTypeDef definition

class DeleteDefaultMessageTypeRequestRequestTypeDef(TypedDict):
    ConfigurationSetName: str,

DeleteDefaultSenderIdRequestRequestTypeDef#

# DeleteDefaultSenderIdRequestRequestTypeDef definition

class DeleteDefaultSenderIdRequestRequestTypeDef(TypedDict):
    ConfigurationSetName: str,

DeleteEventDestinationRequestRequestTypeDef#

# DeleteEventDestinationRequestRequestTypeDef definition

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

DeleteKeywordRequestRequestTypeDef#

# DeleteKeywordRequestRequestTypeDef definition

class DeleteKeywordRequestRequestTypeDef(TypedDict):
    OriginationIdentity: str,
    Keyword: str,

DeleteOptOutListRequestRequestTypeDef#

# DeleteOptOutListRequestRequestTypeDef definition

class DeleteOptOutListRequestRequestTypeDef(TypedDict):
    OptOutListName: str,

DeleteOptedOutNumberRequestRequestTypeDef#

# DeleteOptedOutNumberRequestRequestTypeDef definition

class DeleteOptedOutNumberRequestRequestTypeDef(TypedDict):
    OptOutListName: str,
    OptedOutNumber: str,

DeletePoolRequestRequestTypeDef#

# DeletePoolRequestRequestTypeDef definition

class DeletePoolRequestRequestTypeDef(TypedDict):
    PoolId: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

DescribeAccountAttributesRequestRequestTypeDef#

# DescribeAccountAttributesRequestRequestTypeDef definition

class DescribeAccountAttributesRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

DescribeAccountLimitsRequestRequestTypeDef#

# DescribeAccountLimitsRequestRequestTypeDef definition

class DescribeAccountLimitsRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

KeywordFilterTypeDef#

# KeywordFilterTypeDef definition

class KeywordFilterTypeDef(TypedDict):
    Name: KeywordFilterNameType,  # (1)
    Values: Sequence[str],
  1. See KeywordFilterNameType

KeywordInformationTypeDef#

# KeywordInformationTypeDef definition

class KeywordInformationTypeDef(TypedDict):
    Keyword: str,
    KeywordMessage: str,
    KeywordAction: KeywordActionType,  # (1)
  1. See KeywordActionType

DescribeOptOutListsRequestRequestTypeDef#

# DescribeOptOutListsRequestRequestTypeDef definition

class DescribeOptOutListsRequestRequestTypeDef(TypedDict):
    OptOutListNames: NotRequired[Sequence[str]],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

OptOutListInformationTypeDef#

# OptOutListInformationTypeDef definition

class OptOutListInformationTypeDef(TypedDict):
    OptOutListArn: str,
    OptOutListName: str,
    CreatedTimestamp: datetime,

OptedOutFilterTypeDef#

# OptedOutFilterTypeDef definition

class OptedOutFilterTypeDef(TypedDict):
    Name: OptedOutFilterNameType,  # (1)
    Values: Sequence[str],
  1. See OptedOutFilterNameType

OptedOutNumberInformationTypeDef#

# OptedOutNumberInformationTypeDef definition

class OptedOutNumberInformationTypeDef(TypedDict):
    OptedOutNumber: str,
    OptedOutTimestamp: datetime,
    EndUserOptedOut: bool,

PhoneNumberFilterTypeDef#

# PhoneNumberFilterTypeDef definition

class PhoneNumberFilterTypeDef(TypedDict):
    Name: PhoneNumberFilterNameType,  # (1)
    Values: Sequence[str],
  1. See PhoneNumberFilterNameType

PhoneNumberInformationTypeDef#

# PhoneNumberInformationTypeDef definition

class PhoneNumberInformationTypeDef(TypedDict):
    PhoneNumberArn: str,
    PhoneNumber: str,
    Status: NumberStatusType,  # (1)
    IsoCountryCode: str,
    MessageType: MessageTypeType,  # (2)
    NumberCapabilities: List[NumberCapabilityType],  # (3)
    NumberType: NumberTypeType,  # (4)
    MonthlyLeasingPrice: str,
    TwoWayEnabled: bool,
    SelfManagedOptOutsEnabled: bool,
    OptOutListName: str,
    DeletionProtectionEnabled: bool,
    CreatedTimestamp: datetime,
    PhoneNumberId: NotRequired[str],
    TwoWayChannelArn: NotRequired[str],
    PoolId: NotRequired[str],
  1. See NumberStatusType
  2. See MessageTypeType
  3. See NumberCapabilityType
  4. See NumberTypeType

PoolFilterTypeDef#

# PoolFilterTypeDef definition

class PoolFilterTypeDef(TypedDict):
    Name: PoolFilterNameType,  # (1)
    Values: Sequence[str],
  1. See PoolFilterNameType

PoolInformationTypeDef#

# PoolInformationTypeDef definition

class PoolInformationTypeDef(TypedDict):
    PoolArn: str,
    PoolId: str,
    Status: PoolStatusType,  # (1)
    MessageType: MessageTypeType,  # (2)
    TwoWayEnabled: bool,
    SelfManagedOptOutsEnabled: bool,
    OptOutListName: str,
    SharedRoutesEnabled: bool,
    DeletionProtectionEnabled: bool,
    CreatedTimestamp: datetime,
    TwoWayChannelArn: NotRequired[str],
  1. See PoolStatusType
  2. See MessageTypeType

SenderIdAndCountryTypeDef#

# SenderIdAndCountryTypeDef definition

class SenderIdAndCountryTypeDef(TypedDict):
    SenderId: str,
    IsoCountryCode: str,

SenderIdFilterTypeDef#

# SenderIdFilterTypeDef definition

class SenderIdFilterTypeDef(TypedDict):
    Name: SenderIdFilterNameType,  # (1)
    Values: Sequence[str],
  1. See SenderIdFilterNameType

SenderIdInformationTypeDef#

# SenderIdInformationTypeDef definition

class SenderIdInformationTypeDef(TypedDict):
    SenderIdArn: str,
    SenderId: str,
    IsoCountryCode: str,
    MessageTypes: List[MessageTypeType],  # (1)
    MonthlyLeasingPrice: str,
  1. See MessageTypeType

DescribeSpendLimitsRequestRequestTypeDef#

# DescribeSpendLimitsRequestRequestTypeDef definition

class DescribeSpendLimitsRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

SpendLimitTypeDef#

# SpendLimitTypeDef definition

class SpendLimitTypeDef(TypedDict):
    Name: SpendLimitNameType,  # (1)
    EnforcedLimit: int,
    MaxLimit: int,
    Overridden: bool,
  1. See SpendLimitNameType

DisassociateOriginationIdentityRequestRequestTypeDef#

# DisassociateOriginationIdentityRequestRequestTypeDef definition

class DisassociateOriginationIdentityRequestRequestTypeDef(TypedDict):
    PoolId: str,
    OriginationIdentity: str,
    IsoCountryCode: str,
    ClientToken: NotRequired[str],

PoolOriginationIdentitiesFilterTypeDef#

# PoolOriginationIdentitiesFilterTypeDef definition

class PoolOriginationIdentitiesFilterTypeDef(TypedDict):
    Name: PoolOriginationIdentitiesFilterNameType,  # (1)
    Values: Sequence[str],
  1. See PoolOriginationIdentitiesFilterNameType

OriginationIdentityMetadataTypeDef#

# OriginationIdentityMetadataTypeDef definition

class OriginationIdentityMetadataTypeDef(TypedDict):
    OriginationIdentityArn: str,
    OriginationIdentity: str,
    IsoCountryCode: str,
    NumberCapabilities: List[NumberCapabilityType],  # (1)
  1. See NumberCapabilityType

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

PutKeywordRequestRequestTypeDef#

# PutKeywordRequestRequestTypeDef definition

class PutKeywordRequestRequestTypeDef(TypedDict):
    OriginationIdentity: str,
    Keyword: str,
    KeywordMessage: str,
    KeywordAction: NotRequired[KeywordActionType],  # (1)
  1. See KeywordActionType

PutOptedOutNumberRequestRequestTypeDef#

# PutOptedOutNumberRequestRequestTypeDef definition

class PutOptedOutNumberRequestRequestTypeDef(TypedDict):
    OptOutListName: str,
    OptedOutNumber: str,

ReleasePhoneNumberRequestRequestTypeDef#

# ReleasePhoneNumberRequestRequestTypeDef definition

class ReleasePhoneNumberRequestRequestTypeDef(TypedDict):
    PhoneNumberId: str,

SendTextMessageRequestRequestTypeDef#

# SendTextMessageRequestRequestTypeDef definition

class SendTextMessageRequestRequestTypeDef(TypedDict):
    DestinationPhoneNumber: str,
    OriginationIdentity: NotRequired[str],
    MessageBody: NotRequired[str],
    MessageType: NotRequired[MessageTypeType],  # (1)
    Keyword: NotRequired[str],
    ConfigurationSetName: NotRequired[str],
    MaxPrice: NotRequired[str],
    TimeToLive: NotRequired[int],
    Context: NotRequired[Mapping[str, str]],
    DestinationCountryParameters: NotRequired[Mapping[DestinationCountryParameterKeyType, str]],  # (2)
    DryRun: NotRequired[bool],
  1. See MessageTypeType
  2. See DestinationCountryParameterKeyType

SendVoiceMessageRequestRequestTypeDef#

# SendVoiceMessageRequestRequestTypeDef definition

class SendVoiceMessageRequestRequestTypeDef(TypedDict):
    DestinationPhoneNumber: str,
    OriginationIdentity: str,
    MessageBody: NotRequired[str],
    MessageBodyTextType: NotRequired[VoiceMessageBodyTextTypeType],  # (1)
    VoiceId: NotRequired[VoiceIdType],  # (2)
    ConfigurationSetName: NotRequired[str],
    MaxPricePerMinute: NotRequired[str],
    TimeToLive: NotRequired[int],
    Context: NotRequired[Mapping[str, str]],
    DryRun: NotRequired[bool],
  1. See VoiceMessageBodyTextTypeType
  2. See VoiceIdType

SetDefaultMessageTypeRequestRequestTypeDef#

# SetDefaultMessageTypeRequestRequestTypeDef definition

class SetDefaultMessageTypeRequestRequestTypeDef(TypedDict):
    ConfigurationSetName: str,
    MessageType: MessageTypeType,  # (1)
  1. See MessageTypeType

SetDefaultSenderIdRequestRequestTypeDef#

# SetDefaultSenderIdRequestRequestTypeDef definition

class SetDefaultSenderIdRequestRequestTypeDef(TypedDict):
    ConfigurationSetName: str,
    SenderId: str,

SetTextMessageSpendLimitOverrideRequestRequestTypeDef#

# SetTextMessageSpendLimitOverrideRequestRequestTypeDef definition

class SetTextMessageSpendLimitOverrideRequestRequestTypeDef(TypedDict):
    MonthlyLimit: int,

SetVoiceMessageSpendLimitOverrideRequestRequestTypeDef#

# SetVoiceMessageSpendLimitOverrideRequestRequestTypeDef definition

class SetVoiceMessageSpendLimitOverrideRequestRequestTypeDef(TypedDict):
    MonthlyLimit: int,

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    TagKeys: Sequence[str],

UpdatePhoneNumberRequestRequestTypeDef#

# UpdatePhoneNumberRequestRequestTypeDef definition

class UpdatePhoneNumberRequestRequestTypeDef(TypedDict):
    PhoneNumberId: str,
    TwoWayEnabled: NotRequired[bool],
    TwoWayChannelArn: NotRequired[str],
    SelfManagedOptOutsEnabled: NotRequired[bool],
    OptOutListName: NotRequired[str],
    DeletionProtectionEnabled: NotRequired[bool],

UpdatePoolRequestRequestTypeDef#

# UpdatePoolRequestRequestTypeDef definition

class UpdatePoolRequestRequestTypeDef(TypedDict):
    PoolId: str,
    TwoWayEnabled: NotRequired[bool],
    TwoWayChannelArn: NotRequired[str],
    SelfManagedOptOutsEnabled: NotRequired[bool],
    OptOutListName: NotRequired[str],
    SharedRoutesEnabled: NotRequired[bool],
    DeletionProtectionEnabled: NotRequired[bool],

AssociateOriginationIdentityResultTypeDef#

# AssociateOriginationIdentityResultTypeDef definition

class AssociateOriginationIdentityResultTypeDef(TypedDict):
    PoolArn: str,
    PoolId: str,
    OriginationIdentityArn: str,
    OriginationIdentity: str,
    IsoCountryCode: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteDefaultMessageTypeResultTypeDef#

# DeleteDefaultMessageTypeResultTypeDef definition

class DeleteDefaultMessageTypeResultTypeDef(TypedDict):
    ConfigurationSetArn: str,
    ConfigurationSetName: str,
    MessageType: MessageTypeType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MessageTypeType
  2. See ResponseMetadataTypeDef

DeleteDefaultSenderIdResultTypeDef#

# DeleteDefaultSenderIdResultTypeDef definition

class DeleteDefaultSenderIdResultTypeDef(TypedDict):
    ConfigurationSetArn: str,
    ConfigurationSetName: str,
    SenderId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteKeywordResultTypeDef#

# DeleteKeywordResultTypeDef definition

class DeleteKeywordResultTypeDef(TypedDict):
    OriginationIdentityArn: str,
    OriginationIdentity: str,
    Keyword: str,
    KeywordMessage: str,
    KeywordAction: KeywordActionType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See KeywordActionType
  2. See ResponseMetadataTypeDef

DeleteOptOutListResultTypeDef#

# DeleteOptOutListResultTypeDef definition

class DeleteOptOutListResultTypeDef(TypedDict):
    OptOutListArn: str,
    OptOutListName: str,
    CreatedTimestamp: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteOptedOutNumberResultTypeDef#

# DeleteOptedOutNumberResultTypeDef definition

class DeleteOptedOutNumberResultTypeDef(TypedDict):
    OptOutListArn: str,
    OptOutListName: str,
    OptedOutNumber: str,
    OptedOutTimestamp: datetime,
    EndUserOptedOut: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeletePoolResultTypeDef#

# DeletePoolResultTypeDef definition

class DeletePoolResultTypeDef(TypedDict):
    PoolArn: str,
    PoolId: str,
    Status: PoolStatusType,  # (1)
    MessageType: MessageTypeType,  # (2)
    TwoWayEnabled: bool,
    TwoWayChannelArn: str,
    SelfManagedOptOutsEnabled: bool,
    OptOutListName: str,
    SharedRoutesEnabled: bool,
    CreatedTimestamp: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See PoolStatusType
  2. See MessageTypeType
  3. See ResponseMetadataTypeDef

DeleteTextMessageSpendLimitOverrideResultTypeDef#

# DeleteTextMessageSpendLimitOverrideResultTypeDef definition

class DeleteTextMessageSpendLimitOverrideResultTypeDef(TypedDict):
    MonthlyLimit: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteVoiceMessageSpendLimitOverrideResultTypeDef#

# DeleteVoiceMessageSpendLimitOverrideResultTypeDef definition

class DeleteVoiceMessageSpendLimitOverrideResultTypeDef(TypedDict):
    MonthlyLimit: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeAccountAttributesResultTypeDef#

# DescribeAccountAttributesResultTypeDef definition

class DescribeAccountAttributesResultTypeDef(TypedDict):
    AccountAttributes: List[AccountAttributeTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AccountAttributeTypeDef
  2. See ResponseMetadataTypeDef

DescribeAccountLimitsResultTypeDef#

# DescribeAccountLimitsResultTypeDef definition

class DescribeAccountLimitsResultTypeDef(TypedDict):
    AccountLimits: List[AccountLimitTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AccountLimitTypeDef
  2. See ResponseMetadataTypeDef

DisassociateOriginationIdentityResultTypeDef#

# DisassociateOriginationIdentityResultTypeDef definition

class DisassociateOriginationIdentityResultTypeDef(TypedDict):
    PoolArn: str,
    PoolId: str,
    OriginationIdentityArn: str,
    OriginationIdentity: str,
    IsoCountryCode: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

PutKeywordResultTypeDef#

# PutKeywordResultTypeDef definition

class PutKeywordResultTypeDef(TypedDict):
    OriginationIdentityArn: str,
    OriginationIdentity: str,
    Keyword: str,
    KeywordMessage: str,
    KeywordAction: KeywordActionType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See KeywordActionType
  2. See ResponseMetadataTypeDef

PutOptedOutNumberResultTypeDef#

# PutOptedOutNumberResultTypeDef definition

class PutOptedOutNumberResultTypeDef(TypedDict):
    OptOutListArn: str,
    OptOutListName: str,
    OptedOutNumber: str,
    OptedOutTimestamp: datetime,
    EndUserOptedOut: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ReleasePhoneNumberResultTypeDef#

# ReleasePhoneNumberResultTypeDef definition

class ReleasePhoneNumberResultTypeDef(TypedDict):
    PhoneNumberArn: str,
    PhoneNumberId: str,
    PhoneNumber: str,
    Status: NumberStatusType,  # (1)
    IsoCountryCode: str,
    MessageType: MessageTypeType,  # (2)
    NumberCapabilities: List[NumberCapabilityType],  # (3)
    NumberType: NumberTypeType,  # (4)
    MonthlyLeasingPrice: str,
    TwoWayEnabled: bool,
    TwoWayChannelArn: str,
    SelfManagedOptOutsEnabled: bool,
    OptOutListName: str,
    CreatedTimestamp: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See NumberStatusType
  2. See MessageTypeType
  3. See NumberCapabilityType
  4. See NumberTypeType
  5. See ResponseMetadataTypeDef

SendTextMessageResultTypeDef#

# SendTextMessageResultTypeDef definition

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

SendVoiceMessageResultTypeDef#

# SendVoiceMessageResultTypeDef definition

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

SetDefaultMessageTypeResultTypeDef#

# SetDefaultMessageTypeResultTypeDef definition

class SetDefaultMessageTypeResultTypeDef(TypedDict):
    ConfigurationSetArn: str,
    ConfigurationSetName: str,
    MessageType: MessageTypeType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MessageTypeType
  2. See ResponseMetadataTypeDef

SetDefaultSenderIdResultTypeDef#

# SetDefaultSenderIdResultTypeDef definition

class SetDefaultSenderIdResultTypeDef(TypedDict):
    ConfigurationSetArn: str,
    ConfigurationSetName: str,
    SenderId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

SetTextMessageSpendLimitOverrideResultTypeDef#

# SetTextMessageSpendLimitOverrideResultTypeDef definition

class SetTextMessageSpendLimitOverrideResultTypeDef(TypedDict):
    MonthlyLimit: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

SetVoiceMessageSpendLimitOverrideResultTypeDef#

# SetVoiceMessageSpendLimitOverrideResultTypeDef definition

class SetVoiceMessageSpendLimitOverrideResultTypeDef(TypedDict):
    MonthlyLimit: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdatePhoneNumberResultTypeDef#

# UpdatePhoneNumberResultTypeDef definition

class UpdatePhoneNumberResultTypeDef(TypedDict):
    PhoneNumberArn: str,
    PhoneNumberId: str,
    PhoneNumber: str,
    Status: NumberStatusType,  # (1)
    IsoCountryCode: str,
    MessageType: MessageTypeType,  # (2)
    NumberCapabilities: List[NumberCapabilityType],  # (3)
    NumberType: NumberTypeType,  # (4)
    MonthlyLeasingPrice: str,
    TwoWayEnabled: bool,
    TwoWayChannelArn: str,
    SelfManagedOptOutsEnabled: bool,
    OptOutListName: str,
    DeletionProtectionEnabled: bool,
    CreatedTimestamp: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See NumberStatusType
  2. See MessageTypeType
  3. See NumberCapabilityType
  4. See NumberTypeType
  5. See ResponseMetadataTypeDef

UpdatePoolResultTypeDef#

# UpdatePoolResultTypeDef definition

class UpdatePoolResultTypeDef(TypedDict):
    PoolArn: str,
    PoolId: str,
    Status: PoolStatusType,  # (1)
    MessageType: MessageTypeType,  # (2)
    TwoWayEnabled: bool,
    TwoWayChannelArn: str,
    SelfManagedOptOutsEnabled: bool,
    OptOutListName: str,
    SharedRoutesEnabled: bool,
    DeletionProtectionEnabled: bool,
    CreatedTimestamp: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See PoolStatusType
  2. See MessageTypeType
  3. See ResponseMetadataTypeDef

DescribeConfigurationSetsRequestRequestTypeDef#

# DescribeConfigurationSetsRequestRequestTypeDef definition

class DescribeConfigurationSetsRequestRequestTypeDef(TypedDict):
    ConfigurationSetNames: NotRequired[Sequence[str]],
    Filters: NotRequired[Sequence[ConfigurationSetFilterTypeDef]],  # (1)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
  1. See ConfigurationSetFilterTypeDef

CreateConfigurationSetRequestRequestTypeDef#

# CreateConfigurationSetRequestRequestTypeDef definition

class CreateConfigurationSetRequestRequestTypeDef(TypedDict):
    ConfigurationSetName: str,
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
    ClientToken: NotRequired[str],
  1. See TagTypeDef

CreateConfigurationSetResultTypeDef#

# CreateConfigurationSetResultTypeDef definition

class CreateConfigurationSetResultTypeDef(TypedDict):
    ConfigurationSetArn: str,
    ConfigurationSetName: str,
    Tags: List[TagTypeDef],  # (1)
    CreatedTimestamp: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

CreateOptOutListRequestRequestTypeDef#

# CreateOptOutListRequestRequestTypeDef definition

class CreateOptOutListRequestRequestTypeDef(TypedDict):
    OptOutListName: str,
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
    ClientToken: NotRequired[str],
  1. See TagTypeDef

CreateOptOutListResultTypeDef#

# CreateOptOutListResultTypeDef definition

class CreateOptOutListResultTypeDef(TypedDict):
    OptOutListArn: str,
    OptOutListName: str,
    Tags: List[TagTypeDef],  # (1)
    CreatedTimestamp: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

CreatePoolRequestRequestTypeDef#

# CreatePoolRequestRequestTypeDef definition

class CreatePoolRequestRequestTypeDef(TypedDict):
    OriginationIdentity: str,
    IsoCountryCode: str,
    MessageType: MessageTypeType,  # (1)
    DeletionProtectionEnabled: NotRequired[bool],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
    ClientToken: NotRequired[str],
  1. See MessageTypeType
  2. See TagTypeDef

CreatePoolResultTypeDef#

# CreatePoolResultTypeDef definition

class CreatePoolResultTypeDef(TypedDict):
    PoolArn: str,
    PoolId: str,
    Status: PoolStatusType,  # (1)
    MessageType: MessageTypeType,  # (2)
    TwoWayEnabled: bool,
    TwoWayChannelArn: str,
    SelfManagedOptOutsEnabled: bool,
    OptOutListName: str,
    SharedRoutesEnabled: bool,
    DeletionProtectionEnabled: bool,
    Tags: List[TagTypeDef],  # (3)
    CreatedTimestamp: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See PoolStatusType
  2. See MessageTypeType
  3. See TagTypeDef
  4. See ResponseMetadataTypeDef

ListTagsForResourceResultTypeDef#

# ListTagsForResourceResultTypeDef definition

class ListTagsForResourceResultTypeDef(TypedDict):
    ResourceArn: str,
    Tags: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

RequestPhoneNumberRequestRequestTypeDef#

# RequestPhoneNumberRequestRequestTypeDef definition

class RequestPhoneNumberRequestRequestTypeDef(TypedDict):
    IsoCountryCode: str,
    MessageType: MessageTypeType,  # (1)
    NumberCapabilities: Sequence[NumberCapabilityType],  # (2)
    NumberType: RequestableNumberTypeType,  # (3)
    OptOutListName: NotRequired[str],
    PoolId: NotRequired[str],
    RegistrationId: NotRequired[str],
    DeletionProtectionEnabled: NotRequired[bool],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (4)
    ClientToken: NotRequired[str],
  1. See MessageTypeType
  2. See NumberCapabilityType
  3. See RequestableNumberTypeType
  4. See TagTypeDef

RequestPhoneNumberResultTypeDef#

# RequestPhoneNumberResultTypeDef definition

class RequestPhoneNumberResultTypeDef(TypedDict):
    PhoneNumberArn: str,
    PhoneNumberId: str,
    PhoneNumber: str,
    Status: NumberStatusType,  # (1)
    IsoCountryCode: str,
    MessageType: MessageTypeType,  # (2)
    NumberCapabilities: List[NumberCapabilityType],  # (3)
    NumberType: RequestableNumberTypeType,  # (4)
    MonthlyLeasingPrice: str,
    TwoWayEnabled: bool,
    TwoWayChannelArn: str,
    SelfManagedOptOutsEnabled: bool,
    OptOutListName: str,
    DeletionProtectionEnabled: bool,
    PoolId: str,
    Tags: List[TagTypeDef],  # (5)
    CreatedTimestamp: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)
  1. See NumberStatusType
  2. See MessageTypeType
  3. See NumberCapabilityType
  4. See RequestableNumberTypeType
  5. See TagTypeDef
  6. See ResponseMetadataTypeDef

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

CreateEventDestinationRequestRequestTypeDef#

# CreateEventDestinationRequestRequestTypeDef definition

class CreateEventDestinationRequestRequestTypeDef(TypedDict):
    ConfigurationSetName: str,
    EventDestinationName: str,
    MatchingEventTypes: Sequence[EventTypeType],  # (1)
    CloudWatchLogsDestination: NotRequired[CloudWatchLogsDestinationTypeDef],  # (2)
    KinesisFirehoseDestination: NotRequired[KinesisFirehoseDestinationTypeDef],  # (3)
    SnsDestination: NotRequired[SnsDestinationTypeDef],  # (4)
    ClientToken: NotRequired[str],
  1. See EventTypeType
  2. See CloudWatchLogsDestinationTypeDef
  3. See KinesisFirehoseDestinationTypeDef
  4. See SnsDestinationTypeDef

EventDestinationTypeDef#

# EventDestinationTypeDef definition

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

UpdateEventDestinationRequestRequestTypeDef#

# UpdateEventDestinationRequestRequestTypeDef definition

class UpdateEventDestinationRequestRequestTypeDef(TypedDict):
    ConfigurationSetName: str,
    EventDestinationName: str,
    Enabled: NotRequired[bool],
    MatchingEventTypes: NotRequired[Sequence[EventTypeType]],  # (1)
    CloudWatchLogsDestination: NotRequired[CloudWatchLogsDestinationTypeDef],  # (2)
    KinesisFirehoseDestination: NotRequired[KinesisFirehoseDestinationTypeDef],  # (3)
    SnsDestination: NotRequired[SnsDestinationTypeDef],  # (4)
  1. See EventTypeType
  2. See CloudWatchLogsDestinationTypeDef
  3. See KinesisFirehoseDestinationTypeDef
  4. See SnsDestinationTypeDef

DescribeAccountAttributesRequestDescribeAccountAttributesPaginateTypeDef#

# DescribeAccountAttributesRequestDescribeAccountAttributesPaginateTypeDef definition

class DescribeAccountAttributesRequestDescribeAccountAttributesPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeAccountLimitsRequestDescribeAccountLimitsPaginateTypeDef#

# DescribeAccountLimitsRequestDescribeAccountLimitsPaginateTypeDef definition

class DescribeAccountLimitsRequestDescribeAccountLimitsPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeConfigurationSetsRequestDescribeConfigurationSetsPaginateTypeDef#

# DescribeConfigurationSetsRequestDescribeConfigurationSetsPaginateTypeDef definition

class DescribeConfigurationSetsRequestDescribeConfigurationSetsPaginateTypeDef(TypedDict):
    ConfigurationSetNames: NotRequired[Sequence[str]],
    Filters: NotRequired[Sequence[ConfigurationSetFilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See ConfigurationSetFilterTypeDef
  2. See PaginatorConfigTypeDef

DescribeOptOutListsRequestDescribeOptOutListsPaginateTypeDef#

# DescribeOptOutListsRequestDescribeOptOutListsPaginateTypeDef definition

class DescribeOptOutListsRequestDescribeOptOutListsPaginateTypeDef(TypedDict):
    OptOutListNames: NotRequired[Sequence[str]],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeSpendLimitsRequestDescribeSpendLimitsPaginateTypeDef#

# DescribeSpendLimitsRequestDescribeSpendLimitsPaginateTypeDef definition

class DescribeSpendLimitsRequestDescribeSpendLimitsPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeKeywordsRequestDescribeKeywordsPaginateTypeDef#

# DescribeKeywordsRequestDescribeKeywordsPaginateTypeDef definition

class DescribeKeywordsRequestDescribeKeywordsPaginateTypeDef(TypedDict):
    OriginationIdentity: str,
    Keywords: NotRequired[Sequence[str]],
    Filters: NotRequired[Sequence[KeywordFilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See KeywordFilterTypeDef
  2. See PaginatorConfigTypeDef

DescribeKeywordsRequestRequestTypeDef#

# DescribeKeywordsRequestRequestTypeDef definition

class DescribeKeywordsRequestRequestTypeDef(TypedDict):
    OriginationIdentity: str,
    Keywords: NotRequired[Sequence[str]],
    Filters: NotRequired[Sequence[KeywordFilterTypeDef]],  # (1)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
  1. See KeywordFilterTypeDef

DescribeKeywordsResultTypeDef#

# DescribeKeywordsResultTypeDef definition

class DescribeKeywordsResultTypeDef(TypedDict):
    OriginationIdentityArn: str,
    OriginationIdentity: str,
    Keywords: List[KeywordInformationTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See KeywordInformationTypeDef
  2. See ResponseMetadataTypeDef

DescribeOptOutListsResultTypeDef#

# DescribeOptOutListsResultTypeDef definition

class DescribeOptOutListsResultTypeDef(TypedDict):
    OptOutLists: List[OptOutListInformationTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See OptOutListInformationTypeDef
  2. See ResponseMetadataTypeDef

DescribeOptedOutNumbersRequestDescribeOptedOutNumbersPaginateTypeDef#

# DescribeOptedOutNumbersRequestDescribeOptedOutNumbersPaginateTypeDef definition

class DescribeOptedOutNumbersRequestDescribeOptedOutNumbersPaginateTypeDef(TypedDict):
    OptOutListName: str,
    OptedOutNumbers: NotRequired[Sequence[str]],
    Filters: NotRequired[Sequence[OptedOutFilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See OptedOutFilterTypeDef
  2. See PaginatorConfigTypeDef

DescribeOptedOutNumbersRequestRequestTypeDef#

# DescribeOptedOutNumbersRequestRequestTypeDef definition

class DescribeOptedOutNumbersRequestRequestTypeDef(TypedDict):
    OptOutListName: str,
    OptedOutNumbers: NotRequired[Sequence[str]],
    Filters: NotRequired[Sequence[OptedOutFilterTypeDef]],  # (1)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
  1. See OptedOutFilterTypeDef

DescribeOptedOutNumbersResultTypeDef#

# DescribeOptedOutNumbersResultTypeDef definition

class DescribeOptedOutNumbersResultTypeDef(TypedDict):
    OptOutListArn: str,
    OptOutListName: str,
    OptedOutNumbers: List[OptedOutNumberInformationTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See OptedOutNumberInformationTypeDef
  2. See ResponseMetadataTypeDef

DescribePhoneNumbersRequestDescribePhoneNumbersPaginateTypeDef#

# DescribePhoneNumbersRequestDescribePhoneNumbersPaginateTypeDef definition

class DescribePhoneNumbersRequestDescribePhoneNumbersPaginateTypeDef(TypedDict):
    PhoneNumberIds: NotRequired[Sequence[str]],
    Filters: NotRequired[Sequence[PhoneNumberFilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See PhoneNumberFilterTypeDef
  2. See PaginatorConfigTypeDef

DescribePhoneNumbersRequestRequestTypeDef#

# DescribePhoneNumbersRequestRequestTypeDef definition

class DescribePhoneNumbersRequestRequestTypeDef(TypedDict):
    PhoneNumberIds: NotRequired[Sequence[str]],
    Filters: NotRequired[Sequence[PhoneNumberFilterTypeDef]],  # (1)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
  1. See PhoneNumberFilterTypeDef

DescribePhoneNumbersResultTypeDef#

# DescribePhoneNumbersResultTypeDef definition

class DescribePhoneNumbersResultTypeDef(TypedDict):
    PhoneNumbers: List[PhoneNumberInformationTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PhoneNumberInformationTypeDef
  2. See ResponseMetadataTypeDef

DescribePoolsRequestDescribePoolsPaginateTypeDef#

# DescribePoolsRequestDescribePoolsPaginateTypeDef definition

class DescribePoolsRequestDescribePoolsPaginateTypeDef(TypedDict):
    PoolIds: NotRequired[Sequence[str]],
    Filters: NotRequired[Sequence[PoolFilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See PoolFilterTypeDef
  2. See PaginatorConfigTypeDef

DescribePoolsRequestRequestTypeDef#

# DescribePoolsRequestRequestTypeDef definition

class DescribePoolsRequestRequestTypeDef(TypedDict):
    PoolIds: NotRequired[Sequence[str]],
    Filters: NotRequired[Sequence[PoolFilterTypeDef]],  # (1)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
  1. See PoolFilterTypeDef

DescribePoolsResultTypeDef#

# DescribePoolsResultTypeDef definition

class DescribePoolsResultTypeDef(TypedDict):
    Pools: List[PoolInformationTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PoolInformationTypeDef
  2. See ResponseMetadataTypeDef

DescribeSenderIdsRequestDescribeSenderIdsPaginateTypeDef#

# DescribeSenderIdsRequestDescribeSenderIdsPaginateTypeDef definition

class DescribeSenderIdsRequestDescribeSenderIdsPaginateTypeDef(TypedDict):
    SenderIds: NotRequired[Sequence[SenderIdAndCountryTypeDef]],  # (1)
    Filters: NotRequired[Sequence[SenderIdFilterTypeDef]],  # (2)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)
  1. See SenderIdAndCountryTypeDef
  2. See SenderIdFilterTypeDef
  3. See PaginatorConfigTypeDef

DescribeSenderIdsRequestRequestTypeDef#

# DescribeSenderIdsRequestRequestTypeDef definition

class DescribeSenderIdsRequestRequestTypeDef(TypedDict):
    SenderIds: NotRequired[Sequence[SenderIdAndCountryTypeDef]],  # (1)
    Filters: NotRequired[Sequence[SenderIdFilterTypeDef]],  # (2)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
  1. See SenderIdAndCountryTypeDef
  2. See SenderIdFilterTypeDef

DescribeSenderIdsResultTypeDef#

# DescribeSenderIdsResultTypeDef definition

class DescribeSenderIdsResultTypeDef(TypedDict):
    SenderIds: List[SenderIdInformationTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SenderIdInformationTypeDef
  2. See ResponseMetadataTypeDef

DescribeSpendLimitsResultTypeDef#

# DescribeSpendLimitsResultTypeDef definition

class DescribeSpendLimitsResultTypeDef(TypedDict):
    SpendLimits: List[SpendLimitTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SpendLimitTypeDef
  2. See ResponseMetadataTypeDef

ListPoolOriginationIdentitiesRequestListPoolOriginationIdentitiesPaginateTypeDef#

# ListPoolOriginationIdentitiesRequestListPoolOriginationIdentitiesPaginateTypeDef definition

class ListPoolOriginationIdentitiesRequestListPoolOriginationIdentitiesPaginateTypeDef(TypedDict):
    PoolId: str,
    Filters: NotRequired[Sequence[PoolOriginationIdentitiesFilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See PoolOriginationIdentitiesFilterTypeDef
  2. See PaginatorConfigTypeDef