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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

An Amazon SQS message.

See Also:

Instance Attribute Summary collapse

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.

Returns:

  • (Hash<String,String>) —

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

#body ⇒ String

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

Returns:

  • (String) —

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

#md5_of_body ⇒ String

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

Returns:

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

Returns:

  • (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. For more information, see Amazon SQS Message Attributes in the Amazon Simple Queue Service Developer Guide.

Returns:

#message_id ⇒ String

A unique identifier for the message. A MessageIdis considered unique across all AWS accounts for an extended period of time.

Returns:

  • (String) —

    A unique identifier for the message.

#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) —

    An identifier associated with the act of receiving the message.