String clusterId
The unique identifier of the cluster.
InstanceFleetConfig instanceFleet
Specifies the configuration of the instance fleet.
SdkInternalList<T> instanceGroups
Instance groups to add.
String jobFlowId
Job flow in which to add the instance groups.
String jobFlowId
The job flow ID in which the instance groups are added.
SdkInternalList<T> instanceGroupIds
Instance group IDs of the newly created instance groups.
String clusterArn
The Amazon Resource Name of the cluster.
String jobFlowId
A string that uniquely identifies the job flow. This identifier is returned by RunJobFlow and can also be obtained from ListClusters.
SdkInternalList<T> steps
A list of StepConfig to be executed by the job flow.
String executionRoleArn
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: arn:partition:service:region:account:resource
.
For example, arn:aws:iam::1234567890:role/ReadOnly
is a correctly formatted runtime role ARN.
SdkInternalList<T> stepIds
The identifiers of the list of steps added to the job flow.
String resourceId
The Amazon EMR resource identifier to which tags will be added. For example, a cluster identifier or an Amazon EMR Studio ID.
SdkInternalList<T> tags
A list of tags to associate with a resource. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters, and an optional value string with a maximum of 256 characters.
String name
The name of the application.
String version
The version of the application.
SdkInternalList<T> args
Arguments for Amazon EMR to pass to the application.
SdkInternalMap<K,V> additionalInfo
This option is for advanced users only. This is meta information about third-party applications that third-party vendors use for testing purposes.
ScalingConstraints constraints
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 limits.
SdkInternalList<T> rules
The scale-in and scale-out rules that comprise the automatic scaling policy.
AutoScalingPolicyStatus status
The status of an automatic scaling policy.
ScalingConstraints constraints
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 limits.
SdkInternalList<T> rules
The scale-in and scale-out rules that comprise the automatic scaling policy.
String code
The code indicating the reason for the change in status.USER_REQUEST
indicates that the scaling
policy status was changed by a user. PROVISION_FAILURE
indicates that the status change was because
the policy failed to provision. CLEANUP_FAILURE
indicates an error.
String message
A friendly, more verbose message that accompanies an automatic scaling policy state change.
String state
Indicates the status of the automatic scaling policy.
AutoScalingPolicyStateChangeReason stateChangeReason
The reason for a change in status.
Long idleTimeout
Specifies the amount of idle time in seconds after which the cluster automatically terminates. You can specify a minimum of 60 seconds and a maximum of 604800 seconds (seven days).
Boolean blockPublicSecurityGroupRules
Indicates 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
.
SdkInternalList<T> permittedPublicSecurityGroupRuleRanges
Specifies ports and port ranges that are permitted to have security group rules that allow inbound traffic from
all public sources. For example, if Port 23 (Telnet) is specified for
PermittedPublicSecurityGroupRuleRanges
, Amazon EMR 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
.
String name
The name of the bootstrap action.
ScriptBootstrapActionConfig scriptBootstrapAction
The script run by the bootstrap action.
BootstrapActionConfig bootstrapActionConfig
A description of the bootstrap action.
String clusterId
The ClusterID
for the specified steps that will be canceled. Use RunJobFlow and
ListClusters to get ClusterIDs.
SdkInternalList<T> stepIds
The list of StepIDs
to cancel. Use ListSteps to get steps and their states for the specified
cluster.
String stepCancellationOption
The option to choose to cancel RUNNING
steps. By default, the value is SEND_INTERRUPT
.
SdkInternalList<T> cancelStepsInfoList
A list of CancelStepsInfo, which shows the status of specified cancel requests for each
StepID
specified.
String comparisonOperator
Determines how the metric specified by MetricName
is compared to the value specified by
Threshold
.
Integer evaluationPeriods
The number of periods, in five-minute increments, during which the alarm condition must exist before the alarm
triggers automatic scaling activity. The default value is 1
.
String metricName
The name of the CloudWatch metric that is watched to determine an alarm condition.
String namespace
The namespace for the CloudWatch metric. The default is AWS/ElasticMapReduce
.
Integer period
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
.
String statistic
The statistic to apply to the metric associated with the alarm. The default is AVERAGE
.
Double threshold
The value against which the specified statistic is compared.
String unit
The unit of measure associated with the CloudWatch metric being watched. The value specified for
Unit
must correspond to the units specified in the CloudWatch metric.
SdkInternalList<T> dimensions
A CloudWatch metric dimension.
String id
The unique identifier for the cluster.
String name
The name of the cluster.
ClusterStatus status
The current status details about the cluster.
Ec2InstanceAttributes ec2InstanceAttributes
Provides information about the EC2 instances in a cluster grouped by category. For example, key name, subnet ID, IAM instance profile, and so on.
String instanceCollectionType
The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.
The instance group configuration of the cluster. A value of INSTANCE_GROUP
indicates a uniform
instance group configuration. A value of INSTANCE_FLEET
indicates an instance fleets configuration.
String logUri
The path to the Amazon S3 location where logs for this cluster are stored.
String logEncryptionKmsKeyId
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.
String requestedAmiVersion
The AMI version requested for this cluster.
String runningAmiVersion
The AMI version running on this cluster.
String releaseLabel
The Amazon EMR release label, which determines the version of open-source application packages installed on the
cluster. Release labels are in the form emr-x.x.x
, where x.x.x is an Amazon EMR release version such
as emr-5.14.0
. For more information about Amazon EMR release versions and included application
versions and features, see https://docs.aws.amazon.
com/emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR releases version 4.0 and later.
Earlier versions use AmiVersion
.
Boolean autoTerminate
Specifies whether the cluster should terminate after completing all steps.
Boolean terminationProtected
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.
Boolean visibleToAllUsers
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.
The default value is true
if a value is not provided when creating a cluster using the EMR API
RunJobFlow command, the CLI create-cluster command, or
the Amazon Web Services Management Console.
SdkInternalList<T> applications
The applications installed on this cluster.
SdkInternalList<T> tags
A list of tags associated with a cluster.
String serviceRole
The IAM role that Amazon EMR assumes in order to access Amazon Web Services resources on your behalf.
Integer normalizedInstanceHours
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.
String masterPublicDnsName
The DNS name of the master node. If the cluster is on a private subnet, this is the private DNS name. On a public subnet, this is the public DNS name.
SdkInternalList<T> configurations
Applies only to Amazon EMR releases 4.x and later. The list of Configurations supplied to the EMR cluster.
String securityConfiguration
The name of the security configuration applied to the cluster.
String autoScalingRole
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.
String scaleDownBehavior
The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance
group is resized. TERMINATE_AT_INSTANCE_HOUR
indicates that Amazon EMR terminates nodes at the
instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is
only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version.
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.
String customAmiId
Available only in Amazon EMR version 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI if the cluster uses a custom AMI.
Integer ebsRootVolumeSize
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.
String repoUpgradeOnBoot
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 AMI.
KerberosAttributes kerberosAttributes
Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. For more information see Use Kerberos Authentication in the Amazon EMR Management Guide.
String clusterArn
The Amazon Resource Name of the cluster.
String outpostArn
The Amazon Resource Name (ARN) of the Outpost where the cluster is launched.
Integer stepConcurrencyLevel
Specifies the number of steps that can be executed concurrently.
SdkInternalList<T> placementGroups
Placement group configured for an Amazon EMR cluster.
String oSReleaseLabel
The Amazon Linux release specified in a cluster launch RunJobFlow request. If no Amazon Linux release was specified, the default Amazon Linux release is shown in the response.
String state
The current state of the cluster.
ClusterStateChangeReason stateChangeReason
The reason for the cluster status change.
ClusterTimeline timeline
A timeline that represents the status of a cluster over the lifetime of the cluster.
String id
The unique identifier for the cluster.
String name
The name of the cluster.
ClusterStatus status
The details about the current status of the cluster.
Integer normalizedInstanceHours
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.
String clusterArn
The Amazon Resource Name of the cluster.
String outpostArn
The Amazon Resource Name (ARN) of the Outpost where the cluster is launched.
String name
The name of the command.
String scriptPath
The Amazon S3 location of the command script.
SdkInternalList<T> args
Arguments for Amazon EMR to pass to the command for execution.
String unitType
The unit type used for specifying a managed scaling policy.
Integer minimumCapacityUnits
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.
Integer maximumCapacityUnits
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.
Integer maximumOnDemandCapacityUnits
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.
Integer maximumCoreCapacityUnits
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.
String classification
The classification within a configuration.
SdkInternalList<T> configurations
A list of additional configurations to apply within a configuration object.
SdkInternalMap<K,V> properties
A set of properties specified within a configuration classification.
String name
The name of the security configuration.
String securityConfiguration
The security configuration details in JSON format. For JSON parameters and examples, see Use Security Configurations to Set Up Cluster Security in the Amazon EMR Management Guide.
String name
A descriptive name for the Amazon EMR Studio.
String description
A detailed description of the Amazon EMR Studio.
String authMode
Specifies whether the Studio authenticates users using IAM or Amazon Web Services SSO.
String vpcId
The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
SdkInternalList<T> subnetIds
A list of subnet IDs to associate with the Amazon EMR Studio. A Studio can have a maximum of 5 subnets. The
subnets must belong to the VPC specified by VpcId
. Studio users can create a Workspace in any of the
specified subnets.
String serviceRole
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.
String userRole
The IAM user role that users and groups assume when logged in to an Amazon EMR Studio. Only specify a
UserRole
when you use Amazon Web Services SSO authentication. The permissions attached to the
UserRole
can be scoped down for each user or group using session policies.
String workspaceSecurityGroupId
The ID of the Amazon EMR Studio Workspace security group. The Workspace security group allows outbound network
traffic to resources in the Engine security group, and it must be in the same VPC specified by VpcId
.
String engineSecurityGroupId
The ID of the Amazon EMR Studio Engine security group. The Engine security group allows inbound network traffic
from the Workspace security group, and it must be in the same VPC specified by VpcId
.
String defaultS3Location
The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.
String idpAuthUrl
The authentication endpoint of your identity provider (IdP). Specify this value when you use IAM authentication and want to let federated users log in to a Studio with the Studio URL and credentials from your IdP. Amazon EMR Studio redirects users to this endpoint to enter credentials.
String idpRelayStateParameterName
The name that your identity provider (IdP) uses for its RelayState
parameter. For example,
RelayState
or TargetSource
. Specify this value when you use IAM authentication and want
to let federated users log in to a Studio using the Studio URL. The RelayState
parameter differs by
IdP.
SdkInternalList<T> tags
A list of tags to associate with the Amazon EMR Studio. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters, and an optional value string with a maximum of 256 characters.
String studioId
The ID of the Amazon EMR Studio to which the user or group will be mapped.
String identityId
String identityName
The name of the user or group. For more information, see UserName and DisplayName in the Amazon Web Services SSO Identity Store API Reference. Either
IdentityName
or IdentityId
must be specified, but not both.
String identityType
Specifies whether the identity to map to the Amazon EMR Studio is a user or a group.
String sessionPolicyArn
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.
String name
The name of the security configuration.
String studioId
The ID of the Amazon EMR Studio.
String studioId
The ID of the Amazon EMR Studio.
String identityId
String identityName
The name of the user name or group to remove from the Amazon EMR Studio. For more information, see UserName and DisplayName in the Amazon Web Services SSO Store API Reference. Either IdentityName
or
IdentityId
must be specified.
String identityType
Specifies whether the identity to delete from the Amazon EMR Studio is a user or a group.
String clusterId
The identifier of the cluster to describe.
Cluster cluster
This output contains the details for the requested cluster.
Date createdAfter
Return only job flows created after this date and time.
Date createdBefore
Return only job flows created before this date and time.
SdkInternalList<T> jobFlowIds
Return only job flows whose job flow ID is contained in this list.
SdkInternalList<T> jobFlowStates
Return only job flows whose state is contained in this list.
SdkInternalList<T> jobFlows
A list of job flows matching the parameters supplied.
String notebookExecutionId
The unique identifier of the notebook execution.
NotebookExecution notebookExecution
Properties of the notebook execution.
String releaseLabel
The target release label described in the response.
SdkInternalList<T> applications
The list of applications available for the target release label. Name
is the name of the
application. Version
is the concise version of the application.
String nextToken
The pagination token. Reserved for future use. Currently set to null.
SdkInternalList<T> availableOSReleases
The list of available Amazon Linux release versions for an Amazon EMR release. Contains a Label field that is formatted as shown in Amazon Linux 2 Release Notes . For example, 2.0.20220218.1.
String name
The name of the security configuration.
Step step
The step details for the requested step identifier.
String studioId
The Amazon EMR Studio ID.
Studio studio
The Amazon EMR Studio details.
VolumeSpecification volumeSpecification
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.
String device
The device name that is exposed to the instance, such as /dev/sdh.
VolumeSpecification volumeSpecification
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.
Integer volumesPerInstance
Number of EBS volumes with a specific volume configuration that are associated with every instance in the instance group
SdkInternalList<T> ebsBlockDeviceConfigs
An array of Amazon EBS volume specifications attached to a cluster instance.
Boolean ebsOptimized
Indicates whether an Amazon EBS volume is EBS-optimized.
String ec2KeyName
The name of the Amazon EC2 key pair to use when connecting with SSH into the master node as a user named "hadoop".
String ec2SubnetId
Set this parameter to the identifier of the Amazon VPC subnet where you want the cluster to launch. If you do not specify this value, and your account supports EC2-Classic, the cluster launches in EC2-Classic.
SdkInternalList<T> requestedEc2SubnetIds
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.
String ec2AvailabilityZone
The Availability Zone in which the cluster will run.
SdkInternalList<T> requestedEc2AvailabilityZones
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. RequestedEc2SubnetIDs
and
RequestedEc2AvailabilityZones
cannot be specified together.
String iamInstanceProfile
The IAM role that was specified when the cluster was launched. The EC2 instances of the cluster assume this role.
String emrManagedMasterSecurityGroup
The identifier of the Amazon EC2 security group for the master node.
String emrManagedSlaveSecurityGroup
The identifier of the Amazon EC2 security group for the core and task nodes.
String serviceAccessSecurityGroup
The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private subnets.
SdkInternalList<T> additionalMasterSecurityGroups
A list of additional Amazon EC2 security group IDs for the master node.
SdkInternalList<T> additionalSlaveSecurityGroups
A list of additional Amazon EC2 security group IDs for the core and task nodes.
String id
The unique identifier of the execution engine. For an EMR cluster, this is the cluster ID.
String type
The type of execution engine. A value of EMR
specifies an EMR cluster.
String masterInstanceSecurityGroupId
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.
String reason
The reason for the step failure. In the case where the service cannot successfully determine the root cause of the failure, it returns "Unknown Error" as a reason.
String message
The descriptive message including the error the Amazon EMR service has identified as the cause of step failure. This is text from an error log that describes the root cause of the failure.
String logFile
The path to the log file where the step failure root cause was originally recorded.
String clusterId
Specifies the ID of the Amazon EMR cluster for which the auto-termination policy will be fetched.
AutoTerminationPolicy autoTerminationPolicy
Specifies the auto-termination policy that is attached to an Amazon EMR cluster.
BlockPublicAccessConfiguration blockPublicAccessConfiguration
A configuration for Amazon EMR block public access. The configuration applies to all clusters created in your
account for the current Region. The configuration specifies whether block public access is enabled. If block
public access is enabled, security groups associated with the cluster cannot have rules that allow inbound
traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is specified as an exception using
PermittedPublicSecurityGroupRuleRanges
in the BlockPublicAccessConfiguration
. By
default, Port 22 (SSH) is an exception, and public access is allowed on this port. You can change this by
updating the block public access configuration to remove the exception.
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.
BlockPublicAccessConfigurationMetadata blockPublicAccessConfigurationMetadata
Properties that describe the Amazon Web Services principal that created the
BlockPublicAccessConfiguration
using the PutBlockPublicAccessConfiguration
action as
well as the date and time that the configuration was created. Each time a configuration for block public access
is updated, Amazon EMR updates this metadata.
String clusterId
Specifies the ID of the cluster for which the managed scaling policy will be fetched.
ManagedScalingPolicy managedScalingPolicy
Specifies the managed scaling policy that is attached to an Amazon EMR cluster.
String studioId
The ID of the Amazon EMR Studio.
String identityId
String identityName
The name of the user or group to fetch. For more information, see UserName and DisplayName in the Amazon Web Services SSO Identity Store API Reference. Either
IdentityName
or IdentityId
must be specified.
String identityType
Specifies whether the identity to fetch is a user or a group.
SessionMappingDetail sessionMapping
The session mapping details for the specified Amazon EMR Studio and identity, including session policy ARN and creation time.
SdkInternalList<T> properties
A list of Java properties that are set when the step runs. You can use these properties to pass key-value pairs to your main function.
String jar
A path to a JAR file run during the step.
String mainClass
The name of the main class in the specified Java file. If not specified, the JAR file should specify a Main-Class in its manifest file.
SdkInternalList<T> args
A list of command line arguments passed to the JAR file's main function when executed.
String jar
The path to the JAR file that runs during the step.
SdkInternalMap<K,V> properties
The list of Java properties that are set when the step runs. You can use these properties to pass key-value pairs to your main function.
String mainClass
The name of the main class in the specified Java file. If not specified, the JAR file should specify a main class in its manifest file.
SdkInternalList<T> args
The list of command line arguments to pass to the JAR file's main function for execution.
String id
The unique identifier for the instance in Amazon EMR.
String ec2InstanceId
The unique identifier of the instance in Amazon EC2.
String publicDnsName
The public DNS name of the instance.
String publicIpAddress
The public IP address of the instance.
String privateDnsName
The private DNS name of the instance.
String privateIpAddress
The private IP address of the instance.
InstanceStatus status
The current status of the instance.
String instanceGroupId
The identifier of the instance group to which this instance belongs.
String instanceFleetId
The unique identifier of the instance fleet to which an EC2 instance belongs.
String market
The instance purchasing option. Valid values are ON_DEMAND
or SPOT
.
String instanceType
The EC2 instance type, for example m3.xlarge
.
SdkInternalList<T> ebsVolumes
The list of Amazon EBS volumes that are attached to this instance.
String id
The unique identifier of the instance fleet.
String name
A friendly name for the instance fleet.
InstanceFleetStatus status
The current status of the instance fleet.
String instanceFleetType
The node type that the instance fleet hosts. Valid values are MASTER, CORE, or TASK.
Integer targetOnDemandCapacity
The target capacity of On-Demand units for the instance fleet, which determines how many On-Demand Instances to
provision. When the instance fleet launches, Amazon EMR tries to provision On-Demand Instances as specified by
InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity
. When an
On-Demand Instance is provisioned, the WeightedCapacity
units count toward the target capacity.
Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an
overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an
instance with a WeightedCapacity
of 5 units, the instance is provisioned, and the target capacity is
exceeded by 3 units. You can use InstanceFleet$ProvisionedOnDemandCapacity to determine the Spot capacity
units that have been provisioned for the instance fleet.
If not specified or set to 0, only Spot Instances are provisioned for the instance fleet using
TargetSpotCapacity
. At least one of TargetSpotCapacity
and
TargetOnDemandCapacity
should be greater than 0. For a master instance fleet, only one of
TargetSpotCapacity
and TargetOnDemandCapacity
can be specified, and its value must be
1.
Integer targetSpotCapacity
The target capacity of Spot units for the instance fleet, which determines how many Spot Instances to provision.
When the instance fleet launches, Amazon EMR tries to provision Spot Instances as specified by
InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity
. When a Spot
instance is provisioned, the WeightedCapacity
units count toward the target capacity. Amazon EMR
provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For
example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a
WeightedCapacity
of 5 units, the instance is provisioned, and the target capacity is exceeded by 3
units. You can use InstanceFleet$ProvisionedSpotCapacity to determine the Spot capacity units that have
been provisioned for the instance fleet.
If not specified or set to 0, only On-Demand Instances are provisioned for the instance fleet. At least one of
TargetSpotCapacity
and TargetOnDemandCapacity
should be greater than 0. For a master
instance fleet, only one of TargetSpotCapacity
and TargetOnDemandCapacity
can be
specified, and its value must be 1.
Integer provisionedOnDemandCapacity
The number of On-Demand units that have been provisioned for the instance fleet to fulfill
TargetOnDemandCapacity
. This provisioned capacity might be less than or greater than
TargetOnDemandCapacity
.
Integer provisionedSpotCapacity
The number of Spot units that have been provisioned for this instance fleet to fulfill
TargetSpotCapacity
. This provisioned capacity might be less than or greater than
TargetSpotCapacity
.
SdkInternalList<T> instanceTypeSpecifications
An array of specifications for the instance types that comprise an instance fleet.
InstanceFleetProvisioningSpecifications launchSpecifications
Describes the launch specification for an instance fleet.
String name
The friendly name of the instance fleet.
String instanceFleetType
The node type that the instance fleet hosts. Valid values are MASTER, CORE, and TASK.
Integer targetOnDemandCapacity
The target capacity of On-Demand units for the instance fleet, which determines how many On-Demand Instances to
provision. When the instance fleet launches, Amazon EMR tries to provision On-Demand Instances as specified by
InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity
. When an
On-Demand Instance is provisioned, the WeightedCapacity
units count toward the target capacity.
Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an
overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an
instance with a WeightedCapacity
of 5 units, the instance is provisioned, and the target capacity is
exceeded by 3 units.
If not specified or set to 0, only Spot Instances are provisioned for the instance fleet using
TargetSpotCapacity
. At least one of TargetSpotCapacity
and
TargetOnDemandCapacity
should be greater than 0. For a master instance fleet, only one of
TargetSpotCapacity
and TargetOnDemandCapacity
can be specified, and its value must be
1.
Integer targetSpotCapacity
The target capacity of Spot units for the instance fleet, which determines how many Spot Instances to provision.
When the instance fleet launches, Amazon EMR tries to provision Spot Instances as specified by
InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity
. When a Spot
Instance is provisioned, the WeightedCapacity
units count toward the target capacity. Amazon EMR
provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For
example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a
WeightedCapacity
of 5 units, the instance is provisioned, and the target capacity is exceeded by 3
units.
If not specified or set to 0, only On-Demand Instances are provisioned for the instance fleet. At least one of
TargetSpotCapacity
and TargetOnDemandCapacity
should be greater than 0. For a master
instance fleet, only one of TargetSpotCapacity
and TargetOnDemandCapacity
can be
specified, and its value must be 1.
SdkInternalList<T> instanceTypeConfigs
The instance type configurations that define the EC2 instances in the instance fleet.
InstanceFleetProvisioningSpecifications launchSpecifications
The launch specification for the instance fleet.
String instanceFleetId
A unique identifier for the instance fleet.
Integer targetOnDemandCapacity
The target capacity of On-Demand units for the instance fleet. For more information see InstanceFleetConfig$TargetOnDemandCapacity.
Integer targetSpotCapacity
The target capacity of Spot units for the instance fleet. For more information, see InstanceFleetConfig$TargetSpotCapacity.
SpotProvisioningSpecification spotSpecification
The launch specification for Spot Instances in the fleet, which determines the defined duration, provisioning timeout behavior, and allocation strategy.
OnDemandProvisioningSpecification onDemandSpecification
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 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.
String state
A code representing the instance fleet status.
PROVISIONING
—The instance fleet is provisioning 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.
RUNNING
—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.
SUSPENDED
—A resize operation could not complete. Existing EC2 instances are running, but instances
can't be added or removed.
TERMINATING
—The instance fleet is terminating EC2 instances.
TERMINATED
—The instance fleet is no longer active, and all EC2 instances have been terminated.
InstanceFleetStateChangeReason stateChangeReason
Provides status change reason details for the instance fleet.
InstanceFleetTimeline timeline
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.
String id
The identifier of the instance group.
String name
The name of the instance group.
String market
The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.
String instanceGroupType
The type of the instance group. Valid values are MASTER, CORE or TASK.
String bidPrice
If specified, indicates that the instance group uses Spot Instances. This is the maximum price you are willing to
pay for Spot Instances. Specify OnDemandPrice
to set the amount equal to the On-Demand price, or
specify an amount in USD.
String instanceType
The EC2 instance type for all instances in the instance group.
Integer requestedInstanceCount
The target number of instances for the instance group.
Integer runningInstanceCount
The number of instances currently running in this instance group.
InstanceGroupStatus status
The current status of the instance group.
SdkInternalList<T> configurations
Amazon EMR releases 4.x or later.
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).
Long configurationsVersion
The version number of the requested configuration specification for this instance group.
SdkInternalList<T> lastSuccessfullyAppliedConfigurations
A list of configurations that were successfully applied for an instance group last time.
Long lastSuccessfullyAppliedConfigurationsVersion
The version number of a configuration specification that was successfully applied for an instance group last time.
SdkInternalList<T> ebsBlockDevices
The EBS block devices that are mapped to this instance group.
Boolean ebsOptimized
If the instance group is EBS-optimized. An Amazon EBS-optimized instance uses an optimized configuration stack and provides additional, dedicated capacity for Amazon EBS I/O.
ShrinkPolicy shrinkPolicy
Policy for customizing shrink operations.
AutoScalingPolicyDescription autoScalingPolicy
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.
String customAmiId
The custom AMI ID to use for the provisioned instance group.
String name
Friendly name given to the instance group.
String market
Market type of the EC2 instances used to create a cluster node.
String instanceRole
The role of the instance group in the cluster.
String bidPrice
If specified, indicates that the instance group uses Spot Instances. This is the maximum price you are willing to
pay for Spot Instances. Specify OnDemandPrice
to set the amount equal to the On-Demand price, or
specify an amount in USD.
String instanceType
The EC2 instance type for all instances in the instance group.
Integer instanceCount
Target number of instances for the instance group.
SdkInternalList<T> configurations
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).
EbsConfiguration ebsConfiguration
EBS configurations that will be attached to each EC2 instance in the instance group.
AutoScalingPolicy autoScalingPolicy
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.
String customAmiId
The custom AMI ID to use for the provisioned instance group.
String instanceGroupId
Unique identifier for the instance group.
String name
Friendly name for the instance group.
String market
Market type of the EC2 instances used to create a cluster node.
String instanceRole
Instance group role in the cluster
String bidPrice
If specified, indicates that the instance group uses Spot Instances. This is the maximum price you are willing to
pay for Spot Instances. Specify OnDemandPrice
to set the amount equal to the On-Demand price, or
specify an amount in USD.
String instanceType
EC2 instance type.
Integer instanceRequestCount
Target number of instances to run in the instance group.
Integer instanceRunningCount
Actual count of running instances.
String state
State of instance group. The following values are no longer supported: STARTING, TERMINATED, and FAILED.
String lastStateChangeReason
Details regarding the state of the instance group.
Date creationDateTime
The date/time the instance group was created.
Date startDateTime
The date/time the instance group was started.
Date readyDateTime
The date/time the instance group was available to the cluster.
Date endDateTime
The date/time the instance group was terminated.
String customAmiId
The custom AMI ID to use for the provisioned instance group.
String instanceGroupId
Unique ID of the instance group to modify.
Integer instanceCount
Target size for the instance group.
SdkInternalList<T> eC2InstanceIdsToTerminate
The EC2 InstanceIds to terminate. After you terminate the instances, the instance group will not return to its original requested size.
ShrinkPolicy shrinkPolicy
Policy for customizing shrink operations.
String reconfigurationType
Type of reconfiguration requested. Valid values are MERGE and OVERWRITE.
SdkInternalList<T> configurations
A list of new or modified configurations to apply for an instance group.
String state
The current state of the instance group.
InstanceGroupStateChangeReason stateChangeReason
The status change reason details for the instance group.
InstanceGroupTimeline timeline
The timeline of the instance group status over time.
SdkInternalList<T> instancesToTerminate
Specific list of instances to be terminated when shrinking an instance group.
SdkInternalList<T> instancesToProtect
Specific list of instances to be protected when shrinking an instance group.
Integer instanceTerminationTimeout
Decommissioning timeout override for the specific list of instances to be terminated.
String state
The current state of the instance.
InstanceStateChangeReason stateChangeReason
The details of the status change reason for the instance.
InstanceTimeline timeline
The timeline of the instance status over time.
String instanceType
An EC2 instance type, such as m3.xlarge
.
Integer weightedCapacity
The number of units that a provisioned instance of this type provides toward fulfilling the target capacities defined in InstanceFleetConfig. This value is 1 for a master instance fleet, and must be 1 or greater for core and task instance fleets. Defaults to 1 if not specified.
String bidPrice
The bid price for each EC2 Spot Instance type as defined by InstanceType
. Expressed in USD. If
neither BidPrice
nor BidPriceAsPercentageOfOnDemandPrice
is provided,
BidPriceAsPercentageOfOnDemandPrice
defaults to 100%.
Double bidPriceAsPercentageOfOnDemandPrice
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%.
EbsConfiguration ebsConfiguration
The configuration of Amazon Elastic Block Store (Amazon EBS) attached to each instance as defined by
InstanceType
.
SdkInternalList<T> configurations
A configuration classification that applies when provisioning cluster instances, which can include configurations for applications and software that run on the cluster.
String customAmiId
The custom AMI ID to use for the instance type.
String instanceType
The EC2 instance type, for example m3.xlarge
.
Integer weightedCapacity
The number of units that a provisioned instance of this type provides toward fulfilling the target capacities defined in InstanceFleetConfig. Capacity values represent performance characteristics such as vCPUs, memory, or I/O. If not specified, the default value is 1.
String bidPrice
The bid price for each EC2 Spot Instance type as defined by InstanceType
. Expressed in USD.
Double bidPriceAsPercentageOfOnDemandPrice
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%).
SdkInternalList<T> configurations
A configuration classification that applies when provisioning cluster instances, which can include configurations for applications and software bundled with Amazon EMR.
SdkInternalList<T> ebsBlockDevices
The configuration of Amazon Elastic Block Store (Amazon EBS) attached to each instance as defined by
InstanceType
.
Boolean ebsOptimized
Evaluates to TRUE
when the specified InstanceType
is EBS-optimized.
String customAmiId
The custom AMI ID to use for the instance type.
String emrErrorCode
The error code associated with the exception.
String jobFlowId
The job flow identifier.
String name
The name of the job flow.
String logUri
The location in Amazon S3 where log files for the job are stored.
String logEncryptionKmsKeyId
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.
String amiVersion
Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 and later,
ReleaseLabel
is used. To specify a custom AMI, use CustomAmiID
.
JobFlowExecutionStatusDetail executionStatusDetail
Describes the execution status of the job flow.
JobFlowInstancesDetail instances
Describes the Amazon EC2 instances of the job flow.
SdkInternalList<T> steps
A list of steps run by the job flow.
SdkInternalList<T> bootstrapActions
A list of the bootstrap actions run by the job flow.
SdkInternalList<T> supportedProducts
A list of strings set by third-party software when the job flow is launched. If you are not using third-party software to manage the job flow, this value is empty.
Boolean visibleToAllUsers
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 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 create-cluster command, or
the Amazon Web Services Management Console.
String jobFlowRole
The IAM role that was specified when the job flow was launched. The EC2 instances of the job flow assume this role.
String serviceRole
The IAM role that is assumed by the Amazon EMR service to access Amazon Web Services resources on your behalf.
String autoScalingRole
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.
String scaleDownBehavior
The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance
group is resized. TERMINATE_AT_INSTANCE_HOUR
indicates that Amazon EMR terminates nodes at the
instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is
only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version.
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.
String state
The state of the job flow.
Date creationDateTime
The creation date and time of the job flow.
Date startDateTime
The start date and time of the job flow.
Date readyDateTime
The date and time when the job flow was ready to start running bootstrap actions.
Date endDateTime
The completion date and time of the job flow.
String lastStateChangeReason
Description of the job flow last changed state.
String masterInstanceType
The EC2 instance type of the master node.
String slaveInstanceType
The EC2 instance type of the core and task nodes.
Integer instanceCount
The number of EC2 instances in the cluster.
SdkInternalList<T> instanceGroups
Configuration for the instance groups in a cluster.
SdkInternalList<T> instanceFleets
The instance fleet configuration is available only in Amazon EMR versions 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.
String ec2KeyName
The name of the EC2 key pair that can be used to connect to the master node using SSH as the user called "hadoop."
PlacementType placement
The Availability Zone in which the cluster runs.
Boolean keepJobFlowAliveWhenNoSteps
Specifies whether the cluster should remain available after completing all steps. Defaults to true
.
For more information about configuring cluster termination, see Control Cluster
Termination in the EMR Management Guide.
Boolean terminationProtected
Specifies whether to lock the cluster to prevent the Amazon EC2 instances from being terminated by API call, user intervention, or in the event of a job-flow error.
String hadoopVersion
Applies only to Amazon EMR release versions earlier than 4.0. The Hadoop version for the cluster. Valid inputs
are "0.18" (no longer maintained), "0.20" (no longer maintained), "0.20.205" (no longer maintained), "1.0.3",
"2.2.0", or "2.4.0". If you do not set this value, the default of 0.18 is used, unless the
AmiVersion
parameter is set in the RunJobFlow call, in which case the default version of Hadoop for
that AMI version is used.
String ec2SubnetId
Applies to clusters that use the uniform instance group configuration. To launch the cluster in Amazon Virtual Private Cloud (Amazon VPC), set this parameter to the identifier of the Amazon VPC subnet where you want the cluster to launch. If you do not specify this value and your account supports EC2-Classic, the cluster launches in EC2-Classic.
SdkInternalList<T> ec2SubnetIds
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.
The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.
String emrManagedMasterSecurityGroup
The identifier of the Amazon EC2 security group for the master node. If you specify
EmrManagedMasterSecurityGroup
, you must also specify EmrManagedSlaveSecurityGroup
.
String emrManagedSlaveSecurityGroup
The identifier of the Amazon EC2 security group for the core and task nodes. If you specify
EmrManagedSlaveSecurityGroup
, you must also specify EmrManagedMasterSecurityGroup
.
String serviceAccessSecurityGroup
The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private subnets.
SdkInternalList<T> additionalMasterSecurityGroups
A list of additional Amazon EC2 security group IDs for the master node.
SdkInternalList<T> additionalSlaveSecurityGroups
A list of additional Amazon EC2 security group IDs for the core and task nodes.
String masterInstanceType
The Amazon EC2 master node instance type.
String masterPublicDnsName
The DNS name of the master node. If the cluster is on a private subnet, this is the private DNS name. On a public subnet, this is the public DNS name.
String masterInstanceId
The Amazon EC2 instance identifier of the master node.
String slaveInstanceType
The Amazon EC2 core and task node instance type.
Integer instanceCount
The number of Amazon EC2 instances in the cluster. If the value is 1, the same instance serves as both the master and core and task node. If the value is greater than 1, one instance is the master node and all others are core and task nodes.
SdkInternalList<T> instanceGroups
Details about the instance groups in a cluster.
Integer normalizedInstanceHours
An approximation of the cost of the cluster, represented in m1.small/hours. This value is increased one time for every hour that an m1.small instance runs. Larger instances are weighted more heavily, so an Amazon EC2 instance that is roughly four times more expensive would result in the normalized instance hours being increased incrementally four times. This result is only an approximation and does not reflect the actual billing rate.
String ec2KeyName
The name of an Amazon EC2 key pair that can be used to connect to the master node using SSH.
String ec2SubnetId
For clusters launched within Amazon Virtual Private Cloud, this is the identifier of the subnet where the cluster was launched.
PlacementType placement
The Amazon EC2 Availability Zone for the cluster.
Boolean keepJobFlowAliveWhenNoSteps
Specifies whether the cluster should remain available after completing all steps.
Boolean terminationProtected
Specifies whether the Amazon EC2 instances in the cluster are protected from termination by API calls, user intervention, or in the event of a job-flow error.
String hadoopVersion
The Hadoop version for the cluster.
String realm
The name of the Kerberos realm to which all nodes in a cluster belong. For example, EC2.INTERNAL
.
String kdcAdminPassword
The password used within the cluster for the kadmin service on the cluster-dedicated KDC, which maintains Kerberos principals, password policies, and keytabs for the cluster.
String crossRealmTrustPrincipalPassword
Required only when establishing a cross-realm trust with a KDC in a different realm. The cross-realm principal password, which must be identical across realms.
String aDDomainJoinUser
Required only when establishing a cross-realm trust with an Active Directory domain. A user with sufficient privileges to join resources to the domain.
String aDDomainJoinPassword
The Active Directory password for ADDomainJoinUser
.
SdkInternalList<T> bootstrapActions
The bootstrap actions associated with the cluster.
String marker
The pagination token that indicates the next set of results to retrieve.
Date createdAfter
The creation date and time beginning value filter for listing clusters.
Date createdBefore
The creation date and time end value filter for listing clusters.
SdkInternalList<T> clusterStates
The cluster state filters to apply when listing clusters. Clusters that change state while this action runs may be not be returned as expected in the list of clusters.
String marker
The pagination token that indicates the next set of results to retrieve.
SdkInternalList<T> clusters
The list of clusters for the account based on the given filters.
String marker
The pagination token that indicates the next set of results to retrieve.
SdkInternalList<T> instanceFleets
The list of instance fleets for the cluster and given filters.
String marker
The pagination token that indicates the next set of results to retrieve.
SdkInternalList<T> instanceGroups
The list of instance groups for the cluster and given filters.
String marker
The pagination token that indicates the next set of results to retrieve.
String clusterId
The identifier of the cluster for which to list the instances.
String instanceGroupId
The identifier of the instance group for which to list the instances.
SdkInternalList<T> instanceGroupTypes
The type of instance group for which to list the instances.
String instanceFleetId
The unique identifier of the instance fleet.
String instanceFleetType
The node type of the instance fleet. For example MASTER, CORE, or TASK.
SdkInternalList<T> instanceStates
A list of instance states that will filter the instances returned with this request.
String marker
The pagination token that indicates the next set of results to retrieve.
SdkInternalList<T> instances
The list of instances for the cluster and given filters.
String marker
The pagination token that indicates the next set of results to retrieve.
String editorId
The unique ID of the editor associated with the notebook execution.
String status
The status filter for listing notebook executions.
START_PENDING
indicates that the cluster has received the execution request but execution has not
begun.
STARTING
indicates that the execution is starting on the cluster.
RUNNING
indicates that the execution is being processed by the cluster.
FINISHING
indicates that execution processing is in the final stages.
FINISHED
indicates that the execution has completed without error.
FAILING
indicates that the execution is failing and will not finish successfully.
FAILED
indicates that the execution failed.
STOP_PENDING
indicates that the cluster has received a StopNotebookExecution
request
and the stop is pending.
STOPPING
indicates that the cluster is in the process of stopping the execution as a result of a
StopNotebookExecution
request.
STOPPED
indicates that the execution stopped because of a StopNotebookExecution
request.
Date from
The beginning of time range filter for listing notebook executions. The default is the timestamp of 30 days ago.
Date to
The end of time range filter for listing notebook executions. The default is the current timestamp.
String marker
The pagination token, returned by a previous ListNotebookExecutions
call, that indicates the start
of the list for this ListNotebookExecutions
call.
SdkInternalList<T> notebookExecutions
A list of notebook executions.
String marker
A pagination token that a subsequent ListNotebookExecutions
can use to determine the next set of
results to retrieve.
ReleaseLabelFilter filters
Filters the results of the request. Prefix
specifies the prefix of release labels to return.
Application
specifies the application (with/without version) of release labels to return.
String nextToken
Specifies the next page of results. If NextToken
is not specified, which is usually the case for the
first request of ListReleaseLabels, the first page of results are determined by other filtering parameters or by
the latest version. The ListReleaseLabels
request fails if the identity (Amazon Web Services account
ID) and all filtering parameters are different from the original request, or if the NextToken
is
expired or tampered with.
Integer maxResults
Defines the maximum number of release labels to return in a single response. The default is 100
.
SdkInternalList<T> releaseLabels
The returned release labels.
String nextToken
Used to paginate the next page of results if specified in the next ListReleaseLabels
request.
String marker
The pagination token that indicates the set of results to retrieve.
SdkInternalList<T> securityConfigurations
The creation date and time, and name, of each security configuration.
String marker
A pagination token that indicates the next set of results to retrieve. Include the marker in the next ListSecurityConfiguration call to retrieve the next page of results, if required.
String clusterId
The identifier of the cluster for which to list the steps.
SdkInternalList<T> stepStates
The filter to limit the step list based on certain states.
SdkInternalList<T> stepIds
The filter to limit the step list based on the identifier of the steps. You can specify a maximum of ten Step IDs. The character constraint applies to the overall length of the array.
String marker
The maximum number of steps that a single ListSteps
action returns is 50. To return a longer list of
steps, use multiple ListSteps
actions along with the Marker
parameter, which is a
pagination token that indicates the next set of results to retrieve.
SdkInternalList<T> steps
The filtered list of steps for the cluster.
String marker
The maximum number of steps that a single ListSteps
action returns is 50. To return a longer list of
steps, use multiple ListSteps
actions along with the Marker
parameter, which is a
pagination token that indicates the next set of results to retrieve.
String studioId
The ID of the Amazon EMR Studio.
String identityType
Specifies whether to return session mappings for users or groups. If not specified, the results include session mapping details for both users and groups.
String marker
The pagination token that indicates the set of results to retrieve.
SdkInternalList<T> sessionMappings
A list of session mapping summary objects. Each object includes session mapping details such as creation time, identity type (user or group), and Amazon EMR Studio ID.
String marker
The pagination token that indicates the next set of results to retrieve.
String marker
The pagination token that indicates the set of results to retrieve.
SdkInternalList<T> studios
The list of Studio summary objects.
String marker
The pagination token that indicates the next set of results to retrieve.
ComputeLimits computeLimits
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.
String clusterId
The unique identifier of the cluster.
Integer stepConcurrencyLevel
The number of steps that can be executed concurrently. You can specify a minimum of 1 step and a maximum of 256
steps. We recommend that you do not change this parameter while steps are running or the
ActionOnFailure
setting may not behave as expected. For more information see
Step$ActionOnFailure.
Integer stepConcurrencyLevel
The number of steps that can be executed concurrently.
String clusterId
The unique identifier of the cluster.
InstanceFleetModifyConfig instanceFleet
The configuration parameters of the instance fleet.
String clusterId
The ID of the cluster to which the instance group belongs.
SdkInternalList<T> instanceGroups
Instance groups to change.
String notebookExecutionId
The unique identifier of a notebook execution.
String editorId
The unique identifier of the EMR Notebook that is used for the notebook execution.
ExecutionEngineConfig executionEngine
The execution engine, such as an EMR cluster, used to run the EMR notebook and perform the notebook execution.
String notebookExecutionName
A name for the notebook execution.
String notebookParams
Input parameters in JSON format passed to the EMR Notebook at runtime for execution.
String status
The status of the notebook execution.
START_PENDING
indicates that the cluster has received the execution request but execution has not
begun.
STARTING
indicates that the execution is starting on the cluster.
RUNNING
indicates that the execution is being processed by the cluster.
FINISHING
indicates that execution processing is in the final stages.
FINISHED
indicates that the execution has completed without error.
FAILING
indicates that the execution is failing and will not finish successfully.
FAILED
indicates that the execution failed.
STOP_PENDING
indicates that the cluster has received a StopNotebookExecution
request
and the stop is pending.
STOPPING
indicates that the cluster is in the process of stopping the execution as a result of a
StopNotebookExecution
request.
STOPPED
indicates that the execution stopped because of a StopNotebookExecution
request.
Date startTime
The timestamp when notebook execution started.
Date endTime
The timestamp when notebook execution ended.
String arn
The Amazon Resource Name (ARN) of the notebook execution.
String outputNotebookURI
The location of the notebook execution's output file in Amazon S3.
String lastStateChangeReason
The reason for the latest status change of the notebook execution.
String notebookInstanceSecurityGroupId
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.
SdkInternalList<T> tags
A list of tags associated with a notebook execution. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters and an optional value string with a maximum of 256 characters.
String notebookExecutionId
The unique identifier of the notebook execution.
String editorId
The unique identifier of the editor associated with the notebook execution.
String notebookExecutionName
The name of the notebook execution.
String status
The status of the notebook execution.
START_PENDING
indicates that the cluster has received the execution request but execution has not
begun.
STARTING
indicates that the execution is starting on the cluster.
RUNNING
indicates that the execution is being processed by the cluster.
FINISHING
indicates that execution processing is in the final stages.
FINISHED
indicates that the execution has completed without error.
FAILING
indicates that the execution is failing and will not finish successfully.
FAILED
indicates that the execution failed.
STOP_PENDING
indicates that the cluster has received a StopNotebookExecution
request
and the stop is pending.
STOPPING
indicates that the cluster is in the process of stopping the execution as a result of a
StopNotebookExecution
request.
STOPPED
indicates that the execution stopped because of a StopNotebookExecution
request.
Date startTime
The timestamp when notebook execution started.
Date endTime
The timestamp when notebook execution started.
String usageStrategy
Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.
If you specify use-capacity-reservations-first
, the fleet uses unused Capacity Reservations to
fulfill On-Demand capacity up to the target On-Demand capacity. If multiple instance pools have unused Capacity
Reservations, the On-Demand allocation strategy (lowest-price
) is applied. If the number of unused
Capacity Reservations is less than the On-Demand target capacity, the remaining On-Demand target capacity is
launched according to the On-Demand allocation strategy (lowest-price
).
If you do not specify a value, the fleet fulfills the On-Demand capacity according to the chosen On-Demand allocation strategy.
String capacityReservationPreference
Indicates the instance's Capacity Reservation preferences. Possible preferences include:
open
- The instance can run in any open Capacity Reservation that has matching attributes (instance
type, platform, Availability Zone).
none
- The instance avoids running in a Capacity Reservation even if one is available. The instance
runs as an On-Demand Instance.
String capacityReservationResourceGroupArn
The ARN of the Capacity Reservation resource group in which to run the instance.
String allocationStrategy
Specifies the strategy to use in launching On-Demand instance fleets. Currently, the only option is
lowest-price
(the default), which launches the lowest price first.
OnDemandCapacityReservationOptions capacityReservationOptions
The launch specification for On-Demand instances in the instance fleet, which determines the allocation strategy.
String label
The Amazon Linux release specified for a cluster in the RunJobFlow request. The format is as shown in Amazon Linux 2 Release Notes . For example, 2.0.20220218.1.
String instanceRole
Role of the instance in the cluster.
Starting with Amazon EMR version 5.23.0, the only supported instance role is MASTER
.
String placementStrategy
EC2 Placement Group strategy associated with instance role.
Starting with Amazon EMR version 5.23.0, the only supported placement strategy is SPREAD
for the
MASTER
instance role.
String availabilityZone
The Amazon EC2 Availability Zone for the cluster. AvailabilityZone
is used for uniform instance
groups, while AvailabilityZones
(plural) is used for instance fleets.
SdkInternalList<T> availabilityZones
When multiple Availability Zones are specified, Amazon EMR evaluates them and launches instances in the optimal
Availability Zone. AvailabilityZones
is used for instance fleets, while
AvailabilityZone
(singular) is used for uniform instance groups.
The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.
String clusterId
Specifies the ID of a cluster. The instance group to which the automatic scaling policy is applied is within this cluster.
String instanceGroupId
Specifies the ID of the instance group to which the automatic scaling policy is applied.
AutoScalingPolicy autoScalingPolicy
Specifies the definition of the automatic scaling policy.
String clusterId
Specifies the ID of a cluster. The instance group to which the automatic scaling policy is applied is within this cluster.
String instanceGroupId
Specifies the ID of the instance group to which the scaling policy is applied.
AutoScalingPolicyDescription autoScalingPolicy
The automatic scaling policy definition.
String clusterArn
The Amazon Resource Name (ARN) of the cluster.
String clusterId
Specifies the ID of the Amazon EMR cluster to which the auto-termination policy will be attached.
AutoTerminationPolicy autoTerminationPolicy
Specifies the auto-termination policy to attach to the cluster.
BlockPublicAccessConfiguration blockPublicAccessConfiguration
A configuration for Amazon EMR block public access. The configuration applies to all clusters created in your
account for the current Region. The configuration specifies whether block public access is enabled. If block
public access is enabled, security groups associated with the cluster cannot have rules that allow inbound
traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is specified as an exception using
PermittedPublicSecurityGroupRuleRanges
in the BlockPublicAccessConfiguration
. By
default, Port 22 (SSH) is an exception, and public access is allowed on this port. You can change this by
updating BlockPublicSecurityGroupRules
to remove the exception.
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.
String clusterId
Specifies the ID of an EMR cluster where the managed scaling policy is attached.
ManagedScalingPolicy managedScalingPolicy
Specifies the constraints for the managed scaling policy.
String prefix
Optional release label version prefix filter. For example, emr-5
.
String application
Optional release label application filter. For example, [email protected]
.
String clusterId
Specifies the ID of the Amazon EMR cluster from which the auto-termination policy will be removed.
String clusterId
Specifies the ID of the cluster from which the managed scaling policy will be removed.
String resourceId
The Amazon EMR resource identifier from which tags will be removed. For example, a cluster identifier or an Amazon EMR Studio ID.
SdkInternalList<T> tagKeys
A list of tag keys to remove from the resource.
String name
The name of the job flow.
String logUri
The location in Amazon S3 to write the log files of the job flow. If a value is not provided, logs are not created.
String logEncryptionKmsKeyId
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.
String additionalInfo
A JSON string for selecting additional features.
String amiVersion
Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 and later,
ReleaseLabel
is used. To specify a custom AMI, use CustomAmiID
.
String releaseLabel
The Amazon EMR release label, which determines the version of open-source application packages installed on the
cluster. Release labels are in the form emr-x.x.x
, where x.x.x is an Amazon EMR release version such
as emr-5.14.0
. For more information about Amazon EMR release versions and included application
versions and features, see https://docs.aws.amazon.
com/emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR releases version 4.0 and later.
Earlier versions use AmiVersion
.
JobFlowInstancesConfig instances
A specification of the number and type of Amazon EC2 instances.
SdkInternalList<T> steps
A list of steps to run.
SdkInternalList<T> bootstrapActions
A list of bootstrap actions to run before Hadoop starts on the cluster nodes.
SdkInternalList<T> supportedProducts
For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and later, use Applications.
A list of strings that indicates third-party software to use. For more information, see the Amazon EMR Developer Guide. Currently supported values are:
"mapr-m3" - launch the job flow using MapR M3 Edition.
"mapr-m5" - launch the job flow using MapR M5 Edition.
SdkInternalList<T> newSupportedProducts
For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and 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:
"mapr-m3" - launch the cluster using MapR M3 Edition.
"mapr-m5" - launch the cluster using MapR M5 Edition.
"mapr" with the user arguments specifying "--edition,m3" or "--edition,m5" - launch the job flow using MapR M3 or M5 Edition respectively.
"mapr-m7" - launch the cluster using MapR M7 Edition.
"hunk" - launch the cluster with the Hunk Big Data Analytics Platform.
"hue"- launch the cluster with Hue installed.
"spark" - launch the cluster with Apache Spark installed.
"ganglia" - launch the cluster with the Ganglia Monitoring System installed.
SdkInternalList<T> applications
Applies to Amazon EMR releases 4.0 and later. A case-insensitive list of applications for Amazon EMR to install and configure when launching the cluster. For a list of applications available for each Amazon EMR release version, see the Amazon EMRRelease Guide.
SdkInternalList<T> configurations
For Amazon EMR releases 4.0 and later. The list of configurations supplied for the EMR cluster you are creating.
Boolean visibleToAllUsers
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 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.
String jobFlowRole
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.
String serviceRole
The IAM role that Amazon EMR assumes in order to access Amazon Web Services resources on your behalf.
SdkInternalList<T> tags
A list of tags to associate with a cluster and propagate to Amazon EC2 instances.
String securityConfiguration
The name of a security configuration to apply to the cluster.
String autoScalingRole
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.
String scaleDownBehavior
Specifies the way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an
instance group is resized. TERMINATE_AT_INSTANCE_HOUR
indicates that Amazon EMR terminates nodes at
the instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option
is only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version.
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.
String customAmiId
Available only in Amazon EMR version 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.
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.
Integer ebsRootVolumeSize
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.
String repoUpgradeOnBoot
Applies only when CustomAmiID
is used. Specifies which updates from the Amazon Linux AMI package
repositories to apply automatically when the instance boots using the AMI. If omitted, the default is
SECURITY
, which indicates that only security updates are applied. If NONE
is specified,
no updates are applied, and all updates must be applied manually.
KerberosAttributes kerberosAttributes
Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. For more information see Use Kerberos Authentication in the Amazon EMR Management Guide.
Integer stepConcurrencyLevel
Specifies the number of steps that can be executed concurrently. The default value is 1
. The maximum
value is 256
.
ManagedScalingPolicy managedScalingPolicy
The specified managed scaling policy for an Amazon EMR cluster.
SdkInternalList<T> placementGroupConfigs
The specified placement group configuration for an Amazon EMR cluster.
AutoTerminationPolicy autoTerminationPolicy
String oSReleaseLabel
Specifies a particular Amazon Linux release for all nodes in a cluster launch RunJobFlow request. If a release is not specified, Amazon EMR uses the latest validated Amazon Linux release for cluster launch.
String market
Not available for instance groups. Instance groups use the market type specified for the group.
SimpleScalingPolicyConfiguration simpleScalingPolicyConfiguration
The type of adjustment the automatic scaling activity makes when triggered, and the periodicity of the adjustment.
Integer minCapacity
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.
Integer maxCapacity
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.
String name
The name used to identify an automatic scaling rule. Rule names must be unique within a scaling policy.
String description
A friendly, more verbose description of the automatic scaling rule.
ScalingAction action
The conditions that trigger an automatic scaling activity.
ScalingTrigger trigger
The CloudWatch alarm definition that determines when automatic scaling activity is triggered.
CloudWatchAlarmDefinition cloudWatchAlarmDefinition
The definition of a CloudWatch metric alarm. When the defined alarm conditions are met along with other trigger parameters, scaling activity begins.
String path
Location in Amazon S3 of the script to run during a bootstrap action.
SdkInternalList<T> args
A list of command line arguments to pass to the bootstrap action script.
String studioId
The ID of the Amazon EMR Studio.
String identityId
The globally unique identifier (GUID) of the user or group.
String identityName
The name of the user or group. For more information, see UserName and DisplayName in the Amazon Web Services SSO Identity Store API Reference.
String identityType
Specifies whether the identity mapped to the Amazon EMR Studio is a user or a group.
String sessionPolicyArn
The Amazon Resource Name (ARN) of the session policy associated with the user or group.
Date creationTime
The time the session mapping was created.
Date lastModifiedTime
The time the session mapping was last modified.
String studioId
The ID of the Amazon EMR Studio.
String identityId
The globally unique identifier (GUID) of the user or group from the Amazon Web Services SSO Identity Store.
String identityName
The name of the user or group. For more information, see UserName and DisplayName in the Amazon Web Services SSO Identity Store API Reference.
String identityType
Specifies whether the identity mapped to the Amazon EMR Studio is a user or a group.
String sessionPolicyArn
The Amazon Resource Name (ARN) of the session policy associated with the user or group.
Date creationTime
The time the session mapping was created.
SdkInternalList<T> jobFlowIds
A list of strings that uniquely identify the clusters to protect. This identifier is returned by RunJobFlow and can also be obtained from DescribeJobFlows .
Boolean terminationProtected
A Boolean that indicates whether to protect the cluster and prevent the Amazon EC2 instances in the cluster from shutting down due to API calls, user intervention, or job-flow error.
SdkInternalList<T> jobFlowIds
The unique identifier of the job flow (cluster).
Boolean visibleToAllUsers
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.
Integer decommissionTimeout
The desired timeout for decommissioning an instance. Overrides the default YARN decommissioning timeout.
InstanceResizePolicy instanceResizePolicy
Custom policy for requesting termination protection or termination of specific instances when shrinking an instance group.
String adjustmentType
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.
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.
Integer scalingAdjustment
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.
Integer coolDown
The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling activities can start. The default value is 0.
Integer timeoutDurationMinutes
The spot provisioning timeout period in minutes. If Spot Instances are not provisioned within this time period,
the TimeOutAction
is taken. Minimum value is 5 and maximum value is 1440. The timeout applies only
during initial provisioning, when the cluster is first created.
String timeoutAction
The action to take when TargetSpotCapacity
has not been fulfilled when the
TimeoutDurationMinutes
has expired; that is, when all Spot Instances could not be provisioned within
the Spot provisioning timeout. Valid values are TERMINATE_CLUSTER
and
SWITCH_TO_ON_DEMAND
. SWITCH_TO_ON_DEMAND specifies that if no Spot Instances are available,
On-Demand Instances should be provisioned to fulfill any remaining Spot capacity.
Integer blockDurationMinutes
The defined duration for Spot Instances (also known as Spot blocks) in minutes. When specified, the Spot Instance does not terminate before the defined duration expires, and defined duration pricing for Spot Instances applies. Valid values are 60, 120, 180, 240, 300, or 360. The duration period starts as soon as a Spot Instance receives its instance ID. At the end of the duration, Amazon EC2 marks the Spot Instance for termination and provides a Spot Instance termination notice, which gives the instance a two-minute warning before it terminates.
Spot Instances with a defined duration (also known as Spot blocks) are no longer available to new customers from July 1, 2021. For customers who have previously used the feature, we will continue to support Spot Instances with a defined duration until December 31, 2022.
String allocationStrategy
Specifies the strategy to use in launching Spot Instance fleets. Currently, the only option is capacity-optimized (the default), which launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.
String editorId
The unique identifier of the EMR Notebook to use for notebook execution.
String relativePath
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
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
.
String notebookExecutionName
An optional name for the notebook execution.
String notebookParams
Input parameters in JSON format passed to the EMR Notebook at runtime for execution.
ExecutionEngineConfig executionEngine
Specifies the execution engine (cluster) that runs the notebook execution.
String serviceRole
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.
String notebookInstanceSecurityGroupId
The unique identifier of the Amazon EC2 security group to associate with the EMR Notebook for this notebook execution.
SdkInternalList<T> tags
A list of tags associated with a notebook execution. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters and an optional value string with a maximum of 256 characters.
String notebookExecutionId
The unique identifier of the notebook execution.
String id
The identifier of the cluster step.
String name
The name of the cluster step.
HadoopStepConfig config
The Hadoop job configuration of the cluster step.
String actionOnFailure
The action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER
,
CANCEL_AND_WAIT
, and CONTINUE
. TERMINATE_JOB_FLOW
is provided for backward
compatibility. We recommend using TERMINATE_CLUSTER
instead.
If a cluster's StepConcurrencyLevel
is greater than 1
, do not use
AddJobFlowSteps
to submit a step with this parameter set to CANCEL_AND_WAIT
or
TERMINATE_CLUSTER
. The step is not submitted and the action fails with a message that the
ActionOnFailure
setting is not valid.
If you change a cluster's StepConcurrencyLevel
to be greater than 1 while a step is running, the
ActionOnFailure
parameter may not behave as you expect. In this case, for a step that fails with
this parameter set to CANCEL_AND_WAIT
, pending steps and the running step are not canceled; for a
step that fails with this parameter set to TERMINATE_CLUSTER
, the cluster does not terminate.
StepStatus status
The current execution status details of the cluster step.
String executionRoleArn
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: arn:partition:service:region:account:resource
.
For example, arn:aws:iam::1234567890:role/ReadOnly
is a correctly formatted runtime role ARN.
String name
The name of the step.
String actionOnFailure
The action to take when the step fails. Use one of the following values:
TERMINATE_CLUSTER
- Shuts down the cluster.
CANCEL_AND_WAIT
- Cancels any pending steps and returns the cluster to the WAITING
state.
CONTINUE
- Continues to the next step in the queue.
TERMINATE_JOB_FLOW
- Shuts down the cluster. TERMINATE_JOB_FLOW
is provided for
backward compatibility. We recommend using TERMINATE_CLUSTER
instead.
If a cluster's StepConcurrencyLevel
is greater than 1
, do not use
AddJobFlowSteps
to submit a step with this parameter set to CANCEL_AND_WAIT
or
TERMINATE_CLUSTER
. The step is not submitted and the action fails with a message that the
ActionOnFailure
setting is not valid.
If you change a cluster's StepConcurrencyLevel
to be greater than 1 while a step is running, the
ActionOnFailure
parameter may not behave as you expect. In this case, for a step that fails with
this parameter set to CANCEL_AND_WAIT
, pending steps and the running step are not canceled; for a
step that fails with this parameter set to TERMINATE_CLUSTER
, the cluster does not terminate.
HadoopJarStepConfig hadoopJarStep
The JAR file used for the step.
StepConfig stepConfig
The step configuration.
StepExecutionStatusDetail executionStatusDetail
The description of the step status.
String state
The state of the step.
Date creationDateTime
The creation date and time of the step.
Date startDateTime
The start date and time of the step.
Date endDateTime
The completion date and time of the step.
String lastStateChangeReason
A description of the step's current state.
String state
The execution state of the cluster step.
StepStateChangeReason stateChangeReason
The reason for the step execution status change.
FailureDetails failureDetails
The details for the step failure including reason, message, and log file path where the root cause was identified.
StepTimeline timeline
The timeline of the cluster step status over time.
String id
The identifier of the cluster step.
String name
The name of the cluster step.
HadoopStepConfig config
The Hadoop job configuration of the cluster step.
String actionOnFailure
The action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE. TERMINATE_JOB_FLOW is available for backward compatibility.
StepStatus status
The current execution status details of the cluster step.
String notebookExecutionId
The unique identifier of the notebook execution.
String studioId
The ID of the Amazon EMR Studio.
String studioArn
The Amazon Resource Name (ARN) of the Amazon EMR Studio.
String name
The name of the Amazon EMR Studio.
String description
The detailed description of the Amazon EMR Studio.
String authMode
Specifies whether the Amazon EMR Studio authenticates users using IAM or Amazon Web Services SSO.
String vpcId
The ID of the VPC associated with the Amazon EMR Studio.
SdkInternalList<T> subnetIds
The list of IDs of the subnets associated with the Amazon EMR Studio.
String serviceRole
The name of the IAM role assumed by the Amazon EMR Studio.
String userRole
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.
String workspaceSecurityGroupId
The ID of the Workspace security group associated with the Amazon EMR Studio. The Workspace security group allows outbound network traffic to resources in the Engine security group and to the internet.
String engineSecurityGroupId
The ID of the Engine security group associated with the Amazon EMR Studio. The Engine security group allows inbound network traffic from resources in the Workspace security group.
String url
The unique access URL of the Amazon EMR Studio.
Date creationTime
The time the Amazon EMR Studio was created.
String defaultS3Location
The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.
String idpAuthUrl
Your identity provider's authentication endpoint. Amazon EMR Studio redirects federated users to this endpoint for authentication when logging in to a Studio with the Studio URL.
String idpRelayStateParameterName
The name of your identity provider's RelayState
parameter.
SdkInternalList<T> tags
A list of tags associated with the Amazon EMR Studio.
String studioId
The ID of the Amazon EMR Studio.
String name
The name of the Amazon EMR Studio.
String vpcId
The ID of the Virtual Private Cloud (Amazon VPC) associated with the Amazon EMR Studio.
String description
The detailed description of the Amazon EMR Studio.
String url
The unique access URL of the Amazon EMR Studio.
String authMode
Specifies whether the Studio authenticates users using IAM or Amazon Web Services SSO.
Date creationTime
The time when the Amazon EMR Studio was created.
String name
The name of the product configuration.
SdkInternalList<T> args
The list of user-supplied arguments.
String key
A user-defined key, which is the minimum required information for a valid tag. For more information, see Tag.
String value
A user-defined value, which is optional in a tag. For more information, see Tag Clusters.
SdkInternalList<T> jobFlowIds
A list of job flows to be shut down.
String studioId
The ID of the Amazon EMR Studio to update.
String name
A descriptive name for the Amazon EMR Studio.
String description
A detailed description to assign to the Amazon EMR Studio.
SdkInternalList<T> subnetIds
A list of subnet IDs to associate with the Amazon EMR Studio. The list can include new subnet IDs, but must also include all of the subnet IDs previously associated with the Studio. The list order does not matter. A Studio can have a maximum of 5 subnets. The subnets must belong to the same VPC as the Studio.
String defaultS3Location
The Amazon S3 location to back up Workspaces and notebook files for the Amazon EMR Studio.
String studioId
The ID of the Amazon EMR Studio.
String identityId
String identityName
The name of the user or group to update. For more information, see UserName and DisplayName in the Amazon Web Services SSO Identity Store API Reference. Either
IdentityName
or IdentityId
must be specified.
String identityType
Specifies whether the identity to update is a user or a group.
String sessionPolicyArn
The Amazon Resource Name (ARN) of the session policy to associate with the specified user or group.
String volumeType
The volume type. Volume types supported are gp2, io1, and standard.
Integer iops
The number of I/O operations per second (IOPS) that the volume supports.
Integer sizeInGB
The volume size, in gibibytes (GiB). This can be a number from 1 - 1024. If the volume type is EBS-optimized, the minimum value is 10.
Integer throughput
The throughput, in mebibyte per second (MiB/s). This optional parameter can be a number from 125 - 1000 and is valid only for gp3 volumes.
Copyright © 2022. All rights reserved.