Struct aws_sdk_cognitoidentityprovider::operation::list_groups::builders::ListGroupsFluentBuilder

pub struct ListGroupsFluentBuilder { /* private fields */ }

Fluent builder constructing a request to ListGroups.

Lists the groups associated with a user pool.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

• Signing Amazon Web Services API Requests

• Using the Amazon Cognito user pools API and user pool endpoints

Implementations

impl ListGroupsFluentBuilder

pub fn as_input(&self) -> &ListGroupsInputBuilder

Access the ListGroups as a reference.

pub async fn send( self ) -> Result<ListGroupsOutput, SdkError<ListGroupsError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self ) -> CustomizableOperation<ListGroupsOutput, ListGroupsError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn into_paginator(self) -> ListGroupsPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a PaginationStream.

pub fn user_pool_id(self, input: impl Into<String>) -> Self

The user pool ID for the user pool.

pub fn set_user_pool_id(self, input: Option<String>) -> Self

The user pool ID for the user pool.

pub fn get_user_pool_id(&self) -> &Option<String>

The user pool ID for the user pool.

pub fn limit(self, input: i32) -> Self

The limit of the request to list groups.

pub fn set_limit(self, input: Option<i32>) -> Self

The limit of the request to list groups.

pub fn get_limit(&self) -> &Option<i32>

The limit of the request to list groups.

pub fn next_token(self, input: impl Into<String>) -> Self

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

pub fn set_next_token(self, input: Option<String>) -> Self

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

pub fn get_next_token(&self) -> &Option<String>

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Trait Implementations

impl Clone for ListGroupsFluentBuilder

fn clone(&self) -> ListGroupsFluentBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ListGroupsFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.