Amazon Simple Queue Service (Amazon SQS) offers a reliable, highly scalable, hosted queue for storing messages as they travel between computers. By using Amazon SQS, developers can simply move data between distributed components of their applications that perform different tasks, without losing messages or requiring each component to be always available. Amazon SQS makes it easy to build an automated workflow, working in close conjunction with the Amazon Elastic Compute Cloud (Amazon EC2) and the other AWS infrastructure web services.
Amazon SQS works by exposing Amazon's web-scale messaging infrastructure as a web service. Any computer on the Internet can add or read messages without any installed software or special firewall configurations. Components of applications using Amazon SQS can run independently, and do not need to be on the same network, developed with the same technologies, or running at the same time.
Visit http://aws.amazon.com/sqs/ for more information.
Inheritance Hierarchy
Amazon.Runtime.AbstractWebServiceClient
Amazon.Runtime.AmazonWebServiceClient
Amazon.SQS.AmazonSQSClient
Namespace: Amazon.SQS
Assembly: AWSSDK.dll
Version: 2.0.0.3
Syntax
public class AmazonSQSClient : AmazonWebServiceClient IAmazonSQS, IDisposable
The AmazonSQSClient type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
AmazonSQSClient() |
Constructs AmazonSQSClient with the credentials loaded from the application's
default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="AWSAccessKey" value="********************"/>
<add key="AWSSecretKey" value="****************************************"/>
</appSettings>
</configuration>
|
|
AmazonSQSClient(RegionEndpoint) |
Constructs AmazonSQSClient with the credentials loaded from the application's
default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="AWSAccessKey" value="********************"/>
<add key="AWSSecretKey" value="****************************************"/>
</appSettings>
</configuration>
|
|
AmazonSQSClient(AmazonSQSConfig) |
Constructs AmazonSQSClient with the credentials loaded from the application's
default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="AWSAccessKey" value="********************"/>
<add key="AWSSecretKey" value="****************************************"/>
</appSettings>
</configuration>
|
|
AmazonSQSClient(AWSCredentials) | Constructs AmazonSQSClient with AWS Credentials |
|
AmazonSQSClient(AWSCredentials, RegionEndpoint) | Constructs AmazonSQSClient with AWS Credentials |
|
AmazonSQSClient(AWSCredentials, AmazonSQSConfig) | Constructs AmazonSQSClient with AWS Credentials and an AmazonSQSClient Configuration object. |
|
AmazonSQSClient(string, string) | Constructs AmazonSQSClient with AWS Access Key ID and AWS Secret Key |
|
AmazonSQSClient(string, string, RegionEndpoint) | Constructs AmazonSQSClient with AWS Access Key ID and AWS Secret Key |
|
AmazonSQSClient(string, string, AmazonSQSConfig) | Constructs AmazonSQSClient with AWS Access Key ID, AWS Secret Key and an AmazonSQSClient Configuration object. If the config object's UseSecureStringForAwsSecretKey is false, the AWS Secret Key is stored as a clear-text string. Please use this option only if the application environment doesn't allow the use of SecureStrings. |
|
AmazonSQSClient(string, string, string) | Constructs AmazonSQSClient with AWS Access Key ID and AWS Secret Key |
|
AmazonSQSClient(string, string, string, RegionEndpoint) | Constructs AmazonSQSClient with AWS Access Key ID and AWS Secret Key |
|
AmazonSQSClient(string, string, string, AmazonSQSConfig) | Constructs AmazonSQSClient with AWS Access Key ID, AWS Secret Key and an AmazonSQSClient Configuration object. If the config object's UseSecureStringForAwsSecretKey is false, the AWS Secret Key is stored as a clear-text string. Please use this option only if the application environment doesn't allow the use of SecureStrings. |
Methods
| Name | Description | |
|---|---|---|
|
AddPermission(AddPermissionRequest) |
The AddPermission action adds a permission to a queue for a specific principal. This allows for sharing access to the queue. When you create a queue, you have full control access rights for the queue. Only you (as owner of the queue) can grant or deny permissions to the queue. For more information about these permissions, see Shared Queues in the Amazon SQS Developer Guide.
|
|
AddPermissionAsync(AddPermissionRequest, CancellationToken) |
Initiates the asynchronous execution of the AddPermission operation.
|
|
ChangeMessageVisibility(ChangeMessageVisibilityRequest) |
The For example, let's say you have a message and its default message visibility timeout is 30 minutes. You could
call IMPORTANT:If you attempt to set the VisibilityTimeout to an amount more than the maximum time left, Amazon SQS returns an error. It will not automatically recalculate and increase the timeout to the maximum time remaining. IMPORTANT:Unlike with a queue, when you change the visibility timeout for a specific message, that timeout value is applied immediately but is not saved in memory for that message. If you don't delete a message after it is received, the visibility timeout for the message the next time it is received reverts to the original timeout value, not the value you set with the ChangeMessageVisibility action. |
|
ChangeMessageVisibilityAsync(ChangeMessageVisibilityRequest, CancellationToken) |
Initiates the asynchronous execution of the ChangeMessageVisibility operation.
|
|
ChangeMessageVisibilityBatch(ChangeMessageVisibilityBatchRequest) |
This is a batch version of ChangeMessageVisibility. It takes multiple receipt handles and performs the operation on each of the them. The result of the operation on each message is reported individually in the response. |
|
ChangeMessageVisibilityBatchAsync(ChangeMessageVisibilityBatchRequest, CancellationToken) |
Initiates the asynchronous execution of the ChangeMessageVisibilityBatch operation.
|
|
CreateQueue(CreateQueueRequest) |
The You may pass one or more attributes in the request. If you do not provide a value for any attribute, the queue will have the default value for that attribute. Permitted attributes are the same that can be set using SetQueueAttributes. If you
provide the name of an existing queue, a new queue isn't created. If the values of attributes provided with the request match up with those
on the existing queue, the queue URL is returned. Otherwise, a |
|
CreateQueueAsync(CreateQueueRequest, CancellationToken) |
Initiates the asynchronous execution of the CreateQueue operation.
|
|
DeleteMessage(DeleteMessageRequest) |
The |
|
DeleteMessageAsync(DeleteMessageRequest, CancellationToken) |
Initiates the asynchronous execution of the DeleteMessage operation.
|
|
DeleteMessageBatch(DeleteMessageBatchRequest) |
This is a batch version of DeleteMessage. It takes multiple receipt handles and deletes each one of the messages. The result of the delete operation on each message is reported individually in the response. |
|
DeleteMessageBatchAsync(DeleteMessageBatchRequest, CancellationToken) |
Initiates the asynchronous execution of the DeleteMessageBatch operation.
|
|
DeleteQueue(DeleteQueueRequest) |
This action unconditionally deletes the queue specified by the queue URL. Use this operation WITH CARE! The queue is deleted even if it is NOT empty. Once a queue has been deleted, the queue name is unavailable for use with new queues for 60 seconds. |
|
DeleteQueueAsync(DeleteQueueRequest, CancellationToken) |
Initiates the asynchronous execution of the DeleteQueue operation.
|
|
Dispose() | Disposes of all managed and unmanaged resources. |
|
GetQueueAttributes(GetQueueAttributesRequest) |
Gets attributes for the specified queue. The following attributes are supported:
|
|
GetQueueAttributesAsync(GetQueueAttributesRequest, CancellationToken) |
Initiates the asynchronous execution of the GetQueueAttributes operation.
|
|
GetQueueUrl(GetQueueUrlRequest) |
The |
|
GetQueueUrlAsync(GetQueueUrlRequest, CancellationToken) |
Initiates the asynchronous execution of the GetQueueUrl operation.
|
|
ListQueues(ListQueuesRequest) |
Returns a list of your queues. |
|
ListQueues() |
Returns a list of your queues. |
|
ListQueuesAsync(ListQueuesRequest, CancellationToken) |
Initiates the asynchronous execution of the ListQueues operation.
|
|
ReceiveMessage(ReceiveMessageRequest) |
Retrieves one or more messages from the specified queue, including the message body and message ID of each message. Messages returned
by this action stay in the queue until you delete them. However, once a message is returned to a If a
message is available in the queue, the call will return immediately. Otherwise, it will wait up to You could ask for additional information about each message through the attributes. Attributes that can be
requested are |
|
ReceiveMessageAsync(ReceiveMessageRequest, CancellationToken) |
Initiates the asynchronous execution of the ReceiveMessage operation.
|
|
RemovePermission(RemovePermissionRequest) |
The |
|
RemovePermissionAsync(RemovePermissionRequest, CancellationToken) |
Initiates the asynchronous execution of the RemovePermission operation.
|
|
SendMessage(SendMessageRequest) |
The |
|
SendMessageAsync(SendMessageRequest, CancellationToken) |
Initiates the asynchronous execution of the SendMessage operation.
|
|
SendMessageBatch(SendMessageBatchRequest) |
This is a batch version of SendMessage. It takes multiple messages and adds each of them to the queue. The result of each add operation is reported individually in the response. |
|
SendMessageBatchAsync(SendMessageBatchRequest, CancellationToken) |
Initiates the asynchronous execution of the SendMessageBatch operation.
|
|
SetQueueAttributes(SetQueueAttributesRequest) |
Sets the value of one or more queue attributes. Valid attributes that can be set are [VisibilityTimeout, Policy, MaximumMessageSize, MessageRetentionPeriod, ReceiveMessageWaitTimeSeconds]. |
|
SetQueueAttributesAsync(SetQueueAttributesRequest, CancellationToken) |
Initiates the asynchronous execution of the SetQueueAttributes operation.
|
Version Information
.NET Framework:
Supported in: 4.5, 4.0, 3.5
.NET for Windows Store apps:
Supported in: Windows 8
.NET for Windows Phone:
Supported in: Window Phone 8