DescribeIdentityUsage
Gets usage information for an identity, including number of datasets and data usage.
This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.
Request Syntax
GET /identitypools/IdentityPoolId/identities/IdentityId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- IdentityId
-
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
- 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
{
"IdentityUsage": {
"DatasetCount": number,
"DataStorage": number,
"IdentityId": "string",
"IdentityPoolId": "string",
"LastModifiedDate": 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.
- IdentityUsage
-
Usage information for the identity.
Type: IdentityUsage object
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalErrorException
-
Indicates an internal service error.
HTTP Status Code: 500
- InvalidParameterException
-
Thrown when a request parameter does not comply with the associated constraints.
HTTP Status Code: 400
- NotAuthorizedException
-
Thrown when a user is not authorized to access the requested resource.
HTTP Status Code: 403
- ResourceNotFoundException
-
Thrown if the resource doesn't exist.
HTTP Status Code: 404
- TooManyRequestsException
-
Thrown if the request is throttled.
HTTP Status Code: 429
Examples
DescribeIdentityUsage
The following examples have been edited for readability.
Sample Request
POST / HTTP/1.1
CONTENT-TYPE: application/json
X-AMZN-REQUESTID: 33f9b4e4-a177-4aad-a3bb-6edb7980b283
X-AMZ-TARGET: com.amazonaws.cognito.sync.model.AWSCognitoSyncService.DescribeIdentityUsage
HOST: cognito-sync.us-east-1.amazonaws.com:443
X-AMZ-DATE: 20141111T215129Z
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",
"IdentityId": "IDENTITY_ID"
}
Sample Response
1.1 200 OK
x-amzn-requestid: 33f9b4e4-a177-4aad-a3bb-6edb7980b283
content-type: application/json
content-length: 318
date: Tue, 11 Nov 2014 21:51:29 GMT
{
"IdentityUsage":
{
"DataStorage": 16,
"DatasetCount": 1,
"IdentityId": "IDENTITY_ID",
"IdentityPoolId": "IDENTITY_POOL_ID",
"LastModifiedDate": 1.412974081336E9
}
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
