Try it now and let us know what you think. Switch to the new look >>
You can return to the original look by selecting English in the language selector above.
SetPlatformApplicationAttributes
Sets the attributes of the platform application object for the supported push notification services, such as APNS and FCM. 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 APNS/APNS_SANDBOX, PlatformCredential is private key. For FCM, 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 FCM, 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.
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
Example
The structure of AUTHPARAMS depends on the signature of the API request.
For more information, see Examples
of Signed Signature Version 4 Requests in the Amazon Web Services General Reference.
Example
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%2FFCM%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>
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
