[ aws . cognito-identity ]



Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicit linked account.

This is a public API. You do not need any credentials to call this API.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.


[--account-id <value>]
--identity-pool-id <value>
[--logins <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]


--account-id (string)

A standard AWS account ID (9+ digits).

--identity-pool-id (string)

An identity pool ID in the format REGION:GUID.

--logins (map)

A set of optional name-value pairs that map provider names to provider tokens. The available provider names for Logins are as follows:

  • Facebook: graph.facebook.com

  • Amazon Cognito user pool: cognito-idp.<region>.amazonaws.com/<YOUR_USER_POOL_ID> , for example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789 .

  • Google: accounts.google.com

  • Amazon: www.amazon.com

  • Twitter: api.twitter.com

  • Digits: www.digits.com

key -> (string)

value -> (string)

Shorthand Syntax:


JSON Syntax:

{"string": "string"

--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.

See ‘aws help’ for descriptions of global parameters.


IdentityId -> (string)

A unique identifier in the format REGION:GUID.