@ThreadSafe public class AmazonElasticMapReduceClient extends AmazonWebServiceClient implements AmazonElasticMapReduce
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.
Modifier and Type | Field and Description |
---|---|
protected static ClientConfigurationFactory |
configFactory
Client configuration factory providing ClientConfigurations tailored to
this client
|
protected List<com.amazonaws.transform.JsonErrorUnmarshallerV2> |
jsonErrorUnmarshallers
List of exception unmarshallers for all Amazon EMR exceptions.
|
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
Constructor and Description |
---|
AmazonElasticMapReduceClient()
Constructs a new client to invoke service methods on Amazon EMR.
|
AmazonElasticMapReduceClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on Amazon EMR using the
specified AWS account credentials.
|
AmazonElasticMapReduceClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon EMR using the
specified AWS account credentials and client configuration options.
|
AmazonElasticMapReduceClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on Amazon EMR using the
specified AWS account credentials provider.
|
AmazonElasticMapReduceClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon EMR 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 Amazon EMR 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 Amazon EMR.
|
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()
Simplified method form for invoking the ListClusters operation.
|
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()
Simplified method form for invoking the ModifyInstanceGroups operation.
|
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 |
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.
|
addRequestHandler, addRequestHandler, beforeMarshalling, configSigner, configSigner, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion, shutdown
protected static final ClientConfigurationFactory configFactory
protected List<com.amazonaws.transform.JsonErrorUnmarshallerV2> jsonErrorUnmarshallers
public AmazonElasticMapReduceClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
public AmazonElasticMapReduceClient(ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling how this client
connects to Amazon EMR (ex: proxy settings, retry counts, etc.).DefaultAWSCredentialsProviderChain
public AmazonElasticMapReduceClient(AWSCredentials awsCredentials)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when
authenticating with AWS services.public AmazonElasticMapReduceClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
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 Amazon EMR (ex: proxy settings, retry counts, etc.).public AmazonElasticMapReduceClient(AWSCredentialsProvider awsCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.public AmazonElasticMapReduceClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
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 Amazon EMR (ex: proxy settings, retry counts, etc.).public AmazonElasticMapReduceClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
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 Amazon EMR (ex: proxy settings, retry counts, etc.).requestMetricCollector
- optional request metric collectorpublic AddInstanceGroupsResult addInstanceGroups(AddInstanceGroupsRequest addInstanceGroupsRequest)
AddInstanceGroups adds an instance group to a running cluster.
addInstanceGroups
in interface AmazonElasticMapReduce
addInstanceGroupsRequest
- Input to an AddInstanceGroups call.InternalServerErrorException
- Indicates that an error occurred while processing the request and
that the request was not completed.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.
addJobFlowSteps
in interface AmazonElasticMapReduce
addJobFlowStepsRequest
- The input argument to the AddJobFlowSteps operation.InternalServerErrorException
- Indicates that an error occurred while processing the request and
that the request was not completed.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.
addTags
in interface AmazonElasticMapReduce
addTagsRequest
- This input identifies a cluster and a list of tags to attach.InternalServerException
- This exception occurs when there is an internal failure in the
EMR service.InvalidRequestException
- This exception occurs when there is something wrong with user
input.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.
describeCluster
in interface AmazonElasticMapReduce
describeClusterRequest
- This input determines which cluster to describe.InternalServerException
- This exception occurs when there is an internal failure in the
EMR service.InvalidRequestException
- This exception occurs when there is something wrong with user
input.@Deprecated public DescribeJobFlowsResult describeJobFlows(DescribeJobFlowsRequest describeJobFlowsRequest)
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:
RUNNING
, WAITING
,
SHUTTING_DOWN
, STARTING
Amazon Elastic MapReduce can return a maximum of 512 job flow descriptions.
describeJobFlows
in interface AmazonElasticMapReduce
describeJobFlowsRequest
- The input for the DescribeJobFlows operation.InternalServerErrorException
- Indicates that an error occurred while processing the request and
that the request was not completed.@Deprecated public DescribeJobFlowsResult describeJobFlows()
AmazonElasticMapReduce
describeJobFlows
in interface AmazonElasticMapReduce
AmazonElasticMapReduce.describeJobFlows(DescribeJobFlowsRequest)
public DescribeStepResult describeStep(DescribeStepRequest describeStepRequest)
Provides more detail about the cluster step.
describeStep
in interface AmazonElasticMapReduce
describeStepRequest
- This input determines which step to describe.InternalServerException
- This exception occurs when there is an internal failure in the
EMR service.InvalidRequestException
- This exception occurs when there is something wrong with user
input.public ListBootstrapActionsResult listBootstrapActions(ListBootstrapActionsRequest listBootstrapActionsRequest)
Provides information about the bootstrap actions associated with a cluster.
listBootstrapActions
in interface AmazonElasticMapReduce
listBootstrapActionsRequest
- This input determines which bootstrap actions to retrieve.InternalServerException
- This exception occurs when there is an internal failure in the
EMR service.InvalidRequestException
- This exception occurs when there is something wrong with user
input.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.
listClusters
in interface AmazonElasticMapReduce
listClustersRequest
- This input determines how the ListClusters action filters the list
of clusters that it returns.InternalServerException
- This exception occurs when there is an internal failure in the
EMR service.InvalidRequestException
- This exception occurs when there is something wrong with user
input.public ListClustersResult listClusters()
AmazonElasticMapReduce
listClusters
in interface AmazonElasticMapReduce
AmazonElasticMapReduce.listClusters(ListClustersRequest)
public ListInstanceGroupsResult listInstanceGroups(ListInstanceGroupsRequest listInstanceGroupsRequest)
Provides all available details about the instance groups in a cluster.
listInstanceGroups
in interface AmazonElasticMapReduce
listInstanceGroupsRequest
- This input determines which instance groups to retrieve.InternalServerException
- This exception occurs when there is an internal failure in the
EMR service.InvalidRequestException
- This exception occurs when there is something wrong with user
input.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.
listInstances
in interface AmazonElasticMapReduce
listInstancesRequest
- This input determines which instances to list.InternalServerException
- This exception occurs when there is an internal failure in the
EMR service.InvalidRequestException
- This exception occurs when there is something wrong with user
input.public ListStepsResult listSteps(ListStepsRequest listStepsRequest)
Provides a list of steps for the cluster.
listSteps
in interface AmazonElasticMapReduce
listStepsRequest
- This input determines which steps to list.InternalServerException
- This exception occurs when there is an internal failure in the
EMR service.InvalidRequestException
- This exception occurs when there is something wrong with user
input.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.
modifyInstanceGroups
in interface AmazonElasticMapReduce
modifyInstanceGroupsRequest
- Change the size of some instance groups.InternalServerErrorException
- Indicates that an error occurred while processing the request and
that the request was not completed.public void modifyInstanceGroups()
AmazonElasticMapReduce
modifyInstanceGroups
in interface AmazonElasticMapReduce
AmazonElasticMapReduce.modifyInstanceGroups(ModifyInstanceGroupsRequest)
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:
removeTags
in interface AmazonElasticMapReduce
removeTagsRequest
- This input identifies a cluster and a list of tags to remove.InternalServerException
- This exception occurs when there is an internal failure in the
EMR service.InvalidRequestException
- This exception occurs when there is something wrong with user
input.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.
runJobFlow
in interface AmazonElasticMapReduce
runJobFlowRequest
- Input to the RunJobFlow operation.InternalServerErrorException
- Indicates that an error occurred while processing the request and
that the request was not completed.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.
setTerminationProtection
in interface AmazonElasticMapReduce
setTerminationProtectionRequest
- The input argument to the TerminationProtection operation.InternalServerErrorException
- Indicates that an error occurred while processing the request and
that the request was not completed.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.
setVisibleToAllUsers
in interface AmazonElasticMapReduce
setVisibleToAllUsersRequest
- The input to the SetVisibleToAllUsers action.InternalServerErrorException
- Indicates that an error occurred while processing the request and
that the request was not completed.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 maximum number of JobFlows allowed is 10. 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.
terminateJobFlows
in interface AmazonElasticMapReduce
terminateJobFlowsRequest
- Input to the TerminateJobFlows operation.InternalServerErrorException
- Indicates that an error occurred while processing the request and
that the request was not completed.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
getCachedResponseMetadata
in interface AmazonElasticMapReduce
request
- The originally executed requestCopyright © 2016. All rights reserved.