Network.AWS.EMR.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.

Creating a Request

runJobFlow

Arguments

:: Text

rjfName

-> JobFlowInstancesConfig

rjfInstances

-> RunJobFlow

Creates a value of RunJobFlow with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rjfAMIVersion - 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.
• rjfAdditionalInfo - A JSON string for selecting additional features.
• rjfConfigurations - The list of configurations supplied for the EMR cluster you are creating.
• rjfAutoScalingRole - 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.
• rjfSecurityConfiguration - The name of a security configuration to apply to the cluster.
• rjfScaleDownBehavior - 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.
• rjfSteps - A list of steps to be executed by the job flow.
• rjfJobFlowRole - 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.
• rjfBootstrapActions - A list of bootstrap actions that will be run before Hadoop is started on the cluster nodes.
• rjfReleaseLabel - The release label for the Amazon EMR release. For Amazon EMR 3.x and 2.x AMIs, use amiVersion instead instead of ReleaseLabel.
• rjfLogURI - The location in Amazon S3 to write the log files of the job flow. If a value is not provided, logs are not created.
• rjfNewSupportedProducts - 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.
• rjfVisibleToAllUsers - 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.
• rjfSupportedProducts - 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.
• rjfApplications - A list of applications for the cluster. Valid values are: Hadoop, Hive, Mahout, Pig, and "Spark." They are case insensitive.
• rjfTags - A list of tags to associate with a cluster and propagate to Amazon EC2 instances.
• rjfServiceRole - The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.
• rjfName - The name of the job flow.
• rjfInstances - A specification of the number and type of Amazon EC2 instances on which to run the job flow.

data RunJobFlow

Input to the RunJobFlow operation.

See: runJobFlow smart constructor.

Instances

Eq RunJobFlow

Methods

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

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

Data RunJobFlow

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RunJobFlow -> c RunJobFlow

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RunJobFlow

toConstr :: RunJobFlow -> Constr

dataTypeOf :: RunJobFlow -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c RunJobFlow)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RunJobFlow)

gmapT :: (forall b. Data b => b -> b) -> RunJobFlow -> RunJobFlow

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RunJobFlow -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RunJobFlow -> r

gmapQ :: (forall d. Data d => d -> u) -> RunJobFlow -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> RunJobFlow -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RunJobFlow -> m RunJobFlow

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RunJobFlow -> m RunJobFlow

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RunJobFlow -> m RunJobFlow

Read RunJobFlow

Methods

readsPrec :: Int -> ReadS RunJobFlow

readList :: ReadS [RunJobFlow]

readPrec :: ReadPrec RunJobFlow

readListPrec :: ReadPrec [RunJobFlow]

Show RunJobFlow

Methods

showsPrec :: Int -> RunJobFlow -> ShowS

show :: RunJobFlow -> String

showList :: [RunJobFlow] -> ShowS

Generic RunJobFlow

Associated Types

type Rep RunJobFlow :: * -> *

Methods

from :: RunJobFlow -> Rep RunJobFlow x

to :: Rep RunJobFlow x -> RunJobFlow

Hashable RunJobFlow

Methods

hashWithSalt :: Int -> RunJobFlow -> Int

hash :: RunJobFlow -> Int

ToJSON RunJobFlow

Methods

toJSON :: RunJobFlow -> Value

toEncoding :: RunJobFlow -> Encoding

toJSONList :: [RunJobFlow] -> Value

toEncodingList :: [RunJobFlow] -> Encoding

NFData RunJobFlow

Methods

rnf :: RunJobFlow -> ()

AWSRequest RunJobFlow

Associated Types

type Rs RunJobFlow :: *

Methods

request :: RunJobFlow -> Request RunJobFlow

response :: MonadResource m => Logger -> Service -> Proxy * RunJobFlow -> ClientResponse -> m (Response RunJobFlow)

ToPath RunJobFlow

Methods

toPath :: RunJobFlow -> ByteString

ToHeaders RunJobFlow

Methods

toHeaders :: RunJobFlow -> [Header]

ToQuery RunJobFlow

Methods

toQuery :: RunJobFlow -> QueryString

type Rep RunJobFlow

