DescribeIdentityPool
Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users.
Note
Amazon Cognito evaluates AWS Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Request Syntax
{
"IdentityPoolId": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- IdentityPoolId
-
An identity pool ID in the format REGION:GUID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 55.
Pattern:
[\w-]+:[0-9a-f-]+Required: Yes
Response Syntax
{
"AllowClassicFlow": boolean,
"AllowUnauthenticatedIdentities": boolean,
"CognitoIdentityProviders": [
{
"ClientId": "string",
"ProviderName": "string",
"ServerSideTokenCheck": boolean
}
],
"DeveloperProviderName": "string",
"IdentityPoolId": "string",
"IdentityPoolName": "string",
"IdentityPoolTags": {
"string" : "string"
},
"OpenIdConnectProviderARNs": [ "string" ],
"SamlProviderARNs": [ "string" ],
"SupportedLoginProviders": {
"string" : "string"
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- AllowClassicFlow
-
Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide.
Type: Boolean
- AllowUnauthenticatedIdentities
-
TRUE if the identity pool supports unauthenticated logins.
Type: Boolean
- CognitoIdentityProviders
-
A list representing an Amazon Cognito user pool and its client ID.
Type: Array of CognitoIdentityProvider objects
- DeveloperProviderName
-
The "domain" by which Cognito will refer to your users.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[\w._-]+ - IdentityPoolId
-
An identity pool ID in the format REGION:GUID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 55.
Pattern:
[\w-]+:[0-9a-f-]+ - IdentityPoolName
-
A string that you provide.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[\w\s+=,.@-]+ - IdentityPoolTags
-
The tags that are assigned to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
- OpenIdConnectProviderARNs
-
The ARNs of the OpenID Connect providers.
Type: Array of strings
Length Constraints: Minimum length of 20. Maximum length of 2048.
- SamlProviderARNs
-
An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
Type: Array of strings
Length Constraints: Minimum length of 20. Maximum length of 2048.
- SupportedLoginProviders
-
Optional key:value pairs mapping provider names to provider app IDs.
Type: String to string map
Map Entries: Maximum number of 10 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Minimum length of 1. Maximum length of 128.
Value Pattern:
[\w.;_/-]+
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalErrorException
-
Thrown when the service encounters an error during processing the request.
HTTP Status Code: 500
- InvalidParameterException
-
Thrown for missing or bad input parameter(s).
HTTP Status Code: 400
- NotAuthorizedException
-
Thrown when a user is not authorized to access the requested resource.
HTTP Status Code: 400
- ResourceNotFoundException
-
Thrown when the requested resource (for example, a dataset or record) does not exist.
HTTP Status Code: 400
- TooManyRequestsException
-
Thrown when a request is throttled.
HTTP Status Code: 400
Examples
DescribeIdentityPool
The following examples show a request and response for the
DescribeIdentityPool operation. The request and response bodies have
been edited for readability and may not match the stated content-length
values.
Sample Request
POST / HTTP/1.1
CONTENT-TYPE: application/json
CONTENT-LENGTH: 224
X-AMZ-TARGET: com.amazonaws.cognito.identity.model.AWSCognitoIdentityService.DescribeIdentityPool
HOST: <endpoint>
X-AMZ-DATE: 20140804T203833Z
AUTHORIZATION: AWS4-HMAC-SHA256 Credential=<credential>, SignedHeaders=content-type;content-length;host;x-amz-date;x-amz-target, Signature=<signature>
{
"IdentityPoolId": "us-east-1:177a950c-2c08-43f0-9983-28727EXAMPLE"
}
Sample Response
1.1 200 OK
x-amzn-requestid: c5cc0ad5-c604-455a-87ee-cb830b22341a
date: Mon, 04 Aug 2014 20:38:33 GMT
content-type: application/json
content-length: 367
{
"AllowUnauthenticatedIdentities": true,
"IdentityPoolId": "us-east-1:177a950c-2c08-43f0-9983-28727EXAMPLE",
"IdentityPoolName": "MyIdentityPool",
"SupportedLoginProviders":
{
"accounts.google.com": "123456789012.apps.googleusercontent.com",
"graph.facebook.com": "7346241598935555",
"www.amazon.com": "amzn1.application-oa2-client.188a56d827a7d6555a8b67a5d"
}
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
