amazonka-emr-1.2.0.1: Amazon Elastic MapReduce SDK.

Copyright(c) 2013-2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.EMR

Contents

Description

Amazon Elastic MapReduce (Amazon EMR) is a web service that makes it easy to process large amounts of data efficiently. Amazon EMR uses Hadoop processing combined with several AWS products to do tasks such as web indexing, data mining, log file analysis, machine learning, scientific simulation, and data warehousing.

See: AWS API Reference

Synopsis

Service Configuration

eMR :: Service Source

API version '2009-03-31' of the Amazon Elastic MapReduce SDK configuration.

Errors

Error matchers are designed for use with the functions provided by Control.Exception.Lens. This allows catching (and rethrowing) service specific errors returned by EMR.

InvalidRequestException

_InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source

This exception occurs when there is something wrong with user input.

InternalServerError

_InternalServerError :: AsError a => Getting (First ServiceError) a ServiceError Source

Indicates that an error occurred while processing the request and that the request was not completed.

InternalServerException

_InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError Source

This exception occurs when there is an internal failure in the EMR service.

Waiters

Waiters poll by repeatedly sending a request until some remote success condition configured by the Wait specification is fulfilled. The Wait specification determines how many attempts should be made, in addition to delay and retry strategies.

ClusterRunning

clusterRunning :: Wait DescribeCluster Source

Polls DescribeCluster every 30 seconds until a successful state is reached. An error is returned after 60 failed checks.

Operations

Some AWS operations return results that are incomplete and require subsequent requests in order to obtain the entire result set. The process of sending subsequent requests to continue where a previous request left off is called pagination. For example, the ListObjects operation of Amazon S3 returns up to 1000 objects at a time, and you must send subsequent requests with the appropriate Marker in order to retrieve the next page of results.

Operations that have an AWSPager instance can transparently perform subsequent requests, correctly setting Markers and other request facets to iterate through the entire result set of a truncated API operation. Operations which support this have an additional note in the documentation.

Many operations have the ability to filter results on the server side. See the individual operation parameters for details.

RunJobFlow

module Network.AWS.EMR.RunJobFlow

SetVisibleToAllUsers

module Network.AWS.EMR.SetVisibleToAllUsers

TerminateJobFlows

module Network.AWS.EMR.TerminateJobFlows

RemoveTags

module Network.AWS.EMR.RemoveTags

DescribeStep

module Network.AWS.EMR.DescribeStep

DescribeCluster

module Network.AWS.EMR.DescribeCluster

ModifyInstanceGroups

module Network.AWS.EMR.ModifyInstanceGroups

AddJobFlowSteps

module Network.AWS.EMR.AddJobFlowSteps

SetTerminationProtection

module Network.AWS.EMR.SetTerminationProtection

ListSteps (Paginated)

module Network.AWS.EMR.ListSteps

AddInstanceGroups

module Network.AWS.EMR.AddInstanceGroups

ListInstanceGroups (Paginated)

module Network.AWS.EMR.ListInstanceGroups

ListBootstrapActions (Paginated)

module Network.AWS.EMR.ListBootstrapActions

AddTags

module Network.AWS.EMR.AddTags

ListInstances (Paginated)

module Network.AWS.EMR.ListInstances

ListClusters (Paginated)

module Network.AWS.EMR.ListClusters

Types

ActionOnFailure

data ActionOnFailure Source

Constructors

CancelAndWait 
Continue 
TerminateCluster 
TerminateJobFlow 

Instances

ClusterState

data ClusterState Source

Constructors

Bootstrapping 
Running 
Starting 
Terminated 
TerminatedWithErrors 
Terminating 
Waiting 

Instances

ClusterStateChangeReasonCode

data ClusterStateChangeReasonCode Source

Constructors

AllStepsCompleted 
BootstrapFailure 
InstanceFailure 
InternalError 
StepFailure 
UserRequest 
ValidationError 

Instances

InstanceGroupState

data InstanceGroupState Source

Constructors

IGSArrested 
IGSBootstrapping 
IGSEnded 
IGSProvisioning 
IGSResizing 
IGSRunning 
IGSShuttingDown 
IGSSuspended 
IGSTerminated 
IGSTerminating 

Instances

InstanceGroupStateChangeReasonCode

data InstanceGroupStateChangeReasonCode Source

Constructors