type Rep RunJobFlow = D1 (MetaData "RunJobFlow" "Network.AWS.EMR.RunJobFlow" "amazonka-emr-1.4.5-2XQZ9dXfwaxDxdqyS6qAjg" False) (C1 (MetaCons "RunJobFlow'" PrefixI True) ((:*:) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_rjfAMIVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_rjfAdditionalInfo") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_rjfConfigurations") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Configuration]))) (S1 (MetaSel (Just Symbol "_rjfAutoScalingRole") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_rjfSecurityConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_rjfScaleDownBehavior") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ScaleDownBehavior)))) ((:*:) (S1 (MetaSel (Just Symbol "_rjfSteps") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [StepConfig]))) ((:*:) (S1 (MetaSel (Just Symbol "_rjfJobFlowRole") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_rjfBootstrapActions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [BootstrapActionConfig]))))))) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_rjfReleaseLabel") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_rjfLogURI") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_rjfNewSupportedProducts") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [SupportedProductConfig]))) ((:*:) (S1 (MetaSel (Just Symbol "_rjfVisibleToAllUsers") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_rjfSupportedProducts") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_rjfApplications") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Application]))) (S1 (MetaSel (Just Symbol "_rjfTags") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Tag])))) ((:*:) (S1 (MetaSel (Just Symbol "_rjfServiceRole") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_rjfName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_rjfInstances") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 JobFlowInstancesConfig))))))))

type Rs RunJobFlow

type Rs RunJobFlow = RunJobFlowResponse

Request Lenses

rjfAMIVersion :: Lens' RunJobFlow (Maybe Text)

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.

rjfAdditionalInfo :: Lens' RunJobFlow (Maybe Text)

A JSON string for selecting additional features.

rjfConfigurations :: Lens' RunJobFlow [Configuration]

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

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

rjfSecurityConfiguration :: Lens' RunJobFlow (Maybe Text)

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

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

rjfSteps :: Lens' RunJobFlow [StepConfig]

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

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

rjfBootstrapActions :: Lens' RunJobFlow [BootstrapActionConfig]

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

rjfReleaseLabel :: Lens' RunJobFlow (Maybe Text)

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

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

rjfNewSupportedProducts :: Lens' RunJobFlow [SupportedProductConfig]

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.

rjfVisibleToAllUsers :: Lens' RunJobFlow (Maybe Bool)

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.

rjfSupportedProducts :: Lens' RunJobFlow [Text]

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.

rjfApplications :: Lens' RunJobFlow [Application]

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

rjfTags :: Lens' RunJobFlow [Tag]

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

rjfServiceRole :: Lens' RunJobFlow (Maybe Text)

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

rjfName :: Lens' RunJobFlow Text

The name of the job flow.

rjfInstances :: Lens' RunJobFlow JobFlowInstancesConfig

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

Destructuring the Response

runJobFlowResponse

Arguments

:: Int

rjfrsResponseStatus

-> RunJobFlowResponse

Creates a value of RunJobFlowResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rjfrsJobFlowId - An unique identifier for the job flow.
• rjfrsResponseStatus - -- | The response status code.

data RunJobFlowResponse

The result of the RunJobFlow operation.

See: runJobFlowResponse smart constructor.

Instances

Eq RunJobFlowResponse

Methods

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

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

Data RunJobFlowResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RunJobFlowResponse -> c RunJobFlowResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RunJobFlowResponse

toConstr :: RunJobFlowResponse -> Constr

dataTypeOf :: RunJobFlowResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c RunJobFlowResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RunJobFlowResponse)

gmapT :: (forall b. Data b => b -> b) -> RunJobFlowResponse -> RunJobFlowResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RunJobFlowResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RunJobFlowResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> RunJobFlowResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> RunJobFlowResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RunJobFlowResponse -> m RunJobFlowResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RunJobFlowResponse -> m RunJobFlowResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RunJobFlowResponse -> m RunJobFlowResponse

Read RunJobFlowResponse

Methods

readsPrec :: Int -> ReadS RunJobFlowResponse

readList :: ReadS [RunJobFlowResponse]

readPrec :: ReadPrec RunJobFlowResponse

readListPrec :: ReadPrec [RunJobFlowResponse]

Show RunJobFlowResponse

Methods

showsPrec :: Int -> RunJobFlowResponse -> ShowS

show :: RunJobFlowResponse -> String

showList :: [RunJobFlowResponse] -> ShowS

Generic RunJobFlowResponse

Associated Types

type Rep RunJobFlowResponse :: * -> *

Methods

from :: RunJobFlowResponse -> Rep RunJobFlowResponse x

to :: Rep RunJobFlowResponse x -> RunJobFlowResponse

NFData RunJobFlowResponse

Methods

rnf :: RunJobFlowResponse -> ()

type Rep RunJobFlowResponse

type Rep RunJobFlowResponse = D1 (MetaData "RunJobFlowResponse" "Network.AWS.EMR.RunJobFlow" "amazonka-emr-1.4.5-2XQZ9dXfwaxDxdqyS6qAjg" False) (C1 (MetaCons "RunJobFlowResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_rjfrsJobFlowId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_rjfrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses

rjfrsJobFlowId :: Lens' RunJobFlowResponse (Maybe Text)

An unique identifier for the job flow.

rjfrsResponseStatus :: Lens' RunJobFlowResponse Int

• - | The response status code.