

.. _Message Attribute Data Types: http://docs.aws.amazon.com/sns/latest/dg/SNSMessageAttributes.html#SNSMessageAttributes.DataTypes
.. _Creating an Amazon SNS Endpoint for Baidu: http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePushBaiduEndpoint.html
.. _http\://aws.amazon.com/sns: http://aws.amazon.com/sns/
.. _SetPlatformApplicationAttributes: http://docs.aws.amazon.com/sns/latest/api/API_SetPlatformApplicationAttributes.html
.. _Publish: http://docs.aws.amazon.com/sns/latest/api/API_Publish.html
.. _SetEndpointAttributes: http://docs.aws.amazon.com/sns/latest/api/API_SetEndpointAttributes.html
.. _Using Amazon SNS Mobile Push Notifications: http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html
.. _Using Amazon SNS Message Attributes: http://docs.aws.amazon.com/sns/latest/dg/SNSMessageAttributes.html
.. _Create Different Messages for Each Protocol: http://docs.aws.amazon.com/sns/latest/gsg/Publish.html#sns-message-formatting-by-protocol
.. _http\://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters: http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters


***
SNS
***

.. contents:: Table of Contents
   :depth: 2


======
Client
======



.. py:class:: SNS.Client

  A low-level client representing Amazon Simple Notification Service (SNS)::

    
    import boto3
    
    client = boto3.client('sns')

  
  These are the available methods:
  
  *   :py:meth:`add_permission`

  
  *   :py:meth:`can_paginate`

  
  *   :py:meth:`confirm_subscription`

  
  *   :py:meth:`create_platform_application`

  
  *   :py:meth:`create_platform_endpoint`

  
  *   :py:meth:`create_topic`

  
  *   :py:meth:`delete_endpoint`

  
  *   :py:meth:`delete_platform_application`

  
  *   :py:meth:`delete_topic`

  
  *   :py:meth:`generate_presigned_url`

  
  *   :py:meth:`get_endpoint_attributes`

  
  *   :py:meth:`get_paginator`

  
  *   :py:meth:`get_platform_application_attributes`

  
  *   :py:meth:`get_subscription_attributes`

  
  *   :py:meth:`get_topic_attributes`

  
  *   :py:meth:`get_waiter`

  
  *   :py:meth:`list_endpoints_by_platform_application`

  
  *   :py:meth:`list_platform_applications`

  
  *   :py:meth:`list_subscriptions`

  
  *   :py:meth:`list_subscriptions_by_topic`

  
  *   :py:meth:`list_topics`

  
  *   :py:meth:`publish`

  
  *   :py:meth:`remove_permission`

  
  *   :py:meth:`set_endpoint_attributes`

  
  *   :py:meth:`set_platform_application_attributes`

  
  *   :py:meth:`set_subscription_attributes`

  
  *   :py:meth:`set_topic_attributes`

  
  *   :py:meth:`subscribe`

  
  *   :py:meth:`unsubscribe`

  

  .. py:method:: add_permission(**kwargs)

    

    Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.

    

    **Request Syntax** 
    ::

      response = client.add_permission(
          TopicArn='string',
          Label='string',
          AWSAccountId=[
              'string',
          ],
          ActionName=[
              'string',
          ]
      )
    :type TopicArn: string
    :param TopicArn: **[REQUIRED]** 

      The ARN of the topic whose access control policy you wish to modify.

      

    
    :type Label: string
    :param Label: **[REQUIRED]** 

      A unique identifier for the new policy statement.

      

    
    :type AWSAccountId: list
    :param AWSAccountId: **[REQUIRED]** 

      The AWS account IDs of the users (principals) who will be given access to the specified actions. The users must have AWS accounts, but do not need to be signed up for this service. 

      

    
      - *(string) --* 

      
  
    :type ActionName: list
    :param ActionName: **[REQUIRED]** 

      The action you want to allow for the specified principal(s).

       

      Valid values: any Amazon SNS action name.

      

    
      - *(string) --* 

      
  
    
    :returns: None

  .. py:method:: can_paginate(operation_name)

        
    Check if an operation can be paginated.
    
    :type operation_name: string
    :param operation_name: The operation name.  This is the same name
        as the method name on the client.  For example, if the
        method name is ``create_foo``, and you'd normally invoke the
        operation as ``client.create_foo(**kwargs)``, if the
        ``create_foo`` operation can be paginated, you can use the
        call ``client.get_paginator("create_foo")``.
    
    :return: ``True`` if the operation can be paginated,
        ``False`` otherwise.


  .. py:method:: confirm_subscription(**kwargs)

    

    Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier ``Subscribe`` action. If the token is valid, the action creates a new subscription and returns its Amazon Resource Name (ARN). This call requires an AWS signature only when the ``AuthenticateOnUnsubscribe`` flag is set to "true".

    

    **Request Syntax** 
    ::

      response = client.confirm_subscription(
          TopicArn='string',
          Token='string',
          AuthenticateOnUnsubscribe='string'
      )
    :type TopicArn: string
    :param TopicArn: **[REQUIRED]** 

      The ARN of the topic for which you wish to confirm a subscription.

      

    
    :type Token: string
    :param Token: **[REQUIRED]** 

      Short-lived token sent to an endpoint during the ``Subscribe`` action.

      

    
    :type AuthenticateOnUnsubscribe: string
    :param AuthenticateOnUnsubscribe: 

      Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is ``true`` and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires AWS authentication. 

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'SubscriptionArn': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* Response for ConfirmSubscriptions action.
        

        - **SubscriptionArn** *(string) --* 

          The ARN of the created subscription.

          
    

  .. py:method:: create_platform_application(**kwargs)

    

    Creates a platform application object for one of the supported push notification services, such as APNS and GCM, to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential attributes when using the ``CreatePlatformApplication`` action. The PlatformPrincipal is received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is "SSL certificate". For GCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is "client id". The PlatformCredential is also received from the notification service. For APNS/APNS_SANDBOX, PlatformCredential is "private key". For GCM, PlatformCredential is "API key". For ADM, PlatformCredential is "client secret". The PlatformApplicationArn that is returned when using ``CreatePlatformApplication`` is then used as an attribute for the ``CreatePlatformEndpoint`` action. For more information, see `Using Amazon SNS Mobile Push Notifications`_ . 

    

    **Request Syntax** 
    ::

      response = client.create_platform_application(
          Name='string',
          Platform='string',
          Attributes={
              'string': 'string'
          }
      )
    :type Name: string
    :param Name: **[REQUIRED]** 

      Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long.

      

    
    :type Platform: string
    :param Platform: **[REQUIRED]** 

      The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Google Cloud Messaging).

      

    
    :type Attributes: dict
    :param Attributes: **[REQUIRED]** 

      For a list of attributes, see `SetPlatformApplicationAttributes`_ 

      

    
      - *(string) --* 

      
        - *(string) --* 

        
  

    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'PlatformApplicationArn': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 

        Response from CreatePlatformApplication action.

        
        

        - **PlatformApplicationArn** *(string) --* 

          PlatformApplicationArn is returned.

          
    

  .. py:method:: create_platform_endpoint(**kwargs)

    

    Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM and APNS. ``CreatePlatformEndpoint`` requires the PlatformApplicationArn that is returned from ``CreatePlatformApplication`` . The EndpointArn that is returned when using ``CreatePlatformEndpoint`` can then be used by the ``Publish`` action to send a message to a mobile app or by the ``Subscribe`` action for subscription to a topic. The ``CreatePlatformEndpoint`` action is idempotent, so if the requester already owns an endpoint with the same device token and attributes, that endpoint's ARN is returned without creating a new endpoint. For more information, see `Using Amazon SNS Mobile Push Notifications`_ . 

     

    When using ``CreatePlatformEndpoint`` with Baidu, two attributes must be provided: ChannelId and UserId. The token field must also contain the ChannelId. For more information, see `Creating an Amazon SNS Endpoint for Baidu`_ . 

    

    **Request Syntax** 
    ::

      response = client.create_platform_endpoint(
          PlatformApplicationArn='string',
          Token='string',
          CustomUserData='string',
          Attributes={
              'string': 'string'
          }
      )
    :type PlatformApplicationArn: string
    :param PlatformApplicationArn: **[REQUIRED]** 

      PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.

      

    
    :type Token: string
    :param Token: **[REQUIRED]** 

      Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM or ADM, the device token equivalent is called the registration ID.

      

    
    :type CustomUserData: string
    :param CustomUserData: 

      Arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.

      

    
    :type Attributes: dict
    :param Attributes: 

      For a list of attributes, see `SetEndpointAttributes`_ .

      

    
      - *(string) --* 

      
        - *(string) --* 

        
  

    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'EndpointArn': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 

        Response from CreateEndpoint action.

        
        

        - **EndpointArn** *(string) --* 

          EndpointArn returned from CreateEndpoint action.

          
    

  .. py:method:: create_topic(**kwargs)

    

    Creates a topic to which notifications can be published. Users can create at most 3000 topics. For more information, see `http\://aws.amazon.com/sns`_ . This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic.

    

    **Request Syntax** 
    ::

      response = client.create_topic(
          Name='string'
      )
    :type Name: string
    :param Name: **[REQUIRED]** 

      The name of the topic you want to create.

       

      Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. 

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'TopicArn': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 

        Response from CreateTopic action.

        
        

        - **TopicArn** *(string) --* 

          The Amazon Resource Name (ARN) assigned to the created topic.

          
    

  .. py:method:: delete_endpoint(**kwargs)

    

    Deletes the endpoint from Amazon SNS. This action is idempotent. For more information, see `Using Amazon SNS Mobile Push Notifications`_ . 

    

    **Request Syntax** 
    ::

      response = client.delete_endpoint(
          EndpointArn='string'
      )
    :type EndpointArn: string
    :param EndpointArn: **[REQUIRED]** 

      EndpointArn of endpoint to delete.

      

    
    
    :returns: None

  .. py:method:: delete_platform_application(**kwargs)

    

    Deletes a platform application object for one of the supported push notification services, such as APNS and GCM. For more information, see `Using Amazon SNS Mobile Push Notifications`_ . 

    

    **Request Syntax** 
    ::

      response = client.delete_platform_application(
          PlatformApplicationArn='string'
      )
    :type PlatformApplicationArn: string
    :param PlatformApplicationArn: **[REQUIRED]** 

      PlatformApplicationArn of platform application object to delete.

      

    
    
    :returns: None

  .. py:method:: delete_topic(**kwargs)

    

    Deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error.

    

    **Request Syntax** 
    ::

      response = client.delete_topic(
          TopicArn='string'
      )
    :type TopicArn: string
    :param TopicArn: **[REQUIRED]** 

      The ARN of the topic you want to delete.

      

    
    
    :returns: None

  .. py:method:: generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

        
    Generate a presigned url given a client, its method, and arguments
    
    :type ClientMethod: string
    :param ClientMethod: The client method to presign for
    
    :type Params: dict
    :param Params: The parameters normally passed to
        ``ClientMethod``.
    
    :type ExpiresIn: int
    :param ExpiresIn: The number of seconds the presigned url is valid
        for. By default it expires in an hour (3600 seconds)
    
    :type HttpMethod: string
    :param HttpMethod: The http method to use on the generated url. By
        default, the http method is whatever is used in the method's model.
    
    :returns: The presigned url


  .. py:method:: get_endpoint_attributes(**kwargs)

    

    Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM and APNS. For more information, see `Using Amazon SNS Mobile Push Notifications`_ . 

    

    **Request Syntax** 
    ::

      response = client.get_endpoint_attributes(
          EndpointArn='string'
      )
    :type EndpointArn: string
    :param EndpointArn: **[REQUIRED]** 

      EndpointArn for GetEndpointAttributes input.

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Attributes': {
                'string': 'string'
            }
        }
      **Response Structure** 

      

      - *(dict) --* 

        Response from GetEndpointAttributes of the EndpointArn.

        
        

        - **Attributes** *(dict) --* 

          Attributes include the following:

           

           
          *  ``CustomUserData`` -- arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.
           
          *  ``Enabled`` -- flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.
           
          *  ``Token`` -- device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.
           

          
          

          - *(string) --* 
            

            - *(string) --* 
      
    
    

  .. py:method:: get_paginator(operation_name)

        
    Create a paginator for an operation.
    
    :type operation_name: string
    :param operation_name: The operation name.  This is the same name
        as the method name on the client.  For example, if the
        method name is ``create_foo``, and you'd normally invoke the
        operation as ``client.create_foo(**kwargs)``, if the
        ``create_foo`` operation can be paginated, you can use the
        call ``client.get_paginator("create_foo")``.
    
    :raise OperationNotPageableError: Raised if the operation is not
        pageable.  You can use the ``client.can_paginate`` method to
        check if an operation is pageable.
    
    :rtype: L{botocore.paginate.Paginator}
    :return: A paginator object.


  .. py:method:: get_platform_application_attributes(**kwargs)

    

    Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see `Using Amazon SNS Mobile Push Notifications`_ . 

    

    **Request Syntax** 
    ::

      response = client.get_platform_application_attributes(
          PlatformApplicationArn='string'
      )
    :type PlatformApplicationArn: string
    :param PlatformApplicationArn: **[REQUIRED]** 

      PlatformApplicationArn for GetPlatformApplicationAttributesInput.

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Attributes': {
                'string': 'string'
            }
        }
      **Response Structure** 

      

      - *(dict) --* 

        Response for GetPlatformApplicationAttributes action.

        
        

        - **Attributes** *(dict) --* 

          Attributes include the following:

           

           
          *  ``EventEndpointCreated`` -- Topic ARN to which EndpointCreated event notifications should be sent.
           
          *  ``EventEndpointDeleted`` -- Topic ARN to which EndpointDeleted event notifications should be sent.
           
          *  ``EventEndpointUpdated`` -- Topic ARN to which EndpointUpdate event notifications should be sent.
           
          *  ``EventDeliveryFailure`` -- Topic ARN to which DeliveryFailure event notifications should be sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.
           

          
          

          - *(string) --* 
            

            - *(string) --* 
      
    
    

  .. py:method:: get_subscription_attributes(**kwargs)

    

    Returns all of the properties of a subscription.

    

    **Request Syntax** 
    ::

      response = client.get_subscription_attributes(
          SubscriptionArn='string'
      )
    :type SubscriptionArn: string
    :param SubscriptionArn: **[REQUIRED]** 

      The ARN of the subscription whose properties you want to get.

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Attributes': {
                'string': 'string'
            }
        }
      **Response Structure** 

      

      - *(dict) --* 

        Response for GetSubscriptionAttributes action.

        
        

        - **Attributes** *(dict) --* 

          A map of the subscription's attributes. Attributes in this map include the following:

           

           
          *  ``SubscriptionArn`` -- the subscription's ARN
           
          *  ``TopicArn`` -- the topic ARN that the subscription is associated with
           
          *  ``Owner`` -- the AWS account ID of the subscription's owner
           
          *  ``ConfirmationWasAuthenticated`` -- true if the subscription confirmation request was authenticated
           
          *  ``DeliveryPolicy`` -- the JSON serialization of the subscription's delivery policy
           
          *  ``EffectiveDeliveryPolicy`` -- the JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults
           

          
          

          - *(string) --* 
            

            - *(string) --* 
      
    
    

  .. py:method:: get_topic_attributes(**kwargs)

    

    Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user. 

    

    **Request Syntax** 
    ::

      response = client.get_topic_attributes(
          TopicArn='string'
      )
    :type TopicArn: string
    :param TopicArn: **[REQUIRED]** 

      The ARN of the topic whose properties you want to get.

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Attributes': {
                'string': 'string'
            }
        }
      **Response Structure** 

      

      - *(dict) --* 

        Response for GetTopicAttributes action.

        
        

        - **Attributes** *(dict) --* 

          A map of the topic's attributes. Attributes in this map include the following:

           

           
          *  ``TopicArn`` -- the topic's ARN
           
          *  ``Owner`` -- the AWS account ID of the topic's owner
           
          *  ``Policy`` -- the JSON serialization of the topic's access control policy
           
          *  ``DisplayName`` -- the human-readable name used in the "From" field for notifications to email and email-json endpoints
           
          *  ``SubscriptionsPending`` -- the number of subscriptions pending confirmation on this topic
           
          *  ``SubscriptionsConfirmed`` -- the number of confirmed subscriptions on this topic
           
          *  ``SubscriptionsDeleted`` -- the number of deleted subscriptions on this topic
           
          *  ``DeliveryPolicy`` -- the JSON serialization of the topic's delivery policy
           
          *  ``EffectiveDeliveryPolicy`` -- the JSON serialization of the effective delivery policy that takes into account system defaults
           

          
          

          - *(string) --* 
            

            - *(string) --* 
      
    
    

  .. py:method:: get_waiter(waiter_name)

        


  .. py:method:: list_endpoints_by_platform_application(**kwargs)

    

    Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM and APNS. The results for ``ListEndpointsByPlatformApplication`` are paginated and return a limited list of endpoints, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call ``ListEndpointsByPlatformApplication`` again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see `Using Amazon SNS Mobile Push Notifications`_ . 

    

    **Request Syntax** 
    ::

      response = client.list_endpoints_by_platform_application(
          PlatformApplicationArn='string',
          NextToken='string'
      )
    :type PlatformApplicationArn: string
    :param PlatformApplicationArn: **[REQUIRED]** 

      PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action.

      

    
    :type NextToken: string
    :param NextToken: 

      NextToken string is used when calling ListEndpointsByPlatformApplication action to retrieve additional records that are available after the first page results.

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Endpoints': [
                {
                    'EndpointArn': 'string',
                    'Attributes': {
                        'string': 'string'
                    }
                },
            ],
            'NextToken': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 

        Response for ListEndpointsByPlatformApplication action.

        
        

        - **Endpoints** *(list) --* 

          Endpoints returned for ListEndpointsByPlatformApplication action.

          
          

          - *(dict) --* 

            Endpoint for mobile app and device.

            
            

            - **EndpointArn** *(string) --* 

              EndpointArn for mobile app and device.

              
            

            - **Attributes** *(dict) --* 

              Attributes for endpoint.

              
              

              - *(string) --* 
                

                - *(string) --* 
          
        
        
      
        

        - **NextToken** *(string) --* 

          NextToken string is returned when calling ListEndpointsByPlatformApplication action if additional records are available after the first page results.

          
    

  .. py:method:: list_platform_applications(**kwargs)

    

    Lists the platform application objects for the supported push notification services, such as APNS and GCM. The results for ``ListPlatformApplications`` are paginated and return a limited list of applications, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call ``ListPlatformApplications`` using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see `Using Amazon SNS Mobile Push Notifications`_ . 

    

    **Request Syntax** 
    ::

      response = client.list_platform_applications(
          NextToken='string'
      )
    :type NextToken: string
    :param NextToken: 

      NextToken string is used when calling ListPlatformApplications action to retrieve additional records that are available after the first page results.

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'PlatformApplications': [
                {
                    'PlatformApplicationArn': 'string',
                    'Attributes': {
                        'string': 'string'
                    }
                },
            ],
            'NextToken': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 

        Response for ListPlatformApplications action.

        
        

        - **PlatformApplications** *(list) --* 

          Platform applications returned when calling ListPlatformApplications action.

          
          

          - *(dict) --* 

            Platform application object.

            
            

            - **PlatformApplicationArn** *(string) --* 

              PlatformApplicationArn for platform application object.

              
            

            - **Attributes** *(dict) --* 

              Attributes for platform application object.

              
              

              - *(string) --* 
                

                - *(string) --* 
          
        
        
      
        

        - **NextToken** *(string) --* 

          NextToken string is returned when calling ListPlatformApplications action if additional records are available after the first page results.

          
    

  .. py:method:: list_subscriptions(**kwargs)

    

    Returns a list of the requester's subscriptions. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a ``NextToken`` is also returned. Use the ``NextToken`` parameter in a new ``ListSubscriptions`` call to get further results.

    

    **Request Syntax** 
    ::

      response = client.list_subscriptions(
          NextToken='string'
      )
    :type NextToken: string
    :param NextToken: 

      Token returned by the previous ``ListSubscriptions`` request.

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Subscriptions': [
                {
                    'SubscriptionArn': 'string',
                    'Owner': 'string',
                    'Protocol': 'string',
                    'Endpoint': 'string',
                    'TopicArn': 'string'
                },
            ],
            'NextToken': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 

        Response for ListSubscriptions action

        
        

        - **Subscriptions** *(list) --* 

          A list of subscriptions.

          
          

          - *(dict) --* 

            A wrapper type for the attributes of an Amazon SNS subscription.

            
            

            - **SubscriptionArn** *(string) --* 

              The subscription's ARN.

              
            

            - **Owner** *(string) --* 

              The subscription's owner.

              
            

            - **Protocol** *(string) --* 

              The subscription's protocol.

              
            

            - **Endpoint** *(string) --* 

              The subscription's endpoint (format depends on the protocol).

              
            

            - **TopicArn** *(string) --* 

              The ARN of the subscription's topic.

              
        
      
        

        - **NextToken** *(string) --* 

          Token to pass along to the next ``ListSubscriptions`` request. This element is returned if there are more subscriptions to retrieve.

          
    

  .. py:method:: list_subscriptions_by_topic(**kwargs)

    

    Returns a list of the subscriptions to a specific topic. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a ``NextToken`` is also returned. Use the ``NextToken`` parameter in a new ``ListSubscriptionsByTopic`` call to get further results.

    

    **Request Syntax** 
    ::

      response = client.list_subscriptions_by_topic(
          TopicArn='string',
          NextToken='string'
      )
    :type TopicArn: string
    :param TopicArn: **[REQUIRED]** 

      The ARN of the topic for which you wish to find subscriptions.

      

    
    :type NextToken: string
    :param NextToken: 

      Token returned by the previous ``ListSubscriptionsByTopic`` request.

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Subscriptions': [
                {
                    'SubscriptionArn': 'string',
                    'Owner': 'string',
                    'Protocol': 'string',
                    'Endpoint': 'string',
                    'TopicArn': 'string'
                },
            ],
            'NextToken': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 

        Response for ListSubscriptionsByTopic action.

        
        

        - **Subscriptions** *(list) --* 

          A list of subscriptions.

          
          

          - *(dict) --* 

            A wrapper type for the attributes of an Amazon SNS subscription.

            
            

            - **SubscriptionArn** *(string) --* 

              The subscription's ARN.

              
            

            - **Owner** *(string) --* 

              The subscription's owner.

              
            

            - **Protocol** *(string) --* 

              The subscription's protocol.

              
            

            - **Endpoint** *(string) --* 

              The subscription's endpoint (format depends on the protocol).

              
            

            - **TopicArn** *(string) --* 

              The ARN of the subscription's topic.

              
        
      
        

        - **NextToken** *(string) --* 

          Token to pass along to the next ``ListSubscriptionsByTopic`` request. This element is returned if there are more subscriptions to retrieve.

          
    

  .. py:method:: list_topics(**kwargs)

    

    Returns a list of the requester's topics. Each call returns a limited list of topics, up to 100. If there are more topics, a ``NextToken`` is also returned. Use the ``NextToken`` parameter in a new ``ListTopics`` call to get further results.

    

    **Request Syntax** 
    ::

      response = client.list_topics(
          NextToken='string'
      )
    :type NextToken: string
    :param NextToken: 

      Token returned by the previous ``ListTopics`` request.

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Topics': [
                {
                    'TopicArn': 'string'
                },
            ],
            'NextToken': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 

        Response for ListTopics action.

        
        

        - **Topics** *(list) --* 

          A list of topic ARNs.

          
          

          - *(dict) --* 

            A wrapper type for the topic's Amazon Resource Name (ARN). To retrieve a topic's attributes, use ``GetTopicAttributes`` .

            
            

            - **TopicArn** *(string) --* 

              The topic's ARN.

              
        
      
        

        - **NextToken** *(string) --* 

          Token to pass along to the next ``ListTopics`` request. This element is returned if there are additional topics to retrieve.

          
    

  .. py:method:: publish(**kwargs)

    

    Sends a message to all of a topic's subscribed endpoints. When a ``messageId`` is returned, the message has been saved and Amazon SNS will attempt to deliver it to the topic's subscribers shortly. The format of the outgoing message to each subscribed endpoint depends on the notification protocol selected.

     

    To use the ``Publish`` action for sending a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, you must specify the EndpointArn. The EndpointArn is returned when making a call with the ``CreatePlatformEndpoint`` action. The second example below shows a request and response for publishing to a mobile endpoint. 

    

    **Request Syntax** 
    ::

      response = client.publish(
          TopicArn='string',
          TargetArn='string',
          Message='string',
          Subject='string',
          MessageStructure='string',
          MessageAttributes={
              'string': {
                  'DataType': 'string',
                  'StringValue': 'string',
                  'BinaryValue': b'bytes'
              }
          }
      )
    :type TopicArn: string
    :param TopicArn: 

      The topic you want to publish to.

      

    
    :type TargetArn: string
    :param TargetArn: 

      Either TopicArn or EndpointArn, but not both.

      

    
    :type Message: string
    :param Message: **[REQUIRED]** 

      The message you want to send to the topic.

       

      If you want to send the same message to all transport protocols, include the text of the message as a String value.

       

      If you want to send different messages for each transport protocol, set the value of the ``MessageStructure`` parameter to ``json`` and use a JSON object for the ``Message`` parameter. See the Examples section for the format of the JSON object. 

       

      Constraints: Messages must be UTF-8 encoded strings at most 256 KB in size (262144 bytes, not 262144 characters).

       

      JSON-specific constraints: 

       
      * Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values. 
       
      * The values will be parsed (unescaped) before they are used in outgoing messages.
       
      * Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).
       
      * Values have a minimum length of 0 (the empty string, "", is allowed).
       
      * Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).
       
      * Non-string values will cause the key to be ignored.
       
      * Keys that do not correspond to supported transport protocols are ignored.
       
      * Duplicate keys are not allowed.
       
      * Failure to parse or validate any key or value in the message will cause the ``Publish`` call to return an error (no partial delivery).
       

       

      

    
    :type Subject: string
    :param Subject: 

      Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints.

       

      Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.

      

    
    :type MessageStructure: string
    :param MessageStructure: 

      Set ``MessageStructure`` to ``json`` if you want to send a different message for each protocol. For example, using one publish action, you can send a short message to your SMS subscribers and a longer message to your email subscribers. If you set ``MessageStructure`` to ``json`` , the value of the ``Message`` parameter must: 

       

       
      * be a syntactically valid JSON object; and
       
      * contain at least a top-level JSON key of "default" with a value that is a string.
       

       

      You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g., "http"). 

       

      For information about sending different messages for each protocol using the AWS Management Console, go to `Create Different Messages for Each Protocol`_ in the *Amazon Simple Notification Service Getting Started Guide* . 

       

      Valid value: ``json`` 

      

    
    :type MessageAttributes: dict
    :param MessageAttributes: 

      Message attributes for Publish action.

      

    
      - *(string) --* 

      
        - *(dict) --* 

          The user-specified message attribute value. For string data types, the value attribute has the same restrictions on the content as the message body. For more information, see `Publish`_ .

           

          Name, type, and value must not be empty or null. In addition, the message body should not be empty or null. All parts of the message attribute, including name, type, and value, are included in the message size restriction, which is currently 256 KB (262,144 bytes). For more information, see `Using Amazon SNS Message Attributes`_ .

          

        
          - **DataType** *(string) --* **[REQUIRED]** 

            Amazon SNS supports the following logical data types: String, Number, and Binary. For more information, see `Message Attribute Data Types`_ .

            

          
          - **StringValue** *(string) --* 

            Strings are Unicode with UTF8 binary encoding. For a list of code values, see `http\://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters`_ .

            

          
          - **BinaryValue** *(bytes) --* 

            Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.

            

          
        
  

    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'MessageId': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 

        Response for Publish action.

        
        

        - **MessageId** *(string) --* 

          Unique identifier assigned to the published message.

           

          Length Constraint: Maximum 100 characters

          
    

  .. py:method:: remove_permission(**kwargs)

    

    Removes a statement from a topic's access control policy.

    

    **Request Syntax** 
    ::

      response = client.remove_permission(
          TopicArn='string',
          Label='string'
      )
    :type TopicArn: string
    :param TopicArn: **[REQUIRED]** 

      The ARN of the topic whose access control policy you wish to modify.

      

    
    :type Label: string
    :param Label: **[REQUIRED]** 

      The unique label of the statement you want to remove.

      

    
    
    :returns: None

  .. py:method:: set_endpoint_attributes(**kwargs)

    

    Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM and APNS. For more information, see `Using Amazon SNS Mobile Push Notifications`_ . 

    

    **Request Syntax** 
    ::

      response = client.set_endpoint_attributes(
          EndpointArn='string',
          Attributes={
              'string': 'string'
          }
      )
    :type EndpointArn: string
    :param EndpointArn: **[REQUIRED]** 

      EndpointArn used for SetEndpointAttributes action.

      

    
    :type Attributes: dict
    :param Attributes: **[REQUIRED]** 

      A map of the endpoint attributes. Attributes in this map include the following:

       

       
      *  ``CustomUserData`` -- arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.
       
      *  ``Enabled`` -- flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.
       
      *  ``Token`` -- device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.
       

      

    
      - *(string) --* 

      
        - *(string) --* 

        
  

    
    :returns: None

  .. py:method:: set_platform_application_attributes(**kwargs)

    

    Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see `Using Amazon SNS Mobile Push Notifications`_ . 

    

    **Request Syntax** 
    ::

      response = client.set_platform_application_attributes(
          PlatformApplicationArn='string',
          Attributes={
              'string': 'string'
          }
      )
    :type PlatformApplicationArn: string
    :param PlatformApplicationArn: **[REQUIRED]** 

      PlatformApplicationArn for SetPlatformApplicationAttributes action.

      

    
    :type Attributes: dict
    :param Attributes: **[REQUIRED]** 

      A map of the platform application attributes. Attributes in this map include the following:

       

       
      *  ``PlatformCredential`` -- The credential received from the notification service. For APNS/APNS_SANDBOX, PlatformCredential is "private key". For GCM, PlatformCredential is "API key". For ADM, PlatformCredential is "client secret".
       
      *  ``PlatformPrincipal`` -- The principal received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is "SSL certificate". For GCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is "client id".
       
      *  ``EventEndpointCreated`` -- Topic ARN to which EndpointCreated event notifications should be sent.
       
      *  ``EventEndpointDeleted`` -- Topic ARN to which EndpointDeleted event notifications should be sent.
       
      *  ``EventEndpointUpdated`` -- Topic ARN to which EndpointUpdate event notifications should be sent.
       
      *  ``EventDeliveryFailure`` -- Topic ARN to which DeliveryFailure event notifications should be sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.
       

      

    
      - *(string) --* 

      
        - *(string) --* 

        
  

    
    :returns: None

  .. py:method:: set_subscription_attributes(**kwargs)

    

    Allows a subscription owner to set an attribute of the topic to a new value.

    

    **Request Syntax** 
    ::

      response = client.set_subscription_attributes(
          SubscriptionArn='string',
          AttributeName='string',
          AttributeValue='string'
      )
    :type SubscriptionArn: string
    :param SubscriptionArn: **[REQUIRED]** 

      The ARN of the subscription to modify.

      

    
    :type AttributeName: string
    :param AttributeName: **[REQUIRED]** 

      The name of the attribute you want to set. Only a subset of the subscriptions attributes are mutable.

       

      Valid values: ``DeliveryPolicy`` | ``RawMessageDelivery`` 

      

    
    :type AttributeValue: string
    :param AttributeValue: 

      The new value for the attribute in JSON format.

      

    
    
    :returns: None

  .. py:method:: set_topic_attributes(**kwargs)

    

    Allows a topic owner to set an attribute of the topic to a new value.

    

    **Request Syntax** 
    ::

      response = client.set_topic_attributes(
          TopicArn='string',
          AttributeName='string',
          AttributeValue='string'
      )
    :type TopicArn: string
    :param TopicArn: **[REQUIRED]** 

      The ARN of the topic to modify.

      

    
    :type AttributeName: string
    :param AttributeName: **[REQUIRED]** 

      The name of the attribute you want to set. Only a subset of the topic's attributes are mutable.

       

      Valid values: ``Policy`` | ``DisplayName`` | ``DeliveryPolicy`` 

      

    
    :type AttributeValue: string
    :param AttributeValue: 

      The new value for the attribute.

      

    
    
    :returns: None

  .. py:method:: subscribe(**kwargs)

    

    Prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a subscription, the endpoint owner must call the ``ConfirmSubscription`` action with the token from the confirmation message. Confirmation tokens are valid for three days.

    

    **Request Syntax** 
    ::

      response = client.subscribe(
          TopicArn='string',
          Protocol='string',
          Endpoint='string'
      )
    :type TopicArn: string
    :param TopicArn: **[REQUIRED]** 

      The ARN of the topic you want to subscribe to.

      

    
    :type Protocol: string
    :param Protocol: **[REQUIRED]** 

      The protocol you want to use. Supported protocols include:

       

       
      *  ``http`` -- delivery of JSON-encoded message via HTTP POST
       
      *  ``https`` -- delivery of JSON-encoded message via HTTPS POST
       
      *  ``email`` -- delivery of message via SMTP
       
      *  ``email-json`` -- delivery of JSON-encoded message via SMTP
       
      *  ``sms`` -- delivery of message via SMS
       
      *  ``sqs`` -- delivery of JSON-encoded message to an Amazon SQS queue
       
      *  ``application`` -- delivery of JSON-encoded message to an EndpointArn for a mobile app and device.
       

      

    
    :type Endpoint: string
    :param Endpoint: 

      The endpoint that you want to receive notifications. Endpoints vary by protocol:

       

       
      * For the ``http`` protocol, the endpoint is an URL beginning with "http://"
       
      * For the ``https`` protocol, the endpoint is a URL beginning with "https://"
       
      * For the ``email`` protocol, the endpoint is an email address
       
      * For the ``email-json`` protocol, the endpoint is an email address
       
      * For the ``sms`` protocol, the endpoint is a phone number of an SMS-enabled device
       
      * For the ``sqs`` protocol, the endpoint is the ARN of an Amazon SQS queue
       
      * For the ``application`` protocol, the endpoint is the EndpointArn of a mobile app and device.
       

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'SubscriptionArn': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* Response for Subscribe action.
        

        - **SubscriptionArn** *(string) --* 

          The ARN of the subscription, if the service was able to create a subscription immediately (without requiring endpoint owner confirmation).

          
    

  .. py:method:: unsubscribe(**kwargs)

    

    Deletes a subscription. If the subscription requires authentication for deletion, only the owner of the subscription or the topic's owner can unsubscribe, and an AWS signature is required. If the ``Unsubscribe`` call does not require authentication and the requester is not the subscription owner, a final cancellation message is delivered to the endpoint, so that the endpoint owner can easily resubscribe to the topic if the ``Unsubscribe`` request was unintended.

    

    **Request Syntax** 
    ::

      response = client.unsubscribe(
          SubscriptionArn='string'
      )
    :type SubscriptionArn: string
    :param SubscriptionArn: **[REQUIRED]** 

      The ARN of the subscription to be deleted.

      

    
    
    :returns: None

