/* * Copyright 2010-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ /* * Do not modify this file. This file is generated from the sqs-2012-11-05.normal.json service model. */ using System; using System.Collections.Generic; using Amazon.Runtime; using Amazon.SQS.Model; namespace Amazon.SQS { /// /// Interface for accessing SQS /// /// Welcome to the Amazon Simple Queue Service API Reference. /// /// /// /// Amazon Simple Queue Service (Amazon SQS) is a reliable, highly-scalable hosted queue /// for storing messages as they travel between applications or microservices. Amazon /// SQS moves data between distributed application components and helps you decouple these /// components. /// /// /// /// You can use AWS SDKs to access Amazon /// SQS using your favorite programming language. The SDKs perform tasks such as the following /// automatically: /// /// /// /// Additional Information /// /// /// public partial interface IAmazonSQS : IAmazonService, IDisposable { #region AddPermission /// /// Adds a permission to a queue for a specific principal. /// This allows sharing access to the queue. /// /// /// /// When you create a queue, you have full control access rights for the queue. Only you, /// the owner of the queue, can grant or deny permissions to the queue. For more information /// about these permissions, see Allow /// Developers to Write Messages to a Shared Queue in the Amazon Simple Queue Service /// Developer Guide. /// /// /// /// Some actions take lists of parameters. These lists are specified using the param.n /// notation. Values of n are integers starting from 1. For example, a parameter /// list with two elements looks like this: /// /// /// /// &Attribute.1=first /// /// /// /// &Attribute.2=second /// /// /// /// Cross-account permissions don't apply to this action. For more information, see Grant /// Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue /// Service Developer Guide. /// /// /// /// The URL of the Amazon SQS queue to which permissions are added. Queue URLs and names are case-sensitive. /// The unique identification of the permission you're setting (for example, AliceSendMessage). Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens (-), and underscores (_). /// The AWS account number of the principal who is given permission. The principal must have an AWS account, but does not need to be signed up for Amazon SQS. For information about locating the AWS account identification, see Your AWS Identifiers in the Amazon Simple Queue Service Developer Guide. /// The action the client wants to allow for the specified principal. Valid values: the name of any action or *. For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service Resource in the Amazon Simple Queue Service Developer Guide. Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for ActionName.n also grants permissions for the corresponding batch versions of those actions: SendMessageBatch, DeleteMessageBatch, and ChangeMessageVisibilityBatch. /// An Action delegate that is invoked when the operation completes. /// /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// /// The response from the AddPermission service method, as returned by SQS. /// /// The specified action violates a limit. For example, ReceiveMessage returns /// this error if the maximum number of inflight messages is reached and AddPermission /// returns this error if the maximum number of permissions for the queue is reached. /// /// REST API Reference for AddPermission Operation void AddPermissionAsync(string queueUrl, string label, List awsAccountIds, List actions, AmazonServiceCallback callback, AsyncOptions options = null); /// /// Initiates the asynchronous execution of the AddPermission operation. /// /// /// Container for the necessary parameters to execute the AddPermission operation on AmazonSQSClient. /// An Action delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// REST API Reference for AddPermission Operation void AddPermissionAsync(AddPermissionRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region ChangeMessageVisibility /// /// Changes the visibility timeout of a specified message in a queue to a new value. The /// default visibility timeout for a message is 30 seconds. The minimum is 0 seconds. /// The maximum is 12 hours. For more information, see Visibility /// Timeout in the Amazon Simple Queue Service Developer Guide. /// /// /// /// For example, you have a message with a visibility timeout of 5 minutes. After 3 minutes, /// you call ChangeMessageVisibility with a timeout of 10 minutes. You can /// continue to call ChangeMessageVisibility to extend the visibility timeout /// to the maximum allowed time. If you try to extend the visibility timeout beyond the /// maximum, your request is rejected. /// /// /// /// An Amazon SQS message has three basic states: /// ///
  1. /// /// Sent to a queue by a producer. /// ///
  2. /// /// Received from the queue by a consumer. /// ///
  3. /// /// Deleted from the queue. /// ///
/// /// A message is considered to be stored after it is sent to a queue by a producer, /// but not yet received from the queue by a consumer (that is, between states 1 and 2). /// There is no limit to the number of stored messages. A message is considered to be /// in flight after it is received from a queue by a consumer, but not yet deleted /// from the queue (that is, between states 2 and 3). There is a limit to the number of /// inflight messages. /// /// /// /// Limits that apply to inflight messages are unrelated to the unlimited number /// of stored messages. /// /// /// /// For most standard queues (depending on queue traffic and message backlog), there can /// be a maximum of approximately 120,000 inflight messages (received from a queue by /// a consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS /// returns the OverLimit error message. To avoid reaching the limit, you /// should delete messages from the queue after they're processed. You can also increase /// the number of queues you use to process your messages. To request a limit increase, /// file /// a support request. /// /// /// /// For FIFO queues, there can be a maximum of 20,000 inflight messages (received from /// a queue by a consumer, but not yet deleted from the queue). If you reach this limit, /// Amazon SQS returns no error messages. /// /// /// /// If you attempt to set the VisibilityTimeout to a value greater than the /// maximum time left, Amazon SQS returns an error. Amazon SQS doesn't automatically recalculate /// and increase the timeout to the maximum remaining time. /// /// /// /// Unlike with a queue, when you change the visibility timeout for a specific message /// the timeout value is applied immediately but isn't saved in memory for that message. /// If you don't delete a message after it is received, the visibility timeout for the /// message reverts to the original timeout value (not to the value you set using the /// ChangeMessageVisibility action) the next time the message is received. /// /// /// /// The URL of the Amazon SQS queue whose message's visibility is changed. Queue URLs and names are case-sensitive. /// The receipt handle associated with the message whose visibility timeout is changed. This parameter is returned by the ReceiveMessage action. /// The new value for the message's visibility timeout (in seconds). Values values: 0 to 43200. Maximum: 12 hours. /// An Action delegate that is invoked when the operation completes. /// /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// /// The response from the ChangeMessageVisibility service method, as returned by SQS. /// /// The specified message isn't in flight. /// /// /// The specified receipt handle isn't valid. /// /// REST API Reference for ChangeMessageVisibility Operation void ChangeMessageVisibilityAsync(string queueUrl, string receiptHandle, int visibilityTimeout, AmazonServiceCallback callback, AsyncOptions options = null); /// /// Initiates the asynchronous execution of the ChangeMessageVisibility operation. /// /// /// Container for the necessary parameters to execute the ChangeMessageVisibility operation on AmazonSQSClient. /// An Action delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// REST API Reference for ChangeMessageVisibility Operation void ChangeMessageVisibilityAsync(ChangeMessageVisibilityRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region ChangeMessageVisibilityBatch /// /// Changes the visibility timeout of multiple messages. This is a batch version of /// ChangeMessageVisibility. The result of the action on each message is /// reported individually in the response. You can send up to 10 ChangeMessageVisibility /// requests with each ChangeMessageVisibilityBatch action. /// /// /// /// Because the batch request can result in a combination of successful and unsuccessful /// actions, you should check for batch errors even when the call returns an HTTP status /// code of 200. /// /// /// /// Some actions take lists of parameters. These lists are specified using the param.n /// notation. Values of n are integers starting from 1. For example, a parameter /// list with two elements looks like this: /// /// /// /// &Attribute.1=first /// /// /// /// &Attribute.2=second /// /// /// The URL of the Amazon SQS queue whose messages' visibility is changed. Queue URLs and names are case-sensitive. /// A list of receipt handles of the messages for which the visibility timeout must be changed. /// An Action delegate that is invoked when the operation completes. /// /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// /// The response from the ChangeMessageVisibilityBatch service method, as returned by SQS. /// /// Two or more batch entries in the request have the same Id. /// /// /// The batch request doesn't contain any entries. /// /// /// The Id of a batch entry in a batch request doesn't abide by the specification. /// /// /// The batch request contains more entries than permissible. /// /// REST API Reference for ChangeMessageVisibilityBatch Operation void ChangeMessageVisibilityBatchAsync(string queueUrl, List entries, AmazonServiceCallback callback, AsyncOptions options = null); /// /// Initiates the asynchronous execution of the ChangeMessageVisibilityBatch operation. /// /// /// Container for the necessary parameters to execute the ChangeMessageVisibilityBatch operation on AmazonSQSClient. /// An Action delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// REST API Reference for ChangeMessageVisibilityBatch Operation void ChangeMessageVisibilityBatchAsync(ChangeMessageVisibilityBatchRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region CreateQueue /// /// Creates a new standard or FIFO queue. You can pass one or more attributes in the request. /// Keep the following caveats in mind: /// ///
  • /// /// If you don't specify the FifoQueue attribute, Amazon SQS creates a standard /// queue. /// /// /// /// You can't change the queue type after you create it and you can't convert an existing /// standard queue into a FIFO queue. You must either create a new FIFO queue for your /// application or delete your existing standard queue and recreate it as a FIFO queue. /// For more information, see Moving /// From a Standard Queue to a FIFO Queue in the Amazon Simple Queue Service Developer /// Guide. /// ///
  • /// /// If you don't provide a value for an attribute, the queue is created with the default /// value for the attribute. /// ///
  • /// /// If you delete a queue, you must wait at least 60 seconds before creating a queue with /// the same name. /// ///
/// /// To successfully create a new queue, you must provide a queue name that adheres to /// the limits /// related to queues and is unique within the scope of your queues. /// /// /// /// To get the queue URL, use the GetQueueUrl action. GetQueueUrl /// requires only the QueueName parameter. be aware of existing queue /// names: /// ///
  • /// /// If you provide the name of an existing queue along with the exact names and values /// of all the queue's attributes, CreateQueue returns the queue URL for /// the existing queue. /// ///
  • /// /// If the queue name, attribute names, or attribute values don't match an existing queue, /// CreateQueue returns an error. /// ///
/// /// Some actions take lists of parameters. These lists are specified using the param.n /// notation. Values of n are integers starting from 1. For example, a parameter /// list with two elements looks like this: /// /// /// /// &Attribute.1=first /// /// /// /// &Attribute.2=second /// /// /// /// Cross-account permissions don't apply to this action. For more information, see Grant /// Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue /// Service Developer Guide. /// /// /// /// The name of the new queue. The following limits apply to this name:
  • A queue name can have up to 80 characters.
  • Valid values: alphanumeric characters, hyphens (-), and underscores (_).
  • A FIFO queue name must end with the .fifo suffix.
Queue URLs and names are case-sensitive. /// An Action delegate that is invoked when the operation completes. /// /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// /// The response from the CreateQueue service method, as returned by SQS. /// /// You must wait 60 seconds after deleting a queue before you can create another queue /// with the same name. /// /// /// A queue with this name already exists. Amazon SQS returns this error only if the request /// includes attributes whose values differ from those of the existing queue. /// /// REST API Reference for CreateQueue Operation void CreateQueueAsync(string queueName, AmazonServiceCallback callback, AsyncOptions options = null); /// /// Initiates the asynchronous execution of the CreateQueue operation. /// /// /// Container for the necessary parameters to execute the CreateQueue operation on AmazonSQSClient. /// An Action delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// REST API Reference for CreateQueue Operation void CreateQueueAsync(CreateQueueRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region DeleteMessage /// /// Deletes the specified message from the specified queue. To select the message to delete, /// use the ReceiptHandle of the message (not the MessageId /// which you receive when you send the message). Amazon SQS can delete a message from /// a queue even if a visibility timeout setting causes the message to be locked by another /// consumer. Amazon SQS automatically deletes messages left in a queue longer than the /// retention period configured for the queue. /// /// /// /// The ReceiptHandle is associated with a specific instance of receiving /// a message. If you receive a message more than once, the ReceiptHandle /// is different each time you receive a message. When you use the DeleteMessage /// action, you must provide the most recently received ReceiptHandle for /// the message (otherwise, the request succeeds, but the message might not be deleted). /// /// /// /// For standard queues, it is possible to receive a message even after you delete it. /// This might happen on rare occasions if one of the servers which stores a copy of the /// message is unavailable when you send the request to delete the message. The copy remains /// on the server and might be returned to you during a subsequent receive request. You /// should ensure that your application is idempotent, so that receiving a message more /// than once does not cause issues. /// /// /// /// The URL of the Amazon SQS queue from which messages are deleted. Queue URLs and names are case-sensitive. /// The receipt handle associated with the message to delete. /// An Action delegate that is invoked when the operation completes. /// /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// /// The response from the DeleteMessage service method, as returned by SQS. /// /// The specified receipt handle isn't valid for the current version. /// /// /// The specified receipt handle isn't valid. /// /// REST API Reference for DeleteMessage Operation void DeleteMessageAsync(string queueUrl, string receiptHandle, AmazonServiceCallback callback, AsyncOptions options = null); /// /// Initiates the asynchronous execution of the DeleteMessage operation. /// /// /// Container for the necessary parameters to execute the DeleteMessage operation on AmazonSQSClient. /// An Action delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// REST API Reference for DeleteMessage Operation void DeleteMessageAsync(DeleteMessageRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region DeleteMessageBatch /// /// Deletes up to ten messages from the specified queue. This is a batch version of /// DeleteMessage. The result of the action on each message is reported /// individually in the response. /// /// /// /// Because the batch request can result in a combination of successful and unsuccessful /// actions, you should check for batch errors even when the call returns an HTTP status /// code of 200. /// /// /// /// Some actions take lists of parameters. These lists are specified using the param.n /// notation. Values of n are integers starting from 1. For example, a parameter /// list with two elements looks like this: /// /// /// /// &Attribute.1=first /// /// /// /// &Attribute.2=second /// /// /// The URL of the Amazon SQS queue from which messages are deleted. Queue URLs and names are case-sensitive. /// A list of receipt handles for the messages to be deleted. /// An Action delegate that is invoked when the operation completes. /// /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// /// The response from the DeleteMessageBatch service method, as returned by SQS. /// /// Two or more batch entries in the request have the same Id. /// /// /// The batch request doesn't contain any entries. /// /// /// The Id of a batch entry in a batch request doesn't abide by the specification. /// /// /// The batch request contains more entries than permissible. /// /// REST API Reference for DeleteMessageBatch Operation void DeleteMessageBatchAsync(string queueUrl, List entries, AmazonServiceCallback callback, AsyncOptions options = null); /// /// Initiates the asynchronous execution of the DeleteMessageBatch operation. /// /// /// Container for the necessary parameters to execute the DeleteMessageBatch operation on AmazonSQSClient. /// An Action delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// REST API Reference for DeleteMessageBatch Operation void DeleteMessageBatchAsync(DeleteMessageBatchRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region DeleteQueue /// /// Deletes the queue specified by the QueueUrl, regardless of the queue's /// contents. If the specified queue doesn't exist, Amazon SQS returns a successful response. /// /// /// /// Be careful with the DeleteQueue action: When you delete a queue, any /// messages in the queue are no longer available. /// /// /// /// When you delete a queue, the deletion process takes up to 60 seconds. Requests you /// send involving that queue during the 60 seconds might succeed. For example, a /// SendMessage request might succeed, but after 60 seconds the queue and /// the message you sent no longer exist. /// /// /// /// When you delete a queue, you must wait at least 60 seconds before creating a queue /// with the same name. /// /// /// /// Cross-account permissions don't apply to this action. For more information, see Grant /// Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue /// Service Developer Guide. /// /// /// /// The URL of the Amazon SQS queue to delete. Queue URLs and names are case-sensitive. /// An Action delegate that is invoked when the operation completes. /// /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// /// The response from the DeleteQueue service method, as returned by SQS. /// REST API Reference for DeleteQueue Operation void DeleteQueueAsync(string queueUrl, AmazonServiceCallback callback, AsyncOptions options = null); /// /// Initiates the asynchronous execution of the DeleteQueue operation. /// /// /// Container for the necessary parameters to execute the DeleteQueue operation on AmazonSQSClient. /// An Action delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// REST API Reference for DeleteQueue Operation void DeleteQueueAsync(DeleteQueueRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region GetQueueAttributes /// /// Gets attributes for the specified queue. /// /// /// /// To determine whether a queue is FIFO, /// you can check whether QueueName ends with the .fifo suffix. /// /// /// /// Some actions take lists of parameters. These lists are specified using the param.n /// notation. Values of n are integers starting from 1. For example, a parameter /// list with two elements looks like this: /// /// /// /// &Attribute.1=first /// /// /// /// &Attribute.2=second /// /// /// The URL of the Amazon SQS queue whose attribute information is retrieved. Queue URLs and names are case-sensitive. /// A list of attributes for which to retrieve information. In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully. The following attributes are supported:
  • All - Returns all values.
  • ApproximateNumberOfMessages - Returns the approximate number of messages available for retrieval from the queue.
  • ApproximateNumberOfMessagesDelayed - Returns the approximate number of messages in the queue that are delayed and not available for reading immediately. This can happen when the queue is configured as a delay queue or when a message has been sent with a delay parameter.
  • ApproximateNumberOfMessagesNotVisible - Returns the approximate number of messages that are in flight. Messages are considered to be in flight if they have been sent to a client but have not yet been deleted or have not yet reached the end of their visibility window.
  • CreatedTimestamp - Returns the time when the queue was created in seconds (epoch time).
  • DelaySeconds - Returns the default delay on the queue in seconds.
  • LastModifiedTimestamp - Returns the time when the queue was last changed in seconds (epoch time).
  • MaximumMessageSize - Returns the limit of how many bytes a message can contain before Amazon SQS rejects it.
  • MessageRetentionPeriod - Returns the length of time, in seconds, for which Amazon SQS retains a message.
  • Policy - Returns the policy of the queue.
  • QueueArn - Returns the Amazon resource name (ARN) of the queue.
  • ReceiveMessageWaitTimeSeconds - Returns the length of time, in seconds, for which the ReceiveMessage action waits for a message to arrive.
  • RedrivePolicy - Returns the string that includes the parameters for dead-letter queue functionality of the source queue. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon Simple Queue Service Developer Guide.
    • deadLetterTargetArn - The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
    • maxReceiveCount - The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.
  • VisibilityTimeout - Returns the visibility timeout for the queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.
The following attributes apply only to server-side-encryption:
  • KmsMasterKeyId - Returns the ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.
  • KmsDataKeyReusePeriodSeconds - Returns the length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. For more information, see How Does the Data Key Reuse Period Work?.
The following attributes apply only to FIFO (first-in-first-out) queues:
  • FifoQueue - Returns whether the queue is FIFO. For more information, see FIFO Queue Logic in the Amazon Simple Queue Service Developer Guide. To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.
  • ContentBasedDeduplication - Returns whether content-based deduplication is enabled for the queue. For more information, see Exactly-Once Processing in the Amazon Simple Queue Service Developer Guide.
/// An Action delegate that is invoked when the operation completes. /// /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// /// The response from the GetQueueAttributes service method, as returned by SQS. /// /// The specified attribute doesn't exist. /// /// REST API Reference for GetQueueAttributes Operation void GetQueueAttributesAsync(string queueUrl, List attributeNames, AmazonServiceCallback callback, AsyncOptions options = null); /// /// Initiates the asynchronous execution of the GetQueueAttributes operation. /// /// /// Container for the necessary parameters to execute the GetQueueAttributes operation on AmazonSQSClient. /// An Action delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// REST API Reference for GetQueueAttributes Operation void GetQueueAttributesAsync(GetQueueAttributesRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region GetQueueUrl /// /// Returns the URL of an existing Amazon SQS queue. /// /// /// /// To access a queue that belongs to another AWS account, use the QueueOwnerAWSAccountId /// parameter to specify the account ID of the queue's owner. The queue's owner must grant /// you permission to access the queue. For more information about shared queue access, /// see AddPermission or see Allow /// Developers to Write Messages to a Shared Queue in the Amazon Simple Queue Service /// Developer Guide. /// /// /// The name of the queue whose URL must be fetched. Maximum 80 characters. Valid values: alphanumeric characters, hyphens (-), and underscores (_). Queue URLs and names are case-sensitive. /// An Action delegate that is invoked when the operation completes. /// /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// /// The response from the GetQueueUrl service method, as returned by SQS. /// /// The specified queue doesn't exist. /// /// REST API Reference for GetQueueUrl Operation void GetQueueUrlAsync(string queueName, AmazonServiceCallback callback, AsyncOptions options = null); /// /// Initiates the asynchronous execution of the GetQueueUrl operation. /// /// /// Container for the necessary parameters to execute the GetQueueUrl operation on AmazonSQSClient. /// An Action delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// REST API Reference for GetQueueUrl Operation void GetQueueUrlAsync(GetQueueUrlRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region ListDeadLetterSourceQueues /// /// Initiates the asynchronous execution of the ListDeadLetterSourceQueues operation. /// /// /// Container for the necessary parameters to execute the ListDeadLetterSourceQueues operation on AmazonSQSClient. /// An Action delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// REST API Reference for ListDeadLetterSourceQueues Operation void ListDeadLetterSourceQueuesAsync(ListDeadLetterSourceQueuesRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region ListQueues /// /// Returns a list of your queues. The maximum number of queues that can be returned is /// 1,000. If you specify a value for the optional QueueNamePrefix parameter, /// only queues with a name that begins with the specified value are returned. /// /// /// /// Cross-account permissions don't apply to this action. For more information, see Grant /// Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue /// Service Developer Guide. /// /// /// /// A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned. Queue URLs and names are case-sensitive. /// An Action delegate that is invoked when the operation completes. /// /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// /// The response from the ListQueues service method, as returned by SQS. /// REST API Reference for ListQueues Operation void ListQueuesAsync(string queueNamePrefix, AmazonServiceCallback callback, AsyncOptions options = null); /// /// Initiates the asynchronous execution of the ListQueues operation. /// /// /// Container for the necessary parameters to execute the ListQueues operation on AmazonSQSClient. /// An Action delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// REST API Reference for ListQueues Operation void ListQueuesAsync(ListQueuesRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region ListQueueTags /// /// Initiates the asynchronous execution of the ListQueueTags operation. /// /// /// Container for the necessary parameters to execute the ListQueueTags operation on AmazonSQSClient. /// An Action delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// REST API Reference for ListQueueTags Operation void ListQueueTagsAsync(ListQueueTagsRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region PurgeQueue /// /// Deletes the messages in a queue specified by the QueueURL parameter. /// /// /// /// When you use the PurgeQueue action, you can't retrieve any messages deleted /// from a queue. /// /// /// /// The message deletion process takes up to 60 seconds. We recommend waiting for 60 seconds /// regardless of your queue's size. /// /// /// /// Messages sent to the queue before you call PurgeQueue might be /// received but are deleted within the next minute. /// /// /// /// Messages sent to the queue after you call PurgeQueue might be /// deleted while the queue is being purged. /// /// /// The URL of the queue from which the PurgeQueue action deletes messages. Queue URLs and names are case-sensitive. /// An Action delegate that is invoked when the operation completes. /// /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// /// The response from the PurgeQueue service method, as returned by SQS. /// /// Indicates that the specified queue previously received a PurgeQueue request /// within the last 60 seconds (the time it can take to delete the messages in the queue). /// /// /// The specified queue doesn't exist. /// /// REST API Reference for PurgeQueue Operation void PurgeQueueAsync(string queueUrl, AmazonServiceCallback callback, AsyncOptions options = null); /// /// Initiates the asynchronous execution of the PurgeQueue operation. /// /// /// Container for the necessary parameters to execute the PurgeQueue operation on AmazonSQSClient. /// An Action delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// REST API Reference for PurgeQueue Operation void PurgeQueueAsync(PurgeQueueRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region ReceiveMessage /// /// Retrieves one or more messages (up to 10), from the specified queue. Using the WaitTimeSeconds /// parameter enables long-poll support. For more information, see Amazon /// SQS Long Polling in the Amazon Simple Queue Service Developer Guide. /// /// /// /// Short poll is the default behavior where a weighted random set of machines is sampled /// on a ReceiveMessage call. Thus, only the messages on the sampled machines /// are returned. If the number of messages in the queue is small (fewer than 1,000), /// you most likely get fewer messages than you requested per ReceiveMessage /// call. If the number of messages in the queue is extremely small, you might not receive /// any messages in a particular ReceiveMessage response. If this happens, /// repeat the request. /// /// /// /// For each message returned, the response includes the following: /// ///
  • /// /// The message body. /// ///
  • /// /// An MD5 digest of the message body. For information about MD5, see RFC1321. /// ///
  • /// /// The MessageId you received when you sent the message to the queue. /// ///
  • /// /// The receipt handle. /// ///
  • /// /// The message attributes. /// ///
  • /// /// An MD5 digest of the message attributes. /// ///
/// /// The receipt handle is the identifier you must provide when deleting the message. For /// more information, see Queue /// and Message Identifiers in the Amazon Simple Queue Service Developer Guide. /// /// /// /// You can provide the VisibilityTimeout parameter in your request. The /// parameter is applied to the messages that Amazon SQS returns in the response. If you /// don't include the parameter, the overall visibility timeout for the queue is used /// for the returned messages. For more information, see Visibility /// Timeout in the Amazon Simple Queue Service Developer Guide. /// /// /// /// A message that isn't deleted or a message whose visibility isn't extended before the /// visibility timeout expires counts as a failed receive. Depending on the configuration /// of the queue, the message might be sent to the dead-letter queue. /// /// /// /// In the future, new attributes might be added. If you write code that calls this action, /// we recommend that you structure your code so that it can handle new attributes gracefully. /// /// /// /// The URL of the Amazon SQS queue from which messages are received. Queue URLs and names are case-sensitive. /// An Action delegate that is invoked when the operation completes. /// /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// /// The response from the ReceiveMessage service method, as returned by SQS. /// /// The specified action violates a limit. For example, ReceiveMessage returns /// this error if the maximum number of inflight messages is reached and AddPermission /// returns this error if the maximum number of permissions for the queue is reached. /// /// REST API Reference for ReceiveMessage Operation void ReceiveMessageAsync(string queueUrl, AmazonServiceCallback callback, AsyncOptions options = null); /// /// Initiates the asynchronous execution of the ReceiveMessage operation. /// /// /// Container for the necessary parameters to execute the ReceiveMessage operation on AmazonSQSClient. /// An Action delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// REST API Reference for ReceiveMessage Operation void ReceiveMessageAsync(ReceiveMessageRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region RemovePermission /// /// Revokes any permissions in the queue policy that matches the specified Label /// parameter. /// ///
  • /// /// Only the owner of a queue can remove permissions from it. /// ///
  • /// /// Cross-account permissions don't apply to this action. For more information, see Grant /// Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue /// Service Developer Guide. /// ///
  • /// /// To remove the ability to change queue permissions, you must deny permission to the /// AddPermission, RemovePermission, and SetQueueAttributes /// actions in your IAM policy. /// ///
/// /// The URL of the Amazon SQS queue from which permissions are removed. Queue URLs and names are case-sensitive. /// The identification of the permission to remove. This is the label added using the AddPermission action. /// An Action delegate that is invoked when the operation completes. /// /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// /// The response from the RemovePermission service method, as returned by SQS. /// REST API Reference for RemovePermission Operation void RemovePermissionAsync(string queueUrl, string label, AmazonServiceCallback callback, AsyncOptions options = null); /// /// Initiates the asynchronous execution of the RemovePermission operation. /// /// /// Container for the necessary parameters to execute the RemovePermission operation on AmazonSQSClient. /// An Action delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// REST API Reference for RemovePermission Operation void RemovePermissionAsync(RemovePermissionRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region SendMessage /// /// 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. /// /// /// /// The URL of the Amazon SQS queue to which a message is sent. Queue URLs and names are case-sensitive. /// 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. /// An Action delegate that is invoked when the operation completes. /// /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// /// The response from the SendMessage service method, as returned by SQS. /// /// The message contains characters outside the allowed set. /// /// /// Error code 400. Unsupported operation. /// /// REST API Reference for SendMessage Operation void SendMessageAsync(string queueUrl, string messageBody, AmazonServiceCallback callback, AsyncOptions options = null); /// /// Initiates the asynchronous execution of the SendMessage operation. /// /// /// Container for the necessary parameters to execute the SendMessage operation on AmazonSQSClient. /// An Action delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// REST API Reference for SendMessage Operation void SendMessageAsync(SendMessageRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region SendMessageBatch /// /// Delivers up to ten messages to the specified queue. This is a batch version of /// SendMessage. For a FIFO queue, multiple messages within a single batch /// are enqueued in the order they are sent. /// /// /// /// The result of sending each message is reported individually in the response. Because /// the batch request can result in a combination of successful and unsuccessful actions, /// you should check for batch errors even when the call returns an HTTP status code of /// 200. /// /// /// /// The maximum allowed individual message size and the maximum total payload size (the /// sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 /// bytes). /// /// /// /// 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. /// /// /// /// If you don't specify the DelaySeconds parameter for an entry, Amazon /// SQS uses the default value for the queue. /// /// /// /// Some actions take lists of parameters. These lists are specified using the param.n /// notation. Values of n are integers starting from 1. For example, a parameter /// list with two elements looks like this: /// /// /// /// &Attribute.1=first /// /// /// /// &Attribute.2=second /// /// /// The URL of the Amazon SQS queue to which batched messages are sent. Queue URLs and names are case-sensitive. /// A list of SendMessageBatchRequestEntry items. /// An Action delegate that is invoked when the operation completes. /// /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// /// The response from the SendMessageBatch service method, as returned by SQS. /// /// Two or more batch entries in the request have the same Id. /// /// /// The length of all the messages put together is more than the limit. /// /// /// The batch request doesn't contain any entries. /// /// /// The Id of a batch entry in a batch request doesn't abide by the specification. /// /// /// The batch request contains more entries than permissible. /// /// /// Error code 400. Unsupported operation. /// /// REST API Reference for SendMessageBatch Operation void SendMessageBatchAsync(string queueUrl, List entries, AmazonServiceCallback callback, AsyncOptions options = null); /// /// Initiates the asynchronous execution of the SendMessageBatch operation. /// /// /// Container for the necessary parameters to execute the SendMessageBatch operation on AmazonSQSClient. /// An Action delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// REST API Reference for SendMessageBatch Operation void SendMessageBatchAsync(SendMessageBatchRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region SetQueueAttributes /// /// Sets the value of one or more queue attributes. When you change a queue's attributes, /// the change can take up to 60 seconds for most of the attributes to propagate throughout /// the Amazon SQS system. Changes made to the MessageRetentionPeriod attribute /// can take up to 15 minutes. /// ///
  • /// /// In the future, new attributes might be added. If you write code that calls this action, /// we recommend that you structure your code so that it can handle new attributes gracefully. /// ///
  • /// /// Cross-account permissions don't apply to this action. For more information, see Grant /// Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue /// Service Developer Guide. /// ///
  • /// /// To remove the ability to change queue permissions, you must deny permission to the /// AddPermission, RemovePermission, and SetQueueAttributes /// actions in your IAM policy. /// ///
/// /// The URL of the Amazon SQS queue whose attributes are set. Queue URLs and names are case-sensitive. /// A map of attributes to set. The following lists the names, descriptions, and values of the special request parameters that the SetQueueAttributes action uses:
  • DelaySeconds - The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 (15 minutes). Default: 0.
  • MaximumMessageSize - The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).
  • MessageRetentionPeriod - The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer representing seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days).
  • Policy - The queue's policy. A valid AWS policy. For more information about policy structure, see Overview of AWS IAM Policies in the Amazon IAM User Guide.
  • ReceiveMessageWaitTimeSeconds - The length of time, in seconds, for which a ReceiveMessage action waits for a message to arrive. Valid values: an integer from 0 to 20 (seconds). Default: 0.
  • RedrivePolicy - The string that includes the parameters for the dead-letter queue functionality of the source queue. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon Simple Queue Service Developer Guide.
    • deadLetterTargetArn - The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
    • maxReceiveCount - The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.
    The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.
  • VisibilityTimeout - The visibility timeout for the queue, in seconds. Valid values: an integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.
