Struct aws_sdk_cognitosync::client::fluent_builders::ListRecords

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

Fluent builder constructing a request to ListRecords.

Gets paginated records, optionally changed after a particular sync count for a dataset and identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.

ListRecords can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call.

ListRecords The following examples have been edited for readability. POST / HTTP/1.1 CONTENT-TYPE: application/json X-AMZN-REQUESTID: b3d2e31e-d6b7-4612-8e84-c9ba288dab5d X-AMZ-TARGET: com.amazonaws.cognito.sync.model.AWSCognitoSyncService.ListRecords HOST: cognito-sync.us-east-1.amazonaws.com:443 X-AMZ-DATE: 20141111T183230Z AUTHORIZATION: AWS4-HMAC-SHA256 Credential=, SignedHeaders=content-type;host;x-amz-date;x-amz-target;x-amzn-requestid, Signature=

{ “Operation”: “com.amazonaws.cognito.sync.model#ListRecords”, “Service”: “com.amazonaws.cognito.sync.model#AWSCognitoSyncService”, “Input”: { “IdentityPoolId”: “IDENTITY_POOL_ID”, “IdentityId”: “IDENTITY_ID”, “DatasetName”: “newDataSet” } } 1.1 200 OK x-amzn-requestid: b3d2e31e-d6b7-4612-8e84-c9ba288dab5d content-type: application/json content-length: 623 date: Tue, 11 Nov 2014 18:32:30 GMT

{ “Output”: { “__type”: “com.amazonaws.cognito.sync.model#ListRecordsResponse”, “Count”: 0, “DatasetDeletedAfterRequestedSyncCount”: false, “DatasetExists”: false, “DatasetSyncCount”: 0, “LastModifiedBy”: null, “MergedDatasetNames”: null, “NextToken”: null, “Records”: [], “SyncSessionToken”: “SYNC_SESSION_TOKEN” }, “Version”: “1.0” }

Implementations

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

pub async fn send(self) -> Result<ListRecordsOutput, SdkError<ListRecordsError>> where
    R::Policy: SmithyRetryPolicy<ListRecordsInputOperationOutputAlias, ListRecordsOutput, ListRecordsError, ListRecordsInputOperationRetryAlias>, 

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 last_sync_count(self, inp: i64) -> Self

The last server sync count for this record.

pub fn set_last_sync_count(self, input: Option<i64>) -> Self

The last server sync count for this record.

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

A pagination token for obtaining the next page of results.

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

A pagination token for obtaining the next page of results.

pub fn max_results(self, inp: i32) -> Self

The maximum number of results to be returned.

pub fn set_max_results(self, input: Option<i32>) -> Self

The maximum number of results to be returned.

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

A token containing a session ID, identity ID, and expiration.

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

A token containing a session ID, identity ID, and expiration.

Trait Implementations

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

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

Formats the value using the given formatter.