com.amazonaws.services.elasticmapreduce
Interface AmazonElasticMapReduceAsync

All Superinterfaces:

AmazonElasticMapReduce

All Known Implementing Classes:

AmazonElasticMapReduceAsyncClient

public interface AmazonElasticMapReduceAsync
extends AmazonElasticMapReduce

Interface for accessing AmazonElasticMapReduce asynchronously, using Java Futures.

This is the Amazon Elastic MapReduce API Reference . This guide provides descriptions and samples of the Amazon Elastic MapReduce APIs.

Amazon Elastic MapReduce is a web service that makes it easy to process large amounts of data efficiently. Elastic MapReduce 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

Future<AddInstanceGroupsResult>	addInstanceGroupsAsync(AddInstanceGroupsRequest addInstanceGroupsRequest) AddInstanceGroups adds an instance group to a running cluster.
Future<Void>	addJobFlowStepsAsync(AddJobFlowStepsRequest addJobFlowStepsRequest) AddJobFlowSteps adds new steps to a running job flow.
Future<DescribeJobFlowsResult>	describeJobFlowsAsync(DescribeJobFlowsRequest describeJobFlowsRequest) DescribeJobFlows returns a list of job flows that match all of the supplied parameters.
Future<Void>	modifyInstanceGroupsAsync(ModifyInstanceGroupsRequest modifyInstanceGroupsRequest) ModifyInstanceGroups modifies the number of nodes and configuration settings of an instance group.
Future<RunJobFlowResult>	runJobFlowAsync(RunJobFlowRequest runJobFlowRequest) RunJobFlow creates and starts running a new job flow.
Future<Void>	setTerminationProtectionAsync(SetTerminationProtectionRequest setTerminationProtectionRequest) SetTerminationProtection locks a 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.
Future<Void>	terminateJobFlowsAsync(TerminateJobFlowsRequest terminateJobFlowsRequest) TerminateJobFlows shuts a list of job flows down.

Methods inherited from interface com.amazonaws.services.elasticmapreduce.AmazonElasticMapReduce

addInstanceGroups, addJobFlowSteps, describeJobFlows, describeJobFlows, getCachedResponseMetadata, modifyInstanceGroups, modifyInstanceGroups, runJobFlow, setEndpoint, setTerminationProtection, shutdown, terminateJobFlows

Method Detail

addInstanceGroupsAsync

Future<AddInstanceGroupsResult> addInstanceGroupsAsync(AddInstanceGroupsRequest addInstanceGroupsRequest)
                                                       throws AmazonServiceException,
                                                              AmazonClientException

AddInstanceGroups adds an instance group to a running cluster.

Parameters:

addInstanceGroupsRequest - Container for the necessary parameters to execute the AddInstanceGroups operation on AmazonElasticMapReduce.

Returns:

A Java Future object containing the response from the AddInstanceGroups service method, as returned by AmazonElasticMapReduce.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonElasticMapReduce indicating either a problem with the data in the request, or a server side issue.

addJobFlowStepsAsync

Future<Void> addJobFlowStepsAsync(AddJobFlowStepsRequest addJobFlowStepsRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

AddJobFlowSteps adds new steps to a running job flow. A maximum of 256 steps are allowed in each job flow.

If your job flow 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, go to Add More than 256 Steps to a Job Flow in the Amazon Elastic MapReduce Developer's Guide .

A step specifies the location of a JAR file stored either on the master node of the job flow 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.

Elastic MapReduce 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 job flow that is in one of the following states: STARTING, BOOTSTRAPPING, RUNNING, or WAITING.

Parameters:

addJobFlowStepsRequest - Container for the necessary parameters to execute the AddJobFlowSteps operation on AmazonElasticMapReduce.

Returns:

A Java Future object containing the response from the AddJobFlowSteps service method, as returned by AmazonElasticMapReduce.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonElasticMapReduce indicating either a problem with the data in the request, or a server side issue.

terminateJobFlowsAsync

Future<Void> terminateJobFlowsAsync(TerminateJobFlowsRequest terminateJobFlowsRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

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

Parameters:

terminateJobFlowsRequest - Container for the necessary parameters to execute the TerminateJobFlows operation on AmazonElasticMapReduce.

Returns:

A Java Future object containing the response from the TerminateJobFlows service method, as returned by AmazonElasticMapReduce.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonElasticMapReduce indicating either a problem with the data in the request, or a server side issue.

describeJobFlowsAsync

Future<DescribeJobFlowsResult> describeJobFlowsAsync(DescribeJobFlowsRequest describeJobFlowsRequest)
                                                     throws AmazonServiceException,
                                                            AmazonClientException

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 Elastic MapReduce can return a maximum of 512 job flow descriptions.

Parameters:

describeJobFlowsRequest - Container for the necessary parameters to execute the DescribeJobFlows operation on AmazonElasticMapReduce.

Returns:

A Java Future object containing the response from the DescribeJobFlows service method, as returned by AmazonElasticMapReduce.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonElasticMapReduce indicating either a problem with the data in the request, or a server side issue.

setTerminationProtectionAsync

Future<Void> setTerminationProtectionAsync(SetTerminationProtectionRequest setTerminationProtectionRequest)
                                           throws AmazonServiceException,
                                                  AmazonClientException

SetTerminationProtection locks a 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 SetTerminationProtection on a job flow is analogous to calling the Amazon EC2 DisableAPITermination API on all of the EC2 instances in a cluster.

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

To terminate a job flow 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, go to Protecting a Job Flow from Termination in the Amazon Elastic MapReduce Developer's Guide.

Parameters:

setTerminationProtectionRequest - Container for the necessary parameters to execute the SetTerminationProtection operation on AmazonElasticMapReduce.

Returns:

A Java Future object containing the response from the SetTerminationProtection service method, as returned by AmazonElasticMapReduce.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonElasticMapReduce indicating either a problem with the data in the request, or a server side issue.

runJobFlowAsync

Future<RunJobFlowResult> runJobFlowAsync(RunJobFlowRequest runJobFlowRequest)
                                         throws AmazonServiceException,
                                                AmazonClientException

RunJobFlow creates and starts running a new job flow. The job flow will run the steps specified. Once the job flow completes, the cluster is stopped 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 job flow will transition to the WAITING state rather than shutting down once the steps have completed.

For additional protection, you can set the JobFlowInstancesConfig TerminationProtected parameter to TRUE to lock the job flow 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 job flow 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, go to Add More than 256 Steps to a Job Flow in the Amazon Elastic MapReduce Developer's Guide .

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

Parameters:

runJobFlowRequest - Container for the necessary parameters to execute the RunJobFlow operation on AmazonElasticMapReduce.

Returns:

A Java Future object containing the response from the RunJobFlow service method, as returned by AmazonElasticMapReduce.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonElasticMapReduce indicating either a problem with the data in the request, or a server side issue.

modifyInstanceGroupsAsync

Future<Void> modifyInstanceGroupsAsync(ModifyInstanceGroupsRequest modifyInstanceGroupsRequest)
                                       throws AmazonServiceException,
                                              AmazonClientException

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 - Container for the necessary parameters to execute the ModifyInstanceGroups operation on AmazonElasticMapReduce.

Returns:

A Java Future object containing the response from the ModifyInstanceGroups service method, as returned by AmazonElasticMapReduce.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonElasticMapReduce indicating either a problem with the data in the request, or a server side issue.