aws_sdk_workmail/client/
list_group_members.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListGroupMembers`](crate::operation::list_group_members::builders::ListGroupMembersFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_group_members::builders::ListGroupMembersFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`organization_id(impl Into<String>)`](crate::operation::list_group_members::builders::ListGroupMembersFluentBuilder::organization_id) / [`set_organization_id(Option<String>)`](crate::operation::list_group_members::builders::ListGroupMembersFluentBuilder::set_organization_id):<br>required: **true**<br><p>The identifier for the organization under which the group exists.</p><br>
    ///   - [`group_id(impl Into<String>)`](crate::operation::list_group_members::builders::ListGroupMembersFluentBuilder::group_id) / [`set_group_id(Option<String>)`](crate::operation::list_group_members::builders::ListGroupMembersFluentBuilder::set_group_id):<br>required: **true**<br><p>The identifier for the group to which the members (users or groups) are associated.</p> <p>The identifier can accept <i>GroupId</i>, <i>Groupname</i>, or <i>email</i>. The following identity formats are available:</p> <ul>  <li>   <p>Group ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234</p></li>  <li>   <p>Email address: group@domain.tld</p></li>  <li>   <p>Group name: group</p></li> </ul><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_group_members::builders::ListGroupMembersFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_group_members::builders::ListGroupMembersFluentBuilder::set_next_token):<br>required: **false**<br><p>The token to use to retrieve the next page of results. The first call does not contain any tokens.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_group_members::builders::ListGroupMembersFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_group_members::builders::ListGroupMembersFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return in a single call.</p><br>
    /// - On success, responds with [`ListGroupMembersOutput`](crate::operation::list_group_members::ListGroupMembersOutput) with field(s):
    ///   - [`members(Option<Vec::<Member>>)`](crate::operation::list_group_members::ListGroupMembersOutput::members): <p>The members associated to the group.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_group_members::ListGroupMembersOutput::next_token): <p>The token to use to retrieve the next page of results. The first call does not contain any tokens.</p>
    /// - On failure, responds with [`SdkError<ListGroupMembersError>`](crate::operation::list_group_members::ListGroupMembersError)
    pub fn list_group_members(&self) -> crate::operation::list_group_members::builders::ListGroupMembersFluentBuilder {
        crate::operation::list_group_members::builders::ListGroupMembersFluentBuilder::new(self.handle.clone())
    }
}