NAME

Paws::CognitoIdentity::ListIdentities - Arguments for method ListIdentities on Paws::CognitoIdentity

DESCRIPTION

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

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

SYNOPSIS

    my $cognito-identity = Paws->service('CognitoIdentity');
    my $ListIdentitiesResponse = $cognito -identity->ListIdentities(
      IdentityPoolId => 'MyIdentityPoolId',
      MaxResults     => 1,
      HideDisabled   => 1,                    # OPTIONAL
      NextToken      => 'MyPaginationKey',    # OPTIONAL
    );

    # Results:
    my $Identities     = $ListIdentitiesResponse->Identities;
    my $IdentityPoolId = $ListIdentitiesResponse->IdentityPoolId;
    my $NextToken      = $ListIdentitiesResponse->NextToken;

    # Returns a L<Paws::CognitoIdentity::ListIdentitiesResponse> 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-identity/ListIdentities

ATTRIBUTES

HideDisabled => Bool

An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response.

REQUIRED IdentityPoolId => Str

An identity pool ID in the format REGION:GUID.

REQUIRED MaxResults => Int

The maximum number of identities to return.

NextToken => Str

A pagination token.

SEE ALSO

This class forms part of Paws, documenting arguments for method ListIdentities in Paws::CognitoIdentity

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