Package-level declarations
Types
Input to an AddInstanceGroups call.
Output from an AddInstanceGroups call.
The input argument to the AddJobFlowSteps operation.
The output for the AddJobFlowSteps operation.
This input identifies an Amazon EMR resource and a list of tags to attach.
This output indicates the result of adding tags to a resource.
With Amazon EMR release version 4.0 and later, the only accepted parameter is the application name. To pass arguments to applications, you use configuration classifications specified using configuration JSON objects. For more information, see Configuring Applications.
An automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. An automatic scaling policy defines how an instance group dynamically adds and terminates Amazon EC2 instances in response to the value of a CloudWatch metric. See PutAutoScalingPolicy.
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 Amazon EC2 instances in response to the value of a CloudWatch metric. See PutAutoScalingPolicy.
The reason for an AutoScalingPolicyStatus change.
The status of an automatic scaling policy.
An auto-termination policy for an Amazon EMR cluster. An auto-termination policy defines the amount of idle time in seconds after which a cluster automatically terminates. For alternative cluster termination options, see Control cluster termination.
A configuration for Amazon EMR block public access. When BlockPublicSecurityGroupRules is set to true, Amazon EMR prevents cluster creation if one of the cluster's security groups has a rule that allows inbound traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is specified as an exception using PermittedPublicSecurityGroupRuleRanges.
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.
Configuration of a bootstrap action.
Reports the configuration of a bootstrap action in a cluster (job flow).
Specification of the status of a CancelSteps request. Available only in Amazon EMR version 4.8.0 and later, excluding version 5.0.0.
The input argument to the CancelSteps operation.
The output for the CancelSteps operation.
The definition of a CloudWatch metric alarm, which determines when an automatic scaling activity is triggered. When the defined alarm conditions are satisfied, scaling activity begins.
The reason that the cluster changed to its current state.
The detailed status of the cluster.
The summary description of the cluster.
Represents the timeline of the cluster's lifecycle.
The Amazon EC2 unit limits for a managed scaling policy. The managed scaling activity of a cluster can not be above or below these limits. The limit only applies to the core and task nodes. The master node cannot be scaled after initial configuration.
Amazon EMR releases 4.x or later.
The credentials that you can use to connect to cluster endpoints. Credentials consist of a username and a password.
This input determines which cluster to describe.
This output contains the description of the cluster.
The input for the DescribeJobFlows operation.
The output for the DescribeJobFlows operation.
This input determines which step to describe.
This output contains the description of the cluster step.
Configuration of requested EBS block device associated with the instance group.
Configuration of requested EBS block device associated with the instance group with count of volumes that are associated to every instance.
The Amazon EBS configuration of a cluster instance.
Provides information about the Amazon EC2 instances in a cluster grouped by category. For example, key name, subnet ID, IAM instance profile, and so on.
The EMR container configuration.
Base class for all service related exceptions thrown by the Emr client
A tuple that provides information about an error that caused a cluster to terminate.
Specifies the execution engine (cluster) to run the notebook and perform the notebook execution, for example, an Amazon EMR cluster.
The details of the step failure. The service attempts to detect the root cause for many common failures.
A job flow step consisting of a JAR file whose main function will be executed. The main function submits a job for Hadoop to execute and waits for the job to finish or fail.
A cluster step consisting of a JAR file whose main function will be executed. The main function submits a job for Hadoop to execute and waits for the job to finish or fail.
Describes an instance fleet, which is a group of Amazon EC2 instances that host a particular node type (master, core, or task) in an Amazon EMR cluster. Instance fleets can consist of a mix of instance types and On-Demand and Spot Instances, which are provisioned to meet a defined target capacity.
The configuration that defines an instance fleet.
Configuration parameters for an instance fleet modification request.
The launch specification for On-Demand and Spot Instances in the fleet.
The resize specification for On-Demand and Spot Instances in the fleet.
Provides status change reason details for the instance fleet.
The status of the instance fleet.
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.
This entity represents an instance group, which is a group of instances that have common purpose. For example, CORE instance group is used for HDFS.
Configuration defining a new instance group.
Detailed information about an instance group.
Modify the size or configurations of an instance group.
The status change reason details for the instance group.
The details of the instance group status.
The timeline of the instance group lifecycle.
Custom policy for requesting termination protection or termination of specific instances when shrinking an instance group.
The details of the status change reason for the instance.
The instance status details.
The timeline of the instance lifecycle.
An instance type configuration for each instance type in an instance fleet, which determines the Amazon EC2 instances Amazon EMR attempts to provision to fulfill On-Demand and Spot target capacities. When you use an allocation strategy, you can include a maximum of 30 instance type configurations for a fleet. For more information about how to use an allocation strategy, see Configure Instance Fleets. Without an allocation strategy, you may specify a maximum of five instance type configurations for a fleet.
The configuration specification for each instance type in an instance fleet.
Indicates that an error occurred while processing the request and that the request was not completed.
This exception occurs when there is an internal failure in the Amazon EMR service.
This exception occurs when there is something wrong with user input.
A description of a cluster (job flow).
The type of instance.
Describes the status of the cluster (job flow).
A description of the Amazon EC2 instance on which the cluster (job flow) runs. A valid JobFlowInstancesConfig must contain either InstanceGroups or InstanceFleets. They cannot be used together. You may also have MasterInstanceType, SlaveInstanceType, and InstanceCount (all three must be present), but we don't recommend this configuration.
Specify the type of Amazon EC2 instances that the cluster (job flow) runs on.
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.
This input determines which bootstrap actions to retrieve.
This output contains the bootstrap actions detail.
This input determines how the ListClusters action filters the list of clusters that it returns.
This contains a ClusterSummaryList with the cluster details; for example, the cluster IDs, names, and status.
This input determines which instance groups to retrieve.
This input determines which instance groups to retrieve.
This input determines which instances to list.
This output contains the list of instances.
This input determines which steps to list.
This output contains the list of steps returned in reverse order. This means that the last step is the first element in the list.
Managed scaling policy for an Amazon EMR cluster. The policy specifies the limits for resources that can be added or terminated from a cluster. The policy only applies to the core and task nodes. The master node cannot be scaled after initial configuration.
A CloudWatch dimension, which is specified using a Key (known as a Name in CloudWatch), Value pair. By default, Amazon EMR uses one dimension whose Key is JobFlowID and Value is a variable representing the cluster ID, which is ${emr.clusterId}. This enables the rule to bootstrap when the cluster ID becomes available.
Change the size of some instance groups.
A notebook execution. An execution is a specific instance that an Amazon EMR Notebook is run using the StartNotebookExecution action.
Details for a notebook execution. The details include information such as the unique ID and status of the notebook execution.
The Amazon S3 location that stores the notebook execution input.
The Amazon S3 location that stores the notebook execution input.
Describes the strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.
The launch specification for On-Demand Instances in the instance fleet, which determines the allocation strategy.
The resize specification for On-Demand Instances in the instance fleet, which contains the resize timeout period.
The Amazon S3 location that stores the notebook execution output.
The Amazon S3 location that stores the notebook execution output.
Holds persistent application user interface information. Applications installed on the Amazon EMR cluster publish user interfaces as web sites to monitor cluster activity.
Placement group configuration for an Amazon EMR cluster. The configuration specifies the placement strategy that can be applied to instance roles during cluster creation.
The Amazon EC2 Availability Zone configuration of the cluster (job flow).
The release label filters by application or version prefix.
This input identifies an Amazon EMR resource and a list of tags to remove.
This output indicates the result of removing tags from the resource.
Input to the RunJobFlow operation.
The result of the RunJobFlow operation.
The type of adjustment the automatic scaling activity makes when triggered, and the periodicity of the adjustment.
The upper and lower Amazon EC2 instance limits for an automatic scaling policy. Automatic scaling activities triggered by automatic scaling rules will not cause an instance group to grow above or below these limits.
A scale-in or scale-out rule that defines scaling activity, including the CloudWatch metric alarm that triggers activity, how Amazon EC2 instances are added or removed, and the periodicity of adjustments. The automatic scaling policy for an instance group can comprise one or more automatic scaling rules.
The conditions that trigger an automatic scaling activity.
Configuration of the script to run during a bootstrap action.
The creation date and time, and name, of a security configuration.
Details for an Amazon EMR Studio session mapping including creation time, user or group ID, Studio ID, and so on.
Details for an Amazon EMR Studio session mapping. The details do not include the time the session mapping was last modified.
The input argument to the TerminationProtection operation.
The input to the SetVisibleToAllUsers action.
Policy for customizing shrink operations. Allows configuration of decommissioning timeout and targeted instance shrinking.
An automatic scaling configuration, which describes how the policy adds or removes instances, the cooldown period, and the number of Amazon EC2 instances that will be added each time the CloudWatch metric alarm condition is satisfied.
The returned release label application names or versions.
The launch specification for Spot Instances in the instance fleet, which determines the defined duration, provisioning timeout behavior, and allocation strategy.
The resize specification for Spot Instances in the instance fleet, which contains the resize timeout period.
Specification for a cluster (job flow) step.
Combines the execution state and configuration of a step.
The execution state of a step.
The details of the step state change reason.
The execution status details of the cluster step.
The summary of the cluster step.
The timeline of the cluster step lifecycle.
Details for an Amazon EMR Studio, including ID, Name, VPC, and Description. To fetch additional details such as subnets, IAM roles, security groups, and tags for the Studio, use the DescribeStudio API.
An instance type that the specified Amazon EMR release supports.
The list of supported product configurations that allow user-supplied arguments. Amazon EMR accepts these arguments and forwards them to the corresponding installation script as bootstrap action arguments.
A key-value pair containing user-defined metadata that you can associate with an Amazon EMR resource. Tags make it easier to associate clusters in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. For more information, see Tag Clusters.
Input to the TerminateJobFlows operation.
The username and password that you use to connect to cluster endpoints.
EBS volume specifications such as volume type, IOPS, size (GiB) and throughput (MiB/s) that are requested for the EBS volume attached to an Amazon EC2 instance in the cluster.