SNS / Client / create_platform_endpoint

create_platform_endpoint#

SNS.Client.create_platform_endpoint(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.create_platform_endpoint(
    PlatformApplicationArn='string',
    Token='string',
    CustomUserData='string',
    Attributes={
        'string': 'string'
    }
)
Parameters:

  • PlatformApplicationArn (string) –

    [REQUIRED]

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

  • Token (string) –

    [REQUIRED]

    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.

  • CustomUserData (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.

  • Attributes (dict) –

    For a list of attributes, see SetEndpointAttributes.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'EndpointArn': 'string'
}

Response Structure

  • (dict) –

    Response from CreateEndpoint action.

    • EndpointArn (string) –

      EndpointArn returned from CreateEndpoint action.

Exceptions

  • SNS.Client.exceptions.InvalidParameterException

  • SNS.Client.exceptions.InternalErrorException

  • SNS.Client.exceptions.AuthorizationErrorException

  • SNS.Client.exceptions.NotFoundException