/usr/lib/python2.7/dist-packages/botocore/data/aws/support.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 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 | {
"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 actions 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\" title=\"TrustedAdvisor\">Trusted Advisor</a> features. You can retrieve a list of checks you can run on your resources, specify checks to run and refresh, and check the status of checks you have submitted. </p> \n \n <p>The following list describes the AWS Support case management actions: </p>\n <ul>\n <li>\n<b>Service names, issue categories, and available severity levels. </b>The actions <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_DescribeServices.html\" title=\"DescribeServices\">DescribeServices</a> and <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_DescribeSeverityLevels.html\">DescribeSeverityLevels</a> enable you to obtain AWS service names, service codes, service categories, and problem severity levels. You use these values when you call the <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_CreateCase.html\" title=\"CreateCase\">CreateCase</a> action. </li>\n <li>\n<b>Case Creation, case details, and case resolution</b>. The actions <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_CreateCase.html\" title=\"CreateCase\">CreateCase</a>, <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_DescribeCases.html\" title=\"DescribeCases\">DescribeCases</a>, and <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_ResolveCase.html\" title=\"ResolveCase\">ResolveCase</a> enable you to create AWS Support cases, retrieve them, and resolve them.</li>\n <li>\n<b>Case communication</b>. The actions <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_DescribeCommunications.html\" title=\"DescribeCommunications\">DescribeCommunications</a> and <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_AddCommunicationToCase.html\" title=\"AddCommunicationToCase\">AddCommunicationToCase</a> enable you to retrieve and add communication to AWS Support cases. </li>\n </ul>\n \n <p>The following list describes the actions available from the AWS Support service for Trusted Advisor:</p>\n <ul>\n <li>\n<a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_DescribeTrustedAdvisorChecks.html\" title=\"DescribeTrustedAdvisorChecks\">DescribeTrustedAdvisorChecks</a> returns the list of checks that you can run against your AWS resources.</li> \n <li>Using the CheckId for a specific check returned by DescribeTrustedAdvisorChecks, you can call <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_DescribeTrustedAdvisorCheckResult.html\" title=\"DescribeTrustedAdvisorCheckResult\">DescribeTrustedAdvisorCheckResult</a>\n</li> and obtain a new result for the check you specified. \n <li> Using <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_DescribeTrustedAdvisorCheckSummaries.html\" title=\"DescribeTrustedAdvisorCheckSummaries\">DescribeTrustedAdvisorCheckSummaries</a>, you can get summaries for a set of Trusted Advisor checks.</li>\n <li>\n<a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_RefreshTrustedAdvisorCheck.html\" title=\"RefreshTrustedAdvisorCheck\">RefreshTrustedAdvisorCheck</a> enables you to request that Trusted Advisor run the check again. </li>\n <li>\n<a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_DescribeTrustedAdvisorCheckRefreshStatuses.html\" title=\"DescribeTrustedAdvisorCheckRefreshStatuses\">DescribeTrustedAdvisorCheckRefreshStatuses</a> gets statuses on the checks you are running. </li>\n </ul>\n \n \n \n <p>For authentication of requests, the 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 the AWS Support <a href=\"http://docs.aws.amazon.com/awssupport/latest/developerguide/Welcome.html\">Developer Guide</a> for information about how to use this service to manage create and manage your support cases, and how to call Trusted Advisor for results of checks on your resources. </p>\n \n \n ",
"operations": {
"AddCommunicationToCase": {
"name": "AddCommunicationToCase",
"input": {
"shape_name": "AddCommunicationToCaseRequest",
"type": "structure",
"members": {
"caseId": {
"shape_name": "CaseId",
"type": "string",
"documentation": "\n <p>String that indicates the AWS Support caseID requested or returned in the call. The caseID is an alphanumeric string formatted as shown in this example CaseId: <i>case-12345678910-2013-c4c1d2bf33c5cf47</i></p>\n "
},
"communicationBody": {
"shape_name": "CommunicationBody",
"type": "string",
"min_length": 1,
"max_length": 8000,
"documentation": "\n <p>Represents the body of an email communication added 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>Represents any email addresses contained in the CC line of an email added to the support case.</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>Returns true if the <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_AddCommunicationToCase.html\" title=\"AddCommunicationToCase\">AddCommunicationToCase</a> succeeds. Returns an error otherwise. </p>\n "
}
},
"documentation": "\n <p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>\n "
},
"errors": [
{
"shape_name": "InternalServerError",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>Returns HTTP error 500.</p>\n "
}
},
"documentation": "\n <p>Returns HTTP error 500.</p>\n "
},
{
"shape_name": "CaseIdNotFound",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>Error returned when the request does not return a case for the <i>CaseId</i> submitted.</p> \n "
}
},
"documentation": "\n <p>Returned when the <i>CaseId</i> requested could not be located.</p>\n "
}
],
"documentation": "\n <p>This action adds additional customer communication to an AWS Support case. You use the <i>CaseId</i> value to identify the case to which you want to add communication. You can list a set of email addresses to copy on the communication using the <i>CcEmailAddresses</i> value. The <i>CommunicationBody</i> value contains the text of the communication.</p>\n <p>This action's response indicates the success or failure of the request.</p>\n <p>This action implements a subset of the behavior on the AWS Support <a href=\"https://aws.amazon.com/support\" title=\"Support Center\">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>Title of the AWS Support case.</p>\n ",
"required": true
},
"serviceCode": {
"shape_name": "ServiceCode",
"type": "string",
"pattern": "[0-9a-z\\-_]+",
"documentation": "\n <p>Code for the AWS service returned by the call to <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_DescribeServices.html\" title=\"DescribeServices\">DescribeServices</a>.</p>\n "
},
"severityCode": {
"shape_name": "SeverityCode",
"type": "string",
"documentation": "\n <p>Code for the severity level returned by the call to <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_DescribeSeverityLevels.html\" title=\"DescribeSeverityLevels\">DescribeSeverityLevels</a>.</p>\n <note>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.</note>\n \n "
},
"categoryCode": {
"shape_name": "CategoryCode",
"type": "string",
"documentation": "\n <p>Specifies 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>Parameter that represents the communication body text when you create an AWS Support case by calling <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_CreateCase.html\" title=\"CreateCase\">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>List of email addresses that AWS Support copies on case correspondence.</p>\n "
},
"language": {
"shape_name": "Language",
"type": "string",
"documentation": "\n <p>Specifies the ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English and Japanese, for which the codes are <i>en</i> and <i>ja</i>, respectively. Language parameters must be passed explicitly for operations that take them.</p>\n "
},
"issueType": {
"shape_name": "IssueType",
"type": "string",
"documentation": "\n <p>Field passed as a parameter in a <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_CreateCase.html\" title=\"CreateCase\">CreateCase</a> call. </p>\n "
}
},
"documentation": "\n \n "
},
"output": {
"shape_name": "CreateCaseResponse",
"type": "structure",
"members": {
"caseId": {
"shape_name": "CaseId",
"type": "string",
"documentation": "\n <p>String that indicates the AWS Support caseID requested or returned in the call. The caseID is an alphanumeric string formatted as shown in this example CaseId: <i>case-12345678910-2013-c4c1d2bf33c5cf47</i></p>\n "
}
},
"documentation": "\n <p>Contains the AWSSupport <i>caseId</i> returned by a successful completion of the <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_CreateCase.html\" title=\"CreateCase\">CreateCase</a> action. </p>\n "
},
"errors": [
{
"shape_name": "InternalServerError",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>Returns HTTP error 500.</p>\n "
}
},
"documentation": "\n <p>Returns HTTP error 500.</p>\n "
},
{
"shape_name": "CaseCreationLimitExceeded",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>Error message that indicates that you have exceeded the number of cases you can have open. </p>\n "
}
},
"documentation": "\n <p>Returned when you have exceeded the case creation limit for an account. </p>\n "
}
],
"documentation": "\n <p>Creates a new case in the AWS Support Center. This action 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>ServiceCode.</b> Represents a code for an AWS service. You obtain the <i>ServiceCode</i> by calling <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_DescribeServices.html\" title=\"DescribeServices\">DescribeServices</a>. </li>\n <li>\n<b>CategoryCode</b>. Represents a category for the service defined for the ServiceCode value. You also obtain the cateogory code for a service by calling <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_DescribeServices.html\" title=\"DescribeServices\">DescribeServices</a>. Each AWS service defines its own set of category codes. </li>\n <li>\n<b>SeverityCode</b>. Represents a value that specifies the urgency of the case, and the time interval in which your service level agreement specifies a response from AWS Support. You obtain the SeverityCode by calling <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_DescribeSeverityLevels.html\" title=\"DescribeSeverityLevels\">DescribeSeverityLevels</a>.</li>\n <li>\n<b>Subject</b>. Represents 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>. Represents 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>Language</b>. Specifies the human language in which AWS Support handles the case. The API currently supports English and Japanese.</li>\n <li>\n<b>CcEmailAddresses</b>. Represents 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/\" title=\"Tools for Amazon Web Services\">AWS SDK</a>. </li>\n <li>\n<b>IssueType</b>. Indicates the type of issue for the case. You can specify either \"customer-service\" or \"technical.\" If you do not indicate a value, this parameter defaults to \"technical.\" </li>\n</ol>\n \n <note>The AWS Support API does not currently support the ability to add attachments to cases. You can, however, call <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_AddCommunicationToCase.html\" title=\"AddCommunicationToCase\">AddCommunicationToCase</a> to add information to an open case. </note>\n \n <p>A successful <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_CreateCase.html\" title=\"CreateCase\">CreateCase</a> request returns an AWS Support case number. Case numbers are used by <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_DescribeCases.html\" title=\"DescribeCases\">DescribeCases</a> request to retrieve existing AWS Support support cases. </p>\n \n \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 Strings comprising ID numbers for support cases you want returned. The maximum number of cases is 100. </p>\n "
},
"displayId": {
"shape_name": "DisplayId",
"type": "string",
"documentation": "\n <p>String that corresponds to the ID value displayed for a case in the AWS Support Center user interface. </p>\n "
},
"afterTime": {
"shape_name": "AfterTime",
"type": "string",
"documentation": "\n <p>Start date for a filtered date search on support case communications.</p>\n "
},
"beforeTime": {
"shape_name": "BeforeTime",
"type": "string",
"documentation": "\n <p>End date for a filtered date search on support case communications.</p>\n "
},
"includeResolvedCases": {
"shape_name": "IncludeResolvedCases",
"type": "boolean",
"documentation": "\n <p>Boolean that indicates whether or not resolved support cases should be listed in the <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_DescribeCases.html\" title=\"DescribeCases\">DescribeCases</a> search.</p>\n "
},
"nextToken": {
"shape_name": "NextToken",
"type": "string",
"documentation": "\n <p>Defines a resumption point for pagination.</p> \n "
},
"maxResults": {
"shape_name": "MaxResults",
"type": "integer",
"min_length": 10,
"max_length": 100,
"documentation": "\n <p>Integer that sets the maximum number of results to return before paginating.</p> \n "
},
"language": {
"shape_name": "Language",
"type": "string",
"documentation": "\n <p>Specifies the ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English and Japanese, for which the codes are <i>en</i> and <i>ja</i>, respectively. Language parameters must be passed explicitly for operations that take them.</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>String that indicates the AWS Support caseID requested or returned in the call. The caseID is an alphanumeric string formatted as shown in this example CaseId: <i>case-12345678910-2013-c4c1d2bf33c5cf47</i></p>\n "
},
"displayId": {
"shape_name": "DisplayId",
"type": "string",
"documentation": "\n <p>Represents the Id value displayed on pages for the case in AWS Support Center. This is a numeric string. </p>\n "
},
"subject": {
"shape_name": "Subject",
"type": "string",
"documentation": "\n <p>Represents the subject line for a support case in the AWS Support Center user interface.</p>\n "
},
"status": {
"shape_name": "Status",
"type": "string",
"documentation": "\n <p>Represents the status of a case submitted to AWS Support. </p>\n "
},
"serviceCode": {
"shape_name": "ServiceCode",
"type": "string",
"documentation": "\n <p>Code for the AWS service returned by the call to <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_DescribeServices.html\" title=\"DescribeServices\">DescribeServices</a>.</p>\n "
},
"categoryCode": {
"shape_name": "CategoryCode",
"type": "string",
"documentation": "\n <p>Specifies the category of problem for the AWS Support case.</p>\n "
},
"severityCode": {
"shape_name": "SeverityCode",
"type": "string",
"documentation": "\n <p>Code for the severity level returned by the call to <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_DescribeSeverityLevels.html\" title=\"DescribeSeverityLevels\">DescribeSeverityLevels</a>.</p>\n "
},
"submittedBy": {
"shape_name": "SubmittedBy",
"type": "string",
"documentation": "\n <p>Represents the email address of the account that submitted the case to support.</p> \n "
},
"timeCreated": {
"shape_name": "TimeCreated",
"type": "string",
"documentation": "\n <p>Time that the case was case created in 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>String that indicates the AWS Support caseID requested or returned in the call. The caseID is an alphanumeric string formatted as shown in this example CaseId: <i>case-12345678910-2013-c4c1d2bf33c5cf47</i></p>\n "
},
"body": {
"shape_name": "CommunicationBody",
"type": "string",
"documentation": "\n <p>Contains the text of the the commmunication between the customer and AWS Support.</p>\n "
},
"submittedBy": {
"shape_name": "SubmittedBy",
"type": "string",
"documentation": "\n <p>Email address of the account that submitted the AWS Support case. </p>\n "
},
"timeCreated": {
"shape_name": "TimeCreated",
"type": "string",
"documentation": "\n <p>Time the support case was created. </p>\n "
}
},
"documentation": "\n <p>Object that exposes the fields used by a communication for an AWS Support case.</p>\n "
},
"documentation": "\n <p>List of <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_Communication.html\" title=\"Communication\">Commmunication</a> objects.</p>\n "
},
"nextToken": {
"shape_name": "NextToken",
"type": "string",
"documentation": "\n <p>Defines a resumption point for pagination.</p>\n "
}
},
"documentation": "\n <p>Returns up to the five most recent communications between you and AWS Support Center. Includes a <i>nextToken</i> to retrieve the next set of communications. </p>\n "
},
"ccEmailAddresses": {
"shape_name": "CcEmailAddressList",
"type": "list",
"members": {
"shape_name": "CcEmailAddress",
"type": "string",
"documentation": null
},
"documentation": "\n <p>List of email addresses that are copied in any communication about the case.</p>\n "
},
"language": {
"shape_name": "Language",
"type": "string",
"documentation": "\n <p> Specifies the ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English and Japanese, for which the codes are <i>en</i> and <i>ja</i>, respectively. Language parameters must be passed explicitly for operations that take them.</p>\n "
}
},
"documentation": "\n <p>JSON-formatted object that contains the metadata for a support case. It is contained the response from a <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_DescribeCases.html\" title=\"DescribeCases\">DescribeCases</a> request. This structure contains the following fields:</p>\n <ol>\n <li>\n<b>CaseID</b>. String that indicates the AWS Support caseID requested or returned in the call. The caseID is an alphanumeric string formatted as shown in this example CaseId: <i>case-12345678910-2013-c4c1d2bf33c5cf47</i></li>\n <li>\n<b>CategoryCode</b>. Specifies the category of problem for the AWS Support case. Corresponds to the CategoryCode values returned by a call to <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_DescribeServices.html\" title=\"DescribeServices\">DescribeServices</a>\n</li>\n <li>\n<b>DisplayId</b>. String that identifies the case on pages in the AWS Support Center</li>\n <li>\n<b>Language</b>. Specifies the ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English and Japanese, for which the codes are <i>en</i> and <i>ja</i>, respectively. Language parameters must be passed explicitly for operations that take them.</li>\n <li>\n<b>RecentCommunications</b>. One ore more <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_Communication.html\" title=\"Communication\">Communication</a> data types. Subfields of these structures are Body, CaseId, SubmittedBy, and TimeCreated.</li> \n <li>\n<b>NextToken</b>. Defines a resumption point for pagination.</li>\n <li>\n<b>ServiceCode</b>. Identifier for the AWS service that corresponds to the service code defined in the call to <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_DescribeCases.html\" title=\"DescribeServices\">DescribeServices</a>\n</li>\n <li>\n<b>SeverityCode. </b>Specifies the severity code assigned to the case. Contains one of the values returned by the call to <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_DescribeSeverityLevels.html\" title=\"DescribeSeverityLevels\">DescribeSeverityLevels</a>\n </li>\n <li>\n<b>Status</b>. Represents the status of your case in the AWS Support Center</li>\n <li>\n<b>Subject</b>. Represents the subject line of the case.</li>\n <li>\n<b>SubmittedBy</b>.Email address of the account that submitted the case.</li>\n <li>\n<b>TimeCreated</b>.Time the case was created, using ISO 8601 format. </li>\n </ol>\n \n "
},
"documentation": "\n Array of <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_CaseDetails.html\" title=\"CaseDetails\">CaseDetails</a> objects. \n "
},
"nextToken": {
"shape_name": "NextToken",
"type": "string",
"documentation": "\n <p>Defines a resumption point for pagination.</p>\n "
}
},
"documentation": "\n <p>Returns an array of <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_CaseDetails.html\" title=\"CaseDetails\">CaseDetails</a> objects and a <i>NextToken</i> 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>Returns HTTP error 500.</p>\n "
}
},
"documentation": "\n <p>Returns HTTP error 500.</p>\n "
},
{
"shape_name": "CaseIdNotFound",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>Error returned when the request does not return a case for the <i>CaseId</i> submitted.</p> \n "
}
},
"documentation": "\n <p>Returned when the <i>CaseId</i> requested could not be located.</p>\n "
}
],
"documentation": "\n <p>This action returns a list of cases that you specify by passing one or more CaseIds. In addition, you can filter the cases by date by setting values for the AfterTime and BeforeTime request parameters. </p>\n \n The response returns the following in JSON format: \n <ol>\n <li>One or more <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_CaseDetails.html\" title=\"CaseDetails\">CaseDetails</a> data types. </li>\n <li>One or more <i>NextToken</i> objects, strings that specifies where to paginate the returned records represented by <i>CaseDetails</i>.</li>\n </ol>\n "
},
"DescribeCommunications": {
"name": "DescribeCommunications",
"input": {
"shape_name": "DescribeCommunicationsRequest",
"type": "structure",
"members": {
"caseId": {
"shape_name": "CaseId",
"type": "string",
"documentation": "\n <p>String that indicates the AWS Support caseID requested or returned in the call. The caseID is an alphanumeric string formatted as shown in this example CaseId: <i>case-12345678910-2013-c4c1d2bf33c5cf47</i></p> \n ",
"required": true
},
"beforeTime": {
"shape_name": "BeforeTime",
"type": "string",
"documentation": "\n <p>End date for a filtered date search on support case communications.</p>\n "
},
"afterTime": {
"shape_name": "AfterTime",
"type": "string",
"documentation": "\n <p>Start date for a filtered date search on support case communications.</p>\n "
},
"nextToken": {
"shape_name": "NextToken",
"type": "string",
"documentation": "\n <p>Defines a resumption point for pagination.</p>\n "
},
"maxResults": {
"shape_name": "MaxResults",
"type": "integer",
"min_length": 10,
"max_length": 100,
"documentation": "\n <p>Integer that sets 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>String that indicates the AWS Support caseID requested or returned in the call. The caseID is an alphanumeric string formatted as shown in this example CaseId: <i>case-12345678910-2013-c4c1d2bf33c5cf47</i></p>\n "
},
"body": {
"shape_name": "CommunicationBody",
"type": "string",
"documentation": "\n <p>Contains the text of the the commmunication between the customer and AWS Support.</p>\n "
},
"submittedBy": {
"shape_name": "SubmittedBy",
"type": "string",
"documentation": "\n <p>Email address of the account that submitted the AWS Support case. </p>\n "
},
"timeCreated": {
"shape_name": "TimeCreated",
"type": "string",
"documentation": "\n <p>Time the support case was created. </p>\n "
}
},
"documentation": "\n <p>Object that exposes the fields used by a communication for an AWS Support case.</p>\n "
},
"documentation": "\n <p>Contains a list of <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_Communication.html\" title=\"Communication\">Communications</a> objects. </p>\n "
},
"nextToken": {
"shape_name": "NextToken",
"type": "string",
"documentation": "\n <p>Defines a resumption point for pagination.</p>\n "
}
},
"documentation": "\n <p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>\n "
},
"errors": [
{
"shape_name": "InternalServerError",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>Returns HTTP error 500.</p>\n "
}
},
"documentation": "\n <p>Returns HTTP error 500.</p>\n "
},
{
"shape_name": "CaseIdNotFound",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>Error returned when the request does not return a case for the <i>CaseId</i> submitted.</p> \n "
}
},
"documentation": "\n <p>Returned when the <i>CaseId</i> requested could not be located.</p>\n "
}
],
"documentation": "\n <p>This action returns communications regarding the support case. You can use the <i>AfterTime</i> and <i>BeforeTime</i> parameters to filter by date. The <i>CaseId</i> parameter enables you to identify a specific case by its <i>CaseId</i> number.</p>\n <p>The <i>MaxResults</i> and <i>NextToken</i> parameters enable you to control the pagination of the result set. Set <i>MaxResults</i> to the number of cases you want displayed on each page, and use <i>NextToken</i> to specify the resumption of pagination.</p>\n "
},
"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>List in JSON format of service codes available for AWS services.</p>\n "
},
"language": {
"shape_name": "Language",
"type": "string",
"documentation": "\n <p>Specifies the ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English and Japanese, for which the codes are <i>en</i> and <i>ja</i>, respectively. 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>JSON-formatted string that represents a code for an AWS service returned by <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_DescribeServices.html\" title=\"DescribeServices\">DescribeServices</a> response. Has a corrsponding name represented by a service.name string.</p>\n "
},
"name": {
"shape_name": "ServiceName",
"type": "string",
"documentation": "\n <p>JSON-formatted string that represents the friendly name for an AWS service. Has a corresponding code reprsented by a Service.code string. </p>\n "
},
"categories": {
"shape_name": "CategoryList",
"type": "list",
"members": {
"shape_name": "Category",
"type": "structure",
"members": {
"code": {
"shape_name": "CategoryCode",
"type": "string",
"documentation": "\n <p>Category code for the support case. </p>\n "
},
"name": {
"shape_name": "CategoryName",
"type": "string",
"documentation": "\n <p>Category name for the support case. </p>\n "
}
},
"documentation": "\n <p>JSON-formatted name/value pair that represents the name and category of problem selected from the <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_DescribeServices.html\" title=\"DescribeServices\">DescribeServices</a> response for each AWS service.</p>\n "
},
"documentation": "\n <p>JSON-formatted list of categories that describe the type of support issue a case describes. Categories are strings that represent a category name and a category code. Category names and codes are passed to AWS Support when you call <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_CreateCase.html\" title=\"CreateCase\">CreateCase</a>.</p>\n "
}
},
"documentation": "\n <p>JSON-formatted object that represents an AWS Service returned by the <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_DescribeServices.html\" title=\"DescribeServices\">DescribeServices</a> action. </p>\n "
},
"documentation": "\n <p>JSON-formatted list of AWS services.</p>\n "
}
},
"documentation": "\n <p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>\n "
},
"errors": [
{
"shape_name": "InternalServerError",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>Returns HTTP error 500.</p>\n "
}
},
"documentation": "\n <p>Returns HTTP error 500.</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 href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_CreateCase.html\" title=\"CreateCase\">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\" title=\"Open a new case\">Open a new case</a> page. The values in those fields, however, do not necessarily match the service codes and categories returned by the <code>DescribeServices</code> request. Always use the service codes and categories obtained 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>Specifies the ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English and Japanese, for which the codes are <i>en</i> and <i>ja</i>, respectively. 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>String that represents one of four values: \"low,\" \"medium,\" \"high,\" and \"urgent\". These values correspond to response times returned to the caller in the string <code>SeverityLevel.name</code>. </p>\n "
},
"name": {
"shape_name": "SeverityLevelName",
"type": "string",
"documentation": "\n <p>Name of severity levels that correspond to the severity level codes. </p>\n "
}
},
"documentation": "\n <p>JSON-formatted pair of strings consisting of a code and name that represent a severity level that can be applied to a support case. </p>\n "
},
"documentation": "\n <p>List of available severity levels for the support case. Available severity levels are defined by your service level agreement with AWS.</p>\n "
}
},
"documentation": "\n <p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>\n "
},
"errors": [
{
"shape_name": "InternalServerError",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>Returns HTTP error 500.</p>\n "
}
},
"documentation": "\n <p>Returns HTTP error 500.</p>\n "
}
],
"documentation": "\n <p>This action 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 href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_CaseDetails.html\" title=\"CaseDetails\">CaseDetails</a> data type included in any <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_CreateCase.html\" title=\"CreateCase\">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>List of the <i>CheckId</i> values for the Trusted Advisor checks for which you want to refresh the status. You obtain the <i>CheckId</i> values by calling <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_DescribeTrustedAdvisorChecks.html\" title=\"DescribeTrustedAdvisorChecks\">DescribeTrustedAdvisorChecks</a>. </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>String that specifies the <i>checkId</i> value of the Trusted Advisor check.</p>\n ",
"required": true
},
"status": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Indicates the status of the Trusted Advisor check for which a refresh has been requested.</p>\n ",
"required": true
},
"millisUntilNextRefreshable": {
"shape_name": "Long",
"type": "long",
"documentation": "\n <p>Indicates the time in milliseconds until a call to <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_RefreshTrustedAdvisorCheck.html\" title=\"RefreshTrustedAdvisorCheck\">RefreshTrustedAdvisorCheck</a> can trigger a refresh. </p>\n ",
"required": true
}
},
"documentation": "\n <p>Contains the fields that indicate the statuses Trusted Advisor checks for which refreshes have been requested. </p>\n "
},
"documentation": "\n <p>List of the statuses of the Trusted Advisor checks you've specified for refresh. Status values are:</p>\n <ul>\n <li>\n<b>in_progress</b>. The refresh of the check is currently executing. </li>\n <li>\n<b>successful</b>. The refresh of the check has completed successfully.</li>\n <li>\n<b>enqueued</b>. The refresh check is queued for execution. </li>\n <li>\n<b>abandoned</b>. An error has prevented the check from refreshing. </li>\n </ul>\n ",
"required": true
}
},
"documentation": "\n <p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>\n "
},
"errors": [
{
"shape_name": "InternalServerError",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>Returns HTTP error 500.</p>\n "
}
},
"documentation": "\n <p>Returns HTTP error 500.</p>\n "
}
],
"documentation": "\n <p>Returns the status of all refresh requests Trusted Advisor checks called using <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_RefreshTrustedAdvisorCheck.html\" title=\"RefreshTrustedAdvisorCheck\">RefreshTrustedAdvisorCheck</a>. </p>\n "
},
"DescribeTrustedAdvisorCheckResult": {
"name": "DescribeTrustedAdvisorCheckResult",
"input": {
"shape_name": "DescribeTrustedAdvisorCheckResultRequest",
"type": "structure",
"members": {
"checkId": {
"shape_name": "String",
"type": "string",
"documentation": " \n ",
"required": true
},
"language": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Specifies the ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English and Japanese, for which the codes are <i>en</i> and <i>ja</i>, respectively. Language parameters must be passed explicitly for operations that take them.</p>\n "
}
},
"documentation": "\n \n "
},
"output": {
"shape_name": "DescribeTrustedAdvisorCheckResultResponse",
"type": "structure",
"members": {
"result": {
"shape_name": "TrustedAdvisorCheckResult",
"type": "structure",
"members": {
"checkId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Unique identifier for a Trusted Advisor check.</p>\n ",
"required": true
},
"timestamp": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Time at which Trusted Advisor ran the check.</p>\n ",
"required": true
},
"status": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Overall status of the check. Status values are \"ok,\" \"warning,\" \"error,\" or \"not_available.\" </p>\n ",
"required": true
},
"resourcesSummary": {
"shape_name": "TrustedAdvisorResourcesSummary",
"type": "structure",
"members": {
"resourcesProcessed": {
"shape_name": "Long",
"type": "long",
"documentation": "\n <p>Reports the number of AWS resources that were analyzed in your Trusted Advisor check.</p>\n ",
"required": true
},
"resourcesFlagged": {
"shape_name": "Long",
"type": "long",
"documentation": "\n <p>Reports the number of AWS resources that were flagged in your Trusted Advisor check.</p>\n ",
"required": true
},
"resourcesIgnored": {
"shape_name": "Long",
"type": "long",
"documentation": "\n <p>Indicates the number of resources ignored by Trusted Advisor due to unavailability of information.</p>\n ",
"required": true
},
"resourcesSuppressed": {
"shape_name": "Long",
"type": "long",
"documentation": "\n <p>Indicates whether the specified AWS resource has had its participation in Trusted Advisor checks suppressed.</p>\n ",
"required": true
}
},
"documentation": "\n <p>JSON-formatted object that lists details about AWS resources that were analyzed in a call to Trusted Advisor <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_DescribeTrustedAdvisorCheckSummaries.html\" title=\"DescribeTrustedAdvisorCheckSummaries\">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>Reports the estimated monthly savings determined by the Trusted Advisor check for your account. </p>\n ",
"required": true
},
"estimatedPercentMonthlySavings": {
"shape_name": "Double",
"type": "double",
"documentation": "\n <p>Reports the estimated percentage of savings determined for your account by the Trusted Advisor check. </p>\n ",
"required": true
}
},
"documentation": "\n <p>Corresponds to the <i>Cost Optimizing</i> tab on the AWS Support Center Trusted Advisor page. This field is only available to checks in the Cost Optimizing category.</p>\n "
}
},
"documentation": "\n <p>Reports summaries for each Trusted Advisor category. Only the category <i>cost optimizing</i> is currently supported. The other categories are security, fault tolerance, and performance. </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>Status code for the resource identified in the Trusted Advisor check.</p>\n ",
"required": true
},
"region": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>AWS region in which the identified resource is located. </p>\n ",
"required": true
},
"resourceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Unique identifier for the identified resource.</p>\n ",
"required": true
},
"isSuppressed": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Indicates whether the specified AWS resource has had its participation in Trusted Advisor checks suppressed.</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 href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_TrustedAdvisorCheckDescription.html\" title=\"TrustedAdvisorCheckDescription\">TrustedAdvisorCheckDescription</a> object returned by the call to <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_DescribeTrustedAdvisorChecks.html\" title=\"DescribeTrustedAdvisorChecks\">DescribeTrustedAdvisorChecks</a>.</p>\n ",
"required": true
}
},
"documentation": "\n <p>Structure that contains information about the resource to which the Trusted Advisor check pertains. </p>\n "
},
"documentation": "\n <p>List of AWS resources flagged by the Trusted Advisor check.</p>\n ",
"required": true
}
},
"documentation": "\n <p>Returns a <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_TrustedAdvisorCheckResult.html\" title=\"TrustedAdvisorCheckResult\">TrustedAdvisorCheckResult</a> object. </p>\n "
}
},
"documentation": "\n <p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>\n "
},
"errors": [
{
"shape_name": "InternalServerError",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>Returns HTTP error 500.</p>\n "
}
},
"documentation": "\n <p>Returns HTTP error 500.</p>\n "
}
],
"documentation": "\n <p>This action responds with the results of a Trusted Advisor check. Once you have obtained the list of available Trusted Advisor checks by calling <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_DescribeTrustedAdvisorChecks.html\" title=\"DescribeTrustedAdvisorChecks\">DescribeTrustedAdvisorChecks</a>, you specify the <i>CheckId</i> for the check you want to retrieve from AWS Support.</p>\n <p>The response for this action contains a JSON-formatted <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_DescribeTrustedAdvisorCheckResultResult.html\" title=\"DescribeTrustedAdvisorCheckResultResult\">TrustedAdvisorCheckResult</a> object</p>, which is a container for the following three objects:<p></p>\n <ol>\n <li><a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_TrustedAdvisorCategorySpecificSummary.html\" title=\"TrustedAdvisorCategorySpecificSummary\">TrustedAdvisorCategorySpecificSummary</a></li>\n <li><a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_TrustedAdvisorResourceDetail.html\" title=\"TrustedAdvisorResourceDetail\">TrustedAdvisorResourceDetail</a></li>\n <li><a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_TrustedAdvisorResourcesSummary.html\" title=\"TrustedAdvisorResourcesSummary\">TrustedAdvisorResourcesSummary</a></li>\n </ol>\n<p>In addition, the response contains the following fields:</p>\n <ol>\n <li>\n<b>Status</b>. Overall status of the check.</li>\n <li>\n<b>Timestamp</b>. Time at which Trusted Advisor last ran the check. </li>\n <li>\n<b>CheckId</b>. Unique identifier for the specific check returned by the request.</li>\n </ol>\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>Unique identifier for a Trusted Advisor check.</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> Unique identifier for a Trusted Advisor check.</p>\n ",
"required": true
},
"timestamp": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p></p>\n ",
"required": true
},
"status": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Overall status of the Trusted Advisor check.</p>\n ",
"required": true
},
"hasFlaggedResources": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Indicates that the Trusted Advisor check returned flagged resources. </p>\n "
},
"resourcesSummary": {
"shape_name": "TrustedAdvisorResourcesSummary",
"type": "structure",
"members": {
"resourcesProcessed": {
"shape_name": "Long",
"type": "long",
"documentation": "\n <p>Reports the number of AWS resources that were analyzed in your Trusted Advisor check.</p>\n ",
"required": true
},
"resourcesFlagged": {
"shape_name": "Long",
"type": "long",
"documentation": "\n <p>Reports the number of AWS resources that were flagged in your Trusted Advisor check.</p>\n ",
"required": true
},
"resourcesIgnored": {
"shape_name": "Long",
"type": "long",
"documentation": "\n <p>Indicates the number of resources ignored by Trusted Advisor due to unavailability of information.</p>\n ",
"required": true
},
"resourcesSuppressed": {
"shape_name": "Long",
"type": "long",
"documentation": "\n <p>Indicates whether the specified AWS resource has had its participation in Trusted Advisor checks suppressed.</p>\n ",
"required": true
}
},
"documentation": "\n <p>JSON-formatted object that lists details about AWS resources that were analyzed in a call to Trusted Advisor <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_DescribeTrustedAdvisorCheckSummaries.html\" title=\"DescribeTrustedAdvisorCheckSummaries\">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>Reports the estimated monthly savings determined by the Trusted Advisor check for your account. </p>\n ",
"required": true
},
"estimatedPercentMonthlySavings": {
"shape_name": "Double",
"type": "double",
"documentation": "\n <p>Reports the estimated percentage of savings determined for your account by the Trusted Advisor check. </p>\n ",
"required": true
}
},
"documentation": "\n <p>Corresponds to the <i>Cost Optimizing</i> tab on the AWS Support Center Trusted Advisor page. This field is only available to checks in the Cost Optimizing category.</p>\n "
}
},
"documentation": "\n <p>Reports the results of a Trusted Advisor check by category. Only <i>Cost Optimizing</i> is currently supported. </p>\n ",
"required": true
}
},
"documentation": "\n <p>Reports a summary of the Trusted Advisor check. This object contains the following child objects that report summary information about specific checks by category and resource: </p>\n <ul>\n <li><a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_TrustedAdvisorCategorySpecificSummary.html\" title=\"TrustedAdvisorCategorySpecificSummary\">TrustedAdvisorCategorySpecificSummary</a></li>\n <li><a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_TrustedAdvisorResourcesSummary.html\" title=\"TrustedAdvisorResourcesSummary\">TrustedAdvisorResourcesSummary</a></li>\n </ul>\n "
},
"documentation": "\n <p>List of <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_TrustedAdvisorCheckSummary.html\" title=\"TrustedAdvisorCheckSummary\">TrustedAdvisorCheckSummary</a> objects returned by the <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_DescribeTrustedAdvisorCheckSummaries.html\" title=\"DescribeTrustedAdvisorCheckSummaries\">DescribeTrustedAdvisorCheckSummaries</a> request.</p>\n ",
"required": true
}
},
"documentation": "\n <p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>\n "
},
"errors": [
{
"shape_name": "InternalServerError",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>Returns HTTP error 500.</p>\n "
}
},
"documentation": "\n <p>Returns HTTP error 500.</p>\n "
}
],
"documentation": "\n <p>This action enables you to get the latest summaries for Trusted Advisor checks that you specify in your request. You submit the list of Trusted Advisor checks for which you want summaries. You obtain these <i>CheckIds</i> by submitting a <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_DescribeTrustedAdvisorChecks.html\" title=\"DescribeTrustedAdvisorChecks\">DescribeTrustedAdvisorChecks</a> request. </p> \n <p>The response body contains an array of <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_TrustedAdvisorCheckSummary.html\" title=\"TrustedAdvisorCheckSummary\">TrustedAdvisorCheckSummary</a> objects. </p>\n \n \n "
},
"DescribeTrustedAdvisorChecks": {
"name": "DescribeTrustedAdvisorChecks",
"input": {
"shape_name": "DescribeTrustedAdvisorChecksRequest",
"type": "structure",
"members": {
"language": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Specifies the ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English and Japanese, for which the codes are <i>en</i> and <i>ja</i>, respectively. 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>Unique identifier for a specific Trusted Advisor check description. </p>\n ",
"required": true
},
"name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Display name for the Trusted Advisor check. Corresponds to the display name for the check in the Trusted Advisor user interface.</p>\n ",
"required": true
},
"description": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Description of the Trusted Advisor check.</p>\n ",
"required": true
},
"category": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Category to which the Trusted Advisor check belongs.</p>\n ",
"required": true
},
"metadata": {
"shape_name": "StringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null
},
"documentation": "\n <p>List of metadata returned in <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_TrustedAdvisorResourceDetail.html\" title=\"TrustedAdvisorResourceDetail\">TrustedAdvisorResourceDetail</a> objects for a Trusted Advisor check.</p>\n ",
"required": true
}
},
"documentation": "\n <p>Description of each check returned by <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_DescribeTrustedAdvisorChecks.html\" title=\"DescribeTrustedAdvisorChecks\">DescribeTrustedAdvisorChecks</a>.</p>\n "
},
"documentation": "\n <p>List of the checks returned by calling <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_DescribeTrustedAdvisorChecks.html\" title=\"DescribeTrustedAdvisorChecks\">DescribeTrustedAdvisorChecks</a></p>\n ",
"required": true
}
},
"documentation": "\n <p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>\n "
},
"errors": [
{
"shape_name": "InternalServerError",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>Returns HTTP error 500.</p>\n "
}
},
"documentation": "\n <p>Returns HTTP error 500.</p>\n "
}
],
"documentation": "\n <p>This action enables you to get a list of the available Trusted Advisor checks. You must specify a language code. English (\"en\") and Japanese (\"jp\") are currently supported. The response contains a list of <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_TrustedAdvisorCheckDescription.html\" title=\"TrustedAdvisorCheckDescription\">TrustedAdvisorCheckDescription</a> objects. </p> \n "
},
"RefreshTrustedAdvisorCheck": {
"name": "RefreshTrustedAdvisorCheck",
"input": {
"shape_name": "RefreshTrustedAdvisorCheckRequest",
"type": "structure",
"members": {
"checkId": {
"shape_name": "String",
"type": "string",
"documentation": "\n \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>String that specifies the <i>checkId</i> value of the Trusted Advisor check.</p>\n ",
"required": true
},
"status": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Indicates the status of the Trusted Advisor check for which a refresh has been requested.</p>\n ",
"required": true
},
"millisUntilNextRefreshable": {
"shape_name": "Long",
"type": "long",
"documentation": "\n <p>Indicates the time in milliseconds until a call to <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_RefreshTrustedAdvisorCheck.html\" title=\"RefreshTrustedAdvisorCheck\">RefreshTrustedAdvisorCheck</a> can trigger a refresh. </p>\n ",
"required": true
}
},
"documentation": "\n <p>Returns the overall status of the <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_RefreshTrustedAdvisorCheck.html\" title=\"RefreshTrustedAdvisorCheck\">RefreshTrustedAdvisorCheck</a> call. </p>\n ",
"required": true
}
},
"documentation": "\n "
},
"errors": [
{
"shape_name": "InternalServerError",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>Returns HTTP error 500.</p>\n "
}
},
"documentation": "\n <p>Returns HTTP error 500.</p>\n "
}
],
"documentation": "\n <p>This action enables you to query the service to request a refresh for a specific Trusted Advisor check. Your request body contains a <i>CheckId</i> for which you are querying. The response body contains a <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_RefreshTrustedAdvisorCheckResult.html\" title=\"RefreshTrustedAdvisorCheckResult\">RefreshTrustedAdvisorCheckResult</a> object containing <i>Status</i> and <i>TimeUntilNextRefresh</i> fields.</p>\n "
},
"ResolveCase": {
"name": "ResolveCase",
"input": {
"shape_name": "ResolveCaseRequest",
"type": "structure",
"members": {
"caseId": {
"shape_name": "CaseId",
"type": "string",
"documentation": "\n <p>String that indicates the AWS Support caseID requested or returned in the call. The caseID is an alphanumeric string formatted as shown in this example CaseId: <i>case-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>Status of the case when the <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_ResolveCase.html\" title=\"ResolveCase\">ResolveCase</a> request was sent.</p>\n "
},
"finalCaseStatus": {
"shape_name": "CaseStatus",
"type": "string",
"documentation": "\n <p>Status of the case after the <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_ResolveCase.html\" title=\"ResolveCase\">ResolveCase</a> request was processed.</p>\n "
}
},
"documentation": "\n <p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>\n "
},
"errors": [
{
"shape_name": "InternalServerError",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>Returns HTTP error 500.</p>\n "
}
},
"documentation": "\n <p>Returns HTTP error 500.</p>\n "
},
{
"shape_name": "CaseIdNotFound",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>Error returned when the request does not return a case for the <i>CaseId</i> submitted.</p> \n "
}
},
"documentation": "\n <p>Returned when the <i>CaseId</i> requested could not be located.</p>\n "
}
],
"documentation": "\n \n <p>Takes a <i>CaseId</i> and returns the initial state of the case along with the state of the case after the call to <a href=\"http://docs.aws.amazon.com/awssupport/latest/APIReference/API_ResolveCase.html\" title=\"ResolveCase\">ResolveCase</a> completed.</p>\n "
}
},
"global_endpoint": "support.us-east-1.amazonaws.com",
"metadata": {
"regions": {
"us-east-1": "https://support.us-east-1.amazonaws.com"
},
"protocols": [
"https"
]
},
"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
}
}
}
}
}
}
}
|