create_platform_endpoint¶
Operation¶
async
¶
create_platform_endpoint(input: CreatePlatformEndpointInput, plugins: list[Plugin] | None = None) -> CreatePlatformEndpointOutput
Creates an endpoint for a device and mobile app on one of the supported
push notification services, such as GCM (Firebase Cloud Messaging) and
APNS. CreatePlatformEndpoint requires the PlatformApplicationArn
that is returned from CreatePlatformApplication. You can use the
returned EndpointArn to send a message to a mobile app or by the
Subscribe action for subscription to a topic. The
CreatePlatformEndpoint action is idempotent, so if the requester
already owns an endpoint with the same device token and attributes, that
endpoint's ARN is returned without creating a new endpoint. For more
information, see Using Amazon SNS Mobile Push
Notifications.
When using CreatePlatformEndpoint with Baidu, two attributes must be
provided: ChannelId and UserId. The token field must also contain the
ChannelId. For more information, see Creating an Amazon SNS Endpoint
for
Baidu.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreatePlatformEndpointInput
|
An instance of |
required |
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
|
Returns:
| Type | Description |
|---|---|
CreatePlatformEndpointOutput
|
An instance of |
Input¶
dataclass
¶
Input for CreatePlatformEndpoint action.
Attributes¶
class-attribute
instance-attribute
¶
attributes: dict[str, str] | None = None
For a list of attributes, see
SetEndpointAttributes
.
class-attribute
instance-attribute
¶
custom_user_data: str | None = None
Arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.
class-attribute
instance-attribute
¶
platform_application_arn: str | None = None
PlatformApplicationArn returned from CreatePlatformApplication is used
to create a an endpoint.
class-attribute
instance-attribute
¶
token: str | None = None
Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM (Firebase Cloud Messaging) or ADM, the device token equivalent is called the registration ID.