IGSCRCClusterTerminated 
IGSCRCInstanceFailure 
IGSCRCInternalError 
IGSCRCValidationError 

Instances

InstanceGroupType

data InstanceGroupType Source

Constructors

IGTCore 
IGTMaster 
IGTTask 

Instances

InstanceRoleType

data InstanceRoleType Source

Constructors

Core 
Master 
Task 

Instances

InstanceState

data InstanceState Source

Constructors

ISAwaitingFulfillment 
ISBootstrapping 
ISProvisioning 
ISRunning 
ISTerminated 

Instances

InstanceStateChangeReasonCode

data InstanceStateChangeReasonCode Source

Constructors

ISCRCBootstrapFailure 
ISCRCClusterTerminated 
ISCRCInstanceFailure 
ISCRCInternalError 
ISCRCValidationError 

Instances

MarketType

data MarketType Source

Constructors

OnDemand 
Spot 

Instances

StepState

data StepState Source

Constructors

SSCancelled 
SSCompleted 
SSFailed 
SSInterrupted 
SSPending 
SSRunning 

Instances

StepStateChangeReasonCode

data StepStateChangeReasonCode Source

Constructors

None 

Instances

Application

data Application Source

An application is any Amazon or third-party software that you can add to the cluster. This structure contains a list of strings that indicates the software to use with the cluster and accepts a user argument list. Amazon EMR accepts and forwards the argument list to the corresponding installation script as bootstrap action argument. For more information, see Launch a Job Flow on the MapR Distribution for Hadoop. Currently supported values are:

  • "mapr-m3" - launch the job flow using MapR M3 Edition.
  • "mapr-m5" - launch the job flow 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.

In Amazon EMR releases 4.0 and greater, the only accepted parameter is the application name. To pass arguments to applications, you supply a configuration for each application.

See: application smart constructor.

Instances

application :: Application Source

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

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

aAdditionalInfo :: Lens' Application (HashMap Text Text) Source

This option is for advanced users only. This is meta information about third-party applications that third-party vendors use for testing purposes.

aArgs :: Lens' Application [Text] Source

Arguments for Amazon EMR to pass to the application.

aName :: Lens' Application (Maybe Text) Source

The name of the application.

aVersion :: Lens' Application (Maybe Text) Source

The version of the application.

BootstrapActionConfig

data BootstrapActionConfig Source

Configuration of a bootstrap action.

See: bootstrapActionConfig smart constructor.

Instances

bootstrapActionConfig Source

Arguments

:: Text

bacName

-> ScriptBootstrapActionConfig

bacScriptBootstrapAction

-> BootstrapActionConfig 

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

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

bacName :: Lens' BootstrapActionConfig Text Source

The name of the bootstrap action.

bacScriptBootstrapAction :: Lens' BootstrapActionConfig ScriptBootstrapActionConfig Source

The script run by the bootstrap action.

Cluster

data Cluster Source

The detailed description of the cluster.

See: cluster smart constructor.

Instances

cluster Source

Arguments

:: Text

cluId

-> Text

cluName

-> ClusterStatus

cluStatus

-> Cluster 

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

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

cluRequestedAMIVersion :: Lens' Cluster (Maybe Text) Source

The AMI version requested for this cluster.

cluEC2InstanceAttributes :: Lens' Cluster (Maybe EC2InstanceAttributes) Source

Undocumented member.

cluNormalizedInstanceHours :: Lens' Cluster (Maybe Int) Source

An approximation of the cost of the job flow, represented in m1.small/hours. This value is incremented one time for every hour an m1.small instance runs. Larger instances are weighted more, so an EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.

cluConfigurations :: Lens' Cluster [Configuration] Source

Amazon EMR releases 4.x or later.

The list of Configurations supplied to the EMR cluster.

cluReleaseLabel :: Lens' Cluster (Maybe Text) Source

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

cluLogURI :: Lens' Cluster (Maybe Text) Source

The path to the Amazon S3 location where logs for this cluster are stored.

cluRunningAMIVersion :: Lens' Cluster (Maybe Text) Source

The AMI version running on this cluster.

cluMasterPublicDNSName :: Lens' Cluster (Maybe Text) Source

The public DNS name of the master EC2 instance.

cluAutoTerminate :: Lens' Cluster (Maybe Bool) Source

Specifies whether the cluster should terminate after completing all steps.

cluTerminationProtected :: Lens' Cluster (Maybe Bool) Source