==========
Paginators
==========


The available paginators are:

* :py:class:`SNS.Paginator.list_endpoints_by_platform_application`


* :py:class:`SNS.Paginator.list_platform_applications`


* :py:class:`SNS.Paginator.list_subscriptions`


* :py:class:`SNS.Paginator.list_subscriptions_by_topic`


* :py:class:`SNS.Paginator.list_topics`



.. py:class:: SNS.Paginator.list_endpoints_by_platform_application

  ::

    
    paginator = client.get_paginator('list_endpoints_by_platform_application')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`SNS.Client.list_endpoints_by_platform_application`.

    **Request Syntax** 
    ::

      response_iterator = paginator.paginate(
          PlatformApplicationArn='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
    :type PlatformApplicationArn: string
    :param PlatformApplicationArn: **[REQUIRED]** 

      PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Endpoints': [
                {
                    'EndpointArn': 'string',
                    'Attributes': {
                        'string': 'string'
                    }
                },
            ],
            
        }
      **Response Structure** 

      

      - *(dict) --* 

        Response for ListEndpointsByPlatformApplication action.

        
        

        - **Endpoints** *(list) --* 

          Endpoints returned for ListEndpointsByPlatformApplication action.

          
          

          - *(dict) --* 

            Endpoint for mobile app and device.

            
            

            - **EndpointArn** *(string) --* 

              EndpointArn for mobile app and device.

              
            

            - **Attributes** *(dict) --* 

              Attributes for endpoint.

              
              

              - *(string) --* 
                

                - *(string) --* 
          
        
        
      
    

