Class: Aws::SQS::Types::Message

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

Overview

An Amazon SQS message.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#attributesHash<String,String>

A map of the attributes requested in ` ReceiveMessage ` to their respective values. Supported attributes:

  • `ApproximateReceiveCount`

  • `ApproximateFirstReceiveTimestamp`

  • `MessageDeduplicationId`

  • `MessageGroupId`

  • `SenderId`

  • `SentTimestamp`

  • `SequenceNumber`

`ApproximateFirstReceiveTimestamp` and `SentTimestamp` are each returned as an integer representing the [epoch time] in milliseconds.

[1]: en.wikipedia.org/wiki/Unix_time

Returns:

  • (Hash<String,String>)

1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
# File 'lib/aws-sdk-sqs/types.rb', line 1187

class Message < Struct.new(
  :message_id,
  :receipt_handle,
  :md5_of_body,
  :body,
  :attributes,
  :md5_of_message_attributes,
  :message_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#bodyString

The message's contents (not URL-encoded).

Returns:

  • (String)

1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
# File 'lib/aws-sdk-sqs/types.rb', line 1187

class Message < Struct.new(
  :message_id,
  :receipt_handle,
  :md5_of_body,
  :body,
  :attributes,
  :md5_of_message_attributes,
  :message_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#md5_of_bodyString

An MD5 digest of the non-URL-encoded message body string.

Returns:

  • (String)

1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
# File 'lib/aws-sdk-sqs/types.rb', line 1187

class Message < Struct.new(
  :message_id,
  :receipt_handle,
  :md5_of_body,
  :body,
  :attributes,
  :md5_of_message_attributes,
  :message_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#md5_of_message_attributesString

An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see [RFC1321].

[1]: www.ietf.org/rfc/rfc1321.txt

Returns:

  • (String)

1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
# File 'lib/aws-sdk-sqs/types.rb', line 1187

class Message < Struct.new(
  :message_id,
  :receipt_handle,
  :md5_of_body,
  :body,
  :attributes,
  :md5_of_message_attributes,
  :message_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#message_attributesHash<String,Types::MessageAttributeValue>

Each message attribute consists of a `Name`, `Type`, and `Value`. 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:


1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
# File 'lib/aws-sdk-sqs/types.rb', line 1187

class Message < Struct.new(
  :message_id,
  :receipt_handle,
  :md5_of_body,
  :body,
  :attributes,
  :md5_of_message_attributes,
  :message_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#message_idString

A unique identifier for the message. A `MessageId`is considered unique across all Amazon Web Services accounts for an extended period of time.

Returns:

  • (String)

1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
# File 'lib/aws-sdk-sqs/types.rb', line 1187

class Message < Struct.new(
  :message_id,
  :receipt_handle,
  :md5_of_body,
  :body,
  :attributes,
  :md5_of_message_attributes,
  :message_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#receipt_handleString

An identifier associated with the act of receiving the message. A new receipt handle is returned every time you receive a message. When deleting a message, you provide the last received receipt handle to delete the message.

Returns:

  • (String)

1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
# File 'lib/aws-sdk-sqs/types.rb', line 1187

class Message < Struct.new(
  :message_id,
  :receipt_handle,
  :md5_of_body,
  :body,
  :attributes,
  :md5_of_message_attributes,
  :message_attributes)
  SENSITIVE = []
  include Aws::Structure
end