The following attributes apply only to server-side-encryption:
  • KmsMasterKeyId - The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms. While the alias of the AWS-managed CMK for Amazon SQS is always alias/aws/sqs, the alias of a custom CMK can, for example, be alias/MyAlias . For more examples, see KeyId in the AWS Key Management Service API Reference.
  • KmsDataKeyReusePeriodSeconds - The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time period provides better security but results in more calls to KMS which might incur charges after Free Tier. For more information, see How Does the Data Key Reuse Period Work?.
The following attribute applies only to FIFO (first-in-first-out) queues:
  • ContentBasedDeduplication - Enables content-based deduplication. 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.
/// An Action delegate that is invoked when the operation completes. /// /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// /// The response from the SetQueueAttributes service method, as returned by SQS. /// /// The specified attribute doesn't exist. /// /// REST API Reference for SetQueueAttributes Operation void SetQueueAttributesAsync(string queueUrl, Dictionary attributes, AmazonServiceCallback callback, AsyncOptions options = null); /// /// Initiates the asynchronous execution of the SetQueueAttributes operation. /// /// /// Container for the necessary parameters to execute the SetQueueAttributes operation on AmazonSQSClient. /// An Action delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// REST API Reference for SetQueueAttributes Operation void SetQueueAttributesAsync(SetQueueAttributesRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region TagQueue /// /// Initiates the asynchronous execution of the TagQueue operation. /// /// /// Container for the necessary parameters to execute the TagQueue operation on AmazonSQSClient. /// An Action delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// REST API Reference for TagQueue Operation void TagQueueAsync(TagQueueRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region UntagQueue /// /// Initiates the asynchronous execution of the UntagQueue operation. /// /// /// Container for the necessary parameters to execute the UntagQueue operation on AmazonSQSClient. /// An Action delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// REST API Reference for UntagQueue Operation void UntagQueueAsync(UntagQueueRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion } }