Class: Aws::SQS::Types::MessageAttributeValue
- Inherits:
-
Struct
- Object
- Struct
- Aws::SQS::Types::MessageAttributeValue
- Defined in:
- gems/aws-sdk-sqs/lib/aws-sdk-sqs/types.rb
Overview
When making an API call, you may pass MessageAttributeValue data as a hash:
{
string_value: "String",
binary_value: "data",
string_list_values: ["String"],
binary_list_values: ["data"],
data_type: "String", # required
}
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 SendMessage.
Name
, type
, value
and the message body must not be empty or
null. All parts of the message attribute, including Name
, Type
,
and Value
, are part of the message size restriction (256 KB or
262,144 bytes).
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#binary_list_values ⇒ Array<String>
Not implemented.
-
#binary_value ⇒ String
Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.
-
#data_type ⇒ String
Amazon SQS supports the following logical data types:
String
,Number
, andBinary
. -
#string_list_values ⇒ Array<String>
Not implemented.
-
#string_value ⇒ String
Strings are Unicode with UTF-8 binary encoding.
Instance Attribute Details
#binary_list_values ⇒ Array<String>
Not implemented. Reserved for future use.
1275 1276 1277 1278 1279 1280 1281 1282 1283 |
# File 'gems/aws-sdk-sqs/lib/aws-sdk-sqs/types.rb', line 1275 class MessageAttributeValue < Struct.new( :string_value, :binary_value, :string_list_values, :binary_list_values, :data_type) SENSITIVE = [] include Aws::Structure end |
#binary_value ⇒ String
Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.
1275 1276 1277 1278 1279 1280 1281 1282 1283 |
# File 'gems/aws-sdk-sqs/lib/aws-sdk-sqs/types.rb', line 1275 class MessageAttributeValue < Struct.new( :string_value, :binary_value, :string_list_values, :binary_list_values, :data_type) SENSITIVE = [] include Aws::Structure end |
#data_type ⇒ String
Amazon SQS supports the following logical data types: String
,
Number
, and Binary
. For the Number
data type, you must use
StringValue
.
You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon Simple Queue Service Developer Guide.
1275 1276 1277 1278 1279 1280 1281 1282 1283 |
# File 'gems/aws-sdk-sqs/lib/aws-sdk-sqs/types.rb', line 1275 class MessageAttributeValue < Struct.new( :string_value, :binary_value, :string_list_values, :binary_list_values, :data_type) SENSITIVE = [] include Aws::Structure end |
#string_list_values ⇒ Array<String>
Not implemented. Reserved for future use.
1275 1276 1277 1278 1279 1280 1281 1282 1283 |
# File 'gems/aws-sdk-sqs/lib/aws-sdk-sqs/types.rb', line 1275 class MessageAttributeValue < Struct.new( :string_value, :binary_value, :string_list_values, :binary_list_values, :data_type) SENSITIVE = [] include Aws::Structure end |
#string_value ⇒ String
Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters.
1275 1276 1277 1278 1279 1280 1281 1282 1283 |
# File 'gems/aws-sdk-sqs/lib/aws-sdk-sqs/types.rb', line 1275 class MessageAttributeValue < Struct.new( :string_value, :binary_value, :string_list_values, :binary_list_values, :data_type) SENSITIVE = [] include Aws::Structure end |