Request Parameters Errors Examples See Also

SetPlatformApplicationAttributes

Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). 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.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

Attributes

Attributes.entry.N.key (key)

Attributes.entry.N.value (value)

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

PlatformCredential – The credential received from the notification service.
- For ADM, PlatformCredentialis client secret.
- For Apple Services using certificate credentials, PlatformCredential is private key.
- For Apple Services using token credentials, PlatformCredential is signing key.
- For GCM (Firebase Cloud Messaging), PlatformCredential is API key.

PlatformPrincipal – The principal received from the notification service.
- For ADM, PlatformPrincipalis client id.
- For Apple Services using certificate credentials, PlatformPrincipal is SSL certificate.
- For Apple Services using token credentials, PlatformPrincipal is signing key ID.
- For GCM (Firebase Cloud Messaging), there is no PlatformPrincipal.

EventEndpointCreated – Topic ARN to which EndpointCreated event notifications are sent.
EventEndpointDeleted – Topic ARN to which EndpointDeleted event notifications are sent.
EventEndpointUpdated – Topic ARN to which EndpointUpdate event notifications are sent.
EventDeliveryFailure – Topic ARN to which DeliveryFailure event notifications are 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.

The following attributes only apply to APNs token-based authentication:

ApplePlatformTeamID – The identifier that's assigned to your Apple developer account team.
ApplePlatformBundleID – The bundle identifier that's assigned to your iOS app.

Type: String to string map

Required: Yes

PlatformApplicationArn

PlatformApplicationArn for SetPlatformApplicationAttributes action.

Type: String

Required: Yes

Errors

For information about the errors that are common to all actions, see Common Errors.

AuthorizationError

Indicates that the user has been denied access to the requested resource.

HTTP Status Code: 403

InternalError

Indicates an internal service error.

HTTP Status Code: 500

InvalidParameter

Indicates that a request parameter does not comply with the associated constraints.

HTTP Status Code: 400

NotFound

Indicates that the requested resource does not exist.

HTTP Status Code: 404

Examples

The structure of AUTHPARAMS depends on the signature of the API request. For more information, see Examples of the complete Signature Version 4 signing process (Python) in the AWS General Reference.

Example

This example illustrates one usage of SetPlatformApplicationAttributes.

Sample Request


https://sns.us-west-2.amazonaws.com/?Action=SetPlatformApplicationAttributes
&Attributes.entry.1.key=EventEndpointCreated&PlatformApplicationArn=arn%3Aaws%3Asns%3Aus-west-2%3A123456789012%3Aapp%2FGCM%2Fgcmpushapp
&Attributes.entry.1.value=arn%3Aaws%3Asns%3Aus-west-2%3A123456789012%3Atopicarn
&Version=2010-03-31
&AUTHPARAMS

Sample Response


<SetPlatformApplicationAttributesResponse xmlns="https://sns.amazonaws.com/doc/2010-03-31/">
    <ResponseMetadata>
        <RequestId>cf577bcc-b3dc-5463-88f1-3180b9412395</RequestId>
    </ResponseMetadata>
</SetPlatformApplicationAttributesResponse>