public interface AmazonElasticMapReduce
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.
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 ("https://elasticmapreduce.amazonaws.com").
|
void |
setRegion(Region region)
An alternative to
setEndpoint(String) , sets the
regional endpoint for this client's service calls. |
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 |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
void |
terminateJobFlows(TerminateJobFlowsRequest terminateJobFlowsRequest)
TerminateJobFlows shuts a list of job flows down.
|
void setEndpoint(String endpoint) throws IllegalArgumentException
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
This method is not threadsafe. An endpoint 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 or retrying.
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.IllegalArgumentException
- If any problems are detected with the specified endpoint.void setRegion(Region region) throws IllegalArgumentException
setEndpoint(String)
, sets the
regional endpoint for this client's service calls. Callers can use this
method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol.
To use http instead, specify it in the ClientConfiguration
supplied at construction.
This method is not threadsafe. A region 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 or retrying.
region
- The region this client will communicate with. See
Region.getRegion(com.amazonaws.regions.Regions)
for
accessing a given region.IllegalArgumentException
- If the given region is null, or if this service isn't
available in the given region. See
Region.isServiceSupported(String)
Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
ListBootstrapActionsResult listBootstrapActions(ListBootstrapActionsRequest listBootstrapActionsRequest) throws AmazonServiceException, AmazonClientException
Provides information about the bootstrap actions associated with a cluster.
listBootstrapActionsRequest
- Container for the necessary
parameters to execute the ListBootstrapActions service method on
AmazonElasticMapReduce.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.AddTagsResult addTags(AddTagsRequest addTagsRequest) throws AmazonServiceException, AmazonClientException
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 .
addTagsRequest
- Container for the necessary parameters to
execute the AddTags service method on AmazonElasticMapReduce.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.void setVisibleToAllUsers(SetVisibleToAllUsersRequest setVisibleToAllUsersRequest) throws AmazonServiceException, AmazonClientException
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.
setVisibleToAllUsersRequest
- Container for the necessary
parameters to execute the SetVisibleToAllUsers service method on
AmazonElasticMapReduce.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.ListStepsResult listSteps(ListStepsRequest listStepsRequest) throws AmazonServiceException, AmazonClientException
Provides a list of steps for the cluster.
listStepsRequest
- Container for the necessary parameters to
execute the ListSteps service method on AmazonElasticMapReduce.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.AddJobFlowStepsResult 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.
addJobFlowStepsRequest
- Container for the necessary parameters
to execute the AddJobFlowSteps service method on
AmazonElasticMapReduce.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.DescribeStepResult describeStep(DescribeStepRequest describeStepRequest) throws AmazonServiceException, AmazonClientException
Provides more detail about the cluster step.
describeStepRequest
- Container for the necessary parameters to
execute the DescribeStep service method on AmazonElasticMapReduce.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.ListClustersResult listClusters(ListClustersRequest listClustersRequest) 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.
listClustersRequest
- Container for the necessary parameters to
execute the ListClusters service method on AmazonElasticMapReduce.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.RemoveTagsResult removeTags(RemoveTagsRequest removeTagsRequest) throws AmazonServiceException, AmazonClientException
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:
removeTagsRequest
- Container for the necessary parameters to
execute the RemoveTags service method on AmazonElasticMapReduce.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.ListInstanceGroupsResult listInstanceGroups(ListInstanceGroupsRequest listInstanceGroupsRequest) throws AmazonServiceException, AmazonClientException
Provides all available details about the instance groups in a cluster.
listInstanceGroupsRequest
- Container for the necessary
parameters to execute the ListInstanceGroups service method on
AmazonElasticMapReduce.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.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.
modifyInstanceGroupsRequest
- Container for the necessary
parameters to execute the ModifyInstanceGroups service method on
AmazonElasticMapReduce.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.ListInstancesResult listInstances(ListInstancesRequest listInstancesRequest) throws AmazonServiceException, AmazonClientException
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.
listInstancesRequest
- Container for the necessary parameters to
execute the ListInstances service method on AmazonElasticMapReduce.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.AddInstanceGroupsResult addInstanceGroups(AddInstanceGroupsRequest addInstanceGroupsRequest) throws AmazonServiceException, AmazonClientException
AddInstanceGroups adds an instance group to a running cluster.
addInstanceGroupsRequest
- Container for the necessary parameters
to execute the AddInstanceGroups service method on
AmazonElasticMapReduce.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.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.
terminateJobFlowsRequest
- Container for the necessary parameters
to execute the TerminateJobFlows service method on
AmazonElasticMapReduce.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.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.
setTerminationProtectionRequest
- Container for the necessary
parameters to execute the SetTerminationProtection service method on
AmazonElasticMapReduce.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.@Deprecated DescribeJobFlowsResult describeJobFlows(DescribeJobFlowsRequest describeJobFlowsRequest) throws AmazonServiceException, AmazonClientException
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.
describeJobFlowsRequest
- Container for the necessary parameters
to execute the DescribeJobFlows service method on
AmazonElasticMapReduce.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.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.
runJobFlowRequest
- Container for the necessary parameters to
execute the RunJobFlow service method on AmazonElasticMapReduce.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.DescribeClusterResult describeCluster(DescribeClusterRequest describeClusterRequest) throws AmazonServiceException, AmazonClientException
Provides cluster-level details including status, hardware and software configuration, VPC settings, and so on. For information about the cluster steps, see ListSteps.
describeClusterRequest
- Container for the necessary parameters
to execute the DescribeCluster service method on
AmazonElasticMapReduce.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.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.
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.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.
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.@Deprecated DescribeJobFlowsResult describeJobFlows() throws AmazonServiceException, AmazonClientException
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.
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.void shutdown()
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 a request.
request
- The originally executed request.Copyright © 2014. All rights reserved.