Class: Aws::SNS::PlatformEndpoint

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

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

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


22
23
24
25
26
27
28
 
# 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

Instance Method Details

#arn ⇒ String

Returns:

  • (String) 


33
34
35
 
# File 'lib/aws-sdk-sns/platform_endpoint.rb', line 33

def arn
  @arn
end

#attributes ⇒ Hash<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.

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

    </note>

Returns:

  • (Hash<String,String>) 


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

def attributes
  data[:attributes]
end

#client ⇒ Client

Returns:



64
65
66
 
# File 'lib/aws-sdk-sns/platform_endpoint.rb', line 64

def client
  @client
end

#data ⇒ Types::GetEndpointAttributesResponse

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

Returns:



86
87
88
89
 
# File 'lib/aws-sdk-sns/platform_endpoint.rb', line 86

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.



94
95
96
 
# File 'lib/aws-sdk-sns/platform_endpoint.rb', line 94

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


platform_endpoint.delete()

Parameters:

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

    ({})

Returns:

  • (EmptyStructure) 


105
106
107
108
109
110
111
 
# File 'lib/aws-sdk-sns/platform_endpoint.rb', line 105

def delete(options = {})
  options = options.merge(endpoint_arn: @arn)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.delete_endpoint(options)
  end
  resp.data
end

#identifiers ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


323
324
325
 
# File 'lib/aws-sdk-sns/platform_endpoint.rb', line 323

def identifiers
  { arn: @arn }
end

#load ⇒ self 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) 


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

def load
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.get_endpoint_attributes(endpoint_arn: @arn)
  end
  @data = resp.data
  self
end

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

Examples:

Request syntax with placeholder values


platform_endpoint.publish({
  topic_arn: "topicARN",
  phone_number: "PhoneNumber",
  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",
})

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

  • :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 UTF-8 text with no line breaks or control characters, and 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”).

    Valid value: ‘json`

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

    Message attributes for Publish action.

  • :message_deduplication_id (String) —

    • 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 within the 5 minute minimum deduplication interval.

    • The scope of deduplication depends on the ‘FifoThroughputScope` attribute, when set to `Topic` the message deduplication scope is across the entire topic, when set to `MessageGroup` the message deduplication scope is within each individual message group.

    • If a message with a particular ‘MessageDeduplicationId` is sent successfully, subsequent messages within the deduplication scope and interval, with the same `MessageDeduplicationId`, are accepted successfully but aren’t delivered.

    • Every message must have a unique ‘MessageDeduplicationId`:

      • You may provide a ‘MessageDeduplicationId` explicitly.

      • If you aren’t able to provide a ‘MessageDeduplicationId` and you enable `ContentBasedDeduplication` for your topic, Amazon SNS uses a SHA-256 hash to generate the `MessageDeduplicationId` using the body of the message (but not the attributes of the message).

      • If you don’t provide a ‘MessageDeduplicationId` and the topic doesn’t have ‘ContentBasedDeduplication` set, the action fails with an error.

      • If the topic has a ‘ContentBasedDeduplication` set, your `MessageDeduplicationId` overrides the generated one.

    • When ‘ContentBasedDeduplication` is in effect, messages with identical content sent within the deduplication scope and interval are treated as duplicates and only one copy of the message is delivered.

    • If you send one message with ‘ContentBasedDeduplication` enabled, and then another message with a `MessageDeduplicationId` that is the same as the one generated for the first `MessageDeduplicationId`, the two messages are treated as duplicates, within the deduplication scope and interval, and only one copy of the message is delivered.

  • :message_group_id (String) —

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

Returns:



279
280
281
282
283
284
285
 
# File 'lib/aws-sdk-sns/platform_endpoint.rb', line 279

def publish(options = {})
  options = options.merge(target_arn: @arn)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.publish(options)
  end
  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) 


313
314
315
316
317
318
319
 
# File 'lib/aws-sdk-sns/platform_endpoint.rb', line 313

def set_attributes(options = {})
  options = options.merge(endpoint_arn: @arn)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.set_endpoint_attributes(options)
  end
  resp.data
end