identity_pool_usages
Creates, updates, deletes, gets or lists an identity_pool_usages resource.
Overview
| Name | identity_pool_usages |
| Type | Resource |
| Id | aws.cognito_sync.identity_pool_usages |
Fields
The following fields are returned by SELECT queries:
- describe_identity_pool_usage
- list_identity_pool_usage
| Name | Datatype | Description |
|---|---|---|
data_storage | integer (int64) | Data storage information for the identity pool. |
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 pool was last modified. |
sync_sessions_count | integer (int64) | Number of sync sessions for the identity pool. |
| Name | Datatype | Description |
|---|---|---|
count | integer | Total number of identities for the identity pool. |
identity_pool_usages | array | Usage information for the identity pools. |
max_results | integer | The maximum number of results to be returned. |
next_token | string | A pagination token for obtaining the next page of results. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_identity_pool_usage | select | identity_pool_id, region | 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. | |
list_identity_pool_usage | select | region | nextToken, maxResults | 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. |
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_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) |
maxResults | integer | The maximum number of results to be returned. |
nextToken | string | A pagination token for obtaining the next page of results. |
SELECT examples
- describe_identity_pool_usage
- list_identity_pool_usage
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.
SELECT
data_storage,
identity_pool_id,
last_modified_date,
sync_sessions_count
FROM aws.cognito_sync.identity_pool_usages
WHERE identity_pool_id = '{{ identity_pool_id }}' -- required
AND region = '{{ region }}' -- required
;
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.
SELECT
count,
identity_pool_usages,
max_results,
next_token
FROM aws.cognito_sync.identity_pool_usages
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;