.. py:class:: SNS.Paginator.list_platform_applications

  ::

    
    paginator = client.get_paginator('list_platform_applications')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`SNS.Client.list_platform_applications`.

    **Request Syntax** 
    ::

      response_iterator = paginator.paginate(
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'PlatformApplications': [
                {
                    'PlatformApplicationArn': 'string',
                    'Attributes': {
                        'string': 'string'
                    }
                },
            ],
            
        }
      **Response Structure** 

      

      - *(dict) --* 

        Response for ListPlatformApplications action.

        
        

        - **PlatformApplications** *(list) --* 

          Platform applications returned when calling ListPlatformApplications action.

          
          

          - *(dict) --* 

            Platform application object.

            
            

            - **PlatformApplicationArn** *(string) --* 

              PlatformApplicationArn for platform application object.

              
            

            - **Attributes** *(dict) --* 

              Attributes for platform application object.

              
              

              - *(string) --* 
                

                - *(string) --* 
          
        
        
      
    

.. py:class:: SNS.Paginator.list_subscriptions

  ::

    
    paginator = client.get_paginator('list_subscriptions')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`SNS.Client.list_subscriptions`.

    **Request Syntax** 
    ::

      response_iterator = paginator.paginate(
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Subscriptions': [
                {
                    'SubscriptionArn': 'string',
                    'Owner': 'string',
                    'Protocol': 'string',
                    'Endpoint': 'string',
                    'TopicArn': 'string'
                },
            ],
            
        }
      **Response Structure** 

      

      - *(dict) --* 

        Response for ListSubscriptions action

        
        

        - **Subscriptions** *(list) --* 

          A list of subscriptions.

          
          

          - *(dict) --* 

            A wrapper type for the attributes of an Amazon SNS subscription.

            
            

            - **SubscriptionArn** *(string) --* 

              The subscription's ARN.

              
            

            - **Owner** *(string) --* 

              The subscription's owner.

              
            

            - **Protocol** *(string) --* 

              The subscription's protocol.

              
            

            - **Endpoint** *(string) --* 

              The subscription's endpoint (format depends on the protocol).

              
            

            - **TopicArn** *(string) --* 

              The ARN of the subscription's topic.

              
        
      
    

.. py:class:: SNS.Paginator.list_subscriptions_by_topic

  ::

    
    paginator = client.get_paginator('list_subscriptions_by_topic')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`SNS.Client.list_subscriptions_by_topic`.

    **Request Syntax** 
    ::

      response_iterator = paginator.paginate(
          TopicArn='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
    :type TopicArn: string
    :param TopicArn: **[REQUIRED]** 

      The ARN of the topic for which you wish to find subscriptions.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Subscriptions': [
                {
                    'SubscriptionArn': 'string',
                    'Owner': 'string',
                    'Protocol': 'string',
                    'Endpoint': 'string',
                    'TopicArn': 'string'
                },
            ],
            
        }
      **Response Structure** 

      

      - *(dict) --* 

        Response for ListSubscriptionsByTopic action.

        
        

        - **Subscriptions** *(list) --* 

          A list of subscriptions.

          
          

          - *(dict) --* 

            A wrapper type for the attributes of an Amazon SNS subscription.

            
            

            - **SubscriptionArn** *(string) --* 

              The subscription's ARN.

              
            

            - **Owner** *(string) --* 

              The subscription's owner.

              
            

            - **Protocol** *(string) --* 

              The subscription's protocol.

              
            

            - **Endpoint** *(string) --* 

              The subscription's endpoint (format depends on the protocol).

              
            

            - **TopicArn** *(string) --* 

              The ARN of the subscription's topic.

              
        
      
    

.. py:class:: SNS.Paginator.list_topics

  ::

    
    paginator = client.get_paginator('list_topics')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`SNS.Client.list_topics`.

    **Request Syntax** 
    ::

      response_iterator = paginator.paginate(
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Topics': [
                {
                    'TopicArn': 'string'
                },
            ],
            
        }
      **Response Structure** 

      

      - *(dict) --* 

        Response for ListTopics action.

        
        

        - **Topics** *(list) --* 

          A list of topic ARNs.

          
          

          - *(dict) --* 

            A wrapper type for the topic's Amazon Resource Name (ARN). To retrieve a topic's attributes, use ``GetTopicAttributes`` .

            
            

            - **TopicArn** *(string) --* 

              The topic's ARN.

              
        
      
    

