From 6be4ce45176adea49c6aa4ceada11545fe764575 Mon Sep 17 00:00:00 2001
From: awstools Adds an instance fleet to a running cluster. The instance fleet configuration is available only in Amazon EMR versions
+ * The instance fleet configuration is available only in Amazon EMR releases
* 4.8.0 and later, excluding 5.0.x. Cancels a pending step or steps in a running cluster. Available only in Amazon EMR versions 4.8.0 and later, excluding version 5.0.0. A maximum of 256 steps are allowed in
* each CancelSteps request. CancelSteps is idempotent but asynchronous; it does not guarantee
* that a step will be canceled, even if the request is successfully submitted. When you use
- * Amazon EMR versions 5.28.0 and later, you can cancel steps that are in a
+ * Amazon EMR releases 5.28.0 and later, you can cancel steps that are in a
* Provides EMR release label details, such as releases available the region where the API
- * request is run, and the available applications for a specific EMR release label. Can also
- * list EMR release versions that support a specified version of Spark. Provides Amazon EMR release label details, such as the releases available the
+ * Region where the API request is run, and the available applications for a specific Amazon EMR release label. Can also list Amazon EMR releases that support a
+ * specified version of Spark. Provides temporary, HTTP basic credentials that are associated with a given runtime IAM role
- * and used by a cluster with fine-grained access control activated. You can use these credentials to connect to cluster endpoints that support username and password authentication. Provides temporary, HTTP basic credentials that are associated with a given runtime
+ * IAM role and used by a cluster with fine-grained access control
+ * activated. You can use these credentials to connect to cluster endpoints that support
+ * username and password authentication. Lists all available details about the instance fleets in a cluster. The instance fleet configuration is available only in Amazon EMR versions
+ * The instance fleet configuration is available only in Amazon EMR releases
* 4.8.0 and later, excluding 5.0.x versions. Provides information for all active EC2 instances and EC2 instances terminated in the
- * last 30 days, up to a maximum of 2,000. EC2 instances in any of the following states are
- * considered active: AWAITING_FULFILLMENT, PROVISIONING, BOOTSTRAPPING, RUNNING. Provides information for all active Amazon EC2 instances and Amazon EC2
+ * instances terminated in the last 30 days, up to a maximum of 2,000. Amazon EC2
+ * instances in any of the following states are considered active: AWAITING_FULFILLMENT,
+ * PROVISIONING, BOOTSTRAPPING, RUNNING. Provides summaries of all notebook executions. You can filter the list based on multiple
* criteria such as status, time range, and editor id. Returns a maximum of 50 notebook
* executions and a marker to track the paging of a longer notebook execution list across
- * multiple PENDING
or RUNNING
state. In earlier versions of Amazon EMR, you can only cancel steps that are in a PENDING
state. ListNotebookExecution
calls.ListNotebookExecutions
calls.
Retrieves release labels of EMR services in the region where the API is called.
+ *Retrieves release labels of Amazon EMR services in the Region where the API is + * called.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-emr/src/commands/ModifyInstanceFleetCommand.ts b/clients/client-emr/src/commands/ModifyInstanceFleetCommand.ts index 8749164c14d7c..32a2f8666a44f 100644 --- a/clients/client-emr/src/commands/ModifyInstanceFleetCommand.ts +++ b/clients/client-emr/src/commands/ModifyInstanceFleetCommand.ts @@ -36,7 +36,7 @@ export interface ModifyInstanceFleetCommandOutput extends __MetadataBearer {} * specified InstanceFleetID within the cluster specified using ClusterID. The call either * succeeds or fails atomically. *The instance fleet configuration is available only in Amazon EMR versions + *
The instance fleet configuration is available only in Amazon EMR releases * 4.8.0 and later, excluding 5.0.x versions.
*Creates or updates an automatic scaling policy for a core instance group or task * instance group in an Amazon EMR cluster. The automatic scaling policy defines how - * an instance group dynamically adds and terminates EC2 instances in response to the value of - * a CloudWatch metric.
+ * an instance group dynamically adds and terminates Amazon EC2 instances in response + * to the value of a CloudWatch metric. * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-emr/src/commands/PutAutoTerminationPolicyCommand.ts b/clients/client-emr/src/commands/PutAutoTerminationPolicyCommand.ts index b7bc14f9c9bc1..74661b601feaa 100644 --- a/clients/client-emr/src/commands/PutAutoTerminationPolicyCommand.ts +++ b/clients/client-emr/src/commands/PutAutoTerminationPolicyCommand.ts @@ -33,7 +33,7 @@ export interface PutAutoTerminationPolicyCommandOutput extends PutAutoTerminatio /** * @public *Auto-termination is supported in Amazon EMR versions 5.30.0 and 6.1.0 and + *
Auto-termination is supported in Amazon EMR releases 5.30.0 and 6.1.0 and * later. For more information, see Using an * auto-termination policy.
*Creates or updates a managed scaling policy for an Amazon EMR cluster. The - * managed scaling policy defines the limits for resources, such as EC2 instances that can be - * added or terminated from a cluster. The policy only applies to the core and task nodes. The - * master node cannot be scaled after initial configuration.
+ * managed scaling policy defines the limits for resources, such as Amazon EC2 + * instances that can be added or terminated from a cluster. The policy only applies to the + * core and task nodes. The master node cannot be scaled after initial configuration. * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-emr/src/commands/RemoveAutoScalingPolicyCommand.ts b/clients/client-emr/src/commands/RemoveAutoScalingPolicyCommand.ts index 88ab2687b0159..5d9bb38529903 100644 --- a/clients/client-emr/src/commands/RemoveAutoScalingPolicyCommand.ts +++ b/clients/client-emr/src/commands/RemoveAutoScalingPolicyCommand.ts @@ -32,8 +32,7 @@ export interface RemoveAutoScalingPolicyCommandOutput extends RemoveAutoScalingP /** * @public - *Removes an automatic scaling policy from a specified instance group within an EMR - * cluster.
+ *Removes an automatic scaling policy from a specified instance group within an Amazon EMR cluster.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-emr/src/commands/RemoveManagedScalingPolicyCommand.ts b/clients/client-emr/src/commands/RemoveManagedScalingPolicyCommand.ts index 816a535ec7d69..dc8275e3720f6 100644 --- a/clients/client-emr/src/commands/RemoveManagedScalingPolicyCommand.ts +++ b/clients/client-emr/src/commands/RemoveManagedScalingPolicyCommand.ts @@ -32,7 +32,7 @@ export interface RemoveManagedScalingPolicyCommandOutput extends RemoveManagedSc /** * @public - *Removes a managed scaling policy from a specified EMR cluster.
+ *Removes a managed scaling policy from a specified Amazon EMR cluster.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-emr/src/commands/RunJobFlowCommand.ts b/clients/client-emr/src/commands/RunJobFlowCommand.ts index f8abee01fc48e..111759536b56e 100644 --- a/clients/client-emr/src/commands/RunJobFlowCommand.ts +++ b/clients/client-emr/src/commands/RunJobFlowCommand.ts @@ -50,7 +50,7 @@ export interface RunJobFlowCommandOutput extends RunJobFlowOutput, __MetadataBea * Hadoop. *For long-running clusters, we recommend that you periodically store your results.
*The instance fleets configuration is available only in Amazon EMR versions + *
The instance fleets configuration is available only in Amazon EMR releases * 4.8.0 and later, excluding 5.0.x versions. The RunJobFlow request can contain * InstanceFleets parameters or InstanceGroups parameters, but not both.
*SetTerminationProtection locks a cluster (job flow) so the EC2 instances in the cluster
- * cannot be terminated by user intervention, an API call, or in the event of a job-flow
- * error. The cluster still terminates upon successful completion of the job flow. Calling
- * SetTerminationProtection
on a cluster is similar to calling the Amazon EC2
- * DisableAPITermination
API on all EC2 instances in a cluster.
SetTerminationProtection locks a cluster (job flow) so the Amazon EC2 instances
+ * in the cluster cannot be terminated by user intervention, an API call, or in the event of a
+ * job-flow error. The cluster still terminates upon successful completion of the job flow.
+ * Calling SetTerminationProtection
on a cluster is similar to calling the
+ * Amazon EC2
+ * DisableAPITermination
API on all Amazon EC2 instances in a
+ * cluster.
* The SetVisibleToAllUsers parameter is no longer supported. Your cluster may be
- * visible to all users in your account. To restrict cluster access using an IAM policy, see Identity and Access
- * Management for EMR. SetTerminationProtection
is used to prevent accidental termination of a
* cluster and to ensure that in the event of an error, the instances persist so that you can
diff --git a/clients/client-emr/src/commands/SetVisibleToAllUsersCommand.ts b/clients/client-emr/src/commands/SetVisibleToAllUsersCommand.ts
index d8d74eb4279ec..df68823c5afaa 100644
--- a/clients/client-emr/src/commands/SetVisibleToAllUsersCommand.ts
+++ b/clients/client-emr/src/commands/SetVisibleToAllUsersCommand.ts
@@ -34,18 +34,17 @@ export interface SetVisibleToAllUsersCommandOutput extends __MetadataBearer {}
* @public
*
Sets the Cluster$VisibleToAllUsers value for an EMR cluster. When
- * true
, IAM principals in the Amazon Web Services account can perform EMR
- * cluster actions that their IAM policies allow. When false
, only
- * the IAM principal that created the cluster and the Amazon Web Services account root user can
- * perform EMR actions on the cluster, regardless of IAM permissions policies attached to
- * other IAM principals.
Sets the Cluster$VisibleToAllUsers value for an Amazon EMR
+ * cluster. When true
, IAM principals in the Amazon Web Services account can perform Amazon EMR cluster actions that their IAM policies allow. When false
, only the IAM
+ * principal that created the cluster and the Amazon Web Services account root user can perform
+ * Amazon EMR actions on the cluster, regardless of IAM permissions
+ * policies attached to other IAM principals.
This action works on running clusters. When you create a cluster, use the RunJobFlowInput$VisibleToAllUsers parameter.
- *For more information, see Understanding the EMR Cluster VisibleToAllUsers Setting in the - * Amazon EMRManagement Guide.
+ *For more information, see Understanding the Amazon EMR Cluster VisibleToAllUsers Setting in the + * Amazon EMR Management Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-emr/src/commands/StartNotebookExecutionCommand.ts b/clients/client-emr/src/commands/StartNotebookExecutionCommand.ts index ce0e018f129e5..7454cc107a752 100644 --- a/clients/client-emr/src/commands/StartNotebookExecutionCommand.ts +++ b/clients/client-emr/src/commands/StartNotebookExecutionCommand.ts @@ -40,14 +40,15 @@ export interface StartNotebookExecutionCommandOutput extends StartNotebookExecut * // const { EMRClient, StartNotebookExecutionCommand } = require("@aws-sdk/client-emr"); // CommonJS import * const client = new EMRClient(config); * const input = { // StartNotebookExecutionInput - * EditorId: "STRING_VALUE", // required - * RelativePath: "STRING_VALUE", // required + * EditorId: "STRING_VALUE", + * RelativePath: "STRING_VALUE", * NotebookExecutionName: "STRING_VALUE", * NotebookParams: "STRING_VALUE", * ExecutionEngine: { // ExecutionEngineConfig * Id: "STRING_VALUE", // required * Type: "EMR", * MasterInstanceSecurityGroupId: "STRING_VALUE", + * ExecutionRoleArn: "STRING_VALUE", * }, * ServiceRole: "STRING_VALUE", // required * NotebookInstanceSecurityGroupId: "STRING_VALUE", @@ -57,6 +58,18 @@ export interface StartNotebookExecutionCommandOutput extends StartNotebookExecut * Value: "STRING_VALUE", * }, * ], + * NotebookS3Location: { // NotebookS3LocationFromInput + * Bucket: "STRING_VALUE", + * Key: "STRING_VALUE", + * }, + * OutputNotebookS3Location: { // OutputNotebookS3LocationFromInput + * Bucket: "STRING_VALUE", + * Key: "STRING_VALUE", + * }, + * OutputNotebookFormat: "HTML", + * EnvironmentVariables: { // EnvironmentVariablesMap + * "TerminateJobFlows shuts a list of clusters (job flows) down. When a job flow is shut - * down, any step not yet completed is canceled and the EC2 instances on which the cluster is - * running are stopped. Any log files not already saved are uploaded to Amazon S3 if a - * LogUri was specified when the cluster was created.
+ * down, any step not yet completed is canceled and the Amazon EC2 instances on which + * the cluster is running are stopped. Any log files not already saved are uploaded to Amazon S3 if a LogUri was specified when the cluster was created. *The maximum number of clusters allowed is 10. The call to TerminateJobFlows
* is asynchronous. Depending on the configuration of the cluster, it may take up to 1-5
* minutes for the cluster to completely terminate and release allocated resources, such as
diff --git a/clients/client-emr/src/models/models_0.ts b/clients/client-emr/src/models/models_0.ts
index 3e826e1759f4f..7f3bf23f6746e 100644
--- a/clients/client-emr/src/models/models_0.ts
+++ b/clients/client-emr/src/models/models_0.ts
@@ -37,7 +37,8 @@ export type InstanceFleetType = (typeof InstanceFleetType)[keyof typeof Instance
/**
* @public
*
EBS volume specifications such as volume type, IOPS, size (GiB) and throughput (MiB/s) - * that are requested for the EBS volume attached to an EC2 instance in the cluster.
+ * that are requested for the EBS volume attached to an Amazon EC2 instance in the + * cluster. */ export interface VolumeSpecification { /** @@ -72,7 +73,8 @@ export interface VolumeSpecification { export interface EbsBlockDeviceConfig { /** *EBS volume specifications such as volume type, IOPS, size (GiB) and throughput (MiB/s) - * that are requested for the EBS volume attached to an EC2 instance in the cluster.
+ * that are requested for the EBS volume attached to an Amazon EC2 instance in the + * cluster. */ VolumeSpecification: VolumeSpecification | undefined; @@ -193,9 +195,9 @@ export interface OnDemandCapacityReservationOptions { *The launch specification for On-Demand Instances in the instance fleet, which * determines the allocation strategy.
*The instance fleet configuration is available only in Amazon EMR versions + *
The instance fleet configuration is available only in Amazon EMR releases * 4.8.0 and later, excluding 5.0.x versions. On-Demand Instances allocation strategy is - * available in Amazon EMR version 5.12.1 and later.
+ * available in Amazon EMR releases 5.12.1 and later. *The launch specification for Spot Instances in the instance fleet, which determines the * defined duration, provisioning timeout behavior, and allocation strategy.
*The instance fleet configuration is available only in Amazon EMR versions + *
The instance fleet configuration is available only in Amazon EMR releases * 4.8.0 and later, excluding 5.0.x versions. Spot Instance allocation strategy is - * available in Amazon EMR version 5.12.1 and later.
+ * available in Amazon EMR releases 5.12.1 and later. *Spot Instances with a defined duration (also known as Spot blocks) are no longer @@ -307,9 +309,9 @@ export interface SpotProvisioningSpecification { *
The launch specification for Spot Instances in the fleet, which determines the defined * duration, provisioning timeout behavior, and allocation strategy.
*The instance fleet configuration is available only in Amazon EMR versions + *
The instance fleet configuration is available only in Amazon EMR releases * 4.8.0 and later, excluding 5.0.x versions. On-Demand and Spot instance allocation - * strategies are available in Amazon EMR version 5.12.1 and later.
+ * strategies are available in Amazon EMR releases 5.12.1 and later. *The launch specification for On-Demand Instances in the instance fleet, which * determines the allocation strategy.
*The instance fleet configuration is available only in Amazon EMR versions + *
The instance fleet configuration is available only in Amazon EMR releases * 4.8.0 and later, excluding 5.0.x versions. On-Demand Instances allocation strategy is - * available in Amazon EMR version 5.12.1 and later.
+ * available in Amazon EMR releases 5.12.1 and later. *On-Demand resize timeout in minutes. If On-Demand Instances are not provisioned within * this time, the resize workflow stops. The minimum value is 5 minutes, and the maximum value * is 10,080 minutes (7 days). The timeout applies to all resize workflows on the Instance - * Fleet. The resize could be triggered by Amazon EMR Managed Scaling - * or by the customer (via Amazon EMR Console, Amazon EMR CLI - * modify-instance-fleet or Amazon EMR SDK ModifyInstanceFleet API) or by Amazon EMR due to Amazon EC2 Spot Reclamation.
+ * Fleet. The resize could be triggered by Amazon EMR Managed Scaling or by the + * customer (via Amazon EMR Console, Amazon EMR CLI modify-instance-fleet or + * Amazon EMR SDK ModifyInstanceFleet API) or by Amazon EMR due to Amazon EC2 Spot Reclamation. */ TimeoutDurationMinutes: number | undefined; } @@ -462,22 +464,22 @@ export class InvalidRequestException extends __BaseException { /** * @public - *The upper and lower EC2 instance limits for an automatic scaling policy. Automatic - * scaling activities triggered by automatic scaling rules will not cause an instance group to - * grow above or below these limits.
+ *The upper and lower Amazon EC2 instance limits for an automatic scaling policy. + * Automatic scaling activities triggered by automatic scaling rules will not cause an + * instance group to grow above or below these limits.
*/ export interface ScalingConstraints { /** - *The lower boundary of EC2 instances in an instance group below which scaling activities - * are not allowed to shrink. Scale-in activities will not terminate instances below this - * boundary.
+ *The lower boundary of Amazon EC2 instances in an instance group below which + * scaling activities are not allowed to shrink. Scale-in activities will not terminate + * instances below this boundary.
*/ MinCapacity: number | undefined; /** - *The upper boundary of EC2 instances in an instance group beyond which scaling activities - * are not allowed to grow. Scale-out activities will not add instances beyond this - * boundary.
+ *The upper boundary of Amazon EC2 instances in an instance group beyond which + * scaling activities are not allowed to grow. Scale-out activities will not add instances + * beyond this boundary.
*/ MaxCapacity: number | undefined; } @@ -514,33 +516,34 @@ export type AdjustmentType = (typeof AdjustmentType)[keyof typeof AdjustmentType /** * @public *An automatic scaling configuration, which describes how the policy adds or removes - * instances, the cooldown period, and the number of EC2 instances that will be added each - * time the CloudWatch metric alarm condition is satisfied.
+ * instances, the cooldown period, and the number of Amazon EC2 instances that will be + * added each time the CloudWatch metric alarm condition is satisfied. */ export interface SimpleScalingPolicyConfiguration { /** - *The way in which EC2 instances are added (if ScalingAdjustment
is a
- * positive number) or terminated (if ScalingAdjustment
is a negative number)
- * each time the scaling activity is triggered. CHANGE_IN_CAPACITY
is the
- * default. CHANGE_IN_CAPACITY
indicates that the EC2 instance count increments
- * or decrements by ScalingAdjustment
, which should be expressed as an integer.
+ *
The way in which Amazon EC2 instances are added (if
+ * ScalingAdjustment
is a positive number) or terminated (if
+ * ScalingAdjustment
is a negative number) each time the scaling activity is
+ * triggered. CHANGE_IN_CAPACITY
is the default. CHANGE_IN_CAPACITY
+ * indicates that the Amazon EC2 instance count increments or decrements by
+ * ScalingAdjustment
, which should be expressed as an integer.
* PERCENT_CHANGE_IN_CAPACITY
indicates the instance count increments or
* decrements by the percentage specified by ScalingAdjustment
, which should be
* expressed as an integer. For example, 20 indicates an increase in 20% increments of cluster
* capacity. EXACT_CAPACITY
indicates the scaling activity results in an instance
- * group with the number of EC2 instances specified by ScalingAdjustment
, which
- * should be expressed as a positive integer.
ScalingAdjustment
, which should be expressed as a positive integer.
*/
AdjustmentType?: AdjustmentType | string;
/**
* The amount by which to scale in or scale out, based on the specified
- * AdjustmentType
. A positive value adds to the instance group's EC2 instance
- * count while a negative number removes instances. If AdjustmentType
is set to
- * EXACT_CAPACITY
, the number should only be a positive integer. If
- * AdjustmentType
is set to PERCENT_CHANGE_IN_CAPACITY
, the value
- * should express the percentage as an integer. For example, -20 indicates a decrease in 20%
- * increments of cluster capacity.
AdjustmentType
. A positive value adds to the instance group's Amazon EC2 instance count while a negative number removes instances. If
+ * AdjustmentType
is set to EXACT_CAPACITY
, the number should
+ * only be a positive integer. If AdjustmentType
is set to
+ * PERCENT_CHANGE_IN_CAPACITY
, the value should express the percentage as an
+ * integer. For example, -20 indicates a decrease in 20% increments of cluster
+ * capacity.
*/
ScalingAdjustment: number | undefined;
@@ -695,9 +698,9 @@ export interface CloudWatchAlarmDefinition {
Namespace?: string;
/**
- * The period, in seconds, over which the statistic is applied. EMR CloudWatch metrics are
- * emitted every five minutes (300 seconds), so if an EMR CloudWatch metric is specified,
- * specify 300
.
The period, in seconds, over which the statistic is applied. CloudWatch metrics for
+ * Amazon EMR are emitted every five minutes (300 seconds), so if you specify a
+ * CloudWatch metric, specify 300
.
A scale-in or scale-out rule that defines scaling activity, including the CloudWatch - * metric alarm that triggers activity, how EC2 instances are added or removed, and the - * periodicity of adjustments. The automatic scaling policy for an instance group can comprise - * one or more automatic scaling rules.
+ * metric alarm that triggers activity, how Amazon EC2 instances are added or removed, + * and the periodicity of adjustments. The automatic scaling policy for an instance group can + * comprise one or more automatic scaling rules. */ export interface ScalingRule { /** @@ -772,13 +775,13 @@ export interface ScalingRule { * @public *An automatic scaling policy for a core instance group or task instance group in an * Amazon EMR cluster. An automatic scaling policy defines how an instance group - * dynamically adds and terminates EC2 instances in response to the value of a CloudWatch - * metric. See PutAutoScalingPolicy.
+ * dynamically adds and terminates Amazon EC2 instances in response to the value of a + * CloudWatch metric. See PutAutoScalingPolicy. */ export interface AutoScalingPolicy { /** - *The upper and lower EC2 instance limits for an automatic scaling policy. Automatic - * scaling activity will not cause an instance group to grow above or below these + *
The upper and lower Amazon EC2 instance limits for an automatic scaling policy. + * Automatic scaling activity will not cause an instance group to grow above or below these * limits.
*/ Constraints: ScalingConstraints | undefined; @@ -964,10 +967,10 @@ export interface AddJobFlowStepsInput { /** *The Amazon Resource Name (ARN) of the runtime role for a step on the cluster. The
- * runtime role can be a cross-account IAM role. The runtime role ARN is a combination of
- * account ID, role name, and role type using the following format:
+ * runtime role can be a cross-account IAM role. The runtime role ARN is a
+ * combination of account ID, role name, and role type using the following format:
* arn:partition:service:region:account:resource
.
For example, arn:aws:iam::1234567890:role/ReadOnly
is a correctly formatted
+ *
For example, arn:aws:IAM::1234567890:role/ReadOnly
is a correctly formatted
* runtime role ARN.
An automatic scaling policy for a core instance group or task instance group in an * Amazon EMR cluster. The automatic scaling policy defines how an instance group - * dynamically adds and terminates EC2 instances in response to the value of a CloudWatch - * metric. See PutAutoScalingPolicy.
+ * dynamically adds and terminates Amazon EC2 instances in response to the value of a + * CloudWatch metric. See PutAutoScalingPolicy. */ export interface AutoScalingPolicyDescription { /** @@ -1163,8 +1166,8 @@ export interface AutoScalingPolicyDescription { Status?: AutoScalingPolicyStatus; /** - *The upper and lower EC2 instance limits for an automatic scaling policy. Automatic - * scaling activity will not cause an instance group to grow above or below these + *
The upper and lower Amazon EC2 instance limits for an automatic scaling policy. + * Automatic scaling activity will not cause an instance group to grow above or below these * limits.
*/ Constraints?: ScalingConstraints; @@ -1358,8 +1361,9 @@ export interface CancelStepsOutput { /** * @public - *Provides information about the EC2 instances in a cluster grouped by category. For - * example, key name, subnet ID, IAM instance profile, and so on.
+ *Provides information about the Amazon EC2 instances in a cluster grouped by + * category. For example, key name, subnet ID, IAM instance profile, and so + * on.
*/ export interface Ec2InstanceAttributes { /** @@ -1377,15 +1381,16 @@ export interface Ec2InstanceAttributes { /** *Applies to clusters configured with the instance fleets option. Specifies the unique
- * identifier of one or more Amazon EC2 subnets in which to launch EC2 cluster
- * instances. Subnets must exist within the same VPC. Amazon EMR chooses the EC2
- * subnet with the best fit from among the list of RequestedEc2SubnetIds
, and
- * then launches all cluster instances within that Subnet. If this value is not specified, and
- * the account and Region support EC2-Classic networks, the cluster launches instances in the
- * EC2-Classic network and uses RequestedEc2AvailabilityZones
instead of this
- * setting. If EC2-Classic is not supported, and no Subnet is specified, Amazon EMR
- * chooses the subnet for you. RequestedEc2SubnetIDs
and
- * RequestedEc2AvailabilityZones
cannot be specified together.
RequestedEc2SubnetIds
, and then launches all cluster instances within that
+ * Subnet. If this value is not specified, and the account and Region support EC2-Classic
+ * networks, the cluster launches instances in the EC2-Classic network and uses
+ * RequestedEc2AvailabilityZones
instead of this setting. If EC2-Classic is
+ * not supported, and no Subnet is specified, Amazon EMR chooses the subnet for you.
+ * RequestedEc2SubnetIDs
and RequestedEc2AvailabilityZones
cannot
+ * be specified together.
*/
RequestedEc2SubnetIds?: string[];
@@ -1396,19 +1401,19 @@ export interface Ec2InstanceAttributes {
/**
* Applies to clusters configured with the instance fleets option. Specifies one or more
- * Availability Zones in which to launch EC2 cluster instances when the EC2-Classic network
- * configuration is supported. Amazon EMR chooses the Availability Zone with the best
- * fit from among the list of RequestedEc2AvailabilityZones
, and then launches
- * all cluster instances within that Availability Zone. If you do not specify this value,
- * Amazon EMR chooses the Availability Zone for you.
+ * Availability Zones in which to launch Amazon EC2 cluster instances when the
+ * EC2-Classic network configuration is supported. Amazon EMR chooses the Availability
+ * Zone with the best fit from among the list of RequestedEc2AvailabilityZones
,
+ * and then launches all cluster instances within that Availability Zone. If you do not
+ * specify this value, Amazon EMR chooses the Availability Zone for you.
* RequestedEc2SubnetIDs
and RequestedEc2AvailabilityZones
cannot
* be specified together.
The IAM role that was specified when the cluster was launched. The EC2 instances of the - * cluster assume this role.
+ *The IAM role that was specified when the cluster was launched. The + * Amazon EC2 instances of the cluster assume this role.
*/ IamInstanceProfile?: string; @@ -1515,19 +1520,19 @@ export type PlacementGroupStrategy = (typeof PlacementGroupStrategy)[keyof typeo * specifies the placement strategy that can be applied to instance roles during cluster * creation. *To use this configuration, consider attaching managed policy - * AmazonElasticMapReducePlacementGroupPolicy to the EMR role.
+ * AmazonElasticMapReducePlacementGroupPolicy to the Amazon EMR role. */ export interface PlacementGroupConfig { /** *Role of the instance in the cluster.
- *Starting with Amazon EMR version 5.23.0, the only supported instance role is + *
Starting with Amazon EMR release 5.23.0, the only supported instance role is
* MASTER
.
EC2 Placement Group strategy associated with instance role.
- *Starting with Amazon EMR version 5.23.0, the only supported placement strategy + *
Amazon EC2 Placement Group strategy associated with instance role.
+ *Starting with Amazon EMR release 5.23.0, the only supported placement strategy
* is SPREAD
for the MASTER
instance role.
A tuple that provides information about an error that caused a cluster to terminate.
+ *A tuple that provides information about an error that caused a cluster to + * terminate.
*/ export interface ErrorDetail { /** - *The name or code that's associated with the error.
+ *The name or code associated with the error.
*/ ErrorCode?: string; /** - *A list of key value pairs that provide contextual information to explain why the error may have occured.
+ *A list of key value pairs that provides contextual information about why an error + * occured.
*/ ErrorData?: RecordA message describing the error that occured.
+ *A message that describes the error.
*/ ErrorMessage?: string; } @@ -1681,7 +1688,9 @@ export interface ClusterStatus { Timeline?: ClusterTimeline; /** - *A list of tuples that provide information about the errors that caused a cluster termination. This structure may have up to 10 different ErrorDetail
tuples.
A list of tuples that provides information about the errors that caused a cluster to
+ * terminate. This structure can contain up to 10 different ErrorDetail
+ * tuples.
An approximation of the cost of the cluster, represented in m1.small/hours. This value * is incremented one time for every hour an m1.small instance runs. Larger instances are - * weighted more, so an EC2 instance that is roughly four times more expensive would result in - * the normalized instance hours being incremented by four. This result is only an - * approximation and does not reflect the actual billing rate.
+ * weighted more, so an Amazon EC2 instance that is roughly four times more expensive + * would result in the normalized instance hours being incremented by four. This result is + * only an approximation and does not reflect the actual billing rate. */ NormalizedInstanceHours?: number; @@ -1764,9 +1773,9 @@ export type ComputeLimitsUnitType = (typeof ComputeLimitsUnitType)[keyof typeof /** * @public - *The EC2 unit limits for a managed scaling policy. The managed scaling activity of a - * cluster can not be above or below these limits. The limit only applies to the core and task - * nodes. The master node cannot be scaled after initial configuration.
+ *The Amazon EC2 unit limits for a managed scaling policy. The managed scaling + * activity of a cluster can not be above or below these limits. The limit only applies to the + * core and task nodes. The master node cannot be scaled after initial configuration.
*/ export interface ComputeLimits { /** @@ -1775,34 +1784,34 @@ export interface ComputeLimits { UnitType: ComputeLimitsUnitType | string | undefined; /** - *The lower boundary of EC2 units. It is measured through vCPU cores or instances for - * instance groups and measured through units for instance fleets. Managed scaling activities - * are not allowed beyond this boundary. The limit only applies to the core and task nodes. - * The master node cannot be scaled after initial configuration.
+ *The lower boundary of Amazon EC2 units. It is measured through vCPU cores or + * instances for instance groups and measured through units for instance fleets. Managed + * scaling activities are not allowed beyond this boundary. The limit only applies to the core + * and task nodes. The master node cannot be scaled after initial configuration.
*/ MinimumCapacityUnits: number | undefined; /** - *The upper boundary of EC2 units. It is measured through vCPU cores or instances for - * instance groups and measured through units for instance fleets. Managed scaling activities - * are not allowed beyond this boundary. The limit only applies to the core and task nodes. - * The master node cannot be scaled after initial configuration.
+ *The upper boundary of Amazon EC2 units. It is measured through vCPU cores or + * instances for instance groups and measured through units for instance fleets. Managed + * scaling activities are not allowed beyond this boundary. The limit only applies to the core + * and task nodes. The master node cannot be scaled after initial configuration.
*/ MaximumCapacityUnits: number | undefined; /** - *The upper boundary of On-Demand EC2 units. It is measured through vCPU cores or - * instances for instance groups and measured through units for instance fleets. The On-Demand - * units are not allowed to scale beyond this boundary. The parameter is used to split - * capacity allocation between On-Demand and Spot Instances.
+ *The upper boundary of On-Demand Amazon EC2 units. It is measured through vCPU + * cores or instances for instance groups and measured through units for instance fleets. The + * On-Demand units are not allowed to scale beyond this boundary. The parameter is used to + * split capacity allocation between On-Demand and Spot Instances.
*/ MaximumOnDemandCapacityUnits?: number; /** - *The upper boundary of EC2 units for core node type in a cluster. It is measured through - * vCPU cores or instances for instance groups and measured through units for instance fleets. - * The core units are not allowed to scale beyond this boundary. The parameter is used to - * split capacity allocation between core and task nodes.
+ *The upper boundary of Amazon EC2 units for core node type in a cluster. It is + * measured through vCPU cores or instances for instance groups and measured through units for + * instance fleets. The core units are not allowed to scale beyond this boundary. The + * parameter is used to split capacity allocation between core and task nodes.
*/ MaximumCoreCapacityUnits?: number; } @@ -1873,17 +1882,16 @@ export interface CreateStudioInput { SubnetIds: string[] | undefined; /** - *The IAM role that the Amazon EMR Studio assumes. The service role provides a way - * for Amazon EMR Studio to interoperate with other Amazon Web Services + *
The IAM role that the Amazon EMR Studio assumes. The service role + * provides a way for Amazon EMR Studio to interoperate with other Amazon Web Services * services.
*/ ServiceRole: string | undefined; /** - *The IAM user role that users and groups assume when logged in to an Amazon EMR
- * Studio. Only specify a UserRole
when you use IAM Identity Center
- * authentication. The permissions attached to the UserRole
can be scoped down
- * for each user or group using session policies.
The IAM user role that users and groups assume when logged in to an
+ * Amazon EMR Studio. Only specify a UserRole
when you use IAM Identity Center authentication. The permissions attached to the UserRole
can be
+ * scoped down for each user or group using session policies.
The Amazon Resource Name (ARN) for the session policy that will be applied to the user * or group. You should specify the ARN for the session policy that you want to apply, not the - * ARN of your user role. For more information, see Create an EMR Studio User - * Role with Session Policies.
+ * ARN of your user role. For more information, see Create an Amazon EMR + * Studio User Role with Session Policies. */ SessionPolicyArn: string | undefined; } @@ -2007,19 +2015,22 @@ export interface CreateStudioSessionMappingInput { */ export interface UsernamePassword { /** - *The username associated with the temporary credentials that you use to connect to cluster endpoints.
+ *The username associated with the temporary credentials that you use to connect to + * cluster endpoints.
*/ Username?: string; /** - *The password associated with the temporary credentials that you use to connect to cluster endpoints.
+ *The password associated with the temporary credentials that you use to connect to + * cluster endpoints.
*/ Password?: string; } /** * @public - *The credentials that you can use to connect to cluster endpoints. Credentials consist of a username and a password.
+ *The credentials that you can use to connect to cluster endpoints. Credentials consist of + * a username and a password.
*/ export type Credentials = Credentials.UsernamePasswordMember | Credentials.$UnknownMember; @@ -2238,7 +2249,7 @@ export interface InstanceGroupDetail { Name?: string; /** - *Market type of the EC2 instances used to create a cluster node.
+ *Market type of the Amazon EC2 instances used to create a cluster node.
*/ Market: MarketType | string | undefined; @@ -2255,7 +2266,7 @@ export interface InstanceGroupDetail { BidPrice?: string; /** - *EC2 instance type.
+ *Amazon EC2 instance type.
*/ InstanceType: string | undefined; @@ -2324,7 +2335,7 @@ export interface PlacementType { * for instance fleets, whileAvailabilityZone
(singular) is used for uniform
* instance groups.
* The instance fleet configuration is available only in Amazon EMR versions + *
The instance fleet configuration is available only in Amazon EMR releases * 4.8.0 and later, excluding 5.0.x versions.
*The KMS key used for encrypting log files. This attribute is only - * available with EMR version 5.30.0 and later, excluding EMR 6.0.0.
+ * available with Amazon EMR 5.30.0 and later, excluding 6.0.0. */ LogEncryptionKmsKeyId?: string; @@ -2540,33 +2551,34 @@ export interface JobFlowDetail { SupportedProducts?: string[]; /** - *Indicates whether the cluster is visible to IAM principals in the Amazon Web Services account associated with the cluster. When true
, IAM principals
- * in the Amazon Web Services account can perform EMR cluster actions that their IAM policies
- * allow. When false
, only the IAM principal that created the cluster and the
- * Amazon Web Services account root user can perform EMR actions, regardless of IAM
+ *
Indicates whether the cluster is visible to IAM principals in the Amazon Web Services account associated with the cluster. When true
, IAM principals in the Amazon Web Services account can perform Amazon EMR cluster
+ * actions that their IAM policies allow. When false
, only the
+ * IAM principal that created the cluster and the Amazon Web Services account
+ * root user can perform Amazon EMR actions, regardless of IAM
* permissions policies attached to other IAM principals.
The default value is true
if a value is not provided when creating a
- * cluster using the EMR API RunJobFlow command, the CLI
+ * cluster using the Amazon EMR API RunJobFlow command, the CLI
* create-cluster command, or the Amazon Web Services Management Console.
The IAM role that was specified when the job flow was launched. The EC2 instances of the - * job flow assume this role.
+ *The IAM role that was specified when the job flow was launched. The + * Amazon EC2 instances of the job flow assume this role.
*/ JobFlowRole?: string; /** - *The IAM role that is assumed by the Amazon EMR service to access Amazon Web Services resources on your behalf.
+ *The IAM role that is assumed by the Amazon EMR service to access + * Amazon Web Services resources on your behalf.
*/ ServiceRole?: string; /** *An IAM role for automatic scaling policies. The default role is
- * EMR_AutoScaling_DefaultRole
. The IAM role provides a way for the automatic
- * scaling feature to get the required permissions it needs to launch and terminate EC2
- * instances in an instance group.
EMR_AutoScaling_DefaultRole
. The IAM role provides a way for
+ * the automatic scaling feature to get the required permissions it needs to launch and
+ * terminate Amazon EC2 instances in an instance group.
*/
AutoScalingRole?: string;
@@ -2580,7 +2592,7 @@ export interface JobFlowDetail {
* TERMINATE_AT_TASK_COMPLETION
indicates that Amazon EMR adds nodes
* to a deny list and drains tasks from nodes before terminating the Amazon EC2
* instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to
- * HDFS corruption. TERMINATE_AT_TASK_COMPLETION
available only in Amazon EMR version 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.
+ * HDFS corruption. TERMINATE_AT_TASK_COMPLETION
available only in Amazon EMR releases 4.1.0 and later, and is the default for releases of Amazon EMR earlier than 5.1.0.
*/
ScaleDownBehavior?: ScaleDownBehavior | string;
}
@@ -2622,28 +2634,80 @@ export type ExecutionEngineType = (typeof ExecutionEngineType)[keyof typeof Exec
/**
* @public
* Specifies the execution engine (cluster) to run the notebook and perform the notebook - * execution, for example, an EMR cluster.
+ * execution, for example, an Amazon EMR cluster. */ export interface ExecutionEngineConfig { /** - *The unique identifier of the execution engine. For an EMR cluster, this is the cluster - * ID.
+ *The unique identifier of the execution engine. For an Amazon EMR cluster, this + * is the cluster ID.
*/ Id: string | undefined; /** - *The type of execution engine. A value of EMR
specifies an EMR
- * cluster.
The type of execution engine. A value of EMR
specifies an Amazon EMR cluster.
An optional unique ID of an EC2 security group to associate with the master instance of - * the EMR cluster for this notebook execution. For more information see Specifying - * EC2 Security Groups for EMR Notebooks in the EMR Management - * Guide.
+ *An optional unique ID of an Amazon EC2 security group to associate with the + * master instance of the Amazon EMR cluster for this notebook execution. For more + * information see Specifying + * Amazon EC2 Security Groups for Amazon EMR Notebooks in the + * EMR Management Guide.
*/ MasterInstanceSecurityGroupId?: string; + + /** + *The execution role ARN required for the notebook execution.
+ */ + ExecutionRoleArn?: string; +} + +/** + * @public + *The Amazon S3 location that stores the notebook execution input.
+ */ +export interface NotebookS3LocationForOutput { + /** + *The Amazon S3 bucket that stores the notebook execution input.
+ */ + Bucket?: string; + + /** + *The key to the Amazon S3 location that stores the notebook execution + * input.
+ */ + Key?: string; +} + +/** + * @public + * @enum + */ +export const OutputNotebookFormat = { + HTML: "HTML", +} as const; + +/** + * @public + */ +export type OutputNotebookFormat = (typeof OutputNotebookFormat)[keyof typeof OutputNotebookFormat]; + +/** + * @public + *The Amazon S3 location that stores the notebook execution output.
+ */ +export interface OutputNotebookS3LocationForOutput { + /** + *The Amazon S3 bucket that stores the notebook execution output.
+ */ + Bucket?: string; + + /** + *The key to the Amazon S3 location that stores the notebook execution + * output.
+ */ + Key?: string; } /** @@ -2670,8 +2734,8 @@ export type NotebookExecutionStatus = (typeof NotebookExecutionStatus)[keyof typ /** * @public - *A notebook execution. An execution is a specific instance that an EMR Notebook is run
- * using the StartNotebookExecution
action.
A notebook execution. An execution is a specific instance that an Amazon EMR
+ * Notebook is run using the StartNotebookExecution
action.
The unique identifier of the EMR Notebook that is used for the notebook + *
The unique identifier of the Amazon EMR Notebook that is used for the notebook * execution.
*/ EditorId?: string; /** - *The execution engine, such as an EMR cluster, used to run the EMR notebook and perform - * the notebook execution.
+ *The execution engine, such as an Amazon EMR cluster, used to run the Amazon EMR notebook and perform the notebook execution.
*/ ExecutionEngine?: ExecutionEngineConfig; @@ -2697,7 +2760,7 @@ export interface NotebookExecution { NotebookExecutionName?: string; /** - *Input parameters in JSON format passed to the EMR Notebook at runtime for + *
Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for * execution.
*/ NotebookParams?: string; @@ -2784,10 +2847,10 @@ export interface NotebookExecution { LastStateChangeReason?: string; /** - *The unique identifier of the EC2 security group associated with the EMR Notebook - * instance. For more information see Specifying - * EC2 Security Groups for EMR Notebooks in the EMR Management - * Guide.
+ *The unique identifier of the Amazon EC2 security group associated with the + * Amazon EMR Notebook instance. For more information see Specifying + * Amazon EC2 Security Groups for Amazon EMR Notebooks in the + * Amazon EMR Management Guide.
*/ NotebookInstanceSecurityGroupId?: string; @@ -2797,6 +2860,26 @@ export interface NotebookExecution { * optional value string with a maximum of 256 characters. */ Tags?: Tag[]; + + /** + *The Amazon S3 location that stores the notebook execution input.
+ */ + NotebookS3Location?: NotebookS3LocationForOutput; + + /** + *The Amazon S3 location for the notebook execution output.
+ */ + OutputNotebookS3Location?: OutputNotebookS3LocationForOutput; + + /** + *The output format for the notebook execution.
+ */ + OutputNotebookFormat?: OutputNotebookFormat | string; + + /** + *The environment variables associated with the notebook execution.
+ */ + EnvironmentVariables?: RecordThe Amazon Resource Name (ARN) of the runtime role for a step on the cluster. The
- * runtime role can be a cross-account IAM role. The runtime role ARN is a combination of
- * account ID, role name, and role type using the following format:
+ * runtime role can be a cross-account IAM role. The runtime role ARN is a
+ * combination of account ID, role name, and role type using the following format:
* arn:partition:service:region:account:resource
.
For example, arn:aws:iam::1234567890:role/ReadOnly
is a correctly formatted
+ *
For example, arn:aws:IAM::1234567890:role/ReadOnly
is a correctly formatted
* runtime role ARN.
Specifies whether the Amazon EMR Studio authenticates users using IAM or IAM Identity Center.
+ *Specifies whether the Amazon EMR Studio authenticates users with IAM or IAM Identity Center.
*/ AuthMode?: AuthMode | string; @@ -3214,9 +3297,7 @@ export interface Studio { ServiceRole?: string; /** - *The name of the IAM role assumed by users logged in to the Amazon EMR Studio. A
- * Studio only requires a UserRole
when you use IAM
- * authentication.
The name of the IAM role assumed by users logged in to the Amazon EMR Studio. A Studio only requires a UserRole
when you use IAM authentication.
EBS volume specifications such as volume type, IOPS, size (GiB) and throughput (MiB/s) - * that are requested for the EBS volume attached to an EC2 instance in the cluster.
+ * that are requested for the EBS volume attached to an Amazon EC2 instance in the + * cluster. */ VolumeSpecification?: VolumeSpecification; @@ -3297,7 +3379,7 @@ export interface EbsBlockDevice { /** * @public - *EBS block device that's attached to an EC2 instance.
+ *EBS block device that's attached to an Amazon EC2 instance.
*/ export interface EbsVolume { /** @@ -3348,9 +3430,10 @@ export interface GetClusterSessionCredentialsInput { ClusterId: string | undefined; /** - *The Amazon Resource Name (ARN) of the runtime role for interactive workload submission on the cluster.
- * The runtime role can be a cross-account IAM role. The runtime role ARN is a combination of account ID, role name,
- * and role type using the following format: arn:partition:service:region:account:resource
.
The Amazon Resource Name (ARN) of the runtime role for interactive workload submission
+ * on the cluster. The runtime role can be a cross-account IAM role. The
+ * runtime role ARN is a combination of account ID, role name, and role type using the
+ * following format: arn:partition:service:region:account:resource
.
The credentials that you can use to connect to cluster endpoints that support username and password authentication.
+ *The credentials that you can use to connect to cluster endpoints that support username + * and password authentication.
*/ Credentials?: Credentials; /** - *The time when the credentials that are returned by the GetClusterSessionCredentials
API expire.
The time when the credentials that are returned by the
+ * GetClusterSessionCredentials
API expire.
The EC2 unit limits for a managed scaling policy. The managed scaling activity of a - * cluster is not allowed to go above or below these limits. The limit only applies to the - * core and task nodes. The master node cannot be scaled after initial configuration.
+ *The Amazon EC2 unit limits for a managed scaling policy. The managed scaling + * activity of a cluster is not allowed to go above or below these limits. The limit only + * applies to the core and task nodes. The master node cannot be scaled after initial + * configuration.
*/ ComputeLimits?: ComputeLimits; } @@ -3626,7 +3712,7 @@ export type InstanceFleetStateChangeReasonCode = * @public *Provides status change reason details for the instance fleet.
*The instance fleet configuration is available only in Amazon EMR versions + *
The instance fleet configuration is available only in Amazon EMR releases * 4.8.0 and later, excluding 5.0.x versions.
*Provides historical timestamps for the instance fleet, including the time of creation, * the time it became ready to run jobs, and the time of termination.
*The instance fleet configuration is available only in Amazon EMR versions + *
The instance fleet configuration is available only in Amazon EMR releases * 4.8.0 and later, excluding 5.0.x versions.
*The status of the instance fleet.
*The instance fleet configuration is available only in Amazon EMR versions + *
The instance fleet configuration is available only in Amazon EMR releases * 4.8.0 and later, excluding 5.0.x versions.
*
- * PROVISIONING
—The instance fleet is provisioning EC2 resources and is
- * not yet ready to run jobs.
PROVISIONING
—The instance fleet is provisioning Amazon EC2
+ * resources and is not yet ready to run jobs.
*
- * BOOTSTRAPPING
—EC2 instances and other resources have been provisioned
- * and the bootstrap actions specified for the instances are underway.
BOOTSTRAPPING
—Amazon EC2 instances and other resources have
+ * been provisioned and the bootstrap actions specified for the instances are
+ * underway.
*
- * RUNNING
—EC2 instances and other resources are running. They are
- * either executing jobs or waiting to execute jobs.
RUNNING
—Amazon EC2 instances and other resources are running.
+ * They are either executing jobs or waiting to execute jobs.
*
- * RESIZING
—A resize operation is underway. EC2 instances are either
- * being added or removed.
RESIZING
—A resize operation is underway. Amazon EC2 instances
+ * are either being added or removed.
*
- * SUSPENDED
—A resize operation could not complete. Existing EC2
- * instances are running, but instances can't be added or removed.
SUSPENDED
—A resize operation could not complete. Existing Amazon EC2 instances are running, but instances can't be added or removed.
*
- * TERMINATING
—The instance fleet is terminating EC2 instances.
TERMINATING
—The instance fleet is terminating Amazon EC2
+ * instances.
*
- * TERMINATED
—The instance fleet is no longer active, and all EC2
- * instances have been terminated.
TERMINATED
—The instance fleet is no longer active, and all Amazon EC2 instances have been terminated.
* Represents an EC2 instance provisioned as part of cluster.
+ *Represents an Amazon EC2 instance provisioned as part of cluster.
*/ export interface Instance { /** @@ -4059,7 +4145,8 @@ export interface Instance { InstanceGroupId?: string; /** - *The unique identifier of the instance fleet to which an EC2 instance belongs.
+ *The unique identifier of the instance fleet to which an Amazon EC2 instance + * belongs.
*/ InstanceFleetId?: string; @@ -4070,7 +4157,7 @@ export interface Instance { Market?: MarketType | string; /** - *The EC2 instance type, for example m3.xlarge
.
The Amazon EC2 instance type, for example m3.xlarge
.
The unique ID of the execution engine.
+ */ + ExecutionEngineId?: string; } /** @@ -4267,6 +4359,16 @@ export interface NotebookExecutionSummary { *The timestamp when notebook execution started.
*/ EndTime?: Date; + + /** + *The Amazon S3 location that stores the notebook execution input.
+ */ + NotebookS3Location?: NotebookS3LocationForOutput; + + /** + *The unique ID of the execution engine for the notebook execution.
+ */ + ExecutionEngineId?: string; } /** @@ -4485,8 +4587,8 @@ export interface ListStudiosInput { /** * @public *Details for an Amazon EMR Studio, including ID, Name, VPC, and Description. The - * details do not include subnets, IAM roles, security groups, or tags associated with the - * Studio.
+ * details do not include subnets, IAM roles, security groups, or tags + * associated with the Studio. */ export interface StudioSummary { /** @@ -4651,7 +4753,7 @@ export interface ModifyClusterOutput { * @public *Configuration parameters for an instance fleet modification request.
*The instance fleet configuration is available only in Amazon EMR versions + *
The instance fleet configuration is available only in Amazon EMR releases * 4.8.0 and later, excluding 5.0.x versions.
*Specifies the ID of an EMR cluster where the managed scaling policy is attached.
+ *Specifies the ID of an Amazon EMR cluster where the managed scaling policy is + * attached.
*/ ClusterId: string | undefined; @@ -4881,9 +4984,8 @@ export interface RemoveTagsOutput {} /** * @public - *The list of supported product configurations that allow user-supplied arguments. EMR - * accepts these arguments and forwards them to the corresponding installation script as - * bootstrap action arguments.
+ *The list of supported product configurations that allow user-supplied arguments. Amazon EMR accepts these arguments and forwards them to the corresponding installation + * script as bootstrap action arguments.
*/ export interface SupportedProductConfig { /** @@ -4942,34 +5044,71 @@ export interface SetVisibleToAllUsersInput { JobFlowIds: string[] | undefined; /** - *A value of true
indicates that an IAM principal in the Amazon Web Services account can perform EMR actions on the cluster that the IAM policies attached
- * to the principal allow. A value of false
indicates that only the IAM principal
- * that created the cluster and the Amazon Web Services root user can perform EMR actions on
- * the cluster.
A value of true
indicates that an IAM principal in the
+ * Amazon Web Services account can perform Amazon EMR actions on the cluster that
+ * the IAM policies attached to the principal allow. A value of
+ * false
indicates that only the IAM principal that created the
+ * cluster and the Amazon Web Services root user can perform Amazon EMR actions on the
+ * cluster.
The Amazon S3 location that stores the notebook execution input.
+ */ +export interface NotebookS3LocationFromInput { + /** + *The Amazon S3 bucket that stores the notebook execution input.
+ */ + Bucket?: string; + + /** + *The key to the Amazon S3 location that stores the notebook execution + * input.
+ */ + Key?: string; +} + +/** + * @public + *The Amazon S3 location that stores the notebook execution output.
+ */ +export interface OutputNotebookS3LocationFromInput { + /** + *The Amazon S3 bucket that stores the notebook execution output.
+ */ + Bucket?: string; + + /** + *The key to the Amazon S3 location that stores the notebook execution + * output.
+ */ + Key?: string; +} + /** * @public */ export interface StartNotebookExecutionInput { /** - *The unique identifier of the EMR Notebook to use for notebook execution.
+ *The unique identifier of the Amazon EMR Notebook to use for notebook + * execution.
*/ - EditorId: string | undefined; + EditorId?: string; /** *The path and file name of the notebook file for this execution, relative to the path
- * specified for the EMR Notebook. For example, if you specify a path of
- * s3://MyBucket/MyNotebooks
when you create an EMR Notebook for a notebook
- * with an ID of e-ABCDEFGHIJK1234567890ABCD
(the EditorID
of this
- * request), and you specify a RelativePath
of
+ * specified for the Amazon EMR Notebook. For example, if you specify a path of
+ * s3://MyBucket/MyNotebooks
when you create an Amazon EMR Notebook
+ * for a notebook with an ID of e-ABCDEFGHIJK1234567890ABCD
(the
+ * EditorID
of this request), and you specify a RelativePath
of
* my_notebook_executions/notebook_execution.ipynb
, the location of the file
* for the notebook execution is
* s3://MyBucket/MyNotebooks/e-ABCDEFGHIJK1234567890ABCD/my_notebook_executions/notebook_execution.ipynb
.
An optional name for the notebook execution.
@@ -4977,7 +5116,7 @@ export interface StartNotebookExecutionInput { NotebookExecutionName?: string; /** - *Input parameters in JSON format passed to the EMR Notebook at runtime for + *
Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for * execution.
*/ NotebookParams?: string; @@ -4988,14 +5127,14 @@ export interface StartNotebookExecutionInput { ExecutionEngine: ExecutionEngineConfig | undefined; /** - *The name or ARN of the IAM role that is used as the service role for Amazon EMR - * (the EMR role) for the notebook execution.
+ *The name or ARN of the IAM role that is used as the service role for + * Amazon EMR (the Amazon EMR role) for the notebook execution.
*/ ServiceRole: string | undefined; /** - *The unique identifier of the Amazon EC2 security group to associate with the EMR - * Notebook for this notebook execution.
+ *The unique identifier of the Amazon EC2 security group to associate with the + * Amazon EMR Notebook for this notebook execution.
*/ NotebookInstanceSecurityGroupId?: string; @@ -5005,6 +5144,26 @@ export interface StartNotebookExecutionInput { * optional value string with a maximum of 256 characters. */ Tags?: Tag[]; + + /** + *The Amazon S3 location for the notebook execution input.
+ */ + NotebookS3Location?: NotebookS3LocationFromInput; + + /** + *The Amazon S3 location for the notebook execution output.
+ */ + OutputNotebookS3Location?: OutputNotebookS3LocationFromInput; + + /** + *The output format for the notebook execution.
+ */ + OutputNotebookFormat?: OutputNotebookFormat | string; + + /** + *The environment variables associated with the notebook execution.
+ */ + EnvironmentVariables?: RecordIndicates whether Amazon EMR block public access is enabled (true
)
* or disabled (false
). By default, the value is false
for accounts
- * that have created EMR clusters before July 2019. For accounts created after this, the
- * default is true
.
true
.
*/
BlockPublicSecurityGroupRules: boolean | undefined;
@@ -5158,8 +5317,8 @@ export interface BlockPublicAccessConfiguration {
* allows cluster creation if a security group associated with the cluster has a rule that
* allows inbound traffic on Port 23 from IPv4 0.0.0.0/0 or IPv6 port ::/0 as the
* source.
- * By default, Port 22, which is used for SSH access to the cluster EC2 instances, is in
- * the list of PermittedPublicSecurityGroupRuleRanges
.
By default, Port 22, which is used for SSH access to the cluster Amazon EC2
+ * instances, is in the list of PermittedPublicSecurityGroupRuleRanges
.
Provides information about the EC2 instances in a cluster grouped by category. For - * example, key name, subnet ID, IAM instance profile, and so on.
+ *Provides information about the Amazon EC2 instances in a cluster grouped by + * category. For example, key name, subnet ID, IAM instance profile, and so + * on.
*/ Ec2InstanceAttributes?: Ec2InstanceAttributes; /** *The instance fleet configuration is available only in Amazon EMR versions + *
The instance fleet configuration is available only in Amazon EMR releases * 4.8.0 and later, excluding 5.0.x versions.
*The instance group configuration of the cluster. A value of INSTANCE_GROUP
@@ -5224,7 +5384,8 @@ export interface Cluster {
/**
*
The KMS key used for encrypting log files. This attribute is only - * available with EMR version 5.30.0 and later, excluding EMR 6.0.0.
+ * available with Amazon EMR 5.30.0 and later, excluding Amazon EMR 6.0.0. + * */ LogEncryptionKmsKeyId?: string; @@ -5254,20 +5415,20 @@ export interface Cluster { AutoTerminate?: boolean; /** - *Indicates whether Amazon EMR will lock the cluster to prevent the EC2 instances - * from being terminated by an API call or user intervention, or in the event of a cluster - * error.
+ *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 + * the event of a cluster error.
*/ TerminationProtected?: boolean; /** - *Indicates whether the cluster is visible to IAM principals in the Amazon Web Services account associated with the cluster. When true
, IAM principals
- * in the Amazon Web Services account can perform EMR cluster actions on the cluster that their
- * IAM policies allow. When false
, only the IAM principal that created the
- * cluster and the Amazon Web Services account root user can perform EMR actions, regardless of
- * IAM permissions policies attached to other IAM principals.
Indicates whether the cluster is visible to IAM principals in the Amazon Web Services account associated with the cluster. When true
, IAM principals in the Amazon Web Services account can perform Amazon EMR cluster
+ * actions on the cluster that their IAM policies allow. When
+ * false
, only the IAM principal that created the cluster and
+ * the Amazon Web Services account root user can perform Amazon EMR actions, regardless
+ * of IAM permissions policies attached to other IAM
+ * principals.
The default value is true
if a value is not provided when creating a
- * cluster using the EMR API RunJobFlow command, the CLI
+ * cluster using the Amazon EMR API RunJobFlow command, the CLI
* create-cluster command, or the Amazon Web Services Management Console.
The IAM role that Amazon EMR assumes in order to access Amazon Web Services - * resources on your behalf.
+ *The IAM role that Amazon EMR assumes in order to access Amazon Web Services resources on your behalf.
*/ ServiceRole?: string; /** *An approximation of the cost of the cluster, represented in m1.small/hours. This value * is incremented one time for every hour an m1.small instance runs. Larger instances are - * weighted more, so an EC2 instance that is roughly four times more expensive would result in - * the normalized instance hours being incremented by four. This result is only an - * approximation and does not reflect the actual billing rate.
+ * weighted more, so an Amazon EC2 instance that is roughly four times more expensive + * would result in the normalized instance hours being incremented by four. This result is + * only an approximation and does not reflect the actual billing rate. */ NormalizedInstanceHours?: number; @@ -5304,8 +5464,8 @@ export interface Cluster { MasterPublicDnsName?: string; /** - *Applies only to Amazon EMR releases 4.x and later. The list of Configurations - * supplied to the EMR cluster.
+ *Applies only to Amazon EMR releases 4.x and later. The list of configurations + * that are supplied to the Amazon EMR cluster.
*/ Configurations?: Configuration[]; @@ -5316,9 +5476,8 @@ export interface Cluster { /** *An IAM role for automatic scaling policies. The default role is
- * EMR_AutoScaling_DefaultRole
. The IAM role provides permissions that the
- * automatic scaling feature requires to launch and terminate EC2 instances in an instance
- * group.
EMR_AutoScaling_DefaultRole
. The IAM role provides
+ * permissions that the automatic scaling feature requires to launch and terminate Amazon EC2 instances in an instance group.
*/
AutoScalingRole?: string;
@@ -5332,25 +5491,26 @@ export interface Cluster {
* TERMINATE_AT_TASK_COMPLETION
indicates that Amazon EMR adds nodes
* to a deny list and drains tasks from nodes before terminating the Amazon EC2
* instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to
- * HDFS corruption. TERMINATE_AT_TASK_COMPLETION
is available only in Amazon EMR version 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.
+ * HDFS corruption. TERMINATE_AT_TASK_COMPLETION
is available only in Amazon EMR releases 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.
*/
ScaleDownBehavior?: ScaleDownBehavior | string;
/**
- * Available only in Amazon EMR version 5.7.0 and later. The ID of a custom Amazon + *
Available only in Amazon EMR releases 5.7.0 and later. The ID of a custom Amazon * EBS-backed Linux AMI if the cluster uses a custom AMI.
*/ CustomAmiId?: string; /** *The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is - * used for each EC2 instance. Available in Amazon EMR version 4.x and later.
+ * used for each Amazon EC2 instance. Available in Amazon EMR releases 4.x and + * later. */ EbsRootVolumeSize?: number; /** *Applies only when CustomAmiID
is used. Specifies the type of updates that
- * are applied from the Amazon Linux AMI package repositories when an instance boots using the
+ * the Amazon Linux AMI package repositories apply when an instance boots using the
* AMI.
Market type of the EC2 instances used to create a cluster node.
+ *Market type of the Amazon EC2 instances used to create a cluster node.
*/ Market?: MarketType | string; @@ -5418,7 +5578,7 @@ export interface InstanceGroupConfig { BidPrice?: string; /** - *The EC2 instance type for all instances in the instance group.
+ *The Amazon EC2 instance type for all instances in the instance group.
*/ InstanceType: string | undefined; @@ -5431,22 +5591,23 @@ export interface InstanceGroupConfig { *Amazon EMR releases 4.x or later.
*The list of configurations supplied for an EMR cluster instance group. You can specify a - * separate configuration for each instance group (master, core, and task).
+ *The list of configurations supplied for an Amazon EMR cluster instance group. + * You can specify a separate configuration for each instance group (master, core, and + * task).
*/ Configurations?: Configuration[]; /** - *EBS configurations that will be attached to each EC2 instance in the instance - * group.
+ *EBS configurations that will be attached to each Amazon EC2 instance in the + * instance group.
*/ EbsConfiguration?: EbsConfiguration; /** *An automatic scaling policy for a core instance group or task instance group in an * Amazon EMR cluster. The automatic scaling policy defines how an instance group - * dynamically adds and terminates EC2 instances in response to the value of a CloudWatch - * metric. See PutAutoScalingPolicy.
+ * dynamically adds and terminates Amazon EC2 instances in response to the value of a + * CloudWatch metric. See PutAutoScalingPolicy. */ AutoScalingPolicy?: AutoScalingPolicy; @@ -5472,8 +5633,8 @@ export interface InstanceGroupModifyConfig { InstanceCount?: number; /** - *The EC2 InstanceIds to terminate. After you terminate the instances, the instance group - * will not return to its original requested size.
+ *The Amazon EC2 InstanceIds to terminate. After you terminate the instances, the + * instance group will not return to its original requested size.
*/ EC2InstanceIdsToTerminate?: string[]; @@ -5496,20 +5657,20 @@ export interface InstanceGroupModifyConfig { /** * @public *An instance type configuration for each instance type in an instance fleet, which - * determines the EC2 instances Amazon EMR attempts to provision to fulfill On-Demand - * and Spot target capacities. When you use an allocation strategy, you can include a maximum - * of 30 instance type configurations for a fleet. For more information about how to use an - * allocation strategy, see Configure Instance + * determines the Amazon EC2 instances Amazon EMR attempts to provision to + * fulfill On-Demand and Spot target capacities. When you use an allocation strategy, you can + * include a maximum of 30 instance type configurations for a fleet. For more information + * about how to use an allocation strategy, see Configure Instance * Fleets. Without an allocation strategy, you may specify a maximum of five * instance type configurations for a fleet.
*The instance fleet configuration is available only in Amazon EMR versions + *
The instance fleet configuration is available only in Amazon EMR releases * 4.8.0 and later, excluding 5.0.x versions.
*An EC2 instance type, such as m3.xlarge
.
An Amazon EC2 instance type, such as m3.xlarge
.
The bid price for each EC2 Spot Instance type as defined by InstanceType
.
- * Expressed in USD. If neither BidPrice
nor
+ *
The bid price for each Amazon EC2 Spot Instance type as defined by
+ * InstanceType
. Expressed in USD. If neither BidPrice
nor
* BidPriceAsPercentageOfOnDemandPrice
is provided,
* BidPriceAsPercentageOfOnDemandPrice
defaults to 100%.
The bid price, as a percentage of On-Demand price, for each EC2 Spot Instance as defined
- * by InstanceType
. Expressed as a number (for example, 20 specifies 20%). If
- * neither BidPrice
nor BidPriceAsPercentageOfOnDemandPrice
is
- * provided, BidPriceAsPercentageOfOnDemandPrice
defaults to 100%.
The bid price, as a percentage of On-Demand price, for each Amazon EC2 Spot
+ * Instance as defined by InstanceType
. Expressed as a number (for example, 20
+ * specifies 20%). If neither BidPrice
nor
+ * BidPriceAsPercentageOfOnDemandPrice
is provided,
+ * BidPriceAsPercentageOfOnDemandPrice
defaults to 100%.
The configuration specification for each instance type in an instance fleet.
*The instance fleet configuration is available only in Amazon EMR versions + *
The instance fleet configuration is available only in Amazon EMR releases * 4.8.0 and later, excluding 5.0.x versions.
*The EC2 instance type, for example m3.xlarge
.
The Amazon EC2 instance type, for example m3.xlarge
.
The bid price for each EC2 Spot Instance type as defined by InstanceType
.
- * Expressed in USD.
The bid price for each Amazon EC2 Spot Instance type as defined by
+ * InstanceType
. Expressed in USD.
The bid price, as a percentage of On-Demand price, for each EC2 Spot Instance as defined
- * by InstanceType
. Expressed as a number (for example, 20 specifies 20%).
The bid price, as a percentage of On-Demand price, for each Amazon EC2 Spot
+ * Instance as defined by InstanceType
. Expressed as a number (for example, 20
+ * specifies 20%).
For accounts that created clusters in a Region before November 25, 2019, block public * access is disabled by default in that Region. To use this feature, you must manually - * enable and configure it. For accounts that did not create an EMR cluster in a Region - * before this date, block public access is enabled by default in that Region.
+ * enable and configure it. For accounts that did not create an Amazon EMR cluster + * in a Region before this date, block public access is enabled by default in that + * Region. *For accounts that created clusters in a Region before November 25, 2019, block public * access is disabled by default in that Region. To use this feature, you must manually - * enable and configure it. For accounts that did not create an EMR cluster in a Region - * before this date, block public access is enabled by default in that Region.
+ * enable and configure it. For accounts that did not create an Amazon EMR cluster + * in a Region before this date, block public access is enabled by default in that + * Region. *Describes an instance fleet, which is a group of EC2 instances that host a particular - * node type (master, core, or task) in an Amazon EMR cluster. Instance fleets can - * consist of a mix of instance types and On-Demand and Spot Instances, which are provisioned - * to meet a defined target capacity.
+ *Describes an instance fleet, which is a group of Amazon EC2 instances that host + * a particular node type (master, core, or task) in an Amazon EMR cluster. Instance + * fleets can consist of a mix of instance types and On-Demand and Spot Instances, which are + * provisioned to meet a defined target capacity.
*The instance fleet configuration is available only in Amazon EMR versions + *
The instance fleet configuration is available only in Amazon EMR releases * 4.8.0 and later, excluding 5.0.x versions.
*The configuration that defines an instance fleet.
*The instance fleet configuration is available only in Amazon EMR versions + *
The instance fleet configuration is available only in Amazon EMR releases * 4.8.0 and later, excluding 5.0.x versions.
*The instance type configurations that define the EC2 instances in the instance - * fleet.
+ *The instance type configurations that define the Amazon EC2 instances in the + * instance fleet.
*/ InstanceTypeConfigs?: InstanceTypeConfig[]; @@ -5950,7 +6115,7 @@ export interface InstanceGroup { BidPrice?: string; /** - *The EC2 instance type for all instances in the instance group.
+ *The Amazon EC2 instance type for all instances in the instance group.
*/ InstanceType?: string; @@ -6016,8 +6181,8 @@ export interface InstanceGroup { /** *An automatic scaling policy for a core instance group or task instance group in an * Amazon EMR cluster. The automatic scaling policy defines how an instance group - * dynamically adds and terminates EC2 instances in response to the value of a CloudWatch - * metric. See PutAutoScalingPolicy.
+ * dynamically adds and terminates Amazon EC2 instances in response to the value of a + * CloudWatch metric. See PutAutoScalingPolicy. */ AutoScalingPolicy?: AutoScalingPolicyDescription; @@ -6068,17 +6233,17 @@ export interface ListInstanceGroupsOutput { */ export interface JobFlowInstancesConfig { /** - *The EC2 instance type of the master node.
+ *The Amazon EC2 instance type of the master node.
*/ MasterInstanceType?: string; /** - *The EC2 instance type of the core and task nodes.
+ *The Amazon EC2 instance type of the core and task nodes.
*/ SlaveInstanceType?: string; /** - *The number of EC2 instances in the cluster.
+ *The number of Amazon EC2 instances in the cluster.
*/ InstanceCount?: number; @@ -6089,17 +6254,17 @@ export interface JobFlowInstancesConfig { /** *The instance fleet configuration is available only in Amazon EMR versions + *
The instance fleet configuration is available only in Amazon EMR releases * 4.8.0 and later, excluding 5.0.x versions.
*Describes the EC2 instances and instance configurations for clusters that use the - * instance fleet configuration.
+ *Describes the Amazon EC2 instances and instance configurations for clusters that + * use the instance fleet configuration.
*/ InstanceFleets?: InstanceFleetConfig[]; /** - *The name of the EC2 key pair that can be used to connect to the master node using SSH as - * the user called "hadoop."
+ *The name of the Amazon EC2 key pair that can be used to connect to the master + * node using SSH as the user called "hadoop."
*/ Ec2KeyName?: string; @@ -6143,11 +6308,10 @@ export interface JobFlowInstancesConfig { Ec2SubnetId?: string; /** - *Applies to clusters that use the instance fleet configuration. When multiple EC2 subnet - * IDs are specified, Amazon EMR evaluates them and launches instances in the optimal - * subnet.
+ *Applies to clusters that use the instance fleet configuration. When multiple Amazon EC2 subnet IDs are specified, Amazon EMR evaluates them and launches + * instances in the optimal subnet.
*The instance fleet configuration is available only in Amazon EMR versions + *
The instance fleet configuration is available only in Amazon EMR releases * 4.8.0 and later, excluding 5.0.x versions.
*The KMS key used for encrypting log files. If a value is not * provided, the logs remain encrypted by AES-256. This attribute is only available with - * Amazon EMR version 5.30.0 and later, excluding Amazon EMR 6.0.0.
+ * Amazon EMR releases 5.30.0 and later, excluding Amazon EMR 6.0.0. */ LogEncryptionKmsKeyId?: string; @@ -6269,10 +6433,10 @@ export interface RunJobFlowInput { * later, use Applications. *A list of strings that indicates third-party software to use with the job flow that - * accepts a user argument list. EMR accepts and forwards the argument list to the - * corresponding installation script as bootstrap action arguments. For more information, see - * "Launch a Job Flow on the MapR Distribution for Hadoop" in the Amazon EMR Developer Guide. - * Supported values are:
+ * accepts a user argument list. Amazon EMR accepts and forwards the argument list to + * the corresponding installation script as bootstrap action arguments. For more information, + * see "Launch a Job Flow on the MapR Distribution for Hadoop" in the Amazon EMR + * Developer Guide. Supported values are: *"mapr-m3" - launch the cluster using MapR M3 Edition.
@@ -6315,7 +6479,7 @@ export interface RunJobFlowInput { /** *For Amazon EMR releases 4.0 and later. The list of configurations supplied for - * the EMR cluster you are creating.
+ * the Amazon EMR cluster that you are creating. */ Configurations?: Configuration[]; @@ -6324,30 +6488,29 @@ export interface RunJobFlowInput { *The VisibleToAllUsers parameter is no longer supported. By default, the value is set
* to true
. Setting it to false
now has no effect.
Set this value to true
so that IAM principals in the Amazon Web Services account associated with the cluster can perform EMR actions on the cluster
- * that their IAM policies allow. This value defaults to true
for clusters
- * created using the EMR API or the CLI
+ *
Set this value to true
so that IAM principals in the Amazon Web Services account associated with the cluster can perform Amazon EMR actions on
+ * the cluster that their IAM policies allow. This value defaults to
+ * true
for clusters created using the Amazon EMR API or the CLI
* create-cluster command.
When set to false
, only the IAM principal that created the cluster and the
- * Amazon Web Services account root user can perform EMR actions for the cluster, regardless
- * of the IAM permissions policies attached to other IAM principals. For more information, see
- * Understanding the EMR Cluster VisibleToAllUsers Setting in the
- * Amazon EMRManagement Guide.
When set to false
, only the IAM principal that created the
+ * cluster and the Amazon Web Services account root user can perform Amazon EMR actions
+ * for the cluster, regardless of the IAM permissions policies attached to
+ * other IAM principals. For more information, see Understanding the Amazon EMR cluster VisibleToAllUsers setting in the
+ * Amazon EMR Management Guide.
Also called instance profile and EC2 role. An IAM role for an EMR cluster. The EC2
- * instances of the cluster assume this role. The default role is
- * EMR_EC2_DefaultRole
. In order to use the default role, you must have
- * already created it using the CLI or console.
Also called instance profile and Amazon EC2 role. An IAM role for
+ * an Amazon EMR cluster. The Amazon EC2 instances of the cluster assume this
+ * role. The default role is EMR_EC2_DefaultRole
. In order to use the default
+ * role, you must have already created it using the CLI or console.
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 must specify it - * for the service role when you launch your cluster.
+ *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 + * must specify it for the service role when you launch your cluster.
*/ ServiceRole?: string; @@ -6364,9 +6527,8 @@ export interface RunJobFlowInput { /** *An IAM role for automatic scaling policies. The default role is
- * EMR_AutoScaling_DefaultRole
. The IAM role provides permissions that the
- * automatic scaling feature requires to launch and terminate EC2 instances in an instance
- * group.
EMR_AutoScaling_DefaultRole
. The IAM role provides
+ * permissions that the automatic scaling feature requires to launch and terminate Amazon EC2 instances in an instance group.
*/
AutoScalingRole?: string;
@@ -6380,18 +6542,17 @@ export interface RunJobFlowInput {
* TERMINATE_AT_TASK_COMPLETION
indicates that Amazon EMR adds nodes
* to a deny list and drains tasks from nodes before terminating the Amazon EC2
* instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to
- * HDFS corruption. TERMINATE_AT_TASK_COMPLETION
available only in Amazon EMR version 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.
+ * HDFS corruption. TERMINATE_AT_TASK_COMPLETION
available only in Amazon EMR releases 4.1.0 and later, and is the default for releases of Amazon EMR earlier than 5.1.0.
*/
ScaleDownBehavior?: ScaleDownBehavior | string;
/**
- * Available only in Amazon EMR version 5.7.0 and later. The ID of a custom Amazon + *
Available only in Amazon EMR releases 5.7.0 and later. The ID of a custom Amazon
* EBS-backed Linux AMI. If specified, Amazon EMR uses this AMI when it launches
- * cluster EC2 instances. For more information about custom AMIs in Amazon EMR, see
- * Using a
- * Custom AMI in the Amazon EMR Management Guide. If
- * omitted, the cluster uses the base Linux AMI for the ReleaseLabel
specified.
- * For Amazon EMR versions 2.x and 3.x, use AmiVersion
instead.
ReleaseLabel
specified. For Amazon EMR
+ * releases 2.x and 3.x, use AmiVersion
instead.
* For information about creating a custom AMI, see Creating an Amazon EBS-Backed Linux AMI in the Amazon Elastic Compute Cloud User Guide for Linux * Instances. For information about finding an AMI ID, see Finding a Linux * AMI.
@@ -6400,7 +6561,8 @@ export interface RunJobFlowInput { /** *The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is - * used for each EC2 instance. Available in Amazon EMR version 4.x and later.
+ * used for each Amazon EC2 instance. Available in Amazon EMR releases 4.x and + * later. */ EbsRootVolumeSize?: number; diff --git a/clients/client-emr/src/protocols/Aws_json1_1.ts b/clients/client-emr/src/protocols/Aws_json1_1.ts index 06beb6d96117a..0abb738e76565 100644 --- a/clients/client-emr/src/protocols/Aws_json1_1.ts +++ b/clients/client-emr/src/protocols/Aws_json1_1.ts @@ -278,9 +278,11 @@ import { ModifyInstanceGroupsInput, NotebookExecution, NotebookExecutionSummary, + NotebookS3LocationFromInput, OnDemandCapacityReservationOptions, OnDemandProvisioningSpecification, OnDemandResizingSpecification, + OutputNotebookS3LocationFromInput, PlacementGroupConfig, PlacementType, PortRange, @@ -3679,6 +3681,8 @@ const se_DescribeJobFlowsInput = (input: DescribeJobFlowsInput, context: __Serde // se_EC2InstanceIdsToTerminateList omitted. +// se_EnvironmentVariablesMap omitted. + // se_ExecutionEngineConfig omitted. // se_GetAutoTerminationPolicyInput omitted. @@ -3870,6 +3874,7 @@ const se_ListClustersInput = (input: ListClustersInput, context: __SerdeContext) const se_ListNotebookExecutionsInput = (input: ListNotebookExecutionsInput, context: __SerdeContext): any => { return take(input, { EditorId: [], + ExecutionEngineId: [], From: (_) => Math.round(_.getTime() / 1000), Marker: [], Status: [], @@ -3909,12 +3914,16 @@ const se_ModifyInstanceGroupsInput = (input: ModifyInstanceGroupsInput, context: // se_NewSupportedProductsList omitted. +// se_NotebookS3LocationFromInput omitted. + // se_OnDemandCapacityReservationOptions omitted. // se_OnDemandProvisioningSpecification omitted. // se_OnDemandResizingSpecification omitted. +// se_OutputNotebookS3LocationFromInput omitted. + // se_PlacementGroupConfig omitted. // se_PlacementGroupConfigList omitted. @@ -4384,6 +4393,8 @@ const de_DescribeStudioOutput = (output: any, context: __SerdeContext): Describe // de_EC2InstanceIdsList omitted. +// de_EnvironmentVariablesMap omitted. + // de_ErrorData omitted. // de_ErrorDetail omitted. @@ -4876,12 +4887,16 @@ const de_NotebookExecution = (output: any, context: __SerdeContext): NotebookExe Arn: __expectString, EditorId: __expectString, EndTime: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))), + EnvironmentVariables: _json, ExecutionEngine: _json, LastStateChangeReason: __expectString, NotebookExecutionId: __expectString, NotebookExecutionName: __expectString, NotebookInstanceSecurityGroupId: __expectString, NotebookParams: __expectString, + NotebookS3Location: _json, + OutputNotebookFormat: __expectString, + OutputNotebookS3Location: _json, OutputNotebookURI: __expectString, StartTime: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))), Status: __expectString, @@ -4896,8 +4911,10 @@ const de_NotebookExecutionSummary = (output: any, context: __SerdeContext): Note return take(output, { EditorId: __expectString, EndTime: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))), + ExecutionEngineId: __expectString, NotebookExecutionId: __expectString, NotebookExecutionName: __expectString, + NotebookS3Location: _json, StartTime: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))), Status: __expectString, }) as any; @@ -4915,6 +4932,8 @@ const de_NotebookExecutionSummaryList = (output: any, context: __SerdeContext): return retVal; }; +// de_NotebookS3LocationForOutput omitted. + // de_OnDemandCapacityReservationOptions omitted. // de_OnDemandProvisioningSpecification omitted. @@ -4925,6 +4944,8 @@ const de_NotebookExecutionSummaryList = (output: any, context: __SerdeContext): // de_OSReleaseList omitted. +// de_OutputNotebookS3LocationForOutput omitted. + // de_PlacementGroupConfig omitted. // de_PlacementGroupConfigList omitted. diff --git a/codegen/sdk-codegen/aws-models/emr.json b/codegen/sdk-codegen/aws-models/emr.json index 5bd1fb1bec1c6..58b363ecfec77 100644 --- a/codegen/sdk-codegen/aws-models/emr.json +++ b/codegen/sdk-codegen/aws-models/emr.json @@ -75,7 +75,7 @@ } ], "traits": { - "smithy.api#documentation": "Adds an instance fleet to a running cluster.
\nThe instance fleet configuration is available only in Amazon EMR versions\n 4.8.0 and later, excluding 5.0.x.
\nAdds an instance fleet to a running cluster.
\nThe instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and later, excluding 5.0.x.
\nThe Amazon Resource Name (ARN) of the runtime role for a step on the cluster. The\n runtime role can be a cross-account IAM role. The runtime role ARN is a combination of\n account ID, role name, and role type using the following format:\n arn:partition:service:region:account:resource
.
For example, arn:aws:iam::1234567890:role/ReadOnly
is a correctly formatted\n runtime role ARN.
The Amazon Resource Name (ARN) of the runtime role for a step on the cluster. The\n runtime role can be a cross-account IAM role. The runtime role ARN is a\n combination of account ID, role name, and role type using the following format:\n arn:partition:service:region:account:resource
.
For example, arn:aws:IAM::1234567890:role/ReadOnly
is a correctly formatted\n runtime role ARN.
The upper and lower EC2 instance limits for an automatic scaling policy. Automatic\n scaling activity will not cause an instance group to grow above or below these\n limits.
", + "smithy.api#documentation": "The upper and lower Amazon EC2 instance limits for an automatic scaling policy.\n Automatic scaling activity will not cause an instance group to grow above or below these\n limits.
", "smithy.api#required": {} } }, @@ -411,7 +411,7 @@ } }, "traits": { - "smithy.api#documentation": "An automatic scaling policy for a core instance group or task instance group in an\n Amazon EMR cluster. An automatic scaling policy defines how an instance group\n dynamically adds and terminates EC2 instances in response to the value of a CloudWatch\n metric. See PutAutoScalingPolicy.
" + "smithy.api#documentation": "An automatic scaling policy for a core instance group or task instance group in an\n Amazon EMR cluster. An automatic scaling policy defines how an instance group\n dynamically adds and terminates Amazon EC2 instances in response to the value of a\n CloudWatch metric. See PutAutoScalingPolicy.
" } }, "com.amazonaws.emr#AutoScalingPolicyDescription": { @@ -426,7 +426,7 @@ "Constraints": { "target": "com.amazonaws.emr#ScalingConstraints", "traits": { - "smithy.api#documentation": "The upper and lower EC2 instance limits for an automatic scaling policy. Automatic\n scaling activity will not cause an instance group to grow above or below these\n limits.
" + "smithy.api#documentation": "The upper and lower Amazon EC2 instance limits for an automatic scaling policy.\n Automatic scaling activity will not cause an instance group to grow above or below these\n limits.
" } }, "Rules": { @@ -437,7 +437,7 @@ } }, "traits": { - "smithy.api#documentation": "An automatic scaling policy for a core instance group or task instance group in an\n Amazon EMR cluster. The automatic scaling policy defines how an instance group\n dynamically adds and terminates EC2 instances in response to the value of a CloudWatch\n metric. See PutAutoScalingPolicy.
" + "smithy.api#documentation": "An automatic scaling policy for a core instance group or task instance group in an\n Amazon EMR cluster. The automatic scaling policy defines how an instance group\n dynamically adds and terminates Amazon EC2 instances in response to the value of a\n CloudWatch metric. See PutAutoScalingPolicy.
" } }, "com.amazonaws.emr#AutoScalingPolicyState": { @@ -566,14 +566,14 @@ "target": "com.amazonaws.emr#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Indicates whether Amazon EMR block public access is enabled (true
)\n or disabled (false
). By default, the value is false
for accounts\n that have created EMR clusters before July 2019. For accounts created after this, the\n default is true
.
Indicates whether Amazon EMR block public access is enabled (true
)\n or disabled (false
). By default, the value is false
for accounts\n that have created Amazon EMR clusters before July 2019. For accounts created after\n this, the default is true
.
Specifies ports and port ranges that are permitted to have security group rules that\n allow inbound traffic from all public sources. For example, if Port 23 (Telnet) is\n specified for PermittedPublicSecurityGroupRuleRanges
, Amazon EMR\n allows cluster creation if a security group associated with the cluster has a rule that\n allows inbound traffic on Port 23 from IPv4 0.0.0.0/0 or IPv6 port ::/0 as the\n source.
By default, Port 22, which is used for SSH access to the cluster EC2 instances, is in\n the list of PermittedPublicSecurityGroupRuleRanges
.
Specifies ports and port ranges that are permitted to have security group rules that\n allow inbound traffic from all public sources. For example, if Port 23 (Telnet) is\n specified for PermittedPublicSecurityGroupRuleRanges
, Amazon EMR\n allows cluster creation if a security group associated with the cluster has a rule that\n allows inbound traffic on Port 23 from IPv4 0.0.0.0/0 or IPv6 port ::/0 as the\n source.
By default, Port 22, which is used for SSH access to the cluster Amazon EC2\n instances, is in the list of PermittedPublicSecurityGroupRuleRanges
.
Cancels a pending step or steps in a running cluster. Available only in Amazon EMR versions 4.8.0 and later, excluding version 5.0.0. A maximum of 256 steps are allowed in\n each CancelSteps request. CancelSteps is idempotent but asynchronous; it does not guarantee\n that a step will be canceled, even if the request is successfully submitted. When you use\n Amazon EMR versions 5.28.0 and later, you can cancel steps that are in a\n PENDING
or RUNNING
state. In earlier versions of Amazon EMR, you can only cancel steps that are in a PENDING
state.
Cancels a pending step or steps in a running cluster. Available only in Amazon EMR versions 4.8.0 and later, excluding version 5.0.0. A maximum of 256 steps are allowed in\n each CancelSteps request. CancelSteps is idempotent but asynchronous; it does not guarantee\n that a step will be canceled, even if the request is successfully submitted. When you use\n Amazon EMR releases 5.28.0 and later, you can cancel steps that are in a\n PENDING
or RUNNING
state. In earlier versions of Amazon EMR, you can only cancel steps that are in a PENDING
state.
The period, in seconds, over which the statistic is applied. EMR CloudWatch metrics are\n emitted every five minutes (300 seconds), so if an EMR CloudWatch metric is specified,\n specify 300
.
The period, in seconds, over which the statistic is applied. CloudWatch metrics for\n Amazon EMR are emitted every five minutes (300 seconds), so if you specify a\n CloudWatch metric, specify 300
.
Provides information about the EC2 instances in a cluster grouped by category. For\n example, key name, subnet ID, IAM instance profile, and so on.
" + "smithy.api#documentation": "Provides information about the Amazon EC2 instances in a cluster grouped by\n category. For example, key name, subnet ID, IAM instance profile, and so\n on.
" } }, "InstanceCollectionType": { "target": "com.amazonaws.emr#InstanceCollectionType", "traits": { - "smithy.api#documentation": "The instance fleet configuration is available only in Amazon EMR versions\n 4.8.0 and later, excluding 5.0.x versions.
\nThe instance group configuration of the cluster. A value of INSTANCE_GROUP
\n indicates a uniform instance group configuration. A value of INSTANCE_FLEET
\n indicates an instance fleets configuration.
The instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and later, excluding 5.0.x versions.
\nThe instance group configuration of the cluster. A value of INSTANCE_GROUP
\n indicates a uniform instance group configuration. A value of INSTANCE_FLEET
\n indicates an instance fleets configuration.
The KMS key used for encrypting log files. This attribute is only\n available with EMR version 5.30.0 and later, excluding EMR 6.0.0.
" + "smithy.api#documentation": "The KMS key used for encrypting log files. This attribute is only\n available with Amazon EMR 5.30.0 and later, excluding Amazon EMR 6.0.0.\n
" } }, "RequestedAmiVersion": { @@ -931,14 +931,14 @@ "target": "com.amazonaws.emr#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Indicates whether Amazon EMR will lock the cluster to prevent the EC2 instances\n from being terminated by an API call or user intervention, or in the event of a cluster\n error.
" + "smithy.api#documentation": "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\n the event of a cluster error.
" } }, "VisibleToAllUsers": { "target": "com.amazonaws.emr#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Indicates whether the cluster is visible to IAM principals in the Amazon Web Services account associated with the cluster. When true
, IAM principals\n in the Amazon Web Services account can perform EMR cluster actions on the cluster that their\n IAM policies allow. When false
, only the IAM principal that created the\n cluster and the Amazon Web Services account root user can perform EMR actions, regardless of\n IAM permissions policies attached to other IAM principals.
The default value is true
if a value is not provided when creating a\n cluster using the EMR API RunJobFlow command, the CLI\n create-cluster command, or the Amazon Web Services Management Console.
Indicates whether the cluster is visible to IAM principals in the Amazon Web Services account associated with the cluster. When true
, IAM principals in the Amazon Web Services account can perform Amazon EMR cluster\n actions on the cluster that their IAM policies allow. When\n false
, only the IAM principal that created the cluster and\n the Amazon Web Services account root user can perform Amazon EMR actions, regardless\n of IAM permissions policies attached to other IAM\n principals.
The default value is true
if a value is not provided when creating a\n cluster using the Amazon EMR API RunJobFlow command, the CLI\n create-cluster command, or the Amazon Web Services Management Console.
The IAM role that Amazon EMR assumes in order to access Amazon Web Services\n resources on your behalf.
" + "smithy.api#documentation": "The IAM role that Amazon EMR assumes in order to access Amazon Web Services resources on your behalf.
" } }, "NormalizedInstanceHours": { "target": "com.amazonaws.emr#Integer", "traits": { - "smithy.api#documentation": "An approximation of the cost of the cluster, represented in m1.small/hours. This value\n is incremented one time for every hour an m1.small instance runs. Larger instances are\n weighted more, so an EC2 instance that is roughly four times more expensive would result in\n the normalized instance hours being incremented by four. This result is only an\n approximation and does not reflect the actual billing rate.
" + "smithy.api#documentation": "An approximation of the cost of the cluster, represented in m1.small/hours. This value\n is incremented one time for every hour an m1.small instance runs. Larger instances are\n weighted more, so an Amazon EC2 instance that is roughly four times more expensive\n would result in the normalized instance hours being incremented by four. This result is\n only an approximation and does not reflect the actual billing rate.
" } }, "MasterPublicDnsName": { @@ -974,7 +974,7 @@ "Configurations": { "target": "com.amazonaws.emr#ConfigurationList", "traits": { - "smithy.api#documentation": "Applies only to Amazon EMR releases 4.x and later. The list of Configurations\n supplied to the EMR cluster.
" + "smithy.api#documentation": "Applies only to Amazon EMR releases 4.x and later. The list of configurations\n that are supplied to the Amazon EMR cluster.
" } }, "SecurityConfiguration": { @@ -986,31 +986,31 @@ "AutoScalingRole": { "target": "com.amazonaws.emr#XmlString", "traits": { - "smithy.api#documentation": "An IAM role for automatic scaling policies. The default role is\n EMR_AutoScaling_DefaultRole
. The IAM role provides permissions that the\n automatic scaling feature requires to launch and terminate EC2 instances in an instance\n group.
An IAM role for automatic scaling policies. The default role is\n EMR_AutoScaling_DefaultRole
. The IAM role provides\n permissions that the automatic scaling feature requires to launch and terminate Amazon EC2 instances in an instance group.
The way that individual Amazon EC2 instances terminate when an automatic\n scale-in activity occurs or an instance group is resized.\n TERMINATE_AT_INSTANCE_HOUR
indicates that Amazon EMR terminates\n nodes at the instance-hour boundary, regardless of when the request to terminate the\n instance was submitted. This option is only available with Amazon EMR 5.1.0 and\n later and is the default for clusters created using that version.\n TERMINATE_AT_TASK_COMPLETION
indicates that Amazon EMR adds nodes\n to a deny list and drains tasks from nodes before terminating the Amazon EC2\n instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to\n HDFS corruption. TERMINATE_AT_TASK_COMPLETION
is available only in Amazon EMR version 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.
The way that individual Amazon EC2 instances terminate when an automatic\n scale-in activity occurs or an instance group is resized.\n TERMINATE_AT_INSTANCE_HOUR
indicates that Amazon EMR terminates\n nodes at the instance-hour boundary, regardless of when the request to terminate the\n instance was submitted. This option is only available with Amazon EMR 5.1.0 and\n later and is the default for clusters created using that version.\n TERMINATE_AT_TASK_COMPLETION
indicates that Amazon EMR adds nodes\n to a deny list and drains tasks from nodes before terminating the Amazon EC2\n instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to\n HDFS corruption. TERMINATE_AT_TASK_COMPLETION
is available only in Amazon EMR releases 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.
Available only in Amazon EMR version 5.7.0 and later. The ID of a custom Amazon\n EBS-backed Linux AMI if the cluster uses a custom AMI.
" + "smithy.api#documentation": "Available only in Amazon EMR releases 5.7.0 and later. The ID of a custom Amazon\n EBS-backed Linux AMI if the cluster uses a custom AMI.
" } }, "EbsRootVolumeSize": { "target": "com.amazonaws.emr#Integer", "traits": { - "smithy.api#documentation": "The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is\n used for each EC2 instance. Available in Amazon EMR version 4.x and later.
" + "smithy.api#documentation": "The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is\n used for each Amazon EC2 instance. Available in Amazon EMR releases 4.x and\n later.
" } }, "RepoUpgradeOnBoot": { "target": "com.amazonaws.emr#RepoUpgradeOnBoot", "traits": { - "smithy.api#documentation": "Applies only when CustomAmiID
is used. Specifies the type of updates that\n are applied from the Amazon Linux AMI package repositories when an instance boots using the\n AMI.
Applies only when CustomAmiID
is used. Specifies the type of updates that\n the Amazon Linux AMI package repositories apply when an instance boots using the\n AMI.
A list of tuples that provide information about the errors that caused a cluster termination. This structure may have up to 10 different ErrorDetail
tuples.
A list of tuples that provides information about the errors that caused a cluster to\n terminate. This structure can contain up to 10 different ErrorDetail
\n tuples.
An approximation of the cost of the cluster, represented in m1.small/hours. This value\n is incremented one time for every hour an m1.small instance runs. Larger instances are\n weighted more, so an EC2 instance that is roughly four times more expensive would result in\n the normalized instance hours being incremented by four. This result is only an\n approximation and does not reflect the actual billing rate.
" + "smithy.api#documentation": "An approximation of the cost of the cluster, represented in m1.small/hours. This value\n is incremented one time for every hour an m1.small instance runs. Larger instances are\n weighted more, so an Amazon EC2 instance that is roughly four times more expensive\n would result in the normalized instance hours being incremented by four. This result is\n only an approximation and does not reflect the actual billing rate.
" } }, "ClusterArn": { @@ -1365,32 +1365,32 @@ "MinimumCapacityUnits": { "target": "com.amazonaws.emr#Integer", "traits": { - "smithy.api#documentation": "The lower boundary of EC2 units. It is measured through vCPU cores or instances for\n instance groups and measured through units for instance fleets. Managed scaling activities\n are not allowed beyond this boundary. The limit only applies to the core and task nodes.\n The master node cannot be scaled after initial configuration.
", + "smithy.api#documentation": "The lower boundary of Amazon EC2 units. It is measured through vCPU cores or\n instances for instance groups and measured through units for instance fleets. Managed\n scaling activities are not allowed beyond this boundary. The limit only applies to the core\n and task nodes. The master node cannot be scaled after initial configuration.
", "smithy.api#required": {} } }, "MaximumCapacityUnits": { "target": "com.amazonaws.emr#Integer", "traits": { - "smithy.api#documentation": "The upper boundary of EC2 units. It is measured through vCPU cores or instances for\n instance groups and measured through units for instance fleets. Managed scaling activities\n are not allowed beyond this boundary. The limit only applies to the core and task nodes.\n The master node cannot be scaled after initial configuration.
", + "smithy.api#documentation": "The upper boundary of Amazon EC2 units. It is measured through vCPU cores or\n instances for instance groups and measured through units for instance fleets. Managed\n scaling activities are not allowed beyond this boundary. The limit only applies to the core\n and task nodes. The master node cannot be scaled after initial configuration.
", "smithy.api#required": {} } }, "MaximumOnDemandCapacityUnits": { "target": "com.amazonaws.emr#Integer", "traits": { - "smithy.api#documentation": "The upper boundary of On-Demand EC2 units. It is measured through vCPU cores or\n instances for instance groups and measured through units for instance fleets. The On-Demand\n units are not allowed to scale beyond this boundary. The parameter is used to split\n capacity allocation between On-Demand and Spot Instances.
" + "smithy.api#documentation": "The upper boundary of On-Demand Amazon EC2 units. It is measured through vCPU\n cores or instances for instance groups and measured through units for instance fleets. The\n On-Demand units are not allowed to scale beyond this boundary. The parameter is used to\n split capacity allocation between On-Demand and Spot Instances.
" } }, "MaximumCoreCapacityUnits": { "target": "com.amazonaws.emr#Integer", "traits": { - "smithy.api#documentation": "The upper boundary of EC2 units for core node type in a cluster. It is measured through\n vCPU cores or instances for instance groups and measured through units for instance fleets.\n The core units are not allowed to scale beyond this boundary. The parameter is used to\n split capacity allocation between core and task nodes.
" + "smithy.api#documentation": "The upper boundary of Amazon EC2 units for core node type in a cluster. It is\n measured through vCPU cores or instances for instance groups and measured through units for\n instance fleets. The core units are not allowed to scale beyond this boundary. The\n parameter is used to split capacity allocation between core and task nodes.
" } } }, "traits": { - "smithy.api#documentation": "The EC2 unit limits for a managed scaling policy. The managed scaling activity of a\n cluster can not be above or below these limits. The limit only applies to the core and task\n nodes. The master node cannot be scaled after initial configuration.
" + "smithy.api#documentation": "The Amazon EC2 unit limits for a managed scaling policy. The managed scaling\n activity of a cluster can not be above or below these limits. The limit only applies to the\n core and task nodes. The master node cannot be scaled after initial configuration.
" } }, "com.amazonaws.emr#ComputeLimitsUnitType": { @@ -1572,14 +1572,14 @@ "ServiceRole": { "target": "com.amazonaws.emr#XmlString", "traits": { - "smithy.api#documentation": "The IAM role that the Amazon EMR Studio assumes. The service role provides a way\n for Amazon EMR Studio to interoperate with other Amazon Web Services\n services.
", + "smithy.api#documentation": "The IAM role that the Amazon EMR Studio assumes. The service role\n provides a way for Amazon EMR Studio to interoperate with other Amazon Web Services\n services.
", "smithy.api#required": {} } }, "UserRole": { "target": "com.amazonaws.emr#XmlString", "traits": { - "smithy.api#documentation": "The IAM user role that users and groups assume when logged in to an Amazon EMR\n Studio. Only specify a UserRole
when you use IAM Identity Center\n authentication. The permissions attached to the UserRole
can be scoped down\n for each user or group using session policies.
The IAM user role that users and groups assume when logged in to an\n Amazon EMR Studio. Only specify a UserRole
when you use IAM Identity Center authentication. The permissions attached to the UserRole
can be\n scoped down for each user or group using session policies.
The Amazon Resource Name (ARN) for the session policy that will be applied to the user\n or group. You should specify the ARN for the session policy that you want to apply, not the\n ARN of your user role. For more information, see Create an EMR Studio User\n Role with Session Policies.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the session policy that will be applied to the user\n or group. You should specify the ARN for the session policy that you want to apply, not the\n ARN of your user role. For more information, see Create an Amazon EMR\n Studio User Role with Session Policies.
", "smithy.api#required": {} } } @@ -1718,7 +1718,7 @@ } }, "traits": { - "smithy.api#documentation": "The credentials that you can use to connect to cluster endpoints. Credentials consist of a username and a password.
" + "smithy.api#documentation": "The credentials that you can use to connect to cluster endpoints. Credentials consist of\n a username and a password.
" } }, "com.amazonaws.emr#Date": { @@ -2120,7 +2120,7 @@ } ], "traits": { - "smithy.api#documentation": "Provides EMR release label details, such as releases available the region where the API\n request is run, and the available applications for a specific EMR release label. Can also\n list EMR release versions that support a specified version of Spark.
" + "smithy.api#documentation": "Provides Amazon EMR release label details, such as the releases available the\n Region where the API request is run, and the available applications for a specific Amazon EMR release label. Can also list Amazon EMR releases that support a\n specified version of Spark.
" } }, "com.amazonaws.emr#DescribeReleaseLabelInput": { @@ -2404,7 +2404,7 @@ "VolumeSpecification": { "target": "com.amazonaws.emr#VolumeSpecification", "traits": { - "smithy.api#documentation": "EBS volume specifications such as volume type, IOPS, size (GiB) and throughput (MiB/s)\n that are requested for the EBS volume attached to an EC2 instance in the cluster.
" + "smithy.api#documentation": "EBS volume specifications such as volume type, IOPS, size (GiB) and throughput (MiB/s)\n that are requested for the EBS volume attached to an Amazon EC2 instance in the\n cluster.
" } }, "Device": { @@ -2424,7 +2424,7 @@ "VolumeSpecification": { "target": "com.amazonaws.emr#VolumeSpecification", "traits": { - "smithy.api#documentation": "EBS volume specifications such as volume type, IOPS, size (GiB) and throughput (MiB/s)\n that are requested for the EBS volume attached to an EC2 instance in the cluster.
", + "smithy.api#documentation": "EBS volume specifications such as volume type, IOPS, size (GiB) and throughput (MiB/s)\n that are requested for the EBS volume attached to an Amazon EC2 instance in the\n cluster.
", "smithy.api#required": {} } }, @@ -2488,7 +2488,7 @@ } }, "traits": { - "smithy.api#documentation": "EBS block device that's attached to an EC2 instance.
" + "smithy.api#documentation": "EBS block device that's attached to an Amazon EC2 instance.
" } }, "com.amazonaws.emr#EbsVolumeList": { @@ -2515,7 +2515,7 @@ "RequestedEc2SubnetIds": { "target": "com.amazonaws.emr#XmlStringMaxLen256List", "traits": { - "smithy.api#documentation": "Applies to clusters configured with the instance fleets option. Specifies the unique\n identifier of one or more Amazon EC2 subnets in which to launch EC2 cluster\n instances. Subnets must exist within the same VPC. Amazon EMR chooses the EC2\n subnet with the best fit from among the list of RequestedEc2SubnetIds
, and\n then launches all cluster instances within that Subnet. If this value is not specified, and\n the account and Region support EC2-Classic networks, the cluster launches instances in the\n EC2-Classic network and uses RequestedEc2AvailabilityZones
instead of this\n setting. If EC2-Classic is not supported, and no Subnet is specified, Amazon EMR\n chooses the subnet for you. RequestedEc2SubnetIDs
and\n RequestedEc2AvailabilityZones
cannot be specified together.
Applies to clusters configured with the instance fleets option. Specifies the unique\n identifier of one or more Amazon EC2 subnets in which to launch Amazon EC2\n cluster instances. Subnets must exist within the same VPC. Amazon EMR chooses the\n Amazon EC2 subnet with the best fit from among the list of\n RequestedEc2SubnetIds
, and then launches all cluster instances within that\n Subnet. If this value is not specified, and the account and Region support EC2-Classic\n networks, the cluster launches instances in the EC2-Classic network and uses\n RequestedEc2AvailabilityZones
instead of this setting. If EC2-Classic is\n not supported, and no Subnet is specified, Amazon EMR chooses the subnet for you.\n RequestedEc2SubnetIDs
and RequestedEc2AvailabilityZones
cannot\n be specified together.
Applies to clusters configured with the instance fleets option. Specifies one or more\n Availability Zones in which to launch EC2 cluster instances when the EC2-Classic network\n configuration is supported. Amazon EMR chooses the Availability Zone with the best\n fit from among the list of RequestedEc2AvailabilityZones
, and then launches\n all cluster instances within that Availability Zone. If you do not specify this value,\n Amazon EMR chooses the Availability Zone for you.\n RequestedEc2SubnetIDs
and RequestedEc2AvailabilityZones
cannot\n be specified together.
Applies to clusters configured with the instance fleets option. Specifies one or more\n Availability Zones in which to launch Amazon EC2 cluster instances when the\n EC2-Classic network configuration is supported. Amazon EMR chooses the Availability\n Zone with the best fit from among the list of RequestedEc2AvailabilityZones
,\n and then launches all cluster instances within that Availability Zone. If you do not\n specify this value, Amazon EMR chooses the Availability Zone for you.\n RequestedEc2SubnetIDs
and RequestedEc2AvailabilityZones
cannot\n be specified together.
The IAM role that was specified when the cluster was launched. The EC2 instances of the\n cluster assume this role.
" + "smithy.api#documentation": "The IAM role that was specified when the cluster was launched. The\n Amazon EC2 instances of the cluster assume this role.
" } }, "EmrManagedMasterSecurityGroup": { @@ -2568,7 +2568,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides information about the EC2 instances in a cluster grouped by category. For\n example, key name, subnet ID, IAM instance profile, and so on.
" + "smithy.api#documentation": "Provides information about the Amazon EC2 instances in a cluster grouped by\n category. For example, key name, subnet ID, IAM instance profile, and so\n on.
" } }, "com.amazonaws.emr#ElasticMapReduce": { @@ -3820,6 +3820,15 @@ } } }, + "com.amazonaws.emr#EnvironmentVariablesMap": { + "type": "map", + "key": { + "target": "com.amazonaws.emr#XmlStringMaxLen256" + }, + "value": { + "target": "com.amazonaws.emr#XmlString" + } + }, "com.amazonaws.emr#ErrorCode": { "type": "string", "traits": { @@ -3841,24 +3850,24 @@ "ErrorCode": { "target": "com.amazonaws.emr#String", "traits": { - "smithy.api#documentation": "The name or code that's associated with the error.
" + "smithy.api#documentation": "The name or code associated with the error.
" } }, "ErrorData": { "target": "com.amazonaws.emr#ErrorData", "traits": { - "smithy.api#documentation": "A list of key value pairs that provide contextual information to explain why the error may have occured.
" + "smithy.api#documentation": "A list of key value pairs that provides contextual information about why an error\n occured.
" } }, "ErrorMessage": { "target": "com.amazonaws.emr#String", "traits": { - "smithy.api#documentation": "A message describing the error that occured.
" + "smithy.api#documentation": "A message that describes the error.
" } } }, "traits": { - "smithy.api#documentation": "A tuple that provides information about an error that caused a cluster to terminate.
" + "smithy.api#documentation": "A tuple that provides information about an error that caused a cluster to\n terminate.
" } }, "com.amazonaws.emr#ErrorDetailList": { @@ -3876,25 +3885,31 @@ "Id": { "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "The unique identifier of the execution engine. For an EMR cluster, this is the cluster\n ID.
", + "smithy.api#documentation": "The unique identifier of the execution engine. For an Amazon EMR cluster, this\n is the cluster ID.
", "smithy.api#required": {} } }, "Type": { "target": "com.amazonaws.emr#ExecutionEngineType", "traits": { - "smithy.api#documentation": "The type of execution engine. A value of EMR
specifies an EMR\n cluster.
The type of execution engine. A value of EMR
specifies an Amazon EMR cluster.
An optional unique ID of an EC2 security group to associate with the master instance of\n the EMR cluster for this notebook execution. For more information see Specifying\n EC2 Security Groups for EMR Notebooks in the EMR Management\n Guide.
" + "smithy.api#documentation": "An optional unique ID of an Amazon EC2 security group to associate with the\n master instance of the Amazon EMR cluster for this notebook execution. For more\n information see Specifying\n Amazon EC2 Security Groups for Amazon EMR Notebooks in the\n EMR Management Guide.
" + } + }, + "ExecutionRoleArn": { + "target": "com.amazonaws.emr#IAMRoleArn", + "traits": { + "smithy.api#documentation": "The execution role ARN required for the notebook execution.
" } } }, "traits": { - "smithy.api#documentation": "Specifies the execution engine (cluster) to run the notebook and perform the notebook\n execution, for example, an EMR cluster.
" + "smithy.api#documentation": "Specifies the execution engine (cluster) to run the notebook and perform the notebook\n execution, for example, an Amazon EMR cluster.
" } }, "com.amazonaws.emr#ExecutionEngineType": { @@ -4008,7 +4023,7 @@ "BlockPublicAccessConfiguration": { "target": "com.amazonaws.emr#BlockPublicAccessConfiguration", "traits": { - "smithy.api#documentation": "A configuration for Amazon EMR block public access. The configuration applies to\n all clusters created in your account for the current Region. The configuration specifies\n whether block public access is enabled. If block public access is enabled, security groups\n associated with the cluster cannot have rules that allow inbound traffic from 0.0.0.0/0 or\n ::/0 on a port, unless the port is specified as an exception using\n PermittedPublicSecurityGroupRuleRanges
in the\n BlockPublicAccessConfiguration
. By default, Port 22 (SSH) is an exception,\n and public access is allowed on this port. You can change this by updating the block public\n access configuration to remove the exception.
For accounts that created clusters in a Region before November 25, 2019, block public\n access is disabled by default in that Region. To use this feature, you must manually\n enable and configure it. For accounts that did not create an EMR cluster in a Region\n before this date, block public access is enabled by default in that Region.
\nA configuration for Amazon EMR block public access. The configuration applies to\n all clusters created in your account for the current Region. The configuration specifies\n whether block public access is enabled. If block public access is enabled, security groups\n associated with the cluster cannot have rules that allow inbound traffic from 0.0.0.0/0 or\n ::/0 on a port, unless the port is specified as an exception using\n PermittedPublicSecurityGroupRuleRanges
in the\n BlockPublicAccessConfiguration
. By default, Port 22 (SSH) is an exception,\n and public access is allowed on this port. You can change this by updating the block public\n access configuration to remove the exception.
For accounts that created clusters in a Region before November 25, 2019, block public\n access is disabled by default in that Region. To use this feature, you must manually\n enable and configure it. For accounts that did not create an Amazon EMR cluster\n in a Region before this date, block public access is enabled by default in that\n Region.
\nProvides temporary, HTTP basic credentials that are associated with a given runtime IAM role \n and used by a cluster with fine-grained access control activated. You can use these credentials to connect to cluster endpoints that support username and password authentication.
" + "smithy.api#documentation": "Provides temporary, HTTP basic credentials that are associated with a given runtime\n IAM role and used by a cluster with fine-grained access control\n activated. You can use these credentials to connect to cluster endpoints that support\n username and password authentication.
" } }, "com.amazonaws.emr#GetClusterSessionCredentialsInput": { @@ -4057,7 +4072,7 @@ "ExecutionRoleArn": { "target": "com.amazonaws.emr#ArnType", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the runtime role for interactive workload submission on the cluster. \n The runtime role can be a cross-account IAM role. The runtime role ARN is a combination of account ID, role name, \n and role type using the following format: arn:partition:service:region:account:resource
.
The Amazon Resource Name (ARN) of the runtime role for interactive workload submission\n on the cluster. The runtime role can be a cross-account IAM role. The\n runtime role ARN is a combination of account ID, role name, and role type using the\n following format: arn:partition:service:region:account:resource
.
The credentials that you can use to connect to cluster endpoints that support username and password authentication.
" + "smithy.api#documentation": "The credentials that you can use to connect to cluster endpoints that support username\n and password authentication.
" } }, "ExpiresAt": { "target": "com.amazonaws.emr#Date", "traits": { - "smithy.api#documentation": "The time when the credentials that are returned by the GetClusterSessionCredentials
API expire.
The time when the credentials that are returned by the\n GetClusterSessionCredentials
API expire.
A cluster step consisting of a JAR file whose main function will be executed. The main\n function submits a job for Hadoop to execute and waits for the job to finish or\n fail.
" } }, + "com.amazonaws.emr#IAMRoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):iam::(\\d{12})?:(role((\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F))[\\w+=,.@-]+)$" + } + }, "com.amazonaws.emr#IdentityType": { "type": "enum", "members": { @@ -4331,7 +4356,7 @@ "InstanceFleetId": { "target": "com.amazonaws.emr#InstanceFleetId", "traits": { - "smithy.api#documentation": "The unique identifier of the instance fleet to which an EC2 instance belongs.
" + "smithy.api#documentation": "The unique identifier of the instance fleet to which an Amazon EC2 instance\n belongs.
" } }, "Market": { @@ -4343,7 +4368,7 @@ "InstanceType": { "target": "com.amazonaws.emr#InstanceType", "traits": { - "smithy.api#documentation": "The EC2 instance type, for example m3.xlarge
.
The Amazon EC2 instance type, for example m3.xlarge
.
Represents an EC2 instance provisioned as part of cluster.
" + "smithy.api#documentation": "Represents an Amazon EC2 instance provisioned as part of cluster.
" } }, "com.amazonaws.emr#InstanceCollectionType": { @@ -4445,7 +4470,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes an instance fleet, which is a group of EC2 instances that host a particular\n node type (master, core, or task) in an Amazon EMR cluster. Instance fleets can\n consist of a mix of instance types and On-Demand and Spot Instances, which are provisioned\n to meet a defined target capacity.
\nThe instance fleet configuration is available only in Amazon EMR versions\n 4.8.0 and later, excluding 5.0.x versions.
\nDescribes an instance fleet, which is a group of Amazon EC2 instances that host\n a particular node type (master, core, or task) in an Amazon EMR cluster. Instance\n fleets can consist of a mix of instance types and On-Demand and Spot Instances, which are\n provisioned to meet a defined target capacity.
\nThe instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and later, excluding 5.0.x versions.
\nThe instance type configurations that define the EC2 instances in the instance\n fleet.
" + "smithy.api#documentation": "The instance type configurations that define the Amazon EC2 instances in the\n instance fleet.
" } }, "LaunchSpecifications": { @@ -4496,7 +4521,7 @@ } }, "traits": { - "smithy.api#documentation": "The configuration that defines an instance fleet.
\nThe instance fleet configuration is available only in Amazon EMR versions\n 4.8.0 and later, excluding 5.0.x versions.
\nThe configuration that defines an instance fleet.
\nThe instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and later, excluding 5.0.x versions.
\nConfiguration parameters for an instance fleet modification request.
\nThe instance fleet configuration is available only in Amazon EMR versions\n 4.8.0 and later, excluding 5.0.x versions.
\nConfiguration parameters for an instance fleet modification request.
\nThe instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and later, excluding 5.0.x versions.
\nThe launch specification for On-Demand Instances in the instance fleet, which\n determines the allocation strategy.
\nThe instance fleet configuration is available only in Amazon EMR versions\n 4.8.0 and later, excluding 5.0.x versions. On-Demand Instances allocation strategy is\n available in Amazon EMR version 5.12.1 and later.
\nThe launch specification for On-Demand Instances in the instance fleet, which\n determines the allocation strategy.
\nThe instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and later, excluding 5.0.x versions. On-Demand Instances allocation strategy is\n available in Amazon EMR releases 5.12.1 and later.
\nThe launch specification for Spot Instances in the fleet, which determines the defined\n duration, provisioning timeout behavior, and allocation strategy.
\nThe instance fleet configuration is available only in Amazon EMR versions\n 4.8.0 and later, excluding 5.0.x versions. On-Demand and Spot instance allocation\n strategies are available in Amazon EMR version 5.12.1 and later.
\nThe launch specification for Spot Instances in the fleet, which determines the defined\n duration, provisioning timeout behavior, and allocation strategy.
\nThe instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and later, excluding 5.0.x versions. On-Demand and Spot instance allocation\n strategies are available in Amazon EMR releases 5.12.1 and later.
\nProvides status change reason details for the instance fleet.
\nThe instance fleet configuration is available only in Amazon EMR versions\n 4.8.0 and later, excluding 5.0.x versions.
\nProvides status change reason details for the instance fleet.
\nThe instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and later, excluding 5.0.x versions.
\nA code representing the instance fleet status.
\n\n PROVISIONING
—The instance fleet is provisioning EC2 resources and is\n not yet ready to run jobs.
\n BOOTSTRAPPING
—EC2 instances and other resources have been provisioned\n and the bootstrap actions specified for the instances are underway.
\n RUNNING
—EC2 instances and other resources are running. They are\n either executing jobs or waiting to execute jobs.
\n RESIZING
—A resize operation is underway. EC2 instances are either\n being added or removed.
\n SUSPENDED
—A resize operation could not complete. Existing EC2\n instances are running, but instances can't be added or removed.
\n TERMINATING
—The instance fleet is terminating EC2 instances.
\n TERMINATED
—The instance fleet is no longer active, and all EC2\n instances have been terminated.
A code representing the instance fleet status.
\n\n PROVISIONING
—The instance fleet is provisioning Amazon EC2\n resources and is not yet ready to run jobs.
\n BOOTSTRAPPING
—Amazon EC2 instances and other resources have\n been provisioned and the bootstrap actions specified for the instances are\n underway.
\n RUNNING
—Amazon EC2 instances and other resources are running.\n They are either executing jobs or waiting to execute jobs.
\n RESIZING
—A resize operation is underway. Amazon EC2 instances\n are either being added or removed.
\n SUSPENDED
—A resize operation could not complete. Existing Amazon EC2 instances are running, but instances can't be added or removed.
\n TERMINATING
—The instance fleet is terminating Amazon EC2\n instances.
\n TERMINATED
—The instance fleet is no longer active, and all Amazon EC2 instances have been terminated.
The status of the instance fleet.
\nThe instance fleet configuration is available only in Amazon EMR versions\n 4.8.0 and later, excluding 5.0.x versions.
\nThe status of the instance fleet.
\nThe instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and later, excluding 5.0.x versions.
\nProvides historical timestamps for the instance fleet, including the time of creation,\n the time it became ready to run jobs, and the time of termination.
\nThe instance fleet configuration is available only in Amazon EMR versions\n 4.8.0 and later, excluding 5.0.x versions.
\nProvides historical timestamps for the instance fleet, including the time of creation,\n the time it became ready to run jobs, and the time of termination.
\nThe instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and later, excluding 5.0.x versions.
\nThe EC2 instance type for all instances in the instance group.
" + "smithy.api#documentation": "The Amazon EC2 instance type for all instances in the instance group.
" } }, "RequestedInstanceCount": { @@ -4862,7 +4887,7 @@ "AutoScalingPolicy": { "target": "com.amazonaws.emr#AutoScalingPolicyDescription", "traits": { - "smithy.api#documentation": "An automatic scaling policy for a core instance group or task instance group in an\n Amazon EMR cluster. The automatic scaling policy defines how an instance group\n dynamically adds and terminates EC2 instances in response to the value of a CloudWatch\n metric. See PutAutoScalingPolicy.
" + "smithy.api#documentation": "An automatic scaling policy for a core instance group or task instance group in an\n Amazon EMR cluster. The automatic scaling policy defines how an instance group\n dynamically adds and terminates Amazon EC2 instances in response to the value of a\n CloudWatch metric. See PutAutoScalingPolicy.
" } }, "CustomAmiId": { @@ -4888,7 +4913,7 @@ "Market": { "target": "com.amazonaws.emr#MarketType", "traits": { - "smithy.api#documentation": "Market type of the EC2 instances used to create a cluster node.
" + "smithy.api#documentation": "Market type of the Amazon EC2 instances used to create a cluster node.
" } }, "InstanceRole": { @@ -4907,7 +4932,7 @@ "InstanceType": { "target": "com.amazonaws.emr#InstanceType", "traits": { - "smithy.api#documentation": "The EC2 instance type for all instances in the instance group.
", + "smithy.api#documentation": "The Amazon EC2 instance type for all instances in the instance group.
", "smithy.api#required": {} } }, @@ -4921,19 +4946,19 @@ "Configurations": { "target": "com.amazonaws.emr#ConfigurationList", "traits": { - "smithy.api#documentation": "Amazon EMR releases 4.x or later.
\nThe list of configurations supplied for an EMR cluster instance group. You can specify a\n separate configuration for each instance group (master, core, and task).
" + "smithy.api#documentation": "Amazon EMR releases 4.x or later.
\nThe list of configurations supplied for an Amazon EMR cluster instance group.\n You can specify a separate configuration for each instance group (master, core, and\n task).
" } }, "EbsConfiguration": { "target": "com.amazonaws.emr#EbsConfiguration", "traits": { - "smithy.api#documentation": "EBS configurations that will be attached to each EC2 instance in the instance\n group.
" + "smithy.api#documentation": "EBS configurations that will be attached to each Amazon EC2 instance in the\n instance group.
" } }, "AutoScalingPolicy": { "target": "com.amazonaws.emr#AutoScalingPolicy", "traits": { - "smithy.api#documentation": "An automatic scaling policy for a core instance group or task instance group in an\n Amazon EMR cluster. The automatic scaling policy defines how an instance group\n dynamically adds and terminates EC2 instances in response to the value of a CloudWatch\n metric. See PutAutoScalingPolicy.
" + "smithy.api#documentation": "An automatic scaling policy for a core instance group or task instance group in an\n Amazon EMR cluster. The automatic scaling policy defines how an instance group\n dynamically adds and terminates Amazon EC2 instances in response to the value of a\n CloudWatch metric. See PutAutoScalingPolicy.
" } }, "CustomAmiId": { @@ -4971,7 +4996,7 @@ "Market": { "target": "com.amazonaws.emr#MarketType", "traits": { - "smithy.api#documentation": "Market type of the EC2 instances used to create a cluster node.
", + "smithy.api#documentation": "Market type of the Amazon EC2 instances used to create a cluster node.
", "smithy.api#required": {} } }, @@ -4991,7 +5016,7 @@ "InstanceType": { "target": "com.amazonaws.emr#InstanceType", "traits": { - "smithy.api#documentation": "EC2 instance type.
", + "smithy.api#documentation": "Amazon EC2 instance type.
", "smithy.api#required": {} } }, @@ -5098,7 +5123,7 @@ "EC2InstanceIdsToTerminate": { "target": "com.amazonaws.emr#EC2InstanceIdsToTerminateList", "traits": { - "smithy.api#documentation": "The EC2 InstanceIds to terminate. After you terminate the instances, the instance group\n will not return to its original requested size.
" + "smithy.api#documentation": "The Amazon EC2 InstanceIds to terminate. After you terminate the instances, the\n instance group will not return to its original requested size.
" } }, "ShrinkPolicy": { @@ -5553,7 +5578,7 @@ "InstanceType": { "target": "com.amazonaws.emr#InstanceType", "traits": { - "smithy.api#documentation": "An EC2 instance type, such as m3.xlarge
.
An Amazon EC2 instance type, such as m3.xlarge
.
The bid price for each EC2 Spot Instance type as defined by InstanceType
.\n Expressed in USD. If neither BidPrice
nor\n BidPriceAsPercentageOfOnDemandPrice
is provided,\n BidPriceAsPercentageOfOnDemandPrice
defaults to 100%.
The bid price for each Amazon EC2 Spot Instance type as defined by\n InstanceType
. Expressed in USD. If neither BidPrice
nor\n BidPriceAsPercentageOfOnDemandPrice
is provided,\n BidPriceAsPercentageOfOnDemandPrice
defaults to 100%.
The bid price, as a percentage of On-Demand price, for each EC2 Spot Instance as defined\n by InstanceType
. Expressed as a number (for example, 20 specifies 20%). If\n neither BidPrice
nor BidPriceAsPercentageOfOnDemandPrice
is\n provided, BidPriceAsPercentageOfOnDemandPrice
defaults to 100%.
The bid price, as a percentage of On-Demand price, for each Amazon EC2 Spot\n Instance as defined by InstanceType
. Expressed as a number (for example, 20\n specifies 20%). If neither BidPrice
nor\n BidPriceAsPercentageOfOnDemandPrice
is provided,\n BidPriceAsPercentageOfOnDemandPrice
defaults to 100%.
An instance type configuration for each instance type in an instance fleet, which\n determines the EC2 instances Amazon EMR attempts to provision to fulfill On-Demand\n and Spot target capacities. When you use an allocation strategy, you can include a maximum\n of 30 instance type configurations for a fleet. For more information about how to use an\n allocation strategy, see Configure Instance\n Fleets. Without an allocation strategy, you may specify a maximum of five\n instance type configurations for a fleet.
\nThe instance fleet configuration is available only in Amazon EMR versions\n 4.8.0 and later, excluding 5.0.x versions.
\nAn instance type configuration for each instance type in an instance fleet, which\n determines the Amazon EC2 instances Amazon EMR attempts to provision to\n fulfill On-Demand and Spot target capacities. When you use an allocation strategy, you can\n include a maximum of 30 instance type configurations for a fleet. For more information\n about how to use an allocation strategy, see Configure Instance\n Fleets. Without an allocation strategy, you may specify a maximum of five\n instance type configurations for a fleet.
\nThe instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and later, excluding 5.0.x versions.
\nThe EC2 instance type, for example m3.xlarge
.
The Amazon EC2 instance type, for example m3.xlarge
.
The bid price for each EC2 Spot Instance type as defined by InstanceType
.\n Expressed in USD.
The bid price for each Amazon EC2 Spot Instance type as defined by\n InstanceType
. Expressed in USD.
The bid price, as a percentage of On-Demand price, for each EC2 Spot Instance as defined\n by InstanceType
. Expressed as a number (for example, 20 specifies 20%).
The bid price, as a percentage of On-Demand price, for each Amazon EC2 Spot\n Instance as defined by InstanceType
. Expressed as a number (for example, 20\n specifies 20%).
The configuration specification for each instance type in an instance fleet.
\nThe instance fleet configuration is available only in Amazon EMR versions\n 4.8.0 and later, excluding 5.0.x versions.
\nThe configuration specification for each instance type in an instance fleet.
\nThe instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and later, excluding 5.0.x versions.
\nThe KMS key used for encrypting log files. This attribute is only\n available with EMR version 5.30.0 and later, excluding EMR 6.0.0.
" + "smithy.api#documentation": "The KMS key used for encrypting log files. This attribute is only\n available with Amazon EMR 5.30.0 and later, excluding 6.0.0.
" } }, "AmiVersion": { @@ -5789,31 +5814,31 @@ "target": "com.amazonaws.emr#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Indicates whether the cluster is visible to IAM principals in the Amazon Web Services account associated with the cluster. When true
, IAM principals\n in the Amazon Web Services account can perform EMR cluster actions that their IAM policies\n allow. When false
, only the IAM principal that created the cluster and the\n Amazon Web Services account root user can perform EMR actions, regardless of IAM\n permissions policies attached to other IAM principals.
The default value is true
if a value is not provided when creating a\n cluster using the EMR API RunJobFlow command, the CLI\n create-cluster command, or the Amazon Web Services Management Console.
Indicates whether the cluster is visible to IAM principals in the Amazon Web Services account associated with the cluster. When true
, IAM principals in the Amazon Web Services account can perform Amazon EMR cluster\n actions that their IAM policies allow. When false
, only the\n IAM principal that created the cluster and the Amazon Web Services account\n root user can perform Amazon EMR actions, regardless of IAM\n permissions policies attached to other IAM principals.
The default value is true
if a value is not provided when creating a\n cluster using the Amazon EMR API RunJobFlow command, the CLI\n create-cluster command, or the Amazon Web Services Management Console.
The IAM role that was specified when the job flow was launched. The EC2 instances of the\n job flow assume this role.
" + "smithy.api#documentation": "The IAM role that was specified when the job flow was launched. The\n Amazon EC2 instances of the job flow assume this role.
" } }, "ServiceRole": { "target": "com.amazonaws.emr#XmlString", "traits": { - "smithy.api#documentation": "The IAM role that is assumed by the Amazon EMR service to access Amazon Web Services resources on your behalf.
" + "smithy.api#documentation": "The IAM role that is assumed by the Amazon EMR service to access\n Amazon Web Services resources on your behalf.
" } }, "AutoScalingRole": { "target": "com.amazonaws.emr#XmlString", "traits": { - "smithy.api#documentation": "An IAM role for automatic scaling policies. The default role is\n EMR_AutoScaling_DefaultRole
. The IAM role provides a way for the automatic\n scaling feature to get the required permissions it needs to launch and terminate EC2\n instances in an instance group.
An IAM role for automatic scaling policies. The default role is\n EMR_AutoScaling_DefaultRole
. The IAM role provides a way for\n the automatic scaling feature to get the required permissions it needs to launch and\n terminate Amazon EC2 instances in an instance group.
The way that individual Amazon EC2 instances terminate when an automatic\n scale-in activity occurs or an instance group is resized.\n TERMINATE_AT_INSTANCE_HOUR
indicates that Amazon EMR terminates\n nodes at the instance-hour boundary, regardless of when the request to terminate the\n instance was submitted. This option is only available with Amazon EMR 5.1.0 and\n later and is the default for clusters created using that version.\n TERMINATE_AT_TASK_COMPLETION
indicates that Amazon EMR adds nodes\n to a deny list and drains tasks from nodes before terminating the Amazon EC2\n instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to\n HDFS corruption. TERMINATE_AT_TASK_COMPLETION
available only in Amazon EMR version 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.
The way that individual Amazon EC2 instances terminate when an automatic\n scale-in activity occurs or an instance group is resized.\n TERMINATE_AT_INSTANCE_HOUR
indicates that Amazon EMR terminates\n nodes at the instance-hour boundary, regardless of when the request to terminate the\n instance was submitted. This option is only available with Amazon EMR 5.1.0 and\n later and is the default for clusters created using that version.\n TERMINATE_AT_TASK_COMPLETION
indicates that Amazon EMR adds nodes\n to a deny list and drains tasks from nodes before terminating the Amazon EC2\n instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to\n HDFS corruption. TERMINATE_AT_TASK_COMPLETION
available only in Amazon EMR releases 4.1.0 and later, and is the default for releases of Amazon EMR earlier than 5.1.0.
The EC2 instance type of the master node.
" + "smithy.api#documentation": "The Amazon EC2 instance type of the master node.
" } }, "SlaveInstanceType": { "target": "com.amazonaws.emr#InstanceType", "traits": { - "smithy.api#documentation": "The EC2 instance type of the core and task nodes.
" + "smithy.api#documentation": "The Amazon EC2 instance type of the core and task nodes.
" } }, "InstanceCount": { "target": "com.amazonaws.emr#Integer", "traits": { - "smithy.api#documentation": "The number of EC2 instances in the cluster.
" + "smithy.api#documentation": "The number of Amazon EC2 instances in the cluster.
" } }, "InstanceGroups": { @@ -5965,13 +5990,13 @@ "InstanceFleets": { "target": "com.amazonaws.emr#InstanceFleetConfigList", "traits": { - "smithy.api#documentation": "The instance fleet configuration is available only in Amazon EMR versions\n 4.8.0 and later, excluding 5.0.x versions.
\nDescribes the EC2 instances and instance configurations for clusters that use the\n instance fleet configuration.
" + "smithy.api#documentation": "The instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and later, excluding 5.0.x versions.
\nDescribes the Amazon EC2 instances and instance configurations for clusters that\n use the instance fleet configuration.
" } }, "Ec2KeyName": { "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "The name of the EC2 key pair that can be used to connect to the master node using SSH as\n the user called \"hadoop.\"
" + "smithy.api#documentation": "The name of the Amazon EC2 key pair that can be used to connect to the master\n node using SSH as the user called \"hadoop.\"
" } }, "Placement": { @@ -6009,7 +6034,7 @@ "Ec2SubnetIds": { "target": "com.amazonaws.emr#XmlStringMaxLen256List", "traits": { - "smithy.api#documentation": "Applies to clusters that use the instance fleet configuration. When multiple EC2 subnet\n IDs are specified, Amazon EMR evaluates them and launches instances in the optimal\n subnet.
\nThe instance fleet configuration is available only in Amazon EMR versions\n 4.8.0 and later, excluding 5.0.x versions.
\nApplies to clusters that use the instance fleet configuration. When multiple Amazon EC2 subnet IDs are specified, Amazon EMR evaluates them and launches\n instances in the optimal subnet.
\nThe instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and later, excluding 5.0.x versions.
\nLists all available details about the instance fleets in a cluster.
\nThe instance fleet configuration is available only in Amazon EMR versions\n 4.8.0 and later, excluding 5.0.x versions.
\nLists all available details about the instance fleets in a cluster.
\nThe instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and later, excluding 5.0.x versions.
\nProvides information for all active EC2 instances and EC2 instances terminated in the\n last 30 days, up to a maximum of 2,000. EC2 instances in any of the following states are\n considered active: AWAITING_FULFILLMENT, PROVISIONING, BOOTSTRAPPING, RUNNING.
", + "smithy.api#documentation": "Provides information for all active Amazon EC2 instances and Amazon EC2\n instances terminated in the last 30 days, up to a maximum of 2,000. Amazon EC2\n instances in any of the following states are considered active: AWAITING_FULFILLMENT,\n PROVISIONING, BOOTSTRAPPING, RUNNING.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -6600,7 +6625,7 @@ } ], "traits": { - "smithy.api#documentation": "Provides summaries of all notebook executions. You can filter the list based on multiple\n criteria such as status, time range, and editor id. Returns a maximum of 50 notebook\n executions and a marker to track the paging of a longer notebook execution list across\n multiple ListNotebookExecution
calls.
Provides summaries of all notebook executions. You can filter the list based on multiple\n criteria such as status, time range, and editor id. Returns a maximum of 50 notebook\n executions and a marker to track the paging of a longer notebook execution list across\n multiple ListNotebookExecutions
calls.
The pagination token, returned by a previous ListNotebookExecutions
call,\n that indicates the start of the list for this ListNotebookExecutions
\n call.
The unique ID of the execution engine.
" + } } }, "traits": { @@ -6683,7 +6714,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves release labels of EMR services in the region where the API is called.
", + "smithy.api#documentation": "Retrieves release labels of Amazon EMR services in the Region where the API is\n called.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -7018,7 +7049,7 @@ "ComputeLimits": { "target": "com.amazonaws.emr#ComputeLimits", "traits": { - "smithy.api#documentation": "The EC2 unit limits for a managed scaling policy. The managed scaling activity of a\n cluster is not allowed to go above or below these limits. The limit only applies to the\n core and task nodes. The master node cannot be scaled after initial configuration.
" + "smithy.api#documentation": "The Amazon EC2 unit limits for a managed scaling policy. The managed scaling\n activity of a cluster is not allowed to go above or below these limits. The limit only\n applies to the core and task nodes. The master node cannot be scaled after initial\n configuration.
" } } }, @@ -7153,7 +7184,7 @@ } ], "traits": { - "smithy.api#documentation": "Modifies the target On-Demand and target Spot capacities for the instance fleet with the\n specified InstanceFleetID within the cluster specified using ClusterID. The call either\n succeeds or fails atomically.
\nThe instance fleet configuration is available only in Amazon EMR versions\n 4.8.0 and later, excluding 5.0.x versions.
\nModifies the target On-Demand and target Spot capacities for the instance fleet with the\n specified InstanceFleetID within the cluster specified using ClusterID. The call either\n succeeds or fails atomically.
\nThe instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and later, excluding 5.0.x versions.
\nThe unique identifier of the EMR Notebook that is used for the notebook\n execution.
" + "smithy.api#documentation": "The unique identifier of the Amazon EMR Notebook that is used for the notebook\n execution.
" } }, "ExecutionEngine": { "target": "com.amazonaws.emr#ExecutionEngineConfig", "traits": { - "smithy.api#documentation": "The execution engine, such as an EMR cluster, used to run the EMR notebook and perform\n the notebook execution.
" + "smithy.api#documentation": "The execution engine, such as an Amazon EMR cluster, used to run the Amazon EMR notebook and perform the notebook execution.
" } }, "NotebookExecutionName": { @@ -7260,7 +7291,7 @@ "NotebookParams": { "target": "com.amazonaws.emr#XmlString", "traits": { - "smithy.api#documentation": "Input parameters in JSON format passed to the EMR Notebook at runtime for\n execution.
" + "smithy.api#documentation": "Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for\n execution.
" } }, "Status": { @@ -7302,7 +7333,7 @@ "NotebookInstanceSecurityGroupId": { "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "The unique identifier of the EC2 security group associated with the EMR Notebook\n instance. For more information see Specifying\n EC2 Security Groups for EMR Notebooks in the EMR Management\n Guide.
" + "smithy.api#documentation": "The unique identifier of the Amazon EC2 security group associated with the\n Amazon EMR Notebook instance. For more information see Specifying\n Amazon EC2 Security Groups for Amazon EMR Notebooks in the\n Amazon EMR Management Guide.
" } }, "Tags": { @@ -7310,10 +7341,34 @@ "traits": { "smithy.api#documentation": "A list of tags associated with a notebook execution. Tags are user-defined key-value\n pairs that consist of a required key string with a maximum of 128 characters and an\n optional value string with a maximum of 256 characters.
" } + }, + "NotebookS3Location": { + "target": "com.amazonaws.emr#NotebookS3LocationForOutput", + "traits": { + "smithy.api#documentation": "The Amazon S3 location that stores the notebook execution input.
" + } + }, + "OutputNotebookS3Location": { + "target": "com.amazonaws.emr#OutputNotebookS3LocationForOutput", + "traits": { + "smithy.api#documentation": "The Amazon S3 location for the notebook execution output.
" + } + }, + "OutputNotebookFormat": { + "target": "com.amazonaws.emr#OutputNotebookFormat", + "traits": { + "smithy.api#documentation": "The output format for the notebook execution.
" + } + }, + "EnvironmentVariables": { + "target": "com.amazonaws.emr#EnvironmentVariablesMap", + "traits": { + "smithy.api#documentation": "The environment variables associated with the notebook execution.
" + } } }, "traits": { - "smithy.api#documentation": "A notebook execution. An execution is a specific instance that an EMR Notebook is run\n using the StartNotebookExecution
action.
A notebook execution. An execution is a specific instance that an Amazon EMR\n Notebook is run using the StartNotebookExecution
action.
The timestamp when notebook execution started.
" } + }, + "NotebookS3Location": { + "target": "com.amazonaws.emr#NotebookS3LocationForOutput", + "traits": { + "smithy.api#documentation": "The Amazon S3 location that stores the notebook execution input.
" + } + }, + "ExecutionEngineId": { + "target": "com.amazonaws.emr#XmlString", + "traits": { + "smithy.api#documentation": "The unique ID of the execution engine for the notebook execution.
" + } } }, "traits": { @@ -7431,6 +7498,46 @@ "target": "com.amazonaws.emr#NotebookExecutionSummary" } }, + "com.amazonaws.emr#NotebookS3LocationForOutput": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", + "traits": { + "smithy.api#documentation": "The Amazon S3 bucket that stores the notebook execution input.
" + } + }, + "Key": { + "target": "com.amazonaws.emr#UriString", + "traits": { + "smithy.api#documentation": "The key to the Amazon S3 location that stores the notebook execution\n input.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The Amazon S3 location that stores the notebook execution input.
" + } + }, + "com.amazonaws.emr#NotebookS3LocationFromInput": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", + "traits": { + "smithy.api#documentation": "The Amazon S3 bucket that stores the notebook execution input.
" + } + }, + "Key": { + "target": "com.amazonaws.emr#UriString", + "traits": { + "smithy.api#documentation": "The key to the Amazon S3 location that stores the notebook execution\n input.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The Amazon S3 location that stores the notebook execution input.
" + } + }, "com.amazonaws.emr#OSRelease": { "type": "structure", "members": { @@ -7534,7 +7641,7 @@ } }, "traits": { - "smithy.api#documentation": "The launch specification for On-Demand Instances in the instance fleet, which\n determines the allocation strategy.
\nThe instance fleet configuration is available only in Amazon EMR versions\n 4.8.0 and later, excluding 5.0.x versions. On-Demand Instances allocation strategy is\n available in Amazon EMR version 5.12.1 and later.
\nThe launch specification for On-Demand Instances in the instance fleet, which\n determines the allocation strategy.
\nThe instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and later, excluding 5.0.x versions. On-Demand Instances allocation strategy is\n available in Amazon EMR releases 5.12.1 and later.
\nOn-Demand resize timeout in minutes. If On-Demand Instances are not provisioned within\n this time, the resize workflow stops. The minimum value is 5 minutes, and the maximum value\n is 10,080 minutes (7 days). The timeout applies to all resize workflows on the Instance\n Fleet. The resize could be triggered by Amazon EMR Managed Scaling\n or by the customer (via Amazon EMR Console, Amazon EMR CLI\n modify-instance-fleet or Amazon EMR SDK ModifyInstanceFleet API) or by Amazon EMR due to Amazon EC2 Spot Reclamation.
", + "smithy.api#documentation": "On-Demand resize timeout in minutes. If On-Demand Instances are not provisioned within\n this time, the resize workflow stops. The minimum value is 5 minutes, and the maximum value\n is 10,080 minutes (7 days). The timeout applies to all resize workflows on the Instance\n Fleet. The resize could be triggered by Amazon EMR Managed Scaling or by the\n customer (via Amazon EMR Console, Amazon EMR CLI modify-instance-fleet or\n Amazon EMR SDK ModifyInstanceFleet API) or by Amazon EMR due to Amazon EC2 Spot Reclamation.
", "smithy.api#required": {} } } @@ -7561,25 +7668,76 @@ } } }, + "com.amazonaws.emr#OutputNotebookFormat": { + "type": "enum", + "members": { + "HTML": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTML" + } + } + } + }, + "com.amazonaws.emr#OutputNotebookS3LocationForOutput": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", + "traits": { + "smithy.api#documentation": "The Amazon S3 bucket that stores the notebook execution output.
" + } + }, + "Key": { + "target": "com.amazonaws.emr#UriString", + "traits": { + "smithy.api#documentation": "The key to the Amazon S3 location that stores the notebook execution\n output.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The Amazon S3 location that stores the notebook execution output.
" + } + }, + "com.amazonaws.emr#OutputNotebookS3LocationFromInput": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", + "traits": { + "smithy.api#documentation": "The Amazon S3 bucket that stores the notebook execution output.
" + } + }, + "Key": { + "target": "com.amazonaws.emr#UriString", + "traits": { + "smithy.api#documentation": "The key to the Amazon S3 location that stores the notebook execution\n output.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The Amazon S3 location that stores the notebook execution output.
" + } + }, "com.amazonaws.emr#PlacementGroupConfig": { "type": "structure", "members": { "InstanceRole": { "target": "com.amazonaws.emr#InstanceRoleType", "traits": { - "smithy.api#documentation": "Role of the instance in the cluster.
\nStarting with Amazon EMR version 5.23.0, the only supported instance role is\n MASTER
.
Role of the instance in the cluster.
\nStarting with Amazon EMR release 5.23.0, the only supported instance role is\n MASTER
.
EC2 Placement Group strategy associated with instance role.
\nStarting with Amazon EMR version 5.23.0, the only supported placement strategy\n is SPREAD
for the MASTER
instance role.
Amazon EC2 Placement Group strategy associated with instance role.
\nStarting with Amazon EMR release 5.23.0, the only supported placement strategy\n is SPREAD
for the MASTER
instance role.
Placement group configuration for an Amazon EMR cluster. The configuration\n specifies the placement strategy that can be applied to instance roles during cluster\n creation.
\nTo use this configuration, consider attaching managed policy\n AmazonElasticMapReducePlacementGroupPolicy to the EMR role.
" + "smithy.api#documentation": "Placement group configuration for an Amazon EMR cluster. The configuration\n specifies the placement strategy that can be applied to instance roles during cluster\n creation.
\nTo use this configuration, consider attaching managed policy\n AmazonElasticMapReducePlacementGroupPolicy to the Amazon EMR role.
" } }, "com.amazonaws.emr#PlacementGroupConfigList": { @@ -7629,7 +7787,7 @@ "AvailabilityZones": { "target": "com.amazonaws.emr#XmlStringMaxLen256List", "traits": { - "smithy.api#documentation": "When multiple Availability Zones are specified, Amazon EMR evaluates them and\n launches instances in the optimal Availability Zone. AvailabilityZones
is used\n for instance fleets, while AvailabilityZone
(singular) is used for uniform\n instance groups.
The instance fleet configuration is available only in Amazon EMR versions\n 4.8.0 and later, excluding 5.0.x versions.
\nWhen multiple Availability Zones are specified, Amazon EMR evaluates them and\n launches instances in the optimal Availability Zone. AvailabilityZones
is used\n for instance fleets, while AvailabilityZone
(singular) is used for uniform\n instance groups.
The instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and later, excluding 5.0.x versions.
\nCreates or updates an automatic scaling policy for a core instance group or task\n instance group in an Amazon EMR cluster. The automatic scaling policy defines how\n an instance group dynamically adds and terminates EC2 instances in response to the value of\n a CloudWatch metric.
" + "smithy.api#documentation": "Creates or updates an automatic scaling policy for a core instance group or task\n instance group in an Amazon EMR cluster. The automatic scaling policy defines how\n an instance group dynamically adds and terminates Amazon EC2 instances in response\n to the value of a CloudWatch metric.
" } }, "com.amazonaws.emr#PutAutoScalingPolicyInput": { @@ -7755,7 +7913,7 @@ "target": "com.amazonaws.emr#PutAutoTerminationPolicyOutput" }, "traits": { - "smithy.api#documentation": "Auto-termination is supported in Amazon EMR versions 5.30.0 and 6.1.0 and\n later. For more information, see Using an\n auto-termination policy.
\nCreates or updates an auto-termination policy for an Amazon EMR cluster. An\n auto-termination policy defines the amount of idle time in seconds after which a cluster\n automatically terminates. For alternative cluster termination options, see Control\n cluster termination.
" + "smithy.api#documentation": "Auto-termination is supported in Amazon EMR releases 5.30.0 and 6.1.0 and\n later. For more information, see Using an\n auto-termination policy.
\nCreates or updates an auto-termination policy for an Amazon EMR cluster. An\n auto-termination policy defines the amount of idle time in seconds after which a cluster\n automatically terminates. For alternative cluster termination options, see Control\n cluster termination.
" } }, "com.amazonaws.emr#PutAutoTerminationPolicyInput": { @@ -7812,7 +7970,7 @@ "BlockPublicAccessConfiguration": { "target": "com.amazonaws.emr#BlockPublicAccessConfiguration", "traits": { - "smithy.api#documentation": "A configuration for Amazon EMR block public access. The configuration applies to\n all clusters created in your account for the current Region. The configuration specifies\n whether block public access is enabled. If block public access is enabled, security groups\n associated with the cluster cannot have rules that allow inbound traffic from 0.0.0.0/0 or\n ::/0 on a port, unless the port is specified as an exception using\n PermittedPublicSecurityGroupRuleRanges
in the\n BlockPublicAccessConfiguration
. By default, Port 22 (SSH) is an exception,\n and public access is allowed on this port. You can change this by updating\n BlockPublicSecurityGroupRules
to remove the exception.
For accounts that created clusters in a Region before November 25, 2019, block public\n access is disabled by default in that Region. To use this feature, you must manually\n enable and configure it. For accounts that did not create an EMR cluster in a Region\n before this date, block public access is enabled by default in that Region.
\nA configuration for Amazon EMR block public access. The configuration applies to\n all clusters created in your account for the current Region. The configuration specifies\n whether block public access is enabled. If block public access is enabled, security groups\n associated with the cluster cannot have rules that allow inbound traffic from 0.0.0.0/0 or\n ::/0 on a port, unless the port is specified as an exception using\n PermittedPublicSecurityGroupRuleRanges
in the\n BlockPublicAccessConfiguration
. By default, Port 22 (SSH) is an exception,\n and public access is allowed on this port. You can change this by updating\n BlockPublicSecurityGroupRules
to remove the exception.
For accounts that created clusters in a Region before November 25, 2019, block public\n access is disabled by default in that Region. To use this feature, you must manually\n enable and configure it. For accounts that did not create an Amazon EMR cluster\n in a Region before this date, block public access is enabled by default in that\n Region.
\nCreates or updates a managed scaling policy for an Amazon EMR cluster. The\n managed scaling policy defines the limits for resources, such as EC2 instances that can be\n added or terminated from a cluster. The policy only applies to the core and task nodes. The\n master node cannot be scaled after initial configuration.
" + "smithy.api#documentation": "Creates or updates a managed scaling policy for an Amazon EMR cluster. The\n managed scaling policy defines the limits for resources, such as Amazon EC2\n instances that can be added or terminated from a cluster. The policy only applies to the\n core and task nodes. The master node cannot be scaled after initial configuration.
" } }, "com.amazonaws.emr#PutManagedScalingPolicyInput": { @@ -7846,7 +8004,7 @@ "ClusterId": { "target": "com.amazonaws.emr#ClusterId", "traits": { - "smithy.api#documentation": "Specifies the ID of an EMR cluster where the managed scaling policy is attached.
", + "smithy.api#documentation": "Specifies the ID of an Amazon EMR cluster where the managed scaling policy is\n attached.
", "smithy.api#required": {} } }, @@ -7915,7 +8073,7 @@ "target": "com.amazonaws.emr#RemoveAutoScalingPolicyOutput" }, "traits": { - "smithy.api#documentation": "Removes an automatic scaling policy from a specified instance group within an EMR\n cluster.
" + "smithy.api#documentation": "Removes an automatic scaling policy from a specified instance group within an Amazon EMR cluster.
" } }, "com.amazonaws.emr#RemoveAutoScalingPolicyInput": { @@ -7990,7 +8148,7 @@ "target": "com.amazonaws.emr#RemoveManagedScalingPolicyOutput" }, "traits": { - "smithy.api#documentation": "Removes a managed scaling policy from a specified EMR cluster.
" + "smithy.api#documentation": "Removes a managed scaling policy from a specified Amazon EMR cluster.
" } }, "com.amazonaws.emr#RemoveManagedScalingPolicyInput": { @@ -8100,7 +8258,7 @@ } ], "traits": { - "smithy.api#documentation": "RunJobFlow creates and starts running a new cluster (job flow). The cluster runs the\n steps specified. After the steps complete, the cluster stops and the HDFS partition is\n lost. To prevent loss of data, configure the last step of the job flow to store results in\n Amazon S3. If the JobFlowInstancesConfig\n KeepJobFlowAliveWhenNoSteps
parameter is set to TRUE
, the cluster\n transitions to the WAITING state rather than shutting down after the steps have completed.
For additional protection, you can set the JobFlowInstancesConfig\n TerminationProtected
parameter to TRUE
to lock the cluster and\n prevent it from being terminated by API call, user intervention, or in the event of a job\n flow error.
A maximum of 256 steps are allowed in each job flow.
\nIf your cluster is long-running (such as a Hive data warehouse) or complex, you may\n require more than 256 steps to process your data. You can bypass the 256-step limitation in\n various ways, including using the SSH shell to connect to the master node and submitting\n queries directly to the software running on the master node, such as Hive and\n Hadoop.
\nFor long-running clusters, we recommend that you periodically store your results.
\nThe instance fleets configuration is available only in Amazon EMR versions\n 4.8.0 and later, excluding 5.0.x versions. The RunJobFlow request can contain\n InstanceFleets parameters or InstanceGroups parameters, but not both.
\nRunJobFlow creates and starts running a new cluster (job flow). The cluster runs the\n steps specified. After the steps complete, the cluster stops and the HDFS partition is\n lost. To prevent loss of data, configure the last step of the job flow to store results in\n Amazon S3. If the JobFlowInstancesConfig\n KeepJobFlowAliveWhenNoSteps
parameter is set to TRUE
, the cluster\n transitions to the WAITING state rather than shutting down after the steps have completed.
For additional protection, you can set the JobFlowInstancesConfig\n TerminationProtected
parameter to TRUE
to lock the cluster and\n prevent it from being terminated by API call, user intervention, or in the event of a job\n flow error.
A maximum of 256 steps are allowed in each job flow.
\nIf your cluster is long-running (such as a Hive data warehouse) or complex, you may\n require more than 256 steps to process your data. You can bypass the 256-step limitation in\n various ways, including using the SSH shell to connect to the master node and submitting\n queries directly to the software running on the master node, such as Hive and\n Hadoop.
\nFor long-running clusters, we recommend that you periodically store your results.
\nThe instance fleets configuration is available only in Amazon EMR releases\n 4.8.0 and later, excluding 5.0.x versions. The RunJobFlow request can contain\n InstanceFleets parameters or InstanceGroups parameters, but not both.
\nThe KMS key used for encrypting log files. If a value is not\n provided, the logs remain encrypted by AES-256. This attribute is only available with\n Amazon EMR version 5.30.0 and later, excluding Amazon EMR 6.0.0.
" + "smithy.api#documentation": "The KMS key used for encrypting log files. If a value is not\n provided, the logs remain encrypted by AES-256. This attribute is only available with\n Amazon EMR releases 5.30.0 and later, excluding Amazon EMR 6.0.0.
" } }, "AdditionalInfo": { @@ -8171,7 +8329,7 @@ "NewSupportedProducts": { "target": "com.amazonaws.emr#NewSupportedProductsList", "traits": { - "smithy.api#documentation": "For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and\n later, use Applications.
\nA list of strings that indicates third-party software to use with the job flow that\n accepts a user argument list. EMR accepts and forwards the argument list to the\n corresponding installation script as bootstrap action arguments. For more information, see\n \"Launch a Job Flow on the MapR Distribution for Hadoop\" in the Amazon EMR Developer Guide.\n Supported values are:
\n\"mapr-m3\" - launch the cluster using MapR M3 Edition.
\n\"mapr-m5\" - launch the cluster using MapR M5 Edition.
\n\"mapr\" with the user arguments specifying \"--edition,m3\" or \"--edition,m5\" -\n launch the job flow using MapR M3 or M5 Edition respectively.
\n\"mapr-m7\" - launch the cluster using MapR M7 Edition.
\n\"hunk\" - launch the cluster with the Hunk Big Data Analytics Platform.
\n\"hue\"- launch the cluster with Hue installed.
\n\"spark\" - launch the cluster with Apache Spark installed.
\n\"ganglia\" - launch the cluster with the Ganglia Monitoring System\n installed.
\nFor Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and\n later, use Applications.
\nA list of strings that indicates third-party software to use with the job flow that\n accepts a user argument list. Amazon EMR accepts and forwards the argument list to\n the corresponding installation script as bootstrap action arguments. For more information,\n see \"Launch a Job Flow on the MapR Distribution for Hadoop\" in the Amazon EMR\n Developer Guide. Supported values are:
\n\"mapr-m3\" - launch the cluster using MapR M3 Edition.
\n\"mapr-m5\" - launch the cluster using MapR M5 Edition.
\n\"mapr\" with the user arguments specifying \"--edition,m3\" or \"--edition,m5\" -\n launch the job flow using MapR M3 or M5 Edition respectively.
\n\"mapr-m7\" - launch the cluster using MapR M7 Edition.
\n\"hunk\" - launch the cluster with the Hunk Big Data Analytics Platform.
\n\"hue\"- launch the cluster with Hue installed.
\n\"spark\" - launch the cluster with Apache Spark installed.
\n\"ganglia\" - launch the cluster with the Ganglia Monitoring System\n installed.
\nFor Amazon EMR releases 4.0 and later. The list of configurations supplied for\n the EMR cluster you are creating.
" + "smithy.api#documentation": "For Amazon EMR releases 4.0 and later. The list of configurations supplied for\n the Amazon EMR cluster that you are creating.
" } }, "VisibleToAllUsers": { "target": "com.amazonaws.emr#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "The VisibleToAllUsers parameter is no longer supported. By default, the value is set\n to true
. Setting it to false
now has no effect.
Set this value to true
so that IAM principals in the Amazon Web Services account associated with the cluster can perform EMR actions on the cluster\n that their IAM policies allow. This value defaults to true
for clusters\n created using the EMR API or the CLI\n create-cluster command.
When set to false
, only the IAM principal that created the cluster and the\n Amazon Web Services account root user can perform EMR actions for the cluster, regardless\n of the IAM permissions policies attached to other IAM principals. For more information, see\n Understanding the EMR Cluster VisibleToAllUsers Setting in the\n Amazon EMRManagement Guide.
The VisibleToAllUsers parameter is no longer supported. By default, the value is set\n to true
. Setting it to false
now has no effect.
Set this value to true
so that IAM principals in the Amazon Web Services account associated with the cluster can perform Amazon EMR actions on\n the cluster that their IAM policies allow. This value defaults to\n true
for clusters created using the Amazon EMR API or the CLI\n create-cluster command.
When set to false
, only the IAM principal that created the\n cluster and the Amazon Web Services account root user can perform Amazon EMR actions\n for the cluster, regardless of the IAM permissions policies attached to\n other IAM principals. For more information, see Understanding the Amazon EMR cluster VisibleToAllUsers setting in the\n Amazon EMR Management Guide.
Also called instance profile and EC2 role. An IAM role for an EMR cluster. The EC2\n instances of the cluster assume this role. The default role is\n EMR_EC2_DefaultRole
. In order to use the default role, you must have\n already created it using the CLI or console.
Also called instance profile and Amazon EC2 role. An IAM role for\n an Amazon EMR cluster. The Amazon EC2 instances of the cluster assume this\n role. The default role is EMR_EC2_DefaultRole
. In order to use the default\n role, you must have already created it using the CLI or console.
The IAM role that Amazon EMR assumes in order to access Amazon Web Services\n resources on your behalf. If you've created a custom service role path, you must specify it\n for the service role when you launch your cluster.
" + "smithy.api#documentation": "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\n must specify it for the service role when you launch your cluster.
" } }, "Tags": { @@ -8220,25 +8378,25 @@ "AutoScalingRole": { "target": "com.amazonaws.emr#XmlString", "traits": { - "smithy.api#documentation": "An IAM role for automatic scaling policies. The default role is\n EMR_AutoScaling_DefaultRole
. The IAM role provides permissions that the\n automatic scaling feature requires to launch and terminate EC2 instances in an instance\n group.
An IAM role for automatic scaling policies. The default role is\n EMR_AutoScaling_DefaultRole
. The IAM role provides\n permissions that the automatic scaling feature requires to launch and terminate Amazon EC2 instances in an instance group.
Specifies the way that individual Amazon EC2 instances terminate when an\n automatic scale-in activity occurs or an instance group is resized.\n TERMINATE_AT_INSTANCE_HOUR
indicates that Amazon EMR terminates\n nodes at the instance-hour boundary, regardless of when the request to terminate the\n instance was submitted. This option is only available with Amazon EMR 5.1.0 and\n later and is the default for clusters created using that version.\n TERMINATE_AT_TASK_COMPLETION
indicates that Amazon EMR adds nodes\n to a deny list and drains tasks from nodes before terminating the Amazon EC2\n instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to\n HDFS corruption. TERMINATE_AT_TASK_COMPLETION
available only in Amazon EMR version 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.
Specifies the way that individual Amazon EC2 instances terminate when an\n automatic scale-in activity occurs or an instance group is resized.\n TERMINATE_AT_INSTANCE_HOUR
indicates that Amazon EMR terminates\n nodes at the instance-hour boundary, regardless of when the request to terminate the\n instance was submitted. This option is only available with Amazon EMR 5.1.0 and\n later and is the default for clusters created using that version.\n TERMINATE_AT_TASK_COMPLETION
indicates that Amazon EMR adds nodes\n to a deny list and drains tasks from nodes before terminating the Amazon EC2\n instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to\n HDFS corruption. TERMINATE_AT_TASK_COMPLETION
available only in Amazon EMR releases 4.1.0 and later, and is the default for releases of Amazon EMR earlier than 5.1.0.
Available only in Amazon EMR version 5.7.0 and later. The ID of a custom Amazon\n EBS-backed Linux AMI. If specified, Amazon EMR uses this AMI when it launches\n cluster EC2 instances. For more information about custom AMIs in Amazon EMR, see\n Using a\n Custom AMI in the Amazon EMR Management Guide. If\n omitted, the cluster uses the base Linux AMI for the ReleaseLabel
specified.\n For Amazon EMR versions 2.x and 3.x, use AmiVersion
instead.
For information about creating a custom AMI, see Creating an Amazon EBS-Backed Linux AMI in the Amazon Elastic Compute Cloud User Guide for Linux\n Instances. For information about finding an AMI ID, see Finding a Linux\n AMI.
" + "smithy.api#documentation": "Available only in Amazon EMR releases 5.7.0 and later. The ID of a custom Amazon\n EBS-backed Linux AMI. If specified, Amazon EMR uses this AMI when it launches\n cluster Amazon EC2 instances. For more information about custom AMIs in Amazon EMR, see Using a Custom AMI in the\n Amazon EMR Management Guide. If omitted, the cluster\n uses the base Linux AMI for the ReleaseLabel
specified. For Amazon EMR\n releases 2.x and 3.x, use AmiVersion
instead.
For information about creating a custom AMI, see Creating an Amazon EBS-Backed Linux AMI in the Amazon Elastic Compute Cloud User Guide for Linux\n Instances. For information about finding an AMI ID, see Finding a Linux\n AMI.
" } }, "EbsRootVolumeSize": { "target": "com.amazonaws.emr#Integer", "traits": { - "smithy.api#documentation": "The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is\n used for each EC2 instance. Available in Amazon EMR version 4.x and later.
" + "smithy.api#documentation": "The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is\n used for each Amazon EC2 instance. Available in Amazon EMR releases 4.x and\n later.
" } }, "RepoUpgradeOnBoot": { @@ -8351,20 +8509,20 @@ "MinCapacity": { "target": "com.amazonaws.emr#Integer", "traits": { - "smithy.api#documentation": "The lower boundary of EC2 instances in an instance group below which scaling activities\n are not allowed to shrink. Scale-in activities will not terminate instances below this\n boundary.
", + "smithy.api#documentation": "The lower boundary of Amazon EC2 instances in an instance group below which\n scaling activities are not allowed to shrink. Scale-in activities will not terminate\n instances below this boundary.
", "smithy.api#required": {} } }, "MaxCapacity": { "target": "com.amazonaws.emr#Integer", "traits": { - "smithy.api#documentation": "The upper boundary of EC2 instances in an instance group beyond which scaling activities\n are not allowed to grow. Scale-out activities will not add instances beyond this\n boundary.
", + "smithy.api#documentation": "The upper boundary of Amazon EC2 instances in an instance group beyond which\n scaling activities are not allowed to grow. Scale-out activities will not add instances\n beyond this boundary.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The upper and lower EC2 instance limits for an automatic scaling policy. Automatic\n scaling activities triggered by automatic scaling rules will not cause an instance group to\n grow above or below these limits.
" + "smithy.api#documentation": "The upper and lower Amazon EC2 instance limits for an automatic scaling policy.\n Automatic scaling activities triggered by automatic scaling rules will not cause an\n instance group to grow above or below these limits.
" } }, "com.amazonaws.emr#ScalingRule": { @@ -8399,7 +8557,7 @@ } }, "traits": { - "smithy.api#documentation": "A scale-in or scale-out rule that defines scaling activity, including the CloudWatch\n metric alarm that triggers activity, how EC2 instances are added or removed, and the\n periodicity of adjustments. The automatic scaling policy for an instance group can comprise\n one or more automatic scaling rules.
" + "smithy.api#documentation": "A scale-in or scale-out rule that defines scaling activity, including the CloudWatch\n metric alarm that triggers activity, how Amazon EC2 instances are added or removed,\n and the periodicity of adjustments. The automatic scaling policy for an instance group can\n comprise one or more automatic scaling rules.
" } }, "com.amazonaws.emr#ScalingRuleList": { @@ -8590,7 +8748,7 @@ } ], "traits": { - "smithy.api#documentation": "SetTerminationProtection locks a cluster (job flow) so the EC2 instances in the cluster\n cannot be terminated by user intervention, an API call, or in the event of a job-flow\n error. The cluster still terminates upon successful completion of the job flow. Calling\n SetTerminationProtection
on a cluster is similar to calling the Amazon EC2\n DisableAPITermination
API on all EC2 instances in a cluster.
\n SetTerminationProtection
is used to prevent accidental termination of a\n cluster and to ensure that in the event of an error, the instances persist so that you can\n recover any data stored in their ephemeral instance storage.
To terminate a cluster that has been locked by setting\n SetTerminationProtection
to true
, you must first unlock the\n job flow by a subsequent call to SetTerminationProtection
in which you set the\n value to false
.
For more information, seeManaging Cluster\n Termination in the Amazon EMR Management Guide.
" + "smithy.api#documentation": "SetTerminationProtection locks a cluster (job flow) so the Amazon EC2 instances\n in the cluster cannot be terminated by user intervention, an API call, or in the event of a\n job-flow error. The cluster still terminates upon successful completion of the job flow.\n Calling SetTerminationProtection
on a cluster is similar to calling the\n Amazon EC2\n DisableAPITermination
API on all Amazon EC2 instances in a\n cluster.
\n SetTerminationProtection
is used to prevent accidental termination of a\n cluster and to ensure that in the event of an error, the instances persist so that you can\n recover any data stored in their ephemeral instance storage.
To terminate a cluster that has been locked by setting\n SetTerminationProtection
to true
, you must first unlock the\n job flow by a subsequent call to SetTerminationProtection
in which you set the\n value to false
.
For more information, seeManaging Cluster\n Termination in the Amazon EMR Management Guide.
" } }, "com.amazonaws.emr#SetTerminationProtectionInput": { @@ -8631,7 +8789,7 @@ } ], "traits": { - "smithy.api#documentation": "The SetVisibleToAllUsers parameter is no longer supported. Your cluster may be\n visible to all users in your account. To restrict cluster access using an IAM policy, see Identity and Access\n Management for EMR.
\nSets the Cluster$VisibleToAllUsers value for an EMR cluster. When\n true
, IAM principals in the Amazon Web Services account can perform EMR\n cluster actions that their IAM policies allow. When false
, only\n the IAM principal that created the cluster and the Amazon Web Services account root user can\n perform EMR actions on the cluster, regardless of IAM permissions policies attached to\n other IAM principals.
This action works on running clusters. When you create a cluster, use the RunJobFlowInput$VisibleToAllUsers parameter.
\nFor more information, see Understanding the EMR Cluster VisibleToAllUsers Setting in the\n Amazon EMRManagement Guide.
" + "smithy.api#documentation": "The SetVisibleToAllUsers parameter is no longer supported. Your cluster may be\n visible to all users in your account. To restrict cluster access using an IAM policy, see Identity and Access\n Management for Amazon EMR.
\nSets the Cluster$VisibleToAllUsers value for an Amazon EMR\n cluster. When true
, IAM principals in the Amazon Web Services account can perform Amazon EMR cluster actions that their IAM policies allow. When false
, only the IAM\n principal that created the cluster and the Amazon Web Services account root user can perform\n Amazon EMR actions on the cluster, regardless of IAM permissions\n policies attached to other IAM principals.
This action works on running clusters. When you create a cluster, use the RunJobFlowInput$VisibleToAllUsers parameter.
\nFor more information, see Understanding the Amazon EMR Cluster VisibleToAllUsers Setting in the\n Amazon EMR Management Guide.
" } }, "com.amazonaws.emr#SetVisibleToAllUsersInput": { @@ -8648,7 +8806,7 @@ "target": "com.amazonaws.emr#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "A value of true
indicates that an IAM principal in the Amazon Web Services account can perform EMR actions on the cluster that the IAM policies attached\n to the principal allow. A value of false
indicates that only the IAM principal\n that created the cluster and the Amazon Web Services root user can perform EMR actions on\n the cluster.
A value of true
indicates that an IAM principal in the\n Amazon Web Services account can perform Amazon EMR actions on the cluster that\n the IAM policies attached to the principal allow. A value of\n false
indicates that only the IAM principal that created the\n cluster and the Amazon Web Services root user can perform Amazon EMR actions on the\n cluster.
The way in which EC2 instances are added (if ScalingAdjustment
is a\n positive number) or terminated (if ScalingAdjustment
is a negative number)\n each time the scaling activity is triggered. CHANGE_IN_CAPACITY
is the\n default. CHANGE_IN_CAPACITY
indicates that the EC2 instance count increments\n or decrements by ScalingAdjustment
, which should be expressed as an integer.\n PERCENT_CHANGE_IN_CAPACITY
indicates the instance count increments or\n decrements by the percentage specified by ScalingAdjustment
, which should be\n expressed as an integer. For example, 20 indicates an increase in 20% increments of cluster\n capacity. EXACT_CAPACITY
indicates the scaling activity results in an instance\n group with the number of EC2 instances specified by ScalingAdjustment
, which\n should be expressed as a positive integer.
The way in which Amazon EC2 instances are added (if\n ScalingAdjustment
is a positive number) or terminated (if\n ScalingAdjustment
is a negative number) each time the scaling activity is\n triggered. CHANGE_IN_CAPACITY
is the default. CHANGE_IN_CAPACITY
\n indicates that the Amazon EC2 instance count increments or decrements by\n ScalingAdjustment
, which should be expressed as an integer.\n PERCENT_CHANGE_IN_CAPACITY
indicates the instance count increments or\n decrements by the percentage specified by ScalingAdjustment
, which should be\n expressed as an integer. For example, 20 indicates an increase in 20% increments of cluster\n capacity. EXACT_CAPACITY
indicates the scaling activity results in an instance\n group with the number of Amazon EC2 instances specified by\n ScalingAdjustment
, which should be expressed as a positive integer.
The amount by which to scale in or scale out, based on the specified\n AdjustmentType
. A positive value adds to the instance group's EC2 instance\n count while a negative number removes instances. If AdjustmentType
is set to\n EXACT_CAPACITY
, the number should only be a positive integer. If\n AdjustmentType
is set to PERCENT_CHANGE_IN_CAPACITY
, the value\n should express the percentage as an integer. For example, -20 indicates a decrease in 20%\n increments of cluster capacity.
The amount by which to scale in or scale out, based on the specified\n AdjustmentType
. A positive value adds to the instance group's Amazon EC2 instance count while a negative number removes instances. If\n AdjustmentType
is set to EXACT_CAPACITY
, the number should\n only be a positive integer. If AdjustmentType
is set to\n PERCENT_CHANGE_IN_CAPACITY
, the value should express the percentage as an\n integer. For example, -20 indicates a decrease in 20% increments of cluster\n capacity.
An automatic scaling configuration, which describes how the policy adds or removes\n instances, the cooldown period, and the number of EC2 instances that will be added each\n time the CloudWatch metric alarm condition is satisfied.
" + "smithy.api#documentation": "An automatic scaling configuration, which describes how the policy adds or removes\n instances, the cooldown period, and the number of Amazon EC2 instances that will be\n added each time the CloudWatch metric alarm condition is satisfied.
" } }, "com.amazonaws.emr#SimplifiedApplication": { @@ -8773,7 +8931,7 @@ } }, "traits": { - "smithy.api#documentation": "The launch specification for Spot Instances in the instance fleet, which determines the\n defined duration, provisioning timeout behavior, and allocation strategy.
\nThe instance fleet configuration is available only in Amazon EMR versions\n 4.8.0 and later, excluding 5.0.x versions. Spot Instance allocation strategy is\n available in Amazon EMR version 5.12.1 and later.
\nSpot Instances with a defined duration (also known as Spot blocks) are no longer\n available to new customers from July 1, 2021. For customers who have previously used the\n feature, we will continue to support Spot Instances with a defined duration until\n December 31, 2022.
\nThe launch specification for Spot Instances in the instance fleet, which determines the\n defined duration, provisioning timeout behavior, and allocation strategy.
\nThe instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and later, excluding 5.0.x versions. Spot Instance allocation strategy is\n available in Amazon EMR releases 5.12.1 and later.
\nSpot Instances with a defined duration (also known as Spot blocks) are no longer\n available to new customers from July 1, 2021. For customers who have previously used the\n feature, we will continue to support Spot Instances with a defined duration until\n December 31, 2022.
\nThe unique identifier of the EMR Notebook to use for notebook execution.
", - "smithy.api#required": {} + "smithy.api#documentation": "The unique identifier of the Amazon EMR Notebook to use for notebook\n execution.
" } }, "RelativePath": { "target": "com.amazonaws.emr#XmlString", "traits": { - "smithy.api#documentation": "The path and file name of the notebook file for this execution, relative to the path\n specified for the EMR Notebook. For example, if you specify a path of\n s3://MyBucket/MyNotebooks
when you create an EMR Notebook for a notebook\n with an ID of e-ABCDEFGHIJK1234567890ABCD
(the EditorID
of this\n request), and you specify a RelativePath
of\n my_notebook_executions/notebook_execution.ipynb
, the location of the file\n for the notebook execution is\n s3://MyBucket/MyNotebooks/e-ABCDEFGHIJK1234567890ABCD/my_notebook_executions/notebook_execution.ipynb
.
The path and file name of the notebook file for this execution, relative to the path\n specified for the Amazon EMR Notebook. For example, if you specify a path of\n s3://MyBucket/MyNotebooks
when you create an Amazon EMR Notebook\n for a notebook with an ID of e-ABCDEFGHIJK1234567890ABCD
(the\n EditorID
of this request), and you specify a RelativePath
of\n my_notebook_executions/notebook_execution.ipynb
, the location of the file\n for the notebook execution is\n s3://MyBucket/MyNotebooks/e-ABCDEFGHIJK1234567890ABCD/my_notebook_executions/notebook_execution.ipynb
.
Input parameters in JSON format passed to the EMR Notebook at runtime for\n execution.
" + "smithy.api#documentation": "Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for\n execution.
" } }, "ExecutionEngine": { @@ -8867,14 +9023,14 @@ "ServiceRole": { "target": "com.amazonaws.emr#XmlString", "traits": { - "smithy.api#documentation": "The name or ARN of the IAM role that is used as the service role for Amazon EMR\n (the EMR role) for the notebook execution.
", + "smithy.api#documentation": "The name or ARN of the IAM role that is used as the service role for\n Amazon EMR (the Amazon EMR role) for the notebook execution.
", "smithy.api#required": {} } }, "NotebookInstanceSecurityGroupId": { "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "The unique identifier of the Amazon EC2 security group to associate with the EMR\n Notebook for this notebook execution.
" + "smithy.api#documentation": "The unique identifier of the Amazon EC2 security group to associate with the\n Amazon EMR Notebook for this notebook execution.
" } }, "Tags": { @@ -8882,6 +9038,30 @@ "traits": { "smithy.api#documentation": "A list of tags associated with a notebook execution. Tags are user-defined key-value\n pairs that consist of a required key string with a maximum of 128 characters and an\n optional value string with a maximum of 256 characters.
" } + }, + "NotebookS3Location": { + "target": "com.amazonaws.emr#NotebookS3LocationFromInput", + "traits": { + "smithy.api#documentation": "The Amazon S3 location for the notebook execution input.
" + } + }, + "OutputNotebookS3Location": { + "target": "com.amazonaws.emr#OutputNotebookS3LocationFromInput", + "traits": { + "smithy.api#documentation": "The Amazon S3 location for the notebook execution output.
" + } + }, + "OutputNotebookFormat": { + "target": "com.amazonaws.emr#OutputNotebookFormat", + "traits": { + "smithy.api#documentation": "The output format for the notebook execution.
" + } + }, + "EnvironmentVariables": { + "target": "com.amazonaws.emr#EnvironmentVariablesMap", + "traits": { + "smithy.api#documentation": "The environment variables associated with the notebook execution.
" + } } }, "traits": { @@ -8973,7 +9153,7 @@ "ExecutionRoleArn": { "target": "com.amazonaws.emr#OptionalArnType", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the runtime role for a step on the cluster. The\n runtime role can be a cross-account IAM role. The runtime role ARN is a combination of\n account ID, role name, and role type using the following format:\n arn:partition:service:region:account:resource
.
For example, arn:aws:iam::1234567890:role/ReadOnly
is a correctly formatted\n runtime role ARN.
The Amazon Resource Name (ARN) of the runtime role for a step on the cluster. The\n runtime role can be a cross-account IAM role. The runtime role ARN is a\n combination of account ID, role name, and role type using the following format:\n arn:partition:service:region:account:resource
.
For example, arn:aws:IAM::1234567890:role/ReadOnly
is a correctly formatted\n runtime role ARN.
Specifies whether the Amazon EMR Studio authenticates users using IAM or IAM Identity Center.
" + "smithy.api#documentation": "Specifies whether the Amazon EMR Studio authenticates users with IAM or IAM Identity Center.
" } }, "VpcId": { @@ -9449,7 +9629,7 @@ "UserRole": { "target": "com.amazonaws.emr#XmlString", "traits": { - "smithy.api#documentation": "The name of the IAM role assumed by users logged in to the Amazon EMR Studio. A\n Studio only requires a UserRole
when you use IAM\n authentication.
The name of the IAM role assumed by users logged in to the Amazon EMR Studio. A Studio only requires a UserRole
when you use IAM authentication.
Details for an Amazon EMR Studio, including ID, Name, VPC, and Description. The\n details do not include subnets, IAM roles, security groups, or tags associated with the\n Studio.
" + "smithy.api#documentation": "Details for an Amazon EMR Studio, including ID, Name, VPC, and Description. The\n details do not include subnets, IAM roles, security groups, or tags\n associated with the Studio.
" } }, "com.amazonaws.emr#StudioSummaryList": { @@ -9584,7 +9764,7 @@ } }, "traits": { - "smithy.api#documentation": "The list of supported product configurations that allow user-supplied arguments. EMR\n accepts these arguments and forwards them to the corresponding installation script as\n bootstrap action arguments.
" + "smithy.api#documentation": "The list of supported product configurations that allow user-supplied arguments. Amazon EMR accepts these arguments and forwards them to the corresponding installation\n script as bootstrap action arguments.
" } }, "com.amazonaws.emr#SupportedProductsList": { @@ -9633,7 +9813,7 @@ } ], "traits": { - "smithy.api#documentation": "TerminateJobFlows shuts a list of clusters (job flows) down. When a job flow is shut\n down, any step not yet completed is canceled and the EC2 instances on which the cluster is\n running are stopped. Any log files not already saved are uploaded to Amazon S3 if a\n LogUri was specified when the cluster was created.
\nThe maximum number of clusters allowed is 10. The call to TerminateJobFlows
\n is asynchronous. Depending on the configuration of the cluster, it may take up to 1-5\n minutes for the cluster to completely terminate and release allocated resources, such as\n Amazon EC2 instances.
TerminateJobFlows shuts a list of clusters (job flows) down. When a job flow is shut\n down, any step not yet completed is canceled and the Amazon EC2 instances on which\n the cluster is running are stopped. Any log files not already saved are uploaded to Amazon S3 if a LogUri was specified when the cluster was created.
\nThe maximum number of clusters allowed is 10. The call to TerminateJobFlows
\n is asynchronous. Depending on the configuration of the cluster, it may take up to 1-5\n minutes for the cluster to completely terminate and release allocated resources, such as\n Amazon EC2 instances.
The username associated with the temporary credentials that you use to connect to cluster endpoints.
" + "smithy.api#documentation": "The username associated with the temporary credentials that you use to connect to\n cluster endpoints.
" } }, "Password": { "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "The password associated with the temporary credentials that you use to connect to cluster endpoints.
" + "smithy.api#documentation": "The password associated with the temporary credentials that you use to connect to\n cluster endpoints.
" } } }, @@ -9999,7 +10189,7 @@ } }, "traits": { - "smithy.api#documentation": "EBS volume specifications such as volume type, IOPS, size (GiB) and throughput (MiB/s)\n that are requested for the EBS volume attached to an EC2 instance in the cluster.
" + "smithy.api#documentation": "EBS volume specifications such as volume type, IOPS, size (GiB) and throughput (MiB/s)\n that are requested for the EBS volume attached to an Amazon EC2 instance in the\n cluster.
" } }, "com.amazonaws.emr#WholeNumber": {