Class: Aws::SNS::Types::MessageAttributeValue

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

Overview

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 [Amazon SNS message attributes] and

Publishing to a mobile phone][3

in the *Amazon SNS Developer Guide.*

[1]: docs.aws.amazon.com/sns/latest/api/API_Publish.html [2]: docs.aws.amazon.com/sns/latest/dg/SNSMessageAttributes.html [3]: docs.aws.amazon.com/sns/latest/dg/sms_publish-to-phone.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#binary_value ⇒ String

Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.

Returns:

  • (String) 


1532
1533
1534
1535
1536
1537
1538
 
# File 'lib/aws-sdk-sns/types.rb', line 1532

class MessageAttributeValue < Struct.new(
  :data_type,
  :string_value,
  :binary_value)
  SENSITIVE = []
  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

Returns:

  • (String) 


1532
1533
1534
1535
1536
1537
1538
 
# File 'lib/aws-sdk-sns/types.rb', line 1532

class MessageAttributeValue < Struct.new(
  :data_type,
  :string_value,
  :binary_value)
  SENSITIVE = []
  include Aws::Structure
end

#string_value ⇒ String

Strings are Unicode with UTF8 binary encoding. For a list of code values, see [ASCII Printable Characters].

[1]: en.wikipedia.org/wiki/ASCII#ASCII_printable_characters

Returns:

  • (String) 


1532
1533
1534
1535
1536
1537
1538
 
# File 'lib/aws-sdk-sns/types.rb', line 1532

class MessageAttributeValue < Struct.new(
  :data_type,
  :string_value,
  :binary_value)
  SENSITIVE = []
  include Aws::Structure
end