AWS SDK for C++  1.8.7
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::SQS::Model::SendMessageRequest Class Reference

#include <SendMessageRequest.h>

+ Inheritance diagram for Aws::SQS::Model::SendMessageRequest:

Public Member Functions

 SendMessageRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetQueueUrl () const
 
bool QueueUrlHasBeenSet () const
 
void SetQueueUrl (const Aws::String &value)
 
void SetQueueUrl (Aws::String &&value)
 
void SetQueueUrl (const char *value)
 
SendMessageRequestWithQueueUrl (const Aws::String &value)
 
SendMessageRequestWithQueueUrl (Aws::String &&value)
 
SendMessageRequestWithQueueUrl (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)
 
SendMessageRequestWithMessageBody (const Aws::String &value)
 
SendMessageRequestWithMessageBody (Aws::String &&value)
 
SendMessageRequestWithMessageBody (const char *value)
 
int GetDelaySeconds () const
 
bool DelaySecondsHasBeenSet () const
 
void SetDelaySeconds (int value)
 
SendMessageRequestWithDelaySeconds (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)
 
SendMessageRequestWithMessageAttributes (const Aws::Map< Aws::String, MessageAttributeValue > &value)
 
SendMessageRequestWithMessageAttributes (Aws::Map< Aws::String, MessageAttributeValue > &&value)
 
SendMessageRequestAddMessageAttributes (const Aws::String &key, const MessageAttributeValue &value)
 
SendMessageRequestAddMessageAttributes (Aws::String &&key, const MessageAttributeValue &value)
 
SendMessageRequestAddMessageAttributes (const Aws::String &key, MessageAttributeValue &&value)
 
SendMessageRequestAddMessageAttributes (Aws::String &&key, MessageAttributeValue &&value)
 
SendMessageRequestAddMessageAttributes (const char *key, MessageAttributeValue &&value)
 
SendMessageRequestAddMessageAttributes (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)
 
SendMessageRequestWithMessageSystemAttributes (const Aws::Map< MessageSystemAttributeNameForSends, MessageSystemAttributeValue > &value)
 
SendMessageRequestWithMessageSystemAttributes (Aws::Map< MessageSystemAttributeNameForSends, MessageSystemAttributeValue > &&value)
 
SendMessageRequestAddMessageSystemAttributes (const MessageSystemAttributeNameForSends &key, const MessageSystemAttributeValue &value)
 
SendMessageRequestAddMessageSystemAttributes (MessageSystemAttributeNameForSends &&key, const MessageSystemAttributeValue &value)
 
SendMessageRequestAddMessageSystemAttributes (const MessageSystemAttributeNameForSends &key, MessageSystemAttributeValue &&value)
 
SendMessageRequestAddMessageSystemAttributes (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)
 
SendMessageRequestWithMessageDeduplicationId (const Aws::String &value)
 
SendMessageRequestWithMessageDeduplicationId (Aws::String &&value)
 
SendMessageRequestWithMessageDeduplicationId (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)
 
SendMessageRequestWithMessageGroupId (const Aws::String &value)
 
SendMessageRequestWithMessageGroupId (Aws::String &&value)
 
SendMessageRequestWithMessageGroupId (const char *value)
 
- Public Member Functions inherited from Aws::SQS::SQSRequest
virtual ~SQSRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::SQS::SQSRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

See Also:

AWS API Reference

Definition at line 28 of file SendMessageRequest.h.

Constructor & Destructor Documentation

◆ SendMessageRequest()

Aws::SQS::Model::SendMessageRequest::SendMessageRequest ( )

Member Function Documentation

◆ AddMessageAttributes() [1/6]

SendMessageRequest& Aws::SQS::Model::SendMessageRequest::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 306 of file SendMessageRequest.h.

◆ AddMessageAttributes() [2/6]

SendMessageRequest& Aws::SQS::Model::SendMessageRequest::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 315 of file SendMessageRequest.h.

◆ AddMessageAttributes() [3/6]

SendMessageRequest& Aws::SQS::Model::SendMessageRequest::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 324 of file SendMessageRequest.h.

◆ AddMessageAttributes() [4/6]

SendMessageRequest& Aws::SQS::Model::SendMessageRequest::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 333 of file SendMessageRequest.h.

◆ AddMessageAttributes() [5/6]

SendMessageRequest& Aws::SQS::Model::SendMessageRequest::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 342 of file SendMessageRequest.h.

◆ AddMessageAttributes() [6/6]

