You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CognitoSync::Types::UpdateRecordsRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cognitosync/lib/aws-sdk-cognitosync/types.rb

Overview

Note:

When making an API call, you may pass UpdateRecordsRequest data as a 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

Instance Attribute Details

#client_contextString

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

Returns:

  • (String)


1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
# File 'gems/aws-sdk-cognitosync/lib/aws-sdk-cognitosync/types.rb', line 1187

class UpdateRecordsRequest < Struct.new(
  :identity_pool_id,
  :identity_id,
  :dataset_name,
  :device_id,
  :record_patches,
  :sync_session_token,
  :client_context)
  include Aws::Structure
end

#dataset_nameString

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

Returns:

  • (String)


1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
# File 'gems/aws-sdk-cognitosync/lib/aws-sdk-cognitosync/types.rb', line 1187

class UpdateRecordsRequest < Struct.new(
  :identity_pool_id,
  :identity_id,
  :dataset_name,
  :device_id,
  :record_patches,
  :sync_session_token,
  :client_context)
  include Aws::Structure
end

#device_idString

The unique ID generated for this device by Cognito.

Returns:

  • (String)


1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
# File 'gems/aws-sdk-cognitosync/lib/aws-sdk-cognitosync/types.rb', line 1187

class UpdateRecordsRequest < Struct.new(
  :identity_pool_id,
  :identity_id,
  :dataset_name,
  :device_id,
  :record_patches,
  :sync_session_token,
  :client_context)
  include Aws::Structure
end

#identity_idString

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.

Returns:

  • (String)


1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
# File 'gems/aws-sdk-cognitosync/lib/aws-sdk-cognitosync/types.rb', line 1187

class UpdateRecordsRequest < Struct.new(
  :identity_pool_id,
  :identity_id,
  :dataset_name,
  :device_id,
  :record_patches,
  :sync_session_token,
  :client_context)
  include Aws::Structure
end

#identity_pool_idString

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.

Returns:

  • (String)


1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
# File 'gems/aws-sdk-cognitosync/lib/aws-sdk-cognitosync/types.rb', line 1187

class UpdateRecordsRequest < Struct.new(
  :identity_pool_id,
  :identity_id,
  :dataset_name,
  :device_id,
  :record_patches,
  :sync_session_token,
  :client_context)
  include Aws::Structure
end

#record_patchesArray<Types::RecordPatch>

A list of patch operations.

Returns:



1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
# File 'gems/aws-sdk-cognitosync/lib/aws-sdk-cognitosync/types.rb', line 1187

class UpdateRecordsRequest < Struct.new(
  :identity_pool_id,
  :identity_id,
  :dataset_name,
  :device_id,
  :record_patches,
  :sync_session_token,
  :client_context)
  include Aws::Structure
end

#sync_session_tokenString

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

Returns:

  • (String)


1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
# File 'gems/aws-sdk-cognitosync/lib/aws-sdk-cognitosync/types.rb', line 1187

class UpdateRecordsRequest < Struct.new(
  :identity_pool_id,
  :identity_id,
  :dataset_name,
  :device_id,
  :record_patches,
  :sync_session_token,
  :client_context)
  include Aws::Structure
end