@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonElasticMapReduce
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 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.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| 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, such as a cluster or an Amazon EMR Studio.
|
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.
|
CreateStudioResult |
createStudio(CreateStudioRequest createStudioRequest)
Creates a new Amazon EMR Studio.
|
CreateStudioSessionMappingResult |
createStudioSessionMapping(CreateStudioSessionMappingRequest createStudioSessionMappingRequest)
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. |
DeleteSecurityConfigurationResult |
deleteSecurityConfiguration(DeleteSecurityConfigurationRequest deleteSecurityConfigurationRequest)
Deletes a security configuration.
|
DeleteStudioResult |
deleteStudio(DeleteStudioRequest deleteStudioRequest)
Removes an Amazon EMR Studio from the Studio metadata store.
|
DeleteStudioSessionMappingResult |
deleteStudioSessionMapping(DeleteStudioSessionMappingRequest deleteStudioSessionMappingRequest)
Removes a user or group from an Amazon EMR Studio.
|
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.
|
DescribeNotebookExecutionResult |
describeNotebookExecution(DescribeNotebookExecutionRequest describeNotebookExecutionRequest)
Provides details of a notebook execution.
|
DescribeReleaseLabelResult |
describeReleaseLabel(DescribeReleaseLabelRequest describeReleaseLabelRequest)
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.
|
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.
|
DescribeStudioResult |
describeStudio(DescribeStudioRequest describeStudioRequest)
Returns details for the specified Amazon EMR Studio including ID, Name, VPC, Studio access URL, and so on.
|
GetAutoTerminationPolicyResult |
getAutoTerminationPolicy(GetAutoTerminationPolicyRequest getAutoTerminationPolicyRequest)
Returns the auto-termination policy for an Amazon EMR cluster.
|
GetBlockPublicAccessConfigurationResult |
getBlockPublicAccessConfiguration(GetBlockPublicAccessConfigurationRequest getBlockPublicAccessConfigurationRequest)
Returns the Amazon EMR block public access configuration for your Amazon Web Services account in the current
Region.
|
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.
|
GetManagedScalingPolicyResult |
getManagedScalingPolicy(GetManagedScalingPolicyRequest getManagedScalingPolicyRequest)
Fetches the attached managed scaling policy for an Amazon EMR cluster.
|
GetStudioSessionMappingResult |
getStudioSessionMapping(GetStudioSessionMappingRequest getStudioSessionMappingRequest)
Fetches mapping details for the specified Amazon EMR Studio and identity (user or group).
|
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 Amazon Web Services 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.
|
ListNotebookExecutionsResult |
listNotebookExecutions(ListNotebookExecutionsRequest listNotebookExecutionsRequest)
Provides summaries of all notebook executions.
|
ListReleaseLabelsResult |
listReleaseLabels(ListReleaseLabelsRequest listReleaseLabelsRequest)
Retrieves release labels of EMR services in the region where the API is called.
|
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 or filter by StepStates. |
ListStudiosResult |
listStudios(ListStudiosRequest listStudiosRequest)
Returns a list of all Amazon EMR Studios associated with the Amazon Web Services account.
|
ListStudioSessionMappingsResult |
listStudioSessionMappings(ListStudioSessionMappingsRequest listStudioSessionMappingsRequest)
Returns a list of all user or group session mappings for the Amazon EMR Studio specified by
StudioId
. |
ModifyClusterResult |
modifyCluster(ModifyClusterRequest modifyClusterRequest)
Modifies the number of steps that can be executed concurrently for the cluster specified using ClusterID.
|
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.
|
PutAutoTerminationPolicyResult |
putAutoTerminationPolicy(PutAutoTerminationPolicyRequest putAutoTerminationPolicyRequest)
|
PutBlockPublicAccessConfigurationResult |
putBlockPublicAccessConfiguration(PutBlockPublicAccessConfigurationRequest putBlockPublicAccessConfigurationRequest)
Creates or updates an Amazon EMR block public access configuration for your Amazon Web Services account in the
current Region.
|
PutManagedScalingPolicyResult |
putManagedScalingPolicy(PutManagedScalingPolicyRequest putManagedScalingPolicyRequest)
Creates or updates a managed scaling policy for an Amazon EMR cluster.
|
RemoveAutoScalingPolicyResult |
removeAutoScalingPolicy(RemoveAutoScalingPolicyRequest removeAutoScalingPolicyRequest)
Removes an automatic scaling policy from a specified instance group within an EMR cluster.
|
RemoveAutoTerminationPolicyResult |
removeAutoTerminationPolicy(RemoveAutoTerminationPolicyRequest removeAutoTerminationPolicyRequest)
Removes an auto-termination policy from an Amazon EMR cluster.
|
RemoveManagedScalingPolicyResult |
removeManagedScalingPolicy(RemoveManagedScalingPolicyRequest removeManagedScalingPolicyRequest)
Removes a managed scaling policy from a specified EMR cluster.
|
RemoveTagsResult |
removeTags(RemoveTagsRequest removeTagsRequest)
Removes tags from an Amazon EMR resource, such as a cluster or Amazon EMR Studio.
|
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)
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartNotebookExecutionResult |
startNotebookExecution(StartNotebookExecutionRequest startNotebookExecutionRequest)
Starts a notebook execution.
|
StopNotebookExecutionResult |
stopNotebookExecution(StopNotebookExecutionRequest stopNotebookExecutionRequest)
Stops a notebook execution.
|
TerminateJobFlowsResult |
terminateJobFlows(TerminateJobFlowsRequest terminateJobFlowsRequest)
TerminateJobFlows shuts a list of clusters (job flows) down.
|
UpdateStudioResult |
updateStudio(UpdateStudioRequest updateStudioRequest)
Updates an Amazon EMR Studio configuration, including attributes such as name, description, and subnets.
|
UpdateStudioSessionMappingResult |
updateStudioSessionMapping(UpdateStudioSessionMappingRequest updateStudioSessionMappingRequest)
Updates the session policy attached to the user or group for the specified Amazon EMR Studio.
|
AmazonElasticMapReduceWaiters |
waiters() |
static final String ENDPOINT_PREFIX
@Deprecated void setEndpoint(String endpoint)
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
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: 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.
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 void setRegion(Region region)
AwsClientBuilder#setRegion(String)setEndpoint(String), sets the regional endpoint for this
client's service calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)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.
addInstanceFleetRequest - InternalServerException - This exception occurs when there is an internal failure in the Amazon EMR service.InvalidRequestException - This exception occurs when there is something wrong with user input.AddInstanceGroupsResult addInstanceGroups(AddInstanceGroupsRequest addInstanceGroupsRequest)
Adds one or more instance groups to a running cluster.
addInstanceGroupsRequest - Input to an AddInstanceGroups call.InternalServerErrorException - Indicates that an error occurred while processing the request and that the request was not completed.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.
The string values passed into HadoopJarStep object cannot exceed a total of 10240 characters.
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.AddTagsResult addTags(AddTagsRequest addTagsRequest)
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.
addTagsRequest - This input identifies an Amazon EMR resource and a list of tags to attach.InternalServerException - This exception occurs when there is an internal failure in the Amazon EMR service.InvalidRequestException - This exception occurs when there is something wrong with user input.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 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.
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.CreateSecurityConfigurationResult createSecurityConfiguration(CreateSecurityConfigurationRequest createSecurityConfigurationRequest)
Creates a security configuration, which is stored in the service and can be specified when a cluster is created.
createSecurityConfigurationRequest - InternalServerException - This exception occurs when there is an internal failure in the Amazon EMR service.InvalidRequestException - This exception occurs when there is something wrong with user input.CreateStudioResult createStudio(CreateStudioRequest createStudioRequest)
Creates a new Amazon EMR Studio.
createStudioRequest - InternalServerException - This exception occurs when there is an internal failure in the Amazon EMR service.InvalidRequestException - This exception occurs when there is something wrong with user input.CreateStudioSessionMappingResult createStudioSessionMapping(CreateStudioSessionMappingRequest createStudioSessionMappingRequest)
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.
createStudioSessionMappingRequest - 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.DeleteSecurityConfigurationResult deleteSecurityConfiguration(DeleteSecurityConfigurationRequest deleteSecurityConfigurationRequest)
Deletes a security configuration.
deleteSecurityConfigurationRequest - InternalServerException - This exception occurs when there is an internal failure in the Amazon EMR service.InvalidRequestException - This exception occurs when there is something wrong with user input.DeleteStudioResult deleteStudio(DeleteStudioRequest deleteStudioRequest)
Removes an Amazon EMR Studio from the Studio metadata store.
deleteStudioRequest - InternalServerException - This exception occurs when there is an internal failure in the Amazon EMR service.InvalidRequestException - This exception occurs when there is something wrong with user input.DeleteStudioSessionMappingResult deleteStudioSessionMapping(DeleteStudioSessionMappingRequest deleteStudioSessionMappingRequest)
Removes a user or group from an Amazon EMR Studio.
deleteStudioSessionMappingRequest - 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.DescribeClusterResult describeCluster(DescribeClusterRequest describeClusterRequest)
Provides cluster-level details including status, hardware and software configuration, VPC settings, and so on.
describeClusterRequest - This input determines which cluster to describe.InternalServerException - This exception occurs when there is an internal failure in the Amazon EMR service.InvalidRequestException - This exception occurs when there is something wrong with user input.@Deprecated DescribeJobFlowsResult describeJobFlows(DescribeJobFlowsRequest describeJobFlowsRequest)
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.
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 DescribeJobFlowsResult describeJobFlows()
DescribeNotebookExecutionResult describeNotebookExecution(DescribeNotebookExecutionRequest describeNotebookExecutionRequest)
Provides details of a notebook execution.
describeNotebookExecutionRequest - 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.DescribeReleaseLabelResult describeReleaseLabel(DescribeReleaseLabelRequest describeReleaseLabelRequest)
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.
describeReleaseLabelRequest - InternalServerException - This exception occurs when there is an internal failure in the Amazon EMR service.InvalidRequestException - This exception occurs when there is something wrong with user input.DescribeSecurityConfigurationResult describeSecurityConfiguration(DescribeSecurityConfigurationRequest describeSecurityConfigurationRequest)
Provides the details of a security configuration by returning the configuration JSON.
describeSecurityConfigurationRequest - InternalServerException - This exception occurs when there is an internal failure in the Amazon EMR service.InvalidRequestException - This exception occurs when there is something wrong with user input.DescribeStepResult describeStep(DescribeStepRequest describeStepRequest)
Provides more detail about the cluster step.
describeStepRequest - This input determines which step to describe.InternalServerException - This exception occurs when there is an internal failure in the Amazon EMR service.InvalidRequestException - This exception occurs when there is something wrong with user input.DescribeStudioResult describeStudio(DescribeStudioRequest describeStudioRequest)
Returns details for the specified Amazon EMR Studio including ID, Name, VPC, Studio access URL, and so on.
describeStudioRequest - InternalServerException - This exception occurs when there is an internal failure in the Amazon EMR service.InvalidRequestException - This exception occurs when there is something wrong with user input.GetAutoTerminationPolicyResult getAutoTerminationPolicy(GetAutoTerminationPolicyRequest getAutoTerminationPolicyRequest)
Returns the auto-termination policy for an Amazon EMR cluster.
getAutoTerminationPolicyRequest - GetBlockPublicAccessConfigurationResult getBlockPublicAccessConfiguration(GetBlockPublicAccessConfigurationRequest getBlockPublicAccessConfigurationRequest)
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.
getBlockPublicAccessConfigurationRequest - InternalServerException - This exception occurs when there is an internal failure in the Amazon EMR service.InvalidRequestException - This exception occurs when there is something wrong with user input.GetManagedScalingPolicyResult getManagedScalingPolicy(GetManagedScalingPolicyRequest getManagedScalingPolicyRequest)
Fetches the attached managed scaling policy for an Amazon EMR cluster.
getManagedScalingPolicyRequest - GetStudioSessionMappingResult getStudioSessionMapping(GetStudioSessionMappingRequest getStudioSessionMappingRequest)
Fetches mapping details for the specified Amazon EMR Studio and identity (user or group).
getStudioSessionMappingRequest - 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.ListBootstrapActionsResult listBootstrapActions(ListBootstrapActionsRequest listBootstrapActionsRequest)
Provides information about the bootstrap actions associated with a cluster.
listBootstrapActionsRequest - This input determines which bootstrap actions to retrieve.InternalServerException - This exception occurs when there is an internal failure in the Amazon EMR service.InvalidRequestException - This exception occurs when there is something wrong with user input.ListClustersResult listClusters(ListClustersRequest listClustersRequest)
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.
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 Amazon EMR service.InvalidRequestException - This exception occurs when there is something wrong with user input.ListClustersResult listClusters()
listClusters(ListClustersRequest)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.
listInstanceFleetsRequest - InternalServerException - This exception occurs when there is an internal failure in the Amazon EMR service.InvalidRequestException - This exception occurs when there is something wrong with user input.ListInstanceGroupsResult listInstanceGroups(ListInstanceGroupsRequest listInstanceGroupsRequest)
Provides all available details about the instance groups in a cluster.
listInstanceGroupsRequest - This input determines which instance groups to retrieve.InternalServerException - This exception occurs when there is an internal failure in the Amazon EMR service.InvalidRequestException - This exception occurs when there is something wrong with user input.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.
listInstancesRequest - This input determines which instances to list.InternalServerException - This exception occurs when there is an internal failure in the Amazon EMR service.InvalidRequestException - This exception occurs when there is something wrong with user input.ListNotebookExecutionsResult listNotebookExecutions(ListNotebookExecutionsRequest listNotebookExecutionsRequest)
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.
listNotebookExecutionsRequest - 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.ListReleaseLabelsResult listReleaseLabels(ListReleaseLabelsRequest listReleaseLabelsRequest)
Retrieves release labels of EMR services in the region where the API is called.
listReleaseLabelsRequest - InternalServerException - This exception occurs when there is an internal failure in the Amazon EMR service.InvalidRequestException - This exception occurs when there is something wrong with user input.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.
listSecurityConfigurationsRequest - InternalServerException - This exception occurs when there is an internal failure in the Amazon EMR service.InvalidRequestException - This exception occurs when there is something wrong with user input.ListStepsResult listSteps(ListStepsRequest listStepsRequest)
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.
listStepsRequest - This input determines which steps to list.InternalServerException - This exception occurs when there is an internal failure in the Amazon EMR service.InvalidRequestException - This exception occurs when there is something wrong with user input.ListStudioSessionMappingsResult listStudioSessionMappings(ListStudioSessionMappingsRequest listStudioSessionMappingsRequest)
Returns a list of all user or group session mappings for the Amazon EMR Studio specified by StudioId
.
listStudioSessionMappingsRequest - 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.ListStudiosResult listStudios(ListStudiosRequest listStudiosRequest)
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.
listStudiosRequest - InternalServerException - This exception occurs when there is an internal failure in the Amazon EMR service.InvalidRequestException - This exception occurs when there is something wrong with user input.ModifyClusterResult modifyCluster(ModifyClusterRequest modifyClusterRequest)
Modifies the number of steps that can be executed concurrently for the cluster specified using ClusterID.
modifyClusterRequest - 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.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.
modifyInstanceFleetRequest - InternalServerException - This exception occurs when there is an internal failure in the Amazon EMR service.InvalidRequestException - This exception occurs when there is something wrong with user input.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.
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.ModifyInstanceGroupsResult modifyInstanceGroups()
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.
putAutoScalingPolicyRequest - PutAutoTerminationPolicyResult putAutoTerminationPolicy(PutAutoTerminationPolicyRequest putAutoTerminationPolicyRequest)
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.
putAutoTerminationPolicyRequest - PutBlockPublicAccessConfigurationResult putBlockPublicAccessConfiguration(PutBlockPublicAccessConfigurationRequest putBlockPublicAccessConfigurationRequest)
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.
putBlockPublicAccessConfigurationRequest - InternalServerException - This exception occurs when there is an internal failure in the Amazon EMR service.InvalidRequestException - This exception occurs when there is something wrong with user input.PutManagedScalingPolicyResult putManagedScalingPolicy(PutManagedScalingPolicyRequest putManagedScalingPolicyRequest)
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.
putManagedScalingPolicyRequest - RemoveAutoScalingPolicyResult removeAutoScalingPolicy(RemoveAutoScalingPolicyRequest removeAutoScalingPolicyRequest)
Removes an automatic scaling policy from a specified instance group within an EMR cluster.
removeAutoScalingPolicyRequest - RemoveAutoTerminationPolicyResult removeAutoTerminationPolicy(RemoveAutoTerminationPolicyRequest removeAutoTerminationPolicyRequest)
Removes an auto-termination policy from an Amazon EMR cluster.
removeAutoTerminationPolicyRequest - RemoveManagedScalingPolicyResult removeManagedScalingPolicy(RemoveManagedScalingPolicyRequest removeManagedScalingPolicyRequest)
Removes a managed scaling policy from a specified EMR cluster.
removeManagedScalingPolicyRequest - RemoveTagsResult removeTags(RemoveTagsRequest removeTagsRequest)
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:
removeTagsRequest - This input identifies an Amazon EMR resource and a list of tags to remove.InternalServerException - This exception occurs when there is an internal failure in the Amazon EMR service.InvalidRequestException - This exception occurs when there is something wrong with user input.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.
runJobFlowRequest - Input to the RunJobFlow operation.InternalServerErrorException - Indicates that an error occurred while processing the request and that the request was not completed.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.
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.SetVisibleToAllUsersResult setVisibleToAllUsers(SetVisibleToAllUsersRequest setVisibleToAllUsersRequest)
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.
setVisibleToAllUsersRequest - The input to the SetVisibleToAllUsers action.InternalServerErrorException - Indicates that an error occurred while processing the request and that the request was not completed.StartNotebookExecutionResult startNotebookExecution(StartNotebookExecutionRequest startNotebookExecutionRequest)
Starts a notebook execution.
startNotebookExecutionRequest - InternalServerException - This exception occurs when there is an internal failure in the Amazon EMR service.InvalidRequestException - This exception occurs when there is something wrong with user input.StopNotebookExecutionResult stopNotebookExecution(StopNotebookExecutionRequest stopNotebookExecutionRequest)
Stops a notebook execution.
stopNotebookExecutionRequest - 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.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.
terminateJobFlowsRequest - Input to the TerminateJobFlows operation.InternalServerErrorException - Indicates that an error occurred while processing the request and that the request was not completed.UpdateStudioResult updateStudio(UpdateStudioRequest updateStudioRequest)
Updates an Amazon EMR Studio configuration, including attributes such as name, description, and subnets.
updateStudioRequest - InternalServerException - This exception occurs when there is an internal failure in the Amazon EMR service.InvalidRequestException - This exception occurs when there is something wrong with user input.UpdateStudioSessionMappingResult updateStudioSessionMapping(UpdateStudioSessionMappingRequest updateStudioSessionMappingRequest)
Updates the session policy attached to the user or group for the specified Amazon EMR Studio.
updateStudioSessionMappingRequest - 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.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request - The originally executed request.AmazonElasticMapReduceWaiters waiters()