AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::SQS::Model::SendMessageBatchRequestEntry Class Reference

#include <SendMessageBatchRequestEntry.h>

Public Member Functions

 SendMessageBatchRequestEntry ()
 
 SendMessageBatchRequestEntry (const Aws::Utils::Xml::XmlNode &xmlNode)
 
SendMessageBatchRequestEntryoperator= (const Aws::Utils::Xml::XmlNode &xmlNode)
 
void OutputToStream (Aws::OStream &ostream, const char *location, unsigned index, const char *locationValue) const
 
void OutputToStream (Aws::OStream &oStream, const char *location) const
 
const Aws::StringGetId () const
 
bool IdHasBeenSet () const
 
void SetId (const Aws::String &value)
 
void SetId (Aws::String &&value)
 
void SetId (const char *value)
 
SendMessageBatchRequestEntryWithId (const Aws::String &value)
 
SendMessageBatchRequestEntryWithId (Aws::String &&value)
 
SendMessageBatchRequestEntryWithId (const char *value)
 
const Aws::StringGetMessageBody () const
 
bool MessageBodyHasBeenSet () const
 
void SetMessageBody (const Aws::String &value)
 
void SetMessageBody (Aws::String &&value)
 
void SetMessageBody (const char *value)
 
SendMessageBatchRequestEntryWithMessageBody (const Aws::String &value)
 
SendMessageBatchRequestEntryWithMessageBody (Aws::String &&value)
 
SendMessageBatchRequestEntryWithMessageBody (const char *value)
 
int GetDelaySeconds () const
 
bool DelaySecondsHasBeenSet () const
 
void SetDelaySeconds (int value)
 
SendMessageBatchRequestEntryWithDelaySeconds (int value)
 
const Aws::Map< Aws::String, MessageAttributeValue > & GetMessageAttributes () const
 
bool MessageAttributesHasBeenSet () const
 
void SetMessageAttributes (const Aws::Map< Aws::String, MessageAttributeValue > &value)
 
void SetMessageAttributes (Aws::Map< Aws::String, MessageAttributeValue > &&value)
 
SendMessageBatchRequestEntryWithMessageAttributes (const Aws::Map< Aws::String, MessageAttributeValue > &value)
 
SendMessageBatchRequestEntryWithMessageAttributes (Aws::Map< Aws::String, MessageAttributeValue > &&value)
 
SendMessageBatchRequestEntryAddMessageAttributes (const Aws::String &key, const MessageAttributeValue &value)
 
SendMessageBatchRequestEntryAddMessageAttributes (Aws::String &&key, const MessageAttributeValue &value)
 
SendMessageBatchRequestEntryAddMessageAttributes (const Aws::String &key, MessageAttributeValue &&value)
 
SendMessageBatchRequestEntryAddMessageAttributes (Aws::String &&key, MessageAttributeValue &&value)
 
SendMessageBatchRequestEntryAddMessageAttributes (const char *key, MessageAttributeValue &&value)
 
SendMessageBatchRequestEntryAddMessageAttributes (const char *key, const MessageAttributeValue &value)
 
const Aws::Map< MessageSystemAttributeNameForSends, MessageSystemAttributeValue > & GetMessageSystemAttributes () const
 
bool MessageSystemAttributesHasBeenSet () const
 
void SetMessageSystemAttributes (const Aws::Map< MessageSystemAttributeNameForSends, MessageSystemAttributeValue > &value)
 
void SetMessageSystemAttributes (Aws::Map< MessageSystemAttributeNameForSends, MessageSystemAttributeValue > &&value)
 
SendMessageBatchRequestEntryWithMessageSystemAttributes (const Aws::Map< MessageSystemAttributeNameForSends, MessageSystemAttributeValue > &value)
 
SendMessageBatchRequestEntryWithMessageSystemAttributes (Aws::Map< MessageSystemAttributeNameForSends, MessageSystemAttributeValue > &&value)
 
SendMessageBatchRequestEntryAddMessageSystemAttributes (const MessageSystemAttributeNameForSends &key, const MessageSystemAttributeValue &value)
 
SendMessageBatchRequestEntryAddMessageSystemAttributes (MessageSystemAttributeNameForSends &&key, const MessageSystemAttributeValue &value)
 
