AmazonSQSClient Class

.NET Framework 4.5
 
 
 
Did this page help you?  Yes  No   Tell us about it...
Implementation for accessing AmazonSQS. Amazon Simple Queue Service

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

Namespace: Amazon.SQS
Assembly: AWSSDK.dll
Version: 2.0.0.3

Syntax

C#
public class AmazonSQSClient : AmazonWebServiceClient
         IAmazonSQS, IDisposable

The AmazonSQSClient type exposes the following members

Constructors

  Name Description
Public Method 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>
             
Public Method 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>
             
Public Method 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>
             
Public Method AmazonSQSClient(AWSCredentials) Constructs AmazonSQSClient with AWS Credentials
Public Method AmazonSQSClient(AWSCredentials, RegionEndpoint) Constructs AmazonSQSClient with AWS Credentials
Public Method AmazonSQSClient(AWSCredentials, AmazonSQSConfig) Constructs AmazonSQSClient with AWS Credentials and an AmazonSQSClient Configuration object.
Public Method AmazonSQSClient(string, string) Constructs AmazonSQSClient with AWS Access Key ID and AWS Secret Key
Public Method AmazonSQSClient(string, string, RegionEndpoint) Constructs AmazonSQSClient with AWS Access Key ID and AWS Secret Key
Public Method 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.
Public Method AmazonSQSClient(string, string, string) Constructs AmazonSQSClient with AWS Access Key ID and AWS Secret Key
Public Method AmazonSQSClient(string, string, string, RegionEndpoint) Constructs AmazonSQSClient with AWS Access Key ID and AWS Secret Key
Public Method 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
Public Method 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.

AddPermission writes an SQS-generated policy. If you want to write your own policy, use SetQueueAttributes to upload your policy. For more information about writing your own policy, see Appendix: The Access Policy Language in the Amazon SQS Developer Guide.

Public Method AddPermissionAsync(AddPermissionRequest, CancellationToken) Initiates the asynchronous execution of the AddPermission operation.
Public Method ChangeMessageVisibility(ChangeMessageVisibilityRequest)

The ChangeMessageVisibility action changes the visibility timeout of a specified message in a queue to a new value. The maximum allowed timeout value you can set the value to is 12 hours. This means you can't extend the timeout of a message in an existing queue to more than a total visibility timeout of 12 hours. (For more information visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.)

For example, let's say you have a message and its default message visibility timeout is 30 minutes. You could call ChangeMessageVisiblity with a value of two hours and the effective timeout would be two hours and 30 minutes. When that time comes near you could again extend the time out by calling ChangeMessageVisiblity, but this time the maximum allowed timeout would be 9 hours and 30 minutes.

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.

Public Method ChangeMessageVisibilityAsync(ChangeMessageVisibilityRequest, CancellationToken) Initiates the asynchronous execution of the ChangeMessageVisibility operation.
Public Method 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.

Public Method ChangeMessageVisibilityBatchAsync(ChangeMessageVisibilityBatchRequest, CancellationToken) Initiates the asynchronous execution of the ChangeMessageVisibilityBatch operation.
Public Method CreateQueue(CreateQueueRequest)

The CreateQueue action creates a new queue, or returns the URL of an existing one. When you request CreateQueue , you provide a name for the queue. To successfully create a new queue, you must provide a name that is unique within the scope of your own queues.

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 QueueNameExists error is returned.

Public Method CreateQueueAsync(CreateQueueRequest, CancellationToken) Initiates the asynchronous execution of the CreateQueue operation.
Public Method DeleteMessage(DeleteMessageRequest)

The DeleteMessage action unconditionally removes the specified message from the specified queue. Even if the message is locked by another reader due to the visibility timeout setting, it is still deleted from the queue.

Public Method DeleteMessageAsync(DeleteMessageRequest, CancellationToken) Initiates the asynchronous execution of the DeleteMessage operation.
Public Method 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.

Public Method DeleteMessageBatchAsync(DeleteMessageBatchRequest, CancellationToken) Initiates the asynchronous execution of the DeleteMessageBatch operation.
Public Method 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.

