get-platform-application-attributes¶

Description¶

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 .

Synopsis¶

  get-platform-application-attributes
--platform-application-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--platform-application-arn (string)

PlatformApplicationArn for GetPlatformApplicationAttributesInput.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To list the platform application attributes

The following get-platform-application-attributes example lists the attributes for the specified platform application.

aws sns get-platform-application-attributes \
    --platform-application-arn arn:aws:sns:us-west-2:123456789012:app/MPNS/MyApplication

Output:

{
    "Attributes": {
        "Enabled": "true",
        "SuccessFeedbackSampleRate": "100"
    }
}

Output¶

Attributes -> (map)

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.

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.

key -> (string)

value -> (string)