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

********************
list_stream_sessions
********************



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

  

  Gets a summary of current and previous streams for a specified channel in your account, in the AWS region where the API request is processed.

  

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


  **Request Syntax**
  ::

    response = client.list_stream_sessions(
        channelArn='string',
        maxResults=123,
        nextToken='string'
    )
    
  :type channelArn: string
  :param channelArn: **[REQUIRED]** 

    Channel ARN used to filter the list.

    

  
  :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',
          'streamSessions': [
              {
                  'endTime': datetime(2015, 1, 1),
                  'hasErrorEvent': True|False,
                  'startTime': datetime(2015, 1, 1),
                  'streamId': 'string'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

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

        
      

      - **streamSessions** *(list) --* 

        List of stream sessions.

        
        

        - *(dict) --* 

          Summary information about a stream session.

          
          

          - **endTime** *(datetime) --* 

            Time when the channel went offline. This is an ISO 8601 timestamp; *note that this is returned as a string*. For live streams, this is ``NULL``.

            
          

          - **hasErrorEvent** *(boolean) --* 

            If ``true``, this stream encountered a quota breach or failure.

            
          

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

            Time when the channel went live. This is an ISO 8601 timestamp; *note that this is returned as a string*.

            
          

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

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

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

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

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

  