Package-level declarations

Types

Link copied to clipboard
interface EmrClient : SdkClient

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.

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Functions

Link copied to clipboard

Adds an instance fleet to a running cluster.

Link copied to clipboard

Adds one or more instance groups to a running cluster.

Link copied to clipboard

AddJobFlowSteps adds new steps to a running cluster. A maximum of 256 steps are allowed in each job flow.

Link copied to clipboard
inline suspend fun EmrClient.addTags(crossinline block: AddTagsRequest.Builder.() -> Unit): AddTagsResponse

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.

Link copied to clipboard
inline suspend fun EmrClient.cancelSteps(crossinline block: CancelStepsRequest.Builder.() -> Unit): CancelStepsResponse

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.

Link copied to clipboard

Creates a persistent application user interface.

Link copied to clipboard

Creates a security configuration, which is stored in the service and can be specified when a cluster is created.

Link copied to clipboard
inline suspend fun EmrClient.createStudio(crossinline block: CreateStudioRequest.Builder.() -> Unit): CreateStudioResponse

Creates a new Amazon EMR Studio.

Link copied to clipboard

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.

Link copied to clipboard

Deletes a security configuration.

Link copied to clipboard
inline suspend fun EmrClient.deleteStudio(crossinline block: DeleteStudioRequest.Builder.() -> Unit): DeleteStudioResponse

Removes an Amazon EMR Studio from the Studio metadata store.

Link copied to clipboard

Removes a user or group from an Amazon EMR Studio.

Link copied to clipboard

Provides cluster-level details including status, hardware and software configuration, VPC settings, and so on.

Link copied to clipboard

This API is no longer supported and will eventually be removed. We recommend you use ListClusters, DescribeCluster, ListSteps, ListInstanceGroups and ListBootstrapActions instead.

Link copied to clipboard

Provides details of a notebook execution.

Link copied to clipboard

Describes a persistent application user interface.

Link copied to clipboard

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.

Link copied to clipboard

Provides the details of a security configuration by returning the configuration JSON.

Link copied to clipboard
inline suspend fun EmrClient.describeStep(crossinline block: DescribeStepRequest.Builder.() -> Unit): DescribeStepResponse

Provides more detail about the cluster step.

Link copied to clipboard

Returns details for the specified Amazon EMR Studio including ID, Name, VPC, Studio access URL, and so on.

Link copied to clipboard

Returns the auto-termination policy for an Amazon EMR cluster.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Fetches the attached managed scaling policy for an Amazon EMR cluster.

Link copied to clipboard

The presigned URL properties for the cluster's application user interface.

Link copied to clipboard

The presigned URL properties for the cluster's application user interface.

Link copied to clipboard

Fetches mapping details for the specified Amazon EMR Studio and identity (user or group).

Link copied to clipboard

Provides information about the bootstrap actions associated with a cluster.

Link copied to clipboard
inline suspend fun EmrClient.listClusters(crossinline block: ListClustersRequest.Builder.() -> Unit): ListClustersResponse

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.

Link copied to clipboard

Lists all available details about the instance fleets in a cluster.

Link copied to clipboard

Provides all available details about the instance groups in a cluster.

Link copied to clipboard
inline suspend fun EmrClient.listInstances(crossinline block: ListInstancesRequest.Builder.() -> Unit): ListInstancesResponse

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.

Link copied to clipboard

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.

Link copied to clipboard

Retrieves release labels of Amazon EMR services in the Region where the API is called.

Link copied to clipboard

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.

Link copied to clipboard
inline suspend fun EmrClient.listSteps(crossinline block: ListStepsRequest.Builder.() -> Unit): ListStepsResponse

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.

Link copied to clipboard
inline suspend fun EmrClient.listStudios(crossinline block: ListStudiosRequest.Builder.() -> Unit): ListStudiosResponse

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.

Link copied to clipboard

Returns a list of all user or group session mappings for the Amazon EMR Studio specified by StudioId.

Link copied to clipboard

A list of the instance types that Amazon EMR supports. You can filter the list by Amazon Web Services Region and Amazon EMR release.

Link copied to clipboard
inline suspend fun EmrClient.modifyCluster(crossinline block: ModifyClusterRequest.Builder.() -> Unit): ModifyClusterResponse

Modifies the number of steps that can be executed concurrently for the cluster specified using ClusterID.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Removes an automatic scaling policy from a specified instance group within an Amazon EMR cluster.

Link copied to clipboard

Removes an auto-termination policy from an Amazon EMR cluster.

Link copied to clipboard

Removes a managed scaling policy from a specified Amazon EMR cluster.

Link copied to clipboard
inline suspend fun EmrClient.removeTags(crossinline block: RemoveTagsRequest.Builder.() -> Unit): RemoveTagsResponse

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.

Link copied to clipboard
inline suspend fun EmrClient.runJobFlow(crossinline block: RunJobFlowRequest.Builder.() -> Unit): RunJobFlowResponse

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 JobFlowInstancesConfigKeepJobFlowAliveWhenNoSteps parameter is set to TRUE, the cluster transitions to the WAITING state rather than shutting down after the steps have completed.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Starts a notebook execution.

Link copied to clipboard

Stops a notebook execution.

Link copied to clipboard

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.

Link copied to clipboard
inline suspend fun EmrClient.updateStudio(crossinline block: UpdateStudioRequest.Builder.() -> Unit): UpdateStudioResponse

Updates an Amazon EMR Studio configuration, including attributes such as name, description, and subnets.

Link copied to clipboard

Updates the session policy attached to the user or group for the specified Amazon EMR Studio.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.