CognitoSync / Client / describe_identity_pool_usage

describe_identity_pool_usage#

CognitoSync.Client.describe_identity_pool_usage(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_identity_pool_usage(
    IdentityPoolId='string'
)
Parameters:

IdentityPoolId (string) – [REQUIRED] 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.

Return type:

dict

Returns:

Response Syntax

{
    'IdentityPoolUsage': {
        'IdentityPoolId': 'string',
        'SyncSessionsCount': 123,
        'DataStorage': 123,
        'LastModifiedDate': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) – Response to a successful DescribeIdentityPoolUsage request.

    • IdentityPoolUsage (dict) – Information about the usage of the identity pool.

      • IdentityPoolId (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.

      • SyncSessionsCount (integer) – Number of sync sessions for the identity pool.

      • DataStorage (integer) – Data storage information for the identity pool.

      • LastModifiedDate (datetime) – Date on which the identity pool was last modified.

Exceptions