CognitoSync / Client / list_identity_pool_usage

list_identity_pool_usage#

CognitoSync.Client.list_identity_pool_usage(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.list_identity_pool_usage(
    NextToken='string',
    MaxResults=123
)
Parameters:

  • NextToken (string) – A pagination token for obtaining the next page of results.

  • MaxResults (integer) – The maximum number of results to be returned.

Return type:

dict

Returns:

Response Syntax

{
    'IdentityPoolUsages': [
        {
            'IdentityPoolId': 'string',
            'SyncSessionsCount': 123,
            'DataStorage': 123,
            'LastModifiedDate': datetime(2015, 1, 1)
        },
    ],
    'MaxResults': 123,
    'Count': 123,
    'NextToken': 'string'
}

Response Structure

  • (dict) – Returned for a successful ListIdentityPoolUsage request.

    • IdentityPoolUsages (list) – Usage information for the identity pools.

      • (dict) – Usage information for 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.

    • MaxResults (integer) – The maximum number of results to be returned.

    • Count (integer) – Total number of identities for the identity pool.

    • NextToken (string) – A pagination token for obtaining the next page of results.

Exceptions