SendMessageRequest& Aws::SQS::Model::SendMessageRequest::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 351 of file SendMessageRequest.h.

◆ AddMessageSystemAttributes() [1/4]

SendMessageRequest& Aws::SQS::Model::SendMessageRequest::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 429 of file SendMessageRequest.h.

◆ AddMessageSystemAttributes() [2/4]

SendMessageRequest& Aws::SQS::Model::SendMessageRequest::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 440 of file SendMessageRequest.h.

◆ AddMessageSystemAttributes() [3/4]

SendMessageRequest& Aws::SQS::Model::SendMessageRequest::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 451 of file SendMessageRequest.h.

◆ AddMessageSystemAttributes() [4/4]

SendMessageRequest& Aws::SQS::Model::SendMessageRequest::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 462 of file SendMessageRequest.h.

◆ DelaySecondsHasBeenSet()

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

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.

Definition at line 220 of file SendMessageRequest.h.

◆ DumpBodyToUrl()

void Aws::SQS::Model::SendMessageRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ GetDelaySeconds()

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

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.

Definition at line 209 of file SendMessageRequest.h.

◆ GetMessageAttributes()

const Aws::Map<Aws::String, MessageAttributeValue>& Aws::SQS::Model::SendMessageRequest::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 252 of file SendMessageRequest.h.

◆ GetMessageBody()

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

The message to send. The maximum string 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.

Definition at line 106 of file SendMessageRequest.h.

◆ GetMessageDeduplicationId()

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

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

Definition at line 508 of file SendMessageRequest.h.

◆ GetMessageGroupId()

const Aws::String& Aws::SQS::Model::SendMessageRequest::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 850 of file SendMessageRequest.h.

◆ GetMessageSystemAttributes()

const Aws::Map<MessageSystemAttributeNameForSends, MessageSystemAttributeValue>& Aws::SQS::Model::SendMessageRequest::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 363 of file SendMessageRequest.h.

◆ GetQueueUrl()

const Aws::String& Aws::SQS::Model::SendMessageRequest::GetQueueUrl ( ) const
inline

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

Queue URLs and names are case-sensitive.

Definition at line 50 of file SendMessageRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::SQS::Model::SendMessageRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 37 of file SendMessageRequest.h.

◆ MessageAttributesHasBeenSet()

bool Aws::SQS::Model::SendMessageRequest::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 261 of file SendMessageRequest.h.

◆ MessageBodyHasBeenSet()

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

The message to send. The maximum string 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.

Definition at line 119 of file SendMessageRequest.h.

◆ MessageDeduplicationIdHasBeenSet()

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

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

Definition at line 553 of file SendMessageRequest.h.

◆ MessageGroupIdHasBeenSet()

bool Aws::SQS::Model::SendMessageRequest::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 876 of file SendMessageRequest.h.

◆ MessageSystemAttributesHasBeenSet()

bool Aws::SQS::Model::SendMessageRequest::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 374 of file SendMessageRequest.h.

◆ QueueUrlHasBeenSet()

bool Aws::SQS::Model::SendMessageRequest::QueueUrlHasBeenSet ( ) const
inline

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

Queue URLs and names are case-sensitive.

Definition at line 56 of file SendMessageRequest.h.

◆ SerializePayload()

Aws::String Aws::SQS::Model::SendMessageRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDelaySeconds()

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

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.

Definition at line 231 of file SendMessageRequest.h.

◆ SetMessageAttributes() [1/2]

void Aws::SQS::Model::SendMessageRequest::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 270 of file SendMessageRequest.h.

◆ SetMessageAttributes() [2/2]

void Aws::SQS::Model::SendMessageRequest::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 279 of file SendMessageRequest.h.

◆ SetMessageBody() [1/3]

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

The message to send. The maximum string 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.

Definition at line 132 of file SendMessageRequest.h.

◆ SetMessageBody() [2/3]

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

The message to send. The maximum string 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.

Definition at line 145 of file SendMessageRequest.h.

◆ SetMessageBody() [3/3]

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

The message to send. The maximum string 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.

Definition at line 158 of file SendMessageRequest.h.

◆ SetMessageDeduplicationId() [1/3]

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

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

Definition at line 598 of file SendMessageRequest.h.

◆ SetMessageDeduplicationId() [2/3]

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

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

Definition at line 643 of file SendMessageRequest.h.

◆ SetMessageDeduplicationId() [3/3]

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

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

