Amazon Cognito Sync
Amazon Cognito Sync Amazon Cognito Sync provides an AWS service and client library that enable cross-device syncing of application-related user data.…
Identity & security#openapi#cloud
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Amazon Cognito Sync
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 .
Endpoints 17
- POSTBulk publish
/identitypools/:IdentityPoolId/bulkpublishInitiates a bulk publish of all existing datasets for an Identity Pool to the configured stream. Customers are limited to one successful bulk publish per 24… - GETDescribe dataset
/identitypools/:IdentityPoolId/identities/:IdentityId/datasets/:DatasetNameGets meta data about a dataset by identity and dataset name. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials… - POSTUpdate records
/identitypools/:IdentityPoolId/identities/:IdentityId/datasets/:DatasetNamePosts updates to records and adds and deletes records for a dataset and user. The sync count in the record patch is your last known sync count for that… - DELETEDelete dataset
/identitypools/:IdentityPoolId/identities/:IdentityId/datasets/:DatasetNameDeletes the specific dataset. The dataset will be deleted permanently, and the action can't be undone. Datasets that this dataset was merged with will no… - GETDescribe identity pool usage
/identitypools/:IdentityPoolIdGets usage details (for example, data storage) about a particular identity pool. This API can only be called with developer credentials. You cannot call this… - GETDescribe identity usage
/identitypools/:IdentityPoolId/identities/:IdentityIdGets usage information for an identity, including number of datasets and data usage. This API can be called with temporary user credentials provided by… - POSTGet bulk publish details
/identitypools/:IdentityPoolId/getBulkPublishDetailsGet the status of the last BulkPublish operation for an identity pool. This API can only be called with developer credentials. You cannot call this API with… - GETGet cognito events
/identitypools/:IdentityPoolId/eventsGets the events and the corresponding Lambda functions associated with an identity pool. This API can only be called with developer credentials. You cannot… - POSTSet cognito events
/identitypools/:IdentityPoolId/eventsSets the AWS Lambda function for a given event type for an identity pool. This request only updates the key/value pair specified. Other key/values pairs are… - GETGet identity pool configuration
/identitypools/:IdentityPoolId/configurationGets the configuration settings of an identity pool. This API can only be called with developer credentials. You cannot call this API with the temporary user… - POSTSet identity pool configuration
/identitypools/:IdentityPoolId/configurationSets the necessary configuration for push sync. This API can only be called with developer credentials. You cannot call this API with the temporary user… - GETList datasets
/identitypools/:IdentityPoolId/identities/:IdentityId/datasets?nextToken=string&maxResults=0Lists datasets for an identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need… - GETList identity pool usage
/identitypools?nextToken=string&maxResults=0Gets a list of identity pools registered with Cognito. ListIdentityPoolUsage can only be called with developer credentials. You cannot make this API call with… - GETList records
/identitypools/:IdentityPoolId/identities/:IdentityId/datasets/:DatasetName/records?lastSyncCount=0&nextToken=string&maxResults=0&syncSessionToken=stringGets paginated records, optionally changed after a particular sync count for a dataset and identity. With Amazon Cognito Sync, each identity has access only… - POSTRegister device
/identitypools/:IdentityPoolId/identity/:IdentityId/deviceRegisters a device to receive push sync notifications. This API can only be called with temporary credentials provided by Cognito Identity. You cannot call… - POSTSubscribe to dataset
/identitypools/:IdentityPoolId/identities/:IdentityId/datasets/:DatasetName/subscriptions/:DeviceIdSubscribes to receive notifications when a dataset is modified by another device. This API can only be called with temporary credentials provided by Cognito… - DELETEUnsubscribe from dataset
/identitypools/:IdentityPoolId/identities/:IdentityId/datasets/:DatasetName/subscriptions/:DeviceIdUnsubscribes from receiving notifications when a dataset is modified by another device. This API can only be called with temporary credentials provided by…
API details
- Base URL
https://cognito-sync.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 17 operations on 12 pathsGET 8POST 7DELETE 2
- Description format
- AWS Smithy model, API version
2014-06-30 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the Amazon Cognito Sync in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Cognito Sync collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Bulk publish” (POST /identitypools/:IdentityPoolId/bulkpublish), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Amazon Cognito Sync?
Amazon Cognito Sync Amazon Cognito Sync provides an AWS service and client library that enable cross-device syncing of application-related user data.… It is listed under Identity & security and has 17 endpoints.
Who publishes the Amazon Cognito Sync?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Amazon Cognito Sync?
Requests go to https://cognito-sync.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the Amazon Cognito Sync?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the Amazon Cognito Sync have?
17 operations on 12 paths (8 GET, 7 POST, 2 DELETE).
Is forking the Amazon Cognito Sync free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.