SendMessageBatchRequestEntryAddMessageSystemAttributes (const MessageSystemAttributeNameForSends &key, MessageSystemAttributeValue &&value)
 
SendMessageBatchRequestEntryAddMessageSystemAttributes (MessageSystemAttributeNameForSends &&key, MessageSystemAttributeValue &&value)
 
const Aws::StringGetMessageDeduplicationId () const
 
bool MessageDeduplicationIdHasBeenSet () const
 
void SetMessageDeduplicationId (const Aws::String &value)
 
void SetMessageDeduplicationId (Aws::String &&value)
 
void SetMessageDeduplicationId (const char *value)
 
SendMessageBatchRequestEntryWithMessageDeduplicationId (const Aws::String &value)
 
SendMessageBatchRequestEntryWithMessageDeduplicationId (Aws::String &&value)
 
SendMessageBatchRequestEntryWithMessageDeduplicationId (const char *value)
 
const Aws::StringGetMessageGroupId () const
 
bool MessageGroupIdHasBeenSet () const
 
void SetMessageGroupId (const Aws::String &value)
 
void SetMessageGroupId (Aws::String &&value)
 
void SetMessageGroupId (const char *value)
 
SendMessageBatchRequestEntryWithMessageGroupId (const Aws::String &value)
 
SendMessageBatchRequestEntryWithMessageGroupId (Aws::String &&value)
 
SendMessageBatchRequestEntryWithMessageGroupId (const char *value)
 

Detailed Description

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

See Also:

AWS API Reference

Definition at line 36 of file SendMessageBatchRequestEntry.h.

Constructor & Destructor Documentation

◆ SendMessageBatchRequestEntry() [1/2]

Aws::SQS::Model::SendMessageBatchRequestEntry::SendMessageBatchRequestEntry ( )

◆ SendMessageBatchRequestEntry() [2/2]

Aws::SQS::Model::SendMessageBatchRequestEntry::SendMessageBatchRequestEntry ( const Aws::Utils::Xml::XmlNode xmlNode)

Member Function Documentation

◆ AddMessageAttributes() [1/6]

SendMessageBatchRequestEntry& Aws::SQS::Model::SendMessageBatchRequestEntry::AddMessageAttributes ( const Aws::String key,
const MessageAttributeValue value 
)
inline

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.

Definition at line 267 of file SendMessageBatchRequestEntry.h.

◆ AddMessageAttributes() [2/6]

SendMessageBatchRequestEntry& Aws::SQS::Model::SendMessageBatchRequestEntry::AddMessageAttributes ( Aws::String &&  key,
const MessageAttributeValue value 
)
inline

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.

Definition at line 276 of file SendMessageBatchRequestEntry.h.

◆ AddMessageAttributes() [3/6]

SendMessageBatchRequestEntry& Aws::SQS::Model::SendMessageBatchRequestEntry::AddMessageAttributes ( const Aws::String key,
MessageAttributeValue &&  value 
)
inline

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.

Definition at line 285 of file SendMessageBatchRequestEntry.h.

◆ AddMessageAttributes() [4/6]

SendMessageBatchRequestEntry& Aws::SQS::Model::SendMessageBatchRequestEntry::AddMessageAttributes ( Aws::String &&  key,
MessageAttributeValue &&  value 
)
inline

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.

Definition at line 294 of file SendMessageBatchRequestEntry.h.

◆ AddMessageAttributes() [5/6]

SendMessageBatchRequestEntry& Aws::SQS::Model::SendMessageBatchRequestEntry::AddMessageAttributes ( const char *  key,
MessageAttributeValue &&  value 
)
inline

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.

Definition at line 303 of file SendMessageBatchRequestEntry.h.

◆ AddMessageAttributes() [6/6]

SendMessageBatchRequestEntry& Aws::SQS::Model::SendMessageBatchRequestEntry::AddMessageAttributes ( const char *  key,
const MessageAttributeValue value 
)
inline

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.

Definition at line 312 of file SendMessageBatchRequestEntry.h.

◆ AddMessageSystemAttributes() [1/4]

SendMessageBatchRequestEntry& Aws::SQS::Model::SendMessageBatchRequestEntry::AddMessageSystemAttributes ( const MessageSystemAttributeNameForSends key,
const MessageSystemAttributeValue value 
)
inline

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 AWS X-Ray trace header string.

  • The size of a message system attribute doesn't count towards the total size of a message.

