Table Of Contents


User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . cognito-identity ]



Sets the roles for an identity pool. These roles are used when making calls to GetCredentialsForIdentity action.

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>
--roles <value>
[--role-mappings <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--identity-pool-id (string)

An identity pool ID in the format REGION:GUID.

--roles (map)

The map of roles associated with this pool. For a given role, the key will be either "authenticated" or "unauthenticated" and the value will be the Role ARN.

Shorthand Syntax:


JSON Syntax:

{"string": "string"

--role-mappings (map)

How users for a specific identity provider are to mapped to roles. This is a string to RoleMapping object map. The string identifies the identity provider, for example, "" or "".

Up to 25 rules can be specified per identity provider.

JSON Syntax:

{"string": {
      "Type": "Token"|"Rules",
      "AmbiguousRoleResolution": "AuthenticatedRole"|"Deny",
      "RulesConfiguration": {
        "Rules": [
            "Claim": "string",
            "MatchType": "Equals"|"Contains"|"StartsWith"|"NotEqual",
            "Value": "string",
            "RoleARN": "string"

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


To get identity pool roles

The following set-identity-pool-roles example sets an identity pool role.

aws cognito-identity set-identity-pool-roles \
    --identity-pool-id "us-west-2:11111111-1111-1111-1111-111111111111" \
    --roles authenticated="arn:aws:iam::111111111111:role/Cognito_MyIdentityPoolAuth_Role"