Indicates whether Amazon EMR will lock the cluster to prevent the EC2 instances from being terminated by an API call or user intervention, or in the event of a cluster error.

cluVisibleToAllUsers :: Lens' Cluster (Maybe Bool) Source

Indicates 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 manage the job flow if they have the proper policy permissions set. If this value is false, only the IAM user that created the cluster can view and manage it. This value can be changed using the SetVisibleToAllUsers action.

cluApplications :: Lens' Cluster [Application] Source

The applications installed on this cluster.

cluTags :: Lens' Cluster [Tag] Source

A list of tags associated with a cluster.

cluServiceRole :: Lens' Cluster (Maybe Text) Source

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

cluId :: Lens' Cluster Text Source

The unique identifier for the cluster.

cluName :: Lens' Cluster Text Source

The name of the cluster.

cluStatus :: Lens' Cluster ClusterStatus Source

The current status details about the cluster.

ClusterStateChangeReason

data ClusterStateChangeReason Source

The reason that the cluster changed to its current state.

See: clusterStateChangeReason smart constructor.

Instances

clusterStateChangeReason :: ClusterStateChangeReason Source

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

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

cscrCode :: Lens' ClusterStateChangeReason (Maybe ClusterStateChangeReasonCode) Source

The programmatic code for the state change reason.

cscrMessage :: Lens' ClusterStateChangeReason (Maybe Text) Source

The descriptive message for the state change reason.

ClusterStatus

data ClusterStatus Source

The detailed status of the cluster.

See: clusterStatus smart constructor.

Instances

clusterStatus :: ClusterStatus Source

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

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

csState :: Lens' ClusterStatus (Maybe ClusterState) Source

The current state of the cluster.

csStateChangeReason :: Lens' ClusterStatus (Maybe ClusterStateChangeReason) Source

The reason for the cluster status change.

csTimeline :: Lens' ClusterStatus (Maybe ClusterTimeline) Source

A timeline that represents the status of a cluster over the lifetime of the cluster.

ClusterSummary

data ClusterSummary Source

The summary description of the cluster.

See: clusterSummary smart constructor.

Instances

clusterSummary :: ClusterSummary Source

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

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

csStatus :: Lens' ClusterSummary (Maybe ClusterStatus) Source

The details about the current status of the cluster.

csNormalizedInstanceHours :: Lens' ClusterSummary (Maybe Int) Source

An approximation of the cost of the job flow, represented in m1.small/hours. This value is incremented one time for every hour an m1.small instance runs. Larger instances are weighted more, so an EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.

csName :: Lens' ClusterSummary (Maybe Text) Source

The name of the cluster.

csId :: Lens' ClusterSummary (Maybe Text) Source

The unique identifier for the cluster.

ClusterTimeline

data ClusterTimeline Source

Represents the timeline of the cluster's lifecycle.

See: clusterTimeline smart constructor.

Instances

clusterTimeline :: ClusterTimeline Source

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

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

ctReadyDateTime :: Lens' ClusterTimeline (Maybe UTCTime) Source

The date and time when the cluster was ready to execute steps.

ctCreationDateTime :: Lens' ClusterTimeline (Maybe UTCTime) Source

The creation date and time of the cluster.

ctEndDateTime :: Lens' ClusterTimeline (Maybe UTCTime) Source

The date and time when the cluster was terminated.

Command

data Command Source

An entity describing an executable that runs on a cluster.

See: command smart constructor.

Instances

command :: Command Source

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

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

cArgs :: Lens' Command [Text] Source

Arguments for Amazon EMR to pass to the command for execution.

cScriptPath :: Lens' Command (Maybe Text) Source

The Amazon S3 location of the command script.

cName :: Lens' Command (Maybe Text) Source

The name of the command.

Configuration

data Configuration Source

Amazon EMR releases 4.x or later.

Specifies a hardware and software configuration of the EMR cluster. This includes configurations for applications and software bundled with Amazon EMR. The Configuration object is a JSON object which is defined by a classification and a set of properties. Configurations can be nested, so a configuration may have its own Configuration objects listed.

See: configuration smart constructor.

Instances

configuration :: Configuration Source

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

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

cConfigurations :: Lens' Configuration [Configuration] Source

A list of configurations you apply to this configuration object.

cClassification :: Lens' Configuration (Maybe Text) Source

