list_participant_replicas ¶

def list_participant_replicas(
    self,
    source_stage_arn: "capo_ivs_realtime.types.stage_arn.StageArn",
    participant_id: "capo_ivs_realtime.types.participant_id.ParticipantId",
    *,
    config_overrides: Optional[IVSRealTimeClientConfig] = None,
    next_token: Optional[
        "capo_ivs_realtime.types.pagination_token.PaginationToken"
    ] = None,
    max_results: Optional[
        "capo_ivs_realtime.types.max_participant_replica_results.MaxParticipantReplicaResults"
    ] = None,
) -> "capo_ivs_realtime.types.list_participant_replicas_response.ListParticipantReplicasResponse":
    """<p>Lists all the replicas for a participant from a source stage.</p>

    Args:
        source_stage_arn: <p>ARN of the stage where the participant is publishing.</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>
        next_token: <p>The first participant to retrieve. This is used for pagination; see the <code>nextToken</code> response field.</p>
        max_results: <p>Maximum number of results to return. Default: 50.</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.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.list_participant_replicas_request.ListParticipantReplicasRequest]",
    ) -> OperationResponse[
        "capo_ivs_realtime.types.list_participant_replicas_response.ListParticipantReplicasResponse"
    ]:
        import capo_ivs_realtime._operations.amazon_interactive_video_service_real_time.list_participant_replicas

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListParticipantReplicas")
    )
    input_: capo_ivs_realtime.types.list_participant_replicas_request.ListParticipantReplicasRequest = {
        "source_stage_arn": source_stage_arn,
        "participant_id": participant_id,
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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