:doc:`ivsrealtime <../../ivs-realtime>` / Client / list_stage_sessions

*******************
list_stage_sessions
*******************



.. py:method:: ivsrealtime.Client.list_stage_sessions(**kwargs)

  

  Gets all sessions for a specified stage.

  

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


  **Request Syntax**
  ::

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

    Stage ARN.

    

  
  :type nextToken: string
  :param nextToken: 

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

    

  
  :type maxResults: integer
  :param maxResults: 

    Maximum number of results to return. Default: 50.

    

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

    
    ::

      {
          'stageSessions': [
              {
                  'sessionId': 'string',
                  'startTime': datetime(2015, 1, 1),
                  'endTime': datetime(2015, 1, 1)
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **stageSessions** *(list) --* 

        List of matching stage sessions.

        
        

        - *(dict) --* 

          Summary information about a stage session.

          
          

          - **sessionId** *(string) --* 

            ID of the session within the stage.

            
          

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

            ISO 8601 timestamp (returned as a string) when this stage session began.

            
          

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

            ISO 8601 timestamp (returned as a string) when the stage session ended. This is null if the stage is active.

            
      
    
      

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

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

        
  
  **Exceptions**
  
  *   :py:class:`ivsrealtime.Client.exceptions.ValidationException`

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

  