Create Platform Application
sns_create_platform_application | R Documentation |
Creates a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile apps may register¶
Description¶
Creates a platform application object for one of the supported push
notification services, such as APNS and GCM (Firebase Cloud Messaging),
to which devices and mobile apps may register. You must specify
PlatformPrincipal
and PlatformCredential
attributes when using the
create_platform_application
action.
PlatformPrincipal
and PlatformCredential
are received from the
notification service.
-
For ADM,
PlatformPrincipal
isclient id
andPlatformCredential
isclient secret
. -
For APNS and
APNS_SANDBOX
using certificate credentials,PlatformPrincipal
isSSL certificate
andPlatformCredential
isprivate key
. -
For APNS and
APNS_SANDBOX
using token credentials,PlatformPrincipal
issigning key ID
andPlatformCredential
issigning key
. -
For Baidu,
PlatformPrincipal
isAPI key
andPlatformCredential
issecret key
. -
For GCM (Firebase Cloud Messaging) using key credentials, there is no
PlatformPrincipal
. ThePlatformCredential
isAPI key
. -
For GCM (Firebase Cloud Messaging) using token credentials, there is no
PlatformPrincipal
. ThePlatformCredential
is a JSON formatted private key file. When using the Amazon Web Services CLI, the file must be in string format and special characters must be ignored. To format the file correctly, Amazon SNS recommends using the following command:SERVICE_JSON=`jq @json <<< cat service.json`
. -
For MPNS,
PlatformPrincipal
isTLS certificate
andPlatformCredential
isprivate key
. -
For WNS,
PlatformPrincipal
isPackage Security Identifier
andPlatformCredential
issecret key
.
You can use the returned PlatformApplicationArn
as an attribute for
the create_platform_endpoint
action.
Usage¶
Arguments¶
Name
[required] Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long.
Platform
[required] The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Firebase Cloud Messaging).
Attributes
[required] For a list of attributes, see
set_platform_application_attributes
.
Value¶
A list with the following syntax: