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

Class: Aws::SNS::PlatformEndpoint

Inherits:

Resources::Resource

Object
Resources::Resource
Aws::SNS::PlatformEndpoint

show all

Defined in:: (unknown)

Instance Attribute Summary collapse

#arn ⇒ String readonly
#attributes ⇒ Hash<String,String> readonly
Attributes include the following:.

Attributes inherited from Resources::Resource

#client, #identifiers

Instance Method Summary collapse

#delete ⇒ Struct
Deletes the endpoint for a device and mobile app from Amazon SNS.
#initialize ⇒ Object constructor
#publish(options = {}) ⇒ Types::PublishResponse
Sends a message to an Amazon SNS topic, a text message (SMS message) directly to a phone number, or a message to a mobile platform endpoint (when you specify the TargetArn).

If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is subscribed to the topic.
#set_attributes(options = {}) ⇒ Struct
Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS.

Methods inherited from Resources::Resource

add_data_attribute, add_identifier, #data, data_attributes, #data_loaded?, identifiers, #load, #wait_until

Methods included from Resources::OperationMethods

#add_batch_operation, #add_operation, #batch_operation, #batch_operation_names, #batch_operations, #operation, #operation_names, #operations

Constructor Details

#initialize(arn, options = {}) ⇒ `Object` #initialize(options = {}) ⇒ `Object`

Overloads:

#initialize(arn, options = {}) ⇒ Object
Parameters:
- arn (String)
Options Hash (options):
- :client (Client) —
  When `:client is not given, the options hash is used to construct a new Client object.
#initialize(options = {}) ⇒ Object
Options Hash (options):
- :arn (required, String)
- :client (Client) —
  When `:client is not given, the options hash is used to construct a new Client object.

Instance Attribute Details

#arn ⇒ `String` (readonly)

Returns:

(String)

#attributes ⇒ `Hash<String,String>` (readonly)

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.

The device token for the iOS platform is returned in lowercase.

Returns:

(Hash<String,String>) —
Attributes include the following:.

Instance Method Details

#delete ⇒ `Struct`

Deletes the endpoint for a device and mobile app from Amazon SNS. This action is idempotent. For more information, see Using Amazon SNS Mobile Push Notifications.

When you delete an endpoint that is also subscribed to a topic, then you must also unsubscribe the endpoint from the topic.

Examples:

Request syntax example with placeholder values


platformendpoint.delete()

Returns:

(Struct) —
Returns an empty response.

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

Sends a message to an Amazon SNS topic, a text message (SMS message) directly to a phone number, or a message to a mobile platform endpoint (when you specify the TargetArn).

If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is subscribed to the topic. The format of the message depends on the notification protocol for each subscribed endpoint.

When a messageId is returned, the message has been saved and Amazon SNS will attempt to deliver it shortly.

To use the Publish action for sending a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, you must specify the EndpointArn for the TargetArn parameter. The EndpointArn is returned when making a call with the CreatePlatformEndpoint action.

For more information about formatting messages, see Send Custom Platform-Specific Payloads in Messages to Mobile Devices.

You can publish messages only to topics and endpoints in the same AWS Region.

Examples:

Request syntax example with placeholder values


platformendpoint.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",
})

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

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

(Types::PublishResponse) —
Returns a response object which responds to the following methods:
- #message_id => String
- #sequence_number => String

#set_attributes(options = {}) ⇒ `Struct`

Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.

Examples:

Request syntax example with placeholder values


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

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:

(Struct) —
Returns an empty response.

Class: Aws::SNS::PlatformEndpoint

Instance Attribute Summary collapse

Attributes inherited from Resources::Resource

Instance Method Summary collapse

Methods inherited from Resources::Resource

Methods included from Resources::OperationMethods

Constructor Details

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

Instance Attribute Details

#arn ⇒ String (readonly)

#attributes ⇒ Hash<String,String> (readonly)

Instance Method Details

#delete ⇒ Struct

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

#set_attributes(options = {}) ⇒ Struct

#initialize(arn, options = {}) ⇒ `Object` #initialize(options = {}) ⇒ `Object`

#arn ⇒ `String` (readonly)

#attributes ⇒ `Hash<String,String>` (readonly)

#delete ⇒ `Struct`

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

#set_attributes(options = {}) ⇒ `Struct`