NAME

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

DESCRIPTION

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

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

As an example:

$service_obj->ListUsers(Att1 => $value1, Att2 => $value2, ...);

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.

ATTRIBUTES

AttributesToGet => ArrayRef[Str]

The attributes to get from the request to list users.

Limit => Int

The limit of the request to list users.

PaginationToken => 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 which you want to list users.

UserStatus => Str

The user status. Can be one of the following:

  • UNCONFIRMED - User has been created but not confirmed.

  • CONFIRMED - User has been confirmed.

  • ARCHIVED - User is no longer active.

  • COMPROMISED - User is disabled due to a potential security threat.

  • UNKNOWN - User status is not known.

Valid values are: "UNCONFIRMED", "CONFIRMED", "ARCHIVED", "COMPROMISED", "UNKNOWN"

SEE ALSO

This class forms part of Paws, documenting arguments for method ListUsers 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