com.amazonaws.services.elasticmapreduce

Class AmazonElasticMapReduceClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

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

Constructor Summary

Constructors

Constructor and Description
AmazonElasticMapReduceClient() Constructs a new client to invoke service methods on AmazonElasticMapReduce.
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.
AmazonElasticMapReduceClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on AmazonElasticMapReduce using the specified AWS account credentials provider.
AmazonElasticMapReduceClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonElasticMapReduce using the specified AWS account credentials provider and client configuration options.
AmazonElasticMapReduceClient(ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonElasticMapReduce.

Method Summary

Methods

Modifier and Type	Method and Description
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	setEndpoint(String endpoint, String serviceName, String regionId) Overrides the default endpoint for this client ("https://elasticmapreduce.amazonaws.com") and explicitly provides an AWS region ID and AWS service name to use when the client calculates a signature for requests.
void	setTerminationProtection(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.
void	setVisibleToAllUsers(SetVisibleToAllUsersRequest setVisibleToAllUsersRequest) Sets whether all AWS Identity and Access Management (IAM) users under your account can access the specifed job flows.
void	terminateJobFlows(TerminateJobFlowsRequest terminateJobFlowsRequest) TerminateJobFlows shuts a list of job flows down.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, getRequestMetricsCollector, getTimeOffset, removeRequestHandler, setConfiguration, setEndpoint, setRegion, setTimeOffset, shutdown, withTimeOffset

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, setRegion, shutdown

Constructor Detail

AmazonElasticMapReduceClient

public AmazonElasticMapReduceClient()

Constructs a new client to invoke service methods on AmazonElasticMapReduce. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

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

See Also:

DefaultAWSCredentialsProviderChain

AmazonElasticMapReduceClient

public AmazonElasticMapReduceClient(ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonElasticMapReduce. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

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

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to AmazonElasticMapReduce (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

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

AmazonElasticMapReduceClient

public AmazonElasticMapReduceClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on AmazonElasticMapReduce using the specified AWS account credentials provider.

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

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AmazonElasticMapReduceClient

public AmazonElasticMapReduceClient(AWSCredentialsProvider awsCredentialsProvider,
                            ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonElasticMapReduce using the specified AWS account credentials provider 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:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonElasticMapReduce (ex: proxy settings, retry counts, etc.).

Method Detail

setVisibleToAllUsers

public void setVisibleToAllUsers(SetVisibleToAllUsersRequest setVisibleToAllUsersRequest)
                          throws AmazonServiceException,
                                 AmazonClientException

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

Specified by:

setVisibleToAllUsers in interface AmazonElasticMapReduce

Parameters:

setVisibleToAllUsersRequest - Container for the necessary parameters to execute the SetVisibleToAllUsers 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.

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.

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.

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.

The call to TerminateJobFlows is asynchronous. Depending on the configuration of the job flow, it may take up to 5-20 minutes for the job flow to completely terminate and release allocated resources, such as Amazon EC2 instances.

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:

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

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.

setTerminationProtection

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

Specified by:

setTerminationProtection in interface AmazonElasticMapReduce

Parameters:

setTerminationProtectionRequest - Container for the necessary parameters to execute the SetTerminationProtection 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.

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

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:

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

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.

setEndpoint

public void setEndpoint(String endpoint,
               String serviceName,
               String regionId)
                 throws IllegalArgumentException

Overrides the default endpoint for this client ("https://elasticmapreduce.amazonaws.com") and explicitly provides an AWS region ID and AWS service name to use when the client calculates a signature for requests. In almost all cases, this region ID and service name are automatically determined from the endpoint, and callers should use the simpler one-argument form of setEndpoint instead of this method.

This method is not threadsafe. Endpoints should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit.

Callers can pass in just the endpoint (ex: "elasticmapreduce.amazonaws.com") or a full URL, including the protocol (ex: "https://elasticmapreduce.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912

Parameters:

endpoint - The endpoint (ex: "elasticmapreduce.amazonaws.com") or a full URL, including the protocol (ex: "https://elasticmapreduce.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

serviceName - The name of the AWS service to use when signing requests.

regionId - The ID of the region in which this service resides.

Throws:

IllegalArgumentException - If any problems are detected with the specified endpoint.

See Also:

AmazonDynamoDB#setRegion(Region)

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.