com.amazonaws.services.elasticmapreduce.AmazonElasticMapReduce Maven / Gradle / Ivy
Show all versions of aws-java-sdk-emr Show documentation
/*
* Copyright 2017-2022 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 javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.elasticmapreduce.model.*;
import com.amazonaws.services.elasticmapreduce.waiters.AmazonElasticMapReduceWaiters;
/**
* Interface for accessing Amazon EMR.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.elasticmapreduce.AbstractAmazonElasticMapReduce} instead.
*
*
*
* Amazon EMR is a web service that makes it easier to process large amounts of data efficiently. Amazon EMR uses Hadoop
* processing combined with several Amazon Web Services services to do tasks such as web indexing, data mining, log file
* analysis, machine learning, scientific simulation, and data warehouse management.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonElasticMapReduce {
/**
* 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 RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "elasticmapreduce";
/**
* 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 {@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: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection-
* choose-endpoint
*
* 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.
*
* @param 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.
* @deprecated use {@link AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)} for
* example:
* {@code builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));}
*/
@Deprecated
void setEndpoint(String endpoint);
/**
* An alternative to {@link AmazonElasticMapReduce#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
* {@link 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.
*
* @param region
* The region this client will communicate with. See {@link 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 Region#getRegion(com.amazonaws.regions.Regions)
* @see Region#createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
* @see Region#isServiceSupported(String)
* @deprecated use {@link AwsClientBuilder#setRegion(String)}
*/
@Deprecated
void setRegion(Region region);
/**
*
* 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.
*
*
*
* @param addInstanceFleetRequest
* @return Result of the AddInstanceFleet operation returned by the service.
* @throws InternalServerException
* This exception occurs when there is an internal failure in the Amazon EMR service.
* @throws InvalidRequestException
* This exception occurs when there is something wrong with user input.
* @sample AmazonElasticMapReduce.AddInstanceFleet
* @see AWS API Documentation
*/
AddInstanceFleetResult addInstanceFleet(AddInstanceFleetRequest addInstanceFleetRequest);
/**
*
* Adds one or more instance groups to a running cluster.
*
*
* @param addInstanceGroupsRequest
* Input to an AddInstanceGroups call.
* @return 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.
* @sample AmazonElasticMapReduce.AddInstanceGroups
* @see AWS API Documentation
*/
AddInstanceGroupsResult addInstanceGroups(AddInstanceGroupsRequest addInstanceGroupsRequest);
/**
*
* 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.
*
*
*
* The string values passed into HadoopJarStep object cannot exceed a total of 10240 characters.
*
*
*
* @param addJobFlowStepsRequest
* The input argument to the AddJobFlowSteps operation.
* @return 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.
* @sample AmazonElasticMapReduce.AddJobFlowSteps
* @see AWS API Documentation
*/
AddJobFlowStepsResult addJobFlowSteps(AddJobFlowStepsRequest addJobFlowStepsRequest);
/**
*
* Adds tags to an Amazon EMR resource, such as a cluster or an Amazon EMR Studio. Tags make it easier to associate
* resources in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. For more
* information, see Tag
* Clusters.
*
*
* @param addTagsRequest
* This input identifies an Amazon EMR resource and a list of tags to attach.
* @return Result of the AddTags operation returned by the service.
* @throws InternalServerException
* This exception occurs when there is an internal failure in the Amazon EMR service.
* @throws InvalidRequestException
* This exception occurs when there is something wrong with user input.
* @sample AmazonElasticMapReduce.AddTags
* @see AWS API
* Documentation
*/
AddTagsResult addTags(AddTagsRequest addTagsRequest);
/**
*
* 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 that a step will be canceled, even if the request is
* successfully submitted. When you use Amazon EMR versions 5.28.0 and later, you can cancel steps that are in a
* PENDING or RUNNING state. In earlier versions of Amazon EMR, you can only cancel steps
* that are in a PENDING state.
*
*
* @param cancelStepsRequest
* The input argument to the CancelSteps operation.
* @return 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.
* @throws InvalidRequestException
* This exception occurs when there is something wrong with user input.
* @sample AmazonElasticMapReduce.CancelSteps
* @see AWS
* API Documentation
*/
CancelStepsResult cancelSteps(CancelStepsRequest cancelStepsRequest);
/**
*
* Creates a security configuration, which is stored in the service and can be specified when a cluster is created.
*
*
* @param createSecurityConfigurationRequest
* @return Result of the CreateSecurityConfiguration operation returned by the service.
* @throws InternalServerException
* This exception occurs when there is an internal failure in the Amazon EMR service.
* @throws InvalidRequestException
* This exception occurs when there is something wrong with user input.
* @sample AmazonElasticMapReduce.CreateSecurityConfiguration
* @see AWS API Documentation
*/
CreateSecurityConfigurationResult createSecurityConfiguration(CreateSecurityConfigurationRequest createSecurityConfigurationRequest);
/**
*
* Creates a new Amazon EMR Studio.
*
*
* @param createStudioRequest
* @return Result of the CreateStudio operation returned by the service.
* @throws InternalServerException
* This exception occurs when there is an internal failure in the Amazon EMR service.
* @throws InvalidRequestException
* This exception occurs when there is something wrong with user input.
* @sample AmazonElasticMapReduce.CreateStudio
* @see AWS
* API Documentation
*/
CreateStudioResult createStudio(CreateStudioRequest createStudioRequest);
/**
*
* Maps a user or group to the Amazon EMR Studio specified by StudioId, and applies a session policy to
* refine Studio permissions for that user or group. Use CreateStudioSessionMapping to assign users to
* a Studio when you use Amazon Web Services SSO authentication. For instructions on how to assign users to a Studio
* when you use IAM authentication, see Assign a user or group to your EMR Studio.
*
*
* @param createStudioSessionMappingRequest
* @return Result of the CreateStudioSessionMapping operation returned by the service.
* @throws InternalServerErrorException
* Indicates that an error occurred while processing the request and that the request was not completed.
* @throws InvalidRequestException
* This exception occurs when there is something wrong with user input.
* @sample AmazonElasticMapReduce.CreateStudioSessionMapping
* @see AWS API Documentation
*/
CreateStudioSessionMappingResult createStudioSessionMapping(CreateStudioSessionMappingRequest createStudioSessionMappingRequest);
/**
*
* Deletes a security configuration.
*
*
* @param deleteSecurityConfigurationRequest
* @return Result of the DeleteSecurityConfiguration operation returned by the service.
* @throws InternalServerException
* This exception occurs when there is an internal failure in the Amazon EMR service.
* @throws InvalidRequestException
* This exception occurs when there is something wrong with user input.
* @sample AmazonElasticMapReduce.DeleteSecurityConfiguration
* @see AWS API Documentation
*/
DeleteSecurityConfigurationResult deleteSecurityConfiguration(DeleteSecurityConfigurationRequest deleteSecurityConfigurationRequest);
/**
*
* Removes an Amazon EMR Studio from the Studio metadata store.
*
*
* @param deleteStudioRequest
* @return Result of the DeleteStudio operation returned by the service.
* @throws InternalServerException
* This exception occurs when there is an internal failure in the Amazon EMR service.
* @throws InvalidRequestException
* This exception occurs when there is something wrong with user input.
* @sample AmazonElasticMapReduce.DeleteStudio
* @see AWS
* API Documentation
*/
DeleteStudioResult deleteStudio(DeleteStudioRequest deleteStudioRequest);
/**
*
* Removes a user or group from an Amazon EMR Studio.
*
*
* @param deleteStudioSessionMappingRequest
* @return Result of the DeleteStudioSessionMapping operation returned by the service.
* @throws InternalServerErrorException
* Indicates that an error occurred while processing the request and that the request was not completed.
* @throws InvalidRequestException
* This exception occurs when there is something wrong with user input.
* @sample AmazonElasticMapReduce.DeleteStudioSessionMapping
* @see AWS API Documentation
*/
DeleteStudioSessionMappingResult deleteStudioSessionMapping(DeleteStudioSessionMappingRequest deleteStudioSessionMappingRequest);
/**
*
* Provides cluster-level details including status, hardware and software configuration, VPC settings, and so on.
*
*
* @param describeClusterRequest
* This input determines which cluster to describe.
* @return Result of the DescribeCluster operation returned by the service.
* @throws InternalServerException
* This exception occurs when there is an internal failure in the Amazon EMR service.
* @throws InvalidRequestException
* This exception occurs when there is something wrong with user input.
* @sample AmazonElasticMapReduce.DescribeCluster
* @see AWS API Documentation
*/
DescribeClusterResult describeCluster(DescribeClusterRequest describeClusterRequest);
/**
*
* This API is no longer supported 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.
*
*
* @param describeJobFlowsRequest
* The input for the DescribeJobFlows operation.
* @return 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.
* @sample AmazonElasticMapReduce.DescribeJobFlows
* @see AWS API Documentation
*/
@Deprecated
DescribeJobFlowsResult describeJobFlows(DescribeJobFlowsRequest describeJobFlowsRequest);
/**
* Simplified method form for invoking the DescribeJobFlows operation.
*
* @see #describeJobFlows(DescribeJobFlowsRequest)
*/
@Deprecated
DescribeJobFlowsResult describeJobFlows();
/**
*
* Provides details of a notebook execution.
*
*
* @param describeNotebookExecutionRequest
* @return Result of the DescribeNotebookExecution operation returned by the service.
* @throws InternalServerErrorException
* Indicates that an error occurred while processing the request and that the request was not completed.
* @throws InvalidRequestException
* This exception occurs when there is something wrong with user input.
* @sample AmazonElasticMapReduce.DescribeNotebookExecution
* @see AWS API Documentation
*/
DescribeNotebookExecutionResult describeNotebookExecution(DescribeNotebookExecutionRequest describeNotebookExecutionRequest);
/**
*
* Provides EMR release label details, such as releases available the region where the API request is run, and the
* available applications for a specific EMR release label. Can also list EMR release versions that support a
* specified version of Spark.
*
*
* @param describeReleaseLabelRequest
* @return Result of the DescribeReleaseLabel operation returned by the service.
* @throws InternalServerException
* This exception occurs when there is an internal failure in the Amazon EMR service.
* @throws InvalidRequestException
* This exception occurs when there is something wrong with user input.
* @sample AmazonElasticMapReduce.DescribeReleaseLabel
* @see AWS API Documentation
*/
DescribeReleaseLabelResult describeReleaseLabel(DescribeReleaseLabelRequest describeReleaseLabelRequest);
/**
*
* Provides the details of a security configuration by returning the configuration JSON.
*
*
* @param describeSecurityConfigurationRequest
* @return Result of the DescribeSecurityConfiguration operation returned by the service.
* @throws InternalServerException
* This exception occurs when there is an internal failure in the Amazon EMR service.
* @throws InvalidRequestException
* This exception occurs when there is something wrong with user input.
* @sample AmazonElasticMapReduce.DescribeSecurityConfiguration
* @see AWS API Documentation
*/
DescribeSecurityConfigurationResult describeSecurityConfiguration(DescribeSecurityConfigurationRequest describeSecurityConfigurationRequest);
/**
*
* Provides more detail about the cluster step.
*
*
* @param describeStepRequest
* This input determines which step to describe.
* @return Result of the DescribeStep operation returned by the service.
* @throws InternalServerException
* This exception occurs when there is an internal failure in the Amazon EMR service.
* @throws InvalidRequestException
* This exception occurs when there is something wrong with user input.
* @sample AmazonElasticMapReduce.DescribeStep
* @see AWS
* API Documentation
*/
DescribeStepResult describeStep(DescribeStepRequest describeStepRequest);
/**
*
* Returns details for the specified Amazon EMR Studio including ID, Name, VPC, Studio access URL, and so on.
*
*
* @param describeStudioRequest
* @return Result of the DescribeStudio operation returned by the service.
* @throws InternalServerException
* This exception occurs when there is an internal failure in the Amazon EMR service.
* @throws InvalidRequestException
* This exception occurs when there is something wrong with user input.
* @sample AmazonElasticMapReduce.DescribeStudio
* @see AWS API Documentation
*/
DescribeStudioResult describeStudio(DescribeStudioRequest describeStudioRequest);
/**
*
* Returns the auto-termination policy for an Amazon EMR cluster.
*
*
* @param getAutoTerminationPolicyRequest
* @return Result of the GetAutoTerminationPolicy operation returned by the service.
* @sample AmazonElasticMapReduce.GetAutoTerminationPolicy
* @see AWS API Documentation
*/
GetAutoTerminationPolicyResult getAutoTerminationPolicy(GetAutoTerminationPolicyRequest getAutoTerminationPolicyRequest);
/**
*
* Returns the Amazon EMR block public access configuration for your Amazon Web Services account in the current
* Region. For more information see Configure Block
* Public Access for Amazon EMR in the Amazon EMR Management Guide.
*
*
* @param getBlockPublicAccessConfigurationRequest
* @return Result of the GetBlockPublicAccessConfiguration operation returned by the service.
* @throws InternalServerException
* This exception occurs when there is an internal failure in the Amazon EMR service.
* @throws InvalidRequestException
* This exception occurs when there is something wrong with user input.
* @sample AmazonElasticMapReduce.GetBlockPublicAccessConfiguration
* @see AWS API Documentation
*/
GetBlockPublicAccessConfigurationResult getBlockPublicAccessConfiguration(GetBlockPublicAccessConfigurationRequest getBlockPublicAccessConfigurationRequest);
/**
*
* Fetches the attached managed scaling policy for an Amazon EMR cluster.
*
*
* @param getManagedScalingPolicyRequest
* @return Result of the GetManagedScalingPolicy operation returned by the service.
* @sample AmazonElasticMapReduce.GetManagedScalingPolicy
* @see AWS API Documentation
*/
GetManagedScalingPolicyResult getManagedScalingPolicy(GetManagedScalingPolicyRequest getManagedScalingPolicyRequest);
/**
*
* Fetches mapping details for the specified Amazon EMR Studio and identity (user or group).
*
*
* @param getStudioSessionMappingRequest
* @return Result of the GetStudioSessionMapping operation returned by the service.
* @throws InternalServerErrorException
* Indicates that an error occurred while processing the request and that the request was not completed.
* @throws InvalidRequestException
* This exception occurs when there is something wrong with user input.
* @sample AmazonElasticMapReduce.GetStudioSessionMapping
* @see AWS API Documentation
*/
GetStudioSessionMappingResult getStudioSessionMapping(GetStudioSessionMappingRequest getStudioSessionMappingRequest);
/**
*
* Provides information about the bootstrap actions associated with a cluster.
*
*
* @param listBootstrapActionsRequest
* This input determines which bootstrap actions to retrieve.
* @return Result of the ListBootstrapActions operation returned by the service.
* @throws InternalServerException
* This exception occurs when there is an internal failure in the Amazon EMR service.
* @throws InvalidRequestException
* This exception occurs when there is something wrong with user input.
* @sample AmazonElasticMapReduce.ListBootstrapActions
* @see AWS API Documentation
*/
ListBootstrapActionsResult listBootstrapActions(ListBootstrapActionsRequest listBootstrapActionsRequest);
/**
*
* Provides the status of all clusters visible to this Amazon Web Services 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 in unsorted order per call, but returns a marker to track the paging of the
* cluster list across multiple ListClusters calls.
*
*
* @param listClustersRequest
* This input determines how the ListClusters action filters the list of clusters that it returns.
* @return Result of the ListClusters operation returned by the service.
* @throws InternalServerException
* This exception occurs when there is an internal failure in the Amazon EMR service.
* @throws InvalidRequestException
* This exception occurs when there is something wrong with user input.
* @sample AmazonElasticMapReduce.ListClusters
* @see AWS
* API Documentation
*/
ListClustersResult listClusters(ListClustersRequest listClustersRequest);
/**
* Simplified method form for invoking the ListClusters operation.
*
* @see #listClusters(ListClustersRequest)
*/
ListClustersResult listClusters();
/**
*
* 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.
*
*
*
* @param listInstanceFleetsRequest
* @return Result of the ListInstanceFleets operation returned by the service.
* @throws InternalServerException
* This exception occurs when there is an internal failure in the Amazon EMR service.
* @throws InvalidRequestException
* This exception occurs when there is something wrong with user input.
* @sample AmazonElasticMapReduce.ListInstanceFleets
* @see AWS API Documentation
*/
ListInstanceFleetsResult listInstanceFleets(ListInstanceFleetsRequest listInstanceFleetsRequest);
/**
*
* Provides all available details about the instance groups in a cluster.
*
*
* @param listInstanceGroupsRequest
* This input determines which instance groups to retrieve.
* @return Result of the ListInstanceGroups operation returned by the service.
* @throws InternalServerException
* This exception occurs when there is an internal failure in the Amazon EMR service.
* @throws InvalidRequestException
* This exception occurs when there is something wrong with user input.
* @sample AmazonElasticMapReduce.ListInstanceGroups
* @see AWS API Documentation
*/
ListInstanceGroupsResult listInstanceGroups(ListInstanceGroupsRequest listInstanceGroupsRequest);
/**
*
* 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.
*
*
* @param listInstancesRequest
* This input determines which instances to list.
* @return Result of the ListInstances operation returned by the service.
* @throws InternalServerException
* This exception occurs when there is an internal failure in the Amazon EMR service.
* @throws InvalidRequestException
* This exception occurs when there is something wrong with user input.
* @sample AmazonElasticMapReduce.ListInstances
* @see AWS
* API Documentation
*/
ListInstancesResult listInstances(ListInstancesRequest listInstancesRequest);
/**
*
* Provides summaries of all notebook executions. You can filter the list based on multiple criteria such as status,
* time range, and editor id. Returns a maximum of 50 notebook executions and a marker to track the paging of a
* longer notebook execution list across multiple ListNotebookExecution calls.
*
*
* @param listNotebookExecutionsRequest
* @return Result of the ListNotebookExecutions operation returned by the service.
* @throws InternalServerErrorException
* Indicates that an error occurred while processing the request and that the request was not completed.
* @throws InvalidRequestException
* This exception occurs when there is something wrong with user input.
* @sample AmazonElasticMapReduce.ListNotebookExecutions
* @see AWS API Documentation
*/
ListNotebookExecutionsResult listNotebookExecutions(ListNotebookExecutionsRequest listNotebookExecutionsRequest);
/**
*
* Retrieves release labels of EMR services in the region where the API is called.
*
*
* @param listReleaseLabelsRequest
* @return Result of the ListReleaseLabels operation returned by the service.
* @throws InternalServerException
* This exception occurs when there is an internal failure in the Amazon EMR service.
* @throws InvalidRequestException
* This exception occurs when there is something wrong with user input.
* @sample AmazonElasticMapReduce.ListReleaseLabels
* @see AWS API Documentation
*/
ListReleaseLabelsResult listReleaseLabels(ListReleaseLabelsRequest listReleaseLabelsRequest);
/**
*
* 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.
*
*
* @param listSecurityConfigurationsRequest
* @return Result of the ListSecurityConfigurations operation returned by the service.
* @throws InternalServerException
* This exception occurs when there is an internal failure in the Amazon EMR service.
* @throws InvalidRequestException
* This exception occurs when there is something wrong with user input.
* @sample AmazonElasticMapReduce.ListSecurityConfigurations
* @see AWS API Documentation
*/
ListSecurityConfigurationsResult listSecurityConfigurations(ListSecurityConfigurationsRequest listSecurityConfigurationsRequest);
/**
*
* Provides a list of steps for the cluster in reverse order unless you specify stepIds with the
* request or filter by StepStates. You can specify a maximum of 10 stepIDs. The CLI
* automatically paginates results to return a list greater than 50 steps. To return more than 50 steps using the
* CLI, specify a Marker, which is a pagination token that indicates the next set of steps to retrieve.
*
*
* @param listStepsRequest
* This input determines which steps to list.
* @return Result of the ListSteps operation returned by the service.
* @throws InternalServerException
* This exception occurs when there is an internal failure in the Amazon EMR service.
* @throws InvalidRequestException
* This exception occurs when there is something wrong with user input.
* @sample AmazonElasticMapReduce.ListSteps
* @see AWS API
* Documentation
*/
ListStepsResult listSteps(ListStepsRequest listStepsRequest);
/**
*
* Returns a list of all user or group session mappings for the Amazon EMR Studio specified by StudioId
* .
*
*
* @param listStudioSessionMappingsRequest
* @return Result of the ListStudioSessionMappings operation returned by the service.
* @throws InternalServerErrorException
* Indicates that an error occurred while processing the request and that the request was not completed.
* @throws InvalidRequestException
* This exception occurs when there is something wrong with user input.
* @sample AmazonElasticMapReduce.ListStudioSessionMappings
* @see AWS API Documentation
*/
ListStudioSessionMappingsResult listStudioSessionMappings(ListStudioSessionMappingsRequest listStudioSessionMappingsRequest);
/**
*
* Returns a list of all Amazon EMR Studios associated with the Amazon Web Services account. The list includes
* details such as ID, Studio Access URL, and creation time for each Studio.
*
*
* @param listStudiosRequest
* @return Result of the ListStudios operation returned by the service.
* @throws InternalServerException
* This exception occurs when there is an internal failure in the Amazon EMR service.
* @throws InvalidRequestException
* This exception occurs when there is something wrong with user input.
* @sample AmazonElasticMapReduce.ListStudios
* @see AWS
* API Documentation
*/
ListStudiosResult listStudios(ListStudiosRequest listStudiosRequest);
/**
*
* Modifies the number of steps that can be executed concurrently for the cluster specified using ClusterID.
*
*
* @param modifyClusterRequest
* @return Result of the ModifyCluster operation returned by the service.
* @throws InternalServerErrorException
* Indicates that an error occurred while processing the request and that the request was not completed.
* @throws InvalidRequestException
* This exception occurs when there is something wrong with user input.
* @sample AmazonElasticMapReduce.ModifyCluster
* @see AWS
* API Documentation
*/
ModifyClusterResult modifyCluster(ModifyClusterRequest modifyClusterRequest);
/**
*
* 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.
*
*
*
* @param modifyInstanceFleetRequest
* @return Result of the ModifyInstanceFleet operation returned by the service.
* @throws InternalServerException
* This exception occurs when there is an internal failure in the Amazon EMR service.
* @throws InvalidRequestException
* This exception occurs when there is something wrong with user input.
* @sample AmazonElasticMapReduce.ModifyInstanceFleet
* @see AWS API Documentation
*/
ModifyInstanceFleetResult modifyInstanceFleet(ModifyInstanceFleetRequest modifyInstanceFleetRequest);
/**
*
* 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
* Change the size of some instance groups.
* @return 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.
* @sample AmazonElasticMapReduce.ModifyInstanceGroups
* @see AWS API Documentation
*/
ModifyInstanceGroupsResult modifyInstanceGroups(ModifyInstanceGroupsRequest modifyInstanceGroupsRequest);
/**
* Simplified method form for invoking the ModifyInstanceGroups operation.
*
* @see #modifyInstanceGroups(ModifyInstanceGroupsRequest)
*/
ModifyInstanceGroupsResult modifyInstanceGroups();
/**
*
* 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.
*
*
* @param putAutoScalingPolicyRequest
* @return Result of the PutAutoScalingPolicy operation returned by the service.
* @sample AmazonElasticMapReduce.PutAutoScalingPolicy
* @see AWS API Documentation
*/
PutAutoScalingPolicyResult putAutoScalingPolicy(PutAutoScalingPolicyRequest putAutoScalingPolicyRequest);
/**
*
*
* Auto-termination is supported in Amazon EMR versions 5.30.0 and 6.1.0 and later. For more information, see Using an
* auto-termination policy.
*
*
*
* Creates or updates an auto-termination policy for an Amazon EMR cluster. An auto-termination policy defines the
* amount of idle time in seconds after which a cluster automatically terminates. For alternative cluster
* termination options, see Control cluster
* termination.
*
*
* @param putAutoTerminationPolicyRequest
* @return Result of the PutAutoTerminationPolicy operation returned by the service.
* @sample AmazonElasticMapReduce.PutAutoTerminationPolicy
* @see AWS API Documentation
*/
PutAutoTerminationPolicyResult putAutoTerminationPolicy(PutAutoTerminationPolicyRequest putAutoTerminationPolicyRequest);
/**
*
* Creates or updates an Amazon EMR block public access configuration for your Amazon Web Services account in the
* current Region. For more information see Configure Block
* Public Access for Amazon EMR in the Amazon EMR Management Guide.
*
*
* @param putBlockPublicAccessConfigurationRequest
* @return Result of the PutBlockPublicAccessConfiguration operation returned by the service.
* @throws InternalServerException
* This exception occurs when there is an internal failure in the Amazon EMR service.
* @throws InvalidRequestException
* This exception occurs when there is something wrong with user input.
* @sample AmazonElasticMapReduce.PutBlockPublicAccessConfiguration
* @see AWS API Documentation
*/
PutBlockPublicAccessConfigurationResult putBlockPublicAccessConfiguration(PutBlockPublicAccessConfigurationRequest putBlockPublicAccessConfigurationRequest);
/**
*
* Creates or updates a managed scaling policy for an Amazon EMR cluster. The managed scaling policy defines the
* limits for resources, such as EC2 instances that can be added or terminated from a cluster. The policy only
* applies to the core and task nodes. The master node cannot be scaled after initial configuration.
*
*
* @param putManagedScalingPolicyRequest
* @return Result of the PutManagedScalingPolicy operation returned by the service.
* @sample AmazonElasticMapReduce.PutManagedScalingPolicy
* @see AWS API Documentation
*/
PutManagedScalingPolicyResult putManagedScalingPolicy(PutManagedScalingPolicyRequest putManagedScalingPolicyRequest);
/**
*
* Removes an automatic scaling policy from a specified instance group within an EMR cluster.
*
*
* @param removeAutoScalingPolicyRequest
* @return Result of the RemoveAutoScalingPolicy operation returned by the service.
* @sample AmazonElasticMapReduce.RemoveAutoScalingPolicy
* @see AWS API Documentation
*/
RemoveAutoScalingPolicyResult removeAutoScalingPolicy(RemoveAutoScalingPolicyRequest removeAutoScalingPolicyRequest);
/**
*
* Removes an auto-termination policy from an Amazon EMR cluster.
*
*
* @param removeAutoTerminationPolicyRequest
* @return Result of the RemoveAutoTerminationPolicy operation returned by the service.
* @sample AmazonElasticMapReduce.RemoveAutoTerminationPolicy
* @see AWS API Documentation
*/
RemoveAutoTerminationPolicyResult removeAutoTerminationPolicy(RemoveAutoTerminationPolicyRequest removeAutoTerminationPolicyRequest);
/**
*
* Removes a managed scaling policy from a specified EMR cluster.
*
*
* @param removeManagedScalingPolicyRequest
* @return Result of the RemoveManagedScalingPolicy operation returned by the service.
* @sample AmazonElasticMapReduce.RemoveManagedScalingPolicy
* @see AWS API Documentation
*/
RemoveManagedScalingPolicyResult removeManagedScalingPolicy(RemoveManagedScalingPolicyRequest removeManagedScalingPolicyRequest);
/**
*
* Removes tags from an Amazon EMR resource, such as a cluster or Amazon EMR Studio. Tags make it easier to
* associate resources in various ways, such as grouping clusters to track your Amazon EMR resource allocation
* costs. For more information, see Tag Clusters.
*
*
* The following example removes the stack tag with value Prod from a cluster:
*
*
* @param removeTagsRequest
* This input identifies an Amazon EMR resource and a list of tags to remove.
* @return Result of the RemoveTags operation returned by the service.
* @throws InternalServerException
* This exception occurs when there is an internal failure in the Amazon EMR service.
* @throws InvalidRequestException
* This exception occurs when there is something wrong with user input.
* @sample AmazonElasticMapReduce.RemoveTags
* @see AWS
* API Documentation
*/
RemoveTagsResult removeTags(RemoveTagsRequest removeTagsRequest);
/**
*
* 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.
*
*
*
* @param runJobFlowRequest
* Input to the RunJobFlow operation.
* @return 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.
* @sample AmazonElasticMapReduce.RunJobFlow
* @see AWS
* API Documentation
*/
RunJobFlowResult runJobFlow(RunJobFlowRequest runJobFlowRequest);
/**
*
* 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.
*
*
* @param setTerminationProtectionRequest
* The input argument to the TerminationProtection operation.
* @return 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.
* @sample AmazonElasticMapReduce.SetTerminationProtection
* @see AWS API Documentation
*/
SetTerminationProtectionResult setTerminationProtection(SetTerminationProtectionRequest setTerminationProtectionRequest);
/**
*
*
* The SetVisibleToAllUsers parameter is no longer supported. Your cluster may be visible to all users in your
* account. To restrict cluster access using an IAM policy, see Identity and Access
* Management for EMR.
*
*
*
* Sets the Cluster$VisibleToAllUsers value for an EMR cluster. When true, IAM principals in the
* Amazon Web Services account can perform EMR cluster actions that their IAM policies allow. When
* false, only the IAM principal that created the cluster and the Amazon Web Services account root user
* can perform EMR actions on the cluster, regardless of IAM permissions policies attached to other IAM principals.
*
*
* This action works on running clusters. When you create a cluster, use the
* RunJobFlowInput$VisibleToAllUsers parameter.
*
*
* For more information, see Understanding the EMR Cluster VisibleToAllUsers Setting in the Amazon EMRManagement Guide.
*
*
* @param setVisibleToAllUsersRequest
* The input to the SetVisibleToAllUsers action.
* @return 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.
* @sample AmazonElasticMapReduce.SetVisibleToAllUsers
* @see AWS API Documentation
*/
SetVisibleToAllUsersResult setVisibleToAllUsers(SetVisibleToAllUsersRequest setVisibleToAllUsersRequest);
/**
*
* Starts a notebook execution.
*
*
* @param startNotebookExecutionRequest
* @return Result of the StartNotebookExecution operation returned by the service.
* @throws InternalServerException
* This exception occurs when there is an internal failure in the Amazon EMR service.
* @throws InvalidRequestException
* This exception occurs when there is something wrong with user input.
* @sample AmazonElasticMapReduce.StartNotebookExecution
* @see AWS API Documentation
*/
StartNotebookExecutionResult startNotebookExecution(StartNotebookExecutionRequest startNotebookExecutionRequest);
/**
*
* Stops a notebook execution.
*
*
* @param stopNotebookExecutionRequest
* @return Result of the StopNotebookExecution operation returned by the service.
* @throws InternalServerErrorException
* Indicates that an error occurred while processing the request and that the request was not completed.
* @throws InvalidRequestException
* This exception occurs when there is something wrong with user input.
* @sample AmazonElasticMapReduce.StopNotebookExecution
* @see AWS API Documentation
*/
StopNotebookExecutionResult stopNotebookExecution(StopNotebookExecutionRequest stopNotebookExecutionRequest);
/**
*
* 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.
*
*
* @param terminateJobFlowsRequest
* Input to the TerminateJobFlows operation.
* @return 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.
* @sample AmazonElasticMapReduce.TerminateJobFlows
* @see AWS API Documentation
*/
TerminateJobFlowsResult terminateJobFlows(TerminateJobFlowsRequest terminateJobFlowsRequest);
/**
*
* Updates an Amazon EMR Studio configuration, including attributes such as name, description, and subnets.
*
*
* @param updateStudioRequest
* @return Result of the UpdateStudio operation returned by the service.
* @throws InternalServerException
* This exception occurs when there is an internal failure in the Amazon EMR service.
* @throws InvalidRequestException
* This exception occurs when there is something wrong with user input.
* @sample AmazonElasticMapReduce.UpdateStudio
* @see AWS
* API Documentation
*/
UpdateStudioResult updateStudio(UpdateStudioRequest updateStudioRequest);
/**
*
* Updates the session policy attached to the user or group for the specified Amazon EMR Studio.
*
*
* @param updateStudioSessionMappingRequest
* @return Result of the UpdateStudioSessionMapping operation returned by the service.
* @throws InternalServerErrorException
* Indicates that an error occurred while processing the request and that the request was not completed.
* @throws InvalidRequestException
* This exception occurs when there is something wrong with user input.
* @sample AmazonElasticMapReduce.UpdateStudioSessionMapping
* @see AWS API Documentation
*/
UpdateStudioSessionMappingResult updateStudioSessionMapping(UpdateStudioSessionMappingRequest updateStudioSessionMappingRequest);
/**
* 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.
*/
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.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
AmazonElasticMapReduceWaiters waiters();
}