@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonElasticMapReduce extends Object implements AmazonElasticMapReduce
AmazonElasticMapReduce
. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
AddInstanceFleetResult |
addInstanceFleet(AddInstanceFleetRequest request)
Adds an instance fleet to a running cluster.
|
AddInstanceGroupsResult |
addInstanceGroups(AddInstanceGroupsRequest request)
Adds one or more instance groups to a running cluster.
|
AddJobFlowStepsResult |
addJobFlowSteps(AddJobFlowStepsRequest request)
AddJobFlowSteps adds new steps to a running cluster.
|
AddTagsResult |
addTags(AddTagsRequest request)
Adds tags to an Amazon EMR resource, such as a cluster or an Amazon EMR Studio.
|
CancelStepsResult |
cancelSteps(CancelStepsRequest request)
Cancels a pending step or steps in a running cluster.
|
CreateSecurityConfigurationResult |
createSecurityConfiguration(CreateSecurityConfigurationRequest request)
Creates a security configuration, which is stored in the service and can be specified when a cluster is created.
|
CreateStudioResult |
createStudio(CreateStudioRequest request)
Creates a new Amazon EMR Studio.
|
CreateStudioSessionMappingResult |
createStudioSessionMapping(CreateStudioSessionMappingRequest request)
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 request)
Deletes a security configuration.
|
DeleteStudioResult |
deleteStudio(DeleteStudioRequest request)
Removes an Amazon EMR Studio from the Studio metadata store.
|
DeleteStudioSessionMappingResult |
deleteStudioSessionMapping(DeleteStudioSessionMappingRequest request)
Removes a user or group from an Amazon EMR Studio.
|
DescribeClusterResult |
describeCluster(DescribeClusterRequest request)
Provides cluster-level details including status, hardware and software configuration, VPC settings, and so on.
|
DescribeJobFlowsResult |
describeJobFlows()
Deprecated.
|
DescribeJobFlowsResult |
describeJobFlows(DescribeJobFlowsRequest request)
Deprecated.
|
DescribeNotebookExecutionResult |
describeNotebookExecution(DescribeNotebookExecutionRequest request)
Provides details of a notebook execution.
|
DescribeReleaseLabelResult |
describeReleaseLabel(DescribeReleaseLabelRequest request)
Provides Amazon EMR release label details, such as the releases available the Region where the API request is
run, and the available applications for a specific Amazon EMR release label.
|
DescribeSecurityConfigurationResult |
describeSecurityConfiguration(DescribeSecurityConfigurationRequest request)
Provides the details of a security configuration by returning the configuration JSON.
|
DescribeStepResult |
describeStep(DescribeStepRequest request)
Provides more detail about the cluster step.
|
DescribeStudioResult |
describeStudio(DescribeStudioRequest request)
Returns details for the specified Amazon EMR Studio including ID, Name, VPC, Studio access URL, and so on.
|
GetAutoTerminationPolicyResult |
getAutoTerminationPolicy(GetAutoTerminationPolicyRequest request)
Returns the auto-termination policy for an Amazon EMR cluster.
|
GetBlockPublicAccessConfigurationResult |
getBlockPublicAccessConfiguration(GetBlockPublicAccessConfigurationRequest request)
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.
|
GetClusterSessionCredentialsResult |
getClusterSessionCredentials(GetClusterSessionCredentialsRequest request)
Provides temporary, HTTP basic credentials that are associated with a given runtime IAM role and used by a
cluster with fine-grained access control activated.
|
GetManagedScalingPolicyResult |
getManagedScalingPolicy(GetManagedScalingPolicyRequest request)
Fetches the attached managed scaling policy for an Amazon EMR cluster.
|
GetStudioSessionMappingResult |
getStudioSessionMapping(GetStudioSessionMappingRequest request)
Fetches mapping details for the specified Amazon EMR Studio and identity (user or group).
|
ListBootstrapActionsResult |
listBootstrapActions(ListBootstrapActionsRequest request)
Provides information about the bootstrap actions associated with a cluster.
|
ListClustersResult |
listClusters()
Simplified method form for invoking the ListClusters operation.
|
ListClustersResult |
listClusters(ListClustersRequest request)
Provides the status of all clusters visible to this Amazon Web Services account.
|
ListInstanceFleetsResult |
listInstanceFleets(ListInstanceFleetsRequest request)
Lists all available details about the instance fleets in a cluster.
|
ListInstanceGroupsResult |
listInstanceGroups(ListInstanceGroupsRequest request)
Provides all available details about the instance groups in a cluster.
|
ListInstancesResult |
listInstances(ListInstancesRequest request)
Provides information for all active Amazon EC2 instances and Amazon EC2 instances terminated in the last 30 days,
up to a maximum of 2,000.
|
ListNotebookExecutionsResult |
listNotebookExecutions(ListNotebookExecutionsRequest request)
Provides summaries of all notebook executions.
|
ListReleaseLabelsResult |
listReleaseLabels(ListReleaseLabelsRequest request)
Retrieves release labels of Amazon EMR services in the Region where the API is called.
|
ListSecurityConfigurationsResult |
listSecurityConfigurations(ListSecurityConfigurationsRequest request)
Lists all the security configurations visible to this account, providing their creation dates and times, and
their names.
|
ListStepsResult |
listSteps(ListStepsRequest request)
Provides a list of steps for the cluster in reverse order unless you specify
stepIds with the
request or filter by StepStates . |
ListStudiosResult |
listStudios(ListStudiosRequest request)
Returns a list of all Amazon EMR Studios associated with the Amazon Web Services account.
|
ListStudioSessionMappingsResult |
listStudioSessionMappings(ListStudioSessionMappingsRequest request)
Returns a list of all user or group session mappings for the Amazon EMR Studio specified by
StudioId
. |
ListSupportedInstanceTypesResult |
listSupportedInstanceTypes(ListSupportedInstanceTypesRequest request)
A list of the instance types that Amazon EMR supports.
|
ModifyClusterResult |
modifyCluster(ModifyClusterRequest request)
Modifies the number of steps that can be executed concurrently for the cluster specified using ClusterID.
|
ModifyInstanceFleetResult |
modifyInstanceFleet(ModifyInstanceFleetRequest request)
Modifies the target On-Demand and target Spot capacities for the instance fleet with the specified
InstanceFleetID within the cluster specified using ClusterID.
|
ModifyInstanceGroupsResult |
modifyInstanceGroups()
Simplified method form for invoking the ModifyInstanceGroups operation.
|
ModifyInstanceGroupsResult |
modifyInstanceGroups(ModifyInstanceGroupsRequest request)
ModifyInstanceGroups modifies the number of nodes and configuration settings of an instance group.
|
PutAutoScalingPolicyResult |
putAutoScalingPolicy(PutAutoScalingPolicyRequest request)
Creates or updates an automatic scaling policy for a core instance group or task instance group in an Amazon EMR
cluster.
|
PutAutoTerminationPolicyResult |
putAutoTerminationPolicy(PutAutoTerminationPolicyRequest request)
|
PutBlockPublicAccessConfigurationResult |
putBlockPublicAccessConfiguration(PutBlockPublicAccessConfigurationRequest request)
Creates or updates an Amazon EMR block public access configuration for your Amazon Web Services account in the
current Region.
|
PutManagedScalingPolicyResult |
putManagedScalingPolicy(PutManagedScalingPolicyRequest request)
Creates or updates a managed scaling policy for an Amazon EMR cluster.
|
RemoveAutoScalingPolicyResult |
removeAutoScalingPolicy(RemoveAutoScalingPolicyRequest request)
Removes an automatic scaling policy from a specified instance group within an Amazon EMR cluster.
|
RemoveAutoTerminationPolicyResult |
removeAutoTerminationPolicy(RemoveAutoTerminationPolicyRequest request)
Removes an auto-termination policy from an Amazon EMR cluster.
|
RemoveManagedScalingPolicyResult |
removeManagedScalingPolicy(RemoveManagedScalingPolicyRequest request)
Removes a managed scaling policy from a specified Amazon EMR cluster.
|
RemoveTagsResult |
removeTags(RemoveTagsRequest request)
Removes tags from an Amazon EMR resource, such as a cluster or Amazon EMR Studio.
|
RunJobFlowResult |
runJobFlow(RunJobFlowRequest request)
RunJobFlow creates and starts running a new cluster (job flow).
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("https://elasticmapreduce.amazonaws.com").
|
SetKeepJobFlowAliveWhenNoStepsResult |
setKeepJobFlowAliveWhenNoSteps(SetKeepJobFlowAliveWhenNoStepsRequest request)
You can use the
SetKeepJobFlowAliveWhenNoSteps to configure a cluster (job flow) to terminate after
the step execution, i.e., all your steps are executed. |
void |
setRegion(Region region)
An alternative to
AmazonElasticMapReduce.setEndpoint(String) , sets the regional endpoint for this
client's service calls. |
SetTerminationProtectionResult |
setTerminationProtection(SetTerminationProtectionRequest request)
SetTerminationProtection locks a cluster (job flow) so the Amazon EC2 instances in the cluster cannot be
terminated by user intervention, an API call, or in the event of a job-flow error.
|
SetUnhealthyNodeReplacementResult |
setUnhealthyNodeReplacement(SetUnhealthyNodeReplacementRequest request)
Specify whether to enable unhealthy node replacement, which lets Amazon EMR gracefully replace core nodes on a
cluster if any nodes become unhealthy.
|
SetVisibleToAllUsersResult |
setVisibleToAllUsers(SetVisibleToAllUsersRequest request)
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartNotebookExecutionResult |
startNotebookExecution(StartNotebookExecutionRequest request)
Starts a notebook execution.
|
StopNotebookExecutionResult |
stopNotebookExecution(StopNotebookExecutionRequest request)
Stops a notebook execution.
|
TerminateJobFlowsResult |
terminateJobFlows(TerminateJobFlowsRequest request)
TerminateJobFlows shuts a list of clusters (job flows) down.
|
UpdateStudioResult |
updateStudio(UpdateStudioRequest request)
Updates an Amazon EMR Studio configuration, including attributes such as name, description, and subnets.
|
UpdateStudioSessionMappingResult |
updateStudioSessionMapping(UpdateStudioSessionMappingRequest request)
Updates the session policy attached to the user or group for the specified Amazon EMR Studio.
|
AmazonElasticMapReduceWaiters |
waiters() |
public void setEndpoint(String endpoint)
AmazonElasticMapReduce
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.
setEndpoint
in interface AmazonElasticMapReduce
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.public void setRegion(Region region)
AmazonElasticMapReduce
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
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.
setRegion
in interface AmazonElasticMapReduce
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)
public AddInstanceFleetResult addInstanceFleet(AddInstanceFleetRequest request)
AmazonElasticMapReduce
Adds an instance fleet to a running cluster.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x.
addInstanceFleet
in interface AmazonElasticMapReduce
public AddInstanceGroupsResult addInstanceGroups(AddInstanceGroupsRequest request)
AmazonElasticMapReduce
Adds one or more instance groups to a running cluster.
addInstanceGroups
in interface AmazonElasticMapReduce
request
- Input to an AddInstanceGroups call.public AddJobFlowStepsResult addJobFlowSteps(AddJobFlowStepsRequest request)
AmazonElasticMapReduce
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.
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.
addJobFlowSteps
in interface AmazonElasticMapReduce
request
- The input argument to the AddJobFlowSteps operation.public AddTagsResult addTags(AddTagsRequest request)
AmazonElasticMapReduce
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.
addTags
in interface AmazonElasticMapReduce
request
- This input identifies an Amazon EMR resource and a list of tags to attach.public CancelStepsResult cancelSteps(CancelStepsRequest request)
AmazonElasticMapReduce
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 releases 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.
cancelSteps
in interface AmazonElasticMapReduce
request
- The input argument to the CancelSteps operation.public CreateSecurityConfigurationResult createSecurityConfiguration(CreateSecurityConfigurationRequest request)
AmazonElasticMapReduce
Creates a security configuration, which is stored in the service and can be specified when a cluster is created.
createSecurityConfiguration
in interface AmazonElasticMapReduce
public CreateStudioResult createStudio(CreateStudioRequest request)
AmazonElasticMapReduce
Creates a new Amazon EMR Studio.
createStudio
in interface AmazonElasticMapReduce
public CreateStudioSessionMappingResult createStudioSessionMapping(CreateStudioSessionMappingRequest request)
AmazonElasticMapReduce
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 IAM Identity Center 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.
createStudioSessionMapping
in interface AmazonElasticMapReduce
public DeleteSecurityConfigurationResult deleteSecurityConfiguration(DeleteSecurityConfigurationRequest request)
AmazonElasticMapReduce
Deletes a security configuration.
deleteSecurityConfiguration
in interface AmazonElasticMapReduce
public DeleteStudioResult deleteStudio(DeleteStudioRequest request)
AmazonElasticMapReduce
Removes an Amazon EMR Studio from the Studio metadata store.
deleteStudio
in interface AmazonElasticMapReduce
public DeleteStudioSessionMappingResult deleteStudioSessionMapping(DeleteStudioSessionMappingRequest request)
AmazonElasticMapReduce
Removes a user or group from an Amazon EMR Studio.
deleteStudioSessionMapping
in interface AmazonElasticMapReduce
public DescribeClusterResult describeCluster(DescribeClusterRequest request)
AmazonElasticMapReduce
Provides cluster-level details including status, hardware and software configuration, VPC settings, and so on.
describeCluster
in interface AmazonElasticMapReduce
request
- This input determines which cluster to describe.@Deprecated public DescribeJobFlowsResult describeJobFlows(DescribeJobFlowsRequest request)
AmazonElasticMapReduce
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.
describeJobFlows
in interface AmazonElasticMapReduce
request
- The input for the DescribeJobFlows operation.@Deprecated public DescribeJobFlowsResult describeJobFlows()
AmazonElasticMapReduce
describeJobFlows
in interface AmazonElasticMapReduce
AmazonElasticMapReduce.describeJobFlows(DescribeJobFlowsRequest)
public DescribeNotebookExecutionResult describeNotebookExecution(DescribeNotebookExecutionRequest request)
AmazonElasticMapReduce
Provides details of a notebook execution.
describeNotebookExecution
in interface AmazonElasticMapReduce
public DescribeReleaseLabelResult describeReleaseLabel(DescribeReleaseLabelRequest request)
AmazonElasticMapReduce
Provides Amazon EMR release label details, such as the releases available the Region where the API request is run, and the available applications for a specific Amazon EMR release label. Can also list Amazon EMR releases that support a specified version of Spark.
describeReleaseLabel
in interface AmazonElasticMapReduce
public DescribeSecurityConfigurationResult describeSecurityConfiguration(DescribeSecurityConfigurationRequest request)
AmazonElasticMapReduce
Provides the details of a security configuration by returning the configuration JSON.
describeSecurityConfiguration
in interface AmazonElasticMapReduce
public DescribeStepResult describeStep(DescribeStepRequest request)
AmazonElasticMapReduce
Provides more detail about the cluster step.
describeStep
in interface AmazonElasticMapReduce
request
- This input determines which step to describe.public DescribeStudioResult describeStudio(DescribeStudioRequest request)
AmazonElasticMapReduce
Returns details for the specified Amazon EMR Studio including ID, Name, VPC, Studio access URL, and so on.
describeStudio
in interface AmazonElasticMapReduce
public GetAutoTerminationPolicyResult getAutoTerminationPolicy(GetAutoTerminationPolicyRequest request)
AmazonElasticMapReduce
Returns the auto-termination policy for an Amazon EMR cluster.
getAutoTerminationPolicy
in interface AmazonElasticMapReduce
public GetBlockPublicAccessConfigurationResult getBlockPublicAccessConfiguration(GetBlockPublicAccessConfigurationRequest request)
AmazonElasticMapReduce
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.
getBlockPublicAccessConfiguration
in interface AmazonElasticMapReduce
public GetClusterSessionCredentialsResult getClusterSessionCredentials(GetClusterSessionCredentialsRequest request)
AmazonElasticMapReduce
Provides temporary, HTTP basic credentials that are associated with a given runtime IAM role and used by a cluster with fine-grained access control activated. You can use these credentials to connect to cluster endpoints that support username and password authentication.
getClusterSessionCredentials
in interface AmazonElasticMapReduce
public GetManagedScalingPolicyResult getManagedScalingPolicy(GetManagedScalingPolicyRequest request)
AmazonElasticMapReduce
Fetches the attached managed scaling policy for an Amazon EMR cluster.
getManagedScalingPolicy
in interface AmazonElasticMapReduce
public GetStudioSessionMappingResult getStudioSessionMapping(GetStudioSessionMappingRequest request)
AmazonElasticMapReduce
Fetches mapping details for the specified Amazon EMR Studio and identity (user or group).
getStudioSessionMapping
in interface AmazonElasticMapReduce
public ListBootstrapActionsResult listBootstrapActions(ListBootstrapActionsRequest request)
AmazonElasticMapReduce
Provides information about the bootstrap actions associated with a cluster.
listBootstrapActions
in interface AmazonElasticMapReduce
request
- This input determines which bootstrap actions to retrieve.public ListClustersResult listClusters(ListClustersRequest request)
AmazonElasticMapReduce
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.
listClusters
in interface AmazonElasticMapReduce
request
- This input determines how the ListClusters action filters the list of clusters that it returns.public ListClustersResult listClusters()
AmazonElasticMapReduce
listClusters
in interface AmazonElasticMapReduce
AmazonElasticMapReduce.listClusters(ListClustersRequest)
public ListInstanceFleetsResult listInstanceFleets(ListInstanceFleetsRequest request)
AmazonElasticMapReduce
Lists all available details about the instance fleets in a cluster.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.
listInstanceFleets
in interface AmazonElasticMapReduce
public ListInstanceGroupsResult listInstanceGroups(ListInstanceGroupsRequest request)
AmazonElasticMapReduce
Provides all available details about the instance groups in a cluster.
listInstanceGroups
in interface AmazonElasticMapReduce
request
- This input determines which instance groups to retrieve.public ListInstancesResult listInstances(ListInstancesRequest request)
AmazonElasticMapReduce
Provides information for all active Amazon EC2 instances and Amazon EC2 instances terminated in the last 30 days, up to a maximum of 2,000. Amazon EC2 instances in any of the following states are considered active: AWAITING_FULFILLMENT, PROVISIONING, BOOTSTRAPPING, RUNNING.
listInstances
in interface AmazonElasticMapReduce
request
- This input determines which instances to list.public ListNotebookExecutionsResult listNotebookExecutions(ListNotebookExecutionsRequest request)
AmazonElasticMapReduce
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 ListNotebookExecutions
calls.
listNotebookExecutions
in interface AmazonElasticMapReduce
public ListReleaseLabelsResult listReleaseLabels(ListReleaseLabelsRequest request)
AmazonElasticMapReduce
Retrieves release labels of Amazon EMR services in the Region where the API is called.
listReleaseLabels
in interface AmazonElasticMapReduce
public ListSecurityConfigurationsResult listSecurityConfigurations(ListSecurityConfigurationsRequest request)
AmazonElasticMapReduce
Lists all the security configurations visible to this account, providing their creation dates and times, and their names. This call returns a maximum of 50 clusters per call, but returns a marker to track the paging of the cluster list across multiple ListSecurityConfigurations calls.
listSecurityConfigurations
in interface AmazonElasticMapReduce
public ListStepsResult listSteps(ListStepsRequest request)
AmazonElasticMapReduce
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.
listSteps
in interface AmazonElasticMapReduce
request
- This input determines which steps to list.public ListStudioSessionMappingsResult listStudioSessionMappings(ListStudioSessionMappingsRequest request)
AmazonElasticMapReduce
Returns a list of all user or group session mappings for the Amazon EMR Studio specified by StudioId
.
listStudioSessionMappings
in interface AmazonElasticMapReduce
public ListStudiosResult listStudios(ListStudiosRequest request)
AmazonElasticMapReduce
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.
listStudios
in interface AmazonElasticMapReduce
public ListSupportedInstanceTypesResult listSupportedInstanceTypes(ListSupportedInstanceTypesRequest request)
AmazonElasticMapReduce
A list of the instance types that Amazon EMR supports. You can filter the list by Amazon Web Services Region and Amazon EMR release.
listSupportedInstanceTypes
in interface AmazonElasticMapReduce
public ModifyClusterResult modifyCluster(ModifyClusterRequest request)
AmazonElasticMapReduce
Modifies the number of steps that can be executed concurrently for the cluster specified using ClusterID.
modifyCluster
in interface AmazonElasticMapReduce
public ModifyInstanceFleetResult modifyInstanceFleet(ModifyInstanceFleetRequest request)
AmazonElasticMapReduce
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 releases 4.8.0 and later, excluding 5.0.x versions.
modifyInstanceFleet
in interface AmazonElasticMapReduce
public ModifyInstanceGroupsResult modifyInstanceGroups(ModifyInstanceGroupsRequest request)
AmazonElasticMapReduce
ModifyInstanceGroups modifies the number of nodes and configuration settings of an instance group. The input parameters include the new target instance count for the group and the instance group ID. The call will either succeed or fail atomically.
modifyInstanceGroups
in interface AmazonElasticMapReduce
request
- Change the size of some instance groups.public ModifyInstanceGroupsResult modifyInstanceGroups()
AmazonElasticMapReduce
modifyInstanceGroups
in interface AmazonElasticMapReduce
AmazonElasticMapReduce.modifyInstanceGroups(ModifyInstanceGroupsRequest)
public PutAutoScalingPolicyResult putAutoScalingPolicy(PutAutoScalingPolicyRequest request)
AmazonElasticMapReduce
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 Amazon EC2 instances in response to the value of a CloudWatch metric.
putAutoScalingPolicy
in interface AmazonElasticMapReduce
public PutAutoTerminationPolicyResult putAutoTerminationPolicy(PutAutoTerminationPolicyRequest request)
AmazonElasticMapReduce
Auto-termination is supported in Amazon EMR releases 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.
putAutoTerminationPolicy
in interface AmazonElasticMapReduce
public PutBlockPublicAccessConfigurationResult putBlockPublicAccessConfiguration(PutBlockPublicAccessConfigurationRequest request)
AmazonElasticMapReduce
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.
putBlockPublicAccessConfiguration
in interface AmazonElasticMapReduce
public PutManagedScalingPolicyResult putManagedScalingPolicy(PutManagedScalingPolicyRequest request)
AmazonElasticMapReduce
Creates or updates a managed scaling policy for an Amazon EMR cluster. The managed scaling policy defines the limits for resources, such as Amazon 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.
putManagedScalingPolicy
in interface AmazonElasticMapReduce
public RemoveAutoScalingPolicyResult removeAutoScalingPolicy(RemoveAutoScalingPolicyRequest request)
AmazonElasticMapReduce
Removes an automatic scaling policy from a specified instance group within an Amazon EMR cluster.
removeAutoScalingPolicy
in interface AmazonElasticMapReduce
public RemoveAutoTerminationPolicyResult removeAutoTerminationPolicy(RemoveAutoTerminationPolicyRequest request)
AmazonElasticMapReduce
Removes an auto-termination policy from an Amazon EMR cluster.
removeAutoTerminationPolicy
in interface AmazonElasticMapReduce
public RemoveManagedScalingPolicyResult removeManagedScalingPolicy(RemoveManagedScalingPolicyRequest request)
AmazonElasticMapReduce
Removes a managed scaling policy from a specified Amazon EMR cluster.
removeManagedScalingPolicy
in interface AmazonElasticMapReduce
public RemoveTagsResult removeTags(RemoveTagsRequest request)
AmazonElasticMapReduce
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:
removeTags
in interface AmazonElasticMapReduce
request
- This input identifies an Amazon EMR resource and a list of tags to remove.public RunJobFlowResult runJobFlow(RunJobFlowRequest request)
AmazonElasticMapReduce
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 long-running clusters, we recommend that you periodically store your results.
The instance fleets configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions. The RunJobFlow request can contain InstanceFleets parameters or InstanceGroups parameters, but not both.
runJobFlow
in interface AmazonElasticMapReduce
request
- Input to the RunJobFlow operation.public SetKeepJobFlowAliveWhenNoStepsResult setKeepJobFlowAliveWhenNoSteps(SetKeepJobFlowAliveWhenNoStepsRequest request)
AmazonElasticMapReduce
You can use the SetKeepJobFlowAliveWhenNoSteps
to configure a cluster (job flow) to terminate after
the step execution, i.e., all your steps are executed. If you want a transient cluster that shuts down after the
last of the current executing steps are completed, you can configure SetKeepJobFlowAliveWhenNoSteps
to false. If you want a long running cluster, configure SetKeepJobFlowAliveWhenNoSteps
to true.
For more information, see Managing Cluster Termination in the Amazon EMR Management Guide.
setKeepJobFlowAliveWhenNoSteps
in interface AmazonElasticMapReduce
public SetTerminationProtectionResult setTerminationProtection(SetTerminationProtectionRequest request)
AmazonElasticMapReduce
SetTerminationProtection locks a cluster (job flow) so the Amazon 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 Amazon 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, see Managing Cluster Termination in the Amazon EMR Management Guide.
setTerminationProtection
in interface AmazonElasticMapReduce
request
- The input argument to the TerminationProtection operation.public SetUnhealthyNodeReplacementResult setUnhealthyNodeReplacement(SetUnhealthyNodeReplacementRequest request)
AmazonElasticMapReduce
Specify whether to enable unhealthy node replacement, which lets Amazon EMR gracefully replace core nodes on a
cluster if any nodes become unhealthy. For example, a node becomes unhealthy if disk usage is above 90%. If
unhealthy node replacement is on and TerminationProtected
are off, Amazon EMR immediately terminates
the unhealthy core nodes. To use unhealthy node replacement and retain unhealthy core nodes, use to turn on
termination protection. In such cases, Amazon EMR adds the unhealthy nodes to a denylist, reducing job
interruptions and failures.
If unhealthy node replacement is on, Amazon EMR notifies YARN and other applications on the cluster to stop scheduling tasks with these nodes, moves the data, and then terminates the nodes.
For more information, see graceful node replacement in the Amazon EMR Management Guide.
setUnhealthyNodeReplacement
in interface AmazonElasticMapReduce
public SetVisibleToAllUsersResult setVisibleToAllUsers(SetVisibleToAllUsersRequest request)
AmazonElasticMapReduce
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 Amazon EMR.
Sets the Cluster$VisibleToAllUsers value for an Amazon EMR cluster. When true
, IAM principals
in the Amazon Web Services account can perform Amazon 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 Amazon 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 Amazon EMR Cluster VisibleToAllUsers Setting in the Amazon EMR Management Guide.
setVisibleToAllUsers
in interface AmazonElasticMapReduce
request
- The input to the SetVisibleToAllUsers action.public StartNotebookExecutionResult startNotebookExecution(StartNotebookExecutionRequest request)
AmazonElasticMapReduce
Starts a notebook execution.
startNotebookExecution
in interface AmazonElasticMapReduce
public StopNotebookExecutionResult stopNotebookExecution(StopNotebookExecutionRequest request)
AmazonElasticMapReduce
Stops a notebook execution.
stopNotebookExecution
in interface AmazonElasticMapReduce
public TerminateJobFlowsResult terminateJobFlows(TerminateJobFlowsRequest request)
AmazonElasticMapReduce
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 Amazon EC2 instances on which the cluster is running are stopped. Any log files not already saved are uploaded to Amazon S3 if a LogUri was specified when the cluster was created.
The maximum number of clusters allowed is 10. The call to TerminateJobFlows
is asynchronous.
Depending on the configuration of the cluster, it may take up to 1-5 minutes for the cluster to completely
terminate and release allocated resources, such as Amazon EC2 instances.
terminateJobFlows
in interface AmazonElasticMapReduce
request
- Input to the TerminateJobFlows operation.public UpdateStudioResult updateStudio(UpdateStudioRequest request)
AmazonElasticMapReduce
Updates an Amazon EMR Studio configuration, including attributes such as name, description, and subnets.
updateStudio
in interface AmazonElasticMapReduce
public UpdateStudioSessionMappingResult updateStudioSessionMapping(UpdateStudioSessionMappingRequest request)
AmazonElasticMapReduce
Updates the session policy attached to the user or group for the specified Amazon EMR Studio.
updateStudioSessionMapping
in interface AmazonElasticMapReduce
public void shutdown()
AmazonElasticMapReduce
shutdown
in interface AmazonElasticMapReduce
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonElasticMapReduce
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.
getCachedResponseMetadata
in interface AmazonElasticMapReduce
request
- The originally executed request.public AmazonElasticMapReduceWaiters waiters()
waiters
in interface AmazonElasticMapReduce