The classification of a configuration. For more information see, Amazon EMR Configurations.

cProperties :: Lens' Configuration (HashMap Text Text) Source

A set of properties supplied to the Configuration object.

EC2InstanceAttributes

data EC2InstanceAttributes Source

Provides information about the EC2 instances in a cluster grouped by category. For example, key name, subnet ID, IAM instance profile, and so on.

See: ec2InstanceAttributes smart constructor.

Instances

ec2InstanceAttributes :: EC2InstanceAttributes Source

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

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

eiaEC2KeyName :: Lens' EC2InstanceAttributes (Maybe Text) Source

The name of the Amazon EC2 key pair to use when connecting with SSH into the master node as a user named "hadoop".

eiaEmrManagedSlaveSecurityGroup :: Lens' EC2InstanceAttributes (Maybe Text) Source

The identifier of the Amazon EC2 security group (managed by Amazon Elastic MapReduce) for the slave nodes.

eiaAdditionalSlaveSecurityGroups :: Lens' EC2InstanceAttributes [Text] Source

A list of additional Amazon EC2 security group IDs for the slave nodes.

eiaIAMInstanceProfile :: Lens' EC2InstanceAttributes (Maybe Text) Source

The IAM role that was specified when the job flow was launched. The EC2 instances of the job flow assume this role.

eiaAdditionalMasterSecurityGroups :: Lens' EC2InstanceAttributes [Text] Source

A list of additional Amazon EC2 security group IDs for the master node.

eiaEmrManagedMasterSecurityGroup :: Lens' EC2InstanceAttributes (Maybe Text) Source

The identifier of the Amazon EC2 security group (managed by Amazon Elastic MapReduce) for the master node.

eiaEC2SubnetId :: Lens' EC2InstanceAttributes (Maybe Text) Source

To launch the job flow in Amazon VPC, set this parameter to the identifier of the Amazon VPC subnet where you want the job flow to launch. If you do not specify this value, the job flow is launched in the normal AWS cloud, outside of a VPC.

Amazon VPC currently does not support cluster compute quadruple extra large (cc1.4xlarge) instances. Thus, you cannot specify the cc1.4xlarge instance type for nodes of a job flow launched in a VPC.

eiaEC2AvailabilityZone :: Lens' EC2InstanceAttributes (Maybe Text) Source

The Availability Zone in which the cluster will run.

HadoopJARStepConfig

data HadoopJARStepConfig Source

A job flow step consisting of a JAR file whose main function will be executed. The main function submits a job for Hadoop to execute and waits for the job to finish or fail.

See: hadoopJARStepConfig smart constructor.

Instances

hadoopJARStepConfig Source

Arguments

:: Text

hjscJAR

-> HadoopJARStepConfig 

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

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

hjscArgs :: Lens' HadoopJARStepConfig [Text] Source

A list of command line arguments passed to the JAR file's main function when executed.

hjscMainClass :: Lens' HadoopJARStepConfig (Maybe Text) Source

The name of the main class in the specified Java file. If not specified, the JAR file should specify a Main-Class in its manifest file.

hjscProperties :: Lens' HadoopJARStepConfig [KeyValue] Source

A list of Java properties that are set when the step runs. You can use these properties to pass key value pairs to your main function.

hjscJAR :: Lens' HadoopJARStepConfig Text Source

A path to a JAR file run during the step.

HadoopStepConfig

data HadoopStepConfig Source

A cluster step consisting of a JAR file whose main function will be executed. The main function submits a job for Hadoop to execute and waits for the job to finish or fail.

See: hadoopStepConfig smart constructor.

Instances

hadoopStepConfig :: HadoopStepConfig Source

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

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

hscArgs :: Lens' HadoopStepConfig [Text] Source

The list of command line arguments to pass to the JAR file's main function for execution.

hscJAR :: Lens' HadoopStepConfig (Maybe Text) Source

The path to the JAR file that runs during the step.

hscMainClass :: Lens' HadoopStepConfig (Maybe Text) Source

The name of the main class in the specified Java file. If not specified, the JAR file should specify a main class in its manifest file.

hscProperties :: Lens' HadoopStepConfig (HashMap Text Text) Source

The list of Java properties that are set when the step runs. You can use these properties to pass key value pairs to your main function.

Instance

data Instance Source

Represents an EC2 instance provisioned as part of cluster.

See: instance' smart constructor.

