:doc:`IoT <../../iot>` / Client / list_streams

************
list_streams
************



.. py:method:: IoT.Client.list_streams(**kwargs)

  

  Lists all of the streams in your Amazon Web Services account.

   

  Requires permission to access the `ListStreams <https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions>`__ action.

  

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


  **Request Syntax**
  ::

    response = client.list_streams(
        maxResults=123,
        nextToken='string',
        ascendingOrder=True|False
    )
    
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results to return at a time.

    

  
  :type nextToken: string
  :param nextToken: 

    A token used to get the next set of results.

    

  
  :type ascendingOrder: boolean
  :param ascendingOrder: 

    Set to true to return the list of streams in ascending order.

    

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

    
    ::

      {
          'streams': [
              {
                  'streamId': 'string',
                  'streamArn': 'string',
                  'streamVersion': 123,
                  'description': 'string'
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **streams** *(list) --* 

        A list of streams.

        
        

        - *(dict) --* 

          A summary of a stream.

          
          

          - **streamId** *(string) --* 

            The stream ID.

            
          

          - **streamArn** *(string) --* 

            The stream ARN.

            
          

          - **streamVersion** *(integer) --* 

            The stream version.

            
          

          - **description** *(string) --* 

            A description of the stream.

            
      
    
      

      - **nextToken** *(string) --* 

        A token used to get the next set of results.

        
  
  **Exceptions**
  
  *   :py:class:`IoT.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`IoT.Client.exceptions.ThrottlingException`

  
  *   :py:class:`IoT.Client.exceptions.UnauthorizedException`

  
  *   :py:class:`IoT.Client.exceptions.ServiceUnavailableException`

  
  *   :py:class:`IoT.Client.exceptions.InternalFailureException`

  