Class: Aws::SNS::Types::MessageAttributeValue
- Inherits:
-
Struct
- Object
- Struct
- Aws::SNS::Types::MessageAttributeValue
- Includes:
- Aws::Structure
- Defined in:
- lib/aws-sdk-sns/types.rb
Overview
When making an API call, you may pass MessageAttributeValue data as a hash:
{
data_type: "String", # required
string_value: "String",
binary_value: "data",
}
The user-specified message attribute value. For string data types, the value attribute has the same restrictions on the content as the message body. For more information, see [Publish].
Name, type, and value must not be empty or null. In addition, the message body should not be empty or null. All parts of the message attribute, including name, type, and value, are included in the message size restriction, which is currently 256 KB (262,144 bytes). For more information, see [Using Amazon SNS Message Attributes].
[1]: docs.aws.amazon.com/sns/latest/api/API_Publish.html [2]: docs.aws.amazon.com/sns/latest/dg/SNSMessageAttributes.html
Instance Attribute Summary collapse
-
#binary_value ⇒ String
Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.
-
#data_type ⇒ String
Amazon SNS supports the following logical data types: String, String.Array, Number, and Binary.
-
#string_value ⇒ String
Strings are Unicode with UTF8 binary encoding.
Instance Attribute Details
#binary_value ⇒ String
Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.
959 960 961 962 963 964 |
# File 'lib/aws-sdk-sns/types.rb', line 959 class MessageAttributeValue < Struct.new( :data_type, :string_value, :binary_value) include Aws::Structure end |
#data_type ⇒ String
Amazon SNS supports the following logical data types: String, String.Array, Number, and Binary. For more information, see [Message Attribute Data Types].
[1]: docs.aws.amazon.com/sns/latest/dg/SNSMessageAttributes.html#SNSMessageAttributes.DataTypes
959 960 961 962 963 964 |
# File 'lib/aws-sdk-sns/types.rb', line 959 class MessageAttributeValue < Struct.new( :data_type, :string_value, :binary_value) include Aws::Structure end |
#string_value ⇒ String
Strings are Unicode with UTF8 binary encoding. For a list of code values, see [en.wikipedia.org/wiki/ASCII#ASCII_printable_characters][1].
959 960 961 962 963 964 |
# File 'lib/aws-sdk-sns/types.rb', line 959 class MessageAttributeValue < Struct.new( :data_type, :string_value, :binary_value) include Aws::Structure end |