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

Inherits:

Struct

• Object
• Struct
• Aws::SQS::Types::Message

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-sqs/types.rb

Overview

An Amazon SQS message.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #attributes ⇒ Hash<String,String>

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

• #body ⇒ String

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

• #md5_of_body ⇒ String

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

• #md5_of_message_attributes ⇒ String

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

• #message_attributes ⇒ Hash<String,Types::MessageAttributeValue>

  Each message attribute consists of a ‘Name`, `Type`, and `Value`.

• #message_id ⇒ String

  A unique identifier for the message.

• #receipt_handle ⇒ String

  An identifier associated with the act of receiving the message.

Instance Attribute Details

#attributes ⇒ Hash<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>)

# File 'lib/aws-sdk-sqs/types.rb', line 1425

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

#body ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-sqs/types.rb', line 1425

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_body ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-sqs/types.rb', line 1425

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_attributes ⇒ String

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)

# File 'lib/aws-sdk-sqs/types.rb', line 1425

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_attributes ⇒ Hash<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:

• (Hash<String,Types::MessageAttributeValue>)

# File 'lib/aws-sdk-sqs/types.rb', line 1425

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_id ⇒ String

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)

# File 'lib/aws-sdk-sqs/types.rb', line 1425

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_handle ⇒ String

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)

# File 'lib/aws-sdk-sqs/types.rb', line 1425

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