Definition at line 688 of file SendMessageRequest.h.

◆ SetMessageGroupId() [1/3]

void Aws::SQS::Model::SendMessageRequest::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 902 of file SendMessageRequest.h.

◆ SetMessageGroupId() [2/3]

void Aws::SQS::Model::SendMessageRequest::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 928 of file SendMessageRequest.h.

◆ SetMessageGroupId() [3/3]

void Aws::SQS::Model::SendMessageRequest::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 954 of file SendMessageRequest.h.

◆ SetMessageSystemAttributes() [1/2]

void Aws::SQS::Model::SendMessageRequest::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 385 of file SendMessageRequest.h.

◆ SetMessageSystemAttributes() [2/2]

void Aws::SQS::Model::SendMessageRequest::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 396 of file SendMessageRequest.h.

◆ SetQueueUrl() [1/3]

void Aws::SQS::Model::SendMessageRequest::SetQueueUrl ( const Aws::String value)
inline

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

Queue URLs and names are case-sensitive.

Definition at line 62 of file SendMessageRequest.h.

◆ SetQueueUrl() [2/3]

void Aws::SQS::Model::SendMessageRequest::SetQueueUrl ( Aws::String &&  value)
inline

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

Queue URLs and names are case-sensitive.

Definition at line 68 of file SendMessageRequest.h.

◆ SetQueueUrl() [3/3]

void Aws::SQS::Model::SendMessageRequest::SetQueueUrl ( const char *  value)
inline

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

Queue URLs and names are case-sensitive.

Definition at line 74 of file SendMessageRequest.h.

◆ WithDelaySeconds()

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

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.

Definition at line 242 of file SendMessageRequest.h.

◆ WithMessageAttributes() [1/2]

SendMessageRequest& Aws::SQS::Model::SendMessageRequest::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 288 of file SendMessageRequest.h.

◆ WithMessageAttributes() [2/2]

SendMessageRequest& Aws::SQS::Model::SendMessageRequest::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 297 of file SendMessageRequest.h.

◆ WithMessageBody() [1/3]

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

The message to send. The maximum string 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.

Definition at line 171 of file SendMessageRequest.h.

◆ WithMessageBody() [2/3]

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

The message to send. The maximum string 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.

Definition at line 184 of file SendMessageRequest.h.

◆ WithMessageBody() [3/3]

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

The message to send. The maximum string 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.

Definition at line 197 of file SendMessageRequest.h.

◆ WithMessageDeduplicationId() [1/3]

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

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

Definition at line 733 of file SendMessageRequest.h.

◆ WithMessageDeduplicationId() [2/3]

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

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

Definition at line 778 of file SendMessageRequest.h.

◆ WithMessageDeduplicationId() [3/3]

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

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

Definition at line 823 of file SendMessageRequest.h.

◆ WithMessageGroupId() [1/3]

SendMessageRequest& Aws::SQS::Model::SendMessageRequest::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 980 of file SendMessageRequest.h.

◆ WithMessageGroupId() [2/3]

SendMessageRequest& Aws::SQS::Model::SendMessageRequest::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 1006 of file SendMessageRequest.h.

◆ WithMessageGroupId() [3/3]

SendMessageRequest& Aws::SQS::Model::SendMessageRequest::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 1032 of file SendMessageRequest.h.

◆ WithMessageSystemAttributes() [1/2]

SendMessageRequest& Aws::SQS::Model::SendMessageRequest::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 407 of file SendMessageRequest.h.

◆ WithMessageSystemAttributes() [2/2]

SendMessageRequest& Aws::SQS::Model::SendMessageRequest::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 418 of file SendMessageRequest.h.

◆ WithQueueUrl() [1/3]

SendMessageRequest& Aws::SQS::Model::SendMessageRequest::WithQueueUrl ( const Aws::String value)
inline

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

Queue URLs and names are case-sensitive.

Definition at line 80 of file SendMessageRequest.h.

◆ WithQueueUrl() [2/3]

SendMessageRequest& Aws::SQS::Model::SendMessageRequest::WithQueueUrl ( Aws::String &&  value)
inline

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

Queue URLs and names are case-sensitive.

Definition at line 86 of file SendMessageRequest.h.

◆ WithQueueUrl() [3/3]

SendMessageRequest& Aws::SQS::Model::SendMessageRequest::WithQueueUrl ( const char *  value)
inline

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

Queue URLs and names are case-sensitive.

Definition at line 92 of file SendMessageRequest.h.


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