1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListParticipants`](crate::operation::list_participants::builders::ListParticipantsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_participants::builders::ListParticipantsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`stage_arn(impl Into<String>)`](crate::operation::list_participants::builders::ListParticipantsFluentBuilder::stage_arn) / [`set_stage_arn(Option<String>)`](crate::operation::list_participants::builders::ListParticipantsFluentBuilder::set_stage_arn):<br>required: **true**<br><p>Stage ARN.</p><br>
    ///   - [`session_id(impl Into<String>)`](crate::operation::list_participants::builders::ListParticipantsFluentBuilder::session_id) / [`set_session_id(Option<String>)`](crate::operation::list_participants::builders::ListParticipantsFluentBuilder::set_session_id):<br>required: **true**<br><p>ID of the session within the stage.</p><br>
    ///   - [`filter_by_user_id(impl Into<String>)`](crate::operation::list_participants::builders::ListParticipantsFluentBuilder::filter_by_user_id) / [`set_filter_by_user_id(Option<String>)`](crate::operation::list_participants::builders::ListParticipantsFluentBuilder::set_filter_by_user_id):<br>required: **false**<br><p>Filters the response list to match the specified user ID. Only one of <code>filterByUserId</code>, <code>filterByPublished</code>, or <code>filterByState</code> can be provided per request. A <code>userId</code> is a customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems.</p><br>
    ///   - [`filter_by_published(bool)`](crate::operation::list_participants::builders::ListParticipantsFluentBuilder::filter_by_published) / [`set_filter_by_published(Option<bool>)`](crate::operation::list_participants::builders::ListParticipantsFluentBuilder::set_filter_by_published):<br>required: **false**<br><p>Filters the response list to only show participants who published during the stage session. Only one of <code>filterByUserId</code>, <code>filterByPublished</code>, or <code>filterByState</code> can be provided per request.</p><br>
    ///   - [`filter_by_state(ParticipantState)`](crate::operation::list_participants::builders::ListParticipantsFluentBuilder::filter_by_state) / [`set_filter_by_state(Option<ParticipantState>)`](crate::operation::list_participants::builders::ListParticipantsFluentBuilder::set_filter_by_state):<br>required: **false**<br><p>Filters the response list to only show participants in the specified state. Only one of <code>filterByUserId</code>, <code>filterByPublished</code>, or <code>filterByState</code> can be provided per request.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_participants::builders::ListParticipantsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_participants::builders::ListParticipantsFluentBuilder::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>
    ///   - [`max_results(i32)`](crate::operation::list_participants::builders::ListParticipantsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_participants::builders::ListParticipantsFluentBuilder::set_max_results):<br>required: **false**<br><p>Maximum number of results to return. Default: 50.</p><br>
    /// - On success, responds with [`ListParticipantsOutput`](crate::operation::list_participants::ListParticipantsOutput) with field(s):
    ///   - [`participants(Vec::<ParticipantSummary>)`](crate::operation::list_participants::ListParticipantsOutput::participants): <p>List of the matching participants (summary information only).</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_participants::ListParticipantsOutput::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>
    /// - On failure, responds with [`SdkError<ListParticipantsError>`](crate::operation::list_participants::ListParticipantsError)
    pub fn list_participants(&self) -> crate::operation::list_participants::builders::ListParticipantsFluentBuilder {
        crate::operation::list_participants::builders::ListParticipantsFluentBuilder::new(self.handle.clone())
    }
}