Package software.amazon.awssdk.services.emr

Interface EMRAsyncClient

All Superinterfaces:

AutoCloseable

@Generated("software.amazon.awssdk:codegen")
public interface EMRAsyncClient
extends AutoCloseable

Service client for accessing Amazon EMR asynchronously. This can be created using the static builder() method.

Amazon EMR is a web service that makes it easy to process large amounts of data efficiently. Amazon EMR uses Hadoop processing combined with several AWS products to do tasks such as web indexing, data mining, log file analysis, machine learning, scientific simulation, and data warehousing.

Method Summary

Modifier and Type	Method	Description
default CompletableFuture<AddInstanceFleetResponse>	addInstanceFleet(AddInstanceFleetRequest addInstanceFleetRequest)	Adds an instance fleet to a running cluster.
default CompletableFuture<AddInstanceGroupsResponse>	addInstanceGroups(AddInstanceGroupsRequest addInstanceGroupsRequest)	Adds one or more instance groups to a running cluster.
default CompletableFuture<AddJobFlowStepsResponse>	addJobFlowSteps(AddJobFlowStepsRequest addJobFlowStepsRequest)	AddJobFlowSteps adds new steps to a running cluster.
default CompletableFuture<AddTagsResponse>	addTags(AddTagsRequest addTagsRequest)	Adds tags to an Amazon EMR resource.
static EMRAsyncClientBuilder	builder()	Create a builder that can be used to configure and create a EMRAsyncClient.
default CompletableFuture<CancelStepsResponse>	cancelSteps(CancelStepsRequest cancelStepsRequest)	Cancels a pending step or steps in a running cluster.
static EMRAsyncClient	create()	Create a EMRAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CompletableFuture<CreateSecurityConfigurationResponse>	createSecurityConfiguration(CreateSecurityConfigurationRequest createSecurityConfigurationRequest)	Creates a security configuration, which is stored in the service and can be specified when a cluster is created.
default CompletableFuture<DeleteSecurityConfigurationResponse>	deleteSecurityConfiguration(DeleteSecurityConfigurationRequest deleteSecurityConfigurationRequest)	Deletes a security configuration.
default CompletableFuture<DescribeClusterResponse>	describeCluster(DescribeClusterRequest describeClusterRequest)	Provides cluster-level details including status, hardware and software configuration, VPC settings, and so on.
default CompletableFuture<DescribeJobFlowsResponse>	describeJobFlows(DescribeJobFlowsRequest describeJobFlowsRequest)	This API is deprecated and will eventually be removed.
default CompletableFuture<DescribeSecurityConfigurationResponse>	describeSecurityConfiguration(DescribeSecurityConfigurationRequest describeSecurityConfigurationRequest)	Provides the details of a security configuration by returning the configuration JSON.
default CompletableFuture<DescribeStepResponse>	describeStep(DescribeStepRequest describeStepRequest)	Provides more detail about the cluster step.
default CompletableFuture<ListBootstrapActionsResponse>	listBootstrapActions(ListBootstrapActionsRequest listBootstrapActionsRequest)	Provides information about the bootstrap actions associated with a cluster.
default CompletableFuture<ListClustersResponse>	listClusters(ListClustersRequest listClustersRequest)	Provides the status of all clusters visible to this AWS account.
default CompletableFuture<ListInstanceFleetsResponse>	listInstanceFleets(ListInstanceFleetsRequest listInstanceFleetsRequest)	Lists all available details about the instance fleets in a cluster.
default CompletableFuture<ListInstanceGroupsResponse>	listInstanceGroups(ListInstanceGroupsRequest listInstanceGroupsRequest)	Provides all available details about the instance groups in a cluster.
default CompletableFuture<ListInstancesResponse>	listInstances(ListInstancesRequest listInstancesRequest)	Provides information about the cluster instances that Amazon EMR provisions on behalf of a user when it creates the cluster.
default CompletableFuture<ListSecurityConfigurationsResponse>	listSecurityConfigurations(ListSecurityConfigurationsRequest listSecurityConfigurationsRequest)	Lists all the security configurations visible to this account, providing their creation dates and times, and their names.
default CompletableFuture<ListStepsResponse>	listSteps(ListStepsRequest listStepsRequest)	Provides a list of steps for the cluster in reverse order unless you specify stepIds with the request.
default CompletableFuture<ModifyInstanceFleetResponse>	modifyInstanceFleet(ModifyInstanceFleetRequest modifyInstanceFleetRequest)	Modifies the target On-Demand and target Spot capacities for the instance fleet with the specified InstanceFleetID within the cluster specified using ClusterID.
default CompletableFuture<ModifyInstanceGroupsResponse>	modifyInstanceGroups(ModifyInstanceGroupsRequest modifyInstanceGroupsRequest)	ModifyInstanceGroups modifies the number of nodes and configuration settings of an instance group.
default CompletableFuture<PutAutoScalingPolicyResponse>	putAutoScalingPolicy(PutAutoScalingPolicyRequest putAutoScalingPolicyRequest)	Creates or updates an automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster.
default CompletableFuture<RemoveAutoScalingPolicyResponse>	removeAutoScalingPolicy(RemoveAutoScalingPolicyRequest removeAutoScalingPolicyRequest)	Removes an automatic scaling policy from a specified instance group within an EMR cluster.
default CompletableFuture<RemoveTagsResponse>	removeTags(RemoveTagsRequest removeTagsRequest)	Removes tags from an Amazon EMR resource.
default CompletableFuture<RunJobFlowResponse>	runJobFlow(RunJobFlowRequest runJobFlowRequest)	RunJobFlow creates and starts running a new cluster (job flow).
default CompletableFuture<SetTerminationProtectionResponse>	setTerminationProtection(SetTerminationProtectionRequest setTerminationProtectionRequest)	SetTerminationProtection locks a cluster (job flow) so the EC2 instances in the cluster cannot be terminated by user intervention, an API call, or in the event of a job-flow error.
default CompletableFuture<SetVisibleToAllUsersResponse>	setVisibleToAllUsers(SetVisibleToAllUsersRequest setVisibleToAllUsersRequest)	Sets whether all AWS Identity and Access Management (IAM) users under your account can access the specified clusters (job flows).
default CompletableFuture<TerminateJobFlowsResponse>	terminateJobFlows(TerminateJobFlowsRequest terminateJobFlowsRequest)	TerminateJobFlows shuts a list of clusters (job flows) down.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

