Skip to content

List Datasets

cognitosync_list_datasets R Documentation

Lists datasets for an identity

Description

Lists datasets for an identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.

ListDatasets can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use the Cognito Identity credentials to make this API call.

Usage

cognitosync_list_datasets(IdentityPoolId, IdentityId, NextToken,
  MaxResults)

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.

NextToken

A pagination token for obtaining the next page of results.

MaxResults

The maximum number of results to be returned.

Value

A list with the following syntax:

list(
  Datasets = list(
    list(
      IdentityId = "string",
      DatasetName = "string",
      CreationDate = as.POSIXct(
        "2015-01-01"
      ),
      LastModifiedDate = as.POSIXct(
        "2015-01-01"
      ),
      LastModifiedBy = "string",
      DataStorage = 123,
      NumRecords = 123
    )
  ),
  Count = 123,
  NextToken = "string"
)

Request syntax

svc$list_datasets(
  IdentityPoolId = "string",
  IdentityId = "string",
  NextToken = "string",
  MaxResults = 123
)