@aws-sdk/client-fis 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.
@@ -6,10 +6,12 @@ import { FisServiceException as __BaseException } from "./FisServiceException";
6
6
  */
7
7
  export interface ActionParameter {
8
8
  /**
9
+ * @public
9
10
  * <p>The parameter description.</p>
10
11
  */
11
12
  description?: string;
12
13
  /**
14
+ * @public
13
15
  * <p>Indicates whether the parameter is required.</p>
14
16
  */
15
17
  required?: boolean;
@@ -20,6 +22,7 @@ export interface ActionParameter {
20
22
  */
21
23
  export interface ActionTarget {
22
24
  /**
25
+ * @public
23
26
  * <p>The resource type of the target.</p>
24
27
  */
25
28
  resourceType?: string;
@@ -31,22 +34,27 @@ export interface ActionTarget {
31
34
  */
32
35
  export interface Action {
33
36
  /**
37
+ * @public
34
38
  * <p>The ID of the action.</p>
35
39
  */
36
40
  id?: string;
37
41
  /**
42
+ * @public
38
43
  * <p>The description for the action.</p>
39
44
  */
40
45
  description?: string;
41
46
  /**
47
+ * @public
42
48
  * <p>The action parameters, if applicable.</p>
43
49
  */
44
50
  parameters?: Record<string, ActionParameter>;
45
51
  /**
52
+ * @public
46
53
  * <p>The supported targets for the action.</p>
47
54
  */
48
55
  targets?: Record<string, ActionTarget>;
49
56
  /**
57
+ * @public
50
58
  * <p>The tags for the action.</p>
51
59
  */
52
60
  tags?: Record<string, string>;
@@ -57,18 +65,22 @@ export interface Action {
57
65
  */
58
66
  export interface ActionSummary {
59
67
  /**
68
+ * @public
60
69
  * <p>The ID of the action.</p>
61
70
  */
62
71
  id?: string;
63
72
  /**
73
+ * @public
64
74
  * <p>The description for the action.</p>
65
75
  */
66
76
  description?: string;
67
77
  /**
78
+ * @public
68
79
  * <p>The targets for the action.</p>
69
80
  */
70
81
  targets?: Record<string, ActionTarget>;
71
82
  /**
83
+ * @public
72
84
  * <p>The tags for the action.</p>
73
85
  */
74
86
  tags?: Record<string, string>;
@@ -93,22 +105,27 @@ export declare class ConflictException extends __BaseException {
93
105
  */
94
106
  export interface CreateExperimentTemplateActionInput {
95
107
  /**
108
+ * @public
96
109
  * <p>The ID of the action. The format of the action ID is: aws:<i>service-name</i>:<i>action-type</i>.</p>
97
110
  */
98
111
  actionId: string | undefined;
99
112
  /**
113
+ * @public
100
114
  * <p>A description for the action.</p>
101
115
  */
102
116
  description?: string;
103
117
  /**
118
+ * @public
104
119
  * <p>The parameters for the action, if applicable.</p>
105
120
  */
106
121
  parameters?: Record<string, string>;
107
122
  /**
123
+ * @public
108
124
  * <p>The targets for the action.</p>
109
125
  */
110
126
  targets?: Record<string, string>;
111
127
  /**
128
+ * @public
112
129
  * <p>The name of the action that must be completed before the current action starts. Omit this parameter to run the action at the start of the experiment.</p>
113
130
  */
114
131
  startAfter?: string[];
@@ -119,6 +136,7 @@ export interface CreateExperimentTemplateActionInput {
119
136
  */
120
137
  export interface ExperimentTemplateCloudWatchLogsLogConfigurationInput {
121
138
  /**
139
+ * @public
122
140
  * <p>The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.</p>
123
141
  */
124
142
  logGroupArn: string | undefined;
@@ -129,10 +147,12 @@ export interface ExperimentTemplateCloudWatchLogsLogConfigurationInput {
129
147
  */
130
148
  export interface ExperimentTemplateS3LogConfigurationInput {
131
149
  /**
150
+ * @public
132
151
  * <p>The name of the destination bucket.</p>
133
152
  */
134
153
  bucketName: string | undefined;
135
154
  /**
155
+ * @public
136
156
  * <p>The bucket prefix.</p>
137
157
  */
138
158
  prefix?: string;
@@ -143,14 +163,17 @@ export interface ExperimentTemplateS3LogConfigurationInput {
143
163
  */
144
164
  export interface CreateExperimentTemplateLogConfigurationInput {
145
165
  /**
166
+ * @public
146
167
  * <p>The configuration for experiment logging to Amazon CloudWatch Logs.</p>
147
168
  */
148
169
  cloudWatchLogsConfiguration?: ExperimentTemplateCloudWatchLogsLogConfigurationInput;
149
170
  /**
171
+ * @public
150
172
  * <p>The configuration for experiment logging to Amazon S3.</p>
151
173
  */
152
174
  s3Configuration?: ExperimentTemplateS3LogConfigurationInput;
153
175
  /**
176
+ * @public
154
177
  * <p>The schema version.</p>
155
178
  */
156
179
  logSchemaVersion: number | undefined;
@@ -161,12 +184,14 @@ export interface CreateExperimentTemplateLogConfigurationInput {
161
184
  */
162
185
  export interface CreateExperimentTemplateStopConditionInput {
163
186
  /**
187
+ * @public
164
188
  * <p>The source for the stop condition. Specify <code>aws:cloudwatch:alarm</code> if the stop
165
189
  * condition is defined by a CloudWatch alarm. Specify <code>none</code> if there is no stop
166
190
  * condition.</p>
167
191
  */
168
192
  source: string | undefined;
169
193
  /**
194
+ * @public
170
195
  * <p>The Amazon Resource Name (ARN) of the CloudWatch alarm. This is required if the source is
171
196
  * a CloudWatch alarm.</p>
172
197
  */
@@ -180,10 +205,12 @@ export interface CreateExperimentTemplateStopConditionInput {
180
205
  */
181
206
  export interface ExperimentTemplateTargetInputFilter {
182
207
  /**
208
+ * @public
183
209
  * <p>The attribute path for the filter.</p>
184
210
  */
185
211
  path: string | undefined;
186
212
  /**
213
+ * @public
187
214
  * <p>The attribute values for the filter.</p>
188
215
  */
189
216
  values: string[] | undefined;
@@ -197,22 +224,27 @@ export interface ExperimentTemplateTargetInputFilter {
197
224
  */
198
225
  export interface CreateExperimentTemplateTargetInput {
199
226
  /**
227
+ * @public
200
228
  * <p>The resource type. The resource type must be supported for the specified action.</p>
201
229
  */
202
230
  resourceType: string | undefined;
203
231
  /**
232
+ * @public
204
233
  * <p>The Amazon Resource Names (ARNs) of the resources.</p>
205
234
  */
206
235
  resourceArns?: string[];
207
236
  /**
237
+ * @public
208
238
  * <p>The tags for the target resources.</p>
209
239
  */
210
240
  resourceTags?: Record<string, string>;
211
241
  /**
242
+ * @public
212
243
  * <p>The filters to apply to identify target resources using specific attributes.</p>
213
244
  */
214
245
  filters?: ExperimentTemplateTargetInputFilter[];
215
246
  /**
247
+ * @public
216
248
  * <p>Scopes the identified resources to a specific count of the resources at random, or a percentage of the resources. All identified resources are included in the target.</p>
217
249
  * <ul>
218
250
  * <li>
@@ -230,6 +262,7 @@ export interface CreateExperimentTemplateTargetInput {
230
262
  */
231
263
  selectionMode: string | undefined;
232
264
  /**
265
+ * @public
233
266
  * <p>The resource type parameters.</p>
234
267
  */
235
268
  parameters?: Record<string, string>;
@@ -239,34 +272,42 @@ export interface CreateExperimentTemplateTargetInput {
239
272
  */
240
273
  export interface CreateExperimentTemplateRequest {
241
274
  /**
275
+ * @public
242
276
  * <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
243
277
  */
244
278
  clientToken?: string;
245
279
  /**
280
+ * @public
246
281
  * <p>A description for the experiment template.</p>
247
282
  */
248
283
  description: string | undefined;
249
284
  /**
285
+ * @public
250
286
  * <p>The stop conditions.</p>
251
287
  */
252
288
  stopConditions: CreateExperimentTemplateStopConditionInput[] | undefined;
253
289
  /**
290
+ * @public
254
291
  * <p>The targets for the experiment.</p>
255
292
  */
256
293
  targets?: Record<string, CreateExperimentTemplateTargetInput>;
257
294
  /**
295
+ * @public
258
296
  * <p>The actions for the experiment.</p>
259
297
  */
260
298
  actions: Record<string, CreateExperimentTemplateActionInput> | undefined;
261
299
  /**
300
+ * @public
262
301
  * <p>The Amazon Resource Name (ARN) of an IAM role that grants the FIS service permission to perform service actions on your behalf.</p>
263
302
  */
264
303
  roleArn: string | undefined;
265
304
  /**
305
+ * @public
266
306
  * <p>The tags to apply to the experiment template.</p>
267
307
  */
268
308
  tags?: Record<string, string>;
269
309
  /**
310
+ * @public
270
311
  * <p>The configuration for experiment logging.</p>
271
312
  */
272
313
  logConfiguration?: CreateExperimentTemplateLogConfigurationInput;
@@ -277,22 +318,27 @@ export interface CreateExperimentTemplateRequest {
277
318
  */
278
319
  export interface ExperimentTemplateAction {
279
320
  /**
321
+ * @public
280
322
  * <p>The ID of the action.</p>
281
323
  */
282
324
  actionId?: string;
283
325
  /**
326
+ * @public
284
327
  * <p>A description for the action.</p>
285
328
  */
286
329
  description?: string;
287
330
  /**
331
+ * @public
288
332
  * <p>The parameters for the action.</p>
289
333
  */
290
334
  parameters?: Record<string, string>;
291
335
  /**
336
+ * @public
292
337
  * <p>The targets for the action.</p>
293
338
  */
294
339
  targets?: Record<string, string>;
295
340
  /**
341
+ * @public
296
342
  * <p>The name of the action that must be completed before the current action starts.</p>
297
343
  */
298
344
  startAfter?: string[];
@@ -303,6 +349,7 @@ export interface ExperimentTemplateAction {
303
349
  */
304
350
  export interface ExperimentTemplateCloudWatchLogsLogConfiguration {
305
351
  /**
352
+ * @public
306
353
  * <p>The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.</p>
307
354
  */
308
355
  logGroupArn?: string;
@@ -313,10 +360,12 @@ export interface ExperimentTemplateCloudWatchLogsLogConfiguration {
313
360
  */
314
361
  export interface ExperimentTemplateS3LogConfiguration {
315
362
  /**
363
+ * @public
316
364
  * <p>The name of the destination bucket.</p>
317
365
  */
318
366
  bucketName?: string;
319
367
  /**
368
+ * @public
320
369
  * <p>The bucket prefix.</p>
321
370
  */
322
371
  prefix?: string;
@@ -327,14 +376,17 @@ export interface ExperimentTemplateS3LogConfiguration {
327
376
  */
328
377
  export interface ExperimentTemplateLogConfiguration {
329
378
  /**
379
+ * @public
330
380
  * <p>The configuration for experiment logging to Amazon CloudWatch Logs.</p>
331
381
  */
332
382
  cloudWatchLogsConfiguration?: ExperimentTemplateCloudWatchLogsLogConfiguration;
333
383
  /**
384
+ * @public
334
385
  * <p>The configuration for experiment logging to Amazon S3.</p>
335
386
  */
336
387
  s3Configuration?: ExperimentTemplateS3LogConfiguration;
337
388
  /**
389
+ * @public
338
390
  * <p>The schema version.</p>
339
391
  */
340
392
  logSchemaVersion?: number;
@@ -345,10 +397,12 @@ export interface ExperimentTemplateLogConfiguration {
345
397
  */
346
398
  export interface ExperimentTemplateStopCondition {
347
399
  /**
400
+ * @public
348
401
  * <p>The source for the stop condition.</p>
349
402
  */
350
403
  source?: string;
351
404
  /**
405
+ * @public
352
406
  * <p>The Amazon Resource Name (ARN) of the CloudWatch alarm, if applicable.</p>
353
407
  */
354
408
  value?: string;
@@ -359,10 +413,12 @@ export interface ExperimentTemplateStopCondition {
359
413
  */
360
414
  export interface ExperimentTemplateTargetFilter {
361
415
  /**
416
+ * @public
362
417
  * <p>The attribute path for the filter.</p>
363
418
  */
364
419
  path?: string;
365
420
  /**
421
+ * @public
366
422
  * <p>The attribute values for the filter.</p>
367
423
  */
368
424
  values?: string[];
@@ -373,26 +429,32 @@ export interface ExperimentTemplateTargetFilter {
373
429
  */
374
430
  export interface ExperimentTemplateTarget {
375
431
  /**
432
+ * @public
376
433
  * <p>The resource type.</p>
377
434
  */
378
435
  resourceType?: string;
379
436
  /**
437
+ * @public
380
438
  * <p>The Amazon Resource Names (ARNs) of the targets.</p>
381
439
  */
382
440
  resourceArns?: string[];
383
441
  /**
442
+ * @public
384
443
  * <p>The tags for the target resources.</p>
385
444
  */
386
445
  resourceTags?: Record<string, string>;
387
446
  /**
447
+ * @public
388
448
  * <p>The filters to apply to identify target resources using specific attributes.</p>
389
449
  */
390
450
  filters?: ExperimentTemplateTargetFilter[];
391
451
  /**
452
+ * @public
392
453
  * <p>Scopes the identified resources to a specific count or percentage.</p>
393
454
  */
394
455
  selectionMode?: string;
395
456
  /**
457
+ * @public
396
458
  * <p>The resource type parameters.</p>
397
459
  */
398
460
  parameters?: Record<string, string>;
@@ -403,42 +465,52 @@ export interface ExperimentTemplateTarget {
403
465
  */
404
466
  export interface ExperimentTemplate {
405
467
  /**
468
+ * @public
406
469
  * <p>The ID of the experiment template.</p>
407
470
  */
408
471
  id?: string;
409
472
  /**
473
+ * @public
410
474
  * <p>The description for the experiment template.</p>
411
475
  */
412
476
  description?: string;
413
477
  /**
478
+ * @public
414
479
  * <p>The targets for the experiment.</p>
415
480
  */
416
481
  targets?: Record<string, ExperimentTemplateTarget>;
417
482
  /**
483
+ * @public
418
484
  * <p>The actions for the experiment.</p>
419
485
  */
420
486
  actions?: Record<string, ExperimentTemplateAction>;
421
487
  /**
488
+ * @public
422
489
  * <p>The stop conditions for the experiment.</p>
423
490
  */
424
491
  stopConditions?: ExperimentTemplateStopCondition[];
425
492
  /**
493
+ * @public
426
494
  * <p>The time the experiment template was created.</p>
427
495
  */
428
496
  creationTime?: Date;
429
497
  /**
498
+ * @public
430
499
  * <p>The time the experiment template was last updated.</p>
431
500
  */
432
501
  lastUpdateTime?: Date;
433
502
  /**
503
+ * @public
434
504
  * <p>The Amazon Resource Name (ARN) of an IAM role.</p>
435
505
  */
436
506
  roleArn?: string;
437
507
  /**
508
+ * @public
438
509
  * <p>The tags for the experiment template.</p>
439
510
  */
440
511
  tags?: Record<string, string>;
441
512
  /**
513
+ * @public
442
514
  * <p>The configuration for experiment logging.</p>
443
515
  */
444
516
  logConfiguration?: ExperimentTemplateLogConfiguration;
@@ -448,6 +520,7 @@ export interface ExperimentTemplate {
448
520
  */
449
521
  export interface CreateExperimentTemplateResponse {
450
522
  /**
523
+ * @public
451
524
  * <p>Information about the experiment template.</p>
452
525
  */
453
526
  experimentTemplate?: ExperimentTemplate;
@@ -493,6 +566,7 @@ export declare class ValidationException extends __BaseException {
493
566
  */
494
567
  export interface DeleteExperimentTemplateRequest {
495
568
  /**
569
+ * @public
496
570
  * <p>The ID of the experiment template.</p>
497
571
  */
498
572
  id: string | undefined;
@@ -502,6 +576,7 @@ export interface DeleteExperimentTemplateRequest {
502
576
  */
503
577
  export interface DeleteExperimentTemplateResponse {
504
578
  /**
579
+ * @public
505
580
  * <p>Information about the experiment template.</p>
506
581
  */
507
582
  experimentTemplate?: ExperimentTemplate;
@@ -530,10 +605,12 @@ export type ExperimentActionStatus = (typeof ExperimentActionStatus)[keyof typeo
530
605
  */
531
606
  export interface ExperimentActionState {
532
607
  /**
608
+ * @public
533
609
  * <p>The state of the action.</p>
534
610
  */
535
611
  status?: ExperimentActionStatus | string;
536
612
  /**
613
+ * @public
537
614
  * <p>The reason for the state.</p>
538
615
  */
539
616
  reason?: string;
@@ -544,34 +621,42 @@ export interface ExperimentActionState {
544
621
  */
545
622
  export interface ExperimentAction {
546
623
  /**
624
+ * @public
547
625
  * <p>The ID of the action.</p>
548
626
  */
549
627
  actionId?: string;
550
628
  /**
629
+ * @public
551
630
  * <p>The description for the action.</p>
552
631
  */
553
632
  description?: string;
554
633
  /**
634
+ * @public
555
635
  * <p>The parameters for the action.</p>
556
636
  */
557
637
  parameters?: Record<string, string>;
558
638
  /**
639
+ * @public
559
640
  * <p>The targets for the action.</p>
560
641
  */
561
642
  targets?: Record<string, string>;
562
643
  /**
644
+ * @public
563
645
  * <p>The name of the action that must be completed before this action starts.</p>
564
646
  */
565
647
  startAfter?: string[];
566
648
  /**
649
+ * @public
567
650
  * <p>The state of the action.</p>
568
651
  */
569
652
  state?: ExperimentActionState;
570
653
  /**
654
+ * @public
571
655
  * <p>The time that the action started.</p>
572
656
  */
573
657
  startTime?: Date;
574
658
  /**
659
+ * @public
575
660
  * <p>The time that the action ended.</p>
576
661
  */
577
662
  endTime?: Date;
@@ -582,6 +667,7 @@ export interface ExperimentAction {
582
667
  */
583
668
  export interface ExperimentCloudWatchLogsLogConfiguration {
584
669
  /**
670
+ * @public
585
671
  * <p>The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.</p>
586
672
  */
587
673
  logGroupArn?: string;
@@ -592,10 +678,12 @@ export interface ExperimentCloudWatchLogsLogConfiguration {
592
678
  */
593
679
  export interface ExperimentS3LogConfiguration {
594
680
  /**
681
+ * @public
595
682
  * <p>The name of the destination bucket.</p>
596
683
  */
597
684
  bucketName?: string;
598
685
  /**
686
+ * @public
599
687
  * <p>The bucket prefix.</p>
600
688
  */
601
689
  prefix?: string;
@@ -606,14 +694,17 @@ export interface ExperimentS3LogConfiguration {
606
694
  */
607
695
  export interface ExperimentLogConfiguration {
608
696
  /**
697
+ * @public
609
698
  * <p>The configuration for experiment logging to Amazon CloudWatch Logs.</p>
610
699
  */
611
700
  cloudWatchLogsConfiguration?: ExperimentCloudWatchLogsLogConfiguration;
612
701
  /**
702
+ * @public
613
703
  * <p>The configuration for experiment logging to Amazon S3.</p>
614
704
  */
615
705
  s3Configuration?: ExperimentS3LogConfiguration;
616
706
  /**
707
+ * @public
617
708
  * <p>The schema version.</p>
618
709
  */
619
710
  logSchemaVersion?: number;
@@ -641,10 +732,12 @@ export type ExperimentStatus = (typeof ExperimentStatus)[keyof typeof Experiment
641
732
  */
642
733
  export interface ExperimentState {
643
734
  /**
735
+ * @public
644
736
  * <p>The state of the experiment.</p>
645
737
  */
646
738
  status?: ExperimentStatus | string;
647
739
  /**
740
+ * @public
648
741
  * <p>The reason for the state.</p>
649
742
  */
650
743
  reason?: string;
@@ -655,10 +748,12 @@ export interface ExperimentState {
655
748
  */
656
749
  export interface ExperimentStopCondition {
657
750
  /**
751
+ * @public
658
752
  * <p>The source for the stop condition.</p>
659
753
  */
660
754
  source?: string;
661
755
  /**
756
+ * @public
662
757
  * <p>The Amazon Resource Name (ARN) of the CloudWatch alarm, if applicable.</p>
663
758
  */
664
759
  value?: string;
@@ -669,10 +764,12 @@ export interface ExperimentStopCondition {
669
764
  */
670
765
  export interface ExperimentTargetFilter {
671
766
  /**
767
+ * @public
672
768
  * <p>The attribute path for the filter.</p>
673
769
  */
674
770
  path?: string;
675
771
  /**
772
+ * @public
676
773
  * <p>The attribute values for the filter.</p>
677
774
  */
678
775
  values?: string[];
@@ -683,26 +780,32 @@ export interface ExperimentTargetFilter {
683
780
  */
684
781
  export interface ExperimentTarget {
685
782
  /**
783
+ * @public
686
784
  * <p>The resource type.</p>
687
785
  */
688
786
  resourceType?: string;
689
787
  /**
788
+ * @public
690
789
  * <p>The Amazon Resource Names (ARNs) of the resources.</p>
691
790
  */
692
791
  resourceArns?: string[];
693
792
  /**
793
+ * @public
694
794
  * <p>The tags for the target resources.</p>
695
795
  */
696
796
  resourceTags?: Record<string, string>;
697
797
  /**
798
+ * @public
698
799
  * <p>The filters to apply to identify target resources using specific attributes.</p>
699
800
  */
700
801
  filters?: ExperimentTargetFilter[];
701
802
  /**
803
+ * @public
702
804
  * <p>Scopes the identified resources to a specific count or percentage.</p>
703
805
  */
704
806
  selectionMode?: string;
705
807
  /**
808
+ * @public
706
809
  * <p>The resource type parameters.</p>
707
810
  */
708
811
  parameters?: Record<string, string>;
@@ -713,50 +816,62 @@ export interface ExperimentTarget {
713
816
  */
714
817
  export interface Experiment {
715
818
  /**
819
+ * @public
716
820
  * <p>The ID of the experiment.</p>
717
821
  */
718
822
  id?: string;
719
823
  /**
824
+ * @public
720
825
  * <p>The ID of the experiment template.</p>
721
826
  */
722
827
  experimentTemplateId?: string;
723
828
  /**
829
+ * @public
724
830
  * <p>The Amazon Resource Name (ARN) of an IAM role that grants the FIS service permission to perform service actions on your behalf.</p>
725
831
  */
726
832
  roleArn?: string;
727
833
  /**
834
+ * @public
728
835
  * <p>The state of the experiment.</p>
729
836
  */
730
837
  state?: ExperimentState;
731
838
  /**
839
+ * @public
732
840
  * <p>The targets for the experiment.</p>
733
841
  */
734
842
  targets?: Record<string, ExperimentTarget>;
735
843
  /**
844
+ * @public
736
845
  * <p>The actions for the experiment.</p>
737
846
  */
738
847
  actions?: Record<string, ExperimentAction>;
739
848
  /**
849
+ * @public
740
850
  * <p>The stop conditions for the experiment.</p>
741
851
  */
742
852
  stopConditions?: ExperimentStopCondition[];
743
853
  /**
854
+ * @public
744
855
  * <p>The time that the experiment was created.</p>
745
856
  */
746
857
  creationTime?: Date;
747
858
  /**
859
+ * @public
748
860
  * <p>The time that the experiment started.</p>
749
861
  */
750
862
  startTime?: Date;
751
863
  /**
864
+ * @public
752
865
  * <p>The time that the experiment ended.</p>
753
866
  */
754
867
  endTime?: Date;
755
868
  /**
869
+ * @public
756
870
  * <p>The tags for the experiment.</p>
757
871
  */
758
872
  tags?: Record<string, string>;
759
873
  /**
874
+ * @public
760
875
  * <p>The configuration for experiment logging.</p>
761
876
  */
762
877
  logConfiguration?: ExperimentLogConfiguration;
@@ -767,22 +882,27 @@ export interface Experiment {
767
882
  */
768
883
  export interface ExperimentSummary {
769
884
  /**
885
+ * @public
770
886
  * <p>The ID of the experiment.</p>
771
887
  */
772
888
  id?: string;
773
889
  /**
890
+ * @public
774
891
  * <p>The ID of the experiment template.</p>
775
892
  */
776
893
  experimentTemplateId?: string;
777
894
  /**
895
+ * @public
778
896
  * <p>The state of the experiment.</p>
779
897
  */
780
898
  state?: ExperimentState;
781
899
  /**
900
+ * @public
782
901
  * <p>The time that the experiment was created.</p>
783
902
  */
784
903
  creationTime?: Date;
785
904
  /**
905
+ * @public
786
906
  * <p>The tags for the experiment.</p>
787
907
  */
788
908
  tags?: Record<string, string>;
@@ -793,22 +913,27 @@ export interface ExperimentSummary {
793
913
  */
794
914
  export interface ExperimentTemplateSummary {
795
915
  /**
916
+ * @public
796
917
  * <p>The ID of the experiment template.</p>
797
918
  */
798
919
  id?: string;
799
920
  /**
921
+ * @public
800
922
  * <p>The description of the experiment template.</p>
801
923
  */
802
924
  description?: string;
803
925
  /**
926
+ * @public
804
927
  * <p>The time that the experiment template was created.</p>
805
928
  */
806
929
  creationTime?: Date;
807
930
  /**
931
+ * @public
808
932
  * <p>The time that the experiment template was last updated.</p>
809
933
  */
810
934
  lastUpdateTime?: Date;
811
935
  /**
936
+ * @public
812
937
  * <p>The tags for the experiment template.</p>
813
938
  */
814
939
  tags?: Record<string, string>;
@@ -818,6 +943,7 @@ export interface ExperimentTemplateSummary {
818
943
  */
819
944
  export interface GetActionRequest {
820
945
  /**
946
+ * @public
821
947
  * <p>The ID of the action.</p>
822
948
  */
823
949
  id: string | undefined;
@@ -827,6 +953,7 @@ export interface GetActionRequest {
827
953
  */
828
954
  export interface GetActionResponse {
829
955
  /**
956
+ * @public
830
957
  * <p>Information about the action.</p>
831
958
  */
832
959
  action?: Action;
@@ -836,6 +963,7 @@ export interface GetActionResponse {
836
963
  */
837
964
  export interface GetExperimentRequest {
838
965
  /**
966
+ * @public
839
967
  * <p>The ID of the experiment.</p>
840
968
  */
841
969
  id: string | undefined;
@@ -845,6 +973,7 @@ export interface GetExperimentRequest {
845
973
  */
846
974
  export interface GetExperimentResponse {
847
975
  /**
976
+ * @public
848
977
  * <p>Information about the experiment.</p>
849
978
  */
850
979
  experiment?: Experiment;
@@ -854,6 +983,7 @@ export interface GetExperimentResponse {
854
983
  */
855
984
  export interface GetExperimentTemplateRequest {
856
985
  /**
986
+ * @public
857
987
  * <p>The ID of the experiment template.</p>
858
988
  */
859
989
  id: string | undefined;
@@ -863,6 +993,7 @@ export interface GetExperimentTemplateRequest {
863
993
  */
864
994
  export interface GetExperimentTemplateResponse {
865
995
  /**
996
+ * @public
866
997
  * <p>Information about the experiment template.</p>
867
998
  */
868
999
  experimentTemplate?: ExperimentTemplate;
@@ -872,6 +1003,7 @@ export interface GetExperimentTemplateResponse {
872
1003
  */
873
1004
  export interface GetTargetResourceTypeRequest {
874
1005
  /**
1006
+ * @public
875
1007
  * <p>The resource type.</p>
876
1008
  */
877
1009
  resourceType: string | undefined;
@@ -883,10 +1015,12 @@ export interface GetTargetResourceTypeRequest {
883
1015
  */
884
1016
  export interface TargetResourceTypeParameter {
885
1017
  /**
1018
+ * @public
886
1019
  * <p>A description of the parameter.</p>
887
1020
  */
888
1021
  description?: string;
889
1022
  /**
1023
+ * @public
890
1024
  * <p>Indicates whether the parameter is required.</p>
891
1025
  */
892
1026
  required?: boolean;
@@ -897,14 +1031,17 @@ export interface TargetResourceTypeParameter {
897
1031
  */
898
1032
  export interface TargetResourceType {
899
1033
  /**
1034
+ * @public
900
1035
  * <p>The resource type.</p>
901
1036
  */
902
1037
  resourceType?: string;
903
1038
  /**
1039
+ * @public
904
1040
  * <p>A description of the resource type.</p>
905
1041
  */
906
1042
  description?: string;
907
1043
  /**
1044
+ * @public
908
1045
  * <p>The parameters for the resource type.</p>
909
1046
  */
910
1047
  parameters?: Record<string, TargetResourceTypeParameter>;
@@ -914,6 +1051,7 @@ export interface TargetResourceType {
914
1051
  */
915
1052
  export interface GetTargetResourceTypeResponse {
916
1053
  /**
1054
+ * @public
917
1055
  * <p>Information about the resource type.</p>
918
1056
  */
919
1057
  targetResourceType?: TargetResourceType;
@@ -923,10 +1061,12 @@ export interface GetTargetResourceTypeResponse {
923
1061
  */
924
1062
  export interface ListActionsRequest {
925
1063
  /**
1064
+ * @public
926
1065
  * <p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
927
1066
  */
928
1067
  maxResults?: number;
929
1068
  /**
1069
+ * @public
930
1070
  * <p>The token for the next page of results.</p>
931
1071
  */
932
1072
  nextToken?: string;
@@ -936,10 +1076,12 @@ export interface ListActionsRequest {
936
1076
  */
937
1077
  export interface ListActionsResponse {
938
1078
  /**
1079
+ * @public
939
1080
  * <p>The actions.</p>
940
1081
  */
941
1082
  actions?: ActionSummary[];
942
1083
  /**
1084
+ * @public
943
1085
  * <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>
944
1086
  */
945
1087
  nextToken?: string;
@@ -949,10 +1091,12 @@ export interface ListActionsResponse {
949
1091
  */
950
1092
  export interface ListExperimentsRequest {
951
1093
  /**
1094
+ * @public
952
1095
  * <p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
953
1096
  */
954
1097
  maxResults?: number;
955
1098
  /**
1099
+ * @public
956
1100
  * <p>The token for the next page of results.</p>
957
1101
  */
958
1102
  nextToken?: string;
@@ -962,10 +1106,12 @@ export interface ListExperimentsRequest {
962
1106
  */
963
1107
  export interface ListExperimentsResponse {
964
1108
  /**
1109
+ * @public
965
1110
  * <p>The experiments.</p>
966
1111
  */
967
1112
  experiments?: ExperimentSummary[];
968
1113
  /**
1114
+ * @public
969
1115
  * <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>
970
1116
  */
971
1117
  nextToken?: string;
@@ -975,10 +1121,12 @@ export interface ListExperimentsResponse {
975
1121
  */
976
1122
  export interface ListExperimentTemplatesRequest {
977
1123
  /**
1124
+ * @public
978
1125
  * <p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
979
1126
  */
980
1127
  maxResults?: number;
981
1128
  /**
1129
+ * @public
982
1130
  * <p>The token for the next page of results.</p>
983
1131
  */
984
1132
  nextToken?: string;
@@ -988,10 +1136,12 @@ export interface ListExperimentTemplatesRequest {
988
1136
  */
989
1137
  export interface ListExperimentTemplatesResponse {
990
1138
  /**
1139
+ * @public
991
1140
  * <p>The experiment templates.</p>
992
1141
  */
993
1142
  experimentTemplates?: ExperimentTemplateSummary[];
994
1143
  /**
1144
+ * @public
995
1145
  * <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>
996
1146
  */
997
1147
  nextToken?: string;
@@ -1001,6 +1151,7 @@ export interface ListExperimentTemplatesResponse {
1001
1151
  */
1002
1152
  export interface ListTagsForResourceRequest {
1003
1153
  /**
1154
+ * @public
1004
1155
  * <p>The Amazon Resource Name (ARN) of the resource.</p>
1005
1156
  */
1006
1157
  resourceArn: string | undefined;
@@ -1010,6 +1161,7 @@ export interface ListTagsForResourceRequest {
1010
1161
  */
1011
1162
  export interface ListTagsForResourceResponse {
1012
1163
  /**
1164
+ * @public
1013
1165
  * <p>The tags for the resource.</p>
1014
1166
  */
1015
1167
  tags?: Record<string, string>;
@@ -1019,10 +1171,12 @@ export interface ListTagsForResourceResponse {
1019
1171
  */
1020
1172
  export interface ListTargetResourceTypesRequest {
1021
1173
  /**
1174
+ * @public
1022
1175
  * <p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
1023
1176
  */
1024
1177
  maxResults?: number;
1025
1178
  /**
1179
+ * @public
1026
1180
  * <p>The token for the next page of results.</p>
1027
1181
  */
1028
1182
  nextToken?: string;
@@ -1033,10 +1187,12 @@ export interface ListTargetResourceTypesRequest {
1033
1187
  */
1034
1188
  export interface TargetResourceTypeSummary {
1035
1189
  /**
1190
+ * @public
1036
1191
  * <p>The resource type.</p>
1037
1192
  */
1038
1193
  resourceType?: string;
1039
1194
  /**
1195
+ * @public
1040
1196
  * <p>A description of the resource type.</p>
1041
1197
  */
1042
1198
  description?: string;
@@ -1046,10 +1202,12 @@ export interface TargetResourceTypeSummary {
1046
1202
  */
1047
1203
  export interface ListTargetResourceTypesResponse {
1048
1204
  /**
1205
+ * @public
1049
1206
  * <p>The target resource types.</p>
1050
1207
  */
1051
1208
  targetResourceTypes?: TargetResourceTypeSummary[];
1052
1209
  /**
1210
+ * @public
1053
1211
  * <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>
1054
1212
  */
1055
1213
  nextToken?: string;
@@ -1059,14 +1217,17 @@ export interface ListTargetResourceTypesResponse {
1059
1217
  */
1060
1218
  export interface StartExperimentRequest {
1061
1219
  /**
1220
+ * @public
1062
1221
  * <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
1063
1222
  */
1064
1223
  clientToken?: string;
1065
1224
  /**
1225
+ * @public
1066
1226
  * <p>The ID of the experiment template.</p>
1067
1227
  */
1068
1228
  experimentTemplateId: string | undefined;
1069
1229
  /**
1230
+ * @public
1070
1231
  * <p>The tags to apply to the experiment.</p>
1071
1232
  */
1072
1233
  tags?: Record<string, string>;
@@ -1076,6 +1237,7 @@ export interface StartExperimentRequest {
1076
1237
  */
1077
1238
  export interface StartExperimentResponse {
1078
1239
  /**
1240
+ * @public
1079
1241
  * <p>Information about the experiment.</p>
1080
1242
  */
1081
1243
  experiment?: Experiment;
@@ -1085,6 +1247,7 @@ export interface StartExperimentResponse {
1085
1247
  */
1086
1248
  export interface StopExperimentRequest {
1087
1249
  /**
1250
+ * @public
1088
1251
  * <p>The ID of the experiment.</p>
1089
1252
  */
1090
1253
  id: string | undefined;
@@ -1094,6 +1257,7 @@ export interface StopExperimentRequest {
1094
1257
  */
1095
1258
  export interface StopExperimentResponse {
1096
1259
  /**
1260
+ * @public
1097
1261
  * <p>Information about the experiment.</p>
1098
1262
  */
1099
1263
  experiment?: Experiment;
@@ -1103,10 +1267,12 @@ export interface StopExperimentResponse {
1103
1267
  */
1104
1268
  export interface TagResourceRequest {
1105
1269
  /**
1270
+ * @public
1106
1271
  * <p>The Amazon Resource Name (ARN) of the resource.</p>
1107
1272
  */
1108
1273
  resourceArn: string | undefined;
1109
1274
  /**
1275
+ * @public
1110
1276
  * <p>The tags for the resource.</p>
1111
1277
  */
1112
1278
  tags: Record<string, string> | undefined;
@@ -1121,10 +1287,12 @@ export interface TagResourceResponse {
1121
1287
  */
1122
1288
  export interface UntagResourceRequest {
1123
1289
  /**
1290
+ * @public
1124
1291
  * <p>The Amazon Resource Name (ARN) of the resource.</p>
1125
1292
  */
1126
1293
  resourceArn: string | undefined;
1127
1294
  /**
1295
+ * @public
1128
1296
  * <p>The tag keys to remove.</p>
1129
1297
  */
1130
1298
  tagKeys?: string[];
@@ -1140,22 +1308,27 @@ export interface UntagResourceResponse {
1140
1308
  */
1141
1309
  export interface UpdateExperimentTemplateActionInputItem {
1142
1310
  /**
1311
+ * @public
1143
1312
  * <p>The ID of the action.</p>
1144
1313
  */
1145
1314
  actionId?: string;
1146
1315
  /**
1316
+ * @public
1147
1317
  * <p>A description for the action.</p>
1148
1318
  */
1149
1319
  description?: string;
1150
1320
  /**
1321
+ * @public
1151
1322
  * <p>The parameters for the action, if applicable.</p>
1152
1323
  */
1153
1324
  parameters?: Record<string, string>;
1154
1325
  /**
1326
+ * @public
1155
1327
  * <p>The targets for the action.</p>
1156
1328
  */
1157
1329
  targets?: Record<string, string>;
1158
1330
  /**
1331
+ * @public
1159
1332
  * <p>The name of the action that must be completed before the current action starts. Omit this parameter to run the action at the start of the experiment.</p>
1160
1333
  */
1161
1334
  startAfter?: string[];
@@ -1166,14 +1339,17 @@ export interface UpdateExperimentTemplateActionInputItem {
1166
1339
  */
1167
1340
  export interface UpdateExperimentTemplateLogConfigurationInput {
1168
1341
  /**
1342
+ * @public
1169
1343
  * <p>The configuration for experiment logging to Amazon CloudWatch Logs.</p>
1170
1344
  */
1171
1345
  cloudWatchLogsConfiguration?: ExperimentTemplateCloudWatchLogsLogConfigurationInput;
1172
1346
  /**
1347
+ * @public
1173
1348
  * <p>The configuration for experiment logging to Amazon S3.</p>
1174
1349
  */
1175
1350
  s3Configuration?: ExperimentTemplateS3LogConfigurationInput;
1176
1351
  /**
1352
+ * @public
1177
1353
  * <p>The schema version.</p>
1178
1354
  */
1179
1355
  logSchemaVersion?: number;
@@ -1184,12 +1360,14 @@ export interface UpdateExperimentTemplateLogConfigurationInput {
1184
1360
  */
1185
1361
  export interface UpdateExperimentTemplateStopConditionInput {
1186
1362
  /**
1363
+ * @public
1187
1364
  * <p>The source for the stop condition. Specify <code>aws:cloudwatch:alarm</code> if the stop
1188
1365
  * condition is defined by a CloudWatch alarm. Specify <code>none</code> if there is no stop
1189
1366
  * condition.</p>
1190
1367
  */
1191
1368
  source: string | undefined;
1192
1369
  /**
1370
+ * @public
1193
1371
  * <p>The Amazon Resource Name (ARN) of the CloudWatch alarm.</p>
1194
1372
  */
1195
1373
  value?: string;
@@ -1200,26 +1378,32 @@ export interface UpdateExperimentTemplateStopConditionInput {
1200
1378
  */
1201
1379
  export interface UpdateExperimentTemplateTargetInput {
1202
1380
  /**
1381
+ * @public
1203
1382
  * <p>The resource type. The resource type must be supported for the specified action.</p>
1204
1383
  */
1205
1384
  resourceType: string | undefined;
1206
1385
  /**
1386
+ * @public
1207
1387
  * <p>The Amazon Resource Names (ARNs) of the targets.</p>
1208
1388
  */
1209
1389
  resourceArns?: string[];
1210
1390
  /**
1391
+ * @public
1211
1392
  * <p>The tags for the target resources.</p>
1212
1393
  */
1213
1394
  resourceTags?: Record<string, string>;
1214
1395
  /**
1396
+ * @public
1215
1397
  * <p>The filters to apply to identify target resources using specific attributes.</p>
1216
1398
  */
1217
1399
  filters?: ExperimentTemplateTargetInputFilter[];
1218
1400
  /**
1401
+ * @public
1219
1402
  * <p>Scopes the identified resources to a specific count or percentage.</p>
1220
1403
  */
1221
1404
  selectionMode: string | undefined;
1222
1405
  /**
1406
+ * @public
1223
1407
  * <p>The resource type parameters.</p>
1224
1408
  */
1225
1409
  parameters?: Record<string, string>;
@@ -1229,30 +1413,37 @@ export interface UpdateExperimentTemplateTargetInput {
1229
1413
  */
1230
1414
  export interface UpdateExperimentTemplateRequest {
1231
1415
  /**
1416
+ * @public
1232
1417
  * <p>The ID of the experiment template.</p>
1233
1418
  */
1234
1419
  id: string | undefined;
1235
1420
  /**
1421
+ * @public
1236
1422
  * <p>A description for the template.</p>
1237
1423
  */
1238
1424
  description?: string;
1239
1425
  /**
1426
+ * @public
1240
1427
  * <p>The stop conditions for the experiment.</p>
1241
1428
  */
1242
1429
  stopConditions?: UpdateExperimentTemplateStopConditionInput[];
1243
1430
  /**
1431
+ * @public
1244
1432
  * <p>The targets for the experiment.</p>
1245
1433
  */
1246
1434
  targets?: Record<string, UpdateExperimentTemplateTargetInput>;
1247
1435
  /**
1436
+ * @public
1248
1437
  * <p>The actions for the experiment.</p>
1249
1438
  */
1250
1439
  actions?: Record<string, UpdateExperimentTemplateActionInputItem>;
1251
1440
  /**
1441
+ * @public
1252
1442
  * <p>The Amazon Resource Name (ARN) of an IAM role that grants the FIS service permission to perform service actions on your behalf.</p>
1253
1443
  */
1254
1444
  roleArn?: string;
1255
1445
  /**
1446
+ * @public
1256
1447
  * <p>The configuration for experiment logging.</p>
1257
1448
  */
1258
1449
  logConfiguration?: UpdateExperimentTemplateLogConfigurationInput;
@@ -1262,6 +1453,7 @@ export interface UpdateExperimentTemplateRequest {
1262
1453
  */
1263
1454
  export interface UpdateExperimentTemplateResponse {
1264
1455
  /**
1456
+ * @public
1265
1457
  * <p>Information about the experiment template.</p>
1266
1458
  */
1267
1459
  experimentTemplate?: ExperimentTemplate;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-fis",
3
3
  "description": "AWS SDK for JavaScript Fis 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",