Table Of Contents

Feedback

User Guide

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

[ aws . sns ]

set-platform-application-attributes

Description

Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications . For information on configuring attributes for message delivery status, see Using Amazon SNS Application Attributes for Message Delivery Status .

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  set-platform-application-attributes
--platform-application-arn <value>
--attributes <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--platform-application-arn (string)

PlatformApplicationArn for set-platform-application-attributes action.

--attributes (map)

A map of the platform application attributes. Attributes in this map include the following:

  • PlatformCredential -- The credential received from the notification service. For APNS/APNS_SANDBOX, PlatformCredential is private key. For GCM, PlatformCredential is "API key". For ADM, PlatformCredential is "client secret".
  • PlatformPrincipal -- The principal received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is SSL certificate. For GCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is "client id".
  • EventEndpointCreated -- Topic ARN to which EndpointCreated event notifications should be sent.
  • EventEndpointDeleted -- Topic ARN to which EndpointDeleted event notifications should be sent.
  • EventEndpointUpdated -- Topic ARN to which EndpointUpdate event notifications should be sent.
  • EventDeliveryFailure -- Topic ARN to which DeliveryFailure event notifications should be sent upon Direct publish delivery failure (permanent) to one of the application's endpoints.
  • SuccessFeedbackRoleArn -- IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.
  • FailureFeedbackRoleArn -- IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.
  • SuccessFeedbackSampleRate -- Sample rate percentage (0-100) of successfully delivered messages.

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

None