Instances

instance' :: Instance Source

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

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

iStatus :: Lens' Instance (Maybe InstanceStatus) Source

The current status of the instance.

iPublicDNSName :: Lens' Instance (Maybe Text) Source

The public DNS name of the instance.

iEC2InstanceId :: Lens' Instance (Maybe Text) Source

The unique identifier of the instance in Amazon EC2.

iPrivateIPAddress :: Lens' Instance (Maybe Text) Source

The private IP address of the instance.

iId :: Lens' Instance (Maybe Text) Source

The unique identifier for the instance in Amazon EMR.

iPrivateDNSName :: Lens' Instance (Maybe Text) Source

The private DNS name of the instance.

iPublicIPAddress :: Lens' Instance (Maybe Text) Source

The public IP address of the instance.

InstanceGroup

data InstanceGroup Source

This entity represents an instance group, which is a group of instances that have common purpose. For example, CORE instance group is used for HDFS.

See: instanceGroup smart constructor.

Instances

instanceGroup :: InstanceGroup Source

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

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

igStatus :: Lens' InstanceGroup (Maybe InstanceGroupStatus) Source

The current status of the instance group.

igBidPrice :: Lens' InstanceGroup (Maybe Text) Source

The bid price for each EC2 instance in the instance group when launching nodes as Spot Instances, expressed in USD.

igRequestedInstanceCount :: Lens' InstanceGroup (Maybe Int) Source

The target number of instances for the instance group.

igRunningInstanceCount :: Lens' InstanceGroup (Maybe Int) Source

The number of instances currently running in this instance group.

igConfigurations :: Lens' InstanceGroup [Configuration] Source

Amazon EMR releases 4.x or later.

The list of configurations supplied for an EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).

igInstanceGroupType :: Lens' InstanceGroup (Maybe InstanceGroupType) Source

The type of the instance group. Valid values are MASTER, CORE or TASK.

igInstanceType :: Lens' InstanceGroup (Maybe Text) Source

The EC2 instance type for all instances in the instance group.

igMarket :: Lens' InstanceGroup (Maybe MarketType) Source

The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.

igName :: Lens' InstanceGroup (Maybe Text) Source

The name of the instance group.

igId :: Lens' InstanceGroup (Maybe Text) Source

The identifier of the instance group.

InstanceGroupConfig

data InstanceGroupConfig Source

Configuration defining a new instance group.

See: instanceGroupConfig smart constructor.

Instances

instanceGroupConfig Source

Arguments

:: InstanceRoleType

igcInstanceRole

-> Text

igcInstanceType

-> Int

igcInstanceCount

-> InstanceGroupConfig 

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

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

igcBidPrice :: Lens' InstanceGroupConfig (Maybe Text) Source

Bid price for each Amazon EC2 instance in the instance group when launching nodes as Spot Instances, expressed in USD.

igcConfigurations :: Lens' InstanceGroupConfig [Configuration] Source

Amazon EMR releases 4.x or later.

The list of configurations supplied for an EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).

igcMarket :: Lens' InstanceGroupConfig (Maybe MarketType) Source

Market type of the Amazon EC2 instances used to create a cluster node.

igcName :: Lens' InstanceGroupConfig (Maybe Text) Source

Friendly name given to the instance group.

igcInstanceRole :: Lens' InstanceGroupConfig InstanceRoleType Source

The role of the instance group in the cluster.

igcInstanceType :: Lens' InstanceGroupConfig Text Source

The Amazon EC2 instance type for all instances in the instance group.

igcInstanceCount :: Lens' InstanceGroupConfig Int Source

Target number of instances for the instance group.

InstanceGroupModifyConfig

data InstanceGroupModifyConfig Source

Modify an instance group size.

See: instanceGroupModifyConfig smart constructor.

Instances

instanceGroupModifyConfig Source

Arguments

:: Text

igmcInstanceGroupId

-> InstanceGroupModifyConfig 

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

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

igmcInstanceCount :: Lens' InstanceGroupModifyConfig (Maybe Int) Source

Target size for the instance group.

igmcEC2InstanceIdsToTerminate :: Lens' InstanceGroupModifyConfig [Text] Source

The EC2 InstanceIds to terminate. For advanced users only. Once you terminate the instances, the instance group will not return to its original requested size.

igmcInstanceGroupId :: Lens' InstanceGroupModifyConfig Text Source

