aws_sdk_cognitosync/client/
update_records.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`UpdateRecords`](crate::operation::update_records::builders::UpdateRecordsFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`identity_pool_id(impl Into<String>)`](crate::operation::update_records::builders::UpdateRecordsFluentBuilder::identity_pool_id) / [`set_identity_pool_id(Option<String>)`](crate::operation::update_records::builders::UpdateRecordsFluentBuilder::set_identity_pool_id):<br>required: **true**<br>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.<br>
7    ///   - [`identity_id(impl Into<String>)`](crate::operation::update_records::builders::UpdateRecordsFluentBuilder::identity_id) / [`set_identity_id(Option<String>)`](crate::operation::update_records::builders::UpdateRecordsFluentBuilder::set_identity_id):<br>required: **true**<br>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.<br>
8    ///   - [`dataset_name(impl Into<String>)`](crate::operation::update_records::builders::UpdateRecordsFluentBuilder::dataset_name) / [`set_dataset_name(Option<String>)`](crate::operation::update_records::builders::UpdateRecordsFluentBuilder::set_dataset_name):<br>required: **true**<br>A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).<br>
9    ///   - [`device_id(impl Into<String>)`](crate::operation::update_records::builders::UpdateRecordsFluentBuilder::device_id) / [`set_device_id(Option<String>)`](crate::operation::update_records::builders::UpdateRecordsFluentBuilder::set_device_id):<br>required: **false**<br><p>The unique ID generated for this device by Cognito.</p><br>
10    ///   - [`record_patches(RecordPatch)`](crate::operation::update_records::builders::UpdateRecordsFluentBuilder::record_patches) / [`set_record_patches(Option<Vec::<RecordPatch>>)`](crate::operation::update_records::builders::UpdateRecordsFluentBuilder::set_record_patches):<br>required: **false**<br>A list of patch operations.<br>
11    ///   - [`sync_session_token(impl Into<String>)`](crate::operation::update_records::builders::UpdateRecordsFluentBuilder::sync_session_token) / [`set_sync_session_token(Option<String>)`](crate::operation::update_records::builders::UpdateRecordsFluentBuilder::set_sync_session_token):<br>required: **true**<br>The SyncSessionToken returned by a previous call to ListRecords for this dataset and identity.<br>
12    ///   - [`client_context(impl Into<String>)`](crate::operation::update_records::builders::UpdateRecordsFluentBuilder::client_context) / [`set_client_context(Option<String>)`](crate::operation::update_records::builders::UpdateRecordsFluentBuilder::set_client_context):<br>required: **false**<br>Intended to supply a device ID that will populate the lastModifiedBy field referenced in other methods. The ClientContext field is not yet implemented.<br>
13    /// - On success, responds with [`UpdateRecordsOutput`](crate::operation::update_records::UpdateRecordsOutput) with field(s):
14    ///   - [`records(Option<Vec::<Record>>)`](crate::operation::update_records::UpdateRecordsOutput::records): A list of records that have been updated.
15    /// - On failure, responds with [`SdkError<UpdateRecordsError>`](crate::operation::update_records::UpdateRecordsError)
16    pub fn update_records(&self) -> crate::operation::update_records::builders::UpdateRecordsFluentBuilder {
17        crate::operation::update_records::builders::UpdateRecordsFluentBuilder::new(self.handle.clone())
18    }
19}