AmazonElasticMapReduce (AWS SDK for Java

All Known Subinterfaces:

AmazonElasticMapReduceAsync

All Known Implementing Classes:

AbstractAmazonElasticMapReduce, AbstractAmazonElasticMapReduceAsync, AmazonElasticMapReduceAsyncClient, AmazonElasticMapReduceClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonElasticMapReduce
```
Interface for accessing Amazon EMR.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonElasticMapReduce instead.

Amazon EMR is a web service that makes it easy to process large amounts of data efficiently. Amazon EMR uses Hadoop processing combined with several AWS products to do tasks such as web indexing, data mining, log file analysis, machine learning, scientific simulation, and data warehousing.

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`AddInstanceFleetResult`	`addInstanceFleet(AddInstanceFleetRequest addInstanceFleetRequest)` Adds an instance fleet to a running cluster.
`AddInstanceGroupsResult`	`addInstanceGroups(AddInstanceGroupsRequest addInstanceGroupsRequest)` Adds one or more instance groups to a running cluster.
`AddJobFlowStepsResult`	`addJobFlowSteps(AddJobFlowStepsRequest addJobFlowStepsRequest)` AddJobFlowSteps adds new steps to a running cluster.
`AddTagsResult`	`addTags(AddTagsRequest addTagsRequest)` Adds tags to an Amazon EMR resource.
`CancelStepsResult`	`cancelSteps(CancelStepsRequest cancelStepsRequest)` Cancels a pending step or steps in a running cluster.
`CreateSecurityConfigurationResult`	`createSecurityConfiguration(CreateSecurityConfigurationRequest createSecurityConfigurationRequest)` Creates a security configuration, which is stored in the service and can be specified when a cluster is created.
`DeleteSecurityConfigurationResult`	`deleteSecurityConfiguration(DeleteSecurityConfigurationRequest deleteSecurityConfigurationRequest)` Deletes a security configuration.
`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.
`DescribeSecurityConfigurationResult`	`describeSecurityConfiguration(DescribeSecurityConfigurationRequest describeSecurityConfigurationRequest)` Provides the details of a security configuration by returning the configuration JSON.
`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.
`ListInstanceFleetsResult`	`listInstanceFleets(ListInstanceFleetsRequest listInstanceFleetsRequest)` Lists all available details about the instance fleets in a cluster.
`ListInstanceGroupsResult`	`listInstanceGroups(ListInstanceGroupsRequest listInstanceGroupsRequest)` Provides all available details about the instance groups in a cluster.
`ListInstancesResult`	`listInstances(ListInstancesRequest listInstancesRequest)` 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 listSecurityConfigurationsRequest)` Lists all the security configurations visible to this account, providing their creation dates and times, and their names.
`ListStepsResult`	`listSteps(ListStepsRequest listStepsRequest)` Provides a list of steps for the cluster in reverse order unless you specify stepIds with the request.
`ModifyInstanceFleetResult`	`modifyInstanceFleet(ModifyInstanceFleetRequest modifyInstanceFleetRequest)` 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 modifyInstanceGroupsRequest)` ModifyInstanceGroups modifies the number of nodes and configuration settings of an instance group.
`PutAutoScalingPolicyResult`	`putAutoScalingPolicy(PutAutoScalingPolicyRequest putAutoScalingPolicyRequest)` Creates or updates an automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster.
`RemoveAutoScalingPolicyResult`	`removeAutoScalingPolicy(RemoveAutoScalingPolicyRequest removeAutoScalingPolicyRequest)` Removes an automatic scaling policy from a specified instance group within an EMR cluster.
`RemoveTagsResult`	`removeTags(RemoveTagsRequest removeTagsRequest)` Removes tags from an Amazon EMR resource.
`RunJobFlowResult`	`runJobFlow(RunJobFlowRequest runJobFlowRequest)` RunJobFlow creates and starts running a new cluster (job flow).
`void`	`setEndpoint(String endpoint)` Deprecated. use `AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)` for example: `builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));`
`void`	`setRegion(Region region)` Deprecated. use `AwsClientBuilder#setRegion(String)`
`SetTerminationProtectionResult`	`setTerminationProtection(SetTerminationProtectionRequest setTerminationProtectionRequest)` 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 setVisibleToAllUsersRequest)` 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 terminateJobFlowsRequest)` TerminateJobFlows shuts a list of clusters (job flows) down.
`AmazonElasticMapReduceWaiters`	`waiters()`

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - setEndpoint
```
@Deprecated
void setEndpoint(String endpoint)
```
    Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
    
    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: "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.
    
    Parameters:
    
    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.
  - setRegion
