GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Paws::SQS::SendMessageBatchRequestEntry(3) User Contributed Perl Documentation Paws::SQS::SendMessageBatchRequestEntry(3)

Paws::SQS::SendMessageBatchRequestEntry

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::SQS::SendMessageBatchRequestEntry object:

  $service_obj->Method(Att1 => { DelaySeconds => $value, ..., MessageSystemAttributes => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::SQS::SendMessageBatchRequestEntry object:

  $result = $service_obj->Method(...);
  $result->Att1->DelaySeconds

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

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.

REQUIRED Id => Str

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

The "Id"s of a batch request need to be unique within a request.

This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).

Each message attribute consists of a "Name", "Type", and "Value". For more information, see Amazon SQS message attributes (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes) in the Amazon SQS Developer Guide.

REQUIRED MessageBody => Str

The body of the message.

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 (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html) 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 consumer 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.

Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.

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 (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html) in the Amazon SQS Developer Guide.

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 consumers 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: alphanumeric characters and punctuation "(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)".

For best practices of using "MessageGroupId", see Using the MessageGroupId Property (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagegroupid-property.html) in the Amazon SQS Developer Guide.

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

The message system attribute to send Each message system attribute consists of a "Name", "Type", and "Value".

  • Currently, the only supported message system attribute is "AWSTraceHeader". Its type must be "String" and its value must be a correctly formatted X-Ray trace header string.
  • The size of a message system attribute doesn't count towards the total size of a message.

This class forms part of Paws, describing an object used in Paws::SQS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>

2022-06-01 perl v5.40.2

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.