Table Of Contents

Feedback

User Guide

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

[ aws . cognito-identity ]

create-identity-pool

Description

Creates a new identity pool. The identity pool is a store of user identity information that is specific to your AWS account. The limit on identity pools is 60 per account. The keys for SupportedLoginProviders are as follows:

  • Facebook: graph.facebook.com
  • Google: accounts.google.com
  • Amazon: www.amazon.com
  • Twitter: api.twitter.com
  • Digits: www.digits.com

You must use AWS Developer credentials to call this API.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-identity-pool
--identity-pool-name <value>
--allow-unauthenticated-identities | --no-allow-unauthenticated-identities
[--supported-login-providers <value>]
[--developer-provider-name <value>]
[--open-id-connect-provider-arns <value>]
[--cognito-identity-providers <value>]
[--saml-provider-arns <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--identity-pool-name (string)

A string that you provide.

--allow-unauthenticated-identities | --no-allow-unauthenticated-identities (boolean)

TRUE if the identity pool supports unauthenticated logins.

--supported-login-providers (map)

Optional key:value pairs mapping provider names to provider app IDs.

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--developer-provider-name (string)

The "domain" by which Cognito will refer to your users. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the developer-provider-name , you can use letters as well as period (. ), underscore (_ ), and dash (- ).

Once you have set a developer provider name, you cannot change it. Please take care in setting this parameter.

--open-id-connect-provider-arns (list)

A list of OpendID Connect provider ARNs.

Syntax:

"string" "string" ...

--cognito-identity-providers (list)

An array of Amazon Cognito Identity user pools and their client IDs.

Shorthand Syntax:

ProviderName=string,ClientId=string,ServerSideTokenCheck=boolean ...

JSON Syntax:

[
  {
    "ProviderName": "string",
    "ClientId": "string",
    "ServerSideTokenCheck": true|false
  }
  ...
]

--saml-provider-arns (list)

An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.

Syntax:

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

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

Output

IdentityPoolId -> (string)

An identity pool ID in the format REGION:GUID.

IdentityPoolName -> (string)

A string that you provide.

AllowUnauthenticatedIdentities -> (boolean)

TRUE if the identity pool supports unauthenticated logins.

SupportedLoginProviders -> (map)

Optional key:value pairs mapping provider names to provider app IDs.

key -> (string)

value -> (string)

DeveloperProviderName -> (string)

The "domain" by which Cognito will refer to your users.

OpenIdConnectProviderARNs -> (list)

A list of OpendID Connect provider ARNs.

(string)

CognitoIdentityProviders -> (list)

A list representing an Amazon Cognito Identity User Pool and its client ID.

(structure)

A provider representing an Amazon Cognito Identity User Pool and its client ID.

ProviderName -> (string)

The provider name for an Amazon Cognito Identity User Pool. For example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789 .

ClientId -> (string)

The client ID for the Amazon Cognito Identity User Pool.

ServerSideTokenCheck -> (boolean)

TRUE if server-side token validation is enabled for the identity provider’s token.

SamlProviderARNs -> (list)

An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.

(string)