Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14178465.7 KB

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.

get/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}/records

Path parameters

IdentityPoolIdstring required

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.

IdentityIdstring required

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.

DatasetNamestring required

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

Query parameters

lastSyncCountinteger

The last server sync count for this record.

nextTokenstring

A pagination token for obtaining the next page of results.

maxResultsinteger

The maximum number of results to be returned.

syncSessionTokenstring

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

Response

Success

NextTokenstring

A pagination token for obtaining the next page of results.

Countinteger

Total number of records.

DatasetSyncCountinteger

Server sync count for this dataset.

LastModifiedBystring

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

MergedDatasetNamesString[]

Names of merged datasets.

DatasetExistsboolean

Indicates whether the dataset exists.

DatasetDeletedAfterRequestedSyncCountboolean

A boolean value specifying whether to delete the dataset locally.

SyncSessionTokenstring

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