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

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.

Creating a Request

data RunJobFlow

Input to the RunJobFlow operation.

See: newRunJobFlow smart constructor.

Constructors

RunJobFlow'

Fields

• additionalInfo :: Maybe Text

  A JSON string for selecting additional features.

• amiVersion :: Maybe Text

  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.

• applications :: Maybe [Application]

  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.

• autoScalingRole :: Maybe Text

  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.

• autoTerminationPolicy :: Maybe AutoTerminationPolicy
• bootstrapActions :: Maybe [BootstrapActionConfig]

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

• configurations :: Maybe [Configuration]

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

• customAmiId :: Maybe Text

  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.

• ebsRootVolumeSize :: Maybe Int

  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.

• jobFlowRole :: Maybe Text

  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.

• kerberosAttributes :: Maybe 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.

• logEncryptionKmsKeyId :: Maybe Text

  The 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 version 5.30.0 and later, excluding Amazon EMR 6.0.0.

• logUri :: Maybe Text

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

• managedScalingPolicy :: Maybe ManagedScalingPolicy

  The specified managed scaling policy for an Amazon EMR cluster.

• newSupportedProducts' :: Maybe [SupportedProductConfig]

  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. 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.
• oSReleaseLabel :: Maybe Text

  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.

• placementGroupConfigs :: Maybe [PlacementGroupConfig]

  The specified placement group configuration for an Amazon EMR cluster.

• releaseLabel :: Maybe Text

  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.

• repoUpgradeOnBoot :: Maybe 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.

• scaleDownBehavior :: Maybe 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.

• securityConfiguration :: Maybe Text

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

• serviceRole :: Maybe Text

  The IAM role that Amazon EMR assumes in order to access Amazon Web Services 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.

• stepConcurrencyLevel :: Maybe Int

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

• steps :: Maybe [StepConfig]

  A list of steps to run.

• supportedProducts :: Maybe [Text]

  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.
• tags :: Maybe [Tag]

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

• visibleToAllUsers :: Maybe Bool

  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 Amazon Web Services account associated with the cluster can perform EMR actions on the cluster that their IAM policies allow. This value defaults to true for clusters created using the EMR API or the CLI create-cluster command.

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

• name :: Text

  The name of the job flow.

• instances :: JobFlowInstancesConfig

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

Instances

ToJSON RunJobFlow

Defined in Amazonka.EMR.RunJobFlow

Methods

toJSON :: RunJobFlow -> Value

toEncoding :: RunJobFlow -> Encoding

toJSONList :: [RunJobFlow] -> Value

toEncodingList :: [RunJobFlow] -> Encoding

ToHeaders RunJobFlow

Defined in Amazonka.EMR.RunJobFlow

Methods

toHeaders :: RunJobFlow -> [Header]

ToPath RunJobFlow

Defined in Amazonka.EMR.RunJobFlow

Methods

toPath :: RunJobFlow -> ByteString

ToQuery RunJobFlow

Defined in Amazonka.EMR.RunJobFlow

Methods

toQuery :: RunJobFlow -> QueryString

AWSRequest RunJobFlow

Defined in Amazonka.EMR.RunJobFlow

Associated Types

type AWSResponse RunJobFlow

Methods

request :: (Service -> Service) -> RunJobFlow -> Request RunJobFlow

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy RunJobFlow -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RunJobFlow)))

Generic RunJobFlow

Defined in Amazonka.EMR.RunJobFlow

Associated Types

type Rep RunJobFlow :: Type -> Type

Methods

from :: RunJobFlow -> Rep RunJobFlow x

to :: Rep RunJobFlow x -> RunJobFlow

Read RunJobFlow

Defined in Amazonka.EMR.RunJobFlow

Methods

readsPrec :: Int -> ReadS RunJobFlow

readList :: ReadS [RunJobFlow]

readPrec :: ReadPrec RunJobFlow

readListPrec :: ReadPrec [RunJobFlow]

Show RunJobFlow

Defined in Amazonka.EMR.RunJobFlow

Methods

showsPrec :: Int -> RunJobFlow -> ShowS

