- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
EMRClient
Amazon EMR is a web service that makes it easier to process large amounts of data efficiently. Amazon EMR uses Hadoop processing combined with several Amazon Web Services services to do tasks such as web indexing, data mining, log file analysis, machine learning, scientific simulation, and data warehouse management.
Installation
npm install @aws-sdk/client-emr
yarn add @aws-sdk/client-emr
pnpm add @aws-sdk/client-emr
EMRClient Operations
Command | Summary |
---|
Command | Summary |
---|---|
AddInstanceFleetCommand | Adds an instance fleet to a running cluster. The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x. |
AddInstanceGroupsCommand | Adds one or more instance groups to a running cluster. |
AddJobFlowStepsCommand | AddJobFlowSteps adds new steps to a running cluster. A maximum of 256 steps are allowed in each job flow. If your cluster is long-running (such as a Hive data warehouse) or complex, you may require more than 256 steps to process your data. You can bypass the 256-step limitation in various ways, including using SSH to connect to the master node and submitting queries directly to the software running on the master node, such as Hive and Hadoop. A step specifies the location of a JAR file stored either on the master node of the cluster or in Amazon S3. Each step is performed by the main function of the main class of the JAR file. The main class can be specified either in the manifest of the JAR or by using the MainFunction parameter of the step. Amazon EMR executes each step in the order listed. For a step to be considered complete, the main function must exit with a zero exit code and all Hadoop jobs started while the step was running must have completed and run successfully. You can only add steps to a cluster that is in one of the following states: STARTING, BOOTSTRAPPING, RUNNING, or WAITING. The string values passed into |
AddTagsCommand | Adds tags to an Amazon EMR resource, such as a cluster or an Amazon EMR Studio. Tags make it easier to associate resources in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. For more information, see Tag Clusters . |
CancelStepsCommand | Cancels a pending step or steps in a running cluster. Available only in Amazon EMR versions 4.8.0 and later, excluding version 5.0.0. A maximum of 256 steps are allowed in each CancelSteps request. CancelSteps is idempotent but asynchronous; it does not guarantee that a step will be canceled, even if the request is successfully submitted. When you use Amazon EMR releases 5.28.0 and later, you can cancel steps that are in a |
CreateSecurityConfigurationCommand | Creates a security configuration, which is stored in the service and can be specified when a cluster is created. |
CreateStudioCommand | Creates a new Amazon EMR Studio. |
CreateStudioSessionMappingCommand | Maps a user or group to the Amazon EMR Studio specified by |
DeleteSecurityConfigurationCommand | Deletes a security configuration. |
DeleteStudioCommand | Removes an Amazon EMR Studio from the Studio metadata store. |
DeleteStudioSessionMappingCommand | Removes a user or group from an Amazon EMR Studio. |
DescribeClusterCommand | Provides cluster-level details including status, hardware and software configuration, VPC settings, and so on. |
DescribeJobFlowsCommand | This API is no longer supported and will eventually be removed. We recommend you use ListClusters, DescribeCluster, ListSteps, ListInstanceGroups and ListBootstrapActions instead. DescribeJobFlows returns a list of job flows that match all of the supplied parameters. The parameters can include a list of job flow IDs, job flow states, and restrictions on job flow creation date and time. Regardless of supplied parameters, only job flows created within the last two months are returned. If no parameters are supplied, then job flows matching either of the following criteria are returned:
Amazon EMR can return a maximum of 512 job flow descriptions. |
DescribeNotebookExecutionCommand | Provides details of a notebook execution. |
DescribeReleaseLabelCommand | Provides Amazon EMR release label details, such as the releases available the Region where the API request is run, and the available applications for a specific Amazon EMR release label. Can also list Amazon EMR releases that support a specified version of Spark. |
DescribeSecurityConfigurationCommand | Provides the details of a security configuration by returning the configuration JSON. |
DescribeStepCommand | Provides more detail about the cluster step. |
DescribeStudioCommand | Returns details for the specified Amazon EMR Studio including ID, Name, VPC, Studio access URL, and so on. |
GetAutoTerminationPolicyCommand | Returns the auto-termination policy for an Amazon EMR cluster. |
GetBlockPublicAccessConfigurationCommand | Returns the Amazon EMR block public access configuration for your Amazon Web Services account in the current Region. For more information see Configure Block Public Access for Amazon EMR in the Amazon EMR Management Guide. |
GetClusterSessionCredentialsCommand | Provides temporary, HTTP basic credentials that are associated with a given runtime IAM role and used by a cluster with fine-grained access control activated. You can use these credentials to connect to cluster endpoints that support username and password authentication. |
GetManagedScalingPolicyCommand | Fetches the attached managed scaling policy for an Amazon EMR cluster. |
GetStudioSessionMappingCommand | Fetches mapping details for the specified Amazon EMR Studio and identity (user or group). |
ListBootstrapActionsCommand | Provides information about the bootstrap actions associated with a cluster. |
ListClustersCommand | Provides the status of all clusters visible to this Amazon Web Services account. Allows you to filter the list of clusters based on certain criteria; for example, filtering by cluster creation date and time or by status. This call returns a maximum of 50 clusters in unsorted order per call, but returns a marker to track the paging of the cluster list across multiple ListClusters calls. |
ListInstanceFleetsCommand | Lists all available details about the instance fleets in a cluster. The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions. |
ListInstanceGroupsCommand | Provides all available details about the instance groups in a cluster. |
ListInstancesCommand | Provides information for all active Amazon EC2 instances and Amazon EC2 instances terminated in the last 30 days, up to a maximum of 2,000. Amazon EC2 instances in any of the following states are considered active: AWAITING_FULFILLMENT, PROVISIONING, BOOTSTRAPPING, RUNNING. |
ListNotebookExecutionsCommand | Provides summaries of all notebook executions. You can filter the list based on multiple criteria such as status, time range, and editor id. Returns a maximum of 50 notebook executions and a marker to track the paging of a longer notebook execution list across multiple |
ListReleaseLabelsCommand | Retrieves release labels of Amazon EMR services in the Region where the API is called. |
ListSecurityConfigurationsCommand | Lists all the security configurations visible to this account, providing their creation dates and times, and their names. This call returns a maximum of 50 clusters per call, but returns a marker to track the paging of the cluster list across multiple ListSecurityConfigurations calls. |
ListStepsCommand | Provides a list of steps for the cluster in reverse order unless you specify |
ListStudioSessionMappingsCommand | Returns a list of all user or group session mappings for the Amazon EMR Studio specified by |
ListStudiosCommand | Returns a list of all Amazon EMR Studios associated with the Amazon Web Services account. The list includes details such as ID, Studio Access URL, and creation time for each Studio. |
ListSupportedInstanceTypesCommand | A list of the instance types that Amazon EMR supports. You can filter the list by Amazon Web Services Region and Amazon EMR release. |
ModifyClusterCommand | Modifies the number of steps that can be executed concurrently for the cluster specified using ClusterID. |
ModifyInstanceFleetCommand | Modifies the target On-Demand and target Spot capacities for the instance fleet with the specified InstanceFleetID within the cluster specified using ClusterID. The call either succeeds or fails atomically. The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions. |
ModifyInstanceGroupsCommand | ModifyInstanceGroups modifies the number of nodes and configuration settings of an instance group. The input parameters include the new target instance count for the group and the instance group ID. The call will either succeed or fail atomically. |
PutAutoScalingPolicyCommand | Creates or updates an automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically adds and terminates Amazon EC2 instances in response to the value of a CloudWatch metric. |
PutAutoTerminationPolicyCommand | Auto-termination is supported in Amazon EMR releases 5.30.0 and 6.1.0 and later. For more information, see Using an auto-termination policy . Creates or updates 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 . |
PutBlockPublicAccessConfigurationCommand | Creates or updates an Amazon EMR block public access configuration for your Amazon Web Services account in the current Region. For more information see Configure Block Public Access for Amazon EMR in the Amazon EMR Management Guide. |
PutManagedScalingPolicyCommand | Creates or updates a managed scaling policy for an Amazon EMR cluster. The managed scaling policy defines the limits for resources, such as Amazon EC2 instances that can be added or terminated from a cluster. The policy only applies to the core and task nodes. The master node cannot be scaled after initial configuration. |
RemoveAutoScalingPolicyCommand | Removes an automatic scaling policy from a specified instance group within an Amazon EMR cluster. |
RemoveAutoTerminationPolicyCommand | Removes an auto-termination policy from an Amazon EMR cluster. |
RemoveManagedScalingPolicyCommand | Removes a managed scaling policy from a specified Amazon EMR cluster. |
RemoveTagsCommand | Removes tags from an Amazon EMR resource, such as a cluster or Amazon EMR Studio. Tags make it easier to associate resources in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. For more information, see Tag Clusters . The following example removes the stack tag with value Prod from a cluster: |
RunJobFlowCommand | RunJobFlow creates and starts running a new cluster (job flow). The cluster runs the steps specified. After the steps complete, the cluster stops and the HDFS partition is lost. To prevent loss of data, configure the last step of the job flow to store results in Amazon S3. If the JobFlowInstancesConfig For additional protection, you can set the JobFlowInstancesConfig A maximum of 256 steps are allowed in each job flow. If your cluster is long-running (such as a Hive data warehouse) or complex, you may require more than 256 steps to process your data. You can bypass the 256-step limitation in various ways, including using the SSH shell to connect to the master node and submitting queries directly to the software running on the master node, such as Hive and Hadoop. For long-running clusters, we recommend that you periodically store your results. The instance fleets configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions. The RunJobFlow request can contain InstanceFleets parameters or InstanceGroups parameters, but not both. |
SetKeepJobFlowAliveWhenNoStepsCommand | You can use the For more information, see Managing Cluster Termination in the Amazon EMR Management Guide. |
SetTerminationProtectionCommand | SetTerminationProtection locks a cluster (job flow) so the Amazon EC2 instances in the cluster cannot be terminated by user intervention, an API call, or in the event of a job-flow error. The cluster still terminates upon successful completion of the job flow. Calling To terminate a cluster that has been locked by setting For more information, see Managing Cluster Termination in the Amazon EMR Management Guide. |
SetUnhealthyNodeReplacementCommand | Specify whether to enable unhealthy node replacement, which lets Amazon EMR gracefully replace core nodes on a cluster if any nodes become unhealthy. For example, a node becomes unhealthy if disk usage is above 90%. If unhealthy node replacement is on and If unhealthy node replacement is on, Amazon EMR notifies YARN and other applications on the cluster to stop scheduling tasks with these nodes, moves the data, and then terminates the nodes. For more information, see graceful node replacement in the Amazon EMR Management Guide. |
SetVisibleToAllUsersCommand | The SetVisibleToAllUsers parameter is no longer supported. Your cluster may be visible to all users in your account. To restrict cluster access using an IAM policy, see Identity and Access Management for Amazon EMR . Sets the Cluster$VisibleToAllUsers value for an Amazon EMR cluster. When This action works on running clusters. When you create a cluster, use the RunJobFlowInput$VisibleToAllUsers parameter. For more information, see Understanding the Amazon EMR Cluster VisibleToAllUsers Setting in the Amazon EMR Management Guide. |
StartNotebookExecutionCommand | Starts a notebook execution. |
StopNotebookExecutionCommand | Stops a notebook execution. |
TerminateJobFlowsCommand | TerminateJobFlows shuts a list of clusters (job flows) down. When a job flow is shut down, any step not yet completed is canceled and the Amazon EC2 instances on which the cluster is running are stopped. Any log files not already saved are uploaded to Amazon S3 if a LogUri was specified when the cluster was created. The maximum number of clusters allowed is 10. The call to |
UpdateStudioCommand | Updates an Amazon EMR Studio configuration, including attributes such as name, description, and subnets. |
UpdateStudioSessionMappingCommand | Updates the session policy attached to the user or group for the specified Amazon EMR Studio. |
EMRClient Configuration
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
defaultsMode Optional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefix Optional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensions Optional | RuntimeExtension[] | Optional extensions |
logger Optional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttempts Optional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profile Optional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
region Optional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandler Optional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryMode Optional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpoint Optional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpoint Optional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: EMRClientConfig