```
@Deprecated
void setRegion(Region region)
```
    Deprecated. use AwsClientBuilder#setRegion(String)
    
    An alternative to 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.
    
    Parameters:
    
    region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.
    
    See Also:
    
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - addInstanceFleet
```
AddInstanceFleetResult addInstanceFleet(AddInstanceFleetRequest addInstanceFleetRequest)
```
    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.
    
    Parameters:
    
    addInstanceFleetRequest -
    
    Returns:
    
    Result of the AddInstanceFleet operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - addInstanceGroups
```
AddInstanceGroupsResult addInstanceGroups(AddInstanceGroupsRequest addInstanceGroupsRequest)
```
    Adds one or more instance groups to a running cluster.
    
    Parameters:
    
    addInstanceGroupsRequest - Input to an AddInstanceGroups call.
    
    Returns:
    
    Result of the AddInstanceGroups operation returned by the service.
    
    Throws:
    
    InternalServerErrorException - Indicates that an error occurred while processing the request and that the request was not completed.
    
    See Also:
    
    AWS API Documentation
  - addJobFlowSteps
```
AddJobFlowStepsResult addJobFlowSteps(AddJobFlowStepsRequest addJobFlowStepsRequest)
```
    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.
    
    Parameters:
    
    addJobFlowStepsRequest - The input argument to the AddJobFlowSteps operation.
    
    Returns:
    
    Result of the AddJobFlowSteps operation returned by the service.
    
    Throws:
    
    InternalServerErrorException - Indicates that an error occurred while processing the request and that the request was not completed.
    
    See Also:
    
    AWS API Documentation
  - addTags
```
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.
    
    Parameters:
    
    addTagsRequest - This input identifies a cluster and a list of tags to attach.
    
    Returns:
    
    Result of the AddTags operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - cancelSteps
```
CancelStepsResult cancelSteps(CancelStepsRequest cancelStepsRequest)
```
    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.
    
    Parameters:
    
    cancelStepsRequest - The input argument to the CancelSteps operation.
    
    Returns:
    
    Result of the CancelSteps operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createSecurityConfiguration
```
CreateSecurityConfigurationResult createSecurityConfiguration(CreateSecurityConfigurationRequest createSecurityConfigurationRequest)
```
    Creates a security configuration, which is stored in the service and can be specified when a cluster is created.
    
    Parameters:
    
    createSecurityConfigurationRequest -
    
    Returns:
    
    Result of the CreateSecurityConfiguration operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteSecurityConfiguration
```
DeleteSecurityConfigurationResult deleteSecurityConfiguration(DeleteSecurityConfigurationRequest deleteSecurityConfigurationRequest)
```
    Deletes a security configuration.
    
    Parameters:
    
    deleteSecurityConfigurationRequest -
    
    Returns:
    
    Result of the DeleteSecurityConfiguration operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - describeCluster
```
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.
    
    Parameters:
    
    describeClusterRequest - This input determines which cluster to describe.
    
    Returns:
    
    Result of the DescribeCluster operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - describeJobFlows
```
@Deprecated
DescribeJobFlowsResult describeJobFlows(DescribeJobFlowsRequest describeJobFlowsRequest)
```
    Deprecated.
    This API is deprecated and will eventually be removed. We recommend you use ListClusters, DescribeCluster, ListSteps, ListInstanceGroups and ListBootstrapActions instead.
    
    DescribeJobFlows returns a list of job flows that match all of the supplied parameters. The parameters can include a list of job flow IDs, job flow states, and restrictions on job flow creation date and time.
    
    Regardless of supplied parameters, only job flows created within the last two months are returned.
    
    If no parameters are supplied, then job flows matching either of the following criteria are returned:
    - Job flows created and completed in the last two weeks
    - Job flows created within the last two months that are in one of the following states: RUNNING, WAITING, SHUTTING_DOWN, STARTING
    Amazon EMR can return a maximum of 512 job flow descriptions.
    Parameters:
    
    describeJobFlowsRequest - The input for the DescribeJobFlows operation.
    
    Returns:
    
    Result of the DescribeJobFlows operation returned by the service.
    
    Throws:
    
    InternalServerErrorException - Indicates that an error occurred while processing the request and that the request was not completed.
    
    See Also:
    
    AWS API Documentation
  - describeJobFlows
