List Records

cognitosync_list_records

R Documentation

Gets paginated records, optionally changed after a particular sync count for a dataset and identity

Description

Gets paginated records, optionally changed after a particular sync count for a dataset and 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.

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

Usage

cognitosync_list_records(IdentityPoolId, IdentityId, DatasetName,
  LastSyncCount, NextToken, MaxResults, SyncSessionToken)

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.

DatasetName

[required] A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).

LastSyncCount

The last server sync count for this record.

NextToken

A pagination token for obtaining the next page of results.

MaxResults

The maximum number of results to be returned.

SyncSessionToken

A token containing a session ID, identity ID, and expiration.

Value

A list with the following syntax:

list(
  Records = list(
    list(
      Key = "string",
      Value = "string",
      SyncCount = 123,
      LastModifiedDate = as.POSIXct(
        "2015-01-01"
      ),
      LastModifiedBy = "string",
      DeviceLastModifiedDate = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string",
  Count = 123,
  DatasetSyncCount = 123,
  LastModifiedBy = "string",
  MergedDatasetNames = list(
    "string"
  ),
  DatasetExists = TRUE|FALSE,
  DatasetDeletedAfterRequestedSyncCount = TRUE|FALSE,
  SyncSessionToken = "string"
)

Request syntax

svc$list_records(
  IdentityPoolId = "string",
  IdentityId = "string",
  DatasetName = "string",
  LastSyncCount = 123,
  NextToken = "string",
  MaxResults = 123,
  SyncSessionToken = "string"
)