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

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

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

Overview

An Amazon SQS message.

Instance Attribute Summary collapse

Instance Attribute Details

#attributesHash<String,String>

SenderId, SentTimestamp, ApproximateReceiveCount, and/or ApproximateFirstReceiveTimestamp. SentTimestamp and ApproximateFirstReceiveTimestamp are each returned as an integer representing the epoch time in milliseconds.

Returns:

  • (Hash<String,String>)


916
917
918
919
920
921
922
923
924
925
# File 'gems/aws-sdk-sqs/lib/aws-sdk-sqs/types.rb', line 916

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

#bodyString

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

Returns:

  • (String)


916
917
918
919
920
921
922
923
924
925
# File 'gems/aws-sdk-sqs/lib/aws-sdk-sqs/types.rb', line 916

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

#md5_of_bodyString

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

Returns:

  • (String)


916
917
918
919
920
921
922
923
924
925
# File 'gems/aws-sdk-sqs/lib/aws-sdk-sqs/types.rb', line 916

class Message < Struct.new(
  :message_id,
  :receipt_handle,
  :md5_of_body,
  :body,
  :attributes,
  :md5_of_message_attributes,
  :message_attributes)
  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.

Returns:

  • (String)


916
917
918
919
920
921
922
923
924
925
# File 'gems/aws-sdk-sqs/lib/aws-sdk-sqs/types.rb', line 916

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

#message_attributesHash<String,Types::MessageAttributeValue>

Each message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items and Validation in the Amazon SQS Developer Guide.

Returns:



916
917
918
919
920
921
922
923
924
925
# File 'gems/aws-sdk-sqs/lib/aws-sdk-sqs/types.rb', line 916

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

#message_idString

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

Returns:

  • (String)


916
917
918
919
920
921
922
923
924
925
# File 'gems/aws-sdk-sqs/lib/aws-sdk-sqs/types.rb', line 916

class Message < Struct.new(
  :message_id,
  :receipt_handle,
  :md5_of_body,
  :body,
  :attributes,
  :md5_of_message_attributes,
  :message_attributes)
  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)


916
917
918
919
920
921
922
923
924
925
# File 'gems/aws-sdk-sqs/lib/aws-sdk-sqs/types.rb', line 916

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