[ aws . cognito-identity ]

list-identities

Description

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.

Synopsis

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

Options

--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 | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

IdentityPoolId -> (string)

An identity pool ID in the format REGION:GUID.

Identities -> (list)

An object containing a set of identities and associated mappings.

(structure)

A description of the identity.

IdentityId -> (string)

A unique identifier in the format REGION:GUID.

Logins -> (list)

The provider names.

(string)

CreationDate -> (timestamp)

Date on which the identity was created.

LastModifiedDate -> (timestamp)

Date on which the identity was last modified.

NextToken -> (string)

A pagination token.