aws_sdk_wickr/client/

list_blocked_guest_users.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListBlockedGuestUsers`](crate::operation::list_blocked_guest_users::builders::ListBlockedGuestUsersFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_blocked_guest_users::builders::ListBlockedGuestUsersFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`network_id(impl Into<String>)`](crate::operation::list_blocked_guest_users::builders::ListBlockedGuestUsersFluentBuilder::network_id) / [`set_network_id(Option<String>)`](crate::operation::list_blocked_guest_users::builders::ListBlockedGuestUsersFluentBuilder::set_network_id):<br>required: **true**<br><p>The ID of the Wickr network from which to list blocked guest users.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_blocked_guest_users::builders::ListBlockedGuestUsersFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_blocked_guest_users::builders::ListBlockedGuestUsersFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of blocked guest users to return in a single page. Valid range is 1-100. Default is 10.</p><br>
    ///   - [`sort_direction(SortDirection)`](crate::operation::list_blocked_guest_users::builders::ListBlockedGuestUsersFluentBuilder::sort_direction) / [`set_sort_direction(Option<SortDirection>)`](crate::operation::list_blocked_guest_users::builders::ListBlockedGuestUsersFluentBuilder::set_sort_direction):<br>required: **false**<br><p>The direction to sort results. Valid values are 'ASC' (ascending) or 'DESC' (descending). Default is 'DESC'.</p><br>
    ///   - [`sort_fields(impl Into<String>)`](crate::operation::list_blocked_guest_users::builders::ListBlockedGuestUsersFluentBuilder::sort_fields) / [`set_sort_fields(Option<String>)`](crate::operation::list_blocked_guest_users::builders::ListBlockedGuestUsersFluentBuilder::set_sort_fields):<br>required: **false**<br><p>The field to sort blocked guest users by. Accepted values include 'username', 'admin', and 'modified'.</p><br>
    ///   - [`username(impl Into<String>)`](crate::operation::list_blocked_guest_users::builders::ListBlockedGuestUsersFluentBuilder::username) / [`set_username(Option<String>)`](crate::operation::list_blocked_guest_users::builders::ListBlockedGuestUsersFluentBuilder::set_username):<br>required: **false**<br><p>Filter results to only include blocked guest users with usernames matching this value.</p><br>
    ///   - [`admin(impl Into<String>)`](crate::operation::list_blocked_guest_users::builders::ListBlockedGuestUsersFluentBuilder::admin) / [`set_admin(Option<String>)`](crate::operation::list_blocked_guest_users::builders::ListBlockedGuestUsersFluentBuilder::set_admin):<br>required: **false**<br><p>Filter results to only include blocked guest users that were blocked by this administrator.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_blocked_guest_users::builders::ListBlockedGuestUsersFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_blocked_guest_users::builders::ListBlockedGuestUsersFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for retrieving the next page of results. This is returned from a previous request when there are more results available.</p><br>
    /// - On success, responds with [`ListBlockedGuestUsersOutput`](crate::operation::list_blocked_guest_users::ListBlockedGuestUsersOutput) with field(s):
    ///   - [`next_token(Option<String>)`](crate::operation::list_blocked_guest_users::ListBlockedGuestUsersOutput::next_token): <p>The token to use for retrieving the next page of results. If this is not present, there are no more results.</p>
    ///   - [`blocklist(Vec::<BlockedGuestUser>)`](crate::operation::list_blocked_guest_users::ListBlockedGuestUsersOutput::blocklist): <p>A list of blocked guest user objects within the current page.</p>
    /// - On failure, responds with [`SdkError<ListBlockedGuestUsersError>`](crate::operation::list_blocked_guest_users::ListBlockedGuestUsersError)
    pub fn list_blocked_guest_users(&self) -> crate::operation::list_blocked_guest_users::builders::ListBlockedGuestUsersFluentBuilder {
        crate::operation::list_blocked_guest_users::builders::ListBlockedGuestUsersFluentBuilder::new(self.handle.clone())
    }
}