@aws-sdk/client-rbin 3.378.0 → 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.
@@ -1,4 +1,7 @@
1
1
  import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
2
+ /**
3
+ * @public
4
+ */
2
5
  export interface ClientInputEndpointParameters {
3
6
  region?: string | Provider<string>;
4
7
  useDualstackEndpoint?: boolean | Provider<boolean>;
@@ -18,6 +18,7 @@
18
18
  */
19
19
  export * from "./RbinClient";
20
20
  export * from "./Rbin";
21
+ export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
21
22
  export * from "./commands";
22
23
  export * from "./pagination";
23
24
  export * from "./models";
@@ -19,11 +19,13 @@ export type UnlockDelayUnit = (typeof UnlockDelayUnit)[keyof typeof UnlockDelayU
19
19
  */
20
20
  export interface UnlockDelay {
21
21
  /**
22
+ * @public
22
23
  * <p>The unlock delay period, measured in the unit specified for <b>
23
24
  * UnlockDelayUnit</b>.</p>
24
25
  */
25
26
  UnlockDelayValue: number | undefined;
26
27
  /**
28
+ * @public
27
29
  * <p>The unit of time in which to measure the unlock delay. Currently, the unlock delay can
28
30
  * be measure only in days.</p>
29
31
  */
@@ -35,6 +37,7 @@ export interface UnlockDelay {
35
37
  */
36
38
  export interface LockConfiguration {
37
39
  /**
40
+ * @public
38
41
  * <p>Information about the retention rule unlock delay.</p>
39
42
  */
40
43
  UnlockDelay: UnlockDelay | undefined;
@@ -46,10 +49,12 @@ export interface LockConfiguration {
46
49
  */
47
50
  export interface ResourceTag {
48
51
  /**
52
+ * @public
49
53
  * <p>The tag key.</p>
50
54
  */
51
55
  ResourceTagKey: string | undefined;
52
56
  /**
57
+ * @public
53
58
  * <p>The tag value.</p>
54
59
  */
55
60
  ResourceTagValue?: string;
@@ -83,11 +88,13 @@ export type RetentionPeriodUnit = (typeof RetentionPeriodUnit)[keyof typeof Rete
83
88
  */
84
89
  export interface RetentionPeriod {
85
90
  /**
91
+ * @public
86
92
  * <p>The period value for which the retention rule is to retain resources. The period is measured using
87
93
  * the unit specified for <b>RetentionPeriodUnit</b>.</p>
88
94
  */
89
95
  RetentionPeriodValue: number | undefined;
90
96
  /**
97
+ * @public
91
98
  * <p>The unit of time in which the retention period is measured. Currently, only <code>DAYS</code>
92
99
  * is supported.</p>
93
100
  */
@@ -99,10 +106,12 @@ export interface RetentionPeriod {
99
106
  */
100
107
  export interface Tag {
101
108
  /**
109
+ * @public
102
110
  * <p>The tag key.</p>
103
111
  */
104
112
  Key: string | undefined;
105
113
  /**
114
+ * @public
106
115
  * <p>The tag value.</p>
107
116
  */
108
117
  Value: string | undefined;
@@ -112,24 +121,29 @@ export interface Tag {
112
121
  */
113
122
  export interface CreateRuleRequest {
114
123
  /**
124
+ * @public
115
125
  * <p>Information about the retention period for which the retention rule is to retain resources.</p>
116
126
  */
117
127
  RetentionPeriod: RetentionPeriod | undefined;
118
128
  /**
129
+ * @public
119
130
  * <p>The retention rule description.</p>
120
131
  */
121
132
  Description?: string;
122
133
  /**
134
+ * @public
123
135
  * <p>Information about the tags to assign to the retention rule.</p>
124
136
  */
125
137
  Tags?: Tag[];
126
138
  /**
139
+ * @public
127
140
  * <p>The resource type to be retained by the retention rule. Currently, only Amazon EBS snapshots
128
141
  * and EBS-backed AMIs are supported. To retain snapshots, specify <code>EBS_SNAPSHOT</code>. To
129
142
  * retain EBS-backed AMIs, specify <code>EC2_IMAGE</code>.</p>
130
143
  */
131
144
  ResourceType: ResourceType | string | undefined;
132
145
  /**
146
+ * @public
133
147
  * <p>Specifies the resource tags to use to identify resources that are to be retained by a
134
148
  * tag-level retention rule. For tag-level retention rules, only deleted resources, of the specified resource type, that
135
149
  * have one or more of the specified tag key and value pairs are retained. If a resource is deleted, but it does not have
@@ -141,6 +155,7 @@ export interface CreateRuleRequest {
141
155
  */
142
156
  ResourceTags?: ResourceTag[];
143
157
  /**
158
+ * @public
144
159
  * <p>Information about the retention rule lock configuration.</p>
145
160
  */
146
161
  LockConfiguration?: LockConfiguration;
@@ -175,40 +190,49 @@ export type RuleStatus = (typeof RuleStatus)[keyof typeof RuleStatus];
175
190
  */
176
191
  export interface CreateRuleResponse {
177
192
  /**
193
+ * @public
178
194
  * <p>The unique ID of the retention rule.</p>
179
195
  */
180
196
  Identifier?: string;
181
197
  /**
198
+ * @public
182
199
  * <p>Information about the retention period for which the retention rule is to retain resources.</p>
183
200
  */
184
201
  RetentionPeriod?: RetentionPeriod;
185
202
  /**
203
+ * @public
186
204
  * <p>The retention rule description.</p>
187
205
  */
188
206
  Description?: string;
189
207
  /**
208
+ * @public
190
209
  * <p>Information about the tags assigned to the retention rule.</p>
191
210
  */
192
211
  Tags?: Tag[];
193
212
  /**
213
+ * @public
194
214
  * <p>The resource type retained by the retention rule.</p>
195
215
  */
196
216
  ResourceType?: ResourceType | string;
197
217
  /**
218
+ * @public
198
219
  * <p>Information about the resource tags used to identify resources that are retained by the retention
199
220
  * rule.</p>
200
221
  */
201
222
  ResourceTags?: ResourceTag[];
202
223
  /**
224
+ * @public
203
225
  * <p>The state of the retention rule. Only retention rules that are in the <code>available</code>
204
226
  * state retain resources.</p>
205
227
  */
206
228
  Status?: RuleStatus | string;
207
229
  /**
230
+ * @public
208
231
  * <p>Information about the retention rule lock configuration.</p>
209
232
  */
210
233
  LockConfiguration?: LockConfiguration;
211
234
  /**
235
+ * @public
212
236
  * <p>The lock state for the retention rule.</p>
213
237
  * <ul>
214
238
  * <li>
@@ -269,6 +293,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
269
293
  readonly $fault: "client";
270
294
  Message?: string;
271
295
  /**
296
+ * @public
272
297
  * <p>The reason for the exception.</p>
273
298
  */
274
299
  Reason?: ServiceQuotaExceededExceptionReason | string;
@@ -298,6 +323,7 @@ export declare class ValidationException extends __BaseException {
298
323
  readonly $fault: "client";
299
324
  Message?: string;
300
325
  /**
326
+ * @public
301
327
  * <p>The reason for the exception.</p>
302
328
  */
303
329
  Reason?: ValidationExceptionReason | string;
@@ -326,6 +352,7 @@ export declare class ConflictException extends __BaseException {
326
352
  readonly $fault: "client";
327
353
  Message?: string;
328
354
  /**
355
+ * @public
329
356
  * <p>The reason for the exception.</p>
330
357
  */
331
358
  Reason?: ConflictExceptionReason | string;
@@ -339,6 +366,7 @@ export declare class ConflictException extends __BaseException {
339
366
  */
340
367
  export interface DeleteRuleRequest {
341
368
  /**
369
+ * @public
342
370
  * <p>The unique ID of the retention rule.</p>
343
371
  */
344
372
  Identifier: string | undefined;
@@ -368,6 +396,7 @@ export declare class ResourceNotFoundException extends __BaseException {
368
396
  readonly $fault: "client";
369
397
  Message?: string;
370
398
  /**
399
+ * @public
371
400
  * <p>The reason for the exception.</p>
372
401
  */
373
402
  Reason?: ResourceNotFoundExceptionReason | string;
@@ -381,6 +410,7 @@ export declare class ResourceNotFoundException extends __BaseException {
381
410
  */
382
411
  export interface GetRuleRequest {
383
412
  /**
413
+ * @public
384
414
  * <p>The unique ID of the retention rule.</p>
385
415
  */
386
416
  Identifier: string | undefined;
@@ -390,36 +420,44 @@ export interface GetRuleRequest {
390
420
  */
391
421
  export interface GetRuleResponse {
392
422
  /**
423
+ * @public
393
424
  * <p>The unique ID of the retention rule.</p>
394
425
  */
395
426
  Identifier?: string;
396
427
  /**
428
+ * @public
397
429
  * <p>The retention rule description.</p>
398
430
  */
399
431
  Description?: string;
400
432
  /**
433
+ * @public
401
434
  * <p>The resource type retained by the retention rule.</p>
402
435
  */
403
436
  ResourceType?: ResourceType | string;
404
437
  /**
438
+ * @public
405
439
  * <p>Information about the retention period for which the retention rule is to retain resources.</p>
406
440
  */
407
441
  RetentionPeriod?: RetentionPeriod;
408
442
  /**
443
+ * @public
409
444
  * <p>Information about the resource tags used to identify resources that are retained by the retention
410
445
  * rule.</p>
411
446
  */
412
447
  ResourceTags?: ResourceTag[];
413
448
  /**
449
+ * @public
414
450
  * <p>The state of the retention rule. Only retention rules that are in the <code>available</code>
415
451
  * state retain resources.</p>
416
452
  */
417
453
  Status?: RuleStatus | string;
418
454
  /**
455
+ * @public
419
456
  * <p>Information about the retention rule lock configuration.</p>
420
457
  */
421
458
  LockConfiguration?: LockConfiguration;
422
459
  /**
460
+ * @public
423
461
  * <p>The lock state for the retention rule.</p>
424
462
  * <ul>
425
463
  * <li>
@@ -447,6 +485,7 @@ export interface GetRuleResponse {
447
485
  */
448
486
  LockState?: LockState | string;
449
487
  /**
488
+ * @public
450
489
  * <p>The date and time at which the unlock delay is set to expire. Only returned
451
490
  * for retention rules that have been unlocked and that are still within the unlock
452
491
  * delay period.</p>
@@ -458,15 +497,18 @@ export interface GetRuleResponse {
458
497
  */
459
498
  export interface ListRulesRequest {
460
499
  /**
500
+ * @public
461
501
  * <p>The maximum number of results to return with a single call.
462
502
  * To retrieve the remaining results, make another call with the returned <code>NextToken</code> value.</p>
463
503
  */
464
504
  MaxResults?: number;
465
505
  /**
506
+ * @public
466
507
  * <p>The token for the next page of results.</p>
467
508
  */
468
509
  NextToken?: string;
469
510
  /**
511
+ * @public
470
512
  * <p>The resource type retained by the retention rule. Only retention rules that retain
471
513
  * the specified resource type are listed. Currently, only Amazon EBS snapshots and EBS-backed
472
514
  * AMIs are supported. To list retention rules that retain snapshots, specify
@@ -475,11 +517,13 @@ export interface ListRulesRequest {
475
517
  */
476
518
  ResourceType: ResourceType | string | undefined;
477
519
  /**
520
+ * @public
478
521
  * <p>Information about the resource tags used to identify resources that are retained by the retention
479
522
  * rule.</p>
480
523
  */
481
524
  ResourceTags?: ResourceTag[];
482
525
  /**
526
+ * @public
483
527
  * <p>The lock state of the retention rules to list. Only retention rules with the specified
484
528
  * lock state are returned.</p>
485
529
  */
@@ -491,18 +535,22 @@ export interface ListRulesRequest {
491
535
  */
492
536
  export interface RuleSummary {
493
537
  /**
538
+ * @public
494
539
  * <p>The unique ID of the retention rule.</p>
495
540
  */
496
541
  Identifier?: string;
497
542
  /**
543
+ * @public
498
544
  * <p>The retention rule description.</p>
499
545
  */
500
546
  Description?: string;
501
547
  /**
548
+ * @public
502
549
  * <p>Information about the retention period for which the retention rule is to retain resources.</p>
503
550
  */
504
551
  RetentionPeriod?: RetentionPeriod;
505
552
  /**
553
+ * @public
506
554
  * <p>The lock state for the retention rule.</p>
507
555
  * <ul>
508
556
  * <li>
@@ -535,10 +583,12 @@ export interface RuleSummary {
535
583
  */
536
584
  export interface ListRulesResponse {
537
585
  /**
586
+ * @public
538
587
  * <p>Information about the retention rules.</p>
539
588
  */
540
589
  Rules?: RuleSummary[];
541
590
  /**
591
+ * @public
542
592
  * <p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>
543
593
  */
544
594
  NextToken?: string;
@@ -548,6 +598,7 @@ export interface ListRulesResponse {
548
598
  */
549
599
  export interface ListTagsForResourceRequest {
550
600
  /**
601
+ * @public
551
602
  * <p>The Amazon Resource Name (ARN) of the retention rule.</p>
552
603
  */
553
604
  ResourceArn: string | undefined;
@@ -557,6 +608,7 @@ export interface ListTagsForResourceRequest {
557
608
  */
558
609
  export interface ListTagsForResourceResponse {
559
610
  /**
611
+ * @public
560
612
  * <p>Information about the tags assigned to the retention rule.</p>
561
613
  */
562
614
  Tags?: Tag[];
@@ -566,10 +618,12 @@ export interface ListTagsForResourceResponse {
566
618
  */
567
619
  export interface LockRuleRequest {
568
620
  /**
621
+ * @public
569
622
  * <p>The unique ID of the retention rule.</p>
570
623
  */
571
624
  Identifier: string | undefined;
572
625
  /**
626
+ * @public
573
627
  * <p>Information about the retention rule lock configuration.</p>
574
628
  */
575
629
  LockConfiguration: LockConfiguration | undefined;
@@ -579,36 +633,44 @@ export interface LockRuleRequest {
579
633
  */
580
634
  export interface LockRuleResponse {
581
635
  /**
636
+ * @public
582
637
  * <p>The unique ID of the retention rule.</p>
583
638
  */
584
639
  Identifier?: string;
585
640
  /**
641
+ * @public
586
642
  * <p>The retention rule description.</p>
587
643
  */
588
644
  Description?: string;
589
645
  /**
646
+ * @public
590
647
  * <p>The resource type retained by the retention rule.</p>
591
648
  */
592
649
  ResourceType?: ResourceType | string;
593
650
  /**
651
+ * @public
594
652
  * <p>Information about the retention period for which the retention rule is to retain resources.</p>
595
653
  */
596
654
  RetentionPeriod?: RetentionPeriod;
597
655
  /**
656
+ * @public
598
657
  * <p>Information about the resource tags used to identify resources that are retained by the retention
599
658
  * rule.</p>
600
659
  */
601
660
  ResourceTags?: ResourceTag[];
602
661
  /**
662
+ * @public
603
663
  * <p>The state of the retention rule. Only retention rules that are in the <code>available</code>
604
664
  * state retain resources.</p>
605
665
  */
606
666
  Status?: RuleStatus | string;
607
667
  /**
668
+ * @public
608
669
  * <p>Information about the retention rule lock configuration.</p>
609
670
  */
610
671
  LockConfiguration?: LockConfiguration;
611
672
  /**
673
+ * @public
612
674
  * <p>The lock state for the retention rule.</p>
613
675
  * <ul>
614
676
  * <li>
@@ -641,10 +703,12 @@ export interface LockRuleResponse {
641
703
  */
642
704
  export interface TagResourceRequest {
643
705
  /**
706
+ * @public
644
707
  * <p>The Amazon Resource Name (ARN) of the retention rule.</p>
645
708
  */
646
709
  ResourceArn: string | undefined;
647
710
  /**
711
+ * @public
648
712
  * <p>Information about the tags to assign to the retention rule.</p>
649
713
  */
650
714
  Tags: Tag[] | undefined;
@@ -659,6 +723,7 @@ export interface TagResourceResponse {
659
723
  */
660
724
  export interface UnlockRuleRequest {
661
725
  /**
726
+ * @public
662
727
  * <p>The unique ID of the retention rule.</p>
663
728
  */
664
729
  Identifier: string | undefined;
@@ -668,36 +733,44 @@ export interface UnlockRuleRequest {
668
733
  */
669
734
  export interface UnlockRuleResponse {
670
735
  /**
736
+ * @public
671
737
  * <p>The unique ID of the retention rule.</p>
672
738
  */
673
739
  Identifier?: string;
674
740
  /**
741
+ * @public
675
742
  * <p>The retention rule description.</p>
676
743
  */
677
744
  Description?: string;
678
745
  /**
746
+ * @public
679
747
  * <p>The resource type retained by the retention rule.</p>
680
748
  */
681
749
  ResourceType?: ResourceType | string;
682
750
  /**
751
+ * @public
683
752
  * <p>Information about the retention period for which the retention rule is to retain resources.</p>
684
753
  */
685
754
  RetentionPeriod?: RetentionPeriod;
686
755
  /**
756
+ * @public
687
757
  * <p>Information about the resource tags used to identify resources that are retained by the retention
688
758
  * rule.</p>
689
759
  */
690
760
  ResourceTags?: ResourceTag[];
691
761
  /**
762
+ * @public
692
763
  * <p>The state of the retention rule. Only retention rules that are in the <code>available</code>
693
764
  * state retain resources.</p>
694
765
  */
695
766
  Status?: RuleStatus | string;
696
767
  /**
768
+ * @public
697
769
  * <p>Information about the retention rule lock configuration.</p>
698
770
  */
699
771
  LockConfiguration?: LockConfiguration;
700
772
  /**
773
+ * @public
701
774
  * <p>The lock state for the retention rule.</p>
702
775
  * <ul>
703
776
  * <li>
@@ -725,6 +798,7 @@ export interface UnlockRuleResponse {
725
798
  */
726
799
  LockState?: LockState | string;
727
800
  /**
801
+ * @public
728
802
  * <p>The date and time at which the unlock delay is set to expire. Only returned
729
803
  * for retention rules that have been unlocked and that are still within the unlock
730
804
  * delay period.</p>
@@ -736,10 +810,12 @@ export interface UnlockRuleResponse {
736
810
  */
737
811
  export interface UntagResourceRequest {
738
812
  /**
813
+ * @public
739
814
  * <p>The Amazon Resource Name (ARN) of the retention rule.</p>
740
815
  */
741
816
  ResourceArn: string | undefined;
742
817
  /**
818
+ * @public
743
819
  * <p>The tag keys of the tags to unassign. All tags that have the specified tag key are unassigned.</p>
744
820
  */
745
821
  TagKeys: string[] | undefined;
@@ -754,18 +830,22 @@ export interface UntagResourceResponse {
754
830
  */
755
831
  export interface UpdateRuleRequest {
756
832
  /**
833
+ * @public
757
834
  * <p>The unique ID of the retention rule.</p>
758
835
  */
759
836
  Identifier: string | undefined;
760
837
  /**
838
+ * @public
761
839
  * <p>Information about the retention period for which the retention rule is to retain resources.</p>
762
840
  */
763
841
  RetentionPeriod?: RetentionPeriod;
764
842
  /**
843
+ * @public
765
844
  * <p>The retention rule description.</p>
766
845
  */
767
846
  Description?: string;
768
847
  /**
848
+ * @public
769
849
  * <note>
770
850
  * <p>This parameter is currently not supported. You can't update a retention rule's resource type
771
851
  * after creation.</p>
@@ -773,6 +853,7 @@ export interface UpdateRuleRequest {
773
853
  */
774
854
  ResourceType?: ResourceType | string;
775
855
  /**
856
+ * @public
776
857
  * <p>Specifies the resource tags to use to identify resources that are to be retained by a
777
858
  * tag-level retention rule. For tag-level retention rules, only deleted resources, of the specified resource type, that
778
859
  * have one or more of the specified tag key and value pairs are retained. If a resource is deleted, but it does not have
@@ -789,32 +870,39 @@ export interface UpdateRuleRequest {
789
870
  */
790
871
  export interface UpdateRuleResponse {
791
872
  /**
873
+ * @public
792
874
  * <p>The unique ID of the retention rule.</p>
793
875
  */
794
876
  Identifier?: string;
795
877
  /**
878
+ * @public
796
879
  * <p>Information about the retention period for which the retention rule is to retain resources.</p>
797
880
  */
798
881
  RetentionPeriod?: RetentionPeriod;
799
882
  /**
883
+ * @public
800
884
  * <p>The retention rule description.</p>
801
885
  */
802
886
  Description?: string;
803
887
  /**
888
+ * @public
804
889
  * <p>The resource type retained by the retention rule.</p>
805
890
  */
806
891
  ResourceType?: ResourceType | string;
807
892
  /**
893
+ * @public
808
894
  * <p>Information about the resource tags used to identify resources that are retained by the retention
809
895
  * rule.</p>
810
896
  */
811
897
  ResourceTags?: ResourceTag[];
812
898
  /**
899
+ * @public
813
900
  * <p>The state of the retention rule. Only retention rules that are in the <code>available</code>
814
901
  * state retain resources.</p>
815
902
  */
816
903
  Status?: RuleStatus | string;
817
904
  /**
905
+ * @public
818
906
  * <p>The lock state for the retention rule.</p>
819
907
  * <ul>
820
908
  * <li>
@@ -842,6 +930,7 @@ export interface UpdateRuleResponse {
842
930
  */
843
931
  LockState?: LockState | string;
844
932
  /**
933
+ * @public
845
934
  * <p>The date and time at which the unlock delay is set to expire. Only returned
846
935
  * for retention rules that have been unlocked and that are still within the unlock
847
936
  * delay period.</p>
@@ -1,5 +1,6 @@
1
1
  export * from "./RbinClient";
2
2
  export * from "./Rbin";
3
+ export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
3
4
  export * from "./commands";
4
5
  export * from "./pagination";
5
6
  export * from "./models";
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-rbin",
3
3
  "description": "AWS SDK for JavaScript Rbin Client for Node.js, Browser and React Native",
4
- "version": "3.378.0",
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.378.0",
25
- "@aws-sdk/credential-provider-node": "3.378.0",
26
- "@aws-sdk/middleware-host-header": "3.378.0",
24
+ "@aws-sdk/client-sts": "3.382.0",
25
+ "@aws-sdk/credential-provider-node": "3.382.0",
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
- "@aws-sdk/middleware-signing": "3.378.0",
30
- "@aws-sdk/middleware-user-agent": "3.378.0",
29
+ "@aws-sdk/middleware-signing": "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",