Request Parameters Response Elements Errors Examples See Also

GetPlatformApplicationAttributes

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

Request Parameters

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

PlatformApplicationArn

PlatformApplicationArn for GetPlatformApplicationAttributesInput.

Type: String

Required: Yes

Response Elements

The following element is returned by the service.

Attributes

Attributes.entry.N.key (key)

Attributes.entry.N.value (value)

Attributes include the following:

AppleCertificateExpiryDate – The expiry date of the SSL certificate used to configure certificate-based authentication.
ApplePlatformTeamID – The Apple developer account ID used to configure token-based authentication.
ApplePlatformBundleID – The app identifier used to configure token-based authentication.
AuthenticationMethod – Returns the credential type used when sending push notifications from application to APNS/APNS_Sandbox, or application to GCM.
- APNS – Returns the token or certificate.
- GCM – Returns the token or key.
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.

Type: String to string map

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 Amazon General Reference.

Example

This example illustrates one usage of GetPlatformApplicationAttributes.

Sample Request


https://sns.us-west-2.amazonaws.com/?Action=GetPlatformApplicationAttributes
&PlatformApplicationArn=arn%3Aaws%3Asns%3Aus-west-2%3A123456789012%3Aapp%2FGCM%2Fgcmpushapp
&Version=2010-03-31
&AUTHPARAMS

Sample Response


<GetPlatformApplicationAttributesResponse xmlns="https://sns.amazonaws.com/doc/2010-03-31/">
    <GetPlatformApplicationAttributesResult>
        <Attributes>
            <entry>
                <key>AllowEndpointPolicies</key>
                <value>false</value>
            </entry>
        </Attributes>
    </GetPlatformApplicationAttributesResult>
    <ResponseMetadata>
        <RequestId>74848df2-87f6-55ed-890c-c7be80442462</RequestId>
    </ResponseMetadata>
</GetPlatformApplicationAttributesResponse>