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

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

Overview

A request to post updates to records or add and delete records for a dataset and user.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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.

Returns:

  • (String) 


1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
 
# File 'gems/aws-sdk-cognitosync/lib/aws-sdk-cognitosync/types.rb', line 1215

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

#dataset_name ⇒ String

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

Returns:

  • (String) 


1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
 
# File 'gems/aws-sdk-cognitosync/lib/aws-sdk-cognitosync/types.rb', line 1215

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

#device_id ⇒ String

The unique ID generated for this device by Cognito.

Returns:

  • (String) 


1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
 
# File 'gems/aws-sdk-cognitosync/lib/aws-sdk-cognitosync/types.rb', line 1215

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

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

Returns:

  • (String) 


1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
 
# File 'gems/aws-sdk-cognitosync/lib/aws-sdk-cognitosync/types.rb', line 1215

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

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

Returns:

  • (String) 


1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
 
# File 'gems/aws-sdk-cognitosync/lib/aws-sdk-cognitosync/types.rb', line 1215

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

#record_patches ⇒ Array<Types::RecordPatch>

A list of patch operations.

Returns:



1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
 
# File 'gems/aws-sdk-cognitosync/lib/aws-sdk-cognitosync/types.rb', line 1215

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

#sync_session_token ⇒ String

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

Returns:

  • (String) 


1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
 
# File 'gems/aws-sdk-cognitosync/lib/aws-sdk-cognitosync/types.rb', line 1215

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