Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . cognito-sync ]

register-device

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.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  register-device
--identity-pool-id <value>
--identity-id <value>
--platform <value>
--token <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--identity-pool-id (string)

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.

--identity-id (string)

The unique ID for this identity.

--platform (string)

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

Possible values:

  • APNS
  • APNS_SANDBOX
  • GCM
  • ADM

--token (string)

The push token.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

DeviceId -> (string)

The unique ID generated for this device by Cognito.