AWS.EMR (aws-elixir v0.8.0) View Source

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 AWS services to do tasks such as web indexing, data mining, log file analysis, machine learning, scientific simulation, and data warehouse management.

Link to this section Summary

Functions

Adds an instance fleet to a running cluster.

Adds one or more instance groups to a running cluster.

AddJobFlowSteps adds new steps to a running cluster.

Adds tags to an Amazon EMR resource.

Cancels a pending step or steps in a running cluster.

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

Creates a new Amazon EMR Studio.

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.

Removes an Amazon EMR Studio from the Studio metadata store.

Removes a user or group from an Amazon EMR Studio.

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

This API is no longer supported and will eventually be removed.

Provides details of a notebook execution.

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

Provides more detail about the cluster step.

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

Returns the Amazon EMR block public access configuration for your AWS account in the current Region.

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

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

Provides information about the bootstrap actions associated with a cluster.

Provides the status of all clusters visible to this AWS account.

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

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

Provides information for all active EC2 instances and EC2 instances terminated in the last 30 days, up to a maximum of 2,000.

Provides summaries of all notebook executions.

Lists all the security configurations visible to this account, providing their creation dates and times, and their names.

Provides a list of steps for the cluster in reverse order unless you specify stepIds with the request of filter by StepStates.

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

Returns a list of all Amazon EMR Studios associated with the AWS account.

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

Modifies the target On-Demand and target Spot capacities for the instance fleet with the specified InstanceFleetID within the cluster specified using ClusterID.

ModifyInstanceGroups modifies the number of nodes and configuration settings of an instance group.

Creates or updates an automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster.

Creates or updates an Amazon EMR block public access configuration for your AWS account in the current Region.

Creates or updates a managed scaling policy for an Amazon EMR cluster.

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

Removes a managed scaling policy from a specified EMR cluster.

Removes tags from an Amazon EMR resource.

RunJobFlow creates and starts running a new cluster (job flow).

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.

Sets the Cluster$VisibleToAllUsers value, which determines whether the cluster is visible to all IAM users of the AWS account associated with the cluster.

TerminateJobFlows shuts a list of clusters (job flows) down.

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

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

Link to this section Functions

Link to this function

add_instance_fleet(client, input, options \\ [])

View Source

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.

Link to this function

add_instance_groups(client, input, options \\ [])

View Source

Adds one or more instance groups to a running cluster.

Link to this function

add_job_flow_steps(client, input, options \\ [])

View Source

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.

Link to this function

add_tags(client, input, options \\ [])

View Source

Adds tags to an Amazon EMR resource.

Tags make it easier to associate clusters in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. For more information, see Tag Clusters.

Link to this function

cancel_steps(client, input, options \\ [])

View Source

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. You can only cancel steps that are in a PENDING state.

Link to this function

create_security_configuration(client, input, options \\ [])

View Source

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

Link to this function

create_studio(client, input, options \\ [])

View Source

Creates a new Amazon EMR Studio.

Link to this function

create_studio_session_mapping(client, input, options \\ [])

View Source

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.

Link to this function

delete_security_configuration(client, input, options \\ [])

View Source

Deletes a security configuration.

Link to this function

delete_studio(client, input, options \\ [])

View Source

Removes an Amazon EMR Studio from the Studio metadata store.

Link to this function

delete_studio_session_mapping(client, input, options \\ [])

View Source

Removes a user or group from an Amazon EMR Studio.

Link to this function

describe_cluster(client, input, options \\ [])

View Source

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

Link to this function

describe_job_flows(client, input, options \\ [])

View Source

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.

Link to this function

describe_notebook_execution(client, input, options \\ [])

View Source

Provides details of a notebook execution.

Link to this function

describe_security_configuration(client, input, options \\ [])

View Source

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

Link to this function

describe_step(client, input, options \\ [])

View Source

Provides more detail about the cluster step.

Link to this function

describe_studio(client, input, options \\ [])

View Source

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

Link to this function

get_block_public_access_configuration(client, input, options \\ [])

View Source

