ivsrealtime / Client / get_stage_session

get_stage_session#

ivsrealtime.Client.get_stage_session(**kwargs)#

Gets information for the specified stage session.

See also: AWS API Documentation

Request Syntax

response = client.get_stage_session(
    stageArn='string',
    sessionId='string'
)
Parameters:

  • stageArn (string) –

    [REQUIRED]

    ARN of the stage for which the information is to be retrieved.

  • sessionId (string) –

    [REQUIRED]

    ID of a session within the stage.

Return type:

dict

Returns:

Response Syntax

{
    'stageSession': {
        'sessionId': 'string',
        'startTime': datetime(2015, 1, 1),
        'endTime': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • stageSession (dict) –

      The stage session that is returned.

      • 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.

Exceptions