@aws-sdk/client-support 3.379.1 → 3.385.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -7,10 +7,12 @@ import { SupportServiceException as __BaseException } from "./SupportServiceExce
7
7
  */
8
8
  export interface Attachment {
9
9
  /**
10
+ * @public
10
11
  * <p>The name of the attachment file.</p>
11
12
  */
12
13
  fileName?: string;
13
14
  /**
15
+ * @public
14
16
  * <p>The content of the attachment file.</p>
15
17
  */
16
18
  data?: Uint8Array;
@@ -20,6 +22,7 @@ export interface Attachment {
20
22
  */
21
23
  export interface AddAttachmentsToSetRequest {
22
24
  /**
25
+ * @public
23
26
  * <p>The ID of the attachment set. If an <code>attachmentSetId</code> is not specified, a
24
27
  * new attachment set is created, and the ID of the set is returned in the response. If an
25
28
  * <code>attachmentSetId</code> is specified, the attachments are added to the
@@ -27,6 +30,7 @@ export interface AddAttachmentsToSetRequest {
27
30
  */
28
31
  attachmentSetId?: string;
29
32
  /**
33
+ * @public
30
34
  * <p>One or more attachments to add to the set. You can add up to three attachments per
31
35
  * set. The size limit is 5 MB per attachment.</p>
32
36
  * <p>In the <code>Attachment</code> object, use the <code>data</code> parameter to specify
@@ -43,6 +47,7 @@ export interface AddAttachmentsToSetRequest {
43
47
  */
44
48
  export interface AddAttachmentsToSetResponse {
45
49
  /**
50
+ * @public
46
51
  * <p>The ID of the attachment set. If an <code>attachmentSetId</code> was not specified, a
47
52
  * new attachment set is created, and the ID of the set is returned in the response. If an
48
53
  * <code>attachmentSetId</code> was specified, the attachments are added to the
@@ -50,6 +55,7 @@ export interface AddAttachmentsToSetResponse {
50
55
  */
51
56
  attachmentSetId?: string;
52
57
  /**
58
+ * @public
53
59
  * <p>The time and date when the attachment set expires.</p>
54
60
  */
55
61
  expiryTime?: string;
@@ -122,6 +128,7 @@ export declare class InternalServerError extends __BaseException {
122
128
  */
123
129
  export interface AddCommunicationToCaseRequest {
124
130
  /**
131
+ * @public
125
132
  * <p>The support case ID requested or returned in the call. The case ID is an alphanumeric
126
133
  * string formatted as shown in this example:
127
134
  * case-<i>12345678910-2013-c4c1d2bf33c5cf47</i>
@@ -129,14 +136,17 @@ export interface AddCommunicationToCaseRequest {
129
136
  */
130
137
  caseId?: string;
131
138
  /**
139
+ * @public
132
140
  * <p>The body of an email communication to add to the support case.</p>
133
141
  */
134
142
  communicationBody: string | undefined;
135
143
  /**
144
+ * @public
136
145
  * <p>The email addresses in the CC line of an email to be added to the support case.</p>
137
146
  */
138
147
  ccEmailAddresses?: string[];
139
148
  /**
149
+ * @public
140
150
  * <p>The ID of a set of one or more attachments for the communication to add to the case.
141
151
  * Create the set by calling <a>AddAttachmentsToSet</a>
142
152
  * </p>
@@ -149,6 +159,7 @@ export interface AddCommunicationToCaseRequest {
149
159
  */
150
160
  export interface AddCommunicationToCaseResponse {
151
161
  /**
162
+ * @public
152
163
  * <p>True if <a>AddCommunicationToCase</a> succeeds. Otherwise, returns an
153
164
  * error.</p>
154
165
  */
@@ -173,10 +184,12 @@ export declare class CaseIdNotFound extends __BaseException {
173
184
  */
174
185
  export interface AttachmentDetails {
175
186
  /**
187
+ * @public
176
188
  * <p>The ID of the attachment.</p>
177
189
  */
178
190
  attachmentId?: string;
179
191
  /**
192
+ * @public
180
193
  * <p>The file name of the attachment.</p>
181
194
  */
182
195
  fileName?: string;
@@ -210,15 +223,18 @@ export declare class CaseCreationLimitExceeded extends __BaseException {
210
223
  */
211
224
  export interface CreateCaseRequest {
212
225
  /**
226
+ * @public
213
227
  * <p>The title of the support case. The title appears in the <b>Subject</b> field on the Amazon Web Services Support Center <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a> page.</p>
214
228
  */
215
229
  subject: string | undefined;
216
230
  /**
231
+ * @public
217
232
  * <p>The code for the Amazon Web Services service. You can use the <a>DescribeServices</a>
218
233
  * operation to get the possible <code>serviceCode</code> values.</p>
219
234
  */
220
235
  serviceCode?: string;
221
236
  /**
237
+ * @public
222
238
  * <p>A value that indicates the urgency of the case. This value determines the response
223
239
  * time according to your service level agreement with Amazon Web Services Support. You can use the <a>DescribeSeverityLevels</a> operation to get the possible values for
224
240
  * <code>severityCode</code>. </p>
@@ -231,16 +247,19 @@ export interface CreateCaseRequest {
231
247
  */
232
248
  severityCode?: string;
233
249
  /**
250
+ * @public
234
251
  * <p>The category of problem for the support case. You also use the <a>DescribeServices</a> operation to get the category code for a service. Each
235
252
  * Amazon Web Services service defines its own set of category codes.</p>
236
253
  */
237
254
  categoryCode?: string;
238
255
  /**
256
+ * @public
239
257
  * <p>The communication body text that describes the issue. This text appears in the
240
258
  * <b>Description</b> field on the Amazon Web Services Support Center <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a> page.</p>
241
259
  */
242
260
  communicationBody: string | undefined;
243
261
  /**
262
+ * @public
244
263
  * <p>A list of email addresses that Amazon Web Services Support copies on case correspondence. Amazon Web Services Support
245
264
  * identifies the account that creates the case when you specify your Amazon Web Services credentials in
246
265
  * an HTTP POST method or use the <a href="http://aws.amazon.com/tools/">Amazon Web Services SDKs</a>.
@@ -248,18 +267,21 @@ export interface CreateCaseRequest {
248
267
  */
249
268
  ccEmailAddresses?: string[];
250
269
  /**
270
+ * @public
251
271
  * <p>The language in which Amazon Web Services Support handles the case. Amazon Web Services Support
252
272
  * currently supports Chinese (“zh”), English ("en"), Japanese ("ja") and Korean (“ko”). You must specify the ISO 639-1
253
273
  * code for the <code>language</code> parameter if you want support in that language.</p>
254
274
  */
255
275
  language?: string;
256
276
  /**
277
+ * @public
257
278
  * <p>The type of issue for the case. You can specify <code>customer-service</code> or
258
279
  * <code>technical</code>. If you don't specify a value, the default is
259
280
  * <code>technical</code>.</p>
260
281
  */
261
282
  issueType?: string;
262
283
  /**
284
+ * @public
263
285
  * <p>The ID of a set of one or more attachments for the case. Create the set by using the
264
286
  * <a>AddAttachmentsToSet</a> operation.</p>
265
287
  */
@@ -271,6 +293,7 @@ export interface CreateCaseRequest {
271
293
  */
272
294
  export interface CreateCaseResponse {
273
295
  /**
296
+ * @public
274
297
  * <p>The support case ID requested or returned in the call. The case ID is an alphanumeric
275
298
  * string in the following format:
276
299
  * case-<i>12345678910-2013-c4c1d2bf33c5cf47</i>
@@ -296,6 +319,7 @@ export declare class DescribeAttachmentLimitExceeded extends __BaseException {
296
319
  */
297
320
  export interface DescribeAttachmentRequest {
298
321
  /**
322
+ * @public
299
323
  * <p>The ID of the attachment to return. Attachment IDs are returned by the <a>DescribeCommunications</a> operation.</p>
300
324
  */
301
325
  attachmentId: string | undefined;
@@ -306,6 +330,7 @@ export interface DescribeAttachmentRequest {
306
330
  */
307
331
  export interface DescribeAttachmentResponse {
308
332
  /**
333
+ * @public
309
334
  * <p>This object includes the attachment content and file name.</p>
310
335
  * <p>In the previous response syntax, the value for the <code>data</code> parameter appears
311
336
  * as <code>blob</code>, which is represented as a base64-encoded string. The value for
@@ -319,44 +344,53 @@ export interface DescribeAttachmentResponse {
319
344
  */
320
345
  export interface DescribeCasesRequest {
321
346
  /**
347
+ * @public
322
348
  * <p>A list of ID numbers of the support cases you want returned. The maximum number of
323
349
  * cases is 100.</p>
324
350
  */
325
351
  caseIdList?: string[];
326
352
  /**
353
+ * @public
327
354
  * <p>The ID displayed for a case in the Amazon Web Services Support Center user interface.</p>
328
355
  */
329
356
  displayId?: string;
330
357
  /**
358
+ * @public
331
359
  * <p>The start date for a filtered date search on support case communications. Case
332
360
  * communications are available for 12 months after creation.</p>
333
361
  */
334
362
  afterTime?: string;
335
363
  /**
364
+ * @public
336
365
  * <p>The end date for a filtered date search on support case communications. Case
337
366
  * communications are available for 12 months after creation.</p>
338
367
  */
339
368
  beforeTime?: string;
340
369
  /**
370
+ * @public
341
371
  * <p>Specifies whether to include resolved support cases in the <code>DescribeCases</code>
342
372
  * response. By default, resolved cases aren't included.</p>
343
373
  */
344
374
  includeResolvedCases?: boolean;
345
375
  /**
376
+ * @public
346
377
  * <p>A resumption point for pagination.</p>
347
378
  */
348
379
  nextToken?: string;
349
380
  /**
381
+ * @public
350
382
  * <p>The maximum number of results to return before paginating.</p>
351
383
  */
352
384
  maxResults?: number;
353
385
  /**
386
+ * @public
354
387
  * <p>The language in which Amazon Web Services Support handles the case. Amazon Web Services Support
355
388
  * currently supports Chinese (“zh”), English ("en"), Japanese ("ja") and Korean (“ko”). You must specify the ISO 639-1
356
389
  * code for the <code>language</code> parameter if you want support in that language.</p>
357
390
  */
358
391
  language?: string;
359
392
  /**
393
+ * @public
360
394
  * <p>Specifies whether to include communications in the <code>DescribeCases</code>
361
395
  * response. By default, communications are included.</p>
362
396
  */
@@ -370,6 +404,7 @@ export interface DescribeCasesRequest {
370
404
  */
371
405
  export interface Communication {
372
406
  /**
407
+ * @public
373
408
  * <p>The support case ID requested or returned in the call. The case ID is an alphanumeric
374
409
  * string formatted as shown in this example:
375
410
  * case-<i>12345678910-2013-c4c1d2bf33c5cf47</i>
@@ -377,10 +412,12 @@ export interface Communication {
377
412
  */
378
413
  caseId?: string;
379
414
  /**
415
+ * @public
380
416
  * <p>The text of the communication between the customer and Amazon Web Services Support.</p>
381
417
  */
382
418
  body?: string;
383
419
  /**
420
+ * @public
384
421
  * <p>The identity of the account that submitted, or responded to, the support case.
385
422
  * Customer entries include the IAM role as well as the email address (for example,
386
423
  * "AdminRole (Role) <janedoe@example.com>). Entries from the Amazon Web Services Support team display
@@ -389,10 +426,12 @@ export interface Communication {
389
426
  */
390
427
  submittedBy?: string;
391
428
  /**
429
+ * @public
392
430
  * <p>The time the communication was created.</p>
393
431
  */
394
432
  timeCreated?: string;
395
433
  /**
434
+ * @public
396
435
  * <p>Information about the attachments to the case communication.</p>
397
436
  */
398
437
  attachmentSet?: AttachmentDetails[];
@@ -403,10 +442,12 @@ export interface Communication {
403
442
  */
404
443
  export interface RecentCaseCommunications {
405
444
  /**
445
+ * @public
406
446
  * <p>The five most recent communications associated with the case.</p>
407
447
  */
408
448
  communications?: Communication[];
409
449
  /**
450
+ * @public
410
451
  * <p>A resumption point for pagination.</p>
411
452
  */
412
453
  nextToken?: string;
@@ -519,6 +560,7 @@ export interface RecentCaseCommunications {
519
560
  */
520
561
  export interface CaseDetails {
521
562
  /**
563
+ * @public
522
564
  * <p>The support case ID requested or returned in the call. The case ID is an alphanumeric
523
565
  * string formatted as shown in this example:
524
566
  * case-<i>12345678910-2013-c4c1d2bf33c5cf47</i>
@@ -526,15 +568,18 @@ export interface CaseDetails {
526
568
  */
527
569
  caseId?: string;
528
570
  /**
571
+ * @public
529
572
  * <p>The ID displayed for the case in the Amazon Web Services Support Center. This is a numeric
530
573
  * string.</p>
531
574
  */
532
575
  displayId?: string;
533
576
  /**
577
+ * @public
534
578
  * <p>The subject line for the case in the Amazon Web Services Support Center.</p>
535
579
  */
536
580
  subject?: string;
537
581
  /**
582
+ * @public
538
583
  * <p>The status of the case.</p>
539
584
  * <p>Valid values:</p>
540
585
  * <ul>
@@ -572,37 +617,45 @@ export interface CaseDetails {
572
617
  */
573
618
  status?: string;
574
619
  /**
620
+ * @public
575
621
  * <p>The code for the Amazon Web Services service. You can get a list of codes and the corresponding
576
622
  * service names by calling <a>DescribeServices</a>.</p>
577
623
  */
578
624
  serviceCode?: string;
579
625
  /**
626
+ * @public
580
627
  * <p>The category of problem for the support case.</p>
581
628
  */
582
629
  categoryCode?: string;
583
630
  /**
631
+ * @public
584
632
  * <p>The code for the severity level returned by the call to <a>DescribeSeverityLevels</a>.</p>
585
633
  */
586
634
  severityCode?: string;
587
635
  /**
636
+ * @public
588
637
  * <p>The email address of the account that submitted the case.</p>
589
638
  */
590
639
  submittedBy?: string;
591
640
  /**
641
+ * @public
592
642
  * <p>The time that the case was created in the Amazon Web Services Support Center.</p>
593
643
  */
594
644
  timeCreated?: string;
595
645
  /**
646
+ * @public
596
647
  * <p>The five most recent communications between you and Amazon Web Services Support Center, including the
597
648
  * IDs of any attachments to the communications. Also includes a <code>nextToken</code>
598
649
  * that you can use to retrieve earlier communications.</p>
599
650
  */
600
651
  recentCommunications?: RecentCaseCommunications;
601
652
  /**
653
+ * @public
602
654
  * <p>The email addresses that receive copies of communication about the case.</p>
603
655
  */
604
656
  ccEmailAddresses?: string[];
605
657
  /**
658
+ * @public
606
659
  * <p>The language in which Amazon Web Services Support handles the case. Amazon Web Services Support
607
660
  * currently supports Chinese (“zh”), English ("en"), Japanese ("ja") and Korean (“ko”). You must specify the ISO 639-1
608
661
  * code for the <code>language</code> parameter if you want support in that language.</p>
@@ -617,10 +670,12 @@ export interface CaseDetails {
617
670
  */
618
671
  export interface DescribeCasesResponse {
619
672
  /**
673
+ * @public
620
674
  * <p>The details for the cases that match the request.</p>
621
675
  */
622
676
  cases?: CaseDetails[];
623
677
  /**
678
+ * @public
624
679
  * <p>A resumption point for pagination.</p>
625
680
  */
626
681
  nextToken?: string;
@@ -630,6 +685,7 @@ export interface DescribeCasesResponse {
630
685
  */
631
686
  export interface DescribeCommunicationsRequest {
632
687
  /**
688
+ * @public
633
689
  * <p>The support case ID requested or returned in the call. The case ID is an alphanumeric
634
690
  * string formatted as shown in this example:
635
691
  * case-<i>12345678910-2013-c4c1d2bf33c5cf47</i>
@@ -637,20 +693,24 @@ export interface DescribeCommunicationsRequest {
637
693
  */
638
694
  caseId: string | undefined;
639
695
  /**
696
+ * @public
640
697
  * <p>The end date for a filtered date search on support case communications. Case
641
698
  * communications are available for 12 months after creation.</p>
642
699
  */
643
700
  beforeTime?: string;
644
701
  /**
702
+ * @public
645
703
  * <p>The start date for a filtered date search on support case communications. Case
646
704
  * communications are available for 12 months after creation.</p>
647
705
  */
648
706
  afterTime?: string;
649
707
  /**
708
+ * @public
650
709
  * <p>A resumption point for pagination.</p>
651
710
  */
652
711
  nextToken?: string;
653
712
  /**
713
+ * @public
654
714
  * <p>The maximum number of results to return before paginating.</p>
655
715
  */
656
716
  maxResults?: number;
@@ -662,10 +722,12 @@ export interface DescribeCommunicationsRequest {
662
722
  */
663
723
  export interface DescribeCommunicationsResponse {
664
724
  /**
725
+ * @public
665
726
  * <p>The communications for the case.</p>
666
727
  */
667
728
  communications?: Communication[];
668
729
  /**
730
+ * @public
669
731
  * <p>A resumption point for pagination.</p>
670
732
  */
671
733
  nextToken?: string;
@@ -675,23 +737,27 @@ export interface DescribeCommunicationsResponse {
675
737
  */
676
738
  export interface DescribeCreateCaseOptionsRequest {
677
739
  /**
740
+ * @public
678
741
  * <p>The type of issue for the case. You can specify <code>customer-service</code> or
679
742
  * <code>technical</code>. If you don't specify a value, the default is
680
743
  * <code>technical</code>.</p>
681
744
  */
682
745
  issueType: string | undefined;
683
746
  /**
747
+ * @public
684
748
  * <p>The code for the Amazon Web Services service. You can use the <a>DescribeServices</a>
685
749
  * operation to get the possible <code>serviceCode</code> values.</p>
686
750
  */
687
751
  serviceCode: string | undefined;
688
752
  /**
753
+ * @public
689
754
  * <p>The language in which Amazon Web Services Support handles the case. Amazon Web Services Support
690
755
  * currently supports Chinese (“zh”), English ("en"), Japanese ("ja") and Korean (“ko”). You must specify the ISO 639-1
691
756
  * code for the <code>language</code> parameter if you want support in that language.</p>
692
757
  */
693
758
  language: string | undefined;
694
759
  /**
760
+ * @public
695
761
  * <p>The category of problem for the support case. You also use the <a>DescribeServices</a> operation to get the category code for a service. Each
696
762
  * Amazon Web Services service defines its own set of category codes.</p>
697
763
  */
@@ -703,12 +769,14 @@ export interface DescribeCreateCaseOptionsRequest {
703
769
  */
704
770
  export interface DateInterval {
705
771
  /**
772
+ * @public
706
773
  * <p>
707
774
  * A JSON object containing start and date time (UTC). Date and time format is RFC 3339 : 'yyyy-MM-dd'T'HH:mm:ss.SSSZZ'.
708
775
  * </p>
709
776
  */
710
777
  startDateTime?: string;
711
778
  /**
779
+ * @public
712
780
  * <p>
713
781
  * End Date Time (UTC). RFC 3339 format : 'yyyy-MM-dd'T'HH:mm:ss.SSSZZ'.
714
782
  * </p>
@@ -721,12 +789,14 @@ export interface DateInterval {
721
789
  */
722
790
  export interface SupportedHour {
723
791
  /**
792
+ * @public
724
793
  * <p>
725
794
  * Start Time. RFC 3339 format <code>'HH:mm:ss.SSS'</code>.
726
795
  * </p>
727
796
  */
728
797
  startTime?: string;
729
798
  /**
799
+ * @public
730
800
  * <p>
731
801
  * End Time. RFC 3339 format <code>'HH:mm:ss.SSS'</code>.
732
802
  * </p>
@@ -764,18 +834,21 @@ export interface SupportedHour {
764
834
  */
765
835
  export interface CommunicationTypeOptions {
766
836
  /**
837
+ * @public
767
838
  * <p>
768
839
  * A string value indicating the communication type. At the moment the type value can assume one of 3 values at the moment chat, web and call.
769
840
  * </p>
770
841
  */
771
842
  type?: string;
772
843
  /**
844
+ * @public
773
845
  * <p>
774
846
  * A JSON-formatted list containing time ranges when support is available.
775
847
  * </p>
776
848
  */
777
849
  supportedHours?: SupportedHour[];
778
850
  /**
851
+ * @public
779
852
  * <p>
780
853
  * A JSON-formatted list containing date and time ranges for periods without support
781
854
  * </p>
@@ -787,6 +860,7 @@ export interface CommunicationTypeOptions {
787
860
  */
788
861
  export interface DescribeCreateCaseOptionsResponse {
789
862
  /**
863
+ * @public
790
864
  * <p>Language availability can be any of the following:</p>
791
865
  * <ul>
792
866
  * <li>
@@ -808,6 +882,7 @@ export interface DescribeCreateCaseOptionsResponse {
808
882
  */
809
883
  languageAvailability?: string;
810
884
  /**
885
+ * @public
811
886
  * <p>
812
887
  * A JSON-formatted array that contains the available communication type options, along with the available support
813
888
  * timeframes for the given inputs.
@@ -834,10 +909,12 @@ export declare class ThrottlingException extends __BaseException {
834
909
  */
835
910
  export interface DescribeServicesRequest {
836
911
  /**
912
+ * @public
837
913
  * <p>A JSON-formatted list of service codes available for Amazon Web Services services.</p>
838
914
  */
839
915
  serviceCodeList?: string[];
840
916
  /**
917
+ * @public
841
918
  * <p>The language in which Amazon Web Services Support handles the case. Amazon Web Services Support
842
919
  * currently supports Chinese (“zh”), English ("en"), Japanese ("ja") and Korean (“ko”). You must specify the ISO 639-1
843
920
  * code for the <code>language</code> parameter if you want support in that language.</p>
@@ -852,10 +929,12 @@ export interface DescribeServicesRequest {
852
929
  */
853
930
  export interface Category {
854
931
  /**
932
+ * @public
855
933
  * <p>The category code for the support case.</p>
856
934
  */
857
935
  code?: string;
858
936
  /**
937
+ * @public
859
938
  * <p>The category name for the support case.</p>
860
939
  */
861
940
  name?: string;
@@ -867,16 +946,19 @@ export interface Category {
867
946
  */
868
947
  export interface Service {
869
948
  /**
949
+ * @public
870
950
  * <p>The code for an Amazon Web Services service returned by the <a>DescribeServices</a>
871
951
  * response. The <code>name</code> element contains the corresponding friendly name.</p>
872
952
  */
873
953
  code?: string;
874
954
  /**
955
+ * @public
875
956
  * <p>The friendly name for an Amazon Web Services service. The <code>code</code> element contains the
876
957
  * corresponding code.</p>
877
958
  */
878
959
  name?: string;
879
960
  /**
961
+ * @public
880
962
  * <p>A list of categories that describe the type of support issue a case describes.
881
963
  * Categories consist of a category name and a category code. Category names and codes are
882
964
  * passed to Amazon Web Services Support when you call <a>CreateCase</a>.</p>
@@ -890,6 +972,7 @@ export interface Service {
890
972
  */
891
973
  export interface DescribeServicesResponse {
892
974
  /**
975
+ * @public
893
976
  * <p>A JSON-formatted list of Amazon Web Services services.</p>
894
977
  */
895
978
  services?: Service[];
@@ -899,6 +982,7 @@ export interface DescribeServicesResponse {
899
982
  */
900
983
  export interface DescribeSeverityLevelsRequest {
901
984
  /**
985
+ * @public
902
986
  * <p>The language in which Amazon Web Services Support handles the case. Amazon Web Services Support
903
987
  * currently supports Chinese (“zh”), English ("en"), Japanese ("ja") and Korean (“ko”). You must specify the ISO 639-1
904
988
  * code for the <code>language</code> parameter if you want support in that language.</p>
@@ -914,6 +998,7 @@ export interface DescribeSeverityLevelsRequest {
914
998
  */
915
999
  export interface SeverityLevel {
916
1000
  /**
1001
+ * @public
917
1002
  * <p>The code for case severity level.</p>
918
1003
  * <p>Valid values: <code>low</code> | <code>normal</code> | <code>high</code> |
919
1004
  * <code>urgent</code> | <code>critical</code>
@@ -921,6 +1006,7 @@ export interface SeverityLevel {
921
1006
  */
922
1007
  code?: string;
923
1008
  /**
1009
+ * @public
924
1010
  * <p>The name of the severity level that corresponds to the severity level code.</p>
925
1011
  * <note>
926
1012
  * <p>The values returned by the API are different from the values that appear in the
@@ -962,6 +1048,7 @@ export interface SeverityLevel {
962
1048
  */
963
1049
  export interface DescribeSeverityLevelsResponse {
964
1050
  /**
1051
+ * @public
965
1052
  * <p>The available severity levels for the support case. Available severity levels are
966
1053
  * defined by your service level agreement with Amazon Web Services.</p>
967
1054
  */
@@ -972,16 +1059,19 @@ export interface DescribeSeverityLevelsResponse {
972
1059
  */
973
1060
  export interface DescribeSupportedLanguagesRequest {
974
1061
  /**
1062
+ * @public
975
1063
  * <p>The type of issue for the case. You can specify <code>customer-service</code> or
976
1064
  * <code>technical</code>.</p>
977
1065
  */
978
1066
  issueType: string | undefined;
979
1067
  /**
1068
+ * @public
980
1069
  * <p>The code for the Amazon Web Services service. You can use the <a>DescribeServices</a>
981
1070
  * operation to get the possible <code>serviceCode</code> values.</p>
982
1071
  */
983
1072
  serviceCode: string | undefined;
984
1073
  /**
1074
+ * @public
985
1075
  * <p>The category of problem for the support case. You also use the <a>DescribeServices</a> operation to get the category code for a service. Each
986
1076
  * Amazon Web Services service defines its own set of category codes.</p>
987
1077
  */
@@ -997,18 +1087,21 @@ export interface DescribeSupportedLanguagesRequest {
997
1087
  */
998
1088
  export interface SupportedLanguage {
999
1089
  /**
1090
+ * @public
1000
1091
  * <p>
1001
1092
  * 2 digit ISO 639-1 code. e.g. <code>en</code>
1002
1093
  * </p>
1003
1094
  */
1004
1095
  code?: string;
1005
1096
  /**
1097
+ * @public
1006
1098
  * <p>
1007
1099
  * Full language description e.g. <code>ENGLISH</code>
1008
1100
  * </p>
1009
1101
  */
1010
1102
  language?: string;
1011
1103
  /**
1104
+ * @public
1012
1105
  * <p>
1013
1106
  * Language display value e.g. <code>ENGLISH</code>
1014
1107
  * </p>
@@ -1020,6 +1113,7 @@ export interface SupportedLanguage {
1020
1113
  */
1021
1114
  export interface DescribeSupportedLanguagesResponse {
1022
1115
  /**
1116
+ * @public
1023
1117
  * <p>
1024
1118
  * A JSON-formatted array that contains the available ISO 639-1 language codes.
1025
1119
  * </p>
@@ -1031,6 +1125,7 @@ export interface DescribeSupportedLanguagesResponse {
1031
1125
  */
1032
1126
  export interface DescribeTrustedAdvisorCheckRefreshStatusesRequest {
1033
1127
  /**
1128
+ * @public
1034
1129
  * <p>The IDs of the Trusted Advisor checks to get the status.</p>
1035
1130
  * <note>
1036
1131
  * <p>If you specify the check ID of a check that is automatically refreshed, you might
@@ -1045,10 +1140,12 @@ export interface DescribeTrustedAdvisorCheckRefreshStatusesRequest {
1045
1140
  */
1046
1141
  export interface TrustedAdvisorCheckRefreshStatus {
1047
1142
  /**
1143
+ * @public
1048
1144
  * <p>The unique identifier for the Trusted Advisor check.</p>
1049
1145
  */
1050
1146
  checkId: string | undefined;
1051
1147
  /**
1148
+ * @public
1052
1149
  * <p>The status of the Trusted Advisor check for which a refresh has been requested:
1053
1150
  * </p>
1054
1151
  * <ul>
@@ -1079,6 +1176,7 @@ export interface TrustedAdvisorCheckRefreshStatus {
1079
1176
  */
1080
1177
  status: string | undefined;
1081
1178
  /**
1179
+ * @public
1082
1180
  * <p>The amount of time, in milliseconds, until the Trusted Advisor check is eligible for
1083
1181
  * refresh.</p>
1084
1182
  */
@@ -1090,6 +1188,7 @@ export interface TrustedAdvisorCheckRefreshStatus {
1090
1188
  */
1091
1189
  export interface DescribeTrustedAdvisorCheckRefreshStatusesResponse {
1092
1190
  /**
1191
+ * @public
1093
1192
  * <p>The refresh status of the specified Trusted Advisor checks.</p>
1094
1193
  */
1095
1194
  statuses: TrustedAdvisorCheckRefreshStatus[] | undefined;
@@ -1100,10 +1199,12 @@ export interface DescribeTrustedAdvisorCheckRefreshStatusesResponse {
1100
1199
  */
1101
1200
  export interface DescribeTrustedAdvisorCheckResultRequest {
1102
1201
  /**
1202
+ * @public
1103
1203
  * <p>The unique identifier for the Trusted Advisor check.</p>
1104
1204
  */
1105
1205
  checkId: string | undefined;
1106
1206
  /**
1207
+ * @public
1107
1208
  * <p>The ISO 639-1 code for the language that you want your check results to appear
1108
1209
  * in.</p>
1109
1210
  * <p>The Amazon Web Services Support API currently supports the following languages for Trusted Advisor:</p>
@@ -1163,11 +1264,13 @@ export interface DescribeTrustedAdvisorCheckResultRequest {
1163
1264
  */
1164
1265
  export interface TrustedAdvisorCostOptimizingSummary {
1165
1266
  /**
1267
+ * @public
1166
1268
  * <p>The estimated monthly savings that might be realized if the recommended operations are
1167
1269
  * taken.</p>
1168
1270
  */
1169
1271
  estimatedMonthlySavings: number | undefined;
1170
1272
  /**
1273
+ * @public
1171
1274
  * <p>The estimated percentage of savings that might be realized if the recommended
1172
1275
  * operations are taken.</p>
1173
1276
  */
@@ -1180,6 +1283,7 @@ export interface TrustedAdvisorCostOptimizingSummary {
1180
1283
  */
1181
1284
  export interface TrustedAdvisorCategorySpecificSummary {
1182
1285
  /**
1286
+ * @public
1183
1287
  * <p>The summary information about cost savings for a Trusted Advisor check that is in the Cost
1184
1288
  * Optimizing category.</p>
1185
1289
  */
@@ -1191,23 +1295,28 @@ export interface TrustedAdvisorCategorySpecificSummary {
1191
1295
  */
1192
1296
  export interface TrustedAdvisorResourceDetail {
1193
1297
  /**
1298
+ * @public
1194
1299
  * <p>The status code for the resource identified in the Trusted Advisor check.</p>
1195
1300
  */
1196
1301
  status: string | undefined;
1197
1302
  /**
1303
+ * @public
1198
1304
  * <p>The Amazon Web Services Region in which the identified resource is located.</p>
1199
1305
  */
1200
1306
  region?: string;
1201
1307
  /**
1308
+ * @public
1202
1309
  * <p>The unique identifier for the identified resource.</p>
1203
1310
  */
1204
1311
  resourceId: string | undefined;
1205
1312
  /**
1313
+ * @public
1206
1314
  * <p>Specifies whether the Amazon Web Services resource was ignored by Trusted Advisor because it was marked as
1207
1315
  * suppressed by the user.</p>
1208
1316
  */
1209
1317
  isSuppressed?: boolean;
1210
1318
  /**
1319
+ * @public
1211
1320
  * <p>Additional information about the identified resource. The exact metadata and its order
1212
1321
  * can be obtained by inspecting the <a>TrustedAdvisorCheckDescription</a>
1213
1322
  * object returned by the call to <a>DescribeTrustedAdvisorChecks</a>. <b>Metadata</b> contains all the data that is shown in the Excel
@@ -1221,19 +1330,23 @@ export interface TrustedAdvisorResourceDetail {
1221
1330
  */
1222
1331
  export interface TrustedAdvisorResourcesSummary {
1223
1332
  /**
1333
+ * @public
1224
1334
  * <p>The number of Amazon Web Services resources that were analyzed by the Trusted Advisor check.</p>
1225
1335
  */
1226
1336
  resourcesProcessed: number | undefined;
1227
1337
  /**
1338
+ * @public
1228
1339
  * <p>The number of Amazon Web Services resources that were flagged (listed) by the Trusted Advisor check.</p>
1229
1340
  */
1230
1341
  resourcesFlagged: number | undefined;
1231
1342
  /**
1343
+ * @public
1232
1344
  * <p>The number of Amazon Web Services resources ignored by Trusted Advisor because information was
1233
1345
  * unavailable.</p>
1234
1346
  */
1235
1347
  resourcesIgnored: number | undefined;
1236
1348
  /**
1349
+ * @public
1237
1350
  * <p>The number of Amazon Web Services resources ignored by Trusted Advisor because they were marked as
1238
1351
  * suppressed by the user.</p>
1239
1352
  */
@@ -1245,28 +1358,34 @@ export interface TrustedAdvisorResourcesSummary {
1245
1358
  */
1246
1359
  export interface TrustedAdvisorCheckResult {
1247
1360
  /**
1361
+ * @public
1248
1362
  * <p>The unique identifier for the Trusted Advisor check.</p>
1249
1363
  */
1250
1364
  checkId: string | undefined;
1251
1365
  /**
1366
+ * @public
1252
1367
  * <p>The time of the last refresh of the check.</p>
1253
1368
  */
1254
1369
  timestamp: string | undefined;
1255
1370
  /**
1371
+ * @public
1256
1372
  * <p>The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or
1257
1373
  * "not_available".</p>
1258
1374
  */
1259
1375
  status: string | undefined;
1260
1376
  /**
1377
+ * @public
1261
1378
  * <p>Details about Amazon Web Services resources that were analyzed in a call to Trusted Advisor <a>DescribeTrustedAdvisorCheckSummaries</a>.</p>
1262
1379
  */
1263
1380
  resourcesSummary: TrustedAdvisorResourcesSummary | undefined;
1264
1381
  /**
1382
+ * @public
1265
1383
  * <p>Summary information that relates to the category of the check. Cost Optimizing is the
1266
1384
  * only category that is currently supported.</p>
1267
1385
  */
1268
1386
  categorySpecificSummary: TrustedAdvisorCategorySpecificSummary | undefined;
1269
1387
  /**
1388
+ * @public
1270
1389
  * <p>The details about each resource listed in the check result.</p>
1271
1390
  */
1272
1391
  flaggedResources: TrustedAdvisorResourceDetail[] | undefined;
@@ -1277,6 +1396,7 @@ export interface TrustedAdvisorCheckResult {
1277
1396
  */
1278
1397
  export interface DescribeTrustedAdvisorCheckResultResponse {
1279
1398
  /**
1399
+ * @public
1280
1400
  * <p>The detailed results of the Trusted Advisor check.</p>
1281
1401
  */
1282
1402
  result?: TrustedAdvisorCheckResult;
@@ -1286,6 +1406,7 @@ export interface DescribeTrustedAdvisorCheckResultResponse {
1286
1406
  */
1287
1407
  export interface DescribeTrustedAdvisorChecksRequest {
1288
1408
  /**
1409
+ * @public
1289
1410
  * <p>The ISO 639-1 code for the language that you want your checks to appear in.</p>
1290
1411
  * <p>The Amazon Web Services Support API currently supports the following languages for Trusted Advisor:</p>
1291
1412
  * <ul>
@@ -1343,23 +1464,28 @@ export interface DescribeTrustedAdvisorChecksRequest {
1343
1464
  */
1344
1465
  export interface TrustedAdvisorCheckDescription {
1345
1466
  /**
1467
+ * @public
1346
1468
  * <p>The unique identifier for the Trusted Advisor check.</p>
1347
1469
  */
1348
1470
  id: string | undefined;
1349
1471
  /**
1472
+ * @public
1350
1473
  * <p>The display name for the Trusted Advisor check.</p>
1351
1474
  */
1352
1475
  name: string | undefined;
1353
1476
  /**
1477
+ * @public
1354
1478
  * <p>The description of the Trusted Advisor check, which includes the alert criteria and
1355
1479
  * recommended operations (contains HTML markup).</p>
1356
1480
  */
1357
1481
  description: string | undefined;
1358
1482
  /**
1483
+ * @public
1359
1484
  * <p>The category of the Trusted Advisor check.</p>
1360
1485
  */
1361
1486
  category: string | undefined;
1362
1487
  /**
1488
+ * @public
1363
1489
  * <p>The column headings for the data returned by the Trusted Advisor check. The order of the
1364
1490
  * headings corresponds to the order of the data in the <b>Metadata</b> element of the <a>TrustedAdvisorResourceDetail</a>
1365
1491
  * for the check. <b>Metadata</b> contains all the data that is
@@ -1374,6 +1500,7 @@ export interface TrustedAdvisorCheckDescription {
1374
1500
  */
1375
1501
  export interface DescribeTrustedAdvisorChecksResponse {
1376
1502
  /**
1503
+ * @public
1377
1504
  * <p>Information about all available Trusted Advisor checks.</p>
1378
1505
  */
1379
1506
  checks: TrustedAdvisorCheckDescription[] | undefined;
@@ -1383,6 +1510,7 @@ export interface DescribeTrustedAdvisorChecksResponse {
1383
1510
  */
1384
1511
  export interface DescribeTrustedAdvisorCheckSummariesRequest {
1385
1512
  /**
1513
+ * @public
1386
1514
  * <p>The IDs of the Trusted Advisor checks.</p>
1387
1515
  */
1388
1516
  checkIds: string[] | undefined;
@@ -1394,27 +1522,33 @@ export interface DescribeTrustedAdvisorCheckSummariesRequest {
1394
1522
  */
1395
1523
  export interface TrustedAdvisorCheckSummary {
1396
1524
  /**
1525
+ * @public
1397
1526
  * <p>The unique identifier for the Trusted Advisor check.</p>
1398
1527
  */
1399
1528
  checkId: string | undefined;
1400
1529
  /**
1530
+ * @public
1401
1531
  * <p>The time of the last refresh of the check.</p>
1402
1532
  */
1403
1533
  timestamp: string | undefined;
1404
1534
  /**
1535
+ * @public
1405
1536
  * <p>The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or
1406
1537
  * "not_available".</p>
1407
1538
  */
1408
1539
  status: string | undefined;
1409
1540
  /**
1541
+ * @public
1410
1542
  * <p>Specifies whether the Trusted Advisor check has flagged resources.</p>
1411
1543
  */
1412
1544
  hasFlaggedResources?: boolean;
1413
1545
  /**
1546
+ * @public
1414
1547
  * <p>Details about Amazon Web Services resources that were analyzed in a call to Trusted Advisor <a>DescribeTrustedAdvisorCheckSummaries</a>.</p>
1415
1548
  */
1416
1549
  resourcesSummary: TrustedAdvisorResourcesSummary | undefined;
1417
1550
  /**
1551
+ * @public
1418
1552
  * <p>Summary information that relates to the category of the check. Cost Optimizing is the
1419
1553
  * only category that is currently supported.</p>
1420
1554
  */
@@ -1426,6 +1560,7 @@ export interface TrustedAdvisorCheckSummary {
1426
1560
  */
1427
1561
  export interface DescribeTrustedAdvisorCheckSummariesResponse {
1428
1562
  /**
1563
+ * @public
1429
1564
  * <p>The summary information for the requested Trusted Advisor checks.</p>
1430
1565
  */
1431
1566
  summaries: TrustedAdvisorCheckSummary[] | undefined;
@@ -1436,6 +1571,7 @@ export interface DescribeTrustedAdvisorCheckSummariesResponse {
1436
1571
  */
1437
1572
  export interface RefreshTrustedAdvisorCheckRequest {
1438
1573
  /**
1574
+ * @public
1439
1575
  * <p>The unique identifier for the Trusted Advisor check to refresh.</p>
1440
1576
  * <note>
1441
1577
  * <p>Specifying the check ID of a check that is automatically refreshed causes an
@@ -1450,6 +1586,7 @@ export interface RefreshTrustedAdvisorCheckRequest {
1450
1586
  */
1451
1587
  export interface RefreshTrustedAdvisorCheckResponse {
1452
1588
  /**
1589
+ * @public
1453
1590
  * <p>The current refresh status for a check, including the amount of time until the check
1454
1591
  * is eligible for refresh.</p>
1455
1592
  */
@@ -1460,6 +1597,7 @@ export interface RefreshTrustedAdvisorCheckResponse {
1460
1597
  */
1461
1598
  export interface ResolveCaseRequest {
1462
1599
  /**
1600
+ * @public
1463
1601
  * <p>The support case ID requested or returned in the call. The case ID is an alphanumeric
1464
1602
  * string formatted as shown in this example:
1465
1603
  * case-<i>12345678910-2013-c4c1d2bf33c5cf47</i>
@@ -1473,10 +1611,12 @@ export interface ResolveCaseRequest {
1473
1611
  */
1474
1612
  export interface ResolveCaseResponse {
1475
1613
  /**
1614
+ * @public
1476
1615
  * <p>The status of the case when the <a>ResolveCase</a> request was sent.</p>
1477
1616
  */
1478
1617
  initialCaseStatus?: string;
1479
1618
  /**
1619
+ * @public
1480
1620
  * <p>The status of the case after the <a>ResolveCase</a> request was
1481
1621
  * processed.</p>
1482
1622
  */
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-support",
3
3
  "description": "AWS SDK for JavaScript Support Client for Node.js, Browser and React Native",
4
- "version": "3.379.1",
4
+ "version": "3.385.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,15 +21,15 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.379.1",
25
- "@aws-sdk/credential-provider-node": "3.379.1",
24
+ "@aws-sdk/client-sts": "3.385.0",
25
+ "@aws-sdk/credential-provider-node": "3.385.0",
26
26
  "@aws-sdk/middleware-host-header": "3.379.1",
27
27
  "@aws-sdk/middleware-logger": "3.378.0",
28
28
  "@aws-sdk/middleware-recursion-detection": "3.378.0",
29
29
  "@aws-sdk/middleware-signing": "3.379.1",
30
- "@aws-sdk/middleware-user-agent": "3.379.1",
30
+ "@aws-sdk/middleware-user-agent": "3.382.0",
31
31
  "@aws-sdk/types": "3.378.0",
32
- "@aws-sdk/util-endpoints": "3.378.0",
32
+ "@aws-sdk/util-endpoints": "3.382.0",
33
33
  "@aws-sdk/util-user-agent-browser": "3.378.0",
34
34
  "@aws-sdk/util-user-agent-node": "3.378.0",
35
35
  "@smithy/config-resolver": "^2.0.1",