cognitosync_update_records: Posts updates to records and adds and deletes records for a...

Description Usage Arguments Details Request syntax

View source: R/cognitosync_operations.R

Description

Posts updates to records and adds and deletes records for a dataset and user.

Usage

1
2
cognitosync_update_records(IdentityPoolId, IdentityId, DatasetName,
  DeviceId, RecordPatches, SyncSessionToken, ClientContext)

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

DeviceId

The unique ID generated for this device by Cognito.

RecordPatches

A list of patch operations.

SyncSessionToken

[required] The SyncSessionToken returned by a previous call to ListRecords for this dataset and identity.

ClientContext

Intended to supply a device ID that will populate the lastModifiedBy field referenced in other methods. The ClientContext field is not yet implemented.

Details

The sync count in the record patch is your last known sync count for that record. The server will reject an UpdateRecords request with a ResourceConflictException if you try to patch a record with a new value but a stale sync count.

For example, if the sync count on the server is 5 for a key called highScore and you try and submit a new highScore with sync count of 4, the request will be rejected. To obtain the current sync count for a record, call ListRecords. On a successful update of the record, the response returns the new sync count for that record. You should present that sync count the next time you try to update that same record. When the record does not exist, specify the sync count as 0.

This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
svc$update_records(
  IdentityPoolId = "string",
  IdentityId = "string",
  DatasetName = "string",
  DeviceId = "string",
  RecordPatches = list(
    list(
      Op = "replace"|"remove",
      Key = "string",
      Value = "string",
      SyncCount = 123,
      DeviceLastModifiedDate = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  SyncSessionToken = "string",
  ClientContext = "string"
)

paws.security.identity documentation built on Oct. 30, 2019, 11:26 a.m.