@aws-sdk/client-emr 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.
@@ -35,20 +35,24 @@ export type InstanceFleetType = (typeof InstanceFleetType)[keyof typeof Instance
35
35
  */
36
36
  export interface VolumeSpecification {
37
37
  /**
38
+ * @public
38
39
  * <p>The volume type. Volume types supported are gp3, gp2, io1, st1, sc1, and
39
40
  * standard.</p>
40
41
  */
41
42
  VolumeType: string | undefined;
42
43
  /**
44
+ * @public
43
45
  * <p>The number of I/O operations per second (IOPS) that the volume supports.</p>
44
46
  */
45
47
  Iops?: number;
46
48
  /**
49
+ * @public
47
50
  * <p>The volume size, in gibibytes (GiB). This can be a number from 1 - 1024. If the volume
48
51
  * type is EBS-optimized, the minimum value is 10.</p>
49
52
  */
50
53
  SizeInGB: number | undefined;
51
54
  /**
55
+ * @public
52
56
  * <p>The throughput, in mebibyte per second (MiB/s). This optional parameter can be a number
53
57
  * from 125 - 1000 and is valid only for gp3 volumes.</p>
54
58
  */
@@ -61,12 +65,14 @@ export interface VolumeSpecification {
61
65
  */
62
66
  export interface EbsBlockDeviceConfig {
63
67
  /**
68
+ * @public
64
69
  * <p>EBS volume specifications such as volume type, IOPS, size (GiB) and throughput (MiB/s)
65
70
  * that are requested for the EBS volume attached to an Amazon EC2 instance in the
66
71
  * cluster.</p>
67
72
  */
68
73
  VolumeSpecification: VolumeSpecification | undefined;
69
74
  /**
75
+ * @public
70
76
  * <p>Number of EBS volumes with a specific volume configuration that are associated with
71
77
  * every instance in the instance group</p>
72
78
  */
@@ -78,11 +84,13 @@ export interface EbsBlockDeviceConfig {
78
84
  */
79
85
  export interface EbsConfiguration {
80
86
  /**
87
+ * @public
81
88
  * <p>An array of Amazon EBS volume specifications attached to a cluster
82
89
  * instance.</p>
83
90
  */
84
91
  EbsBlockDeviceConfigs?: EbsBlockDeviceConfig[];
85
92
  /**
93
+ * @public
86
94
  * <p>Indicates whether an Amazon EBS volume is EBS-optimized.</p>
87
95
  */
88
96
  EbsOptimized?: boolean;
@@ -128,6 +136,7 @@ export type OnDemandCapacityReservationUsageStrategy = (typeof OnDemandCapacityR
128
136
  */
129
137
  export interface OnDemandCapacityReservationOptions {
130
138
  /**
139
+ * @public
131
140
  * <p>Indicates whether to use unused Capacity Reservations for fulfilling On-Demand
132
141
  * capacity.</p>
133
142
  * <p>If you specify <code>use-capacity-reservations-first</code>, the fleet uses unused
@@ -142,6 +151,7 @@ export interface OnDemandCapacityReservationOptions {
142
151
  */
143
152
  UsageStrategy?: OnDemandCapacityReservationUsageStrategy | string;
144
153
  /**
154
+ * @public
145
155
  * <p>Indicates the instance's Capacity Reservation preferences. Possible preferences
146
156
  * include:</p>
147
157
  * <ul>
@@ -159,6 +169,7 @@ export interface OnDemandCapacityReservationOptions {
159
169
  */
160
170
  CapacityReservationPreference?: OnDemandCapacityReservationPreference | string;
161
171
  /**
172
+ * @public
162
173
  * <p>The ARN of the Capacity Reservation resource group in which to run the instance.</p>
163
174
  */
164
175
  CapacityReservationResourceGroupArn?: string;
@@ -175,12 +186,14 @@ export interface OnDemandCapacityReservationOptions {
175
186
  */
176
187
  export interface OnDemandProvisioningSpecification {
177
188
  /**
189
+ * @public
178
190
  * <p>Specifies the strategy to use in launching On-Demand instance fleets. Currently, the
179
191
  * only option is <code>lowest-price</code> (the default), which launches the lowest price
180
192
  * first.</p>
181
193
  */
182
194
  AllocationStrategy: OnDemandProvisioningAllocationStrategy | string | undefined;
183
195
  /**
196
+ * @public
184
197
  * <p>The launch specification for On-Demand instances in the instance fleet, which determines
185
198
  * the allocation strategy.</p>
186
199
  */
@@ -230,6 +243,7 @@ export type SpotProvisioningTimeoutAction = (typeof SpotProvisioningTimeoutActio
230
243
  */
231
244
  export interface SpotProvisioningSpecification {
232
245
  /**
246
+ * @public
233
247
  * <p>The Spot provisioning timeout period in minutes. If Spot Instances are not provisioned
234
248
  * within this time period, the <code>TimeOutAction</code> is taken. Minimum value is 5 and
235
249
  * maximum value is 1440. The timeout applies only during initial provisioning, when the
@@ -237,6 +251,7 @@ export interface SpotProvisioningSpecification {
237
251
  */
238
252
  TimeoutDurationMinutes: number | undefined;
239
253
  /**
254
+ * @public
240
255
  * <p>The action to take when <code>TargetSpotCapacity</code> has not been fulfilled when the
241
256
  * <code>TimeoutDurationMinutes</code> has expired; that is, when all Spot Instances could
242
257
  * not be provisioned within the Spot provisioning timeout. Valid values are
@@ -246,6 +261,7 @@ export interface SpotProvisioningSpecification {
246
261
  */
247
262
  TimeoutAction: SpotProvisioningTimeoutAction | string | undefined;
248
263
  /**
264
+ * @public
249
265
  * <p>The defined duration for Spot Instances (also known as Spot blocks) in minutes. When
250
266
  * specified, the Spot Instance does not terminate before the defined duration expires, and
251
267
  * defined duration pricing for Spot Instances applies. Valid values are 60, 120, 180, 240,
@@ -262,6 +278,7 @@ export interface SpotProvisioningSpecification {
262
278
  */
263
279
  BlockDurationMinutes?: number;
264
280
  /**
281
+ * @public
265
282
  * <p> Specifies the strategy to use in launching Spot Instance fleets. Currently, the only
266
283
  * option is capacity-optimized (the default), which launches instances from Spot Instance
267
284
  * pools with optimal capacity for the number of instances that are launching. </p>
@@ -280,11 +297,13 @@ export interface SpotProvisioningSpecification {
280
297
  */
281
298
  export interface InstanceFleetProvisioningSpecifications {
282
299
  /**
300
+ * @public
283
301
  * <p>The launch specification for Spot instances in the fleet, which determines the defined
284
302
  * duration, provisioning timeout behavior, and allocation strategy.</p>
285
303
  */
286
304
  SpotSpecification?: SpotProvisioningSpecification;
287
305
  /**
306
+ * @public
288
307
  * <p> The launch specification for On-Demand Instances in the instance fleet, which
289
308
  * determines the allocation strategy. </p>
290
309
  * <note>
@@ -302,6 +321,7 @@ export interface InstanceFleetProvisioningSpecifications {
302
321
  */
303
322
  export interface OnDemandResizingSpecification {
304
323
  /**
324
+ * @public
305
325
  * <p>On-Demand resize timeout in minutes. If On-Demand Instances are not provisioned within
306
326
  * this time, the resize workflow stops. The minimum value is 5 minutes, and the maximum value
307
327
  * is 10,080 minutes (7 days). The timeout applies to all resize workflows on the Instance
@@ -318,6 +338,7 @@ export interface OnDemandResizingSpecification {
318
338
  */
319
339
  export interface SpotResizingSpecification {
320
340
  /**
341
+ * @public
321
342
  * <p>Spot resize timeout in minutes. If Spot Instances are not provisioned within this time,
322
343
  * the resize workflow will stop provisioning of Spot instances. Minimum value is 5 minutes
323
344
  * and maximum value is 10,080 minutes (7 days). The timeout applies to all resize workflows
@@ -333,11 +354,13 @@ export interface SpotResizingSpecification {
333
354
  */
334
355
  export interface InstanceFleetResizingSpecifications {
335
356
  /**
357
+ * @public
336
358
  * <p>The resize specification for Spot Instances in the instance fleet, which contains the
337
359
  * resize timeout period. </p>
338
360
  */
339
361
  SpotResizeSpecification?: SpotResizingSpecification;
340
362
  /**
363
+ * @public
341
364
  * <p>The resize specification for On-Demand Instances in the instance fleet, which contains
342
365
  * the resize timeout period. </p>
343
366
  */
@@ -348,14 +371,17 @@ export interface InstanceFleetResizingSpecifications {
348
371
  */
349
372
  export interface AddInstanceFleetOutput {
350
373
  /**
374
+ * @public
351
375
  * <p>The unique identifier of the cluster.</p>
352
376
  */
353
377
  ClusterId?: string;
354
378
  /**
379
+ * @public
355
380
  * <p>The unique identifier of the instance fleet.</p>
356
381
  */
357
382
  InstanceFleetId?: string;
358
383
  /**
384
+ * @public
359
385
  * <p>The Amazon Resource Name of the cluster.</p>
360
386
  */
361
387
  ClusterArn?: string;
@@ -369,6 +395,7 @@ export declare class InternalServerException extends __BaseException {
369
395
  readonly name: "InternalServerException";
370
396
  readonly $fault: "server";
371
397
  /**
398
+ * @public
372
399
  * <p>The message associated with the exception.</p>
373
400
  */
374
401
  Message?: string;
@@ -385,10 +412,12 @@ export declare class InvalidRequestException extends __BaseException {
385
412
  readonly name: "InvalidRequestException";
386
413
  readonly $fault: "client";
387
414
  /**
415
+ * @public
388
416
  * <p>The error code associated with the exception.</p>
389
417
  */
390
418
  ErrorCode?: string;
391
419
  /**
420
+ * @public
392
421
  * <p>The message associated with the exception.</p>
393
422
  */
394
423
  Message?: string;
@@ -405,12 +434,14 @@ export declare class InvalidRequestException extends __BaseException {
405
434
  */
406
435
  export interface ScalingConstraints {
407
436
  /**
437
+ * @public
408
438
  * <p>The lower boundary of Amazon EC2 instances in an instance group below which
409
439
  * scaling activities are not allowed to shrink. Scale-in activities will not terminate
410
440
  * instances below this boundary.</p>
411
441
  */
412
442
  MinCapacity: number | undefined;
413
443
  /**
444
+ * @public
414
445
  * <p>The upper boundary of Amazon EC2 instances in an instance group beyond which
415
446
  * scaling activities are not allowed to grow. Scale-out activities will not add instances
416
447
  * beyond this boundary.</p>
@@ -450,6 +481,7 @@ export type AdjustmentType = (typeof AdjustmentType)[keyof typeof AdjustmentType
450
481
  */
451
482
  export interface SimpleScalingPolicyConfiguration {
452
483
  /**
484
+ * @public
453
485
  * <p>The way in which Amazon EC2 instances are added (if
454
486
  * <code>ScalingAdjustment</code> is a positive number) or terminated (if
455
487
  * <code>ScalingAdjustment</code> is a negative number) each time the scaling activity is
@@ -465,6 +497,7 @@ export interface SimpleScalingPolicyConfiguration {
465
497
  */
466
498
  AdjustmentType?: AdjustmentType | string;
467
499
  /**
500
+ * @public
468
501
  * <p>The amount by which to scale in or scale out, based on the specified
469
502
  * <code>AdjustmentType</code>. A positive value adds to the instance group's Amazon EC2 instance count while a negative number removes instances. If
470
503
  * <code>AdjustmentType</code> is set to <code>EXACT_CAPACITY</code>, the number should
@@ -475,6 +508,7 @@ export interface SimpleScalingPolicyConfiguration {
475
508
  */
476
509
  ScalingAdjustment: number | undefined;
477
510
  /**
511
+ * @public
478
512
  * <p>The amount of time, in seconds, after a scaling activity completes before any further
479
513
  * trigger-related scaling activities can start. The default value is 0.</p>
480
514
  */
@@ -487,11 +521,13 @@ export interface SimpleScalingPolicyConfiguration {
487
521
  */
488
522
  export interface ScalingAction {
489
523
  /**
524
+ * @public
490
525
  * <p>Not available for instance groups. Instance groups use the market type specified for the
491
526
  * group.</p>
492
527
  */
493
528
  Market?: MarketType | string;
494
529
  /**
530
+ * @public
495
531
  * <p>The type of adjustment the automatic scaling activity makes when triggered, and the
496
532
  * periodicity of the adjustment.</p>
497
533
  */
@@ -521,10 +557,12 @@ export type ComparisonOperator = (typeof ComparisonOperator)[keyof typeof Compar
521
557
  */
522
558
  export interface MetricDimension {
523
559
  /**
560
+ * @public
524
561
  * <p>The dimension name.</p>
525
562
  */
526
563
  Key?: string;
527
564
  /**
565
+ * @public
528
566
  * <p>The dimension value.</p>
529
567
  */
530
568
  Value?: string;
@@ -589,48 +627,57 @@ export type Unit = (typeof Unit)[keyof typeof Unit];
589
627
  */
590
628
  export interface CloudWatchAlarmDefinition {
591
629
  /**
630
+ * @public
592
631
  * <p>Determines how the metric specified by <code>MetricName</code> is compared to the value
593
632
  * specified by <code>Threshold</code>.</p>
594
633
  */
595
634
  ComparisonOperator: ComparisonOperator | string | undefined;
596
635
  /**
636
+ * @public
597
637
  * <p>The number of periods, in five-minute increments, during which the alarm condition must
598
638
  * exist before the alarm triggers automatic scaling activity. The default value is
599
639
  * <code>1</code>.</p>
600
640
  */
601
641
  EvaluationPeriods?: number;
602
642
  /**
643
+ * @public
603
644
  * <p>The name of the CloudWatch metric that is watched to determine an alarm
604
645
  * condition.</p>
605
646
  */
606
647
  MetricName: string | undefined;
607
648
  /**
649
+ * @public
608
650
  * <p>The namespace for the CloudWatch metric. The default is
609
651
  * <code>AWS/ElasticMapReduce</code>.</p>
610
652
  */
611
653
  Namespace?: string;
612
654
  /**
655
+ * @public
613
656
  * <p>The period, in seconds, over which the statistic is applied. CloudWatch metrics for
614
657
  * Amazon EMR are emitted every five minutes (300 seconds), so if you specify a
615
658
  * CloudWatch metric, specify <code>300</code>.</p>
616
659
  */
617
660
  Period: number | undefined;
618
661
  /**
662
+ * @public
619
663
  * <p>The statistic to apply to the metric associated with the alarm. The default is
620
664
  * <code>AVERAGE</code>.</p>
621
665
  */
622
666
  Statistic?: Statistic | string;
623
667
  /**
668
+ * @public
624
669
  * <p>The value against which the specified statistic is compared.</p>
625
670
  */
626
671
  Threshold: number | undefined;
627
672
  /**
673
+ * @public
628
674
  * <p>The unit of measure associated with the CloudWatch metric being watched. The value
629
675
  * specified for <code>Unit</code> must correspond to the units specified in the CloudWatch
630
676
  * metric.</p>
631
677
  */
632
678
  Unit?: Unit | string;
633
679
  /**
680
+ * @public
634
681
  * <p>A CloudWatch metric dimension.</p>
635
682
  */
636
683
  Dimensions?: MetricDimension[];
@@ -641,6 +688,7 @@ export interface CloudWatchAlarmDefinition {
641
688
  */
642
689
  export interface ScalingTrigger {
643
690
  /**
691
+ * @public
644
692
  * <p>The definition of a CloudWatch metric alarm. When the defined alarm conditions are met
645
693
  * along with other trigger parameters, scaling activity begins.</p>
646
694
  */
@@ -655,19 +703,23 @@ export interface ScalingTrigger {
655
703
  */
656
704
  export interface ScalingRule {
657
705
  /**
706
+ * @public
658
707
  * <p>The name used to identify an automatic scaling rule. Rule names must be unique within a
659
708
  * scaling policy.</p>
660
709
  */
661
710
  Name: string | undefined;
662
711
  /**
712
+ * @public
663
713
  * <p>A friendly, more verbose description of the automatic scaling rule.</p>
664
714
  */
665
715
  Description?: string;
666
716
  /**
717
+ * @public
667
718
  * <p>The conditions that trigger an automatic scaling activity.</p>
668
719
  */
669
720
  Action: ScalingAction | undefined;
670
721
  /**
722
+ * @public
671
723
  * <p>The CloudWatch alarm definition that determines when automatic scaling activity is
672
724
  * triggered.</p>
673
725
  */
@@ -682,12 +734,14 @@ export interface ScalingRule {
682
734
  */
683
735
  export interface AutoScalingPolicy {
684
736
  /**
737
+ * @public
685
738
  * <p>The upper and lower Amazon EC2 instance limits for an automatic scaling policy.
686
739
  * Automatic scaling activity will not cause an instance group to grow above or below these
687
740
  * limits.</p>
688
741
  */
689
742
  Constraints: ScalingConstraints | undefined;
690
743
  /**
744
+ * @public
691
745
  * <p>The scale-in and scale-out rules that comprise the automatic scaling policy.</p>
692
746
  */
693
747
  Rules: ScalingRule[] | undefined;
@@ -711,14 +765,17 @@ export type InstanceRoleType = (typeof InstanceRoleType)[keyof typeof InstanceRo
711
765
  */
712
766
  export interface AddInstanceGroupsOutput {
713
767
  /**
768
+ * @public
714
769
  * <p>The job flow ID in which the instance groups are added.</p>
715
770
  */
716
771
  JobFlowId?: string;
717
772
  /**
773
+ * @public
718
774
  * <p>Instance group IDs of the newly created instance groups.</p>
719
775
  */
720
776
  InstanceGroupIds?: string[];
721
777
  /**
778
+ * @public
722
779
  * <p>The Amazon Resource Name of the cluster.</p>
723
780
  */
724
781
  ClusterArn?: string;
@@ -742,10 +799,12 @@ export declare class InternalServerError extends __BaseException {
742
799
  */
743
800
  export interface KeyValue {
744
801
  /**
802
+ * @public
745
803
  * <p>The unique identifier of a key-value pair.</p>
746
804
  */
747
805
  Key?: string;
748
806
  /**
807
+ * @public
749
808
  * <p>The value part of the identified key.</p>
750
809
  */
751
810
  Value?: string;
@@ -758,20 +817,24 @@ export interface KeyValue {
758
817
  */
759
818
  export interface HadoopJarStepConfig {
760
819
  /**
820
+ * @public
761
821
  * <p>A list of Java properties that are set when the step runs. You can use these properties
762
822
  * to pass key-value pairs to your main function.</p>
763
823
  */
764
824
  Properties?: KeyValue[];
765
825
  /**
826
+ * @public
766
827
  * <p>A path to a JAR file run during the step.</p>
767
828
  */
768
829
  Jar: string | undefined;
769
830
  /**
831
+ * @public
770
832
  * <p>The name of the main class in the specified Java file. If not specified, the JAR file
771
833
  * should specify a Main-Class in its manifest file.</p>
772
834
  */
773
835
  MainClass?: string;
774
836
  /**
837
+ * @public
775
838
  * <p>A list of command line arguments passed to the JAR file's main function when
776
839
  * executed.</p>
777
840
  */
@@ -783,10 +846,12 @@ export interface HadoopJarStepConfig {
783
846
  */
784
847
  export interface StepConfig {
785
848
  /**
849
+ * @public
786
850
  * <p>The name of the step.</p>
787
851
  */
788
852
  Name: string | undefined;
789
853
  /**
854
+ * @public
790
855
  * <p>The action to take when the step fails. Use one of the following values:</p>
791
856
  * <ul>
792
857
  * <li>
@@ -823,6 +888,7 @@ export interface StepConfig {
823
888
  */
824
889
  ActionOnFailure?: ActionOnFailure | string;
825
890
  /**
891
+ * @public
826
892
  * <p>The JAR file used for the step.</p>
827
893
  */
828
894
  HadoopJarStep: HadoopJarStepConfig | undefined;
@@ -833,15 +899,18 @@ export interface StepConfig {
833
899
  */
834
900
  export interface AddJobFlowStepsInput {
835
901
  /**
902
+ * @public
836
903
  * <p>A string that uniquely identifies the job flow. This identifier is returned by <a>RunJobFlow</a> and can also be obtained from <a>ListClusters</a>.
837
904
  * </p>
838
905
  */
839
906
  JobFlowId: string | undefined;
840
907
  /**
908
+ * @public
841
909
  * <p> A list of <a>StepConfig</a> to be executed by the job flow. </p>
842
910
  */
843
911
  Steps: StepConfig[] | undefined;
844
912
  /**
913
+ * @public
845
914
  * <p>The Amazon Resource Name (ARN) of the runtime role for a step on the cluster. The
846
915
  * runtime role can be a cross-account IAM role. The runtime role ARN is a
847
916
  * combination of account ID, role name, and role type using the following format:
@@ -857,6 +926,7 @@ export interface AddJobFlowStepsInput {
857
926
  */
858
927
  export interface AddJobFlowStepsOutput {
859
928
  /**
929
+ * @public
860
930
  * <p>The identifiers of the list of steps added to the job flow.</p>
861
931
  */
862
932
  StepIds?: string[];
@@ -869,11 +939,13 @@ export interface AddJobFlowStepsOutput {
869
939
  */
870
940
  export interface Tag {
871
941
  /**
942
+ * @public
872
943
  * <p>A user-defined key, which is the minimum required information for a valid tag. For more
873
944
  * information, see <a href="https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-tags.html">Tag</a>. </p>
874
945
  */
875
946
  Key?: string;
876
947
  /**
948
+ * @public
877
949
  * <p>A user-defined value, which is optional in a tag. For more information, see <a href="https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-tags.html">Tag
878
950
  * Clusters</a>. </p>
879
951
  */
@@ -886,11 +958,13 @@ export interface Tag {
886
958
  */
887
959
  export interface AddTagsInput {
888
960
  /**
961
+ * @public
889
962
  * <p>The Amazon EMR resource identifier to which tags will be added. For example, a
890
963
  * cluster identifier or an Amazon EMR Studio ID.</p>
891
964
  */
892
965
  ResourceId: string | undefined;
893
966
  /**
967
+ * @public
894
968
  * <p>A list of tags to associate with a resource. Tags are user-defined key-value pairs that
895
969
  * consist of a required key string with a maximum of 128 characters, and an optional value
896
970
  * string with a maximum of 256 characters.</p>
@@ -916,18 +990,22 @@ export interface AddTagsOutput {
916
990
  */
917
991
  export interface Application {
918
992
  /**
993
+ * @public
919
994
  * <p>The name of the application.</p>
920
995
  */
921
996
  Name?: string;
922
997
  /**
998
+ * @public
923
999
  * <p>The version of the application.</p>
924
1000
  */
925
1001
  Version?: string;
926
1002
  /**
1003
+ * @public
927
1004
  * <p>Arguments for Amazon EMR to pass to the application.</p>
928
1005
  */
929
1006
  Args?: string[];
930
1007
  /**
1008
+ * @public
931
1009
  * <p>This option is for advanced users only. This is meta information about third-party
932
1010
  * applications that third-party vendors use for testing purposes.</p>
933
1011
  */
@@ -980,6 +1058,7 @@ export type AutoScalingPolicyStateChangeReasonCode = (typeof AutoScalingPolicySt
980
1058
  */
981
1059
  export interface AutoScalingPolicyStateChangeReason {
982
1060
  /**
1061
+ * @public
983
1062
  * <p>The code indicating the reason for the change in status.<code>USER_REQUEST</code>
984
1063
  * indicates that the scaling policy status was changed by a user.
985
1064
  * <code>PROVISION_FAILURE</code> indicates that the status change was because the policy
@@ -987,6 +1066,7 @@ export interface AutoScalingPolicyStateChangeReason {
987
1066
  */
988
1067
  Code?: AutoScalingPolicyStateChangeReasonCode | string;
989
1068
  /**
1069
+ * @public
990
1070
  * <p>A friendly, more verbose message that accompanies an automatic scaling policy state
991
1071
  * change.</p>
992
1072
  */
@@ -999,10 +1079,12 @@ export interface AutoScalingPolicyStateChangeReason {
999
1079
  */
1000
1080
  export interface AutoScalingPolicyStatus {
1001
1081
  /**
1082
+ * @public
1002
1083
  * <p>Indicates the status of the automatic scaling policy.</p>
1003
1084
  */
1004
1085
  State?: AutoScalingPolicyState | string;
1005
1086
  /**
1087
+ * @public
1006
1088
  * <p>The reason for a change in status.</p>
1007
1089
  */
1008
1090
  StateChangeReason?: AutoScalingPolicyStateChangeReason;
@@ -1016,16 +1098,19 @@ export interface AutoScalingPolicyStatus {
1016
1098
  */
1017
1099
  export interface AutoScalingPolicyDescription {
1018
1100
  /**
1101
+ * @public
1019
1102
  * <p>The status of an automatic scaling policy. </p>
1020
1103
  */
1021
1104
  Status?: AutoScalingPolicyStatus;
1022
1105
  /**
1106
+ * @public
1023
1107
  * <p>The upper and lower Amazon EC2 instance limits for an automatic scaling policy.
1024
1108
  * Automatic scaling activity will not cause an instance group to grow above or below these
1025
1109
  * limits.</p>
1026
1110
  */
1027
1111
  Constraints?: ScalingConstraints;
1028
1112
  /**
1113
+ * @public
1029
1114
  * <p>The scale-in and scale-out rules that comprise the automatic scaling policy.</p>
1030
1115
  */
1031
1116
  Rules?: ScalingRule[];
@@ -1039,6 +1124,7 @@ export interface AutoScalingPolicyDescription {
1039
1124
  */
1040
1125
  export interface AutoTerminationPolicy {
1041
1126
  /**
1127
+ * @public
1042
1128
  * <p>Specifies the amount of idle time in seconds after which the cluster automatically
1043
1129
  * terminates. You can specify a minimum of 60 seconds and a maximum of 604800 seconds (seven
1044
1130
  * days).</p>
@@ -1053,10 +1139,12 @@ export interface AutoTerminationPolicy {
1053
1139
  */
1054
1140
  export interface PortRange {
1055
1141
  /**
1142
+ * @public
1056
1143
  * <p>The smallest port number in a specified range of port numbers.</p>
1057
1144
  */
1058
1145
  MinRange: number | undefined;
1059
1146
  /**
1147
+ * @public
1060
1148
  * <p>The smallest port number in a specified range of port numbers.</p>
1061
1149
  */
1062
1150
  MaxRange?: number;
@@ -1071,10 +1159,12 @@ export interface PortRange {
1071
1159
  */
1072
1160
  export interface BlockPublicAccessConfigurationMetadata {
1073
1161
  /**
1162
+ * @public
1074
1163
  * <p>The date and time that the configuration was created.</p>
1075
1164
  */
1076
1165
  CreationDateTime: Date | undefined;
1077
1166
  /**
1167
+ * @public
1078
1168
  * <p>The Amazon Resource Name that created or last modified the configuration.</p>
1079
1169
  */
1080
1170
  CreatedByArn: string | undefined;
@@ -1085,10 +1175,12 @@ export interface BlockPublicAccessConfigurationMetadata {
1085
1175
  */
1086
1176
  export interface ScriptBootstrapActionConfig {
1087
1177
  /**
1178
+ * @public
1088
1179
  * <p>Location in Amazon S3 of the script to run during a bootstrap action.</p>
1089
1180
  */
1090
1181
  Path: string | undefined;
1091
1182
  /**
1183
+ * @public
1092
1184
  * <p>A list of command line arguments to pass to the bootstrap action script.</p>
1093
1185
  */
1094
1186
  Args?: string[];
@@ -1099,10 +1191,12 @@ export interface ScriptBootstrapActionConfig {
1099
1191
  */
1100
1192
  export interface BootstrapActionConfig {
1101
1193
  /**
1194
+ * @public
1102
1195
  * <p>The name of the bootstrap action.</p>
1103
1196
  */
1104
1197
  Name: string | undefined;
1105
1198
  /**
1199
+ * @public
1106
1200
  * <p>The script run by the bootstrap action.</p>
1107
1201
  */
1108
1202
  ScriptBootstrapAction: ScriptBootstrapActionConfig | undefined;
@@ -1113,6 +1207,7 @@ export interface BootstrapActionConfig {
1113
1207
  */
1114
1208
  export interface BootstrapActionDetail {
1115
1209
  /**
1210
+ * @public
1116
1211
  * <p>A description of the bootstrap action.</p>
1117
1212
  */
1118
1213
  BootstrapActionConfig?: BootstrapActionConfig;
@@ -1135,15 +1230,18 @@ export type StepCancellationOption = (typeof StepCancellationOption)[keyof typeo
1135
1230
  */
1136
1231
  export interface CancelStepsInput {
1137
1232
  /**
1233
+ * @public
1138
1234
  * <p>The <code>ClusterID</code> for the specified steps that will be canceled. Use <a>RunJobFlow</a> and <a>ListClusters</a> to get ClusterIDs. </p>
1139
1235
  */
1140
1236
  ClusterId: string | undefined;
1141
1237
  /**
1238
+ * @public
1142
1239
  * <p>The list of <code>StepIDs</code> to cancel. Use <a>ListSteps</a> to get steps
1143
1240
  * and their states for the specified cluster.</p>
1144
1241
  */
1145
1242
  StepIds: string[] | undefined;
1146
1243
  /**
1244
+ * @public
1147
1245
  * <p>The option to choose to cancel <code>RUNNING</code> steps. By default, the value is
1148
1246
  * <code>SEND_INTERRUPT</code>.</p>
1149
1247
  */
@@ -1167,14 +1265,17 @@ export type CancelStepsRequestStatus = (typeof CancelStepsRequestStatus)[keyof t
1167
1265
  */
1168
1266
  export interface CancelStepsInfo {
1169
1267
  /**
1268
+ * @public
1170
1269
  * <p>The encrypted StepId of a step.</p>
1171
1270
  */
1172
1271
  StepId?: string;
1173
1272
  /**
1273
+ * @public
1174
1274
  * <p>The status of a CancelSteps Request. The value may be SUBMITTED or FAILED.</p>
1175
1275
  */
1176
1276
  Status?: CancelStepsRequestStatus | string;
1177
1277
  /**
1278
+ * @public
1178
1279
  * <p>The reason for the failure if the CancelSteps request fails.</p>
1179
1280
  */
1180
1281
  Reason?: string;
@@ -1185,6 +1286,7 @@ export interface CancelStepsInfo {
1185
1286
  */
1186
1287
  export interface CancelStepsOutput {
1187
1288
  /**
1289
+ * @public
1188
1290
  * <p>A list of <a>CancelStepsInfo</a>, which shows the status of specified cancel
1189
1291
  * requests for each <code>StepID</code> specified.</p>
1190
1292
  */
@@ -1198,17 +1300,20 @@ export interface CancelStepsOutput {
1198
1300
  */
1199
1301
  export interface Ec2InstanceAttributes {
1200
1302
  /**
1303
+ * @public
1201
1304
  * <p>The name of the Amazon EC2 key pair to use when connecting with SSH into the
1202
1305
  * master node as a user named "hadoop".</p>
1203
1306
  */
1204
1307
  Ec2KeyName?: string;
1205
1308
  /**
1309
+ * @public
1206
1310
  * <p>Set this parameter to the identifier of the Amazon VPC subnet where you want the
1207
1311
  * cluster to launch. If you do not specify this value, and your account supports EC2-Classic,
1208
1312
  * the cluster launches in EC2-Classic.</p>
1209
1313
  */
1210
1314
  Ec2SubnetId?: string;
1211
1315
  /**
1316
+ * @public
1212
1317
  * <p>Applies to clusters configured with the instance fleets option. Specifies the unique
1213
1318
  * identifier of one or more Amazon EC2 subnets in which to launch Amazon EC2
1214
1319
  * cluster instances. Subnets must exist within the same VPC. Amazon EMR chooses the
@@ -1223,10 +1328,12 @@ export interface Ec2InstanceAttributes {
1223
1328
  */
1224
1329
  RequestedEc2SubnetIds?: string[];
1225
1330
  /**
1331
+ * @public
1226
1332
  * <p>The Availability Zone in which the cluster will run. </p>
1227
1333
  */
1228
1334
  Ec2AvailabilityZone?: string;
1229
1335
  /**
1336
+ * @public
1230
1337
  * <p>Applies to clusters configured with the instance fleets option. Specifies one or more
1231
1338
  * Availability Zones in which to launch Amazon EC2 cluster instances when the
1232
1339
  * EC2-Classic network configuration is supported. Amazon EMR chooses the Availability
@@ -1238,29 +1345,35 @@ export interface Ec2InstanceAttributes {
1238
1345
  */
1239
1346
  RequestedEc2AvailabilityZones?: string[];
1240
1347
  /**
1348
+ * @public
1241
1349
  * <p>The IAM role that was specified when the cluster was launched. The
1242
1350
  * Amazon EC2 instances of the cluster assume this role.</p>
1243
1351
  */
1244
1352
  IamInstanceProfile?: string;
1245
1353
  /**
1354
+ * @public
1246
1355
  * <p>The identifier of the Amazon EC2 security group for the master node.</p>
1247
1356
  */
1248
1357
  EmrManagedMasterSecurityGroup?: string;
1249
1358
  /**
1359
+ * @public
1250
1360
  * <p>The identifier of the Amazon EC2 security group for the core and task
1251
1361
  * nodes.</p>
1252
1362
  */
1253
1363
  EmrManagedSlaveSecurityGroup?: string;
1254
1364
  /**
1365
+ * @public
1255
1366
  * <p>The identifier of the Amazon EC2 security group for the Amazon EMR
1256
1367
  * service to access clusters in VPC private subnets.</p>
1257
1368
  */
1258
1369
  ServiceAccessSecurityGroup?: string;
1259
1370
  /**
1371
+ * @public
1260
1372
  * <p>A list of additional Amazon EC2 security group IDs for the master node.</p>
1261
1373
  */
1262
1374
  AdditionalMasterSecurityGroups?: string[];
1263
1375
  /**
1376
+ * @public
1264
1377
  * <p>A list of additional Amazon EC2 security group IDs for the core and task
1265
1378
  * nodes.</p>
1266
1379
  */
@@ -1286,27 +1399,32 @@ export type InstanceCollectionType = (typeof InstanceCollectionType)[keyof typeo
1286
1399
  */
1287
1400
  export interface KerberosAttributes {
1288
1401
  /**
1402
+ * @public
1289
1403
  * <p>The name of the Kerberos realm to which all nodes in a cluster belong. For example,
1290
1404
  * <code>EC2.INTERNAL</code>. </p>
1291
1405
  */
1292
1406
  Realm: string | undefined;
1293
1407
  /**
1408
+ * @public
1294
1409
  * <p>The password used within the cluster for the kadmin service on the cluster-dedicated
1295
1410
  * KDC, which maintains Kerberos principals, password policies, and keytabs for the
1296
1411
  * cluster.</p>
1297
1412
  */
1298
1413
  KdcAdminPassword: string | undefined;
1299
1414
  /**
1415
+ * @public
1300
1416
  * <p>Required only when establishing a cross-realm trust with a KDC in a different realm. The
1301
1417
  * cross-realm principal password, which must be identical across realms.</p>
1302
1418
  */
1303
1419
  CrossRealmTrustPrincipalPassword?: string;
1304
1420
  /**
1421
+ * @public
1305
1422
  * <p>Required only when establishing a cross-realm trust with an Active Directory domain. A
1306
1423
  * user with sufficient privileges to join resources to the domain.</p>
1307
1424
  */
1308
1425
  ADDomainJoinUser?: string;
1309
1426
  /**
1427
+ * @public
1310
1428
  * <p>The Active Directory password for <code>ADDomainJoinUser</code>.</p>
1311
1429
  */
1312
1430
  ADDomainJoinPassword?: string;
@@ -1335,12 +1453,14 @@ export type PlacementGroupStrategy = (typeof PlacementGroupStrategy)[keyof typeo
1335
1453
  */
1336
1454
  export interface PlacementGroupConfig {
1337
1455
  /**
1456
+ * @public
1338
1457
  * <p>Role of the instance in the cluster.</p>
1339
1458
  * <p>Starting with Amazon EMR release 5.23.0, the only supported instance role is
1340
1459
  * <code>MASTER</code>.</p>
1341
1460
  */
1342
1461
  InstanceRole: InstanceRoleType | string | undefined;
1343
1462
  /**
1463
+ * @public
1344
1464
  * <p>Amazon EC2 Placement Group strategy associated with instance role.</p>
1345
1465
  * <p>Starting with Amazon EMR release 5.23.0, the only supported placement strategy
1346
1466
  * is <code>SPREAD</code> for the <code>MASTER</code> instance role.</p>
@@ -1378,15 +1498,18 @@ export type ScaleDownBehavior = (typeof ScaleDownBehavior)[keyof typeof ScaleDow
1378
1498
  */
1379
1499
  export interface ErrorDetail {
1380
1500
  /**
1501
+ * @public
1381
1502
  * <p>The name or code associated with the error.</p>
1382
1503
  */
1383
1504
  ErrorCode?: string;
1384
1505
  /**
1506
+ * @public
1385
1507
  * <p>A list of key value pairs that provides contextual information about why an error
1386
1508
  * occured.</p>
1387
1509
  */
1388
1510
  ErrorData?: Record<string, string>[];
1389
1511
  /**
1512
+ * @public
1390
1513
  * <p>A message that describes the error.</p>
1391
1514
  */
1392
1515
  ErrorMessage?: string;
@@ -1432,10 +1555,12 @@ export type ClusterStateChangeReasonCode = (typeof ClusterStateChangeReasonCode)
1432
1555
  */
1433
1556
  export interface ClusterStateChangeReason {
1434
1557
  /**
1558
+ * @public
1435
1559
  * <p>The programmatic code for the state change reason.</p>
1436
1560
  */
1437
1561
  Code?: ClusterStateChangeReasonCode | string;
1438
1562
  /**
1563
+ * @public
1439
1564
  * <p>The descriptive message for the state change reason.</p>
1440
1565
  */
1441
1566
  Message?: string;
@@ -1446,14 +1571,17 @@ export interface ClusterStateChangeReason {
1446
1571
  */
1447
1572
  export interface ClusterTimeline {
1448
1573
  /**
1574
+ * @public
1449
1575
  * <p>The creation date and time of the cluster.</p>
1450
1576
  */
1451
1577
  CreationDateTime?: Date;
1452
1578
  /**
1579
+ * @public
1453
1580
  * <p>The date and time when the cluster was ready to run steps.</p>
1454
1581
  */
1455
1582
  ReadyDateTime?: Date;
1456
1583
  /**
1584
+ * @public
1457
1585
  * <p>The date and time when the cluster was terminated.</p>
1458
1586
  */
1459
1587
  EndDateTime?: Date;
@@ -1464,19 +1592,23 @@ export interface ClusterTimeline {
1464
1592
  */
1465
1593
  export interface ClusterStatus {
1466
1594
  /**
1595
+ * @public
1467
1596
  * <p>The current state of the cluster.</p>
1468
1597
  */
1469
1598
  State?: ClusterState | string;
1470
1599
  /**
1600
+ * @public
1471
1601
  * <p>The reason for the cluster status change.</p>
1472
1602
  */
1473
1603
  StateChangeReason?: ClusterStateChangeReason;
1474
1604
  /**
1605
+ * @public
1475
1606
  * <p>A timeline that represents the status of a cluster over the lifetime of the
1476
1607
  * cluster.</p>
1477
1608
  */
1478
1609
  Timeline?: ClusterTimeline;
1479
1610
  /**
1611
+ * @public
1480
1612
  * <p>A list of tuples that provides information about the errors that caused a cluster to
1481
1613
  * terminate. This structure can contain up to 10 different <code>ErrorDetail</code>
1482
1614
  * tuples.</p>
@@ -1489,18 +1621,22 @@ export interface ClusterStatus {
1489
1621
  */
1490
1622
  export interface ClusterSummary {
1491
1623
  /**
1624
+ * @public
1492
1625
  * <p>The unique identifier for the cluster.</p>
1493
1626
  */
1494
1627
  Id?: string;
1495
1628
  /**
1629
+ * @public
1496
1630
  * <p>The name of the cluster.</p>
1497
1631
  */
1498
1632
  Name?: string;
1499
1633
  /**
1634
+ * @public
1500
1635
  * <p>The details about the current status of the cluster.</p>
1501
1636
  */
1502
1637
  Status?: ClusterStatus;
1503
1638
  /**
1639
+ * @public
1504
1640
  * <p>An approximation of the cost of the cluster, represented in m1.small/hours. This value
1505
1641
  * is incremented one time for every hour an m1.small instance runs. Larger instances are
1506
1642
  * weighted more, so an Amazon EC2 instance that is roughly four times more expensive
@@ -1509,10 +1645,12 @@ export interface ClusterSummary {
1509
1645
  */
1510
1646
  NormalizedInstanceHours?: number;
1511
1647
  /**
1648
+ * @public
1512
1649
  * <p>The Amazon Resource Name of the cluster.</p>
1513
1650
  */
1514
1651
  ClusterArn?: string;
1515
1652
  /**
1653
+ * @public
1516
1654
  * <p> The Amazon Resource Name (ARN) of the Outpost where the cluster is launched. </p>
1517
1655
  */
1518
1656
  OutpostArn?: string;
@@ -1523,14 +1661,17 @@ export interface ClusterSummary {
1523
1661
  */
1524
1662
  export interface Command {
1525
1663
  /**
1664
+ * @public
1526
1665
  * <p>The name of the command.</p>
1527
1666
  */
1528
1667
  Name?: string;
1529
1668
  /**
1669
+ * @public
1530
1670
  * <p>The Amazon S3 location of the command script.</p>
1531
1671
  */
1532
1672
  ScriptPath?: string;
1533
1673
  /**
1674
+ * @public
1534
1675
  * <p>Arguments for Amazon EMR to pass to the command for execution.</p>
1535
1676
  */
1536
1677
  Args?: string[];
@@ -1556,10 +1697,12 @@ export type ComputeLimitsUnitType = (typeof ComputeLimitsUnitType)[keyof typeof
1556
1697
  */
1557
1698
  export interface ComputeLimits {
1558
1699
  /**
1700
+ * @public
1559
1701
  * <p> The unit type used for specifying a managed scaling policy. </p>
1560
1702
  */
1561
1703
  UnitType: ComputeLimitsUnitType | string | undefined;
1562
1704
  /**
1705
+ * @public
1563
1706
  * <p> The lower boundary of Amazon EC2 units. It is measured through vCPU cores or
1564
1707
  * instances for instance groups and measured through units for instance fleets. Managed
1565
1708
  * scaling activities are not allowed beyond this boundary. The limit only applies to the core
@@ -1567,6 +1710,7 @@ export interface ComputeLimits {
1567
1710
  */
1568
1711
  MinimumCapacityUnits: number | undefined;
1569
1712
  /**
1713
+ * @public
1570
1714
  * <p> The upper boundary of Amazon EC2 units. It is measured through vCPU cores or
1571
1715
  * instances for instance groups and measured through units for instance fleets. Managed
1572
1716
  * scaling activities are not allowed beyond this boundary. The limit only applies to the core
@@ -1574,6 +1718,7 @@ export interface ComputeLimits {
1574
1718
  */
1575
1719
  MaximumCapacityUnits: number | undefined;
1576
1720
  /**
1721
+ * @public
1577
1722
  * <p> The upper boundary of On-Demand Amazon EC2 units. It is measured through vCPU
1578
1723
  * cores or instances for instance groups and measured through units for instance fleets. The
1579
1724
  * On-Demand units are not allowed to scale beyond this boundary. The parameter is used to
@@ -1581,6 +1726,7 @@ export interface ComputeLimits {
1581
1726
  */
1582
1727
  MaximumOnDemandCapacityUnits?: number;
1583
1728
  /**
1729
+ * @public
1584
1730
  * <p> The upper boundary of Amazon EC2 units for core node type in a cluster. It is
1585
1731
  * measured through vCPU cores or instances for instance groups and measured through units for
1586
1732
  * instance fleets. The core units are not allowed to scale beyond this boundary. The
@@ -1593,10 +1739,12 @@ export interface ComputeLimits {
1593
1739
  */
1594
1740
  export interface CreateSecurityConfigurationInput {
1595
1741
  /**
1742
+ * @public
1596
1743
  * <p>The name of the security configuration.</p>
1597
1744
  */
1598
1745
  Name: string | undefined;
1599
1746
  /**
1747
+ * @public
1600
1748
  * <p>The security configuration details in JSON format. For JSON parameters and examples, see
1601
1749
  * <a href="https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-security-configurations.html">Use Security
1602
1750
  * Configurations to Set Up Cluster Security</a> in the <i>Amazon EMR
@@ -1609,10 +1757,12 @@ export interface CreateSecurityConfigurationInput {
1609
1757
  */
1610
1758
  export interface CreateSecurityConfigurationOutput {
1611
1759
  /**
1760
+ * @public
1612
1761
  * <p>The name of the security configuration.</p>
1613
1762
  */
1614
1763
  Name: string | undefined;
1615
1764
  /**
1765
+ * @public
1616
1766
  * <p>The date and time the security configuration was created.</p>
1617
1767
  */
1618
1768
  CreationDateTime: Date | undefined;
@@ -1622,58 +1772,69 @@ export interface CreateSecurityConfigurationOutput {
1622
1772
  */
1623
1773
  export interface CreateStudioInput {
1624
1774
  /**
1775
+ * @public
1625
1776
  * <p>A descriptive name for the Amazon EMR Studio.</p>
1626
1777
  */
1627
1778
  Name: string | undefined;
1628
1779
  /**
1780
+ * @public
1629
1781
  * <p>A detailed description of the Amazon EMR Studio.</p>
1630
1782
  */
1631
1783
  Description?: string;
1632
1784
  /**
1785
+ * @public
1633
1786
  * <p>Specifies whether the Studio authenticates users using IAM or IAM Identity Center.</p>
1634
1787
  */
1635
1788
  AuthMode: AuthMode | string | undefined;
1636
1789
  /**
1790
+ * @public
1637
1791
  * <p>The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the
1638
1792
  * Studio.</p>
1639
1793
  */
1640
1794
  VpcId: string | undefined;
1641
1795
  /**
1796
+ * @public
1642
1797
  * <p>A list of subnet IDs to associate with the Amazon EMR Studio. A Studio can have
1643
1798
  * a maximum of 5 subnets. The subnets must belong to the VPC specified by <code>VpcId</code>.
1644
1799
  * Studio users can create a Workspace in any of the specified subnets.</p>
1645
1800
  */
1646
1801
  SubnetIds: string[] | undefined;
1647
1802
  /**
1803
+ * @public
1648
1804
  * <p>The IAM role that the Amazon EMR Studio assumes. The service role
1649
1805
  * provides a way for Amazon EMR Studio to interoperate with other Amazon Web Services
1650
1806
  * services.</p>
1651
1807
  */
1652
1808
  ServiceRole: string | undefined;
1653
1809
  /**
1810
+ * @public
1654
1811
  * <p>The IAM user role that users and groups assume when logged in to an
1655
1812
  * Amazon EMR Studio. Only specify a <code>UserRole</code> when you use IAM Identity Center authentication. The permissions attached to the <code>UserRole</code> can be
1656
1813
  * scoped down for each user or group using session policies.</p>
1657
1814
  */
1658
1815
  UserRole?: string;
1659
1816
  /**
1817
+ * @public
1660
1818
  * <p>The ID of the Amazon EMR Studio Workspace security group. The Workspace security
1661
1819
  * group allows outbound network traffic to resources in the Engine security group, and it
1662
1820
  * must be in the same VPC specified by <code>VpcId</code>.</p>
1663
1821
  */
1664
1822
  WorkspaceSecurityGroupId: string | undefined;
1665
1823
  /**
1824
+ * @public
1666
1825
  * <p>The ID of the Amazon EMR Studio Engine security group. The Engine security group
1667
1826
  * allows inbound network traffic from the Workspace security group, and it must be in the
1668
1827
  * same VPC specified by <code>VpcId</code>.</p>
1669
1828
  */
1670
1829
  EngineSecurityGroupId: string | undefined;
1671
1830
  /**
1831
+ * @public
1672
1832
  * <p>The Amazon S3 location to back up Amazon EMR Studio Workspaces and
1673
1833
  * notebook files.</p>
1674
1834
  */
1675
1835
  DefaultS3Location: string | undefined;
1676
1836
  /**
1837
+ * @public
1677
1838
  * <p>The authentication endpoint of your identity provider (IdP). Specify this value when you
1678
1839
  * use IAM authentication and want to let federated users log in to a Studio
1679
1840
  * with the Studio URL and credentials from your IdP. Amazon EMR Studio redirects
@@ -1681,6 +1842,7 @@ export interface CreateStudioInput {
1681
1842
  */
1682
1843
  IdpAuthUrl?: string;
1683
1844
  /**
1845
+ * @public
1684
1846
  * <p>The name that your identity provider (IdP) uses for its <code>RelayState</code>
1685
1847
  * parameter. For example, <code>RelayState</code> or <code>TargetSource</code>. Specify this
1686
1848
  * value when you use IAM authentication and want to let federated users log in
@@ -1689,6 +1851,7 @@ export interface CreateStudioInput {
1689
1851
  */
1690
1852
  IdpRelayStateParameterName?: string;
1691
1853
  /**
1854
+ * @public
1692
1855
  * <p>A list of tags to associate with the Amazon EMR Studio. Tags are user-defined
1693
1856
  * key-value pairs that consist of a required key string with a maximum of 128 characters, and
1694
1857
  * an optional value string with a maximum of 256 characters.</p>
@@ -1700,10 +1863,12 @@ export interface CreateStudioInput {
1700
1863
  */
1701
1864
  export interface CreateStudioOutput {
1702
1865
  /**
1866
+ * @public
1703
1867
  * <p>The ID of the Amazon EMR Studio.</p>
1704
1868
  */
1705
1869
  StudioId?: string;
1706
1870
  /**
1871
+ * @public
1707
1872
  * <p>The unique Studio access URL.</p>
1708
1873
  */
1709
1874
  Url?: string;
@@ -1725,11 +1890,13 @@ export type IdentityType = (typeof IdentityType)[keyof typeof IdentityType];
1725
1890
  */
1726
1891
  export interface CreateStudioSessionMappingInput {
1727
1892
  /**
1893
+ * @public
1728
1894
  * <p>The ID of the Amazon EMR Studio to which the user or group will be
1729
1895
  * mapped.</p>
1730
1896
  */
1731
1897
  StudioId: string | undefined;
1732
1898
  /**
1899
+ * @public
1733
1900
  * <p>The globally unique identifier (GUID) of the user or group from the IAM Identity Center
1734
1901
  * Identity Store. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserId">UserId</a> and <a href="https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-GroupId">GroupId</a> in the <i>IAM Identity Center Identity Store API
1735
1902
  * Reference</i>. Either <code>IdentityName</code> or <code>IdentityId</code> must
@@ -1737,17 +1904,20 @@ export interface CreateStudioSessionMappingInput {
1737
1904
  */
1738
1905
  IdentityId?: string;
1739
1906
  /**
1907
+ * @public
1740
1908
  * <p>The name of the user or group. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserName">UserName</a> and <a href="https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName">DisplayName</a> in the <i>IAM Identity Center Identity Store API
1741
1909
  * Reference</i>. Either <code>IdentityName</code> or <code>IdentityId</code> must
1742
1910
  * be specified, but not both.</p>
1743
1911
  */
1744
1912
  IdentityName?: string;
1745
1913
  /**
1914
+ * @public
1746
1915
  * <p>Specifies whether the identity to map to the Amazon EMR Studio is a user or a
1747
1916
  * group.</p>
1748
1917
  */
1749
1918
  IdentityType: IdentityType | string | undefined;
1750
1919
  /**
1920
+ * @public
1751
1921
  * <p>The Amazon Resource Name (ARN) for the session policy that will be applied to the user
1752
1922
  * or group. You should specify the ARN for the session policy that you want to apply, not the
1753
1923
  * ARN of your user role. For more information, see <a href="https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-studio-user-role.html">Create an Amazon EMR
@@ -1761,11 +1931,13 @@ export interface CreateStudioSessionMappingInput {
1761
1931
  */
1762
1932
  export interface UsernamePassword {
1763
1933
  /**
1934
+ * @public
1764
1935
  * <p>The username associated with the temporary credentials that you use to connect to
1765
1936
  * cluster endpoints.</p>
1766
1937
  */
1767
1938
  Username?: string;
1768
1939
  /**
1940
+ * @public
1769
1941
  * <p>The password associated with the temporary credentials that you use to connect to
1770
1942
  * cluster endpoints.</p>
1771
1943
  */
@@ -1782,12 +1954,16 @@ export type Credentials = Credentials.UsernamePasswordMember | Credentials.$Unkn
1782
1954
  */
1783
1955
  export declare namespace Credentials {
1784
1956
  /**
1957
+ * @public
1785
1958
  * <p>The username and password that you use to connect to cluster endpoints.</p>
1786
1959
  */
1787
1960
  interface UsernamePasswordMember {
1788
1961
  UsernamePassword: UsernamePassword;
1789
1962
  $unknown?: never;
1790
1963
  }
1964
+ /**
1965
+ * @public
1966
+ */
1791
1967
  interface $UnknownMember {
1792
1968
  UsernamePassword?: never;
1793
1969
  $unknown: [string, any];
@@ -1803,6 +1979,7 @@ export declare namespace Credentials {
1803
1979
  */
1804
1980
  export interface DeleteSecurityConfigurationInput {
1805
1981
  /**
1982
+ * @public
1806
1983
  * <p>The name of the security configuration.</p>
1807
1984
  */
1808
1985
  Name: string | undefined;
@@ -1817,6 +1994,7 @@ export interface DeleteSecurityConfigurationOutput {
1817
1994
  */
1818
1995
  export interface DeleteStudioInput {
1819
1996
  /**
1997
+ * @public
1820
1998
  * <p>The ID of the Amazon EMR Studio.</p>
1821
1999
  */
1822
2000
  StudioId: string | undefined;
@@ -1826,22 +2004,26 @@ export interface DeleteStudioInput {
1826
2004
  */
1827
2005
  export interface DeleteStudioSessionMappingInput {
1828
2006
  /**
2007
+ * @public
1829
2008
  * <p>The ID of the Amazon EMR Studio.</p>
1830
2009
  */
1831
2010
  StudioId: string | undefined;
1832
2011
  /**
2012
+ * @public
1833
2013
  * <p>The globally unique identifier (GUID) of the user or group to remove from the Amazon EMR Studio. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserId">UserId</a> and <a href="https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-GroupId">GroupId</a> in the <i>IAM Identity Center Identity Store API
1834
2014
  * Reference</i>. Either <code>IdentityName</code> or <code>IdentityId</code> must
1835
2015
  * be specified.</p>
1836
2016
  */
1837
2017
  IdentityId?: string;
1838
2018
  /**
2019
+ * @public
1839
2020
  * <p>The name of the user name or group to remove from the Amazon EMR Studio. For
1840
2021
  * more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserName">UserName</a> and <a href="https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName">DisplayName</a> in the <i>IAM Identity Center Store API Reference</i>.
1841
2022
  * Either <code>IdentityName</code> or <code>IdentityId</code> must be specified.</p>
1842
2023
  */
1843
2024
  IdentityName?: string;
1844
2025
  /**
2026
+ * @public
1845
2027
  * <p>Specifies whether the identity to delete from the Amazon EMR Studio is a user or
1846
2028
  * a group.</p>
1847
2029
  */
@@ -1853,6 +2035,7 @@ export interface DeleteStudioSessionMappingInput {
1853
2035
  */
1854
2036
  export interface DescribeClusterInput {
1855
2037
  /**
2038
+ * @public
1856
2039
  * <p>The identifier of the cluster to describe.</p>
1857
2040
  */
1858
2041
  ClusterId: string | undefined;
@@ -1881,18 +2064,22 @@ export type JobFlowExecutionState = (typeof JobFlowExecutionState)[keyof typeof
1881
2064
  */
1882
2065
  export interface DescribeJobFlowsInput {
1883
2066
  /**
2067
+ * @public
1884
2068
  * <p>Return only job flows created after this date and time.</p>
1885
2069
  */
1886
2070
  CreatedAfter?: Date;
1887
2071
  /**
2072
+ * @public
1888
2073
  * <p>Return only job flows created before this date and time.</p>
1889
2074
  */
1890
2075
  CreatedBefore?: Date;
1891
2076
  /**
2077
+ * @public
1892
2078
  * <p>Return only job flows whose job flow ID is contained in this list.</p>
1893
2079
  */
1894
2080
  JobFlowIds?: string[];
1895
2081
  /**
2082
+ * @public
1896
2083
  * <p>Return only job flows whose state is contained in this list.</p>
1897
2084
  */
1898
2085
  JobFlowStates?: (JobFlowExecutionState | string)[];
@@ -1903,26 +2090,32 @@ export interface DescribeJobFlowsInput {
1903
2090
  */
1904
2091
  export interface JobFlowExecutionStatusDetail {
1905
2092
  /**
2093
+ * @public
1906
2094
  * <p>The state of the job flow.</p>
1907
2095
  */
1908
2096
  State: JobFlowExecutionState | string | undefined;
1909
2097
  /**
2098
+ * @public
1910
2099
  * <p>The creation date and time of the job flow.</p>
1911
2100
  */
1912
2101
  CreationDateTime: Date | undefined;
1913
2102
  /**
2103
+ * @public
1914
2104
  * <p>The start date and time of the job flow.</p>
1915
2105
  */
1916
2106
  StartDateTime?: Date;
1917
2107
  /**
2108
+ * @public
1918
2109
  * <p>The date and time when the job flow was ready to start running bootstrap actions.</p>
1919
2110
  */
1920
2111
  ReadyDateTime?: Date;
1921
2112
  /**
2113
+ * @public
1922
2114
  * <p>The completion date and time of the job flow.</p>
1923
2115
  */
1924
2116
  EndDateTime?: Date;
1925
2117
  /**
2118
+ * @public
1926
2119
  * <p>Description of the job flow last changed state.</p>
1927
2120
  */
1928
2121
  LastStateChangeReason?: string;
@@ -1954,65 +2147,80 @@ export type InstanceGroupState = (typeof InstanceGroupState)[keyof typeof Instan
1954
2147
  */
1955
2148
  export interface InstanceGroupDetail {
1956
2149
  /**
2150
+ * @public
1957
2151
  * <p>Unique identifier for the instance group.</p>
1958
2152
  */
1959
2153
  InstanceGroupId?: string;
1960
2154
  /**
2155
+ * @public
1961
2156
  * <p>Friendly name for the instance group.</p>
1962
2157
  */
1963
2158
  Name?: string;
1964
2159
  /**
2160
+ * @public
1965
2161
  * <p>Market type of the Amazon EC2 instances used to create a cluster node.</p>
1966
2162
  */
1967
2163
  Market: MarketType | string | undefined;
1968
2164
  /**
2165
+ * @public
1969
2166
  * <p>Instance group role in the cluster</p>
1970
2167
  */
1971
2168
  InstanceRole: InstanceRoleType | string | undefined;
1972
2169
  /**
2170
+ * @public
1973
2171
  * <p>If specified, indicates that the instance group uses Spot Instances. This is the maximum
1974
2172
  * price you are willing to pay for Spot Instances. Specify <code>OnDemandPrice</code> to set
1975
2173
  * the amount equal to the On-Demand price, or specify an amount in USD.</p>
1976
2174
  */
1977
2175
  BidPrice?: string;
1978
2176
  /**
2177
+ * @public
1979
2178
  * <p>Amazon EC2 instance type.</p>
1980
2179
  */
1981
2180
  InstanceType: string | undefined;
1982
2181
  /**
2182
+ * @public
1983
2183
  * <p>Target number of instances to run in the instance group.</p>
1984
2184
  */
1985
2185
  InstanceRequestCount: number | undefined;
1986
2186
  /**
2187
+ * @public
1987
2188
  * <p>Actual count of running instances.</p>
1988
2189
  */
1989
2190
  InstanceRunningCount: number | undefined;
1990
2191
  /**
2192
+ * @public
1991
2193
  * <p>State of instance group. The following values are no longer supported: STARTING,
1992
2194
  * TERMINATED, and FAILED.</p>
1993
2195
  */
1994
2196
  State: InstanceGroupState | string | undefined;
1995
2197
  /**
2198
+ * @public
1996
2199
  * <p>Details regarding the state of the instance group.</p>
1997
2200
  */
1998
2201
  LastStateChangeReason?: string;
1999
2202
  /**
2203
+ * @public
2000
2204
  * <p>The date/time the instance group was created.</p>
2001
2205
  */
2002
2206
  CreationDateTime: Date | undefined;
2003
2207
  /**
2208
+ * @public
2004
2209
  * <p>The date/time the instance group was started.</p>
2005
2210
  */
2006
2211
  StartDateTime?: Date;
2007
2212
  /**
2213
+ * @public
2008
2214
  * <p>The date/time the instance group was available to the cluster.</p>
2009
2215
  */
2010
2216
  ReadyDateTime?: Date;
2011
2217
  /**
2218
+ * @public
2012
2219
  * <p>The date/time the instance group was terminated.</p>
2013
2220
  */
2014
2221
  EndDateTime?: Date;
2015
2222
  /**
2223
+ * @public
2016
2224
  * <p>The custom AMI ID to use for the provisioned instance group.</p>
2017
2225
  */
2018
2226
  CustomAmiId?: string;
@@ -2023,12 +2231,14 @@ export interface InstanceGroupDetail {
2023
2231
  */
2024
2232
  export interface PlacementType {
2025
2233
  /**
2234
+ * @public
2026
2235
  * <p>The Amazon EC2 Availability Zone for the cluster. <code>AvailabilityZone</code>
2027
2236
  * is used for uniform instance groups, while <code>AvailabilityZones</code> (plural) is used
2028
2237
  * for instance fleets.</p>
2029
2238
  */
2030
2239
  AvailabilityZone?: string;
2031
2240
  /**
2241
+ * @public
2032
2242
  * <p>When multiple Availability Zones are specified, Amazon EMR evaluates them and
2033
2243
  * launches instances in the optimal Availability Zone. <code>AvailabilityZones</code> is used
2034
2244
  * for instance fleets, while <code>AvailabilityZone</code> (singular) is used for uniform
@@ -2047,33 +2257,40 @@ export interface PlacementType {
2047
2257
  */
2048
2258
  export interface JobFlowInstancesDetail {
2049
2259
  /**
2260
+ * @public
2050
2261
  * <p>The Amazon EC2 master node instance type.</p>
2051
2262
  */
2052
2263
  MasterInstanceType: string | undefined;
2053
2264
  /**
2265
+ * @public
2054
2266
  * <p>The DNS name of the master node. If the cluster is on a private subnet, this is the
2055
2267
  * private DNS name. On a public subnet, this is the public DNS name.</p>
2056
2268
  */
2057
2269
  MasterPublicDnsName?: string;
2058
2270
  /**
2271
+ * @public
2059
2272
  * <p>The Amazon EC2 instance identifier of the master node.</p>
2060
2273
  */
2061
2274
  MasterInstanceId?: string;
2062
2275
  /**
2276
+ * @public
2063
2277
  * <p>The Amazon EC2 core and task node instance type.</p>
2064
2278
  */
2065
2279
  SlaveInstanceType: string | undefined;
2066
2280
  /**
2281
+ * @public
2067
2282
  * <p>The number of Amazon EC2 instances in the cluster. If the value is 1, the same
2068
2283
  * instance serves as both the master and core and task node. If the value is greater than 1,
2069
2284
  * one instance is the master node and all others are core and task nodes.</p>
2070
2285
  */
2071
2286
  InstanceCount: number | undefined;
2072
2287
  /**
2288
+ * @public
2073
2289
  * <p>Details about the instance groups in a cluster.</p>
2074
2290
  */
2075
2291
  InstanceGroups?: InstanceGroupDetail[];
2076
2292
  /**
2293
+ * @public
2077
2294
  * <p>An approximation of the cost of the cluster, represented in m1.small/hours. This value
2078
2295
  * is increased one time for every hour that an m1.small instance runs. Larger instances are
2079
2296
  * weighted more heavily, so an Amazon EC2 instance that is roughly four times more
@@ -2083,29 +2300,35 @@ export interface JobFlowInstancesDetail {
2083
2300
  */
2084
2301
  NormalizedInstanceHours?: number;
2085
2302
  /**
2303
+ * @public
2086
2304
  * <p>The name of an Amazon EC2 key pair that can be used to connect to the master
2087
2305
  * node using SSH.</p>
2088
2306
  */
2089
2307
  Ec2KeyName?: string;
2090
2308
  /**
2309
+ * @public
2091
2310
  * <p>For clusters launched within Amazon Virtual Private Cloud, this is the identifier of the
2092
2311
  * subnet where the cluster was launched.</p>
2093
2312
  */
2094
2313
  Ec2SubnetId?: string;
2095
2314
  /**
2315
+ * @public
2096
2316
  * <p>The Amazon EC2 Availability Zone for the cluster.</p>
2097
2317
  */
2098
2318
  Placement?: PlacementType;
2099
2319
  /**
2320
+ * @public
2100
2321
  * <p>Specifies whether the cluster should remain available after completing all steps.</p>
2101
2322
  */
2102
2323
  KeepJobFlowAliveWhenNoSteps?: boolean;
2103
2324
  /**
2325
+ * @public
2104
2326
  * <p>Specifies whether the Amazon EC2 instances in the cluster are protected from
2105
2327
  * termination by API calls, user intervention, or in the event of a job-flow error.</p>
2106
2328
  */
2107
2329
  TerminationProtected?: boolean;
2108
2330
  /**
2331
+ * @public
2109
2332
  * <p>The Hadoop version for the cluster.</p>
2110
2333
  */
2111
2334
  HadoopVersion?: string;
@@ -2133,22 +2356,27 @@ export type StepExecutionState = (typeof StepExecutionState)[keyof typeof StepEx
2133
2356
  */
2134
2357
  export interface StepExecutionStatusDetail {
2135
2358
  /**
2359
+ * @public
2136
2360
  * <p>The state of the step.</p>
2137
2361
  */
2138
2362
  State: StepExecutionState | string | undefined;
2139
2363
  /**
2364
+ * @public
2140
2365
  * <p>The creation date and time of the step.</p>
2141
2366
  */
2142
2367
  CreationDateTime: Date | undefined;
2143
2368
  /**
2369
+ * @public
2144
2370
  * <p>The start date and time of the step.</p>
2145
2371
  */
2146
2372
  StartDateTime?: Date;
2147
2373
  /**
2374
+ * @public
2148
2375
  * <p>The completion date and time of the step.</p>
2149
2376
  */
2150
2377
  EndDateTime?: Date;
2151
2378
  /**
2379
+ * @public
2152
2380
  * <p>A description of the step's current state.</p>
2153
2381
  */
2154
2382
  LastStateChangeReason?: string;
@@ -2159,10 +2387,12 @@ export interface StepExecutionStatusDetail {
2159
2387
  */
2160
2388
  export interface StepDetail {
2161
2389
  /**
2390
+ * @public
2162
2391
  * <p>The step configuration.</p>
2163
2392
  */
2164
2393
  StepConfig: StepConfig | undefined;
2165
2394
  /**
2395
+ * @public
2166
2396
  * <p>The description of the step status.</p>
2167
2397
  */
2168
2398
  ExecutionStatusDetail: StepExecutionStatusDetail | undefined;
@@ -2173,50 +2403,61 @@ export interface StepDetail {
2173
2403
  */
2174
2404
  export interface JobFlowDetail {
2175
2405
  /**
2406
+ * @public
2176
2407
  * <p>The job flow identifier.</p>
2177
2408
  */
2178
2409
  JobFlowId: string | undefined;
2179
2410
  /**
2411
+ * @public
2180
2412
  * <p>The name of the job flow.</p>
2181
2413
  */
2182
2414
  Name: string | undefined;
2183
2415
  /**
2416
+ * @public
2184
2417
  * <p>The location in Amazon S3 where log files for the job are stored.</p>
2185
2418
  */
2186
2419
  LogUri?: string;
2187
2420
  /**
2421
+ * @public
2188
2422
  * <p>The KMS key used for encrypting log files. This attribute is only
2189
2423
  * available with Amazon EMR 5.30.0 and later, excluding 6.0.0.</p>
2190
2424
  */
2191
2425
  LogEncryptionKmsKeyId?: string;
2192
2426
  /**
2427
+ * @public
2193
2428
  * <p>Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR
2194
2429
  * releases 4.0 and later, <code>ReleaseLabel</code> is used. To specify a custom AMI, use
2195
2430
  * <code>CustomAmiID</code>.</p>
2196
2431
  */
2197
2432
  AmiVersion?: string;
2198
2433
  /**
2434
+ * @public
2199
2435
  * <p>Describes the execution status of the job flow.</p>
2200
2436
  */
2201
2437
  ExecutionStatusDetail: JobFlowExecutionStatusDetail | undefined;
2202
2438
  /**
2439
+ * @public
2203
2440
  * <p>Describes the Amazon EC2 instances of the job flow.</p>
2204
2441
  */
2205
2442
  Instances: JobFlowInstancesDetail | undefined;
2206
2443
  /**
2444
+ * @public
2207
2445
  * <p>A list of steps run by the job flow.</p>
2208
2446
  */
2209
2447
  Steps?: StepDetail[];
2210
2448
  /**
2449
+ * @public
2211
2450
  * <p>A list of the bootstrap actions run by the job flow.</p>
2212
2451
  */
2213
2452
  BootstrapActions?: BootstrapActionDetail[];
2214
2453
  /**
2454
+ * @public
2215
2455
  * <p>A list of strings set by third-party software when the job flow is launched. If you are
2216
2456
  * not using third-party software to manage the job flow, this value is empty.</p>
2217
2457
  */
2218
2458
  SupportedProducts?: string[];
2219
2459
  /**
2460
+ * @public
2220
2461
  * <p>Indicates whether the cluster is visible to IAM principals in the Amazon Web Services account associated with the cluster. When <code>true</code>, IAM principals in the Amazon Web Services account can perform Amazon EMR cluster
2221
2462
  * actions that their IAM policies allow. When <code>false</code>, only the
2222
2463
  * IAM principal that created the cluster and the Amazon Web Services account
@@ -2228,16 +2469,19 @@ export interface JobFlowDetail {
2228
2469
  */
2229
2470
  VisibleToAllUsers?: boolean;
2230
2471
  /**
2472
+ * @public
2231
2473
  * <p>The IAM role that was specified when the job flow was launched. The
2232
2474
  * Amazon EC2 instances of the job flow assume this role.</p>
2233
2475
  */
2234
2476
  JobFlowRole?: string;
2235
2477
  /**
2478
+ * @public
2236
2479
  * <p>The IAM role that is assumed by the Amazon EMR service to access
2237
2480
  * Amazon Web Services resources on your behalf.</p>
2238
2481
  */
2239
2482
  ServiceRole?: string;
2240
2483
  /**
2484
+ * @public
2241
2485
  * <p>An IAM role for automatic scaling policies. The default role is
2242
2486
  * <code>EMR_AutoScaling_DefaultRole</code>. The IAM role provides a way for
2243
2487
  * the automatic scaling feature to get the required permissions it needs to launch and
@@ -2245,6 +2489,7 @@ export interface JobFlowDetail {
2245
2489
  */
2246
2490
  AutoScalingRole?: string;
2247
2491
  /**
2492
+ * @public
2248
2493
  * <p>The way that individual Amazon EC2 instances terminate when an automatic
2249
2494
  * scale-in activity occurs or an instance group is resized.
2250
2495
  * <code>TERMINATE_AT_INSTANCE_HOUR</code> indicates that Amazon EMR terminates
@@ -2264,6 +2509,7 @@ export interface JobFlowDetail {
2264
2509
  */
2265
2510
  export interface DescribeJobFlowsOutput {
2266
2511
  /**
2512
+ * @public
2267
2513
  * <p>A list of job flows matching the parameters supplied.</p>
2268
2514
  */
2269
2515
  JobFlows?: JobFlowDetail[];
@@ -2273,6 +2519,7 @@ export interface DescribeJobFlowsOutput {
2273
2519
  */
2274
2520
  export interface DescribeNotebookExecutionInput {
2275
2521
  /**
2522
+ * @public
2276
2523
  * <p>The unique identifier of the notebook execution.</p>
2277
2524
  */
2278
2525
  NotebookExecutionId: string | undefined;
@@ -2295,15 +2542,18 @@ export type ExecutionEngineType = (typeof ExecutionEngineType)[keyof typeof Exec
2295
2542
  */
2296
2543
  export interface ExecutionEngineConfig {
2297
2544
  /**
2545
+ * @public
2298
2546
  * <p>The unique identifier of the execution engine. For an Amazon EMR cluster, this
2299
2547
  * is the cluster ID.</p>
2300
2548
  */
2301
2549
  Id: string | undefined;
2302
2550
  /**
2551
+ * @public
2303
2552
  * <p>The type of execution engine. A value of <code>EMR</code> specifies an Amazon EMR cluster.</p>
2304
2553
  */
2305
2554
  Type?: ExecutionEngineType | string;
2306
2555
  /**
2556
+ * @public
2307
2557
  * <p>An optional unique ID of an Amazon EC2 security group to associate with the
2308
2558
  * master instance of the Amazon EMR cluster for this notebook execution. For more
2309
2559
  * information see <a href="https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-managed-notebooks-security-groups.html">Specifying
@@ -2312,6 +2562,7 @@ export interface ExecutionEngineConfig {
2312
2562
  */
2313
2563
  MasterInstanceSecurityGroupId?: string;
2314
2564
  /**
2565
+ * @public
2315
2566
  * <p>The execution role ARN required for the notebook execution.</p>
2316
2567
  */
2317
2568
  ExecutionRoleArn?: string;
@@ -2322,10 +2573,12 @@ export interface ExecutionEngineConfig {
2322
2573
  */
2323
2574
  export interface NotebookS3LocationForOutput {
2324
2575
  /**
2576
+ * @public
2325
2577
  * <p>The Amazon S3 bucket that stores the notebook execution input.</p>
2326
2578
  */
2327
2579
  Bucket?: string;
2328
2580
  /**
2581
+ * @public
2329
2582
  * <p>The key to the Amazon S3 location that stores the notebook execution
2330
2583
  * input.</p>
2331
2584
  */
@@ -2348,10 +2601,12 @@ export type OutputNotebookFormat = (typeof OutputNotebookFormat)[keyof typeof Ou
2348
2601
  */
2349
2602
  export interface OutputNotebookS3LocationForOutput {
2350
2603
  /**
2604
+ * @public
2351
2605
  * <p>The Amazon S3 bucket that stores the notebook execution output.</p>
2352
2606
  */
2353
2607
  Bucket?: string;
2354
2608
  /**
2609
+ * @public
2355
2610
  * <p>The key to the Amazon S3 location that stores the notebook execution
2356
2611
  * output.</p>
2357
2612
  */
@@ -2384,28 +2639,34 @@ export type NotebookExecutionStatus = (typeof NotebookExecutionStatus)[keyof typ
2384
2639
  */
2385
2640
  export interface NotebookExecution {
2386
2641
  /**
2642
+ * @public
2387
2643
  * <p>The unique identifier of a notebook execution.</p>
2388
2644
  */
2389
2645
  NotebookExecutionId?: string;
2390
2646
  /**
2647
+ * @public
2391
2648
  * <p>The unique identifier of the Amazon EMR Notebook that is used for the notebook
2392
2649
  * execution.</p>
2393
2650
  */
2394
2651
  EditorId?: string;
2395
2652
  /**
2653
+ * @public
2396
2654
  * <p>The execution engine, such as an Amazon EMR cluster, used to run the Amazon EMR notebook and perform the notebook execution.</p>
2397
2655
  */
2398
2656
  ExecutionEngine?: ExecutionEngineConfig;
2399
2657
  /**
2658
+ * @public
2400
2659
  * <p>A name for the notebook execution.</p>
2401
2660
  */
2402
2661
  NotebookExecutionName?: string;
2403
2662
  /**
2663
+ * @public
2404
2664
  * <p>Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for
2405
2665
  * execution.</p>
2406
2666
  */
2407
2667
  NotebookParams?: string;
2408
2668
  /**
2669
+ * @public
2409
2670
  * <p>The status of the notebook execution.</p>
2410
2671
  * <ul>
2411
2672
  * <li>
@@ -2461,26 +2722,32 @@ export interface NotebookExecution {
2461
2722
  */
2462
2723
  Status?: NotebookExecutionStatus | string;
2463
2724
  /**
2725
+ * @public
2464
2726
  * <p>The timestamp when notebook execution started.</p>
2465
2727
  */
2466
2728
  StartTime?: Date;
2467
2729
  /**
2730
+ * @public
2468
2731
  * <p>The timestamp when notebook execution ended.</p>
2469
2732
  */
2470
2733
  EndTime?: Date;
2471
2734
  /**
2735
+ * @public
2472
2736
  * <p>The Amazon Resource Name (ARN) of the notebook execution.</p>
2473
2737
  */
2474
2738
  Arn?: string;
2475
2739
  /**
2740
+ * @public
2476
2741
  * <p>The location of the notebook execution's output file in Amazon S3.</p>
2477
2742
  */
2478
2743
  OutputNotebookURI?: string;
2479
2744
  /**
2745
+ * @public
2480
2746
  * <p>The reason for the latest status change of the notebook execution.</p>
2481
2747
  */
2482
2748
  LastStateChangeReason?: string;
2483
2749
  /**
2750
+ * @public
2484
2751
  * <p>The unique identifier of the Amazon EC2 security group associated with the
2485
2752
  * Amazon EMR Notebook instance. For more information see <a href="https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-managed-notebooks-security-groups.html">Specifying
2486
2753
  * Amazon EC2 Security Groups for Amazon EMR Notebooks</a> in the
@@ -2488,24 +2755,29 @@ export interface NotebookExecution {
2488
2755
  */
2489
2756
  NotebookInstanceSecurityGroupId?: string;
2490
2757
  /**
2758
+ * @public
2491
2759
  * <p>A list of tags associated with a notebook execution. Tags are user-defined key-value
2492
2760
  * pairs that consist of a required key string with a maximum of 128 characters and an
2493
2761
  * optional value string with a maximum of 256 characters.</p>
2494
2762
  */
2495
2763
  Tags?: Tag[];
2496
2764
  /**
2765
+ * @public
2497
2766
  * <p>The Amazon S3 location that stores the notebook execution input.</p>
2498
2767
  */
2499
2768
  NotebookS3Location?: NotebookS3LocationForOutput;
2500
2769
  /**
2770
+ * @public
2501
2771
  * <p>The Amazon S3 location for the notebook execution output.</p>
2502
2772
  */
2503
2773
  OutputNotebookS3Location?: OutputNotebookS3LocationForOutput;
2504
2774
  /**
2775
+ * @public
2505
2776
  * <p>The output format for the notebook execution.</p>
2506
2777
  */
2507
2778
  OutputNotebookFormat?: OutputNotebookFormat | string;
2508
2779
  /**
2780
+ * @public
2509
2781
  * <p>The environment variables associated with the notebook execution.</p>
2510
2782
  */
2511
2783
  EnvironmentVariables?: Record<string, string>;
@@ -2515,6 +2787,7 @@ export interface NotebookExecution {
2515
2787
  */
2516
2788
  export interface DescribeNotebookExecutionOutput {
2517
2789
  /**
2790
+ * @public
2518
2791
  * <p>Properties of the notebook execution.</p>
2519
2792
  */
2520
2793
  NotebookExecution?: NotebookExecution;
@@ -2524,14 +2797,17 @@ export interface DescribeNotebookExecutionOutput {
2524
2797
  */
2525
2798
  export interface DescribeReleaseLabelInput {
2526
2799
  /**
2800
+ * @public
2527
2801
  * <p>The target release label to be described.</p>
2528
2802
  */
2529
2803
  ReleaseLabel?: string;
2530
2804
  /**
2805
+ * @public
2531
2806
  * <p>The pagination token. Reserved for future use. Currently set to null.</p>
2532
2807
  */
2533
2808
  NextToken?: string;
2534
2809
  /**
2810
+ * @public
2535
2811
  * <p>Reserved for future use. Currently set to null.</p>
2536
2812
  */
2537
2813
  MaxResults?: number;
@@ -2542,10 +2818,12 @@ export interface DescribeReleaseLabelInput {
2542
2818
  */
2543
2819
  export interface SimplifiedApplication {
2544
2820
  /**
2821
+ * @public
2545
2822
  * <p>The returned release label application name. For example, <code>hadoop</code>.</p>
2546
2823
  */
2547
2824
  Name?: string;
2548
2825
  /**
2826
+ * @public
2549
2827
  * <p>The returned release label application version. For example, <code>3.2.1</code>.</p>
2550
2828
  */
2551
2829
  Version?: string;
@@ -2556,6 +2834,7 @@ export interface SimplifiedApplication {
2556
2834
  */
2557
2835
  export interface OSRelease {
2558
2836
  /**
2837
+ * @public
2559
2838
  * <p>The Amazon Linux release specified for a cluster in the RunJobFlow request. The format
2560
2839
  * is as shown in <a href="https://docs.aws.amazon.com/AL2/latest/relnotes/relnotes-20220218.html">
2561
2840
  * <i>Amazon Linux 2 Release Notes</i>
@@ -2569,20 +2848,24 @@ export interface OSRelease {
2569
2848
  */
2570
2849
  export interface DescribeReleaseLabelOutput {
2571
2850
  /**
2851
+ * @public
2572
2852
  * <p>The target release label described in the response.</p>
2573
2853
  */
2574
2854
  ReleaseLabel?: string;
2575
2855
  /**
2856
+ * @public
2576
2857
  * <p>The list of applications available for the target release label. <code>Name</code> is
2577
2858
  * the name of the application. <code>Version</code> is the concise version of the
2578
2859
  * application.</p>
2579
2860
  */
2580
2861
  Applications?: SimplifiedApplication[];
2581
2862
  /**
2863
+ * @public
2582
2864
  * <p>The pagination token. Reserved for future use. Currently set to null.</p>
2583
2865
  */
2584
2866
  NextToken?: string;
2585
2867
  /**
2868
+ * @public
2586
2869
  * <p>The list of available Amazon Linux release versions for an Amazon EMR release.
2587
2870
  * Contains a Label field that is formatted as shown in <a href="https://docs.aws.amazon.com/AL2/latest/relnotes/relnotes-al2.html">
2588
2871
  * <i>Amazon Linux 2 Release
@@ -2596,6 +2879,7 @@ export interface DescribeReleaseLabelOutput {
2596
2879
  */
2597
2880
  export interface DescribeSecurityConfigurationInput {
2598
2881
  /**
2882
+ * @public
2599
2883
  * <p>The name of the security configuration.</p>
2600
2884
  */
2601
2885
  Name: string | undefined;
@@ -2605,14 +2889,17 @@ export interface DescribeSecurityConfigurationInput {
2605
2889
  */
2606
2890
  export interface DescribeSecurityConfigurationOutput {
2607
2891
  /**
2892
+ * @public
2608
2893
  * <p>The name of the security configuration.</p>
2609
2894
  */
2610
2895
  Name?: string;
2611
2896
  /**
2897
+ * @public
2612
2898
  * <p>The security configuration details in JSON format.</p>
2613
2899
  */
2614
2900
  SecurityConfiguration?: string;
2615
2901
  /**
2902
+ * @public
2616
2903
  * <p>The date and time the security configuration was created</p>
2617
2904
  */
2618
2905
  CreationDateTime?: Date;
@@ -2623,10 +2910,12 @@ export interface DescribeSecurityConfigurationOutput {
2623
2910
  */
2624
2911
  export interface DescribeStepInput {
2625
2912
  /**
2913
+ * @public
2626
2914
  * <p>The identifier of the cluster with steps to describe.</p>
2627
2915
  */
2628
2916
  ClusterId: string | undefined;
2629
2917
  /**
2918
+ * @public
2630
2919
  * <p>The identifier of the step to describe.</p>
2631
2920
  */
2632
2921
  StepId: string | undefined;
@@ -2639,20 +2928,24 @@ export interface DescribeStepInput {
2639
2928
  */
2640
2929
  export interface HadoopStepConfig {
2641
2930
  /**
2931
+ * @public
2642
2932
  * <p>The path to the JAR file that runs during the step.</p>
2643
2933
  */
2644
2934
  Jar?: string;
2645
2935
  /**
2936
+ * @public
2646
2937
  * <p>The list of Java properties that are set when the step runs. You can use these
2647
2938
  * properties to pass key-value pairs to your main function.</p>
2648
2939
  */
2649
2940
  Properties?: Record<string, string>;
2650
2941
  /**
2942
+ * @public
2651
2943
  * <p>The name of the main class in the specified Java file. If not specified, the JAR file
2652
2944
  * should specify a main class in its manifest file.</p>
2653
2945
  */
2654
2946
  MainClass?: string;
2655
2947
  /**
2948
+ * @public
2656
2949
  * <p>The list of command line arguments to pass to the JAR file's main function for
2657
2950
  * execution.</p>
2658
2951
  */
@@ -2665,17 +2958,20 @@ export interface HadoopStepConfig {
2665
2958
  */
2666
2959
  export interface FailureDetails {
2667
2960
  /**
2961
+ * @public
2668
2962
  * <p>The reason for the step failure. In the case where the service cannot successfully
2669
2963
  * determine the root cause of the failure, it returns "Unknown Error" as a reason.</p>
2670
2964
  */
2671
2965
  Reason?: string;
2672
2966
  /**
2967
+ * @public
2673
2968
  * <p>The descriptive message including the error the Amazon EMR service has
2674
2969
  * identified as the cause of step failure. This is text from an error log that describes the
2675
2970
  * root cause of the failure.</p>
2676
2971
  */
2677
2972
  Message?: string;
2678
2973
  /**
2974
+ * @public
2679
2975
  * <p>The path to the log file where the step failure root cause was originally
2680
2976
  * recorded.</p>
2681
2977
  */
@@ -2715,11 +3011,13 @@ export type StepStateChangeReasonCode = (typeof StepStateChangeReasonCode)[keyof
2715
3011
  */
2716
3012
  export interface StepStateChangeReason {
2717
3013
  /**
3014
+ * @public
2718
3015
  * <p>The programmable code for the state change reason. Note: Currently, the service provides
2719
3016
  * no code for the state change.</p>
2720
3017
  */
2721
3018
  Code?: StepStateChangeReasonCode | string;
2722
3019
  /**
3020
+ * @public
2723
3021
  * <p>The descriptive message for the state change reason.</p>
2724
3022
  */
2725
3023
  Message?: string;
@@ -2730,14 +3028,17 @@ export interface StepStateChangeReason {
2730
3028
  */
2731
3029
  export interface StepTimeline {
2732
3030
  /**
3031
+ * @public
2733
3032
  * <p>The date and time when the cluster step was created.</p>
2734
3033
  */
2735
3034
  CreationDateTime?: Date;
2736
3035
  /**
3036
+ * @public
2737
3037
  * <p>The date and time when the cluster step execution started.</p>
2738
3038
  */
2739
3039
  StartDateTime?: Date;
2740
3040
  /**
3041
+ * @public
2741
3042
  * <p>The date and time when the cluster step execution completed or failed.</p>
2742
3043
  */
2743
3044
  EndDateTime?: Date;
@@ -2748,19 +3049,23 @@ export interface StepTimeline {
2748
3049
  */
2749
3050
  export interface StepStatus {
2750
3051
  /**
3052
+ * @public
2751
3053
  * <p>The execution state of the cluster step.</p>
2752
3054
  */
2753
3055
  State?: StepState | string;
2754
3056
  /**
3057
+ * @public
2755
3058
  * <p>The reason for the step execution status change.</p>
2756
3059
  */
2757
3060
  StateChangeReason?: StepStateChangeReason;
2758
3061
  /**
3062
+ * @public
2759
3063
  * <p>The details for the step failure including reason, message, and log file path where the
2760
3064
  * root cause was identified.</p>
2761
3065
  */
2762
3066
  FailureDetails?: FailureDetails;
2763
3067
  /**
3068
+ * @public
2764
3069
  * <p>The timeline of the cluster step status over time.</p>
2765
3070
  */
2766
3071
  Timeline?: StepTimeline;
@@ -2771,18 +3076,22 @@ export interface StepStatus {
2771
3076
  */
2772
3077
  export interface Step {
2773
3078
  /**
3079
+ * @public
2774
3080
  * <p>The identifier of the cluster step.</p>
2775
3081
  */
2776
3082
  Id?: string;
2777
3083
  /**
3084
+ * @public
2778
3085
  * <p>The name of the cluster step.</p>
2779
3086
  */
2780
3087
  Name?: string;
2781
3088
  /**
3089
+ * @public
2782
3090
  * <p>The Hadoop job configuration of the cluster step.</p>
2783
3091
  */
2784
3092
  Config?: HadoopStepConfig;
2785
3093
  /**
3094
+ * @public
2786
3095
  * <p>The action to take when the cluster step fails. Possible values are
2787
3096
  * <code>TERMINATE_CLUSTER</code>, <code>CANCEL_AND_WAIT</code>, and <code>CONTINUE</code>.
2788
3097
  * <code>TERMINATE_JOB_FLOW</code> is provided for backward compatibility. We recommend
@@ -2801,10 +3110,12 @@ export interface Step {
2801
3110
  */
2802
3111
  ActionOnFailure?: ActionOnFailure | string;
2803
3112
  /**
3113
+ * @public
2804
3114
  * <p>The current execution status details of the cluster step.</p>
2805
3115
  */
2806
3116
  Status?: StepStatus;
2807
3117
  /**
3118
+ * @public
2808
3119
  * <p>The Amazon Resource Name (ARN) of the runtime role for a step on the cluster. The
2809
3120
  * runtime role can be a cross-account IAM role. The runtime role ARN is a
2810
3121
  * combination of account ID, role name, and role type using the following format:
@@ -2820,6 +3131,7 @@ export interface Step {
2820
3131
  */
2821
3132
  export interface DescribeStepOutput {
2822
3133
  /**
3134
+ * @public
2823
3135
  * <p>The step details for the requested step identifier.</p>
2824
3136
  */
2825
3137
  Step?: Step;
@@ -2829,6 +3141,7 @@ export interface DescribeStepOutput {
2829
3141
  */
2830
3142
  export interface DescribeStudioInput {
2831
3143
  /**
3144
+ * @public
2832
3145
  * <p>The Amazon EMR Studio ID.</p>
2833
3146
  */
2834
3147
  StudioId: string | undefined;
@@ -2840,77 +3153,94 @@ export interface DescribeStudioInput {
2840
3153
  */
2841
3154
  export interface Studio {
2842
3155
  /**
3156
+ * @public
2843
3157
  * <p>The ID of the Amazon EMR Studio.</p>
2844
3158
  */
2845
3159
  StudioId?: string;
2846
3160
  /**
3161
+ * @public
2847
3162
  * <p>The Amazon Resource Name (ARN) of the Amazon EMR Studio.</p>
2848
3163
  */
2849
3164
  StudioArn?: string;
2850
3165
  /**
3166
+ * @public
2851
3167
  * <p>The name of the Amazon EMR Studio.</p>
2852
3168
  */
2853
3169
  Name?: string;
2854
3170
  /**
3171
+ * @public
2855
3172
  * <p>The detailed description of the Amazon EMR Studio.</p>
2856
3173
  */
2857
3174
  Description?: string;
2858
3175
  /**
3176
+ * @public
2859
3177
  * <p>Specifies whether the Amazon EMR Studio authenticates users with IAM or IAM Identity Center.</p>
2860
3178
  */
2861
3179
  AuthMode?: AuthMode | string;
2862
3180
  /**
3181
+ * @public
2863
3182
  * <p>The ID of the VPC associated with the Amazon EMR Studio.</p>
2864
3183
  */
2865
3184
  VpcId?: string;
2866
3185
  /**
3186
+ * @public
2867
3187
  * <p>The list of IDs of the subnets associated with the Amazon EMR Studio.</p>
2868
3188
  */
2869
3189
  SubnetIds?: string[];
2870
3190
  /**
3191
+ * @public
2871
3192
  * <p>The name of the IAM role assumed by the Amazon EMR Studio.</p>
2872
3193
  */
2873
3194
  ServiceRole?: string;
2874
3195
  /**
3196
+ * @public
2875
3197
  * <p>The name of the IAM role assumed by users logged in to the Amazon EMR Studio. A Studio only requires a <code>UserRole</code> when you use IAM authentication.</p>
2876
3198
  */
2877
3199
  UserRole?: string;
2878
3200
  /**
3201
+ * @public
2879
3202
  * <p>The ID of the Workspace security group associated with the Amazon EMR Studio.
2880
3203
  * The Workspace security group allows outbound network traffic to resources in the Engine
2881
3204
  * security group and to the internet.</p>
2882
3205
  */
2883
3206
  WorkspaceSecurityGroupId?: string;
2884
3207
  /**
3208
+ * @public
2885
3209
  * <p>The ID of the Engine security group associated with the Amazon EMR Studio. The
2886
3210
  * Engine security group allows inbound network traffic from resources in the Workspace
2887
3211
  * security group.</p>
2888
3212
  */
2889
3213
  EngineSecurityGroupId?: string;
2890
3214
  /**
3215
+ * @public
2891
3216
  * <p>The unique access URL of the Amazon EMR Studio.</p>
2892
3217
  */
2893
3218
  Url?: string;
2894
3219
  /**
3220
+ * @public
2895
3221
  * <p>The time the Amazon EMR Studio was created.</p>
2896
3222
  */
2897
3223
  CreationTime?: Date;
2898
3224
  /**
3225
+ * @public
2899
3226
  * <p>The Amazon S3 location to back up Amazon EMR Studio Workspaces and
2900
3227
  * notebook files.</p>
2901
3228
  */
2902
3229
  DefaultS3Location?: string;
2903
3230
  /**
3231
+ * @public
2904
3232
  * <p>Your identity provider's authentication endpoint. Amazon EMR Studio redirects
2905
3233
  * federated users to this endpoint for authentication when logging in to a Studio with the
2906
3234
  * Studio URL.</p>
2907
3235
  */
2908
3236
  IdpAuthUrl?: string;
2909
3237
  /**
3238
+ * @public
2910
3239
  * <p>The name of your identity provider's <code>RelayState</code> parameter.</p>
2911
3240
  */
2912
3241
  IdpRelayStateParameterName?: string;
2913
3242
  /**
3243
+ * @public
2914
3244
  * <p>A list of tags associated with the Amazon EMR Studio.</p>
2915
3245
  */
2916
3246
  Tags?: Tag[];
@@ -2920,6 +3250,7 @@ export interface Studio {
2920
3250
  */
2921
3251
  export interface DescribeStudioOutput {
2922
3252
  /**
3253
+ * @public
2923
3254
  * <p>The Amazon EMR Studio details.</p>
2924
3255
  */
2925
3256
  Studio?: Studio;
@@ -2930,12 +3261,14 @@ export interface DescribeStudioOutput {
2930
3261
  */
2931
3262
  export interface EbsBlockDevice {
2932
3263
  /**
3264
+ * @public
2933
3265
  * <p>EBS volume specifications such as volume type, IOPS, size (GiB) and throughput (MiB/s)
2934
3266
  * that are requested for the EBS volume attached to an Amazon EC2 instance in the
2935
3267
  * cluster.</p>
2936
3268
  */
2937
3269
  VolumeSpecification?: VolumeSpecification;
2938
3270
  /**
3271
+ * @public
2939
3272
  * <p>The device name that is exposed to the instance, such as /dev/sdh.</p>
2940
3273
  */
2941
3274
  Device?: string;
@@ -2946,10 +3279,12 @@ export interface EbsBlockDevice {
2946
3279
  */
2947
3280
  export interface EbsVolume {
2948
3281
  /**
3282
+ * @public
2949
3283
  * <p>The device name that is exposed to the instance, such as /dev/sdh.</p>
2950
3284
  */
2951
3285
  Device?: string;
2952
3286
  /**
3287
+ * @public
2953
3288
  * <p>The volume identifier of the EBS volume.</p>
2954
3289
  */
2955
3290
  VolumeId?: string;
@@ -2959,6 +3294,7 @@ export interface EbsVolume {
2959
3294
  */
2960
3295
  export interface GetAutoTerminationPolicyInput {
2961
3296
  /**
3297
+ * @public
2962
3298
  * <p>Specifies the ID of the Amazon EMR cluster for which the auto-termination policy
2963
3299
  * will be fetched.</p>
2964
3300
  */
@@ -2969,6 +3305,7 @@ export interface GetAutoTerminationPolicyInput {
2969
3305
  */
2970
3306
  export interface GetAutoTerminationPolicyOutput {
2971
3307
  /**
3308
+ * @public
2972
3309
  * <p>Specifies the auto-termination policy that is attached to an Amazon EMR cluster.
2973
3310
  * </p>
2974
3311
  */
@@ -2984,10 +3321,12 @@ export interface GetBlockPublicAccessConfigurationInput {
2984
3321
  */
2985
3322
  export interface GetClusterSessionCredentialsInput {
2986
3323
  /**
3324
+ * @public
2987
3325
  * <p>The unique identifier of the cluster.</p>
2988
3326
  */
2989
3327
  ClusterId: string | undefined;
2990
3328
  /**
3329
+ * @public
2991
3330
  * <p>The Amazon Resource Name (ARN) of the runtime role for interactive workload submission
2992
3331
  * on the cluster. The runtime role can be a cross-account IAM role. The
2993
3332
  * runtime role ARN is a combination of account ID, role name, and role type using the
@@ -3000,11 +3339,13 @@ export interface GetClusterSessionCredentialsInput {
3000
3339
  */
3001
3340
  export interface GetClusterSessionCredentialsOutput {
3002
3341
  /**
3342
+ * @public
3003
3343
  * <p>The credentials that you can use to connect to cluster endpoints that support username
3004
3344
  * and password authentication.</p>
3005
3345
  */
3006
3346
  Credentials?: Credentials;
3007
3347
  /**
3348
+ * @public
3008
3349
  * <p>The time when the credentials that are returned by the
3009
3350
  * <code>GetClusterSessionCredentials</code> API expire.</p>
3010
3351
  */
@@ -3015,6 +3356,7 @@ export interface GetClusterSessionCredentialsOutput {
3015
3356
  */
3016
3357
  export interface GetManagedScalingPolicyInput {
3017
3358
  /**
3359
+ * @public
3018
3360
  * <p>Specifies the ID of the cluster for which the managed scaling policy will be fetched.
3019
3361
  * </p>
3020
3362
  */
@@ -3029,6 +3371,7 @@ export interface GetManagedScalingPolicyInput {
3029
3371
  */
3030
3372
  export interface ManagedScalingPolicy {
3031
3373
  /**
3374
+ * @public
3032
3375
  * <p>The Amazon EC2 unit limits for a managed scaling policy. The managed scaling
3033
3376
  * activity of a cluster is not allowed to go above or below these limits. The limit only
3034
3377
  * applies to the core and task nodes. The master node cannot be scaled after initial
@@ -3041,6 +3384,7 @@ export interface ManagedScalingPolicy {
3041
3384
  */
3042
3385
  export interface GetManagedScalingPolicyOutput {
3043
3386
  /**
3387
+ * @public
3044
3388
  * <p>Specifies the managed scaling policy that is attached to an Amazon EMR cluster.
3045
3389
  * </p>
3046
3390
  */
@@ -3051,10 +3395,12 @@ export interface GetManagedScalingPolicyOutput {
3051
3395
  */
3052
3396
  export interface GetStudioSessionMappingInput {
3053
3397
  /**
3398
+ * @public
3054
3399
  * <p>The ID of the Amazon EMR Studio.</p>
3055
3400
  */
3056
3401
  StudioId: string | undefined;
3057
3402
  /**
3403
+ * @public
3058
3404
  * <p>The globally unique identifier (GUID) of the user or group. For more information, see
3059
3405
  * <a href="https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserId">UserId</a> and <a href="https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-GroupId">GroupId</a> in the <i>IAM Identity Center Identity Store API
3060
3406
  * Reference</i>. Either <code>IdentityName</code> or <code>IdentityId</code> must
@@ -3062,12 +3408,14 @@ export interface GetStudioSessionMappingInput {
3062
3408
  */
3063
3409
  IdentityId?: string;
3064
3410
  /**
3411
+ * @public
3065
3412
  * <p>The name of the user or group to fetch. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserName">UserName</a> and <a href="https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName">DisplayName</a> in the <i>IAM Identity Center Identity Store API
3066
3413
  * Reference</i>. Either <code>IdentityName</code> or <code>IdentityId</code> must
3067
3414
  * be specified.</p>
3068
3415
  */
3069
3416
  IdentityName?: string;
3070
3417
  /**
3418
+ * @public
3071
3419
  * <p>Specifies whether the identity to fetch is a user or a group.</p>
3072
3420
  */
3073
3421
  IdentityType: IdentityType | string | undefined;
@@ -3079,33 +3427,40 @@ export interface GetStudioSessionMappingInput {
3079
3427
  */
3080
3428
  export interface SessionMappingDetail {
3081
3429
  /**
3430
+ * @public
3082
3431
  * <p>The ID of the Amazon EMR Studio.</p>
3083
3432
  */
3084
3433
  StudioId?: string;
3085
3434
  /**
3435
+ * @public
3086
3436
  * <p>The globally unique identifier (GUID) of the user or group.</p>
3087
3437
  */
3088
3438
  IdentityId?: string;
3089
3439
  /**
3440
+ * @public
3090
3441
  * <p>The name of the user or group. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserName">UserName</a> and <a href="https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName">DisplayName</a> in the <i>IAM Identity Center Identity Store API
3091
3442
  * Reference</i>.</p>
3092
3443
  */
3093
3444
  IdentityName?: string;
3094
3445
  /**
3446
+ * @public
3095
3447
  * <p>Specifies whether the identity mapped to the Amazon EMR Studio is a user or a
3096
3448
  * group.</p>
3097
3449
  */
3098
3450
  IdentityType?: IdentityType | string;
3099
3451
  /**
3452
+ * @public
3100
3453
  * <p>The Amazon Resource Name (ARN) of the session policy associated with the user or
3101
3454
  * group.</p>
3102
3455
  */
3103
3456
  SessionPolicyArn?: string;
3104
3457
  /**
3458
+ * @public
3105
3459
  * <p>The time the session mapping was created.</p>
3106
3460
  */
3107
3461
  CreationTime?: Date;
3108
3462
  /**
3463
+ * @public
3109
3464
  * <p>The time the session mapping was last modified.</p>
3110
3465
  */
3111
3466
  LastModifiedTime?: Date;
@@ -3115,6 +3470,7 @@ export interface SessionMappingDetail {
3115
3470
  */
3116
3471
  export interface GetStudioSessionMappingOutput {
3117
3472
  /**
3473
+ * @public
3118
3474
  * <p>The session mapping details for the specified Amazon EMR Studio and identity,
3119
3475
  * including session policy ARN and creation time.</p>
3120
3476
  */
@@ -3126,10 +3482,12 @@ export interface GetStudioSessionMappingOutput {
3126
3482
  */
3127
3483
  export interface ListBootstrapActionsInput {
3128
3484
  /**
3485
+ * @public
3129
3486
  * <p>The cluster identifier for the bootstrap actions to list.</p>
3130
3487
  */
3131
3488
  ClusterId: string | undefined;
3132
3489
  /**
3490
+ * @public
3133
3491
  * <p>The pagination token that indicates the next set of results to retrieve.</p>
3134
3492
  */
3135
3493
  Marker?: string;
@@ -3140,10 +3498,12 @@ export interface ListBootstrapActionsInput {
3140
3498
  */
3141
3499
  export interface ListBootstrapActionsOutput {
3142
3500
  /**
3501
+ * @public
3143
3502
  * <p>The bootstrap actions associated with the cluster.</p>
3144
3503
  */
3145
3504
  BootstrapActions?: Command[];
3146
3505
  /**
3506
+ * @public
3147
3507
  * <p>The pagination token that indicates the next set of results to retrieve.</p>
3148
3508
  */
3149
3509
  Marker?: string;
@@ -3155,19 +3515,23 @@ export interface ListBootstrapActionsOutput {
3155
3515
  */
3156
3516
  export interface ListClustersInput {
3157
3517
  /**
3518
+ * @public
3158
3519
  * <p>The creation date and time beginning value filter for listing clusters.</p>
3159
3520
  */
3160
3521
  CreatedAfter?: Date;
3161
3522
  /**
3523
+ * @public
3162
3524
  * <p>The creation date and time end value filter for listing clusters.</p>
3163
3525
  */
3164
3526
  CreatedBefore?: Date;
3165
3527
  /**
3528
+ * @public
3166
3529
  * <p>The cluster state filters to apply when listing clusters. Clusters that change state
3167
3530
  * while this action runs may be not be returned as expected in the list of clusters.</p>
3168
3531
  */
3169
3532
  ClusterStates?: (ClusterState | string)[];
3170
3533
  /**
3534
+ * @public
3171
3535
  * <p>The pagination token that indicates the next set of results to retrieve.</p>
3172
3536
  */
3173
3537
  Marker?: string;
@@ -3179,10 +3543,12 @@ export interface ListClustersInput {
3179
3543
  */
3180
3544
  export interface ListClustersOutput {
3181
3545
  /**
3546
+ * @public
3182
3547
  * <p>The list of clusters for the account based on the given filters.</p>
3183
3548
  */
3184
3549
  Clusters?: ClusterSummary[];
3185
3550
  /**
3551
+ * @public
3186
3552
  * <p>The pagination token that indicates the next set of results to retrieve.</p>
3187
3553
  */
3188
3554
  Marker?: string;
@@ -3192,10 +3558,12 @@ export interface ListClustersOutput {
3192
3558
  */
3193
3559
  export interface ListInstanceFleetsInput {
3194
3560
  /**
3561
+ * @public
3195
3562
  * <p>The unique identifier of the cluster.</p>
3196
3563
  */
3197
3564
  ClusterId: string | undefined;
3198
3565
  /**
3566
+ * @public
3199
3567
  * <p>The pagination token that indicates the next set of results to retrieve.</p>
3200
3568
  */
3201
3569
  Marker?: string;
@@ -3241,10 +3609,12 @@ export type InstanceFleetStateChangeReasonCode = (typeof InstanceFleetStateChang
3241
3609
  */
3242
3610
  export interface InstanceFleetStateChangeReason {
3243
3611
  /**
3612
+ * @public
3244
3613
  * <p>A code corresponding to the reason the state change occurred.</p>
3245
3614
  */
3246
3615
  Code?: InstanceFleetStateChangeReasonCode | string;
3247
3616
  /**
3617
+ * @public
3248
3618
  * <p>An explanatory message.</p>
3249
3619
  */
3250
3620
  Message?: string;
@@ -3260,14 +3630,17 @@ export interface InstanceFleetStateChangeReason {
3260
3630
  */
3261
3631
  export interface InstanceFleetTimeline {
3262
3632
  /**
3633
+ * @public
3263
3634
  * <p>The time and date the instance fleet was created.</p>
3264
3635
  */
3265
3636
  CreationDateTime?: Date;
3266
3637
  /**
3638
+ * @public
3267
3639
  * <p>The time and date the instance fleet was ready to run jobs.</p>
3268
3640
  */
3269
3641
  ReadyDateTime?: Date;
3270
3642
  /**
3643
+ * @public
3271
3644
  * <p>The time and date the instance fleet terminated.</p>
3272
3645
  */
3273
3646
  EndDateTime?: Date;
@@ -3282,6 +3655,7 @@ export interface InstanceFleetTimeline {
3282
3655
  */
3283
3656
  export interface InstanceFleetStatus {
3284
3657
  /**
3658
+ * @public
3285
3659
  * <p>A code representing the instance fleet status.</p>
3286
3660
  * <ul>
3287
3661
  * <li>
@@ -3322,10 +3696,12 @@ export interface InstanceFleetStatus {
3322
3696
  */
3323
3697
  State?: InstanceFleetState | string;
3324
3698
  /**
3699
+ * @public
3325
3700
  * <p>Provides status change reason details for the instance fleet.</p>
3326
3701
  */
3327
3702
  StateChangeReason?: InstanceFleetStateChangeReason;
3328
3703
  /**
3704
+ * @public
3329
3705
  * <p>Provides historical timestamps for the instance fleet, including the time of creation,
3330
3706
  * the time it became ready to run jobs, and the time of termination.</p>
3331
3707
  */
@@ -3337,10 +3713,12 @@ export interface InstanceFleetStatus {
3337
3713
  */
3338
3714
  export interface ListInstanceGroupsInput {
3339
3715
  /**
3716
+ * @public
3340
3717
  * <p>The identifier of the cluster for which to list the instance groups.</p>
3341
3718
  */
3342
3719
  ClusterId: string | undefined;
3343
3720
  /**
3721
+ * @public
3344
3722
  * <p>The pagination token that indicates the next set of results to retrieve.</p>
3345
3723
  */
3346
3724
  Marker?: string;
@@ -3365,14 +3743,17 @@ export type InstanceGroupType = (typeof InstanceGroupType)[keyof typeof Instance
3365
3743
  */
3366
3744
  export interface InstanceResizePolicy {
3367
3745
  /**
3746
+ * @public
3368
3747
  * <p>Specific list of instances to be terminated when shrinking an instance group.</p>
3369
3748
  */
3370
3749
  InstancesToTerminate?: string[];
3371
3750
  /**
3751
+ * @public
3372
3752
  * <p>Specific list of instances to be protected when shrinking an instance group.</p>
3373
3753
  */
3374
3754
  InstancesToProtect?: string[];
3375
3755
  /**
3756
+ * @public
3376
3757
  * <p>Decommissioning timeout override for the specific list of instances to be
3377
3758
  * terminated.</p>
3378
3759
  */
@@ -3385,11 +3766,13 @@ export interface InstanceResizePolicy {
3385
3766
  */
3386
3767
  export interface ShrinkPolicy {
3387
3768
  /**
3769
+ * @public
3388
3770
  * <p>The desired timeout for decommissioning an instance. Overrides the default YARN
3389
3771
  * decommissioning timeout.</p>
3390
3772
  */
3391
3773
  DecommissionTimeout?: number;
3392
3774
  /**
3775
+ * @public
3393
3776
  * <p>Custom policy for requesting termination protection or termination of specific instances
3394
3777
  * when shrinking an instance group.</p>
3395
3778
  */
@@ -3415,10 +3798,12 @@ export type InstanceGroupStateChangeReasonCode = (typeof InstanceGroupStateChang
3415
3798
  */
3416
3799
  export interface InstanceGroupStateChangeReason {
3417
3800
  /**
3801
+ * @public
3418
3802
  * <p>The programmable code for the state change reason.</p>
3419
3803
  */
3420
3804
  Code?: InstanceGroupStateChangeReasonCode | string;
3421
3805
  /**
3806
+ * @public
3422
3807
  * <p>The status change reason description.</p>
3423
3808
  */
3424
3809
  Message?: string;
@@ -3429,14 +3814,17 @@ export interface InstanceGroupStateChangeReason {
3429
3814
  */
3430
3815
  export interface InstanceGroupTimeline {
3431
3816
  /**
3817
+ * @public
3432
3818
  * <p>The creation date and time of the instance group.</p>
3433
3819
  */
3434
3820
  CreationDateTime?: Date;
3435
3821
  /**
3822
+ * @public
3436
3823
  * <p>The date and time when the instance group became ready to perform tasks.</p>
3437
3824
  */
3438
3825
  ReadyDateTime?: Date;
3439
3826
  /**
3827
+ * @public
3440
3828
  * <p>The date and time when the instance group terminated.</p>
3441
3829
  */
3442
3830
  EndDateTime?: Date;
@@ -3447,14 +3835,17 @@ export interface InstanceGroupTimeline {
3447
3835
  */
3448
3836
  export interface InstanceGroupStatus {
3449
3837
  /**
3838
+ * @public
3450
3839
  * <p>The current state of the instance group.</p>
3451
3840
  */
3452
3841
  State?: InstanceGroupState | string;
3453
3842
  /**
3843
+ * @public
3454
3844
  * <p>The status change reason details for the instance group.</p>
3455
3845
  */
3456
3846
  StateChangeReason?: InstanceGroupStateChangeReason;
3457
3847
  /**
3848
+ * @public
3458
3849
  * <p>The timeline of the instance group status over time.</p>
3459
3850
  */
3460
3851
  Timeline?: InstanceGroupTimeline;
@@ -3480,31 +3871,38 @@ export type InstanceState = (typeof InstanceState)[keyof typeof InstanceState];
3480
3871
  */
3481
3872
  export interface ListInstancesInput {
3482
3873
  /**
3874
+ * @public
3483
3875
  * <p>The identifier of the cluster for which to list the instances.</p>
3484
3876
  */
3485
3877
  ClusterId: string | undefined;
3486
3878
  /**
3879
+ * @public
3487
3880
  * <p>The identifier of the instance group for which to list the instances.</p>
3488
3881
  */
3489
3882
  InstanceGroupId?: string;
3490
3883
  /**
3884
+ * @public
3491
3885
  * <p>The type of instance group for which to list the instances.</p>
3492
3886
  */
3493
3887
  InstanceGroupTypes?: (InstanceGroupType | string)[];
3494
3888
  /**
3889
+ * @public
3495
3890
  * <p>The unique identifier of the instance fleet.</p>
3496
3891
  */
3497
3892
  InstanceFleetId?: string;
3498
3893
  /**
3894
+ * @public
3499
3895
  * <p>The node type of the instance fleet. For example MASTER, CORE, or TASK.</p>
3500
3896
  */
3501
3897
  InstanceFleetType?: InstanceFleetType | string;
3502
3898
  /**
3899
+ * @public
3503
3900
  * <p>A list of instance states that will filter the instances returned with this
3504
3901
  * request.</p>
3505
3902
  */
3506
3903
  InstanceStates?: (InstanceState | string)[];
3507
3904
  /**
3905
+ * @public
3508
3906
  * <p>The pagination token that indicates the next set of results to retrieve.</p>
3509
3907
  */
3510
3908
  Marker?: string;
@@ -3530,10 +3928,12 @@ export type InstanceStateChangeReasonCode = (typeof InstanceStateChangeReasonCod
3530
3928
  */
3531
3929
  export interface InstanceStateChangeReason {
3532
3930
  /**
3931
+ * @public
3533
3932
  * <p>The programmable code for the state change reason.</p>
3534
3933
  */
3535
3934
  Code?: InstanceStateChangeReasonCode | string;
3536
3935
  /**
3936
+ * @public
3537
3937
  * <p>The status change reason description.</p>
3538
3938
  */
3539
3939
  Message?: string;
@@ -3544,14 +3944,17 @@ export interface InstanceStateChangeReason {
3544
3944
  */
3545
3945
  export interface InstanceTimeline {
3546
3946
  /**
3947
+ * @public
3547
3948
  * <p>The creation date and time of the instance.</p>
3548
3949
  */
3549
3950
  CreationDateTime?: Date;
3550
3951
  /**
3952
+ * @public
3551
3953
  * <p>The date and time when the instance was ready to perform tasks.</p>
3552
3954
  */
3553
3955
  ReadyDateTime?: Date;
3554
3956
  /**
3957
+ * @public
3555
3958
  * <p>The date and time when the instance was terminated.</p>
3556
3959
  */
3557
3960
  EndDateTime?: Date;
@@ -3562,14 +3965,17 @@ export interface InstanceTimeline {
3562
3965
  */
3563
3966
  export interface InstanceStatus {
3564
3967
  /**
3968
+ * @public
3565
3969
  * <p>The current state of the instance.</p>
3566
3970
  */
3567
3971
  State?: InstanceState | string;
3568
3972
  /**
3973
+ * @public
3569
3974
  * <p>The details of the status change reason for the instance.</p>
3570
3975
  */
3571
3976
  StateChangeReason?: InstanceStateChangeReason;
3572
3977
  /**
3978
+ * @public
3573
3979
  * <p>The timeline of the instance status over time.</p>
3574
3980
  */
3575
3981
  Timeline?: InstanceTimeline;
@@ -3580,52 +3986,64 @@ export interface InstanceStatus {
3580
3986
  */
3581
3987
  export interface Instance {
3582
3988
  /**
3989
+ * @public
3583
3990
  * <p>The unique identifier for the instance in Amazon EMR.</p>
3584
3991
  */
3585
3992
  Id?: string;
3586
3993
  /**
3994
+ * @public
3587
3995
  * <p>The unique identifier of the instance in Amazon EC2.</p>
3588
3996
  */
3589
3997
  Ec2InstanceId?: string;
3590
3998
  /**
3999
+ * @public
3591
4000
  * <p>The public DNS name of the instance.</p>
3592
4001
  */
3593
4002
  PublicDnsName?: string;
3594
4003
  /**
4004
+ * @public
3595
4005
  * <p>The public IP address of the instance.</p>
3596
4006
  */
3597
4007
  PublicIpAddress?: string;
3598
4008
  /**
4009
+ * @public
3599
4010
  * <p>The private DNS name of the instance.</p>
3600
4011
  */
3601
4012
  PrivateDnsName?: string;
3602
4013
  /**
4014
+ * @public
3603
4015
  * <p>The private IP address of the instance.</p>
3604
4016
  */
3605
4017
  PrivateIpAddress?: string;
3606
4018
  /**
4019
+ * @public
3607
4020
  * <p>The current status of the instance.</p>
3608
4021
  */
3609
4022
  Status?: InstanceStatus;
3610
4023
  /**
4024
+ * @public
3611
4025
  * <p>The identifier of the instance group to which this instance belongs.</p>
3612
4026
  */
3613
4027
  InstanceGroupId?: string;
3614
4028
  /**
4029
+ * @public
3615
4030
  * <p>The unique identifier of the instance fleet to which an Amazon EC2 instance
3616
4031
  * belongs.</p>
3617
4032
  */
3618
4033
  InstanceFleetId?: string;
3619
4034
  /**
4035
+ * @public
3620
4036
  * <p>The instance purchasing option. Valid values are <code>ON_DEMAND</code> or
3621
4037
  * <code>SPOT</code>. </p>
3622
4038
  */
3623
4039
  Market?: MarketType | string;
3624
4040
  /**
4041
+ * @public
3625
4042
  * <p>The Amazon EC2 instance type, for example <code>m3.xlarge</code>.</p>
3626
4043
  */
3627
4044
  InstanceType?: string;
3628
4045
  /**
4046
+ * @public
3629
4047
  * <p>The list of Amazon EBS volumes that are attached to this instance.</p>
3630
4048
  */
3631
4049
  EbsVolumes?: EbsVolume[];
@@ -3636,10 +4054,12 @@ export interface Instance {
3636
4054
  */
3637
4055
  export interface ListInstancesOutput {
3638
4056
  /**
4057
+ * @public
3639
4058
  * <p>The list of instances for the cluster and given filters.</p>
3640
4059
  */
3641
4060
  Instances?: Instance[];
3642
4061
  /**
4062
+ * @public
3643
4063
  * <p>The pagination token that indicates the next set of results to retrieve.</p>
3644
4064
  */
3645
4065
  Marker?: string;
@@ -3649,10 +4069,12 @@ export interface ListInstancesOutput {
3649
4069
  */
3650
4070
  export interface ListNotebookExecutionsInput {
3651
4071
  /**
4072
+ * @public
3652
4073
  * <p>The unique ID of the editor associated with the notebook execution.</p>
3653
4074
  */
3654
4075
  EditorId?: string;
3655
4076
  /**
4077
+ * @public
3656
4078
  * <p>The status filter for listing notebook executions.</p>
3657
4079
  * <ul>
3658
4080
  * <li>
@@ -3708,22 +4130,26 @@ export interface ListNotebookExecutionsInput {
3708
4130
  */
3709
4131
  Status?: NotebookExecutionStatus | string;
3710
4132
  /**
4133
+ * @public
3711
4134
  * <p>The beginning of time range filter for listing notebook executions. The default is the
3712
4135
  * timestamp of 30 days ago.</p>
3713
4136
  */
3714
4137
  From?: Date;
3715
4138
  /**
4139
+ * @public
3716
4140
  * <p>The end of time range filter for listing notebook executions. The default is the current
3717
4141
  * timestamp.</p>
3718
4142
  */
3719
4143
  To?: Date;
3720
4144
  /**
4145
+ * @public
3721
4146
  * <p>The pagination token, returned by a previous <code>ListNotebookExecutions</code> call,
3722
4147
  * that indicates the start of the list for this <code>ListNotebookExecutions</code>
3723
4148
  * call.</p>
3724
4149
  */
3725
4150
  Marker?: string;
3726
4151
  /**
4152
+ * @public
3727
4153
  * <p>The unique ID of the execution engine.</p>
3728
4154
  */
3729
4155
  ExecutionEngineId?: string;
@@ -3735,18 +4161,22 @@ export interface ListNotebookExecutionsInput {
3735
4161
  */
3736
4162
  export interface NotebookExecutionSummary {
3737
4163
  /**
4164
+ * @public
3738
4165
  * <p>The unique identifier of the notebook execution.</p>
3739
4166
  */
3740
4167
  NotebookExecutionId?: string;
3741
4168
  /**
4169
+ * @public
3742
4170
  * <p>The unique identifier of the editor associated with the notebook execution.</p>
3743
4171
  */
3744
4172
  EditorId?: string;
3745
4173
  /**
4174
+ * @public
3746
4175
  * <p>The name of the notebook execution.</p>
3747
4176
  */
3748
4177
  NotebookExecutionName?: string;
3749
4178
  /**
4179
+ * @public
3750
4180
  * <p>The status of the notebook execution.</p>
3751
4181
  * <ul>
3752
4182
  * <li>
@@ -3802,18 +4232,22 @@ export interface NotebookExecutionSummary {
3802
4232
  */
3803
4233
  Status?: NotebookExecutionStatus | string;
3804
4234
  /**
4235
+ * @public
3805
4236
  * <p>The timestamp when notebook execution started.</p>
3806
4237
  */
3807
4238
  StartTime?: Date;
3808
4239
  /**
4240
+ * @public
3809
4241
  * <p>The timestamp when notebook execution started.</p>
3810
4242
  */
3811
4243
  EndTime?: Date;
3812
4244
  /**
4245
+ * @public
3813
4246
  * <p>The Amazon S3 location that stores the notebook execution input.</p>
3814
4247
  */
3815
4248
  NotebookS3Location?: NotebookS3LocationForOutput;
3816
4249
  /**
4250
+ * @public
3817
4251
  * <p>The unique ID of the execution engine for the notebook execution.</p>
3818
4252
  */
3819
4253
  ExecutionEngineId?: string;
@@ -3823,10 +4257,12 @@ export interface NotebookExecutionSummary {
3823
4257
  */
3824
4258
  export interface ListNotebookExecutionsOutput {
3825
4259
  /**
4260
+ * @public
3826
4261
  * <p>A list of notebook executions.</p>
3827
4262
  */
3828
4263
  NotebookExecutions?: NotebookExecutionSummary[];
3829
4264
  /**
4265
+ * @public
3830
4266
  * <p>A pagination token that a subsequent <code>ListNotebookExecutions</code> can use to
3831
4267
  * determine the next set of results to retrieve.</p>
3832
4268
  */
@@ -3838,10 +4274,12 @@ export interface ListNotebookExecutionsOutput {
3838
4274
  */
3839
4275
  export interface ReleaseLabelFilter {
3840
4276
  /**
4277
+ * @public
3841
4278
  * <p>Optional release label version prefix filter. For example, <code>emr-5</code>.</p>
3842
4279
  */
3843
4280
  Prefix?: string;
3844
4281
  /**
4282
+ * @public
3845
4283
  * <p>Optional release label application filter. For example, <code>spark@2.1.0</code>.</p>
3846
4284
  */
3847
4285
  Application?: string;
@@ -3851,12 +4289,14 @@ export interface ReleaseLabelFilter {
3851
4289
  */
3852
4290
  export interface ListReleaseLabelsInput {
3853
4291
  /**
4292
+ * @public
3854
4293
  * <p>Filters the results of the request. <code>Prefix</code> specifies the prefix of release
3855
4294
  * labels to return. <code>Application</code> specifies the application (with/without version)
3856
4295
  * of release labels to return.</p>
3857
4296
  */
3858
4297
  Filters?: ReleaseLabelFilter;
3859
4298
  /**
4299
+ * @public
3860
4300
  * <p>Specifies the next page of results. If <code>NextToken</code> is not specified, which is
3861
4301
  * usually the case for the first request of ListReleaseLabels, the first page of results are
3862
4302
  * determined by other filtering parameters or by the latest version. The
@@ -3866,6 +4306,7 @@ export interface ListReleaseLabelsInput {
3866
4306
  */
3867
4307
  NextToken?: string;
3868
4308
  /**
4309
+ * @public
3869
4310
  * <p>Defines the maximum number of release labels to return in a single response. The default
3870
4311
  * is <code>100</code>.</p>
3871
4312
  */
@@ -3876,10 +4317,12 @@ export interface ListReleaseLabelsInput {
3876
4317
  */
3877
4318
  export interface ListReleaseLabelsOutput {
3878
4319
  /**
4320
+ * @public
3879
4321
  * <p>The returned release labels.</p>
3880
4322
  */
3881
4323
  ReleaseLabels?: string[];
3882
4324
  /**
4325
+ * @public
3883
4326
  * <p>Used to paginate the next page of results if specified in the next
3884
4327
  * <code>ListReleaseLabels</code> request.</p>
3885
4328
  */
@@ -3890,6 +4333,7 @@ export interface ListReleaseLabelsOutput {
3890
4333
  */
3891
4334
  export interface ListSecurityConfigurationsInput {
3892
4335
  /**
4336
+ * @public
3893
4337
  * <p>The pagination token that indicates the set of results to retrieve.</p>
3894
4338
  */
3895
4339
  Marker?: string;
@@ -3900,10 +4344,12 @@ export interface ListSecurityConfigurationsInput {
3900
4344
  */
3901
4345
  export interface SecurityConfigurationSummary {
3902
4346
  /**
4347
+ * @public
3903
4348
  * <p>The name of the security configuration.</p>
3904
4349
  */
3905
4350
  Name?: string;
3906
4351
  /**
4352
+ * @public
3907
4353
  * <p>The date and time the security configuration was created.</p>
3908
4354
  */
3909
4355
  CreationDateTime?: Date;
@@ -3913,10 +4359,12 @@ export interface SecurityConfigurationSummary {
3913
4359
  */
3914
4360
  export interface ListSecurityConfigurationsOutput {
3915
4361
  /**
4362
+ * @public
3916
4363
  * <p>The creation date and time, and name, of each security configuration.</p>
3917
4364
  */
3918
4365
  SecurityConfigurations?: SecurityConfigurationSummary[];
3919
4366
  /**
4367
+ * @public
3920
4368
  * <p>A pagination token that indicates the next set of results to retrieve. Include the
3921
4369
  * marker in the next ListSecurityConfiguration call to retrieve the next page of results, if
3922
4370
  * required.</p>
@@ -3929,20 +4377,24 @@ export interface ListSecurityConfigurationsOutput {
3929
4377
  */
3930
4378
  export interface ListStepsInput {
3931
4379
  /**
4380
+ * @public
3932
4381
  * <p>The identifier of the cluster for which to list the steps.</p>
3933
4382
  */
3934
4383
  ClusterId: string | undefined;
3935
4384
  /**
4385
+ * @public
3936
4386
  * <p>The filter to limit the step list based on certain states.</p>
3937
4387
  */
3938
4388
  StepStates?: (StepState | string)[];
3939
4389
  /**
4390
+ * @public
3940
4391
  * <p>The filter to limit the step list based on the identifier of the steps. You can specify
3941
4392
  * a maximum of ten Step IDs. The character constraint applies to the overall length of the
3942
4393
  * array.</p>
3943
4394
  */
3944
4395
  StepIds?: string[];
3945
4396
  /**
4397
+ * @public
3946
4398
  * <p>The maximum number of steps that a single <code>ListSteps</code> action returns is 50.
3947
4399
  * To return a longer list of steps, use multiple <code>ListSteps</code> actions along with
3948
4400
  * the <code>Marker</code> parameter, which is a pagination token that indicates the next set
@@ -3956,24 +4408,29 @@ export interface ListStepsInput {
3956
4408
  */
3957
4409
  export interface StepSummary {
3958
4410
  /**
4411
+ * @public
3959
4412
  * <p>The identifier of the cluster step.</p>
3960
4413
  */
3961
4414
  Id?: string;
3962
4415
  /**
4416
+ * @public
3963
4417
  * <p>The name of the cluster step.</p>
3964
4418
  */
3965
4419
  Name?: string;
3966
4420
  /**
4421
+ * @public
3967
4422
  * <p>The Hadoop job configuration of the cluster step.</p>
3968
4423
  */
3969
4424
  Config?: HadoopStepConfig;
3970
4425
  /**
4426
+ * @public
3971
4427
  * <p>The action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER,
3972
4428
  * CANCEL_AND_WAIT, and CONTINUE. TERMINATE_JOB_FLOW is available for backward
3973
4429
  * compatibility.</p>
3974
4430
  */
3975
4431
  ActionOnFailure?: ActionOnFailure | string;
3976
4432
  /**
4433
+ * @public
3977
4434
  * <p>The current execution status details of the cluster step.</p>
3978
4435
  */
3979
4436
  Status?: StepStatus;
@@ -3985,10 +4442,12 @@ export interface StepSummary {
3985
4442
  */
3986
4443
  export interface ListStepsOutput {
3987
4444
  /**
4445
+ * @public
3988
4446
  * <p>The filtered list of steps for the cluster.</p>
3989
4447
  */
3990
4448
  Steps?: StepSummary[];
3991
4449
  /**
4450
+ * @public
3992
4451
  * <p>The maximum number of steps that a single <code>ListSteps</code> action returns is 50.
3993
4452
  * To return a longer list of steps, use multiple <code>ListSteps</code> actions along with
3994
4453
  * the <code>Marker</code> parameter, which is a pagination token that indicates the next set
@@ -4001,6 +4460,7 @@ export interface ListStepsOutput {
4001
4460
  */
4002
4461
  export interface ListStudiosInput {
4003
4462
  /**
4463
+ * @public
4004
4464
  * <p>The pagination token that indicates the set of results to retrieve.</p>
4005
4465
  */
4006
4466
  Marker?: string;
@@ -4013,30 +4473,37 @@ export interface ListStudiosInput {
4013
4473
  */
4014
4474
  export interface StudioSummary {
4015
4475
  /**
4476
+ * @public
4016
4477
  * <p>The ID of the Amazon EMR Studio.</p>
4017
4478
  */
4018
4479
  StudioId?: string;
4019
4480
  /**
4481
+ * @public
4020
4482
  * <p>The name of the Amazon EMR Studio.</p>
4021
4483
  */
4022
4484
  Name?: string;
4023
4485
  /**
4486
+ * @public
4024
4487
  * <p>The ID of the Virtual Private Cloud (Amazon VPC) associated with the Amazon EMR Studio.</p>
4025
4488
  */
4026
4489
  VpcId?: string;
4027
4490
  /**
4491
+ * @public
4028
4492
  * <p>The detailed description of the Amazon EMR Studio.</p>
4029
4493
  */
4030
4494
  Description?: string;
4031
4495
  /**
4496
+ * @public
4032
4497
  * <p>The unique access URL of the Amazon EMR Studio.</p>
4033
4498
  */
4034
4499
  Url?: string;
4035
4500
  /**
4501
+ * @public
4036
4502
  * <p>Specifies whether the Studio authenticates users using IAM or IAM Identity Center.</p>
4037
4503
  */
4038
4504
  AuthMode?: AuthMode | string;
4039
4505
  /**
4506
+ * @public
4040
4507
  * <p>The time when the Amazon EMR Studio was created.</p>
4041
4508
  */
4042
4509
  CreationTime?: Date;
@@ -4046,10 +4513,12 @@ export interface StudioSummary {
4046
4513
  */
4047
4514
  export interface ListStudiosOutput {
4048
4515
  /**
4516
+ * @public
4049
4517
  * <p>The list of Studio summary objects.</p>
4050
4518
  */
4051
4519
  Studios?: StudioSummary[];
4052
4520
  /**
4521
+ * @public
4053
4522
  * <p>The pagination token that indicates the next set of results to retrieve.</p>
4054
4523
  */
4055
4524
  Marker?: string;
@@ -4059,15 +4528,18 @@ export interface ListStudiosOutput {
4059
4528
  */
4060
4529
  export interface ListStudioSessionMappingsInput {
4061
4530
  /**
4531
+ * @public
4062
4532
  * <p>The ID of the Amazon EMR Studio.</p>
4063
4533
  */
4064
4534
  StudioId?: string;
4065
4535
  /**
4536
+ * @public
4066
4537
  * <p>Specifies whether to return session mappings for users or groups. If not specified, the
4067
4538
  * results include session mapping details for both users and groups.</p>
4068
4539
  */
4069
4540
  IdentityType?: IdentityType | string;
4070
4541
  /**
4542
+ * @public
4071
4543
  * <p>The pagination token that indicates the set of results to retrieve.</p>
4072
4544
  */
4073
4545
  Marker?: string;
@@ -4079,30 +4551,36 @@ export interface ListStudioSessionMappingsInput {
4079
4551
  */
4080
4552
  export interface SessionMappingSummary {
4081
4553
  /**
4554
+ * @public
4082
4555
  * <p>The ID of the Amazon EMR Studio.</p>
4083
4556
  */
4084
4557
  StudioId?: string;
4085
4558
  /**
4559
+ * @public
4086
4560
  * <p>The globally unique identifier (GUID) of the user or group from the IAM Identity Center
4087
4561
  * Identity Store.</p>
4088
4562
  */
4089
4563
  IdentityId?: string;
4090
4564
  /**
4565
+ * @public
4091
4566
  * <p>The name of the user or group. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserName">UserName</a> and <a href="https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName">DisplayName</a> in the <i>IAM Identity Center Identity Store API
4092
4567
  * Reference</i>.</p>
4093
4568
  */
4094
4569
  IdentityName?: string;
4095
4570
  /**
4571
+ * @public
4096
4572
  * <p>Specifies whether the identity mapped to the Amazon EMR Studio is a user or a
4097
4573
  * group.</p>
4098
4574
  */
4099
4575
  IdentityType?: IdentityType | string;
4100
4576
  /**
4577
+ * @public
4101
4578
  * <p>The Amazon Resource Name (ARN) of the session policy associated with the user or
4102
4579
  * group.</p>
4103
4580
  */
4104
4581
  SessionPolicyArn?: string;
4105
4582
  /**
4583
+ * @public
4106
4584
  * <p>The time the session mapping was created.</p>
4107
4585
  */
4108
4586
  CreationTime?: Date;
@@ -4112,12 +4590,14 @@ export interface SessionMappingSummary {
4112
4590
  */
4113
4591
  export interface ListStudioSessionMappingsOutput {
4114
4592
  /**
4593
+ * @public
4115
4594
  * <p>A list of session mapping summary objects. Each object includes session mapping details
4116
4595
  * such as creation time, identity type (user or group), and Amazon EMR Studio
4117
4596
  * ID.</p>
4118
4597
  */
4119
4598
  SessionMappings?: SessionMappingSummary[];
4120
4599
  /**
4600
+ * @public
4121
4601
  * <p>The pagination token that indicates the next set of results to retrieve.</p>
4122
4602
  */
4123
4603
  Marker?: string;
@@ -4127,6 +4607,7 @@ export interface ListStudioSessionMappingsOutput {
4127
4607
  */
4128
4608
  export interface ListSupportedInstanceTypesInput {
4129
4609
  /**
4610
+ * @public
4130
4611
  * <p>The Amazon EMR release label determines the <a href="https://docs.aws.amazon.com/emr/latest/ReleaseGuide/emr-release-app-versions-6.x.html">versions of open-source
4131
4612
  * application packages</a> that Amazon EMR has installed on the cluster.
4132
4613
  * Release labels are in the format <code>emr-x.x.x</code>, where x.x.x is an Amazon EMR release number such as <code>emr-6.10.0</code>. For more information about Amazon EMR releases and their included application versions and features, see the
@@ -4137,6 +4618,7 @@ export interface ListSupportedInstanceTypesInput {
4137
4618
  */
4138
4619
  ReleaseLabel: string | undefined;
4139
4620
  /**
4621
+ * @public
4140
4622
  * <p>The pagination token that marks the next set of results to retrieve.</p>
4141
4623
  */
4142
4624
  Marker?: string;
@@ -4147,57 +4629,68 @@ export interface ListSupportedInstanceTypesInput {
4147
4629
  */
4148
4630
  export interface SupportedInstanceType {
4149
4631
  /**
4632
+ * @public
4150
4633
  * <p>The <a href="http://aws.amazon.com/ec2/instance-types/">Amazon EC2 instance
4151
4634
  * type</a>, for example <code>m5.xlarge</code>, of the
4152
4635
  * <code>SupportedInstanceType</code>.</p>
4153
4636
  */
4154
4637
  Type?: string;
4155
4638
  /**
4639
+ * @public
4156
4640
  * <p>The amount of memory that is available to Amazon EMR from the <code>SupportedInstanceType</code>. The kernel and hypervisor
4157
4641
  * software consume some memory, so this value might be lower than the overall memory for the
4158
4642
  * instance type.</p>
4159
4643
  */
4160
4644
  MemoryGB?: number;
4161
4645
  /**
4646
+ * @public
4162
4647
  * <p>
4163
4648
  * <code>StorageGB</code> represents the storage capacity of the
4164
4649
  * <code>SupportedInstanceType</code>. This value is <code>0</code> for Amazon EBS-only instance types.</p>
4165
4650
  */
4166
4651
  StorageGB?: number;
4167
4652
  /**
4653
+ * @public
4168
4654
  * <p>The number of vCPUs available for the <code>SupportedInstanceType</code>.</p>
4169
4655
  */
4170
4656
  VCPU?: number;
4171
4657
  /**
4658
+ * @public
4172
4659
  * <p>Indicates whether the <code>SupportedInstanceType</code> only supports 64-bit
4173
4660
  * architecture.</p>
4174
4661
  */
4175
4662
  Is64BitsOnly?: boolean;
4176
4663
  /**
4664
+ * @public
4177
4665
  * <p>The Amazon EC2 family and generation for the
4178
4666
  * <code>SupportedInstanceType</code>.</p>
4179
4667
  */
4180
4668
  InstanceFamilyId?: string;
4181
4669
  /**
4670
+ * @public
4182
4671
  * <p>Indicates whether the <code>SupportedInstanceType</code> supports Amazon EBS
4183
4672
  * optimization.</p>
4184
4673
  */
4185
4674
  EbsOptimizedAvailable?: boolean;
4186
4675
  /**
4676
+ * @public
4187
4677
  * <p>Indicates whether the <code>SupportedInstanceType</code> uses Amazon EBS
4188
4678
  * optimization by default.</p>
4189
4679
  */
4190
4680
  EbsOptimizedByDefault?: boolean;
4191
4681
  /**
4682
+ * @public
4192
4683
  * <p>Number of disks for the <code>SupportedInstanceType</code>. This value is <code>0</code>
4193
4684
  * for Amazon EBS-only instance types.</p>
4194
4685
  */
4195
4686
  NumberOfDisks?: number;
4196
4687
  /**
4688
+ * @public
4197
4689
  * <p>Indicates whether the <code>SupportedInstanceType</code> only supports Amazon EBS.</p>
4198
4690
  */
4199
4691
  EbsStorageOnly?: boolean;
4200
4692
  /**
4693
+ * @public
4201
4694
  * <p>The CPU architecture, for example <code>X86_64</code> or <code>AARCH64</code>.</p>
4202
4695
  */
4203
4696
  Architecture?: string;
@@ -4207,11 +4700,13 @@ export interface SupportedInstanceType {
4207
4700
  */
4208
4701
  export interface ListSupportedInstanceTypesOutput {
4209
4702
  /**
4703
+ * @public
4210
4704
  * <p>The list of instance types that the release specified in
4211
4705
  * <code>ListSupportedInstanceTypesInput$ReleaseLabel</code> supports, filtered by Amazon Web Services Region.</p>
4212
4706
  */
4213
4707
  SupportedInstanceTypes?: SupportedInstanceType[];
4214
4708
  /**
4709
+ * @public
4215
4710
  * <p>The pagination token that marks the next set of results to retrieve.</p>
4216
4711
  */
4217
4712
  Marker?: string;
@@ -4221,10 +4716,12 @@ export interface ListSupportedInstanceTypesOutput {
4221
4716
  */
4222
4717
  export interface ModifyClusterInput {
4223
4718
  /**
4719
+ * @public
4224
4720
  * <p>The unique identifier of the cluster.</p>
4225
4721
  */
4226
4722
  ClusterId: string | undefined;
4227
4723
  /**
4724
+ * @public
4228
4725
  * <p>The number of steps that can be executed concurrently. You can specify a minimum of 1
4229
4726
  * step and a maximum of 256 steps. We recommend that you do not change this parameter while
4230
4727
  * steps are running or the <code>ActionOnFailure</code> setting may not behave as expected.
@@ -4237,6 +4734,7 @@ export interface ModifyClusterInput {
4237
4734
  */
4238
4735
  export interface ModifyClusterOutput {
4239
4736
  /**
4737
+ * @public
4240
4738
  * <p>The number of steps that can be executed concurrently.</p>
4241
4739
  */
4242
4740
  StepConcurrencyLevel?: number;
@@ -4251,20 +4749,24 @@ export interface ModifyClusterOutput {
4251
4749
  */
4252
4750
  export interface InstanceFleetModifyConfig {
4253
4751
  /**
4752
+ * @public
4254
4753
  * <p>A unique identifier for the instance fleet.</p>
4255
4754
  */
4256
4755
  InstanceFleetId: string | undefined;
4257
4756
  /**
4757
+ * @public
4258
4758
  * <p>The target capacity of On-Demand units for the instance fleet. For more information see
4259
4759
  * <a>InstanceFleetConfig$TargetOnDemandCapacity</a>.</p>
4260
4760
  */
4261
4761
  TargetOnDemandCapacity?: number;
4262
4762
  /**
4763
+ * @public
4263
4764
  * <p>The target capacity of Spot units for the instance fleet. For more information, see
4264
4765
  * <a>InstanceFleetConfig$TargetSpotCapacity</a>.</p>
4265
4766
  */
4266
4767
  TargetSpotCapacity?: number;
4267
4768
  /**
4769
+ * @public
4268
4770
  * <p>The resize specification for the instance fleet.</p>
4269
4771
  */
4270
4772
  ResizeSpecifications?: InstanceFleetResizingSpecifications;
@@ -4274,10 +4776,12 @@ export interface InstanceFleetModifyConfig {
4274
4776
  */
4275
4777
  export interface ModifyInstanceFleetInput {
4276
4778
  /**
4779
+ * @public
4277
4780
  * <p>The unique identifier of the cluster.</p>
4278
4781
  */
4279
4782
  ClusterId: string | undefined;
4280
4783
  /**
4784
+ * @public
4281
4785
  * <p>The configuration parameters of the instance fleet.</p>
4282
4786
  */
4283
4787
  InstanceFleet: InstanceFleetModifyConfig | undefined;
@@ -4299,16 +4803,19 @@ export type ReconfigurationType = (typeof ReconfigurationType)[keyof typeof Reco
4299
4803
  */
4300
4804
  export interface PutAutoScalingPolicyInput {
4301
4805
  /**
4806
+ * @public
4302
4807
  * <p>Specifies the ID of a cluster. The instance group to which the automatic scaling policy
4303
4808
  * is applied is within this cluster.</p>
4304
4809
  */
4305
4810
  ClusterId: string | undefined;
4306
4811
  /**
4812
+ * @public
4307
4813
  * <p>Specifies the ID of the instance group to which the automatic scaling policy is
4308
4814
  * applied.</p>
4309
4815
  */
4310
4816
  InstanceGroupId: string | undefined;
4311
4817
  /**
4818
+ * @public
4312
4819
  * <p>Specifies the definition of the automatic scaling policy.</p>
4313
4820
  */
4314
4821
  AutoScalingPolicy: AutoScalingPolicy | undefined;
@@ -4318,19 +4825,23 @@ export interface PutAutoScalingPolicyInput {
4318
4825
  */
4319
4826
  export interface PutAutoScalingPolicyOutput {
4320
4827
  /**
4828
+ * @public
4321
4829
  * <p>Specifies the ID of a cluster. The instance group to which the automatic scaling policy
4322
4830
  * is applied is within this cluster.</p>
4323
4831
  */
4324
4832
  ClusterId?: string;
4325
4833
  /**
4834
+ * @public
4326
4835
  * <p>Specifies the ID of the instance group to which the scaling policy is applied.</p>
4327
4836
  */
4328
4837
  InstanceGroupId?: string;
4329
4838
  /**
4839
+ * @public
4330
4840
  * <p>The automatic scaling policy definition.</p>
4331
4841
  */
4332
4842
  AutoScalingPolicy?: AutoScalingPolicyDescription;
4333
4843
  /**
4844
+ * @public
4334
4845
  * <p>The Amazon Resource Name (ARN) of the cluster.</p>
4335
4846
  */
4336
4847
  ClusterArn?: string;
@@ -4340,11 +4851,13 @@ export interface PutAutoScalingPolicyOutput {
4340
4851
  */
4341
4852
  export interface PutAutoTerminationPolicyInput {
4342
4853
  /**
4854
+ * @public
4343
4855
  * <p>Specifies the ID of the Amazon EMR cluster to which the auto-termination policy
4344
4856
  * will be attached.</p>
4345
4857
  */
4346
4858
  ClusterId: string | undefined;
4347
4859
  /**
4860
+ * @public
4348
4861
  * <p>Specifies the auto-termination policy to attach to the cluster.</p>
4349
4862
  */
4350
4863
  AutoTerminationPolicy?: AutoTerminationPolicy;
@@ -4364,11 +4877,13 @@ export interface PutBlockPublicAccessConfigurationOutput {
4364
4877
  */
4365
4878
  export interface PutManagedScalingPolicyInput {
4366
4879
  /**
4880
+ * @public
4367
4881
  * <p>Specifies the ID of an Amazon EMR cluster where the managed scaling policy is
4368
4882
  * attached. </p>
4369
4883
  */
4370
4884
  ClusterId: string | undefined;
4371
4885
  /**
4886
+ * @public
4372
4887
  * <p>Specifies the constraints for the managed scaling policy. </p>
4373
4888
  */
4374
4889
  ManagedScalingPolicy: ManagedScalingPolicy | undefined;
@@ -4383,11 +4898,13 @@ export interface PutManagedScalingPolicyOutput {
4383
4898
  */
4384
4899
  export interface RemoveAutoScalingPolicyInput {
4385
4900
  /**
4901
+ * @public
4386
4902
  * <p>Specifies the ID of a cluster. The instance group to which the automatic scaling policy
4387
4903
  * is applied is within this cluster.</p>
4388
4904
  */
4389
4905
  ClusterId: string | undefined;
4390
4906
  /**
4907
+ * @public
4391
4908
  * <p>Specifies the ID of the instance group to which the scaling policy is applied.</p>
4392
4909
  */
4393
4910
  InstanceGroupId: string | undefined;
@@ -4402,6 +4919,7 @@ export interface RemoveAutoScalingPolicyOutput {
4402
4919
  */
4403
4920
  export interface RemoveAutoTerminationPolicyInput {
4404
4921
  /**
4922
+ * @public
4405
4923
  * <p>Specifies the ID of the Amazon EMR cluster from which the auto-termination
4406
4924
  * policy will be removed.</p>
4407
4925
  */
@@ -4417,6 +4935,7 @@ export interface RemoveAutoTerminationPolicyOutput {
4417
4935
  */
4418
4936
  export interface RemoveManagedScalingPolicyInput {
4419
4937
  /**
4938
+ * @public
4420
4939
  * <p> Specifies the ID of the cluster from which the managed scaling policy will be removed.
4421
4940
  * </p>
4422
4941
  */
@@ -4434,11 +4953,13 @@ export interface RemoveManagedScalingPolicyOutput {
4434
4953
  */
4435
4954
  export interface RemoveTagsInput {
4436
4955
  /**
4956
+ * @public
4437
4957
  * <p>The Amazon EMR resource identifier from which tags will be removed. For example,
4438
4958
  * a cluster identifier or an Amazon EMR Studio ID.</p>
4439
4959
  */
4440
4960
  ResourceId: string | undefined;
4441
4961
  /**
4962
+ * @public
4442
4963
  * <p>A list of tag keys to remove from the resource.</p>
4443
4964
  */
4444
4965
  TagKeys: string[] | undefined;
@@ -4456,10 +4977,12 @@ export interface RemoveTagsOutput {
4456
4977
  */
4457
4978
  export interface SupportedProductConfig {
4458
4979
  /**
4980
+ * @public
4459
4981
  * <p>The name of the product configuration.</p>
4460
4982
  */
4461
4983
  Name?: string;
4462
4984
  /**
4985
+ * @public
4463
4986
  * <p>The list of user-supplied arguments.</p>
4464
4987
  */
4465
4988
  Args?: string[];
@@ -4470,10 +4993,12 @@ export interface SupportedProductConfig {
4470
4993
  */
4471
4994
  export interface RunJobFlowOutput {
4472
4995
  /**
4996
+ * @public
4473
4997
  * <p>A unique identifier for the job flow.</p>
4474
4998
  */
4475
4999
  JobFlowId?: string;
4476
5000
  /**
5001
+ * @public
4477
5002
  * <p>The Amazon Resource Name (ARN) of the cluster.</p>
4478
5003
  */
4479
5004
  ClusterArn?: string;
@@ -4484,11 +5009,13 @@ export interface RunJobFlowOutput {
4484
5009
  */
4485
5010
  export interface SetTerminationProtectionInput {
4486
5011
  /**
5012
+ * @public
4487
5013
  * <p> A list of strings that uniquely identify the clusters to protect. This identifier is
4488
5014
  * returned by <a>RunJobFlow</a> and can also be obtained from <a>DescribeJobFlows</a> . </p>
4489
5015
  */
4490
5016
  JobFlowIds: string[] | undefined;
4491
5017
  /**
5018
+ * @public
4492
5019
  * <p>A Boolean that indicates whether to protect the cluster and prevent the Amazon EC2 instances in the cluster from shutting down due to API calls, user intervention, or
4493
5020
  * job-flow error.</p>
4494
5021
  */
@@ -4500,10 +5027,12 @@ export interface SetTerminationProtectionInput {
4500
5027
  */
4501
5028
  export interface SetVisibleToAllUsersInput {
4502
5029
  /**
5030
+ * @public
4503
5031
  * <p>The unique identifier of the job flow (cluster).</p>
4504
5032
  */
4505
5033
  JobFlowIds: string[] | undefined;
4506
5034
  /**
5035
+ * @public
4507
5036
  * <p>A value of <code>true</code> indicates that an IAM principal in the
4508
5037
  * Amazon Web Services account can perform Amazon EMR actions on the cluster that
4509
5038
  * the IAM policies attached to the principal allow. A value of
@@ -4519,10 +5048,12 @@ export interface SetVisibleToAllUsersInput {
4519
5048
  */
4520
5049
  export interface NotebookS3LocationFromInput {
4521
5050
  /**
5051
+ * @public
4522
5052
  * <p>The Amazon S3 bucket that stores the notebook execution input.</p>
4523
5053
  */
4524
5054
  Bucket?: string;
4525
5055
  /**
5056
+ * @public
4526
5057
  * <p>The key to the Amazon S3 location that stores the notebook execution
4527
5058
  * input.</p>
4528
5059
  */
@@ -4534,10 +5065,12 @@ export interface NotebookS3LocationFromInput {
4534
5065
  */
4535
5066
  export interface OutputNotebookS3LocationFromInput {
4536
5067
  /**
5068
+ * @public
4537
5069
  * <p>The Amazon S3 bucket that stores the notebook execution output.</p>
4538
5070
  */
4539
5071
  Bucket?: string;
4540
5072
  /**
5073
+ * @public
4541
5074
  * <p>The key to the Amazon S3 location that stores the notebook execution
4542
5075
  * output.</p>
4543
5076
  */
@@ -4548,11 +5081,13 @@ export interface OutputNotebookS3LocationFromInput {
4548
5081
  */
4549
5082
  export interface StartNotebookExecutionInput {
4550
5083
  /**
5084
+ * @public
4551
5085
  * <p>The unique identifier of the Amazon EMR Notebook to use for notebook
4552
5086
  * execution.</p>
4553
5087
  */
4554
5088
  EditorId?: string;
4555
5089
  /**
5090
+ * @public
4556
5091
  * <p>The path and file name of the notebook file for this execution, relative to the path
4557
5092
  * specified for the Amazon EMR Notebook. For example, if you specify a path of
4558
5093
  * <code>s3://MyBucket/MyNotebooks</code> when you create an Amazon EMR Notebook
@@ -4564,47 +5099,57 @@ export interface StartNotebookExecutionInput {
4564
5099
  */
4565
5100
  RelativePath?: string;
4566
5101
  /**
5102
+ * @public
4567
5103
  * <p>An optional name for the notebook execution.</p>
4568
5104
  */
4569
5105
  NotebookExecutionName?: string;
4570
5106
  /**
5107
+ * @public
4571
5108
  * <p>Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for
4572
5109
  * execution.</p>
4573
5110
  */
4574
5111
  NotebookParams?: string;
4575
5112
  /**
5113
+ * @public
4576
5114
  * <p>Specifies the execution engine (cluster) that runs the notebook execution.</p>
4577
5115
  */
4578
5116
  ExecutionEngine: ExecutionEngineConfig | undefined;
4579
5117
  /**
5118
+ * @public
4580
5119
  * <p>The name or ARN of the IAM role that is used as the service role for
4581
5120
  * Amazon EMR (the Amazon EMR role) for the notebook execution.</p>
4582
5121
  */
4583
5122
  ServiceRole: string | undefined;
4584
5123
  /**
5124
+ * @public
4585
5125
  * <p>The unique identifier of the Amazon EC2 security group to associate with the
4586
5126
  * Amazon EMR Notebook for this notebook execution.</p>
4587
5127
  */
4588
5128
  NotebookInstanceSecurityGroupId?: string;
4589
5129
  /**
5130
+ * @public
4590
5131
  * <p>A list of tags associated with a notebook execution. Tags are user-defined key-value
4591
5132
  * pairs that consist of a required key string with a maximum of 128 characters and an
4592
5133
  * optional value string with a maximum of 256 characters.</p>
4593
5134
  */
4594
5135
  Tags?: Tag[];
4595
5136
  /**
5137
+ * @public
4596
5138
  * <p>The Amazon S3 location for the notebook execution input.</p>
4597
5139
  */
4598
5140
  NotebookS3Location?: NotebookS3LocationFromInput;
4599
5141
  /**
5142
+ * @public
4600
5143
  * <p>The Amazon S3 location for the notebook execution output.</p>
4601
5144
  */
4602
5145
  OutputNotebookS3Location?: OutputNotebookS3LocationFromInput;
4603
5146
  /**
5147
+ * @public
4604
5148
  * <p>The output format for the notebook execution.</p>
4605
5149
  */
4606
5150
  OutputNotebookFormat?: OutputNotebookFormat | string;
4607
5151
  /**
5152
+ * @public
4608
5153
  * <p>The environment variables associated with the notebook execution.</p>
4609
5154
  */
4610
5155
  EnvironmentVariables?: Record<string, string>;
@@ -4614,6 +5159,7 @@ export interface StartNotebookExecutionInput {
4614
5159
  */
4615
5160
  export interface StartNotebookExecutionOutput {
4616
5161
  /**
5162
+ * @public
4617
5163
  * <p>The unique identifier of the notebook execution.</p>
4618
5164
  */
4619
5165
  NotebookExecutionId?: string;
@@ -4623,6 +5169,7 @@ export interface StartNotebookExecutionOutput {
4623
5169
  */
4624
5170
  export interface StopNotebookExecutionInput {
4625
5171
  /**
5172
+ * @public
4626
5173
  * <p>The unique identifier of the notebook execution.</p>
4627
5174
  */
4628
5175
  NotebookExecutionId: string | undefined;
@@ -4633,6 +5180,7 @@ export interface StopNotebookExecutionInput {
4633
5180
  */
4634
5181
  export interface TerminateJobFlowsInput {
4635
5182
  /**
5183
+ * @public
4636
5184
  * <p>A list of job flows to be shut down.</p>
4637
5185
  */
4638
5186
  JobFlowIds: string[] | undefined;
@@ -4642,18 +5190,22 @@ export interface TerminateJobFlowsInput {
4642
5190
  */
4643
5191
  export interface UpdateStudioInput {
4644
5192
  /**
5193
+ * @public
4645
5194
  * <p>The ID of the Amazon EMR Studio to update.</p>
4646
5195
  */
4647
5196
  StudioId: string | undefined;
4648
5197
  /**
5198
+ * @public
4649
5199
  * <p>A descriptive name for the Amazon EMR Studio.</p>
4650
5200
  */
4651
5201
  Name?: string;
4652
5202
  /**
5203
+ * @public
4653
5204
  * <p>A detailed description to assign to the Amazon EMR Studio.</p>
4654
5205
  */
4655
5206
  Description?: string;
4656
5207
  /**
5208
+ * @public
4657
5209
  * <p>A list of subnet IDs to associate with the Amazon EMR Studio. The list can
4658
5210
  * include new subnet IDs, but must also include all of the subnet IDs previously associated
4659
5211
  * with the Studio. The list order does not matter. A Studio can have a maximum of 5 subnets.
@@ -4661,6 +5213,7 @@ export interface UpdateStudioInput {
4661
5213
  */
4662
5214
  SubnetIds?: string[];
4663
5215
  /**
5216
+ * @public
4664
5217
  * <p>The Amazon S3 location to back up Workspaces and notebook files for the Amazon EMR Studio.</p>
4665
5218
  */
4666
5219
  DefaultS3Location?: string;
@@ -4670,10 +5223,12 @@ export interface UpdateStudioInput {
4670
5223
  */
4671
5224
  export interface UpdateStudioSessionMappingInput {
4672
5225
  /**
5226
+ * @public
4673
5227
  * <p>The ID of the Amazon EMR Studio.</p>
4674
5228
  */
4675
5229
  StudioId: string | undefined;
4676
5230
  /**
5231
+ * @public
4677
5232
  * <p>The globally unique identifier (GUID) of the user or group. For more information, see
4678
5233
  * <a href="https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserId">UserId</a> and <a href="https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-GroupId">GroupId</a> in the <i>IAM Identity Center Identity Store API
4679
5234
  * Reference</i>. Either <code>IdentityName</code> or <code>IdentityId</code> must
@@ -4681,16 +5236,19 @@ export interface UpdateStudioSessionMappingInput {
4681
5236
  */
4682
5237
  IdentityId?: string;
4683
5238
  /**
5239
+ * @public
4684
5240
  * <p>The name of the user or group to update. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserName">UserName</a> and <a href="https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName">DisplayName</a> in the <i>IAM Identity Center Identity Store API
4685
5241
  * Reference</i>. Either <code>IdentityName</code> or <code>IdentityId</code> must
4686
5242
  * be specified.</p>
4687
5243
  */
4688
5244
  IdentityName?: string;
4689
5245
  /**
5246
+ * @public
4690
5247
  * <p>Specifies whether the identity to update is a user or a group.</p>
4691
5248
  */
4692
5249
  IdentityType: IdentityType | string | undefined;
4693
5250
  /**
5251
+ * @public
4694
5252
  * <p>The Amazon Resource Name (ARN) of the session policy to associate with the specified
4695
5253
  * user or group.</p>
4696
5254
  */
@@ -4709,14 +5267,17 @@ export interface UpdateStudioSessionMappingInput {
4709
5267
  */
4710
5268
  export interface Configuration {
4711
5269
  /**
5270
+ * @public
4712
5271
  * <p>The classification within a configuration.</p>
4713
5272
  */
4714
5273
  Classification?: string;
4715
5274
  /**
5275
+ * @public
4716
5276
  * <p>A list of additional configurations to apply within a configuration object.</p>
4717
5277
  */
4718
5278
  Configurations?: Configuration[];
4719
5279
  /**
5280
+ * @public
4720
5281
  * <p>A set of properties specified within a configuration classification.</p>
4721
5282
  */
4722
5283
  Properties?: Record<string, string>;
@@ -4730,6 +5291,7 @@ export interface Configuration {
4730
5291
  */
4731
5292
  export interface BlockPublicAccessConfiguration {
4732
5293
  /**
5294
+ * @public
4733
5295
  * <p>Indicates whether Amazon EMR block public access is enabled (<code>true</code>)
4734
5296
  * or disabled (<code>false</code>). By default, the value is <code>false</code> for accounts
4735
5297
  * that have created Amazon EMR clusters before July 2019. For accounts created after
@@ -4737,6 +5299,7 @@ export interface BlockPublicAccessConfiguration {
4737
5299
  */
4738
5300
  BlockPublicSecurityGroupRules: boolean | undefined;
4739
5301
  /**
5302
+ * @public
4740
5303
  * <p>Specifies ports and port ranges that are permitted to have security group rules that
4741
5304
  * allow inbound traffic from all public sources. For example, if Port 23 (Telnet) is
4742
5305
  * specified for <code>PermittedPublicSecurityGroupRuleRanges</code>, Amazon EMR
@@ -4748,14 +5311,17 @@ export interface BlockPublicAccessConfiguration {
4748
5311
  */
4749
5312
  PermittedPublicSecurityGroupRuleRanges?: PortRange[];
4750
5313
  /**
5314
+ * @public
4751
5315
  * <p>The classification within a configuration.</p>
4752
5316
  */
4753
5317
  Classification?: string;
4754
5318
  /**
5319
+ * @public
4755
5320
  * <p>A list of additional configurations to apply within a configuration object.</p>
4756
5321
  */
4757
5322
  Configurations?: Configuration[];
4758
5323
  /**
5324
+ * @public
4759
5325
  * <p>A set of properties specified within a configuration classification.</p>
4760
5326
  */
4761
5327
  Properties?: Record<string, string>;
@@ -4766,24 +5332,29 @@ export interface BlockPublicAccessConfiguration {
4766
5332
  */
4767
5333
  export interface Cluster {
4768
5334
  /**
5335
+ * @public
4769
5336
  * <p>The unique identifier for the cluster.</p>
4770
5337
  */
4771
5338
  Id?: string;
4772
5339
  /**
5340
+ * @public
4773
5341
  * <p>The name of the cluster.</p>
4774
5342
  */
4775
5343
  Name?: string;
4776
5344
  /**
5345
+ * @public
4777
5346
  * <p>The current status details about the cluster.</p>
4778
5347
  */
4779
5348
  Status?: ClusterStatus;
4780
5349
  /**
5350
+ * @public
4781
5351
  * <p>Provides information about the Amazon EC2 instances in a cluster grouped by
4782
5352
  * category. For example, key name, subnet ID, IAM instance profile, and so
4783
5353
  * on.</p>
4784
5354
  */
4785
5355
  Ec2InstanceAttributes?: Ec2InstanceAttributes;
4786
5356
  /**
5357
+ * @public
4787
5358
  * <note>
4788
5359
  * <p>The instance fleet configuration is available only in Amazon EMR releases
4789
5360
  * 4.8.0 and later, excluding 5.0.x versions.</p>
@@ -4794,25 +5365,30 @@ export interface Cluster {
4794
5365
  */
4795
5366
  InstanceCollectionType?: InstanceCollectionType | string;
4796
5367
  /**
5368
+ * @public
4797
5369
  * <p>The path to the Amazon S3 location where logs for this cluster are
4798
5370
  * stored.</p>
4799
5371
  */
4800
5372
  LogUri?: string;
4801
5373
  /**
5374
+ * @public
4802
5375
  * <p> The KMS key used for encrypting log files. This attribute is only
4803
5376
  * available with Amazon EMR 5.30.0 and later, excluding Amazon EMR 6.0.0.
4804
5377
  * </p>
4805
5378
  */
4806
5379
  LogEncryptionKmsKeyId?: string;
4807
5380
  /**
5381
+ * @public
4808
5382
  * <p>The AMI version requested for this cluster.</p>
4809
5383
  */
4810
5384
  RequestedAmiVersion?: string;
4811
5385
  /**
5386
+ * @public
4812
5387
  * <p>The AMI version running on this cluster.</p>
4813
5388
  */
4814
5389
  RunningAmiVersion?: string;
4815
5390
  /**
5391
+ * @public
4816
5392
  * <p>The Amazon EMR release label, which determines the version of open-source
4817
5393
  * application packages installed on the cluster. Release labels are in the form
4818
5394
  * <code>emr-x.x.x</code>, where x.x.x is an Amazon EMR release version such as
@@ -4822,15 +5398,18 @@ export interface Cluster {
4822
5398
  */
4823
5399
  ReleaseLabel?: string;
4824
5400
  /**
5401
+ * @public
4825
5402
  * <p>Specifies whether the cluster should terminate after completing all steps.</p>
4826
5403
  */
4827
5404
  AutoTerminate?: boolean;
4828
5405
  /**
5406
+ * @public
4829
5407
  * <p>Indicates whether Amazon EMR will lock the cluster to prevent the Amazon EC2 instances from being terminated by an API call or user intervention, or in
4830
5408
  * the event of a cluster error.</p>
4831
5409
  */
4832
5410
  TerminationProtected?: boolean;
4833
5411
  /**
5412
+ * @public
4834
5413
  * <p>Indicates whether the cluster is visible to IAM principals in the Amazon Web Services account associated with the cluster. When <code>true</code>, IAM principals in the Amazon Web Services account can perform Amazon EMR cluster
4835
5414
  * actions on the cluster that their IAM policies allow. When
4836
5415
  * <code>false</code>, only the IAM principal that created the cluster and
@@ -4843,18 +5422,22 @@ export interface Cluster {
4843
5422
  */
4844
5423
  VisibleToAllUsers?: boolean;
4845
5424
  /**
5425
+ * @public
4846
5426
  * <p>The applications installed on this cluster.</p>
4847
5427
  */
4848
5428
  Applications?: Application[];
4849
5429
  /**
5430
+ * @public
4850
5431
  * <p>A list of tags associated with a cluster.</p>
4851
5432
  */
4852
5433
  Tags?: Tag[];
4853
5434
  /**
5435
+ * @public
4854
5436
  * <p>The IAM role that Amazon EMR assumes in order to access Amazon Web Services resources on your behalf.</p>
4855
5437
  */
4856
5438
  ServiceRole?: string;
4857
5439
  /**
5440
+ * @public
4858
5441
  * <p>An approximation of the cost of the cluster, represented in m1.small/hours. This value
4859
5442
  * is incremented one time for every hour an m1.small instance runs. Larger instances are
4860
5443
  * weighted more, so an Amazon EC2 instance that is roughly four times more expensive
@@ -4863,26 +5446,31 @@ export interface Cluster {
4863
5446
  */
4864
5447
  NormalizedInstanceHours?: number;
4865
5448
  /**
5449
+ * @public
4866
5450
  * <p>The DNS name of the master node. If the cluster is on a private subnet, this is the
4867
5451
  * private DNS name. On a public subnet, this is the public DNS name.</p>
4868
5452
  */
4869
5453
  MasterPublicDnsName?: string;
4870
5454
  /**
5455
+ * @public
4871
5456
  * <p>Applies only to Amazon EMR releases 4.x and later. The list of configurations
4872
5457
  * that are supplied to the Amazon EMR cluster.</p>
4873
5458
  */
4874
5459
  Configurations?: Configuration[];
4875
5460
  /**
5461
+ * @public
4876
5462
  * <p>The name of the security configuration applied to the cluster.</p>
4877
5463
  */
4878
5464
  SecurityConfiguration?: string;
4879
5465
  /**
5466
+ * @public
4880
5467
  * <p>An IAM role for automatic scaling policies. The default role is
4881
5468
  * <code>EMR_AutoScaling_DefaultRole</code>. The IAM role provides
4882
5469
  * permissions that the automatic scaling feature requires to launch and terminate Amazon EC2 instances in an instance group.</p>
4883
5470
  */
4884
5471
  AutoScalingRole?: string;
4885
5472
  /**
5473
+ * @public
4886
5474
  * <p>The way that individual Amazon EC2 instances terminate when an automatic
4887
5475
  * scale-in activity occurs or an instance group is resized.
4888
5476
  * <code>TERMINATE_AT_INSTANCE_HOUR</code> indicates that Amazon EMR terminates
@@ -4896,45 +5484,54 @@ export interface Cluster {
4896
5484
  */
4897
5485
  ScaleDownBehavior?: ScaleDownBehavior | string;
4898
5486
  /**
5487
+ * @public
4899
5488
  * <p>Available only in Amazon EMR releases 5.7.0 and later. The ID of a custom Amazon
4900
5489
  * EBS-backed Linux AMI if the cluster uses a custom AMI.</p>
4901
5490
  */
4902
5491
  CustomAmiId?: string;
4903
5492
  /**
5493
+ * @public
4904
5494
  * <p>The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is
4905
5495
  * used for each Amazon EC2 instance. Available in Amazon EMR releases 4.x and
4906
5496
  * later.</p>
4907
5497
  */
4908
5498
  EbsRootVolumeSize?: number;
4909
5499
  /**
5500
+ * @public
4910
5501
  * <p>Applies only when <code>CustomAmiID</code> is used. Specifies the type of updates that
4911
5502
  * the Amazon Linux AMI package repositories apply when an instance boots using the
4912
5503
  * AMI.</p>
4913
5504
  */
4914
5505
  RepoUpgradeOnBoot?: RepoUpgradeOnBoot | string;
4915
5506
  /**
5507
+ * @public
4916
5508
  * <p>Attributes for Kerberos configuration when Kerberos authentication is enabled using a
4917
5509
  * security configuration. For more information see <a href="https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-kerberos.html">Use Kerberos Authentication</a>
4918
5510
  * in the <i>Amazon EMR Management Guide</i>.</p>
4919
5511
  */
4920
5512
  KerberosAttributes?: KerberosAttributes;
4921
5513
  /**
5514
+ * @public
4922
5515
  * <p>The Amazon Resource Name of the cluster.</p>
4923
5516
  */
4924
5517
  ClusterArn?: string;
4925
5518
  /**
5519
+ * @public
4926
5520
  * <p> The Amazon Resource Name (ARN) of the Outpost where the cluster is launched. </p>
4927
5521
  */
4928
5522
  OutpostArn?: string;
4929
5523
  /**
5524
+ * @public
4930
5525
  * <p>Specifies the number of steps that can be executed concurrently.</p>
4931
5526
  */
4932
5527
  StepConcurrencyLevel?: number;
4933
5528
  /**
5529
+ * @public
4934
5530
  * <p>Placement group configured for an Amazon EMR cluster.</p>
4935
5531
  */
4936
5532
  PlacementGroups?: PlacementGroupConfig[];
4937
5533
  /**
5534
+ * @public
4938
5535
  * <p>The Amazon Linux release specified in a cluster launch RunJobFlow request. If no Amazon
4939
5536
  * Linux release was specified, the default Amazon Linux release is shown in the
4940
5537
  * response.</p>
@@ -4947,32 +5544,39 @@ export interface Cluster {
4947
5544
  */
4948
5545
  export interface InstanceGroupConfig {
4949
5546
  /**
5547
+ * @public
4950
5548
  * <p>Friendly name given to the instance group.</p>
4951
5549
  */
4952
5550
  Name?: string;
4953
5551
  /**
5552
+ * @public
4954
5553
  * <p>Market type of the Amazon EC2 instances used to create a cluster node.</p>
4955
5554
  */
4956
5555
  Market?: MarketType | string;
4957
5556
  /**
5557
+ * @public
4958
5558
  * <p>The role of the instance group in the cluster.</p>
4959
5559
  */
4960
5560
  InstanceRole: InstanceRoleType | string | undefined;
4961
5561
  /**
5562
+ * @public
4962
5563
  * <p>If specified, indicates that the instance group uses Spot Instances. This is the maximum
4963
5564
  * price you are willing to pay for Spot Instances. Specify <code>OnDemandPrice</code> to set
4964
5565
  * the amount equal to the On-Demand price, or specify an amount in USD.</p>
4965
5566
  */
4966
5567
  BidPrice?: string;
4967
5568
  /**
5569
+ * @public
4968
5570
  * <p>The Amazon EC2 instance type for all instances in the instance group.</p>
4969
5571
  */
4970
5572
  InstanceType: string | undefined;
4971
5573
  /**
5574
+ * @public
4972
5575
  * <p>Target number of instances for the instance group.</p>
4973
5576
  */
4974
5577
  InstanceCount: number | undefined;
4975
5578
  /**
5579
+ * @public
4976
5580
  * <note>
4977
5581
  * <p>Amazon EMR releases 4.x or later.</p>
4978
5582
  * </note>
@@ -4982,11 +5586,13 @@ export interface InstanceGroupConfig {
4982
5586
  */
4983
5587
  Configurations?: Configuration[];
4984
5588
  /**
5589
+ * @public
4985
5590
  * <p>EBS configurations that will be attached to each Amazon EC2 instance in the
4986
5591
  * instance group.</p>
4987
5592
  */
4988
5593
  EbsConfiguration?: EbsConfiguration;
4989
5594
  /**
5595
+ * @public
4990
5596
  * <p>An automatic scaling policy for a core instance group or task instance group in an
4991
5597
  * Amazon EMR cluster. The automatic scaling policy defines how an instance group
4992
5598
  * dynamically adds and terminates Amazon EC2 instances in response to the value of a
@@ -4994,6 +5600,7 @@ export interface InstanceGroupConfig {
4994
5600
  */
4995
5601
  AutoScalingPolicy?: AutoScalingPolicy;
4996
5602
  /**
5603
+ * @public
4997
5604
  * <p>The custom AMI ID to use for the provisioned instance group.</p>
4998
5605
  */
4999
5606
  CustomAmiId?: string;
@@ -5004,27 +5611,33 @@ export interface InstanceGroupConfig {
5004
5611
  */
5005
5612
  export interface InstanceGroupModifyConfig {
5006
5613
  /**
5614
+ * @public
5007
5615
  * <p>Unique ID of the instance group to modify.</p>
5008
5616
  */
5009
5617
  InstanceGroupId: string | undefined;
5010
5618
  /**
5619
+ * @public
5011
5620
  * <p>Target size for the instance group.</p>
5012
5621
  */
5013
5622
  InstanceCount?: number;
5014
5623
  /**
5624
+ * @public
5015
5625
  * <p>The Amazon EC2 InstanceIds to terminate. After you terminate the instances, the
5016
5626
  * instance group will not return to its original requested size.</p>
5017
5627
  */
5018
5628
  EC2InstanceIdsToTerminate?: string[];
5019
5629
  /**
5630
+ * @public
5020
5631
  * <p>Policy for customizing shrink operations.</p>
5021
5632
  */
5022
5633
  ShrinkPolicy?: ShrinkPolicy;
5023
5634
  /**
5635
+ * @public
5024
5636
  * <p>Type of reconfiguration requested. Valid values are MERGE and OVERWRITE.</p>
5025
5637
  */
5026
5638
  ReconfigurationType?: ReconfigurationType | string;
5027
5639
  /**
5640
+ * @public
5028
5641
  * <p>A list of new or modified configurations to apply for an instance group.</p>
5029
5642
  */
5030
5643
  Configurations?: Configuration[];
@@ -5045,10 +5658,12 @@ export interface InstanceGroupModifyConfig {
5045
5658
  */
5046
5659
  export interface InstanceTypeConfig {
5047
5660
  /**
5661
+ * @public
5048
5662
  * <p>An Amazon EC2 instance type, such as <code>m3.xlarge</code>. </p>
5049
5663
  */
5050
5664
  InstanceType: string | undefined;
5051
5665
  /**
5666
+ * @public
5052
5667
  * <p>The number of units that a provisioned instance of this type provides toward fulfilling
5053
5668
  * the target capacities defined in <a>InstanceFleetConfig</a>. This value is 1 for
5054
5669
  * a master instance fleet, and must be 1 or greater for core and task instance fleets.
@@ -5056,6 +5671,7 @@ export interface InstanceTypeConfig {
5056
5671
  */
5057
5672
  WeightedCapacity?: number;
5058
5673
  /**
5674
+ * @public
5059
5675
  * <p>The bid price for each Amazon EC2 Spot Instance type as defined by
5060
5676
  * <code>InstanceType</code>. Expressed in USD. If neither <code>BidPrice</code> nor
5061
5677
  * <code>BidPriceAsPercentageOfOnDemandPrice</code> is provided,
@@ -5063,6 +5679,7 @@ export interface InstanceTypeConfig {
5063
5679
  */
5064
5680
  BidPrice?: string;
5065
5681
  /**
5682
+ * @public
5066
5683
  * <p>The bid price, as a percentage of On-Demand price, for each Amazon EC2 Spot
5067
5684
  * Instance as defined by <code>InstanceType</code>. Expressed as a number (for example, 20
5068
5685
  * specifies 20%). If neither <code>BidPrice</code> nor
@@ -5071,16 +5688,19 @@ export interface InstanceTypeConfig {
5071
5688
  */
5072
5689
  BidPriceAsPercentageOfOnDemandPrice?: number;
5073
5690
  /**
5691
+ * @public
5074
5692
  * <p>The configuration of Amazon Elastic Block Store (Amazon EBS) attached to each
5075
5693
  * instance as defined by <code>InstanceType</code>. </p>
5076
5694
  */
5077
5695
  EbsConfiguration?: EbsConfiguration;
5078
5696
  /**
5697
+ * @public
5079
5698
  * <p>A configuration classification that applies when provisioning cluster instances, which
5080
5699
  * can include configurations for applications and software that run on the cluster.</p>
5081
5700
  */
5082
5701
  Configurations?: Configuration[];
5083
5702
  /**
5703
+ * @public
5084
5704
  * <p>The custom AMI ID to use for the instance type.</p>
5085
5705
  */
5086
5706
  CustomAmiId?: string;
@@ -5095,10 +5715,12 @@ export interface InstanceTypeConfig {
5095
5715
  */
5096
5716
  export interface InstanceTypeSpecification {
5097
5717
  /**
5718
+ * @public
5098
5719
  * <p>The Amazon EC2 instance type, for example <code>m3.xlarge</code>.</p>
5099
5720
  */
5100
5721
  InstanceType?: string;
5101
5722
  /**
5723
+ * @public
5102
5724
  * <p>The number of units that a provisioned instance of this type provides toward fulfilling
5103
5725
  * the target capacities defined in <a>InstanceFleetConfig</a>. Capacity values
5104
5726
  * represent performance characteristics such as vCPUs, memory, or I/O. If not specified, the
@@ -5106,32 +5728,38 @@ export interface InstanceTypeSpecification {
5106
5728
  */
5107
5729
  WeightedCapacity?: number;
5108
5730
  /**
5731
+ * @public
5109
5732
  * <p>The bid price for each Amazon EC2 Spot Instance type as defined by
5110
5733
  * <code>InstanceType</code>. Expressed in USD.</p>
5111
5734
  */
5112
5735
  BidPrice?: string;
5113
5736
  /**
5737
+ * @public
5114
5738
  * <p>The bid price, as a percentage of On-Demand price, for each Amazon EC2 Spot
5115
5739
  * Instance as defined by <code>InstanceType</code>. Expressed as a number (for example, 20
5116
5740
  * specifies 20%).</p>
5117
5741
  */
5118
5742
  BidPriceAsPercentageOfOnDemandPrice?: number;
5119
5743
  /**
5744
+ * @public
5120
5745
  * <p>A configuration classification that applies when provisioning cluster instances, which
5121
5746
  * can include configurations for applications and software bundled with Amazon EMR.</p>
5122
5747
  */
5123
5748
  Configurations?: Configuration[];
5124
5749
  /**
5750
+ * @public
5125
5751
  * <p>The configuration of Amazon Elastic Block Store (Amazon EBS) attached to each
5126
5752
  * instance as defined by <code>InstanceType</code>.</p>
5127
5753
  */
5128
5754
  EbsBlockDevices?: EbsBlockDevice[];
5129
5755
  /**
5756
+ * @public
5130
5757
  * <p>Evaluates to <code>TRUE</code> when the specified <code>InstanceType</code> is
5131
5758
  * EBS-optimized.</p>
5132
5759
  */
5133
5760
  EbsOptimized?: boolean;
5134
5761
  /**
5762
+ * @public
5135
5763
  * <p>The custom AMI ID to use for the instance type.</p>
5136
5764
  */
5137
5765
  CustomAmiId?: string;
@@ -5142,6 +5770,7 @@ export interface InstanceTypeSpecification {
5142
5770
  */
5143
5771
  export interface DescribeClusterOutput {
5144
5772
  /**
5773
+ * @public
5145
5774
  * <p>This output contains the details for the requested cluster.</p>
5146
5775
  */
5147
5776
  Cluster?: Cluster;
@@ -5151,6 +5780,7 @@ export interface DescribeClusterOutput {
5151
5780
  */
5152
5781
  export interface GetBlockPublicAccessConfigurationOutput {
5153
5782
  /**
5783
+ * @public
5154
5784
  * <p>A configuration for Amazon EMR block public access. The configuration applies to
5155
5785
  * all clusters created in your account for the current Region. The configuration specifies
5156
5786
  * whether block public access is enabled. If block public access is enabled, security groups
@@ -5170,6 +5800,7 @@ export interface GetBlockPublicAccessConfigurationOutput {
5170
5800
  */
5171
5801
  BlockPublicAccessConfiguration: BlockPublicAccessConfiguration | undefined;
5172
5802
  /**
5803
+ * @public
5173
5804
  * <p>Properties that describe the Amazon Web Services principal that created the
5174
5805
  * <code>BlockPublicAccessConfiguration</code> using the
5175
5806
  * <code>PutBlockPublicAccessConfiguration</code> action as well as the date and time that
@@ -5183,6 +5814,7 @@ export interface GetBlockPublicAccessConfigurationOutput {
5183
5814
  */
5184
5815
  export interface PutBlockPublicAccessConfigurationInput {
5185
5816
  /**
5817
+ * @public
5186
5818
  * <p>A configuration for Amazon EMR block public access. The configuration applies to
5187
5819
  * all clusters created in your account for the current Region. The configuration specifies
5188
5820
  * whether block public access is enabled. If block public access is enabled, security groups
@@ -5208,10 +5840,12 @@ export interface PutBlockPublicAccessConfigurationInput {
5208
5840
  */
5209
5841
  export interface AddInstanceGroupsInput {
5210
5842
  /**
5843
+ * @public
5211
5844
  * <p>Instance groups to add.</p>
5212
5845
  */
5213
5846
  InstanceGroups: InstanceGroupConfig[] | undefined;
5214
5847
  /**
5848
+ * @public
5215
5849
  * <p>Job flow in which to add the instance groups.</p>
5216
5850
  */
5217
5851
  JobFlowId: string | undefined;
@@ -5229,23 +5863,28 @@ export interface AddInstanceGroupsInput {
5229
5863
  */
5230
5864
  export interface InstanceFleet {
5231
5865
  /**
5866
+ * @public
5232
5867
  * <p>The unique identifier of the instance fleet.</p>
5233
5868
  */
5234
5869
  Id?: string;
5235
5870
  /**
5871
+ * @public
5236
5872
  * <p>A friendly name for the instance fleet.</p>
5237
5873
  */
5238
5874
  Name?: string;
5239
5875
  /**
5876
+ * @public
5240
5877
  * <p>The current status of the instance fleet. </p>
5241
5878
  */
5242
5879
  Status?: InstanceFleetStatus;
5243
5880
  /**
5881
+ * @public
5244
5882
  * <p>The node type that the instance fleet hosts. Valid values are MASTER, CORE, or TASK.
5245
5883
  * </p>
5246
5884
  */
5247
5885
  InstanceFleetType?: InstanceFleetType | string;
5248
5886
  /**
5887
+ * @public
5249
5888
  * <p>The target capacity of On-Demand units for the instance fleet, which determines how many
5250
5889
  * On-Demand Instances to provision. When the instance fleet launches, Amazon EMR
5251
5890
  * tries to provision On-Demand Instances as specified by <a>InstanceTypeConfig</a>. Each instance configuration has a specified <code>WeightedCapacity</code>. When an
@@ -5267,6 +5906,7 @@ export interface InstanceFleet {
5267
5906
  */
5268
5907
  TargetOnDemandCapacity?: number;
5269
5908
  /**
5909
+ * @public
5270
5910
  * <p>The target capacity of Spot units for the instance fleet, which determines how many Spot
5271
5911
  * Instances to provision. When the instance fleet launches, Amazon EMR tries to
5272
5912
  * provision Spot Instances as specified by <a>InstanceTypeConfig</a>. Each
@@ -5288,27 +5928,32 @@ export interface InstanceFleet {
5288
5928
  */
5289
5929
  TargetSpotCapacity?: number;
5290
5930
  /**
5931
+ * @public
5291
5932
  * <p>The number of On-Demand units that have been provisioned for the instance fleet to
5292
5933
  * fulfill <code>TargetOnDemandCapacity</code>. This provisioned capacity might be less than
5293
5934
  * or greater than <code>TargetOnDemandCapacity</code>.</p>
5294
5935
  */
5295
5936
  ProvisionedOnDemandCapacity?: number;
5296
5937
  /**
5938
+ * @public
5297
5939
  * <p>The number of Spot units that have been provisioned for this instance fleet to fulfill
5298
5940
  * <code>TargetSpotCapacity</code>. This provisioned capacity might be less than or greater
5299
5941
  * than <code>TargetSpotCapacity</code>.</p>
5300
5942
  */
5301
5943
  ProvisionedSpotCapacity?: number;
5302
5944
  /**
5945
+ * @public
5303
5946
  * <p>An array of specifications for the instance types that comprise an instance
5304
5947
  * fleet.</p>
5305
5948
  */
5306
5949
  InstanceTypeSpecifications?: InstanceTypeSpecification[];
5307
5950
  /**
5951
+ * @public
5308
5952
  * <p>Describes the launch specification for an instance fleet. </p>
5309
5953
  */
5310
5954
  LaunchSpecifications?: InstanceFleetProvisioningSpecifications;
5311
5955
  /**
5956
+ * @public
5312
5957
  * <p>The resize specification for the instance fleet.</p>
5313
5958
  */
5314
5959
  ResizeSpecifications?: InstanceFleetResizingSpecifications;
@@ -5323,15 +5968,18 @@ export interface InstanceFleet {
5323
5968
  */
5324
5969
  export interface InstanceFleetConfig {
5325
5970
  /**
5971
+ * @public
5326
5972
  * <p>The friendly name of the instance fleet.</p>
5327
5973
  */
5328
5974
  Name?: string;
5329
5975
  /**
5976
+ * @public
5330
5977
  * <p>The node type that the instance fleet hosts. Valid values are MASTER, CORE, and
5331
5978
  * TASK.</p>
5332
5979
  */
5333
5980
  InstanceFleetType: InstanceFleetType | string | undefined;
5334
5981
  /**
5982
+ * @public
5335
5983
  * <p>The target capacity of On-Demand units for the instance fleet, which determines how many
5336
5984
  * On-Demand Instances to provision. When the instance fleet launches, Amazon EMR
5337
5985
  * tries to provision On-Demand Instances as specified by <a>InstanceTypeConfig</a>. Each instance configuration has a specified <code>WeightedCapacity</code>. When an
@@ -5352,6 +6000,7 @@ export interface InstanceFleetConfig {
5352
6000
  */
5353
6001
  TargetOnDemandCapacity?: number;
5354
6002
  /**
6003
+ * @public
5355
6004
  * <p>The target capacity of Spot units for the instance fleet, which determines how many Spot
5356
6005
  * Instances to provision. When the instance fleet launches, Amazon EMR tries to
5357
6006
  * provision Spot Instances as specified by <a>InstanceTypeConfig</a>. Each
@@ -5372,15 +6021,18 @@ export interface InstanceFleetConfig {
5372
6021
  */
5373
6022
  TargetSpotCapacity?: number;
5374
6023
  /**
6024
+ * @public
5375
6025
  * <p>The instance type configurations that define the Amazon EC2 instances in the
5376
6026
  * instance fleet.</p>
5377
6027
  */
5378
6028
  InstanceTypeConfigs?: InstanceTypeConfig[];
5379
6029
  /**
6030
+ * @public
5380
6031
  * <p>The launch specification for the instance fleet.</p>
5381
6032
  */
5382
6033
  LaunchSpecifications?: InstanceFleetProvisioningSpecifications;
5383
6034
  /**
6035
+ * @public
5384
6036
  * <p>The resize specification for the instance fleet.</p>
5385
6037
  */
5386
6038
  ResizeSpecifications?: InstanceFleetResizingSpecifications;
@@ -5391,10 +6043,12 @@ export interface InstanceFleetConfig {
5391
6043
  */
5392
6044
  export interface ModifyInstanceGroupsInput {
5393
6045
  /**
6046
+ * @public
5394
6047
  * <p>The ID of the cluster to which the instance group belongs.</p>
5395
6048
  */
5396
6049
  ClusterId?: string;
5397
6050
  /**
6051
+ * @public
5398
6052
  * <p>Instance groups to change.</p>
5399
6053
  */
5400
6054
  InstanceGroups?: InstanceGroupModifyConfig[];
@@ -5404,10 +6058,12 @@ export interface ModifyInstanceGroupsInput {
5404
6058
  */
5405
6059
  export interface AddInstanceFleetInput {
5406
6060
  /**
6061
+ * @public
5407
6062
  * <p>The unique identifier of the cluster.</p>
5408
6063
  */
5409
6064
  ClusterId: string | undefined;
5410
6065
  /**
6066
+ * @public
5411
6067
  * <p>Specifies the configuration of the instance fleet.</p>
5412
6068
  */
5413
6069
  InstanceFleet: InstanceFleetConfig | undefined;
@@ -5419,45 +6075,55 @@ export interface AddInstanceFleetInput {
5419
6075
  */
5420
6076
  export interface InstanceGroup {
5421
6077
  /**
6078
+ * @public
5422
6079
  * <p>The identifier of the instance group.</p>
5423
6080
  */
5424
6081
  Id?: string;
5425
6082
  /**
6083
+ * @public
5426
6084
  * <p>The name of the instance group.</p>
5427
6085
  */
5428
6086
  Name?: string;
5429
6087
  /**
6088
+ * @public
5430
6089
  * <p>The marketplace to provision instances for this group. Valid values are ON_DEMAND or
5431
6090
  * SPOT.</p>
5432
6091
  */
5433
6092
  Market?: MarketType | string;
5434
6093
  /**
6094
+ * @public
5435
6095
  * <p>The type of the instance group. Valid values are MASTER, CORE or TASK.</p>
5436
6096
  */
5437
6097
  InstanceGroupType?: InstanceGroupType | string;
5438
6098
  /**
6099
+ * @public
5439
6100
  * <p>If specified, indicates that the instance group uses Spot Instances. This is the maximum
5440
6101
  * price you are willing to pay for Spot Instances. Specify <code>OnDemandPrice</code> to set
5441
6102
  * the amount equal to the On-Demand price, or specify an amount in USD.</p>
5442
6103
  */
5443
6104
  BidPrice?: string;
5444
6105
  /**
6106
+ * @public
5445
6107
  * <p>The Amazon EC2 instance type for all instances in the instance group.</p>
5446
6108
  */
5447
6109
  InstanceType?: string;
5448
6110
  /**
6111
+ * @public
5449
6112
  * <p>The target number of instances for the instance group.</p>
5450
6113
  */
5451
6114
  RequestedInstanceCount?: number;
5452
6115
  /**
6116
+ * @public
5453
6117
  * <p>The number of instances currently running in this instance group.</p>
5454
6118
  */
5455
6119
  RunningInstanceCount?: number;
5456
6120
  /**
6121
+ * @public
5457
6122
  * <p>The current status of the instance group.</p>
5458
6123
  */
5459
6124
  Status?: InstanceGroupStatus;
5460
6125
  /**
6126
+ * @public
5461
6127
  * <note>
5462
6128
  * <p>Amazon EMR releases 4.x or later.</p>
5463
6129
  * </note>
@@ -5467,34 +6133,41 @@ export interface InstanceGroup {
5467
6133
  */
5468
6134
  Configurations?: Configuration[];
5469
6135
  /**
6136
+ * @public
5470
6137
  * <p>The version number of the requested configuration specification for this instance
5471
6138
  * group.</p>
5472
6139
  */
5473
6140
  ConfigurationsVersion?: number;
5474
6141
  /**
6142
+ * @public
5475
6143
  * <p>A list of configurations that were successfully applied for an instance group last
5476
6144
  * time.</p>
5477
6145
  */
5478
6146
  LastSuccessfullyAppliedConfigurations?: Configuration[];
5479
6147
  /**
6148
+ * @public
5480
6149
  * <p>The version number of a configuration specification that was successfully applied for an
5481
6150
  * instance group last time. </p>
5482
6151
  */
5483
6152
  LastSuccessfullyAppliedConfigurationsVersion?: number;
5484
6153
  /**
6154
+ * @public
5485
6155
  * <p>The EBS block devices that are mapped to this instance group.</p>
5486
6156
  */
5487
6157
  EbsBlockDevices?: EbsBlockDevice[];
5488
6158
  /**
6159
+ * @public
5489
6160
  * <p>If the instance group is EBS-optimized. An Amazon EBS-optimized instance uses an
5490
6161
  * optimized configuration stack and provides additional, dedicated capacity for Amazon EBS I/O.</p>
5491
6162
  */
5492
6163
  EbsOptimized?: boolean;
5493
6164
  /**
6165
+ * @public
5494
6166
  * <p>Policy for customizing shrink operations.</p>
5495
6167
  */
5496
6168
  ShrinkPolicy?: ShrinkPolicy;
5497
6169
  /**
6170
+ * @public
5498
6171
  * <p>An automatic scaling policy for a core instance group or task instance group in an
5499
6172
  * Amazon EMR cluster. The automatic scaling policy defines how an instance group
5500
6173
  * dynamically adds and terminates Amazon EC2 instances in response to the value of a
@@ -5502,6 +6175,7 @@ export interface InstanceGroup {
5502
6175
  */
5503
6176
  AutoScalingPolicy?: AutoScalingPolicyDescription;
5504
6177
  /**
6178
+ * @public
5505
6179
  * <p>The custom AMI ID to use for the provisioned instance group.</p>
5506
6180
  */
5507
6181
  CustomAmiId?: string;
@@ -5511,10 +6185,12 @@ export interface InstanceGroup {
5511
6185
  */
5512
6186
  export interface ListInstanceFleetsOutput {
5513
6187
  /**
6188
+ * @public
5514
6189
  * <p>The list of instance fleets for the cluster and given filters.</p>
5515
6190
  */
5516
6191
  InstanceFleets?: InstanceFleet[];
5517
6192
  /**
6193
+ * @public
5518
6194
  * <p>The pagination token that indicates the next set of results to retrieve.</p>
5519
6195
  */
5520
6196
  Marker?: string;
@@ -5525,10 +6201,12 @@ export interface ListInstanceFleetsOutput {
5525
6201
  */
5526
6202
  export interface ListInstanceGroupsOutput {
5527
6203
  /**
6204
+ * @public
5528
6205
  * <p>The list of instance groups for the cluster and given filters.</p>
5529
6206
  */
5530
6207
  InstanceGroups?: InstanceGroup[];
5531
6208
  /**
6209
+ * @public
5532
6210
  * <p>The pagination token that indicates the next set of results to retrieve.</p>
5533
6211
  */
5534
6212
  Marker?: string;
@@ -5543,22 +6221,27 @@ export interface ListInstanceGroupsOutput {
5543
6221
  */
5544
6222
  export interface JobFlowInstancesConfig {
5545
6223
  /**
6224
+ * @public
5546
6225
  * <p>The Amazon EC2 instance type of the master node.</p>
5547
6226
  */
5548
6227
  MasterInstanceType?: string;
5549
6228
  /**
6229
+ * @public
5550
6230
  * <p>The Amazon EC2 instance type of the core and task nodes.</p>
5551
6231
  */
5552
6232
  SlaveInstanceType?: string;
5553
6233
  /**
6234
+ * @public
5554
6235
  * <p>The number of Amazon EC2 instances in the cluster.</p>
5555
6236
  */
5556
6237
  InstanceCount?: number;
5557
6238
  /**
6239
+ * @public
5558
6240
  * <p>Configuration for the instance groups in a cluster.</p>
5559
6241
  */
5560
6242
  InstanceGroups?: InstanceGroupConfig[];
5561
6243
  /**
6244
+ * @public
5562
6245
  * <note>
5563
6246
  * <p>The instance fleet configuration is available only in Amazon EMR releases
5564
6247
  * 4.8.0 and later, excluding 5.0.x versions.</p>
@@ -5568,15 +6251,18 @@ export interface JobFlowInstancesConfig {
5568
6251
  */
5569
6252
  InstanceFleets?: InstanceFleetConfig[];
5570
6253
  /**
6254
+ * @public
5571
6255
  * <p>The name of the Amazon EC2 key pair that can be used to connect to the master
5572
6256
  * node using SSH as the user called "hadoop."</p>
5573
6257
  */
5574
6258
  Ec2KeyName?: string;
5575
6259
  /**
6260
+ * @public
5576
6261
  * <p>The Availability Zone in which the cluster runs.</p>
5577
6262
  */
5578
6263
  Placement?: PlacementType;
5579
6264
  /**
6265
+ * @public
5580
6266
  * <p>Specifies whether the cluster should remain available after completing all steps.
5581
6267
  * Defaults to <code>true</code>. For more information about configuring cluster termination,
5582
6268
  * see <a href="https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-termination.html">Control Cluster Termination</a> in the <i>EMR Management
@@ -5584,12 +6270,14 @@ export interface JobFlowInstancesConfig {
5584
6270
  */
5585
6271
  KeepJobFlowAliveWhenNoSteps?: boolean;
5586
6272
  /**
6273
+ * @public
5587
6274
  * <p>Specifies whether to lock the cluster to prevent the Amazon EC2 instances from
5588
6275
  * being terminated by API call, user intervention, or in the event of a job-flow
5589
6276
  * error.</p>
5590
6277
  */
5591
6278
  TerminationProtected?: boolean;
5592
6279
  /**
6280
+ * @public
5593
6281
  * <p>Applies only to Amazon EMR release versions earlier than 4.0. The Hadoop version
5594
6282
  * for the cluster. Valid inputs are "0.18" (no longer maintained), "0.20" (no longer
5595
6283
  * maintained), "0.20.205" (no longer maintained), "1.0.3", "2.2.0", or "2.4.0". If you do not
@@ -5599,6 +6287,7 @@ export interface JobFlowInstancesConfig {
5599
6287
  */
5600
6288
  HadoopVersion?: string;
5601
6289
  /**
6290
+ * @public
5602
6291
  * <p>Applies to clusters that use the uniform instance group configuration. To launch the
5603
6292
  * cluster in Amazon Virtual Private Cloud (Amazon VPC), set this parameter to the
5604
6293
  * identifier of the Amazon VPC subnet where you want the cluster to launch. If you do
@@ -5607,6 +6296,7 @@ export interface JobFlowInstancesConfig {
5607
6296
  */
5608
6297
  Ec2SubnetId?: string;
5609
6298
  /**
6299
+ * @public
5610
6300
  * <p>Applies to clusters that use the instance fleet configuration. When multiple Amazon EC2 subnet IDs are specified, Amazon EMR evaluates them and launches
5611
6301
  * instances in the optimal subnet.</p>
5612
6302
  * <note>
@@ -5616,27 +6306,32 @@ export interface JobFlowInstancesConfig {
5616
6306
  */
5617
6307
  Ec2SubnetIds?: string[];
5618
6308
  /**
6309
+ * @public
5619
6310
  * <p>The identifier of the Amazon EC2 security group for the master node. If you
5620
6311
  * specify <code>EmrManagedMasterSecurityGroup</code>, you must also specify
5621
6312
  * <code>EmrManagedSlaveSecurityGroup</code>.</p>
5622
6313
  */
5623
6314
  EmrManagedMasterSecurityGroup?: string;
5624
6315
  /**
6316
+ * @public
5625
6317
  * <p>The identifier of the Amazon EC2 security group for the core and task nodes. If
5626
6318
  * you specify <code>EmrManagedSlaveSecurityGroup</code>, you must also specify
5627
6319
  * <code>EmrManagedMasterSecurityGroup</code>.</p>
5628
6320
  */
5629
6321
  EmrManagedSlaveSecurityGroup?: string;
5630
6322
  /**
6323
+ * @public
5631
6324
  * <p>The identifier of the Amazon EC2 security group for the Amazon EMR
5632
6325
  * service to access clusters in VPC private subnets.</p>
5633
6326
  */
5634
6327
  ServiceAccessSecurityGroup?: string;
5635
6328
  /**
6329
+ * @public
5636
6330
  * <p>A list of additional Amazon EC2 security group IDs for the master node.</p>
5637
6331
  */
5638
6332
  AdditionalMasterSecurityGroups?: string[];
5639
6333
  /**
6334
+ * @public
5640
6335
  * <p>A list of additional Amazon EC2 security group IDs for the core and task
5641
6336
  * nodes.</p>
5642
6337
  */
@@ -5648,31 +6343,37 @@ export interface JobFlowInstancesConfig {
5648
6343
  */
5649
6344
  export interface RunJobFlowInput {
5650
6345
  /**
6346
+ * @public
5651
6347
  * <p>The name of the job flow.</p>
5652
6348
  */
5653
6349
  Name: string | undefined;
5654
6350
  /**
6351
+ * @public
5655
6352
  * <p>The location in Amazon S3 to write the log files of the job flow. If a value is
5656
6353
  * not provided, logs are not created.</p>
5657
6354
  */
5658
6355
  LogUri?: string;
5659
6356
  /**
6357
+ * @public
5660
6358
  * <p>The KMS key used for encrypting log files. If a value is not
5661
6359
  * provided, the logs remain encrypted by AES-256. This attribute is only available with
5662
6360
  * Amazon EMR releases 5.30.0 and later, excluding Amazon EMR 6.0.0.</p>
5663
6361
  */
5664
6362
  LogEncryptionKmsKeyId?: string;
5665
6363
  /**
6364
+ * @public
5666
6365
  * <p>A JSON string for selecting additional features.</p>
5667
6366
  */
5668
6367
  AdditionalInfo?: string;
5669
6368
  /**
6369
+ * @public
5670
6370
  * <p>Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR
5671
6371
  * releases 4.0 and later, <code>ReleaseLabel</code> is used. To specify a custom AMI, use
5672
6372
  * <code>CustomAmiID</code>.</p>
5673
6373
  */
5674
6374
  AmiVersion?: string;
5675
6375
  /**
6376
+ * @public
5676
6377
  * <p>The Amazon EMR release label, which determines the version of open-source
5677
6378
  * application packages installed on the cluster. Release labels are in the form
5678
6379
  * <code>emr-x.x.x</code>, where x.x.x is an Amazon EMR release version such as
@@ -5682,18 +6383,22 @@ export interface RunJobFlowInput {
5682
6383
  */
5683
6384
  ReleaseLabel?: string;
5684
6385
  /**
6386
+ * @public
5685
6387
  * <p>A specification of the number and type of Amazon EC2 instances.</p>
5686
6388
  */
5687
6389
  Instances: JobFlowInstancesConfig | undefined;
5688
6390
  /**
6391
+ * @public
5689
6392
  * <p>A list of steps to run.</p>
5690
6393
  */
5691
6394
  Steps?: StepConfig[];
5692
6395
  /**
6396
+ * @public
5693
6397
  * <p>A list of bootstrap actions to run before Hadoop starts on the cluster nodes.</p>
5694
6398
  */
5695
6399
  BootstrapActions?: BootstrapActionConfig[];
5696
6400
  /**
6401
+ * @public
5697
6402
  * <note>
5698
6403
  * <p>For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and
5699
6404
  * later, use Applications.</p>
@@ -5711,6 +6416,7 @@ export interface RunJobFlowInput {
5711
6416
  */
5712
6417
  SupportedProducts?: string[];
5713
6418
  /**
6419
+ * @public
5714
6420
  * <note>
5715
6421
  * <p>For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and
5716
6422
  * later, use Applications.</p>
@@ -5751,6 +6457,7 @@ export interface RunJobFlowInput {
5751
6457
  */
5752
6458
  NewSupportedProducts?: SupportedProductConfig[];
5753
6459
  /**
6460
+ * @public
5754
6461
  * <p>Applies to Amazon EMR releases 4.0 and later. A case-insensitive list of
5755
6462
  * applications for Amazon EMR to install and configure when launching the cluster.
5756
6463
  * For a list of applications available for each Amazon EMR release version, see the
@@ -5759,11 +6466,13 @@ export interface RunJobFlowInput {
5759
6466
  */
5760
6467
  Applications?: Application[];
5761
6468
  /**
6469
+ * @public
5762
6470
  * <p>For Amazon EMR releases 4.0 and later. The list of configurations supplied for
5763
6471
  * the Amazon EMR cluster that you are creating.</p>
5764
6472
  */
5765
6473
  Configurations?: Configuration[];
5766
6474
  /**
6475
+ * @public
5767
6476
  * <important>
5768
6477
  * <p>The VisibleToAllUsers parameter is no longer supported. By default, the value is set
5769
6478
  * to <code>true</code>. Setting it to <code>false</code> now has no effect.</p>
@@ -5780,6 +6489,7 @@ export interface RunJobFlowInput {
5780
6489
  */
5781
6490
  VisibleToAllUsers?: boolean;
5782
6491
  /**
6492
+ * @public
5783
6493
  * <p>Also called instance profile and Amazon EC2 role. An IAM role for
5784
6494
  * an Amazon EMR cluster. The Amazon EC2 instances of the cluster assume this
5785
6495
  * role. The default role is <code>EMR_EC2_DefaultRole</code>. In order to use the default
@@ -5787,26 +6497,31 @@ export interface RunJobFlowInput {
5787
6497
  */
5788
6498
  JobFlowRole?: string;
5789
6499
  /**
6500
+ * @public
5790
6501
  * <p>The IAM role that Amazon EMR assumes in order to access Amazon Web Services resources on your behalf. If you've created a custom service role path, you
5791
6502
  * must specify it for the service role when you launch your cluster.</p>
5792
6503
  */
5793
6504
  ServiceRole?: string;
5794
6505
  /**
6506
+ * @public
5795
6507
  * <p>A list of tags to associate with a cluster and propagate to Amazon EC2
5796
6508
  * instances.</p>
5797
6509
  */
5798
6510
  Tags?: Tag[];
5799
6511
  /**
6512
+ * @public
5800
6513
  * <p>The name of a security configuration to apply to the cluster.</p>
5801
6514
  */
5802
6515
  SecurityConfiguration?: string;
5803
6516
  /**
6517
+ * @public
5804
6518
  * <p>An IAM role for automatic scaling policies. The default role is
5805
6519
  * <code>EMR_AutoScaling_DefaultRole</code>. The IAM role provides
5806
6520
  * permissions that the automatic scaling feature requires to launch and terminate Amazon EC2 instances in an instance group.</p>
5807
6521
  */
5808
6522
  AutoScalingRole?: string;
5809
6523
  /**
6524
+ * @public
5810
6525
  * <p>Specifies the way that individual Amazon EC2 instances terminate when an
5811
6526
  * automatic scale-in activity occurs or an instance group is resized.
5812
6527
  * <code>TERMINATE_AT_INSTANCE_HOUR</code> indicates that Amazon EMR terminates
@@ -5820,6 +6535,7 @@ export interface RunJobFlowInput {
5820
6535
  */
5821
6536
  ScaleDownBehavior?: ScaleDownBehavior | string;
5822
6537
  /**
6538
+ * @public
5823
6539
  * <p>Available only in Amazon EMR releases 5.7.0 and later. The ID of a custom Amazon
5824
6540
  * EBS-backed Linux AMI. If specified, Amazon EMR uses this AMI when it launches
5825
6541
  * cluster Amazon EC2 instances. For more information about custom AMIs in Amazon EMR, see <a href="https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-custom-ami.html">Using a Custom AMI</a> in the
@@ -5832,12 +6548,14 @@ export interface RunJobFlowInput {
5832
6548
  */
5833
6549
  CustomAmiId?: string;
5834
6550
  /**
6551
+ * @public
5835
6552
  * <p>The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is
5836
6553
  * used for each Amazon EC2 instance. Available in Amazon EMR releases 4.x and
5837
6554
  * later.</p>
5838
6555
  */
5839
6556
  EbsRootVolumeSize?: number;
5840
6557
  /**
6558
+ * @public
5841
6559
  * <p>Applies only when <code>CustomAmiID</code> is used. Specifies which updates from the
5842
6560
  * Amazon Linux AMI package repositories to apply automatically when the instance boots using
5843
6561
  * the AMI. If omitted, the default is <code>SECURITY</code>, which indicates that only
@@ -5846,25 +6564,30 @@ export interface RunJobFlowInput {
5846
6564
  */
5847
6565
  RepoUpgradeOnBoot?: RepoUpgradeOnBoot | string;
5848
6566
  /**
6567
+ * @public
5849
6568
  * <p>Attributes for Kerberos configuration when Kerberos authentication is enabled using a
5850
6569
  * security configuration. For more information see <a href="https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-kerberos.html">Use Kerberos Authentication</a>
5851
6570
  * in the <i>Amazon EMR Management Guide</i>.</p>
5852
6571
  */
5853
6572
  KerberosAttributes?: KerberosAttributes;
5854
6573
  /**
6574
+ * @public
5855
6575
  * <p>Specifies the number of steps that can be executed concurrently. The default value is
5856
6576
  * <code>1</code>. The maximum value is <code>256</code>.</p>
5857
6577
  */
5858
6578
  StepConcurrencyLevel?: number;
5859
6579
  /**
6580
+ * @public
5860
6581
  * <p> The specified managed scaling policy for an Amazon EMR cluster. </p>
5861
6582
  */
5862
6583
  ManagedScalingPolicy?: ManagedScalingPolicy;
5863
6584
  /**
6585
+ * @public
5864
6586
  * <p>The specified placement group configuration for an Amazon EMR cluster.</p>
5865
6587
  */
5866
6588
  PlacementGroupConfigs?: PlacementGroupConfig[];
5867
6589
  /**
6590
+ * @public
5868
6591
  * <p>An auto-termination policy for an Amazon EMR cluster. An auto-termination policy
5869
6592
  * defines the amount of idle time in seconds after which a cluster automatically terminates.
5870
6593
  * For alternative cluster termination options, see <a href="https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-termination.html">Control cluster
@@ -5872,6 +6595,7 @@ export interface RunJobFlowInput {
5872
6595
  */
5873
6596
  AutoTerminationPolicy?: AutoTerminationPolicy;
5874
6597
  /**
6598
+ * @public
5875
6599
  * <p>Specifies a particular Amazon Linux release for all nodes in a cluster launch RunJobFlow
5876
6600
  * request. If a release is not specified, Amazon EMR uses the latest validated Amazon
5877
6601
  * Linux release for cluster launch.</p>