Public Method DeleteQueueAsync(DeleteQueueRequest, CancellationToken) Initiates the asynchronous execution of the DeleteQueue operation.
Public Method Dispose() Disposes of all managed and unmanaged resources.
Public Method GetQueueAttributes(GetQueueAttributesRequest)

Gets attributes for the specified queue. The following attributes are supported:

  • All - returns all values.
  • ApproximateNumberOfMessages - returns the approximate number of visible messages in a queue. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide.
  • ApproximateNumberOfMessagesNotVisible - returns the approximate number of messages that are not timed-out and not deleted. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide.
  • VisibilityTimeout - returns the visibility timeout for the queue. For more information about visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.
  • CreatedTimestamp - returns the time when the queue was created (epoch time in seconds).
  • LastModifiedTimestamp - returns the time when the queue was last changed (epoch time in seconds).
  • Policy - returns the queue's policy.
  • MaximumMessageSize - returns the limit of how many bytes a message can contain before Amazon SQS rejects it.
  • MessageRetentionPeriod - returns the number of seconds Amazon SQS retains a message.
  • QueueArn - returns the queue's Amazon resource name (ARN).
  • ApproximateNumberOfMessagesDelayed - returns the approximate number of messages that are pending to be added to the queue.
  • DelaySeconds - returns the default delay on the queue in seconds.
  • ReceiveMessageWaitTimeSeconds - returns the time for which a ReceiveMessage call will wait for a message to arrive.

Public Method GetQueueAttributesAsync(GetQueueAttributesRequest, CancellationToken) Initiates the asynchronous execution of the GetQueueAttributes operation.
Public Method GetQueueUrl(GetQueueUrlRequest)

The GetQueueUrl action returns the URL of an existing queue.

Public Method GetQueueUrlAsync(GetQueueUrlRequest, CancellationToken) Initiates the asynchronous execution of the GetQueueUrl operation.
Public Method ListQueues(ListQueuesRequest)

Returns a list of your queues.

Public Method ListQueues()

Returns a list of your queues.

Public Method ListQueuesAsync(ListQueuesRequest, CancellationToken) Initiates the asynchronous execution of the ListQueues operation.
Public Method 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 ReceiveMessage request, it is not returned on subsequent ReceiveMessage requests for the duration of the VisibilityTimeout . If you do not specify a VisibilityTimeout in the request, the overall visibility timeout for the queue is used for the returned messages.

If a message is available in the queue, the call will return immediately. Otherwise, it will wait up to WaitTimeSeconds for a message to arrive. If you do not specify WaitTimeSeconds in the request, the queue attribute ReceiveMessageWaitTimeSeconds is used to determine how long to wait.

You could ask for additional information about each message through the attributes. Attributes that can be requested are [SenderId, ApproximateFirstReceiveTimestamp, ApproximateReceiveCount, SentTimestamp] .

Public Method ReceiveMessageAsync(ReceiveMessageRequest, CancellationToken) Initiates the asynchronous execution of the ReceiveMessage operation.
Public Method RemovePermission(RemovePermissionRequest)

The RemovePermission action revokes any permissions in the queue policy that matches the specified Label parameter. Only the owner of the queue can remove permissions.

Public Method RemovePermissionAsync(RemovePermissionRequest, CancellationToken) Initiates the asynchronous execution of the RemovePermission operation.
Public Method SendMessage(SendMessageRequest)

The SendMessage action delivers a message to the specified queue.

Public Method SendMessageAsync(SendMessageRequest, CancellationToken) Initiates the asynchronous execution of the SendMessage operation.
Public Method 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.

Public Method SendMessageBatchAsync(SendMessageBatchRequest, CancellationToken) Initiates the asynchronous execution of the SendMessageBatch operation.
Public Method SetQueueAttributes(SetQueueAttributesRequest)

Sets the value of one or more queue attributes. Valid attributes that can be set are [VisibilityTimeout, Policy, MaximumMessageSize, MessageRetentionPeriod, ReceiveMessageWaitTimeSeconds].

Public Method 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