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 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.
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. This value must be a cluster identifier.
SdkInternalList<T> tags
A list of tags to associate with a cluster and propagate to EC2 instances. 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.
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 which specified steps 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.
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, expressed in seconds using Period
, 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 requestedAmiVersion
The AMI version requested for this cluster.
String runningAmiVersion
The AMI version running on this cluster.
String releaseLabel
The release label for the Amazon EMR release. For Amazon EMR 3.x and 2.x AMIs, use amiVersion instead instead of ReleaseLabel.
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 all IAM users of the AWS account associated with the cluster. If this
value is set to true
, all IAM users of that AWS account can view and manage the cluster if they have
the proper policy permissions set. If this value is false
, only the IAM user that created the
cluster can view and manage it. This value can be changed using the SetVisibleToAllUsers action.
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 will be assumed by the Amazon EMR service to access AWS 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 public DNS name of the master EC2 instance.
SdkInternalList<T> configurations
Amazon EMR releases 4.x or 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 blacklists 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 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 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 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 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 name
The name of the security configuration.
Step step
The step details for the requested step identifier.
VolumeSpecification volumeSpecification
EBS volume specifications such as volume type, IOPS, and size (GiB) that will be 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, and size (GiB) that will be 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 will be 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
To launch the cluster in 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, the cluster is launched in the normal AWS cloud, outside of a VPC.
Amazon VPC currently does not support cluster compute quadruple extra large (cc1.4xlarge) instances. Thus, you cannot specify the cc1.4xlarge instance type for nodes of a cluster launched in a VPC.
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. Amazon EMR chooses the EC2 subnet with the best performance and cost characteristics from among the list of RequestedEc2SubnetIds and launches all cluster instances within that subnet. If this value is not specified, and the account supports EC2-Classic networks, the cluster launches instances in the EC2-Classic network and uses Requested
String ec2AvailabilityZone
The Availability Zone in which the cluster will run.
SdkInternalList<T> requestedEc2AvailabilityZones
Applies to clusters configured with the The list of availability zones to choose from. The service will choose the availability zone with the best mix of available capacity and lowest cost to launch the cluster. If you do not specify this value, the cluster is launched in any availability zone that the customer account has access to.
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 slave 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 slave nodes.
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 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.
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 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
The specification for the instance types that comprise an instance fleet. Up to five unique instance specifications may be defined for each 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 and provisioning timeout behavior.
String state
A code representing the instance fleet status.
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
The bid price for each EC2 instance in the instance group when launching nodes as Spot Instances, expressed 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 EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).
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 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
Bid price for each EC2 instance in the instance group when launching nodes as Spot Instances, expressed 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 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
Bid price for EC2 Instances when launching nodes as Spot Instances, expressed 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 deprecated: 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 instanceGroupId
Unique ID of the instance group to expand or shrink.
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 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 greater than 0 for core and task instance fleets.
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 between 0 and 1000 (for example, 20 specifies 20%). If neither
BidPrice
nor BidPriceAsPercentageOfOnDemandPrice
is provided,
BidPriceAsPercentageOfOnDemandPrice
defaults to 100%.
EbsConfiguration ebsConfiguration
The configuration of Amazon Elastic Block Storage (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 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 Storage (EBS) attached to each instance as defined by
InstanceType
.
Boolean ebsOptimized
Evaluates to TRUE
when the specified InstanceType
is EBS-optimized.
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 amiVersion
The version of the AMI used to initialize Amazon EC2 instances in the job flow. For a list of AMI versions currently supported by Amazon EMR, see AMI Versions Supported in EMR in the Amazon EMR Developer Guide.
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
Specifies whether the cluster is visible to all IAM users of the AWS account associated with the cluster. If this
value is set to true
, all IAM users of that AWS account can view and (if they have the proper policy
permissions set) manage the cluster. If it is set to false
, only the IAM user that created the
cluster can view and manage it. This value can be changed using the SetVisibleToAllUsers action.
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 will be assumed by the Amazon EMR service to access AWS 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 blacklists 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 slave 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 ssh to the master node 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.
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
The Hadoop version for the cluster. Valid inputs are "0.18" (deprecated), "0.20" (deprecated), "0.20.205" (deprecated), "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, the cluster launches in the normal Amazon Web Services cloud, outside of an Amazon VPC, if the account launching the cluster supports EC2 Classic networks in the region where the cluster launches.
Amazon VPC currently does not support cluster compute quadruple extra large (cc1.4xlarge) instances. Thus you cannot specify the cc1.4xlarge instance type for clusters launched in an Amazon VPC.
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.
String emrManagedSlaveSecurityGroup
The identifier of the Amazon EC2 security group for the slave 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 slave nodes.
String masterInstanceType
The Amazon EC2 master node instance type.
String masterPublicDnsName
The DNS name of the master node.
String masterInstanceId
The Amazon EC2 instance identifier of the master node.
String slaveInstanceType
The Amazon EC2 slave 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 slave node. If the value is greater than 1, one instance is the master node and all others are slave 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 incremented one time for every hour that an m1.small runs. Larger instances are weighted more, so an Amazon EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.
String ec2KeyName
The name of an Amazon EC2 key pair that can be used to ssh to the master node.
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.
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.
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 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.
String marker
The 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 pagination token that indicates the next set of results to retrieve.
String clusterId
The unique identifier of the cluster.
InstanceFleetModifyConfig instanceFleet
The unique identifier 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 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 resourceId
The Amazon EMR resource identifier from which tags will be removed. This value must be a cluster identifier.
SdkInternalList<T> tagKeys
A list of tag keys to remove from a 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 additionalInfo
A JSON string for selecting additional features.
String amiVersion
For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and greater, use ReleaseLabel.
The version of the Amazon Machine Image (AMI) to use when launching Amazon EC2 instances in the job flow. The following values are valid:
The version number of the AMI to use, for example, "2.0."
If the AMI supports multiple versions of Hadoop (for example, AMI 1.0 supports both Hadoop 0.18 and 0.20) you can
use the JobFlowInstancesConfig HadoopVersion
parameter to modify the version of Hadoop from
the defaults shown above.
For details about the AMI versions currently supported by Amazon Elastic MapReduce, see AMI Versions Supported in Elastic MapReduce in the Amazon Elastic MapReduce Developer Guide.
Previously, the EMR AMI version API parameter options allowed you to use latest for the latest AMI version rather than specify a numerical value. Some regions no longer support this deprecated option as they only have a newer release label version of EMR, which requires you to specify an EMR release label release (EMR 4.x or later).
String releaseLabel
Amazon EMR releases 4.x or later.
The release label for the Amazon EMR release. For Amazon EMR 3.x and 2.x AMIs, use amiVersion instead instead of ReleaseLabel.
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 greater, use Applications.
A list of strings that indicates third-party software to use. For more information, see Use Third Party Applications with Amazon EMR. 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 greater, 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 Analtics 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
Amazon EMR releases 4.x or later.
A list of applications for the cluster. Valid values are: "Hadoop", "Hive", "Mahout", "Pig", and "Spark." They are case insensitive.
SdkInternalList<T> configurations
Amazon EMR releases 4.x or later.
The list of configurations supplied for the EMR cluster you are creating.
Boolean visibleToAllUsers
Whether the cluster is visible to all IAM users of the AWS account associated with the cluster. If this value is
set to true
, all IAM users of that AWS account can view and (if they have the proper policy
permissions set) manage the cluster. If it is set to false
, only the IAM user that created the
cluster can view and manage it.
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 will be assumed by the Amazon EMR service to access AWS 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 blacklists 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 jobFlowId
An unique identifier for the job flow.
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 of the script to run during a bootstrap action. Can be either a location in Amazon S3 or on a local file system.
SdkInternalList<T> args
A list of command line arguments to pass to the bootstrap action script.
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
Identifiers of the job flows to receive the new visibility setting.
Boolean visibleToAllUsers
Whether the specified clusters are visible to all IAM users of the AWS account associated with the cluster. If this value is set to True, all IAM users of that AWS account can view and, if they have the proper IAM policy permissions set, manage the clusters. If it is set to False, only the IAM user that created a cluster can view and manage it.
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 a decimal. For example, 0.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 a decimal. For example, -0.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. Spot instances are not uprovisioned within the Spot
provisioining timeout. Valid values are TERMINATE_CLUSTER
and SWITCH_TO_ON_DEMAND
to
fulfill the remaining 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.
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
This specifies what action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE.
StepStatus status
The current execution status details of the cluster step.
String name
The name of the step.
String actionOnFailure
The action to take if the step fails.
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
This specifies what action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE.
StepStatus status
The current execution status details of the cluster step.
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 Tagging Amazon EMR Resources.
String value
A user-defined value, which is optional in a tag. For more information, see Tagging Amazon EMR Resources.
SdkInternalList<T> jobFlowIds
A list of job flows to be shutdown.
String volumeType
The volume type. Volume types supported are gp2, io1, 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.
Copyright © 2017. All rights reserved.