amazonka-cognito-sync-0.0.7: Amazon Cognito Sync SDK.

Safe HaskellNone
LanguageHaskell2010

Network.AWS.CognitoSync.ListRecords

Contents

Description

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

http://docs.aws.amazon.com/cognitosync/latest/APIReference/API_ListRecords.html

Synopsis

Request

Request constructor

Request lenses

lrDatasetName :: Lens' ListRecords Text Source

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

lrIdentityId :: Lens' ListRecords Text Source

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.

lrIdentityPoolId :: Lens' ListRecords Text Source

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.

lrLastSyncCount :: Lens' ListRecords (Maybe Integer) Source

The last server sync count for this record.

lrMaxResults :: Lens' ListRecords (Maybe Int) Source

The maximum number of results to be returned.

lrNextToken :: Lens' ListRecords (Maybe Text) Source

A pagination token for obtaining the next page of results.

lrSyncSessionToken :: Lens' ListRecords (Maybe Text) Source

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

Response

Response constructor

Response lenses

lrrCount :: Lens' ListRecordsResponse (Maybe Int) Source

Total number of records.

lrrDatasetDeletedAfterRequestedSyncCount :: Lens' ListRecordsResponse (Maybe Bool) Source

A boolean value specifying whether to delete the dataset locally.

lrrDatasetExists :: Lens' ListRecordsResponse (Maybe Bool) Source

Indicates whether the dataset exists.

lrrDatasetSyncCount :: Lens' ListRecordsResponse (Maybe Integer) Source

Server sync count for this dataset.

lrrLastModifiedBy :: Lens' ListRecordsResponse (Maybe Text) Source

The user/device that made the last change to this record.

lrrNextToken :: Lens' ListRecordsResponse (Maybe Text) Source

A pagination token for obtaining the next page of results.

lrrRecords :: Lens' ListRecordsResponse [Record] Source

A list of all records.

lrrSyncSessionToken :: Lens' ListRecordsResponse (Maybe Text) Source

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