```
@Deprecated
DescribeJobFlowsResult describeJobFlows()
```
    Deprecated.
    
    Simplified method form for invoking the DescribeJobFlows operation.
    
    See Also:
    
    describeJobFlows(DescribeJobFlowsRequest)
  - describeSecurityConfiguration
```
DescribeSecurityConfigurationResult describeSecurityConfiguration(DescribeSecurityConfigurationRequest describeSecurityConfigurationRequest)
```
    Provides the details of a security configuration by returning the configuration JSON.
    
    Parameters:
    
    describeSecurityConfigurationRequest -
    
    Returns:
    
    Result of the DescribeSecurityConfiguration operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - describeStep
```
DescribeStepResult describeStep(DescribeStepRequest describeStepRequest)
```
    Provides more detail about the cluster step.
    
    Parameters:
    
    describeStepRequest - This input determines which step to describe.
    
    Returns:
    
    Result of the DescribeStep operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listBootstrapActions
```
ListBootstrapActionsResult listBootstrapActions(ListBootstrapActionsRequest listBootstrapActionsRequest)
```
    Provides information about the bootstrap actions associated with a cluster.
    
    Parameters:
    
    listBootstrapActionsRequest - This input determines which bootstrap actions to retrieve.
    
    Returns:
    
    Result of the ListBootstrapActions operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listClusters
```
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.
    
    Parameters:
    
    listClustersRequest - This input determines how the ListClusters action filters the list of clusters that it returns.
    
    Returns:
    
    Result of the ListClusters operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listClusters
```
ListClustersResult listClusters()
```
    Simplified method form for invoking the ListClusters operation.
    
    See Also:
    
    listClusters(ListClustersRequest)
  - listInstanceFleets
```
ListInstanceFleetsResult listInstanceFleets(ListInstanceFleetsRequest listInstanceFleetsRequest)
```
    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.
    
    Parameters:
    
    listInstanceFleetsRequest -
    
    Returns:
    
    Result of the ListInstanceFleets operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listInstanceGroups
```
ListInstanceGroupsResult listInstanceGroups(ListInstanceGroupsRequest listInstanceGroupsRequest)
```
    Provides all available details about the instance groups in a cluster.
    
    Parameters:
    
    listInstanceGroupsRequest - This input determines which instance groups to retrieve.
    
    Returns:
    
    Result of the ListInstanceGroups operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listInstances
```
ListInstancesResult listInstances(ListInstancesRequest listInstancesRequest)
```
    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.
    
    Parameters:
    
    listInstancesRequest - This input determines which instances to list.
    
    Returns:
    
    Result of the ListInstances operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listSecurityConfigurations
```
ListSecurityConfigurationsResult listSecurityConfigurations(ListSecurityConfigurationsRequest listSecurityConfigurationsRequest)
```
    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.
    
    Parameters:
    
    listSecurityConfigurationsRequest -
    
    Returns:
    
    Result of the ListSecurityConfigurations operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listSteps
```
ListStepsResult listSteps(ListStepsRequest listStepsRequest)
```
    Provides a list of steps for the cluster in reverse order unless you specify stepIds with the request.
    
    Parameters:
    
    listStepsRequest - This input determines which steps to list.
    
    Returns:
    
    Result of the ListSteps operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - modifyInstanceFleet
```
ModifyInstanceFleetResult modifyInstanceFleet(ModifyInstanceFleetRequest modifyInstanceFleetRequest)
```
    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.
    
    Parameters:
    
    modifyInstanceFleetRequest -
    
    Returns:
    
    Result of the ModifyInstanceFleet operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - modifyInstanceGroups
```
ModifyInstanceGroupsResult 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.
    
    Parameters:
    
    modifyInstanceGroupsRequest - Change the size of some instance groups.
    
    Returns:
    
    Result of the ModifyInstanceGroups operation returned by the service.
    
    Throws:
    
    InternalServerErrorException - Indicates that an error occurred while processing the request and that the request was not completed.
    
    See Also:
    
    AWS API Documentation
  - modifyInstanceGroups
