NAME

Paws::CognitoIdp::ListGroups - Arguments for method ListGroups on Paws::CognitoIdp

DESCRIPTION

This class represents the parameters used for calling the method ListGroups on the Amazon Cognito Identity Provider service. Use the attributes of this class as arguments to method ListGroups.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListGroups.

SYNOPSIS

my $cognito-idp = Paws->service('CognitoIdp');
my $ListGroupsResponse = $cognito -idp->ListGroups(
  UserPoolId => 'MyUserPoolIdType',
  Limit      => 1,                    # OPTIONAL
  NextToken  => 'MyPaginationKey',    # OPTIONAL
);

# Results:
my $Groups    = $ListGroupsResponse->Groups;
my $NextToken = $ListGroupsResponse->NextToken;

# Returns a L<Paws::CognitoIdp::ListGroupsResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp/ListGroups

ATTRIBUTES

Limit => Int

The limit of the request to list groups.

NextToken => Str

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.

REQUIRED UserPoolId => Str

The user pool ID for the user pool.

SEE ALSO

This class forms part of Paws, documenting arguments for method ListGroups in Paws::CognitoIdp

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues