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

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

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#binary_list_values ⇒ Array<String>

Not implemented. Reserved for future use.

Returns:

  • (Array<String>) 


1371
1372
1373
1374
1375
1376
1377
1378
1379
 
# File 'lib/aws-sdk-sqs/types.rb', line 1371

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

Returns:

  • (String) 


1371
1372
1373
1374
1375
1376
1377
1378
1379
 
# File 'lib/aws-sdk-sqs/types.rb', line 1371

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

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

Returns:

  • (String) 


1371
1372
1373
1374
1375
1376
1377
1378
1379
 
# File 'lib/aws-sdk-sqs/types.rb', line 1371

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

Returns:

  • (Array<String>) 


1371
1372
1373
1374
1375
1376
1377
1378
1379
 
# File 'lib/aws-sdk-sqs/types.rb', line 1371

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

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

Returns:

  • (String) 


1371
1372
1373
1374
1375
1376
1377
1378
1379
 
# File 'lib/aws-sdk-sqs/types.rb', line 1371

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