Skip to content

Type definitions#

Index > SNS > Type definitions

Auto-generated documentation for SNS type annotations stubs module types-boto3-sns.

BlobTypeDef#

# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    StreamingBody,
]

AddPermissionInputRequestTypeDef#

# AddPermissionInputRequestTypeDef definition

class AddPermissionInputRequestTypeDef(TypedDict):
    TopicArn: str,
    Label: str,
    AWSAccountId: Sequence[str],
    ActionName: Sequence[str],

AddPermissionInputTopicAddPermissionTypeDef#

# AddPermissionInputTopicAddPermissionTypeDef definition

class AddPermissionInputTopicAddPermissionTypeDef(TypedDict):
    Label: str,
    AWSAccountId: Sequence[str],
    ActionName: Sequence[str],

BatchResultErrorEntryTypeDef#

# BatchResultErrorEntryTypeDef definition

class BatchResultErrorEntryTypeDef(TypedDict):
    Id: str,
    Code: str,
    SenderFault: bool,
    Message: NotRequired[str],

CheckIfPhoneNumberIsOptedOutInputRequestTypeDef#

# CheckIfPhoneNumberIsOptedOutInputRequestTypeDef definition

class CheckIfPhoneNumberIsOptedOutInputRequestTypeDef(TypedDict):
    phoneNumber: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

ConfirmSubscriptionInputRequestTypeDef#

# ConfirmSubscriptionInputRequestTypeDef definition

class ConfirmSubscriptionInputRequestTypeDef(TypedDict):
    TopicArn: str,
    Token: str,
    AuthenticateOnUnsubscribe: NotRequired[str],

ConfirmSubscriptionInputTopicConfirmSubscriptionTypeDef#

# ConfirmSubscriptionInputTopicConfirmSubscriptionTypeDef definition

class ConfirmSubscriptionInputTopicConfirmSubscriptionTypeDef(TypedDict):
    Token: str,
    AuthenticateOnUnsubscribe: NotRequired[str],

CreatePlatformApplicationInputRequestTypeDef#

# CreatePlatformApplicationInputRequestTypeDef definition

class CreatePlatformApplicationInputRequestTypeDef(TypedDict):
    Name: str,
    Platform: str,
    Attributes: Mapping[str, str],

CreatePlatformApplicationInputServiceResourceCreatePlatformApplicationTypeDef#

# CreatePlatformApplicationInputServiceResourceCreatePlatformApplicationTypeDef definition

class CreatePlatformApplicationInputServiceResourceCreatePlatformApplicationTypeDef(TypedDict):
    Name: str,
    Platform: str,
    Attributes: Mapping[str, str],

CreatePlatformEndpointInputPlatformApplicationCreatePlatformEndpointTypeDef#

# CreatePlatformEndpointInputPlatformApplicationCreatePlatformEndpointTypeDef definition

class CreatePlatformEndpointInputPlatformApplicationCreatePlatformEndpointTypeDef(TypedDict):
    Token: str,
    CustomUserData: NotRequired[str],
    Attributes: NotRequired[Mapping[str, str]],

CreatePlatformEndpointInputRequestTypeDef#

# CreatePlatformEndpointInputRequestTypeDef definition

class CreatePlatformEndpointInputRequestTypeDef(TypedDict):
    PlatformApplicationArn: str,
    Token: str,
    CustomUserData: NotRequired[str],
    Attributes: NotRequired[Mapping[str, str]],

CreateSMSSandboxPhoneNumberInputRequestTypeDef#

# CreateSMSSandboxPhoneNumberInputRequestTypeDef definition

class CreateSMSSandboxPhoneNumberInputRequestTypeDef(TypedDict):
    PhoneNumber: str,
    LanguageCode: NotRequired[LanguageCodeStringType],  # (1)
  1. See LanguageCodeStringType

TagTypeDef#

# TagTypeDef definition

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

DeleteEndpointInputRequestTypeDef#

# DeleteEndpointInputRequestTypeDef definition

class DeleteEndpointInputRequestTypeDef(TypedDict):
    EndpointArn: str,

DeletePlatformApplicationInputRequestTypeDef#

# DeletePlatformApplicationInputRequestTypeDef definition

