v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14178465.7 KB

Registers a device to receive push sync notifications.

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

post/identitypools/{IdentityPoolId}/identity/{IdentityId}/device

Path parameters

IdentityPoolIdstring required

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

IdentityIdstring required

The unique ID for this identity.

Request body

Platform'APNS' | 'APNS_SANDBOX' | 'GCM' | 'ADM' required

The SNS platform type (e.g. GCM, SDM, APNS, APNS_SANDBOX).

Tokenstring required

The push token.

Response

Success

DeviceIdstring

The unique ID generated for this device by Cognito.