Table Of Contents

Feedback

User Guide

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

[ aws . cognito-identity ]

describe-identity-pool

Description

Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users.

You must use AWS Developer credentials to call this API.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-identity-pool
--identity-pool-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--identity-pool-id (string)

An identity pool ID in the format REGION:GUID.

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