create

static EMRAsyncClient create()

Create a EMRAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static EMRAsyncClientBuilder builder()

Create a builder that can be used to configure and create a EMRAsyncClient.

addInstanceFleet

default CompletableFuture<AddInstanceFleetResponse> addInstanceFleet(AddInstanceFleetRequest addInstanceFleetRequest)

Adds an instance fleet to a running cluster.

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x.

Parameters:

addInstanceFleetRequest -

Returns:

A Java Future containing the result of the AddInstanceFleet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalServerException This exception occurs when there is an internal failure in the EMR service.
• InvalidRequestException This exception occurs when there is something wrong with user input.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• EMRException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

addInstanceGroups

default CompletableFuture<AddInstanceGroupsResponse> addInstanceGroups(AddInstanceGroupsRequest addInstanceGroupsRequest)

Adds one or more instance groups to a running cluster.

Parameters:

addInstanceGroupsRequest - Input to an AddInstanceGroups call.

Returns:

A Java Future containing the result of the AddInstanceGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalServerErrorException Indicates that an error occurred while processing the request and that the request was not completed.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• EMRException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

addJobFlowSteps

default CompletableFuture<AddJobFlowStepsResponse> addJobFlowSteps(AddJobFlowStepsRequest addJobFlowStepsRequest)

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. For more information on how to do this, see Add More than 256 Steps to a Cluster in the Amazon EMR Management Guide.

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.

Parameters:

addJobFlowStepsRequest - The input argument to the AddJobFlowSteps operation.

Returns:

A Java Future containing the result of the AddJobFlowSteps operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalServerErrorException Indicates that an error occurred while processing the request and that the request was not completed.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• EMRException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

addTags

default CompletableFuture<AddTagsResponse> addTags(AddTagsRequest addTagsRequest)

Adds tags to 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 Tagging Amazon EMR Resources.

Parameters:

addTagsRequest - This input identifies a cluster and a list of tags to attach.

Returns:

A Java Future containing the result of the AddTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalServerException This exception occurs when there is an internal failure in the EMR service.
• InvalidRequestException This exception occurs when there is something wrong with user input.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• EMRException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

cancelSteps

default CompletableFuture<CancelStepsResponse> cancelSteps(CancelStepsRequest cancelStepsRequest)

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 a step will be canceled, even if the request is successfully submitted. You can only cancel steps that are in a PENDING state.

Parameters:

cancelStepsRequest - The input argument to the CancelSteps operation.

Returns:

