Expand description
Amazon Cognito Sync provides an AWS service and client library that enable cross-device syncing of application-related user data. High-level client libraries are available for both iOS and Android. You can use these libraries to persist data locally so that it's available even if the device is offline. Developer credentials don't need to be stored on the mobile device to access the service. You can use Amazon Cognito to obtain a normalized user ID and credentials. User data is persisted in a dataset that can store up to 1 MB of key-value pairs, and you can have up to 20 datasets per user identity.
With Amazon Cognito Sync, the data stored for each identity is accessible only to credentials assigned to that identity. In order to use the Cognito Sync service, you need to make API calls using credentials retrieved with Amazon Cognito Identity service.
If you want to use Cognito Sync in an Android or iOS application, you will probably want to make API calls via the AWS Mobile SDK. To learn more, see the Developer Guide for Android and the Developer Guide for iOS.
If you’re using the service, you’re probably looking for CognitoSyncClient and CognitoSync.
Structs§
- Bulk
Publish Request The input for the BulkPublish operation.
- Bulk
Publish Response The output for the BulkPublish operation.
- Cognito
Streams Configuration options for configure Cognito streams.
- Cognito
Sync Client - A client for the Amazon Cognito Sync API.
- 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.
- Delete
Dataset Request A request to delete the specific dataset.
- Delete
Dataset Response Response to a successful DeleteDataset request.
- Describe
Dataset Request A request for meta data about a dataset (creation date, number of records, size) by owner and dataset name.
- Describe
Dataset Response Response to a successful DescribeDataset request.
- Describe
Identity Pool Usage Request A request for usage information about the identity pool.
- Describe
Identity Pool Usage Response Response to a successful DescribeIdentityPoolUsage request.
- Describe
Identity Usage Request A request for information about the usage of an identity pool.
- Describe
Identity Usage Response The response to a successful DescribeIdentityUsage request.
- GetBulk
Publish Details Request The input for the GetBulkPublishDetails operation.
- GetBulk
Publish Details Response The output for the GetBulkPublishDetails operation.
- GetCognito
Events Request A request for a list of the configured Cognito Events
- GetCognito
Events Response The response from the GetCognitoEvents request
- GetIdentity
Pool Configuration Request The input for the GetIdentityPoolConfiguration operation.
- GetIdentity
Pool Configuration Response The output for the GetIdentityPoolConfiguration operation.
- Identity
Pool Usage Usage information for the identity pool.
- Identity
Usage Usage information for the identity.
- List
Datasets Request Request for a list of datasets for an identity.
- List
Datasets Response Returned for a successful ListDatasets request.
- List
Identity Pool Usage Request A request for usage information on an identity pool.
- List
Identity Pool Usage Response Returned for a successful ListIdentityPoolUsage request.
- List
Records Request A request for a list of records.
- List
Records Response Returned for a successful ListRecordsRequest.
- Push
Sync Configuration options to be applied to the identity pool.
- Record
The basic data structure of a dataset.
- Record
Patch An update operation for a record.
- Register
Device Request A request to RegisterDevice.
- Register
Device Response Response to a RegisterDevice request.
- SetCognito
Events Request A request to configure Cognito Events
- SetIdentity
Pool Configuration Request The input for the SetIdentityPoolConfiguration operation.
- SetIdentity
Pool Configuration Response The output for the SetIdentityPoolConfiguration operation
- Subscribe
ToDataset Request A request to SubscribeToDatasetRequest.
- Subscribe
ToDataset Response Response to a SubscribeToDataset request.
- Unsubscribe
From Dataset Request A request to UnsubscribeFromDataset.
- Unsubscribe
From Dataset Response Response to an UnsubscribeFromDataset request.
- Update
Records Request A request to post updates to records or add and delete records for a dataset and user.
- Update
Records Response Returned for a successful UpdateRecordsRequest.
Enums§
- Bulk
Publish Error - Errors returned by BulkPublish
- Delete
Dataset Error - Errors returned by DeleteDataset
- Describe
Dataset Error - Errors returned by DescribeDataset
- Describe
Identity Pool Usage Error - Errors returned by DescribeIdentityPoolUsage
- Describe
Identity Usage Error - Errors returned by DescribeIdentityUsage
- GetBulk
Publish Details Error - Errors returned by GetBulkPublishDetails
- GetCognito
Events Error - Errors returned by GetCognitoEvents
- GetIdentity
Pool Configuration Error - Errors returned by GetIdentityPoolConfiguration
- List
Datasets Error - Errors returned by ListDatasets
- List
Identity Pool Usage Error - Errors returned by ListIdentityPoolUsage
- List
Records Error - Errors returned by ListRecords
- Register
Device Error - Errors returned by RegisterDevice
- SetCognito
Events Error - Errors returned by SetCognitoEvents
- SetIdentity
Pool Configuration Error - Errors returned by SetIdentityPoolConfiguration
- Subscribe
ToDataset Error - Errors returned by SubscribeToDataset
- Unsubscribe
From Dataset Error - Errors returned by UnsubscribeFromDataset
- Update
Records Error - Errors returned by UpdateRecords
Traits§
- Cognito
Sync - Trait representing the capabilities of the Amazon Cognito Sync API. Amazon Cognito Sync clients implement this trait.