[ aws . cognito-sync ]

list-identity-pool-usage

Description

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

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-identity-pool-usage
[--next-token <value>]
[--max-results <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--next-token (string) A pagination token for obtaining the next page of results.

--max-results (integer) The maximum number of results to be returned.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

IdentityPoolUsages -> (list)

Usage information for the identity pools.

(structure)

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 -> (long)

Number of sync sessions for the identity pool.

DataStorage -> (long)

Data storage information for the identity pool.

LastModifiedDate -> (timestamp)

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.