AWS SDK Version 2 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

.NET Framework 4.5
 
Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM and APNS. CreatePlatformEndpoint requires the PlatformApplicationArn that is returned from CreatePlatformApplication. The EndpointArn that is returned when using CreatePlatformEndpoint can then be used by the Publish action 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.

Namespace: Amazon.SimpleNotificationService
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C#
public abstract CreatePlatformEndpointResponse CreatePlatformEndpoint(
         CreatePlatformEndpointRequest request
)

Parameters

request
Type: Amazon.SimpleNotificationService.Model.CreatePlatformEndpointRequest

Container for the necessary parameters to execute the CreatePlatformEndpoint service method.

Return Value
Type: Amazon.SimpleNotificationService.Model.CreatePlatformEndpointResponse
The response from the CreatePlatformEndpoint service method, as returned by SimpleNotificationService.

Exceptions

ExceptionCondition
AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
InternalErrorException Indicates an internal service error.
InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
NotFoundException Indicates that the requested resource does not exist.

Examples

This example shows how to create a mobile push application endpoint.

Create mobile push application endpoint example

var snsClient = new AmazonSimpleNotificationServiceClient();

var request = new CreatePlatformEndpointRequest
{
  CustomUserData = "Any arbitrary data can go here",
  PlatformApplicationArn = "arn:aws:sns:us-east-1:80398EXAMPLE:" +
    "app/GCM/TimeCardProcessingApplication",
  Token = "APBTKzPGlCyT6E6oOfpdwLpcRNxQp5vCPFiF" +
    "eru9oZylc22HvZSwQTDgmmw9WdNlXMerUPEXAMPLE"
};

snsClient.CreatePlatformEndpoint(request);
      

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5