Class: Aws::SQS::Types::MessageAttributeValue

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

Overview

Note:

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

Instance Attribute Details

#binary_list_valuesArray<String>

Not implemented. Reserved for future use.

Returns:

  • (Array<String>)

1300
1301
1302
1303
1304
1305
1306
1307
1308
# File 'lib/aws-sdk-sqs/types.rb', line 1300

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

#binary_valueString

Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.

Returns:

  • (String)

1300
1301
1302
1303
1304
1305
1306
1307
1308
# File 'lib/aws-sdk-sqs/types.rb', line 1300

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

#data_typeString

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 SQS Developer Guide*.

[1]: docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes

Returns:

  • (String)

1300
1301
1302
1303
1304
1305
1306
1307
1308
# File 'lib/aws-sdk-sqs/types.rb', line 1300

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

#string_list_valuesArray<String>

Not implemented. Reserved for future use.

Returns:

  • (Array<String>)

1300
1301
1302
1303
1304
1305
1306
1307
1308
# File 'lib/aws-sdk-sqs/types.rb', line 1300

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

#string_valueString

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

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

Returns:

  • (String)

1300
1301
1302
1303
1304
1305
1306
1307
1308
# File 'lib/aws-sdk-sqs/types.rb', line 1300

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