PyPI 官网下载 | mypy-boto3-sns-1.17.79.tar.gz

# mypy-boto3-sns<a id="mypy-boto3-sns"></a> [](https://pypi.org/project/mypy-boto3-sns) [](https://pypi.org/project/mypy-boto3-sns) [](https://mypy-boto3-builder.readthedocs.io/) [](https://pypistats.org/packages/mypy-boto3-sns)  Type annotations for [boto3.SNS 1.17.79](https://boto3.amazonaws.com/v1/documentation/api/1.17.79/reference/services/sns.html#SNS) service compatible with [VSCode](https://code.visualstudio.com/), [PyCharm](https://www.jetbrains.com/pycharm/), [Emacs](https://www.gnu.org/software/emacs/), [Sublime Text](https://www.sublimetext.com/), [mypy](https://github.com/python/mypy), [pyright](https://github.com/microsoft/pyright) and other tools. Generated by [mypy-boto3-buider 4.14.0](https://github.com/vemel/mypy_boto3_builder). More information can be found on [boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in [mypy-boto3-sns docs](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_sns/) See how it helps to find and fix potential bugs:  - [mypy-boto3-sns](#mypy-boto3-sns) - [How to install](#how-to-install) - [Usage](#usage) - [VSCode](#vscode) - [PyCharm](#pycharm) - [Other IDEs](#other-ides) - [mypy](#mypy) - [pyright](#pyright) - [Explicit type annotations](#explicit-type-annotations) - [Client annotations](#client-annotations) - [Paginators annotations](#paginators-annotations) - [Service Resource annotations](#service-resource-annotations) - [Other resources annotations](#other-resources-annotations) - [Collections annotations](#collections-annotations) - [Literals](#literals) - [Typed dictionaries](#typed-dictionaries) - [Versioning](#versioning) - [Documentation](#documentation) - [Support and contributing](#support-and-contributing) ## How to install<a id="how-to-install"></a> Install `boto3-stubs` for `SNS` service. ```bash python -m pip install boto3-stubs[sns] ``` ## Usage<a id="usage"></a> ### VSCode<a id="vscode"></a> - Install [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python) - Install [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance) - Set `Pylance` as your Python Language Server - Install `boto-stubs[sns]` in your environment: `python -m pip install 'boto3-stubs[sns]'` Both type checking and auto-complete should work for `SNS` service. No explicit type annotations required, write your `boto3` code as usual. ### PyCharm<a id="pycharm"></a> - Install `boto-stubs[sns]` in your environment: `python -m pip install 'boto3-stubs[sns]'` Both type checking and auto-complete should work for `SNS` service. No explicit type annotations required, write your `boto3` code as usual. Auto-complete can be slow on big projects or if you have a lot of installed `boto3-stubs` submodules. ### Other IDEs<a id="other-ides"></a> Not tested, but as long as your IDE support `mypy` or `pyright`, everything should work. ### mypy<a id="mypy"></a> - Install `mypy`: `python -m pip install mypy` - Install `boto-stubs[sns]` in your environment: `python -m pip install 'boto3-stubs[sns]'` - Run `mypy` as usual Type checking should work for `SNS` service. No explicit type annotations required, write your `boto3` code as usual. ### pyright<a id="pyright"></a> - Install `pyright`: `yarn global add pyright` - Install `boto-stubs[sns]` in your environment: `python -m pip install 'boto3-stubs[sns]'` - Optionally, you can install `boto3-stubs` to `typings` folder. Type checking should work for `SNS` service. No explicit type annotations required, write your `boto3` code as usual. ## Explicit type annotations<a id="explicit-type-annotations"></a> ### Client annotations<a id="client-annotations"></a> `SNSClient` provides annotations for `boto3.client("sns")`. ```python import boto3 from mypy_boto3_sns import SNSClient client: SNSClient = boto3.client("sns") # now client usage is checked by mypy and IDE should provide code auto-complete # works for session as well session = boto3.session.Session(region="us-west-1") session_client: SNSClient = session.client("sns") ``` ### Paginators annotations<a id="paginators-annotations"></a> `mypy_boto3_sns.paginator` module contains type annotations for all paginators. ```python from mypy_boto3_sns import SNSClient from mypy_boto3_sns.paginator import ( ListEndpointsByPlatformApplicationPaginator, ListPhoneNumbersOptedOutPaginator, ListPlatformApplicationsPaginator, ListSubscriptionsPaginator, ListSubscriptionsByTopicPaginator, ListTopicsPaginator, ) client: SNSClient = boto3.client("sns") # Explicit type annotations are optional here # Type should be correctly discovered by mypy and IDEs # VSCode requires explicit type annotations list_endpoints_by_platform_application_paginator: ListEndpointsByPlatformApplicationPaginator = client.get_paginator("list_endpoints_by_platform_application") list_phone_numbers_opted_out_paginator: ListPhoneNumbersOptedOutPaginator = client.get_paginator("list_phone_numbers_opted_out") list_platform_applications_paginator: ListPlatformApplicationsPaginator = client.get_paginator("list_platform_applications") list_subscriptions_paginator: ListSubscriptionsPaginator = client.get_paginator("list_subscriptions") list_subscriptions_by_topic_paginator: ListSubscriptionsByTopicPaginator = client.get_paginator("list_subscriptions_by_topic") list_topics_paginator: ListTopicsPaginator = client.get_paginator("list_topics") ``` ### Service Resource annotations<a id="service-resource-annotations"></a> `SNSServiceResource` provides annotations for `boto3.resource("sns")`. ```python from mypy_boto3_sns import SNSServiceResource resource: SNSServiceResource = boto3.resource("sns") # now resource usage is checked by mypy and IDE should provide code auto-complete # works for session as well session = boto3.session.Session(region="us-west-1") session_resource: SNSServiceResource = session.resource("sns") ``` ### Other resources annotations<a id="other-resources-annotations"></a> `mypy_boto3_sns.service_resource` module contains type annotations for all resources. ```python from mypy_boto3_sns import SNSServiceResource from mypy_boto3_sns.service_resource import ( PlatformApplication, PlatformEndpoint, Subscription, Topic, ) resource: SNSServiceResource = boto3.resource("sns") # Explicit type annotations are optional here # Type should be correctly discovered by mypy and IDEs my_platform_application: PlatformApplication = resource.PlatformApplication(...) my_platform_endpoint: PlatformEndpoint = resource.PlatformEndpoint(...) my_subscription: Subscription = resource.Subscription(...) my_topic: Topic = resource.Topic(...) ``` ### Collections annotations<a id="collections-annotations"></a> `mypy_boto3_sns.service_resource` module contains type annotations for all `SNSServiceResource` collections. ```python from mypy_boto3_sns import SNSServiceResource from mypy_boto3_sns.service_resource import ( ServiceResourcePlatformApplicationsCollection, ServiceResourceSubscriptionsCollection, ServiceResourceTopicsCollection, ) resource: SNSServiceResource = boto3.resource("sns") # Explicit type annotations are optional here # Type should be correctly discovered by mypy and IDEs platform_applications: sns_resources.ServiceResourcePlatformApplicationsCollection = resource.platform_applications subscriptions: sns_resources.ServiceResourceSubscriptionsCollection = res