Skip to content

Describe Identity Usage

cognitosync_describe_identity_usage R Documentation

Gets usage information for an identity, including number of datasets and data usage

Description

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.

Usage

cognitosync_describe_identity_usage(IdentityPoolId, IdentityId)

Arguments

IdentityPoolId

[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.

IdentityId

[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.

Value

A list with the following syntax:

list(
  IdentityUsage = list(
    IdentityId = "string",
    IdentityPoolId = "string",
    LastModifiedDate = as.POSIXct(
      "2015-01-01"
    ),
    DatasetCount = 123,
    DataStorage = 123
  )
)

Request syntax

svc$describe_identity_usage(
  IdentityPoolId = "string",
  IdentityId = "string"
)