Definition at line 390 of file SendMessageBatchRequestEntry.h.

◆ AddMessageSystemAttributes() [2/4]

SendMessageBatchRequestEntry& Aws::SQS::Model::SendMessageBatchRequestEntry::AddMessageSystemAttributes ( MessageSystemAttributeNameForSends &&  key,
const MessageSystemAttributeValue value 
)
inline

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 AWS X-Ray trace header string.

  • The size of a message system attribute doesn't count towards the total size of a message.

Definition at line 401 of file SendMessageBatchRequestEntry.h.

◆ AddMessageSystemAttributes() [3/4]

SendMessageBatchRequestEntry& Aws::SQS::Model::SendMessageBatchRequestEntry::AddMessageSystemAttributes ( const MessageSystemAttributeNameForSends key,
MessageSystemAttributeValue &&  value 
)
inline

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 AWS X-Ray trace header string.

  • The size of a message system attribute doesn't count towards the total size of a message.

Definition at line 412 of file SendMessageBatchRequestEntry.h.

◆ AddMessageSystemAttributes() [4/4]

SendMessageBatchRequestEntry& Aws::SQS::Model::SendMessageBatchRequestEntry::AddMessageSystemAttributes ( MessageSystemAttributeNameForSends &&  key,
MessageSystemAttributeValue &&  value 
)
inline

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 AWS X-Ray trace header string.

  • The size of a message system attribute doesn't count towards the total size of a message.

Definition at line 423 of file SendMessageBatchRequestEntry.h.

◆ DelaySecondsHasBeenSet()

bool Aws::SQS::Model::SendMessageBatchRequestEntry::DelaySecondsHasBeenSet ( ) const
inline

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.

Definition at line 181 of file SendMessageBatchRequestEntry.h.

◆ GetDelaySeconds()

int Aws::SQS::Model::SendMessageBatchRequestEntry::GetDelaySeconds ( ) const
inline

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.

Definition at line 170 of file SendMessageBatchRequestEntry.h.

◆ GetId()

const Aws::String& Aws::SQS::Model::SendMessageBatchRequestEntry::GetId ( ) const
inline

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.

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

Definition at line 54 of file SendMessageBatchRequestEntry.h.

◆ GetMessageAttributes()

const Aws::Map<Aws::String, MessageAttributeValue>& Aws::SQS::Model::SendMessageBatchRequestEntry::GetMessageAttributes ( ) const
inline

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.

Definition at line 213 of file SendMessageBatchRequestEntry.h.

◆ GetMessageBody()

const Aws::String& Aws::SQS::Model::SendMessageBatchRequestEntry::GetMessageBody ( ) const
inline

The body of the message.

Definition at line 123 of file SendMessageBatchRequestEntry.h.

◆ GetMessageDeduplicationId()

const Aws::String& Aws::SQS::Model::SendMessageBatchRequestEntry::GetMessageDeduplicationId ( ) const
inline

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 Simple Queue Service 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 in the Amazon Simple Queue Service Developer Guide.

Definition at line 469 of file SendMessageBatchRequestEntry.h.

◆ GetMessageGroupId()

const Aws::String& Aws::SQS::Model::SendMessageBatchRequestEntry::GetMessageGroupId ( ) const
inline

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 in the Amazon Simple Queue Service Developer Guide.

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

Definition at line 811 of file SendMessageBatchRequestEntry.h.

◆ GetMessageSystemAttributes()

const Aws::Map<MessageSystemAttributeNameForSends, MessageSystemAttributeValue>& Aws::SQS::Model::SendMessageBatchRequestEntry::GetMessageSystemAttributes ( ) const
inline

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 AWS X-Ray trace header string.

  • The size of a message system attribute doesn't count towards the total size of a message.

Definition at line 324 of file SendMessageBatchRequestEntry.h.

◆ IdHasBeenSet()

bool Aws::SQS::Model::SendMessageBatchRequestEntry::IdHasBeenSet ( ) const
inline

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.

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

Definition at line 63 of file SendMessageBatchRequestEntry.h.

◆ MessageAttributesHasBeenSet()

bool Aws::SQS::Model::SendMessageBatchRequestEntry::MessageAttributesHasBeenSet ( ) const
inline

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.

