Skip to content

create_platform_application

Operation

create_platform_application

create_platform_application(request: CreatePlatformApplicationInput | CreatePlatformApplicationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreatePlatformApplicationInputDict]) -> CreatePlatformApplicationOutput

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.

Parameters:

Name Type Description Default
request CreatePlatformApplicationInput | CreatePlatformApplicationInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[CreatePlatformApplicationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreatePlatformApplicationOutput

An instance of CreatePlatformApplicationOutput.

create_platform_application async

create_platform_application(request: CreatePlatformApplicationInput | CreatePlatformApplicationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreatePlatformApplicationInputDict]) -> CreatePlatformApplicationOutput

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.

Parameters:

Name Type Description Default
request CreatePlatformApplicationInput | CreatePlatformApplicationInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[CreatePlatformApplicationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreatePlatformApplicationOutput

An instance of CreatePlatformApplicationOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

CreatePlatformApplicationInputDict

Bases: TypedDict

Dictionary form of CreatePlatformApplicationInput.

Attributes

attributes instance-attribute
attributes: Required[Mapping[str, str]]

For a list of attributes, see SetPlatformApplicationAttributes .

name instance-attribute
name: Required[str]

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 instance-attribute
platform: Required[str]

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

CreatePlatformApplicationInput dataclass

Bases: _SerdeShape

Input for CreatePlatformApplication action.

Attributes

attributes class-attribute instance-attribute
attributes: dict[str, str] | None = ...

For a list of attributes, see SetPlatformApplicationAttributes .

name class-attribute instance-attribute
name: str | None = ...

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 class-attribute instance-attribute
platform: str | None = ...

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

Output

CreatePlatformApplicationOutput dataclass

Bases: _SerdeShape

Response from CreatePlatformApplication action.

Attributes

platform_application_arn class-attribute instance-attribute
platform_application_arn: str | None = ...

PlatformApplicationArn is returned.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.