ivsrealtime / Client / list_stage_sessions

list_stage_sessions#

ivsrealtime.Client.list_stage_sessions(**kwargs)#

Gets all sessions for a specified stage.

See also: AWS API Documentation

Request Syntax

response = client.list_stage_sessions(
    stageArn='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • stageArn (string) –

    [REQUIRED]

    Stage ARN.

  • nextToken (string) – The first stage session to retrieve. This is used for pagination; see the nextToken response field.

  • maxResults (integer) – Maximum number of results to return. Default: 50.

Return type:

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

  • ivsrealtime.Client.exceptions.ValidationException

  • ivsrealtime.Client.exceptions.AccessDeniedException