Skip to content

Commit 32ac973

Browse files
author
AWS
committed
Amazon Simple Queue Service Update: Documentation changes related to SQS APIs.
1 parent d5fcdb6 commit 32ac973

File tree

2 files changed

+11
-5
lines changed

2 files changed

+11
-5
lines changed
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "Amazon Simple Queue Service",
4+
"contributor": "",
5+
"description": "Documentation changes related to SQS APIs."
6+
}

services/sqs/src/main/resources/codegen-resources/service-2.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
{"shape":"ResourceNotFoundException"},
4040
{"shape":"UnsupportedOperation"}
4141
],
42-
"documentation":"<p>Cancels a specified message movement task.</p> <note> <ul> <li> <p>A message movement can only be cancelled when the current status is RUNNING.</p> </li> <li> <p>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.</p> </li> </ul> </note>"
42+
"documentation":"<p>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.</p> <note> <ul> <li> <p>This action is currently limited to supporting message redrive from <a href=\"https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html\">dead-letter queues (DLQs)</a> 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. </p> </li> <li> <p>Currently, only standard queues are supported.</p> </li> <li> <p>Only one active message movement task is supported per queue at any given time.</p> </li> </ul> </note>"
4343
},
4444
"ChangeMessageVisibility":{
4545
"name":"ChangeMessageVisibility",
@@ -194,7 +194,7 @@
194194
{"shape":"ResourceNotFoundException"},
195195
{"shape":"UnsupportedOperation"}
196196
],
197-
"documentation":"<p>Gets the most recent message movement tasks (up to 10) under a specific source queue.</p>"
197+
"documentation":"<p>Gets the most recent message movement tasks (up to 10) under a specific source queue.</p> <note> <ul> <li> <p>This action is currently limited to supporting message redrive from <a href=\"https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html\">dead-letter queues (DLQs)</a> 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. </p> </li> <li> <p>Currently, only standard queues are supported.</p> </li> <li> <p>Only one active message movement task is supported per queue at any given time.</p> </li> </ul> </note>"
198198
},
199199
"ListQueueTags":{
200200
"name":"ListQueueTags",
@@ -233,7 +233,7 @@
233233
{"shape":"QueueDoesNotExist"},
234234
{"shape":"PurgeQueueInProgress"}
235235
],
236-
"documentation":"<p>Deletes the messages in a queue specified by the <code>QueueURL</code> parameter.</p> <important> <p>When you use the <code>PurgeQueue</code> action, you can't retrieve any messages deleted from a queue.</p> <p>The message deletion process takes up to 60 seconds. We recommend waiting for 60 seconds regardless of your queue's size. </p> </important> <p>Messages sent to the queue <i>before</i> you call <code>PurgeQueue</code> might be received but are deleted within the next minute.</p> <p>Messages sent to the queue <i>after</i> you call <code>PurgeQueue</code> might be deleted while the queue is being purged.</p>"
236+
"documentation":"<p>Deletes available messages in a queue (including in-flight messages) specified by the <code>QueueURL</code> parameter.</p> <important> <p>When you use the <code>PurgeQueue</code> action, you can't retrieve any messages deleted from a queue.</p> <p>The message deletion process takes up to 60 seconds. We recommend waiting for 60 seconds regardless of your queue's size. </p> </important> <p>Messages sent to the queue <i>before</i> you call <code>PurgeQueue</code> might be received but are deleted within the next minute.</p> <p>Messages sent to the queue <i>after</i> you call <code>PurgeQueue</code> might be deleted while the queue is being purged.</p>"
237237
},
238238
"ReceiveMessage":{
239239
"name":"ReceiveMessage",
@@ -325,7 +325,7 @@
325325
{"shape":"ResourceNotFoundException"},
326326
{"shape":"UnsupportedOperation"}
327327
],
328-
"documentation":"<p>Starts an asynchronous task to move messages from a specified source queue to a specified destination queue.</p> <note> <ul> <li> <p>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. </p> </li> <li> <p>Currently, only standard queues are supported.</p> </li> <li> <p>Only one active message movement task is supported per queue at any given time.</p> </li> </ul> </note>"
328+
"documentation":"<p>Starts an asynchronous task to move messages from a specified source queue to a specified destination queue.</p> <note> <ul> <li> <p>This action is currently limited to supporting message redrive from queues that are configured as <a href=\"https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html\">dead-letter queues (DLQs)</a> 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.</p> </li> <li> <p>In dead-letter queues redrive context, the <code>StartMessageMoveTask</code> the source queue is the 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.</p> </li> <li> <p>Currently, only standard queues support redrive. FIFO queues don't support redrive.</p> </li> <li> <p>Only one active message movement task is supported per queue at any given time.</p> </li> </ul> </note>"
329329
},
330330
"TagQueue":{
331331
"name":"TagQueue",
@@ -1596,7 +1596,7 @@
15961596
"members":{
15971597
"SourceArn":{
15981598
"shape":"String",
1599-
"documentation":"<p>The ARN of the queue that contains the messages to be moved to another queue. Currently, only dead-letter queue (DLQ) ARNs are accepted.</p>"
1599+
"documentation":"<p>The ARN of the queue that contains the messages to be moved to another queue. Currently, only ARNs of dead-letter queues (DLQs) whose sources are other Amazon SQS queues are accepted. DLQs whose sources are non-SQS queues, such as Lambda or Amazon SNS topics, are not currently supported.</p>"
16001600
},
16011601
"DestinationArn":{
16021602
"shape":"String",

0 commit comments

Comments
 (0)