A Java Future containing the result of the CancelSteps operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalServerErrorException Indicates that an error occurred while processing the request and that the request was not completed.
• InvalidRequestException This exception occurs when there is something wrong with user input.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• EMRException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

createSecurityConfiguration

default CompletableFuture<CreateSecurityConfigurationResponse> createSecurityConfiguration(CreateSecurityConfigurationRequest createSecurityConfigurationRequest)

Creates a security configuration, which is stored in the service and can be specified when a cluster is created.

Parameters:

createSecurityConfigurationRequest -

Returns:

A Java Future containing the result of the CreateSecurityConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalServerException This exception occurs when there is an internal failure in the EMR service.
• InvalidRequestException This exception occurs when there is something wrong with user input.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• EMRException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

deleteSecurityConfiguration

default CompletableFuture<DeleteSecurityConfigurationResponse> deleteSecurityConfiguration(DeleteSecurityConfigurationRequest deleteSecurityConfigurationRequest)

Deletes a security configuration.

Parameters:

deleteSecurityConfigurationRequest -

Returns:

A Java Future containing the result of the DeleteSecurityConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalServerException This exception occurs when there is an internal failure in the EMR service.
• InvalidRequestException This exception occurs when there is something wrong with user input.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• EMRException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeCluster

default CompletableFuture<DescribeClusterResponse> describeCluster(DescribeClusterRequest describeClusterRequest)

Provides cluster-level details including status, hardware and software configuration, VPC settings, and so on. For information about the cluster steps, see ListSteps.

Parameters:

describeClusterRequest - This input determines which cluster to describe.

Returns:

A Java Future containing the result of the DescribeCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalServerException This exception occurs when there is an internal failure in the EMR service.
• InvalidRequestException This exception occurs when there is something wrong with user input.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• EMRException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeJobFlows

default CompletableFuture<DescribeJobFlowsResponse> describeJobFlows(DescribeJobFlowsRequest describeJobFlowsRequest)

This API is deprecated 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:

• Job flows created and completed in the last two weeks

• Job flows created within the last two months that are in one of the following states: RUNNING, WAITING, SHUTTING_DOWN, STARTING

Amazon EMR can return a maximum of 512 job flow descriptions.

Parameters:

describeJobFlowsRequest - The input for the DescribeJobFlows operation.

Returns:

A Java Future containing the result of the DescribeJobFlows operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalServerErrorException Indicates that an error occurred while processing the request and that the request was not completed.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• EMRException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeSecurityConfiguration

default CompletableFuture<DescribeSecurityConfigurationResponse> describeSecurityConfiguration(DescribeSecurityConfigurationRequest describeSecurityConfigurationRequest)

Provides the details of a security configuration by returning the configuration JSON.

Parameters:

describeSecurityConfigurationRequest -

Returns:

A Java Future containing the result of the DescribeSecurityConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalServerException This exception occurs when there is an internal failure in the EMR service.
• InvalidRequestException This exception occurs when there is something wrong with user input.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• EMRException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeStep

default CompletableFuture<DescribeStepResponse> describeStep(DescribeStepRequest describeStepRequest)

Provides more detail about the cluster step.

Parameters:

describeStepRequest - This input determines which step to describe.

Returns:

A Java Future containing the result of the DescribeStep operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalServerException This exception occurs when there is an internal failure in the EMR service.
• InvalidRequestException This exception occurs when there is something wrong with user input.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• EMRException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listBootstrapActions

default CompletableFuture<ListBootstrapActionsResponse> listBootstrapActions(ListBootstrapActionsRequest listBootstrapActionsRequest)

Provides information about the bootstrap actions associated with a cluster.

Parameters:

listBootstrapActionsRequest - This input determines which bootstrap actions to retrieve.

Returns:

A Java Future containing the result of the ListBootstrapActions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalServerException This exception occurs when there is an internal failure in the EMR service.
• InvalidRequestException This exception occurs when there is something wrong with user input.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• EMRException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listClusters

default CompletableFuture<ListClustersResponse> listClusters(ListClustersRequest listClustersRequest)

Provides the status of all clusters visible to this AWS 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 per call, but returns a marker to track the paging of the cluster list across multiple ListClusters calls.

Parameters:

listClustersRequest - This input determines how the ListClusters action filters the list of clusters that it returns.

Returns:

A Java Future containing the result of the ListClusters operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalServerException This exception occurs when there is an internal failure in the EMR service.
• InvalidRequestException This exception occurs when there is something wrong with user input.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• EMRException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listInstanceFleets