Unique ID of the instance group to expand or shrink.

InstanceGroupStateChangeReason

data InstanceGroupStateChangeReason Source

The status change reason details for the instance group.

See: instanceGroupStateChangeReason smart constructor.

Instances

instanceGroupStateChangeReason :: InstanceGroupStateChangeReason Source

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

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

igscrCode :: Lens' InstanceGroupStateChangeReason (Maybe InstanceGroupStateChangeReasonCode) Source

The programmable code for the state change reason.

igscrMessage :: Lens' InstanceGroupStateChangeReason (Maybe Text) Source

The status change reason description.

InstanceGroupStatus

data InstanceGroupStatus Source

The details of the instance group status.

See: instanceGroupStatus smart constructor.

Instances

instanceGroupStatus :: InstanceGroupStatus Source

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

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

igsState :: Lens' InstanceGroupStatus (Maybe InstanceGroupState) Source

The current state of the instance group.

igsStateChangeReason :: Lens' InstanceGroupStatus (Maybe InstanceGroupStateChangeReason) Source

The status change reason details for the instance group.

igsTimeline :: Lens' InstanceGroupStatus (Maybe InstanceGroupTimeline) Source

The timeline of the instance group status over time.

InstanceGroupTimeline

data InstanceGroupTimeline Source

The timeline of the instance group lifecycle.

See: instanceGroupTimeline smart constructor.

Instances

instanceGroupTimeline :: InstanceGroupTimeline Source

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

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

igtReadyDateTime :: Lens' InstanceGroupTimeline (Maybe UTCTime) Source

The date and time when the instance group became ready to perform tasks.

igtCreationDateTime :: Lens' InstanceGroupTimeline (Maybe UTCTime) Source

The creation date and time of the instance group.

igtEndDateTime :: Lens' InstanceGroupTimeline (Maybe UTCTime) Source

The date and time when the instance group terminated.

InstanceStateChangeReason

data InstanceStateChangeReason Source

The details of the status change reason for the instance.

See: instanceStateChangeReason smart constructor.

Instances

instanceStateChangeReason :: InstanceStateChangeReason Source

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

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

iscrCode :: Lens' InstanceStateChangeReason (Maybe InstanceStateChangeReasonCode) Source

The programmable code for the state change reason.

iscrMessage :: Lens' InstanceStateChangeReason (Maybe Text) Source

The status change reason description.

InstanceStatus

data InstanceStatus Source

The instance status details.

See: instanceStatus smart constructor.

Instances

instanceStatus :: InstanceStatus Source

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

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

isState :: Lens' InstanceStatus (Maybe InstanceState) Source

The current state of the instance.

isStateChangeReason :: Lens' InstanceStatus (Maybe InstanceStateChangeReason) Source

The details of the status change reason for the instance.

isTimeline :: Lens' InstanceStatus (Maybe InstanceTimeline) Source

The timeline of the instance status over time.

InstanceTimeline

data InstanceTimeline Source

The timeline of the instance lifecycle.

See: instanceTimeline smart constructor.

Instances

instanceTimeline :: InstanceTimeline Source

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

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

itReadyDateTime :: Lens' InstanceTimeline (Maybe UTCTime) Source

The date and time when the instance was ready to perform tasks.

itCreationDateTime :: Lens' InstanceTimeline (Maybe UTCTime) Source

The creation date and time of the instance.

itEndDateTime :: Lens' InstanceTimeline (Maybe UTCTime) Source

The date and time when the instance was terminated.

JobFlowInstancesConfig

data JobFlowInstancesConfig Source

A description of the Amazon EC2 instance running the job flow. A valid JobFlowInstancesConfig must contain at least InstanceGroups, which is the recommended configuration. However, a valid alternative is to have MasterInstanceType, SlaveInstanceType, and InstanceCount (all three must be present).

See: jobFlowInstancesConfig smart constructor.

Instances

jobFlowInstancesConfig :: JobFlowInstancesConfig Source

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

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

jficSlaveInstanceType :: Lens' JobFlowInstancesConfig (Maybe Text) Source

The EC2 instance type of the slave nodes.

jficEC2KeyName :: Lens' JobFlowInstancesConfig (Maybe Text) Source

The name of the Amazon EC2 key pair that can be used to ssh to the master node as the user called "hadoop."

jficInstanceCount :: Lens' JobFlowInstancesConfig (Maybe Int) Source

The number of Amazon EC2 instances used to execute the job flow.

jficEmrManagedSlaveSecurityGroup :: Lens' JobFlowInstancesConfig (Maybe Text) Source

The identifier of the Amazon EC2 security group (managed by Amazon ElasticMapReduce) for the slave nodes.

jficAdditionalSlaveSecurityGroups :: Lens' JobFlowInstancesConfig [Text] Source

A list of additional Amazon EC2 security group IDs for the slave nodes.

jficHadoopVersion :: Lens' JobFlowInstancesConfig (Maybe Text) Source

The Hadoop version for the job flow. Valid inputs are "0.18" (deprecated), "0.20" (deprecated), "0.20.205" (deprecated), "1.0.3", "2.2.0", or "2.4.0". If you do not set this value, the default of 0.18 is used, unless the AmiVersion parameter is set in the RunJobFlow call, in which case the default version of Hadoop for that AMI version is used.

jficAdditionalMasterSecurityGroups :: Lens' JobFlowInstancesConfig [Text] Source

A list of additional Amazon EC2 security group IDs for the master node.

jficEmrManagedMasterSecurityGroup :: Lens' JobFlowInstancesConfig (Maybe Text) Source

The identifier of the Amazon EC2 security group (managed by Amazon ElasticMapReduce) for the master node.

jficEC2SubnetId :: Lens' JobFlowInstancesConfig (Maybe Text) Source

To launch the job flow in Amazon Virtual Private Cloud (Amazon VPC), set this parameter to the identifier of the Amazon VPC subnet where you want the job flow to launch. If you do not specify this value, the job flow is launched in the normal Amazon Web Services cloud, outside of an Amazon VPC.

Amazon VPC currently does not support cluster compute quadruple extra large (cc1.4xlarge) instances. Thus you cannot specify the cc1.4xlarge instance type for nodes of a job flow launched in a Amazon VPC.

jficMasterInstanceType :: Lens' JobFlowInstancesConfig (Maybe Text) Source

The EC2 instance type of the master node.

jficInstanceGroups :: Lens' JobFlowInstancesConfig [InstanceGroupConfig] Source

Configuration for the job flow's instance groups.

jficKeepJobFlowAliveWhenNoSteps :: Lens' JobFlowInstancesConfig (Maybe Bool) Source

Specifies whether the job flow should be kept alive after completing all steps.

jficTerminationProtected :: Lens' JobFlowInstancesConfig (Maybe Bool) Source

Specifies whether to lock the job flow to prevent the Amazon EC2 instances from being terminated by API call, user intervention, or in the event of a job flow error.

jficPlacement :: Lens' JobFlowInstancesConfig (Maybe PlacementType) Source

The Availability Zone the job flow will run in.

KeyValue

data KeyValue Source

A key value pair.

See: keyValue smart constructor.

Instances

keyValue :: KeyValue Source

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

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

kvValue :: Lens' KeyValue (Maybe Text) Source

The value part of the identified key.

kvKey :: Lens' KeyValue (Maybe Text) Source

The unique identifier of a key value pair.

PlacementType

data PlacementType Source

The Amazon EC2 location for the job flow.

See: placementType smart constructor.

Instances

placementType Source

Arguments

:: Text

ptAvailabilityZone

-> PlacementType 

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

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

ptAvailabilityZone :: Lens' PlacementType Text Source

The Amazon EC2 Availability Zone for the job flow.

ScriptBootstrapActionConfig

data ScriptBootstrapActionConfig Source

Configuration of the script to run during a bootstrap action.

See: scriptBootstrapActionConfig smart constructor.

Instances

scriptBootstrapActionConfig Source

Arguments

:: Text

sbacPath

-> ScriptBootstrapActionConfig 

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

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

sbacArgs :: Lens' ScriptBootstrapActionConfig [Text] Source

A list of command line arguments to pass to the bootstrap action script.

sbacPath :: Lens' ScriptBootstrapActionConfig Text Source

Location of the script to run during a bootstrap action. Can be either a location in Amazon S3 or on a local file system.

Step

data Step Source

This represents a step in a cluster.

See: step smart constructor.

Instances

step :: Step Source

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

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

sStatus :: Lens' Step (Maybe StepStatus) Source

The current execution status details of the cluster step.

sActionOnFailure :: Lens' Step (Maybe ActionOnFailure) Source

