sqs-2012-11-05.min.json
  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            "NextToken": {},
276            "MaxResults": {
277              "type": "integer"
278            }
279          }
280        },
281        "output": {
282          "resultWrapper": "ListDeadLetterSourceQueuesResult",
283          "type": "structure",
284          "required": [
285            "queueUrls"
286          ],
287          "members": {
288            "queueUrls": {
289              "shape": "S14"
290            },
291            "NextToken": {}
292          }
293        }
294      },
295      "ListQueueTags": {
296        "input": {
297          "type": "structure",
298          "required": [
299            "QueueUrl"
300          ],
301          "members": {
302            "QueueUrl": {}
303          }
304        },
305        "output": {
306          "resultWrapper": "ListQueueTagsResult",
307          "type": "structure",
308          "members": {
309            "Tags": {
310              "shape": "Sj",
311              "locationName": "Tag"
312            }
313          }
314        }
315      },
316      "ListQueues": {
317        "input": {
318          "type": "structure",
319          "members": {
320            "QueueNamePrefix": {},
321            "NextToken": {},
322            "MaxResults": {
323              "type": "integer"
324            }
325          }
326        },
327        "output": {
328          "resultWrapper": "ListQueuesResult",
329          "type": "structure",
330          "members": {
331            "QueueUrls": {
332              "shape": "S14"
333            },
334            "NextToken": {}
335          }
336        }
337      },
338      "PurgeQueue": {
339        "input": {
340          "type": "structure",
341          "required": [
342            "QueueUrl"
343          ],
344          "members": {
345            "QueueUrl": {}
346          }
347        }
348      },
349      "ReceiveMessage": {
350        "input": {
351          "type": "structure",
352          "required": [
353            "QueueUrl"
354          ],
355          "members": {
356            "QueueUrl": {},
357            "AttributeNames": {
358              "shape": "Sw"
359            },
360            "MessageAttributeNames": {
361              "type": "list",
362              "member": {
363                "locationName": "MessageAttributeName"
364              },
365              "flattened": true
366            },
367            "MaxNumberOfMessages": {
368              "type": "integer"
369            },
370            "VisibilityTimeout": {
371              "type": "integer"
372            },
373            "WaitTimeSeconds": {
374              "type": "integer"
375            },
376            "ReceiveRequestAttemptId": {}
377          }
378        },
379        "output": {
380          "resultWrapper": "ReceiveMessageResult",
381          "type": "structure",
382          "members": {
383            "Messages": {
384              "type": "list",
385              "member": {
386                "locationName": "Message",
387                "type": "structure",
388                "members": {
389                  "MessageId": {},
390                  "ReceiptHandle": {},
391                  "MD5OfBody": {},
392                  "Body": {},
393                  "Attributes": {
394                    "locationName": "Attribute",
395                    "type": "map",
396                    "key": {
397                      "locationName": "Name"
398                    },
399                    "value": {
400                      "locationName": "Value"
401                    },
402                    "flattened": true
403                  },
404                  "MD5OfMessageAttributes": {},
405                  "MessageAttributes": {
406                    "shape": "S1i",
407                    "locationName": "MessageAttribute"
408                  }
409                }
410              },
411              "flattened": true
412            }
413          }
414        }
415      },
416      "RemovePermission": {
417        "input": {
418          "type": "structure",
419          "required": [
420            "QueueUrl",
421            "Label"
422          ],
423          "members": {
424            "QueueUrl": {},
425            "Label": {}
426          }
427        }
428      },
429      "SendMessage": {
430        "input": {
431          "type": "structure",
432          "required": [
433            "QueueUrl",
434            "MessageBody"
435          ],
436          "members": {
437            "QueueUrl": {},
438            "MessageBody": {},
439            "DelaySeconds": {
440              "type": "integer"
441            },
442            "MessageAttributes": {
443              "shape": "S1i",
444              "locationName": "MessageAttribute"
445            },
446            "MessageSystemAttributes": {
447              "shape": "S1p",
448              "locationName": "MessageSystemAttribute"
449            },
450            "MessageDeduplicationId": {},
451            "MessageGroupId": {}
452          }
453        },
454        "output": {
455          "resultWrapper": "SendMessageResult",
456          "type": "structure",
457          "members": {
458            "MD5OfMessageBody": {},
459            "MD5OfMessageAttributes": {},
460            "MD5OfMessageSystemAttributes": {},
461            "MessageId": {},
462            "SequenceNumber": {}
463          }
464        }
465      },
466      "SendMessageBatch": {
467        "input": {
468          "type": "structure",
469          "required": [
470            "QueueUrl",
471            "Entries"
472          ],
473          "members": {
474            "QueueUrl": {},
475            "Entries": {
476              "type": "list",
477              "member": {
478                "locationName": "SendMessageBatchRequestEntry",
479                "type": "structure",
480                "required": [
481                  "Id",
482                  "MessageBody"
483                ],
484                "members": {
485                  "Id": {},
486                  "MessageBody": {},
487                  "DelaySeconds": {
488                    "type": "integer"
489                  },
490                  "MessageAttributes": {
491                    "shape": "S1i",
492                    "locationName": "MessageAttribute"
493                  },
494                  "MessageSystemAttributes": {
495                    "shape": "S1p",
496                    "locationName": "MessageSystemAttribute"
497                  },
498                  "MessageDeduplicationId": {},
499                  "MessageGroupId": {}
500                }
501              },
502              "flattened": true
503            }
504          }
505        },
506        "output": {
507          "resultWrapper": "SendMessageBatchResult",
508          "type": "structure",
509          "required": [
510            "Successful",
511            "Failed"
512          ],
513          "members": {
514            "Successful": {
515              "type": "list",
516              "member": {
517                "locationName": "SendMessageBatchResultEntry",
518                "type": "structure",
519                "required": [
520                  "Id",
521                  "MessageId",
522                  "MD5OfMessageBody"
523                ],
524                "members": {
525                  "Id": {},
526                  "MessageId": {},
527                  "MD5OfMessageBody": {},
528                  "MD5OfMessageAttributes": {},
529                  "MD5OfMessageSystemAttributes": {},
530                  "SequenceNumber": {}
531                }
532              },
533              "flattened": true
534            },
535            "Failed": {
536              "shape": "Sd"
537            }
538          }
539        }
540      },
541      "SetQueueAttributes": {
542        "input": {
543          "type": "structure",
544          "required": [
545            "QueueUrl",
546            "Attributes"
547          ],
548          "members": {
549            "QueueUrl": {},
550            "Attributes": {
551              "shape": "Sh",
552              "locationName": "Attribute"
553            }
554          }
555        }
556      },
557      "TagQueue": {
558        "input": {
559          "type": "structure",
560          "required": [
561            "QueueUrl",
562            "Tags"
563          ],
564          "members": {
565            "QueueUrl": {},
566            "Tags": {
567              "shape": "Sj"
568            }
569          }
570        }
571      },
572      "UntagQueue": {
573        "input": {
574          "type": "structure",
575          "required": [
576            "QueueUrl",
577            "TagKeys"
578          ],
579          "members": {
580            "QueueUrl": {},
581            "TagKeys": {
582              "type": "list",
583              "member": {
584                "locationName": "TagKey"
585              },
586              "flattened": true
587            }
588          }
589        }
590      }
591    },
592    "shapes": {
593      "Sd": {
594        "type": "list",
595        "member": {
596          "locationName": "BatchResultErrorEntry",
597          "type": "structure",
598          "required": [
599            "Id",
600            "SenderFault",
601            "Code"
602          ],
603          "members": {
604            "Id": {},
605            "SenderFault": {
606              "type": "boolean"
607            },
608            "Code": {},
609            "Message": {}
610          }
611        },
612        "flattened": true
613      },
614      "Sh": {
615        "type": "map",
616        "key": {
617          "locationName": "Name"
618        },
619        "value": {
620          "locationName": "Value"
621        },
622        "flattened": true,
623        "locationName": "Attribute"
624      },
625      "Sj": {
626        "type": "map",
627        "key": {
628          "locationName": "Key"
629        },
630        "value": {
631          "locationName": "Value"
632        },
633        "flattened": true,
634        "locationName": "Tag"
635      },
636      "Sw": {
637        "type": "list",
638        "member": {
639          "locationName": "AttributeName"
640        },
641        "flattened": true
642      },
643      "S14": {
644        "type": "list",
645        "member": {
646          "locationName": "QueueUrl"
647        },
648        "flattened": true
649      },
650      "S1i": {
651        "type": "map",
652        "key": {
653          "locationName": "Name"
654        },
655        "value": {
656          "locationName": "Value",
657          "type": "structure",
658          "required": [
659            "DataType"
660          ],
661          "members": {
662            "StringValue": {},
663            "BinaryValue": {
664              "type": "blob"
665            },
666            "StringListValues": {
667              "shape": "S1l",
668              "flattened": true,
669              "locationName": "StringListValue"
670            },
671            "BinaryListValues": {
672              "shape": "S1m",
673              "flattened": true,
674              "locationName": "BinaryListValue"
675            },
676            "DataType": {}
677          }
678        },
679        "flattened": true
680      },
681      "S1l": {
682        "type": "list",
683        "member": {
684          "locationName": "StringListValue"
685        }
686      },
687      "S1m": {
688        "type": "list",
689        "member": {
690          "locationName": "BinaryListValue",
691          "type": "blob"
692        }
693      },
694      "S1p": {
695        "type": "map",
696        "key": {
697          "locationName": "Name"
698        },
699        "value": {
700          "locationName": "Value",
701          "type": "structure",
702          "required": [
703            "DataType"
704          ],
705          "members": {
706            "StringValue": {},
707            "BinaryValue": {
708              "type": "blob"
709            },
710            "StringListValues": {
711              "shape": "S1l",
712              "flattened": true,
713              "locationName": "StringListValue"
714            },
715            "BinaryListValues": {
716              "shape": "S1m",
717              "flattened": true,
718              "locationName": "BinaryListValue"
719            },
720            "DataType": {}
721          }
722        },
723        "flattened": true
724      }
725    }
726  }