:doc:`Kinesis <../../kinesis>` / Paginator / ListStreams

***********
ListStreams
***********



.. py:class:: Kinesis.Paginator.ListStreams

  ::

    
    paginator = client.get_paginator('list_streams')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`Kinesis.Client.list_streams`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/ListStreams>`_    


    **Request Syntax**
    ::

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

      The name of the stream to start the list with.

      

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

      
      ::

        {
            'StreamNames': [
                'string',
            ],
            'HasMoreStreams': True|False,
            'StreamSummaries': [
                {
                    'StreamName': 'string',
                    'StreamARN': 'string',
                    'StreamStatus': 'CREATING'|'DELETING'|'ACTIVE'|'UPDATING',
                    'StreamModeDetails': {
                        'StreamMode': 'PROVISIONED'|'ON_DEMAND'
                    },
                    'StreamCreationTimestamp': datetime(2015, 1, 1)
                },
            ]
        }
        
      **Response Structure**

      

      - *(dict) --* 

        Represents the output for ``ListStreams``.

        
        

        - **StreamNames** *(list) --* 

          The names of the streams that are associated with the Amazon Web Services account making the ``ListStreams`` request.

          
          

          - *(string) --* 
      
        

        - **HasMoreStreams** *(boolean) --* 

          If set to ``true``, there are more streams available to list.

          
        

        - **StreamSummaries** *(list) --* 
          

          - *(dict) --* 

            The summary of a stream.

            
            

            - **StreamName** *(string) --* 

              The name of a stream.

              
            

            - **StreamARN** *(string) --* 

              The ARN of the stream.

              
            

            - **StreamStatus** *(string) --* 

              The status of the stream.

              
            

            - **StreamModeDetails** *(dict) --* 

              Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can choose between an **on-demand** capacity mode and a **provisioned** capacity mode for your data streams.

              
              

              - **StreamMode** *(string) --* 

                Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can choose between an **on-demand** capacity mode and a **provisioned** capacity mode for your data streams.

                
          
            

            - **StreamCreationTimestamp** *(datetime) --* 

              The timestamp at which the stream was created.

              
        
      
    