com.amazonaws.services.elasticmapreduce
Class AmazonElasticMapReduceAsyncClient

java.lang.Object
  com.amazonaws.AmazonWebServiceClient
      com.amazonaws.services.elasticmapreduce.AmazonElasticMapReduceClient
          com.amazonaws.services.elasticmapreduce.AmazonElasticMapReduceAsyncClient

All Implemented Interfaces:

AmazonElasticMapReduce, AmazonElasticMapReduceAsync

public class AmazonElasticMapReduceAsyncClient
extends AmazonElasticMapReduceClient
implements AmazonElasticMapReduceAsync

Client for accessing AmazonElasticMapReduce. All calls made using this client are non-blocking and will immediately return a Java Future. Callers must use the Future object to determine when the service call has actually completed.

This is the Amazon Elastic MapReduce API Reference Guide. This guide is for programmers that need detailed information about the Amazon Elastic MapReduce SOAP and Query APIs.

This document was last updated on May 5, 2010.

Constructor Summary

AmazonElasticMapReduceAsyncClient(AWSCredentials awsCredentials)
Constructs a new asynchronous client to invoke service methods on AmazonElasticMapReduce using the specified AWS account credentials.

AmazonElasticMapReduceAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AmazonElasticMapReduce using the specified AWS account credentials, executor service, and client configuration options.

AmazonElasticMapReduceAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AmazonElasticMapReduce using the specified AWS account credentials and executor service.

Method Summary

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.
ExecutorService	getExecutorService() Returns the executor service used by this async client to execute requests.
Future<RunJobFlowResult>	runJobFlowAsync(RunJobFlowRequest runJobFlowRequest) RunJobFlow creates and starts running a new job flow.
Future<Void>	terminateJobFlowsAsync(TerminateJobFlowsRequest terminateJobFlowsRequest) TerminateJobFlows shuts a list of job flows down.

Methods inherited from class com.amazonaws.services.elasticmapreduce.AmazonElasticMapReduceClient

addJobFlowSteps, describeJobFlows, describeJobFlows, runJobFlow, terminateJobFlows

Methods inherited from class com.amazonaws.AmazonWebServiceClient

setEndpoint

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

addJobFlowSteps, describeJobFlows, describeJobFlows, runJobFlow, setEndpoint, terminateJobFlows

Constructor Detail

AmazonElasticMapReduceAsyncClient

public AmazonElasticMapReduceAsyncClient(AWSCredentials awsCredentials)

Constructs a new asynchronous client to invoke service methods on AmazonElasticMapReduce using the specified AWS account credentials. Default client settings will be used, and a default cached thread pool will be created for executing the asynchronous tasks.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AmazonElasticMapReduceAsyncClient

public AmazonElasticMapReduceAsyncClient(AWSCredentials awsCredentials,
                                         ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on AmazonElasticMapReduce using the specified AWS account credentials and executor service. Default client settings will be used.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

executorService - The executor service by which all asynchronous requests will be executed.

AmazonElasticMapReduceAsyncClient

public AmazonElasticMapReduceAsyncClient(AWSCredentials awsCredentials,
                                         ClientConfiguration clientConfiguration,
                                         ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on AmazonElasticMapReduce using the specified AWS account credentials, executor service, and client configuration options.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

executorService - The executor service by which all asynchronous requests will be executed.

Method Detail

getExecutorService

public ExecutorService getExecutorService()

Returns the executor service used by this async client to execute requests.

Returns:

The executor service used by this async client to execute requests.

addJobFlowStepsAsync

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

AddJobFlowSteps adds new steps to a running job flow. The maximum number of steps in a job flow is 256.

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.

SElastic 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, BOOTSTAPPING, RUNNING or WAITING.

Specified by:

addJobFlowStepsAsync in interface AmazonElasticMapReduceAsync

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

public 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.

Specified by:

terminateJobFlowsAsync in interface AmazonElasticMapReduceAsync

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

public 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 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.

Specified by:

describeJobFlowsAsync in interface AmazonElasticMapReduceAsync

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.

runJobFlowAsync

public 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 EC2 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 JobFlowInstancesDetail : KeepJobFlowAliveWhenNoSteps parameter is set to TRUE, the job flow will transition to the WAITING state rather than shutting down once the steps have completed.

A maximum of 256 steps are allowed in each job flow.

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

Specified by:

runJobFlowAsync in interface AmazonElasticMapReduceAsync

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.