Definition at line 222 of file SendMessageBatchRequestEntry.h.

◆ MessageBodyHasBeenSet()

bool Aws::SQS::Model::SendMessageBatchRequestEntry::MessageBodyHasBeenSet ( ) const
inline

The body of the message.

Definition at line 128 of file SendMessageBatchRequestEntry.h.

◆ MessageDeduplicationIdHasBeenSet()

bool Aws::SQS::Model::SendMessageBatchRequestEntry::MessageDeduplicationIdHasBeenSet ( ) const
inline

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 Simple Queue Service 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 in the Amazon Simple Queue Service Developer Guide.

Definition at line 514 of file SendMessageBatchRequestEntry.h.

◆ MessageGroupIdHasBeenSet()

bool Aws::SQS::Model::SendMessageBatchRequestEntry::MessageGroupIdHasBeenSet ( ) const
inline

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 in the Amazon Simple Queue Service Developer Guide.

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

Definition at line 837 of file SendMessageBatchRequestEntry.h.

◆ MessageSystemAttributesHasBeenSet()

bool Aws::SQS::Model::SendMessageBatchRequestEntry::MessageSystemAttributesHasBeenSet ( ) const
inline

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 AWS X-Ray trace header string.

  • The size of a message system attribute doesn't count towards the total size of a message.

Definition at line 335 of file SendMessageBatchRequestEntry.h.

◆ operator=()

SendMessageBatchRequestEntry& Aws::SQS::Model::SendMessageBatchRequestEntry::operator= ( const Aws::Utils::Xml::XmlNode xmlNode)

◆ OutputToStream() [1/2]

void Aws::SQS::Model::SendMessageBatchRequestEntry::OutputToStream ( Aws::OStream ostream,
const char *  location,
unsigned  index,
const char *  locationValue 
) const

◆ OutputToStream() [2/2]

void Aws::SQS::Model::SendMessageBatchRequestEntry::OutputToStream ( Aws::OStream oStream,
const char *  location 
) const

◆ SetDelaySeconds()

void Aws::SQS::Model::SendMessageBatchRequestEntry::SetDelaySeconds ( int  value)
inline

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.

Definition at line 192 of file SendMessageBatchRequestEntry.h.

◆ SetId() [1/3]

void Aws::SQS::Model::SendMessageBatchRequestEntry::SetId ( const Aws::String value)
inline

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.

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

Definition at line 72 of file SendMessageBatchRequestEntry.h.

◆ SetId() [2/3]

void Aws::SQS::Model::SendMessageBatchRequestEntry::SetId ( Aws::String &&  value)
inline

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.

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

Definition at line 81 of file SendMessageBatchRequestEntry.h.

◆ SetId() [3/3]

void Aws::SQS::Model::SendMessageBatchRequestEntry::SetId ( const char *  value)
inline

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.

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

Definition at line 90 of file SendMessageBatchRequestEntry.h.

◆ SetMessageAttributes() [1/2]

void Aws::SQS::Model::SendMessageBatchRequestEntry::SetMessageAttributes ( const Aws::Map< Aws::String, MessageAttributeValue > &  value)
inline

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.

Definition at line 231 of file SendMessageBatchRequestEntry.h.

◆ SetMessageAttributes() [2/2]

void Aws::SQS::Model::SendMessageBatchRequestEntry::SetMessageAttributes ( Aws::Map< Aws::String, MessageAttributeValue > &&  value)
inline

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.

Definition at line 240 of file SendMessageBatchRequestEntry.h.

◆ SetMessageBody() [1/3]

void Aws::SQS::Model::SendMessageBatchRequestEntry::SetMessageBody ( const Aws::String value)
inline

The body of the message.

Definition at line 133 of file SendMessageBatchRequestEntry.h.

◆ SetMessageBody() [2/3]

void Aws::SQS::Model::SendMessageBatchRequestEntry::SetMessageBody ( Aws::String &&  value)
inline

The body of the message.

Definition at line 138 of file SendMessageBatchRequestEntry.h.

◆ SetMessageBody() [3/3]

void Aws::SQS::Model::SendMessageBatchRequestEntry::SetMessageBody ( const char *  value)
inline

The body of the message.

Definition at line 143 of file SendMessageBatchRequestEntry.h.

◆ SetMessageDeduplicationId() [1/3]

