Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
RunJobFlow creates and starts running a new job flow. The job flow will
run the steps specified. Once 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 once 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, go to Add More than 256 Steps to a Job Flow in the Amazon Elastic MapReduce Developer's Guide.
For long running job flows, we recommend that you periodically store your results.
See: AWS API Reference for RunJobFlow.
- runJobFlow :: Text -> JobFlowInstancesConfig -> RunJobFlow
- data RunJobFlow
- rjfAMIVersion :: Lens' RunJobFlow (Maybe Text)
- rjfAdditionalInfo :: Lens' RunJobFlow (Maybe Text)
- rjfConfigurations :: Lens' RunJobFlow [Configuration]
- rjfJobFlowRole :: Lens' RunJobFlow (Maybe Text)
- rjfSteps :: Lens' RunJobFlow [StepConfig]
- rjfBootstrapActions :: Lens' RunJobFlow [BootstrapActionConfig]
- rjfReleaseLabel :: Lens' RunJobFlow (Maybe Text)
- rjfNewSupportedProducts :: Lens' RunJobFlow [SupportedProductConfig]
- rjfLogURI :: Lens' RunJobFlow (Maybe Text)
- rjfSupportedProducts :: Lens' RunJobFlow [Text]
- rjfVisibleToAllUsers :: Lens' RunJobFlow (Maybe Bool)
- rjfApplications :: Lens' RunJobFlow [Application]
- rjfTags :: Lens' RunJobFlow [Tag]
- rjfServiceRole :: Lens' RunJobFlow (Maybe Text)
- rjfName :: Lens' RunJobFlow Text
- rjfInstances :: Lens' RunJobFlow JobFlowInstancesConfig
- runJobFlowResponse :: Int -> RunJobFlowResponse
- data RunJobFlowResponse
- rjfrsJobFlowId :: Lens' RunJobFlowResponse (Maybe Text)
- rjfrsStatus :: Lens' RunJobFlowResponse Int
Creating a Request
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:
data RunJobFlow Source
Input to the RunJobFlow operation.
See: runJobFlow
smart constructor.
Request Lenses
rjfAMIVersion :: Lens' RunJobFlow (Maybe Text) Source
For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and greater, use ReleaseLabel.
The version of the Amazon Machine Image (AMI) to use when launching Amazon EC2 instances in the job flow. The following values are valid:
- The version number of the AMI to use, for example, "2.0."
If the AMI supports multiple versions of Hadoop (for example, AMI 1.0
supports both Hadoop 0.18 and 0.20) you can use the
JobFlowInstancesConfig HadoopVersion
parameter to modify the version
of Hadoop from the defaults shown above.
For details about the AMI versions currently supported by Amazon Elastic MapReduce, go to AMI Versions Supported in Elastic MapReduce in the Amazon Elastic MapReduce Developer's Guide.
rjfAdditionalInfo :: Lens' RunJobFlow (Maybe Text) Source
A JSON string for selecting additional features.
rjfConfigurations :: Lens' RunJobFlow [Configuration] Source
Amazon EMR releases 4.x or later.
The list of configurations supplied for the EMR cluster you are creating.
rjfJobFlowRole :: Lens' RunJobFlow (Maybe Text) Source
An IAM role for the job flow. The EC2 instances of the job flow assume
this role. The default role is EMRJobflowDefault
. In order to use the
default role, you must have already created it using the CLI.
rjfSteps :: Lens' RunJobFlow [StepConfig] Source
A list of steps to be executed by the job flow.
rjfBootstrapActions :: Lens' RunJobFlow [BootstrapActionConfig] Source
A list of bootstrap actions that will be run before Hadoop is started on the cluster nodes.
rjfReleaseLabel :: Lens' RunJobFlow (Maybe Text) Source
Amazon EMR releases 4.x or later.
The release label for the Amazon EMR release. For Amazon EMR 3.x and 2.x AMIs, use amiVersion instead instead of ReleaseLabel.
rjfNewSupportedProducts :: Lens' RunJobFlow [SupportedProductConfig] Source
For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and greater, use Applications.
A list of strings that indicates third-party software to use with the job flow that accepts a user argument list. EMR accepts and forwards the argument list to the corresponding installation script as bootstrap action arguments. For more information, see Launch a Job Flow on the MapR Distribution for Hadoop. Currently supported values are:
- "mapr-m3" - launch the cluster using MapR M3 Edition.
- "mapr-m5" - launch the cluster using MapR M5 Edition.
- "mapr" with the user arguments specifying "--edition,m3" or "--edition,m5" - launch the job flow using MapR M3 or M5 Edition respectively.
- "mapr-m7" - launch the cluster using MapR M7 Edition.
- "hunk" - launch the cluster with the Hunk Big Data Analtics Platform.
- "hue"- launch the cluster with Hue installed.
- "spark" - launch the cluster with Apache Spark installed.
- "ganglia" - launch the cluster with the Ganglia Monitoring System installed.
rjfLogURI :: Lens' RunJobFlow (Maybe Text) Source
The location in Amazon S3 to write the log files of the job flow. If a value is not provided, logs are not created.
rjfSupportedProducts :: Lens' RunJobFlow [Text] Source
For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and greater, use Applications.
A list of strings that indicates third-party software to use with the job flow. For more information, go to 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.
rjfVisibleToAllUsers :: Lens' RunJobFlow (Maybe Bool) Source
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.
rjfApplications :: Lens' RunJobFlow [Application] Source
Amazon EMR releases 4.x or later.
A list of applications for the cluster. Valid values are: "Hadoop", "Hive", "Mahout", "Pig", and "Spark." They are case insensitive.
rjfTags :: Lens' RunJobFlow [Tag] Source
A list of tags to associate with a cluster and propagate to Amazon EC2 instances.
rjfServiceRole :: Lens' RunJobFlow (Maybe Text) Source
The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.
rjfName :: Lens' RunJobFlow Text Source
The name of the job flow.
rjfInstances :: Lens' RunJobFlow JobFlowInstancesConfig Source
A specification of the number and type of Amazon EC2 instances on which to run the job flow.
Destructuring the Response
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:
data RunJobFlowResponse Source
The result of the RunJobFlow operation.
See: runJobFlowResponse
smart constructor.
Response Lenses
rjfrsJobFlowId :: Lens' RunJobFlowResponse (Maybe Text) Source
An unique identifier for the job flow.
rjfrsStatus :: Lens' RunJobFlowResponse Int Source
The response status code.