SNS module#
Index > SNS
Auto-generated documentation for SNS type annotations stubs module mypy-boto3-sns.
How to install#
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and SNS
.
From PyPI with pip#
Install boto3-stubs
for SNS
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[sns]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[sns]'
# standalone installation
python -m pip install mypy-boto3-sns
How to uninstall#
python -m pip uninstall -y mypy-boto3-sns
Usage#
Code samples can be found in Examples.
SNSClient#
Type annotations and code completion for boto3.client("sns")
as SNSClient
boto3 documentation
# SNSClient usage example
from boto3.session import Session
from mypy_boto3_sns.client import SNSClient
def get_client() -> SNSClient:
return Session().client("sns")
Paginators#
Type annotations and code completion for paginators
from boto3.client("sns").get_paginator("...")
.
# ListEndpointsByPlatformApplicationPaginator usage example
from boto3.session import Session
from mypy_boto3_sns.paginator import ListEndpointsByPlatformApplicationPaginator
def get_list_endpoints_by_platform_application_paginator() -> ListEndpointsByPlatformApplicationPaginator:
return Session().client("sns").get_paginator("list_endpoints_by_platform_application"))
- ListEndpointsByPlatformApplicationPaginator
- ListOriginationNumbersPaginator
- ListPhoneNumbersOptedOutPaginator
- ListPlatformApplicationsPaginator
- ListSMSSandboxPhoneNumbersPaginator
- ListSubscriptionsPaginator
- ListSubscriptionsByTopicPaginator
- ListTopicsPaginator
SNSServiceResource#
Type annotations and code completion for boto3.resource("sns")
as
SNSServiceResource
boto3 documentation
# SNSServiceResource usage example
from boto3.session import Session
from mypy_boto3_sns.service_resource import SNSServiceResource
def get_sns_resource() -> SNSServiceResource:
return Session().resource("sns")
Collections#
Type annotations and code completion for collections
from boto3.resource("sns").*
.
# ServiceResourcePlatformApplicationsCollection usage example
from boto3.session import Session
from mypy_boto3_sns.service_resource import ServiceResourcePlatformApplicationsCollection
def get_collection() -> ServiceResourcePlatformApplicationsCollection:
return Session().resource("sns").platform_applications
- ServiceResourcePlatformApplicationsCollection
- ServiceResourceSubscriptionsCollection
- ServiceResourceTopicsCollection
Resources#
Type annotations and code completion for additional resources
from boto3.resource("sns").*
.
# PlatformApplication usage example
from boto3.session import Session
from mypy_boto3_sns.service_resource import PlatformApplication
def get_resource() -> PlatformApplication:
return Session().resource("sns").PlatformApplication(...)
Literals#
Type annotations for literals used in methods and schemas.
# LanguageCodeStringType usage example
from mypy_boto3_sns.literals import LanguageCodeStringType
def get_value() -> LanguageCodeStringType:
return "de-DE"
- LanguageCodeStringType
- ListEndpointsByPlatformApplicationPaginatorName
- ListOriginationNumbersPaginatorName
- ListPhoneNumbersOptedOutPaginatorName
- ListPlatformApplicationsPaginatorName
- ListSMSSandboxPhoneNumbersPaginatorName
- ListSubscriptionsByTopicPaginatorName
- ListSubscriptionsPaginatorName
- ListTopicsPaginatorName
- NumberCapabilityType
- RouteTypeType
- SMSSandboxPhoneNumberVerificationStatusType
- SNSServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Typed dictionaries#
Type annotations for typed dictionaries used in methods and schema.
# AddPermissionInputRequestTypeDef usage example
from mypy_boto3_sns.type_defs import AddPermissionInputRequestTypeDef
def get_value() -> AddPermissionInputRequestTypeDef:
return {
"TopicArn": ...,
"Label": ...,
"AWSAccountId": ...,
"ActionName": ...,
}
- AddPermissionInputRequestTypeDef
- AddPermissionInputTopicAddPermissionTypeDef
- BatchResultErrorEntryTypeDef
- CheckIfPhoneNumberIsOptedOutInputRequestTypeDef
- CheckIfPhoneNumberIsOptedOutResponseTypeDef
- ConfirmSubscriptionInputRequestTypeDef
- ConfirmSubscriptionInputTopicConfirmSubscriptionTypeDef
- ConfirmSubscriptionResponseTypeDef
- CreateEndpointResponseTypeDef
- CreatePlatformApplicationInputRequestTypeDef
- CreatePlatformApplicationInputServiceResourceCreatePlatformApplicationTypeDef
- CreatePlatformApplicationResponseTypeDef
- CreatePlatformEndpointInputPlatformApplicationCreatePlatformEndpointTypeDef
- CreatePlatformEndpointInputRequestTypeDef
- CreateSMSSandboxPhoneNumberInputRequestTypeDef
- TagTypeDef
- CreateTopicResponseTypeDef
- DeleteEndpointInputRequestTypeDef
- DeletePlatformApplicationInputRequestTypeDef
- DeleteSMSSandboxPhoneNumberInputRequestTypeDef
- DeleteTopicInputRequestTypeDef
- EmptyResponseMetadataTypeDef
- EndpointTypeDef
- GetDataProtectionPolicyInputRequestTypeDef
- GetDataProtectionPolicyResponseTypeDef
- GetEndpointAttributesInputRequestTypeDef
- GetEndpointAttributesResponseTypeDef
- GetPlatformApplicationAttributesInputRequestTypeDef
- GetPlatformApplicationAttributesResponseTypeDef
- GetSMSAttributesInputRequestTypeDef
- GetSMSAttributesResponseTypeDef
- GetSMSSandboxAccountStatusResultTypeDef
- GetSubscriptionAttributesInputRequestTypeDef
- GetSubscriptionAttributesResponseTypeDef
- GetTopicAttributesInputRequestTypeDef
- GetTopicAttributesResponseTypeDef
- ListEndpointsByPlatformApplicationInputListEndpointsByPlatformApplicationPaginateTypeDef
- ListEndpointsByPlatformApplicationInputRequestTypeDef
- ListOriginationNumbersRequestListOriginationNumbersPaginateTypeDef
- ListOriginationNumbersRequestRequestTypeDef
- PhoneNumberInformationTypeDef
- ListPhoneNumbersOptedOutInputListPhoneNumbersOptedOutPaginateTypeDef
- ListPhoneNumbersOptedOutInputRequestTypeDef
- ListPhoneNumbersOptedOutResponseTypeDef
- ListPlatformApplicationsInputListPlatformApplicationsPaginateTypeDef
- ListPlatformApplicationsInputRequestTypeDef
- PlatformApplicationTypeDef
- ListSMSSandboxPhoneNumbersInputListSMSSandboxPhoneNumbersPaginateTypeDef
- ListSMSSandboxPhoneNumbersInputRequestTypeDef
- SMSSandboxPhoneNumberTypeDef
- ListSubscriptionsByTopicInputListSubscriptionsByTopicPaginateTypeDef
- ListSubscriptionsByTopicInputRequestTypeDef
- SubscriptionTypeDef
- ListSubscriptionsInputListSubscriptionsPaginateTypeDef
- ListSubscriptionsInputRequestTypeDef
- ListTagsForResourceRequestRequestTypeDef
- ListTopicsInputListTopicsPaginateTypeDef
- ListTopicsInputRequestTypeDef
- TopicTypeDef
- MessageAttributeValueTypeDef
- OptInPhoneNumberInputRequestTypeDef
- PaginatorConfigTypeDef
- PublishBatchResultEntryTypeDef
- PublishResponseTypeDef
- PutDataProtectionPolicyInputRequestTypeDef
- RemovePermissionInputRequestTypeDef
- RemovePermissionInputTopicRemovePermissionTypeDef
- ResponseMetadataTypeDef
- SetEndpointAttributesInputPlatformEndpointSetAttributesTypeDef
- SetEndpointAttributesInputRequestTypeDef
- SetPlatformApplicationAttributesInputPlatformApplicationSetAttributesTypeDef
- SetPlatformApplicationAttributesInputRequestTypeDef
- SetSMSAttributesInputRequestTypeDef
- SetSubscriptionAttributesInputRequestTypeDef
- SetSubscriptionAttributesInputSubscriptionSetAttributesTypeDef
- SetTopicAttributesInputRequestTypeDef
- SetTopicAttributesInputTopicSetAttributesTypeDef
- SubscribeInputRequestTypeDef
- SubscribeInputTopicSubscribeTypeDef
- SubscribeResponseTypeDef
- UnsubscribeInputRequestTypeDef
- UntagResourceRequestRequestTypeDef
- VerifySMSSandboxPhoneNumberInputRequestTypeDef
- CreateTopicInputRequestTypeDef
- CreateTopicInputServiceResourceCreateTopicTypeDef
- ListTagsForResourceResponseTypeDef
- TagResourceRequestRequestTypeDef
- ListEndpointsByPlatformApplicationResponseTypeDef
- ListOriginationNumbersResultTypeDef
- ListPlatformApplicationsResponseTypeDef
- ListSMSSandboxPhoneNumbersResultTypeDef
- ListSubscriptionsByTopicResponseTypeDef
- ListSubscriptionsResponseTypeDef
- ListTopicsResponseTypeDef
- PublishBatchRequestEntryTypeDef
- PublishInputPlatformEndpointPublishTypeDef
- PublishInputRequestTypeDef
- PublishInputTopicPublishTypeDef
- PublishBatchResponseTypeDef
- PublishBatchInputRequestTypeDef