C# Class Amazon.SQS.AmazonSQSClient

Inheritance: AmazonServiceClient, IAmazonSQS
Show file Open project: aws/aws-sdk-net Class Usage Examples

Public Methods

Method Description
AddPermission ( AddPermissionRequest request ) : Amazon.SQS.Model.AddPermissionResponse

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 Shared Queues in the Amazon SQS Developer Guide.

AddPermission writes an Amazon-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 Using The Access Policy Language in the Amazon SQS 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=this

&Attribute.2=that

AddPermission ( string queueUrl, string label, List awsAccountIds, List actions ) : Amazon.SQS.Model.AddPermissionResponse

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 Shared Queues in the Amazon SQS Developer Guide.

AddPermission writes an Amazon-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 Using The Access Policy Language in the Amazon SQS 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=this

&Attribute.2=that

AddPermissionAsync ( AddPermissionRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the AddPermission operation.

AddPermissionAsync ( string queueUrl, string label, List awsAccountIds, List actions, System cancellationToken = default(CancellationToken) ) : Task

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 Shared Queues in the Amazon SQS Developer Guide.

AddPermission writes an Amazon-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 Using The Access Policy Language in the Amazon SQS 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=this

&Attribute.2=that

AddPermissionAsync ( AddPermissionRequest request, AddPermissionResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

Initiates the asynchronous execution of the AddPermission operation.

AddPermissionAsync ( string queueUrl, string label, List awsAccountIds, List actions, AddPermissionResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

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 Shared Queues in the Amazon SQS Developer Guide.

AddPermission writes an Amazon-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 Using The Access Policy Language in the Amazon SQS 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=this

&Attribute.2=that

AmazonSQSClient ( ) : System

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="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>

AmazonSQSClient ( AWSCredentials credentials ) : System

Constructs AmazonSQSClient with AWS Credentials

AmazonSQSClient ( AWSCredentials credentials, AmazonSQSConfig clientConfig ) : System

Constructs AmazonSQSClient with AWS Credentials and an AmazonSQSClient Configuration object.

AmazonSQSClient ( AWSCredentials credentials, RegionEndpoint region ) : System

Constructs AmazonSQSClient with AWS Credentials

AmazonSQSClient ( AmazonSQSConfig config ) : System

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="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>

AmazonSQSClient ( RegionEndpoint region ) : System

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="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>

AmazonSQSClient ( string awsAccessKeyId, string awsSecretAccessKey ) : System

Constructs AmazonSQSClient with AWS Access Key ID and AWS Secret Key

AmazonSQSClient ( string awsAccessKeyId, string awsSecretAccessKey, AmazonSQSConfig clientConfig ) : System

Constructs AmazonSQSClient with AWS Access Key ID, AWS Secret Key and an AmazonSQSClient Configuration object.

AmazonSQSClient ( string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region ) : System

Constructs AmazonSQSClient with AWS Access Key ID and AWS Secret Key

AmazonSQSClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken ) : System

Constructs AmazonSQSClient with AWS Access Key ID and AWS Secret Key

AmazonSQSClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonSQSConfig clientConfig ) : System

Constructs AmazonSQSClient with AWS Access Key ID, AWS Secret Key and an AmazonSQSClient Configuration object.

AmazonSQSClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region ) : System

Constructs AmazonSQSClient with AWS Access Key ID and AWS Secret Key

AuthorizeS3ToSendMessage ( string queueUrl, string bucket ) : string

This is a utility method which updates the policy of a queue to allow the S3 bucket to publish events to it.

AuthorizeS3ToSendMessageAsync ( string queueUrl, string bucket ) : Task

This is a utility method which updates the policy of a queue to allow the S3 bucket to publish events to it.

