Skip to content

Registers a device to receive push sync notifications

Description

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.

Usage

cognitosync_register_device(IdentityPoolId, IdentityId, Platform, Token)

Arguments

  • IdentityPoolId

    [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.

  • IdentityId

    [required] The unique ID for this identity.

  • Platform

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

  • Token

    [required] The push token.

Value

A list with the following syntax:

list(
  DeviceId = "string"
)

Request syntax

svc$register_device(
  IdentityPoolId = "string",
  IdentityId = "string",
  Platform = "APNS"|"APNS_SANDBOX"|"GCM"|"ADM",
  Token = "string"
)