forked from aws/aws-sdk-js
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathsupport-2013-04-15.normal.json
1220 lines (1220 loc) · 59.8 KB
/
support-2013-04-15.normal.json
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
{
"version":"2.0",
"metadata":{
"uid":"support-2013-04-15",
"apiVersion":"2013-04-15",
"endpointPrefix":"support",
"jsonVersion":"1.1",
"protocol":"json",
"serviceFullName":"AWS Support",
"signatureVersion":"v4",
"targetPrefix":"AWSSupport_20130415"
},
"operations":{
"AddAttachmentsToSet":{
"name":"AddAttachmentsToSet",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AddAttachmentsToSetRequest"},
"output":{"shape":"AddAttachmentsToSetResponse"},
"errors":[
{"shape":"InternalServerError"},
{"shape":"AttachmentSetIdNotFound"},
{"shape":"AttachmentSetExpired"},
{"shape":"AttachmentSetSizeLimitExceeded"},
{"shape":"AttachmentLimitExceeded"}
],
"documentation":"<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> <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>"
},
"AddCommunicationToCase":{
"name":"AddCommunicationToCase",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AddCommunicationToCaseRequest"},
"output":{"shape":"AddCommunicationToCaseResponse"},
"errors":[
{"shape":"InternalServerError"},
{"shape":"CaseIdNotFound"},
{"shape":"AttachmentSetIdNotFound"},
{"shape":"AttachmentSetExpired"}
],
"documentation":"<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> <p>The response indicates the success or failure of the request.</p> <p>This operation implements a subset of the features of the AWS Support Center.</p>"
},
"CreateCase":{
"name":"CreateCase",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateCaseRequest"},
"output":{"shape":"CreateCaseResponse"},
"errors":[
{"shape":"InternalServerError"},
{"shape":"CaseCreationLimitExceeded"},
{"shape":"AttachmentSetIdNotFound"},
{"shape":"AttachmentSetExpired"}
],
"documentation":"<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://console.aws.amazon.com/support/home#/case/create\">Create Case</a> page. Its parameters require you to specify the following information: </p> <ul> <li> <p> <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.\" </p> </li> <li> <p> <b>serviceCode.</b> The code for an AWS service. You obtain the <code>serviceCode</code> by calling <a>DescribeServices</a>. </p> </li> <li> <p> <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. </p> </li> <li> <p> <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>.</p> </li> <li> <p> <b>subject.</b> The <b>Subject</b> field on the AWS Support Center <a href=\"https://console.aws.amazon.com/support/home#/case/create\">Create Case</a> page.</p> </li> <li> <p> <b>communicationBody.</b> The <b>Description</b> field on the AWS Support Center <a href=\"https://console.aws.amazon.com/support/home#/case/create\">Create Case</a> page.</p> </li> <li> <p> <b>attachmentSetId.</b> The ID of a set of attachments that has been created by using <a>AddAttachmentsToSet</a>.</p> </li> <li> <p> <b>language.</b> The human language in which AWS Support handles the case. English and Japanese are currently supported.</p> </li> <li> <p> <b>ccEmailAddresses.</b> The AWS Support Center <b>CC</b> field on the <a href=\"https://console.aws.amazon.com/support/home#/case/create\">Create 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>. </p> </li> </ul> <note> <p>To add additional communication or attachments to an existing case, use <a>AddCommunicationToCase</a>.</p> </note> <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>"
},
"DescribeAttachment":{
"name":"DescribeAttachment",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeAttachmentRequest"},
"output":{"shape":"DescribeAttachmentResponse"},
"errors":[
{"shape":"InternalServerError"},
{"shape":"DescribeAttachmentLimitExceeded"},
{"shape":"AttachmentIdNotFound"}
],
"documentation":"<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>"
},
"DescribeCases":{
"name":"DescribeCases",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeCasesRequest"},
"output":{"shape":"DescribeCasesResponse"},
"errors":[
{"shape":"InternalServerError"},
{"shape":"CaseIdNotFound"}
],
"documentation":"<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. You can set values for the <code>includeResolvedCases</code> and <code>includeCommunications</code> request parameters to control how much information is returned. </p> <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> <p>The response returns the following in JSON format:</p> <ul> <li> <p>One or more <a>CaseDetails</a> data types. </p> </li> <li> <p>One or more <code>nextToken</code> values, which specify where to paginate the returned records represented by the <code>CaseDetails</code> objects.</p> </li> </ul>"
},
"DescribeCommunications":{
"name":"DescribeCommunications",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeCommunicationsRequest"},
"output":{"shape":"DescribeCommunicationsResponse"},
"errors":[
{"shape":"InternalServerError"},
{"shape":"CaseIdNotFound"}
],
"documentation":"<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> <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> <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>"
},
"DescribeServices":{
"name":"DescribeServices",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeServicesRequest"},
"output":{"shape":"DescribeServicesResponse"},
"errors":[
{"shape":"InternalServerError"}
],
"documentation":"<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> <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://console.aws.amazon.com/support/home#/case/create\">Create 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>"
},
"DescribeSeverityLevels":{
"name":"DescribeSeverityLevels",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeSeverityLevelsRequest"},
"output":{"shape":"DescribeSeverityLevelsResponse"},
"errors":[
{"shape":"InternalServerError"}
],
"documentation":"<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>"
},
"DescribeTrustedAdvisorCheckRefreshStatuses":{
"name":"DescribeTrustedAdvisorCheckRefreshStatuses",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeTrustedAdvisorCheckRefreshStatusesRequest"},
"output":{"shape":"DescribeTrustedAdvisorCheckRefreshStatusesResponse"},
"errors":[
{"shape":"InternalServerError"}
],
"documentation":"<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> <note> <p>Some checks are refreshed automatically, and their refresh statuses cannot be retrieved by using this operation. Use of the <code>DescribeTrustedAdvisorCheckRefreshStatuses</code> operation for these checks causes an <code>InvalidParameterValue</code> error.</p> </note>"
},
"DescribeTrustedAdvisorCheckResult":{
"name":"DescribeTrustedAdvisorCheckResult",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeTrustedAdvisorCheckResultRequest"},
"output":{"shape":"DescribeTrustedAdvisorCheckResultResponse"},
"errors":[
{"shape":"InternalServerError"}
],
"documentation":"<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> <p>The response contains a <a>TrustedAdvisorCheckResult</a> object, which contains these three objects:</p> <ul> <li> <p> <a>TrustedAdvisorCategorySpecificSummary</a> </p> </li> <li> <p> <a>TrustedAdvisorResourceDetail</a> </p> </li> <li> <p> <a>TrustedAdvisorResourcesSummary</a> </p> </li> </ul> <p>In addition, the response contains these fields:</p> <ul> <li> <p> <b>status.</b> The alert status of the check: \"ok\" (green), \"warning\" (yellow), \"error\" (red), or \"not_available\".</p> </li> <li> <p> <b>timestamp.</b> The time of the last refresh of the check.</p> </li> <li> <p> <b>checkId.</b> The unique identifier for the check.</p> </li> </ul>"
},
"DescribeTrustedAdvisorCheckSummaries":{
"name":"DescribeTrustedAdvisorCheckSummaries",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeTrustedAdvisorCheckSummariesRequest"},
"output":{"shape":"DescribeTrustedAdvisorCheckSummariesResponse"},
"errors":[
{"shape":"InternalServerError"}
],
"documentation":"<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> <p>The response contains an array of <a>TrustedAdvisorCheckSummary</a> objects.</p>"
},
"DescribeTrustedAdvisorChecks":{
"name":"DescribeTrustedAdvisorChecks",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeTrustedAdvisorChecksRequest"},
"output":{"shape":"DescribeTrustedAdvisorChecksResponse"},
"errors":[
{"shape":"InternalServerError"}
],
"documentation":"<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>"
},
"RefreshTrustedAdvisorCheck":{
"name":"RefreshTrustedAdvisorCheck",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RefreshTrustedAdvisorCheckRequest"},
"output":{"shape":"RefreshTrustedAdvisorCheckResponse"},
"errors":[
{"shape":"InternalServerError"}
],
"documentation":"<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> <note> <p>Some checks are refreshed automatically, and they cannot be refreshed by using this operation. Use of the <code>RefreshTrustedAdvisorCheck</code> operation for these checks causes an <code>InvalidParameterValue</code> error.</p> </note> <p>The response contains a <a>TrustedAdvisorCheckRefreshStatus</a> object, which contains these fields:</p> <ul> <li> <p> <b>status.</b> The refresh status of the check: \"none\", \"enqueued\", \"processing\", \"success\", or \"abandoned\".</p> </li> <li> <p> <b>millisUntilNextRefreshable.</b> The amount of time, in milliseconds, until the check is eligible for refresh.</p> </li> <li> <p> <b>checkId.</b> The unique identifier for the check.</p> </li> </ul>"
},
"ResolveCase":{
"name":"ResolveCase",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ResolveCaseRequest"},
"output":{"shape":"ResolveCaseResponse"},
"errors":[
{"shape":"InternalServerError"},
{"shape":"CaseIdNotFound"}
],
"documentation":"<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>"
}
},
"shapes":{
"AddAttachmentsToSetRequest":{
"type":"structure",
"required":["attachments"],
"members":{
"attachmentSetId":{
"shape":"AttachmentSetId",
"documentation":"<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>"
},
"attachments":{
"shape":"Attachments",
"documentation":"<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>"
}
},
"documentation":"<p/>"
},
"AddAttachmentsToSetResponse":{
"type":"structure",
"members":{
"attachmentSetId":{
"shape":"AttachmentSetId",
"documentation":"<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>"
},
"expiryTime":{
"shape":"ExpiryTime",
"documentation":"<p>The time and date when the attachment set expires.</p>"
}
},
"documentation":"<p>The ID and expiry time of the attachment set returned by the <a>AddAttachmentsToSet</a> operation.</p>"
},
"AddCommunicationToCaseRequest":{
"type":"structure",
"required":["communicationBody"],
"members":{
"caseId":{
"shape":"CaseId",
"documentation":"<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>"
},
"communicationBody":{
"shape":"CommunicationBody",
"documentation":"<p>The body of an email communication to add to the support case.</p>"
},
"ccEmailAddresses":{
"shape":"CcEmailAddressList",
"documentation":"<p>The email addresses in the CC line of an email to be added to the support case.</p>"
},
"attachmentSetId":{
"shape":"AttachmentSetId",
"documentation":"<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>"
}
},
"documentation":"<p>To be written.</p>"
},
"AddCommunicationToCaseResponse":{
"type":"structure",
"members":{
"result":{
"shape":"Result",
"documentation":"<p>True if <a>AddCommunicationToCase</a> succeeds. Otherwise, returns an error.</p>"
}
},
"documentation":"<p>The result of the <a>AddCommunicationToCase</a> operation.</p>"
},
"AfterTime":{"type":"string"},
"Attachment":{
"type":"structure",
"members":{
"fileName":{
"shape":"FileName",
"documentation":"<p>The name of the attachment file.</p>"
},
"data":{
"shape":"Data",
"documentation":"<p>The content of the attachment file.</p>"
}
},
"documentation":"<p>An attachment to a case communication. The attachment consists of the file name and the content of the file.</p>"
},
"AttachmentDetails":{
"type":"structure",
"members":{
"attachmentId":{
"shape":"AttachmentId",
"documentation":"<p>The ID of the attachment.</p>"
},
"fileName":{
"shape":"FileName",
"documentation":"<p>The file name of the attachment.</p>"
}
},
"documentation":"<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>"
},
"AttachmentId":{"type":"string"},
"AttachmentIdNotFound":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"<p>An attachment with the specified ID could not be found.</p>"
}
},
"documentation":"<p>An attachment with the specified ID could not be found.</p>",
"exception":true
},
"AttachmentLimitExceeded":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"<p>The limit for the number of attachment sets created in a short period of time has been exceeded.</p>"
}
},
"documentation":"<p>The limit for the number of attachment sets created in a short period of time has been exceeded.</p>",
"exception":true
},
"AttachmentSet":{
"type":"list",
"member":{"shape":"AttachmentDetails"}
},
"AttachmentSetExpired":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"<p>The expiration time of the attachment set has passed. The set expires 1 hour after it is created.</p>"
}
},
"documentation":"<p>The expiration time of the attachment set has passed. The set expires 1 hour after it is created.</p>",
"exception":true
},
"AttachmentSetId":{"type":"string"},
"AttachmentSetIdNotFound":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"<p>An attachment set with the specified ID could not be found.</p>"
}
},
"documentation":"<p>An attachment set with the specified ID could not be found.</p>",
"exception":true
},
"AttachmentSetSizeLimitExceeded":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"<p>A limit for the size of an attachment set has been exceeded. The limits are 3 attachments and 5 MB per attachment.</p>"
}
},
"documentation":"<p>A limit for the size of an attachment set has been exceeded. The limits are 3 attachments and 5 MB per attachment.</p>",
"exception":true
},
"Attachments":{
"type":"list",
"member":{"shape":"Attachment"}
},
"BeforeTime":{"type":"string"},
"Boolean":{"type":"boolean"},
"CaseCreationLimitExceeded":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"<p>An error message that indicates that you have exceeded the number of cases you can have open.</p>"
}
},
"documentation":"<p>The case creation limit for the account has been exceeded.</p>",
"exception":true
},
"CaseDetails":{
"type":"structure",
"members":{
"caseId":{
"shape":"CaseId",
"documentation":"<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>"
},
"displayId":{
"shape":"DisplayId",
"documentation":"<p>The ID displayed for the case in the AWS Support Center. This is a numeric string.</p>"
},
"subject":{
"shape":"Subject",
"documentation":"<p>The subject line for the case in the AWS Support Center.</p>"
},
"status":{
"shape":"Status",
"documentation":"<p>The status of the case.</p>"
},
"serviceCode":{
"shape":"ServiceCode",
"documentation":"<p>The code for the AWS service returned by the call to <a>DescribeServices</a>.</p>"
},
"categoryCode":{
"shape":"CategoryCode",
"documentation":"<p>The category of problem for the AWS Support case.</p>"
},
"severityCode":{
"shape":"SeverityCode",
"documentation":"<p>The code for the severity level returned by the call to <a>DescribeSeverityLevels</a>.</p>"
},
"submittedBy":{
"shape":"SubmittedBy",
"documentation":"<p>The email address of the account that submitted the case.</p>"
},
"timeCreated":{
"shape":"TimeCreated",
"documentation":"<p>The time that the case was case created in the AWS Support Center.</p>"
},
"recentCommunications":{
"shape":"RecentCaseCommunications",
"documentation":"<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>"
},
"ccEmailAddresses":{
"shape":"CcEmailAddressList",
"documentation":"<p>The email addresses that receive copies of communication about the case.</p>"
},
"language":{
"shape":"Language",
"documentation":"<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>"
}
},
"documentation":"<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> <ul> <li> <p> <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>.</p> </li> <li> <p> <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>.</p> </li> <li> <p> <b>displayId.</b> The identifier for the case on pages in the AWS Support Center.</p> </li> <li> <p> <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.</p> </li> <li> <p> <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>.</p> </li> <li> <p> <b>nextToken.</b> A resumption point for pagination.</p> </li> <li> <p> <b>serviceCode.</b> The identifier for the AWS service that corresponds to the service code defined in the call to <a>DescribeServices</a>.</p> </li> <li> <p> <b>severityCode. </b>The severity code assigned to the case. Contains one of the values returned by the call to <a>DescribeSeverityLevels</a>.</p> </li> <li> <p> <b>status.</b> The status of the case in the AWS Support Center.</p> </li> <li> <p> <b>subject.</b> The subject line of the case.</p> </li> <li> <p> <b>submittedBy.</b> The email address of the account that submitted the case.</p> </li> <li> <p> <b>timeCreated.</b> The time the case was created, in ISO-8601 format.</p> </li> </ul>"
},
"CaseId":{"type":"string"},
"CaseIdList":{
"type":"list",
"member":{"shape":"CaseId"},
"max":100,
"min":0
},
"CaseIdNotFound":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"<p>The requested <code>CaseId</code> could not be located.</p>"
}
},
"documentation":"<p>The requested <code>caseId</code> could not be located.</p>",
"exception":true
},
"CaseList":{
"type":"list",
"member":{"shape":"CaseDetails"}
},
"CaseStatus":{"type":"string"},
"Category":{
"type":"structure",
"members":{
"code":{
"shape":"CategoryCode",
"documentation":"<p>The category code for the support case.</p>"
},
"name":{
"shape":"CategoryName",
"documentation":"<p>The category name for the support case.</p>"
}
},
"documentation":"<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>"
},
"CategoryCode":{"type":"string"},
"CategoryList":{
"type":"list",
"member":{"shape":"Category"}
},
"CategoryName":{"type":"string"},
"CcEmailAddress":{"type":"string"},
"CcEmailAddressList":{
"type":"list",
"member":{"shape":"CcEmailAddress"},
"max":10,
"min":0
},
"Communication":{
"type":"structure",
"members":{
"caseId":{
"shape":"CaseId",
"documentation":"<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>"
},
"body":{
"shape":"CommunicationBody",
"documentation":"<p>The text of the communication between the customer and AWS Support.</p>"
},
"submittedBy":{
"shape":"SubmittedBy",
"documentation":"<p>The email address of the account that submitted the AWS Support case.</p>"
},
"timeCreated":{
"shape":"TimeCreated",
"documentation":"<p>The time the communication was created.</p>"
},
"attachmentSet":{
"shape":"AttachmentSet",
"documentation":"<p>Information about the attachments to the case communication.</p>"
}
},
"documentation":"<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>"
},
"CommunicationBody":{
"type":"string",
"max":8000,
"min":1
},
"CommunicationList":{
"type":"list",
"member":{"shape":"Communication"}
},
"CreateCaseRequest":{
"type":"structure",
"required":[
"subject",
"communicationBody"
],
"members":{
"subject":{
"shape":"Subject",
"documentation":"<p>The title of the AWS Support case.</p>"
},
"serviceCode":{
"shape":"ServiceCode",
"documentation":"<p>The code for the AWS service returned by the call to <a>DescribeServices</a>.</p>"
},
"severityCode":{
"shape":"SeverityCode",
"documentation":"<p>The code for the severity level returned by the call to <a>DescribeSeverityLevels</a>.</p> <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>"
},
"categoryCode":{
"shape":"CategoryCode",
"documentation":"<p>The category of problem for the AWS Support case.</p>"
},
"communicationBody":{
"shape":"CommunicationBody",
"documentation":"<p>The communication body text when you create an AWS Support case by calling <a>CreateCase</a>.</p>"
},
"ccEmailAddresses":{
"shape":"CcEmailAddressList",
"documentation":"<p>A list of email addresses that AWS Support copies on case correspondence.</p>"
},
"language":{
"shape":"Language",
"documentation":"<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>"
},
"issueType":{
"shape":"IssueType",
"documentation":"<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>"
},
"attachmentSetId":{
"shape":"AttachmentSetId",
"documentation":"<p>The ID of a set of one or more attachments for the case. Create the set by using <a>AddAttachmentsToSet</a>.</p>"
}
},
"documentation":"<p/>"
},
"CreateCaseResponse":{
"type":"structure",
"members":{
"caseId":{
"shape":"CaseId",
"documentation":"<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>"
}
},
"documentation":"<p>The AWS Support case ID returned by a successful completion of the <a>CreateCase</a> operation. </p>"
},
"Data":{"type":"blob"},
"DescribeAttachmentLimitExceeded":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"<p>The limit for the number of <a>DescribeAttachment</a> requests in a short period of time has been exceeded.</p>"
}
},
"documentation":"<p>The limit for the number of <a>DescribeAttachment</a> requests in a short period of time has been exceeded.</p>",
"exception":true
},
"DescribeAttachmentRequest":{
"type":"structure",
"required":["attachmentId"],
"members":{
"attachmentId":{
"shape":"AttachmentId",
"documentation":"<p>The ID of the attachment to return. Attachment IDs are returned by the <a>DescribeCommunications</a> operation.</p>"
}
}
},
"DescribeAttachmentResponse":{
"type":"structure",
"members":{
"attachment":{
"shape":"Attachment",
"documentation":"<p>The attachment content and file name.</p>"
}
},
"documentation":"<p>The content and file name of the attachment returned by the <a>DescribeAttachment</a> operation.</p>"
},
"DescribeCasesRequest":{
"type":"structure",
"members":{
"caseIdList":{
"shape":"CaseIdList",
"documentation":"<p>A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.</p>"
},
"displayId":{
"shape":"DisplayId",
"documentation":"<p>The ID displayed for a case in the AWS Support Center user interface.</p>"
},
"afterTime":{
"shape":"AfterTime",
"documentation":"<p>The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.</p>"
},
"beforeTime":{
"shape":"BeforeTime",
"documentation":"<p>The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.</p>"
},
"includeResolvedCases":{
"shape":"IncludeResolvedCases",
"documentation":"<p>Specifies whether resolved support cases should be included in the <a>DescribeCases</a> results. The default is <i>false</i>.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>A resumption point for pagination.</p>"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return before paginating.</p>"
},
"language":{
"shape":"Language",
"documentation":"<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>"
},
"includeCommunications":{
"shape":"IncludeCommunications",
"documentation":"<p>Specifies whether communications should be included in the <a>DescribeCases</a> results. The default is <i>true</i>.</p>"
}
},
"documentation":"<p/>"
},
"DescribeCasesResponse":{
"type":"structure",
"members":{
"cases":{
"shape":"CaseList",
"documentation":"<p>The details for the cases that match the request.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>A resumption point for pagination.</p>"
}
},
"documentation":"<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>"
},
"DescribeCommunicationsRequest":{
"type":"structure",
"required":["caseId"],
"members":{
"caseId":{
"shape":"CaseId",
"documentation":"<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>"
},
"beforeTime":{
"shape":"BeforeTime",
"documentation":"<p>The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.</p>"
},
"afterTime":{
"shape":"AfterTime",
"documentation":"<p>The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>A resumption point for pagination.</p>"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return before paginating.</p>"
}
},
"documentation":"<p/>"
},
"DescribeCommunicationsResponse":{
"type":"structure",
"members":{
"communications":{
"shape":"CommunicationList",
"documentation":"<p>The communications for the case.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>A resumption point for pagination.</p>"
}
},
"documentation":"<p>The communications returned by the <a>DescribeCommunications</a> operation.</p>"
},
"DescribeServicesRequest":{
"type":"structure",
"members":{
"serviceCodeList":{
"shape":"ServiceCodeList",
"documentation":"<p>A JSON-formatted list of service codes available for AWS services.</p>"
},
"language":{
"shape":"Language",
"documentation":"<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>"
}
},
"documentation":"<p/>"
},
"DescribeServicesResponse":{
"type":"structure",
"members":{
"services":{
"shape":"ServiceList",
"documentation":"<p>A JSON-formatted list of AWS services.</p>"
}
},
"documentation":"<p>The list of AWS services returned by the <a>DescribeServices</a> operation.</p>"
},
"DescribeSeverityLevelsRequest":{
"type":"structure",
"members":{
"language":{
"shape":"Language",
"documentation":"<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>"
}
},
"documentation":"<p/>"
},
"DescribeSeverityLevelsResponse":{
"type":"structure",
"members":{
"severityLevels":{
"shape":"SeverityLevelsList",
"documentation":"<p>The available severity levels for the support case. Available severity levels are defined by your service level agreement with AWS.</p>"
}
},
"documentation":"<p>The list of severity levels returned by the <a>DescribeSeverityLevels</a> operation.</p>"
},
"DescribeTrustedAdvisorCheckRefreshStatusesRequest":{
"type":"structure",
"required":["checkIds"],
"members":{
"checkIds":{
"shape":"StringList",
"documentation":"<p>The IDs of the Trusted Advisor checks to get the status of. <b>Note:</b> Specifying the check ID of a check that is automatically refreshed causes an <code>InvalidParameterValue</code> error.</p>"
}
},
"documentation":"<p/>"
},
"DescribeTrustedAdvisorCheckRefreshStatusesResponse":{
"type":"structure",
"required":["statuses"],
"members":{
"statuses":{
"shape":"TrustedAdvisorCheckRefreshStatusList",
"documentation":"<p>The refresh status of the specified Trusted Advisor checks.</p>"
}
},
"documentation":"<p>The statuses of the Trusted Advisor checks returned by the <a>DescribeTrustedAdvisorCheckRefreshStatuses</a> operation.</p>"
},
"DescribeTrustedAdvisorCheckResultRequest":{
"type":"structure",
"required":["checkId"],
"members":{
"checkId":{
"shape":"String",
"documentation":"<p>The unique identifier for the Trusted Advisor check.</p>"
},
"language":{
"shape":"String",
"documentation":"<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>"
}
},
"documentation":"<p/>"
},
"DescribeTrustedAdvisorCheckResultResponse":{
"type":"structure",
"members":{
"result":{
"shape":"TrustedAdvisorCheckResult",
"documentation":"<p>The detailed results of the Trusted Advisor check.</p>"
}
},
"documentation":"<p>The result of the Trusted Advisor check returned by the <a>DescribeTrustedAdvisorCheckResult</a> operation.</p>"
},
"DescribeTrustedAdvisorCheckSummariesRequest":{
"type":"structure",
"required":["checkIds"],
"members":{
"checkIds":{
"shape":"StringList",
"documentation":"<p>The IDs of the Trusted Advisor checks.</p>"
}
},
"documentation":"<p/>"
},
"DescribeTrustedAdvisorCheckSummariesResponse":{
"type":"structure",
"required":["summaries"],
"members":{
"summaries":{
"shape":"TrustedAdvisorCheckSummaryList",
"documentation":"<p>The summary information for the requested Trusted Advisor checks.</p>"
}
},
"documentation":"<p>The summaries of the Trusted Advisor checks returned by the <a>DescribeTrustedAdvisorCheckSummaries</a> operation.</p>"
},
"DescribeTrustedAdvisorChecksRequest":{
"type":"structure",
"required":["language"],
"members":{
"language":{
"shape":"String",
"documentation":"<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>"
}
},
"documentation":"<p/>"
},
"DescribeTrustedAdvisorChecksResponse":{
"type":"structure",
"required":["checks"],
"members":{
"checks":{
"shape":"TrustedAdvisorCheckList",
"documentation":"<p>Information about all available Trusted Advisor checks.</p>"
}
},
"documentation":"<p>Information about the Trusted Advisor checks returned by the <a>DescribeTrustedAdvisorChecks</a> operation.</p>"
},
"DisplayId":{"type":"string"},
"Double":{"type":"double"},
"ErrorMessage":{"type":"string"},
"ExpiryTime":{"type":"string"},
"FileName":{"type":"string"},
"IncludeCommunications":{"type":"boolean"},
"IncludeResolvedCases":{"type":"boolean"},
"InternalServerError":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"<p>An internal server error occurred.</p>"
}
},
"documentation":"<p>An internal server error occurred.</p>",
"exception":true,
"fault":true
},
"IssueType":{"type":"string"},
"Language":{"type":"string"},
"Long":{"type":"long"},
"MaxResults":{
"type":"integer",
"max":100,
"min":10
},
"NextToken":{"type":"string"},
"RecentCaseCommunications":{
"type":"structure",
"members":{
"communications":{
"shape":"CommunicationList",
"documentation":"<p>The five most recent communications associated with the case.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>A resumption point for pagination.</p>"
}
},
"documentation":"<p>The five most recent communications associated with the case.</p>"
},
"RefreshTrustedAdvisorCheckRequest":{
"type":"structure",
"required":["checkId"],
"members":{
"checkId":{
"shape":"String",
"documentation":"<p>The unique identifier for the Trusted Advisor check to refresh. <b>Note:</b> Specifying the check ID of a check that is automatically refreshed causes an <code>InvalidParameterValue</code> error.</p>"
}
},
"documentation":"<p/>"
},
"RefreshTrustedAdvisorCheckResponse":{
"type":"structure",
"required":["status"],
"members":{
"status":{
"shape":"TrustedAdvisorCheckRefreshStatus",
"documentation":"<p>The current refresh status for a check, including the amount of time until the check is eligible for refresh.</p>"
}
},
"documentation":"<p>The current refresh status of a Trusted Advisor check.</p>"
},
"ResolveCaseRequest":{
"type":"structure",
"members":{
"caseId":{
"shape":"CaseId",
"documentation":"<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>"
}
},
"documentation":"<p/>"
},
"ResolveCaseResponse":{
"type":"structure",
"members":{
"initialCaseStatus":{
"shape":"CaseStatus",
"documentation":"<p>The status of the case when the <a>ResolveCase</a> request was sent.</p>"
},
"finalCaseStatus":{
"shape":"CaseStatus",
"documentation":"<p>The status of the case after the <a>ResolveCase</a> request was processed.</p>"
}
},
"documentation":"<p>The status of the case returned by the <a>ResolveCase</a> operation.</p>"
},
"Result":{"type":"boolean"},
"Service":{
"type":"structure",
"members":{
"code":{
"shape":"ServiceCode",
"documentation":"<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>"
},
"name":{
"shape":"ServiceName",
"documentation":"<p>The friendly name for an AWS service. The <code>code</code> element contains the corresponding code.</p>"
},
"categories":{
"shape":"CategoryList",
"documentation":"<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>"
}
},
"documentation":"<p>Information about an AWS service returned by the <a>DescribeServices</a> operation. </p>"
},
"ServiceCode":{"type":"string"},
"ServiceCodeList":{
"type":"list",
"member":{"shape":"ServiceCode"},
"max":100,
"min":0
},
"ServiceList":{
"type":"list",
"member":{"shape":"Service"}
},
"ServiceName":{"type":"string"},
"SeverityCode":{"type":"string"},
"SeverityLevel":{
"type":"structure",
"members":{
"code":{
"shape":"SeverityLevelCode",
"documentation":"<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>"
},
"name":{
"shape":"SeverityLevelName",
"documentation":"<p>The name of the severity level that corresponds to the severity level code.</p>"
}
},
"documentation":"<p>A code and name pair that represent a severity level that can be applied to a support case.</p>"
},
"SeverityLevelCode":{"type":"string"},
"SeverityLevelName":{"type":"string"},
"SeverityLevelsList":{
"type":"list",
"member":{"shape":"SeverityLevel"}
},
"Status":{"type":"string"},
"String":{"type":"string"},
"StringList":{
"type":"list",
"member":{"shape":"String"}
},
"Subject":{"type":"string"},
"SubmittedBy":{"type":"string"},
"TimeCreated":{"type":"string"},
"TrustedAdvisorCategorySpecificSummary":{
"type":"structure",
"members":{
"costOptimizing":{
"shape":"TrustedAdvisorCostOptimizingSummary",
"documentation":"<p>The summary information about cost savings for a Trusted Advisor check that is in the Cost Optimizing category.</p>"
}
},
"documentation":"<p>The container for summary information that relates to the category of the Trusted Advisor check.</p>"
},
"TrustedAdvisorCheckDescription":{