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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-sns/lib/aws-sdk-sns/types.rb

Overview

Note:

When making an API call, you may pass CreatePlatformEndpointInput data as a hash:

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

Input for CreatePlatformEndpoint action.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#attributesHash<String,String>

For a list of attributes, see SetEndpointAttributes.

Returns:

  • (Hash<String,String>)


289
290
291
292
293
294
295
296
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/types.rb', line 289

class CreatePlatformEndpointInput < Struct.new(
  :platform_application_arn,
  :token,
  :custom_user_data,
  :attributes)
  SENSITIVE = []
  include Aws::Structure
end

#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)


289
290
291
292
293
294
295
296
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/types.rb', line 289

class CreatePlatformEndpointInput < Struct.new(
  :platform_application_arn,
  :token,
  :custom_user_data,
  :attributes)
  SENSITIVE = []
  include Aws::Structure
end

#platform_application_arnString

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

Returns:

  • (String)


289
290
291
292
293
294
295
296
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/types.rb', line 289

class CreatePlatformEndpointInput < Struct.new(
  :platform_application_arn,
  :token,
  :custom_user_data,
  :attributes)
  SENSITIVE = []
  include Aws::Structure
end

#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 (Firebase Cloud Messaging) or ADM, the device token equivalent is called the registration ID.

Returns:

  • (String)


289
290
291
292
293
294
295
296
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/types.rb', line 289

class CreatePlatformEndpointInput < Struct.new(
  :platform_application_arn,
  :token,
  :custom_user_data,
  :attributes)
  SENSITIVE = []
  include Aws::Structure
end