Amazon Cognito Sync
API Reference (API Version 2014-06-30)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.


Subscribes to receive notifications when a dataset is modified by another device.

This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.

Request Syntax

POST /identitypools/IdentityPoolId/identities/IdentityId/datasets/DatasetName/subscriptions/DeviceId HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.


The name of the dataset to subcribe to.

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

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


The unique ID generated for this device by Cognito.

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


Unique ID for this identity.

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

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


A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. The ID of the pool to which the identity belongs.

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

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

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.


For information about the errors that are common to all actions, see Common Errors.


Indicates an internal service error.

HTTP Status Code: 500


This exception is thrown when Amazon Cognito detects an invalid configuration.

HTTP Status Code: 400


Thrown when a request parameter does not comply with the associated constraints.

HTTP Status Code: 400


Thrown when a user is not authorized to access the requested resource.

HTTP Status Code: 403


Thrown if the resource doesn't exist.

HTTP Status Code: 404


Thrown if the request is throttled.

HTTP Status Code: 429



The following examples have been edited for readability.

Sample Request

POST / HTTP/1.1 CONTENT-TYPE: application/json X-AMZN-REQUESTID: 8b9932b7-201d-4418-a960-0a470e11de9f X-AMZ-TARGET: com.amazonaws.cognito.sync.model.AWSCognitoSyncService.SubscribeToDataset HOST: X-AMZ-DATE: 20141004T195350Z X-AMZ-SECURITY-TOKEN: <securitytoken> AUTHORIZATION: AWS4-HMAC-SHA256 Credential=<credential>, SignedHeaders=content-type;content-length;host;x-amz-date;x-amz-target, Signature=<signature> { "IdentityPoolId": "ID_POOL_ID", "IdentityId": "IDENTITY_ID", "DatasetName": "Rufus", "DeviceId": "5cd28fbe-dd83-47ab-9f83-19093a5fb014 }

Sample Response

1.1 200 OK x-amzn-requestid: 8b9932b7-201d-4418-a960-0a470e11de9f date: Sat, 04 Oct 2014 19:53:50 GMT content-type: application/json content-length: 99 { }

See Also

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