AWS SDK Version 3 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.

Implementation for accessing ElasticMapReduce 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

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.ElasticMapReduce.AmazonElasticMapReduceClient

Namespace: Amazon.ElasticMapReduce
Assembly: AWSSDK.ElasticMapReduce.dll
Version: 3.x.y.z

Syntax

C#
public class AmazonElasticMapReduceClient : AmazonServiceClient
         IAmazonElasticMapReduce, IAmazonService, IDisposable

The AmazonElasticMapReduceClient type exposes the following members

Constructors

NameDescription
Public Method AmazonElasticMapReduceClient()

Constructs AmazonElasticMapReduceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonElasticMapReduceClient(RegionEndpoint)

Constructs AmazonElasticMapReduceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonElasticMapReduceClient(AmazonElasticMapReduceConfig)

Constructs AmazonElasticMapReduceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonElasticMapReduceClient(AWSCredentials)

Constructs AmazonElasticMapReduceClient with AWS Credentials

Public Method AmazonElasticMapReduceClient(AWSCredentials, RegionEndpoint)

Constructs AmazonElasticMapReduceClient with AWS Credentials

Public Method AmazonElasticMapReduceClient(AWSCredentials, AmazonElasticMapReduceConfig)

Constructs AmazonElasticMapReduceClient with AWS Credentials and an AmazonElasticMapReduceClient Configuration object.

Public Method AmazonElasticMapReduceClient(string, string)

Constructs AmazonElasticMapReduceClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonElasticMapReduceClient(string, string, RegionEndpoint)

Constructs AmazonElasticMapReduceClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonElasticMapReduceClient(string, string, AmazonElasticMapReduceConfig)

Constructs AmazonElasticMapReduceClient with AWS Access Key ID, AWS Secret Key and an AmazonElasticMapReduceClient Configuration object.

Public Method AmazonElasticMapReduceClient(string, string, string)

Constructs AmazonElasticMapReduceClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonElasticMapReduceClient(string, string, string, RegionEndpoint)

Constructs AmazonElasticMapReduceClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonElasticMapReduceClient(string, string, string, AmazonElasticMapReduceConfig)

Constructs AmazonElasticMapReduceClient with AWS Access Key ID, AWS Secret Key and an AmazonElasticMapReduceClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method AddInstanceFleet(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.

Public Method AddInstanceFleetAsync(AddInstanceFleetRequest, CancellationToken)

Initiates the asynchronous execution of the AddInstanceFleet operation.

Public Method AddInstanceGroups(AddInstanceGroupsRequest)

Adds one or more instance groups 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 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.

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 CancelSteps(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 a step will be canceled, even if the request is successfully submitted. You can only cancel steps that are in a PENDING state.

Public Method CancelStepsAsync(CancelStepsRequest, CancellationToken)

Initiates the asynchronous execution of the CancelSteps operation.

Public Method CreateSecurityConfiguration(CreateSecurityConfigurationRequest)

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

Public Method CreateSecurityConfigurationAsync(CreateSecurityConfigurationRequest, CancellationToken)

Initiates the asynchronous execution of the CreateSecurityConfiguration operation.

Public Method DeleteSecurityConfiguration(DeleteSecurityConfigurationRequest)

Deletes a security configuration.

Public Method DeleteSecurityConfigurationAsync(DeleteSecurityConfigurationRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteSecurityConfiguration 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(CancellationToken)

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 EMR 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 EMR can return a maximum of 512 job flow descriptions.

Public Method DescribeJobFlowsAsync(CancellationToken)

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 EMR can return a maximum of 512 job flow descriptions.

Public Method DescribeJobFlowsAsync(DescribeJobFlowsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeJobFlows operation.

Public Method DescribeSecurityConfiguration(DescribeSecurityConfigurationRequest)

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

Public Method DescribeSecurityConfigurationAsync(DescribeSecurityConfigurationRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeSecurityConfiguration 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(CancellationToken)

Provides more detail about the cluster step.

Public Method DescribeStepAsync(DescribeStepRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeStep operation.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
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(CancellationToken)

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(CancellationToken)

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 ListInstanceFleets(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.

Public Method ListInstanceFleetsAsync(ListInstanceFleetsRequest, CancellationToken)

Initiates the asynchronous execution of the ListInstanceFleets 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(CancellationToken)

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 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.

Public Method ListInstances(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.

Public Method ListInstancesAsync(CancellationToken)

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.

Public Method ListInstancesAsync(ListInstancesRequest, CancellationToken)

Initiates the asynchronous execution of the ListInstances operation.

Public Method ListSecurityConfigurations(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.

Public Method ListSecurityConfigurationsAsync(ListSecurityConfigurationsRequest, CancellationToken)

Initiates the asynchronous execution of the ListSecurityConfigurations operation.

Public Method ListSteps()

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

Public Method ListSteps(ListStepsRequest)

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

Public Method ListStepsAsync(CancellationToken)

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

Public Method ListStepsAsync(ListStepsRequest, CancellationToken)

Initiates the asynchronous execution of the ListSteps operation.

Public Method ModifyInstanceFleet(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.

Public Method ModifyInstanceFleetAsync(ModifyInstanceFleetRequest, CancellationToken)

Initiates the asynchronous execution of the ModifyInstanceFleet 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 PutAutoScalingPolicy(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.

Public Method PutAutoScalingPolicyAsync(PutAutoScalingPolicyRequest, CancellationToken)

Initiates the asynchronous execution of the PutAutoScalingPolicy operation.

Public Method RemoveAutoScalingPolicy(RemoveAutoScalingPolicyRequest)

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

Public Method RemoveAutoScalingPolicyAsync(RemoveAutoScalingPolicyRequest, CancellationToken)

Initiates the asynchronous execution of the RemoveAutoScalingPolicy 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 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.

Public Method RunJobFlowAsync(RunJobFlowRequest, CancellationToken)

Initiates the asynchronous execution of the RunJobFlow operation.

Public Method SetTerminationProtection(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.

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 clusters (job flows). This action works on running clusters. You can also set the visibility of a cluster when you launch it using the VisibleToAllUsers parameter of RunJobFlow. The SetVisibleToAllUsers action can be called only by an IAM user who created the cluster or the AWS account that owns the cluster.

Public Method SetVisibleToAllUsersAsync(SetVisibleToAllUsersRequest, CancellationToken)

Initiates the asynchronous execution of the SetVisibleToAllUsers operation.

Public Method TerminateJobFlows(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.

Public Method TerminateJobFlowsAsync(TerminateJobFlowsRequest, CancellationToken)

Initiates the asynchronous execution of the TerminateJobFlows operation.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Standard:
Supported in: 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms