RunJobFlow - Amazon EMR
Request SyntaxRequest ParametersResponse SyntaxResponse ElementsErrorsExamplesSee Also

RunJobFlow

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 long-running clusters, we recommend that you periodically store your results.

Note

The instance fleets configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions. The RunJobFlow request can contain InstanceFleets parameters or InstanceGroups parameters, but not both.

Request Syntax

{
   "AdditionalInfo": "string",
   "AmiVersion": "string",
   "Applications": [ 
      { 
         "AdditionalInfo": { 
            "string" : "string" 
         },
         "Args": [ "string" ],
         "Name": "string",
         "Version": "string"
      }
   ],
   "AutoScalingRole": "string",
   "AutoTerminationPolicy": { 
      "IdleTimeout": number
   },
   "BootstrapActions": [ 
      { 
         "Name": "string",
         "ScriptBootstrapAction": { 
            "Args": [ "string" ],
            "Path": "string"
         }
      }
   ],
   "Configurations": [ 
      { 
         "Classification": "string",
         "Configurations": [ 
            "Configuration"
         ],
         "Properties": { 
            "string" : "string" 
         }
      }
   ],
   "CustomAmiId": "string",
   "EbsRootVolumeIops": number,
   "EbsRootVolumeSize": number,
   "EbsRootVolumeThroughput": number,
   "Instances": { 
      "AdditionalMasterSecurityGroups": [ "string" ],
      "AdditionalSlaveSecurityGroups": [ "string" ],
      "Ec2KeyName": "string",
      "Ec2SubnetId": "string",
      "Ec2SubnetIds": [ "string" ],
      "EmrManagedMasterSecurityGroup": "string",
      "EmrManagedSlaveSecurityGroup": "string",
      "HadoopVersion": "string",
      "InstanceCount": number,
      "InstanceFleets": [ 
         { 
            "Context": "string",
            "InstanceFleetType": "string",
            "InstanceTypeConfigs": [ 
               { 
                  "BidPrice": "string",
                  "BidPriceAsPercentageOfOnDemandPrice": number,
                  "Configurations": [ 
                     { 
                        "Classification": "string",
                        "Configurations": [ 
                           "Configuration"
                        ],
                        "Properties": { 
                           "string" : "string" 
                        }
                     }
                  ],
                  "CustomAmiId": "string",
                  "EbsConfiguration": { 
                     "EbsBlockDeviceConfigs": [ 
                        { 
                           "VolumeSpecification": { 
                              "Iops": number,
                              "SizeInGB": number,
                              "Throughput": number,
                              "VolumeType": "string"
                           },
                           "VolumesPerInstance": number
                        }
                     ],
                     "EbsOptimized": boolean
                  },
                  "InstanceType": "string",
                  "Priority": number,
                  "WeightedCapacity": number
               }
            ],
            "LaunchSpecifications": { 
               "OnDemandSpecification": { 
                  "AllocationStrategy": "string",
                  "CapacityReservationOptions": { 
                     "CapacityReservationPreference": "string",
                     "CapacityReservationResourceGroupArn": "string",
                     "UsageStrategy": "string"
                  }
               },
               "SpotSpecification": { 
                  "AllocationStrategy": "string",
                  "BlockDurationMinutes": number,
                  "TimeoutAction": "string",
                  "TimeoutDurationMinutes": number
               }
            },
            "Name": "string",
            "ResizeSpecifications": { 
               "OnDemandResizeSpecification": { 
                  "AllocationStrategy": "string",
                  "CapacityReservationOptions": { 
                     "CapacityReservationPreference": "string",
                     "CapacityReservationResourceGroupArn": "string",
                     "UsageStrategy": "string"
                  },
                  "TimeoutDurationMinutes": number
               },
               "SpotResizeSpecification": { 
                  "AllocationStrategy": "string",
                  "TimeoutDurationMinutes": number
               }
            },
            "TargetOnDemandCapacity": number,
            "TargetSpotCapacity": 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" 
                  }
               }
            ],
            "CustomAmiId": "string",
            "EbsConfiguration": { 
               "EbsBlockDeviceConfigs": [ 
                  { 
                     "VolumeSpecification": { 
                        "Iops": number,
                        "SizeInGB": number,
                        "Throughput": number,
                        "VolumeType": "string"
                     },
                     "VolumesPerInstance": number
                  }
               ],
               "EbsOptimized": boolean
            },
            "InstanceCount": number,
            "InstanceRole": "string",
            "InstanceType": "string",
            "Market": "string",
            "Name": "string"
         }
      ],
      "KeepJobFlowAliveWhenNoSteps": boolean,
      "MasterInstanceType": "string",
      "Placement": { 
         "AvailabilityZone": "string",
         "AvailabilityZones": [ "string" ]
      },
      "ServiceAccessSecurityGroup": "string",
      "SlaveInstanceType": "string",
      "TerminationProtected": boolean,
      "UnhealthyNodeReplacement": boolean
   },
   "JobFlowRole": "string",
   "KerberosAttributes": { 
      "ADDomainJoinPassword": "string",
      "ADDomainJoinUser": "string",
      "CrossRealmTrustPrincipalPassword": "string",
      "KdcAdminPassword": "string",
      "Realm": "string"
   },
   "LogEncryptionKmsKeyId": "string",
   "LogUri": "string",
   "ManagedScalingPolicy": { 
      "ComputeLimits": { 
         "MaximumCapacityUnits": number,
         "MaximumCoreCapacityUnits": number,
         "MaximumOnDemandCapacityUnits": number,
         "MinimumCapacityUnits": number,
         "UnitType": "string"
      }
   },
   "Name": "string",
   "NewSupportedProducts": [ 
      { 
         "Args": [ "string" ],
         "Name": "string"
      }
   ],
   "OSReleaseLabel": "string",
   "PlacementGroupConfigs": [ 
      { 
         "InstanceRole": "string",
         "PlacementStrategy": "string"
      }
   ],
   "ReleaseLabel": "string",
   "RepoUpgradeOnBoot": "string",
   "ScaleDownBehavior": "string",
   "SecurityConfiguration": "string",
   "ServiceRole": "string",
   "StepConcurrencyLevel": number,
   "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

Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 and later, ReleaseLabel is used. To specify a custom AMI, use CustomAmiID.

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

Applies to Amazon EMR releases 4.0 and later. A case-insensitive list of applications for Amazon EMR to install and configure when launching the cluster. For a list of applications available for each Amazon EMR release version, see the Amazon EMRRelease Guide.

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

AutoTerminationPolicy

An auto-termination policy for an Amazon EMR cluster. An auto-termination policy defines the amount of idle time in seconds after which a cluster automatically terminates. For alternative cluster termination options, see Control cluster termination.

Type: AutoTerminationPolicy object

Required: No

BootstrapActions

A list of bootstrap actions to run before Hadoop starts on the cluster nodes.

Type: Array of BootstrapActionConfig objects

Required: No

Configurations

For Amazon EMR releases 4.0 and later. The list of configurations supplied for the Amazon EMR cluster that you are creating.

Type: Array of Configuration objects

Required: No

CustomAmiId

Available only in Amazon EMR releases 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI. If specified, Amazon EMR uses this AMI when it launches cluster Amazon EC2 instances. For more information about custom AMIs in Amazon EMR, see Using a Custom AMI in the Amazon EMR Management Guide. If omitted, the cluster uses the base Linux AMI for the ReleaseLabel specified. For Amazon EMR releases 2.x and 3.x, use AmiVersion instead.

For information about creating a custom AMI, see Creating an Amazon EBS-Backed Linux AMI in the Amazon Elastic Compute Cloud User Guide for Linux Instances. For information about finding an AMI ID, see Finding a Linux AMI.

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

