You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::CognitoSync::Types::UpdateRecordsRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::CognitoSync::Types::UpdateRecordsRequest
- Defined in:
- (unknown)
Overview
When passing UpdateRecordsRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
identity_pool_id: "IdentityPoolId", # required
identity_id: "IdentityId", # required
dataset_name: "DatasetName", # required
device_id: "DeviceId",
record_patches: [
{
op: "replace", # required, accepts replace, remove
key: "RecordKey", # required
value: "RecordValue",
sync_count: 1, # required
device_last_modified_date: Time.now,
},
],
sync_session_token: "SyncSessionToken", # required
client_context: "ClientContext",
}
A request to post updates to records or add and delete records for a dataset and user.
Instance Attribute Summary collapse
-
#client_context ⇒ String
Intended to supply a device ID that will populate the lastModifiedBy field referenced in other methods.
-
#dataset_name ⇒ String
A string of up to 128 characters.
-
#device_id ⇒ String
The unique ID generated for this device by Cognito.
-
#identity_id ⇒ String
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.
-
#identity_pool_id ⇒ String
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.
-
#record_patches ⇒ Array<Types::RecordPatch>
A list of patch operations.
-
#sync_session_token ⇒ String
The SyncSessionToken returned by a previous call to ListRecords for this dataset and identity.
Instance Attribute Details
#client_context ⇒ String
Intended to supply a device ID that will populate the lastModifiedBy field referenced in other methods. The ClientContext field is not yet implemented.
#dataset_name ⇒ String
A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, \'_\' (underscore), \'-\' (dash), and \'.\' (dot).
#device_id ⇒ String
The unique ID generated for this device by Cognito.
#identity_id ⇒ 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.
#identity_pool_id ⇒ 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.
#record_patches ⇒ Array<Types::RecordPatch>
A list of patch operations.
#sync_session_token ⇒ String
The SyncSessionToken returned by a previous call to ListRecords for this dataset and identity.