aws_sdk_cognitoidentityprovider/client/

list_groups.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListGroups`](crate::operation::list_groups::builders::ListGroupsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_groups::builders::ListGroupsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`user_pool_id(impl Into<String>)`](crate::operation::list_groups::builders::ListGroupsFluentBuilder::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::operation::list_groups::builders::ListGroupsFluentBuilder::set_user_pool_id):<br>required: **true**<br><p>The ID of the user pool where you want to list user groups.</p><br>
    ///   - [`limit(i32)`](crate::operation::list_groups::builders::ListGroupsFluentBuilder::limit) / [`set_limit(Option<i32>)`](crate::operation::list_groups::builders::ListGroupsFluentBuilder::set_limit):<br>required: **false**<br><p>The maximum number of groups that you want Amazon Cognito to return in the response.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_groups::builders::ListGroupsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_groups::builders::ListGroupsFluentBuilder::set_next_token):<br>required: **false**<br><p>This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.</p><br>
    /// - On success, responds with [`ListGroupsOutput`](crate::operation::list_groups::ListGroupsOutput) with field(s):
    ///   - [`groups(Option<Vec::<GroupType>>)`](crate::operation::list_groups::ListGroupsOutput::groups): <p>An array of groups and their details. Each entry that's returned includes description, precedence, and IAM role values.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_groups::ListGroupsOutput::next_token): <p>The identifier that Amazon Cognito returned with the previous request to this operation. When you include a pagination token in your request, Amazon Cognito returns the next set of items in the list. By use of this token, you can paginate through the full list of items.</p>
    /// - On failure, responds with [`SdkError<ListGroupsError>`](crate::operation::list_groups::ListGroupsError)
    pub fn list_groups(&self) -> crate::operation::list_groups::builders::ListGroupsFluentBuilder {
        crate::operation::list_groups::builders::ListGroupsFluentBuilder::new(self.handle.clone())
    }
}