This specifies what action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE.

sConfig :: Lens' Step (Maybe HadoopStepConfig) Source

The Hadoop job configuration of the cluster step.

sName :: Lens' Step (Maybe Text) Source

The name of the cluster step.

sId :: Lens' Step (Maybe Text) Source

The identifier of the cluster step.

StepConfig

data StepConfig Source

Specification of a job flow step.

See: stepConfig smart constructor.

Instances

stepConfig Source

Arguments

:: Text

scName

-> HadoopJARStepConfig

scHadoopJARStep

-> StepConfig 

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

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

scActionOnFailure :: Lens' StepConfig (Maybe ActionOnFailure) Source

The action to take if the job flow step fails.

scName :: Lens' StepConfig Text Source

The name of the job flow step.

scHadoopJARStep :: Lens' StepConfig HadoopJARStepConfig Source

The JAR file used for the job flow step.

StepStateChangeReason

data StepStateChangeReason Source

The details of the step state change reason.

See: stepStateChangeReason smart constructor.

Instances

stepStateChangeReason :: StepStateChangeReason Source

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

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

sscrCode :: Lens' StepStateChangeReason (Maybe StepStateChangeReasonCode) Source

The programmable code for the state change reason. Note: Currently, the service provides no code for the state change.

sscrMessage :: Lens' StepStateChangeReason (Maybe Text) Source

The descriptive message for the state change reason.

StepStatus

data StepStatus Source

The execution status details of the cluster step.

See: stepStatus smart constructor.

Instances

stepStatus :: StepStatus Source

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

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

ssState :: Lens' StepStatus (Maybe StepState) Source

The execution state of the cluster step.

ssStateChangeReason :: Lens' StepStatus (Maybe StepStateChangeReason) Source

The reason for the step execution status change.

ssTimeline :: Lens' StepStatus (Maybe StepTimeline) Source

The timeline of the cluster step status over time.

StepSummary

data StepSummary Source

The summary of the cluster step.

See: stepSummary smart constructor.

Instances

stepSummary :: StepSummary Source

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

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

ssStatus :: Lens' StepSummary (Maybe StepStatus) Source

The current execution status details of the cluster step.

ssActionOnFailure :: Lens' StepSummary (Maybe ActionOnFailure) Source

This specifies what action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE.

ssConfig :: Lens' StepSummary (Maybe HadoopStepConfig) Source

The Hadoop job configuration of the cluster step.

ssName :: Lens' StepSummary (Maybe Text) Source

The name of the cluster step.

ssId :: Lens' StepSummary (Maybe Text) Source

The identifier of the cluster step.

StepTimeline

data StepTimeline Source

The timeline of the cluster step lifecycle.

See: stepTimeline smart constructor.

Instances

stepTimeline :: StepTimeline Source

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

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

stCreationDateTime :: Lens' StepTimeline (Maybe UTCTime) Source

The date and time when the cluster step was created.

stEndDateTime :: Lens' StepTimeline (Maybe UTCTime) Source

The date and time when the cluster step execution completed or failed.

stStartDateTime :: Lens' StepTimeline (Maybe UTCTime) Source

The date and time when the cluster step execution started.

SupportedProductConfig

data SupportedProductConfig Source

The list of supported product configurations which allow user-supplied arguments. EMR accepts these arguments and forwards them to the corresponding installation script as bootstrap action arguments.

See: supportedProductConfig smart constructor.

Instances

supportedProductConfig :: SupportedProductConfig Source

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

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

spcArgs :: Lens' SupportedProductConfig [Text] Source

The list of user-supplied arguments.

spcName :: Lens' SupportedProductConfig (Maybe Text) Source

The name of the product configuration.

Tag

data Tag Source

A key/value pair containing user-defined metadata that you can associate with an Amazon EMR resource. Tags make it easier to associate clusters in various ways, such as grouping clu\ sters to track your Amazon EMR resource allocation costs. For more information, see Tagging Amazon EMR Resources.

See: tag smart constructor.

Instances

tag :: Tag Source

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

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

tagValue :: Lens' Tag (Maybe Text) Source

A user-defined value, which is optional in a tag. For more information, see Tagging Amazon EMR Resources.

tagKey :: Lens' Tag (Maybe Text) Source

A user-defined key, which is the minimum required information for a valid tag. For more information, see Tagging Amazon EMR Resources.