AWS SDK Version 2 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

.NET Framework 4.5
 
Interface for accessing ElasticMapReduce Amazon Elastic MapReduce (Amazon EMR) is a web service that makes it easy to process large amounts of data efficiently. Amazon EMR uses Hadoop processing combined with several AWS products to do tasks such as web indexing, data mining, log file analysis, machine learning, scientific simulation, and data warehousing.

Inheritance Hierarchy

Amazon.ElasticMapReduce.IAmazonElasticMapReduce

Namespace: Amazon.ElasticMapReduce
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C#
public interface IAmazonElasticMapReduce
         IDisposable

The IAmazonElasticMapReduce type exposes the following members

Methods

NameDescription
Public Method AddInstanceGroups(AddInstanceGroupsRequest) AddInstanceGroups adds an instance group to a running cluster.
Public Method AddInstanceGroupsAsync(AddInstanceGroupsRequest, CancellationToken) Initiates the asynchronous execution of the AddInstanceGroups operation.
Public Method AddJobFlowSteps(AddJobFlowStepsRequest) AddJobFlowSteps adds new steps to a running job flow. A maximum of 256 steps are allowed in each job flow.

If your job flow 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, go to Add More than 256 Steps to a Job Flow in the Amazon Elastic MapReduce Developer's Guide.

A step specifies the location of a JAR file stored either on the master node of the job flow 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.

Elastic MapReduce 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 job flow that is in one of the following states: STARTING, BOOTSTRAPPING, RUNNING, or WAITING.

Public Method AddJobFlowStepsAsync(AddJobFlowStepsRequest, CancellationToken) Initiates the asynchronous execution of the AddJobFlowSteps operation.
Public Method AddTags(AddTagsRequest) 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 Tagging Amazon EMR Resources.
Public Method AddTagsAsync(AddTagsRequest, CancellationToken) Initiates the asynchronous execution of the AddTags operation.
Public Method DescribeCluster() Provides cluster-level details including status, hardware and software configuration, VPC settings, and so on. For information about the cluster steps, see ListSteps.
Public Method DescribeCluster(DescribeClusterRequest) Provides cluster-level details including status, hardware and software configuration, VPC settings, and so on. For information about the cluster steps, see ListSteps.
Public Method DescribeClusterAsync(DescribeClusterRequest, CancellationToken) Initiates the asynchronous execution of the DescribeCluster operation.
Public Method DescribeJobFlows() This API is deprecated 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 Elastic MapReduce can return a maximum of 512 job flow descriptions.

Public Method DescribeJobFlows(DescribeJobFlowsRequest) This API is deprecated 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 Elastic MapReduce can return a maximum of 512 job flow descriptions.

