Skip to content

get_stage_session

get_stage_session(
    stage_arn: StageArn,
    session_id: StageSessionId,
    *,
    config_overrides: Optional[IVSRealTimeClientConfig] = None,
) -> GetStageSessionResponse

Gets information for the specified stage session.

Parameters:

  • stage_arn (StageArn) –

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

  • session_id (StageSessionId) –

    ID of a session within the stage.

Raises:

Source code in docs_src/capo_ivs_realtime/_services/ivs_real_time.py
def get_stage_session(
    self,
    stage_arn: "capo_ivs_realtime.types.stage_arn.StageArn",
    session_id: "capo_ivs_realtime.types.stage_session_id.StageSessionId",
    *,
    config_overrides: Optional[IVSRealTimeClientConfig] = None,
) -> "capo_ivs_realtime.types.get_stage_session_response.GetStageSessionResponse":
    """<p>Gets information for the specified stage session.</p>

    Args:
        stage_arn: <p>ARN of the stage for which the information is to be retrieved.</p>
        session_id: <p>ID of a session within the stage.</p>

    Raises:
        capo_ivs_realtime.errors.access_denied_exception.AccessDeniedException: <p>User does not have sufficient access to perform this action.</p>
        capo_ivs_realtime.errors.resource_not_found_exception.ResourceNotFoundException: <p>Request references a resource which does not exist.</p>
        capo_ivs_realtime.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_ivs_realtime.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ivs_realtime.types.get_stage_session_request.GetStageSessionRequest]",
    ) -> OperationResponse[
        "capo_ivs_realtime.types.get_stage_session_response.GetStageSessionResponse"
    ]:
        import capo_ivs_realtime._operations.amazon_interactive_video_service_real_time.get_stage_session

        output, http_response = (
            capo_ivs_realtime._operations.amazon_interactive_video_service_real_time.get_stage_session.get_stage_session(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetStageSession")
    )
    input_: capo_ivs_realtime.types.get_stage_session_request.GetStageSessionRequest = {
        "stage_arn": stage_arn,
        "session_id": session_id,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output