Skip to content

CreatePlatformEndpointInput

Source code in docs_src/capo_sns/types/create_platform_endpoint_input.py
class CreatePlatformEndpointInput(TypedDict, closed=True):
    platform_application_arn: "capo_sns.types.string.String"
    """<p> <code>PlatformApplicationArn</code> returned from CreatePlatformApplication is used to create a an endpoint.</p>"""
    token: "capo_sns.types.string.String"
    """<p>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.</p>"""
    custom_user_data: NotRequired["capo_sns.types.string.String"]
    """<p>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.</p>"""
    attributes: NotRequired["capo_sns.types.map_string_to_string.MapStringToString"]
    """<p>For a list of attributes, see <a href="https://docs.aws.amazon.com/sns/latest/api/API_SetEndpointAttributes.html"> <code>SetEndpointAttributes</code> </a>.</p>"""

attributes instance-attribute

attributes: NotRequired[MapStringToString]

For a list of attributes, see SetEndpointAttributes .

custom_user_data instance-attribute

custom_user_data: NotRequired[String]

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.

platform_application_arn instance-attribute

platform_application_arn: String

PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.

token instance-attribute

token: String

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.