BeginAddPermission ( AddPermissionRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the AddPermission operation.

BeginChangeMessageVisibility ( ChangeMessageVisibilityRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the ChangeMessageVisibility operation.

BeginChangeMessageVisibilityBatch ( ChangeMessageVisibilityBatchRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the ChangeMessageVisibilityBatch operation.

BeginCreateQueue ( CreateQueueRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the CreateQueue operation.

BeginDeleteMessage ( DeleteMessageRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DeleteMessage operation.

BeginDeleteMessageBatch ( DeleteMessageBatchRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DeleteMessageBatch operation.

BeginDeleteQueue ( DeleteQueueRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DeleteQueue operation.

BeginGetQueueAttributes ( GetQueueAttributesRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the GetQueueAttributes operation.

BeginGetQueueUrl ( GetQueueUrlRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the GetQueueUrl operation.

BeginListDeadLetterSourceQueues ( ListDeadLetterSourceQueuesRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the ListDeadLetterSourceQueues operation.

BeginListQueues ( ListQueuesRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the ListQueues operation.

BeginPurgeQueue ( PurgeQueueRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the PurgeQueue operation.

BeginReceiveMessage ( ReceiveMessageRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the ReceiveMessage operation.

BeginRemovePermission ( RemovePermissionRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the RemovePermission operation.

BeginSendMessage ( SendMessageRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the SendMessage operation.

BeginSendMessageBatch ( SendMessageBatchRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the SendMessageBatch operation.

BeginSetQueueAttributes ( SetQueueAttributesRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the SetQueueAttributes operation.

ChangeMessageVisibility ( ChangeMessageVisibilityRequest request ) : Amazon.SQS.Model.ChangeMessageVisibilityResponse

Changes the visibility timeout of a specified message in a queue to a new value. The maximum allowed timeout value is 12 hours. Thus, 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, see Visibility Timeout in the Amazon SQS Developer Guide.

For example, you have a message and with the default visibility timeout of 5 minutes. After 3 minutes, you call ChangeMessageVisiblity with a timeout of 10 minutes. At that time, the timeout for the message is extended by 10 minutes beyond the time of the ChangeMessageVisibility action. This results in a total visibility timeout of 13 minutes. You can continue to call the ChangeMessageVisibility to extend the visibility timeout to a maximum of 12 hours. If you try to extend the visibility timeout beyond 12 hours, your request is rejected.

A message is considered to be in flight after it's received from a queue by a consumer, but not yet deleted from the queue.

For standard queues, there can be a maximum of 120,000 inflight messages per 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.

For FIFO queues, there can be a maximum of 20,000 inflight messages per 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.

ChangeMessageVisibility ( string queueUrl, string receiptHandle, int visibilityTimeout ) : Amazon.SQS.Model.ChangeMessageVisibilityResponse

Changes the visibility timeout of a specified message in a queue to a new value. The maximum allowed timeout value is 12 hours. Thus, 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, see Visibility Timeout in the Amazon SQS Developer Guide.

For example, you have a message and with the default visibility timeout of 5 minutes. After 3 minutes, you call ChangeMessageVisiblity with a timeout of 10 minutes. At that time, the timeout for the message is extended by 10 minutes beyond the time of the ChangeMessageVisibility action. This results in a total visibility timeout of 13 minutes. You can continue to call the ChangeMessageVisibility to extend the visibility timeout to a maximum of 12 hours. If you try to extend the visibility timeout beyond 12 hours, your request is rejected.

A message is considered to be in flight after it's received from a queue by a consumer, but not yet deleted from the queue.

For standard queues, there can be a maximum of 120,000 inflight messages per 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.

For FIFO queues, there can be a maximum of 20,000 inflight messages per 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.

ChangeMessageVisibilityAsync ( ChangeMessageVisibilityRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the ChangeMessageVisibility operation.

ChangeMessageVisibilityAsync ( string queueUrl, string receiptHandle, int visibilityTimeout, System cancellationToken = default(CancellationToken) ) : Task

Changes the visibility timeout of a specified message in a queue to a new value. The maximum allowed timeout value is 12 hours. Thus, 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, see Visibility Timeout in the Amazon SQS Developer Guide.

For example, you have a message and with the default visibility timeout of 5 minutes. After 3 minutes, you call ChangeMessageVisiblity with a timeout of 10 minutes. At that time, the timeout for the message is extended by 10 minutes beyond the time of the ChangeMessageVisibility action. This results in a total visibility timeout of 13 minutes. You can continue to call the ChangeMessageVisibility to extend the visibility timeout to a maximum of 12 hours. If you try to extend the visibility timeout beyond 12 hours, your request is rejected.

A message is considered to be in flight after it's received from a queue by a consumer, but not yet deleted from the queue.

For standard queues, there can be a maximum of 120,000 inflight messages per 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.

For FIFO queues, there can be a maximum of 20,000 inflight messages per 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.

ChangeMessageVisibilityAsync ( ChangeMessageVisibilityRequest request, ChangeMessageVisibilityResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

Initiates the asynchronous execution of the ChangeMessageVisibility operation.

ChangeMessageVisibilityAsync ( string queueUrl, string receiptHandle, int visibilityTimeout, ChangeMessageVisibilityResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

Changes the visibility timeout of a specified message in a queue to a new value. The maximum allowed timeout value is 12 hours. Thus, 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, see Visibility Timeout in the Amazon SQS Developer Guide.

For example, you have a message and with the default visibility timeout of 5 minutes. After 3 minutes, you call ChangeMessageVisiblity with a timeout of 10 minutes. At that time, the timeout for the message is extended by 10 minutes beyond the time of the ChangeMessageVisibility action. This results in a total visibility timeout of 13 minutes. You can continue to call the ChangeMessageVisibility to extend the visibility timeout to a maximum of 12 hours. If you try to extend the visibility timeout beyond 12 hours, your request is rejected.

A message is considered to be in flight after it's received from a queue by a consumer, but not yet deleted from the queue.

For standard queues, there can be a maximum of 120,000 inflight messages per 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.

For FIFO queues, there can be a maximum of 20,000 inflight messages per 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.

ChangeMessageVisibilityBatch ( ChangeMessageVisibilityBatchRequest request ) : ChangeMessageVisibilityBatchResponse

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=this

&Attribute.2=that

ChangeMessageVisibilityBatch ( string queueUrl, List entries ) : ChangeMessageVisibilityBatchResponse

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=this

&Attribute.2=that

ChangeMessageVisibilityBatchAsync ( ChangeMessageVisibilityBatchRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the ChangeMessageVisibilityBatch operation.

ChangeMessageVisibilityBatchAsync ( string queueUrl, List entries, System cancellationToken = default(CancellationToken) ) : Task

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=this

&Attribute.2=that

ChangeMessageVisibilityBatchAsync ( ChangeMessageVisibilityBatchRequest request, ChangeMessageVisibilityBatchResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

Initiates the asynchronous execution of the ChangeMessageVisibilityBatch operation.

ChangeMessageVisibilityBatchAsync ( string queueUrl, List entries, ChangeMessageVisibilityBatchResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

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=this

&Attribute.2=that

CreateQueue ( CreateQueueRequest request ) : CreateQueueResponse

Creates a new standard or FIFO queue or returns the URL of an existing 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 SQS 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=this

&Attribute.2=that

CreateQueue ( string queueName ) : CreateQueueResponse

Creates a new standard or FIFO queue or returns the URL of an existing 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 SQS 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=this

&Attribute.2=that

CreateQueueAsync ( CreateQueueRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the CreateQueue operation.

CreateQueueAsync ( string queueName, System cancellationToken = default(CancellationToken) ) : Task

Creates a new standard or FIFO queue or returns the URL of an existing 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 SQS 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=this

&Attribute.2=that

CreateQueueAsync ( CreateQueueRequest request, CreateQueueResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

Initiates the asynchronous execution of the CreateQueue operation.

CreateQueueAsync ( string queueName, CreateQueueResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

Creates a new standard or FIFO queue or returns the URL of an existing 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 SQS 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=this

&Attribute.2=that

DeleteMessage ( DeleteMessageRequest request ) : Amazon.SQS.Model.DeleteMessageResponse

Deletes the specified message from the specified queue. You specify the message by using the message's receipt handle and not the MessageId you receive when you send the message. Even if the message is locked by another reader due to the visibility timeout setting, it is still deleted from the queue. If you leave a message in the queue for longer than the queue's configured retention period, Amazon SQS automatically deletes the message.

The receipt handle is associated with a specific instance of receiving the message. If you receive a message more than once, the receipt handle you get each time you receive the message is different. If you don't provide the most recently received receipt handle for the message when you use the DeleteMessage action, the request succeeds, but the message might not be deleted.

For standard queues, it is possible to receive a message even after you deleting it. This might happen on rare occasions if one of the servers storing 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 on a subsequent receive request. You should ensure that your application is idempotent, so that receiving a message more than once does not cause issues.

DeleteMessage ( string queueUrl, string receiptHandle ) : Amazon.SQS.Model.DeleteMessageResponse

Deletes the specified message from the specified queue. You specify the message by using the message's receipt handle and not the MessageId you receive when you send the message. Even if the message is locked by another reader due to the visibility timeout setting, it is still deleted from the queue. If you leave a message in the queue for longer than the queue's configured retention period, Amazon SQS automatically deletes the message.

The receipt handle is associated with a specific instance of receiving the message. If you receive a message more than once, the receipt handle you get each time you receive the message is different. If you don't provide the most recently received receipt handle for the message when you use the DeleteMessage action, the request succeeds, but the message might not be deleted.

For standard queues, it is possible to receive a message even after you deleting it. This might happen on rare occasions if one of the servers storing 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 on a subsequent receive request. You should ensure that your application is idempotent, so that receiving a message more than once does not cause issues.

DeleteMessageAsync ( DeleteMessageRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DeleteMessage operation.

DeleteMessageAsync ( string queueUrl, string receiptHandle, System cancellationToken = default(CancellationToken) ) : Task

Deletes the specified message from the specified queue. You specify the message by using the message's receipt handle and not the MessageId you receive when you send the message. Even if the message is locked by another reader due to the visibility timeout setting, it is still deleted from the queue. If you leave a message in the queue for longer than the queue's configured retention period, Amazon SQS automatically deletes the message.

The receipt handle is associated with a specific instance of receiving the message. If you receive a message more than once, the receipt handle you get each time you receive the message is different. If you don't provide the most recently received receipt handle for the message when you use the DeleteMessage action, the request succeeds, but the message might not be deleted.

For standard queues, it is possible to receive a message even after you deleting it. This might happen on rare occasions if one of the servers storing 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 on a subsequent receive request. You should ensure that your application is idempotent, so that receiving a message more than once does not cause issues.

DeleteMessageAsync ( DeleteMessageRequest request, DeleteMessageResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

Initiates the asynchronous execution of the DeleteMessage operation.

DeleteMessageAsync ( string queueUrl, string receiptHandle, DeleteMessageResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

Deletes the specified message from the specified queue. You specify the message by using the message's receipt handle and not the MessageId you receive when you send the message. Even if the message is locked by another reader due to the visibility timeout setting, it is still deleted from the queue. If you leave a message in the queue for longer than the queue's configured retention period, Amazon SQS automatically deletes the message.

The receipt handle is associated with a specific instance of receiving the message. If you receive a message more than once, the receipt handle you get each time you receive the message is different. If you don't provide the most recently received receipt handle for the message when you use the DeleteMessage action, the request succeeds, but the message might not be deleted.

For standard queues, it is possible to receive a message even after you deleting it. This might happen on rare occasions if one of the servers storing 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 on a subsequent receive request. You should ensure that your application is idempotent, so that receiving a message more than once does not cause issues.

DeleteMessageBatch ( DeleteMessageBatchRequest request ) : DeleteMessageBatchResponse

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=this

&Attribute.2=that

DeleteMessageBatch ( string queueUrl, List entries ) : DeleteMessageBatchResponse

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=this

&Attribute.2=that

DeleteMessageBatchAsync ( DeleteMessageBatchRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DeleteMessageBatch operation.

DeleteMessageBatchAsync ( string queueUrl, List entries, System cancellationToken = default(CancellationToken) ) : Task

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=this

&Attribute.2=that

DeleteMessageBatchAsync ( DeleteMessageBatchRequest request, DeleteMessageBatchResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

Initiates the asynchronous execution of the DeleteMessageBatch operation.

DeleteMessageBatchAsync ( string queueUrl, List entries, DeleteMessageBatchResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

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=this

&Attribute.2=that

DeleteQueue ( DeleteQueueRequest request ) : Amazon.SQS.Model.DeleteQueueResponse

Deletes the queue specified by the QueueUrl, even if the queue is empty. 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.

DeleteQueue ( string queueUrl ) : Amazon.SQS.Model.DeleteQueueResponse

Deletes the queue specified by the QueueUrl, even if the queue is empty. 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.

DeleteQueueAsync ( DeleteQueueRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DeleteQueue operation.

DeleteQueueAsync ( string queueUrl, System cancellationToken = default(CancellationToken) ) : Task

Deletes the queue specified by the QueueUrl, even if the queue is empty. 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.

DeleteQueueAsync ( DeleteQueueRequest request, DeleteQueueResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

Initiates the asynchronous execution of the DeleteQueue operation.

DeleteQueueAsync ( string queueUrl, DeleteQueueResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

Deletes the queue specified by the QueueUrl, even if the queue is empty. 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.

EndAddPermission ( IAsyncResult asyncResult ) : Amazon.SQS.Model.AddPermissionResponse

Finishes the asynchronous execution of the AddPermission operation.

EndChangeMessageVisibility ( IAsyncResult asyncResult ) : Amazon.SQS.Model.ChangeMessageVisibilityResponse

Finishes the asynchronous execution of the ChangeMessageVisibility operation.

EndChangeMessageVisibilityBatch ( IAsyncResult asyncResult ) : ChangeMessageVisibilityBatchResponse

Finishes the asynchronous execution of the ChangeMessageVisibilityBatch operation.

EndCreateQueue ( IAsyncResult asyncResult ) : CreateQueueResponse

Finishes the asynchronous execution of the CreateQueue operation.

EndDeleteMessage ( IAsyncResult asyncResult ) : Amazon.SQS.Model.DeleteMessageResponse

Finishes the asynchronous execution of the DeleteMessage operation.

EndDeleteMessageBatch ( IAsyncResult asyncResult ) : DeleteMessageBatchResponse

Finishes the asynchronous execution of the DeleteMessageBatch operation.

EndDeleteQueue ( IAsyncResult asyncResult ) : Amazon.SQS.Model.DeleteQueueResponse

Finishes the asynchronous execution of the DeleteQueue operation.

EndGetQueueAttributes ( IAsyncResult asyncResult ) : GetQueueAttributesResponse

Finishes the asynchronous execution of the GetQueueAttributes operation.

EndGetQueueUrl ( IAsyncResult asyncResult ) : GetQueueUrlResponse

Finishes the asynchronous execution of the GetQueueUrl operation.

EndListDeadLetterSourceQueues ( IAsyncResult asyncResult ) : ListDeadLetterSourceQueuesResponse

Finishes the asynchronous execution of the ListDeadLetterSourceQueues operation.

EndListQueues ( IAsyncResult asyncResult ) : ListQueuesResponse

Finishes the asynchronous execution of the ListQueues operation.

EndPurgeQueue ( IAsyncResult asyncResult ) : PurgeQueueResponse

Finishes the asynchronous execution of the PurgeQueue operation.

EndReceiveMessage ( IAsyncResult asyncResult ) : ReceiveMessageResponse

Finishes the asynchronous execution of the ReceiveMessage operation.

EndRemovePermission ( IAsyncResult asyncResult ) : Amazon.SQS.Model.RemovePermissionResponse

Finishes the asynchronous execution of the RemovePermission operation.

EndSendMessage ( IAsyncResult asyncResult ) : SendMessageResponse

Finishes the asynchronous execution of the SendMessage operation.

EndSendMessageBatch ( IAsyncResult asyncResult ) : SendMessageBatchResponse

Finishes the asynchronous execution of the SendMessageBatch operation.

EndSetQueueAttributes ( IAsyncResult asyncResult ) : Amazon.SQS.Model.SetQueueAttributesResponse

Finishes the asynchronous execution of the SetQueueAttributes operation.

GetQueueAttributes ( GetQueueAttributesRequest request ) : GetQueueAttributesResponse

Gets attributes for the specified 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=this

&Attribute.2=that

GetQueueAttributes ( string queueUrl, List attributeNames ) : GetQueueAttributesResponse

Gets attributes for the specified 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=this

&Attribute.2=that

GetQueueAttributesAsync ( GetQueueAttributesRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the GetQueueAttributes operation.

GetQueueAttributesAsync ( string queueUrl, List attributeNames, System cancellationToken = default(CancellationToken) ) : Task

Gets attributes for the specified 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=this

&Attribute.2=that

GetQueueAttributesAsync ( GetQueueAttributesRequest request, GetQueueAttributesResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

Initiates the asynchronous execution of the GetQueueAttributes operation.

GetQueueAttributesAsync ( string queueUrl, List attributeNames, GetQueueAttributesResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

Gets attributes for the specified 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=this

&Attribute.2=that

GetQueueUrl ( GetQueueUrlRequest request ) : GetQueueUrlResponse

Returns the URL of an existing queue. This action provides a simple way to retrieve the URL of an 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 Shared Queues in the Amazon SQS Developer Guide.

GetQueueUrl ( string queueName ) : GetQueueUrlResponse

Returns the URL of an existing queue. This action provides a simple way to retrieve the URL of an 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 Shared Queues in the Amazon SQS Developer Guide.

GetQueueUrlAsync ( GetQueueUrlRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the GetQueueUrl operation.

GetQueueUrlAsync ( string queueName, System cancellationToken = default(CancellationToken) ) : Task

Returns the URL of an existing queue. This action provides a simple way to retrieve the URL of an 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 Shared Queues in the Amazon SQS Developer Guide.

GetQueueUrlAsync ( GetQueueUrlRequest request, GetQueueUrlResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

Initiates the asynchronous execution of the GetQueueUrl operation.

GetQueueUrlAsync ( string queueName, GetQueueUrlResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

Returns the URL of an existing queue. This action provides a simple way to retrieve the URL of an 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 Shared Queues in the Amazon SQS Developer Guide.

ListDeadLetterSourceQueues ( ListDeadLetterSourceQueuesRequest request ) : ListDeadLetterSourceQueuesResponse

Returns a list of your queues that have the RedrivePolicy queue attribute configured with a dead letter queue.

For more information about using dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide.

ListDeadLetterSourceQueuesAsync ( ListDeadLetterSourceQueuesRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the ListDeadLetterSourceQueues operation.

ListDeadLetterSourceQueuesAsync ( ListDeadLetterSourceQueuesRequest request, ListDeadLetterSourceQueuesResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

Initiates the asynchronous execution of the ListDeadLetterSourceQueues operation.

ListQueues ( ListQueuesRequest request ) : ListQueuesResponse

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.

ListQueues ( string queueNamePrefix ) : ListQueuesResponse

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.

ListQueuesAsync ( ListQueuesRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the ListQueues operation.

ListQueuesAsync ( string queueNamePrefix, System cancellationToken = default(CancellationToken) ) : Task

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.

ListQueuesAsync ( ListQueuesRequest request, ListQueuesResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

Initiates the asynchronous execution of the ListQueues operation.

ListQueuesAsync ( string queueNamePrefix, ListQueuesResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

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.

PurgeQueue ( PurgeQueueRequest request ) : PurgeQueueResponse

Deletes the messages in a queue specified by the QueueURL parameter.

When you use the PurgeQueue action, you can't retrieve a message deleted from a queue.

When you purge a queue, the message deletion process takes up to 60 seconds. All messages sent to the queue before calling the PurgeQueue action are deleted. Messages sent to the queue while it is being purged might be deleted. While the queue is being purged, messages sent to the queue before PurgeQueue is called might be received, but are deleted within the next minute.

PurgeQueue ( string queueUrl ) : PurgeQueueResponse

Deletes the messages in a queue specified by the QueueURL parameter.

When you use the PurgeQueue action, you can't retrieve a message deleted from a queue.

When you purge a queue, the message deletion process takes up to 60 seconds. All messages sent to the queue before calling the PurgeQueue action are deleted. Messages sent to the queue while it is being purged might be deleted. While the queue is being purged, messages sent to the queue before PurgeQueue is called might be received, but are deleted within the next minute.

PurgeQueueAsync ( PurgeQueueRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the PurgeQueue operation.

PurgeQueueAsync ( string queueUrl, System cancellationToken = default(CancellationToken) ) : Task

Deletes the messages in a queue specified by the QueueURL parameter.

When you use the PurgeQueue action, you can't retrieve a message deleted from a queue.

When you purge a queue, the message deletion process takes up to 60 seconds. All messages sent to the queue before calling the PurgeQueue action are deleted. Messages sent to the queue while it is being purged might be deleted. While the queue is being purged, messages sent to the queue before PurgeQueue is called might be received, but are deleted within the next minute.

PurgeQueueAsync ( PurgeQueueRequest request, PurgeQueueResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

Initiates the asynchronous execution of the PurgeQueue operation.

PurgeQueueAsync ( string queueUrl, PurgeQueueResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

Deletes the messages in a queue specified by the QueueURL parameter.

When you use the PurgeQueue action, you can't retrieve a message deleted from a queue.

When you purge a queue, the message deletion process takes up to 60 seconds. All messages sent to the queue before calling the PurgeQueue action are deleted. Messages sent to the queue while it is being purged might be deleted. While the queue is being purged, messages sent to the queue before PurgeQueue is called might be received, but are deleted within the next minute.

ReceiveMessage ( ReceiveMessageRequest request ) : ReceiveMessageResponse

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 SQS 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 on 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 SQS 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 SQS 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.

ReceiveMessage ( string queueUrl ) : ReceiveMessageResponse

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 SQS 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 on 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 SQS 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 SQS 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.

ReceiveMessageAsync ( ReceiveMessageRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the ReceiveMessage operation.

ReceiveMessageAsync ( string queueUrl, System cancellationToken = default(CancellationToken) ) : Task

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 SQS 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 on 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 SQS 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 SQS 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.

ReceiveMessageAsync ( ReceiveMessageRequest request, ReceiveMessageResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

Initiates the asynchronous execution of the ReceiveMessage operation.

ReceiveMessageAsync ( string queueUrl, ReceiveMessageResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

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 SQS 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 on 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 SQS 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 SQS 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.

RemovePermission ( RemovePermissionRequest request ) : Amazon.SQS.Model.RemovePermissionResponse

Revokes any permissions in the queue policy that matches the specified Label parameter. Only the owner of the queue can remove permissions.

RemovePermission ( string queueUrl, string label ) : Amazon.SQS.Model.RemovePermissionResponse

Revokes any permissions in the queue policy that matches the specified Label parameter. Only the owner of the queue can remove permissions.

RemovePermissionAsync ( RemovePermissionRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the RemovePermission operation.

RemovePermissionAsync ( string queueUrl, string label, System cancellationToken = default(CancellationToken) ) : Task

Revokes any permissions in the queue policy that matches the specified Label parameter. Only the owner of the queue can remove permissions.

RemovePermissionAsync ( RemovePermissionRequest request, RemovePermissionResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

Initiates the asynchronous execution of the RemovePermission operation.

RemovePermissionAsync ( string queueUrl, string label, RemovePermissionResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

Revokes any permissions in the queue policy that matches the specified Label parameter. Only the owner of the queue can remove permissions.

SendMessage ( SendMessageRequest request ) : SendMessageResponse

Delivers a message to the specified queue.

The following list shows the characters (in Unicode) that are allowed in your message, according to the W3C XML specification:

  • #x9

  • #xA

  • #xD

  • #x20 to #xD7FF

  • #xE000 to #xFFFD

  • #x10000 to #x10FFFF

For more information, see RFC1321. If you send any characters that aren't included in this list, your request is rejected.

SendMessage ( string queueUrl, string messageBody ) : SendMessageResponse

Delivers a message to the specified queue.

The following list shows the characters (in Unicode) that are allowed in your message, according to the W3C XML specification:

  • #x9

  • #xA

  • #xD

  • #x20 to #xD7FF

  • #xE000 to #xFFFD

  • #x10000 to #x10FFFF

For more information, see RFC1321. If you send any characters that aren't included in this list, your request is rejected.

SendMessageAsync ( SendMessageRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the SendMessage operation.

SendMessageAsync ( string queueUrl, string messageBody, System cancellationToken = default(CancellationToken) ) : Task

Delivers a message to the specified queue.

The following list shows the characters (in Unicode) that are allowed in your message, according to the W3C XML specification:

  • #x9

  • #xA

  • #xD

  • #x20 to #xD7FF

  • #xE000 to #xFFFD

  • #x10000 to #x10FFFF

For more information, see RFC1321. If you send any characters that aren't included in this list, your request is rejected.

SendMessageAsync ( SendMessageRequest request, SendMessageResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

Initiates the asynchronous execution of the SendMessage operation.

SendMessageAsync ( string queueUrl, string messageBody, SendMessageResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

Delivers a message to the specified queue.

The following list shows the characters (in Unicode) that are allowed in your message, according to the W3C XML specification:

  • #x9

  • #xA

  • #xD

  • #x20 to #xD7FF

  • #xE000 to #xFFFD

  • #x10000 to #x10FFFF

For more information, see RFC1321. If you send any characters that aren't included in this list, your request is rejected.

SendMessageBatch ( SendMessageBatchRequest request ) : SendMessageBatchResponse

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).

The following list shows the characters (in Unicode) that are allowed in your message, according to the W3C XML specification:

  • #x9

  • #xA

  • #xD

  • #x20 to #xD7FF

  • #xE000 to #xFFFD

  • #x10000 to #x10FFFF

For more information, see RFC1321. If you send any characters that aren't included in this list, your request is rejected.

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=this

&Attribute.2=that

SendMessageBatch ( string queueUrl, List entries ) : SendMessageBatchResponse

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).

The following list shows the characters (in Unicode) that are allowed in your message, according to the W3C XML specification:

  • #x9

  • #xA

  • #xD

  • #x20 to #xD7FF

  • #xE000 to #xFFFD

  • #x10000 to #x10FFFF

For more information, see RFC1321. If you send any characters that aren't included in this list, your request is rejected.

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=this

&Attribute.2=that

SendMessageBatchAsync ( SendMessageBatchRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the SendMessageBatch operation.

SendMessageBatchAsync ( string queueUrl, List entries, System cancellationToken = default(CancellationToken) ) : Task

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).

The following list shows the characters (in Unicode) that are allowed in your message, according to the W3C XML specification:

  • #x9

  • #xA

  • #xD

  • #x20 to #xD7FF

  • #xE000 to #xFFFD

  • #x10000 to #x10FFFF

For more information, see RFC1321. If you send any characters that aren't included in this list, your request is rejected.

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=this

&Attribute.2=that

SendMessageBatchAsync ( SendMessageBatchRequest request, SendMessageBatchResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

Initiates the asynchronous execution of the SendMessageBatch operation.

SendMessageBatchAsync ( string queueUrl, List entries, SendMessageBatchResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

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).

The following list shows the characters (in Unicode) that are allowed in your message, according to the W3C XML specification:

  • #x9

  • #xA

  • #xD

  • #x20 to #xD7FF

  • #xE000 to #xFFFD

  • #x10000 to #x10FFFF

For more information, see RFC1321. If you send any characters that aren't included in this list, your request is rejected.

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=this

&Attribute.2=that

SetQueueAttributes ( SetQueueAttributesRequest request ) : Amazon.SQS.Model.SetQueueAttributesResponse

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.

SetQueueAttributes ( string queueUrl, string>.Dictionary attributes ) : Amazon.SQS.Model.SetQueueAttributesResponse

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.

SetQueueAttributesAsync ( SetQueueAttributesRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the SetQueueAttributes operation.

SetQueueAttributesAsync ( string queueUrl, string>.Dictionary attributes, System cancellationToken = default(CancellationToken) ) : Task

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.

SetQueueAttributesAsync ( SetQueueAttributesRequest request, SetQueueAttributesResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

Initiates the asynchronous execution of the SetQueueAttributes operation.

SetQueueAttributesAsync ( string queueUrl, string>.Dictionary attributes, SetQueueAttributesResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

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.

Protected Methods

Method Description
CreateSigner ( ) : AbstractAWSSigner

Creates the signer for the service.

CustomizeRuntimePipeline ( RuntimePipeline pipeline ) : void

Customize the pipeline

Dispose ( bool disposing ) : void

Disposes the service client.

Private Methods

Method Description
GetNewPolicyAndStatement ( GetQueueAttributesResponse response, string bucket, Amazon.Auth.AccessControlPolicy.Policy &policy, Amazon.Auth.AccessControlPolicy.Statement &statement ) : void

Helper method for AuthorizeS3ToSendMessage()

ICoreAmazonSQS ( string queueUrl ) : string>.Dictionary
ICoreAmazonSQS ( string queueUrl, string>.Dictionary attributes ) : System.Threading.Tasks.Task
ICoreAmazonSQS ( string queueUrl ) : string>>.Task
ICoreAmazonSQS ( string queueUrl, string>.Dictionary attributes ) : void

Method Details

AddPermission() public method

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 Shared Queues in the Amazon SQS Developer Guide.

AddPermission writes an Amazon-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 Using The Access Policy Language in the Amazon SQS 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=this

&Attribute.2=that

/// The action that you requested would violate a limit. For example, ReceiveMessage /// returns this error if the maximum number of inflight messages is reached. AddPermission /// returns this error if the maximum number of permissions for the queue is reached. ///
public AddPermission ( AddPermissionRequest request ) : Amazon.SQS.Model.AddPermissionResponse
request Amazon.SQS.Model.AddPermissionRequest Container for the necessary parameters to execute the AddPermission service method.
return Amazon.SQS.Model.AddPermissionResponse

AddPermission() public method

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 Shared Queues in the Amazon SQS Developer Guide.

AddPermission writes an Amazon-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 Using The Access Policy Language in the Amazon SQS 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=this

&Attribute.2=that

/// The action that you requested would violate a limit. For example, ReceiveMessage /// returns this error if the maximum number of inflight messages is reached. AddPermission /// returns this error if the maximum number of permissions for the queue is reached. ///
public AddPermission ( string queueUrl, string label, List awsAccountIds, List actions ) : Amazon.SQS.Model.AddPermissionResponse
queueUrl string The URL of the Amazon SQS queue to which permissions are added. Queue URLs are case-sensitive.
label string The unique identification of the permission you're setting (for example, AliceSendMessage). Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens (-), and underscores (_).
awsAccountIds List 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 SQS Developer Guide.
actions List The action the client wants to allow for the specified principal. The following values are valid:
  • *
  • ChangeMessageVisibility
  • DeleteMessage
  • GetQueueAttributes
  • GetQueueUrl
  • ReceiveMessage
  • SendMessage
For more information about these actions, see Understanding Permissions in the Amazon SQS 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.
return Amazon.SQS.Model.AddPermissionResponse

AddPermissionAsync() public method

Initiates the asynchronous execution of the AddPermission operation.
public AddPermissionAsync ( AddPermissionRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.SQS.Model.AddPermissionRequest Container for the necessary parameters to execute the AddPermission operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

AddPermissionAsync() public method

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 Shared Queues in the Amazon SQS Developer Guide.

AddPermission writes an Amazon-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 Using The Access Policy Language in the Amazon SQS 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=this

&Attribute.2=that

/// The action that you requested would violate a limit. For example, ReceiveMessage /// returns this error if the maximum number of inflight messages is reached. AddPermission /// returns this error if the maximum number of permissions for the queue is reached. ///
public AddPermissionAsync ( string queueUrl, string label, List awsAccountIds, List actions, System cancellationToken = default(CancellationToken) ) : Task
queueUrl string The URL of the Amazon SQS queue to which permissions are added. Queue URLs are case-sensitive.
label string The unique identification of the permission you're setting (for example, AliceSendMessage). Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens (-), and underscores (_).
awsAccountIds List 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 SQS Developer Guide.
actions List The action the client wants to allow for the specified principal. The following values are valid:
  • *
  • ChangeMessageVisibility
  • DeleteMessage
  • GetQueueAttributes
  • GetQueueUrl
  • ReceiveMessage
  • SendMessage
For more information about these actions, see Understanding Permissions in the Amazon SQS 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.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

AddPermissionAsync() public method

Initiates the asynchronous execution of the AddPermission operation.
public AddPermissionAsync ( AddPermissionRequest request, AddPermissionResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
request Amazon.SQS.Model.AddPermissionRequest Container for the necessary parameters to execute the AddPermission operation on AmazonSQSClient.
callback AddPermissionResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return void

AddPermissionAsync() public method

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 Shared Queues in the Amazon SQS Developer Guide.

AddPermission writes an Amazon-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 Using The Access Policy Language in the Amazon SQS 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=this

&Attribute.2=that

/// The action that you requested would violate a limit. For example, ReceiveMessage /// returns this error if the maximum number of inflight messages is reached. AddPermission /// returns this error if the maximum number of permissions for the queue is reached. ///
public AddPermissionAsync ( string queueUrl, string label, List awsAccountIds, List actions, AddPermissionResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
queueUrl string The URL of the Amazon SQS queue to which permissions are added. Queue URLs are case-sensitive.
label string The unique identification of the permission you're setting (for example, AliceSendMessage). Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens (-), and underscores (_).
awsAccountIds List 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 SQS Developer Guide.
actions List The action the client wants to allow for the specified principal. The following values are valid:
  • *
  • ChangeMessageVisibility
  • DeleteMessage
  • GetQueueAttributes
  • GetQueueUrl
  • ReceiveMessage
  • SendMessage
For more information about these actions, see Understanding Permissions in the Amazon SQS 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.
callback AddPermissionResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. ///
return void

AmazonSQSClient() public method

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="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>
public AmazonSQSClient ( ) : System
return System

AmazonSQSClient() public method

Constructs AmazonSQSClient with AWS Credentials
public AmazonSQSClient ( AWSCredentials credentials ) : System
credentials Amazon.Runtime.AWSCredentials AWS Credentials
return System

AmazonSQSClient() public method

Constructs AmazonSQSClient with AWS Credentials and an AmazonSQSClient Configuration object.
public AmazonSQSClient ( AWSCredentials credentials, AmazonSQSConfig clientConfig ) : System
credentials Amazon.Runtime.AWSCredentials AWS Credentials
clientConfig AmazonSQSConfig The AmazonSQSClient Configuration Object
return System

AmazonSQSClient() public method

Constructs AmazonSQSClient with AWS Credentials
public AmazonSQSClient ( AWSCredentials credentials, RegionEndpoint region ) : System
credentials Amazon.Runtime.AWSCredentials AWS Credentials
region RegionEndpoint The region to connect.
return System

AmazonSQSClient() public method

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="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>
public AmazonSQSClient ( AmazonSQSConfig config ) : System
config AmazonSQSConfig The AmazonSQSClient Configuration Object
return System

AmazonSQSClient() public method

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="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>
public AmazonSQSClient ( RegionEndpoint region ) : System
region RegionEndpoint The region to connect.
return System

AmazonSQSClient() public method

Constructs AmazonSQSClient with AWS Access Key ID and AWS Secret Key
public AmazonSQSClient ( string awsAccessKeyId, string awsSecretAccessKey ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
return System

AmazonSQSClient() public method

Constructs AmazonSQSClient with AWS Access Key ID, AWS Secret Key and an AmazonSQSClient Configuration object.
public AmazonSQSClient ( string awsAccessKeyId, string awsSecretAccessKey, AmazonSQSConfig clientConfig ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
clientConfig AmazonSQSConfig The AmazonSQSClient Configuration Object
return System

AmazonSQSClient() public method

Constructs AmazonSQSClient with AWS Access Key ID and AWS Secret Key
public AmazonSQSClient ( string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
region RegionEndpoint The region to connect.
return System

AmazonSQSClient() public method

Constructs AmazonSQSClient with AWS Access Key ID and AWS Secret Key
public AmazonSQSClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
awsSessionToken string AWS Session Token
return System

AmazonSQSClient() public method

Constructs AmazonSQSClient with AWS Access Key ID, AWS Secret Key and an AmazonSQSClient Configuration object.
public AmazonSQSClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonSQSConfig clientConfig ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
awsSessionToken string AWS Session Token
clientConfig AmazonSQSConfig The AmazonSQSClient Configuration Object
return System

AmazonSQSClient() public method

Constructs AmazonSQSClient with AWS Access Key ID and AWS Secret Key
public AmazonSQSClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
awsSessionToken string AWS Session Token
region RegionEndpoint The region to connect.
return System

AuthorizeS3ToSendMessage() public method

This is a utility method which updates the policy of a queue to allow the S3 bucket to publish events to it.
public AuthorizeS3ToSendMessage ( string queueUrl, string bucket ) : string
queueUrl string The queue that will have its policy updated.
bucket string The bucket that will be given access to send messages from.
return string

AuthorizeS3ToSendMessageAsync() public method

This is a utility method which updates the policy of a queue to allow the S3 bucket to publish events to it.
public AuthorizeS3ToSendMessageAsync ( string queueUrl, string bucket ) : Task
queueUrl string The queue that will have its policy updated.
bucket string The bucket that will be given access to send messages from.
return Task

BeginAddPermission() public method

Initiates the asynchronous execution of the AddPermission operation.
public BeginAddPermission ( AddPermissionRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.SQS.Model.AddPermissionRequest Container for the necessary parameters to execute the AddPermission operation on AmazonSQSClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginChangeMessageVisibility() public method

Initiates the asynchronous execution of the ChangeMessageVisibility operation.
public BeginChangeMessageVisibility ( ChangeMessageVisibilityRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.SQS.Model.ChangeMessageVisibilityRequest Container for the necessary parameters to execute the ChangeMessageVisibility operation on AmazonSQSClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginChangeMessageVisibilityBatch() public method

Initiates the asynchronous execution of the ChangeMessageVisibilityBatch operation.
public BeginChangeMessageVisibilityBatch ( ChangeMessageVisibilityBatchRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.SQS.Model.ChangeMessageVisibilityBatchRequest Container for the necessary parameters to execute the ChangeMessageVisibilityBatch operation on AmazonSQSClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginCreateQueue() public method

Initiates the asynchronous execution of the CreateQueue operation.
public BeginCreateQueue ( CreateQueueRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.SQS.Model.CreateQueueRequest Container for the necessary parameters to execute the CreateQueue operation on AmazonSQSClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDeleteMessage() public method

Initiates the asynchronous execution of the DeleteMessage operation.
public BeginDeleteMessage ( DeleteMessageRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.SQS.Model.DeleteMessageRequest Container for the necessary parameters to execute the DeleteMessage operation on AmazonSQSClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDeleteMessageBatch() public method

Initiates the asynchronous execution of the DeleteMessageBatch operation.
public BeginDeleteMessageBatch ( DeleteMessageBatchRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.SQS.Model.DeleteMessageBatchRequest Container for the necessary parameters to execute the DeleteMessageBatch operation on AmazonSQSClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDeleteQueue() public method

Initiates the asynchronous execution of the DeleteQueue operation.
public BeginDeleteQueue ( DeleteQueueRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.SQS.Model.DeleteQueueRequest Container for the necessary parameters to execute the DeleteQueue operation on AmazonSQSClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginGetQueueAttributes() public method

Initiates the asynchronous execution of the GetQueueAttributes operation.
public BeginGetQueueAttributes ( GetQueueAttributesRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.SQS.Model.GetQueueAttributesRequest Container for the necessary parameters to execute the GetQueueAttributes operation on AmazonSQSClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginGetQueueUrl() public method

Initiates the asynchronous execution of the GetQueueUrl operation.
public BeginGetQueueUrl ( GetQueueUrlRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.SQS.Model.GetQueueUrlRequest Container for the necessary parameters to execute the GetQueueUrl operation on AmazonSQSClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginListDeadLetterSourceQueues() public method

Initiates the asynchronous execution of the ListDeadLetterSourceQueues operation.
public BeginListDeadLetterSourceQueues ( ListDeadLetterSourceQueuesRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.SQS.Model.ListDeadLetterSourceQueuesRequest Container for the necessary parameters to execute the ListDeadLetterSourceQueues operation on AmazonSQSClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginListQueues() public method

Initiates the asynchronous execution of the ListQueues operation.
public BeginListQueues ( ListQueuesRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.SQS.Model.ListQueuesRequest Container for the necessary parameters to execute the ListQueues operation on AmazonSQSClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginPurgeQueue() public method

Initiates the asynchronous execution of the PurgeQueue operation.
public BeginPurgeQueue ( PurgeQueueRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.SQS.Model.PurgeQueueRequest Container for the necessary parameters to execute the PurgeQueue operation on AmazonSQSClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginReceiveMessage() public method

Initiates the asynchronous execution of the ReceiveMessage operation.
public BeginReceiveMessage ( ReceiveMessageRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.SQS.Model.ReceiveMessageRequest Container for the necessary parameters to execute the ReceiveMessage operation on AmazonSQSClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginRemovePermission() public method

Initiates the asynchronous execution of the RemovePermission operation.
public BeginRemovePermission ( RemovePermissionRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.SQS.Model.RemovePermissionRequest Container for the necessary parameters to execute the RemovePermission operation on AmazonSQSClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginSendMessage() public method

Initiates the asynchronous execution of the SendMessage operation.
public BeginSendMessage ( SendMessageRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.SQS.Model.SendMessageRequest Container for the necessary parameters to execute the SendMessage operation on AmazonSQSClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginSendMessageBatch() public method

Initiates the asynchronous execution of the SendMessageBatch operation.
public BeginSendMessageBatch ( SendMessageBatchRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.SQS.Model.SendMessageBatchRequest Container for the necessary parameters to execute the SendMessageBatch operation on AmazonSQSClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginSetQueueAttributes() public method

Initiates the asynchronous execution of the SetQueueAttributes operation.
public BeginSetQueueAttributes ( SetQueueAttributesRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.SQS.Model.SetQueueAttributesRequest Container for the necessary parameters to execute the SetQueueAttributes operation on AmazonSQSClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

ChangeMessageVisibility() public method

Changes the visibility timeout of a specified message in a queue to a new value. The maximum allowed timeout value is 12 hours. Thus, 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, see Visibility Timeout in the Amazon SQS Developer Guide.

For example, you have a message and with the default visibility timeout of 5 minutes. After 3 minutes, you call ChangeMessageVisiblity with a timeout of 10 minutes. At that time, the timeout for the message is extended by 10 minutes beyond the time of the ChangeMessageVisibility action. This results in a total visibility timeout of 13 minutes. You can continue to call the ChangeMessageVisibility to extend the visibility timeout to a maximum of 12 hours. If you try to extend the visibility timeout beyond 12 hours, your request is rejected.

A message is considered to be in flight after it's received from a queue by a consumer, but not yet deleted from the queue.

For standard queues, there can be a maximum of 120,000 inflight messages per 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.

For FIFO queues, there can be a maximum of 20,000 inflight messages per 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 message referred to isn't in flight. /// /// The receipt handle provided isn't valid. ///
public ChangeMessageVisibility ( ChangeMessageVisibilityRequest request ) : Amazon.SQS.Model.ChangeMessageVisibilityResponse
request Amazon.SQS.Model.ChangeMessageVisibilityRequest Container for the necessary parameters to execute the ChangeMessageVisibility service method.
return Amazon.SQS.Model.ChangeMessageVisibilityResponse

ChangeMessageVisibility() public method

Changes the visibility timeout of a specified message in a queue to a new value. The maximum allowed timeout value is 12 hours. Thus, 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, see Visibility Timeout in the Amazon SQS Developer Guide.

For example, you have a message and with the default visibility timeout of 5 minutes. After 3 minutes, you call ChangeMessageVisiblity with a timeout of 10 minutes. At that time, the timeout for the message is extended by 10 minutes beyond the time of the ChangeMessageVisibility action. This results in a total visibility timeout of 13 minutes. You can continue to call the ChangeMessageVisibility to extend the visibility timeout to a maximum of 12 hours. If you try to extend the visibility timeout beyond 12 hours, your request is rejected.

A message is considered to be in flight after it's received from a queue by a consumer, but not yet deleted from the queue.

For standard queues, there can be a maximum of 120,000 inflight messages per 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.

For FIFO queues, there can be a maximum of 20,000 inflight messages per 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 message referred to isn't in flight. /// /// The receipt handle provided isn't valid. ///
public ChangeMessageVisibility ( string queueUrl, string receiptHandle, int visibilityTimeout ) : Amazon.SQS.Model.ChangeMessageVisibilityResponse
queueUrl string The URL of the Amazon SQS queue whose message's visibility is changed. Queue URLs are case-sensitive.
receiptHandle string The receipt handle associated with the message whose visibility timeout is changed. This parameter is returned by the ReceiveMessage action.
visibilityTimeout int The new value for the message's visibility timeout (in seconds). Values values: 0 to 43200. Maximum: 12 hours.
return Amazon.SQS.Model.ChangeMessageVisibilityResponse

ChangeMessageVisibilityAsync() public method

Initiates the asynchronous execution of the ChangeMessageVisibility operation.
public ChangeMessageVisibilityAsync ( ChangeMessageVisibilityRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.SQS.Model.ChangeMessageVisibilityRequest Container for the necessary parameters to execute the ChangeMessageVisibility operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

ChangeMessageVisibilityAsync() public method

Changes the visibility timeout of a specified message in a queue to a new value. The maximum allowed timeout value is 12 hours. Thus, 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, see Visibility Timeout in the Amazon SQS Developer Guide.

For example, you have a message and with the default visibility timeout of 5 minutes. After 3 minutes, you call ChangeMessageVisiblity with a timeout of 10 minutes. At that time, the timeout for the message is extended by 10 minutes beyond the time of the ChangeMessageVisibility action. This results in a total visibility timeout of 13 minutes. You can continue to call the ChangeMessageVisibility to extend the visibility timeout to a maximum of 12 hours. If you try to extend the visibility timeout beyond 12 hours, your request is rejected.

A message is considered to be in flight after it's received from a queue by a consumer, but not yet deleted from the queue.

For standard queues, there can be a maximum of 120,000 inflight messages per 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.

For FIFO queues, there can be a maximum of 20,000 inflight messages per 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 message referred to isn't in flight. /// /// The receipt handle provided isn't valid. ///
public ChangeMessageVisibilityAsync ( string queueUrl, string receiptHandle, int visibilityTimeout, System cancellationToken = default(CancellationToken) ) : Task
queueUrl string The URL of the Amazon SQS queue whose message's visibility is changed. Queue URLs are case-sensitive.
receiptHandle string The receipt handle associated with the message whose visibility timeout is changed. This parameter is returned by the ReceiveMessage action.
visibilityTimeout int The new value for the message's visibility timeout (in seconds). Values values: 0 to 43200. Maximum: 12 hours.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

ChangeMessageVisibilityAsync() public method

Initiates the asynchronous execution of the ChangeMessageVisibility operation.
public ChangeMessageVisibilityAsync ( ChangeMessageVisibilityRequest request, ChangeMessageVisibilityResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
request Amazon.SQS.Model.ChangeMessageVisibilityRequest Container for the necessary parameters to execute the ChangeMessageVisibility operation on AmazonSQSClient.
callback ChangeMessageVisibilityResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return void

ChangeMessageVisibilityAsync() public method

Changes the visibility timeout of a specified message in a queue to a new value. The maximum allowed timeout value is 12 hours. Thus, 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, see Visibility Timeout in the Amazon SQS Developer Guide.

For example, you have a message and with the default visibility timeout of 5 minutes. After 3 minutes, you call ChangeMessageVisiblity with a timeout of 10 minutes. At that time, the timeout for the message is extended by 10 minutes beyond the time of the ChangeMessageVisibility action. This results in a total visibility timeout of 13 minutes. You can continue to call the ChangeMessageVisibility to extend the visibility timeout to a maximum of 12 hours. If you try to extend the visibility timeout beyond 12 hours, your request is rejected.

A message is considered to be in flight after it's received from a queue by a consumer, but not yet deleted from the queue.

For standard queues, there can be a maximum of 120,000 inflight messages per 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.

For FIFO queues, there can be a maximum of 20,000 inflight messages per 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 message referred to isn't in flight. /// /// The receipt handle provided isn't valid. ///
public ChangeMessageVisibilityAsync ( string queueUrl, string receiptHandle, int visibilityTimeout, ChangeMessageVisibilityResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
queueUrl string The URL of the Amazon SQS queue whose message's visibility is changed. Queue URLs are case-sensitive.
receiptHandle string The receipt handle associated with the message whose visibility timeout is changed. This parameter is returned by the ReceiveMessage action.
visibilityTimeout int The new value for the message's visibility timeout (in seconds). Values values: 0 to 43200. Maximum: 12 hours.
callback ChangeMessageVisibilityResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. ///
return void

ChangeMessageVisibilityBatch() public method

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=this

&Attribute.2=that

/// 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. ///
public ChangeMessageVisibilityBatch ( ChangeMessageVisibilityBatchRequest request ) : ChangeMessageVisibilityBatchResponse
request Amazon.SQS.Model.ChangeMessageVisibilityBatchRequest Container for the necessary parameters to execute the ChangeMessageVisibilityBatch service method.
return Amazon.SQS.Model.ChangeMessageVisibilityBatchResponse

ChangeMessageVisibilityBatch() public method

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=this

&Attribute.2=that

/// 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. ///
public ChangeMessageVisibilityBatch ( string queueUrl, List entries ) : ChangeMessageVisibilityBatchResponse
queueUrl string The URL of the Amazon SQS queue whose messages' visibility is changed. Queue URLs are case-sensitive.
entries List A list of receipt handles of the messages for which the visibility timeout must be changed.
return Amazon.SQS.Model.ChangeMessageVisibilityBatchResponse

ChangeMessageVisibilityBatchAsync() public method

Initiates the asynchronous execution of the ChangeMessageVisibilityBatch operation.
public ChangeMessageVisibilityBatchAsync ( ChangeMessageVisibilityBatchRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.SQS.Model.ChangeMessageVisibilityBatchRequest Container for the necessary parameters to execute the ChangeMessageVisibilityBatch operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

ChangeMessageVisibilityBatchAsync() public method

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=this

&Attribute.2=that

/// 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. ///
public ChangeMessageVisibilityBatchAsync ( string queueUrl, List entries, System cancellationToken = default(CancellationToken) ) : Task
queueUrl string The URL of the Amazon SQS queue whose messages' visibility is changed. Queue URLs are case-sensitive.
entries List A list of receipt handles of the messages for which the visibility timeout must be changed.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

ChangeMessageVisibilityBatchAsync() public method

Initiates the asynchronous execution of the ChangeMessageVisibilityBatch operation.
public ChangeMessageVisibilityBatchAsync ( ChangeMessageVisibilityBatchRequest request, ChangeMessageVisibilityBatchResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
request Amazon.SQS.Model.ChangeMessageVisibilityBatchRequest Container for the necessary parameters to execute the ChangeMessageVisibilityBatch operation on AmazonSQSClient.
callback ChangeMessageVisibilityBatchResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return void

ChangeMessageVisibilityBatchAsync() public method

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=this

&Attribute.2=that

/// 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. ///
public ChangeMessageVisibilityBatchAsync ( string queueUrl, List entries, ChangeMessageVisibilityBatchResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
queueUrl string The URL of the Amazon SQS queue whose messages' visibility is changed. Queue URLs are case-sensitive.
entries List A list of receipt handles of the messages for which the visibility timeout must be changed.
callback ChangeMessageVisibilityBatchResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. ///
return void

CreateQueue() public method

Creates a new standard or FIFO queue or returns the URL of an existing 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 SQS 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=this

&Attribute.2=that

/// You must wait 60 seconds after deleting a queue before you can create another one /// with the same name. /// /// A queue already exists with this name. Amazon SQS returns this error only if the request /// includes attributes whose values differ from those of the existing queue. ///
public CreateQueue ( CreateQueueRequest request ) : CreateQueueResponse
request Amazon.SQS.Model.CreateQueueRequest Container for the necessary parameters to execute the CreateQueue service method.
return Amazon.SQS.Model.CreateQueueResponse

CreateQueue() public method

Creates a new standard or FIFO queue or returns the URL of an existing 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 SQS 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=this

&Attribute.2=that

/// You must wait 60 seconds after deleting a queue before you can create another one /// with the same name. /// /// A queue already exists with this name. Amazon SQS returns this error only if the request /// includes attributes whose values differ from those of the existing queue. ///
public CreateQueue ( string queueName ) : CreateQueueResponse
queueName string 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 names are case-sensitive.
return Amazon.SQS.Model.CreateQueueResponse

CreateQueueAsync() public method

Initiates the asynchronous execution of the CreateQueue operation.
public CreateQueueAsync ( CreateQueueRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.SQS.Model.CreateQueueRequest Container for the necessary parameters to execute the CreateQueue operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

CreateQueueAsync() public method

Creates a new standard or FIFO queue or returns the URL of an existing 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 SQS 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=this

&Attribute.2=that

/// You must wait 60 seconds after deleting a queue before you can create another one /// with the same name. /// /// A queue already exists with this name. Amazon SQS returns this error only if the request /// includes attributes whose values differ from those of the existing queue. ///
public CreateQueueAsync ( string queueName, System cancellationToken = default(CancellationToken) ) : Task
queueName string 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 names are case-sensitive.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

CreateQueueAsync() public method

Initiates the asynchronous execution of the CreateQueue operation.
public CreateQueueAsync ( CreateQueueRequest request, CreateQueueResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
request Amazon.SQS.Model.CreateQueueRequest Container for the necessary parameters to execute the CreateQueue operation on AmazonSQSClient.
callback CreateQueueResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return void

CreateQueueAsync() public method

Creates a new standard or FIFO queue or returns the URL of an existing 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 SQS 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=this

&Attribute.2=that

/// You must wait 60 seconds after deleting a queue before you can create another one /// with the same name. /// /// A queue already exists with this name. Amazon SQS returns this error only if the request /// includes attributes whose values differ from those of the existing queue. ///
public CreateQueueAsync ( string queueName, CreateQueueResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
queueName string 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 names are case-sensitive.
callback CreateQueueResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. ///
return void

CreateSigner() protected method

Creates the signer for the service.
protected CreateSigner ( ) : AbstractAWSSigner
return AbstractAWSSigner

CustomizeRuntimePipeline() protected method

Customize the pipeline
protected CustomizeRuntimePipeline ( RuntimePipeline pipeline ) : void
pipeline RuntimePipeline
return void

DeleteMessage() public method

Deletes the specified message from the specified queue. You specify the message by using the message's receipt handle and not the MessageId you receive when you send the message. Even if the message is locked by another reader due to the visibility timeout setting, it is still deleted from the queue. If you leave a message in the queue for longer than the queue's configured retention period, Amazon SQS automatically deletes the message.

The receipt handle is associated with a specific instance of receiving the message. If you receive a message more than once, the receipt handle you get each time you receive the message is different. If you don't provide the most recently received receipt handle for the message when you use the DeleteMessage action, the request succeeds, but the message might not be deleted.

For standard queues, it is possible to receive a message even after you deleting it. This might happen on rare occasions if one of the servers storing 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 on 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 receipt handle isn't valid for the current version. /// /// The receipt handle provided isn't valid. ///
public DeleteMessage ( DeleteMessageRequest request ) : Amazon.SQS.Model.DeleteMessageResponse
request Amazon.SQS.Model.DeleteMessageRequest Container for the necessary parameters to execute the DeleteMessage service method.
return Amazon.SQS.Model.DeleteMessageResponse

DeleteMessage() public method

Deletes the specified message from the specified queue. You specify the message by using the message's receipt handle and not the MessageId you receive when you send the message. Even if the message is locked by another reader due to the visibility timeout setting, it is still deleted from the queue. If you leave a message in the queue for longer than the queue's configured retention period, Amazon SQS automatically deletes the message.

The receipt handle is associated with a specific instance of receiving the message. If you receive a message more than once, the receipt handle you get each time you receive the message is different. If you don't provide the most recently received receipt handle for the message when you use the DeleteMessage action, the request succeeds, but the message might not be deleted.

For standard queues, it is possible to receive a message even after you deleting it. This might happen on rare occasions if one of the servers storing 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 on 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 receipt handle isn't valid for the current version. /// /// The receipt handle provided isn't valid. ///
public DeleteMessage ( string queueUrl, string receiptHandle ) : Amazon.SQS.Model.DeleteMessageResponse
queueUrl string The URL of the Amazon SQS queue from which messages are deleted. Queue URLs are case-sensitive.
receiptHandle string The receipt handle associated with the message to delete.
return Amazon.SQS.Model.DeleteMessageResponse

DeleteMessageAsync() public method

Initiates the asynchronous execution of the DeleteMessage operation.
public DeleteMessageAsync ( DeleteMessageRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.SQS.Model.DeleteMessageRequest Container for the necessary parameters to execute the DeleteMessage operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DeleteMessageAsync() public method

Deletes the specified message from the specified queue. You specify the message by using the message's receipt handle and not the MessageId you receive when you send the message. Even if the message is locked by another reader due to the visibility timeout setting, it is still deleted from the queue. If you leave a message in the queue for longer than the queue's configured retention period, Amazon SQS automatically deletes the message.

The receipt handle is associated with a specific instance of receiving the message. If you receive a message more than once, the receipt handle you get each time you receive the message is different. If you don't provide the most recently received receipt handle for the message when you use the DeleteMessage action, the request succeeds, but the message might not be deleted.

For standard queues, it is possible to receive a message even after you deleting it. This might happen on rare occasions if one of the servers storing 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 on 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 receipt handle isn't valid for the current version. /// /// The receipt handle provided isn't valid. ///
public DeleteMessageAsync ( string queueUrl, string receiptHandle, System cancellationToken = default(CancellationToken) ) : Task
queueUrl string The URL of the Amazon SQS queue from which messages are deleted. Queue URLs are case-sensitive.
receiptHandle string The receipt handle associated with the message to delete.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DeleteMessageAsync() public method

Initiates the asynchronous execution of the DeleteMessage operation.
public DeleteMessageAsync ( DeleteMessageRequest request, DeleteMessageResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
request Amazon.SQS.Model.DeleteMessageRequest Container for the necessary parameters to execute the DeleteMessage operation on AmazonSQSClient.
callback DeleteMessageResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return void

DeleteMessageAsync() public method

Deletes the specified message from the specified queue. You specify the message by using the message's receipt handle and not the MessageId you receive when you send the message. Even if the message is locked by another reader due to the visibility timeout setting, it is still deleted from the queue. If you leave a message in the queue for longer than the queue's configured retention period, Amazon SQS automatically deletes the message.

The receipt handle is associated with a specific instance of receiving the message. If you receive a message more than once, the receipt handle you get each time you receive the message is different. If you don't provide the most recently received receipt handle for the message when you use the DeleteMessage action, the request succeeds, but the message might not be deleted.

For standard queues, it is possible to receive a message even after you deleting it. This might happen on rare occasions if one of the servers storing 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 on 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 receipt handle isn't valid for the current version. /// /// The receipt handle provided isn't valid. ///
public DeleteMessageAsync ( string queueUrl, string receiptHandle, DeleteMessageResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
queueUrl string The URL of the Amazon SQS queue from which messages are deleted. Queue URLs are case-sensitive.
receiptHandle string The receipt handle associated with the message to delete.
callback DeleteMessageResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. ///
return void

DeleteMessageBatch() public method

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=this

&Attribute.2=that

/// 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. ///
public DeleteMessageBatch ( DeleteMessageBatchRequest request ) : DeleteMessageBatchResponse
request Amazon.SQS.Model.DeleteMessageBatchRequest Container for the necessary parameters to execute the DeleteMessageBatch service method.
return Amazon.SQS.Model.DeleteMessageBatchResponse

DeleteMessageBatch() public method

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=this

&Attribute.2=that

/// 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. ///
public DeleteMessageBatch ( string queueUrl, List entries ) : DeleteMessageBatchResponse
queueUrl string The URL of the Amazon SQS queue from which messages are deleted. Queue URLs are case-sensitive.
entries List A list of receipt handles for the messages to be deleted.
return Amazon.SQS.Model.DeleteMessageBatchResponse

DeleteMessageBatchAsync() public method

Initiates the asynchronous execution of the DeleteMessageBatch operation.
public DeleteMessageBatchAsync ( DeleteMessageBatchRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.SQS.Model.DeleteMessageBatchRequest Container for the necessary parameters to execute the DeleteMessageBatch operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DeleteMessageBatchAsync() public method

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=this

&Attribute.2=that

/// 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. ///
public DeleteMessageBatchAsync ( string queueUrl, List entries, System cancellationToken = default(CancellationToken) ) : Task
queueUrl string The URL of the Amazon SQS queue from which messages are deleted. Queue URLs are case-sensitive.
entries List A list of receipt handles for the messages to be deleted.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DeleteMessageBatchAsync() public method

Initiates the asynchronous execution of the DeleteMessageBatch operation.
public DeleteMessageBatchAsync ( DeleteMessageBatchRequest request, DeleteMessageBatchResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
request Amazon.SQS.Model.DeleteMessageBatchRequest Container for the necessary parameters to execute the DeleteMessageBatch operation on AmazonSQSClient.
callback DeleteMessageBatchResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return void

DeleteMessageBatchAsync() public method

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=this

&Attribute.2=that

/// 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. ///
public DeleteMessageBatchAsync ( string queueUrl, List entries, DeleteMessageBatchResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
queueUrl string The URL of the Amazon SQS queue from which messages are deleted. Queue URLs are case-sensitive.
entries List A list of receipt handles for the messages to be deleted.
callback DeleteMessageBatchResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. ///
return void

DeleteQueue() public method

Deletes the queue specified by the QueueUrl, even if the queue is empty. 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.

public DeleteQueue ( DeleteQueueRequest request ) : Amazon.SQS.Model.DeleteQueueResponse
request Amazon.SQS.Model.DeleteQueueRequest Container for the necessary parameters to execute the DeleteQueue service method.
return Amazon.SQS.Model.DeleteQueueResponse

DeleteQueue() public method

Deletes the queue specified by the QueueUrl, even if the queue is empty. 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.

public DeleteQueue ( string queueUrl ) : Amazon.SQS.Model.DeleteQueueResponse
queueUrl string The URL of the Amazon SQS queue to delete. Queue URLs are case-sensitive.
return Amazon.SQS.Model.DeleteQueueResponse

DeleteQueueAsync() public method

Initiates the asynchronous execution of the DeleteQueue operation.
public DeleteQueueAsync ( DeleteQueueRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.SQS.Model.DeleteQueueRequest Container for the necessary parameters to execute the DeleteQueue operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DeleteQueueAsync() public method

Deletes the queue specified by the QueueUrl, even if the queue is empty. 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.

public DeleteQueueAsync ( string queueUrl, System cancellationToken = default(CancellationToken) ) : Task
queueUrl string The URL of the Amazon SQS queue to delete. Queue URLs are case-sensitive.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DeleteQueueAsync() public method

Initiates the asynchronous execution of the DeleteQueue operation.
public DeleteQueueAsync ( DeleteQueueRequest request, DeleteQueueResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
request Amazon.SQS.Model.DeleteQueueRequest Container for the necessary parameters to execute the DeleteQueue operation on AmazonSQSClient.
callback DeleteQueueResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return void

DeleteQueueAsync() public method

Deletes the queue specified by the QueueUrl, even if the queue is empty. 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.

public DeleteQueueAsync ( string queueUrl, DeleteQueueResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
queueUrl string The URL of the Amazon SQS queue to delete. Queue URLs are case-sensitive.
callback DeleteQueueResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. ///
return void

Dispose() protected method

Disposes the service client.
protected Dispose ( bool disposing ) : void
disposing bool
return void

EndAddPermission() public method

Finishes the asynchronous execution of the AddPermission operation.
public EndAddPermission ( IAsyncResult asyncResult ) : Amazon.SQS.Model.AddPermissionResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginAddPermission.
return Amazon.SQS.Model.AddPermissionResponse

EndChangeMessageVisibility() public method

Finishes the asynchronous execution of the ChangeMessageVisibility operation.
public EndChangeMessageVisibility ( IAsyncResult asyncResult ) : Amazon.SQS.Model.ChangeMessageVisibilityResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginChangeMessageVisibility.
return Amazon.SQS.Model.ChangeMessageVisibilityResponse

EndChangeMessageVisibilityBatch() public method

Finishes the asynchronous execution of the ChangeMessageVisibilityBatch operation.
public EndChangeMessageVisibilityBatch ( IAsyncResult asyncResult ) : ChangeMessageVisibilityBatchResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginChangeMessageVisibilityBatch.
return Amazon.SQS.Model.ChangeMessageVisibilityBatchResponse

EndCreateQueue() public method

Finishes the asynchronous execution of the CreateQueue operation.
public EndCreateQueue ( IAsyncResult asyncResult ) : CreateQueueResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginCreateQueue.
return Amazon.SQS.Model.CreateQueueResponse

EndDeleteMessage() public method

Finishes the asynchronous execution of the DeleteMessage operation.
public EndDeleteMessage ( IAsyncResult asyncResult ) : Amazon.SQS.Model.DeleteMessageResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDeleteMessage.
return Amazon.SQS.Model.DeleteMessageResponse

EndDeleteMessageBatch() public method

Finishes the asynchronous execution of the DeleteMessageBatch operation.
public EndDeleteMessageBatch ( IAsyncResult asyncResult ) : DeleteMessageBatchResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDeleteMessageBatch.
return Amazon.SQS.Model.DeleteMessageBatchResponse

EndDeleteQueue() public method

Finishes the asynchronous execution of the DeleteQueue operation.
public EndDeleteQueue ( IAsyncResult asyncResult ) : Amazon.SQS.Model.DeleteQueueResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDeleteQueue.
return Amazon.SQS.Model.DeleteQueueResponse

EndGetQueueAttributes() public method

Finishes the asynchronous execution of the GetQueueAttributes operation.
public EndGetQueueAttributes ( IAsyncResult asyncResult ) : GetQueueAttributesResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginGetQueueAttributes.
return Amazon.SQS.Model.GetQueueAttributesResponse

EndGetQueueUrl() public method

Finishes the asynchronous execution of the GetQueueUrl operation.
public EndGetQueueUrl ( IAsyncResult asyncResult ) : GetQueueUrlResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginGetQueueUrl.
return Amazon.SQS.Model.GetQueueUrlResponse

EndListDeadLetterSourceQueues() public method

Finishes the asynchronous execution of the ListDeadLetterSourceQueues operation.
public EndListDeadLetterSourceQueues ( IAsyncResult asyncResult ) : ListDeadLetterSourceQueuesResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginListDeadLetterSourceQueues.
return Amazon.SQS.Model.ListDeadLetterSourceQueuesResponse

EndListQueues() public method

Finishes the asynchronous execution of the ListQueues operation.
public EndListQueues ( IAsyncResult asyncResult ) : ListQueuesResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginListQueues.
return Amazon.SQS.Model.ListQueuesResponse

EndPurgeQueue() public method

Finishes the asynchronous execution of the PurgeQueue operation.
public EndPurgeQueue ( IAsyncResult asyncResult ) : PurgeQueueResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginPurgeQueue.
return PurgeQueueResponse

EndReceiveMessage() public method

Finishes the asynchronous execution of the ReceiveMessage operation.
public EndReceiveMessage ( IAsyncResult asyncResult ) : ReceiveMessageResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginReceiveMessage.
return Amazon.SQS.Model.ReceiveMessageResponse

EndRemovePermission() public method

Finishes the asynchronous execution of the RemovePermission operation.
public EndRemovePermission ( IAsyncResult asyncResult ) : Amazon.SQS.Model.RemovePermissionResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginRemovePermission.
return Amazon.SQS.Model.RemovePermissionResponse

EndSendMessage() public method

Finishes the asynchronous execution of the SendMessage operation.
public EndSendMessage ( IAsyncResult asyncResult ) : SendMessageResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginSendMessage.
return Amazon.SQS.Model.SendMessageResponse

EndSendMessageBatch() public method

Finishes the asynchronous execution of the SendMessageBatch operation.
public EndSendMessageBatch ( IAsyncResult asyncResult ) : SendMessageBatchResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginSendMessageBatch.
return Amazon.SQS.Model.SendMessageBatchResponse

EndSetQueueAttributes() public method

Finishes the asynchronous execution of the SetQueueAttributes operation.
public EndSetQueueAttributes ( IAsyncResult asyncResult ) : Amazon.SQS.Model.SetQueueAttributesResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginSetQueueAttributes.
return Amazon.SQS.Model.SetQueueAttributesResponse

GetQueueAttributes() public method

Gets attributes for the specified 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=this

&Attribute.2=that

/// The attribute referred to doesn't exist. ///
public GetQueueAttributes ( GetQueueAttributesRequest request ) : GetQueueAttributesResponse
request Amazon.SQS.Model.GetQueueAttributesRequest Container for the necessary parameters to execute the GetQueueAttributes service method.
return Amazon.SQS.Model.GetQueueAttributesResponse

GetQueueAttributes() public method

Gets attributes for the specified 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=this

&Attribute.2=that

/// The attribute referred to doesn't exist. ///
public GetQueueAttributes ( string queueUrl, List attributeNames ) : GetQueueAttributesResponse
queueUrl string The URL of the Amazon SQS queue whose attribute information is retrieved. Queue URLs are case-sensitive.
attributeNames List 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 visible messages in a queue. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide.
  • ApproximateNumberOfMessagesDelayed - Returns the approximate number of messages that are waiting to be added to the queue.
  • ApproximateNumberOfMessagesNotVisible - Returns the approximate number of messages that have not timed-out and aren't deleted. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide.
  • 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 number of 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 number of seconds for which the ReceiveMessage action waits for a message to arrive.
  • RedrivePolicy - Returns 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 SQS Developer Guide.
  • VisibilityTimeout - Returns the visibility timeout for the queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.
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 SQS Developer Guide.
  • ContentBasedDeduplication - Returns whether content-based deduplication is enabled for the queue. For more information, see Exactly-Once Processing in the Amazon SQS Developer Guide.
return Amazon.SQS.Model.GetQueueAttributesResponse

GetQueueAttributesAsync() public method

Initiates the asynchronous execution of the GetQueueAttributes operation.
public GetQueueAttributesAsync ( GetQueueAttributesRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.SQS.Model.GetQueueAttributesRequest Container for the necessary parameters to execute the GetQueueAttributes operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

GetQueueAttributesAsync() public method

Gets attributes for the specified 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=this

&Attribute.2=that

/// The attribute referred to doesn't exist. ///
public GetQueueAttributesAsync ( string queueUrl, List attributeNames, System cancellationToken = default(CancellationToken) ) : Task
queueUrl string The URL of the Amazon SQS queue whose attribute information is retrieved. Queue URLs are case-sensitive.
attributeNames List 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 visible messages in a queue. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide.
  • ApproximateNumberOfMessagesDelayed - Returns the approximate number of messages that are waiting to be added to the queue.
  • ApproximateNumberOfMessagesNotVisible - Returns the approximate number of messages that have not timed-out and aren't deleted. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide.
  • 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 number of 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 number of seconds for which the ReceiveMessage action waits for a message to arrive.
  • RedrivePolicy - Returns 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 SQS Developer Guide.
  • VisibilityTimeout - Returns the visibility timeout for the queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.
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 SQS Developer Guide.
  • ContentBasedDeduplication - Returns whether content-based deduplication is enabled for the queue. For more information, see Exactly-Once Processing in the Amazon SQS Developer Guide.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

GetQueueAttributesAsync() public method

Initiates the asynchronous execution of the GetQueueAttributes operation.
public GetQueueAttributesAsync ( GetQueueAttributesRequest request, GetQueueAttributesResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
request Amazon.SQS.Model.GetQueueAttributesRequest Container for the necessary parameters to execute the GetQueueAttributes operation on AmazonSQSClient.
callback GetQueueAttributesResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return void

GetQueueAttributesAsync() public method

Gets attributes for the specified 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=this

&Attribute.2=that

/// The attribute referred to doesn't exist. ///
public GetQueueAttributesAsync ( string queueUrl, List attributeNames, GetQueueAttributesResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
queueUrl string The URL of the Amazon SQS queue whose attribute information is retrieved. Queue URLs are case-sensitive.
attributeNames List 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 visible messages in a queue. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide.
  • ApproximateNumberOfMessagesDelayed - Returns the approximate number of messages that are waiting to be added to the queue.
  • ApproximateNumberOfMessagesNotVisible - Returns the approximate number of messages that have not timed-out and aren't deleted. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide.
  • 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 number of 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 number of seconds for which the ReceiveMessage action waits for a message to arrive.
  • RedrivePolicy - Returns 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 SQS Developer Guide.
  • VisibilityTimeout - Returns the visibility timeout for the queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.
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 SQS Developer Guide.
  • ContentBasedDeduplication - Returns whether content-based deduplication is enabled for the queue. For more information, see Exactly-Once Processing in the Amazon SQS Developer Guide.
callback GetQueueAttributesResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. ///
return void

GetQueueUrl() public method

Returns the URL of an existing queue. This action provides a simple way to retrieve the URL of an 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 Shared Queues in the Amazon SQS Developer Guide.

/// The queue referred to doesn't exist. ///
public GetQueueUrl ( GetQueueUrlRequest request ) : GetQueueUrlResponse
request Amazon.SQS.Model.GetQueueUrlRequest Container for the necessary parameters to execute the GetQueueUrl service method.
return Amazon.SQS.Model.GetQueueUrlResponse

GetQueueUrl() public method

Returns the URL of an existing queue. This action provides a simple way to retrieve the URL of an 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 Shared Queues in the Amazon SQS Developer Guide.

/// The queue referred to doesn't exist. ///
public GetQueueUrl ( string queueName ) : GetQueueUrlResponse
queueName string The name of the queue whose URL must be fetched. Maximum 80 characters. Valid values: alphanumeric characters, hyphens (-), and underscores (_). Queue names are case-sensitive.
return Amazon.SQS.Model.GetQueueUrlResponse

GetQueueUrlAsync() public method

Initiates the asynchronous execution of the GetQueueUrl operation.
public GetQueueUrlAsync ( GetQueueUrlRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.SQS.Model.GetQueueUrlRequest Container for the necessary parameters to execute the GetQueueUrl operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

GetQueueUrlAsync() public method

Returns the URL of an existing queue. This action provides a simple way to retrieve the URL of an 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 Shared Queues in the Amazon SQS Developer Guide.

/// The queue referred to doesn't exist. ///
public GetQueueUrlAsync ( string queueName, System cancellationToken = default(CancellationToken) ) : Task
queueName string The name of the queue whose URL must be fetched. Maximum 80 characters. Valid values: alphanumeric characters, hyphens (-), and underscores (_). Queue names are case-sensitive.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

GetQueueUrlAsync() public method

Initiates the asynchronous execution of the GetQueueUrl operation.
public GetQueueUrlAsync ( GetQueueUrlRequest request, GetQueueUrlResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
request Amazon.SQS.Model.GetQueueUrlRequest Container for the necessary parameters to execute the GetQueueUrl operation on AmazonSQSClient.
callback GetQueueUrlResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return void

GetQueueUrlAsync() public method

Returns the URL of an existing queue. This action provides a simple way to retrieve the URL of an 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 Shared Queues in the Amazon SQS Developer Guide.

/// The queue referred to doesn't exist. ///
public GetQueueUrlAsync ( string queueName, GetQueueUrlResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
queueName string The name of the queue whose URL must be fetched. Maximum 80 characters. Valid values: alphanumeric characters, hyphens (-), and underscores (_). Queue names are case-sensitive.
callback GetQueueUrlResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. ///
return void

ListDeadLetterSourceQueues() public method

Returns a list of your queues that have the RedrivePolicy queue attribute configured with a dead letter queue.

For more information about using dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide.

/// The queue referred to doesn't exist. ///
public ListDeadLetterSourceQueues ( ListDeadLetterSourceQueuesRequest request ) : ListDeadLetterSourceQueuesResponse
request Amazon.SQS.Model.ListDeadLetterSourceQueuesRequest Container for the necessary parameters to execute the ListDeadLetterSourceQueues service method.
return Amazon.SQS.Model.ListDeadLetterSourceQueuesResponse

ListDeadLetterSourceQueuesAsync() public method

Initiates the asynchronous execution of the ListDeadLetterSourceQueues operation.
public ListDeadLetterSourceQueuesAsync ( ListDeadLetterSourceQueuesRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.SQS.Model.ListDeadLetterSourceQueuesRequest Container for the necessary parameters to execute the ListDeadLetterSourceQueues operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

ListDeadLetterSourceQueuesAsync() public method

Initiates the asynchronous execution of the ListDeadLetterSourceQueues operation.
public ListDeadLetterSourceQueuesAsync ( ListDeadLetterSourceQueuesRequest request, ListDeadLetterSourceQueuesResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
request Amazon.SQS.Model.ListDeadLetterSourceQueuesRequest Container for the necessary parameters to execute the ListDeadLetterSourceQueues operation on AmazonSQSClient.
callback ListDeadLetterSourceQueuesResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return void

ListQueues() public method

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.
public ListQueues ( ListQueuesRequest request ) : ListQueuesResponse
request Amazon.SQS.Model.ListQueuesRequest Container for the necessary parameters to execute the ListQueues service method.
return Amazon.SQS.Model.ListQueuesResponse

ListQueues() public method

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.
public ListQueues ( string queueNamePrefix ) : ListQueuesResponse
queueNamePrefix string A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned. Queue names are case-sensitive.
return Amazon.SQS.Model.ListQueuesResponse

ListQueuesAsync() public method

Initiates the asynchronous execution of the ListQueues operation.
public ListQueuesAsync ( ListQueuesRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.SQS.Model.ListQueuesRequest Container for the necessary parameters to execute the ListQueues operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

ListQueuesAsync() public method

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.
public ListQueuesAsync ( string queueNamePrefix, System cancellationToken = default(CancellationToken) ) : Task
queueNamePrefix string A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned. Queue names are case-sensitive.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

ListQueuesAsync() public method

Initiates the asynchronous execution of the ListQueues operation.
public ListQueuesAsync ( ListQueuesRequest request, ListQueuesResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
request Amazon.SQS.Model.ListQueuesRequest Container for the necessary parameters to execute the ListQueues operation on AmazonSQSClient.
callback ListQueuesResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return void

ListQueuesAsync() public method

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.
public ListQueuesAsync ( string queueNamePrefix, ListQueuesResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
queueNamePrefix string A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned. Queue names are case-sensitive.
callback ListQueuesResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. ///
return void

PurgeQueue() public method

Deletes the messages in a queue specified by the QueueURL parameter.

When you use the PurgeQueue action, you can't retrieve a message deleted from a queue.

When you purge a queue, the message deletion process takes up to 60 seconds. All messages sent to the queue before calling the PurgeQueue action are deleted. Messages sent to the queue while it is being purged might be deleted. While the queue is being purged, messages sent to the queue before PurgeQueue is called might be received, but are deleted within the next minute.

/// 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 queue referred to doesn't exist. ///
public PurgeQueue ( PurgeQueueRequest request ) : PurgeQueueResponse
request Amazon.SQS.Model.PurgeQueueRequest Container for the necessary parameters to execute the PurgeQueue service method.
return PurgeQueueResponse

PurgeQueue() public method

Deletes the messages in a queue specified by the QueueURL parameter.

When you use the PurgeQueue action, you can't retrieve a message deleted from a queue.

When you purge a queue, the message deletion process takes up to 60 seconds. All messages sent to the queue before calling the PurgeQueue action are deleted. Messages sent to the queue while it is being purged might be deleted. While the queue is being purged, messages sent to the queue before PurgeQueue is called might be received, but are deleted within the next minute.

/// 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 queue referred to doesn't exist. ///
public PurgeQueue ( string queueUrl ) : PurgeQueueResponse
queueUrl string The URL of the queue from which the PurgeQueue action deletes messages. Queue URLs are case-sensitive.
return PurgeQueueResponse

PurgeQueueAsync() public method

Initiates the asynchronous execution of the PurgeQueue operation.
public PurgeQueueAsync ( PurgeQueueRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.SQS.Model.PurgeQueueRequest Container for the necessary parameters to execute the PurgeQueue operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

PurgeQueueAsync() public method

Deletes the messages in a queue specified by the QueueURL parameter.

When you use the PurgeQueue action, you can't retrieve a message deleted from a queue.

When you purge a queue, the message deletion process takes up to 60 seconds. All messages sent to the queue before calling the PurgeQueue action are deleted. Messages sent to the queue while it is being purged might be deleted. While the queue is being purged, messages sent to the queue before PurgeQueue is called might be received, but are deleted within the next minute.

/// 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 queue referred to doesn't exist. ///
public PurgeQueueAsync ( string queueUrl, System cancellationToken = default(CancellationToken) ) : Task
queueUrl string The URL of the queue from which the PurgeQueue action deletes messages. Queue URLs are case-sensitive.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

PurgeQueueAsync() public method

Initiates the asynchronous execution of the PurgeQueue operation.
public PurgeQueueAsync ( PurgeQueueRequest request, PurgeQueueResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
request Amazon.SQS.Model.PurgeQueueRequest Container for the necessary parameters to execute the PurgeQueue operation on AmazonSQSClient.
callback PurgeQueueResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return void

PurgeQueueAsync() public method

Deletes the messages in a queue specified by the QueueURL parameter.

When you use the PurgeQueue action, you can't retrieve a message deleted from a queue.

When you purge a queue, the message deletion process takes up to 60 seconds. All messages sent to the queue before calling the PurgeQueue action are deleted. Messages sent to the queue while it is being purged might be deleted. While the queue is being purged, messages sent to the queue before PurgeQueue is called might be received, but are deleted within the next minute.

/// 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 queue referred to doesn't exist. ///
public PurgeQueueAsync ( string queueUrl, PurgeQueueResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
queueUrl string The URL of the queue from which the PurgeQueue action deletes messages. Queue URLs are case-sensitive.
callback PurgeQueueResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. ///
return void

ReceiveMessage() public method

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 SQS 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 on 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 SQS 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 SQS 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 action that you requested would violate a limit. For example, ReceiveMessage /// returns this error if the maximum number of inflight messages is reached. AddPermission /// returns this error if the maximum number of permissions for the queue is reached. ///
public ReceiveMessage ( ReceiveMessageRequest request ) : ReceiveMessageResponse
request Amazon.SQS.Model.ReceiveMessageRequest Container for the necessary parameters to execute the ReceiveMessage service method.
return Amazon.SQS.Model.ReceiveMessageResponse

ReceiveMessage() public method

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 SQS 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 on 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 SQS 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 SQS 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 action that you requested would violate a limit. For example, ReceiveMessage /// returns this error if the maximum number of inflight messages is reached. AddPermission /// returns this error if the maximum number of permissions for the queue is reached. ///
public ReceiveMessage ( string queueUrl ) : ReceiveMessageResponse
queueUrl string The URL of the Amazon SQS queue from which messages are received. Queue URLs are case-sensitive.
return Amazon.SQS.Model.ReceiveMessageResponse

ReceiveMessageAsync() public method

Initiates the asynchronous execution of the ReceiveMessage operation.
public ReceiveMessageAsync ( ReceiveMessageRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.SQS.Model.ReceiveMessageRequest Container for the necessary parameters to execute the ReceiveMessage operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

ReceiveMessageAsync() public method

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 SQS 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 on 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 SQS 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 SQS 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 action that you requested would violate a limit. For example, ReceiveMessage /// returns this error if the maximum number of inflight messages is reached. AddPermission /// returns this error if the maximum number of permissions for the queue is reached. ///
public ReceiveMessageAsync ( string queueUrl, System cancellationToken = default(CancellationToken) ) : Task
queueUrl string The URL of the Amazon SQS queue from which messages are received. Queue URLs are case-sensitive.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

ReceiveMessageAsync() public method

Initiates the asynchronous execution of the ReceiveMessage operation.
public ReceiveMessageAsync ( ReceiveMessageRequest request, ReceiveMessageResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
request Amazon.SQS.Model.ReceiveMessageRequest Container for the necessary parameters to execute the ReceiveMessage operation on AmazonSQSClient.
callback ReceiveMessageResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return void

ReceiveMessageAsync() public method

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 SQS 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 on 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 SQS 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 SQS 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 action that you requested would violate a limit. For example, ReceiveMessage /// returns this error if the maximum number of inflight messages is reached. AddPermission /// returns this error if the maximum number of permissions for the queue is reached. ///
public ReceiveMessageAsync ( string queueUrl, ReceiveMessageResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
queueUrl string The URL of the Amazon SQS queue from which messages are received. Queue URLs are case-sensitive.
callback ReceiveMessageResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. ///
return void

RemovePermission() public method

Revokes any permissions in the queue policy that matches the specified Label parameter. Only the owner of the queue can remove permissions.
public RemovePermission ( RemovePermissionRequest request ) : Amazon.SQS.Model.RemovePermissionResponse
request Amazon.SQS.Model.RemovePermissionRequest Container for the necessary parameters to execute the RemovePermission service method.
return Amazon.SQS.Model.RemovePermissionResponse

RemovePermission() public method

Revokes any permissions in the queue policy that matches the specified Label parameter. Only the owner of the queue can remove permissions.
public RemovePermission ( string queueUrl, string label ) : Amazon.SQS.Model.RemovePermissionResponse
queueUrl string The URL of the Amazon SQS queue from which permissions are removed. Queue URLs are case-sensitive.
label string The identification of the permission to remove. This is the label added using the AddPermission action.
return Amazon.SQS.Model.RemovePermissionResponse

RemovePermissionAsync() public method

Initiates the asynchronous execution of the RemovePermission operation.
public RemovePermissionAsync ( RemovePermissionRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.SQS.Model.RemovePermissionRequest Container for the necessary parameters to execute the RemovePermission operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

RemovePermissionAsync() public method

Revokes any permissions in the queue policy that matches the specified Label parameter. Only the owner of the queue can remove permissions.
public RemovePermissionAsync ( string queueUrl, string label, System cancellationToken = default(CancellationToken) ) : Task
queueUrl string The URL of the Amazon SQS queue from which permissions are removed. Queue URLs are case-sensitive.
label string The identification of the permission to remove. This is the label added using the AddPermission action.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

RemovePermissionAsync() public method

Initiates the asynchronous execution of the RemovePermission operation.
public RemovePermissionAsync ( RemovePermissionRequest request, RemovePermissionResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
request Amazon.SQS.Model.RemovePermissionRequest Container for the necessary parameters to execute the RemovePermission operation on AmazonSQSClient.
callback RemovePermissionResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return void

RemovePermissionAsync() public method

Revokes any permissions in the queue policy that matches the specified Label parameter. Only the owner of the queue can remove permissions.
public RemovePermissionAsync ( string queueUrl, string label, RemovePermissionResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
queueUrl string The URL of the Amazon SQS queue from which permissions are removed. Queue URLs are case-sensitive.
label string The identification of the permission to remove. This is the label added using the AddPermission action.
callback RemovePermissionResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. ///
return void

SendMessage() public method

Delivers a message to the specified queue.

The following list shows the characters (in Unicode) that are allowed in your message, according to the W3C XML specification:

  • #x9

  • #xA

  • #xD

  • #x20 to #xD7FF

  • #xE000 to #xFFFD

  • #x10000 to #x10FFFF

For more information, see RFC1321. If you send any characters that aren't included in this list, your request is rejected.

/// The message contains characters outside the allowed set. /// /// Error code 400. Unsupported operation. ///
public SendMessage ( SendMessageRequest request ) : SendMessageResponse
request Amazon.SQS.Model.SendMessageRequest Container for the necessary parameters to execute the SendMessage service method.
return Amazon.SQS.Model.SendMessageResponse

SendMessage() public method

Delivers a message to the specified queue.

The following list shows the characters (in Unicode) that are allowed in your message, according to the W3C XML specification:

  • #x9

  • #xA

  • #xD

  • #x20 to #xD7FF

  • #xE000 to #xFFFD

  • #x10000 to #x10FFFF

For more information, see RFC1321. If you send any characters that aren't included in this list, your request is rejected.

/// The message contains characters outside the allowed set. /// /// Error code 400. Unsupported operation. ///
public SendMessage ( string queueUrl, string messageBody ) : SendMessageResponse
queueUrl string The URL of the Amazon SQS queue to which a message is sent. Queue URLs are case-sensitive.
messageBody string The message to send. The maximum string size is 256 KB. The following list shows the characters (in Unicode) that are allowed in your message, according to the W3C XML specification:
  • #x9
  • #xA
  • #xD
  • #x20 to #xD7FF
  • #xE000 to #xFFFD
  • #x10000 to #x10FFFF
For more information, see RFC1321. If you send any characters that aren't included in this list, your request is rejected.
return Amazon.SQS.Model.SendMessageResponse

SendMessageAsync() public method

Initiates the asynchronous execution of the SendMessage operation.
public SendMessageAsync ( SendMessageRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.SQS.Model.SendMessageRequest Container for the necessary parameters to execute the SendMessage operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

SendMessageAsync() public method

Delivers a message to the specified queue.

The following list shows the characters (in Unicode) that are allowed in your message, according to the W3C XML specification:

  • #x9

  • #xA

  • #xD

  • #x20 to #xD7FF

  • #xE000 to #xFFFD

  • #x10000 to #x10FFFF

For more information, see RFC1321. If you send any characters that aren't included in this list, your request is rejected.

/// The message contains characters outside the allowed set. /// /// Error code 400. Unsupported operation. ///
public SendMessageAsync ( string queueUrl, string messageBody, System cancellationToken = default(CancellationToken) ) : Task
queueUrl string The URL of the Amazon SQS queue to which a message is sent. Queue URLs are case-sensitive.
messageBody string The message to send. The maximum string size is 256 KB. The following list shows the characters (in Unicode) that are allowed in your message, according to the W3C XML specification:
  • #x9
  • #xA
  • #xD
  • #x20 to #xD7FF
  • #xE000 to #xFFFD
  • #x10000 to #x10FFFF
For more information, see RFC1321. If you send any characters that aren't included in this list, your request is rejected.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

SendMessageAsync() public method

Initiates the asynchronous execution of the SendMessage operation.
public SendMessageAsync ( SendMessageRequest request, SendMessageResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
request Amazon.SQS.Model.SendMessageRequest Container for the necessary parameters to execute the SendMessage operation on AmazonSQSClient.
callback SendMessageResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return void

SendMessageAsync() public method

Delivers a message to the specified queue.

The following list shows the characters (in Unicode) that are allowed in your message, according to the W3C XML specification:

  • #x9

  • #xA

  • #xD

  • #x20 to #xD7FF

  • #xE000 to #xFFFD

  • #x10000 to #x10FFFF

For more information, see RFC1321. If you send any characters that aren't included in this list, your request is rejected.

/// The message contains characters outside the allowed set. /// /// Error code 400. Unsupported operation. ///
public SendMessageAsync ( string queueUrl, string messageBody, SendMessageResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
queueUrl string The URL of the Amazon SQS queue to which a message is sent. Queue URLs are case-sensitive.
messageBody string The message to send. The maximum string size is 256 KB. The following list shows the characters (in Unicode) that are allowed in your message, according to the W3C XML specification:
  • #x9
  • #xA
  • #xD
  • #x20 to #xD7FF
  • #xE000 to #xFFFD
  • #x10000 to #x10FFFF
For more information, see RFC1321. If you send any characters that aren't included in this list, your request is rejected.
callback SendMessageResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. ///
return void

SendMessageBatch() public method

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).

The following list shows the characters (in Unicode) that are allowed in your message, according to the W3C XML specification:

  • #x9

  • #xA

  • #xD

  • #x20 to #xD7FF

  • #xE000 to #xFFFD

  • #x10000 to #x10FFFF

For more information, see RFC1321. If you send any characters that aren't included in this list, your request is rejected.

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=this

&Attribute.2=that

/// 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. ///
public SendMessageBatch ( SendMessageBatchRequest request ) : SendMessageBatchResponse
request Amazon.SQS.Model.SendMessageBatchRequest Container for the necessary parameters to execute the SendMessageBatch service method.
return Amazon.SQS.Model.SendMessageBatchResponse

SendMessageBatch() public method

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).

The following list shows the characters (in Unicode) that are allowed in your message, according to the W3C XML specification:

  • #x9

  • #xA

  • #xD

  • #x20 to #xD7FF

  • #xE000 to #xFFFD

  • #x10000 to #x10FFFF

For more information, see RFC1321. If you send any characters that aren't included in this list, your request is rejected.

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=this

&Attribute.2=that

/// 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. ///
public SendMessageBatch ( string queueUrl, List entries ) : SendMessageBatchResponse
queueUrl string The URL of the Amazon SQS queue to which batched messages are sent. Queue URLs are case-sensitive.
entries List A list of SendMessageBatchRequestEntry items.
return Amazon.SQS.Model.SendMessageBatchResponse

SendMessageBatchAsync() public method

Initiates the asynchronous execution of the SendMessageBatch operation.
public SendMessageBatchAsync ( SendMessageBatchRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.SQS.Model.SendMessageBatchRequest Container for the necessary parameters to execute the SendMessageBatch operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

SendMessageBatchAsync() public method

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).

The following list shows the characters (in Unicode) that are allowed in your message, according to the W3C XML specification:

  • #x9

  • #xA

  • #xD

  • #x20 to #xD7FF

  • #xE000 to #xFFFD

  • #x10000 to #x10FFFF

For more information, see RFC1321. If you send any characters that aren't included in this list, your request is rejected.

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=this

&Attribute.2=that

/// 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. ///
public SendMessageBatchAsync ( string queueUrl, List entries, System cancellationToken = default(CancellationToken) ) : Task
queueUrl string The URL of the Amazon SQS queue to which batched messages are sent. Queue URLs are case-sensitive.
entries List A list of SendMessageBatchRequestEntry items.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

SendMessageBatchAsync() public method

Initiates the asynchronous execution of the SendMessageBatch operation.
public SendMessageBatchAsync ( SendMessageBatchRequest request, SendMessageBatchResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
request Amazon.SQS.Model.SendMessageBatchRequest Container for the necessary parameters to execute the SendMessageBatch operation on AmazonSQSClient.
callback SendMessageBatchResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return void

SendMessageBatchAsync() public method

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).

The following list shows the characters (in Unicode) that are allowed in your message, according to the W3C XML specification:

  • #x9

  • #xA

  • #xD

  • #x20 to #xD7FF

  • #xE000 to #xFFFD

  • #x10000 to #x10FFFF

For more information, see RFC1321. If you send any characters that aren't included in this list, your request is rejected.

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=this

&Attribute.2=that

/// 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. ///
public SendMessageBatchAsync ( string queueUrl, List entries, SendMessageBatchResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
queueUrl string The URL of the Amazon SQS queue to which batched messages are sent. Queue URLs are case-sensitive.
entries List A list of SendMessageBatchRequestEntry items.
callback SendMessageBatchResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. ///
return void

SetQueueAttributes() public method

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.

/// The attribute referred to doesn't exist. ///
public SetQueueAttributes ( SetQueueAttributesRequest request ) : Amazon.SQS.Model.SetQueueAttributesResponse
request Amazon.SQS.Model.SetQueueAttributesRequest Container for the necessary parameters to execute the SetQueueAttributes service method.
return Amazon.SQS.Model.SetQueueAttributesResponse

SetQueueAttributes() public method

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.

/// The attribute referred to doesn't exist. ///
public SetQueueAttributes ( string queueUrl, string>.Dictionary attributes ) : Amazon.SQS.Model.SetQueueAttributesResponse
queueUrl string The URL of the Amazon SQS queue whose attributes are set. Queue URLs are case-sensitive.
attributes string>.Dictionary 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 number of seconds for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 (15 minutes). The default is 0 (zero).
  • 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). The default is 262,144 (256 KiB).
  • MessageRetentionPeriod - The number of seconds for which Amazon SQS retains a message. Valid values: An integer representing seconds, from 60 (1 minute) to 1,209,600 (14 days). The default is 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 number of seconds for which a ReceiveMessage action waits for a message to arrive. Valid values: an integer from 0 to 20 (seconds). The default is 0.
  • RedrivePolicy - 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 SQS Developer Guide. 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. Valid values: an integer from 0 to 43,200 (12 hours). The default is 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.
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 SQS 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.
    • You can also use ContentBasedDeduplication for messages with identical content to be treated as duplicates.
    • 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.
Any other valid special request parameters (such as the following) are ignored:
  • ApproximateNumberOfMessages
  • ApproximateNumberOfMessagesDelayed
  • ApproximateNumberOfMessagesNotVisible
  • CreatedTimestamp
  • LastModifiedTimestamp
  • QueueArn
return Amazon.SQS.Model.SetQueueAttributesResponse

SetQueueAttributesAsync() public method

Initiates the asynchronous execution of the SetQueueAttributes operation.
public SetQueueAttributesAsync ( SetQueueAttributesRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.SQS.Model.SetQueueAttributesRequest Container for the necessary parameters to execute the SetQueueAttributes operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

SetQueueAttributesAsync() public method

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.

/// The attribute referred to doesn't exist. ///
public SetQueueAttributesAsync ( string queueUrl, string>.Dictionary attributes, System cancellationToken = default(CancellationToken) ) : Task
queueUrl string The URL of the Amazon SQS queue whose attributes are set. Queue URLs are case-sensitive.
attributes string>.Dictionary 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 number of seconds for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 (15 minutes). The default is 0 (zero).
  • 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). The default is 262,144 (256 KiB).
  • MessageRetentionPeriod - The number of seconds for which Amazon SQS retains a message. Valid values: An integer representing seconds, from 60 (1 minute) to 1,209,600 (14 days). The default is 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 number of seconds for which a ReceiveMessage action waits for a message to arrive. Valid values: an integer from 0 to 20 (seconds). The default is 0.
  • RedrivePolicy - 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 SQS Developer Guide. 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. Valid values: an integer from 0 to 43,200 (12 hours). The default is 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.
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 SQS 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.
    • You can also use ContentBasedDeduplication for messages with identical content to be treated as duplicates.
    • 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.
Any other valid special request parameters (such as the following) are ignored:
  • ApproximateNumberOfMessages
  • ApproximateNumberOfMessagesDelayed
  • ApproximateNumberOfMessagesNotVisible
  • CreatedTimestamp
  • LastModifiedTimestamp
  • QueueArn
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

SetQueueAttributesAsync() public method

Initiates the asynchronous execution of the SetQueueAttributes operation.
public SetQueueAttributesAsync ( SetQueueAttributesRequest request, SetQueueAttributesResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
request Amazon.SQS.Model.SetQueueAttributesRequest Container for the necessary parameters to execute the SetQueueAttributes operation on AmazonSQSClient.
callback SetQueueAttributesResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return void

SetQueueAttributesAsync() public method

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.

/// The attribute referred to doesn't exist. ///
public SetQueueAttributesAsync ( string queueUrl, string>.Dictionary attributes, SetQueueAttributesResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
queueUrl string The URL of the Amazon SQS queue whose attributes are set. Queue URLs are case-sensitive.
attributes string>.Dictionary 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 number of seconds for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 (15 minutes). The default is 0 (zero).
  • 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). The default is 262,144 (256 KiB).
  • MessageRetentionPeriod - The number of seconds for which Amazon SQS retains a message. Valid values: An integer representing seconds, from 60 (1 minute) to 1,209,600 (14 days). The default is 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 number of seconds for which a ReceiveMessage action waits for a message to arrive. Valid values: an integer from 0 to 20 (seconds). The default is 0.
  • RedrivePolicy - 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 SQS Developer Guide. 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. Valid values: an integer from 0 to 43,200 (12 hours). The default is 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.
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 SQS 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.
    • You can also use ContentBasedDeduplication for messages with identical content to be treated as duplicates.
    • 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.
Any other valid special request parameters (such as the following) are ignored:
  • ApproximateNumberOfMessages
  • ApproximateNumberOfMessagesDelayed
  • ApproximateNumberOfMessagesNotVisible
  • CreatedTimestamp
  • LastModifiedTimestamp
  • QueueArn
callback SetQueueAttributesResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. ///
return void