UNPKG

16.3 kBJSONView Raw
1{
2 "version": "2.0",
3 "metadata": {
4 "apiVersion": "2012-11-05",
5 "endpointPrefix": "sqs",
6 "protocol": "query",
7 "serviceAbbreviation": "Amazon SQS",
8 "serviceFullName": "Amazon Simple Queue Service",
9 "serviceId": "SQS",
10 "signatureVersion": "v4",
11 "uid": "sqs-2012-11-05",
12 "xmlNamespace": "http://queue.amazonaws.com/doc/2012-11-05/"
13 },
14 "operations": {
15 "AddPermission": {
16 "input": {
17 "type": "structure",
18 "required": [
19 "QueueUrl",
20 "Label",
21 "AWSAccountIds",
22 "Actions"
23 ],
24 "members": {
25 "QueueUrl": {},
26 "Label": {},
27 "AWSAccountIds": {
28 "type": "list",
29 "member": {
30 "locationName": "AWSAccountId"
31 },
32 "flattened": true
33 },
34 "Actions": {
35 "type": "list",
36 "member": {
37 "locationName": "ActionName"
38 },
39 "flattened": true
40 }
41 }
42 }
43 },
44 "ChangeMessageVisibility": {
45 "input": {
46 "type": "structure",
47 "required": [
48 "QueueUrl",
49 "ReceiptHandle",
50 "VisibilityTimeout"
51 ],
52 "members": {
53 "QueueUrl": {},
54 "ReceiptHandle": {},
55 "VisibilityTimeout": {
56 "type": "integer"
57 }
58 }
59 }
60 },
61 "ChangeMessageVisibilityBatch": {
62 "input": {
63 "type": "structure",
64 "required": [
65 "QueueUrl",
66 "Entries"
67 ],
68 "members": {
69 "QueueUrl": {},
70 "Entries": {
71 "type": "list",
72 "member": {
73 "locationName": "ChangeMessageVisibilityBatchRequestEntry",
74 "type": "structure",
75 "required": [
76 "Id",
77 "ReceiptHandle"
78 ],
79 "members": {
80 "Id": {},
81 "ReceiptHandle": {},
82 "VisibilityTimeout": {
83 "type": "integer"
84 }
85 }
86 },
87 "flattened": true
88 }
89 }
90 },
91 "output": {
92 "resultWrapper": "ChangeMessageVisibilityBatchResult",
93 "type": "structure",
94 "required": [
95 "Successful",
96 "Failed"
97 ],
98 "members": {
99 "Successful": {
100 "type": "list",
101 "member": {
102 "locationName": "ChangeMessageVisibilityBatchResultEntry",
103 "type": "structure",
104 "required": [
105 "Id"
106 ],
107 "members": {
108 "Id": {}
109 }
110 },
111 "flattened": true
112 },
113 "Failed": {
114 "shape": "Sd"
115 }
116 }
117 }
118 },
119 "CreateQueue": {
120 "input": {
121 "type": "structure",
122 "required": [
123 "QueueName"
124 ],
125 "members": {
126 "QueueName": {},
127 "Attributes": {
128 "shape": "Sh",
129 "locationName": "Attribute"
130 },
131 "tags": {
132 "shape": "Sj",
133 "locationName": "Tag"
134 }
135 }
136 },
137 "output": {
138 "resultWrapper": "CreateQueueResult",
139 "type": "structure",
140 "members": {
141 "QueueUrl": {}
142 }
143 }
144 },
145 "DeleteMessage": {
146 "input": {
147 "type": "structure",
148 "required": [
149 "QueueUrl",
150 "ReceiptHandle"
151 ],
152 "members": {
153 "QueueUrl": {},
154 "ReceiptHandle": {}
155 }
156 }
157 },
158 "DeleteMessageBatch": {
159 "input": {
160 "type": "structure",
161 "required": [
162 "QueueUrl",
163 "Entries"
164 ],
165 "members": {
166 "QueueUrl": {},
167 "Entries": {
168 "type": "list",
169 "member": {
170 "locationName": "DeleteMessageBatchRequestEntry",
171 "type": "structure",
172 "required": [
173 "Id",
174 "ReceiptHandle"
175 ],
176 "members": {
177 "Id": {},
178 "ReceiptHandle": {}
179 }
180 },
181 "flattened": true
182 }
183 }
184 },
185 "output": {
186 "resultWrapper": "DeleteMessageBatchResult",
187 "type": "structure",
188 "required": [
189 "Successful",
190 "Failed"
191 ],
192 "members": {
193 "Successful": {
194 "type": "list",
195 "member": {
196 "locationName": "DeleteMessageBatchResultEntry",
197 "type": "structure",
198 "required": [
199 "Id"
200 ],
201 "members": {
202 "Id": {}
203 }
204 },
205 "flattened": true
206 },
207 "Failed": {
208 "shape": "Sd"
209 }
210 }
211 }
212 },
213 "DeleteQueue": {
214 "input": {
215 "type": "structure",
216 "required": [
217 "QueueUrl"
218 ],
219 "members": {
220 "QueueUrl": {}
221 }
222 }
223 },
224 "GetQueueAttributes": {
225 "input": {
226 "type": "structure",
227 "required": [
228 "QueueUrl"
229 ],
230 "members": {
231 "QueueUrl": {},
232 "AttributeNames": {
233 "shape": "Sw"
234 }
235 }
236 },
237 "output": {
238 "resultWrapper": "GetQueueAttributesResult",
239 "type": "structure",
240 "members": {
241 "Attributes": {
242 "shape": "Sh",
243 "locationName": "Attribute"
244 }
245 }
246 }
247 },
248 "GetQueueUrl": {
249 "input": {
250 "type": "structure",
251 "required": [
252 "QueueName"
253 ],
254 "members": {
255 "QueueName": {},
256 "QueueOwnerAWSAccountId": {}
257 }
258 },
259 "output": {
260 "resultWrapper": "GetQueueUrlResult",
261 "type": "structure",
262 "members": {
263 "QueueUrl": {}
264 }
265 }
266 },
267 "ListDeadLetterSourceQueues": {
268 "input": {
269 "type": "structure",
270 "required": [
271 "QueueUrl"
272 ],
273 "members": {
274 "QueueUrl": {}
275 }
276 },
277 "output": {
278 "resultWrapper": "ListDeadLetterSourceQueuesResult",
279 "type": "structure",
280 "required": [
281 "queueUrls"
282 ],
283 "members": {
284 "queueUrls": {
285 "shape": "S12"
286 }
287 }
288 }
289 },
290 "ListQueueTags": {
291 "input": {
292 "type": "structure",
293 "required": [
294 "QueueUrl"
295 ],
296 "members": {
297 "QueueUrl": {}
298 }
299 },
300 "output": {
301 "resultWrapper": "ListQueueTagsResult",
302 "type": "structure",
303 "members": {
304 "Tags": {
305 "shape": "Sj",
306 "locationName": "Tag"
307 }
308 }
309 }
310 },
311 "ListQueues": {
312 "input": {
313 "type": "structure",
314 "members": {
315 "QueueNamePrefix": {}
316 }
317 },
318 "output": {
319 "resultWrapper": "ListQueuesResult",
320 "type": "structure",
321 "members": {
322 "QueueUrls": {
323 "shape": "S12"
324 }
325 }
326 }
327 },
328 "PurgeQueue": {
329 "input": {
330 "type": "structure",
331 "required": [
332 "QueueUrl"
333 ],
334 "members": {
335 "QueueUrl": {}
336 }
337 }
338 },
339 "ReceiveMessage": {
340 "input": {
341 "type": "structure",
342 "required": [
343 "QueueUrl"
344 ],
345 "members": {
346 "QueueUrl": {},
347 "AttributeNames": {
348 "shape": "Sw"
349 },
350 "MessageAttributeNames": {
351 "type": "list",
352 "member": {
353 "locationName": "MessageAttributeName"
354 },
355 "flattened": true
356 },
357 "MaxNumberOfMessages": {
358 "type": "integer"
359 },
360 "VisibilityTimeout": {
361 "type": "integer"
362 },
363 "WaitTimeSeconds": {
364 "type": "integer"
365 },
366 "ReceiveRequestAttemptId": {}
367 }
368 },
369 "output": {
370 "resultWrapper": "ReceiveMessageResult",
371 "type": "structure",
372 "members": {
373 "Messages": {
374 "type": "list",
375 "member": {
376 "locationName": "Message",
377 "type": "structure",
378 "members": {
379 "MessageId": {},
380 "ReceiptHandle": {},
381 "MD5OfBody": {},
382 "Body": {},
383 "Attributes": {
384 "locationName": "Attribute",
385 "type": "map",
386 "key": {
387 "locationName": "Name"
388 },
389 "value": {
390 "locationName": "Value"
391 },
392 "flattened": true
393 },
394 "MD5OfMessageAttributes": {},
395 "MessageAttributes": {
396 "shape": "S1g",
397 "locationName": "MessageAttribute"
398 }
399 }
400 },
401 "flattened": true
402 }
403 }
404 }
405 },
406 "RemovePermission": {
407 "input": {
408 "type": "structure",
409 "required": [
410 "QueueUrl",
411 "Label"
412 ],
413 "members": {
414 "QueueUrl": {},
415 "Label": {}
416 }
417 }
418 },
419 "SendMessage": {
420 "input": {
421 "type": "structure",
422 "required": [
423 "QueueUrl",
424 "MessageBody"
425 ],
426 "members": {
427 "QueueUrl": {},
428 "MessageBody": {},
429 "DelaySeconds": {
430 "type": "integer"
431 },
432 "MessageAttributes": {
433 "shape": "S1g",
434 "locationName": "MessageAttribute"
435 },
436 "MessageSystemAttributes": {
437 "shape": "S1n",
438 "locationName": "MessageSystemAttribute"
439 },
440 "MessageDeduplicationId": {},
441 "MessageGroupId": {}
442 }
443 },
444 "output": {
445 "resultWrapper": "SendMessageResult",
446 "type": "structure",
447 "members": {
448 "MD5OfMessageBody": {},
449 "MD5OfMessageAttributes": {},
450 "MD5OfMessageSystemAttributes": {},
451 "MessageId": {},
452 "SequenceNumber": {}
453 }
454 }
455 },
456 "SendMessageBatch": {
457 "input": {
458 "type": "structure",
459 "required": [
460 "QueueUrl",
461 "Entries"
462 ],
463 "members": {
464 "QueueUrl": {},
465 "Entries": {
466 "type": "list",
467 "member": {
468 "locationName": "SendMessageBatchRequestEntry",
469 "type": "structure",
470 "required": [
471 "Id",
472 "MessageBody"
473 ],
474 "members": {
475 "Id": {},
476 "MessageBody": {},
477 "DelaySeconds": {
478 "type": "integer"
479 },
480 "MessageAttributes": {
481 "shape": "S1g",
482 "locationName": "MessageAttribute"
483 },
484 "MessageSystemAttributes": {
485 "shape": "S1n",
486 "locationName": "MessageSystemAttribute"
487 },
488 "MessageDeduplicationId": {},
489 "MessageGroupId": {}
490 }
491 },
492 "flattened": true
493 }
494 }
495 },
496 "output": {
497 "resultWrapper": "SendMessageBatchResult",
498 "type": "structure",
499 "required": [
500 "Successful",
501 "Failed"
502 ],
503 "members": {
504 "Successful": {
505 "type": "list",
506 "member": {
507 "locationName": "SendMessageBatchResultEntry",
508 "type": "structure",
509 "required": [
510 "Id",
511 "MessageId",
512 "MD5OfMessageBody"
513 ],
514 "members": {
515 "Id": {},
516 "MessageId": {},
517 "MD5OfMessageBody": {},
518 "MD5OfMessageAttributes": {},
519 "MD5OfMessageSystemAttributes": {},
520 "SequenceNumber": {}
521 }
522 },
523 "flattened": true
524 },
525 "Failed": {
526 "shape": "Sd"
527 }
528 }
529 }
530 },
531 "SetQueueAttributes": {
532 "input": {
533 "type": "structure",
534 "required": [
535 "QueueUrl",
536 "Attributes"
537 ],
538 "members": {
539 "QueueUrl": {},
540 "Attributes": {
541 "shape": "Sh",
542 "locationName": "Attribute"
543 }
544 }
545 }
546 },
547 "TagQueue": {
548 "input": {
549 "type": "structure",
550 "required": [
551 "QueueUrl",
552 "Tags"
553 ],
554 "members": {
555 "QueueUrl": {},
556 "Tags": {
557 "shape": "Sj"
558 }
559 }
560 }
561 },
562 "UntagQueue": {
563 "input": {
564 "type": "structure",
565 "required": [
566 "QueueUrl",
567 "TagKeys"
568 ],
569 "members": {
570 "QueueUrl": {},
571 "TagKeys": {
572 "type": "list",
573 "member": {
574 "locationName": "TagKey"
575 },
576 "flattened": true
577 }
578 }
579 }
580 }
581 },
582 "shapes": {
583 "Sd": {
584 "type": "list",
585 "member": {
586 "locationName": "BatchResultErrorEntry",
587 "type": "structure",
588 "required": [
589 "Id",
590 "SenderFault",
591 "Code"
592 ],
593 "members": {
594 "Id": {},
595 "SenderFault": {
596 "type": "boolean"
597 },
598 "Code": {},
599 "Message": {}
600 }
601 },
602 "flattened": true
603 },
604 "Sh": {
605 "type": "map",
606 "key": {
607 "locationName": "Name"
608 },
609 "value": {
610 "locationName": "Value"
611 },
612 "flattened": true,
613 "locationName": "Attribute"
614 },
615 "Sj": {
616 "type": "map",
617 "key": {
618 "locationName": "Key"
619 },
620 "value": {
621 "locationName": "Value"
622 },
623 "flattened": true,
624 "locationName": "Tag"
625 },
626 "Sw": {
627 "type": "list",
628 "member": {
629 "locationName": "AttributeName"
630 },
631 "flattened": true
632 },
633 "S12": {
634 "type": "list",
635 "member": {
636 "locationName": "QueueUrl"
637 },
638 "flattened": true
639 },
640 "S1g": {
641 "type": "map",
642 "key": {
643 "locationName": "Name"
644 },
645 "value": {
646 "locationName": "Value",
647 "type": "structure",
648 "required": [
649 "DataType"
650 ],
651 "members": {
652 "StringValue": {},
653 "BinaryValue": {
654 "type": "blob"
655 },
656 "StringListValues": {
657 "shape": "S1j",
658 "flattened": true,
659 "locationName": "StringListValue"
660 },
661 "BinaryListValues": {
662 "shape": "S1k",
663 "flattened": true,
664 "locationName": "BinaryListValue"
665 },
666 "DataType": {}
667 }
668 },
669 "flattened": true
670 },
671 "S1j": {
672 "type": "list",
673 "member": {
674 "locationName": "StringListValue"
675 }
676 },
677 "S1k": {
678 "type": "list",
679 "member": {
680 "locationName": "BinaryListValue",
681 "type": "blob"
682 }
683 },
684 "S1n": {
685 "type": "map",
686 "key": {
687 "locationName": "Name"
688 },
689 "value": {
690 "locationName": "Value",
691 "type": "structure",
692 "required": [
693 "DataType"
694 ],
695 "members": {
696 "StringValue": {},
697 "BinaryValue": {
698 "type": "blob"
699 },
700 "StringListValues": {
701 "shape": "S1j",
702 "flattened": true,
703 "locationName": "StringListValue"
704 },
705 "BinaryListValues": {
706 "shape": "S1k",
707 "flattened": true,
708 "locationName": "BinaryListValue"
709 },
710 "DataType": {}
711 }
712 },
713 "flattened": true
714 }
715 }
716}
\No newline at end of file