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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-sqs/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).

Instance Attribute Summary collapse

Instance Attribute Details

#binary_list_valuesArray<String>

Not implemented. Reserved for future use.

Returns:

  • (Array<String>)


1018
1019
1020
1021
1022
1023
1024
1025
# File 'gems/aws-sdk-sqs/lib/aws-sdk-sqs/types.rb', line 1018

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

#binary_valueString

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

Returns:

  • (String)


1018
1019
1020
1021
1022
1023
1024
1025
# File 'gems/aws-sdk-sqs/lib/aws-sdk-sqs/types.rb', line 1018

class MessageAttributeValue < Struct.new(
  :string_value,
  :binary_value,
  :string_list_values,
  :binary_list_values,
  :data_type)
  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 Message Attribute Data Types and Validation in the Amazon Simple Queue Service Developer Guide.

Returns:

  • (String)


1018
1019
1020
1021
1022
1023
1024
1025
# File 'gems/aws-sdk-sqs/lib/aws-sdk-sqs/types.rb', line 1018

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

#string_list_valuesArray<String>

Not implemented. Reserved for future use.

Returns:

  • (Array<String>)


1018
1019
1020
1021
1022
1023
1024
1025
# File 'gems/aws-sdk-sqs/lib/aws-sdk-sqs/types.rb', line 1018

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

#string_valueString

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

Returns:

  • (String)


1018
1019
1020
1021
1022
1023
1024
1025
# File 'gems/aws-sdk-sqs/lib/aws-sdk-sqs/types.rb', line 1018

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