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.

SYNOPSIS

    my $cognito-idp = Paws->service('CognitoIdp');
    my $ListUsersResponse = $cognito -idp->ListUsers(
      UserPoolId      => 'MyUserPoolIdType',
      AttributesToGet => [
        'MyAttributeNameType', ...    # min: 1, max: 32
      ],    # OPTIONAL
      Filter          => 'MyUserFilterType',               # OPTIONAL
      Limit           => 1,                                # OPTIONAL
      PaginationToken => 'MySearchPaginationTokenType',    # OPTIONAL
    );

    # Results:
    my $PaginationToken = $ListUsersResponse->PaginationToken;
    my $Users           = $ListUsersResponse->Users;

    # Returns a L<Paws::CognitoIdp::ListUsersResponse> 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/ListUsers

ATTRIBUTES

AttributesToGet => ArrayRef[Str|Undef]

An array of strings, where each string is the name of a user attribute to be returned for each user in the search results. If the array is null, all attributes are returned.

Filter => Str

A filter string of the form "AttributeName Filter-Type "AttributeValue"". Quotation marks within the filter string must be escaped using the backslash (\) character. For example, "family_name = \"Reddy\"".

• AttributeName: The name of the attribute to search for. You can only search for one attribute at a time.

• Filter-Type: For an exact match, use =, for example, "given_name = \"Jon\"". For a prefix ("starts with") match, use ^=, for example, "given_name ^= \"Jon\"".

• AttributeValue: The attribute value that must be matched for each user.

If the filter string is empty, ListUsers returns all users in the user pool.

You can only search for the following standard attributes:

• username (case-sensitive)

• email

• phone_number

• name

• given_name

• family_name

• preferred_username

• cognito:user_status (called Status in the Console) (case-insensitive)

• status (called Enabled in the Console) (case-sensitive)

• sub

Custom attributes are not searchable.

For more information, see Searching for Users Using the ListUsers API (https://docs.aws.amazon.com/cognito/latest/developerguide/how-to-manage-user-accounts.html#cognito-user-pools-searching-for-users-using-listusers-api) and Examples of Using the ListUsers API (https://docs.aws.amazon.com/cognito/latest/developerguide/how-to-manage-user-accounts.html#cognito-user-pools-searching-for-users-listusers-api-examples) in the Amazon Cognito Developer Guide.

Limit => Int

Maximum number of users to be returned.

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 the user pool on which the search should be performed.

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