show :: RunJobFlow -> String

showList :: [RunJobFlow] -> ShowS

NFData RunJobFlow

Defined in Amazonka.EMR.RunJobFlow

Methods

rnf :: RunJobFlow -> ()

Eq RunJobFlow

Defined in Amazonka.EMR.RunJobFlow

Methods

(==) :: RunJobFlow -> RunJobFlow -> Bool

(/=) :: RunJobFlow -> RunJobFlow -> Bool

Hashable RunJobFlow

Defined in Amazonka.EMR.RunJobFlow

Methods

hashWithSalt :: Int -> RunJobFlow -> Int

hash :: RunJobFlow -> Int

type AWSResponse RunJobFlow

Defined in Amazonka.EMR.RunJobFlow

type AWSResponse RunJobFlow = RunJobFlowResponse

type Rep RunJobFlow

Defined in Amazonka.EMR.RunJobFlow

type Rep RunJobFlow = D1 ('MetaData "RunJobFlow" "Amazonka.EMR.RunJobFlow" "amazonka-emr-2.0-B3cWhP6sdymF3IBUMdPGcd" 'False) (C1 ('MetaCons "RunJobFlow'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "additionalInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "amiVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "applications") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Application])))) :*: ((S1 ('MetaSel ('Just "autoScalingRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "autoTerminationPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AutoTerminationPolicy))) :*: (S1 ('MetaSel ('Just "bootstrapActions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [BootstrapActionConfig])) :*: S1 ('MetaSel ('Just "configurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Configuration]))))) :*: ((S1 ('MetaSel ('Just "customAmiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "ebsRootVolumeSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "jobFlowRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "kerberosAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KerberosAttributes)) :*: S1 ('MetaSel ('Just "logEncryptionKmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "logUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "managedScalingPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ManagedScalingPolicy)))))) :*: (((S1 ('MetaSel ('Just "newSupportedProducts'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SupportedProductConfig])) :*: (S1 ('MetaSel ('Just "oSReleaseLabel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "placementGroupConfigs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PlacementGroupConfig])))) :*: ((S1 ('MetaSel ('Just "releaseLabel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "repoUpgradeOnBoot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RepoUpgradeOnBoot))) :*: (S1 ('MetaSel ('Just "scaleDownBehavior") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ScaleDownBehavior)) :*: S1 ('MetaSel ('Just "securityConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 ('MetaSel ('Just "serviceRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "stepConcurrencyLevel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "steps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [StepConfig])) :*: S1 ('MetaSel ('Just "supportedProducts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :*: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "visibleToAllUsers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "instances") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 JobFlowInstancesConfig)))))))

newRunJobFlow

Arguments

:: Text

RunJobFlow

-> JobFlowInstancesConfig

$sel:instances:RunJobFlow'

-> RunJobFlow

Create a value of RunJobFlow with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

RunJobFlow, runJobFlow_additionalInfo - A JSON string for selecting additional features.

$sel:amiVersion:RunJobFlow', runJobFlow_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.

RunJobFlow, runJobFlow_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.

RunJobFlow, runJobFlow_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.

$sel:autoTerminationPolicy:RunJobFlow', runJobFlow_autoTerminationPolicy - Undocumented member.

$sel:bootstrapActions:RunJobFlow', runJobFlow_bootstrapActions - A list of bootstrap actions to run before Hadoop starts on the cluster nodes.

RunJobFlow, runJobFlow_configurations - For Amazon EMR releases 4.0 and later. The list of configurations supplied for the EMR cluster you are creating.

RunJobFlow, runJobFlow_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.

RunJobFlow, runJobFlow_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.

$sel:jobFlowRole:RunJobFlow', runJobFlow_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.

RunJobFlow, runJobFlow_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.

RunJobFlow, runJobFlow_logEncryptionKmsKeyId - The 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 version 5.30.0 and later, excluding Amazon EMR 6.0.0.

RunJobFlow, runJobFlow_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.

$sel:managedScalingPolicy:RunJobFlow', runJobFlow_managedScalingPolicy - The specified managed scaling policy for an Amazon EMR cluster.

$sel:newSupportedProducts':RunJobFlow', runJobFlow_newSupportedProducts - 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. 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.

RunJobFlow, runJobFlow_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.

$sel:placementGroupConfigs:RunJobFlow', runJobFlow_placementGroupConfigs - The specified placement group configuration for an Amazon EMR cluster.

RunJobFlow, runJobFlow_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.

RunJobFlow, runJobFlow_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.

RunJobFlow, runJobFlow_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.

RunJobFlow, runJobFlow_securityConfiguration - The name of a security configuration to apply to the cluster.

RunJobFlow, runJobFlow_serviceRole - The IAM role that Amazon EMR assumes in order to access Amazon Web Services 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.

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

$sel:steps:RunJobFlow', runJobFlow_steps - A list of steps to run.

$sel:supportedProducts:RunJobFlow', runJobFlow_supportedProducts - 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.

RunJobFlow, runJobFlow_tags - A list of tags to associate with a cluster and propagate to Amazon EC2 instances.

RunJobFlow, runJobFlow_visibleToAllUsers - 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 Amazon Web Services account associated with the cluster can perform EMR actions on the cluster that their IAM policies allow. This value defaults to true for clusters created using the EMR API or the CLI create-cluster command.

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

RunJobFlow, runJobFlow_name - The name of the job flow.

$sel:instances:RunJobFlow', runJobFlow_instances - A specification of the number and type of Amazon EC2 instances.

Request Lenses

runJobFlow_additionalInfo :: Lens' RunJobFlow (Maybe Text)

A JSON string for selecting additional features.

runJobFlow_amiVersion :: Lens' RunJobFlow (Maybe Text)

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.

runJobFlow_applications :: Lens' RunJobFlow (Maybe [Application])

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.

runJobFlow_autoScalingRole :: Lens' RunJobFlow (Maybe Text)

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.

runJobFlow_autoTerminationPolicy :: Lens' RunJobFlow (Maybe AutoTerminationPolicy)

Undocumented member.

runJobFlow_bootstrapActions :: Lens' RunJobFlow (Maybe [BootstrapActionConfig])

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

runJobFlow_configurations :: Lens' RunJobFlow (Maybe [Configuration])

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

runJobFlow_customAmiId :: Lens' RunJobFlow (Maybe Text)

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.

runJobFlow_ebsRootVolumeSize :: Lens' RunJobFlow (Maybe Int)

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.

runJobFlow_jobFlowRole :: Lens' RunJobFlow (Maybe Text)

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.

runJobFlow_kerberosAttributes :: Lens' RunJobFlow (Maybe 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.

runJobFlow_logEncryptionKmsKeyId :: Lens' RunJobFlow (Maybe Text)

The 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 version 5.30.0 and later, excluding Amazon EMR 6.0.0.

runJobFlow_logUri :: Lens' RunJobFlow (Maybe Text)

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

runJobFlow_managedScalingPolicy :: Lens' RunJobFlow (Maybe ManagedScalingPolicy)

The specified managed scaling policy for an Amazon EMR cluster.

runJobFlow_newSupportedProducts :: Lens' RunJobFlow (Maybe [SupportedProductConfig])

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

runJobFlow_oSReleaseLabel :: Lens' RunJobFlow (Maybe Text)

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.

runJobFlow_placementGroupConfigs :: Lens' RunJobFlow (Maybe [PlacementGroupConfig])

The specified placement group configuration for an Amazon EMR cluster.

runJobFlow_releaseLabel :: Lens' RunJobFlow (Maybe Text)

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.

runJobFlow_repoUpgradeOnBoot :: Lens' RunJobFlow (Maybe 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.

runJobFlow_scaleDownBehavior :: Lens' RunJobFlow (Maybe 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.

runJobFlow_securityConfiguration :: Lens' RunJobFlow (Maybe Text)

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

runJobFlow_serviceRole :: Lens' RunJobFlow (Maybe Text)

The IAM role that Amazon EMR assumes in order to access Amazon Web Services 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.

runJobFlow_stepConcurrencyLevel :: Lens' RunJobFlow (Maybe Int)

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

runJobFlow_steps :: Lens' RunJobFlow (Maybe [StepConfig])

A list of steps to run.

runJobFlow_supportedProducts :: Lens' RunJobFlow (Maybe [Text])

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.

runJobFlow_tags :: Lens' RunJobFlow (Maybe [Tag])

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

runJobFlow_visibleToAllUsers :: Lens' RunJobFlow (Maybe Bool)

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 Amazon Web Services account associated with the cluster can perform EMR actions on the cluster that their IAM policies allow. This value defaults to true for clusters created using the EMR API or the CLI create-cluster command.

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

runJobFlow_name :: Lens' RunJobFlow Text

The name of the job flow.

runJobFlow_instances :: Lens' RunJobFlow JobFlowInstancesConfig

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

Destructuring the Response

data RunJobFlowResponse

The result of the RunJobFlow operation.

See: newRunJobFlowResponse smart constructor.

Constructors

RunJobFlowResponse'

Fields

• clusterArn :: Maybe Text

  The Amazon Resource Name (ARN) of the cluster.

• jobFlowId :: Maybe Text

  A unique identifier for the job flow.

• httpStatus :: Int

  The response's http status code.

Instances

Generic RunJobFlowResponse

Defined in Amazonka.EMR.RunJobFlow

Associated Types

type Rep RunJobFlowResponse :: Type -> Type

Methods

from :: RunJobFlowResponse -> Rep RunJobFlowResponse x

to :: Rep RunJobFlowResponse x -> RunJobFlowResponse

Read RunJobFlowResponse

Defined in Amazonka.EMR.RunJobFlow

Methods

readsPrec :: Int -> ReadS RunJobFlowResponse

readList :: ReadS [RunJobFlowResponse]

readPrec :: ReadPrec RunJobFlowResponse

readListPrec :: ReadPrec [RunJobFlowResponse]

Show RunJobFlowResponse

Defined in Amazonka.EMR.RunJobFlow

Methods

showsPrec :: Int -> RunJobFlowResponse -> ShowS

show :: RunJobFlowResponse -> String

showList :: [RunJobFlowResponse] -> ShowS

NFData RunJobFlowResponse

Defined in Amazonka.EMR.RunJobFlow

Methods

rnf :: RunJobFlowResponse -> ()

Eq RunJobFlowResponse

Defined in Amazonka.EMR.RunJobFlow

Methods

(==) :: RunJobFlowResponse -> RunJobFlowResponse -> Bool

(/=) :: RunJobFlowResponse -> RunJobFlowResponse -> Bool

type Rep RunJobFlowResponse

Defined in Amazonka.EMR.RunJobFlow

type Rep RunJobFlowResponse = D1 ('MetaData "RunJobFlowResponse" "Amazonka.EMR.RunJobFlow" "amazonka-emr-2.0-B3cWhP6sdymF3IBUMdPGcd" 'False) (C1 ('MetaCons "RunJobFlowResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clusterArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "jobFlowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newRunJobFlowResponse

Arguments

:: Int

$sel:httpStatus:RunJobFlowResponse'

-> RunJobFlowResponse

Create a value of RunJobFlowResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

RunJobFlowResponse, runJobFlowResponse_clusterArn - The Amazon Resource Name (ARN) of the cluster.

$sel:jobFlowId:RunJobFlowResponse', runJobFlowResponse_jobFlowId - A unique identifier for the job flow.

$sel:httpStatus:RunJobFlowResponse', runJobFlowResponse_httpStatus - The response's http status code.

Response Lenses

runJobFlowResponse_clusterArn :: Lens' RunJobFlowResponse (Maybe Text)

The Amazon Resource Name (ARN) of the cluster.

runJobFlowResponse_jobFlowId :: Lens' RunJobFlowResponse (Maybe Text)

A unique identifier for the job flow.

runJobFlowResponse_httpStatus :: Lens' RunJobFlowResponse Int

The response's http status code.