Skip to main content

Type annotations for boto3.SNS 1.15.17 service, generated by mypy-boto3-buider 3.2.1

Project description

mypy-boto3-sns

PyPI - mypy-boto3-sns PyPI - Python Version Docs

Type annotations for boto3.SNS 1.15.17 service compatible with VSCode, PyCharm, mypy, pyright and other tools.

Generated by mypy-boto3-buider 3.2.1.

More information can be found on boto3-stubs page.

How to install

Install boto3-stubs for SNS service.

python -m pip install boto3-stubs[sns]

Usage

VSCode

  • Install Python extension
  • Install Pylance extension
  • 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

  • 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

Not tested, but as long as your IDE support mypy or pyright, everything should work.

mypy

  • 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

  • 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

Client annotations

SNSClient provides annotations for boto3.client("sns").

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

mypy_boto3_sns.paginator module contains type annotations for all paginators.

from mypy_boto3_sns import SNSClient
from mypy_boto3_sns.paginator import (
    ListEndpointsByPlatformApplicationPaginator,
    ListPhoneNumbersOptedOutPaginator,
    ListPlatformApplicationsPaginator,
    ListSubscriptionsByTopicPaginator,
    ListSubscriptionsPaginator,
    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

SNSServiceResource provides annotations for boto3.resource("sns").

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

mypy_boto3_sns.service_resource module contains type annotations for all resources.

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

mypy_boto3_sns.service_resource module contains type annotations for all SNSServiceResource collections.

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 = resource.subscriptions
topics: sns_resources.ServiceResourceTopicsCollection = resource.topics

Typed dictionations

mypy_boto3_sns.type_defs module contains structures and shapes assembled to typed dictionaries for additional type checking.

from mypy_boto3_sns.type_defs import (
    CheckIfPhoneNumberIsOptedOutResponseTypeDef,
    ConfirmSubscriptionResponseTypeDef,
    CreateEndpointResponseTypeDef,
    CreatePlatformApplicationResponseTypeDef,
    CreateTopicResponseTypeDef,
    EndpointTypeDef,
    GetEndpointAttributesResponseTypeDef,
    GetPlatformApplicationAttributesResponseTypeDef,
    GetSMSAttributesResponseTypeDef,
    GetSubscriptionAttributesResponseTypeDef,
    GetTopicAttributesResponseTypeDef,
    ListEndpointsByPlatformApplicationResponseTypeDef,
    ListPhoneNumbersOptedOutResponseTypeDef,
    ListPlatformApplicationsResponseTypeDef,
    ListSubscriptionsByTopicResponseTypeDef,
    ListSubscriptionsResponseTypeDef,
    ListTagsForResourceResponseTypeDef,
    ListTopicsResponseTypeDef,
    MessageAttributeValueTypeDef,
    PaginatorConfigTypeDef,
    PlatformApplicationTypeDef,
    PublishResponseTypeDef,
    SubscribeResponseTypeDef,
    SubscriptionTypeDef,
    TagTypeDef,
    TopicTypeDef,
)

def get_structure() -> EndpointTypeDef:
    return {
      ...
    }

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mypy-boto3-sns-1.15.17.0.tar.gz (12.7 kB view details)

Uploaded Source

Built Distribution

mypy_boto3_sns-1.15.17.0-py3-none-any.whl (18.8 kB view details)

Uploaded Python 3

File details

Details for the file mypy-boto3-sns-1.15.17.0.tar.gz.

File metadata

  • Download URL: mypy-boto3-sns-1.15.17.0.tar.gz
  • Upload date:
  • Size: 12.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.8.6

File hashes

Hashes for mypy-boto3-sns-1.15.17.0.tar.gz
Algorithm Hash digest
SHA256 d9f7bb841aced3bada6c1505b3423516ac26399ac093b29a3d6ba11e862d4a96
MD5 e3848a37d3c4556b3ee153ada2cee9f3
BLAKE2b-256 1c02b56a78006f6ece1b22a81d546000e0a24c9b6643fc5084ff307a7fe459c7

See more details on using hashes here.

File details

Details for the file mypy_boto3_sns-1.15.17.0-py3-none-any.whl.

File metadata

  • Download URL: mypy_boto3_sns-1.15.17.0-py3-none-any.whl
  • Upload date:
  • Size: 18.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.8.6

File hashes

Hashes for mypy_boto3_sns-1.15.17.0-py3-none-any.whl
Algorithm Hash digest
SHA256 66af6984233fbd914494b318c1fdc11f7484ab6fc04716e7e388b865556089fa
MD5 4f49620ae8b2f1f80c51e322b1601871
BLAKE2b-256 8bf5ba089ceaed6025137fd8d5faf18bf77e917cf07ad33cc4f4f11aa5609520

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page