Method: Aws::SNS::Client#create_platform_application

Defined in:

lib/aws-sdk-sns/client.rb

#create_platform_application(params = {}) ⇒ Types::CreatePlatformApplicationResponse

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 CreatePlatformApplication action.

PlatformPrincipal and PlatformCredential are received from the notification service.

• For ADM, PlatformPrincipal is ‘client id` and PlatformCredential is `client secret`.

• For APNS and APNS_SANDBOX using certificate credentials, PlatformPrincipal is ‘SSL certificate` and PlatformCredential is `private key`.

• For APNS and APNS_SANDBOX using token credentials, PlatformPrincipal is ‘signing key ID` and PlatformCredential is `signing key`.

• For Baidu, PlatformPrincipal is ‘API key` and PlatformCredential is `secret key`.

• For GCM (Firebase Cloud Messaging) using key credentials, there is no PlatformPrincipal. The PlatformCredential is ‘API key`.

• For GCM (Firebase Cloud Messaging) using token credentials, there is no PlatformPrincipal. The PlatformCredential is a JSON formatted private key file. When using the Amazon Web Services CLI or Amazon Web Services SDKs, 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 < service.json)`.

• For MPNS, PlatformPrincipal is ‘TLS certificate` and PlatformCredential is `private key`.

• For WNS, PlatformPrincipal is ‘Package Security Identifier` and PlatformCredential is `secret key`.

You can use the returned PlatformApplicationArn as an attribute for the CreatePlatformEndpoint action.

Examples:

Request syntax with placeholder values

resp = client.create_platform_application({
  name: "String", # required
  platform: "String", # required
  attributes: { # required
    "String" => "String",
  },
})

Response structure

resp.platform_application_arn #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :name (required, String) —

  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, String) —

  The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Firebase Cloud Messaging).

• :attributes (required, Hash<String,String>) —

  For a list of attributes, see [ SetPlatformApplicationAttributes ][1].

  [1]: docs.aws.amazon.com/sns/latest/api/API_SetPlatformApplicationAttributes.html

Returns:

• (Types::CreatePlatformApplicationResponse) —

  Returns a response object which responds to the following methods:

  • #platform_application_arn => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-sns/client.rb', line 686

def create_platform_application(params = {}, options = {})
  req = build_request(:create_platform_application, params)
  req.send_request(options)
end