================
Service Resource
================



.. py:class:: SNS.ServiceResource()

  A resource representing Amazon Simple Notification Service (SNS)::

    
    import boto3
    
    sns = boto3.resource('sns')

  
  These are the resource's available actions:
  
  *   :py:meth:`create_platform_application()`

  
  *   :py:meth:`create_topic()`

  
  These are the resource's available sub-resources:
  
  *   :py:meth:`PlatformApplication()`

  
  *   :py:meth:`PlatformEndpoint()`

  
  *   :py:meth:`Subscription()`

  
  *   :py:meth:`Topic()`

  
  These are the resource's available collections:
  
  *   :py:attr:`platform_applications`

  
  *   :py:attr:`subscriptions`

  
  *   :py:attr:`topics`

  
  .. rst-class:: admonition-title
  
  Actions
  
  Actions call operations on resources.  They may automatically handle the passing in of arguments set from identifiers and some attributes.
  For more information about actions refer to the :ref:`Resources Introduction Guide<actions_intro>`.
  

  .. py:method:: create_platform_application(**kwargs)

    

    Creates a platform application object for one of the supported push notification services, such as APNS and GCM, to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential attributes when using the ``CreatePlatformApplication`` action. The PlatformPrincipal is received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is "SSL certificate". For GCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is "client id". The PlatformCredential is also received from the notification service. For APNS/APNS_SANDBOX, PlatformCredential is "private key". For GCM, PlatformCredential is "API key". For ADM, PlatformCredential is "client secret". The PlatformApplicationArn that is returned when using ``CreatePlatformApplication`` is then used as an attribute for the ``CreatePlatformEndpoint`` action. For more information, see `Using Amazon SNS Mobile Push Notifications`_ . 

    

    **Request Syntax** 
    ::

      platform_application = sns.create_platform_application(
          Name='string',
          Platform='string',
          Attributes={
              'string': 'string'
          }
      )
    :type Name: string
    :param Name: **[REQUIRED]** 

      Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long.

      

    
    :type Platform: string
    :param Platform: **[REQUIRED]** 

      The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Google Cloud Messaging).

      

    
    :type Attributes: dict
    :param Attributes: **[REQUIRED]** 

      For a list of attributes, see `SetPlatformApplicationAttributes`_ 

      

    
      - *(string) --* 

      
        - *(string) --* 

        
  

    
    :rtype: :py:class:`sns.PlatformApplication`
    :returns: A PlatformApplication resource
    

  .. py:method:: create_topic(**kwargs)

    

    Creates a topic to which notifications can be published. Users can create at most 3000 topics. For more information, see `http\://aws.amazon.com/sns`_ . This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic.

    

    **Request Syntax** 
    ::

      topic = sns.create_topic(
          Name='string'
      )
    :type Name: string
    :param Name: **[REQUIRED]** 

      The name of the topic you want to create.

       

      Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. 

      

    
    
    :rtype: :py:class:`sns.Topic`
    :returns: A Topic resource
    
  .. rst-class:: admonition-title
  
  Sub-resources
  
  Sub-resources are methods that create a new instance of a child resource. This resource's identifiers get passed along to the child.
  For more information about sub-resources refer to the :ref:`Resources Introduction Guide<subresources_intro>`.
  

  .. py:method:: PlatformApplication(arn)

    Creates a PlatformApplication resource.::

      platform_application = sns.PlatformApplication('arn')

    :type arn: string
    :param arn: The PlatformApplication's arn identifier. This **must** be set.
    
    :rtype: :py:class:`SNS.PlatformApplication`
    :returns: A PlatformApplication resource
    

  .. py:method:: PlatformEndpoint(arn)

    Creates a PlatformEndpoint resource.::

      platform_endpoint = sns.PlatformEndpoint('arn')

    :type arn: string
    :param arn: The PlatformEndpoint's arn identifier. This **must** be set.
    
    :rtype: :py:class:`SNS.PlatformEndpoint`
    :returns: A PlatformEndpoint resource
    

  .. py:method:: Subscription(arn)

    Creates a Subscription resource.::

      subscription = sns.Subscription('arn')

    :type arn: string
    :param arn: The Subscription's arn identifier. This **must** be set.
    
    :rtype: :py:class:`SNS.Subscription`
    :returns: A Subscription resource
    

  .. py:method:: Topic(arn)

    Creates a Topic resource.::

      topic = sns.Topic('arn')

    :type arn: string
    :param arn: The Topic's arn identifier. This **must** be set.
    
    :rtype: :py:class:`SNS.Topic`
    :returns: A Topic resource
    
  .. rst-class:: admonition-title
  
  Collections
  
  Collections provide an interface to iterate over and manipulate groups of resources. 
  For more information about collections refer to the :ref:`Resources Introduction Guide<guide_collections>`.
  

  .. py:attribute:: platform_applications

    

    .. py:method:: all()

      Creates an iterable of all PlatformApplication resources in the collection.

      **Request Syntax** 
      ::

        platform_application_iterator = sns.platform_applications.all()
        
      
      :rtype: :py:class:`sns.PlatformApplication`
      :returns: A PlatformApplication resource
      

    .. py:method:: filter(**kwargs)

      Creates an iterable of all PlatformApplication resources in the collection filtered by kwargs passed to method.

      **Request Syntax** 
      ::

        platform_application_iterator = sns.platform_applications.filter(
            NextToken='string'
        )
      :type NextToken: string
      :param NextToken: 

        NextToken string is used when calling ListPlatformApplications action to retrieve additional records that are available after the first page results.

        

      
      
      :rtype: :py:class:`sns.PlatformApplication`
      :returns: A PlatformApplication resource
      

    .. py:method:: limit(**kwargs)

      Creates an iterable up to a specified amount of PlatformApplication resources in the collection.

      **Request Syntax** 
      ::

        platform_application_iterator = sns.platform_applications.limit(
            count=123
        )
      :type count: integer
      :param count: The limit to the number of resources in the iterable.

      
      
      :rtype: :py:class:`sns.PlatformApplication`
      :returns: A PlatformApplication resource
      

    .. py:method:: page_size(**kwargs)

      Creates an iterable of all PlatformApplication resources in the collection, but limits the number of items returned by each service call by the specified amount.

      **Request Syntax** 
      ::

        platform_application_iterator = sns.platform_applications.page_size(
            count=123
        )
      :type count: integer
      :param count: The number of items returned by each service call

      
      
      :rtype: :py:class:`sns.PlatformApplication`
      :returns: A PlatformApplication resource
      

  .. py:attribute:: subscriptions

    

    .. py:method:: all()

      Creates an iterable of all Subscription resources in the collection.

      **Request Syntax** 
      ::

        subscription_iterator = sns.subscriptions.all()
        
      
      :rtype: :py:class:`sns.Subscription`
      :returns: A Subscription resource
      

    .. py:method:: filter(**kwargs)

      Creates an iterable of all Subscription resources in the collection filtered by kwargs passed to method.

      **Request Syntax** 
      ::

        subscription_iterator = sns.subscriptions.filter(
            NextToken='string'
        )
      :type NextToken: string
      :param NextToken: 

        Token returned by the previous ``ListSubscriptions`` request.

        

      
      
      :rtype: :py:class:`sns.Subscription`
      :returns: A Subscription resource
      

    .. py:method:: limit(**kwargs)

      Creates an iterable up to a specified amount of Subscription resources in the collection.

      **Request Syntax** 
      ::

        subscription_iterator = sns.subscriptions.limit(
            count=123
        )
      :type count: integer
      :param count: The limit to the number of resources in the iterable.

      
      
      :rtype: :py:class:`sns.Subscription`
      :returns: A Subscription resource
      

    .. py:method:: page_size(**kwargs)

      Creates an iterable of all Subscription resources in the collection, but limits the number of items returned by each service call by the specified amount.

      **Request Syntax** 
      ::

        subscription_iterator = sns.subscriptions.page_size(
            count=123
        )
      :type count: integer
      :param count: The number of items returned by each service call

      
      
      :rtype: :py:class:`sns.Subscription`
      :returns: A Subscription resource
      

  .. py:attribute:: topics

    

    .. py:method:: all()

      Creates an iterable of all Topic resources in the collection.

      **Request Syntax** 
      ::

        topic_iterator = sns.topics.all()
        
      
      :rtype: :py:class:`sns.Topic`
      :returns: A Topic resource
      

    .. py:method:: filter(**kwargs)

      Creates an iterable of all Topic resources in the collection filtered by kwargs passed to method.

      **Request Syntax** 
      ::

        topic_iterator = sns.topics.filter(
            NextToken='string'
        )
      :type NextToken: string
      :param NextToken: 

        Token returned by the previous ``ListTopics`` request.

        

      
      
      :rtype: :py:class:`sns.Topic`
      :returns: A Topic resource
      

    .. py:method:: limit(**kwargs)

      Creates an iterable up to a specified amount of Topic resources in the collection.

      **Request Syntax** 
      ::

        topic_iterator = sns.topics.limit(
            count=123
        )
      :type count: integer
      :param count: The limit to the number of resources in the iterable.

      
      
      :rtype: :py:class:`sns.Topic`
      :returns: A Topic resource
      

    .. py:method:: page_size(**kwargs)

      Creates an iterable of all Topic resources in the collection, but limits the number of items returned by each service call by the specified amount.

      **Request Syntax** 
      ::

        topic_iterator = sns.topics.page_size(
            count=123
        )
      :type count: integer
      :param count: The number of items returned by each service call

      
      
      :rtype: :py:class:`sns.Topic`
      :returns: A Topic resource
      

===================
PlatformApplication
===================



