AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Implementation for accessing SQS
Welcome to the Amazon SQS API Reference.Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel between applications or microservices. Amazon SQS moves data between distributed application components and helps you decouple these components.
For information on the permissions you need to use this API, see Identity and access management in the Amazon SQS Developer Guide.
You can use Amazon Web Services SDKs to access Amazon SQS using your favorite programming language. The SDKs perform tasks such as the following automatically:
Cryptographically sign your service requests
Retry requests
Handle error responses
Additional information
Amazon SQS Developer Guide
Amazon Web Services General Reference
Namespace: Amazon.SQS
Assembly: AWSSDK.SQS.dll
Version: 3.x.y.z
public class AmazonSQSClient : AmazonServiceClient IAmazonService, IAmazonSQS, ICoreAmazonSQS, IDisposable
The AmazonSQSClient type exposes the following members
Name | Description | |
---|---|---|
![]() |
AmazonSQSClient() |
Constructs AmazonSQSClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
![]() |
AmazonSQSClient(RegionEndpoint) |
Constructs AmazonSQSClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
![]() |
AmazonSQSClient(AmazonSQSConfig) |
Constructs AmazonSQSClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
![]() |
AmazonSQSClient(AWSCredentials) |
Constructs AmazonSQSClient with AWS Credentials |
![]() |
AmazonSQSClient(AWSCredentials, RegionEndpoint) |
Constructs AmazonSQSClient with AWS Credentials |
![]() |
AmazonSQSClient(AWSCredentials, AmazonSQSConfig) |
Constructs AmazonSQSClient with AWS Credentials and an AmazonSQSClient Configuration object. |
![]() |
AmazonSQSClient(string, string) |
Constructs AmazonSQSClient with AWS Access Key ID and AWS Secret Key |
![]() |
AmazonSQSClient(string, string, RegionEndpoint) |
Constructs AmazonSQSClient with AWS Access Key ID and AWS Secret Key |
![]() |
AmazonSQSClient(string, string, AmazonSQSConfig) |
Constructs AmazonSQSClient with AWS Access Key ID, AWS Secret Key and an AmazonSQSClient Configuration object. |
![]() |
AmazonSQSClient(string, string, string) |
Constructs AmazonSQSClient with AWS Access Key ID and AWS Secret Key |
![]() |
AmazonSQSClient(string, string, string, RegionEndpoint) |
Constructs AmazonSQSClient with AWS Access Key ID and AWS Secret Key |
![]() |
AmazonSQSClient(string, string, string, AmazonSQSConfig) |
Constructs AmazonSQSClient with AWS Access Key ID, AWS Secret Key and an AmazonSQSClient Configuration object. |
Name | Type | Description | |
---|---|---|---|
![]() |
Config | Amazon.Runtime.IClientConfig | Inherited from Amazon.Runtime.AmazonServiceClient. |
![]() |
Paginators | Amazon.SQS.Model.ISQSPaginatorFactory |
Paginators for the service |
Name | Description | |
---|---|---|
![]() |
AddPermission(string, string, List<String>, List<String>) |
Adds a permission to a queue for a specific principal. This allows sharing access to the queue. When you create a queue, you have full control access rights for the queue. Only you, the owner of the queue, can grant or deny permissions to the queue. For more information about these permissions, see Allow Developers to Write Messages to a Shared Queue in the Amazon SQS Developer Guide.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide. |
![]() |
AddPermission(AddPermissionRequest) |
Adds a permission to a queue for a specific principal. This allows sharing access to the queue. When you create a queue, you have full control access rights for the queue. Only you, the owner of the queue, can grant or deny permissions to the queue. For more information about these permissions, see Allow Developers to Write Messages to a Shared Queue in the Amazon SQS Developer Guide.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide. |
![]() |
AddPermissionAsync(string, string, List<String>, List<String>, CancellationToken) |
Adds a permission to a queue for a specific principal. This allows sharing access to the queue. When you create a queue, you have full control access rights for the queue. Only you, the owner of the queue, can grant or deny permissions to the queue. For more information about these permissions, see Allow Developers to Write Messages to a Shared Queue in the Amazon SQS Developer Guide.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide. |
![]() |
AddPermissionAsync(AddPermissionRequest, CancellationToken) |
Adds a permission to a queue for a specific principal. This allows sharing access to the queue. When you create a queue, you have full control access rights for the queue. Only you, the owner of the queue, can grant or deny permissions to the queue. For more information about these permissions, see Allow Developers to Write Messages to a Shared Queue in the Amazon SQS Developer Guide.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide. |
![]() |
AuthorizeS3ToSendMessage(string, 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, string) |
This is a utility method which updates the policy of a queue to allow the S3 bucket to publish events to it. |
![]() |
CancelMessageMoveTask(CancelMessageMoveTaskRequest) |
Cancels a specified message movement task. A message movement can only be cancelled
when the current status is RUNNING. Cancelling a message movement task does not revert
the messages that have already been moved. It can only stop the messages that have
not been moved yet.
This action is currently limited to supporting message redrive from dead-letter
queues (DLQs) only. In this context, the source queue is the dead-letter queue
(DLQ), while the destination queue can be the original source queue (from which the
messages were driven to the dead-letter-queue), or a custom destination queue.
Only one active message movement task is supported per queue at any given time.
|
![]() |
CancelMessageMoveTaskAsync(CancelMessageMoveTaskRequest, CancellationToken) |
Cancels a specified message movement task. A message movement can only be cancelled
when the current status is RUNNING. Cancelling a message movement task does not revert
the messages that have already been moved. It can only stop the messages that have
not been moved yet.
This action is currently limited to supporting message redrive from dead-letter
queues (DLQs) only. In this context, the source queue is the dead-letter queue
(DLQ), while the destination queue can be the original source queue (from which the
messages were driven to the dead-letter-queue), or a custom destination queue.
Only one active message movement task is supported per queue at any given time.
|
![]() |
ChangeMessageVisibility(string, string, int) |
Changes the visibility timeout of a specified message in a queue to a new value. The default visibility timeout for a message is 30 seconds. The minimum is 0 seconds. The maximum is 12 hours. For more information, see Visibility Timeout in the Amazon SQS Developer Guide.
For example, if the default timeout for a queue is 60 seconds, 15 seconds have elapsed
since you received the message, and you send a ChangeMessageVisibility call with An Amazon SQS message has three basic states:
A message is considered to be stored after it is sent to a queue by a producer, but not yet received from the queue by a consumer (that is, between states 1 and 2). There is no limit to the number of stored messages. A message is considered to be in flight after it is received from a queue by a consumer, but not yet deleted from the queue (that is, between states 2 and 3). There is a limit to the number of in flight messages. Limits that apply to in flight messages are unrelated to the unlimited number of stored messages.
For most standard queues (depending on queue traffic and message backlog), there can
be a maximum of approximately 120,000 in flight messages (received from a queue by
a consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS
returns the For FIFO queues, there can be a maximum of 20,000 in flight messages (received from a queue by a consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS returns no error messages.
If you attempt to set the
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(ChangeMessageVisibilityRequest) |
Changes the visibility timeout of a specified message in a queue to a new value. The default visibility timeout for a message is 30 seconds. The minimum is 0 seconds. The maximum is 12 hours. For more information, see Visibility Timeout in the Amazon SQS Developer Guide.
For example, if the default timeout for a queue is 60 seconds, 15 seconds have elapsed
since you received the message, and you send a ChangeMessageVisibility call with An Amazon SQS message has three basic states:
A message is considered to be stored after it is sent to a queue by a producer, but not yet received from the queue by a consumer (that is, between states 1 and 2). There is no limit to the number of stored messages. A message is considered to be in flight after it is received from a queue by a consumer, but not yet deleted from the queue (that is, between states 2 and 3). There is a limit to the number of in flight messages. Limits that apply to in flight messages are unrelated to the unlimited number of stored messages.
For most standard queues (depending on queue traffic and message backlog), there can
be a maximum of approximately 120,000 in flight messages (received from a queue by
a consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS
returns the For FIFO queues, there can be a maximum of 20,000 in flight messages (received from a queue by a consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS returns no error messages.
If you attempt to set the
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
|
![]() |
ChangeMessageVisibilityAsync(string, string, int, CancellationToken) |
Changes the visibility timeout of a specified message in a queue to a new value. The default visibility timeout for a message is 30 seconds. The minimum is 0 seconds. The maximum is 12 hours. For more information, see Visibility Timeout in the Amazon SQS Developer Guide.
For example, if the default timeout for a queue is 60 seconds, 15 seconds have elapsed
since you received the message, and you send a ChangeMessageVisibility call with An Amazon SQS message has three basic states:
A message is considered to be stored after it is sent to a queue by a producer, but not yet received from the queue by a consumer (that is, between states 1 and 2). There is no limit to the number of stored messages. A message is considered to be in flight after it is received from a queue by a consumer, but not yet deleted from the queue (that is, between states 2 and 3). There is a limit to the number of in flight messages. Limits that apply to in flight messages are unrelated to the unlimited number of stored messages.
For most standard queues (depending on queue traffic and message backlog), there can
be a maximum of approximately 120,000 in flight messages (received from a queue by
a consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS
returns the For FIFO queues, there can be a maximum of 20,000 in flight messages (received from a queue by a consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS returns no error messages.
If you attempt to set the
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
|
![]() |
ChangeMessageVisibilityAsync(ChangeMessageVisibilityRequest, CancellationToken) |
Changes the visibility timeout of a specified message in a queue to a new value. The default visibility timeout for a message is 30 seconds. The minimum is 0 seconds. The maximum is 12 hours. For more information, see Visibility Timeout in the Amazon SQS Developer Guide.
For example, if the default timeout for a queue is 60 seconds, 15 seconds have elapsed
since you received the message, and you send a ChangeMessageVisibility call with An Amazon SQS message has three basic states:
A message is considered to be stored after it is sent to a queue by a producer, but not yet received from the queue by a consumer (that is, between states 1 and 2). There is no limit to the number of stored messages. A message is considered to be in flight after it is received from a queue by a consumer, but not yet deleted from the queue (that is, between states 2 and 3). There is a limit to the number of in flight messages. Limits that apply to in flight messages are unrelated to the unlimited number of stored messages.
For most standard queues (depending on queue traffic and message backlog), there can
be a maximum of approximately 120,000 in flight messages (received from a queue by
a consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS
returns the For FIFO queues, there can be a maximum of 20,000 in flight messages (received from a queue by a consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS returns no error messages.
If you attempt to set the
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
|
![]() |
ChangeMessageVisibilityBatch(string, List<ChangeMessageVisibilityBatchRequestEntry>) |
Changes the visibility timeout of multiple messages. This is a batch version of
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 |
![]() |
ChangeMessageVisibilityBatch(ChangeMessageVisibilityBatchRequest) |
Changes the visibility timeout of multiple messages. This is a batch version of
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 |
![]() |
ChangeMessageVisibilityBatchAsync(string, List<ChangeMessageVisibilityBatchRequestEntry>, CancellationToken) |
Changes the visibility timeout of multiple messages. This is a batch version of
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 |
![]() |
ChangeMessageVisibilityBatchAsync(ChangeMessageVisibilityBatchRequest, CancellationToken) |
Changes the visibility timeout of multiple messages. This is a batch version of
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 |
![]() |
CreateQueue(string) |
Creates a new standard or FIFO queue. You can pass one or more attributes in the request. Keep the following in mind:
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. After you create a queue, you must wait at least one second after the queue is created to be able to use the queue.
To get the queue URL, use the
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide. |
![]() |
CreateQueue(CreateQueueRequest) |
Creates a new standard or FIFO queue. You can pass one or more attributes in the request. Keep the following in mind:
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. After you create a queue, you must wait at least one second after the queue is created to be able to use the queue.
To get the queue URL, use the
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide. |
![]() |
CreateQueueAsync(string, CancellationToken) |
Creates a new standard or FIFO queue. You can pass one or more attributes in the request. Keep the following in mind:
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. After you create a queue, you must wait at least one second after the queue is created to be able to use the queue.
To get the queue URL, use the
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide. |
![]() |
CreateQueueAsync(CreateQueueRequest, CancellationToken) |
Creates a new standard or FIFO queue. You can pass one or more attributes in the request. Keep the following in mind:
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. After you create a queue, you must wait at least one second after the queue is created to be able to use the queue.
To get the queue URL, use the
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide. |
![]() |
DeleteMessage(string, string) |
Deletes the specified message from the specified queue. To select the message to delete,
use the
The
For standard queues, it is possible to receive a message even after you delete it.
This might happen on rare occasions if one of the servers which stores a copy of the
message is unavailable when you send the request to delete the message. The copy remains
on the server and might be returned to you during a subsequent receive request. You
should ensure that your application is idempotent, so that receiving a message more
than once does not cause issues.
|
![]() |
DeleteMessage(DeleteMessageRequest) |
Deletes the specified message from the specified queue. To select the message to delete,
use the
The
For standard queues, it is possible to receive a message even after you delete it.
This might happen on rare occasions if one of the servers which stores a copy of the
message is unavailable when you send the request to delete the message. The copy remains
on the server and might be returned to you during a subsequent receive request. You
should ensure that your application is idempotent, so that receiving a message more
than once does not cause issues.
|
![]() |
DeleteMessageAsync(string, string, CancellationToken) |
Deletes the specified message from the specified queue. To select the message to delete,
use the
The
For standard queues, it is possible to receive a message even after you delete it.
This might happen on rare occasions if one of the servers which stores a copy of the
message is unavailable when you send the request to delete the message. The copy remains
on the server and might be returned to you during a subsequent receive request. You
should ensure that your application is idempotent, so that receiving a message more
than once does not cause issues.
|
![]() |
DeleteMessageAsync(DeleteMessageRequest, CancellationToken) |
Deletes the specified message from the specified queue. To select the message to delete,
use the
The
For standard queues, it is possible to receive a message even after you delete it.
This might happen on rare occasions if one of the servers which stores a copy of the
message is unavailable when you send the request to delete the message. The copy remains
on the server and might be returned to you during a subsequent receive request. You
should ensure that your application is idempotent, so that receiving a message more
than once does not cause issues.
|
![]() |
DeleteMessageBatch(string, List<DeleteMessageBatchRequestEntry>) |
Deletes up to ten messages from the specified queue. This is a batch version of
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 |
![]() |
DeleteMessageBatch(DeleteMessageBatchRequest) |
Deletes up to ten messages from the specified queue. This is a batch version of
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 |
![]() |
DeleteMessageBatchAsync(string, List<DeleteMessageBatchRequestEntry>, CancellationToken) |
Deletes up to ten messages from the specified queue. This is a batch version of
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 |
![]() |
DeleteMessageBatchAsync(DeleteMessageBatchRequest, CancellationToken) |
Deletes up to ten messages from the specified queue. This is a batch version of
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 |
![]() |
DeleteQueue(string) |
Deletes the queue specified by the
Be careful with the
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 When you delete a queue, you must wait at least 60 seconds before creating a queue with the same name. Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
The delete operation uses the HTTP |
![]() |
DeleteQueue(DeleteQueueRequest) |
Deletes the queue specified by the
Be careful with the
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 When you delete a queue, you must wait at least 60 seconds before creating a queue with the same name. Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
The delete operation uses the HTTP |
![]() |
DeleteQueueAsync(string, CancellationToken) |
Deletes the queue specified by the
Be careful with the
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 When you delete a queue, you must wait at least 60 seconds before creating a queue with the same name. Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
The delete operation uses the HTTP |
![]() |
DeleteQueueAsync(DeleteQueueRequest, CancellationToken) |
Deletes the queue specified by the
Be careful with the
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 When you delete a queue, you must wait at least 60 seconds before creating a queue with the same name. Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
The delete operation uses the HTTP |
![]() |
DetermineServiceOperationEndpoint(AmazonWebServiceRequest) |
Returns the endpoint that will be used for a particular request. |
![]() |
Dispose() | Inherited from Amazon.Runtime.AmazonServiceClient. |
![]() |
GetQueueAttributes(string, List<String>) |
Gets attributes for the specified queue.
To determine whether a queue is FIFO,
you can check whether |
![]() |
GetQueueAttributes(GetQueueAttributesRequest) |
Gets attributes for the specified queue.
To determine whether a queue is FIFO,
you can check whether |
![]() |
GetQueueAttributesAsync(string, List<String>, CancellationToken) |
Gets attributes for the specified queue.
To determine whether a queue is FIFO,
you can check whether |
![]() |
GetQueueAttributesAsync(GetQueueAttributesRequest, CancellationToken) |
Gets attributes for the specified queue.
To determine whether a queue is FIFO,
you can check whether |
![]() |
GetQueueUrl(string) |
Returns the URL of an existing Amazon SQS queue.
To access a queue that belongs to another AWS account, use the |
![]() |
GetQueueUrl(GetQueueUrlRequest) |
Returns the URL of an existing Amazon SQS queue.
To access a queue that belongs to another AWS account, use the |
![]() |
GetQueueUrlAsync(string, CancellationToken) |
Returns the URL of an existing Amazon SQS queue.
To access a queue that belongs to another AWS account, use the |
![]() |
GetQueueUrlAsync(GetQueueUrlRequest, CancellationToken) |
Returns the URL of an existing Amazon SQS queue.
To access a queue that belongs to another AWS account, use the |
![]() |
ListDeadLetterSourceQueues(ListDeadLetterSourceQueuesRequest) |
Returns a list of your queues that have the
The For more information about using dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon SQS Developer Guide. |
![]() |
ListDeadLetterSourceQueuesAsync(ListDeadLetterSourceQueuesRequest, CancellationToken) |
Returns a list of your queues that have the
The For more information about using dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon SQS Developer Guide. |
![]() |
ListMessageMoveTasks(ListMessageMoveTasksRequest) |
Gets the most recent message movement tasks (up to 10) under a specific source queue.
This action is currently limited to supporting message redrive from dead-letter
queues (DLQs) only. In this context, the source queue is the dead-letter queue
(DLQ), while the destination queue can be the original source queue (from which the
messages were driven to the dead-letter-queue), or a custom destination queue.
Only one active message movement task is supported per queue at any given time.
|
![]() |
ListMessageMoveTasksAsync(ListMessageMoveTasksRequest, CancellationToken) |
Gets the most recent message movement tasks (up to 10) under a specific source queue.
This action is currently limited to supporting message redrive from dead-letter
queues (DLQs) only. In this context, the source queue is the dead-letter queue
(DLQ), while the destination queue can be the original source queue (from which the
messages were driven to the dead-letter-queue), or a custom destination queue.
Only one active message movement task is supported per queue at any given time.
|
![]() |
ListQueues(string) |
Returns a list of your queues in the current region. The response includes a maximum
of 1,000 results. If you specify a value for the optional
The Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide. |
![]() |
ListQueues(ListQueuesRequest) |
Returns a list of your queues in the current region. The response includes a maximum
of 1,000 results. If you specify a value for the optional
The Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide. |
![]() |
ListQueuesAsync(string, CancellationToken) |
Returns a list of your queues in the current region. The response includes a maximum
of 1,000 results. If you specify a value for the optional
The Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide. |
![]() |
ListQueuesAsync(ListQueuesRequest, CancellationToken) |
Returns a list of your queues in the current region. The response includes a maximum
of 1,000 results. If you specify a value for the optional
The Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide. |
![]() |
ListQueueTags(ListQueueTagsRequest) |
List all cost allocation tags added to the specified Amazon SQS queue. For an overview,
see Tagging
Your Amazon SQS Queues in the Amazon SQS Developer Guide.
Cross-account permissions don't apply to this action. For more information, see Grant
cross-account permissions to a role and a username in the Amazon SQS Developer
Guide.
|
![]() |
ListQueueTagsAsync(ListQueueTagsRequest, CancellationToken) |
List all cost allocation tags added to the specified Amazon SQS queue. For an overview,
see Tagging
Your Amazon SQS Queues in the Amazon SQS Developer Guide.
Cross-account permissions don't apply to this action. For more information, see Grant
cross-account permissions to a role and a username in the Amazon SQS Developer
Guide.
|
![]() |
PurgeQueue(string) |
Deletes available messages in a queue (including in-flight messages) specified by
the
When you use the
The message deletion process takes up to 60 seconds. We recommend waiting for 60 seconds
regardless of your queue's size.
Messages sent to the queue before you call
Messages sent to the queue after you call |
![]() |
PurgeQueue(PurgeQueueRequest) |
Deletes available messages in a queue (including in-flight messages) specified by
the
When you use the
The message deletion process takes up to 60 seconds. We recommend waiting for 60 seconds
regardless of your queue's size.
Messages sent to the queue before you call
Messages sent to the queue after you call |
![]() |
PurgeQueueAsync(string, CancellationToken) |
Deletes available messages in a queue (including in-flight messages) specified by
the
When you use the
The message deletion process takes up to 60 seconds. We recommend waiting for 60 seconds
regardless of your queue's size.
Messages sent to the queue before you call
Messages sent to the queue after you call |
![]() |
PurgeQueueAsync(PurgeQueueRequest, CancellationToken) |
Deletes available messages in a queue (including in-flight messages) specified by
the
When you use the
The message deletion process takes up to 60 seconds. We recommend waiting for 60 seconds
regardless of your queue's size.
Messages sent to the queue before you call
Messages sent to the queue after you call |
![]() |
ReceiveMessage(string) |
Retrieves one or more messages (up to 10), from the specified queue. Using the
Short poll is the default behavior where a weighted random set of machines is sampled
on a For each message returned, the response includes the following:
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 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(ReceiveMessageRequest) |
Retrieves one or more messages (up to 10), from the specified queue. Using the
Short poll is the default behavior where a weighted random set of machines is sampled
on a For each message returned, the response includes the following:
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 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(string, CancellationToken) |
Retrieves one or more messages (up to 10), from the specified queue. Using the
Short poll is the default behavior where a weighted random set of machines is sampled
on a For each message returned, the response includes the following:
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 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, CancellationToken) |
Retrieves one or more messages (up to 10), from the specified queue. Using the
Short poll is the default behavior where a weighted random set of machines is sampled
on a For each message returned, the response includes the following:
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 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(string, string) |
Revokes any permissions in the queue policy that matches the specified
Only the owner of a queue can remove permissions from it.
Cross-account permissions don't apply to this action. For more information, see Grant
cross-account permissions to a role and a username in the Amazon SQS Developer
Guide.
To remove the ability to change queue permissions, you must deny permission to the
|
![]() |
RemovePermission(RemovePermissionRequest) |
Revokes any permissions in the queue policy that matches the specified
Only the owner of a queue can remove permissions from it.
Cross-account permissions don't apply to this action. For more information, see Grant
cross-account permissions to a role and a username in the Amazon SQS Developer
Guide.
To remove the ability to change queue permissions, you must deny permission to the
|
![]() |
RemovePermissionAsync(string, string, CancellationToken) |
Revokes any permissions in the queue policy that matches the specified
Only the owner of a queue can remove permissions from it.
Cross-account permissions don't apply to this action. For more information, see Grant
cross-account permissions to a role and a username in the Amazon SQS Developer
Guide.
To remove the ability to change queue permissions, you must deny permission to the
|
![]() |
RemovePermissionAsync(RemovePermissionRequest, CancellationToken) |
Revokes any permissions in the queue policy that matches the specified
Only the owner of a queue can remove permissions from it.
Cross-account permissions don't apply to this action. For more information, see Grant
cross-account permissions to a role and a username in the Amazon SQS Developer
Guide.
To remove the ability to change queue permissions, you must deny permission to the
|
![]() |
SendMessage(string, string) |
Delivers a message to the specified queue.
A message can include only XML, JSON, and unformatted text. The following Unicode
characters are allowed. For more information, see the W3C
specification for characters.
Amazon SQS does not throw an exception or completely reject the message if it contains
invalid characters. Instead, it replaces those invalid characters with |
![]() |
SendMessage(SendMessageRequest) |
Delivers a message to the specified queue.
A message can include only XML, JSON, and unformatted text. The following Unicode
characters are allowed. For more information, see the W3C
specification for characters.
Amazon SQS does not throw an exception or completely reject the message if it contains
invalid characters. Instead, it replaces those invalid characters with |
![]() |
SendMessageAsync(string, string, CancellationToken) |
Delivers a message to the specified queue.
A message can include only XML, JSON, and unformatted text. The following Unicode
characters are allowed. For more information, see the W3C
specification for characters.
Amazon SQS does not throw an exception or completely reject the message if it contains
invalid characters. Instead, it replaces those invalid characters with |
![]() |
SendMessageAsync(SendMessageRequest, CancellationToken) |
Delivers a message to the specified queue.
A message can include only XML, JSON, and unformatted text. The following Unicode
characters are allowed. For more information, see the W3C
specification for characters.
Amazon SQS does not throw an exception or completely reject the message if it contains
invalid characters. Instead, it replaces those invalid characters with |
![]() |
SendMessageBatch(string, List<SendMessageBatchRequestEntry>) |
You can use
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
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 KiB (262,144 bytes). A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters.
Amazon SQS does not throw an exception or completely reject the message if it contains
invalid characters. Instead, it replaces those invalid characters with
If you don't specify the |
![]() |
SendMessageBatch(SendMessageBatchRequest) |
You can use
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
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 KiB (262,144 bytes). A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters.
Amazon SQS does not throw an exception or completely reject the message if it contains
invalid characters. Instead, it replaces those invalid characters with
If you don't specify the |
![]() |
SendMessageBatchAsync(string, List<SendMessageBatchRequestEntry>, CancellationToken) |
You can use
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
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 KiB (262,144 bytes). A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters.
Amazon SQS does not throw an exception or completely reject the message if it contains
invalid characters. Instead, it replaces those invalid characters with
If you don't specify the |
![]() |
SendMessageBatchAsync(SendMessageBatchRequest, CancellationToken) |
You can use
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
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 KiB (262,144 bytes). A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters.
Amazon SQS does not throw an exception or completely reject the message if it contains
invalid characters. Instead, it replaces those invalid characters with
If you don't specify the |
![]() |
SetQueueAttributes(string, Dictionary<String, String>) |
Sets the value of one or more queue attributes, like a policy. 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
In the future, new attributes might be added. If you write code that calls this action,
we recommend that you structure your code so that it can handle new attributes gracefully.
Cross-account permissions don't apply to this action. For more information, see Grant
cross-account permissions to a role and a username in the Amazon SQS Developer
Guide.
To remove the ability to change queue permissions, you must deny permission to the
|
![]() |
SetQueueAttributes(SetQueueAttributesRequest) |
Sets the value of one or more queue attributes, like a policy. 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
In the future, new attributes might be added. If you write code that calls this action,
we recommend that you structure your code so that it can handle new attributes gracefully.
Cross-account permissions don't apply to this action. For more information, see Grant
cross-account permissions to a role and a username in the Amazon SQS Developer
Guide.
To remove the ability to change queue permissions, you must deny permission to the
|
![]() |
SetQueueAttributesAsync(string, Dictionary<String, String>, CancellationToken) |
Sets the value of one or more queue attributes, like a policy. 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
In the future, new attributes might be added. If you write code that calls this action,
we recommend that you structure your code so that it can handle new attributes gracefully.
Cross-account permissions don't apply to this action. For more information, see Grant
cross-account permissions to a role and a username in the Amazon SQS Developer
Guide.
To remove the ability to change queue permissions, you must deny permission to the
|
![]() |
SetQueueAttributesAsync(SetQueueAttributesRequest, CancellationToken) |
Sets the value of one or more queue attributes, like a policy. 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
In the future, new attributes might be added. If you write code that calls this action,
we recommend that you structure your code so that it can handle new attributes gracefully.
Cross-account permissions don't apply to this action. For more information, see Grant
cross-account permissions to a role and a username in the Amazon SQS Developer
Guide.
To remove the ability to change queue permissions, you must deny permission to the
|
![]() |
StartMessageMoveTask(StartMessageMoveTaskRequest) |
Starts an asynchronous task to move messages from a specified source queue to a specified
destination queue.
This action is currently limited to supporting message redrive from queues that are
configured as dead-letter
queues (DLQs) of other Amazon SQS queues only. Non-SQS queue sources of dead-letter
queues, such as Lambda or Amazon SNS topics, are currently not supported.
In dead-letter queues redrive context, the
Only one active message movement task is supported per queue at any given time.
|
![]() |
StartMessageMoveTaskAsync(StartMessageMoveTaskRequest, CancellationToken) |
Starts an asynchronous task to move messages from a specified source queue to a specified
destination queue.
This action is currently limited to supporting message redrive from queues that are
configured as dead-letter
queues (DLQs) of other Amazon SQS queues only. Non-SQS queue sources of dead-letter
queues, such as Lambda or Amazon SNS topics, are currently not supported.
In dead-letter queues redrive context, the
Only one active message movement task is supported per queue at any given time.
|
![]() |
TagQueue(TagQueueRequest) |
Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon SQS Developer Guide. When you use queue tags, keep the following guidelines in mind:
For a full list of tag restrictions, see Quotas related to queues in the Amazon SQS Developer Guide. Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide. |
![]() |
TagQueueAsync(TagQueueRequest, CancellationToken) |
Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon SQS Developer Guide. When you use queue tags, keep the following guidelines in mind:
For a full list of tag restrictions, see Quotas related to queues in the Amazon SQS Developer Guide. Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide. |
![]() |
UntagQueue(UntagQueueRequest) |
Remove cost allocation tags from the specified Amazon SQS queue. For an overview,
see Tagging
Your Amazon SQS Queues in the Amazon SQS Developer Guide.
Cross-account permissions don't apply to this action. For more information, see Grant
cross-account permissions to a role and a username in the Amazon SQS Developer
Guide.
|
![]() |
UntagQueueAsync(UntagQueueRequest, CancellationToken) |
Remove cost allocation tags from the specified Amazon SQS queue. For an overview,
see Tagging
Your Amazon SQS Queues in the Amazon SQS Developer Guide.
Cross-account permissions don't apply to this action. For more information, see Grant
cross-account permissions to a role and a username in the Amazon SQS Developer
Guide.
|
Name | Description | |
---|---|---|
![]() |
AfterResponseEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
![]() |
BeforeRequestEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
![]() |
ExceptionEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
This example shows how to receive a message.
var client = new AmazonSQSClient(); var request = new ReceiveMessageRequest { AttributeNames = new List<string>() { "All" }, MaxNumberOfMessages = 5, QueueUrl = "https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyTestQueue", VisibilityTimeout = (int)TimeSpan.FromMinutes(10).TotalSeconds, WaitTimeSeconds = (int)TimeSpan.FromSeconds(5).TotalSeconds }; var response = client.ReceiveMessage(request); if (response.Messages.Count > 0) { foreach (var message in response.Messages) { Console.WriteLine("For message ID '" + message.MessageId + "':"); Console.WriteLine(" Body: " + message.Body); Console.WriteLine(" Receipt handle: " + message.ReceiptHandle); Console.WriteLine(" MD5 of body: " + message.MD5OfBody); Console.WriteLine(" MD5 of message attributes: " + message.MD5OfMessageAttributes); Console.WriteLine(" Attributes:"); foreach (var attr in message.Attributes) { Console.WriteLine(" " + attr.Key + ": " + attr.Value); } } } else { Console.WriteLine("No messages received."); }
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5