class Aws::SNS::PlatformEndpoint

Public Class Methods

new(*args) click to toggle source

@overload def initialize(arn, options = {})

@param [String] arn
@option options [Client] :client

@overload def initialize(options = {})

@option options [required, String] :arn
@option options [Client] :client
# File lib/aws-sdk-sns/platform_endpoint.rb, line 22
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)
  @waiter_block_warned = false
end

Public Instance Methods

arn() click to toggle source

@return [String]

# File lib/aws-sdk-sns/platform_endpoint.rb, line 33
def arn
  @arn
end
attributes() click to toggle source

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.

    <note markdown=“1”> The device token for the iOS platform is returned in lowercase.

    </note>

@return [Hash<String,String>]

# File lib/aws-sdk-sns/platform_endpoint.rb, line 57
def attributes
  data[:attributes]
end
client() click to toggle source

@return [Client]

# File lib/aws-sdk-sns/platform_endpoint.rb, line 64
def client
  @client
end
data() click to toggle source

@return [Types::GetEndpointAttributesResponse]

Returns the data for this {PlatformEndpoint}. Calls
{Client#get_endpoint_attributes} if {#data_loaded?} is `false`.
# File lib/aws-sdk-sns/platform_endpoint.rb, line 84
def data
  load unless @data
  @data
end
data_loaded?() click to toggle source

@return [Boolean]

Returns `true` if this resource is loaded.  Accessing attributes or
{#data} on an unloaded resource will trigger a call to {#load}.
# File lib/aws-sdk-sns/platform_endpoint.rb, line 92
def data_loaded?
  !!@data
end
delete(options = {}) click to toggle source

@example Request syntax with placeholder values

platform_endpoint.delete()

@param [Hash] options ({}) @return [EmptyStructure]

# File lib/aws-sdk-sns/platform_endpoint.rb, line 103
def delete(options = {})
  options = options.merge(endpoint_arn: @arn)
  resp = @client.delete_endpoint(options)
  resp.data
end
identifiers() click to toggle source

@deprecated @api private

# File lib/aws-sdk-sns/platform_endpoint.rb, line 286
def identifiers
  { arn: @arn }
end
load() click to toggle source

Loads, or reloads {#data} for the current {PlatformEndpoint}. Returns `self` making it possible to chain methods.

platform_endpoint.reload.data

@return [self]

# File lib/aws-sdk-sns/platform_endpoint.rb, line 74
def load
  resp = @client.get_endpoint_attributes(endpoint_arn: @arn)
  @data = resp.data
  self
end
Also aliased as: reload
publish(options = {}) click to toggle source

@example 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",
    },
  },
  message_deduplication_id: "String",
  message_group_id: "String",
})

@param [Hash] options ({}) @option options [String] :topic_arn

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.

@option options [String] :phone_number

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.

@option options [required, String] :message

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 (262,144 bytes, not 262,144 characters).

* For SMS, each message can contain up to 140 characters. This
  character limit depends on the encoding schema. 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 this size limit, Amazon SNS
  sends the message as multiple messages, each fitting within the size
  limit. Messages aren't truncated mid-word but are cut off at
  whole-word boundaries.

  The total size limit for a single SMS `Publish` action is 1,600
  characters.

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

@option options [String] :subject

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.

@option options [String] :message_structure

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").

Valid value: `json`

@option options [Hash<String,Types::MessageAttributeValue>] :message_attributes

Message attributes for Publish action.

@option options [String] :message_deduplication_id

This parameter applies only to FIFO (first-in-first-out) topics. The
`MessageDeduplicationId` can contain up to 128 alphanumeric characters
(a-z, A-Z, 0-9) and punctuation ``
(!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~) ``.

Every message must have a unique `MessageDeduplicationId`, which is a
token used for deduplication of sent messages. If a message with a
particular `MessageDeduplicationId` is sent successfully, any message
sent with the same `MessageDeduplicationId` during the 5-minute
deduplication interval is treated as a duplicate.

If the topic has `ContentBasedDeduplication` set, the system generates
a `MessageDeduplicationId` based on the contents of the message. Your
`MessageDeduplicationId` overrides the generated one.

@option options [String] :message_group_id

This parameter applies only to FIFO (first-in-first-out) topics. The
`MessageGroupId` can contain up to 128 alphanumeric characters (a-z,
A-Z, 0-9) and punctuation `` (!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~) ``.

The `MessageGroupId` is a tag that specifies that a message belongs to
a specific message group. Messages that belong to the same message
group are processed in a FIFO manner (however, messages in different
message groups might be processed out of order). Every message must
include a `MessageGroupId`.

@return [Types::PublishResponse]

# File lib/aws-sdk-sns/platform_endpoint.rb, line 246
def publish(options = {})
  options = options.merge(target_arn: @arn)
  resp = @client.publish(options)
  resp.data
end
reload()
Alias for: load
set_attributes(options = {}) click to toggle source

@example Request syntax with placeholder values

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

@param [Hash] options ({}) @option options [required, Hash<String,String>] :attributes

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.

@return [EmptyStructure]

# File lib/aws-sdk-sns/platform_endpoint.rb, line 278
def set_attributes(options = {})
  options = options.merge(endpoint_arn: @arn)
  resp = @client.set_endpoint_attributes(options)
  resp.data
end

Private Instance Methods

extract_arn(args, options) click to toggle source
# File lib/aws-sdk-sns/platform_endpoint.rb, line 293
def extract_arn(args, options)
  value = args[0] || options.delete(:arn)
  case value
  when String then value
  when nil then raise ArgumentError, "missing required option :arn"
  else
    msg = "expected :arn to be a String, got #{value.class}"
    raise ArgumentError, msg
  end
end