:doc:`IoTAnalytics <../../iotanalytics>` / Paginator / ListChannels

************
ListChannels
************



.. py:class:: IoTAnalytics.Paginator.ListChannels

  ::

    
    paginator = client.get_paginator('list_channels')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`IoTAnalytics.Client.list_channels`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iotanalytics-2017-11-27/ListChannels>`_    


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

      
      ::

        {
            'channelSummaries': [
                {
                    'channelName': 'string',
                    'channelStorage': {
                        'serviceManagedS3': {},
                        'customerManagedS3': {
                            'bucket': 'string',
                            'keyPrefix': 'string',
                            'roleArn': 'string'
                        }
                    },
                    'status': 'CREATING'|'ACTIVE'|'DELETING',
                    'creationTime': datetime(2015, 1, 1),
                    'lastUpdateTime': datetime(2015, 1, 1),
                    'lastMessageArrivalTime': datetime(2015, 1, 1)
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **channelSummaries** *(list) --* 

          A list of ``ChannelSummary`` objects.

          
          

          - *(dict) --* 

            A summary of information about a channel.

            
            

            - **channelName** *(string) --* 

              The name of the channel.

              
            

            - **channelStorage** *(dict) --* 

              Where channel data is stored.

              
              

              - **serviceManagedS3** *(dict) --* 

                Used to store channel data in an S3 bucket managed by IoT Analytics.

                
            
              

              - **customerManagedS3** *(dict) --* 

                Used to store channel data in an S3 bucket that you manage.

                
                

                - **bucket** *(string) --* 

                  The name of the S3 bucket in which channel data is stored.

                  
                

                - **keyPrefix** *(string) --* 

                  (Optional) The prefix used to create the keys of the channel data objects. Each object in an S3 bucket has a key that is its unique identifier within the bucket (each object in a bucket has exactly one key). The prefix must end with a forward slash (/).

                  
                

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

                  The ARN of the role that grants IoT Analytics permission to interact with your Amazon S3 resources.

                  
            
          
            

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

              The status of the channel.

              
            

            - **creationTime** *(datetime) --* 

              When the channel was created.

              
            

            - **lastUpdateTime** *(datetime) --* 

              The last time the channel was updated.

              
            

            - **lastMessageArrivalTime** *(datetime) --* 

              The last time when a new message arrived in the channel.

               

              IoT Analytics updates this value at most once per minute for one channel. Hence, the ``lastMessageArrivalTime`` value is an approximation.

               

              This feature only applies to messages that arrived in the data store after October 23, 2020.

              
        
      
        

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

          A token to resume pagination.

          
    