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

Field Summary

Fields

Modifier and Type	Field and Description
protected List<com.amazonaws.transform.JsonErrorUnmarshaller>	jsonErrorUnmarshallers List of exception unmarshallers for all AmazonElasticMapReduce exceptions.

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

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(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Constructs a new client to invoke service methods on AmazonElasticMapReduce using the specified AWS account credentials provider, client configuration options and request metric collector.
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.
AddJobFlowStepsResult	addJobFlowSteps(AddJobFlowStepsRequest addJobFlowStepsRequest) AddJobFlowSteps adds new steps to a running job flow.
AddTagsResult	addTags(AddTagsRequest addTagsRequest) Adds tags to an Amazon EMR resource.
DescribeClusterResult	describeCluster(DescribeClusterRequest describeClusterRequest) Provides cluster-level details including status, hardware and software configuration, VPC settings, and so on.
DescribeJobFlowsResult	describeJobFlows() Deprecated.
DescribeJobFlowsResult	describeJobFlows(DescribeJobFlowsRequest describeJobFlowsRequest) Deprecated.
DescribeStepResult	describeStep(DescribeStepRequest describeStepRequest) Provides more detail about the cluster step.
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.
ListBootstrapActionsResult	listBootstrapActions(ListBootstrapActionsRequest listBootstrapActionsRequest) Provides information about the bootstrap actions associated with a cluster.
ListClustersResult	listClusters() Provides the status of all clusters visible to this AWS account.
ListClustersResult	listClusters(ListClustersRequest listClustersRequest) Provides the status of all clusters visible to this AWS account.
ListInstanceGroupsResult	listInstanceGroups(ListInstanceGroupsRequest listInstanceGroupsRequest) Provides all available details about the instance groups in a cluster.
ListInstancesResult	listInstances(ListInstancesRequest listInstancesRequest) Provides information about the cluster instances that Amazon EMR provisions on behalf of a user when it creates the cluster.
ListStepsResult	listSteps(ListStepsRequest listStepsRequest) Provides a list of steps for the cluster.
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.
RemoveTagsResult	removeTags(RemoveTagsRequest removeTagsRequest) Removes tags from an Amazon EMR resource.
RunJobFlowResult	runJobFlow(RunJobFlowRequest runJobFlowRequest) RunJobFlow creates and starts running a new job flow.
void	setEndpoint(String endpoint) Overrides the default endpoint for this client.
void	setEndpoint(String endpoint, String serviceName, String regionId) An internal method that is not expected to be normally called except for AWS internal development purposes.
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 specified job flows.
void	terminateJobFlows(TerminateJobFlowsRequest terminateJobFlowsRequest) TerminateJobFlows shuts a list of job flows down.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configSigner, configSigner, convertToHttpRequest, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setConfiguration, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withTimeOffset

Methods inherited from class java.lang.Object

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

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

setRegion, shutdown

Field Detail

jsonErrorUnmarshallers

protected List<com.amazonaws.transform.JsonErrorUnmarshaller> jsonErrorUnmarshallers

List of exception unmarshallers for all AmazonElasticMapReduce exceptions.

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

AmazonElasticMapReduceClient

public AmazonElasticMapReduceClient(AWSCredentialsProvider awsCredentialsProvider,
                            ClientConfiguration clientConfiguration,
                            RequestMetricCollector requestMetricCollector)

Constructs a new client to invoke service methods on AmazonElasticMapReduce using the specified AWS account credentials provider, client configuration options and request metric collector.

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

requestMetricCollector - optional request metric collector

Method Detail

listBootstrapActions

public ListBootstrapActionsResult listBootstrapActions(ListBootstrapActionsRequest listBootstrapActionsRequest)

Provides information about the bootstrap actions associated with a cluster.

Specified by:

listBootstrapActions in interface AmazonElasticMapReduce

Parameters:

listBootstrapActionsRequest - Container for the necessary parameters to execute the ListBootstrapActions service method on AmazonElasticMapReduce.

Returns:

The response from the ListBootstrapActions service method, as returned by AmazonElasticMapReduce.

Throws:

InternalServerException

InvalidRequestException

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.

addTags

public AddTagsResult addTags(AddTagsRequest addTagsRequest)

Adds tags to an Amazon EMR resource. Tags make it easier to associate clusters in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. For more information, see Tagging Amazon EMR Resources .

Specified by:

addTags in interface AmazonElasticMapReduce

Parameters:

addTagsRequest - Container for the necessary parameters to execute the AddTags service method on AmazonElasticMapReduce.

Returns:

The response from the AddTags service method, as returned by AmazonElasticMapReduce.

Throws:

InternalServerException

InvalidRequestException

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.

setVisibleToAllUsers

public void setVisibleToAllUsers(SetVisibleToAllUsersRequest setVisibleToAllUsersRequest)

Sets whether all AWS Identity and Access Management (IAM) users under your account can access the specified 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.

listSteps

public ListStepsResult listSteps(ListStepsRequest listStepsRequest)

Provides a list of steps for the cluster.

Specified by:

listSteps in interface AmazonElasticMapReduce

Parameters:

listStepsRequest - Container for the necessary parameters to execute the ListSteps service method on AmazonElasticMapReduce.

Returns:

The response from the ListSteps service method, as returned by AmazonElasticMapReduce.

Throws:

InternalServerException

InvalidRequestException

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 AddJobFlowStepsResult addJobFlowSteps(AddJobFlowStepsRequest addJobFlowStepsRequest)

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.

Returns:

The response from the AddJobFlowSteps 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.

describeStep

public DescribeStepResult describeStep(DescribeStepRequest describeStepRequest)

Provides more detail about the cluster step.

Specified by:

describeStep in interface AmazonElasticMapReduce

Parameters:

describeStepRequest - Container for the necessary parameters to execute the DescribeStep service method on AmazonElasticMapReduce.

Returns:

The response from the DescribeStep service method, as returned by AmazonElasticMapReduce.

Throws:

InternalServerException

InvalidRequestException

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.

listClusters

public ListClustersResult listClusters(ListClustersRequest listClustersRequest)

Provides the status of all clusters visible to this AWS account. Allows you to filter the list of clusters based on certain criteria; for example, filtering by cluster creation date and time or by status. This call returns a maximum of 50 clusters per call, but returns a marker to track the paging of the cluster list across multiple ListClusters calls.

Specified by:

listClusters in interface AmazonElasticMapReduce

Parameters:

listClustersRequest - Container for the necessary parameters to execute the ListClusters service method on AmazonElasticMapReduce.

Returns:

The response from the ListClusters service method, as returned by AmazonElasticMapReduce.

Throws:

InternalServerException

InvalidRequestException

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.

removeTags

public RemoveTagsResult removeTags(RemoveTagsRequest removeTagsRequest)

Removes tags from an Amazon EMR resource. Tags make it easier to associate clusters in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. For more information, see Tagging Amazon EMR Resources .

The following example removes the stack tag with value Prod from a cluster:

Specified by:

removeTags in interface AmazonElasticMapReduce

Parameters:

removeTagsRequest - Container for the necessary parameters to execute the RemoveTags service method on AmazonElasticMapReduce.

Returns:

The response from the RemoveTags service method, as returned by AmazonElasticMapReduce.

Throws:

InternalServerException

InvalidRequestException

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.

listInstanceGroups

public ListInstanceGroupsResult listInstanceGroups(ListInstanceGroupsRequest listInstanceGroupsRequest)

Provides all available details about the instance groups in a cluster.

Specified by:

listInstanceGroups in interface AmazonElasticMapReduce

Parameters:

listInstanceGroupsRequest - Container for the necessary parameters to execute the ListInstanceGroups service method on AmazonElasticMapReduce.

Returns:

The response from the ListInstanceGroups service method, as returned by AmazonElasticMapReduce.

Throws:

InternalServerException

InvalidRequestException

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)

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.

listInstances

public ListInstancesResult listInstances(ListInstancesRequest listInstancesRequest)

Provides information about the cluster instances that Amazon EMR provisions on behalf of a user when it creates the cluster. For example, this operation indicates when the EC2 instances reach the Ready state, when instances become available to Amazon EMR to use for jobs, and the IP addresses for cluster instances, etc.

Specified by:

listInstances in interface AmazonElasticMapReduce

Parameters:

listInstancesRequest - Container for the necessary parameters to execute the ListInstances service method on AmazonElasticMapReduce.

Returns:

The response from the ListInstances service method, as returned by AmazonElasticMapReduce.

Throws:

InternalServerException

InvalidRequestException

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)

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.

terminateJobFlows

public void terminateJobFlows(TerminateJobFlowsRequest terminateJobFlowsRequest)

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.

setTerminationProtection

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

describeJobFlows

@Deprecated
public DescribeJobFlowsResult describeJobFlows(DescribeJobFlowsRequest describeJobFlowsRequest)

Deprecated.

This API is deprecated and will eventually be removed. We recommend you use ListClusters, DescribeCluster, ListSteps, ListInstanceGroups and ListBootstrapActions instead.

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.

runJobFlow

public RunJobFlowResult runJobFlow(RunJobFlowRequest runJobFlowRequest)

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.

