@aws-sdk/client-backup-gateway 3.379.1 → 3.382.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.
@@ -8,6 +8,7 @@ export declare class AccessDeniedException extends __BaseException {
8
8
  readonly name: "AccessDeniedException";
9
9
  readonly $fault: "client";
10
10
  /**
11
+ * @public
11
12
  * <p>A description of why you have insufficient permissions.</p>
12
13
  */
13
14
  ErrorCode: string | undefined;
@@ -22,11 +23,13 @@ export declare class AccessDeniedException extends __BaseException {
22
23
  */
23
24
  export interface AssociateGatewayToServerInput {
24
25
  /**
26
+ * @public
25
27
  * <p>The Amazon Resource Name (ARN) of the gateway. Use the <code>ListGateways</code> operation
26
28
  * to return a list of gateways for your account and Amazon Web Services Region.</p>
27
29
  */
28
30
  GatewayArn: string | undefined;
29
31
  /**
32
+ * @public
30
33
  * <p>The Amazon Resource Name (ARN) of the server that hosts your virtual machines.</p>
31
34
  */
32
35
  ServerArn: string | undefined;
@@ -36,6 +39,7 @@ export interface AssociateGatewayToServerInput {
36
39
  */
37
40
  export interface AssociateGatewayToServerOutput {
38
41
  /**
42
+ * @public
39
43
  * <p>The Amazon Resource Name (ARN) of a gateway.</p>
40
44
  */
41
45
  GatewayArn?: string;
@@ -48,6 +52,7 @@ export declare class ConflictException extends __BaseException {
48
52
  readonly name: "ConflictException";
49
53
  readonly $fault: "client";
50
54
  /**
55
+ * @public
51
56
  * <p>A description of why the operation is not supported.</p>
52
57
  */
53
58
  ErrorCode: string | undefined;
@@ -65,6 +70,7 @@ export declare class InternalServerException extends __BaseException {
65
70
  readonly name: "InternalServerException";
66
71
  readonly $fault: "server";
67
72
  /**
73
+ * @public
68
74
  * <p>A description of which internal error occured.</p>
69
75
  */
70
76
  ErrorCode?: string;
@@ -83,6 +89,7 @@ export declare class ThrottlingException extends __BaseException {
83
89
  readonly name: "ThrottlingException";
84
90
  readonly $fault: "client";
85
91
  /**
92
+ * @public
86
93
  * <p>Error: TPS has been limited to protect against intentional or unintentional
87
94
  * high request volumes.</p>
88
95
  */
@@ -101,6 +108,7 @@ export declare class ValidationException extends __BaseException {
101
108
  readonly name: "ValidationException";
102
109
  readonly $fault: "client";
103
110
  /**
111
+ * @public
104
112
  * <p>A description of what caused the validation error.</p>
105
113
  */
106
114
  ErrorCode?: string;
@@ -115,6 +123,7 @@ export declare class ValidationException extends __BaseException {
115
123
  */
116
124
  export interface GetBandwidthRateLimitScheduleInput {
117
125
  /**
126
+ * @public
118
127
  * <p>The Amazon Resource Name (ARN) of the gateway. Use the
119
128
  * <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html">
120
129
  * <code>ListGateways</code>
@@ -133,6 +142,7 @@ export interface GetBandwidthRateLimitScheduleInput {
133
142
  */
134
143
  export interface BandwidthRateLimitInterval {
135
144
  /**
145
+ * @public
136
146
  * <p>The average upload rate limit component of the bandwidth rate limit
137
147
  * interval, in bits per second. This field does not appear in the response if
138
148
  * the upload rate limit is not set.</p>
@@ -142,20 +152,24 @@ export interface BandwidthRateLimitInterval {
142
152
  */
143
153
  AverageUploadRateLimitInBitsPerSec?: number;
144
154
  /**
155
+ * @public
145
156
  * <p>The hour of the day to start the bandwidth rate limit interval.</p>
146
157
  */
147
158
  StartHourOfDay: number | undefined;
148
159
  /**
160
+ * @public
149
161
  * <p>The hour of the day to end the bandwidth rate limit interval.</p>
150
162
  */
151
163
  EndHourOfDay: number | undefined;
152
164
  /**
165
+ * @public
153
166
  * <p>The minute of the hour to start the bandwidth rate limit interval. The
154
167
  * interval begins at the start of that minute. To begin an interval exactly at
155
168
  * the start of the hour, use the value <code>0</code>.</p>
156
169
  */
157
170
  StartMinuteOfHour: number | undefined;
158
171
  /**
172
+ * @public
159
173
  * <p>The minute of the hour to end the bandwidth rate limit interval.</p>
160
174
  * <important>
161
175
  * <p>The bandwidth rate limit interval ends at the end of the minute.
@@ -164,6 +178,7 @@ export interface BandwidthRateLimitInterval {
164
178
  */
165
179
  EndMinuteOfHour: number | undefined;
166
180
  /**
181
+ * @public
167
182
  * <p>The days of the week component of the bandwidth rate limit interval,
168
183
  * represented as ordinal numbers from 0 to 6, where 0 represents Sunday and 6 represents
169
184
  * Saturday.</p>
@@ -175,6 +190,7 @@ export interface BandwidthRateLimitInterval {
175
190
  */
176
191
  export interface GetBandwidthRateLimitScheduleOutput {
177
192
  /**
193
+ * @public
178
194
  * <p>The Amazon Resource Name (ARN) of the gateway. Use the
179
195
  * <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html">
180
196
  * <code>ListGateways</code>
@@ -183,6 +199,7 @@ export interface GetBandwidthRateLimitScheduleOutput {
183
199
  */
184
200
  GatewayArn?: string;
185
201
  /**
202
+ * @public
186
203
  * <p>An array containing bandwidth rate limit schedule intervals for a gateway.
187
204
  * When no bandwidth rate limit intervals have been scheduled, the array is empty.</p>
188
205
  */
@@ -196,6 +213,7 @@ export declare class ResourceNotFoundException extends __BaseException {
196
213
  readonly name: "ResourceNotFoundException";
197
214
  readonly $fault: "client";
198
215
  /**
216
+ * @public
199
217
  * <p>A description of which resource wasn't found.</p>
200
218
  */
201
219
  ErrorCode?: string;
@@ -210,6 +228,7 @@ export declare class ResourceNotFoundException extends __BaseException {
210
228
  */
211
229
  export interface PutBandwidthRateLimitScheduleInput {
212
230
  /**
231
+ * @public
213
232
  * <p>The Amazon Resource Name (ARN) of the gateway. Use the
214
233
  * <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html">
215
234
  * <code>ListGateways</code>
@@ -218,6 +237,7 @@ export interface PutBandwidthRateLimitScheduleInput {
218
237
  */
219
238
  GatewayArn: string | undefined;
220
239
  /**
240
+ * @public
221
241
  * <p>An array containing bandwidth rate limit schedule intervals for a gateway.
222
242
  * When no bandwidth rate limit intervals have been scheduled, the array is empty.</p>
223
243
  */
@@ -228,6 +248,7 @@ export interface PutBandwidthRateLimitScheduleInput {
228
248
  */
229
249
  export interface PutBandwidthRateLimitScheduleOutput {
230
250
  /**
251
+ * @public
231
252
  * <p>The Amazon Resource Name (ARN) of the gateway. Use the
232
253
  * <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html">
233
254
  * <code>ListGateways</code>
@@ -255,10 +276,12 @@ export type GatewayType = (typeof GatewayType)[keyof typeof GatewayType];
255
276
  */
256
277
  export interface Tag {
257
278
  /**
279
+ * @public
258
280
  * <p>The key part of a tag's key-value pair. The key can't start with <code>aws:</code>.</p>
259
281
  */
260
282
  Key: string | undefined;
261
283
  /**
284
+ * @public
262
285
  * <p>The value part of a tag's key-value pair.</p>
263
286
  */
264
287
  Value: string | undefined;
@@ -268,18 +291,22 @@ export interface Tag {
268
291
  */
269
292
  export interface CreateGatewayInput {
270
293
  /**
294
+ * @public
271
295
  * <p>The activation key of the created gateway.</p>
272
296
  */
273
297
  ActivationKey: string | undefined;
274
298
  /**
299
+ * @public
275
300
  * <p>The display name of the created gateway.</p>
276
301
  */
277
302
  GatewayDisplayName: string | undefined;
278
303
  /**
304
+ * @public
279
305
  * <p>The type of created gateway.</p>
280
306
  */
281
307
  GatewayType: GatewayType | string | undefined;
282
308
  /**
309
+ * @public
283
310
  * <p>A list of up to 50 tags to assign to the gateway. Each tag is a key-value pair.</p>
284
311
  */
285
312
  Tags?: Tag[];
@@ -289,6 +316,7 @@ export interface CreateGatewayInput {
289
316
  */
290
317
  export interface CreateGatewayOutput {
291
318
  /**
319
+ * @public
292
320
  * <p>The Amazon Resource Name (ARN) of the gateway you create.</p>
293
321
  */
294
322
  GatewayArn?: string;
@@ -298,6 +326,7 @@ export interface CreateGatewayOutput {
298
326
  */
299
327
  export interface DeleteGatewayInput {
300
328
  /**
329
+ * @public
301
330
  * <p>The Amazon Resource Name (ARN) of the gateway to delete.</p>
302
331
  */
303
332
  GatewayArn: string | undefined;
@@ -307,6 +336,7 @@ export interface DeleteGatewayInput {
307
336
  */
308
337
  export interface DeleteGatewayOutput {
309
338
  /**
339
+ * @public
310
340
  * <p>The Amazon Resource Name (ARN) of the gateway you deleted.</p>
311
341
  */
312
342
  GatewayArn?: string;
@@ -316,6 +346,7 @@ export interface DeleteGatewayOutput {
316
346
  */
317
347
  export interface DisassociateGatewayFromServerInput {
318
348
  /**
349
+ * @public
319
350
  * <p>The Amazon Resource Name (ARN) of the gateway to disassociate.</p>
320
351
  */
321
352
  GatewayArn: string | undefined;
@@ -325,6 +356,7 @@ export interface DisassociateGatewayFromServerInput {
325
356
  */
326
357
  export interface DisassociateGatewayFromServerOutput {
327
358
  /**
359
+ * @public
328
360
  * <p>The Amazon Resource Name (ARN) of the gateway you disassociated.</p>
329
361
  */
330
362
  GatewayArn?: string;
@@ -334,6 +366,7 @@ export interface DisassociateGatewayFromServerOutput {
334
366
  */
335
367
  export interface GetGatewayInput {
336
368
  /**
369
+ * @public
337
370
  * <p>The Amazon Resource Name (ARN) of the gateway.</p>
338
371
  */
339
372
  GatewayArn: string | undefined;
@@ -345,21 +378,25 @@ export interface GetGatewayInput {
345
378
  */
346
379
  export interface MaintenanceStartTime {
347
380
  /**
381
+ * @public
348
382
  * <p>The day of the month component of the maintenance start time represented as an ordinal number from
349
383
  * 1 to 28, where 1 represents the first day of the month and 28 represents the last day of the month.</p>
350
384
  */
351
385
  DayOfMonth?: number;
352
386
  /**
387
+ * @public
353
388
  * <p>An ordinal number between 0 and 6 that represents the day of the week, where 0 represents Sunday
354
389
  * and 6 represents Saturday. The day of week is in the time zone of the gateway.</p>
355
390
  */
356
391
  DayOfWeek?: number;
357
392
  /**
393
+ * @public
358
394
  * <p>The hour component of the maintenance start time represented as <i>hh</i>,
359
395
  * where <i>hh</i> is the hour (0 to 23). The hour of the day is in the time zone of the gateway.</p>
360
396
  */
361
397
  HourOfDay: number | undefined;
362
398
  /**
399
+ * @public
363
400
  * <p>The minute component of the maintenance start time represented as <i>mm</i>, where
364
401
  * <i>mm</i> is the minute (0 to 59). The minute of the hour is in the time zone of the gateway.</p>
365
402
  */
@@ -371,6 +408,7 @@ export interface MaintenanceStartTime {
371
408
  */
372
409
  export interface GatewayDetails {
373
410
  /**
411
+ * @public
374
412
  * <p>The Amazon Resource Name (ARN) of the
375
413
  * gateway. Use the <code>ListGateways</code> operation
376
414
  * to return a list of gateways for your account and
@@ -378,33 +416,40 @@ export interface GatewayDetails {
378
416
  */
379
417
  GatewayArn?: string;
380
418
  /**
419
+ * @public
381
420
  * <p>The display name of the gateway.</p>
382
421
  */
383
422
  GatewayDisplayName?: string;
384
423
  /**
424
+ * @public
385
425
  * <p>The type of the gateway type.</p>
386
426
  */
387
427
  GatewayType?: GatewayType | string;
388
428
  /**
429
+ * @public
389
430
  * <p>The hypervisor ID of the gateway.</p>
390
431
  */
391
432
  HypervisorId?: string;
392
433
  /**
434
+ * @public
393
435
  * <p>Details showing the last time Backup gateway communicated
394
436
  * with the cloud, in Unix format and UTC time.</p>
395
437
  */
396
438
  LastSeenTime?: Date;
397
439
  /**
440
+ * @public
398
441
  * <p>Returns your gateway's weekly maintenance start time including the day and time of the week.
399
442
  * Note that values are in terms of the gateway's time zone. Can be weekly or monthly.</p>
400
443
  */
401
444
  MaintenanceStartTime?: MaintenanceStartTime;
402
445
  /**
446
+ * @public
403
447
  * <p>Details showing the next update availability time of the
404
448
  * gateway.</p>
405
449
  */
406
450
  NextUpdateAvailabilityTime?: Date;
407
451
  /**
452
+ * @public
408
453
  * <p>The DNS name for the virtual private cloud (VPC) endpoint the gateway
409
454
  * uses to connect to the cloud for backup gateway.</p>
410
455
  */
@@ -415,6 +460,7 @@ export interface GatewayDetails {
415
460
  */
416
461
  export interface GetGatewayOutput {
417
462
  /**
463
+ * @public
418
464
  * <p>By providing the ARN (Amazon Resource Name), this
419
465
  * API returns the gateway.</p>
420
466
  */
@@ -425,10 +471,12 @@ export interface GetGatewayOutput {
425
471
  */
426
472
  export interface ListGatewaysInput {
427
473
  /**
474
+ * @public
428
475
  * <p>The maximum number of gateways to list.</p>
429
476
  */
430
477
  MaxResults?: number;
431
478
  /**
479
+ * @public
432
480
  * <p>The next item following a partial list of returned resources. For example, if a request is
433
481
  * made to return <code>MaxResults</code> number of resources, <code>NextToken</code> allows you
434
482
  * to return more items in your list starting at the location pointed to by the next
@@ -443,23 +491,28 @@ export interface ListGatewaysInput {
443
491
  */
444
492
  export interface Gateway {
445
493
  /**
494
+ * @public
446
495
  * <p>The Amazon Resource Name (ARN) of the gateway. Use the <code>ListGateways</code> operation
447
496
  * to return a list of gateways for your account and Amazon Web Services Region.</p>
448
497
  */
449
498
  GatewayArn?: string;
450
499
  /**
500
+ * @public
451
501
  * <p>The display name of the gateway.</p>
452
502
  */
453
503
  GatewayDisplayName?: string;
454
504
  /**
505
+ * @public
455
506
  * <p>The type of the gateway.</p>
456
507
  */
457
508
  GatewayType?: GatewayType | string;
458
509
  /**
510
+ * @public
459
511
  * <p>The hypervisor ID of the gateway.</p>
460
512
  */
461
513
  HypervisorId?: string;
462
514
  /**
515
+ * @public
463
516
  * <p>The last time Backup gateway communicated with the gateway, in Unix format and
464
517
  * UTC time.</p>
465
518
  */
@@ -470,10 +523,12 @@ export interface Gateway {
470
523
  */
471
524
  export interface ListGatewaysOutput {
472
525
  /**
526
+ * @public
473
527
  * <p>A list of your gateways.</p>
474
528
  */
475
529
  Gateways?: Gateway[];
476
530
  /**
531
+ * @public
477
532
  * <p>The next item following a partial list of returned resources. For example, if a request is
478
533
  * made to return <code>maxResults</code> number of resources, <code>NextToken</code> allows you
479
534
  * to return more items in your list starting at the location pointed to by the next
@@ -486,23 +541,28 @@ export interface ListGatewaysOutput {
486
541
  */
487
542
  export interface PutMaintenanceStartTimeInput {
488
543
  /**
544
+ * @public
489
545
  * <p>The Amazon Resource Name (ARN) for the gateway, used to specify its maintenance start
490
546
  * time.</p>
491
547
  */
492
548
  GatewayArn: string | undefined;
493
549
  /**
550
+ * @public
494
551
  * <p>The hour of the day to start maintenance on a gateway.</p>
495
552
  */
496
553
  HourOfDay: number | undefined;
497
554
  /**
555
+ * @public
498
556
  * <p>The minute of the hour to start maintenance on a gateway.</p>
499
557
  */
500
558
  MinuteOfHour: number | undefined;
501
559
  /**
560
+ * @public
502
561
  * <p>The day of the week to start maintenance on a gateway.</p>
503
562
  */
504
563
  DayOfWeek?: number;
505
564
  /**
565
+ * @public
506
566
  * <p>The day of the month start maintenance on a gateway.</p>
507
567
  * <p>Valid values range from <code>Sunday</code> to <code>Saturday</code>.</p>
508
568
  */
@@ -513,6 +573,7 @@ export interface PutMaintenanceStartTimeInput {
513
573
  */
514
574
  export interface PutMaintenanceStartTimeOutput {
515
575
  /**
576
+ * @public
516
577
  * <p>The Amazon Resource Name (ARN) of a gateway for which you set the maintenance start
517
578
  * time.</p>
518
579
  */
@@ -523,19 +584,23 @@ export interface PutMaintenanceStartTimeOutput {
523
584
  */
524
585
  export interface TestHypervisorConfigurationInput {
525
586
  /**
587
+ * @public
526
588
  * <p>The Amazon Resource Name (ARN) of the gateway to the hypervisor to test.</p>
527
589
  */
528
590
  GatewayArn: string | undefined;
529
591
  /**
592
+ * @public
530
593
  * <p>The server host of the hypervisor. This can be either an IP address or a fully-qualified
531
594
  * domain name (FQDN).</p>
532
595
  */
533
596
  Host: string | undefined;
534
597
  /**
598
+ * @public
535
599
  * <p>The username for the hypervisor.</p>
536
600
  */
537
601
  Username?: string;
538
602
  /**
603
+ * @public
539
604
  * <p>The password for the hypervisor.</p>
540
605
  */
541
606
  Password?: string;
@@ -550,10 +615,12 @@ export interface TestHypervisorConfigurationOutput {
550
615
  */
551
616
  export interface UpdateGatewayInformationInput {
552
617
  /**
618
+ * @public
553
619
  * <p>The Amazon Resource Name (ARN) of the gateway to update.</p>
554
620
  */
555
621
  GatewayArn: string | undefined;
556
622
  /**
623
+ * @public
557
624
  * <p>The updated display name of the gateway.</p>
558
625
  */
559
626
  GatewayDisplayName?: string;
@@ -563,6 +630,7 @@ export interface UpdateGatewayInformationInput {
563
630
  */
564
631
  export interface UpdateGatewayInformationOutput {
565
632
  /**
633
+ * @public
566
634
  * <p>The Amazon Resource Name (ARN) of the gateway you updated.</p>
567
635
  */
568
636
  GatewayArn?: string;
@@ -572,6 +640,7 @@ export interface UpdateGatewayInformationOutput {
572
640
  */
573
641
  export interface UpdateGatewaySoftwareNowInput {
574
642
  /**
643
+ * @public
575
644
  * <p>The Amazon Resource Name (ARN) of the gateway
576
645
  * to be updated.</p>
577
646
  */
@@ -582,6 +651,7 @@ export interface UpdateGatewaySoftwareNowInput {
582
651
  */
583
652
  export interface UpdateGatewaySoftwareNowOutput {
584
653
  /**
654
+ * @public
585
655
  * <p>The Amazon Resource Name (ARN) of the gateway
586
656
  * you updated.</p>
587
657
  */
@@ -592,6 +662,7 @@ export interface UpdateGatewaySoftwareNowOutput {
592
662
  */
593
663
  export interface DeleteHypervisorInput {
594
664
  /**
665
+ * @public
595
666
  * <p>The Amazon Resource Name (ARN) of the hypervisor to delete.</p>
596
667
  */
597
668
  HypervisorArn: string | undefined;
@@ -601,6 +672,7 @@ export interface DeleteHypervisorInput {
601
672
  */
602
673
  export interface DeleteHypervisorOutput {
603
674
  /**
675
+ * @public
604
676
  * <p>The Amazon Resource Name (ARN) of the hypervisor you deleted.</p>
605
677
  */
606
678
  HypervisorArn?: string;
@@ -610,6 +682,7 @@ export interface DeleteHypervisorOutput {
610
682
  */
611
683
  export interface GetHypervisorInput {
612
684
  /**
685
+ * @public
613
686
  * <p>The Amazon Resource Name (ARN) of the hypervisor.</p>
614
687
  */
615
688
  HypervisorArn: string | undefined;
@@ -651,44 +724,53 @@ export type HypervisorState = (typeof HypervisorState)[keyof typeof HypervisorSt
651
724
  */
652
725
  export interface HypervisorDetails {
653
726
  /**
727
+ * @public
654
728
  * <p>The server host of the hypervisor. This can be either an IP address or
655
729
  * a fully-qualified domain name (FQDN).</p>
656
730
  */
657
731
  Host?: string;
658
732
  /**
733
+ * @public
659
734
  * <p>The Amazon Resource Name (ARN) of the hypervisor.</p>
660
735
  */
661
736
  HypervisorArn?: string;
662
737
  /**
738
+ * @public
663
739
  * <p>The Amazon Resource Name (ARN) of the KMS
664
740
  * used to encrypt the hypervisor.</p>
665
741
  */
666
742
  KmsKeyArn?: string;
667
743
  /**
744
+ * @public
668
745
  * <p>This is the name of the specified hypervisor.</p>
669
746
  */
670
747
  Name?: string;
671
748
  /**
749
+ * @public
672
750
  * <p>The Amazon Resource Name (ARN) of the group of gateways within
673
751
  * the requested log.</p>
674
752
  */
675
753
  LogGroupArn?: string;
676
754
  /**
755
+ * @public
677
756
  * <p>This is the current state of the specified hypervisor.</p>
678
757
  * <p>The possible states are <code>PENDING</code>, <code>ONLINE</code>,
679
758
  * <code>OFFLINE</code>, or <code>ERROR</code>.</p>
680
759
  */
681
760
  State?: HypervisorState | string;
682
761
  /**
762
+ * @public
683
763
  * <p>This is the time when the most recent successful sync
684
764
  * of metadata occurred.</p>
685
765
  */
686
766
  LastSuccessfulMetadataSyncTime?: Date;
687
767
  /**
768
+ * @public
688
769
  * <p>This is the most recent status for the indicated metadata sync.</p>
689
770
  */
690
771
  LatestMetadataSyncStatusMessage?: string;
691
772
  /**
773
+ * @public
692
774
  * <p>This is the most recent status for the indicated metadata sync.</p>
693
775
  */
694
776
  LatestMetadataSyncStatus?: SyncMetadataStatus | string;
@@ -698,6 +780,7 @@ export interface HypervisorDetails {
698
780
  */
699
781
  export interface GetHypervisorOutput {
700
782
  /**
783
+ * @public
701
784
  * <p>Details about the requested hypervisor.</p>
702
785
  */
703
786
  Hypervisor?: HypervisorDetails;
@@ -707,6 +790,7 @@ export interface GetHypervisorOutput {
707
790
  */
708
791
  export interface GetHypervisorPropertyMappingsInput {
709
792
  /**
793
+ * @public
710
794
  * <p>The Amazon Resource Name (ARN) of the hypervisor.</p>
711
795
  */
712
796
  HypervisorArn: string | undefined;
@@ -718,18 +802,22 @@ export interface GetHypervisorPropertyMappingsInput {
718
802
  */
719
803
  export interface VmwareToAwsTagMapping {
720
804
  /**
805
+ * @public
721
806
  * <p>The is the category of VMware.</p>
722
807
  */
723
808
  VmwareCategory: string | undefined;
724
809
  /**
810
+ * @public
725
811
  * <p>This is the user-defined name of a VMware tag.</p>
726
812
  */
727
813
  VmwareTagName: string | undefined;
728
814
  /**
815
+ * @public
729
816
  * <p>The key part of the Amazon Web Services tag's key-value pair.</p>
730
817
  */
731
818
  AwsTagKey: string | undefined;
732
819
  /**
820
+ * @public
733
821
  * <p>The value part of the Amazon Web Services tag's key-value pair.</p>
734
822
  */
735
823
  AwsTagValue: string | undefined;
@@ -739,15 +827,18 @@ export interface VmwareToAwsTagMapping {
739
827
  */
740
828
  export interface GetHypervisorPropertyMappingsOutput {
741
829
  /**
830
+ * @public
742
831
  * <p>The Amazon Resource Name (ARN) of the hypervisor.</p>
743
832
  */
744
833
  HypervisorArn?: string;
745
834
  /**
835
+ * @public
746
836
  * <p>This is a display of the mappings of on-premises VMware tags to the
747
837
  * Amazon Web Services tags.</p>
748
838
  */
749
839
  VmwareToAwsTagMappings?: VmwareToAwsTagMapping[];
750
840
  /**
841
+ * @public
751
842
  * <p>The Amazon Resource Name (ARN) of the IAM role.</p>
752
843
  */
753
844
  IamRoleArn?: string;
@@ -757,15 +848,18 @@ export interface GetHypervisorPropertyMappingsOutput {
757
848
  */
758
849
  export interface PutHypervisorPropertyMappingsInput {
759
850
  /**
851
+ * @public
760
852
  * <p>The Amazon Resource Name (ARN) of the hypervisor.</p>
761
853
  */
762
854
  HypervisorArn: string | undefined;
763
855
  /**
856
+ * @public
764
857
  * <p>This action requests the mappings of on-premises VMware tags to the
765
858
  * Amazon Web Services tags.</p>
766
859
  */
767
860
  VmwareToAwsTagMappings: VmwareToAwsTagMapping[] | undefined;
768
861
  /**
862
+ * @public
769
863
  * <p>The Amazon Resource Name (ARN) of the IAM role.</p>
770
864
  */
771
865
  IamRoleArn: string | undefined;
@@ -775,6 +869,7 @@ export interface PutHypervisorPropertyMappingsInput {
775
869
  */
776
870
  export interface PutHypervisorPropertyMappingsOutput {
777
871
  /**
872
+ * @public
778
873
  * <p>The Amazon Resource Name (ARN) of the hypervisor.</p>
779
874
  */
780
875
  HypervisorArn?: string;
@@ -784,27 +879,33 @@ export interface PutHypervisorPropertyMappingsOutput {
784
879
  */
785
880
  export interface ImportHypervisorConfigurationInput {
786
881
  /**
882
+ * @public
787
883
  * <p>The name of the hypervisor.</p>
788
884
  */
789
885
  Name: string | undefined;
790
886
  /**
887
+ * @public
791
888
  * <p>The server host of the hypervisor. This can be either an IP address or a fully-qualified
792
889
  * domain name (FQDN).</p>
793
890
  */
794
891
  Host: string | undefined;
795
892
  /**
893
+ * @public
796
894
  * <p>The username for the hypervisor.</p>
797
895
  */
798
896
  Username?: string;
799
897
  /**
898
+ * @public
800
899
  * <p>The password for the hypervisor.</p>
801
900
  */
802
901
  Password?: string;
803
902
  /**
903
+ * @public
804
904
  * <p>The Key Management Service for the hypervisor.</p>
805
905
  */
806
906
  KmsKeyArn?: string;
807
907
  /**
908
+ * @public
808
909
  * <p>The tags of the hypervisor configuration to import.</p>
809
910
  */
810
911
  Tags?: Tag[];
@@ -814,6 +915,7 @@ export interface ImportHypervisorConfigurationInput {
814
915
  */
815
916
  export interface ImportHypervisorConfigurationOutput {
816
917
  /**
918
+ * @public
817
919
  * <p>The Amazon Resource Name (ARN) of the hypervisor you disassociated.</p>
818
920
  */
819
921
  HypervisorArn?: string;
@@ -823,10 +925,12 @@ export interface ImportHypervisorConfigurationOutput {
823
925
  */
824
926
  export interface ListHypervisorsInput {
825
927
  /**
928
+ * @public
826
929
  * <p>The maximum number of hypervisors to list.</p>
827
930
  */
828
931
  MaxResults?: number;
829
932
  /**
933
+ * @public
830
934
  * <p>The next item following a partial list of returned resources. For example, if a request is
831
935
  * made to return <code>maxResults</code> number of resources, <code>NextToken</code> allows you
832
936
  * to return more items in your list starting at the location pointed to by the next
@@ -842,24 +946,29 @@ export interface ListHypervisorsInput {
842
946
  */
843
947
  export interface Hypervisor {
844
948
  /**
949
+ * @public
845
950
  * <p>The server host of the hypervisor. This can be either an IP address or a fully-qualified
846
951
  * domain name (FQDN).</p>
847
952
  */
848
953
  Host?: string;
849
954
  /**
955
+ * @public
850
956
  * <p>The Amazon Resource Name (ARN) of the hypervisor.</p>
851
957
  */
852
958
  HypervisorArn?: string;
853
959
  /**
960
+ * @public
854
961
  * <p>The Amazon Resource Name (ARN) of the Key Management Service used to encrypt the
855
962
  * hypervisor.</p>
856
963
  */
857
964
  KmsKeyArn?: string;
858
965
  /**
966
+ * @public
859
967
  * <p>The name of the hypervisor.</p>
860
968
  */
861
969
  Name?: string;
862
970
  /**
971
+ * @public
863
972
  * <p>The state of the hypervisor.</p>
864
973
  */
865
974
  State?: HypervisorState | string;
@@ -869,11 +978,13 @@ export interface Hypervisor {
869
978
  */
870
979
  export interface ListHypervisorsOutput {
871
980
  /**
981
+ * @public
872
982
  * <p>A list of your <code>Hypervisor</code> objects, ordered by their Amazon Resource Names
873
983
  * (ARNs).</p>
874
984
  */
875
985
  Hypervisors?: Hypervisor[];
876
986
  /**
987
+ * @public
877
988
  * <p>The next item following a partial list of returned resources. For example, if a request is
878
989
  * made to return <code>maxResults</code> number of resources, <code>NextToken</code> allows you
879
990
  * to return more items in your list starting at the location pointed to by the next
@@ -886,6 +997,7 @@ export interface ListHypervisorsOutput {
886
997
  */
887
998
  export interface StartVirtualMachinesMetadataSyncInput {
888
999
  /**
1000
+ * @public
889
1001
  * <p>The Amazon Resource Name (ARN) of the hypervisor.</p>
890
1002
  */
891
1003
  HypervisorArn: string | undefined;
@@ -895,6 +1007,7 @@ export interface StartVirtualMachinesMetadataSyncInput {
895
1007
  */
896
1008
  export interface StartVirtualMachinesMetadataSyncOutput {
897
1009
  /**
1010
+ * @public
898
1011
  * <p>The Amazon Resource Name (ARN) of the hypervisor.</p>
899
1012
  */
900
1013
  HypervisorArn?: string;
@@ -904,27 +1017,33 @@ export interface StartVirtualMachinesMetadataSyncOutput {
904
1017
  */
905
1018
  export interface UpdateHypervisorInput {
906
1019
  /**
1020
+ * @public
907
1021
  * <p>The Amazon Resource Name (ARN) of the hypervisor to update.</p>
908
1022
  */
909
1023
  HypervisorArn: string | undefined;
910
1024
  /**
1025
+ * @public
911
1026
  * <p>The updated host of the hypervisor. This can be either an IP address or a fully-qualified
912
1027
  * domain name (FQDN).</p>
913
1028
  */
914
1029
  Host?: string;
915
1030
  /**
1031
+ * @public
916
1032
  * <p>The updated username for the hypervisor.</p>
917
1033
  */
918
1034
  Username?: string;
919
1035
  /**
1036
+ * @public
920
1037
  * <p>The updated password for the hypervisor.</p>
921
1038
  */
922
1039
  Password?: string;
923
1040
  /**
1041
+ * @public
924
1042
  * <p>The updated name for the hypervisor</p>
925
1043
  */
926
1044
  Name?: string;
927
1045
  /**
1046
+ * @public
928
1047
  * <p>The Amazon Resource Name (ARN) of the group of gateways within the requested log.</p>
929
1048
  */
930
1049
  LogGroupArn?: string;
@@ -934,6 +1053,7 @@ export interface UpdateHypervisorInput {
934
1053
  */
935
1054
  export interface UpdateHypervisorOutput {
936
1055
  /**
1056
+ * @public
937
1057
  * <p>The Amazon Resource Name (ARN) of the hypervisor you updated.</p>
938
1058
  */
939
1059
  HypervisorArn?: string;
@@ -943,6 +1063,7 @@ export interface UpdateHypervisorOutput {
943
1063
  */
944
1064
  export interface ListTagsForResourceInput {
945
1065
  /**
1066
+ * @public
946
1067
  * <p>The Amazon Resource Name (ARN) of the resource's tags to list.</p>
947
1068
  */
948
1069
  ResourceArn: string | undefined;
@@ -952,10 +1073,12 @@ export interface ListTagsForResourceInput {
952
1073
  */
953
1074
  export interface ListTagsForResourceOutput {
954
1075
  /**
1076
+ * @public
955
1077
  * <p>The Amazon Resource Name (ARN) of the resource's tags that you listed.</p>
956
1078
  */
957
1079
  ResourceArn?: string;
958
1080
  /**
1081
+ * @public
959
1082
  * <p>A list of the resource's tags.</p>
960
1083
  */
961
1084
  Tags?: Tag[];
@@ -965,10 +1088,12 @@ export interface ListTagsForResourceOutput {
965
1088
  */
966
1089
  export interface TagResourceInput {
967
1090
  /**
1091
+ * @public
968
1092
  * <p>The Amazon Resource Name (ARN) of the resource to tag.</p>
969
1093
  */
970
1094
  ResourceARN: string | undefined;
971
1095
  /**
1096
+ * @public
972
1097
  * <p>A list of tags to assign to the resource.</p>
973
1098
  */
974
1099
  Tags: Tag[] | undefined;
@@ -978,6 +1103,7 @@ export interface TagResourceInput {
978
1103
  */
979
1104
  export interface TagResourceOutput {
980
1105
  /**
1106
+ * @public
981
1107
  * <p>The Amazon Resource Name (ARN) of the resource you tagged.</p>
982
1108
  */
983
1109
  ResourceARN?: string;
@@ -987,10 +1113,12 @@ export interface TagResourceOutput {
987
1113
  */
988
1114
  export interface UntagResourceInput {
989
1115
  /**
1116
+ * @public
990
1117
  * <p>The Amazon Resource Name (ARN) of the resource from which to remove tags.</p>
991
1118
  */
992
1119
  ResourceARN: string | undefined;
993
1120
  /**
1121
+ * @public
994
1122
  * <p>The list of tag keys specifying which tags to remove.</p>
995
1123
  */
996
1124
  TagKeys: string[] | undefined;
@@ -1000,6 +1128,7 @@ export interface UntagResourceInput {
1000
1128
  */
1001
1129
  export interface UntagResourceOutput {
1002
1130
  /**
1131
+ * @public
1003
1132
  * <p>The Amazon Resource Name (ARN) of the resource from which you removed tags.</p>
1004
1133
  */
1005
1134
  ResourceARN?: string;
@@ -1009,6 +1138,7 @@ export interface UntagResourceOutput {
1009
1138
  */
1010
1139
  export interface GetVirtualMachineInput {
1011
1140
  /**
1141
+ * @public
1012
1142
  * <p>The Amazon Resource Name (ARN) of the virtual machine.</p>
1013
1143
  */
1014
1144
  ResourceArn: string | undefined;
@@ -1022,14 +1152,17 @@ export interface GetVirtualMachineInput {
1022
1152
  */
1023
1153
  export interface VmwareTag {
1024
1154
  /**
1155
+ * @public
1025
1156
  * <p>The is the category of VMware.</p>
1026
1157
  */
1027
1158
  VmwareCategory?: string;
1028
1159
  /**
1160
+ * @public
1029
1161
  * <p>This is the user-defined name of a VMware tag.</p>
1030
1162
  */
1031
1163
  VmwareTagName?: string;
1032
1164
  /**
1165
+ * @public
1033
1166
  * <p>This is a user-defined description of a VMware tag.</p>
1034
1167
  */
1035
1168
  VmwareTagDescription?: string;
@@ -1040,31 +1173,38 @@ export interface VmwareTag {
1040
1173
  */
1041
1174
  export interface VirtualMachineDetails {
1042
1175
  /**
1176
+ * @public
1043
1177
  * <p>The host name of the virtual machine.</p>
1044
1178
  */
1045
1179
  HostName?: string;
1046
1180
  /**
1181
+ * @public
1047
1182
  * <p>The ID of the virtual machine's hypervisor.</p>
1048
1183
  */
1049
1184
  HypervisorId?: string;
1050
1185
  /**
1186
+ * @public
1051
1187
  * <p>The name of the virtual machine.</p>
1052
1188
  */
1053
1189
  Name?: string;
1054
1190
  /**
1191
+ * @public
1055
1192
  * <p>The path of the virtual machine.</p>
1056
1193
  */
1057
1194
  Path?: string;
1058
1195
  /**
1196
+ * @public
1059
1197
  * <p>The Amazon Resource Name (ARN) of the virtual machine. For example,
1060
1198
  * <code>arn:aws:backup-gateway:us-west-1:0000000000000:vm/vm-0000ABCDEFGIJKL</code>.</p>
1061
1199
  */
1062
1200
  ResourceArn?: string;
1063
1201
  /**
1202
+ * @public
1064
1203
  * <p>The most recent date a virtual machine was backed up, in Unix format and UTC time.</p>
1065
1204
  */
1066
1205
  LastBackupDate?: Date;
1067
1206
  /**
1207
+ * @public
1068
1208
  * <p>These are the details of the VMware tags associated with the specified
1069
1209
  * virtual machine.</p>
1070
1210
  */
@@ -1075,6 +1215,7 @@ export interface VirtualMachineDetails {
1075
1215
  */
1076
1216
  export interface GetVirtualMachineOutput {
1077
1217
  /**
1218
+ * @public
1078
1219
  * <p>This object contains the basic attributes of <code>VirtualMachine</code> contained by the output of
1079
1220
  * <code>GetVirtualMachine</code>
1080
1221
  * </p>
@@ -1086,14 +1227,17 @@ export interface GetVirtualMachineOutput {
1086
1227
  */
1087
1228
  export interface ListVirtualMachinesInput {
1088
1229
  /**
1230
+ * @public
1089
1231
  * <p>The Amazon Resource Name (ARN) of the hypervisor connected to your virtual machine.</p>
1090
1232
  */
1091
1233
  HypervisorArn?: string;
1092
1234
  /**
1235
+ * @public
1093
1236
  * <p>The maximum number of virtual machines to list.</p>
1094
1237
  */
1095
1238
  MaxResults?: number;
1096
1239
  /**
1240
+ * @public
1097
1241
  * <p>The next item following a partial list of returned resources. For example, if a request is
1098
1242
  * made to return <code>maxResults</code> number of resources, <code>NextToken</code> allows you
1099
1243
  * to return more items in your list starting at the location pointed to by the next
@@ -1107,27 +1251,33 @@ export interface ListVirtualMachinesInput {
1107
1251
  */
1108
1252
  export interface VirtualMachine {
1109
1253
  /**
1254
+ * @public
1110
1255
  * <p>The host name of the virtual machine.</p>
1111
1256
  */
1112
1257
  HostName?: string;
1113
1258
  /**
1259
+ * @public
1114
1260
  * <p>The ID of the virtual machine's hypervisor.</p>
1115
1261
  */
1116
1262
  HypervisorId?: string;
1117
1263
  /**
1264
+ * @public
1118
1265
  * <p>The name of the virtual machine.</p>
1119
1266
  */
1120
1267
  Name?: string;
1121
1268
  /**
1269
+ * @public
1122
1270
  * <p>The path of the virtual machine.</p>
1123
1271
  */
1124
1272
  Path?: string;
1125
1273
  /**
1274
+ * @public
1126
1275
  * <p>The Amazon Resource Name (ARN) of the virtual machine. For example,
1127
1276
  * <code>arn:aws:backup-gateway:us-west-1:0000000000000:vm/vm-0000ABCDEFGIJKL</code>.</p>
1128
1277
  */
1129
1278
  ResourceArn?: string;
1130
1279
  /**
1280
+ * @public
1131
1281
  * <p>The most recent date a virtual machine was backed up, in Unix format and UTC time.</p>
1132
1282
  */
1133
1283
  LastBackupDate?: Date;
@@ -1137,11 +1287,13 @@ export interface VirtualMachine {
1137
1287
  */
1138
1288
  export interface ListVirtualMachinesOutput {
1139
1289
  /**
1290
+ * @public
1140
1291
  * <p>A list of your <code>VirtualMachine</code> objects, ordered by their Amazon Resource Names
1141
1292
  * (ARNs).</p>
1142
1293
  */
1143
1294
  VirtualMachines?: VirtualMachine[];
1144
1295
  /**
1296
+ * @public
1145
1297
  * <p>The next item following a partial list of returned resources. For example, if a request is
1146
1298
  * made to return <code>maxResults</code> number of resources, <code>NextToken</code> allows you
1147
1299
  * to return more items in your list starting at the location pointed to by the next
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-backup-gateway",
3
3
  "description": "AWS SDK for JavaScript Backup Gateway Client for Node.js, Browser and React Native",
4
- "version": "3.379.1",
4
+ "version": "3.382.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.382.0",
25
+ "@aws-sdk/credential-provider-node": "3.382.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",