/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::SQS::SendMessage

NAME

Paws::SQS::SendMessage - Arguments for method SendMessage on Paws::SQS

DESCRIPTION

This class represents the parameters used for calling the method SendMessage on the Amazon Simple Queue Service service. Use the attributes of this class as arguments to method SendMessage.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SendMessage.

SYNOPSIS

my $sqs = Paws->service('SQS');
my $SendMessageResult = $sqs->SendMessage(
  MessageBody       => 'MyString',
  QueueUrl          => 'MyString',
  DelaySeconds      => 1,            # OPTIONAL
  MessageAttributes => {
    'MyString' => {
      DataType         => 'MyString',
      BinaryListValues => [ 'BlobBinary', ... ],    # OPTIONAL
      BinaryValue      => 'BlobBinary',
      StringListValues => [ 'MyString', ... ],      # OPTIONAL
      StringValue      => 'MyString',
    },
  },    # OPTIONAL
  MessageDeduplicationId  => 'MyString',    # OPTIONAL
  MessageGroupId          => 'MyString',    # OPTIONAL
  MessageSystemAttributes => {
    'AWSTraceHeader' => {
      DataType         => 'MyString',
      BinaryListValues => [ 'BlobBinary', ... ],    # OPTIONAL
      BinaryValue      => 'BlobBinary',
      StringListValues => [ 'MyString', ... ],      # OPTIONAL
      StringValue      => 'MyString',
    },    # key: values: AWSTraceHeader
  },    # OPTIONAL
);

# Results:
my $MD5OfMessageAttributes = $SendMessageResult->MD5OfMessageAttributes;
my $MD5OfMessageBody       = $SendMessageResult->MD5OfMessageBody;
my $MD5OfMessageSystemAttributes =
  $SendMessageResult->MD5OfMessageSystemAttributes;
my $MessageId      = $SendMessageResult->MessageId;
my $SequenceNumber = $SendMessageResult->SequenceNumber;

# Returns a L<Paws::SQS::SendMessageResult> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/sqs/SendMessage

ATTRIBUTES

DelaySeconds => Int

The length of time, in seconds, for which to delay a specific message. 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 applies.

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

MessageAttributes => Paws::SQS::MessageBodyAttributeMap

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 message to send. The minimum size is one character. The maximum size is 256 KB.

A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:

#x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF

Any characters not included in this list will be rejected. For more information, see the W3C specification for characters (http://www.w3.org/TR/REC-xml/#charsets).

MessageDeduplicationId => Str

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

The token used for deduplication of sent messages. If a message with a particular MessageDeduplicationId is sent successfully, any messages sent with the same MessageDeduplicationId are accepted successfully but aren't delivered during the 5-minute deduplication interval. 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 maximum 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.

MessageGroupId => Str

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.

MessageSystemAttributes => Paws::SQS::MessageBodySystemAttributeMap

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.

REQUIRED QueueUrl => Str

The URL of the Amazon SQS queue to which a message is sent.

Queue URLs and names are case-sensitive.

SEE ALSO

This class forms part of Paws, documenting arguments for method SendMessage in Paws::SQS

BUGS and CONTRIBUTIONS

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