v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14178465.7 KB

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.

post/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}/subscriptions/{DeviceId}

Path parameters

IdentityPoolIdstring required

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.

IdentityIdstring required

Unique ID for this identity.

DatasetNamestring required

The name of the dataset to subcribe to.

DeviceIdstring required

The unique ID generated for this device by Cognito.

Response

Success

SubscribeToDatasetResponse required

Response to a SubscribeToDataset request.