aws_sdk_ivsrealtime/client/
list_participant_replicas.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`ListParticipantReplicas`](crate::operation::list_participant_replicas::builders::ListParticipantReplicasFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_participant_replicas::builders::ListParticipantReplicasFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`source_stage_arn(impl Into<String>)`](crate::operation::list_participant_replicas::builders::ListParticipantReplicasFluentBuilder::source_stage_arn) / [`set_source_stage_arn(Option<String>)`](crate::operation::list_participant_replicas::builders::ListParticipantReplicasFluentBuilder::set_source_stage_arn):<br>required: **true**<br><p>ARN of the stage where the participant is publishing.</p><br>
8    ///   - [`participant_id(impl Into<String>)`](crate::operation::list_participant_replicas::builders::ListParticipantReplicasFluentBuilder::participant_id) / [`set_participant_id(Option<String>)`](crate::operation::list_participant_replicas::builders::ListParticipantReplicasFluentBuilder::set_participant_id):<br>required: **true**<br><p>Participant ID of the publisher that has been replicated. This is assigned by IVS and returned by <code>CreateParticipantToken</code> 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><br>
9    ///   - [`next_token(impl Into<String>)`](crate::operation::list_participant_replicas::builders::ListParticipantReplicasFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_participant_replicas::builders::ListParticipantReplicasFluentBuilder::set_next_token):<br>required: **false**<br><p>The first participant to retrieve. This is used for pagination; see the <code>nextToken</code> response field.</p><br>
10    ///   - [`max_results(i32)`](crate::operation::list_participant_replicas::builders::ListParticipantReplicasFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_participant_replicas::builders::ListParticipantReplicasFluentBuilder::set_max_results):<br>required: **false**<br><p>Maximum number of results to return. Default: 50.</p><br>
11    /// - On success, responds with [`ListParticipantReplicasOutput`](crate::operation::list_participant_replicas::ListParticipantReplicasOutput) with field(s):
12    ///   - [`replicas(Vec::<ParticipantReplica>)`](crate::operation::list_participant_replicas::ListParticipantReplicasOutput::replicas): <p>List of all participant replicas.</p>
13    ///   - [`next_token(Option<String>)`](crate::operation::list_participant_replicas::ListParticipantReplicasOutput::next_token): <p>If there are more participants than <code>maxResults</code>, use <code>nextToken</code> in the request to get the next set.</p>
14    /// - On failure, responds with [`SdkError<ListParticipantReplicasError>`](crate::operation::list_participant_replicas::ListParticipantReplicasError)
15    pub fn list_participant_replicas(&self) -> crate::operation::list_participant_replicas::builders::ListParticipantReplicasFluentBuilder {
16        crate::operation::list_participant_replicas::builders::ListParticipantReplicasFluentBuilder::new(self.handle.clone())
17    }
18}
aws_sdk_ivsrealtime/client/list_participant_replicas.rs

aws_sdk_ivsrealtime/client/
list_participant_replicas.rs
