AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Delivers a message to the specified queue.

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.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginSendMessage and EndSendMessage.

Namespace: Amazon.SQS
Assembly: AWSSDK.SQS.dll
Version: 3.x.y.z

Syntax

C#
public virtual Task<SendMessageResponse> SendMessageAsync(
         String queueUrl,
         String messageBody,
         CancellationToken cancellationToken
)

Parameters

queueUrl
Type: System.String

The URL of the Amazon SQS queue to which a message is sent. Queue URLs and names are case-sensitive.

messageBody
Type: System.String

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

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the SendMessage service method, as returned by SQS.

Exceptions

ExceptionCondition
InvalidAddressException The accountId is invalid.
InvalidMessageContentsException The message contains characters outside the allowed set.
InvalidSecurityException When the request to a queue is not HTTPS and SigV4.
KmsAccessDeniedException The caller doesn't have the required KMS access.
KmsDisabledException The request was denied due to request throttling.
KmsInvalidKeyUsageException The request was rejected for one of the following reasons: The KeyUsage value of the KMS key is incompatible with the API operation. The encryption algorithm or signing algorithm specified for the operation is incompatible with the type of key material in the KMS key (KeySpec).
KmsInvalidStateException The request was rejected because the state of the specified resource is not valid for this request.
KmsNotFoundException The request was rejected because the specified entity or resource could not be found.
KmsOptInRequiredException The request was rejected because the specified key policy isn't syntactically or semantically correct.
KmsThrottledException Amazon Web Services KMS throttles requests for the following conditions.
QueueDoesNotExistException The specified queue doesn't exist.
RequestThrottledException The request was denied due to request throttling. The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region. A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key." Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
UnsupportedOperationException Error code 400. Unsupported operation.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also