describeCluster

public DescribeClusterResult describeCluster(DescribeClusterRequest describeClusterRequest)

Provides cluster-level details including status, hardware and software configuration, VPC settings, and so on. For information about the cluster steps, see ListSteps.

Specified by:

describeCluster in interface AmazonElasticMapReduce

Parameters:

describeClusterRequest - Container for the necessary parameters to execute the DescribeCluster service method on AmazonElasticMapReduce.

Returns:

The response from the DescribeCluster service method, as returned by AmazonElasticMapReduce.

Throws:

InternalServerException

InvalidRequestException

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.

listClusters

public ListClustersResult listClusters()
                                throws AmazonServiceException,
                                       AmazonClientException

Provides the status of all clusters visible to this AWS account. Allows you to filter the list of clusters based on certain criteria; for example, filtering by cluster creation date and time or by status. This call returns a maximum of 50 clusters per call, but returns a marker to track the paging of the cluster list across multiple ListClusters calls.

Specified by:

listClusters in interface AmazonElasticMapReduce

Returns:

The response from the ListClusters service method, as returned by AmazonElasticMapReduce.

Throws:

InternalServerException

InvalidRequestException

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.

describeJobFlows

@Deprecated
public DescribeJobFlowsResult describeJobFlows()
                                        throws AmazonServiceException,
                                               AmazonClientException

Deprecated.

This API is deprecated and will eventually be removed. We recommend you use ListClusters, DescribeCluster, ListSteps, ListInstanceGroups and ListBootstrapActions instead.

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.

setEndpoint

public void setEndpoint(String endpoint)

Description copied from class: AmazonWebServiceClient

Overrides the default endpoint for this client. Callers can use this method to control which AWS region they want to work with.

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: "ec2.amazonaws.com") or a full URL, including the protocol (ex: "https://ec2.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

Specified by:

setEndpoint in interface AmazonElasticMapReduce

Overrides:

setEndpoint in class AmazonWebServiceClient

Parameters:

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

setEndpoint

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

Description copied from class: AmazonWebServiceClient

An internal method that is not expected to be normally called except for AWS internal development purposes.

Overrides the default endpoint for this client ("http://dynamodb.us-east-1.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.

Callers can pass in just the endpoint (ex: "dynamodb.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "http://dynamodb.us-east-1.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

Overrides:

setEndpoint in class AmazonWebServiceClient

Parameters:

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

serviceName - This parameter is ignored.

regionId - The ID of the region in which this service resides AND the overriding region for signing purposes.

Throws:

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

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.