.. py:class:: SNS.PlatformApplication(arn)

  A resource representing an Amazon Simple Notification Service (SNS) PlatformApplication::

    
    import boto3
    
    sns = boto3.resource('sns')
    platform_application = sns.PlatformApplication('arn')

  :type arn: string
  :param arn: The PlatformApplication's arn identifier. This **must** be set.
  
  These are the resource's available identifiers:
  
  *   :py:attr:`arn`

  
  These are the resource's available attributes:
  
  *   :py:attr:`attributes`

  
  These are the resource's available actions:
  
  *   :py:meth:`create_platform_endpoint()`

  
  *   :py:meth:`delete()`

  
  *   :py:meth:`load()`

  
  *   :py:meth:`reload()`

  
  *   :py:meth:`set_attributes()`

  
  These are the resource's available collections:
  
  *   :py:attr:`endpoints`

  
  .. rst-class:: admonition-title
  
  Identifiers
  
  Identifiers are properties of a resource that are set upon instantation of the resource.
  For more information about identifiers refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.
  

  .. py:attribute:: arn

    *(string)* The PlatformApplication's arn identifier. This **must** be set.
  .. rst-class:: admonition-title
  
  Attributes
  
  Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the :py:meth:`load` method.
  For more information about attributes refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.
  

  .. py:attribute:: attributes

    *(dict)* 

    Attributes include the following:

     

     
    *  ``EventEndpointCreated`` -- Topic ARN to which EndpointCreated event notifications should be sent.
     
    *  ``EventEndpointDeleted`` -- Topic ARN to which EndpointDeleted event notifications should be sent.
     
    *  ``EventEndpointUpdated`` -- Topic ARN to which EndpointUpdate event notifications should be sent.
     
    *  ``EventDeliveryFailure`` -- Topic ARN to which DeliveryFailure event notifications should be sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.
     

    
  .. rst-class:: admonition-title
  
  Actions
  
  Actions call operations on resources.  They may automatically handle the passing in of arguments set from identifiers and some attributes.
  For more information about actions refer to the :ref:`Resources Introduction Guide<actions_intro>`.
  

  .. py:method:: create_platform_endpoint(**kwargs)

    

    Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM and APNS. ``CreatePlatformEndpoint`` requires the PlatformApplicationArn that is returned from ``CreatePlatformApplication`` . The EndpointArn that is returned when using ``CreatePlatformEndpoint`` can then be used by the ``Publish`` action to send a message to a mobile app or by the ``Subscribe`` action for subscription to a topic. The ``CreatePlatformEndpoint`` action is idempotent, so if the requester already owns an endpoint with the same device token and attributes, that endpoint's ARN is returned without creating a new endpoint. For more information, see `Using Amazon SNS Mobile Push Notifications`_ . 

     

    When using ``CreatePlatformEndpoint`` with Baidu, two attributes must be provided: ChannelId and UserId. The token field must also contain the ChannelId. For more information, see `Creating an Amazon SNS Endpoint for Baidu`_ . 

    

    **Request Syntax** 
    ::

      platform_endpoint = platform_application.create_platform_endpoint(
          Token='string',
          CustomUserData='string',
          Attributes={
              'string': 'string'
          }
      )
    :type Token: string
    :param Token: **[REQUIRED]** 

      Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM or ADM, the device token equivalent is called the registration ID.

      

    
    :type CustomUserData: string
    :param CustomUserData: 

      Arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.

      

    
    :type Attributes: dict
    :param Attributes: 

      For a list of attributes, see `SetEndpointAttributes`_ .

      

    
      - *(string) --* 

      
        - *(string) --* 

        
  

    
    :rtype: :py:class:`sns.PlatformEndpoint`
    :returns: A PlatformEndpoint resource
    

  .. py:method:: delete()

    

    Deletes a platform application object for one of the supported push notification services, such as APNS and GCM. For more information, see `Using Amazon SNS Mobile Push Notifications`_ . 

    

    **Request Syntax** 
    ::

      response = platform_application.delete()
      
    
    :returns: None

  .. py:method:: load()

    Calls :py:meth:`sns.Client.get_platform_application_attributes` to update the attributes of the PlatformApplication resource

    **Request Syntax** 

    ::

      platform_application.load()
    :returns: None

  .. py:method:: reload()

    Calls :py:meth:`sns.Client.get_platform_application_attributes` to update the attributes of the PlatformApplication resource

    **Request Syntax** 

    ::

      platform_application.reload()
    :returns: None

  .. py:method:: set_attributes(**kwargs)

    

    Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see `Using Amazon SNS Mobile Push Notifications`_ . 

    

    **Request Syntax** 
    ::

      response = platform_application.set_attributes(
          Attributes={
              'string': 'string'
          }
      )
    :type Attributes: dict
    :param Attributes: **[REQUIRED]** 

      A map of the platform application attributes. Attributes in this map include the following:

       

       
      *  ``PlatformCredential`` -- The credential received from the notification service. For APNS/APNS_SANDBOX, PlatformCredential is "private key". For GCM, PlatformCredential is "API key". For ADM, PlatformCredential is "client secret".
       
      *  ``PlatformPrincipal`` -- The principal received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is "SSL certificate". For GCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is "client id".
       
      *  ``EventEndpointCreated`` -- Topic ARN to which EndpointCreated event notifications should be sent.
       
      *  ``EventEndpointDeleted`` -- Topic ARN to which EndpointDeleted event notifications should be sent.
       
      *  ``EventEndpointUpdated`` -- Topic ARN to which EndpointUpdate event notifications should be sent.
       
      *  ``EventDeliveryFailure`` -- Topic ARN to which DeliveryFailure event notifications should be sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.
       

      

    
      - *(string) --* 

      
        - *(string) --* 

        
  

    
    :returns: None
  .. rst-class:: admonition-title
  
  Collections
  
  Collections provide an interface to iterate over and manipulate groups of resources. 
  For more information about collections refer to the :ref:`Resources Introduction Guide<guide_collections>`.
  

  .. py:attribute:: endpoints

    

    .. py:method:: all()

      Creates an iterable of all PlatformEndpoint resources in the collection.

      **Request Syntax** 
      ::

        platform_endpoint_iterator = platform_application.endpoints.all()
        
      
      :rtype: :py:class:`sns.PlatformEndpoint`
      :returns: A PlatformEndpoint resource
      

    .. py:method:: filter(**kwargs)

      Creates an iterable of all PlatformEndpoint resources in the collection filtered by kwargs passed to method.

      **Request Syntax** 
      ::

        platform_endpoint_iterator = platform_application.endpoints.filter(
            NextToken='string'
        )
      :type NextToken: string
      :param NextToken: 

        NextToken string is used when calling ListEndpointsByPlatformApplication action to retrieve additional records that are available after the first page results.

        

      
      
      :rtype: :py:class:`sns.PlatformEndpoint`
      :returns: A PlatformEndpoint resource
      

    .. py:method:: limit(**kwargs)

      Creates an iterable up to a specified amount of PlatformEndpoint resources in the collection.

      **Request Syntax** 
      ::

        platform_endpoint_iterator = platform_application.endpoints.limit(
            count=123
        )
      :type count: integer
      :param count: The limit to the number of resources in the iterable.

      
      
      :rtype: :py:class:`sns.PlatformEndpoint`
      :returns: A PlatformEndpoint resource
      

    .. py:method:: page_size(**kwargs)

      Creates an iterable of all PlatformEndpoint resources in the collection, but limits the number of items returned by each service call by the specified amount.

      **Request Syntax** 
      ::

        platform_endpoint_iterator = platform_application.endpoints.page_size(
            count=123
        )
      :type count: integer
      :param count: The number of items returned by each service call

      
      
      :rtype: :py:class:`sns.PlatformEndpoint`
      :returns: A PlatformEndpoint resource
      

================
PlatformEndpoint
================



