@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonElasticMapReduceClient extends AmazonWebServiceClient implements AmazonElasticMapReduce
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.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Constructor and Description |
---|
AmazonElasticMapReduceClient()
Deprecated.
|
AmazonElasticMapReduceClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AmazonElasticMapReduceClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AmazonElasticMapReduceClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AmazonElasticMapReduceClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AmazonElasticMapReduceClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AmazonElasticMapReduceClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AmazonElasticMapReduceClient(ClientConfiguration clientConfiguration)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
AddInstanceFleetResult |
addInstanceFleet(AddInstanceFleetRequest request)
Adds an instance fleet to a running cluster.
|
AddInstanceGroupsResult |
addInstanceGroups(AddInstanceGroupsRequest request)
Adds one or more instance groups to a running cluster.
|
AddJobFlowStepsResult |
addJobFlowSteps(AddJobFlowStepsRequest request)
AddJobFlowSteps adds new steps to a running cluster.
|
AddTagsResult |
addTags(AddTagsRequest request)
Adds tags to an Amazon EMR resource.
|
static AmazonElasticMapReduceClientBuilder |
builder() |
CancelStepsResult |
cancelSteps(CancelStepsRequest request)
Cancels a pending step or steps in a running cluster.
|
CreateSecurityConfigurationResult |
createSecurityConfiguration(CreateSecurityConfigurationRequest request)
Creates a security configuration, which is stored in the service and can be specified when a cluster is created.
|
DeleteSecurityConfigurationResult |
deleteSecurityConfiguration(DeleteSecurityConfigurationRequest request)
Deletes a security configuration.
|
DescribeClusterResult |
describeCluster(DescribeClusterRequest request)
Provides cluster-level details including status, hardware and software configuration, VPC settings, and so on.
|
DescribeJobFlowsResult |
describeJobFlows()
Deprecated.
|
DescribeJobFlowsResult |
describeJobFlows(DescribeJobFlowsRequest request)
Deprecated.
|
DescribeSecurityConfigurationResult |
describeSecurityConfiguration(DescribeSecurityConfigurationRequest request)
Provides the details of a security configuration by returning the configuration JSON.
|
DescribeStepResult |
describeStep(DescribeStepRequest request)
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 request)
Provides information about the bootstrap actions associated with a cluster.
|
ListClustersResult |
listClusters()
Simplified method form for invoking the ListClusters operation.
|
ListClustersResult |
listClusters(ListClustersRequest request)
Provides the status of all clusters visible to this AWS account.
|
ListInstanceFleetsResult |
listInstanceFleets(ListInstanceFleetsRequest request)
Lists all available details about the instance fleets in a cluster.
|
ListInstanceGroupsResult |
listInstanceGroups(ListInstanceGroupsRequest request)
Provides all available details about the instance groups in a cluster.
|
ListInstancesResult |
listInstances(ListInstancesRequest request)
Provides information for all active EC2 instances and EC2 instances terminated in the last 30 days, up to a
maximum of 2,000.
|
ListSecurityConfigurationsResult |
listSecurityConfigurations(ListSecurityConfigurationsRequest request)
Lists all the security configurations visible to this account, providing their creation dates and times, and
their names.
|
ListStepsResult |
listSteps(ListStepsRequest request)
Provides a list of steps for the cluster in reverse order unless you specify stepIds with the request.
|
ModifyInstanceFleetResult |
modifyInstanceFleet(ModifyInstanceFleetRequest request)
Modifies the target On-Demand and target Spot capacities for the instance fleet with the specified
InstanceFleetID within the cluster specified using ClusterID.
|
ModifyInstanceGroupsResult |
modifyInstanceGroups()
Simplified method form for invoking the ModifyInstanceGroups operation.
|
ModifyInstanceGroupsResult |
modifyInstanceGroups(ModifyInstanceGroupsRequest request)
ModifyInstanceGroups modifies the number of nodes and configuration settings of an instance group.
|
PutAutoScalingPolicyResult |
putAutoScalingPolicy(PutAutoScalingPolicyRequest request)
Creates or updates an automatic scaling policy for a core instance group or task instance group in an Amazon EMR
cluster.
|
RemoveAutoScalingPolicyResult |
removeAutoScalingPolicy(RemoveAutoScalingPolicyRequest request)
Removes an automatic scaling policy from a specified instance group within an EMR cluster.
|
RemoveTagsResult |
removeTags(RemoveTagsRequest request)
Removes tags from an Amazon EMR resource.
|
RunJobFlowResult |
runJobFlow(RunJobFlowRequest request)
RunJobFlow creates and starts running a new cluster (job flow).
|
SetTerminationProtectionResult |
setTerminationProtection(SetTerminationProtectionRequest request)
SetTerminationProtection locks a cluster (job flow) so the EC2 instances in the cluster cannot be terminated by
user intervention, an API call, or in the event of a job-flow error.
|
SetVisibleToAllUsersResult |
setVisibleToAllUsers(SetVisibleToAllUsersRequest request)
Sets whether all AWS Identity and Access Management (IAM) users under your account can access the specified
clusters (job flows).
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
TerminateJobFlowsResult |
terminateJobFlows(TerminateJobFlowsRequest request)
TerminateJobFlows shuts a list of clusters (job flows) down.
|
AmazonElasticMapReduceWaiters |
waiters() |
addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion
@Deprecated public AmazonElasticMapReduceClient()
AmazonElasticMapReduceClientBuilder.defaultClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
@Deprecated public AmazonElasticMapReduceClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(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
@Deprecated public AmazonElasticMapReduceClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
for example:
AmazonElasticMapReduceClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
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.@Deprecated public AmazonElasticMapReduceClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(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.).@Deprecated public AmazonElasticMapReduceClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(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.@Deprecated public AmazonElasticMapReduceClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(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.).@Deprecated public AmazonElasticMapReduceClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
and
AwsClientBuilder.withMetricsCollector(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 static AmazonElasticMapReduceClientBuilder builder()
public AddInstanceFleetResult addInstanceFleet(AddInstanceFleetRequest request)
Adds an instance fleet to a running cluster.
The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x.
addInstanceFleet
in interface AmazonElasticMapReduce
addInstanceFleetRequest
- 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 AddInstanceGroupsResult addInstanceGroups(AddInstanceGroupsRequest request)
Adds one or more instance groups 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 request)
AddJobFlowSteps adds new steps to a running cluster. A maximum of 256 steps are allowed in each job flow.
If your cluster 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 SSH 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, see Add More than 256 Steps to a Cluster in the Amazon EMR Management Guide.
A step specifies the location of a JAR file stored either on the master node of the cluster 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.
Amazon EMR 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 cluster 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 request)
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 CancelStepsResult cancelSteps(CancelStepsRequest request)
Cancels a pending step or steps in a running cluster. Available only in Amazon EMR versions 4.8.0 and later,
excluding version 5.0.0. A maximum of 256 steps are allowed in each CancelSteps request. CancelSteps is
idempotent but asynchronous; it does not guarantee a step will be canceled, even if the request is successfully
submitted. You can only cancel steps that are in a PENDING
state.
cancelSteps
in interface AmazonElasticMapReduce
cancelStepsRequest
- The input argument to the CancelSteps operation.InternalServerErrorException
- Indicates that an error occurred while processing the request and that the request was not completed.InvalidRequestException
- This exception occurs when there is something wrong with user input.public CreateSecurityConfigurationResult createSecurityConfiguration(CreateSecurityConfigurationRequest request)
Creates a security configuration, which is stored in the service and can be specified when a cluster is created.
createSecurityConfiguration
in interface AmazonElasticMapReduce
createSecurityConfigurationRequest
- 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 DeleteSecurityConfigurationResult deleteSecurityConfiguration(DeleteSecurityConfigurationRequest request)
Deletes a security configuration.
deleteSecurityConfiguration
in interface AmazonElasticMapReduce
deleteSecurityConfigurationRequest
- 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 request)
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 request)
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 EMR 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 DescribeSecurityConfigurationResult describeSecurityConfiguration(DescribeSecurityConfigurationRequest request)
Provides the details of a security configuration by returning the configuration JSON.
describeSecurityConfiguration
in interface AmazonElasticMapReduce
describeSecurityConfigurationRequest
- 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 DescribeStepResult describeStep(DescribeStepRequest request)
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 request)
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 request)
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 ListInstanceFleetsResult listInstanceFleets(ListInstanceFleetsRequest request)
Lists all available details about the instance fleets in a cluster.
The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.
listInstanceFleets
in interface AmazonElasticMapReduce
listInstanceFleetsRequest
- 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 ListInstanceGroupsResult listInstanceGroups(ListInstanceGroupsRequest request)
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 request)
Provides information for all active EC2 instances and EC2 instances terminated in the last 30 days, up to a maximum of 2,000. EC2 instances in any of the following states are considered active: AWAITING_FULFILLMENT, PROVISIONING, BOOTSTRAPPING, RUNNING.
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 ListSecurityConfigurationsResult listSecurityConfigurations(ListSecurityConfigurationsRequest request)
Lists all the security configurations visible to this account, providing their creation dates and times, and their names. This call returns a maximum of 50 clusters per call, but returns a marker to track the paging of the cluster list across multiple ListSecurityConfigurations calls.
listSecurityConfigurations
in interface AmazonElasticMapReduce
listSecurityConfigurationsRequest
- 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 request)
Provides a list of steps for the cluster in reverse order unless you specify stepIds with the request.
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 ModifyInstanceFleetResult modifyInstanceFleet(ModifyInstanceFleetRequest request)
Modifies the target On-Demand and target Spot capacities for the instance fleet with the specified InstanceFleetID within the cluster specified using ClusterID. The call either succeeds or fails atomically.
The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.
modifyInstanceFleet
in interface AmazonElasticMapReduce
modifyInstanceFleetRequest
- 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 ModifyInstanceGroupsResult modifyInstanceGroups(ModifyInstanceGroupsRequest request)
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 ModifyInstanceGroupsResult modifyInstanceGroups()
AmazonElasticMapReduce
modifyInstanceGroups
in interface AmazonElasticMapReduce
AmazonElasticMapReduce.modifyInstanceGroups(ModifyInstanceGroupsRequest)
public PutAutoScalingPolicyResult putAutoScalingPolicy(PutAutoScalingPolicyRequest request)
Creates or updates an automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically adds and terminates EC2 instances in response to the value of a CloudWatch metric.
putAutoScalingPolicy
in interface AmazonElasticMapReduce
putAutoScalingPolicyRequest
- public RemoveAutoScalingPolicyResult removeAutoScalingPolicy(RemoveAutoScalingPolicyRequest request)
Removes an automatic scaling policy from a specified instance group within an EMR cluster.
removeAutoScalingPolicy
in interface AmazonElasticMapReduce
removeAutoScalingPolicyRequest
- public RemoveTagsResult removeTags(RemoveTagsRequest request)
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 request)
RunJobFlow creates and starts running a new cluster (job flow). The cluster runs the steps specified. After the
steps complete, the cluster stops 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 cluster transitions to the
WAITING state rather than shutting down after the steps have completed.
For additional protection, you can set the JobFlowInstancesConfig TerminationProtected
parameter to TRUE
to lock the cluster 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 cluster 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, see Add More than 256 Steps to a Cluster in the Amazon EMR Management Guide.
For long running clusters, we recommend that you periodically store your results.
The instance fleets configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. The RunJobFlow request can contain InstanceFleets parameters or InstanceGroups parameters, but not both.
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 SetTerminationProtectionResult setTerminationProtection(SetTerminationProtectionRequest request)
SetTerminationProtection locks a cluster (job flow) so the 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 cluster is similar to calling the
Amazon EC2 DisableAPITermination
API on all EC2 instances in a cluster.
SetTerminationProtection
is used to prevent accidental termination of a cluster and to ensure that
in the event of an error, the instances persist so that you can recover any data stored in their ephemeral
instance storage.
To terminate a cluster 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, seeManaging Cluster Termination in the Amazon EMR Management 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 SetVisibleToAllUsersResult setVisibleToAllUsers(SetVisibleToAllUsersRequest request)
Sets whether all AWS Identity and Access Management (IAM) users under your account can access the specified
clusters (job flows). This action works on running clusters. You can also set the visibility of a cluster when
you launch it using the VisibleToAllUsers
parameter of RunJobFlow. The SetVisibleToAllUsers
action can be called only by an IAM user who created the cluster or the AWS account that owns the cluster.
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 TerminateJobFlowsResult terminateJobFlows(TerminateJobFlowsRequest request)
TerminateJobFlows shuts a list of clusters (job flows) down. When a job flow is shut down, any step not yet completed is canceled and the EC2 instances on which the cluster is running are stopped. Any log files not already saved are uploaded to Amazon S3 if a LogUri was specified when the cluster was created.
The maximum number of clusters allowed is 10. The call to TerminateJobFlows
is asynchronous.
Depending on the configuration of the cluster, it may take up to 1-5 minutes for the cluster 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 requestpublic AmazonElasticMapReduceWaiters waiters()
waiters
in interface AmazonElasticMapReduce
public void shutdown()
AmazonWebServiceClient
shutdown
in interface AmazonElasticMapReduce
shutdown
in class AmazonWebServiceClient
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.