Returns the Amazon EMR block public access configuration for your AWS account in the current Region.

For more information see Configure Block Public Access for Amazon EMR in the Amazon EMR Management Guide.

Link to this function

get_managed_scaling_policy(client, input, options \\ [])

View Source

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

Link to this function

get_studio_session_mapping(client, input, options \\ [])

View Source

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

Link to this function

list_bootstrap_actions(client, input, options \\ [])

View Source

Provides information about the bootstrap actions associated with a cluster.

Link to this function

list_clusters(client, input, options \\ [])

View Source

Provides the status of all clusters visible to this AWS account.

Allows you to filter the list of clusters based on certain criteria; for example, filtering by cluster creation date and time or by status. This call returns a maximum of 50 clusters per call, but returns a marker to track the paging of the cluster list across multiple ListClusters calls.

Link to this function

list_instance_fleets(client, input, options \\ [])

View Source

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.

Link to this function

list_instance_groups(client, input, options \\ [])

View Source

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

Link to this function

list_instances(client, input, options \\ [])

View Source

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.

Link to this function

list_notebook_executions(client, input, options \\ [])

View Source

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.

Link to this function

list_security_configurations(client, input, options \\ [])

View Source

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 to this function

list_steps(client, input, options \\ [])

View Source

Provides a list of steps for the cluster in reverse order unless you specify stepIds with the request of filter by StepStates.

You can specify a maximum of 10 stepIDs.

Link to this function

list_studio_session_mappings(client, input, options \\ [])

View Source

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

Link to this function

list_studios(client, input, options \\ [])

View Source

Returns a list of all Amazon EMR Studios associated with the AWS account.

The list includes details such as ID, Studio Access URL, and creation time for each Studio.

Link to this function

modify_cluster(client, input, options \\ [])

View Source

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

Link to this function

modify_instance_fleet(client, input, options \\ [])

View Source

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.

Link to this function

modify_instance_groups(client, input, options \\ [])

View Source

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 to this function

put_auto_scaling_policy(client, input, options \\ [])

View Source

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.

Link to this function

put_block_public_access_configuration(client, input, options \\ [])

View Source

Creates or updates an Amazon EMR block public access configuration for your AWS account in the current Region.

For more information see Configure Block Public Access for Amazon EMR in the Amazon EMR Management Guide.

Link to this function

put_managed_scaling_policy(client, input, options \\ [])

View Source

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.

Link to this function

remove_auto_scaling_policy(client, input, options \\ [])

View Source

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

Link to this function

remove_managed_scaling_policy(client, input, options \\ [])

View Source

Removes a managed scaling policy from a specified EMR cluster.

Link to this function

remove_tags(client, input, options \\ [])

View Source

Removes tags from an Amazon EMR resource.

Tags make it easier to associate clusters in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. For more information, see Tag Clusters.

The following example removes the stack tag with value Prod from a cluster:

Link to this function

run_job_flow(client, input, options \\ [])

View Source

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.

Link to this function

set_termination_protection(client, input, options \\ [])

View Source

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.

Link to this function

set_visible_to_all_users(client, input, options \\ [])

View Source

Sets the Cluster$VisibleToAllUsers value, which determines whether the cluster is visible to all IAM users of the AWS account associated with the cluster.

Only the IAM user who created the cluster or the AWS account root user can call this action. The default value, true, indicates that all IAM users in the AWS account can perform cluster actions if they have the proper IAM policy permissions. If set to false, only the IAM user that created the cluster can perform actions. This action works on running clusters. You can override the default true setting when you create a cluster by using the VisibleToAllUsers parameter with RunJobFlow.

Link to this function

start_notebook_execution(client, input, options \\ [])

View Source

Starts a notebook execution.

Link to this function

stop_notebook_execution(client, input, options \\ [])

View Source

Stops a notebook execution.

Link to this function

terminate_job_flows(client, input, options \\ [])

View Source

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.

Link to this function

update_studio(client, input, options \\ [])

View Source

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

Link to this function

update_studio_session_mapping(client, input, options \\ [])

View Source

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