void Aws::SQS::Model::SendMessageBatchRequestEntry::SetMessageDeduplicationId ( const Aws::String value)
inline

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 Simple Queue Service 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 in the Amazon Simple Queue Service Developer Guide.

Definition at line 559 of file SendMessageBatchRequestEntry.h.

◆ SetMessageDeduplicationId() [2/3]

void Aws::SQS::Model::SendMessageBatchRequestEntry::SetMessageDeduplicationId ( Aws::String &&  value)
inline

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 Simple Queue Service 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 in the Amazon Simple Queue Service Developer Guide.

Definition at line 604 of file SendMessageBatchRequestEntry.h.

◆ SetMessageDeduplicationId() [3/3]

void Aws::SQS::Model::SendMessageBatchRequestEntry::SetMessageDeduplicationId ( const char *  value)
inline

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 Simple Queue Service 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 in the Amazon Simple Queue Service Developer Guide.

Definition at line 649 of file SendMessageBatchRequestEntry.h.

◆ SetMessageGroupId() [1/3]

void Aws::SQS::Model::SendMessageBatchRequestEntry::SetMessageGroupId ( const Aws::String value)
inline

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 in the Amazon Simple Queue Service Developer Guide.

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

Definition at line 863 of file SendMessageBatchRequestEntry.h.

◆ SetMessageGroupId() [2/3]

void Aws::SQS::Model::SendMessageBatchRequestEntry::SetMessageGroupId ( Aws::String &&  value)
inline

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 in the Amazon Simple Queue Service Developer Guide.

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

Definition at line 889 of file SendMessageBatchRequestEntry.h.

◆ SetMessageGroupId() [3/3]

void Aws::SQS::Model::SendMessageBatchRequestEntry::SetMessageGroupId ( const char *  value)
inline

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 in the Amazon Simple Queue Service Developer Guide.

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

Definition at line 915 of file SendMessageBatchRequestEntry.h.

◆ SetMessageSystemAttributes() [1/2]

void Aws::SQS::Model::SendMessageBatchRequestEntry::SetMessageSystemAttributes ( const Aws::Map< MessageSystemAttributeNameForSends, MessageSystemAttributeValue > &  value)
inline

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 AWS X-Ray trace header string.

  • The size of a message system attribute doesn't count towards the total size of a message.

Definition at line 346 of file SendMessageBatchRequestEntry.h.

◆ SetMessageSystemAttributes() [2/2]

void Aws::SQS::Model::SendMessageBatchRequestEntry::SetMessageSystemAttributes ( Aws::Map< MessageSystemAttributeNameForSends, MessageSystemAttributeValue > &&  value)
inline

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 AWS X-Ray trace header string.

  • The size of a message system attribute doesn't count towards the total size of a message.

Definition at line 357 of file SendMessageBatchRequestEntry.h.

◆ WithDelaySeconds()

SendMessageBatchRequestEntry& Aws::SQS::Model::SendMessageBatchRequestEntry::WithDelaySeconds ( int  value)
inline

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.

Definition at line 203 of file SendMessageBatchRequestEntry.h.

◆ WithId() [1/3]

SendMessageBatchRequestEntry& Aws::SQS::Model::SendMessageBatchRequestEntry::WithId ( const Aws::String value)
inline

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.

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

Definition at line 99 of file SendMessageBatchRequestEntry.h.

◆ WithId() [2/3]

SendMessageBatchRequestEntry& Aws::SQS::Model::SendMessageBatchRequestEntry::WithId ( Aws::String &&  value)
inline

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.

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

Definition at line 108 of file SendMessageBatchRequestEntry.h.

◆ WithId() [3/3]

SendMessageBatchRequestEntry& Aws::SQS::Model::SendMessageBatchRequestEntry::WithId ( const char *  value)
inline

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.

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

Definition at line 117 of file SendMessageBatchRequestEntry.h.

◆ WithMessageAttributes() [1/2]

SendMessageBatchRequestEntry& Aws::SQS::Model::SendMessageBatchRequestEntry::WithMessageAttributes ( const Aws::Map< Aws::String, MessageAttributeValue > &  value)
inline

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.

Definition at line 249 of file SendMessageBatchRequestEntry.h.

◆ WithMessageAttributes() [2/2]

