AWS SDK for .NET Documentation
AmazonElasticMapReduce Interface
AmazonAmazon.ElasticMapReduceAmazonElasticMapReduce Did this page help you?   Yes   No    Tell us about it...
Implementation for accessing ElasticMapReduce This is the Amazon Elastic MapReduce API Reference. This guide provides descriptions and samples of the Amazon Elastic MapReduce APIs.

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.

Declaration Syntax
C#
public interface AmazonElasticMapReduce : IDisposable
Members
All MembersMethods



IconMemberDescription
AddInstanceGroups(AddInstanceGroupsRequest)
AddInstanceGroups adds an instance group to a running cluster.

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.


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.

BeginAddInstanceGroups(AddInstanceGroupsRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the AddInstanceGroups operation.

BeginAddJobFlowSteps(AddJobFlowStepsRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the AddJobFlowSteps operation.

BeginAddTags(AddTagsRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the AddTags operation.

BeginDescribeCluster(DescribeClusterRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeCluster operation.

BeginDescribeJobFlows(DescribeJobFlowsRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeJobFlows operation.

BeginDescribeStep(DescribeStepRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeStep operation.

BeginListBootstrapActions(ListBootstrapActionsRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the ListBootstrapActions operation.

BeginListClusters(ListClustersRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the ListClusters operation.

BeginListInstanceGroups(ListInstanceGroupsRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the ListInstanceGroups operation.

BeginListInstances(ListInstancesRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the ListInstances operation.

BeginListSteps(ListStepsRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the ListSteps operation.

BeginModifyInstanceGroups(ModifyInstanceGroupsRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the ModifyInstanceGroups operation.

BeginRemoveTags(RemoveTagsRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the RemoveTags operation.

BeginRunJobFlow(RunJobFlowRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the RunJobFlow operation.

BeginSetTerminationProtection(SetTerminationProtectionRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the SetTerminationProtection operation.

BeginSetVisibleToAllUsers(SetVisibleToAllUsersRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the SetVisibleToAllUsers operation.

BeginTerminateJobFlows(TerminateJobFlowsRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the TerminateJobFlows operation.

DescribeCluster()()()()
Provides cluster-level details including status, hardware and software configuration, VPC settings, and so on. For information about the cluster steps, see ListSteps.

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.

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:
    CopyC#
    RUNNING
    ,
    CopyC#
    WAITING
    ,
    CopyC#
    SHUTTING_DOWN
    ,
    CopyC#
    STARTING

Amazon Elastic MapReduce can return a maximum of 512 job flow descriptions.


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:
    CopyC#
    RUNNING
    ,
    CopyC#
    WAITING
    ,
    CopyC#
    SHUTTING_DOWN
    ,
    CopyC#
    STARTING

Amazon Elastic MapReduce can return a maximum of 512 job flow descriptions.


DescribeStep()()()()
Provides more detail about the cluster step.

DescribeStep(DescribeStepRequest)
Provides more detail about the cluster step.

Dispose()()()()
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable.)
EndAddInstanceGroups(IAsyncResult)
Finishes the asynchronous execution of the AddInstanceGroups operation.

EndAddJobFlowSteps(IAsyncResult)
Finishes the asynchronous execution of the AddJobFlowSteps operation.

EndAddTags(IAsyncResult)
Finishes the asynchronous execution of the AddTags operation.

EndDescribeCluster(IAsyncResult)
Finishes the asynchronous execution of the DescribeCluster operation.

EndDescribeJobFlows(IAsyncResult)
Finishes the asynchronous execution of the DescribeJobFlows operation.

EndDescribeStep(IAsyncResult)
Finishes the asynchronous execution of the DescribeStep operation.

EndListBootstrapActions(IAsyncResult)
Finishes the asynchronous execution of the ListBootstrapActions operation.

EndListClusters(IAsyncResult)
Finishes the asynchronous execution of the ListClusters operation.

EndListInstanceGroups(IAsyncResult)
Finishes the asynchronous execution of the ListInstanceGroups operation.

EndListInstances(IAsyncResult)
Finishes the asynchronous execution of the ListInstances operation.

EndListSteps(IAsyncResult)
Finishes the asynchronous execution of the ListSteps operation.

EndModifyInstanceGroups(IAsyncResult)
Finishes the asynchronous execution of the ModifyInstanceGroups operation.

EndRemoveTags(IAsyncResult)
Finishes the asynchronous execution of the RemoveTags operation.

EndRunJobFlow(IAsyncResult)
Finishes the asynchronous execution of the RunJobFlow operation.

EndSetTerminationProtection(IAsyncResult)
Finishes the asynchronous execution of the SetTerminationProtection operation.

EndSetVisibleToAllUsers(IAsyncResult)
Finishes the asynchronous execution of the SetVisibleToAllUsers operation.

EndTerminateJobFlows(IAsyncResult)
Finishes the asynchronous execution of the TerminateJobFlows operation.

ListBootstrapActions()()()()
Provides information about the bootstrap actions associated with a cluster.

ListBootstrapActions(ListBootstrapActionsRequest)
Provides information about the bootstrap actions associated with a cluster.

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.

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.

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

ListInstanceGroups(ListInstanceGroupsRequest)
Provides all available details about the instance groups in a cluster.

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.

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.

ListSteps()()()()
Provides a list of steps for the cluster.

ListSteps(ListStepsRequest)
Provides a list of steps for the cluster.

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.

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:


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 JobFlowInstancesConfig
CopyC#
KeepJobFlowAliveWhenNoSteps
parameter is set to
CopyC#
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 JobFlowInstancesConfig

CopyC#
TerminationProtected
parameter to
CopyC#
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.


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

CopyC#
true
, you must first unlock the job flow by a subsequent call to SetTerminationProtection in which you set the value to
CopyC#
false
.

For more information, go to Protecting a Job Flow from Termination in the Amazon Elastic MapReduce Developer's Guide.


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

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


Assembly: AWSSDK (Module: AWSSDK) Version: 1.5.60.0 (1.5.60.0)