types-aiobotocore-sns 2.1.0.post1

Type annotations for aiobotocore.SNS 2.1.0 service generated by mypy-boto3-builder 6.4.2

mypy-boto3-sns

Type annotations for boto3.SNS 1.20.47 service compatible with VSCode, PyCharm, Emacs, Sublime Text, mypy, pyright and other tools.

Generated by mypy-boto3-builder 6.4.2.

More information can be found on boto3-stubs page and in types-aiobotocore-sns docs

See how it helps to find and fix potential bugs:

• mypy-boto3-sns
  • How to install
    • VSCode extension
    • From PyPI with pip
  • Usage
    • VSCode
    • PyCharm
    • Other IDEs
    • mypy
    • pyright
  • Explicit type annotations
    • Client annotations
    • Paginators annotations
• Explicit type annotations are optional here
• Type should be correctly discovered by mypy and IDEs
• Explicit type annotations are optional here
• Type should be correctly discovered by mypy and IDEs

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 types-aiobotocore for SNS service.

# install with aiobotocore type annotations
python -m pip install 'types-aiobotocore[sns]'

# Lite version does not provide session.create_client overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-aiobotocore-lite[sns]'

# standalone installation
python -m pip install types-aiobotocore-sns

Usage

VSCode

• Install Python extension
• Install Pylance extension
• Set Pylance as your Python Language Server
• Install types-aiobotocore[sns] in your environment: python -m pip install 'types-aiobotocore[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 types-aiobotocore[sns] in your environment: python -m pip install 'types-aiobotocore[sns]'

Both type checking and auto-complete should work for SNS service. No explicit type annotations required, write your aiobotocore code as usual. Auto-complete can be slow on big projects or if you have a lot of installed types-aiobotocore submodules.

Other IDEs

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

mypy

• Install mypy: python -m pip install mypy
• Install types-aiobotocore[sns] in your environment: python -m pip install 'types-aiobotocore[sns]'
• Run mypy as usual

Type checking should work for SNS service. No explicit type annotations required, write your aiobotocore code as usual.

pyright

• Install pyright: yarn global add pyright
• Install types-aiobotocore[sns] in your environment: python -m pip install 'types-aiobotocore[sns]'
• Optionally, you can install boto3-stubs to typings folder.

Type checking should work for SNS service. No explicit type annotations required, write your aiobotocore code as usual.

Explicit type annotations

Client annotations

SNSClient provides annotations for session.create_client("sns").

from aiobotocore.session import get_session

from types_aiobotocore_sns import SNSClient

session = get_session()
async with session.create_client("sns") as client:
    client: SNSClient
    # now client usage is checked by mypy and IDE should provide code auto-complete

Paginators annotations

types_aiobotocore_sns.paginator module contains type annotations for all paginators.

from aiobotocore.session import get_session

from types_aiobotocore_sns import SNSClient
from types_aiobotocore_sns.paginator import (
    ListEndpointsByPlatformApplicationPaginator,
    ListOriginationNumbersPaginator,
    ListPhoneNumbersOptedOutPaginator,
    ListPlatformApplicationsPaginator,
    ListSMSSandboxPhoneNumbersPaginator,
    ListSubscriptionsPaginator,
    ListSubscriptionsByTopicPaginator,
    ListTopicsPaginator,
)

session = get_session()
async with session.create_client("sns") as client:
    client: SNSClient

    # 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_origination_numbers_paginator: ListOriginationNumbersPaginator = client.get_paginator("list_origination_numbers")
        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_sms_sandbox_phone_numbers_paginator: ListSMSSandboxPhoneNumbersPaginator = client.get_paginator("list_sms_sandbox_phone_numbers")
        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 `aiobotocore.resource("sns")`.

