{ "api_version": "2012-11-05", "type": "query", "result_wrapped": true, "signature_version": "v4", "service_full_name": "Amazon Simple Queue Service", "service_abbreviation": "Amazon SQS", "endpoint_prefix": "sqs", "xmlnamespace": "http://queue.amazonaws.com/doc/2012-11-05/", "documentation": " \n
Welcome to the Amazon Simple Queue Service API Reference. This section\n describes who should read this guide, how the guide is organized, and other resources related to the\n Amazon Simple Queue Service (Amazon SQS).
\nAmazon SQS offers reliable and scalable hosted queues for storing messages as they travel\n between computers. By using Amazon SQS, you can move data between distributed components of\n your applications that perform different tasks without losing messages or requiring each\n component to be always available.
\nHelpful Links:\n
We also provide SDKs that enable you to access Amazon SQS from your preferred programming language. \n The SDKs contain functionality that automatically takes care of tasks such as:
\n\n
For a list of available SDKs, go to Tools for Amazon Web Services.
\n ", "operations": { "AddPermission": { "name": "AddPermission", "input": { "shape_name": "AddPermissionRequest", "type": "structure", "members": { "QueueUrl": { "shape_name": "String", "type": "string", "documentation": "\nThe URL of the Amazon SQS queue to take action on.
\n ", "required": true, "no_paramfile": true }, "Label": { "shape_name": "String", "type": "string", "documentation": "\nThe unique identification of the permission you're setting (e.g.,\n AliceSendMessage
). Constraints: Maximum 80 characters;\n alphanumeric characters, hyphens (-), and underscores (_) are allowed.
The AWS account number of the principal\n who will be given permission. The principal must have an AWS account, but does\n not need to be signed up for Amazon SQS. For information about locating the AWS\n account identification, see Your\n AWS Identifiers in the Amazon SQS Developer Guide.
\n ", "required": true }, "Actions": { "shape_name": "ActionNameList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "ActionName" }, "flattened": true, "documentation": "\nThe action the client wants to allow for the specified principal. \n The following are valid values: * | SendMessage | ReceiveMessage | DeleteMessage | ChangeMessageVisibility | GetQueueAttributes | GetQueueUrl
. \n For more information about these actions, see Understanding\n Permissions in the Amazon SQS Developer Guide.
Specifying SendMessage
,\n DeleteMessage
, or ChangeMessageVisibility
for the \n ActionName.n
also grants\n permissions for the corresponding batch versions of those actions:\n SendMessageBatch
,\n DeleteMessageBatch
, and ChangeMessageVisibilityBatch
.
The action that you requested would violate a limit. For example,\n ReceiveMessage returns this error if the maximum number of messages\n inflight has already been reached. AddPermission returns this error if\n the maximum number of permissions for the queue has already been reached.\n
\n " } ], "documentation": "\nAdds a permission to a queue for a specific \n principal.\n This allows for sharing access to the queue.
\n\nWhen you create a queue, you have full control access rights for the queue.\n Only you (as owner of the queue) can grant or deny permissions to the queue.\n For more information about these permissions, see\n Shared\n Queues in the Amazon SQS Developer Guide.
\n\nAddPermission
writes an Amazon SQS-generated policy. If you want to\n write your own policy, use SetQueueAttributes to upload your policy. For more\n information about writing your own policy, see\n Using\n The Access Policy Language in the Amazon SQS Developer Guide.
param.n
notation. Values\n of n
are integers starting from 1. For example, a parameter list with two elements looks like this: \n &Attribute.1=this
&Attribute.2=that
The URL of the Amazon SQS queue to take action on.
\n ", "required": true, "no_paramfile": true }, "ReceiptHandle": { "shape_name": "String", "type": "string", "documentation": "\nThe receipt handle associated with the message whose visibility timeout\n should be changed. This parameter is returned by the ReceiveMessage action.
\n ", "required": true }, "VisibilityTimeout": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe new value (in seconds - from 0 to 43200 - maximum 12 hours) for the message's visibility timeout.
\n ", "required": true } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "MessageNotInflight", "type": "structure", "members": {}, "documentation": "\nThe message referred to is not in flight.
\n " }, { "shape_name": "ReceiptHandleIsInvalid", "type": "structure", "members": {}, "documentation": "\nThe receipt handle provided is not valid.
\n " } ], "documentation": "\nChanges the visibility\n timeout of a specified message in a queue to a new value. The maximum allowed\n timeout value you can set the value to is 12 hours. This means you can't extend\n the timeout of a message in an existing queue to more than a total visibility\n timeout of 12 hours. (For more information visibility timeout, see Visibility\n Timeout in the Amazon SQS Developer Guide.)
\n\nFor example, let's say you have a message and its default message visibility\n timeout is 30 minutes. You could call ChangeMessageVisiblity
with\n a value of two hours and the effective timeout would be two hours and 30\n minutes. When that time comes near you could again extend the time out by\n calling ChangeMessageVisiblity, but this time the maximum allowed timeout would\n be 9 hours and 30 minutes.
There is a 120,000 limit for the number of inflight messages per queue. Messages are inflight after they have been received from the queue by a consuming component, but have not yet been deleted from the queue. If you reach the 120,000 limit, you will receive an OverLimit error message from Amazon SQS. To help avoid reaching the limit, you should \n delete the messages from the queue after they have been processed. You can also increase the number of queues you use to process the messages.\n
VisibilityTimeout
to an\n amount more than the maximum time left, Amazon SQS returns an error. It will\n not automatically recalculate and increase the timeout to the maximum time\n remaining.ChangeMessageVisibility
action.The URL of the Amazon SQS queue to take action on.
\n ", "required": true, "no_paramfile": true }, "Entries": { "shape_name": "ChangeMessageVisibilityBatchRequestEntryList", "type": "list", "members": { "shape_name": "ChangeMessageVisibilityBatchRequestEntry", "type": "structure", "members": { "Id": { "shape_name": "String", "type": "string", "documentation": "\nAn identifier for this particular receipt handle. This is used to communicate\n the result. Note that the Id
s of a batch request need to be\n unique within the request.
A receipt handle.
\n ", "required": true }, "VisibilityTimeout": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe new value (in seconds) for the message's visibility timeout.
\n " } }, "documentation": "\nEncloses a receipt handle and an entry id for each message in\n ChangeMessageVisibilityBatch.
\n \nAll of the following parameters are list parameters that must be prefixed with ChangeMessageVisibilityBatchRequestEntry.n
, \n where n
is an integer value starting with 1. For example, a parameter list for this action might look like this:
&ChangeMessageVisibilityBatchRequestEntry.1.Id=change_visibility_msg_2
&ChangeMessageVisibilityBatchRequestEntry.1.ReceiptHandle=
&ChangeMessageVisibilityBatchRequestEntry.1.VisibilityTimeout=45
A list of receipt handles of the messages for which the visibility timeout\n must be changed.
\n ", "required": true } }, "documentation": "\n \n " }, "output": { "shape_name": "ChangeMessageVisibilityBatchResult", "type": "structure", "members": { "Successful": { "shape_name": "ChangeMessageVisibilityBatchResultEntryList", "type": "list", "members": { "shape_name": "ChangeMessageVisibilityBatchResultEntry", "type": "structure", "members": { "Id": { "shape_name": "String", "type": "string", "documentation": "\nRepresents a message whose visibility timeout has been changed\n successfully.
\n ", "required": true } }, "documentation": "\nEncloses the id of an entry in ChangeMessageVisibilityBatch.
\n ", "xmlname": "ChangeMessageVisibilityBatchResultEntry" }, "flattened": true, "documentation": "\nA list of ChangeMessageVisibilityBatchResultEntry items.
\n ", "required": true }, "Failed": { "shape_name": "BatchResultErrorEntryList", "type": "list", "members": { "shape_name": "BatchResultErrorEntry", "type": "structure", "members": { "Id": { "shape_name": "String", "type": "string", "documentation": "\nThe id of an entry in a batch request.
\n ", "required": true }, "SenderFault": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the error happened due to the sender's fault.
\n ", "required": true }, "Code": { "shape_name": "String", "type": "string", "documentation": "\nAn error code representing why the action failed on this entry.
\n ", "required": true }, "Message": { "shape_name": "String", "type": "string", "documentation": "\nA message explaining why the action failed on this entry.
\n " } }, "documentation": "\nThis is used in the responses of batch API to give a detailed description\n of the result of an action on each entry in the request.
\n ", "xmlname": "BatchResultErrorEntry" }, "flattened": true, "documentation": "\nA list of BatchResultErrorEntry items.
\n ", "required": true } }, "documentation": "\n\n For each message in the batch, the response contains a \n ChangeMessageVisibilityBatchResultEntry tag if the message succeeds or \n a BatchResultErrorEntry tag if the message fails.\n
\n " }, "errors": [ { "shape_name": "TooManyEntriesInBatchRequest", "type": "structure", "members": {}, "documentation": "\nBatch request contains more number of entries than permissible.
\n " }, { "shape_name": "EmptyBatchRequest", "type": "structure", "members": {}, "documentation": "\nBatch request does not contain an entry.
\n " }, { "shape_name": "BatchEntryIdsNotDistinct", "type": "structure", "members": {}, "documentation": "\nTwo or more batch entries have the same Id
in the request.
The Id
of a batch entry in a batch request does not abide\n by the specification.
Changes the visibility timeout of multiple messages.\n This is a batch version of ChangeMessageVisibility. The\n result of the action on each message is reported individually in the\n response. You can send up to 10 ChangeMessageVisibility requests with each ChangeMessageVisibilityBatch
action.
param.n
notation. Values\n of n
are integers starting from 1. For example, a parameter list with two elements looks like this: \n &Attribute.1=this
&Attribute.2=that
ChangeMessageVisibilityBatch
request changes the visibility timeout settings for two messages. \n You must URL encode the entire URL; however, we've URL encoded\n only the message body to make the example easier for you to read.\n The name for the queue to be created.
\n ", "required": true }, "Attributes": { "shape_name": "AttributeMap", "type": "map", "keys": { "shape_name": "QueueAttributeName", "type": "string", "enum": [ "Policy", "VisibilityTimeout", "MaximumMessageSize", "MessageRetentionPeriod", "ApproximateNumberOfMessages", "ApproximateNumberOfMessagesNotVisible", "CreatedTimestamp", "LastModifiedTimestamp", "QueueArn", "ApproximateNumberOfMessagesDelayed", "DelaySeconds", "ReceiveMessageWaitTimeSeconds", "RedrivePolicy" ], "documentation": "\nThe name of a queue attribute.
\n ", "xmlname": "Name" }, "members": { "shape_name": "String", "type": "string", "documentation": "\nThe value of a queue attribute.
\n ", "xmlname": "Value" }, "flattened": true, "xmlname": "Attribute", "documentation": "\nA map of attributes with their corresponding values.
\nThe following lists the names, descriptions, and values of the special request parameters the CreateQueue
\n action uses:
\n
DelaySeconds
- The time in seconds that the delivery of all messages in the queue will be delayed. An integer from 0 to 900 (15 minutes). The default for this attribute is 0 (zero).MaximumMessageSize
- The limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1024 bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this attribute is 262144 (256 KiB).MessageRetentionPeriod
- The number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). The default for this attribute is 345600 (4 days).Policy
- The queue's policy. A valid\n form-url-encoded policy. For more information about policy\n structure, see Basic Policy Structure in the Amazon SQS Developer Guide. \n For more information about form-url-encoding, see \n http://www.w3.org/MarkUp/html-spec/html-spec_8.html#SEC8.2.1.ReceiveMessageWaitTimeSeconds
- The time for which a ReceiveMessage call will wait for a message to arrive. An integer from 0 to 20 (seconds). The default for this attribute is 0. VisibilityTimeout
- The visibility timeout for the queue. An integer from 0 to 43200 (12 hours). The default for this attribute is 30. For more information about visibility timeout,\n see Visibility Timeout in the Amazon SQS Developer Guide.The URL for the created Amazon SQS queue.
\n " } }, "documentation": "\nReturns the QueueUrl element of the created queue.
\n " }, "errors": [ { "shape_name": "QueueDeletedRecently", "type": "structure", "members": {}, "documentation": "\nYou must wait 60 seconds after deleting a queue before you can create another\n with the same name.
\n " }, { "shape_name": "QueueNameExists", "type": "structure", "members": {}, "documentation": "\nA queue already exists with this name. Amazon SQS returns this error only if the request includes\n attributes whose values differ from those of the existing queue.
\n " } ], "documentation": "\nCreates a new queue, or returns the URL\n of an existing one. When you request CreateQueue
, you provide a\n name for the queue. To successfully create a new queue, you must provide a name\n that is unique within the scope of your own queues.
If you delete a queue, you must wait at least 60 seconds before creating a queue with the\n same name.
\nYou may pass one or more attributes in the request. If you do not\n provide a value for any attribute, the queue will have the default value\n for that attribute. Permitted attributes are the same that can be set\n using SetQueueAttributes.
\n \nUse GetQueueUrl to get a queue's URL.\n GetQueueUrl requires only the QueueName
parameter.
If you provide the name of an existing queue, along with the exact names and values of all the queue's attributes,\n CreateQueue
returns the queue URL for the existing queue. If the queue name, attribute names, \n or attribute values do not match an existing queue, CreateQueue
returns an error.
param.n
notation. Values\n of n
are integers starting from 1. For example, a parameter list with two elements looks like this: \n &Attribute.1=this
&Attribute.2=that
testQueue
.The URL of the Amazon SQS queue to take action on.
\n ", "required": true, "no_paramfile": true }, "ReceiptHandle": { "shape_name": "String", "type": "string", "documentation": "\nThe receipt handle associated with the message to delete.
\n ", "required": true } }, "documentation": "\n \n " }, "output": null, "errors": [ { "shape_name": "InvalidIdFormat", "type": "structure", "members": {}, "documentation": "\nThe receipt handle is not valid for the current version.
\n " }, { "shape_name": "ReceiptHandleIsInvalid", "type": "structure", "members": {}, "documentation": "\nThe receipt handle provided is not valid.
\n " } ], "documentation": "\n \n Deletes the specified message from the specified\n queue. You specify the message by using the message's receipt\n handle
and not the message ID
you received when you\n sent the message. Even if the message is locked by another reader due to the visibility\n timeout setting, it is still deleted from the queue. If you leave a message in the queue\n for longer than the queue's configured retention period, Amazon SQS automatically deletes\n it. \n
\n The receipt handle is associated with a specific instance of receiving the message. If\n you receive a message more than once, the receipt handle you get each time you receive the\n message is different. When you request DeleteMessage
, if you don't\n provide the most recently received receipt handle for the message, the request will still\n succeed, but the message might not be deleted.\n
\n It is possible you will receive a message even after you have deleted it. This might\n happen on rare occasions if one of the servers storing a copy of the message is unavailable\n when you request to delete the message. The copy remains on the server and might be returned\n to you again on a subsequent receive request. You should create your system to be idempotent\n so that receiving a particular message more than once is not a problem.\n
\ntestQueue
.The URL of the Amazon SQS queue to take action on.
\n ", "required": true, "no_paramfile": true }, "Entries": { "shape_name": "DeleteMessageBatchRequestEntryList", "type": "list", "members": { "shape_name": "DeleteMessageBatchRequestEntry", "type": "structure", "members": { "Id": { "shape_name": "String", "type": "string", "documentation": "\nAn identifier for this particular receipt handle. This is used to\n communicate the result. Note that the Id
s of a batch request\n need to be unique within the request.
A receipt handle.
\n ", "required": true } }, "documentation": "\nEncloses a receipt handle and an identifier for it.
\n ", "xmlname": "DeleteMessageBatchRequestEntry" }, "flattened": true, "documentation": "\nA list of receipt handles for the messages to be deleted.
\n ", "required": true } }, "documentation": "\n \n " }, "output": { "shape_name": "DeleteMessageBatchResult", "type": "structure", "members": { "Successful": { "shape_name": "DeleteMessageBatchResultEntryList", "type": "list", "members": { "shape_name": "DeleteMessageBatchResultEntry", "type": "structure", "members": { "Id": { "shape_name": "String", "type": "string", "documentation": "\nRepresents a successfully deleted message.
\n ", "required": true } }, "documentation": "\nEncloses the id an entry in DeleteMessageBatch.
\n ", "xmlname": "DeleteMessageBatchResultEntry" }, "flattened": true, "documentation": "\nA list of DeleteMessageBatchResultEntry items.
\n ", "required": true }, "Failed": { "shape_name": "BatchResultErrorEntryList", "type": "list", "members": { "shape_name": "BatchResultErrorEntry", "type": "structure", "members": { "Id": { "shape_name": "String", "type": "string", "documentation": "\nThe id of an entry in a batch request.
\n ", "required": true }, "SenderFault": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the error happened due to the sender's fault.
\n ", "required": true }, "Code": { "shape_name": "String", "type": "string", "documentation": "\nAn error code representing why the action failed on this entry.
\n ", "required": true }, "Message": { "shape_name": "String", "type": "string", "documentation": "\nA message explaining why the action failed on this entry.
\n " } }, "documentation": "\nThis is used in the responses of batch API to give a detailed description\n of the result of an action on each entry in the request.
\n ", "xmlname": "BatchResultErrorEntry" }, "flattened": true, "documentation": "\nA list of BatchResultErrorEntry items.
\n ", "required": true } }, "documentation": "\n\n For each message in the batch, the response contains a \n DeleteMessageBatchResultEntry tag if the message is deleted or \n a BatchResultErrorEntry tag if the message cannot be deleted.\n
\n " }, "errors": [ { "shape_name": "TooManyEntriesInBatchRequest", "type": "structure", "members": {}, "documentation": "\nBatch request contains more number of entries than permissible.
\n " }, { "shape_name": "EmptyBatchRequest", "type": "structure", "members": {}, "documentation": "\nBatch request does not contain an entry.
\n " }, { "shape_name": "BatchEntryIdsNotDistinct", "type": "structure", "members": {}, "documentation": "\nTwo or more batch entries have the same Id
in the request.
The Id
of a batch entry in a batch request does not abide\n by the specification.
Deletes multiple messages.\n This is a batch version of DeleteMessage. The result of the delete\n action on each message is reported individually in the response.
\n\n Because the batch request can result in a combination of successful and unsuccessful actions, \n you should check for batch errors even when the call returns an HTTP status code of 200.\n
\nparam.n
notation. Values\n of n
are integers starting from 1. For example, a parameter list with two elements looks like this: \n &Attribute.1=this
&Attribute.2=that
DeleteMessageBatch
request deletes two messages. You must URL encode the entire URL; however, we've URL encoded\n only the message body to make the example easier for you to read.\n The URL of the Amazon SQS queue to take action on.
\n ", "required": true, "no_paramfile": true } }, "documentation": "\n \n " }, "output": null, "errors": [], "documentation": "\n\n Deletes the queue specified by the queue\n URL, regardless of whether the queue is empty. If the specified queue does not\n exist, Amazon SQS returns a successful response.\n
\n\n Use DeleteQueue
with care; once you delete your queue, any messages\n in the queue are no longer available.\n
\n When you delete a queue, the deletion process takes up to 60 seconds. Requests you send\n involving that queue during the 60 seconds might succeed. For example, a\n SendMessage request might succeed, but after the 60 seconds, the queue and\n that message you sent no longer exist. Also, when you delete a queue, you must wait at least 60\n seconds before creating a queue with the same name.\n
\n\n We reserve the right to delete queues that have had no activity for more than 30 days. For more\n information, see \n How\n Amazon SQS Queues Work in the Amazon SQS Developer Guide.\n
\nThe URL of the Amazon SQS queue to take action on.
\n ", "required": true, "no_paramfile": true }, "AttributeNames": { "shape_name": "AttributeNameList", "type": "list", "members": { "shape_name": "QueueAttributeName", "type": "string", "enum": [ "Policy", "VisibilityTimeout", "MaximumMessageSize", "MessageRetentionPeriod", "ApproximateNumberOfMessages", "ApproximateNumberOfMessagesNotVisible", "CreatedTimestamp", "LastModifiedTimestamp", "QueueArn", "ApproximateNumberOfMessagesDelayed", "DelaySeconds", "ReceiveMessageWaitTimeSeconds", "RedrivePolicy" ], "documentation": null, "xmlname": "AttributeName" }, "flattened": true, "documentation": "\nA list of attributes to retrieve information for.
\n " } }, "documentation": "\n \n " }, "output": { "shape_name": "GetQueueAttributesResult", "type": "structure", "members": { "Attributes": { "shape_name": "AttributeMap", "type": "map", "keys": { "shape_name": "QueueAttributeName", "type": "string", "enum": [ "Policy", "VisibilityTimeout", "MaximumMessageSize", "MessageRetentionPeriod", "ApproximateNumberOfMessages", "ApproximateNumberOfMessagesNotVisible", "CreatedTimestamp", "LastModifiedTimestamp", "QueueArn", "ApproximateNumberOfMessagesDelayed", "DelaySeconds", "ReceiveMessageWaitTimeSeconds", "RedrivePolicy" ], "documentation": "\nThe name of a queue attribute.
\n ", "xmlname": "Name" }, "members": { "shape_name": "String", "type": "string", "documentation": "\nThe value of a queue attribute.
\n ", "xmlname": "Value" }, "flattened": true, "xmlname": "Attribute", "documentation": "\nA map of attributes to the respective values.
\n " } }, "documentation": "\n A list of returned queue attributes.\n " }, "errors": [ { "shape_name": "InvalidAttributeName", "type": "structure", "members": {}, "documentation": "\nThe attribute referred to does not exist.
\n " } ], "documentation": "\nGets attributes for the specified queue. The following attributes are supported:\n
All
- returns all values.ApproximateNumberOfMessages
- returns the approximate\n number of visible messages in a queue. For more information, see\n Resources Required to Process Messages\n in the Amazon SQS Developer Guide.ApproximateNumberOfMessagesNotVisible
- returns the\n approximate number of messages that are not timed-out and not deleted. \n For more information, see \n Resources Required to Process Messages in the\n Amazon SQS Developer Guide.VisibilityTimeout
- returns the visibility timeout for\n the queue. For more information about visibility timeout, see\n Visibility Timeout in the Amazon SQS Developer Guide.CreatedTimestamp
- returns the time when the queue was\n created (epoch time in seconds).LastModifiedTimestamp
- returns the time when the queue\n was last changed (epoch time in seconds).Policy
- returns the queue's policy.MaximumMessageSize
- returns the limit of how many bytes\n a message can contain before Amazon SQS rejects it.MessageRetentionPeriod
- returns the number of seconds\n Amazon SQS retains a message.QueueArn
- returns the queue's Amazon resource name\n (ARN).ApproximateNumberOfMessagesDelayed
- returns the\n approximate number of messages that are pending to be added to the\n queue.DelaySeconds
- returns the default delay on the queue\n in seconds.ReceiveMessageWaitTimeSeconds
- returns the time for which a\n ReceiveMessage call will wait for a message to arrive.RedrivePolicy
- returns the parameters for dead letter queue functionality of the source queue. \n For more information about RedrivePolicy and dead letter queues, see\n Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide.param.n
notation. Values\n of n
are integers starting from 1. For example, a parameter list with two elements looks like this: \n &Attribute.1=this
&Attribute.2=that
The name of the queue whose URL must be fetched. \n Maximum 80 characters; alphanumeric characters, hyphens (-), and underscores (_) are allowed.
\n ", "required": true }, "QueueOwnerAWSAccountId": { "shape_name": "String", "type": "string", "documentation": "\nThe AWS account ID of the account that created the queue.
\n " } }, "documentation": "\n \n " }, "output": { "shape_name": "GetQueueUrlResult", "type": "structure", "members": { "QueueUrl": { "shape_name": "String", "type": "string", "documentation": "\nThe URL for the queue.
\n " } }, "documentation": "\nFor more information, see \n Responses\n in the Amazon SQS Developer Guide.
\n " }, "errors": [ { "shape_name": "QueueDoesNotExist", "type": "structure", "members": {}, "documentation": "\nThe queue referred to does not exist.
\n " } ], "documentation": "\n\n Returns the URL of an existing queue. \n This action provides a simple way to retrieve the URL of an Amazon SQS queue.\n
\n\n To access a queue that belongs to another AWS account, use the QueueOwnerAWSAccountId
\n parameter to specify the account ID of the queue's owner. The queue's owner must grant you permission to \n access the queue. For more information about shared queue access, see AddPermission or go to\n Shared Queues\n in the Amazon SQS Developer Guide.\n
The queue referred to does not exist.
\n " } ], "documentation": "\nReturns a list of your queues that have the RedrivePolicy queue attribute configured with a dead letter queue.
\n \nMySourceQueue
, was configured \n with a dead letter queue.For more information about using dead letter queues, see Using Amazon SQS Dead Letter Queues.
\n " }, "ListQueues": { "name": "ListQueues", "input": { "shape_name": "ListQueuesRequest", "type": "structure", "members": { "QueueNamePrefix": { "shape_name": "String", "type": "string", "documentation": "\nA string to use for filtering the list results. Only those queues whose name\n begins with the specified string are returned.
\n " } }, "documentation": "\n \n " }, "output": { "shape_name": "ListQueuesResult", "type": "structure", "members": { "QueueUrls": { "shape_name": "QueueUrlList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "QueueUrl" }, "flattened": true, "documentation": "\nA list of queue URLs, up to 1000 entries.
\n " } }, "documentation": "\n A list of your queues.\n " }, "errors": [], "documentation": "\nReturns a list of your queues. The maximum number of\n queues that can be returned is 1000. If you specify a value for the optional\n QueueNamePrefix
parameter, only queues with a name beginning with the\n specified value are returned.
The URL of the Amazon SQS queue to take action on.
\n ", "required": true, "no_paramfile": true }, "AttributeNames": { "shape_name": "AttributeNameList", "type": "list", "members": { "shape_name": "QueueAttributeName", "type": "string", "enum": [ "Policy", "VisibilityTimeout", "MaximumMessageSize", "MessageRetentionPeriod", "ApproximateNumberOfMessages", "ApproximateNumberOfMessagesNotVisible", "CreatedTimestamp", "LastModifiedTimestamp", "QueueArn", "ApproximateNumberOfMessagesDelayed", "DelaySeconds", "ReceiveMessageWaitTimeSeconds", "RedrivePolicy" ], "documentation": null, "xmlname": "AttributeName" }, "flattened": true, "documentation": "\nA list of attributes that need to be returned along with each message. \n
\n\n The following lists the names and descriptions of the attributes that can be returned:\n
\nAll
- returns all values.ApproximateFirstReceiveTimestamp
- returns\n the time when the message was first received (epoch time in milliseconds).ApproximateReceiveCount
- returns the\n number of times a message has been received but not deleted.SenderId
- returns the AWS account\n number (or the IP address, if anonymous access is allowed) of the\n sender.SentTimestamp
- returns the time when\n the message was sent (epoch time in milliseconds).The message attribute Name can contain the following characters: A-Z, a-z, 0-9, underscore(_), hyphen(-), and period (.). \n The message attribute name must not start or end with a period, and it should not have successive periods. The message attribute name is case sensitive and must be unique among all attribute \n names for the message. The message attribute name can be up to 256 characters long. Attribute names cannot start with \"AWS.\" or \"Amazon.\" because these prefixes are reserved for use by Amazon Web Services.
\n " }, "MaxNumberOfMessages": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe maximum number of messages to return. Amazon SQS never returns more\n messages than this value but may return fewer. Values can be from 1 to 10. Default is 1.
\n\nAll of the messages are not necessarily returned.
\n " }, "VisibilityTimeout": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe duration (in seconds) that the received messages are hidden from\n subsequent retrieve requests after being retrieved by a\n ReceiveMessage
request.
The duration (in seconds) for which the call will wait for a message to arrive\n in the queue before returning. If a message is available, the call will\n return sooner than WaitTimeSeconds.
\n " } }, "documentation": "\n \n " }, "output": { "shape_name": "ReceiveMessageResult", "type": "structure", "members": { "Messages": { "shape_name": "MessageList", "type": "list", "members": { "shape_name": "Message", "type": "structure", "members": { "MessageId": { "shape_name": "String", "type": "string", "documentation": "\nA unique identifier for the message. Message IDs are considered unique across all AWS accounts for an extended period of time.
\n " }, "ReceiptHandle": { "shape_name": "String", "type": "string", "documentation": "\nAn identifier associated with the act of receiving the message. \n A new receipt handle is returned every time you receive a message. \n When deleting a message, you provide the last received receipt handle to delete the message.
\n " }, "MD5OfBody": { "shape_name": "String", "type": "string", "documentation": "\nAn MD5 digest of the non-URL-encoded message body string.
\n " }, "Body": { "shape_name": "String", "type": "string", "documentation": "\nThe message's contents (not URL-encoded).
\n " }, "Attributes": { "shape_name": "AttributeMap", "type": "map", "keys": { "shape_name": "QueueAttributeName", "type": "string", "enum": [ "Policy", "VisibilityTimeout", "MaximumMessageSize", "MessageRetentionPeriod", "ApproximateNumberOfMessages", "ApproximateNumberOfMessagesNotVisible", "CreatedTimestamp", "LastModifiedTimestamp", "QueueArn", "ApproximateNumberOfMessagesDelayed", "DelaySeconds", "ReceiveMessageWaitTimeSeconds", "RedrivePolicy" ], "documentation": "\nThe name of a queue attribute.
\n ", "xmlname": "Name" }, "members": { "shape_name": "String", "type": "string", "documentation": "\nThe value of a queue attribute.
\n ", "xmlname": "Value" }, "flattened": true, "xmlname": "Attribute", "documentation": "\nSenderId
, SentTimestamp
, ApproximateReceiveCount
, and/or \n ApproximateFirstReceiveTimestamp
. SentTimestamp
\n and ApproximateFirstReceiveTimestamp
are each returned as an integer representing the \n epoch time in milliseconds.
An MD5 digest of the non-URL-encoded message attribute string. This can be used to verify that Amazon SQS received the message correctly. Amazon SQS first URL decodes the message before creating the MD5 digest. For information about MD5, go to http://www.faqs.org/rfcs/rfc1321.html.
\n " }, "MessageAttributes": { "shape_name": "MessageAttributeMap", "type": "map", "keys": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Name" }, "members": { "shape_name": "MessageAttributeValue", "type": "structure", "members": { "StringValue": { "shape_name": "String", "type": "string", "documentation": "\nStrings are Unicode with UTF8 binary encoding. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
\n " }, "BinaryValue": { "shape_name": "Binary", "type": "blob", "documentation": "\nBinary type attributes can store any binary data, for example, compressed data, encrypted data, or images.
\n " }, "StringListValues": { "shape_name": "StringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "StringListValue" }, "documentation": "\nNot implemented. Reserved for future use.
\n ", "flattened": true, "xmlname": "StringListValue" }, "BinaryListValues": { "shape_name": "BinaryList", "type": "list", "members": { "shape_name": "Binary", "type": "blob", "documentation": null, "xmlname": "BinaryListValue" }, "documentation": "\nNot implemented. Reserved for future use.
\n ", "flattened": true, "xmlname": "BinaryListValue" }, "DataType": { "shape_name": "String", "type": "string", "documentation": "\nAmazon SQS supports the following logical data types: String, Number, and Binary. In addition, you can append your own custom labels. For more information, see Message Attribute Data Types.
\n ", "required": true } }, "documentation": "\nThe user-specified message attribute value. For string data types, the value attribute has the same restrictions on the content as the message body. For more information, see SendMessage.
\nName, type, and value must not be empty or null. In addition, the message body should not be empty or null. All parts of the message attribute, including name, type, and value, are included in the message size restriction, which is currently 256 KB (262,144 bytes).
\n ", "xmlname": "Value" }, "flattened": true, "documentation": "\nEach message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items.
\n ", "xmlname": "MessageAttribute" } }, "documentation": "\nAn Amazon SQS message.
\n ", "xmlname": "Message" }, "flattened": true, "documentation": "\nA list of messages.
\n " } }, "documentation": "\n A list of received messages.\n " }, "errors": [ { "shape_name": "OverLimit", "type": "structure", "members": {}, "documentation": "\nThe action that you requested would violate a limit. For example,\n ReceiveMessage returns this error if the maximum number of messages\n inflight has already been reached. AddPermission returns this error if\n the maximum number of permissions for the queue has already been reached.\n
\n " } ], "documentation": "\n \n\n Retrieves one or more messages, with a maximum limit of 10 messages, from the specified\n queue. Long poll support is enabled by using the WaitTimeSeconds
parameter. \n For more information, see \n Amazon SQS Long Poll in the Amazon SQS Developer Guide.\n
\n Short poll is the default behavior where a weighted random set of machines is sampled on a ReceiveMessage
call. \n This means only the messages on the sampled machines are returned. If the number of messages in the queue is small (less than 1000), \n it is likely you will get fewer messages than you requested per ReceiveMessage
call. \n If the number of messages in the queue is extremely small, you might not receive any messages in\n a particular ReceiveMessage
response; in which case you should repeat the\n request.\n
\n For each message returned, the response includes the following:\n
\n\n Message body\n
\n\n MD5 digest of the message body. For information about MD5, go to \n http://www.faqs.org/rfcs/rfc1321.html.\n
\n\n Message ID you received when you sent the message to the queue.\n
\n\n Receipt handle.\n
\n\n Message attributes.\n
\n\n MD5 digest of the message attributes.\n
\n\n The receipt handle is the identifier you must provide when deleting the message. For more\n information, see \n Queue\n and Message Identifiers in the Amazon SQS Developer Guide.\n
\n\n You can provide the VisibilityTimeout
parameter in your request, which\n will be applied to the messages that Amazon SQS returns in the response. If you do not include the\n parameter, the overall visibility timeout for the queue is used for the returned messages. For\n more information, see \n Visibility\n Timeout in the Amazon SQS Developer Guide. \n
\n Going forward, new attributes might be added. If you are writing code that calls this action,\n we recommend that you structure your code so that it can handle new attributes gracefully.\n
\nThe URL of the Amazon SQS queue to take action on.
\n ", "required": true, "no_paramfile": true }, "Label": { "shape_name": "String", "type": "string", "documentation": "\nThe identification of the permission to remove. This is the label added with\n the AddPermission action.
\n ", "required": true } }, "documentation": "\n \n " }, "output": null, "errors": [], "documentation": "\nRevokes any permissions in the queue\n policy that matches the specified Label
parameter. Only the owner\n of the queue can remove permissions.
testLabel
permission on the queue named testQueue
.The URL of the Amazon SQS queue to take action on.
\n ", "required": true, "no_paramfile": true }, "MessageBody": { "shape_name": "String", "type": "string", "documentation": "\nThe message to send. String maximum 256 KB in size. For a list of allowed characters, see the preceding important note.
\n ", "required": true }, "DelaySeconds": { "shape_name": "Integer", "type": "integer", "documentation": "\n\n The number of seconds (0 to 900 - 15 minutes) to delay a specific message. Messages with a positive DelaySeconds
value \n become available for processing after the delay time is finished.\n If you don't specify a value, the default value for the queue applies.\n
Strings are Unicode with UTF8 binary encoding. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
\n " }, "BinaryValue": { "shape_name": "Binary", "type": "blob", "documentation": "\nBinary type attributes can store any binary data, for example, compressed data, encrypted data, or images.
\n " }, "StringListValues": { "shape_name": "StringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "StringListValue" }, "documentation": "\nNot implemented. Reserved for future use.
\n ", "flattened": true, "xmlname": "StringListValue" }, "BinaryListValues": { "shape_name": "BinaryList", "type": "list", "members": { "shape_name": "Binary", "type": "blob", "documentation": null, "xmlname": "BinaryListValue" }, "documentation": "\nNot implemented. Reserved for future use.
\n ", "flattened": true, "xmlname": "BinaryListValue" }, "DataType": { "shape_name": "String", "type": "string", "documentation": "\nAmazon SQS supports the following logical data types: String, Number, and Binary. In addition, you can append your own custom labels. For more information, see Message Attribute Data Types.
\n ", "required": true } }, "documentation": "\nThe user-specified message attribute value. For string data types, the value attribute has the same restrictions on the content as the message body. For more information, see SendMessage.
\nName, type, and value must not be empty or null. In addition, the message body should not be empty or null. All parts of the message attribute, including name, type, and value, are included in the message size restriction, which is currently 256 KB (262,144 bytes).
\n ", "xmlname": "Value" }, "flattened": true, "documentation": "\nEach message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items.
\n ", "xmlname": "MessageAttribute" } }, "documentation": "\n \n " }, "output": { "shape_name": "SendMessageResult", "type": "structure", "members": { "MD5OfMessageBody": { "shape_name": "String", "type": "string", "documentation": "\nAn MD5 digest of the non-URL-encoded message body string. This can be used to\n verify that Amazon SQS received the message correctly. Amazon SQS first URL decodes the\n message before creating the MD5 digest. For information about MD5, go to http://www.faqs.org/rfcs/rfc1321.html.
\n " }, "MD5OfMessageAttributes": { "shape_name": "String", "type": "string", "documentation": "\nAn MD5 digest of the non-URL-encoded message attribute string. This can be used to verify that Amazon SQS received the message correctly. Amazon SQS first URL decodes the message before creating the MD5 digest. For information about MD5, go to http://www.faqs.org/rfcs/rfc1321.html.
\n " }, "MessageId": { "shape_name": "String", "type": "string", "documentation": "\n\n An element containing the message ID of the message sent to the queue. \n \n For more information, see \n Queue and Message Identifiers\n in the Amazon SQS Developer Guide.\n
\n " } }, "documentation": "\nThe MD5OfMessageBody and MessageId elements.
\n " }, "errors": [ { "shape_name": "InvalidMessageContents", "type": "structure", "members": {}, "documentation": "\nThe message contains characters outside the allowed set.
\n " }, { "shape_name": "UnsupportedOperation", "type": "structure", "members": {}, "documentation": "\nError code 400. Unsupported operation.
\n " } ], "documentation": "\n\n Delivers a message to the specified\n queue. With Amazon SQS, you now have the ability to send large payload messages that are up\n to 256KB (262,144 bytes) in size. To send large payloads, you must use an AWS SDK that\n supports SigV4 signing. To verify whether SigV4 is supported for an AWS SDK, check the SDK\n release notes.\n
\n\n The following list shows the characters (in Unicode) allowed in your message, according\n to the W3C XML specification. For more information, go to \n http://www.w3.org/TR/REC-xml/#charsets \n If you send any characters not included in the list, your request will be rejected.\n
\n\n #x9 | #xA | #xD | [#x20 to #xD7FF] | [#xE000 to #xFFFD] | [#x10000 to #x10FFFF]\n
\nSendMessage
request sends a message containing \"This is a test message\" to the queue. \n You must URL encode the entire URL; however, we've URL encoded only the message body to make the example easier for you to read. \n The following example response includes the MD5 digest for \"This is a test message\".\n The URL of the Amazon SQS queue to take action on.
\n ", "required": true, "no_paramfile": true }, "Entries": { "shape_name": "SendMessageBatchRequestEntryList", "type": "list", "members": { "shape_name": "SendMessageBatchRequestEntry", "type": "structure", "members": { "Id": { "shape_name": "String", "type": "string", "documentation": "\nAn identifier for the message in this batch. This is used to communicate\n the result. Note that the Id
s of a batch request need to\n be unique within the request.
Body of the message.
\n ", "required": true }, "DelaySeconds": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe number of seconds for which the message has to be delayed.
\n " }, "MessageAttributes": { "shape_name": "MessageAttributeMap", "type": "map", "keys": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Name" }, "members": { "shape_name": "MessageAttributeValue", "type": "structure", "members": { "StringValue": { "shape_name": "String", "type": "string", "documentation": "\nStrings are Unicode with UTF8 binary encoding. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
\n " }, "BinaryValue": { "shape_name": "Binary", "type": "blob", "documentation": "\nBinary type attributes can store any binary data, for example, compressed data, encrypted data, or images.
\n " }, "StringListValues": { "shape_name": "StringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "StringListValue" }, "documentation": "\nNot implemented. Reserved for future use.
\n ", "flattened": true, "xmlname": "StringListValue" }, "BinaryListValues": { "shape_name": "BinaryList", "type": "list", "members": { "shape_name": "Binary", "type": "blob", "documentation": null, "xmlname": "BinaryListValue" }, "documentation": "\nNot implemented. Reserved for future use.
\n ", "flattened": true, "xmlname": "BinaryListValue" }, "DataType": { "shape_name": "String", "type": "string", "documentation": "\nAmazon SQS supports the following logical data types: String, Number, and Binary. In addition, you can append your own custom labels. For more information, see Message Attribute Data Types.
\n ", "required": true } }, "documentation": "\nThe user-specified message attribute value. For string data types, the value attribute has the same restrictions on the content as the message body. For more information, see SendMessage.
\nName, type, and value must not be empty or null. In addition, the message body should not be empty or null. All parts of the message attribute, including name, type, and value, are included in the message size restriction, which is currently 256 KB (262,144 bytes).
\n ", "xmlname": "Value" }, "flattened": true, "documentation": "\nEach message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items.
\n ", "xmlname": "MessageAttribute" } }, "documentation": "\nContains the details of a single Amazon SQS message along with a Id
.
A list of SendMessageBatchRequestEntry items.
\n ", "required": true } }, "documentation": "\n \n " }, "output": { "shape_name": "SendMessageBatchResult", "type": "structure", "members": { "Successful": { "shape_name": "SendMessageBatchResultEntryList", "type": "list", "members": { "shape_name": "SendMessageBatchResultEntry", "type": "structure", "members": { "Id": { "shape_name": "String", "type": "string", "documentation": "\nAn identifier for the message in this batch.
\n ", "required": true }, "MessageId": { "shape_name": "String", "type": "string", "documentation": "\nAn identifier for the message.
\n ", "required": true }, "MD5OfMessageBody": { "shape_name": "String", "type": "string", "documentation": "\nAn MD5 digest of the non-URL-encoded message body string. This can be used to\n verify that Amazon SQS received the message correctly. Amazon SQS first URL decodes the\n message before creating the MD5 digest. For information about MD5, go to http://www.faqs.org/rfcs/rfc1321.html.
\n ", "required": true }, "MD5OfMessageAttributes": { "shape_name": "String", "type": "string", "documentation": "\nAn MD5 digest of the non-URL-encoded message attribute string. This can be used to verify that Amazon SQS received the message batch correctly. Amazon SQS first URL decodes the message before creating the MD5 digest. For information about MD5, go to http://www.faqs.org/rfcs/rfc1321.html.
\n " } }, "documentation": "\nEncloses a message ID for successfully enqueued message of a\n SendMessageBatch.
\n ", "xmlname": "SendMessageBatchResultEntry" }, "flattened": true, "documentation": "\nA list of SendMessageBatchResultEntry items.
\n ", "required": true }, "Failed": { "shape_name": "BatchResultErrorEntryList", "type": "list", "members": { "shape_name": "BatchResultErrorEntry", "type": "structure", "members": { "Id": { "shape_name": "String", "type": "string", "documentation": "\nThe id of an entry in a batch request.
\n ", "required": true }, "SenderFault": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the error happened due to the sender's fault.
\n ", "required": true }, "Code": { "shape_name": "String", "type": "string", "documentation": "\nAn error code representing why the action failed on this entry.
\n ", "required": true }, "Message": { "shape_name": "String", "type": "string", "documentation": "\nA message explaining why the action failed on this entry.
\n " } }, "documentation": "\nThis is used in the responses of batch API to give a detailed description\n of the result of an action on each entry in the request.
\n ", "xmlname": "BatchResultErrorEntry" }, "flattened": true, "documentation": "\nA list of BatchResultErrorEntry items with the error detail about each\n message that could not be enqueued.
\n ", "required": true } }, "documentation": "\nFor each message in the batch, the response contains a SendMessageBatchResultEntry tag if the message succeeds or a BatchResultErrorEntry tag if the message fails.
\n " }, "errors": [ { "shape_name": "TooManyEntriesInBatchRequest", "type": "structure", "members": {}, "documentation": "\nBatch request contains more number of entries than permissible.
\n " }, { "shape_name": "EmptyBatchRequest", "type": "structure", "members": {}, "documentation": "\nBatch request does not contain an entry.
\n " }, { "shape_name": "BatchEntryIdsNotDistinct", "type": "structure", "members": {}, "documentation": "\nTwo or more batch entries have the same Id
in the request.
The length of all the messages put together is more than the limit.
\n " }, { "shape_name": "InvalidBatchEntryId", "type": "structure", "members": {}, "documentation": "\nThe Id
of a batch entry in a batch request does not abide\n by the specification.
Error code 400. Unsupported operation.
\n " } ], "documentation": "\nDelivers up to ten messages to the specified queue.\n This is a batch version of SendMessage.\n The result of the send action on each message is reported individually in the response.\n The maximum allowed individual message size is 256 KB (262,144 bytes).
\nThe maximum total payload size (i.e., the sum of all a batch's individual message lengths)\n is also 256 KB (262,144 bytes).
\nIf the DelaySeconds
parameter is not specified for an entry, \n the default for the queue is used.
#x9 | #xA | #xD | [#x20 to #xD7FF] | [#xE000 to #xFFFD] | [#x10000 to #x10FFFF]
\nparam.n
notation. Values\n of n
are integers starting from 1. For example, a parameter list with two elements looks like this: \n &Attribute.1=this
&Attribute.2=that
SendMessageBatch
request sends two messages\n to the queue. You must URL encode the entire URL; however, we've URL encoded\n only the message body to make the example easier for you to read.\n The following example response includes the MD5 digest for the messages.\n The URL of the Amazon SQS queue to take action on.
\n ", "required": true, "no_paramfile": true }, "Attributes": { "shape_name": "AttributeMap", "type": "map", "keys": { "shape_name": "QueueAttributeName", "type": "string", "enum": [ "Policy", "VisibilityTimeout", "MaximumMessageSize", "MessageRetentionPeriod", "ApproximateNumberOfMessages", "ApproximateNumberOfMessagesNotVisible", "CreatedTimestamp", "LastModifiedTimestamp", "QueueArn", "ApproximateNumberOfMessagesDelayed", "DelaySeconds", "ReceiveMessageWaitTimeSeconds", "RedrivePolicy" ], "documentation": "\nThe name of a queue attribute.
\n ", "xmlname": "Name" }, "members": { "shape_name": "String", "type": "string", "documentation": "\nThe value of a queue attribute.
\n ", "xmlname": "Value" }, "flattened": true, "xmlname": "Attribute", "documentation": "\nA map of attributes to set.
\nThe following lists the names, descriptions, and values of the special request parameters the SetQueueAttributes
\n action uses:
\n
DelaySeconds
- The time in seconds that the delivery of all messages in the queue will be delayed. An integer from 0 to 900 (15 minutes). The default for this attribute is 0 (zero).MaximumMessageSize
- The limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1024 bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this attribute is 262144 (256 KiB).MessageRetentionPeriod
- The number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). The default for this attribute is 345600 (4 days).Policy
- The queue's policy. A valid\n form-url-encoded policy. For more information about policy\n structure, see Basic Policy Structure in the Amazon SQS Developer Guide. \n For more information about form-url-encoding, see \n http://www.w3.org/MarkUp/html-spec/html-spec_8.html#SEC8.2.1.ReceiveMessageWaitTimeSeconds
- The time for which a ReceiveMessage call will wait for a message to arrive. An integer from 0 to 20 (seconds). The default for this attribute is 0. VisibilityTimeout
- The visibility timeout for the queue. An integer from 0 to 43200 (12 hours). The default for this attribute is 30. For more information about visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.RedrivePolicy
- The parameters for dead letter queue functionality of the source queue. \n For more information about RedrivePolicy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide.The attribute referred to does not exist.
\n " } ], "documentation": " \nSets the value of one or more queue attributes. When you change a queue's attributes, \n the change can take up to 60 seconds for most of the attributes to propagate throughout the SQS system. \n Changes made to the MessageRetentionPeriod
attribute can take up to 15 minutes.
testQueue
. \n For more examples of policies, see \n Amazon SQS Policy Examples\n in the Amazon SQS Developer Guide. \n testQueue
. Note: There is a 120,000 limit for the number of inflight messages per queue. Messages are inflight after they have been received by the queue, but have \n not yet been deleted from the queue. If you reach the 120,000 limit, you will receive an OverLimit error message from Amazon SQS. To help avoid reaching the limit, you should \n delete the messages from the queue after they have been processed. You can also increase the number of queues you use to process the messages. \n