Menu
Amazon Elastic MapReduce
API Reference (API Version 2009-03-31)

RunJobFlow

RunJobFlow creates and starts running a new job flow. The job flow will run the steps specified. After 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 KeepJobFlowAliveWhenNoSteps parameter is set to TRUE, the job flow will transition 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 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, see Add More than 256 Steps to a Job Flow in the Amazon EMR Management Guide.

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

Request Syntax

{
   "AdditionalInfo": "string",
   "AmiVersion": "string",
   "Applications": [ 
      { 
         "AdditionalInfo": { 
            "string" : "string" 
         },
         "Args": [ "string" ],
         "Name": "string",
         "Version": "string"
      }
   ],
   "AutoScalingRole": "string",
   "BootstrapActions": [ 
      { 
         "Name": "string",
         "ScriptBootstrapAction": { 
            "Args": [ "string" ],
            "Path": "string"
         }
      }
   ],
   "Configurations": [ 
      { 
         "Classification": "string",
         "Configurations": [ 
            "Configuration"
         ],
         "Properties": { 
            "string" : "string" 
         }
      }
   ],
   "Instances": { 
      "AdditionalMasterSecurityGroups": [ "string" ],
      "AdditionalSlaveSecurityGroups": [ "string" ],
      "Ec2KeyName": "string",
      "Ec2SubnetId": "string",
      "EmrManagedMasterSecurityGroup": "string",
      "EmrManagedSlaveSecurityGroup": "string",
      "HadoopVersion": "string",
      "InstanceCount": number,
      "InstanceGroups": [ 
         { 
            "AutoScalingPolicy": { 
               "Constraints": { 
                  "MaxCapacity": number,
                  "MinCapacity": number
               },
               "Rules": [ 
                  { 
                     "Action": { 
                        "Market": "string",
                        "SimpleScalingPolicyConfiguration": { 
                           "AdjustmentType": "string",
                           "CoolDown": number,
                           "ScalingAdjustment": number
                        }
                     },
                     "Description": "string",
                     "Name": "string",
                     "Trigger": { 
                        "CloudWatchAlarmDefinition": { 
                           "ComparisonOperator": "string",
                           "Dimensions": [ 
                              { 
                                 "Key": "string",
                                 "Value": "string"
                              }
                           ],
                           "EvaluationPeriods": number,
                           "MetricName": "string",
                           "Namespace": "string",
                           "Period": number,
                           "Statistic": "string",
                           "Threshold": number,
                           "Unit": "string"
                        }
                     }
                  }
               ]
            },
            "BidPrice": "string",
            "Configurations": [ 
               { 
                  "Classification": "string",
                  "Configurations": [ 
                     "Configuration"
                  ],
                  "Properties": { 
                     "string" : "string" 
                  }
               }
            ],
            "EbsConfiguration": { 
               "EbsBlockDeviceConfigs": [ 
                  { 
                     "VolumeSpecification": { 
                        "Iops": number,
                        "SizeInGB": number,
                        "VolumeType": "string"
                     },
                     "VolumesPerInstance": number
                  }
               ],
               "EbsOptimized": boolean
            },
            "InstanceCount": number,
            "InstanceRole": "string",
            "InstanceType": "string",
            "Market": "string",
            "Name": "string"
         }
      ],
      "KeepJobFlowAliveWhenNoSteps": boolean,
      "MasterInstanceType": "string",
      "Placement": { 
         "AvailabilityZone": "string"
      },
      "ServiceAccessSecurityGroup": "string",
      "SlaveInstanceType": "string",
      "TerminationProtected": boolean
   },
   "JobFlowRole": "string",
   "LogUri": "string",
   "Name": "string",
   "NewSupportedProducts": [ 
      { 
         "Args": [ "string" ],
         "Name": "string"
      }
   ],
   "ReleaseLabel": "string",
   "ScaleDownBehavior": "string",
   "SecurityConfiguration": "string",
   "ServiceRole": "string",
   "Steps": [ 
      { 
         "ActionOnFailure": "string",
         "HadoopJarStep": { 
            "Args": [ "string" ],
            "Jar": "string",
            "MainClass": "string",
            "Properties": [ 
               { 
                  "Key": "string",
                  "Value": "string"
               }
            ]
         },
         "Name": "string"
      }
   ],
   "SupportedProducts": [ "string" ],
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "VisibleToAllUsers": boolean
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

AdditionalInfo

A JSON string for selecting additional features.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 10280.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

AmiVersion

Note

For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and greater, use ReleaseLabel.

The version of the Amazon Machine Image (AMI) to use when launching Amazon EC2 instances in the job flow. The following values are valid:

  • The version number of the AMI to use, for example, "2.0."

If the AMI supports multiple versions of Hadoop (for example, AMI 1.0 supports both Hadoop 0.18 and 0.20) you can use the JobFlowInstancesConfig HadoopVersion parameter to modify the version of Hadoop from the defaults shown above.

For details about the AMI versions currently supported by Amazon Elastic MapReduce, see AMI Versions Supported in Elastic MapReduce in the Amazon Elastic MapReduce Developer Guide.

Note

Previously, the EMR AMI version API parameter options allowed you to use latest for the latest AMI version rather than specify a numerical value. Some regions no longer support this deprecated option as they only have a newer release label version of EMR, which requires you to specify an EMR release label release (EMR 4.x or later).

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

Applications

Note

Amazon EMR releases 4.x or later.

A list of applications for the cluster. Valid values are: "Hadoop", "Hive", "Mahout", "Pig", and "Spark." They are case insensitive.

Type: array of Application objects

Required: No

AutoScalingRole

An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole. The IAM role provides permissions that the automatic scaling feature requires to launch and terminate EC2 instances in an instance group.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 10280.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

BootstrapActions

A list of bootstrap actions that will be run before Hadoop is started on the cluster nodes.

Type: array of BootstrapActionConfig objects

Required: No

Configurations

Note

Amazon EMR releases 4.x or later.

The list of configurations supplied for the EMR cluster you are creating.

Type: array of Configuration objects

Required: No

Instances

A specification of the number and type of Amazon EC2 instances on which to run the job flow.

Type: JobFlowInstancesConfig object

Required: Yes

JobFlowRole

Also called instance profile and EC2 role. An IAM role for an EMR cluster. The EC2 instances of the cluster assume this role. The default role is EMR_EC2_DefaultRole. In order to use the default role, you must have already created it using the CLI or console.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 10280.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

LogUri

The location in Amazon S3 to write the log files of the job flow. If a value is not provided, logs are not created.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 10280.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

Name

The name of the job flow.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: Yes

NewSupportedProducts

Note

For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and greater, use Applications.

A list of strings that indicates third-party software to use with the job flow that accepts a user argument list. EMR accepts and forwards the argument list to the corresponding installation script as bootstrap action arguments. For more information, see Launch a Job Flow on the MapR Distribution for Hadoop. Currently supported values are:

  • "mapr-m3" - launch the cluster using MapR M3 Edition.

  • "mapr-m5" - launch the cluster using MapR M5 Edition.

  • "mapr" with the user arguments specifying "--edition,m3" or "--edition,m5" - launch the job flow using MapR M3 or M5 Edition respectively.

  • "mapr-m7" - launch the cluster using MapR M7 Edition.

  • "hunk" - launch the cluster with the Hunk Big Data Analtics Platform.

  • "hue"- launch the cluster with Hue installed.

  • "spark" - launch the cluster with Apache Spark installed.

  • "ganglia" - launch the cluster with the Ganglia Monitoring System installed.

Type: array of SupportedProductConfig objects

Required: No

ReleaseLabel

Note

Amazon EMR releases 4.x or later.

The release label for the Amazon EMR release. For Amazon EMR 3.x and 2.x AMIs, use amiVersion instead instead of ReleaseLabel.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

ScaleDownBehavior

Specifies the way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized. TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates nodes at the instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version. TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR blacklists and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption. TERMINATE_AT_TASK_COMPLETION available only in Amazon EMR version 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.

Type: String

Valid Values: TERMINATE_AT_INSTANCE_HOUR | TERMINATE_AT_TASK_COMPLETION

Required: No

SecurityConfiguration

The name of a security configuration to apply to the cluster.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 10280.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

ServiceRole

The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 10280.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

Steps

A list of steps to be executed by the job flow.

Type: array of StepConfig objects

Required: No

SupportedProducts

Note

For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and greater, use Applications.

A list of strings that indicates third-party software to use with the job flow. For more information, see Use Third Party Applications with Amazon EMR. Currently supported values are:

  • "mapr-m3" - launch the job flow using MapR M3 Edition.

  • "mapr-m5" - launch the job flow using MapR M5 Edition.

Type: array of Strings

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

Tags

A list of tags to associate with a cluster and propagate to Amazon EC2 instances.

Type: array of Tag objects

Required: No

VisibleToAllUsers

Whether the job flow is visible to all IAM users of the AWS account associated with the job flow. If this value is set to true, all IAM users of that AWS account can view and (if they have the proper policy permissions set) manage the job flow. If it is set to false, only the IAM user that created the job flow can view and manage it.

Type: Boolean

Required: No

Response Syntax

{
   "JobFlowId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

JobFlowId

An unique identifier for the job flow.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerError

Indicates that an error occurred while processing the request and that the request was not completed.

HTTP Status Code: 400

Example

Example 1

Sample Request

POST / HTTP/1.1
Content-Type: application/x-amz-json-1.1
X-Amz-Target: ElasticMapReduce.RunJobFlow
Content-Length: 734
User-Agent: aws-sdk-ruby/1.9.2 ruby/1.9.3 i386-mingw32
Host: us-east-1.elasticmapreduce.amazonaws.com
X-Amz-Date: 20130715T210803Z
X-Amz-Content-Sha256: 8676d21986e4628a89fb1232a1344063778d4ffc23d10be02b437e0d53a24db3
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20130715/us-east-1/elasticmapreduce/aws4_request, SignedHeaders=content-length;content-type;host;user-agent;x-amz-content-sha256;x-amz-date;x-amz-target, Signature=71f79725c4dbe77c0e842718485f0b37fe6df69e1153c80f7748ebd9617ca2f3
Accept: */*


{
    "Name": "Development Job Flow",
    "Instances": {
        "KeepJobFlowAliveWhenNoSteps": "false",
        "TerminationProtected": "false",
        "InstanceGroups": [{
            "Name": "Master Instance Group",
            "InstanceRole": "MASTER",
            "InstanceCount": 1,
            "InstanceType": "m1.small",
            "Market": "ON_DEMAND"
        }]
    },
    "Steps": [{
        "Name": "Example Streaming Step",
        "ActionOnFailure": "CANCEL_AND_WAIT",
        "HadoopJarStep": {
            "Jar": "/home/hadoop/contrib/streaming/hadoop-streaming.jar",
            "Args": [
                "-input",
                "s3://elasticmapreduce/samples/wordcount/input",
                "-output",
                "s3://examples-bucket/example-output",
                "-mapper",
                "s3://elasticmapreduce/samples/wordcount/wordSplitter.py",
                "-reducer",
                "aggregate"
            ]
        }
    }],
    "BootstrapActions": [],
    "VisibleToAllUsers": "false",
    "NewSupportedProduct": [],
    "AmiVersion": "3.8.0"
}

Sample Response

HTTP/1.1 200 OK
x-amzn-RequestId: a4406d6b-ed92-11e2-9787-192218ecb460
Content-Type: application/x-amz-json-1.1
Content-Length: 31
Date: Mon, 15 Jul 2013 21:08:05 GMT

{"JobFlowId": "j-ZKIY4CKQRX72"}