{-# LANGUAGE DeriveDataTypeable #-} {-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE TypeFamilies #-} {-# OPTIONS_GHC -fno-warn-unused-imports #-} {-# OPTIONS_GHC -fno-warn-unused-binds #-} {-# OPTIONS_GHC -fno-warn-unused-matches #-} -- Derived from AWS service descriptions, licensed under Apache 2.0. -- | -- Module : Network.AWS.EMR.RunJobFlow -- Copyright : (c) 2013-2016 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) -- -- 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 -- <http://docs.aws.amazon.com/ElasticMapReduce/latest/DeveloperGuide/AddMoreThan256Steps.html 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. module Network.AWS.EMR.RunJobFlow ( -- * Creating a Request runJobFlow , RunJobFlow -- * Request Lenses , rjfAMIVersion , rjfAdditionalInfo , rjfConfigurations , rjfSteps , rjfJobFlowRole , rjfBootstrapActions , rjfReleaseLabel , rjfLogURI , rjfNewSupportedProducts , rjfVisibleToAllUsers , rjfSupportedProducts , rjfApplications , rjfTags , rjfServiceRole , rjfName , rjfInstances -- * Destructuring the Response , runJobFlowResponse , RunJobFlowResponse -- * Response Lenses , rjfrsJobFlowId , rjfrsResponseStatus ) where import Network.AWS.EMR.Types import Network.AWS.EMR.Types.Product import Network.AWS.Lens import Network.AWS.Prelude import Network.AWS.Request import Network.AWS.Response -- | Input to the < RunJobFlow> operation. -- -- /See:/ 'runJobFlow' smart constructor. data RunJobFlow = RunJobFlow' { _rjfAMIVersion :: !(Maybe Text) , _rjfAdditionalInfo :: !(Maybe Text) , _rjfConfigurations :: !(Maybe [Configuration]) , _rjfSteps :: !(Maybe [StepConfig]) , _rjfJobFlowRole :: !(Maybe Text) , _rjfBootstrapActions :: !(Maybe [BootstrapActionConfig]) , _rjfReleaseLabel :: !(Maybe Text) , _rjfLogURI :: !(Maybe Text) , _rjfNewSupportedProducts :: !(Maybe [SupportedProductConfig]) , _rjfVisibleToAllUsers :: !(Maybe Bool) , _rjfSupportedProducts :: !(Maybe [Text]) , _rjfApplications :: !(Maybe [Application]) , _rjfTags :: !(Maybe [Tag]) , _rjfServiceRole :: !(Maybe Text) , _rjfName :: !Text , _rjfInstances :: !JobFlowInstancesConfig } deriving (Eq,Read,Show,Data,Typeable,Generic) -- | 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' -- -- * 'rjfAdditionalInfo' -- -- * 'rjfConfigurations' -- -- * 'rjfSteps' -- -- * 'rjfJobFlowRole' -- -- * 'rjfBootstrapActions' -- -- * 'rjfReleaseLabel' -- -- * 'rjfLogURI' -- -- * 'rjfNewSupportedProducts' -- -- * 'rjfVisibleToAllUsers' -- -- * 'rjfSupportedProducts' -- -- * 'rjfApplications' -- -- * 'rjfTags' -- -- * 'rjfServiceRole' -- -- * 'rjfName' -- -- * 'rjfInstances' runJobFlow :: Text -- ^ 'rjfName' -> JobFlowInstancesConfig -- ^ 'rjfInstances' -> RunJobFlow runJobFlow pName_ pInstances_ = RunJobFlow' { _rjfAMIVersion = Nothing , _rjfAdditionalInfo = Nothing , _rjfConfigurations = Nothing , _rjfSteps = Nothing , _rjfJobFlowRole = Nothing , _rjfBootstrapActions = Nothing , _rjfReleaseLabel = Nothing , _rjfLogURI = Nothing , _rjfNewSupportedProducts = Nothing , _rjfVisibleToAllUsers = Nothing , _rjfSupportedProducts = Nothing , _rjfApplications = Nothing , _rjfTags = Nothing , _rjfServiceRole = Nothing , _rjfName = pName_ , _rjfInstances = pInstances_ } -- | 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 -- <http://docs.aws.amazon.com/ElasticMapReduce/latest/DeveloperGuide/EnvironmentConfig_AMIVersion.html#ami-versions-supported AMI Versions Supported in Elastic MapReduce> -- in the /Amazon Elastic MapReduce Developer\'s Guide./ rjfAMIVersion :: Lens' RunJobFlow (Maybe Text) rjfAMIVersion = lens _rjfAMIVersion (\ s a -> s{_rjfAMIVersion = a}); -- | A JSON string for selecting additional features. rjfAdditionalInfo :: Lens' RunJobFlow (Maybe Text) rjfAdditionalInfo = lens _rjfAdditionalInfo (\ s a -> s{_rjfAdditionalInfo = a}); -- | Amazon EMR releases 4.x or later. -- -- The list of configurations supplied for the EMR cluster you are -- creating. rjfConfigurations :: Lens' RunJobFlow [Configuration] rjfConfigurations = lens _rjfConfigurations (\ s a -> s{_rjfConfigurations = a}) . _Default . _Coerce; -- | A list of steps to be executed by the job flow. rjfSteps :: Lens' RunJobFlow [StepConfig] rjfSteps = lens _rjfSteps (\ s a -> s{_rjfSteps = a}) . _Default . _Coerce; -- | 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. rjfJobFlowRole :: Lens' RunJobFlow (Maybe Text) rjfJobFlowRole = lens _rjfJobFlowRole (\ s a -> s{_rjfJobFlowRole = a}); -- | A list of bootstrap actions that will be run before Hadoop is started on -- the cluster nodes. rjfBootstrapActions :: Lens' RunJobFlow [BootstrapActionConfig] rjfBootstrapActions = lens _rjfBootstrapActions (\ s a -> s{_rjfBootstrapActions = a}) . _Default . _Coerce; -- | 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. rjfReleaseLabel :: Lens' RunJobFlow (Maybe Text) rjfReleaseLabel = lens _rjfReleaseLabel (\ s a -> s{_rjfReleaseLabel = a}); -- | The location in Amazon S3 to write the log files of the job flow. If a -- value is not provided, logs are not created. rjfLogURI :: Lens' RunJobFlow (Maybe Text) rjfLogURI = lens _rjfLogURI (\ s a -> s{_rjfLogURI = a}); -- | 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 -- <http://docs.aws.amazon.com/ElasticMapReduce/latest/DeveloperGuide/emr-mapr.html 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. rjfNewSupportedProducts :: Lens' RunJobFlow [SupportedProductConfig] rjfNewSupportedProducts = lens _rjfNewSupportedProducts (\ s a -> s{_rjfNewSupportedProducts = a}) . _Default . _Coerce; -- | 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. rjfVisibleToAllUsers :: Lens' RunJobFlow (Maybe Bool) rjfVisibleToAllUsers = lens _rjfVisibleToAllUsers (\ s a -> s{_rjfVisibleToAllUsers = a}); -- | 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 -- <http://docs.aws.amazon.com/ElasticMapReduce/latest/DeveloperGuide/emr-supported-products.html 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. rjfSupportedProducts :: Lens' RunJobFlow [Text] rjfSupportedProducts = lens _rjfSupportedProducts (\ s a -> s{_rjfSupportedProducts = a}) . _Default . _Coerce; -- | 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. rjfApplications :: Lens' RunJobFlow [Application] rjfApplications = lens _rjfApplications (\ s a -> s{_rjfApplications = a}) . _Default . _Coerce; -- | A list of tags to associate with a cluster and propagate to Amazon EC2 -- instances. rjfTags :: Lens' RunJobFlow [Tag] rjfTags = lens _rjfTags (\ s a -> s{_rjfTags = a}) . _Default . _Coerce; -- | The IAM role that will be assumed by the Amazon EMR service to access -- AWS resources on your behalf. rjfServiceRole :: Lens' RunJobFlow (Maybe Text) rjfServiceRole = lens _rjfServiceRole (\ s a -> s{_rjfServiceRole = a}); -- | The name of the job flow. rjfName :: Lens' RunJobFlow Text rjfName = lens _rjfName (\ s a -> s{_rjfName = a}); -- | A specification of the number and type of Amazon EC2 instances on which -- to run the job flow. rjfInstances :: Lens' RunJobFlow JobFlowInstancesConfig rjfInstances = lens _rjfInstances (\ s a -> s{_rjfInstances = a}); instance AWSRequest RunJobFlow where type Rs RunJobFlow = RunJobFlowResponse request = postJSON emr response = receiveJSON (\ s h x -> RunJobFlowResponse' <$> (x .?> "JobFlowId") <*> (pure (fromEnum s))) instance Hashable RunJobFlow instance ToHeaders RunJobFlow where toHeaders = const (mconcat ["X-Amz-Target" =# ("ElasticMapReduce.RunJobFlow" :: ByteString), "Content-Type" =# ("application/x-amz-json-1.1" :: ByteString)]) instance ToJSON RunJobFlow where toJSON RunJobFlow'{..} = object (catMaybes [("AmiVersion" .=) <$> _rjfAMIVersion, ("AdditionalInfo" .=) <$> _rjfAdditionalInfo, ("Configurations" .=) <$> _rjfConfigurations, ("Steps" .=) <$> _rjfSteps, ("JobFlowRole" .=) <$> _rjfJobFlowRole, ("BootstrapActions" .=) <$> _rjfBootstrapActions, ("ReleaseLabel" .=) <$> _rjfReleaseLabel, ("LogUri" .=) <$> _rjfLogURI, ("NewSupportedProducts" .=) <$> _rjfNewSupportedProducts, ("VisibleToAllUsers" .=) <$> _rjfVisibleToAllUsers, ("SupportedProducts" .=) <$> _rjfSupportedProducts, ("Applications" .=) <$> _rjfApplications, ("Tags" .=) <$> _rjfTags, ("ServiceRole" .=) <$> _rjfServiceRole, Just ("Name" .= _rjfName), Just ("Instances" .= _rjfInstances)]) instance ToPath RunJobFlow where toPath = const "/" instance ToQuery RunJobFlow where toQuery = const mempty -- | The result of the < RunJobFlow> operation. -- -- /See:/ 'runJobFlowResponse' smart constructor. data RunJobFlowResponse = RunJobFlowResponse' { _rjfrsJobFlowId :: !(Maybe Text) , _rjfrsResponseStatus :: !Int } deriving (Eq,Read,Show,Data,Typeable,Generic) -- | 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' -- -- * 'rjfrsResponseStatus' runJobFlowResponse :: Int -- ^ 'rjfrsResponseStatus' -> RunJobFlowResponse runJobFlowResponse pResponseStatus_ = RunJobFlowResponse' { _rjfrsJobFlowId = Nothing , _rjfrsResponseStatus = pResponseStatus_ } -- | An unique identifier for the job flow. rjfrsJobFlowId :: Lens' RunJobFlowResponse (Maybe Text) rjfrsJobFlowId = lens _rjfrsJobFlowId (\ s a -> s{_rjfrsJobFlowId = a}); -- | The response status code. rjfrsResponseStatus :: Lens' RunJobFlowResponse Int rjfrsResponseStatus = lens _rjfrsResponseStatus (\ s a -> s{_rjfrsResponseStatus = a});