Table Of Contents

Feedback

User Guide

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

[ aws . sns ]

create-platform-endpoint

Description

Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM and APNS. create-platform-endpoint requires the PlatformApplicationArn that is returned from create-platform-application . The EndpointArn that is returned when using create-platform-endpoint can then be used by the publish action to send a message to a mobile app or by the subscribe action for subscription to a topic. The create-platform-endpoint action is idempotent, so if the requester already owns an endpoint with the same device token and attributes, that endpoint's ARN is returned without creating a new endpoint. For more information, see Using Amazon SNS Mobile Push Notifications .

When using create-platform-endpoint with Baidu, two attributes must be provided: ChannelId and UserId. The token field must also contain the ChannelId. For more information, see Creating an Amazon SNS Endpoint for Baidu .

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-platform-endpoint
--platform-application-arn <value>
--token <value>
[--custom-user-data <value>]
[--attributes <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--platform-application-arn (string)

PlatformApplicationArn returned from create-platform-application is used to create a an endpoint.

--token (string)

Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM or ADM, the device token equivalent is called the registration ID.

--custom-user-data (string)

Arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.

--attributes (map)

For a list of attributes, see set-endpoint-attributes .

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

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

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

EndpointArn -> (string)

EndpointArn returned from CreateEndpoint action.