identity_usages
Creates, updates, deletes, gets or lists an identity_usages resource.
Overview
| Name | identity_usages |
| Type | Resource |
| Id | aws.cognito_sync.identity_usages |
Fields
The following fields are returned by SELECT queries:
- describe_identity_usage
| Name | Datatype | Description |
|---|---|---|
data_storage | integer (int64) | Total data storage for this identity. |
dataset_count | integer | Number of datasets for the identity. |
identity_id | string | 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. (pattern: <code>[\w-]+:[0-9a-f-]+</code>) |
identity_pool_id | string | 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. (pattern: <code>[\w-]+:[0-9a-f-]+</code>) |
last_modified_date | string (date-time) | Date on which the identity was last modified. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_identity_usage | select | identity_pool_id, identity_id, region | 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. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
identity_id | string | 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. |
identity_pool_id | string | 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. |
region | string | AWS region (default: us-east-1) |
SELECT examples
- describe_identity_usage
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.
SELECT
data_storage,
dataset_count,
identity_id,
identity_pool_id,
last_modified_date
FROM aws.cognito_sync.identity_usages
WHERE identity_pool_id = '{{ identity_pool_id }}' -- required
AND identity_id = '{{ identity_id }}' -- required
AND region = '{{ region }}' -- required
;