Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . cognito-identity ]



Lists the identities in an identity pool.

You must use AWS Developer credentials to call this API.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--identity-pool-id <value>
--max-results <value>
[--next-token <value>]
[--hide-disabled | --no-hide-disabled]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--identity-pool-id (string)

An identity pool ID in the format REGION:GUID.

--max-results (integer)

The maximum number of identities to return.

--next-token (string)

A pagination token.

--hide-disabled | --no-hide-disabled (boolean)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.


IdentityPoolId -> (string)

An identity pool ID in the format REGION:GUID.

Identities -> (list)

An object containing a set of identities and associated mappings.


A description of the identity.

IdentityId -> (string)

A unique identifier in the format REGION:GUID.

Logins -> (list)

The provider names.


CreationDate -> (timestamp)

Date on which the identity was created.

LastModifiedDate -> (timestamp)

Date on which the identity was last modified.

NextToken -> (string)

A pagination token.