/usr/lib/python2.7/dist-packages/botocore/data/aws/sqs.json is in python-botocore 0.29.0+repack-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 | {
"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 <p>Amazon Simple Queue Service (Amazon SQS) offers a reliable, highly scalable,\n hosted queue for storing messages as they travel between computers. By using\n Amazon SQS, developers can simply move data between distributed components of\n their applications that perform different tasks, without losing messages or\n requiring each component to be always available. Amazon SQS makes it easy to\n build an automated workflow, working in close conjunction with the Amazon\n Elastic Compute Cloud (Amazon EC2) and the other AWS infrastructure web\n services.</p>\n\n <p>Amazon SQS works by exposing Amazon's web-scale messaging infrastructure as\n a web service. Any computer on the Internet can add or read messages without\n any installed software or special firewall configurations. Components of\n applications using Amazon SQS can run independently, and do not need to be on\n the same network, developed with the same technologies, or running at the same\n time.</p>\n\n <p>Visit <a href=\"http://aws.amazon.com/sqs/\">http://aws.amazon.com/sqs/</a>\n for more information.</p>\n ",
"operations": {
"AddPermission": {
"name": "AddPermission",
"input": {
"shape_name": "AddPermissionRequest",
"type": "structure",
"members": {
"QueueUrl": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The URL of the SQS queue to take action on.</p>\n ",
"required": true,
"no_paramfile": true
},
"Label": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The unique identification of the permission you're setting (e.g.,\n <code>AliceSendMessage</code>). Constraints: Maximum 80 characters;\n alphanumeric characters, hyphens (-), and underscores (_) are allowed.</p>\n ",
"required": true
},
"AWSAccountIds": {
"shape_name": "AWSAccountIdList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "AWSAccountId"
},
"flattened": true,
"documentation": "\n <p>The AWS account number of the <a href=\"http://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/Glossary.html\">principal</a>\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.</p>\n ",
"required": true
},
"Actions": {
"shape_name": "ActionNameList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "ActionName"
},
"flattened": true,
"documentation": "\n <p>The action the client wants to allow for the specified principal.</p>\n ",
"required": true
}
},
"documentation": null
},
"output": null,
"errors": [
{
"shape_name": "OverLimit",
"type": "structure",
"members": {},
"documentation": "\n <p>The operation 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 </p>\n "
}
],
"documentation": "\n <p>The AddPermission action adds a permission to a queue for a specific \n <a href=\"http://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/Glossary.html\">principal</a>.\n This allows for sharing access to the queue.</p>\n\n <p>When 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 <a href=\"http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/?acp-overview.html\">Shared\n Queues</a> in the Amazon SQS Developer Guide.</p>\n\n <p><code>AddPermission</code> writes an 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 <a href=\"http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/?AccessPolicyLanguage.html\">Appendix:\n The Access Policy Language</a> in the Amazon SQS Developer Guide.</p>\n "
},
"ChangeMessageVisibility": {
"name": "ChangeMessageVisibility",
"input": {
"shape_name": "ChangeMessageVisibilityRequest",
"type": "structure",
"members": {
"QueueUrl": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The URL of the SQS queue to take action on.</p>\n ",
"required": true,
"no_paramfile": true
},
"ReceiptHandle": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The receipt handle associated with the message whose visibility timeout\n should be changed.</p>\n ",
"required": true
},
"VisibilityTimeout": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The new value (in seconds) for the message's visibility timeout.</p>\n ",
"required": true
}
},
"documentation": null
},
"output": null,
"errors": [
{
"shape_name": "MessageNotInflight",
"type": "structure",
"members": {},
"documentation": "\n <p>The message referred to is not in flight.</p>\n "
},
{
"shape_name": "ReceiptHandleIsInvalid",
"type": "structure",
"members": {},
"documentation": "\n <p>The receipt handle provided is not valid.</p>\n "
}
],
"documentation": "\n <p>The <code>ChangeMessageVisibility</code> action changes 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 <a href=\"http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AboutVT.html\">Visibility\n Timeout</a> in the Amazon SQS Developer Guide.)</p>\n\n <p>For example, let's say you have a message and its default message visibility\n timeout is 30 minutes. You could call <code>ChangeMessageVisiblity</code> 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.</p>\n\n <important>If you attempt to set the <code>VisibilityTimeout</code> 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.</important>\n\n <important>Unlike with a queue, when you change the visibility timeout for a\n specific message, that timeout value is applied immediately but is not saved in\n memory for that message. If you don't delete a message after it is received,\n the visibility timeout for the message the next time it is received reverts to\n the original timeout value, not the value you set with the\n ChangeMessageVisibility action.</important>\n "
},
"ChangeMessageVisibilityBatch": {
"name": "ChangeMessageVisibilityBatch",
"input": {
"shape_name": "ChangeMessageVisibilityBatchRequest",
"type": "structure",
"members": {
"QueueUrl": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The URL of the SQS queue to take action on.</p>\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": "\n <p>An identifier for this particular receipt handle. This is used to communicate\n the result. Note that the <code>Id</code>s of a batch request need to be\n unique within the request.</p>\n ",
"required": true
},
"ReceiptHandle": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>A receipt handle.</p>\n ",
"required": true
},
"VisibilityTimeout": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The new value (in seconds) for the message's visibility timeout.</p>\n "
}
},
"documentation": "\n <p>Encloses a receipt handle and an entry id for each message in\n <a>ChangeMessageVisibilityBatch</a>.</p>\n ",
"xmlname": "ChangeMessageVisibilityBatchRequestEntry"
},
"flattened": true,
"documentation": "\n <p>A list of receipt handles of the messages for which the visibility timeout\n must be changed.</p>\n ",
"required": true
}
},
"documentation": null
},
"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": "\n <p>Represents a message whose visibility timeout has been changed\n successfully.</p>\n ",
"required": true
}
},
"documentation": "\n <p>Encloses the id of an entry in <a>ChangeMessageVisibilityBatch</a>.</p>\n ",
"xmlname": "ChangeMessageVisibilityBatchResultEntry"
},
"flattened": true,
"documentation": "\n <p>A list of <a>ChangeMessageVisibilityBatchResultEntry</a>s.</p>\n ",
"required": true
},
"Failed": {
"shape_name": "BatchResultErrorEntryList",
"type": "list",
"members": {
"shape_name": "BatchResultErrorEntry",
"type": "structure",
"members": {
"Id": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The id of an entry in a batch request.</p>\n ",
"required": true
},
"SenderFault": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Whether the error happened due to the sender's fault.</p>\n ",
"required": true
},
"Code": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>An error code representing why the operation failed on this entry.</p>\n ",
"required": true
},
"Message": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>A message explaining why the operation failed on this entry.</p>\n "
}
},
"documentation": "\n <p>This is used in the responses of batch API to give a detailed description\n of the result of an operation on each entry in the request.</p>\n ",
"xmlname": "BatchResultErrorEntry"
},
"flattened": true,
"documentation": "\n <p>A list of <a>BatchResultErrorEntry</a>s.</p>\n ",
"required": true
}
},
"documentation": null
},
"errors": [
{
"shape_name": "TooManyEntriesInBatchRequest",
"type": "structure",
"members": {},
"documentation": "\n <p>Batch request contains more number of entries than permissible.</p>\n "
},
{
"shape_name": "EmptyBatchRequest",
"type": "structure",
"members": {},
"documentation": "\n <p>Batch request does not contain an entry.</p>\n "
},
{
"shape_name": "BatchEntryIdsNotDistinct",
"type": "structure",
"members": {},
"documentation": "\n <p>Two or more batch entries have the same <code>Id</code> in the request.</p>\n "
},
{
"shape_name": "InvalidBatchEntryId",
"type": "structure",
"members": {},
"documentation": "\n <p>The <code>Id</code> of a batch entry in a batch request does not abide\n by the specification.</p>\n "
}
],
"documentation": "\n <p>This is a batch version of <a>ChangeMessageVisibility</a>. It takes\n multiple receipt handles and performs the operation on each of the them. The\n result of the operation on each message is reported individually in the\n response.</p>\n "
},
"CreateQueue": {
"name": "CreateQueue",
"input": {
"shape_name": "CreateQueueRequest",
"type": "structure",
"members": {
"QueueName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name for the queue to be created.</p>\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"
],
"documentation": "\n <p>The name of a queue attribute.</p>\n ",
"xmlname": "Name"
},
"members": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The value of a queue attribute.</p>\n ",
"xmlname": "Value"
},
"flattened": true,
"xmlname": "Attribute",
"documentation": "\n <p>A map of attributes with their corresponding values.</p>\n "
}
},
"documentation": null
},
"output": {
"shape_name": "CreateQueueResult",
"type": "structure",
"members": {
"QueueUrl": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The URL for the created SQS queue.</p>\n "
}
},
"documentation": null
},
"errors": [
{
"shape_name": "QueueDeletedRecently",
"type": "structure",
"members": {},
"documentation": "\n <p>You must wait 60 seconds after deleting a queue before you can create another\n with the same name.</p>\n "
},
{
"shape_name": "QueueNameExists",
"type": "structure",
"members": {},
"documentation": "\n <p>A queue already exists with this name. SQS returns this error only if the request includes\n attributes whose values differ from those of the existing queue.</p>\n "
}
],
"documentation": "\n <p>The <code>CreateQueue</code> action creates a new queue, or returns the URL\n of an existing one. When you request <code>CreateQueue</code>, 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.</p>\n\n <p>You 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 <a>SetQueueAttributes</a>.</p>\n\n <p>If you provide the name of an existing queue, a new queue isn't created.\n If the values of attributes provided with the request match up with those\n on the existing queue, the queue URL is returned. Otherwise, a\n <code>QueueNameExists</code> error is returned.</p>\n "
},
"DeleteMessage": {
"name": "DeleteMessage",
"input": {
"shape_name": "DeleteMessageRequest",
"type": "structure",
"members": {
"QueueUrl": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The URL of the SQS queue to take action on.</p>\n ",
"required": true,
"no_paramfile": true
},
"ReceiptHandle": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The receipt handle associated with the message to delete.</p>\n ",
"required": true
}
},
"documentation": null
},
"output": null,
"errors": [
{
"shape_name": "InvalidIdFormat",
"type": "structure",
"members": {},
"documentation": "\n <p>The receipt handle is not valid for the current version.</p>\n "
},
{
"shape_name": "ReceiptHandleIsInvalid",
"type": "structure",
"members": {},
"documentation": "\n <p>The receipt handle provided is not valid.</p>\n "
}
],
"documentation": "\n <p>The <code>DeleteMessage</code> action unconditionally removes the specified\n message from the specified queue. Even if the message is locked by another\n reader due to the visibility timeout setting, it is still deleted from the\n queue.</p>\n "
},
"DeleteMessageBatch": {
"name": "DeleteMessageBatch",
"input": {
"shape_name": "DeleteMessageBatchRequest",
"type": "structure",
"members": {
"QueueUrl": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The URL of the SQS queue to take action on.</p>\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": "\n <p>An identifier for this particular receipt handle. This is used to\n communicate the result. Note that the <code>Id</code>s of a batch request\n need to be unique within the request.</p>\n ",
"required": true
},
"ReceiptHandle": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>A receipt handle.</p>\n ",
"required": true
}
},
"documentation": "\n <p>Encloses a receipt handle and an identifier for it.</p>\n ",
"xmlname": "DeleteMessageBatchRequestEntry"
},
"flattened": true,
"documentation": "\n <p>A list of receipt handles for the messages to be deleted.</p>\n ",
"required": true
}
},
"documentation": null
},
"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": "\n <p>Represents a successfully deleted message.</p>\n ",
"required": true
}
},
"documentation": "\n <p>Encloses the id an entry in <a>DeleteMessageBatch</a>.</p>\n ",
"xmlname": "DeleteMessageBatchResultEntry"
},
"flattened": true,
"documentation": "\n <p>A list of <a>DeleteMessageBatchResultEntry</a>s.</p>\n ",
"required": true
},
"Failed": {
"shape_name": "BatchResultErrorEntryList",
"type": "list",
"members": {
"shape_name": "BatchResultErrorEntry",
"type": "structure",
"members": {
"Id": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The id of an entry in a batch request.</p>\n ",
"required": true
},
"SenderFault": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Whether the error happened due to the sender's fault.</p>\n ",
"required": true
},
"Code": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>An error code representing why the operation failed on this entry.</p>\n ",
"required": true
},
"Message": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>A message explaining why the operation failed on this entry.</p>\n "
}
},
"documentation": "\n <p>This is used in the responses of batch API to give a detailed description\n of the result of an operation on each entry in the request.</p>\n ",
"xmlname": "BatchResultErrorEntry"
},
"flattened": true,
"documentation": "\n <p>A list of <a>BatchResultErrorEntry</a>s.</p>\n ",
"required": true
}
},
"documentation": null
},
"errors": [
{
"shape_name": "TooManyEntriesInBatchRequest",
"type": "structure",
"members": {},
"documentation": "\n <p>Batch request contains more number of entries than permissible.</p>\n "
},
{
"shape_name": "EmptyBatchRequest",
"type": "structure",
"members": {},
"documentation": "\n <p>Batch request does not contain an entry.</p>\n "
},
{
"shape_name": "BatchEntryIdsNotDistinct",
"type": "structure",
"members": {},
"documentation": "\n <p>Two or more batch entries have the same <code>Id</code> in the request.</p>\n "
},
{
"shape_name": "InvalidBatchEntryId",
"type": "structure",
"members": {},
"documentation": "\n <p>The <code>Id</code> of a batch entry in a batch request does not abide\n by the specification.</p>\n "
}
],
"documentation": "\n <p>This is a batch version of <a>DeleteMessage</a>. It takes multiple\n receipt handles and deletes each one of the messages. The result of the delete\n operation on each message is reported individually in the response.</p>\n "
},
"DeleteQueue": {
"name": "DeleteQueue",
"input": {
"shape_name": "DeleteQueueRequest",
"type": "structure",
"members": {
"QueueUrl": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The URL of the SQS queue to take action on.</p>\n ",
"required": true,
"no_paramfile": true
}
},
"documentation": null
},
"output": null,
"errors": [],
"documentation": "\n <p>This action unconditionally deletes the queue specified by the queue URL. Use\n this operation WITH CARE! The queue is deleted even if it is NOT empty.</p>\n <p>Once a queue has been deleted, the queue name is unavailable for use with new\n queues for 60 seconds.</p>\n "
},
"GetQueueAttributes": {
"name": "GetQueueAttributes",
"input": {
"shape_name": "GetQueueAttributesRequest",
"type": "structure",
"members": {
"QueueUrl": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The URL of the SQS queue to take action on.</p>\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"
],
"documentation": null,
"xmlname": "AttributeName"
},
"flattened": true,
"documentation": "\n <p>A list of attributes to retrieve information for. </p>\n "
}
},
"documentation": null
},
"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"
],
"documentation": "\n <p>The name of a queue attribute.</p>\n ",
"xmlname": "Name"
},
"members": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The value of a queue attribute.</p>\n ",
"xmlname": "Value"
},
"flattened": true,
"xmlname": "Attribute",
"documentation": "\n <p>A map of attributes to the respective values.</p>\n "
}
},
"documentation": null
},
"errors": [
{
"shape_name": "InvalidAttributeName",
"type": "structure",
"members": {},
"documentation": "\n <p>The attribute referred to does not exist.</p>\n "
}
],
"documentation": "\n <p>Gets attributes for the specified queue. The following attributes are supported:\n <ul>\n <li>\n<code>All</code> - returns all values.</li>\n <li>\n<code>ApproximateNumberOfMessages</code> - returns the approximate\n number of visible messages in a queue. For more information, see\n Resources Required to Process Messages in the Amazon SQS Developer\n Guide.</li>\n <li>\n<code>ApproximateNumberOfMessagesNotVisible</code> - returns the\n approximate number of messages that are not timed-out and not deleted. \n For more information, see Resources Required to Process Messages in the\n Amazon SQS Developer Guide.</li>\n <li>\n<code>VisibilityTimeout</code> - returns the visibility timeout for\n the queue. For more information about visibility timeout, see\n Visibility Timeout in the Amazon SQS Developer Guide.</li>\n <li>\n<code>CreatedTimestamp</code> - returns the time when the queue was\n created (epoch time in seconds).</li>\n <li>\n<code>LastModifiedTimestamp</code> - returns the time when the queue\n was last changed (epoch time in seconds).</li>\n <li>\n<code>Policy</code> - returns the queue's policy.</li>\n <li>\n<code>MaximumMessageSize</code> - returns the limit of how many bytes\n a message can contain before Amazon SQS rejects it.</li>\n <li>\n<code>MessageRetentionPeriod</code> - returns the number of seconds\n Amazon SQS retains a message.</li>\n <li>\n<code>QueueArn</code> - returns the queue's Amazon resource name\n (ARN).</li>\n <li>\n<code>ApproximateNumberOfMessagesDelayed</code> - returns the\n approximate number of messages that are pending to be added to the\n queue.</li>\n <li>\n<code>DelaySeconds</code> - returns the default delay on the queue\n in seconds.</li>\n <li>\n<code>ReceiveMessageWaitTimeSeconds</code> - returns the time for which a\n ReceiveMessage call will wait for a message to arrive.</li>\n </ul> \n </p>\n "
},
"GetQueueUrl": {
"name": "GetQueueUrl",
"input": {
"shape_name": "GetQueueUrlRequest",
"type": "structure",
"members": {
"QueueName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the queue whose URL must be fetched.</p>\n ",
"required": true
},
"QueueOwnerAWSAccountId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The AWS account number of the queue's owner.</p>\n "
}
},
"documentation": null
},
"output": {
"shape_name": "GetQueueUrlResult",
"type": "structure",
"members": {
"QueueUrl": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The URL for the queue.</p>\n "
}
},
"documentation": null
},
"errors": [
{
"shape_name": "QueueDoesNotExist",
"type": "structure",
"members": {},
"documentation": "\n <p>The queue referred to does not exist.</p>\n "
}
],
"documentation": "\n <p>The <code>GetQueueUrl</code> action returns the URL of an existing queue.</p>\n "
},
"ListQueues": {
"name": "ListQueues",
"input": {
"shape_name": "ListQueuesRequest",
"type": "structure",
"members": {
"QueueNamePrefix": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>A string to use for filtering the list results. Only those queues whose name\n begins with the specified string are returned.</p>\n "
}
},
"documentation": null
},
"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": "\n <p>A list of queue URLs, up to 1000 entries.</p>\n "
}
},
"documentation": null
},
"errors": [],
"documentation": "\n <p>Returns a list of your queues.</p>\n "
},
"ReceiveMessage": {
"name": "ReceiveMessage",
"input": {
"shape_name": "ReceiveMessageRequest",
"type": "structure",
"members": {
"QueueUrl": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The URL of the SQS queue to take action on.</p>\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"
],
"documentation": null,
"xmlname": "AttributeName"
},
"flattened": true,
"documentation": "\n <p>A list of attributes that need to be returned along with each message.\n The set of valid attributes are [SenderId, ApproximateFirstReceiveTimestamp,\n ApproximateReceiveCount, SentTimestamp].\n </p>\n "
},
"MaxNumberOfMessages": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The maximum number of messages to return. Amazon SQS never returns more\n messages than this value but may return fewer.</p>\n\n <p>All of the messages are not necessarily returned.</p>\n "
},
"VisibilityTimeout": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The duration (in seconds) that the received messages are hidden from\n subsequent retrieve requests after being retrieved by a\n <code>ReceiveMessage</code> request.</p>\n "
},
"WaitTimeSeconds": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>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.</p>\n "
}
},
"documentation": null
},
"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": null
},
"ReceiptHandle": {
"shape_name": "String",
"type": "string",
"documentation": null
},
"MD5OfBody": {
"shape_name": "String",
"type": "string",
"documentation": null
},
"Body": {
"shape_name": "String",
"type": "string",
"documentation": null
},
"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"
],
"documentation": "\n <p>The name of a queue attribute.</p>\n ",
"xmlname": "Name"
},
"members": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The value of a queue attribute.</p>\n ",
"xmlname": "Value"
},
"flattened": true,
"xmlname": "Attribute",
"documentation": null
}
},
"documentation": null,
"xmlname": "Message"
},
"flattened": true,
"documentation": "\n <p>A list of messages.</p>\n "
}
},
"documentation": null
},
"errors": [
{
"shape_name": "OverLimit",
"type": "structure",
"members": {},
"documentation": "\n <p>The operation 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 </p>\n "
}
],
"documentation": "\n <p>Retrieves one or more messages from the specified queue, including the message\n body and message ID of each message. Messages returned by this action stay in\n the queue until you delete them. However, once a message is returned to a\n <code>ReceiveMessage</code> request, it is not returned on subsequent\n <code>ReceiveMessage</code> requests\n for the duration of the <code>VisibilityTimeout</code>. If you do not specify a\n <code>VisibilityTimeout</code> in the request, the overall visibility timeout for the queue\n is used for the returned messages.</p>\n\n <p>If a message is available in the queue, the call will return immediately. Otherwise,\n it will wait up to <code>WaitTimeSeconds</code> for a message to arrive. If you do not specify\n <code>WaitTimeSeconds</code> in the request, the queue attribute\n ReceiveMessageWaitTimeSeconds is used to determine how long to wait.</p>\n\n <p>You could ask for additional information about each message through the attributes.\n Attributes that can be requested are <code>[SenderId, ApproximateFirstReceiveTimestamp,\n ApproximateReceiveCount, SentTimestamp]</code>.</p>\n "
},
"RemovePermission": {
"name": "RemovePermission",
"input": {
"shape_name": "RemovePermissionRequest",
"type": "structure",
"members": {
"QueueUrl": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The URL of the SQS queue to take action on.</p>\n ",
"required": true,
"no_paramfile": true
},
"Label": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The identification of the permission to remove. This is the label added with\n the <a>AddPermission</a> operation.</p>\n ",
"required": true
}
},
"documentation": null
},
"output": null,
"errors": [],
"documentation": "\n <p>The <code>RemovePermission</code> action revokes any permissions in the queue\n policy that matches the specified <code>Label</code> parameter. Only the owner\n of the queue can remove permissions.</p>\n "
},
"SendMessage": {
"name": "SendMessage",
"input": {
"shape_name": "SendMessageRequest",
"type": "structure",
"members": {
"QueueUrl": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The URL of the SQS queue to take action on.</p>\n ",
"required": true,
"no_paramfile": true
},
"MessageBody": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The message to send.</p>\n ",
"required": true
},
"DelaySeconds": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The number of seconds the message has to be delayed.</p>\n "
}
},
"documentation": null
},
"output": {
"shape_name": "SendMessageResult",
"type": "structure",
"members": {
"MD5OfMessageBody": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>An MD5 digest of the non-URL-encoded message body string. This can be used to\n verify that SQS received the message correctly. SQS first URL decodes the\n message before creating the MD5 digest. For information about MD5, go to <a href=\"http://faqs.org/rfcs/rfc1321.html\">http://faqs.org/rfcs/rfc1321.html</a>.</p>\n "
},
"MessageId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The message ID of the message added to the queue.</p>\n "
}
},
"documentation": null
},
"errors": [
{
"shape_name": "InvalidMessageContents",
"type": "structure",
"members": {},
"documentation": "\n <p>The message contains characters outside the allowed set.</p>\n "
}
],
"documentation": "\n <p>The <code>SendMessage</code> action delivers a message to the specified\n queue.</p>\n "
},
"SendMessageBatch": {
"name": "SendMessageBatch",
"input": {
"shape_name": "SendMessageBatchRequest",
"type": "structure",
"members": {
"QueueUrl": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The URL of the SQS queue to take action on.</p>\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": "\n <p>An identifier for the message in this batch. This is used to communicate\n the result. Note that the the <code>Id</code>s of a batch request need to\n be unique within the request.</p>\n ",
"required": true
},
"MessageBody": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Body of the message.</p>\n ",
"required": true
},
"DelaySeconds": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The number of seconds for which the message has to be delayed.</p>\n "
}
},
"documentation": "\n <p>Contains the details of a single SQS message along with a <code>Id</code>. </p>\n ",
"xmlname": "SendMessageBatchRequestEntry"
},
"flattened": true,
"documentation": "\n <p>A list of <a>SendMessageBatchRequestEntry</a>s.</p>\n ",
"required": true
}
},
"documentation": null
},
"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": "\n <p>An identifier for the message in this batch.</p>\n ",
"required": true
},
"MessageId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>An identifier for the message.</p>\n ",
"required": true
},
"MD5OfMessageBody": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>An MD5 digest of the non-URL-encoded message body string. This can be used to\n verify that SQS received the message correctly. SQS first URL decodes the\n message before creating the MD5 digest. For information about MD5, go to <a href=\"http://faqs.org/rfcs/rfc1321.html\">http://faqs.org/rfcs/rfc1321.html</a>.</p>\n ",
"required": true
}
},
"documentation": "\n <p>Encloses a message ID for successfully enqueued message of a\n <a>SendMessageBatch</a>.</p>\n ",
"xmlname": "SendMessageBatchResultEntry"
},
"flattened": true,
"documentation": "\n <p>A list of <a>SendMessageBatchResultEntry</a>s.</p>\n ",
"required": true
},
"Failed": {
"shape_name": "BatchResultErrorEntryList",
"type": "list",
"members": {
"shape_name": "BatchResultErrorEntry",
"type": "structure",
"members": {
"Id": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The id of an entry in a batch request.</p>\n ",
"required": true
},
"SenderFault": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Whether the error happened due to the sender's fault.</p>\n ",
"required": true
},
"Code": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>An error code representing why the operation failed on this entry.</p>\n ",
"required": true
},
"Message": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>A message explaining why the operation failed on this entry.</p>\n "
}
},
"documentation": "\n <p>This is used in the responses of batch API to give a detailed description\n of the result of an operation on each entry in the request.</p>\n ",
"xmlname": "BatchResultErrorEntry"
},
"flattened": true,
"documentation": "\n <p>A list of <a>BatchResultErrorEntry</a>s with the error detail about each\n message that could not be enqueued.</p>\n ",
"required": true
}
},
"documentation": null
},
"errors": [
{
"shape_name": "TooManyEntriesInBatchRequest",
"type": "structure",
"members": {},
"documentation": "\n <p>Batch request contains more number of entries than permissible.</p>\n "
},
{
"shape_name": "EmptyBatchRequest",
"type": "structure",
"members": {},
"documentation": "\n <p>Batch request does not contain an entry.</p>\n "
},
{
"shape_name": "BatchEntryIdsNotDistinct",
"type": "structure",
"members": {},
"documentation": "\n <p>Two or more batch entries have the same <code>Id</code> in the request.</p>\n "
},
{
"shape_name": "BatchRequestTooLong",
"type": "structure",
"members": {},
"documentation": "\n <p>The length of all the messages put together is more than the limit.</p>\n "
},
{
"shape_name": "InvalidBatchEntryId",
"type": "structure",
"members": {},
"documentation": "\n <p>The <code>Id</code> of a batch entry in a batch request does not abide\n by the specification.</p>\n "
}
],
"documentation": "\n <p>This is a batch version of <a>SendMessage</a>. It takes\n multiple messages and adds each of them to the queue. The result of each \n add operation is reported individually in the response.</p>\n "
},
"SetQueueAttributes": {
"name": "SetQueueAttributes",
"input": {
"shape_name": "SetQueueAttributesRequest",
"type": "structure",
"members": {
"QueueUrl": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The URL of the SQS queue to take action on.</p>\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"
],
"documentation": "\n <p>The name of a queue attribute.</p>\n ",
"xmlname": "Name"
},
"members": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The value of a queue attribute.</p>\n ",
"xmlname": "Value"
},
"flattened": true,
"xmlname": "Attribute",
"documentation": "\n <p>A map of attributes to set.</p>\n ",
"required": true
}
},
"documentation": null
},
"output": null,
"errors": [
{
"shape_name": "InvalidAttributeName",
"type": "structure",
"members": {},
"documentation": "\n <p>The attribute referred to does not exist.</p>\n "
}
],
"documentation": "\n <p>Sets the value of one or more queue attributes. Valid attributes that\n can be set are [VisibilityTimeout, Policy, MaximumMessageSize,\n MessageRetentionPeriod, ReceiveMessageWaitTimeSeconds].</p>\n "
}
},
"metadata": {
"regions": {
"us-east-1": "https://queue.amazonaws.com/",
"ap-northeast-1": "https://ap-northeast-1.queue.amazonaws.com/",
"sa-east-1": "https://sa-east-1.queue.amazonaws.com/",
"ap-southeast-1": "https://ap-southeast-1.queue.amazonaws.com/",
"ap-southeast-2": "https://ap-southeast-2.queue.amazonaws.com/",
"us-west-2": "https://us-west-2.queue.amazonaws.com/",
"us-west-1": "https://us-west-1.queue.amazonaws.com/",
"eu-west-1": "https://eu-west-1.queue.amazonaws.com/",
"us-gov-west-1": null,
"cn-north-1": "https://sqs.cn-north-1.amazonaws.com.cn"
},
"protocols": [
"https",
"http"
]
},
"retry": {
"__default__": {
"max_attempts": 5,
"delay": {
"type": "exponential",
"base": "rand",
"growth_factor": 2
},
"policies": {
"general_socket_errors": {
"applies_when": {
"socket_errors": [
"GENERAL_CONNECTION_ERROR"
]
}
},
"general_server_error": {
"applies_when": {
"response": {
"http_status_code": 500
}
}
},
"service_unavailable": {
"applies_when": {
"response": {
"http_status_code": 503
}
}
},
"limit_exceeded": {
"applies_when": {
"response": {
"http_status_code": 509
}
}
},
"request_limit_exceeded": {
"applies_when": {
"response": {
"service_error_code": "RequestThrottled",
"http_status_code": 403
}
}
}
}
}
}
}
|