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
 
 
Container for the parameters to the CreatePlatformEndpoint operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceRequest
      Amazon.SimpleNotificationService.Model.CreatePlatformEndpointRequest

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

Syntax

C# 
public class CreatePlatformEndpointRequest : AmazonSimpleNotificationServiceRequest
         IRequestEvents

The CreatePlatformEndpointRequest type exposes the following members

Constructors

NameDescription
Public Method CreatePlatformEndpointRequest()

Properties

NameTypeDescription
Public Property Attributes System.Collections.Generic.Dictionary<System.String, System.String> Gets and sets the property Attributes.

For a list of attributes, see SetEndpointAttributes.

Public Property CustomUserData System.String Gets and sets the property CustomUserData.

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.

Public Property PlatformApplicationArn System.String Gets and sets the property PlatformApplicationArn.

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

Public Property Token System.String Gets and sets the property Token.

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 or ADM, the device token equivalent is called the registration ID.

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

.NET for Windows Store apps:
Supported in: Windows 8.1, Windows 8

.NET for Windows Phone:
Supported in: Windows Phone 8.1, Windows Phone 8