class DeletePlatformApplicationInputRequestTypeDef(TypedDict):
    PlatformApplicationArn: str,

DeleteSMSSandboxPhoneNumberInputRequestTypeDef#

# DeleteSMSSandboxPhoneNumberInputRequestTypeDef definition

class DeleteSMSSandboxPhoneNumberInputRequestTypeDef(TypedDict):
    PhoneNumber: str,

DeleteTopicInputRequestTypeDef#

# DeleteTopicInputRequestTypeDef definition

class DeleteTopicInputRequestTypeDef(TypedDict):
    TopicArn: str,

EndpointTypeDef#

# EndpointTypeDef definition

class EndpointTypeDef(TypedDict):
    EndpointArn: NotRequired[str],
    Attributes: NotRequired[dict[str, str]],

GetDataProtectionPolicyInputRequestTypeDef#

# GetDataProtectionPolicyInputRequestTypeDef definition

class GetDataProtectionPolicyInputRequestTypeDef(TypedDict):
    ResourceArn: str,

GetEndpointAttributesInputRequestTypeDef#

# GetEndpointAttributesInputRequestTypeDef definition

class GetEndpointAttributesInputRequestTypeDef(TypedDict):
    EndpointArn: str,

GetPlatformApplicationAttributesInputRequestTypeDef#

# GetPlatformApplicationAttributesInputRequestTypeDef definition

class GetPlatformApplicationAttributesInputRequestTypeDef(TypedDict):
    PlatformApplicationArn: str,

GetSMSAttributesInputRequestTypeDef#

# GetSMSAttributesInputRequestTypeDef definition

class GetSMSAttributesInputRequestTypeDef(TypedDict):
    attributes: NotRequired[Sequence[str]],

GetSubscriptionAttributesInputRequestTypeDef#

# GetSubscriptionAttributesInputRequestTypeDef definition

class GetSubscriptionAttributesInputRequestTypeDef(TypedDict):
    SubscriptionArn: str,

GetTopicAttributesInputRequestTypeDef#

# GetTopicAttributesInputRequestTypeDef definition

class GetTopicAttributesInputRequestTypeDef(TypedDict):
    TopicArn: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

ListEndpointsByPlatformApplicationInputRequestTypeDef#

# ListEndpointsByPlatformApplicationInputRequestTypeDef definition

class ListEndpointsByPlatformApplicationInputRequestTypeDef(TypedDict):
    PlatformApplicationArn: str,
    NextToken: NotRequired[str],

ListOriginationNumbersRequestRequestTypeDef#

# ListOriginationNumbersRequestRequestTypeDef definition

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

PhoneNumberInformationTypeDef#

# PhoneNumberInformationTypeDef definition

class PhoneNumberInformationTypeDef(TypedDict):
    CreatedAt: NotRequired[datetime],
    PhoneNumber: NotRequired[str],
    Status: NotRequired[str],
    Iso2CountryCode: NotRequired[str],
    RouteType: NotRequired[RouteTypeType],  # (1)
    NumberCapabilities: NotRequired[list[NumberCapabilityType]],  # (2)
  1. See RouteTypeType
  2. See NumberCapabilityType

ListPhoneNumbersOptedOutInputRequestTypeDef#

# ListPhoneNumbersOptedOutInputRequestTypeDef definition

class ListPhoneNumbersOptedOutInputRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],

ListPlatformApplicationsInputRequestTypeDef#

# ListPlatformApplicationsInputRequestTypeDef definition

class ListPlatformApplicationsInputRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],

PlatformApplicationTypeDef#

# PlatformApplicationTypeDef definition

class PlatformApplicationTypeDef(TypedDict):
    PlatformApplicationArn: NotRequired[str],
    Attributes: NotRequired[dict[str, str]],

ListSMSSandboxPhoneNumbersInputRequestTypeDef#

# ListSMSSandboxPhoneNumbersInputRequestTypeDef definition

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

SMSSandboxPhoneNumberTypeDef#

# SMSSandboxPhoneNumberTypeDef definition

class SMSSandboxPhoneNumberTypeDef(TypedDict):
    PhoneNumber: NotRequired[str],
    Status: NotRequired[SMSSandboxPhoneNumberVerificationStatusType],  # (1)
  1. See SMSSandboxPhoneNumberVerificationStatusType

