Overview  Package   Class  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

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.

This is the Amazon Elastic MapReduce API Reference Guide. This guide is for programmers who need detailed information about the Amazon Elastic MapReduce APIs.

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
 AddInstanceGroupsResult addInstanceGroups(AddInstanceGroupsRequest addInstanceGroupsRequest)
           AddInstanceGroups adds an instance group to a running cluster.
 void addJobFlowSteps(AddJobFlowStepsRequest addJobFlowStepsRequest)
           AddJobFlowSteps adds new steps to a running job flow.
 DescribeJobFlowsResult describeJobFlows()
           DescribeJobFlows returns a list of job flows that match all of the supplied parameters.
 DescribeJobFlowsResult describeJobFlows(DescribeJobFlowsRequest describeJobFlowsRequest)
           DescribeJobFlows returns a list of job flows that match all of the supplied parameters.
 ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
          Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
 void modifyInstanceGroups()
           ModifyInstanceGroups modifies the number of nodes and configuration settings of an instance group.
 void modifyInstanceGroups(ModifyInstanceGroupsRequest modifyInstanceGroupsRequest)
           ModifyInstanceGroups modifies the number of nodes and configuration settings of an instance group.
 RunJobFlowResult runJobFlow(RunJobFlowRequest runJobFlowRequest)
           RunJobFlow creates and starts running a new job flow.
 void terminateJobFlows(TerminateJobFlowsRequest terminateJobFlowsRequest)
           TerminateJobFlows shuts a list of job flows down.
 
Methods inherited from class com.amazonaws.AmazonWebServiceClient
setEndpoint, shutdown
 
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, shutdown
 

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

addInstanceGroups

public AddInstanceGroupsResult addInstanceGroups(AddInstanceGroupsRequest addInstanceGroupsRequest)
                                          throws AmazonServiceException,
                                                 AmazonClientException

AddInstanceGroups adds an instance group to a running cluster.

Specified by:
addInstanceGroups in interface AmazonElasticMapReduce
Parameters:
addInstanceGroupsRequest - Container for the necessary parameters to execute the AddInstanceGroups service method on AmazonElasticMapReduce.
Returns:
The response from the AddInstanceGroups 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.

addJobFlowSteps

public void addJobFlowSteps(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.

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

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

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:
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

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

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

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

modifyInstanceGroups

public void modifyInstanceGroups(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.

Specified by:
modifyInstanceGroups in interface AmazonElasticMapReduce
Parameters:
modifyInstanceGroupsRequest - Container for the necessary parameters to execute the ModifyInstanceGroups 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()
                                        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:

Amazon Elastic MapReduce can return a maximum of 512 job flow descriptions.

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.

modifyInstanceGroups

public void modifyInstanceGroups()
                          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.

Specified by:
modifyInstanceGroups in interface 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.

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:
getCachedResponseMetadata in interface AmazonElasticMapReduce
Parameters:
request - The originally executed request
Returns:
The response metadata for the specified request, or null if none is available.
Overview  Package   Class  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.