Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

DescribeIdentityPoolUsage

Note

Amazon Cognito Sync will no longer be open to new customers starting July 30, 2026. Existing Amazon Cognito Sync customers can continue using the service. For alternatives to Cognito Sync, please explore AWS AppSync and Amazon DynamoDB. Learn more.

Gets usage details (for example, data storage) about a particular identity pool.

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

Request Syntax


GET /identitypools/IdentityPoolId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

IdentityPoolId

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

Length Constraints: Minimum length of 1. Maximum length of 55.

Pattern: [\w-]+:[0-9a-f-]+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "IdentityPoolUsage": { 
      "DataStorage": number,
      "IdentityPoolId": "string",
      "LastModifiedDate": number,
      "SyncSessionsCount": number
   }
}

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.

IdentityPoolUsage

Information about the usage of the identity pool.

Type: IdentityPoolUsage object

Errors

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

InternalErrorException

Indicates an internal service error.

message: Message returned by InternalErrorException.

HTTP Status Code: 500

InvalidParameterException

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

message: Message returned by InvalidParameterException.

HTTP Status Code: 400

NotAuthorizedException

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

message: The message returned by a NotAuthorizedException.

HTTP Status Code: 403

ResourceNotFoundException

Thrown if the resource doesn't exist.

message: Message returned by a ResourceNotFoundException.

HTTP Status Code: 404

TooManyRequestsException

Thrown if the request is throttled.

message: Message returned by a TooManyRequestsException.

HTTP Status Code: 429

Examples

DescribeIdentityPoolUsage

The following examples have been edited for readability.

Sample Request



POST / HTTP/1.1
CONTENT-TYPE: application/json
X-AMZN-REQUESTID: 8dc0e749-c8cd-48bd-8520-da6be00d528b
X-AMZ-TARGET: com.amazonaws.cognito.sync.model.AWSCognitoSyncService.DescribeIdentityPoolUsage
HOST: cognito-sync.us-east-1.amazonaws.com:443
X-AMZ-DATE: 20141111T205737Z
AUTHORIZATION: AWS4-HMAC-SHA256 Credential=<credential>, SignedHeaders=content-type;host;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<signature>
 
{
    "IdentityPoolId": "IDENTITY_POOL_ID"
}

Sample Response



1.1 200 OK
x-amzn-requestid: 8dc0e749-c8cd-48bd-8520-da6be00d528b
content-type: application/json
content-length: 271
date: Tue, 11 Nov 2014 20:57:37 GMT
 
{
    "IdentityPoolUsage":
    {
        "DataStorage": 0,
        "IdentityPoolId": "IDENTITY_POOL_ID",
        "LastModifiedDate": 1.413231134115E9,
        "SyncSessionsCount": null
    }
}