Skip to content

stop_participant_replication

stop_participant_replication(
    source_stage_arn: StageArn,
    destination_stage_arn: StageArn,
    participant_id: ParticipantId,
    *,
    config_overrides: Optional[IVSRealTimeClientConfig] = None,
) -> StopParticipantReplicationResponse

Stops a replicated participant session.

Parameters:

  • source_stage_arn (StageArn) –

    ARN of the stage where the participant is publishing.

  • destination_stage_arn (StageArn) –

    ARN of the stage where the participant has been replicated.

  • participant_id (ParticipantId) –

    Participant ID of the publisher that has been replicated. This is assigned by IVS and returned by CreateParticipantToken or the jti (JWT ID) used to create a self signed token.

Raises:

Source code in docs_src/capo_ivs_realtime/_services/ivs_real_time.py
def stop_participant_replication(
    self,
    source_stage_arn: "capo_ivs_realtime.types.stage_arn.StageArn",
    destination_stage_arn: "capo_ivs_realtime.types.stage_arn.StageArn",
    participant_id: "capo_ivs_realtime.types.participant_id.ParticipantId",
    *,
    config_overrides: Optional[IVSRealTimeClientConfig] = None,
) -> "capo_ivs_realtime.types.stop_participant_replication_response.StopParticipantReplicationResponse":
    """<p>Stops a replicated participant session.</p>

    Args:
        source_stage_arn: <p>ARN of the stage where the participant is publishing.</p>
        destination_stage_arn: <p>ARN of the stage where the participant has been replicated.</p>
        participant_id: <p>Participant ID of the publisher that has been replicated. This is assigned by IVS and returned by <a>CreateParticipantToken</a> or the <code>jti</code> (JWT ID) used to <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started-distribute-tokens.html#getting-started-distribute-tokens-self-signed"> create a self signed token</a>.</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.internal_server_exception.InternalServerException: <p>Unexpected error during processing of request.</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.stop_participant_replication_request.StopParticipantReplicationRequest]",
    ) -> OperationResponse[
        "capo_ivs_realtime.types.stop_participant_replication_response.StopParticipantReplicationResponse"
    ]:
        import capo_ivs_realtime._operations.amazon_interactive_video_service_real_time.stop_participant_replication

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StopParticipantReplication")
    )
    input_: capo_ivs_realtime.types.stop_participant_replication_request.StopParticipantReplicationRequest = {
        "source_stage_arn": source_stage_arn,
        "destination_stage_arn": destination_stage_arn,
        "participant_id": participant_id,
    }

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