```
ModifyInstanceGroupsResult modifyInstanceGroups()
```
    Simplified method form for invoking the ModifyInstanceGroups operation.
    
    See Also:
    
    modifyInstanceGroups(ModifyInstanceGroupsRequest)
  - putAutoScalingPolicy
```
PutAutoScalingPolicyResult putAutoScalingPolicy(PutAutoScalingPolicyRequest putAutoScalingPolicyRequest)
```
    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.
    
    Parameters:
    
    putAutoScalingPolicyRequest -
    
    Returns:
    
    Result of the PutAutoScalingPolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - removeAutoScalingPolicy
```
RemoveAutoScalingPolicyResult removeAutoScalingPolicy(RemoveAutoScalingPolicyRequest removeAutoScalingPolicyRequest)
```
    Removes an automatic scaling policy from a specified instance group within an EMR cluster.
    
    Parameters:
    
    removeAutoScalingPolicyRequest -
    
    Returns:
    
    Result of the RemoveAutoScalingPolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - removeTags
```
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:
    
    Parameters:
    
    removeTagsRequest - This input identifies a cluster and a list of tags to remove.
    
    Returns:
    
    Result of the RemoveTags operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - runJobFlow
```
RunJobFlowResult runJobFlow(RunJobFlowRequest runJobFlowRequest)
```
    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.
    
    Parameters:
    
    runJobFlowRequest - Input to the RunJobFlow operation.
    
    Returns:
    
    Result of the RunJobFlow operation returned by the service.
    
    Throws:
    
    InternalServerErrorException - Indicates that an error occurred while processing the request and that the request was not completed.
    
    See Also:
    
    AWS API Documentation
  - setTerminationProtection
```
SetTerminationProtectionResult setTerminationProtection(SetTerminationProtectionRequest setTerminationProtectionRequest)
```
    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.
    
    Parameters:
    
    setTerminationProtectionRequest - The input argument to the TerminationProtection operation.
    
    Returns:
    
    Result of the SetTerminationProtection operation returned by the service.
    
    Throws:
    
    InternalServerErrorException - Indicates that an error occurred while processing the request and that the request was not completed.
    
    See Also:
    
    AWS API Documentation
  - setVisibleToAllUsers
```
SetVisibleToAllUsersResult setVisibleToAllUsers(SetVisibleToAllUsersRequest setVisibleToAllUsersRequest)
```
    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.
    
    Parameters:
    
    setVisibleToAllUsersRequest - The input to the SetVisibleToAllUsers action.
    
    Returns:
    
    Result of the SetVisibleToAllUsers operation returned by the service.
    
    Throws:
    
    InternalServerErrorException - Indicates that an error occurred while processing the request and that the request was not completed.
    
    See Also:
    
    AWS API Documentation
  - terminateJobFlows
```
TerminateJobFlowsResult terminateJobFlows(TerminateJobFlowsRequest terminateJobFlowsRequest)
```
    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.
    
    Parameters:
    
    terminateJobFlowsRequest - Input to the TerminateJobFlows operation.
    
    Returns:
    
    Result of the TerminateJobFlows operation returned by the service.
    
    Throws:
    
    InternalServerErrorException - Indicates that an error occurred while processing the request and that the request was not completed.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    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.
  - getCachedResponseMetadata
```
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - waiters
```
AmazonElasticMapReduceWaiters waiters()
```

Did this page help you?

Interface AmazonElasticMapReduce

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

setEndpoint

setRegion

addInstanceFleet

addInstanceGroups

addJobFlowSteps

addTags

cancelSteps

createSecurityConfiguration

deleteSecurityConfiguration

describeCluster

describeJobFlows

describeJobFlows

describeSecurityConfiguration

describeStep

listBootstrapActions

listClusters

listClusters

listInstanceFleets

listInstanceGroups

listInstances

listSecurityConfigurations

listSteps

modifyInstanceFleet

modifyInstanceGroups

modifyInstanceGroups

putAutoScalingPolicy

removeAutoScalingPolicy

removeTags

runJobFlow

setTerminationProtection

setVisibleToAllUsers

terminateJobFlows

shutdown

getCachedResponseMetadata

waiters