/usr/lib/python3/dist-packages/botocore/data/aws/support/2013-04-15.json is in python3-botocore 0.62.0-1.
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 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 | {
"api_version": "2013-04-15",
"type": "json",
"json_version": "1.1",
"target_prefix": "AWSSupport_20130415",
"signature_version": "v4",
"service_full_name": "AWS Support",
"endpoint_prefix": "support",
"xmlnamespace": "http://support.amazonaws.com/doc/2013-04-15/",
"documentation": "\n <fullname>AWS Support</fullname>\n \n \n <p>The AWS Support API reference is intended for programmers who need detailed information about the AWS Support operations and data types. This service enables you to manage your AWS Support cases programmatically. It uses HTTP methods that return results in JSON format.</p>\n \n <p>The AWS Support service also exposes a set of <a href=\"https://aws.amazon.com/support/trustedadvisor\">Trusted Advisor</a> features. You can retrieve a list of checks and their descriptions, get check results, specify checks to refresh, and get the refresh status of checks. </p> \n \n <p>The following list describes the AWS Support case management operations: </p>\n <ul>\n <li>\n<b>Service names, issue categories, and available severity levels. </b>The <a>DescribeServices</a> and <a>DescribeSeverityLevels</a> operations return AWS service names, service codes, service categories, and problem severity levels. You use these values when you call the <a>CreateCase</a> operation. </li>\n <li>\n<b>Case creation, case details, and case resolution.</b> The <a>CreateCase</a>, <a>DescribeCases</a>, <a>DescribeAttachment</a>, and <a>ResolveCase</a> operations create AWS Support cases, retrieve information about cases, and resolve cases.</li>\n <li>\n<b>Case communication.</b> The <a>DescribeCommunications</a>, <a>AddCommunicationToCase</a>, and <a>AddAttachmentsToSet</a> operations retrieve and add communications and attachments to AWS Support cases. </li>\n </ul>\n \n <p>The following list describes the operations available from the AWS Support service for Trusted Advisor:</p>\n <ul>\n <li>\n<a>DescribeTrustedAdvisorChecks</a> returns the list of checks that run against your AWS resources.</li> \n <li>Using the <code>CheckId</code> for a specific check returned by <a>DescribeTrustedAdvisorChecks</a>, you can call <a>DescribeTrustedAdvisorCheckResult</a> to obtain the results for the check you specified.</li> \n <li>\n<a>DescribeTrustedAdvisorCheckSummaries</a> returns summarized results for one or more Trusted Advisor checks.</li>\n <li>\n<a>RefreshTrustedAdvisorCheck</a> requests that Trusted Advisor rerun a specified check. </li>\n <li>\n<a>DescribeTrustedAdvisorCheckRefreshStatuses</a> reports the refresh status of one or more checks. </li>\n </ul>\n \n <p>For authentication of requests, AWS Support uses <a href=\"http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version 4 Signing Process</a>.</p>\n \n <p>See <a href=\"http://docs.aws.amazon.com/awssupport/latest/user/Welcome.html\">About the AWS Support API</a> in the <i>AWS Support User Guide</i> for information about how to use this service to create and manage your support cases, and how to call Trusted Advisor for results of checks on your resources. </p>\n \n \n ",
"operations": {
"AddAttachmentsToSet": {
"name": "AddAttachmentsToSet",
"input": {
"shape_name": "AddAttachmentsToSetRequest",
"type": "structure",
"members": {
"attachmentSetId": {
"shape_name": "AttachmentSetId",
"type": "string",
"documentation": "\n <p>The ID of the attachment set. If an <code>AttachmentSetId</code> is not specified, a new attachment set is created, and the ID of the set is returned in the response. If an <code>AttachmentSetId</code> is specified, the attachments are added to the specified set, if it exists.</p>\n "
},
"attachments": {
"shape_name": "Attachments",
"type": "list",
"members": {
"shape_name": "Attachment",
"type": "structure",
"members": {
"fileName": {
"shape_name": "FileName",
"type": "string",
"documentation": "\n <p>The name of the attachment file.</p>\n "
},
"data": {
"shape_name": "Data",
"type": "blob",
"documentation": "\n <p>The content of the attachment file.</p>\n "
}
},
"documentation": "\n <p>An attachment to a case communication. The attachment consists of the file name and the content of the file.</p>\n "
},
"documentation": "\n <p>One or more attachments to add to the set. The limit is 3 attachments per set, and the size limit is 5 MB per attachment.</p>\n ",
"required": true
}
},
"documentation": "\n\n "
},
"output": {
"shape_name": "AddAttachmentsToSetResponse",
"type": "structure",
"members": {
"attachmentSetId": {
"shape_name": "AttachmentSetId",
"type": "string",
"documentation": "\n <p>The ID of the attachment set. If an <code>AttachmentSetId</code> was not specified, a new attachment set is created, and the ID of the set is returned in the response. If an <code>AttachmentSetId</code> was specified, the attachments are added to the specified set, if it exists.</p>\n "
},
"expiryTime": {
"shape_name": "ExpiryTime",
"type": "string",
"documentation": "\n <p>The time and date when the attachment set expires.</p>\n "
}
},
"documentation": "\n <p>The ID and expiry time of the attachment set returned by the <a>AddAttachmentsToSet</a> operation.</p>\n "
},
"errors": [
{
"shape_name": "InternalServerError",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>An internal server error occurred.</p>\n "
}
},
"documentation": "\n <p>An internal server error occurred.</p>\n "
},
{
"shape_name": "AttachmentSetIdNotFound",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>An attachment set with the specified ID could not be found.</p>\n "
}
},
"documentation": "\n <p>An attachment set with the specified ID could not be found.</p>\n "
},
{
"shape_name": "AttachmentSetExpired",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>The expiration time of the attachment set has passed. The set expires 1 hour after it is created.</p>\n "
}
},
"documentation": "\n <p>The expiration time of the attachment set has passed. The set expires 1 hour after it is created.</p>\n "
},
{
"shape_name": "AttachmentSetSizeLimitExceeded",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>A limit for the size of an attachment set has been exceeded. The limits are 3 attachments and 5 MB per attachment.</p>\n "
}
},
"documentation": "\n <p>A limit for the size of an attachment set has been exceeded. The limits are 3 attachments and 5 MB per attachment.</p> \n "
},
{
"shape_name": "AttachmentLimitExceeded",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>The limit for the number of attachment sets created in a short period of time has been exceeded.</p>\n "
}
},
"documentation": "\n <p>The limit for the number of attachment sets created in a short period of time has been exceeded.</p>\n "
}
],
"documentation": "\n <p>Adds one or more attachments to an attachment set. If an <code>AttachmentSetId</code> is not specified, a new attachment set is created, and the ID of the set is returned in the response. If an <code>AttachmentSetId</code> is specified, the attachments are added to the specified set, if it exists.</p>\n <p>An attachment set is a temporary container for attachments that are to be added to a case or case communication. The set is available for one hour after it is created; the <code>ExpiryTime</code> returned in the response indicates when the set expires. The maximum number of attachments in a set is 3, and the maximum size of any attachment in the set is 5 MB.</p>\n "
},
"AddCommunicationToCase": {
"name": "AddCommunicationToCase",
"input": {
"shape_name": "AddCommunicationToCaseRequest",
"type": "structure",
"members": {
"caseId": {
"shape_name": "CaseId",
"type": "string",
"documentation": "\n <p>The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-<i>12345678910-2013-c4c1d2bf33c5cf47</i></p>\n "
},
"communicationBody": {
"shape_name": "CommunicationBody",
"type": "string",
"min_length": 1,
"max_length": 8000,
"documentation": "\n <p>The body of an email communication to add to the support case.</p>\n ",
"required": true
},
"ccEmailAddresses": {
"shape_name": "CcEmailAddressList",
"type": "list",
"members": {
"shape_name": "CcEmailAddress",
"type": "string",
"documentation": null
},
"min_length": 0,
"max_length": 10,
"documentation": "\n <p>The email addresses in the CC line of an email to be added to the support case.</p>\n "
},
"attachmentSetId": {
"shape_name": "AttachmentSetId",
"type": "string",
"documentation": "\n <p>The ID of a set of one or more attachments for the communication to add to the case. Create the set by calling <a>AddAttachmentsToSet</a></p>\n "
}
},
"documentation": "\n <p>To be written.</p>\n "
},
"output": {
"shape_name": "AddCommunicationToCaseResponse",
"type": "structure",
"members": {
"result": {
"shape_name": "Result",
"type": "boolean",
"documentation": "\n <p>True if <a>AddCommunicationToCase</a> succeeds. Otherwise, returns an error.</p>\n "
}
},
"documentation": "\n <p>The result of the <a>AddCommunicationToCase</a> operation.</p>\n "
},
"errors": [
{
"shape_name": "InternalServerError",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>An internal server error occurred.</p>\n "
}
},
"documentation": "\n <p>An internal server error occurred.</p>\n "
},
{
"shape_name": "CaseIdNotFound",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>The requested <code>CaseId</code> could not be located.</p> \n "
}
},
"documentation": "\n <p>The requested <code>CaseId</code> could not be located.</p>\n "
},
{
"shape_name": "AttachmentSetIdNotFound",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>An attachment set with the specified ID could not be found.</p>\n "
}
},
"documentation": "\n <p>An attachment set with the specified ID could not be found.</p>\n "
},
{
"shape_name": "AttachmentSetExpired",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>The expiration time of the attachment set has passed. The set expires 1 hour after it is created.</p>\n "
}
},
"documentation": "\n <p>The expiration time of the attachment set has passed. The set expires 1 hour after it is created.</p>\n "
}
],
"documentation": "\n <p>Adds additional customer communication to an AWS Support case. You use the <code>CaseId</code> value to identify the case to add communication to. You can list a set of email addresses to copy on the communication using the <code>CcEmailAddresses</code> value. The <code>CommunicationBody</code> value contains the text of the communication.</p>\n <p>The response indicates the success or failure of the request.</p>\n <p>This operation implements a subset of the behavior on the AWS Support <a href=\"https://aws.amazon.com/support\">Your Support Cases</a> web form.</p>\n "
},
"CreateCase": {
"name": "CreateCase",
"input": {
"shape_name": "CreateCaseRequest",
"type": "structure",
"members": {
"subject": {
"shape_name": "Subject",
"type": "string",
"documentation": "\n <p>The title of the AWS Support case.</p>\n ",
"required": true
},
"serviceCode": {
"shape_name": "ServiceCode",
"type": "string",
"pattern": "[0-9a-z\\-_]+",
"documentation": "\n <p>The code for the AWS service returned by the call to <a>DescribeServices</a>.</p>\n "
},
"severityCode": {
"shape_name": "SeverityCode",
"type": "string",
"documentation": "\n <p>The code for the severity level returned by the call to <a>DescribeSeverityLevels</a>.</p>\n <note><p>The availability of severity levels depends on each customer's support subscription. In other words, your subscription may not necessarily require the urgent level of response time.</p></note>\n \n "
},
"categoryCode": {
"shape_name": "CategoryCode",
"type": "string",
"documentation": "\n <p>The category of problem for the AWS Support case. </p>\n "
},
"communicationBody": {
"shape_name": "CommunicationBody",
"type": "string",
"min_length": 1,
"max_length": 8000,
"documentation": "\n <p>The communication body text when you create an AWS Support case by calling <a>CreateCase</a>.</p>\n ",
"required": true
},
"ccEmailAddresses": {
"shape_name": "CcEmailAddressList",
"type": "list",
"members": {
"shape_name": "CcEmailAddress",
"type": "string",
"documentation": null
},
"min_length": 0,
"max_length": 10,
"documentation": "\n <p>A list of email addresses that AWS Support copies on case correspondence.</p>\n "
},
"language": {
"shape_name": "Language",
"type": "string",
"documentation": "\n <p>The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.</p>\n "
},
"issueType": {
"shape_name": "IssueType",
"type": "string",
"documentation": "\n <p>The type of issue for the case. You can specify either \"customer-service\" or \"technical.\" If you do not indicate a value, the default is \"technical.\" </p>\n "
},
"attachmentSetId": {
"shape_name": "AttachmentSetId",
"type": "string",
"documentation": "\n <p>The ID of a set of one or more attachments for the case. Create the set by using <a>AddAttachmentsToSet</a>.</p>\n "
}
},
"documentation": "\n \n "
},
"output": {
"shape_name": "CreateCaseResponse",
"type": "structure",
"members": {
"caseId": {
"shape_name": "CaseId",
"type": "string",
"documentation": "\n <p>The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-<i>12345678910-2013-c4c1d2bf33c5cf47</i></p>\n "
}
},
"documentation": "\n <p>The AWS Support case ID returned by a successful completion of the <a>CreateCase</a> operation. </p>\n "
},
"errors": [
{
"shape_name": "InternalServerError",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>An internal server error occurred.</p>\n "
}
},
"documentation": "\n <p>An internal server error occurred.</p>\n "
},
{
"shape_name": "CaseCreationLimitExceeded",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>An error message that indicates that you have exceeded the number of cases you can have open. </p>\n "
}
},
"documentation": "\n <p>The case creation limit for the account has been exceeded. </p>\n "
},
{
"shape_name": "AttachmentSetIdNotFound",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>An attachment set with the specified ID could not be found.</p>\n "
}
},
"documentation": "\n <p>An attachment set with the specified ID could not be found.</p>\n "
},
{
"shape_name": "AttachmentSetExpired",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>The expiration time of the attachment set has passed. The set expires 1 hour after it is created.</p>\n "
}
},
"documentation": "\n <p>The expiration time of the attachment set has passed. The set expires 1 hour after it is created.</p>\n "
}
],
"documentation": "\n <p>Creates a new case in the AWS Support Center. This operation is modeled on the behavior of the AWS Support Center <a href=\"https://aws.amazon.com/support/createCase\">Open a new case</a> page. Its parameters require you to specify the following information: </p>\n <ol>\n <li>\n<b>IssueType.</b> The type of issue for the case. You can specify either \"customer-service\" or \"technical.\" If you do not indicate a value, the default is \"technical.\" </li>\n <li>\n<b>ServiceCode.</b> The code for an AWS service. You obtain the <code>ServiceCode</code> by calling <a>DescribeServices</a>. </li>\n <li>\n<b>CategoryCode.</b> The category for the service defined for the <code>ServiceCode</code> value. You also obtain the category code for a service by calling <a>DescribeServices</a>. Each AWS service defines its own set of category codes. </li>\n <li>\n<b>SeverityCode.</b> A value that indicates the urgency of the case, which in turn determines the response time according to your service level agreement with AWS Support. You obtain the SeverityCode by calling <a>DescribeSeverityLevels</a>.</li>\n <li>\n<b>Subject.</b> The <b>Subject</b> field on the AWS Support Center <a href=\"https://aws.amazon.com/support/createCase\">Open a new case</a> page.</li>\n <li>\n<b>CommunicationBody.</b> The <b>Description</b> field on the AWS Support Center <a href=\"https://aws.amazon.com/support/createCase\">Open a new case</a> page.</li>\n <li>\n<b>AttachmentSetId.</b> The ID of a set of attachments that has been created by using <a>AddAttachmentsToSet</a>.</li>\n <li>\n<b>Language.</b> The human language in which AWS Support handles the case. English and Japanese are currently supported.</li>\n <li>\n<b>CcEmailAddresses.</b> The AWS Support Center <b>CC</b> field on the <a href=\"https://aws.amazon.com/support/createCase\">Open a new case</a> page. You can list email addresses to be copied on any correspondence about the case. The account that opens the case is already identified by passing the AWS Credentials in the HTTP POST method or in a method or function call from one of the programming languages supported by an <a href=\"http://aws.amazon.com/tools/\">AWS SDK</a>. </li>\n </ol>\n \n <note><p>To add additional communication or attachments to an existing case, use <a>AddCommunicationToCase</a>.</p> </note>\n \n <p>A successful <a>CreateCase</a> request returns an AWS Support case number. Case numbers are used by the <a>DescribeCases</a> operation to retrieve existing AWS Support cases. </p>\n \n \n "
},
"DescribeAttachment": {
"name": "DescribeAttachment",
"input": {
"shape_name": "DescribeAttachmentRequest",
"type": "structure",
"members": {
"attachmentId": {
"shape_name": "AttachmentId",
"type": "string",
"documentation": "\n <p>The ID of the attachment to return. Attachment IDs are returned by the <a>DescribeCommunications</a> operation.</p>\n ",
"required": true
}
},
"documentation": "\n\n "
},
"output": {
"shape_name": "DescribeAttachmentResponse",
"type": "structure",
"members": {
"attachment": {
"shape_name": "Attachment",
"type": "structure",
"members": {
"fileName": {
"shape_name": "FileName",
"type": "string",
"documentation": "\n <p>The name of the attachment file.</p>\n "
},
"data": {
"shape_name": "Data",
"type": "blob",
"documentation": "\n <p>The content of the attachment file.</p>\n "
}
},
"documentation": "\n <p>The attachment content and file name.</p>\n "
}
},
"documentation": "\n <p>The content and file name of the attachment returned by the <a>DescribeAttachment</a> operation.</p>\n "
},
"errors": [
{
"shape_name": "InternalServerError",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>An internal server error occurred.</p>\n "
}
},
"documentation": "\n <p>An internal server error occurred.</p>\n "
},
{
"shape_name": "DescribeAttachmentLimitExceeded",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>The limit for the number of <a>DescribeAttachment</a> requests in a short period of time has been exceeded.</p>\n "
}
},
"documentation": "\n <p>The limit for the number of <a>DescribeAttachment</a> requests in a short period of time has been exceeded.</p>\n "
},
{
"shape_name": "AttachmentIdNotFound",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>An attachment with the specified ID could not be found.</p>\n "
}
},
"documentation": "\n <p>An attachment with the specified ID could not be found.</p>\n "
}
],
"documentation": "\n <p>Returns the attachment that has the specified ID. Attachment IDs are generated by the case management system when you add an attachment to a case or case communication. Attachment IDs are returned in the <a>AttachmentDetails</a> objects that are returned by the <a>DescribeCommunications</a> operation.</p>\n "
},
"DescribeCases": {
"name": "DescribeCases",
"input": {
"shape_name": "DescribeCasesRequest",
"type": "structure",
"members": {
"caseIdList": {
"shape_name": "CaseIdList",
"type": "list",
"members": {
"shape_name": "CaseId",
"type": "string",
"documentation": null
},
"min_length": 0,
"max_length": 100,
"documentation": "\n <p>A list of ID numbers of the support cases you want returned. The maximum number of cases is 100. </p>\n "
},
"displayId": {
"shape_name": "DisplayId",
"type": "string",
"documentation": "\n <p>The ID displayed for a case in the AWS Support Center user interface. </p>\n "
},
"afterTime": {
"shape_name": "AfterTime",
"type": "string",
"documentation": "\n <p>The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.</p>\n "
},
"beforeTime": {
"shape_name": "BeforeTime",
"type": "string",
"documentation": "\n <p>The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.</p>\n "
},
"includeResolvedCases": {
"shape_name": "IncludeResolvedCases",
"type": "boolean",
"documentation": "\n <p>Specifies whether resolved support cases should be included in the <a>DescribeCases</a> results. The default is <i>false</i>.</p>\n "
},
"nextToken": {
"shape_name": "NextToken",
"type": "string",
"documentation": "\n <p>A resumption point for pagination.</p> \n "
},
"maxResults": {
"shape_name": "MaxResults",
"type": "integer",
"min_length": 10,
"max_length": 100,
"documentation": "\n <p>The maximum number of results to return before paginating.</p> \n "
},
"language": {
"shape_name": "Language",
"type": "string",
"documentation": "\n <p>The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.</p>\n "
},
"includeCommunications": {
"shape_name": "IncludeCommunications",
"type": "boolean",
"documentation": "\n <p>Specifies whether communications should be included in the <a>DescribeCases</a> results. The default is <i>true</i>.</p>\n "
}
},
"documentation": "\n \n "
},
"output": {
"shape_name": "DescribeCasesResponse",
"type": "structure",
"members": {
"cases": {
"shape_name": "CaseList",
"type": "list",
"members": {
"shape_name": "CaseDetails",
"type": "structure",
"members": {
"caseId": {
"shape_name": "CaseId",
"type": "string",
"documentation": "\n <p>The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-<i>12345678910-2013-c4c1d2bf33c5cf47</i></p>\n "
},
"displayId": {
"shape_name": "DisplayId",
"type": "string",
"documentation": "\n <p>The ID displayed for the case in the AWS Support Center. This is a numeric string. </p>\n "
},
"subject": {
"shape_name": "Subject",
"type": "string",
"documentation": "\n <p>The subject line for the case in the AWS Support Center.</p>\n "
},
"status": {
"shape_name": "Status",
"type": "string",
"documentation": "\n <p>The status of the case. </p>\n "
},
"serviceCode": {
"shape_name": "ServiceCode",
"type": "string",
"documentation": "\n <p>The code for the AWS service returned by the call to <a>DescribeServices</a>.</p>\n "
},
"categoryCode": {
"shape_name": "CategoryCode",
"type": "string",
"documentation": "\n <p>The category of problem for the AWS Support case.</p>\n "
},
"severityCode": {
"shape_name": "SeverityCode",
"type": "string",
"documentation": "\n <p>The code for the severity level returned by the call to <a>DescribeSeverityLevels</a>.</p>\n "
},
"submittedBy": {
"shape_name": "SubmittedBy",
"type": "string",
"documentation": "\n <p>The email address of the account that submitted the case.</p> \n "
},
"timeCreated": {
"shape_name": "TimeCreated",
"type": "string",
"documentation": "\n <p>The time that the case was case created in the AWS Support Center. </p>\n "
},
"recentCommunications": {
"shape_name": "RecentCaseCommunications",
"type": "structure",
"members": {
"communications": {
"shape_name": "CommunicationList",
"type": "list",
"members": {
"shape_name": "Communication",
"type": "structure",
"members": {
"caseId": {
"shape_name": "CaseId",
"type": "string",
"documentation": "\n <p>The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-<i>12345678910-2013-c4c1d2bf33c5cf47</i></p>\n "
},
"body": {
"shape_name": "CommunicationBody",
"type": "string",
"documentation": "\n <p>The text of the communication between the customer and AWS Support.</p>\n "
},
"submittedBy": {
"shape_name": "SubmittedBy",
"type": "string",
"documentation": "\n <p>The email address of the account that submitted the AWS Support case. </p>\n "
},
"timeCreated": {
"shape_name": "TimeCreated",
"type": "string",
"documentation": "\n <p>The time the communication was created. </p>\n "
},
"attachmentSet": {
"shape_name": "AttachmentSet",
"type": "list",
"members": {
"shape_name": "AttachmentDetails",
"type": "structure",
"members": {
"attachmentId": {
"shape_name": "AttachmentId",
"type": "string",
"documentation": "\n <p>The ID of the attachment.</p>\n"
},
"fileName": {
"shape_name": "FileName",
"type": "string",
"documentation": "\n <p>The file name of the attachment.</p>\n"
}
},
"documentation": "\n <p>The file name and ID of an attachment to a case communication. You can use the ID to retrieve the attachment with the <a>DescribeAttachment</a> operation.</p>\n"
},
"documentation": "\n <p>Information about the attachments to the case communication. </p>\n "
}
},
"documentation": "\n <p>A communication associated with an AWS Support case. The communication consists of the case ID, the message body, attachment information, the account email address, and the date and time of the communication.</p>\n "
},
"documentation": "\n <p>The five most recent communications associated with the case.</p>\n "
},
"nextToken": {
"shape_name": "NextToken",
"type": "string",
"documentation": "\n <p>A resumption point for pagination.</p>\n "
}
},
"documentation": "\n <p>The five most recent communications between you and AWS Support Center, including the IDs of any attachments to the communications. Also includes a <code>nextToken</code> that you can use to retrieve earlier communications.</p>\n "
},
"ccEmailAddresses": {
"shape_name": "CcEmailAddressList",
"type": "list",
"members": {
"shape_name": "CcEmailAddress",
"type": "string",
"documentation": null
},
"documentation": "\n <p>The email addresses that receive copies of communication about the case.</p>\n "
},
"language": {
"shape_name": "Language",
"type": "string",
"documentation": "\n <p>The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.</p>\n "
}
},
"documentation": "\n <p>A JSON-formatted object that contains the metadata for a support case. It is contained the response from a <a>DescribeCases</a> request. <b>CaseDetails</b> contains the following fields:</p>\n <ol>\n <li>\n<b>CaseID.</b> The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-<i>12345678910-2013-c4c1d2bf33c5cf47</i>.</li>\n <li>\n<b>CategoryCode.</b> The category of problem for the AWS Support case. Corresponds to the CategoryCode values returned by a call to <a>DescribeServices</a>.</li>\n <li>\n<b>DisplayId.</b> The identifier for the case on pages in the AWS Support Center.</li>\n <li>\n<b>Language.</b> The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.</li>\n <li>\n<b>RecentCommunications.</b> One or more <a>Communication</a> objects. Fields of these objects are <code>Attachments</code>, <code>Body</code>, <code>CaseId</code>, <code>SubmittedBy</code>, and <code>TimeCreated</code>.</li> \n <li>\n<b>NextToken.</b> A resumption point for pagination.</li>\n <li>\n<b>ServiceCode.</b> The identifier for the AWS service that corresponds to the service code defined in the call to <a>DescribeServices</a>.</li>\n <li>\n<b>SeverityCode. </b>The severity code assigned to the case. Contains one of the values returned by the call to <a>DescribeSeverityLevels</a>.</li>\n <li>\n<b>Status.</b> The status of the case in the AWS Support Center.</li>\n <li>\n<b>Subject.</b> The subject line of the case.</li>\n <li>\n<b>SubmittedBy.</b> The email address of the account that submitted the case.</li>\n <li>\n<b>TimeCreated.</b> The time the case was created, in ISO-8601 format.</li>\n </ol>\n \n "
},
"documentation": "\n <p>The details for the cases that match the request.</p> \n "
},
"nextToken": {
"shape_name": "NextToken",
"type": "string",
"documentation": "\n <p>A resumption point for pagination.</p>\n "
}
},
"documentation": "\n <p>Returns an array of <a>CaseDetails</a> objects and a <code>NextToken</code> that defines a point for pagination in the result set.</p>\n "
},
"errors": [
{
"shape_name": "InternalServerError",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>An internal server error occurred.</p>\n "
}
},
"documentation": "\n <p>An internal server error occurred.</p>\n "
},
{
"shape_name": "CaseIdNotFound",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>The requested <code>CaseId</code> could not be located.</p> \n "
}
},
"documentation": "\n <p>The requested <code>CaseId</code> could not be located.</p>\n "
}
],
"documentation": "\n <p>Returns a list of cases that you specify by passing one or more case IDs. In addition, you can filter the cases by date by setting values for the <code>AfterTime</code> and <code>BeforeTime</code> request parameters. </p>\n <p>Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error. </p> \n <p>The response returns the following in JSON format:</p> \n <ol>\n <li>One or more <a>CaseDetails</a> data types. </li>\n <li>One or more <code>NextToken</code> values, which specify where to paginate the returned records represented by the <code>CaseDetails</code> objects.</li>\n </ol>\n ",
"pagination": {
"input_token": "nextToken",
"output_token": "nextToken",
"limit_key": "maxResults",
"result_key": "cases",
"py_input_token": "next_token"
}
},
"DescribeCommunications": {
"name": "DescribeCommunications",
"input": {
"shape_name": "DescribeCommunicationsRequest",
"type": "structure",
"members": {
"caseId": {
"shape_name": "CaseId",
"type": "string",
"documentation": "\n <p>The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-<i>12345678910-2013-c4c1d2bf33c5cf47</i></p> \n ",
"required": true
},
"beforeTime": {
"shape_name": "BeforeTime",
"type": "string",
"documentation": "\n <p>The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.</p>\n "
},
"afterTime": {
"shape_name": "AfterTime",
"type": "string",
"documentation": "\n <p>The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.</p>\n "
},
"nextToken": {
"shape_name": "NextToken",
"type": "string",
"documentation": "\n <p>A resumption point for pagination.</p>\n "
},
"maxResults": {
"shape_name": "MaxResults",
"type": "integer",
"min_length": 10,
"max_length": 100,
"documentation": "\n <p>The maximum number of results to return before paginating.</p>\n "
}
},
"documentation": "\n \n "
},
"output": {
"shape_name": "DescribeCommunicationsResponse",
"type": "structure",
"members": {
"communications": {
"shape_name": "CommunicationList",
"type": "list",
"members": {
"shape_name": "Communication",
"type": "structure",
"members": {
"caseId": {
"shape_name": "CaseId",
"type": "string",
"documentation": "\n <p>The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-<i>12345678910-2013-c4c1d2bf33c5cf47</i></p>\n "
},
"body": {
"shape_name": "CommunicationBody",
"type": "string",
"documentation": "\n <p>The text of the communication between the customer and AWS Support.</p>\n "
},
"submittedBy": {
"shape_name": "SubmittedBy",
"type": "string",
"documentation": "\n <p>The email address of the account that submitted the AWS Support case. </p>\n "
},
"timeCreated": {
"shape_name": "TimeCreated",
"type": "string",
"documentation": "\n <p>The time the communication was created. </p>\n "
},
"attachmentSet": {
"shape_name": "AttachmentSet",
"type": "list",
"members": {
"shape_name": "AttachmentDetails",
"type": "structure",
"members": {
"attachmentId": {
"shape_name": "AttachmentId",
"type": "string",
"documentation": "\n <p>The ID of the attachment.</p>\n"
},
"fileName": {
"shape_name": "FileName",
"type": "string",
"documentation": "\n <p>The file name of the attachment.</p>\n"
}
},
"documentation": "\n <p>The file name and ID of an attachment to a case communication. You can use the ID to retrieve the attachment with the <a>DescribeAttachment</a> operation.</p>\n"
},
"documentation": "\n <p>Information about the attachments to the case communication. </p>\n "
}
},
"documentation": "\n <p>A communication associated with an AWS Support case. The communication consists of the case ID, the message body, attachment information, the account email address, and the date and time of the communication.</p>\n "
},
"documentation": "\n <p>The communications for the case.</p>\n "
},
"nextToken": {
"shape_name": "NextToken",
"type": "string",
"documentation": "\n <p>A resumption point for pagination.</p>\n "
}
},
"documentation": "\n <p>The communications returned by the <a>DescribeCommunications</a> operation.</p>\n "
},
"errors": [
{
"shape_name": "InternalServerError",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>An internal server error occurred.</p>\n "
}
},
"documentation": "\n <p>An internal server error occurred.</p>\n "
},
{
"shape_name": "CaseIdNotFound",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>The requested <code>CaseId</code> could not be located.</p> \n "
}
},
"documentation": "\n <p>The requested <code>CaseId</code> could not be located.</p>\n "
}
],
"documentation": "\n <p>Returns communications (and attachments) for one or more support cases. You can use the <code>AfterTime</code> and <code>BeforeTime</code> parameters to filter by date. You can use the <code>CaseId</code> parameter to restrict the results to a particular case.</p>\n <p>Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error. </p>\n <p>You can use the <code>MaxResults</code> and <code>NextToken</code> parameters to control the pagination of the result set. Set <code>MaxResults</code> to the number of cases you want displayed on each page, and use <code>NextToken</code> to specify the resumption of pagination.</p>\n ",
"pagination": {
"input_token": "nextToken",
"output_token": "nextToken",
"limit_key": "maxResults",
"result_key": "communications",
"py_input_token": "next_token"
}
},
"DescribeServices": {
"name": "DescribeServices",
"input": {
"shape_name": "DescribeServicesRequest",
"type": "structure",
"members": {
"serviceCodeList": {
"shape_name": "ServiceCodeList",
"type": "list",
"members": {
"shape_name": "ServiceCode",
"type": "string",
"pattern": "[0-9a-z\\-_]+",
"documentation": null
},
"min_length": 0,
"max_length": 100,
"documentation": "\n <p>A JSON-formatted list of service codes available for AWS services.</p>\n "
},
"language": {
"shape_name": "Language",
"type": "string",
"documentation": "\n <p>The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.</p>\n "
}
},
"documentation": "\n \n "
},
"output": {
"shape_name": "DescribeServicesResponse",
"type": "structure",
"members": {
"services": {
"shape_name": "ServiceList",
"type": "list",
"members": {
"shape_name": "Service",
"type": "structure",
"members": {
"code": {
"shape_name": "ServiceCode",
"type": "string",
"documentation": "\n <p>The code for an AWS service returned by the <a>DescribeServices</a> response. The <code>Name</code> element contains the corresponding friendly name.</p>\n "
},
"name": {
"shape_name": "ServiceName",
"type": "string",
"documentation": "\n <p>The friendly name for an AWS service. The <code>Code</code> element contains the corresponding code.</p>\n "
},
"categories": {
"shape_name": "CategoryList",
"type": "list",
"members": {
"shape_name": "Category",
"type": "structure",
"members": {
"code": {
"shape_name": "CategoryCode",
"type": "string",
"documentation": "\n <p>The category code for the support case. </p>\n "
},
"name": {
"shape_name": "CategoryName",
"type": "string",
"documentation": "\n <p>The category name for the support case. </p>\n "
}
},
"documentation": "\n <p>A JSON-formatted name/value pair that represents the category name and category code of the problem, selected from the <a>DescribeServices</a> response for each AWS service.</p>\n "
},
"documentation": "\n <p>A list of categories that describe the type of support issue a case describes. Categories consist of a category name and a category code. Category names and codes are passed to AWS Support when you call <a>CreateCase</a>.</p>\n "
}
},
"documentation": "\n <p>Information about an AWS service returned by the <a>DescribeServices</a> operation. </p>\n "
},
"documentation": "\n <p>A JSON-formatted list of AWS services.</p>\n "
}
},
"documentation": "\n <p>The list of AWS services returned by the <a>DescribeServices</a> operation.</p>\n "
},
"errors": [
{
"shape_name": "InternalServerError",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>An internal server error occurred.</p>\n "
}
},
"documentation": "\n <p>An internal server error occurred.</p>\n "
}
],
"documentation": "\n <p>Returns the current list of AWS services and a list of service categories that applies to each one. You then use service names and categories in your <a>CreateCase</a> requests. Each AWS service has its own set of categories.</p>\n \n<p>The service codes and category codes correspond to the values that are displayed in the <b>Service</b> and <b>Category</b> drop-down lists on the AWS Support Center <a href=\"https://aws.amazon.com/support/createCase\">Open a new case</a> page. The values in those\n fields, however, do not necessarily match the service codes and categories returned by the\n <code>DescribeServices</code> request. Always use the service codes and categories obtained\n programmatically. This practice ensures that you always have the most recent set of service and category codes.</p> \n \n "
},
"DescribeSeverityLevels": {
"name": "DescribeSeverityLevels",
"input": {
"shape_name": "DescribeSeverityLevelsRequest",
"type": "structure",
"members": {
"language": {
"shape_name": "Language",
"type": "string",
"documentation": "\n <p>The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.</p>\n "
}
},
"documentation": " \n "
},
"output": {
"shape_name": "DescribeSeverityLevelsResponse",
"type": "structure",
"members": {
"severityLevels": {
"shape_name": "SeverityLevelsList",
"type": "list",
"members": {
"shape_name": "SeverityLevel",
"type": "structure",
"members": {
"code": {
"shape_name": "SeverityLevelCode",
"type": "string",
"documentation": "\n <p>One of four values: \"low,\" \"medium,\" \"high,\" and \"urgent\". These values correspond to response times returned to the caller in <code>SeverityLevel.name</code>. </p>\n "
},
"name": {
"shape_name": "SeverityLevelName",
"type": "string",
"documentation": "\n <p>The name of the severity level that corresponds to the severity level code.</p>\n "
}
},
"documentation": "\n <p>A code and name pair that represent a severity level that can be applied to a support case. </p>\n "
},
"documentation": "\n <p>The available severity levels for the support case. Available severity levels are defined by your service level agreement with AWS.</p>\n "
}
},
"documentation": "\n <p>The list of severity levels returned by the <a>DescribeSeverityLevels</a> operation.</p>\n "
},
"errors": [
{
"shape_name": "InternalServerError",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>An internal server error occurred.</p>\n "
}
},
"documentation": "\n <p>An internal server error occurred.</p>\n "
}
],
"documentation": "\n <p>Returns the list of severity levels that you can assign to an AWS Support case. The severity level for a case is also a field in the <a>CaseDetails</a> data type included in any <a>CreateCase</a> request. </p>\n \n "
},
"DescribeTrustedAdvisorCheckRefreshStatuses": {
"name": "DescribeTrustedAdvisorCheckRefreshStatuses",
"input": {
"shape_name": "DescribeTrustedAdvisorCheckRefreshStatusesRequest",
"type": "structure",
"members": {
"checkIds": {
"shape_name": "StringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null
},
"documentation": "\n <p>The IDs of the Trusted Advisor checks.</p>\n ",
"required": true
}
},
"documentation": "\n \n "
},
"output": {
"shape_name": "DescribeTrustedAdvisorCheckRefreshStatusesResponse",
"type": "structure",
"members": {
"statuses": {
"shape_name": "TrustedAdvisorCheckRefreshStatusList",
"type": "list",
"members": {
"shape_name": "TrustedAdvisorCheckRefreshStatus",
"type": "structure",
"members": {
"checkId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The unique identifier for the Trusted Advisor check.</p>\n ",
"required": true
},
"status": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The status of the Trusted Advisor check for which a refresh has been requested: \"none\", \"enqueued\", \"processing\", \"success\", or \"abandoned\".</p>\n ",
"required": true
},
"millisUntilNextRefreshable": {
"shape_name": "Long",
"type": "long",
"documentation": "\n <p>The amount of time, in milliseconds, until the Trusted Advisor check is eligible for refresh.</p>\n ",
"required": true
}
},
"documentation": "\n <p>The refresh status of a Trusted Advisor check. </p>\n "
},
"documentation": "\n <p>The refresh status of the specified Trusted Advisor checks.</p>\n ",
"required": true
}
},
"documentation": "\n <p>The statuses of the Trusted Advisor checks returned by the <a>DescribeTrustedAdvisorCheckRefreshStatuses</a> operation.</p>\n "
},
"errors": [
{
"shape_name": "InternalServerError",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>An internal server error occurred.</p>\n "
}
},
"documentation": "\n <p>An internal server error occurred.</p>\n "
}
],
"documentation": "\n <p>Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling <a>DescribeTrustedAdvisorChecks</a>.</p>\n "
},
"DescribeTrustedAdvisorCheckResult": {
"name": "DescribeTrustedAdvisorCheckResult",
"input": {
"shape_name": "DescribeTrustedAdvisorCheckResultRequest",
"type": "structure",
"members": {
"checkId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The unique identifier for the Trusted Advisor check.</p>\n ",
"required": true
},
"language": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.</p>\n "
}
},
"documentation": "\n "
},
"output": {
"shape_name": "DescribeTrustedAdvisorCheckResultResponse",
"type": "structure",
"members": {
"result": {
"shape_name": "TrustedAdvisorCheckResult",
"type": "structure",
"members": {
"checkId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The unique identifier for the Trusted Advisor check.</p>\n ",
"required": true
},
"timestamp": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The time of the last refresh of the check.</p>\n ",
"required": true
},
"status": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The alert status of the check: \"ok\" (green), \"warning\" (yellow), \"error\" (red), or \"not_available\".</p>\n ",
"required": true
},
"resourcesSummary": {
"shape_name": "TrustedAdvisorResourcesSummary",
"type": "structure",
"members": {
"resourcesProcessed": {
"shape_name": "Long",
"type": "long",
"documentation": "\n <p>The number of AWS resources that were analyzed by the Trusted Advisor check.</p>\n ",
"required": true
},
"resourcesFlagged": {
"shape_name": "Long",
"type": "long",
"documentation": "\n <p>The number of AWS resources that were flagged (listed) by the Trusted Advisor check.</p>\n ",
"required": true
},
"resourcesIgnored": {
"shape_name": "Long",
"type": "long",
"documentation": "\n <p>The number of AWS resources ignored by Trusted Advisor because information was unavailable.</p>\n ",
"required": true
},
"resourcesSuppressed": {
"shape_name": "Long",
"type": "long",
"documentation": "\n <p>The number of AWS resources ignored by Trusted Advisor because they were marked as suppressed by the user.</p>\n ",
"required": true
}
},
"documentation": "\n <p>Details about AWS resources that were analyzed in a call to Trusted Advisor <a>DescribeTrustedAdvisorCheckSummaries</a>. </p>\n ",
"required": true
},
"categorySpecificSummary": {
"shape_name": "TrustedAdvisorCategorySpecificSummary",
"type": "structure",
"members": {
"costOptimizing": {
"shape_name": "TrustedAdvisorCostOptimizingSummary",
"type": "structure",
"members": {
"estimatedMonthlySavings": {
"shape_name": "Double",
"type": "double",
"documentation": "\n <p>The estimated monthly savings that might be realized if the recommended actions are taken.</p>\n ",
"required": true
},
"estimatedPercentMonthlySavings": {
"shape_name": "Double",
"type": "double",
"documentation": "\n <p>The estimated percentage of savings that might be realized if the recommended actions are taken.</p>\n ",
"required": true
}
},
"documentation": "\n <p>The summary information about cost savings for a Trusted Advisor check that is in the Cost Optimizing category.</p>\n "
}
},
"documentation": "\n <p>Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported.</p>\n ",
"required": true
},
"flaggedResources": {
"shape_name": "TrustedAdvisorResourceDetailList",
"type": "list",
"members": {
"shape_name": "TrustedAdvisorResourceDetail",
"type": "structure",
"members": {
"status": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The status code for the resource identified in the Trusted Advisor check.</p>\n ",
"required": true
},
"region": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The AWS region in which the identified resource is located. </p>\n ",
"required": true
},
"resourceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The unique identifier for the identified resource.</p>\n ",
"required": true
},
"isSuppressed": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Specifies whether the AWS resource was ignored by Trusted Advisor because it was marked as suppressed by the user.</p>\n "
},
"metadata": {
"shape_name": "StringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null
},
"documentation": "\n <p>Additional information about the identified resource. The exact metadata and its order can be obtained by inspecting the <a>TrustedAdvisorCheckDescription</a> object returned by the call to <a>DescribeTrustedAdvisorChecks</a>. <b>Metadata</b> contains all the data that is shown in the Excel download, even in those cases where the UI shows just summary data. </p>\n ",
"required": true
}
},
"documentation": "\n <p>Contains information about a resource identified by a Trusted Advisor check. </p>\n "
},
"documentation": "\n <p>The details about each resource listed in the check result.</p>\n ",
"required": true
}
},
"documentation": "\n <p>The detailed results of the Trusted Advisor check.</p>\n "
}
},
"documentation": "\n <p>The result of the Trusted Advisor check returned by the <a>DescribeTrustedAdvisorCheckResult</a> operation.</p>\n "
},
"errors": [
{
"shape_name": "InternalServerError",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>An internal server error occurred.</p>\n "
}
},
"documentation": "\n <p>An internal server error occurred.</p>\n "
}
],
"documentation": "\n <p>Returns the results of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling <a>DescribeTrustedAdvisorChecks</a>.</p>\n <p>The response contains a <a>TrustedAdvisorCheckResult</a> object, which contains these three objects:</p>\n <ul>\n <li><a>TrustedAdvisorCategorySpecificSummary</a></li>\n <li><a>TrustedAdvisorResourceDetail</a></li>\n <li><a>TrustedAdvisorResourcesSummary</a></li>\n </ul>\n<p>In addition, the response contains these fields:</p>\n <ul>\n <li>\n<b>Status.</b> The alert status of the check: \"ok\" (green), \"warning\" (yellow), \"error\" (red), or \"not_available\".</li>\n <li>\n<b>Timestamp.</b> The time of the last refresh of the check.</li>\n <li>\n<b>CheckId.</b> The unique identifier for the check.</li>\n </ul>\n "
},
"DescribeTrustedAdvisorCheckSummaries": {
"name": "DescribeTrustedAdvisorCheckSummaries",
"input": {
"shape_name": "DescribeTrustedAdvisorCheckSummariesRequest",
"type": "structure",
"members": {
"checkIds": {
"shape_name": "StringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null
},
"documentation": "\n <p>The IDs of the Trusted Advisor checks.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "DescribeTrustedAdvisorCheckSummariesResponse",
"type": "structure",
"members": {
"summaries": {
"shape_name": "TrustedAdvisorCheckSummaryList",
"type": "list",
"members": {
"shape_name": "TrustedAdvisorCheckSummary",
"type": "structure",
"members": {
"checkId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The unique identifier for the Trusted Advisor check.</p>\n ",
"required": true
},
"timestamp": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The time of the last refresh of the check.</p>\n ",
"required": true
},
"status": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The alert status of the check: \"ok\" (green), \"warning\" (yellow), \"error\" (red), or \"not_available\".</p>\n ",
"required": true
},
"hasFlaggedResources": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Specifies whether the Trusted Advisor check has flagged resources.</p>\n "
},
"resourcesSummary": {
"shape_name": "TrustedAdvisorResourcesSummary",
"type": "structure",
"members": {
"resourcesProcessed": {
"shape_name": "Long",
"type": "long",
"documentation": "\n <p>The number of AWS resources that were analyzed by the Trusted Advisor check.</p>\n ",
"required": true
},
"resourcesFlagged": {
"shape_name": "Long",
"type": "long",
"documentation": "\n <p>The number of AWS resources that were flagged (listed) by the Trusted Advisor check.</p>\n ",
"required": true
},
"resourcesIgnored": {
"shape_name": "Long",
"type": "long",
"documentation": "\n <p>The number of AWS resources ignored by Trusted Advisor because information was unavailable.</p>\n ",
"required": true
},
"resourcesSuppressed": {
"shape_name": "Long",
"type": "long",
"documentation": "\n <p>The number of AWS resources ignored by Trusted Advisor because they were marked as suppressed by the user.</p>\n ",
"required": true
}
},
"documentation": "\n <p>Details about AWS resources that were analyzed in a call to Trusted Advisor <a>DescribeTrustedAdvisorCheckSummaries</a>. </p>\n ",
"required": true
},
"categorySpecificSummary": {
"shape_name": "TrustedAdvisorCategorySpecificSummary",
"type": "structure",
"members": {
"costOptimizing": {
"shape_name": "TrustedAdvisorCostOptimizingSummary",
"type": "structure",
"members": {
"estimatedMonthlySavings": {
"shape_name": "Double",
"type": "double",
"documentation": "\n <p>The estimated monthly savings that might be realized if the recommended actions are taken.</p>\n ",
"required": true
},
"estimatedPercentMonthlySavings": {
"shape_name": "Double",
"type": "double",
"documentation": "\n <p>The estimated percentage of savings that might be realized if the recommended actions are taken.</p>\n ",
"required": true
}
},
"documentation": "\n <p>The summary information about cost savings for a Trusted Advisor check that is in the Cost Optimizing category.</p>\n "
}
},
"documentation": "\n <p>Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported.</p>\n ",
"required": true
}
},
"documentation": "\n <p>A summary of a Trusted Advisor check result, including the alert status, last refresh, and number of resources examined.</p>\n "
},
"documentation": "\n <p>The summary information for the requested Trusted Advisor checks.</p>\n ",
"required": true
}
},
"documentation": "\n <p>The summaries of the Trusted Advisor checks returned by the <a>DescribeTrustedAdvisorCheckSummaries</a> operation.</p>\n "
},
"errors": [
{
"shape_name": "InternalServerError",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>An internal server error occurred.</p>\n "
}
},
"documentation": "\n <p>An internal server error occurred.</p>\n "
}
],
"documentation": "\n <p>Returns the summaries of the results of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling <a>DescribeTrustedAdvisorChecks</a>.</p> \n <p>The response contains an array of <a>TrustedAdvisorCheckSummary</a> objects.</p> \n "
},
"DescribeTrustedAdvisorChecks": {
"name": "DescribeTrustedAdvisorChecks",
"input": {
"shape_name": "DescribeTrustedAdvisorChecksRequest",
"type": "structure",
"members": {
"language": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "DescribeTrustedAdvisorChecksResponse",
"type": "structure",
"members": {
"checks": {
"shape_name": "TrustedAdvisorCheckList",
"type": "list",
"members": {
"shape_name": "TrustedAdvisorCheckDescription",
"type": "structure",
"members": {
"id": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The unique identifier for the Trusted Advisor check.</p>\n ",
"required": true
},
"name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The display name for the Trusted Advisor check.</p>\n ",
"required": true
},
"description": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The description of the Trusted Advisor check, which includes the alert criteria and recommended actions (contains HTML markup).</p>\n ",
"required": true
},
"category": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The category of the Trusted Advisor check.</p>\n ",
"required": true
},
"metadata": {
"shape_name": "StringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null
},
"documentation": "\n <p>The column headings for the data returned by the Trusted Advisor check. The order of the headings corresponds to the order of the data in the <b>Metadata</b> element of the <a>TrustedAdvisorResourceDetail</a> for the check. <b>Metadata</b> contains all the data that is shown in the Excel download, even in those cases where the UI shows just summary data. </p>\n ",
"required": true
}
},
"documentation": "\n <p>The description and metadata for a Trusted Advisor check.</p>\n "
},
"documentation": "\n <p>Information about all available Trusted Advisor checks.</p>\n ",
"required": true
}
},
"documentation": "\n <p>Information about the Trusted Advisor checks returned by the <a>DescribeTrustedAdvisorChecks</a> operation.</p>\n "
},
"errors": [
{
"shape_name": "InternalServerError",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>An internal server error occurred.</p>\n "
}
},
"documentation": "\n <p>An internal server error occurred.</p>\n "
}
],
"documentation": "\n <p>Returns information about all available Trusted Advisor checks, including name, ID, category, description, and metadata. You must specify a language code; English (\"en\") and Japanese (\"ja\") are currently supported. The response contains a <a>TrustedAdvisorCheckDescription</a> for each check.</p> \n "
},
"RefreshTrustedAdvisorCheck": {
"name": "RefreshTrustedAdvisorCheck",
"input": {
"shape_name": "RefreshTrustedAdvisorCheckRequest",
"type": "structure",
"members": {
"checkId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The unique identifier for the Trusted Advisor check.</p>\n ",
"required": true
}
},
"documentation": "\n \n "
},
"output": {
"shape_name": "RefreshTrustedAdvisorCheckResponse",
"type": "structure",
"members": {
"status": {
"shape_name": "TrustedAdvisorCheckRefreshStatus",
"type": "structure",
"members": {
"checkId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The unique identifier for the Trusted Advisor check.</p>\n ",
"required": true
},
"status": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The status of the Trusted Advisor check for which a refresh has been requested: \"none\", \"enqueued\", \"processing\", \"success\", or \"abandoned\".</p>\n ",
"required": true
},
"millisUntilNextRefreshable": {
"shape_name": "Long",
"type": "long",
"documentation": "\n <p>The amount of time, in milliseconds, until the Trusted Advisor check is eligible for refresh.</p>\n ",
"required": true
}
},
"documentation": "\n <p>The current refresh status for a check, including the amount of time until the check is eligible for refresh. </p>\n ",
"required": true
}
},
"documentation": "\n <p>The current refresh status of a Trusted Advisor check.</p>\n "
},
"errors": [
{
"shape_name": "InternalServerError",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>An internal server error occurred.</p>\n "
}
},
"documentation": "\n <p>An internal server error occurred.</p>\n "
}
],
"documentation": "\n <p>Requests a refresh of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling <a>DescribeTrustedAdvisorChecks</a>.</p>\n <p>The response contains a <a>RefreshTrustedAdvisorCheckResult</a> object, which contains these fields:</p>\n <ul>\n <li>\n<b>Status.</b> The refresh status of the check: \"none\", \"enqueued\", \"processing\", \"success\", or \"abandoned\".</li>\n <li>\n<b>MillisUntilNextRefreshable.</b> The amount of time, in milliseconds, until the check is eligible for refresh.</li>\n <li>\n<b>CheckId.</b> The unique identifier for the check.</li>\n </ul>\n "
},
"ResolveCase": {
"name": "ResolveCase",
"input": {
"shape_name": "ResolveCaseRequest",
"type": "structure",
"members": {
"caseId": {
"shape_name": "CaseId",
"type": "string",
"documentation": "\n <p>The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-<i>12345678910-2013-c4c1d2bf33c5cf47</i></p>\n "
}
},
"documentation": "\n \n "
},
"output": {
"shape_name": "ResolveCaseResponse",
"type": "structure",
"members": {
"initialCaseStatus": {
"shape_name": "CaseStatus",
"type": "string",
"documentation": "\n <p>The status of the case when the <a>ResolveCase</a> request was sent.</p>\n "
},
"finalCaseStatus": {
"shape_name": "CaseStatus",
"type": "string",
"documentation": "\n <p>The status of the case after the <a>ResolveCase</a> request was processed.</p>\n "
}
},
"documentation": "\n <p>The status of the case returned by the <a>ResolveCase</a> operation.</p>\n "
},
"errors": [
{
"shape_name": "InternalServerError",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>An internal server error occurred.</p>\n "
}
},
"documentation": "\n <p>An internal server error occurred.</p>\n "
},
{
"shape_name": "CaseIdNotFound",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>The requested <code>CaseId</code> could not be located.</p> \n "
}
},
"documentation": "\n <p>The requested <code>CaseId</code> could not be located.</p>\n "
}
],
"documentation": "\n \n <p>Takes a <code>CaseId</code> and returns the initial state of the case along with the state of the case after the call to <a>ResolveCase</a> completed.</p>\n "
}
},
"pagination": {
"DescribeCases": {
"input_token": "nextToken",
"output_token": "nextToken",
"limit_key": "maxResults",
"result_key": "cases",
"py_input_token": "next_token"
},
"DescribeCommunications": {
"input_token": "nextToken",
"output_token": "nextToken",
"limit_key": "maxResults",
"result_key": "communications",
"py_input_token": "next_token"
}
},
"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
}
}
}
}
}
}
}
|