Struct aws_sdk_cognitosync::client::fluent_builders::UpdateRecords

pub struct UpdateRecords<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to UpdateRecords.

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

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.

Implementations

impl<C, M, R> UpdateRecords<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<UpdateRecordsOutput, SdkError<UpdateRecordsError>> where
    R::Policy: SmithyRetryPolicy<UpdateRecordsInputOperationOutputAlias, UpdateRecordsOutput, UpdateRecordsError, UpdateRecordsInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn identity_pool_id(self, inp: impl Into<String>) -> Self

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.

pub fn set_identity_pool_id(self, input: Option<String>) -> Self

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.

pub fn identity_id(self, inp: impl Into<String>) -> Self

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.

pub fn set_identity_id(self, input: Option<String>) -> Self

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.

pub fn dataset_name(self, inp: impl Into<String>) -> Self

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

pub fn set_dataset_name(self, input: Option<String>) -> Self

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

pub fn device_id(self, inp: impl Into<String>) -> Self

The unique ID generated for this device by Cognito.

pub fn set_device_id(self, input: Option<String>) -> Self

The unique ID generated for this device by Cognito.

pub fn record_patches(self, inp: impl Into<RecordPatch>) -> Self

Appends an item to RecordPatches.

To override the contents of this collection use set_record_patches.

A list of patch operations.

pub fn set_record_patches(self, input: Option<Vec<RecordPatch>>) -> Self

A list of patch operations.

pub fn sync_session_token(self, inp: impl Into<String>) -> Self

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

pub fn set_sync_session_token(self, input: Option<String>) -> Self

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

pub fn client_context(self, inp: impl Into<String>) -> Self

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

pub fn set_client_context(self, input: Option<String>) -> Self

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

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for UpdateRecords<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.