ListSubscriptionsByTopicInputRequestTypeDef#

# ListSubscriptionsByTopicInputRequestTypeDef definition

class ListSubscriptionsByTopicInputRequestTypeDef(TypedDict):
    TopicArn: str,
    NextToken: NotRequired[str],

SubscriptionTypeDef#

# SubscriptionTypeDef definition

class SubscriptionTypeDef(TypedDict):
    SubscriptionArn: NotRequired[str],
    Owner: NotRequired[str],
    Protocol: NotRequired[str],
    Endpoint: NotRequired[str],
    TopicArn: NotRequired[str],

ListSubscriptionsInputRequestTypeDef#

# ListSubscriptionsInputRequestTypeDef definition

class ListSubscriptionsInputRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

ListTopicsInputRequestTypeDef#

# ListTopicsInputRequestTypeDef definition

class ListTopicsInputRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],

TopicTypeDef#

# TopicTypeDef definition

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

OptInPhoneNumberInputRequestTypeDef#

# OptInPhoneNumberInputRequestTypeDef definition

class OptInPhoneNumberInputRequestTypeDef(TypedDict):
    phoneNumber: str,

PublishBatchResultEntryTypeDef#

# PublishBatchResultEntryTypeDef definition

class PublishBatchResultEntryTypeDef(TypedDict):
    Id: NotRequired[str],
    MessageId: NotRequired[str],
    SequenceNumber: NotRequired[str],

PutDataProtectionPolicyInputRequestTypeDef#

# PutDataProtectionPolicyInputRequestTypeDef definition

class PutDataProtectionPolicyInputRequestTypeDef(TypedDict):
    ResourceArn: str,
    DataProtectionPolicy: str,

RemovePermissionInputRequestTypeDef#

# RemovePermissionInputRequestTypeDef definition

class RemovePermissionInputRequestTypeDef(TypedDict):
    TopicArn: str,
    Label: str,

RemovePermissionInputTopicRemovePermissionTypeDef#

# RemovePermissionInputTopicRemovePermissionTypeDef definition

class RemovePermissionInputTopicRemovePermissionTypeDef(TypedDict):
    Label: str,

SetEndpointAttributesInputPlatformEndpointSetAttributesTypeDef#

# SetEndpointAttributesInputPlatformEndpointSetAttributesTypeDef definition

class SetEndpointAttributesInputPlatformEndpointSetAttributesTypeDef(TypedDict):
    Attributes: Mapping[str, str],

SetEndpointAttributesInputRequestTypeDef#

# SetEndpointAttributesInputRequestTypeDef definition

class SetEndpointAttributesInputRequestTypeDef(TypedDict):
    EndpointArn: str,
    Attributes: Mapping[str, str],

SetPlatformApplicationAttributesInputPlatformApplicationSetAttributesTypeDef#

# SetPlatformApplicationAttributesInputPlatformApplicationSetAttributesTypeDef definition

class SetPlatformApplicationAttributesInputPlatformApplicationSetAttributesTypeDef(TypedDict):
    Attributes: Mapping[str, str],

SetPlatformApplicationAttributesInputRequestTypeDef#

# SetPlatformApplicationAttributesInputRequestTypeDef definition

class SetPlatformApplicationAttributesInputRequestTypeDef(TypedDict):
    PlatformApplicationArn: str,
    Attributes: Mapping[str, str],

SetSMSAttributesInputRequestTypeDef#

# SetSMSAttributesInputRequestTypeDef definition

class SetSMSAttributesInputRequestTypeDef(TypedDict):
    attributes: Mapping[str, str],

SetSubscriptionAttributesInputRequestTypeDef#

# SetSubscriptionAttributesInputRequestTypeDef definition

class SetSubscriptionAttributesInputRequestTypeDef(TypedDict):
    SubscriptionArn: str,
    AttributeName: str,
    AttributeValue: NotRequired[str],

SetSubscriptionAttributesInputSubscriptionSetAttributesTypeDef#

# SetSubscriptionAttributesInputSubscriptionSetAttributesTypeDef definition

