aws_sdk_wickr/client/list_security_group_users.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 [`ListSecurityGroupUsers`](crate::operation::list_security_group_users::builders::ListSecurityGroupUsersFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_security_group_users::builders::ListSecurityGroupUsersFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`network_id(impl Into<String>)`](crate::operation::list_security_group_users::builders::ListSecurityGroupUsersFluentBuilder::network_id) / [`set_network_id(Option<String>)`](crate::operation::list_security_group_users::builders::ListSecurityGroupUsersFluentBuilder::set_network_id):<br>required: **true**<br><p>The ID of the Wickr network containing the security group.</p><br>
8 /// - [`group_id(impl Into<String>)`](crate::operation::list_security_group_users::builders::ListSecurityGroupUsersFluentBuilder::group_id) / [`set_group_id(Option<String>)`](crate::operation::list_security_group_users::builders::ListSecurityGroupUsersFluentBuilder::set_group_id):<br>required: **true**<br><p>The unique identifier of the security group whose users will be listed.</p><br>
9 /// - [`next_token(impl Into<String>)`](crate::operation::list_security_group_users::builders::ListSecurityGroupUsersFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_security_group_users::builders::ListSecurityGroupUsersFluentBuilder::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>
10 /// - [`max_results(i32)`](crate::operation::list_security_group_users::builders::ListSecurityGroupUsersFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_security_group_users::builders::ListSecurityGroupUsersFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of users to return in a single page. Valid range is 1-100. Default is 10.</p><br>
11 /// - [`sort_fields(impl Into<String>)`](crate::operation::list_security_group_users::builders::ListSecurityGroupUsersFluentBuilder::sort_fields) / [`set_sort_fields(Option<String>)`](crate::operation::list_security_group_users::builders::ListSecurityGroupUsersFluentBuilder::set_sort_fields):<br>required: **false**<br><p>The field to sort users by. Multiple fields can be specified by separating them with '+'. Accepted values include 'username', 'firstName', and 'lastName'.</p><br>
12 /// - [`sort_direction(SortDirection)`](crate::operation::list_security_group_users::builders::ListSecurityGroupUsersFluentBuilder::sort_direction) / [`set_sort_direction(Option<SortDirection>)`](crate::operation::list_security_group_users::builders::ListSecurityGroupUsersFluentBuilder::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>
13 /// - On success, responds with [`ListSecurityGroupUsersOutput`](crate::operation::list_security_group_users::ListSecurityGroupUsersOutput) with field(s):
14 /// - [`users(Vec::<User>)`](crate::operation::list_security_group_users::ListSecurityGroupUsersOutput::users): <p>A list of user objects belonging to the security group within the current page.</p>
15 /// - [`next_token(Option<String>)`](crate::operation::list_security_group_users::ListSecurityGroupUsersOutput::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>
16 /// - On failure, responds with [`SdkError<ListSecurityGroupUsersError>`](crate::operation::list_security_group_users::ListSecurityGroupUsersError)
17 pub fn list_security_group_users(&self) -> crate::operation::list_security_group_users::builders::ListSecurityGroupUsersFluentBuilder {
18 crate::operation::list_security_group_users::builders::ListSecurityGroupUsersFluentBuilder::new(self.handle.clone())
19 }
20}