SendMessageBatchRequestEntry& Aws::SQS::Model::SendMessageBatchRequestEntry::WithMessageAttributes ( Aws::Map< Aws::String, MessageAttributeValue > &&  value)
inline

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.

Definition at line 258 of file SendMessageBatchRequestEntry.h.

◆ WithMessageBody() [1/3]

SendMessageBatchRequestEntry& Aws::SQS::Model::SendMessageBatchRequestEntry::WithMessageBody ( const Aws::String value)
inline

The body of the message.

Definition at line 148 of file SendMessageBatchRequestEntry.h.

◆ WithMessageBody() [2/3]

SendMessageBatchRequestEntry& Aws::SQS::Model::SendMessageBatchRequestEntry::WithMessageBody ( Aws::String &&  value)
inline

The body of the message.

Definition at line 153 of file SendMessageBatchRequestEntry.h.

◆ WithMessageBody() [3/3]

SendMessageBatchRequestEntry& Aws::SQS::Model::SendMessageBatchRequestEntry::WithMessageBody ( const char *  value)
inline

The body of the message.

Definition at line 158 of file SendMessageBatchRequestEntry.h.

◆ WithMessageDeduplicationId() [1/3]

SendMessageBatchRequestEntry& Aws::SQS::Model::SendMessageBatchRequestEntry::WithMessageDeduplicationId ( const Aws::String value)
inline

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 Simple Queue Service 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 in the Amazon Simple Queue Service Developer Guide.

Definition at line 694 of file SendMessageBatchRequestEntry.h.

◆ WithMessageDeduplicationId() [2/3]

SendMessageBatchRequestEntry& Aws::SQS::Model::SendMessageBatchRequestEntry::WithMessageDeduplicationId ( Aws::String &&  value)
inline

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 Simple Queue Service 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 in the Amazon Simple Queue Service Developer Guide.

Definition at line 739 of file SendMessageBatchRequestEntry.h.

◆ WithMessageDeduplicationId() [3/3]

SendMessageBatchRequestEntry& Aws::SQS::Model::SendMessageBatchRequestEntry::WithMessageDeduplicationId ( const char *  value)
inline

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 Simple Queue Service 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 in the Amazon Simple Queue Service Developer Guide.

Definition at line 784 of file SendMessageBatchRequestEntry.h.

◆ WithMessageGroupId() [1/3]

SendMessageBatchRequestEntry& Aws::SQS::Model::SendMessageBatchRequestEntry::WithMessageGroupId ( const Aws::String value)
inline

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 in the Amazon Simple Queue Service Developer Guide.

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

Definition at line 941 of file SendMessageBatchRequestEntry.h.

◆ WithMessageGroupId() [2/3]

SendMessageBatchRequestEntry& Aws::SQS::Model::SendMessageBatchRequestEntry::WithMessageGroupId ( Aws::String &&  value)
inline

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 in the Amazon Simple Queue Service Developer Guide.

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

Definition at line 967 of file SendMessageBatchRequestEntry.h.

◆ WithMessageGroupId() [3/3]

SendMessageBatchRequestEntry& Aws::SQS::Model::SendMessageBatchRequestEntry::WithMessageGroupId ( const char *  value)
inline

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 in the Amazon Simple Queue Service Developer Guide.

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

Definition at line 993 of file SendMessageBatchRequestEntry.h.

◆ WithMessageSystemAttributes() [1/2]

SendMessageBatchRequestEntry& Aws::SQS::Model::SendMessageBatchRequestEntry::WithMessageSystemAttributes ( const Aws::Map< MessageSystemAttributeNameForSends, MessageSystemAttributeValue > &  value)
inline

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 AWS X-Ray trace header string.

  • The size of a message system attribute doesn't count towards the total size of a message.

Definition at line 368 of file SendMessageBatchRequestEntry.h.

◆ WithMessageSystemAttributes() [2/2]

SendMessageBatchRequestEntry& Aws::SQS::Model::SendMessageBatchRequestEntry::WithMessageSystemAttributes ( Aws::Map< MessageSystemAttributeNameForSends, MessageSystemAttributeValue > &&  value)
inline

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 AWS X-Ray trace header string.

  • The size of a message system attribute doesn't count towards the total size of a message.

Definition at line 379 of file SendMessageBatchRequestEntry.h.


The documentation for this class was generated from the following file: