Dataset - Amazon Cognito Sync
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

Dataset

A collection of data for an identity pool. An identity pool can have multiple datasets. A dataset is per identity and can be general or associated with a particular entity in an application (like a saved game). Datasets are automatically created if they don't exist. Data is synced by dataset, and a dataset can hold up to 1MB of key-value pairs.

Contents

CreationDate

Date on which the dataset was created.

Type: Timestamp

Required: No

DatasetName

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9_.:-]+

Required: No

DataStorage

Total size in bytes of the records in this dataset.

Type: Long

Required: No

IdentityId

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 55.

Pattern: [\w-]+:[0-9a-f-]+

Required: No

LastModifiedBy

The device that made the last change to this dataset.

Type: String

Required: No

LastModifiedDate

Date when the dataset was last modified.

Type: Timestamp

Required: No

NumRecords

Number of records in this dataset.

Type: Long

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: