com.amazonaws.services.elasticmapreduce
Class AmazonElasticMapReduceClient

java.lang.Object
  extended by com.amazonaws.AmazonWebServiceClient
      extended by com.amazonaws.services.elasticmapreduce.AmazonElasticMapReduceClient
All Implemented Interfaces:
AmazonElasticMapReduce
Direct Known Subclasses:
AmazonElasticMapReduceAsyncClient

public class AmazonElasticMapReduceClient
extends AmazonWebServiceClient
implements AmazonElasticMapReduce

Client for accessing AmazonElasticMapReduce. All service calls made using this client are blocking, and will not return until the service call completes.

Elastic MapReduce is a web service that makes it easy to process vast amounts of data using Amazon Simple Storage Service (Amazon S3), where data is stored, and a cluster of Amazon Elastic Compute Cloud (EC2) instances, where that data is processed. Elastic MapReduce uses Hadoop processing to do such things as web indexing, data mining, log file analysis, machine learning, scientific simulation, and bioinformatics research.


Constructor Summary
AmazonElasticMapReduceClient(AWSCredentials awsCredentials)
          Constructs a new client to invoke service methods on AmazonElasticMapReduce using the specified AWS account credentials.
AmazonElasticMapReduceClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
          Constructs a new client to invoke service methods on AmazonElasticMapReduce using the specified AWS account credentials and client configuration options.
 
Method Summary
 void addJobFlowSteps(AddJobFlowStepsRequest addJobFlowStepsRequest)
           Adds new steps to a job flow already loaded on an EC2 cluster.
 DescribeJobFlowsResult describeJobFlows()
           Returns extensive details about specified job flows.
 DescribeJobFlowsResult describeJobFlows(DescribeJobFlowsRequest describeJobFlowsRequest)
           Returns extensive details about specified job flows.
 RunJobFlowResult runJobFlow(RunJobFlowRequest runJobFlowRequest)
           Creates a new job flow and EC2 cluster, and then executes the job flow steps on the cluster.
 void terminateJobFlows(TerminateJobFlowsRequest terminateJobFlowsRequest)
           Terminates job flow processing, uploads data from EC2 to Amazon S3, and terminates the EC2 cluster.
 
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
setEndpoint
 

Constructor Detail

AmazonElasticMapReduceClient

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

All service calls made using this new client object are blocking, and will not return until the service call completes.

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

AmazonElasticMapReduceClient

public AmazonElasticMapReduceClient(AWSCredentials awsCredentials,
                                    ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AmazonElasticMapReduce using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
clientConfiguration - The client configuration options controlling how this client connects to AmazonElasticMapReduce (ex: proxy settings, retry counts, etc.).
Method Detail

addJobFlowSteps

public void addJobFlowSteps(AddJobFlowStepsRequest addJobFlowStepsRequest)
                     throws AmazonServiceException,
                            AmazonClientException

Adds new steps to a job flow already loaded on an EC2 cluster. Each step applies an algorithm to the data set, for the first step, or to the data returned by the previous step in the job flow. If the job flow isn't executing any other steps, execution begins from the first added step. The maximum number of steps in a job flow is 256.

Specified by:
addJobFlowSteps in interface AmazonElasticMapReduce
Parameters:
addJobFlowStepsRequest - Container for the necessary parameters to execute the AddJobFlowSteps service method on AmazonElasticMapReduce.
Throws:
InternalServerErrorException
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.

terminateJobFlows

public void terminateJobFlows(TerminateJobFlowsRequest terminateJobFlowsRequest)
                       throws AmazonServiceException,
                              AmazonClientException

Terminates job flow processing, uploads data from EC2 to Amazon S3, and terminates the EC2 cluster. Use this action to terminate a single job flow or list of job flows. Job flows that complete successfully terminate automatically unless the job flow's KeepJobFlowAliveWhenNoSteps field is set to true when provided to the RunJobFlows operation.

Specified by:
terminateJobFlows in interface AmazonElasticMapReduce
Parameters:
terminateJobFlowsRequest - Container for the necessary parameters to execute the TerminateJobFlows service method on AmazonElasticMapReduce.
Throws:
InternalServerErrorException
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.

describeJobFlows

public DescribeJobFlowsResult describeJobFlows(DescribeJobFlowsRequest describeJobFlowsRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

Returns extensive details about specified job flows. The client specifies job flows by their ID, creation date, or state. Elastic MapReduce returns descriptions of job flows that are up to two months old. Specifying a date older than two months returns an error. The maximum number of job flow descriptions that are returned is 512.

Each input parameter acts as a filter so that Elastic MapReduce returns information about a more precise set of job flows with each parameter that is used in the request. If parameters are not included in a request, Elastic MapReduce returns descriptions of all job flows that have:

Specified by:
describeJobFlows in interface AmazonElasticMapReduce
Parameters:
describeJobFlowsRequest - Container for the necessary parameters to execute the DescribeJobFlows service method on AmazonElasticMapReduce.
Returns:
The response from the DescribeJobFlows service method, as returned by AmazonElasticMapReduce.
Throws:
InternalServerErrorException
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.

runJobFlow

public RunJobFlowResult runJobFlow(RunJobFlowRequest runJobFlowRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

Creates a new job flow and EC2 cluster, and then executes the job flow steps on the cluster. When the job flow finishes, depending on the specified parameter values, RunJobFlow terminates the EC2 cluster and uploads results to a specified Amazon S3 bucket.

NOTE: When running a new job flow, the following restrictions apply: The maximum lifetime of a job flow is 2 weeks. The maximum number of steps allowed in a job flow is 256.

Specified by:
runJobFlow in interface AmazonElasticMapReduce
Parameters:
runJobFlowRequest - Container for the necessary parameters to execute the RunJobFlow service method on AmazonElasticMapReduce.
Returns:
The response from the RunJobFlow service method, as returned by AmazonElasticMapReduce.
Throws:
InternalServerErrorException
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.

describeJobFlows

public DescribeJobFlowsResult describeJobFlows()
                                        throws AmazonServiceException,
                                               AmazonClientException

Returns extensive details about specified job flows. The client specifies job flows by their ID, creation date, or state. Elastic MapReduce returns descriptions of job flows that are up to two months old. Specifying a date older than two months returns an error. The maximum number of job flow descriptions that are returned is 512.

Each input parameter acts as a filter so that Elastic MapReduce returns information about a more precise set of job flows with each parameter that is used in the request. If parameters are not included in a request, Elastic MapReduce returns descriptions of all job flows that have:

Specified by:
describeJobFlows in interface AmazonElasticMapReduce
Returns:
The response from the DescribeJobFlows service method, as returned by AmazonElasticMapReduce.
Throws:
InternalServerErrorException
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.


Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.