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

Class: Aws::SQS::Types::SendMessageBatchRequestEntry

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

Overview

Note:

When making an API call, you may pass SendMessageBatchRequestEntry data as a hash:

{
  id: "String", # required
  message_body: "String", # required
  delay_seconds: 1,
  message_attributes: {
    "String" => {
      string_value: "String",
      binary_value: "data",
      string_list_values: ["String"],
      binary_list_values: ["data"],
      data_type: "String", # required
    },
  },
  message_deduplication_id: "String",
  message_group_id: "String",
}

Contains the details of a single Amazon SQS message along with an Id.

Instance Attribute Summary collapse

Instance Attribute Details

#delay_secondsInteger

The length of time, in seconds, for which a specific message is delayed. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value become available for processing after the delay period is finished. If you don't specify a value, the default value for the queue is applied.

When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.

Returns:

  • (Integer)


1453
1454
1455
1456
1457
1458
1459
1460
1461
# File 'gems/aws-sdk-sqs/lib/aws-sdk-sqs/types.rb', line 1453

class SendMessageBatchRequestEntry < Struct.new(
  :id,
  :message_body,
  :delay_seconds,
  :message_attributes,
  :message_deduplication_id,
  :message_group_id)
  include Aws::Structure
end

#idString

An identifier for a message in this batch used to communicate the result.

The Ids of a batch request need to be unique within a request

Returns:

  • (String)


1453
1454
1455
1456
1457
1458
1459
1460
1461
# File 'gems/aws-sdk-sqs/lib/aws-sdk-sqs/types.rb', line 1453

class SendMessageBatchRequestEntry < Struct.new(
  :id,
  :message_body,
  :delay_seconds,
  :message_attributes,
  :message_deduplication_id,
  :message_group_id)
  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:



1453
1454
1455
1456
1457
1458
1459
1460
1461
# File 'gems/aws-sdk-sqs/lib/aws-sdk-sqs/types.rb', line 1453

class SendMessageBatchRequestEntry < Struct.new(
  :id,
  :message_body,
  :delay_seconds,
  :message_attributes,
  :message_deduplication_id,
  :message_group_id)
  include Aws::Structure
end

#message_bodyString

The body of the message.

Returns:

  • (String)


1453
1454
1455
1456
1457
1458
1459
1460
1461
# File 'gems/aws-sdk-sqs/lib/aws-sdk-sqs/types.rb', line 1453

class SendMessageBatchRequestEntry < Struct.new(
  :id,
  :message_body,
  :delay_seconds,
  :message_attributes,
  :message_deduplication_id,
  :message_group_id)
  include Aws::Structure
end

#message_deduplication_idString

This parameter applies only to FIFO (first-in-first-out) queues.

The token used for deduplication of messages within a 5-minute minimum deduplication interval. If a message with a particular MessageDeduplicationId is sent successfully, subsequent messages with the same MessageDeduplicationId are accepted successfully but aren't delivered. For more information, see Exactly-Once Processing in the Amazon SQS Developer Guide.

  • Every message must have a unique MessageDeduplicationId,

    • You may provide a MessageDeduplicationId explicitly.

    • If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).

    • If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error.

    • If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.

  • When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.

  • If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.

The MessageDeduplicationId is available to the recipient of the message (this can be useful for troubleshooting delivery issues).

If a message is sent successfully but the acknowledgement is lost and the message is resent with the same MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages.

The length of MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~ ).

For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId Property in the Amazon Simple Queue Service Developer Guide.

Returns:

  • (String)


1453
1454
1455
1456
1457
1458
1459
1460
1461
# File 'gems/aws-sdk-sqs/lib/aws-sdk-sqs/types.rb', line 1453

class SendMessageBatchRequestEntry < Struct.new(
  :id,
  :message_body,
  :delay_seconds,
  :message_attributes,
  :message_deduplication_id,
  :message_group_id)
  include Aws::Structure
end

#message_group_idString

This parameter applies only to FIFO (first-in-first-out) queues.

The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). To interleave multiple ordered streams within a single queue, use MessageGroupId values (for example, session data for multiple users). In this scenario, multiple readers can process the queue, but the session data of each user is processed in a FIFO fashion.

  • You must associate a non-empty MessageGroupId with a message. If you don't provide a MessageGroupId, the action fails.

  • ReceiveMessage might return messages with multiple MessageGroupId values. For each MessageGroupId, the messages are sorted by time sent. The caller can't specify a MessageGroupId.

The length of MessageGroupId is 128 characters. Valid values are alphanumeric characters and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~).

For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon Simple Queue Service Developer Guide.

MessageGroupId is required for FIFO queues. You can't use it for Standard queues.

Returns:

  • (String)


1453
1454
1455
1456
1457
1458
1459
1460
1461
# File 'gems/aws-sdk-sqs/lib/aws-sdk-sqs/types.rb', line 1453

class SendMessageBatchRequestEntry < Struct.new(
  :id,
  :message_body,
  :delay_seconds,
  :message_attributes,
  :message_deduplication_id,
  :message_group_id)
  include Aws::Structure
end