Class: Aws::SNS::Types::PublishInput

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

Overview

Note:

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

{
  topic_arn: "topicARN",
  target_arn: "String",
  phone_number: "String",
  message: "message", # required
  subject: "subject",
  message_structure: "messageStructure",
  message_attributes: {
    "String" => {
      data_type: "String", # required
      string_value: "String",
      binary_value: "data",
    },
  },
}

Input for Publish action.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#message ⇒ String

The message you want to send.

The ‘Message` parameter is always a string. If you set `MessageStructure` to `json`, you must string-encode the `Message` parameter.

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

Returns:

  • (String) 


1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
 
# File 'lib/aws-sdk-sns/types.rb', line 1160

class PublishInput < Struct.new(
  :topic_arn,
  :target_arn,
  :phone_number,
  :message,
  :subject,
  :message_structure,
  :message_attributes)
  include Aws::Structure
end

#message_attributes ⇒ Hash<String,Types::MessageAttributeValue>

Message attributes for Publish action.

Returns:



1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
 
# File 'lib/aws-sdk-sns/types.rb', line 1160

class PublishInput < Struct.new(
  :topic_arn,
  :target_arn,
  :phone_number,
  :message,
  :subject,
  :message_structure,
  :message_attributes)
  include Aws::Structure
end

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

[1]: docs.aws.amazon.com/sns/latest/gsg/Publish.html#sns-message-formatting-by-protocol

Returns:

  • (String) 


1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
 
# File 'lib/aws-sdk-sns/types.rb', line 1160

class PublishInput < Struct.new(
  :topic_arn,
  :target_arn,
  :phone_number,
  :message,
  :subject,
  :message_structure,
  :message_attributes)
  include Aws::Structure
end

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

Returns:

  • (String) 


1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
 
# File 'lib/aws-sdk-sns/types.rb', line 1160

class PublishInput < Struct.new(
  :topic_arn,
  :target_arn,
  :phone_number,
  :message,
  :subject,
  :message_structure,
  :message_attributes)
  include Aws::Structure
end

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

Returns:

  • (String) 


1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
 
# File 'lib/aws-sdk-sns/types.rb', line 1160

class PublishInput < Struct.new(
  :topic_arn,
  :target_arn,
  :phone_number,
  :message,
  :subject,
  :message_structure,
  :message_attributes)
  include Aws::Structure
end

#target_arn ⇒ String

Either TopicArn or EndpointArn, but not both.

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

Returns:

  • (String) 


1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
 
# File 'lib/aws-sdk-sns/types.rb', line 1160

class PublishInput < Struct.new(
  :topic_arn,
  :target_arn,
  :phone_number,
  :message,
  :subject,
  :message_structure,
  :message_attributes)
  include Aws::Structure
end

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

Returns:

  • (String) 


1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
 
# File 'lib/aws-sdk-sns/types.rb', line 1160

class PublishInput < Struct.new(
  :topic_arn,
  :target_arn,
  :phone_number,
  :message,
  :subject,
  :message_structure,
  :message_attributes)
  include Aws::Structure
end