EbsRootVolumeIops

The IOPS, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. Available in Amazon EMR releases 6.15.0 and later.

Type: Integer

Required: No

EbsRootVolumeSize

The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. Available in Amazon EMR releases 4.x and later.

Type: Integer

Required: No

EbsRootVolumeThroughput

The throughput, in MiB/s, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. Available in Amazon EMR releases 6.15.0 and later.

Type: Integer

Required: No

Instances

A specification of the number and type of Amazon EC2 instances.

Type: JobFlowInstancesConfig object

Required: Yes

JobFlowRole

Also called instance profile and Amazon EC2 role. An IAM role for an Amazon EMR cluster. The Amazon 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 AWS 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

KerberosAttributes

Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. For more information see Use Kerberos Authentication in the Amazon EMR Management Guide.

Type: KerberosAttributes object

Required: No

LogEncryptionKmsKeyId

The AWS KMS key used for encrypting log files. If a value is not provided, the logs remain encrypted by AES-256. This attribute is only available with Amazon EMR releases 5.30.0 and later, excluding Amazon EMR 6.0.0.

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

ManagedScalingPolicy

The specified managed scaling policy for an Amazon EMR cluster.

Type: ManagedScalingPolicy object

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 later, use Applications.

A list of strings that indicates third-party software to use with the job flow that accepts a user argument list. Amazon 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" in the Amazon EMR Developer Guide. 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 Analytics 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

OSReleaseLabel

Specifies a particular Amazon Linux release for all nodes in a cluster launch RunJobFlow request. If a release is not specified, Amazon EMR uses the latest validated Amazon Linux release for cluster launch.

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

PlacementGroupConfigs

The specified placement group configuration for an Amazon EMR cluster.

Type: Array of PlacementGroupConfig objects

Required: No

ReleaseLabel

The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster. Release labels are in the form emr-x.x.x, where x.x.x is an Amazon EMR release version such as emr-5.14.0. For more information about Amazon EMR release versions and included application versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR releases version 4.0 and later. Earlier versions use AmiVersion.

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

RepoUpgradeOnBoot

Applies only when CustomAmiID is used. Specifies which updates from the Amazon Linux AMI package repositories to apply automatically when the instance boots using the AMI. If omitted, the default is SECURITY, which indicates that only security updates are applied. If NONE is specified, no updates are applied, and all updates must be applied manually.

Type: String

Valid Values: SECURITY | NONE

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 adds nodes to a deny list 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 releases 4.1.0 and later, and is the default for releases 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 Amazon EMR assumes in order to access AWS resources on your behalf. If you've created a custom service role path, you must specify it for the service role when you launch your 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

StepConcurrencyLevel

Specifies the number of steps that can be executed concurrently. The default value is 1. The maximum value is 256.

Type: Integer

Required: No

Steps

A list of steps to run.

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 later, use Applications.

A list of strings that indicates third-party software to use. For more information, see the Amazon EMR Developer Guide. 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
Important

The VisibleToAllUsers parameter is no longer supported. By default, the value is set to true. Setting it to false now has no effect.

Set this value to true so that IAM principals in the AWS account associated with the cluster can perform Amazon EMR actions on the cluster that their IAM policies allow. This value defaults to true for clusters created using the Amazon EMR API or the AWS CLI create-cluster command.

When set to false, only the IAM principal that created the cluster and the AWS account root user can perform Amazon EMR actions for the cluster, regardless of the IAM permissions policies attached to other IAM principals. For more information, see Understanding the Amazon EMR cluster VisibleToAllUsers setting in the Amazon EMR Management Guide.

Type: Boolean

Required: No

Response Syntax

{
   "ClusterArn": "string",
   "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.

ClusterArn

The Amazon Resource Name (ARN) of the cluster.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

JobFlowId

A 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

Examples

Example 1

This example illustrates one usage of RunJobFlow.

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": [],
    "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"}

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: