You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::SNS::Types::CreatePlatformEndpointInput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreatePlatformEndpointInput as input to an Aws::Client method, you can use a vanilla Hash:

{
  platform_application_arn: "String", # required
  token: "String", # required
  custom_user_data: "String",
  attributes: {
    "String" => "String",
  },
}

Input for CreatePlatformEndpoint action.

Instance Attribute Summary collapse

Instance Attribute Details

#attributesHash<String,String>

For a list of attributes, see SetEndpointAttributes.

Returns:

  • (Hash<String,String>)

    For a list of attributes, see [SetEndpointAttributes][1].

#custom_user_dataString

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.

Returns:

  • (String)

    Arbitrary user data to associate with the endpoint.

#platform_application_arnString

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

Returns:

  • (String)

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

#tokenString

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.

Returns:

  • (String)

    Unique identifier created by the notification service for an app on a device.