ListIdentityPools - Amazon Cognito Federated Identities


Lists all of the Cognito identity pools registered for your account.

You must use AWS developer credentials to call this operation.

Request Syntax

{ "MaxResults": number, "NextToken": "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.


The maximum number of identities to return.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 60.

Required: Yes


A pagination token.

Type: String

Length Constraints: Minimum length of 1.

Pattern: [\S]+

Required: No

Response Syntax

{ "IdentityPools": [ { "IdentityPoolId": "string", "IdentityPoolName": "string" } ], "NextToken": "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.


The identity pools returned by the ListIdentityPools action.

Type: Array of IdentityPoolShortDescription objects


A pagination token.

Type: String

Length Constraints: Minimum length of 1.

Pattern: [\S]+


For information about the errors that are common to all actions, see Common Errors.


Thrown when the service encounters an error during processing the request.

HTTP Status Code: 500


Thrown for missing or bad input parameter(s).

HTTP Status Code: 400


Thrown when a user is not authorized to access the requested resource.

HTTP Status Code: 400


Thrown when the requested resource (for example, a dataset or record) does not exist.

HTTP Status Code: 400


Thrown when a request is throttled.

HTTP Status Code: 400



The following examples show a request and a response for a ListIdentityPools 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: 171 X-AMZ-TARGET: com.amazonaws.cognito.identity.model.AWSCognitoIdentityService.ListIdentityPools HOST: <endpoint> X-AMZ-DATE: 20140804T193802Z AUTHORIZATION: AWS4-HMAC-SHA256 Credential=<credential>, SignedHeaders=content-type;content-length;host;x-amz-date;x-amz-target, Signature=<signature> { "MaxResults": 3 }

Sample Response

1.1 200 OK x-amzn-requestid: 84423a7a-4db8-437f-9dfa-f60aacc0f85f date: Mon, 04 Aug 2014 19:38:03 GMT content-type: application/json content-length: 521 { "IdentityPools": [ { "IdentityPoolId": "us-east-1:0248e249-21e7-495a-9dd5-b2444EXAMPLE", "IdentityPoolName": "MyIdentityPool1" }, { "IdentityPoolId": "us-east-1:04507bc2-9e14-4d1b-8cbf-b6f51EXAMPLE", "IdentityPoolName": "MyIdentityPool2" }, { "IdentityPoolId": "us-east-1:177a950c-2c08-43f0-9983-28727EXAMPLE", "IdentityPoolName": "MyIdentityPool3"li }], "NextToken": "dXMtZWFzdC0xOjE3N2E5NTBjLTJjMDgtNDNmMC05OTgzLTI4NzI3YjQ0N2Y4MA==" }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: