com.amazonaws.services.elasticmapreduce.AmazonElasticMapReduce Maven / Gradle / Ivy
/*
* Copyright 2010-2011 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.elasticmapreduce;
import com.amazonaws.*;
import com.amazonaws.services.elasticmapreduce.model.*;
/**
* Interface for accessing AmazonElasticMapReduce.
*
* This is the Amazon Elastic MapReduce API Reference Guide. This guide
* is for programmers who need detailed information about the Amazon
* Elastic MapReduce APIs.
*
*/
public interface AmazonElasticMapReduce {
/**
* Overrides the default endpoint for this client ("https://elasticmapreduce.amazonaws.com").
* Callers can use this method to control which AWS region they want to work with.
*
* 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
* {@link 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
*
* @param 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.
*
* @throws IllegalArgumentException
* If any problems are detected with the specified endpoint.
*/
public void setEndpoint(String endpoint) throws java.lang.IllegalArgumentException;
/**
*
* AddInstanceGroups adds an instance group to a running cluster.
*
*
* @param addInstanceGroupsRequest Container for the necessary parameters
* to execute the AddInstanceGroups service method on
* AmazonElasticMapReduce.
*
* @return The response from the AddInstanceGroups service method, as
* returned by AmazonElasticMapReduce.
*
* @throws InternalServerErrorException
*
* @throws 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticMapReduce indicating
* either a problem with the data in the request, or a server side issue.
*/
public AddInstanceGroupsResult addInstanceGroups(AddInstanceGroupsRequest addInstanceGroupsRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* AddJobFlowSteps adds new steps to a running job flow. A maximum of
* 256 steps are allowed in each job flow.
*
*
* A step specifies the location of a JAR file stored either on the
* master node of the job flow or in Amazon S3. Each step is performed by
* the main function of the main class of the JAR file. The main class
* can be specified either in the manifest of the JAR or by using the
* MainFunction parameter of the step.
*
*
* Elastic MapReduce executes each step in the order listed. For a step
* to be considered complete, the main function must exit with a zero
* exit code and all Hadoop jobs started while the step was running must
* have completed and run successfully.
*
*
* You can only add steps to a job flow that is in one of the following
* states: STARTING, BOOTSTAPPING, RUNNING, or WAITING.
*
*
* @param addJobFlowStepsRequest Container for the necessary parameters
* to execute the AddJobFlowSteps service method on
* AmazonElasticMapReduce.
*
* @throws InternalServerErrorException
*
* @throws 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticMapReduce indicating
* either a problem with the data in the request, or a server side issue.
*/
public void addJobFlowSteps(AddJobFlowStepsRequest addJobFlowStepsRequest)
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.
*
*
* @param terminateJobFlowsRequest Container for the necessary parameters
* to execute the TerminateJobFlows service method on
* AmazonElasticMapReduce.
*
* @throws InternalServerErrorException
*
* @throws 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticMapReduce indicating
* either a problem with the data in the request, or a server side issue.
*/
public void terminateJobFlows(TerminateJobFlowsRequest terminateJobFlowsRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* DescribeJobFlows returns a list of job flows that match all of the
* supplied parameters. The parameters can include a list of job flow
* IDs, job flow states, and restrictions on job flow creation date and
* time.
*
*
* Regardless of supplied parameters, only job flows created within the
* last two months are returned.
*
*
* If no parameters are supplied, then job flows matching either of the
* following criteria are returned:
*
*
*
* - Job flows created and completed in the last two weeks
* - Job flows created within the last two months that are in one of
* the following states:
RUNNING ,
*
* WAITING ,
*
* SHUTTING_DOWN ,
*
* STARTING
*
*
*
* Amazon Elastic MapReduce can return a maximum of 512 job flow
* descriptions.
*
*
* @param describeJobFlowsRequest Container for the necessary parameters
* to execute the DescribeJobFlows service method on
* AmazonElasticMapReduce.
*
* @return The response from the DescribeJobFlows service method, as
* returned by AmazonElasticMapReduce.
*
* @throws InternalServerErrorException
*
* @throws 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticMapReduce indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeJobFlowsResult describeJobFlows(DescribeJobFlowsRequest describeJobFlowsRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* RunJobFlow creates and starts running a new job flow. The job flow
* will run the steps specified. Once the job flow completes, the cluster
* is stopped and the HDFS partition is lost. To prevent loss of data,
* configure the last step of the job flow to store results in Amazon
* S3. If the JobFlowInstancesDetail : KeepJobFlowAliveWhenNoSteps
* parameter is set to TRUE , the job flow will transition
* to the WAITING state rather than shutting down once the steps have
* completed.
*
*
* A maximum of 256 steps are allowed in each job flow.
*
*
* For long running job flows, we recommended that you periodically store
* your results.
*
*
* @param runJobFlowRequest Container for the necessary parameters to
* execute the RunJobFlow service method on AmazonElasticMapReduce.
*
* @return The response from the RunJobFlow service method, as returned
* by AmazonElasticMapReduce.
*
* @throws InternalServerErrorException
*
* @throws 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticMapReduce indicating
* either a problem with the data in the request, or a server side issue.
*/
public RunJobFlowResult runJobFlow(RunJobFlowRequest runJobFlowRequest)
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.
*
*
* @param modifyInstanceGroupsRequest Container for the necessary
* parameters to execute the ModifyInstanceGroups service method on
* AmazonElasticMapReduce.
*
* @throws InternalServerErrorException
*
* @throws 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticMapReduce indicating
* either a problem with the data in the request, or a server side issue.
*/
public void modifyInstanceGroups(ModifyInstanceGroupsRequest modifyInstanceGroupsRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* DescribeJobFlows returns a list of job flows that match all of the
* supplied parameters. The parameters can include a list of job flow
* IDs, job flow states, and restrictions on job flow creation date and
* time.
*
*
* Regardless of supplied parameters, only job flows created within the
* last two months are returned.
*
*
* If no parameters are supplied, then job flows matching either of the
* following criteria are returned:
*
*
*
* - Job flows created and completed in the last two weeks
* - Job flows created within the last two months that are in one of
* the following states:
RUNNING ,
*
* WAITING ,
*
* SHUTTING_DOWN ,
*
* STARTING
*
*
*
* Amazon Elastic MapReduce can return a maximum of 512 job flow
* descriptions.
*
*
* @return The response from the DescribeJobFlows service method, as
* returned by AmazonElasticMapReduce.
*
* @throws InternalServerErrorException
*
* @throws 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticMapReduce indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeJobFlowsResult describeJobFlows() 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.
*
*
* @throws InternalServerErrorException
*
* @throws 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticMapReduce indicating
* either a problem with the data in the request, or a server side issue.
*/
public void modifyInstanceGroups() throws AmazonServiceException, AmazonClientException;
/**
* Shuts down this client object, releasing any resources that might be held
* open. This is an optional method, and callers are not expected to call
* it, but can if they want to explicitly release any open resources. Once a
* client has been shutdown, it should not be used to make any more
* requests.
*/
public void shutdown();
/**
* 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 a request.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none
* is available.
*/
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}