Class: Aws::SQS::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::SQS::Client
- Includes:
- ClientStubs
- Defined in:
- lib/aws-sdk-sqs/client.rb
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#add_permission(params = {}) ⇒ Struct
Adds a permission to a queue for a specific [principal].
-
#change_message_visibility(params = {}) ⇒ Struct
Changes the visibility timeout of a specified message in a queue to a new value.
-
#change_message_visibility_batch(params = {}) ⇒ Types::ChangeMessageVisibilityBatchResult
Changes the visibility timeout of multiple messages.
-
#create_queue(params = {}) ⇒ Types::CreateQueueResult
Creates a new standard or FIFO queue.
-
#delete_message(params = {}) ⇒ Struct
Deletes the specified message from the specified queue.
-
#delete_message_batch(params = {}) ⇒ Types::DeleteMessageBatchResult
Deletes up to ten messages from the specified queue.
-
#delete_queue(params = {}) ⇒ Struct
Deletes the queue specified by the ‘QueueUrl`, regardless of the queue’s contents.
-
#get_queue_attributes(params = {}) ⇒ Types::GetQueueAttributesResult
Gets attributes for the specified queue.
-
#get_queue_url(params = {}) ⇒ Types::GetQueueUrlResult
Returns the URL of an existing Amazon SQS queue.
-
#list_dead_letter_source_queues(params = {}) ⇒ Types::ListDeadLetterSourceQueuesResult
Returns a list of your queues that have the ‘RedrivePolicy` queue attribute configured with a dead-letter queue.
-
#list_queue_tags(params = {}) ⇒ Types::ListQueueTagsResult
List all cost allocation tags added to the specified Amazon SQS queue.
-
#list_queues(params = {}) ⇒ Types::ListQueuesResult
Returns a list of your queues.
-
#purge_queue(params = {}) ⇒ Struct
Deletes the messages in a queue specified by the ‘QueueURL` parameter.
-
#receive_message(params = {}) ⇒ Types::ReceiveMessageResult
Retrieves one or more messages (up to 10), from the specified queue.
-
#remove_permission(params = {}) ⇒ Struct
Revokes any permissions in the queue policy that matches the specified ‘Label` parameter.
-
#send_message(params = {}) ⇒ Types::SendMessageResult
Delivers a message to the specified queue.
-
#send_message_batch(params = {}) ⇒ Types::SendMessageBatchResult
Delivers up to ten messages to the specified queue.
-
#set_queue_attributes(params = {}) ⇒ Struct
Sets the value of one or more queue attributes.
-
#tag_queue(params = {}) ⇒ Struct
Add cost allocation tags to the specified Amazon SQS queue.
-
#untag_queue(params = {}) ⇒ Struct
Remove cost allocation tags from the specified Amazon SQS queue.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
212 213 214 |
# File 'lib/aws-sdk-sqs/client.rb', line 212 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
2129 2130 2131 |
# File 'lib/aws-sdk-sqs/client.rb', line 2129 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
2132 2133 2134 |
# File 'lib/aws-sdk-sqs/client.rb', line 2132 def errors_module Errors end |
Instance Method Details
#add_permission(params = {}) ⇒ Struct
Adds a permission to a queue for a specific [principal]. This allows sharing access to the queue.
When you create a queue, you have full control access rights for the queue. Only you, the owner of the queue, can grant or deny permissions to the queue. For more information about these permissions, see [Allow Developers to Write Messages to a Shared Queue] in the *Amazon Simple Queue Service Developer Guide*.
<note markdown=“1”> ‘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 Custom Policies with the Amazon SQS Access Policy Language] in the *Amazon Simple Queue Service Developer Guide*.
An Amazon SQS policy can have a maximum of 7 actions.
</note>
Some actions take lists of parameters. These lists are specified using the ‘param.n` notation. Values of `n` are integers starting from 1. For example, a parameter list with two elements looks like this:
‘&Attribute.1=first`
‘&Attribute.2=second`
<note markdown=“1”> Cross-account permissions don’t apply to this action. For more information, see see [Grant Cross-Account Permissions to a Role and a User Name] in the *Amazon Simple Queue Service Developer Guide*.
</note>
[1]: docs.aws.amazon.com/general/latest/gr/glos-chap.html#P [2]: docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-writing-an-sqs-policy.html#write-messages-to-shared-queue [3]: docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-creating-custom-policies.html [4]: docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name
314 315 316 317 |
# File 'lib/aws-sdk-sqs/client.rb', line 314 def (params = {}, = {}) req = build_request(:add_permission, params) req.send_request() end |
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 |
# File 'lib/aws-sdk-sqs/client.rb', line 2107 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-sqs' context[:gem_version] = '1.10.0' Seahorse::Client::Request.new(handlers, context) end |
#change_message_visibility(params = {}) ⇒ Struct
Changes the visibility timeout of a specified message in a queue to a new value. The maximum allowed timeout value is 12 hours. For more information, see [Visibility Timeout] in the *Amazon Simple Queue Service Developer Guide*.
For example, you have a message with a visibility timeout of 5 minutes. After 3 minutes, you call ‘ChangeMessageVisibility` with a timeout of 10 minutes. You can continue to call `ChangeMessageVisibility` to extend the visibility timeout to 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.
[1]: docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
390 391 392 393 |
# File 'lib/aws-sdk-sqs/client.rb', line 390 def (params = {}, = {}) req = build_request(:change_message_visibility, params) req.send_request() end |
#change_message_visibility_batch(params = {}) ⇒ Types::ChangeMessageVisibilityBatchResult
Changes the visibility timeout of multiple messages. This is a batch version of ‘ ChangeMessageVisibility.` The result of the action on each message is reported individually in the response. You can send up to 10 ` ChangeMessageVisibility ` requests with each `ChangeMessageVisibilityBatch` action.
Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of ‘200`.
Some actions take lists of parameters. These lists are specified using the ‘param.n` notation. Values of `n` are integers starting from 1. For example, a parameter list with two elements looks like this:
‘&Attribute.1=first`
‘&Attribute.2=second`
455 456 457 458 |
# File 'lib/aws-sdk-sqs/client.rb', line 455 def (params = {}, = {}) req = build_request(:change_message_visibility_batch, params) req.send_request() end |
#create_queue(params = {}) ⇒ Types::CreateQueueResult
Creates a new standard or FIFO queue. You can pass one or more attributes in the request. Keep the following caveats in mind:
-
If you don’t specify the ‘FifoQueue` attribute, Amazon SQS creates a standard queue.
<note markdown=“1”> You can’t change the queue type after you create it and you can’t convert an existing standard queue into a FIFO queue. You must either create a new FIFO queue for your application or delete your existing standard queue and recreate it as a FIFO queue. For more information, see [Moving From a Standard Queue to a FIFO Queue] in the *Amazon Simple Queue Service Developer Guide*.
</note>
-
If you don’t provide a value for an attribute, the queue is created with the default value for the attribute.
-
If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
To successfully create a new queue, you must provide a queue name that adheres to the [limits related to queues] and is unique within the scope of your queues.
To get the queue URL, use the ‘ GetQueueUrl ` action. ` GetQueueUrl ` requires only the `QueueName` parameter. be aware of existing queue names:
-
If you provide the name of an existing queue along with the exact names and values of all the queue’s attributes, ‘CreateQueue` returns the queue URL for the existing queue.
-
If the queue name, attribute names, or attribute values don’t match an existing queue, ‘CreateQueue` returns an error.
Some actions take lists of parameters. These lists are specified using the ‘param.n` notation. Values of `n` are integers starting from 1. For example, a parameter list with two elements looks like this:
‘&Attribute.1=first`
‘&Attribute.2=second`
<note markdown=“1”> Cross-account permissions don’t apply to this action. For more information, see see [Grant Cross-Account Permissions to a Role and a User Name] in the *Amazon Simple Queue Service Developer Guide*.
</note>
[1]: docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-moving [2]: docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-queues.html [3]: docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name
681 682 683 684 |
# File 'lib/aws-sdk-sqs/client.rb', line 681 def create_queue(params = {}, = {}) req = build_request(:create_queue, params) req.send_request() end |
#delete_message(params = {}) ⇒ Struct
Deletes the specified message from the specified queue. To select the message to delete, use the ‘ReceiptHandle` of the message (not the `MessageId` which you receive when you send the message). Amazon SQS can delete a message from a queue even if a visibility timeout setting causes the message to be locked by another consumer. Amazon SQS automatically deletes messages left in a queue longer than the retention period configured for the queue.
<note markdown=“1”> The ‘ReceiptHandle` is associated with a *specific instance* of receiving a message. If you receive a message more than once, the `ReceiptHandle` is different each time you receive a message. When you use the `DeleteMessage` action, you must provide the most recently received `ReceiptHandle` for the message (otherwise, the request succeeds, but the message might not be deleted).
For standard queues, it is possible to receive a message even after
you delete it. This might happen on rare occasions if one of the servers which stores a copy of the message is unavailable when you send the request to delete the message. The copy remains on the server and might be returned to you during a subsequent receive request. You should ensure that your application is idempotent, so that receiving a message more than once does not cause issues.
</note>
732 733 734 735 |
# File 'lib/aws-sdk-sqs/client.rb', line 732 def (params = {}, = {}) req = build_request(:delete_message, params) req.send_request() end |
#delete_message_batch(params = {}) ⇒ Types::DeleteMessageBatchResult
Deletes up to ten messages from the specified queue. This is a batch version of ‘ DeleteMessage.` The result of the action on each message is reported individually in the response.
Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of ‘200`.
Some actions take lists of parameters. These lists are specified using the ‘param.n` notation. Values of `n` are integers starting from 1. For example, a parameter list with two elements looks like this:
‘&Attribute.1=first`
‘&Attribute.2=second`
792 793 794 795 |
# File 'lib/aws-sdk-sqs/client.rb', line 792 def (params = {}, = {}) req = build_request(:delete_message_batch, params) req.send_request() end |
#delete_queue(params = {}) ⇒ Struct
Deletes the queue specified by the ‘QueueUrl`, regardless of the queue’s contents. If the specified queue doesn’t exist, Amazon SQS returns a successful response.
Be careful with the ‘DeleteQueue` action: When you delete a queue, any messages in the queue are no longer available.
When you delete a queue, the deletion process takes up to 60 seconds. Requests you send involving that queue during the 60 seconds might succeed. For example, a ‘ SendMessage ` request might succeed, but after 60 seconds the queue and the message you sent no longer exist.
When you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
<note markdown=“1”> Cross-account permissions don’t apply to this action. For more information, see see [Grant Cross-Account Permissions to a Role and a User Name] in the *Amazon Simple Queue Service Developer Guide*.
</note>
839 840 841 842 |
# File 'lib/aws-sdk-sqs/client.rb', line 839 def delete_queue(params = {}, = {}) req = build_request(:delete_queue, params) req.send_request() end |
#get_queue_attributes(params = {}) ⇒ Types::GetQueueAttributesResult
Gets attributes for the specified queue.
<note markdown=“1”> To determine whether a queue is [FIFO], you can check whether ‘QueueName` ends with the `.fifo` suffix.
</note>
Some actions take lists of parameters. These lists are specified using the ‘param.n` notation. Values of `n` are integers starting from 1. For example, a parameter list with two elements looks like this:
‘&Attribute.1=first`
‘&Attribute.2=second`
[1]: docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
997 998 999 1000 |
# File 'lib/aws-sdk-sqs/client.rb', line 997 def get_queue_attributes(params = {}, = {}) req = build_request(:get_queue_attributes, params) req.send_request() end |
#get_queue_url(params = {}) ⇒ Types::GetQueueUrlResult
Returns the URL of an existing Amazon SQS queue.
To access a queue that belongs to another AWS account, use the ‘QueueOwnerAWSAccountId` parameter to specify the account ID of the queue’s owner. The queue’s owner must grant you permission to access the queue. For more information about shared queue access, see ‘ AddPermission ` or see [Allow Developers to Write Messages to a Shared Queue] in the *Amazon Simple Queue Service Developer Guide*.
1044 1045 1046 1047 |
# File 'lib/aws-sdk-sqs/client.rb', line 1044 def get_queue_url(params = {}, = {}) req = build_request(:get_queue_url, params) req.send_request() end |
#list_dead_letter_source_queues(params = {}) ⇒ Types::ListDeadLetterSourceQueuesResult
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 Simple Queue Service Developer Guide*.
[1]: docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
1084 1085 1086 1087 |
# File 'lib/aws-sdk-sqs/client.rb', line 1084 def list_dead_letter_source_queues(params = {}, = {}) req = build_request(:list_dead_letter_source_queues, params) req.send_request() end |
#list_queue_tags(params = {}) ⇒ Types::ListQueueTagsResult
List all cost allocation tags added to the specified Amazon SQS queue. For an overview, see [Tagging Your Amazon SQS Queues] in the *Amazon Simple Queue Service Developer Guide*.
When you use queue tags, keep the following guidelines in mind:
-
Adding more than 50 tags to a queue isn’t recommended.
-
Tags don’t have any semantic meaning. Amazon SQS interprets tags as character strings.
-
Tags are case-sensitive.
-
A new tag with a key identical to that of an existing tag overwrites the existing tag.
-
Tagging actions are limited to 5 TPS per AWS account. If your application requires a higher throughput, file a [technical support request].
For a full list of tag restrictions, see [Limits Related to Queues] in the *Amazon Simple Queue Service Developer Guide*.
<note markdown=“1”> Cross-account permissions don’t apply to this action. For more information, see see [Grant Cross-Account Permissions to a Role and a User Name] in the *Amazon Simple Queue Service Developer Guide*.
</note>
[1]: docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html [2]: console.aws.amazon.com/support/home#/case/create?issueType=technical [3]: docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-limits.html#limits-queues [4]: docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name
1147 1148 1149 1150 |
# File 'lib/aws-sdk-sqs/client.rb', line 1147 def (params = {}, = {}) req = build_request(:list_queue_tags, params) req.send_request() end |
#list_queues(params = {}) ⇒ Types::ListQueuesResult
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.
<note markdown=“1”> Cross-account permissions don’t apply to this action. For more information, see see [Grant Cross-Account Permissions to a Role and a User Name] in the *Amazon Simple Queue Service Developer Guide*.
</note>
1192 1193 1194 1195 |
# File 'lib/aws-sdk-sqs/client.rb', line 1192 def list_queues(params = {}, = {}) req = build_request(:list_queues, params) req.send_request() end |
#purge_queue(params = {}) ⇒ Struct
Deletes the messages in a queue specified by the ‘QueueURL` parameter.
When you use the ‘PurgeQueue` action, you can’t retrieve any messages deleted from a queue.
The message deletion process takes up to 60 seconds. We recommend
waiting for 60 seconds regardless of your queue’s size.
Messages sent to the queue before you call ‘PurgeQueue` might be received but are deleted within the next minute.
Messages sent to the queue after you call ‘PurgeQueue` might be deleted while the queue is being purged.
1229 1230 1231 1232 |
# File 'lib/aws-sdk-sqs/client.rb', line 1229 def purge_queue(params = {}, = {}) req = build_request(:purge_queue, params) req.send_request() end |
#receive_message(params = {}) ⇒ Types::ReceiveMessageResult
Retrieves one or more messages (up to 10), from the specified queue. Using the ‘WaitTimeSeconds` parameter enables long-poll support. For more information, see [Amazon SQS Long Polling] in the *Amazon Simple Queue Service Developer Guide*.
Short poll is the default behavior where a weighted random set of machines is sampled on a ‘ReceiveMessage` call. Thus, only the messages on the sampled machines are returned. If the number of messages in the queue is small (fewer than 1,000), you most likely get fewer messages than you requested per `ReceiveMessage` call. If the number of messages in the queue is extremely small, you might not receive any messages in a particular `ReceiveMessage` response. If this happens, repeat the request.
For each message returned, the response includes the following:
-
The message body.
-
An MD5 digest of the message body. For information about MD5, see [RFC1321].
-
The ‘MessageId` you received when you sent the message to the queue.
-
The receipt handle.
-
The message attributes.
-
An MD5 digest of the message attributes.
The receipt handle is the identifier you must provide when deleting the message. For more information, see [Queue and Message Identifiers] in the *Amazon Simple Queue Service Developer Guide*.
You can provide the ‘VisibilityTimeout` parameter in your request. The parameter is applied to the messages that Amazon SQS returns in the response. If you don’t include the parameter, the overall visibility timeout for the queue is used for the returned messages. For more information, see [Visibility Timeout] in the *Amazon Simple Queue Service Developer Guide*.
A message that isn’t deleted or a message whose visibility isn’t extended before the visibility timeout expires counts as a failed receive. Depending on the configuration of the queue, the message might be sent to the dead-letter queue.
<note markdown=“1”> 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.
</note>
[1]: docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-long-polling.html [2]: www.ietf.org/rfc/rfc1321.txt [3]: docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-message-identifiers.html [4]: docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
1476 1477 1478 1479 |
# File 'lib/aws-sdk-sqs/client.rb', line 1476 def (params = {}, = {}) req = build_request(:receive_message, params) req.send_request() end |
#remove_permission(params = {}) ⇒ Struct
Revokes any permissions in the queue policy that matches the specified ‘Label` parameter.
<note markdown=“1”> Only the owner of a queue can remove permissions from it.
Cross-account permissions don't apply to this action. For more
information, see see [Grant Cross-Account Permissions to a Role and a User Name] in the *Amazon Simple Queue Service Developer Guide*.
</note>
1518 1519 1520 1521 |
# File 'lib/aws-sdk-sqs/client.rb', line 1518 def (params = {}, = {}) req = build_request(:remove_permission, params) req.send_request() end |
#send_message(params = {}) ⇒ Types::SendMessageResult
Delivers a message to the specified queue.
A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
`#x9` \| `#xA` \| `#xD` \| `#x20` to `#xD7FF` \| `#xE000` to `#xFFFD`
| ‘#x10000` to `#x10FFFF`
Any characters not included in this list will be rejected. For more
information, see the [W3C specification for characters].
1713 1714 1715 1716 |
# File 'lib/aws-sdk-sqs/client.rb', line 1713 def (params = {}, = {}) req = build_request(:send_message, params) req.send_request() end |
#send_message_batch(params = {}) ⇒ Types::SendMessageBatchResult
Delivers up to ten messages to the specified queue. This is a batch version of ‘ SendMessage.` For a FIFO queue, multiple messages within a single batch are enqueued in the order they are sent.
The result of sending each message is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of ‘200`.
The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 bytes).
A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
`#x9` \| `#xA` \| `#xD` \| `#x20` to `#xD7FF` \| `#xE000` to `#xFFFD`
| ‘#x10000` to `#x10FFFF`
Any characters not included in this list will be rejected. For more
information, see the [W3C specification for characters].
If you don’t specify the ‘DelaySeconds` parameter for an entry, Amazon SQS uses the default value for the queue.
Some actions take lists of parameters. These lists are specified using the ‘param.n` notation. Values of `n` are integers starting from 1. For example, a parameter list with two elements looks like this:
‘&Attribute.1=first`
‘&Attribute.2=second`
1810 1811 1812 1813 |
# File 'lib/aws-sdk-sqs/client.rb', line 1810 def (params = {}, = {}) req = build_request(:send_message_batch, params) req.send_request() end |
#set_queue_attributes(params = {}) ⇒ Struct
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.
<note markdown=“1”> 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 see [Grant Cross-Account Permissions to a Role and a User Name] in the *Amazon Simple Queue Service Developer Guide*.
</note>
1976 1977 1978 1979 |
# File 'lib/aws-sdk-sqs/client.rb', line 1976 def set_queue_attributes(params = {}, = {}) req = build_request(:set_queue_attributes, params) req.send_request() end |
#tag_queue(params = {}) ⇒ Struct
Add cost allocation tags to the specified Amazon SQS queue. For an overview, see [Tagging Your Amazon SQS Queues] in the *Amazon Simple Queue Service Developer Guide*.
When you use queue tags, keep the following guidelines in mind:
-
Adding more than 50 tags to a queue isn’t recommended.
-
Tags don’t have any semantic meaning. Amazon SQS interprets tags as character strings.
-
Tags are case-sensitive.
-
A new tag with a key identical to that of an existing tag overwrites the existing tag.
-
Tagging actions are limited to 5 TPS per AWS account. If your application requires a higher throughput, file a [technical support request].
For a full list of tag restrictions, see [Limits Related to Queues] in the *Amazon Simple Queue Service Developer Guide*.
<note markdown=“1”> Cross-account permissions don’t apply to this action. For more information, see see [Grant Cross-Account Permissions to a Role and a User Name] in the *Amazon Simple Queue Service Developer Guide*.
</note>
[1]: docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html [2]: console.aws.amazon.com/support/home#/case/create?issueType=technical [3]: docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-limits.html#limits-queues [4]: docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name
2038 2039 2040 2041 |
# File 'lib/aws-sdk-sqs/client.rb', line 2038 def tag_queue(params = {}, = {}) req = build_request(:tag_queue, params) req.send_request() end |
#untag_queue(params = {}) ⇒ Struct
Remove cost allocation tags from the specified Amazon SQS queue. For an overview, see [Tagging Your Amazon SQS Queues] in the *Amazon Simple Queue Service Developer Guide*.
When you use queue tags, keep the following guidelines in mind:
-
Adding more than 50 tags to a queue isn’t recommended.
-
Tags don’t have any semantic meaning. Amazon SQS interprets tags as character strings.
-
Tags are case-sensitive.
-
A new tag with a key identical to that of an existing tag overwrites the existing tag.
-
Tagging actions are limited to 5 TPS per AWS account. If your application requires a higher throughput, file a [technical support request].
For a full list of tag restrictions, see [Limits Related to Queues] in the *Amazon Simple Queue Service Developer Guide*.
<note markdown=“1”> Cross-account permissions don’t apply to this action. For more information, see see [Grant Cross-Account Permissions to a Role and a User Name] in the *Amazon Simple Queue Service Developer Guide*.
</note>
[1]: docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html [2]: console.aws.amazon.com/support/home#/case/create?issueType=technical [3]: docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-limits.html#limits-queues [4]: docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name
2098 2099 2100 2101 |
# File 'lib/aws-sdk-sqs/client.rb', line 2098 def untag_queue(params = {}, = {}) req = build_request(:untag_queue, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
2122 2123 2124 |
# File 'lib/aws-sdk-sqs/client.rb', line 2122 def waiter_names [] end |