:doc:`IoT <../../iot>` / Paginator / ListTopicRuleDestinations

*************************
ListTopicRuleDestinations
*************************



.. py:class:: IoT.Paginator.ListTopicRuleDestinations

  ::

    
    paginator = client.get_paginator('list_topic_rule_destinations')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`IoT.Client.list_topic_rule_destinations`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iot-2015-05-28/ListTopicRuleDestinations>`_    


    **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**

      
      ::

        {
            'destinationSummaries': [
                {
                    'arn': 'string',
                    'status': 'ENABLED'|'IN_PROGRESS'|'DISABLED'|'ERROR'|'DELETING',
                    'createdAt': datetime(2015, 1, 1),
                    'lastUpdatedAt': datetime(2015, 1, 1),
                    'statusReason': 'string',
                    'httpUrlSummary': {
                        'confirmationUrl': 'string'
                    },
                    'vpcDestinationSummary': {
                        'subnetIds': [
                            'string',
                        ],
                        'securityGroups': [
                            'string',
                        ],
                        'vpcId': 'string',
                        'roleArn': 'string'
                    }
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **destinationSummaries** *(list) --* 

          Information about a topic rule destination.

          
          

          - *(dict) --* 

            Information about the topic rule destination.

            
            

            - **arn** *(string) --* 

              The topic rule destination ARN.

              
            

            - **status** *(string) --* 

              The status of the topic rule destination. Valid values are:

                IN_PROGRESS  

              A topic rule destination was created but has not been confirmed. You can set ``status`` to ``IN_PROGRESS`` by calling ``UpdateTopicRuleDestination``. Calling ``UpdateTopicRuleDestination`` causes a new confirmation challenge to be sent to your confirmation endpoint.

                ENABLED  

              Confirmation was completed, and traffic to this destination is allowed. You can set ``status`` to ``DISABLED`` by calling ``UpdateTopicRuleDestination``.

                DISABLED  

              Confirmation was completed, and traffic to this destination is not allowed. You can set ``status`` to ``ENABLED`` by calling ``UpdateTopicRuleDestination``.

                ERROR  

              Confirmation could not be completed, for example if the confirmation timed out. You can call ``GetTopicRuleDestination`` for details about the error. You can set ``status`` to ``IN_PROGRESS`` by calling ``UpdateTopicRuleDestination``. Calling ``UpdateTopicRuleDestination`` causes a new confirmation challenge to be sent to your confirmation endpoint.

              
            

            - **createdAt** *(datetime) --* 

              The date and time when the topic rule destination was created.

              
            

            - **lastUpdatedAt** *(datetime) --* 

              The date and time when the topic rule destination was last updated.

              
            

            - **statusReason** *(string) --* 

              The reason the topic rule destination is in the current status.

              
            

            - **httpUrlSummary** *(dict) --* 

              Information about the HTTP URL.

              
              

              - **confirmationUrl** *(string) --* 

                The URL used to confirm ownership of or access to the HTTP topic rule destination URL.

                
          
            

            - **vpcDestinationSummary** *(dict) --* 

              Information about the virtual private cloud (VPC) connection.

              
              

              - **subnetIds** *(list) --* 

                The subnet IDs of the VPC destination.

                
                

                - *(string) --* 
            
              

              - **securityGroups** *(list) --* 

                The security groups of the VPC destination.

                
                

                - *(string) --* 
            
              

              - **vpcId** *(string) --* 

                The ID of the VPC.

                
              

              - **roleArn** *(string) --* 

                The ARN of a role that has permission to create and attach to elastic network interfaces (ENIs).

                
          
        
      
        

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

          A token to resume pagination.

          
    