default CompletableFuture<ListInstanceFleetsResponse> listInstanceFleets(ListInstanceFleetsRequest listInstanceFleetsRequest)

Lists all available details about the instance fleets in a cluster.

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

Parameters:

listInstanceFleetsRequest -

Returns:

A Java Future containing the result of the ListInstanceFleets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalServerException This exception occurs when there is an internal failure in the EMR service.
• InvalidRequestException This exception occurs when there is something wrong with user input.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• EMRException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listInstanceGroups

default CompletableFuture<ListInstanceGroupsResponse> listInstanceGroups(ListInstanceGroupsRequest listInstanceGroupsRequest)

Provides all available details about the instance groups in a cluster.

Parameters:

listInstanceGroupsRequest - This input determines which instance groups to retrieve.

Returns:

A Java Future containing the result of the ListInstanceGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalServerException This exception occurs when there is an internal failure in the EMR service.
• InvalidRequestException This exception occurs when there is something wrong with user input.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• EMRException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listInstances

default CompletableFuture<ListInstancesResponse> listInstances(ListInstancesRequest listInstancesRequest)

Provides information about the cluster instances that Amazon EMR provisions on behalf of a user when it creates the cluster. For example, this operation indicates when the EC2 instances reach the Ready state, when instances become available to Amazon EMR to use for jobs, and the IP addresses for cluster instances, etc.

Parameters:

listInstancesRequest - This input determines which instances to list.

Returns:

A Java Future containing the result of the ListInstances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalServerException This exception occurs when there is an internal failure in the EMR service.
• InvalidRequestException This exception occurs when there is something wrong with user input.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• EMRException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listSecurityConfigurations

default CompletableFuture<ListSecurityConfigurationsResponse> listSecurityConfigurations(ListSecurityConfigurationsRequest listSecurityConfigurationsRequest)

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.

Parameters:

listSecurityConfigurationsRequest -

Returns:

A Java Future containing the result of the ListSecurityConfigurations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalServerException This exception occurs when there is an internal failure in the EMR service.
• InvalidRequestException This exception occurs when there is something wrong with user input.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• EMRException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listSteps

default CompletableFuture<ListStepsResponse> listSteps(ListStepsRequest listStepsRequest)

Provides a list of steps for the cluster in reverse order unless you specify stepIds with the request.

Parameters:

listStepsRequest - This input determines which steps to list.

Returns:

A Java Future containing the result of the ListSteps operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalServerException This exception occurs when there is an internal failure in the EMR service.
• InvalidRequestException This exception occurs when there is something wrong with user input.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• EMRException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

modifyInstanceFleet

default CompletableFuture<ModifyInstanceFleetResponse> modifyInstanceFleet(ModifyInstanceFleetRequest modifyInstanceFleetRequest)

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 versions 4.8.0 and later, excluding 5.0.x versions.

Parameters:

modifyInstanceFleetRequest -

Returns:

A Java Future containing the result of the ModifyInstanceFleet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalServerException This exception occurs when there is an internal failure in the EMR service.
• InvalidRequestException This exception occurs when there is something wrong with user input.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• EMRException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

modifyInstanceGroups

default CompletableFuture<ModifyInstanceGroupsResponse> modifyInstanceGroups(ModifyInstanceGroupsRequest modifyInstanceGroupsRequest)

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.

Parameters:

modifyInstanceGroupsRequest - Change the size of some instance groups.

Returns:

A Java Future containing the result of the ModifyInstanceGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalServerErrorException Indicates that an error occurred while processing the request and that the request was not completed.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• EMRException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

putAutoScalingPolicy

default CompletableFuture<PutAutoScalingPolicyResponse> putAutoScalingPolicy(PutAutoScalingPolicyRequest putAutoScalingPolicyRequest)

Creates or updates an automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically adds and terminates EC2 instances in response to the value of a CloudWatch metric.

Parameters:

putAutoScalingPolicyRequest -

Returns:

A Java Future containing the result of the PutAutoScalingPolicy operation returned by the service.

See Also:

AWS API Documentation

removeAutoScalingPolicy

default CompletableFuture<RemoveAutoScalingPolicyResponse> removeAutoScalingPolicy(RemoveAutoScalingPolicyRequest removeAutoScalingPolicyRequest)

Removes an automatic scaling policy from a specified instance group within an EMR cluster.

Parameters:

removeAutoScalingPolicyRequest -

Returns:

A Java Future containing the result of the RemoveAutoScalingPolicy operation returned by the service.

See Also:

AWS API Documentation

removeTags

default CompletableFuture<RemoveTagsResponse> removeTags(RemoveTagsRequest removeTagsRequest)

Removes tags from 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 Tagging Amazon EMR Resources.

The following example removes the stack tag with value Prod from a cluster:

Parameters:

removeTagsRequest - This input identifies a cluster and a list of tags to remove.

Returns:

A Java Future containing the result of the RemoveTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalServerException This exception occurs when there is an internal failure in the EMR service.
• InvalidRequestException This exception occurs when there is something wrong with user input.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• EMRException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

runJobFlow

default CompletableFuture<RunJobFlowResponse> runJobFlow(RunJobFlowRequest runJobFlowRequest)

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 KeepJobFlowAliveWhenNoSteps parameter is set to TRUE, the cluster transitions to the WAITING state rather than shutting down after the steps have completed.

For additional protection, you can set the JobFlowInstancesConfig TerminationProtected parameter to TRUE to lock the cluster and prevent it from being terminated by API call, user intervention, or in the event of a job flow error.

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 more information on how to do this, see Add More than 256 Steps to a Cluster in the Amazon EMR Management Guide.

For long running clusters, we recommend that you periodically store your results.

The instance fleets configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. The RunJobFlow request can contain InstanceFleets parameters or InstanceGroups parameters, but not both.

Parameters:

runJobFlowRequest - Input to the RunJobFlow operation.

Returns:

A Java Future containing the result of the RunJobFlow operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalServerErrorException Indicates that an error occurred while processing the request and that the request was not completed.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• EMRException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

setTerminationProtection

default CompletableFuture<SetTerminationProtectionResponse> setTerminationProtection(SetTerminationProtectionRequest setTerminationProtectionRequest)

SetTerminationProtection locks a cluster (job flow) so the EC2 instances in the cluster cannot be terminated by user intervention, an API call, or in the event of a job-flow error. The cluster still terminates upon successful completion of the job flow. Calling SetTerminationProtection on a cluster is similar to calling the Amazon EC2 DisableAPITermination API on all EC2 instances in a cluster.

SetTerminationProtection is used to prevent accidental termination of a cluster and to ensure that in the event of an error, the instances persist so that you can recover any data stored in their ephemeral instance storage.

To terminate a cluster that has been locked by setting SetTerminationProtection to true , you must first unlock the job flow by a subsequent call to SetTerminationProtection in which you set the value to false.

For more information, seeManaging Cluster Termination in the Amazon EMR Management Guide.

Parameters:

setTerminationProtectionRequest - The input argument to the TerminationProtection operation.

Returns:

A Java Future containing the result of the SetTerminationProtection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalServerErrorException Indicates that an error occurred while processing the request and that the request was not completed.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• EMRException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

setVisibleToAllUsers

default CompletableFuture<SetVisibleToAllUsersResponse> setVisibleToAllUsers(SetVisibleToAllUsersRequest setVisibleToAllUsersRequest)

Sets whether all AWS Identity and Access Management (IAM) users under your account can access the specified clusters (job flows). This action works on running clusters. You can also set the visibility of a cluster when you launch it using the VisibleToAllUsers parameter of RunJobFlow. The SetVisibleToAllUsers action can be called only by an IAM user who created the cluster or the AWS account that owns the cluster.

Parameters:

setVisibleToAllUsersRequest - The input to the SetVisibleToAllUsers action.

Returns:

A Java Future containing the result of the SetVisibleToAllUsers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalServerErrorException Indicates that an error occurred while processing the request and that the request was not completed.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• EMRException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

terminateJobFlows

default CompletableFuture<TerminateJobFlowsResponse> terminateJobFlows(TerminateJobFlowsRequest terminateJobFlowsRequest)

TerminateJobFlows shuts a list of clusters (job flows) down. When a job flow is shut down, any step not yet completed is canceled and the EC2 instances on which the cluster is running are stopped. Any log files not already saved are uploaded to Amazon S3 if a LogUri was specified when the cluster was created.

The maximum number of clusters allowed is 10. The call to TerminateJobFlows is asynchronous. Depending on the configuration of the cluster, it may take up to 1-5 minutes for the cluster to completely terminate and release allocated resources, such as Amazon EC2 instances.

Parameters:

terminateJobFlowsRequest - Input to the TerminateJobFlows operation.

Returns:

A Java Future containing the result of the TerminateJobFlows operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalServerErrorException Indicates that an error occurred while processing the request and that the request was not completed.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• EMRException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation