Amazon Cognito Sync
API Reference (API Version 2014-06-30)


Gets a list of identity pools registered with Cognito.

ListIdentityPoolUsage can only be called with developer credentials. You cannot make this API call with the temporary user credentials provided by Cognito Identity.

Request Syntax

GET /identitypools?maxResults=MaxResults&nextToken=NextToken HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.


The maximum number of results to be returned.


A pagination token for obtaining the next page of results.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Count": number, "IdentityPoolUsages": [ { "DataStorage": number, "IdentityPoolId": "string", "LastModifiedDate": number, "SyncSessionsCount": number } ], "MaxResults": number, "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.


Total number of identities for the identity pool.

Type: Integer


Usage information for the identity pools.

Type: Array of IdentityPoolUsage objects


The maximum number of results to be returned.

Type: Integer


A pagination token for obtaining the next page of results.

Type: String


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


Indicates an internal service error.

HTTP Status Code: 500


Thrown when a request parameter does not comply with the associated constraints.

HTTP Status Code: 400


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

HTTP Status Code: 403


Thrown if the request is throttled.

HTTP Status Code: 429



The following examples have been edited for readability.

Sample Request

POST / HTTP/1.1 CONTENT-TYPE: application/json X-AMZN-REQUESTID: 9be7c425-ef05-48c0-aef3-9f0ff2fe17d3 X-AMZ-TARGET: com.amazonaws.cognito.sync.model.AWSCognitoSyncService.ListIdentityPoolUsage HOST: X-AMZ-DATE: 20141111T211414Z AUTHORIZATION: AWS4-HMAC-SHA256 Credential=<credential>, SignedHeaders=content-type;host;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<signature> { "MaxResults": "2" }

Sample Response

1.1 200 OK x-amzn-requestid: 9be7c425-ef05-48c0-aef3-9f0ff2fe17d3 content-type: application/json content-length: 519 date: Tue, 11 Nov 2014 21:14:14 GMT { "Count": 2, "IdentityPoolUsages": [ { "DataStorage": 0, "IdentityPoolId": "IDENTITY_POOL_ID", "LastModifiedDate": 1.413836234607E9, "SyncSessionsCount": null }, { "DataStorage": 0, "IdentityPoolId": "IDENTITY_POOL_ID", "LastModifiedDate": 1.410892165601E9, "SyncSessionsCount": null }], "MaxResults": 2, "NextToken": "dXMtZWFzdC0xOjBjMWJhMDUyLWUwOTgtNDFmYS1hNzZlLWVhYTJjMTI1Zjg2MQ==" }

See Also

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