:doc:`IVS <../../ivs>` / Client / list_streams

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



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

  

  Gets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreams>`_  


  **Request Syntax**
  ::

    response = client.list_streams(
        filterBy={
            'health': 'HEALTHY'|'STARVING'|'UNKNOWN'
        },
        maxResults=123,
        nextToken='string'
    )
    
  :type filterBy: dict
  :param filterBy: 

    Filters the stream list to match the specified criterion.

    

  
    - **health** *(string) --* 

      The stream’s health.

      

    
  
  :type maxResults: integer
  :param maxResults: 

    Maximum number of streams to return. Default: 100.

    

  
  :type nextToken: string
  :param nextToken: 

    The first stream to retrieve. This is used for pagination; see the ``nextToken`` response field.

    

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

    
    ::

      {
          'nextToken': 'string',
          'streams': [
              {
                  'channelArn': 'string',
                  'health': 'HEALTHY'|'STARVING'|'UNKNOWN',
                  'startTime': datetime(2015, 1, 1),
                  'state': 'LIVE'|'OFFLINE',
                  'streamId': 'string',
                  'viewerCount': 123
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        If there are more streams than ``maxResults``, use ``nextToken`` in the request to get the next set.

        
      

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

        List of streams.

        
        

        - *(dict) --* 

          Summary information about a stream.

          
          

          - **channelArn** *(string) --* 

            Channel ARN for the stream.

            
          

          - **health** *(string) --* 

            The stream’s health.

            
          

          - **startTime** *(datetime) --* 

            Time of the stream’s start. This is an ISO 8601 timestamp; *note that this is returned as a string*.

            
          

          - **state** *(string) --* 

            The stream’s state. Do not rely on the ``OFFLINE`` state, as the API may not return it; instead, a "NotBroadcasting" error will indicate that the stream is not live.

            
          

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

            Unique identifier for a live or previously live stream in the specified channel.

            
          

          - **viewerCount** *(integer) --* 

            A count of concurrent views of the stream. Typically, a new view appears in ``viewerCount`` within 15 seconds of when video playback starts and a view is removed from ``viewerCount`` within 1 minute of when video playback ends. A value of -1 indicates that the request timed out; in this case, retry.

            
      
    
  
  **Exceptions**
  
  *   :py:class:`IVS.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`IVS.Client.exceptions.ValidationException`

  