.. py:class:: SNS.PlatformEndpoint(arn)

  A resource representing an Amazon Simple Notification Service (SNS) PlatformEndpoint::

    
    import boto3
    
    sns = boto3.resource('sns')
    platform_endpoint = sns.PlatformEndpoint('arn')

  :type arn: string
  :param arn: The PlatformEndpoint's arn identifier. This **must** be set.
  
  These are the resource's available identifiers:
  
  *   :py:attr:`arn`

  
  These are the resource's available attributes:
  
  *   :py:attr:`attributes`

  
  These are the resource's available actions:
  
  *   :py:meth:`delete()`

  
  *   :py:meth:`load()`

  
  *   :py:meth:`publish()`

  
  *   :py:meth:`reload()`

  
  *   :py:meth:`set_attributes()`

  
  .. rst-class:: admonition-title
  
  Identifiers
  
  Identifiers are properties of a resource that are set upon instantation of the resource.
  For more information about identifiers refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.
  

  .. py:attribute:: arn

    *(string)* The PlatformEndpoint's arn identifier. This **must** be set.
  .. rst-class:: admonition-title
  
  Attributes
  
  Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the :py:meth:`load` method.
  For more information about attributes refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.
  

  .. py:attribute:: attributes

    *(dict)* 

    Attributes include the following:

     

     
    *  ``CustomUserData`` -- arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.
     
    *  ``Enabled`` -- flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.
     
    *  ``Token`` -- device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.
     

    
  .. rst-class:: admonition-title
  
  Actions
  
  Actions call operations on resources.  They may automatically handle the passing in of arguments set from identifiers and some attributes.
  For more information about actions refer to the :ref:`Resources Introduction Guide<actions_intro>`.
  

  .. py:method:: delete()

    

    Deletes the endpoint from Amazon SNS. This action is idempotent. For more information, see `Using Amazon SNS Mobile Push Notifications`_ . 

    

    **Request Syntax** 
    ::

      response = platform_endpoint.delete()
      
    
    :returns: None

  .. py:method:: load()

    Calls :py:meth:`sns.Client.get_endpoint_attributes` to update the attributes of the PlatformEndpoint resource

    **Request Syntax** 

    ::

      platform_endpoint.load()
    :returns: None

  .. py:method:: publish(**kwargs)

    

    Sends a message to all of a topic's subscribed endpoints. When a ``messageId`` is returned, the message has been saved and Amazon SNS will attempt to deliver it to the topic's subscribers shortly. The format of the outgoing message to each subscribed endpoint depends on the notification protocol selected.

     

    To use the ``Publish`` action for sending a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, you must specify the EndpointArn. The EndpointArn is returned when making a call with the ``CreatePlatformEndpoint`` action. The second example below shows a request and response for publishing to a mobile endpoint. 

    

    **Request Syntax** 
    ::

      response = platform_endpoint.publish(
          TopicArn='string',
          Message='string',
          Subject='string',
          MessageStructure='string',
          MessageAttributes={
              'string': {
                  'DataType': 'string',
                  'StringValue': 'string',
                  'BinaryValue': b'bytes'
              }
          }
      )
    :type TopicArn: string
    :param TopicArn: 

      The topic you want to publish to.

      

    
    :type Message: string
    :param Message: **[REQUIRED]** 

      The message you want to send to the topic.

       

      If you want to send the same message to all transport protocols, include the text of the message as a String value.

       

      If you want to send different messages for each transport protocol, set the value of the ``MessageStructure`` parameter to ``json`` and use a JSON object for the ``Message`` parameter. See the Examples section for the format of the JSON object. 

       

      Constraints: Messages must be UTF-8 encoded strings at most 256 KB in size (262144 bytes, not 262144 characters).

       

      JSON-specific constraints: 

       
      * Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values. 
       
      * The values will be parsed (unescaped) before they are used in outgoing messages.
       
      * Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).
       
      * Values have a minimum length of 0 (the empty string, "", is allowed).
       
      * Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).
       
      * Non-string values will cause the key to be ignored.
       
      * Keys that do not correspond to supported transport protocols are ignored.
       
      * Duplicate keys are not allowed.
       
      * Failure to parse or validate any key or value in the message will cause the ``Publish`` call to return an error (no partial delivery).
       

       

      

    
    :type Subject: string
    :param Subject: 

      Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints.

       

      Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.

      

    
    :type MessageStructure: string
    :param MessageStructure: 

      Set ``MessageStructure`` to ``json`` if you want to send a different message for each protocol. For example, using one publish action, you can send a short message to your SMS subscribers and a longer message to your email subscribers. If you set ``MessageStructure`` to ``json`` , the value of the ``Message`` parameter must: 

       

       
      * be a syntactically valid JSON object; and
       
      * contain at least a top-level JSON key of "default" with a value that is a string.
       

       

      You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g., "http"). 

       

      For information about sending different messages for each protocol using the AWS Management Console, go to `Create Different Messages for Each Protocol`_ in the *Amazon Simple Notification Service Getting Started Guide* . 

       

      Valid value: ``json`` 

      

    
    :type MessageAttributes: dict
    :param MessageAttributes: 

      Message attributes for Publish action.

      

    
      - *(string) --* 

      
        - *(dict) --* 

          The user-specified message attribute value. For string data types, the value attribute has the same restrictions on the content as the message body. For more information, see `Publish`_ .

           

          Name, type, and value must not be empty or null. In addition, the message body should not be empty or null. All parts of the message attribute, including name, type, and value, are included in the message size restriction, which is currently 256 KB (262,144 bytes). For more information, see `Using Amazon SNS Message Attributes`_ .

          

        
          - **DataType** *(string) --* **[REQUIRED]** 

            Amazon SNS supports the following logical data types: String, Number, and Binary. For more information, see `Message Attribute Data Types`_ .

            

          
          - **StringValue** *(string) --* 

            Strings are Unicode with UTF8 binary encoding. For a list of code values, see `http\://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters`_ .

            

          
          - **BinaryValue** *(bytes) --* 

            Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.

            

          
        
  

    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'MessageId': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 

        Response for Publish action.

        
        

        - **MessageId** *(string) --* 

          Unique identifier assigned to the published message.

           

          Length Constraint: Maximum 100 characters

          
    

  .. py:method:: reload()

    Calls :py:meth:`sns.Client.get_endpoint_attributes` to update the attributes of the PlatformEndpoint resource

    **Request Syntax** 

    ::

      platform_endpoint.reload()
    :returns: None

  .. py:method:: set_attributes(**kwargs)

    

    Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM and APNS. For more information, see `Using Amazon SNS Mobile Push Notifications`_ . 

    

    **Request Syntax** 
    ::

      response = platform_endpoint.set_attributes(
          Attributes={
              'string': 'string'
          }
      )
    :type Attributes: dict
    :param Attributes: **[REQUIRED]** 

      A map of the endpoint attributes. Attributes in this map include the following:

       

       
      *  ``CustomUserData`` -- arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.
       
      *  ``Enabled`` -- flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.
       
      *  ``Token`` -- device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.
       

      

    
      - *(string) --* 

      
        - *(string) --* 

        
  

    
    :returns: None

============
Subscription
============



.. py:class:: SNS.Subscription(arn)

  A resource representing an Amazon Simple Notification Service (SNS) Subscription::

    
    import boto3
    
    sns = boto3.resource('sns')
    subscription = sns.Subscription('arn')

  :type arn: string
  :param arn: The Subscription's arn identifier. This **must** be set.
  
  These are the resource's available identifiers:
  
  *   :py:attr:`arn`

  
  These are the resource's available attributes:
  
  *   :py:attr:`attributes`

  
  These are the resource's available actions:
  
  *   :py:meth:`delete()`

  
  *   :py:meth:`load()`

  
  *   :py:meth:`reload()`

  
  *   :py:meth:`set_attributes()`

  
  .. rst-class:: admonition-title
  
  Identifiers
  
  Identifiers are properties of a resource that are set upon instantation of the resource.
  For more information about identifiers refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.
  

  .. py:attribute:: arn

    *(string)* The Subscription's arn identifier. This **must** be set.
  .. rst-class:: admonition-title
  
  Attributes
  
  Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the :py:meth:`load` method.
  For more information about attributes refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.
  

  .. py:attribute:: attributes

    *(dict)* 

    A map of the subscription's attributes. Attributes in this map include the following:

     

     
    *  ``SubscriptionArn`` -- the subscription's ARN
     
    *  ``TopicArn`` -- the topic ARN that the subscription is associated with
     
    *  ``Owner`` -- the AWS account ID of the subscription's owner
     
    *  ``ConfirmationWasAuthenticated`` -- true if the subscription confirmation request was authenticated
     
    *  ``DeliveryPolicy`` -- the JSON serialization of the subscription's delivery policy
     
    *  ``EffectiveDeliveryPolicy`` -- the JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults
     

    
  .. rst-class:: admonition-title
  
  Actions
  
  Actions call operations on resources.  They may automatically handle the passing in of arguments set from identifiers and some attributes.
  For more information about actions refer to the :ref:`Resources Introduction Guide<actions_intro>`.
  

  .. py:method:: delete()

    

    Deletes a subscription. If the subscription requires authentication for deletion, only the owner of the subscription or the topic's owner can unsubscribe, and an AWS signature is required. If the ``Unsubscribe`` call does not require authentication and the requester is not the subscription owner, a final cancellation message is delivered to the endpoint, so that the endpoint owner can easily resubscribe to the topic if the ``Unsubscribe`` request was unintended.

    

    **Request Syntax** 
    ::

      response = subscription.delete()
      
    
    :returns: None

  .. py:method:: load()

    Calls :py:meth:`sns.Client.get_subscription_attributes` to update the attributes of the Subscription resource

    **Request Syntax** 

    ::

      subscription.load()
    :returns: None

  .. py:method:: reload()

    Calls :py:meth:`sns.Client.get_subscription_attributes` to update the attributes of the Subscription resource

    **Request Syntax** 

    ::

      subscription.reload()
    :returns: None

  .. py:method:: set_attributes(**kwargs)

    

    Allows a subscription owner to set an attribute of the topic to a new value.

    

    **Request Syntax** 
    ::

      response = subscription.set_attributes(
          AttributeName='string',
          AttributeValue='string'
      )
    :type AttributeName: string
    :param AttributeName: **[REQUIRED]** 

      The name of the attribute you want to set. Only a subset of the subscriptions attributes are mutable.

       

      Valid values: ``DeliveryPolicy`` | ``RawMessageDelivery`` 

      

    
    :type AttributeValue: string
    :param AttributeValue: 

      The new value for the attribute in JSON format.

      

    
    
    :returns: None

=====
Topic
=====