Public Method DescribeJobFlowsAsync(DescribeJobFlowsRequest, CancellationToken) Initiates the asynchronous execution of the DescribeJobFlows operation.
Public Method DescribeStep() Provides more detail about the cluster step.
Public Method DescribeStep(DescribeStepRequest) Provides more detail about the cluster step.
Public Method DescribeStepAsync(DescribeStepRequest, CancellationToken) Initiates the asynchronous execution of the DescribeStep operation.
Public Method ListBootstrapActions() Provides information about the bootstrap actions associated with a cluster.
Public Method ListBootstrapActions(ListBootstrapActionsRequest) Provides information about the bootstrap actions associated with a cluster.
Public Method ListBootstrapActionsAsync(ListBootstrapActionsRequest, CancellationToken) Initiates the asynchronous execution of the ListBootstrapActions operation.
Public Method ListClusters() 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.
Public Method ListClusters(ListClustersRequest) 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.
Public Method ListClustersAsync(ListClustersRequest, CancellationToken) Initiates the asynchronous execution of the ListClusters operation.
Public Method ListInstanceGroups() Provides all available details about the instance groups in a cluster.
Public Method ListInstanceGroups(ListInstanceGroupsRequest) Provides all available details about the instance groups in a cluster.
Public Method ListInstanceGroupsAsync(ListInstanceGroupsRequest, CancellationToken) Initiates the asynchronous execution of the ListInstanceGroups operation.
Public Method ListInstances() Provides information about the cluster instances that Amazon EMR provisions on behalf of a user when it creates the cluster. For example, this operation indicates when the EC2 instances reach the Ready state, when instances become available to Amazon EMR to use for jobs, and the IP addresses for cluster instances, etc.
Public Method ListInstances(ListInstancesRequest) Provides information about the cluster instances that Amazon EMR provisions on behalf of a user when it creates the cluster. For example, this operation indicates when the EC2 instances reach the Ready state, when instances become available to Amazon EMR to use for jobs, and the IP addresses for cluster instances, etc.
Public Method ListInstancesAsync(ListInstancesRequest, CancellationToken) Initiates the asynchronous execution of the ListInstances operation.
Public Method ListSteps() Provides a list of steps for the cluster.
Public Method ListSteps(ListStepsRequest) Provides a list of steps for the cluster.
Public Method ListStepsAsync(ListStepsRequest, CancellationToken) Initiates the asynchronous execution of the ListSteps operation.
Public Method ModifyInstanceGroups(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.
Public Method ModifyInstanceGroupsAsync(ModifyInstanceGroupsRequest, CancellationToken) Initiates the asynchronous execution of the ModifyInstanceGroups operation.
Public Method RemoveTags(RemoveTagsRequest) 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 Tagging Amazon EMR Resources.

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

Public Method RemoveTagsAsync(RemoveTagsRequest, CancellationToken) Initiates the asynchronous execution of the RemoveTags operation.
Public Method RunJobFlow(RunJobFlowRequest) RunJobFlow creates and starts running a new job flow. The job flow will run the steps specified. Once the job flow completes, the cluster is stopped 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 job flow will transition to the WAITING state rather than shutting down once the steps have completed.

For additional protection, you can set the JobFlowInstancesConfigTerminationProtected parameter to TRUE to lock the job flow 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 job flow 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, go to Add More than 256 Steps to a Job Flow in the Amazon Elastic MapReduce Developer's Guide.

For long running job flows, we recommend that you periodically store your results.

Public Method RunJobFlowAsync(RunJobFlowRequest, CancellationToken) Initiates the asynchronous execution of the RunJobFlow operation.
Public Method SetTerminationProtection(SetTerminationProtectionRequest) SetTerminationProtection locks a 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 job flow is analogous to calling the Amazon EC2 DisableAPITermination API on all of the EC2 instances in a cluster.

SetTerminationProtection is used to prevent accidental termination of a job flow and to ensure that in the event of an error, the instances will persist so you can recover any data stored in their ephemeral instance storage.

To terminate a job flow 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, go to Protecting a Job Flow from Termination in the Amazon Elastic MapReduce Developer's Guide.

Public Method SetTerminationProtectionAsync(SetTerminationProtectionRequest, CancellationToken) Initiates the asynchronous execution of the SetTerminationProtection operation.
Public Method SetVisibleToAllUsers(SetVisibleToAllUsersRequest) Sets whether all AWS Identity and Access Management (IAM) users under your account can access the specified job flows. This action works on running job flows. You can also set the visibility of a job flow when you launch it using the VisibleToAllUsers parameter of RunJobFlow. The SetVisibleToAllUsers action can be called only by an IAM user who created the job flow or the AWS account that owns the job flow.
Public Method SetVisibleToAllUsersAsync(SetVisibleToAllUsersRequest, CancellationToken) Initiates the asynchronous execution of the SetVisibleToAllUsers operation.
Public Method TerminateJobFlows(TerminateJobFlowsRequest) TerminateJobFlows shuts a list of job flows down. When a job flow is shut down, any step not yet completed is canceled and the EC2 instances on which the job flow is running are stopped. Any log files not already saved are uploaded to Amazon S3 if a LogUri was specified when the job flow was created.

The maximum number of JobFlows allowed is 10. The call to TerminateJobFlows is asynchronous. Depending on the configuration of the job flow, it may take up to 5-20 minutes for the job flow to completely terminate and release allocated resources, such as Amazon EC2 instances.

Public Method TerminateJobFlowsAsync(TerminateJobFlowsRequest, CancellationToken) Initiates the asynchronous execution of the TerminateJobFlows operation.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

.NET for Windows Store apps:
Supported in: Windows 8