AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::SQS::Types::MessageSystemAttributeValue

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 MessageSystemAttributeValue 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 system 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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#binary_list_valuesArray<String>

Not implemented. Reserved for future use.

Returns:

  • (Array<String>)


1247
1248
1249
1250
1251
1252
1253
1254
1255
# File 'gems/aws-sdk-sqs/lib/aws-sdk-sqs/types.rb', line 1247

class MessageSystemAttributeValue < 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)


1247
1248
1249
1250
1251
1252
1253
1254
1255
# File 'gems/aws-sdk-sqs/lib/aws-sdk-sqs/types.rb', line 1247

class MessageSystemAttributeValue < 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 Simple Queue Service Developer Guide.

Returns:

  • (String)


1247
1248
1249
1250
1251
1252
1253
1254
1255
# File 'gems/aws-sdk-sqs/lib/aws-sdk-sqs/types.rb', line 1247

class MessageSystemAttributeValue < 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>)


1247
1248
1249
1250
1251
1252
1253
1254
1255
# File 'gems/aws-sdk-sqs/lib/aws-sdk-sqs/types.rb', line 1247

class MessageSystemAttributeValue < 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.

Returns:

  • (String)


1247
1248
1249
1250
1251
1252
1253
1254
1255
# File 'gems/aws-sdk-sqs/lib/aws-sdk-sqs/types.rb', line 1247

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