aws_sdk_cognitosync/client/
list_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 [`ListRecords`](crate::operation::list_records::builders::ListRecordsFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`identity_pool_id(impl Into<String>)`](crate::operation::list_records::builders::ListRecordsFluentBuilder::identity_pool_id) / [`set_identity_pool_id(Option<String>)`](crate::operation::list_records::builders::ListRecordsFluentBuilder::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::list_records::builders::ListRecordsFluentBuilder::identity_id) / [`set_identity_id(Option<String>)`](crate::operation::list_records::builders::ListRecordsFluentBuilder::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::list_records::builders::ListRecordsFluentBuilder::dataset_name) / [`set_dataset_name(Option<String>)`](crate::operation::list_records::builders::ListRecordsFluentBuilder::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    ///   - [`last_sync_count(i64)`](crate::operation::list_records::builders::ListRecordsFluentBuilder::last_sync_count) / [`set_last_sync_count(Option<i64>)`](crate::operation::list_records::builders::ListRecordsFluentBuilder::set_last_sync_count):<br>required: **false**<br>The last server sync count for this record.<br>
10    ///   - [`next_token(impl Into<String>)`](crate::operation::list_records::builders::ListRecordsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_records::builders::ListRecordsFluentBuilder::set_next_token):<br>required: **false**<br>A pagination token for obtaining the next page of results.<br>
11    ///   - [`max_results(i32)`](crate::operation::list_records::builders::ListRecordsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_records::builders::ListRecordsFluentBuilder::set_max_results):<br>required: **false**<br>The maximum number of results to be returned.<br>
12    ///   - [`sync_session_token(impl Into<String>)`](crate::operation::list_records::builders::ListRecordsFluentBuilder::sync_session_token) / [`set_sync_session_token(Option<String>)`](crate::operation::list_records::builders::ListRecordsFluentBuilder::set_sync_session_token):<br>required: **false**<br>A token containing a session ID, identity ID, and expiration.<br>
13    /// - On success, responds with [`ListRecordsOutput`](crate::operation::list_records::ListRecordsOutput) with field(s):
14    ///   - [`records(Option<Vec::<Record>>)`](crate::operation::list_records::ListRecordsOutput::records): A list of all records.
15    ///   - [`next_token(Option<String>)`](crate::operation::list_records::ListRecordsOutput::next_token): A pagination token for obtaining the next page of results.
16    ///   - [`count(i32)`](crate::operation::list_records::ListRecordsOutput::count): Total number of records.
17    ///   - [`dataset_sync_count(Option<i64>)`](crate::operation::list_records::ListRecordsOutput::dataset_sync_count): Server sync count for this dataset.
18    ///   - [`last_modified_by(Option<String>)`](crate::operation::list_records::ListRecordsOutput::last_modified_by): The user/device that made the last change to this record.
19    ///   - [`merged_dataset_names(Option<Vec::<String>>)`](crate::operation::list_records::ListRecordsOutput::merged_dataset_names): Names of merged datasets.
20    ///   - [`dataset_exists(bool)`](crate::operation::list_records::ListRecordsOutput::dataset_exists): Indicates whether the dataset exists.
21    ///   - [`dataset_deleted_after_requested_sync_count(bool)`](crate::operation::list_records::ListRecordsOutput::dataset_deleted_after_requested_sync_count): A boolean value specifying whether to delete the dataset locally.
22    ///   - [`sync_session_token(Option<String>)`](crate::operation::list_records::ListRecordsOutput::sync_session_token): A token containing a session ID, identity ID, and expiration.
23    /// - On failure, responds with [`SdkError<ListRecordsError>`](crate::operation::list_records::ListRecordsError)
24    pub fn list_records(&self) -> crate::operation::list_records::builders::ListRecordsFluentBuilder {
25        crate::operation::list_records::builders::ListRecordsFluentBuilder::new(self.handle.clone())
26    }
27}
aws_sdk_cognitosync/client/list_records.rs

aws_sdk_cognitosync/client/
list_records.rs