```python
from aiobotocore.session import get_session

from types_aiobotocore_sns import SNSServiceResource

session = get_session()
async with session.resource("sns") as resource:
    resource: SNSServiceResource
    # now resource usage is checked by mypy and IDE should provide code auto-complete

Other resources annotations

types_aiobotocore_sns.service_resource module contains type annotations for all resources.

from aiobotocore.session import get_session

from types_aiobotocore_sns import SNSServiceResource
from types_aiobotocore_sns.service_resource import (
    PlatformApplication,
    PlatformEndpoint,
    Subscription,
    Topic,
)

session = get_session()
async with session.resource("sns") as resource:
    resource: SNSServiceResource

<a id="explicit-type-annotations-are-optional-here"></a>

# Explicit type annotations are optional here
<a id="type-should-be-correctly-discovered-by-mypy-and-ides"></a>

# 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

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

from aiobotocore.session import get_session

from types_aiobotocore_sns import SNSServiceResource
from types_aiobotocore_sns.service_resource import (
    ServiceResourcePlatformApplicationsCollection,
    ServiceResourceSubscriptionsCollection,
    ServiceResourceTopicsCollection,
)

session = get_session()
async with session.resource("sns") as resource:
    resource: SNSServiceResource

<a id="explicit-type-annotations-are-optional-here"></a>

# Explicit type annotations are optional here
<a id="type-should-be-correctly-discovered-by-mypy-and-ides"></a>

# 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

Literals

types_aiobotocore_sns.literals module contains literals extracted from shapes that can be used in user code for type checking.

from types_aiobotocore_sns.literals import (
    LanguageCodeStringType,
    ListEndpointsByPlatformApplicationPaginatorName,
    ListOriginationNumbersPaginatorName,
    ListPhoneNumbersOptedOutPaginatorName,
    ListPlatformApplicationsPaginatorName,
    ListSMSSandboxPhoneNumbersPaginatorName,
    ListSubscriptionsByTopicPaginatorName,
    ListSubscriptionsPaginatorName,
    ListTopicsPaginatorName,
    NumberCapabilityType,
    RouteTypeType,
    SMSSandboxPhoneNumberVerificationStatusType,
    ServiceName,
    PaginatorName,
)

def check_value(value: LanguageCodeStringType) -> bool:
    ...

Typed dictionaries

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

from types_aiobotocore_sns.type_defs import (
    AddPermissionInputRequestTypeDef,
    AddPermissionInputTopicTypeDef,
    BatchResultErrorEntryTypeDef,
    CheckIfPhoneNumberIsOptedOutInputRequestTypeDef,
    CheckIfPhoneNumberIsOptedOutResponseTypeDef,
    ConfirmSubscriptionInputRequestTypeDef,
    ConfirmSubscriptionInputTopicTypeDef,
    ConfirmSubscriptionResponseTypeDef,
    CreateEndpointResponseTypeDef,
    CreatePlatformApplicationInputRequestTypeDef,
    CreatePlatformApplicationInputServiceResourceTypeDef,
    CreatePlatformApplicationResponseTypeDef,
    CreatePlatformEndpointInputPlatformApplicationTypeDef,
    CreatePlatformEndpointInputRequestTypeDef,
    CreateSMSSandboxPhoneNumberInputRequestTypeDef,
    CreateTopicInputRequestTypeDef,
    CreateTopicInputServiceResourceTypeDef,
    CreateTopicResponseTypeDef,
    DeleteEndpointInputRequestTypeDef,
    DeletePlatformApplicationInputRequestTypeDef,
    DeleteSMSSandboxPhoneNumberInputRequestTypeDef,
    DeleteTopicInputRequestTypeDef,
    EndpointTypeDef,
    GetEndpointAttributesInputRequestTypeDef,
    GetEndpointAttributesResponseTypeDef,
    GetPlatformApplicationAttributesInputRequestTypeDef,
    GetPlatformApplicationAttributesResponseTypeDef,
    GetSMSAttributesInputRequestTypeDef,
    GetSMSAttributesResponseTypeDef,
    GetSMSSandboxAccountStatusResultTypeDef,
    GetSubscriptionAttributesInputRequestTypeDef,
    GetSubscriptionAttributesResponseTypeDef,
    GetTopicAttributesInputRequestTypeDef,
    GetTopicAttributesResponseTypeDef,
    ListEndpointsByPlatformApplicationInputRequestTypeDef,
    ListEndpointsByPlatformApplicationResponseTypeDef,
    ListOriginationNumbersRequestRequestTypeDef,
    ListOriginationNumbersResultTypeDef,
    ListPhoneNumbersOptedOutInputRequestTypeDef,
    ListPhoneNumbersOptedOutResponseTypeDef,
    ListPlatformApplicationsInputRequestTypeDef,
    ListPlatformApplicationsResponseTypeDef,
    ListSMSSandboxPhoneNumbersInputRequestTypeDef,
    ListSMSSandboxPhoneNumbersResultTypeDef,
    ListSubscriptionsByTopicInputRequestTypeDef,
    ListSubscriptionsByTopicResponseTypeDef,
    ListSubscriptionsInputRequestTypeDef,
    ListSubscriptionsResponseTypeDef,
    ListTagsForResourceRequestRequestTypeDef,
    ListTagsForResourceResponseTypeDef,
    ListTopicsInputRequestTypeDef,
    ListTopicsResponseTypeDef,
    MessageAttributeValueTypeDef,
    OptInPhoneNumberInputRequestTypeDef,
    PaginatorConfigTypeDef,
    PhoneNumberInformationTypeDef,
    PlatformApplicationTypeDef,
    PublishBatchInputRequestTypeDef,
    PublishBatchRequestEntryTypeDef,
    PublishBatchResponseTypeDef,
    PublishBatchResultEntryTypeDef,
    PublishInputPlatformEndpointTypeDef,
    PublishInputRequestTypeDef,
    PublishInputTopicTypeDef,
    PublishResponseTypeDef,
    RemovePermissionInputRequestTypeDef,
    RemovePermissionInputTopicTypeDef,
    ResponseMetadataTypeDef,
    SMSSandboxPhoneNumberTypeDef,
    ServiceResourcePlatformApplicationRequestTypeDef,
    ServiceResourcePlatformEndpointRequestTypeDef,
    ServiceResourceSubscriptionRequestTypeDef,
    ServiceResourceTopicRequestTypeDef,
    SetEndpointAttributesInputPlatformEndpointTypeDef,
    SetEndpointAttributesInputRequestTypeDef,
    SetPlatformApplicationAttributesInputPlatformApplicationTypeDef,
    SetPlatformApplicationAttributesInputRequestTypeDef,
    SetSMSAttributesInputRequestTypeDef,
    SetSubscriptionAttributesInputRequestTypeDef,
    SetSubscriptionAttributesInputSubscriptionTypeDef,
    SetTopicAttributesInputRequestTypeDef,
    SetTopicAttributesInputTopicTypeDef,
    SubscribeInputRequestTypeDef,
    SubscribeInputTopicTypeDef,
    SubscribeResponseTypeDef,
    SubscriptionTypeDef,
    TagResourceRequestRequestTypeDef,
    TagTypeDef,
    TopicTypeDef,
    UnsubscribeInputRequestTypeDef,
    UntagResourceRequestRequestTypeDef,
    VerifySMSSandboxPhoneNumberInputRequestTypeDef,
)

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

Versioning

types-aiobotocore-sns version is the same as related boto3 version and follows PEP 440 format.

Documentation

All type annotations can be found in types-aiobotocore-sns docs

Support and contributing

This package is auto-generated. Please reports any bugs or request new features in mypy-boto3-builder repository.