You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing MessageAttributeValue as input to an Aws::Client method, you can use a vanilla 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).

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#binary_list_values ⇒ Array<String>

Not implemented. Reserved for future use.

Returns:

  • (Array<String>) —

    Not implemented.

#binary_value ⇒ String

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

Returns:

  • (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, 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.

Returns:

  • (String) —

    Amazon SQS supports the following logical data types: String, Number, and Binary.

#string_list_values ⇒ Array<String>

Not implemented. Reserved for future use.

Returns:

  • (Array<String>) —

    Not implemented.

#string_value ⇒ String

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

Returns:

  • (String) —

    Strings are Unicode with UTF-8 binary encoding.