Network.AWS.CognitoSync.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.

See: AWS API Reference for ListRecords.

Creating a Request

listRecords

Arguments

:: Text

lrIdentityPoolId

-> Text

lrIdentityId

-> Text

lrDatasetName

-> ListRecords

Creates a value of ListRecords with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lrLastSyncCount
• lrNextToken
• lrSyncSessionToken
• lrMaxResults
• lrIdentityPoolId
• lrIdentityId
• lrDatasetName

data ListRecords

A request for a list of records.

See: listRecords smart constructor.

Instances

Eq ListRecords

Data ListRecords

Read ListRecords

Show ListRecords

Generic ListRecords

AWSRequest ListRecords

ToPath ListRecords

ToHeaders ListRecords

ToQuery ListRecords

Typeable * ListRecords

type Rep ListRecords

type Sv ListRecords = CognitoSync

type Rs ListRecords = ListRecordsResponse

Request Lenses

lrLastSyncCount :: Lens' ListRecords (Maybe Integer)

The last server sync count for this record.

lrNextToken :: Lens' ListRecords (Maybe Text)

A pagination token for obtaining the next page of results.

lrSyncSessionToken :: Lens' ListRecords (Maybe Text)

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

lrMaxResults :: Lens' ListRecords (Maybe Int)

The maximum number of results to be returned.

lrIdentityPoolId :: Lens' ListRecords Text

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.

lrIdentityId :: Lens' ListRecords Text

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.

lrDatasetName :: Lens' ListRecords Text

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

Destructuring the Response

listRecordsResponse

Arguments

:: Int

lrrsStatus

-> ListRecordsResponse

Creates a value of ListRecordsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lrrsDatasetDeletedAfterRequestedSyncCount
• lrrsDatasetExists
• lrrsCount
• lrrsRecords
• lrrsNextToken
• lrrsSyncSessionToken
• lrrsMergedDatasetNames
• lrrsLastModifiedBy
• lrrsDatasetSyncCount
• lrrsStatus

data ListRecordsResponse

Returned for a successful ListRecordsRequest.

See: listRecordsResponse smart constructor.

Instances

Eq ListRecordsResponse

Data ListRecordsResponse

Read ListRecordsResponse

Show ListRecordsResponse

Generic ListRecordsResponse

Typeable * ListRecordsResponse

type Rep ListRecordsResponse

Response Lenses

lrrsDatasetDeletedAfterRequestedSyncCount :: Lens' ListRecordsResponse (Maybe Bool)

A boolean value specifying whether to delete the dataset locally.

lrrsDatasetExists :: Lens' ListRecordsResponse (Maybe Bool)

Indicates whether the dataset exists.

lrrsCount :: Lens' ListRecordsResponse (Maybe Int)

Total number of records.

lrrsRecords :: Lens' ListRecordsResponse [Record]

A list of all records.

lrrsNextToken :: Lens' ListRecordsResponse (Maybe Text)

A pagination token for obtaining the next page of results.

lrrsSyncSessionToken :: Lens' ListRecordsResponse (Maybe Text)

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

lrrsMergedDatasetNames :: Lens' ListRecordsResponse [Text]

Names of merged datasets.

lrrsLastModifiedBy :: Lens' ListRecordsResponse (Maybe Text)

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

lrrsDatasetSyncCount :: Lens' ListRecordsResponse (Maybe Integer)

Server sync count for this dataset.

lrrsStatus :: Lens' ListRecordsResponse Int

The response status code.