class SetSubscriptionAttributesInputSubscriptionSetAttributesTypeDef(TypedDict):
    AttributeName: str,
    AttributeValue: NotRequired[str],

SetTopicAttributesInputRequestTypeDef#

# SetTopicAttributesInputRequestTypeDef definition

class SetTopicAttributesInputRequestTypeDef(TypedDict):
    TopicArn: str,
    AttributeName: str,
    AttributeValue: NotRequired[str],

SetTopicAttributesInputTopicSetAttributesTypeDef#

# SetTopicAttributesInputTopicSetAttributesTypeDef definition

class SetTopicAttributesInputTopicSetAttributesTypeDef(TypedDict):
    AttributeName: str,
    AttributeValue: NotRequired[str],

SubscribeInputRequestTypeDef#

# SubscribeInputRequestTypeDef definition

class SubscribeInputRequestTypeDef(TypedDict):
    TopicArn: str,
    Protocol: str,
    Endpoint: NotRequired[str],
    Attributes: NotRequired[Mapping[str, str]],
    ReturnSubscriptionArn: NotRequired[bool],

SubscribeInputTopicSubscribeTypeDef#

# SubscribeInputTopicSubscribeTypeDef definition

class SubscribeInputTopicSubscribeTypeDef(TypedDict):
    Protocol: str,
    Endpoint: NotRequired[str],
    Attributes: NotRequired[Mapping[str, str]],
    ReturnSubscriptionArn: NotRequired[bool],

UnsubscribeInputRequestTypeDef#

# UnsubscribeInputRequestTypeDef definition

class UnsubscribeInputRequestTypeDef(TypedDict):
    SubscriptionArn: str,

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

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

VerifySMSSandboxPhoneNumberInputRequestTypeDef#

# VerifySMSSandboxPhoneNumberInputRequestTypeDef definition

class VerifySMSSandboxPhoneNumberInputRequestTypeDef(TypedDict):
    PhoneNumber: str,
    OneTimePassword: str,

MessageAttributeValueTypeDef#

# MessageAttributeValueTypeDef definition

class MessageAttributeValueTypeDef(TypedDict):
    DataType: str,
    StringValue: NotRequired[str],
    BinaryValue: NotRequired[BlobTypeDef],

CheckIfPhoneNumberIsOptedOutResponseTypeDef#

# CheckIfPhoneNumberIsOptedOutResponseTypeDef definition

class CheckIfPhoneNumberIsOptedOutResponseTypeDef(TypedDict):
    isOptedOut: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ConfirmSubscriptionResponseTypeDef#

# ConfirmSubscriptionResponseTypeDef definition

class ConfirmSubscriptionResponseTypeDef(TypedDict):
    SubscriptionArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateEndpointResponseTypeDef#

# CreateEndpointResponseTypeDef definition

class CreateEndpointResponseTypeDef(TypedDict):
    EndpointArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreatePlatformApplicationResponseTypeDef#

# CreatePlatformApplicationResponseTypeDef definition

class CreatePlatformApplicationResponseTypeDef(TypedDict):
    PlatformApplicationArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateTopicResponseTypeDef#

# CreateTopicResponseTypeDef definition

class CreateTopicResponseTypeDef(TypedDict):
    TopicArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetDataProtectionPolicyResponseTypeDef#

# GetDataProtectionPolicyResponseTypeDef definition

class GetDataProtectionPolicyResponseTypeDef(TypedDict):
    DataProtectionPolicy: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetEndpointAttributesResponseTypeDef#

# GetEndpointAttributesResponseTypeDef definition

class GetEndpointAttributesResponseTypeDef(TypedDict):
    Attributes: dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetPlatformApplicationAttributesResponseTypeDef#

# GetPlatformApplicationAttributesResponseTypeDef definition

class GetPlatformApplicationAttributesResponseTypeDef(TypedDict):
    Attributes: dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetSMSAttributesResponseTypeDef#

# GetSMSAttributesResponseTypeDef definition

class GetSMSAttributesResponseTypeDef(TypedDict):
    attributes: dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetSMSSandboxAccountStatusResultTypeDef#

# GetSMSSandboxAccountStatusResultTypeDef definition

