runJobFlow method

Future<RunJobFlowOutput> runJobFlow({
  1. required JobFlowInstancesConfig instances,
  2. required String name,
  3. String? additionalInfo,
  4. String? amiVersion,
  5. List<Application>? applications,
  6. String? autoScalingRole,
  7. List<BootstrapActionConfig>? bootstrapActions,
  8. List<Configuration>? configurations,
  9. String? customAmiId,
  10. int? ebsRootVolumeSize,
  11. String? jobFlowRole,
  12. KerberosAttributes? kerberosAttributes,
  13. String? logEncryptionKmsKeyId,
  14. String? logUri,
  15. ManagedScalingPolicy? managedScalingPolicy,
  16. List<SupportedProductConfig>? newSupportedProducts,
  17. List<PlacementGroupConfig>? placementGroupConfigs,
  18. String? releaseLabel,
  19. RepoUpgradeOnBoot? repoUpgradeOnBoot,
  20. ScaleDownBehavior? scaleDownBehavior,
  21. String? securityConfiguration,
  22. String? serviceRole,
  23. int? stepConcurrencyLevel,
  24. List<StepConfig>? steps,
  25. List<String>? supportedProducts,
  26. List<Tag>? tags,
  27. bool? visibleToAllUsers,
})

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.

May throw InternalServerError.

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

Parameter name : The name of the job flow.

Parameter additionalInfo : A JSON string for selecting additional features.

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

Parameter 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 EMR Release Guide.

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

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

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

Parameter customAmiId : Available only in Amazon EMR version 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 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 versions 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.

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

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

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

Parameter logEncryptionKmsKeyId : The AWS KMS customer master key (CMK) 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 version 5.30.0 and later, excluding Amazon EMR 6.0.0.

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

Parameter managedScalingPolicy : The specified managed scaling policy for an Amazon EMR cluster.

Parameter newSupportedProducts : 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" 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 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.

Parameter placementGroupConfigs : The specified placement group configuration for an Amazon EMR cluster.

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

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

Parameter 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 version 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.

Parameter securityConfiguration : The name of a security configuration to apply to the cluster.

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

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

Parameter steps : A list of steps to run.

Parameter supportedProducts : 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.

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

Parameter visibleToAllUsers : A value of true indicates that all IAM users in the AWS account can perform cluster actions if they have the proper IAM policy permissions. This is the default. A value of false indicates that only the IAM user who created the cluster can perform actions.

Implementation

Future<RunJobFlowOutput> runJobFlow({
  required JobFlowInstancesConfig instances,
  required String name,
  String? additionalInfo,
  String? amiVersion,
  List<Application>? applications,
  String? autoScalingRole,
  List<BootstrapActionConfig>? bootstrapActions,
  List<Configuration>? configurations,
  String? customAmiId,
  int? ebsRootVolumeSize,
  String? jobFlowRole,
  KerberosAttributes? kerberosAttributes,
  String? logEncryptionKmsKeyId,
  String? logUri,
  ManagedScalingPolicy? managedScalingPolicy,
  List<SupportedProductConfig>? newSupportedProducts,
  List<PlacementGroupConfig>? placementGroupConfigs,
  String? releaseLabel,
  RepoUpgradeOnBoot? repoUpgradeOnBoot,
  ScaleDownBehavior? scaleDownBehavior,
  String? securityConfiguration,
  String? serviceRole,
  int? stepConcurrencyLevel,
  List<StepConfig>? steps,
  List<String>? supportedProducts,
  List<Tag>? tags,
  bool? visibleToAllUsers,
}) async {
  ArgumentError.checkNotNull(instances, 'instances');
  ArgumentError.checkNotNull(name, 'name');
  _s.validateStringLength(
    'name',
    name,
    0,
    256,
    isRequired: true,
  );
  _s.validateStringLength(
    'additionalInfo',
    additionalInfo,
    0,
    10280,
  );
  _s.validateStringLength(
    'amiVersion',
    amiVersion,
    0,
    256,
  );
  _s.validateStringLength(
    'autoScalingRole',
    autoScalingRole,
    0,
    10280,
  );
  _s.validateStringLength(
    'customAmiId',
    customAmiId,
    0,
    256,
  );
  _s.validateStringLength(
    'jobFlowRole',
    jobFlowRole,
    0,
    10280,
  );
  _s.validateStringLength(
    'logEncryptionKmsKeyId',
    logEncryptionKmsKeyId,
    0,
    10280,
  );
  _s.validateStringLength(
    'logUri',
    logUri,
    0,
    10280,
  );
  _s.validateStringLength(
    'releaseLabel',
    releaseLabel,
    0,
    256,
  );
  _s.validateStringLength(
    'securityConfiguration',
    securityConfiguration,
    0,
    10280,
  );
  _s.validateStringLength(
    'serviceRole',
    serviceRole,
    0,
    10280,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'ElasticMapReduce.RunJobFlow'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'Instances': instances,
      'Name': name,
      if (additionalInfo != null) 'AdditionalInfo': additionalInfo,
      if (amiVersion != null) 'AmiVersion': amiVersion,
      if (applications != null) 'Applications': applications,
      if (autoScalingRole != null) 'AutoScalingRole': autoScalingRole,
      if (bootstrapActions != null) 'BootstrapActions': bootstrapActions,
      if (configurations != null) 'Configurations': configurations,
      if (customAmiId != null) 'CustomAmiId': customAmiId,
      if (ebsRootVolumeSize != null) 'EbsRootVolumeSize': ebsRootVolumeSize,
      if (jobFlowRole != null) 'JobFlowRole': jobFlowRole,
      if (kerberosAttributes != null)
        'KerberosAttributes': kerberosAttributes,
      if (logEncryptionKmsKeyId != null)
        'LogEncryptionKmsKeyId': logEncryptionKmsKeyId,
      if (logUri != null) 'LogUri': logUri,
      if (managedScalingPolicy != null)
        'ManagedScalingPolicy': managedScalingPolicy,
      if (newSupportedProducts != null)
        'NewSupportedProducts': newSupportedProducts,
      if (placementGroupConfigs != null)
        'PlacementGroupConfigs': placementGroupConfigs,
      if (releaseLabel != null) 'ReleaseLabel': releaseLabel,
      if (repoUpgradeOnBoot != null)
        'RepoUpgradeOnBoot': repoUpgradeOnBoot.toValue(),
      if (scaleDownBehavior != null)
        'ScaleDownBehavior': scaleDownBehavior.toValue(),
      if (securityConfiguration != null)
        'SecurityConfiguration': securityConfiguration,
      if (serviceRole != null) 'ServiceRole': serviceRole,
      if (stepConcurrencyLevel != null)
        'StepConcurrencyLevel': stepConcurrencyLevel,
      if (steps != null) 'Steps': steps,
      if (supportedProducts != null) 'SupportedProducts': supportedProducts,
      if (tags != null) 'Tags': tags,
      if (visibleToAllUsers != null) 'VisibleToAllUsers': visibleToAllUsers,
    },
  );

  return RunJobFlowOutput.fromJson(jsonResponse.body);
}