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

Class: Aws::SNS::PlatformEndpoint

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

Defined Under Namespace

Classes: Collection

Actions collapse

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

#initialize(arn, options = {}) ⇒ PlatformEndpoint #initialize(options = {}) ⇒ PlatformEndpoint

Returns a new instance of PlatformEndpoint

Overloads:

  • #initialize(arn, options = {}) ⇒ PlatformEndpoint

    Parameters:

    • arn (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ PlatformEndpoint

    Options Hash (options):

    • :arn (required, String)
    • :client (Client)


19
20
21
22
23
24
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/platform_endpoint.rb', line 19

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @arn = extract_arn(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
end

Instance Method Details

#arnString

Returns:

  • (String)


29
30
31
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/platform_endpoint.rb', line 29

def arn
  @arn
end

#attributesHash<String,String>

Attributes include the following:

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

  • Enabled -- flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.

  • Token -- device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.

Returns:

  • (Hash<String,String>)


49
50
51
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/platform_endpoint.rb', line 49

def attributes
  data[:attributes]
end

#clientClient

Returns:



56
57
58
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/platform_endpoint.rb', line 56

def client
  @client
end

#dataTypes::GetEndpointAttributesResponse

Returns the data for this Aws::SNS::PlatformEndpoint. Calls Client#get_endpoint_attributes if #data_loaded? is false.



76
77
78
79
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/platform_endpoint.rb', line 76

def data
  load unless @data
  @data
end

#data_loaded?Boolean

Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.

Returns:

  • (Boolean)

    Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.



84
85
86
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/platform_endpoint.rb', line 84

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


platform_endpoint.delete()

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Returns:

  • (EmptyStructure)


95
96
97
98
99
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/platform_endpoint.rb', line 95

def delete(options = {})
  options = options.merge(endpoint_arn: @arn)
  resp = @client.delete_endpoint(options)
  resp.data
end

#loadself Also known as: reload

Loads, or reloads #data for the current Aws::SNS::PlatformEndpoint. Returns self making it possible to chain methods.

platform_endpoint.reload.data

Returns:

  • (self)


66
67
68
69
70
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/platform_endpoint.rb', line 66

def load
  resp = @client.get_endpoint_attributes(endpoint_arn: @arn)
  @data = resp.data
  self
end

#publish(options = {}) ⇒ Types::PublishResponse

Examples:

Request syntax with placeholder values


platform_endpoint.publish({
  topic_arn: "topicARN",
  phone_number: "String",
  message: "message", # required
  subject: "subject",
  message_structure: "messageStructure",
  message_attributes: {
    "String" => {
      data_type: "String", # required
      string_value: "String",
      binary_value: "data",
    },
  },
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

  • :topic_arn (String)

    The topic you want to publish to.

    If you don't specify a value for the TopicArn parameter, you must specify a value for the PhoneNumber or TargetArn parameters.

  • :phone_number (String)

    The phone number to which you want to deliver an SMS message. Use E.164 format.

    If you don't specify a value for the PhoneNumber parameter, you must specify a value for the TargetArn or TopicArn parameters.

  • :message (required, String)

    The message you want to send.

    If you are publishing to a topic and you want to send the same message to all transport protocols, include the text of the message as a String value. If you want to send different messages for each transport protocol, set the value of the MessageStructure parameter to json and use a JSON object for the Message parameter.

    Constraints:

    • With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262144 bytes, not 262144 characters).

    • For SMS, each message can contain up to 140 bytes, and the character limit depends on the encoding scheme. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters. If you publish a message that exceeds the size limit, Amazon SNS sends it as multiple messages, each fitting within the size limit. Messages are not cut off in the middle of a word but on whole-word boundaries. The total size limit for a single SMS publish action is 1600 bytes.

    JSON-specific constraints:

    • Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.

    • The values will be parsed (unescaped) before they are used in outgoing messages.

    • Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).

    • Values have a minimum length of 0 (the empty string, "", is allowed).

    • Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).

    • Non-string values will cause the key to be ignored.

    • Keys that do not correspond to supported transport protocols are ignored.

    • Duplicate keys are not allowed.

    • Failure to parse or validate any key or value in the message will cause the Publish call to return an error (no partial delivery).

  • :subject (String)

    Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints.

    Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.

  • :message_structure (String)

    Set MessageStructure to json if you want to send a different message for each protocol. For example, using one publish action, you can send a short message to your SMS subscribers and a longer message to your email subscribers. If you set MessageStructure to json, the value of the Message parameter must:

    • be a syntactically valid JSON object; and

    • contain at least a top-level JSON key of "default" with a value that is a string.

    You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g., "http").

    For information about sending different messages for each protocol using the AWS Management Console, go to Create Different Messages for Each Protocol in the Amazon Simple Notification Service Getting Started Guide.

    Valid value: json

  • :message_attributes (Hash<String,Types::MessageAttributeValue>)

    Message attributes for Publish action.

Returns:



216
217
218
219
220
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/platform_endpoint.rb', line 216

def publish(options = {})
  options = options.merge(target_arn: @arn)
  resp = @client.publish(options)
  resp.data
end

#set_attributes(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


platform_endpoint.set_attributes({
  attributes: { # required
    "String" => "String",
  },
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

  • :attributes (required, Hash<String,String>)

    A map of the endpoint attributes. Attributes in this map include the following:

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

    • Enabled -- flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.

    • Token -- device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.

Returns:

  • (EmptyStructure)


248
249
250
251
252
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/platform_endpoint.rb', line 248

def set_attributes(options = {})
  options = options.merge(endpoint_arn: @arn)
  resp = @client.set_endpoint_attributes(options)
  resp.data
end