class GetSMSSandboxAccountStatusResultTypeDef(TypedDict):
    IsInSandbox: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetSubscriptionAttributesResponseTypeDef#

# GetSubscriptionAttributesResponseTypeDef definition

class GetSubscriptionAttributesResponseTypeDef(TypedDict):
    Attributes: dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetTopicAttributesResponseTypeDef#

# GetTopicAttributesResponseTypeDef definition

class GetTopicAttributesResponseTypeDef(TypedDict):
    Attributes: dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListPhoneNumbersOptedOutResponseTypeDef#

# ListPhoneNumbersOptedOutResponseTypeDef definition

class ListPhoneNumbersOptedOutResponseTypeDef(TypedDict):
    phoneNumbers: list[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
    nextToken: NotRequired[str],
  1. See ResponseMetadataTypeDef

PublishResponseTypeDef#

# PublishResponseTypeDef definition

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

SubscribeResponseTypeDef#

# SubscribeResponseTypeDef definition

class SubscribeResponseTypeDef(TypedDict):
    SubscriptionArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateTopicInputRequestTypeDef#

# CreateTopicInputRequestTypeDef definition

class CreateTopicInputRequestTypeDef(TypedDict):
    Name: str,
    Attributes: NotRequired[Mapping[str, str]],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
    DataProtectionPolicy: NotRequired[str],
  1. See TagTypeDef

CreateTopicInputServiceResourceCreateTopicTypeDef#

# CreateTopicInputServiceResourceCreateTopicTypeDef definition

class CreateTopicInputServiceResourceCreateTopicTypeDef(TypedDict):
    Name: str,
    Attributes: NotRequired[Mapping[str, str]],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
    DataProtectionPolicy: NotRequired[str],
  1. See TagTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    Tags: list[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

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

ListEndpointsByPlatformApplicationResponseTypeDef#

# ListEndpointsByPlatformApplicationResponseTypeDef definition

class ListEndpointsByPlatformApplicationResponseTypeDef(TypedDict):
    Endpoints: list[EndpointTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See EndpointTypeDef
  2. See ResponseMetadataTypeDef

ListEndpointsByPlatformApplicationInputPaginateTypeDef#

# ListEndpointsByPlatformApplicationInputPaginateTypeDef definition

class ListEndpointsByPlatformApplicationInputPaginateTypeDef(TypedDict):
    PlatformApplicationArn: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListOriginationNumbersRequestPaginateTypeDef#

# ListOriginationNumbersRequestPaginateTypeDef definition

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

ListPhoneNumbersOptedOutInputPaginateTypeDef#

# ListPhoneNumbersOptedOutInputPaginateTypeDef definition

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

ListPlatformApplicationsInputPaginateTypeDef#

# ListPlatformApplicationsInputPaginateTypeDef definition

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

ListSMSSandboxPhoneNumbersInputPaginateTypeDef#

# ListSMSSandboxPhoneNumbersInputPaginateTypeDef definition

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

ListSubscriptionsByTopicInputPaginateTypeDef#

# ListSubscriptionsByTopicInputPaginateTypeDef definition

class ListSubscriptionsByTopicInputPaginateTypeDef(TypedDict):
    TopicArn: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListSubscriptionsInputPaginateTypeDef#

# ListSubscriptionsInputPaginateTypeDef definition

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

ListTopicsInputPaginateTypeDef#

# ListTopicsInputPaginateTypeDef definition

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

ListOriginationNumbersResultTypeDef#

# ListOriginationNumbersResultTypeDef definition

class ListOriginationNumbersResultTypeDef(TypedDict):
    PhoneNumbers: list[PhoneNumberInformationTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See PhoneNumberInformationTypeDef
  2. See ResponseMetadataTypeDef

ListPlatformApplicationsResponseTypeDef#

# ListPlatformApplicationsResponseTypeDef definition

class ListPlatformApplicationsResponseTypeDef(TypedDict):
    PlatformApplications: list[PlatformApplicationTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See PlatformApplicationTypeDef
  2. See ResponseMetadataTypeDef

ListSMSSandboxPhoneNumbersResultTypeDef#

# ListSMSSandboxPhoneNumbersResultTypeDef definition

class ListSMSSandboxPhoneNumbersResultTypeDef(TypedDict):
    PhoneNumbers: list[SMSSandboxPhoneNumberTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See SMSSandboxPhoneNumberTypeDef
  2. See ResponseMetadataTypeDef

ListSubscriptionsByTopicResponseTypeDef#

# ListSubscriptionsByTopicResponseTypeDef definition

class ListSubscriptionsByTopicResponseTypeDef(TypedDict):
    Subscriptions: list[SubscriptionTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See SubscriptionTypeDef
  2. See ResponseMetadataTypeDef

ListSubscriptionsResponseTypeDef#

# ListSubscriptionsResponseTypeDef definition

class ListSubscriptionsResponseTypeDef(TypedDict):
    Subscriptions: list[SubscriptionTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See SubscriptionTypeDef
  2. See ResponseMetadataTypeDef

ListTopicsResponseTypeDef#

# ListTopicsResponseTypeDef definition

class ListTopicsResponseTypeDef(TypedDict):
    Topics: list[TopicTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See TopicTypeDef
  2. See ResponseMetadataTypeDef

PublishBatchResponseTypeDef#

# PublishBatchResponseTypeDef definition

class PublishBatchResponseTypeDef(TypedDict):
    Successful: list[PublishBatchResultEntryTypeDef],  # (1)
    Failed: list[BatchResultErrorEntryTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See PublishBatchResultEntryTypeDef
  2. See BatchResultErrorEntryTypeDef
  3. See ResponseMetadataTypeDef

PublishBatchRequestEntryTypeDef#

# PublishBatchRequestEntryTypeDef definition

class PublishBatchRequestEntryTypeDef(TypedDict):
    Id: str,
    Message: str,
    Subject: NotRequired[str],
    MessageStructure: NotRequired[str],
    MessageAttributes: NotRequired[Mapping[str, MessageAttributeValueTypeDef]],  # (1)
    MessageDeduplicationId: NotRequired[str],
    MessageGroupId: NotRequired[str],
  1. See MessageAttributeValueTypeDef

PublishInputPlatformEndpointPublishTypeDef#

# PublishInputPlatformEndpointPublishTypeDef definition

class PublishInputPlatformEndpointPublishTypeDef(TypedDict):
    Message: str,
    TopicArn: NotRequired[str],
    PhoneNumber: NotRequired[str],
    Subject: NotRequired[str],
    MessageStructure: NotRequired[str],
    MessageAttributes: NotRequired[Mapping[str, MessageAttributeValueTypeDef]],  # (1)
    MessageDeduplicationId: NotRequired[str],
    MessageGroupId: NotRequired[str],
  1. See MessageAttributeValueTypeDef

PublishInputRequestTypeDef#

# PublishInputRequestTypeDef definition

class PublishInputRequestTypeDef(TypedDict):
    Message: str,
    TopicArn: NotRequired[str],
    TargetArn: NotRequired[str],
    PhoneNumber: NotRequired[str],
    Subject: NotRequired[str],
    MessageStructure: NotRequired[str],
    MessageAttributes: NotRequired[Mapping[str, MessageAttributeValueTypeDef]],  # (1)
    MessageDeduplicationId: NotRequired[str],
    MessageGroupId: NotRequired[str],
  1. See MessageAttributeValueTypeDef

PublishInputTopicPublishTypeDef#

# PublishInputTopicPublishTypeDef definition

class PublishInputTopicPublishTypeDef(TypedDict):
    Message: str,
    TargetArn: NotRequired[str],
    PhoneNumber: NotRequired[str],
    Subject: NotRequired[str],
    MessageStructure: NotRequired[str],
    MessageAttributes: NotRequired[Mapping[str, MessageAttributeValueTypeDef]],  # (1)
    MessageDeduplicationId: NotRequired[str],
    MessageGroupId: NotRequired[str],
  1. See MessageAttributeValueTypeDef

PublishBatchInputRequestTypeDef#

# PublishBatchInputRequestTypeDef definition

class PublishBatchInputRequestTypeDef(TypedDict):
    TopicArn: str,
    PublishBatchRequestEntries: Sequence[PublishBatchRequestEntryTypeDef],  # (1)
  1. See PublishBatchRequestEntryTypeDef