.. py:class:: SNS.Topic(arn)

  A resource representing an Amazon Simple Notification Service (SNS) Topic::

    
    import boto3
    
    sns = boto3.resource('sns')
    topic = sns.Topic('arn')

  :type arn: string
  :param arn: The Topic's arn identifier. This **must** be set.
  
  These are the resource's available identifiers:
  
  *   :py:attr:`arn`

  
  These are the resource's available attributes:
  
  *   :py:attr:`attributes`

  
  These are the resource's available actions:
  
  *   :py:meth:`add_permission()`

  
  *   :py:meth:`confirm_subscription()`

  
  *   :py:meth:`delete()`

  
  *   :py:meth:`load()`

  
  *   :py:meth:`publish()`

  
  *   :py:meth:`reload()`

  
  *   :py:meth:`remove_permission()`

  
  *   :py:meth:`set_attributes()`

  
  *   :py:meth:`subscribe()`

  
  These are the resource's available collections:
  
  *   :py:attr:`subscriptions`

  
  .. rst-class:: admonition-title
  
  Identifiers
  
  Identifiers are properties of a resource that are set upon instantation of the resource.
  For more information about identifiers refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.
  

  .. py:attribute:: arn

    *(string)* The Topic's arn identifier. This **must** be set.
  .. rst-class:: admonition-title
  
  Attributes
  
  Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the :py:meth:`load` method.
  For more information about attributes refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.
  

  .. py:attribute:: attributes

    *(dict)* 

    A map of the topic's attributes. Attributes in this map include the following:

     

     
    *  ``TopicArn`` -- the topic's ARN
     
    *  ``Owner`` -- the AWS account ID of the topic's owner
     
    *  ``Policy`` -- the JSON serialization of the topic's access control policy
     
    *  ``DisplayName`` -- the human-readable name used in the "From" field for notifications to email and email-json endpoints
     
    *  ``SubscriptionsPending`` -- the number of subscriptions pending confirmation on this topic
     
    *  ``SubscriptionsConfirmed`` -- the number of confirmed subscriptions on this topic
     
    *  ``SubscriptionsDeleted`` -- the number of deleted subscriptions on this topic
     
    *  ``DeliveryPolicy`` -- the JSON serialization of the topic's delivery policy
     
    *  ``EffectiveDeliveryPolicy`` -- the JSON serialization of the effective delivery policy that takes into account system defaults
     

    
  .. rst-class:: admonition-title
  
  Actions
  
  Actions call operations on resources.  They may automatically handle the passing in of arguments set from identifiers and some attributes.
  For more information about actions refer to the :ref:`Resources Introduction Guide<actions_intro>`.
  

  .. py:method:: add_permission(**kwargs)

    

    Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.

    

    **Request Syntax** 
    ::

      response = topic.add_permission(
          Label='string',
          AWSAccountId=[
              'string',
          ],
          ActionName=[
              'string',
          ]
      )
    :type Label: string
    :param Label: **[REQUIRED]** 

      A unique identifier for the new policy statement.

      

    
    :type AWSAccountId: list
    :param AWSAccountId: **[REQUIRED]** 

      The AWS account IDs of the users (principals) who will be given access to the specified actions. The users must have AWS accounts, but do not need to be signed up for this service. 

      

    
      - *(string) --* 

      
  
    :type ActionName: list
    :param ActionName: **[REQUIRED]** 

      The action you want to allow for the specified principal(s).

       

      Valid values: any Amazon SNS action name.

      

    
      - *(string) --* 

      
  
    
    :returns: None

  .. py:method:: confirm_subscription(**kwargs)

    

    Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier ``Subscribe`` action. If the token is valid, the action creates a new subscription and returns its Amazon Resource Name (ARN). This call requires an AWS signature only when the ``AuthenticateOnUnsubscribe`` flag is set to "true".

    

    **Request Syntax** 
    ::

      subscription = topic.confirm_subscription(
          Token='string',
          AuthenticateOnUnsubscribe='string'
      )
    :type Token: string
    :param Token: **[REQUIRED]** 

      Short-lived token sent to an endpoint during the ``Subscribe`` action.

      

    
    :type AuthenticateOnUnsubscribe: string
    :param AuthenticateOnUnsubscribe: 

      Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is ``true`` and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires AWS authentication. 

      

    
    
    :rtype: :py:class:`sns.Subscription`
    :returns: A Subscription resource
    

  .. py:method:: delete()

    

    Deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error.

    

    **Request Syntax** 
    ::

      response = topic.delete()
      
    
    :returns: None

  .. py:method:: load()

    Calls :py:meth:`sns.Client.get_topic_attributes` to update the attributes of the Topic resource

    **Request Syntax** 

    ::

      topic.load()
    :returns: None

  .. py:method:: publish(**kwargs)

    

    Sends a message to all of a topic's subscribed endpoints. When a ``messageId`` is returned, the message has been saved and Amazon SNS will attempt to deliver it to the topic's subscribers shortly. The format of the outgoing message to each subscribed endpoint depends on the notification protocol selected.

     

    To use the ``Publish`` action for sending a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, you must specify the EndpointArn. The EndpointArn is returned when making a call with the ``CreatePlatformEndpoint`` action. The second example below shows a request and response for publishing to a mobile endpoint. 

    

    **Request Syntax** 
    ::

      response = topic.publish(
          TargetArn='string',
          Message='string',
          Subject='string',
          MessageStructure='string',
          MessageAttributes={
              'string': {
                  'DataType': 'string',
                  'StringValue': 'string',
                  'BinaryValue': b'bytes'
              }
          }
      )
    :type TargetArn: string
    :param TargetArn: 

      Either TopicArn or EndpointArn, but not both.

      

    
    :type Message: string
    :param Message: **[REQUIRED]** 

      The message you want to send to the topic.

       

      If you want to send the same message to all transport protocols, include the text of the message as a String value.

       

      If you want to send different messages for each transport protocol, set the value of the ``MessageStructure`` parameter to ``json`` and use a JSON object for the ``Message`` parameter. See the Examples section for the format of the JSON object. 

       

      Constraints: Messages must be UTF-8 encoded strings at most 256 KB in size (262144 bytes, not 262144 characters).

       

      JSON-specific constraints: 

       
      * Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values. 
       
      * The values will be parsed (unescaped) before they are used in outgoing messages.
       
      * Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).
       
      * Values have a minimum length of 0 (the empty string, "", is allowed).
       
      * Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).
       
      * Non-string values will cause the key to be ignored.
       
      * Keys that do not correspond to supported transport protocols are ignored.
       
      * Duplicate keys are not allowed.
       
      * Failure to parse or validate any key or value in the message will cause the ``Publish`` call to return an error (no partial delivery).
       

       

      

    
    :type Subject: string
    :param Subject: 

      Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints.

       

      Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.

      

    
    :type MessageStructure: string
    :param MessageStructure: 

      Set ``MessageStructure`` to ``json`` if you want to send a different message for each protocol. For example, using one publish action, you can send a short message to your SMS subscribers and a longer message to your email subscribers. If you set ``MessageStructure`` to ``json`` , the value of the ``Message`` parameter must: 

       

       
      * be a syntactically valid JSON object; and
       
      * contain at least a top-level JSON key of "default" with a value that is a string.
       

       

      You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g., "http"). 

       

      For information about sending different messages for each protocol using the AWS Management Console, go to `Create Different Messages for Each Protocol`_ in the *Amazon Simple Notification Service Getting Started Guide* . 

       

      Valid value: ``json`` 

      

    
    :type MessageAttributes: dict
    :param MessageAttributes: 

      Message attributes for Publish action.

      

    
      - *(string) --* 

      
        - *(dict) --* 

          The user-specified message attribute value. For string data types, the value attribute has the same restrictions on the content as the message body. For more information, see `Publish`_ .

           

          Name, type, and value must not be empty or null. In addition, the message body should not be empty or null. All parts of the message attribute, including name, type, and value, are included in the message size restriction, which is currently 256 KB (262,144 bytes). For more information, see `Using Amazon SNS Message Attributes`_ .

          

        
          - **DataType** *(string) --* **[REQUIRED]** 

            Amazon SNS supports the following logical data types: String, Number, and Binary. For more information, see `Message Attribute Data Types`_ .

            

          
          - **StringValue** *(string) --* 

            Strings are Unicode with UTF8 binary encoding. For a list of code values, see `http\://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters`_ .

            

          
          - **BinaryValue** *(bytes) --* 

            Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.

            

          
        
  

    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'MessageId': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 

        Response for Publish action.

        
        

        - **MessageId** *(string) --* 

          Unique identifier assigned to the published message.

           

          Length Constraint: Maximum 100 characters

          
    

  .. py:method:: reload()

    Calls :py:meth:`sns.Client.get_topic_attributes` to update the attributes of the Topic resource

    **Request Syntax** 

    ::

      topic.reload()
    :returns: None

  .. py:method:: remove_permission(**kwargs)

    

    Removes a statement from a topic's access control policy.

    

    **Request Syntax** 
    ::

      response = topic.remove_permission(
          Label='string'
      )
    :type Label: string
    :param Label: **[REQUIRED]** 

      The unique label of the statement you want to remove.

      

    
    
    :returns: None

  .. py:method:: set_attributes(**kwargs)

    

    Allows a topic owner to set an attribute of the topic to a new value.

    

    **Request Syntax** 
    ::

      response = topic.set_attributes(
          AttributeName='string',
          AttributeValue='string'
      )
    :type AttributeName: string
    :param AttributeName: **[REQUIRED]** 

      The name of the attribute you want to set. Only a subset of the topic's attributes are mutable.

       

      Valid values: ``Policy`` | ``DisplayName`` | ``DeliveryPolicy`` 

      

    
    :type AttributeValue: string
    :param AttributeValue: 

      The new value for the attribute.

      

    
    
    :returns: None

  .. py:method:: subscribe(**kwargs)

    

    Prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a subscription, the endpoint owner must call the ``ConfirmSubscription`` action with the token from the confirmation message. Confirmation tokens are valid for three days.

    

    **Request Syntax** 
    ::

      subscription = topic.subscribe(
          Protocol='string',
          Endpoint='string'
      )
    :type Protocol: string
    :param Protocol: **[REQUIRED]** 

      The protocol you want to use. Supported protocols include:

       

       
      *  ``http`` -- delivery of JSON-encoded message via HTTP POST
       
      *  ``https`` -- delivery of JSON-encoded message via HTTPS POST
       
      *  ``email`` -- delivery of message via SMTP
       
      *  ``email-json`` -- delivery of JSON-encoded message via SMTP
       
      *  ``sms`` -- delivery of message via SMS
       
      *  ``sqs`` -- delivery of JSON-encoded message to an Amazon SQS queue
       
      *  ``application`` -- delivery of JSON-encoded message to an EndpointArn for a mobile app and device.
       

      

    
    :type Endpoint: string
    :param Endpoint: 

      The endpoint that you want to receive notifications. Endpoints vary by protocol:

       

       
      * For the ``http`` protocol, the endpoint is an URL beginning with "http://"
       
      * For the ``https`` protocol, the endpoint is a URL beginning with "https://"
       
      * For the ``email`` protocol, the endpoint is an email address
       
      * For the ``email-json`` protocol, the endpoint is an email address
       
      * For the ``sms`` protocol, the endpoint is a phone number of an SMS-enabled device
       
      * For the ``sqs`` protocol, the endpoint is the ARN of an Amazon SQS queue
       
      * For the ``application`` protocol, the endpoint is the EndpointArn of a mobile app and device.
       

      

    
    
    :rtype: :py:class:`sns.Subscription`
    :returns: A Subscription resource
    
  .. rst-class:: admonition-title
  
  Collections
  
  Collections provide an interface to iterate over and manipulate groups of resources. 
  For more information about collections refer to the :ref:`Resources Introduction Guide<guide_collections>`.
  

  .. py:attribute:: subscriptions

    

    .. py:method:: all()

      Creates an iterable of all Subscription resources in the collection.

      **Request Syntax** 
      ::

        subscription_iterator = topic.subscriptions.all()
        
      
      :rtype: :py:class:`sns.Subscription`
      :returns: A Subscription resource
      

    .. py:method:: filter(**kwargs)

      Creates an iterable of all Subscription resources in the collection filtered by kwargs passed to method.

      **Request Syntax** 
      ::

        subscription_iterator = topic.subscriptions.filter(
            NextToken='string'
        )
      :type NextToken: string
      :param NextToken: 

        Token returned by the previous ``ListSubscriptionsByTopic`` request.

        

      
      
      :rtype: :py:class:`sns.Subscription`
      :returns: A Subscription resource
      

    .. py:method:: limit(**kwargs)

      Creates an iterable up to a specified amount of Subscription resources in the collection.

      **Request Syntax** 
      ::

        subscription_iterator = topic.subscriptions.limit(
            count=123
        )
      :type count: integer
      :param count: The limit to the number of resources in the iterable.

      
      
      :rtype: :py:class:`sns.Subscription`
      :returns: A Subscription resource
      

    .. py:method:: page_size(**kwargs)

      Creates an iterable of all Subscription resources in the collection, but limits the number of items returned by each service call by the specified amount.

      **Request Syntax** 
      ::

        subscription_iterator = topic.subscriptions.page_size(
            count=123
        )
      :type count: integer
      :param count: The number of items returned by each service call

      
      
      :rtype: :py:class:`sns.Subscription`
      :returns: A Subscription resource
      