2017/03/10 - Amazon Elastic MapReduce - 3 new 4 updated api methods
Adds an instance fleet to a running cluster.
Note
The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x.
See also: AWS API Documentation
Request Syntax
client.add_instance_fleet(
ClusterId='string',
InstanceFleet={
'Name': 'string',
'InstanceFleetType': 'MASTER'|'CORE'|'TASK',
'TargetOnDemandCapacity': 123,
'TargetSpotCapacity': 123,
'InstanceTypeConfigs': [
{
'InstanceType': 'string',
'WeightedCapacity': 123,
'BidPrice': 'string',
'BidPriceAsPercentageOfOnDemandPrice': 123.0,
'EbsConfiguration': {
'EbsBlockDeviceConfigs': [
{
'VolumeSpecification': {
'VolumeType': 'string',
'Iops': 123,
'SizeInGB': 123
},
'VolumesPerInstance': 123
},
],
'EbsOptimized': True|False
},
'Configurations': [
{
'Classification': 'string',
'Configurations': {'... recursive ...'},
'Properties': {
'string': 'string'
}
},
]
},
],
'LaunchSpecifications': {
'SpotSpecification': {
'TimeoutDurationMinutes': 123,
'TimeoutAction': 'SWITCH_TO_ON_DEMAND'|'TERMINATE_CLUSTER',
'BlockDurationMinutes': 123
}
}
}
)
string
[REQUIRED]
The unique identifier of the cluster.
dict
[REQUIRED]
Specifies the configuration of the instance fleet.
Name (string) --
The friendly name of the instance fleet.
InstanceFleetType (string) -- [REQUIRED]
The node type that the instance fleet hosts. Valid values are MASTER,CORE,and TASK.
TargetOnDemandCapacity (integer) --
The target capacity of On-Demand units for the instance fleet, which determines how many On-Demand instances to provision. When the instance fleet launches, Amazon EMR tries to provision On-Demand instances as specified by InstanceTypeConfig . Each instance configuration has a specified WeightedCapacity . When an On-Demand instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units.
Note
If not specified or set to 0, only Spot instances are provisioned for the instance fleet using TargetSpotCapacity . At least one of TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1.
TargetSpotCapacity (integer) --
The target capacity of Spot units for the instance fleet, which determines how many Spot instances to provision. When the instance fleet launches, Amazon EMR tries to provision Spot instances as specified by InstanceTypeConfig . Each instance configuration has a specified WeightedCapacity . When a Spot instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units.
Note
If not specified or set to 0, only On-Demand instances are provisioned for the instance fleet. At least one of TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1.
InstanceTypeConfigs (list) --
The instance type configurations that define the EC2 instances in the instance fleet.
(dict) --
An instance type configuration for each instance type in an instance fleet, which determines the EC2 instances Amazon EMR attempts to provision to fulfill On-Demand and Spot target capacities. There can be a maximum of 5 instance type configurations in a fleet.
Note
The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.
InstanceType (string) -- [REQUIRED]
An EC2 instance type, such as m3.xlarge .
WeightedCapacity (integer) --
The number of units that a provisioned instance of this type provides toward fulfilling the target capacities defined in InstanceFleetConfig . This value is 1 for a master instance fleet, and must be greater than 0 for core and task instance fleets.
BidPrice (string) --
The bid price for each EC2 Spot instance type as defined by InstanceType . Expressed in USD. If neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is provided, BidPriceAsPercentageOfOnDemandPrice defaults to 100%.
BidPriceAsPercentageOfOnDemandPrice (float) --
The bid price, as a percentage of On-Demand price, for each EC2 Spot instance as defined by InstanceType . Expressed as a number between 0 and 1000 (for example, 20 specifies 20%). If neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is provided, BidPriceAsPercentageOfOnDemandPrice defaults to 100%.
EbsConfiguration (dict) --
The configuration of Amazon Elastic Block Storage (EBS) attached to each instance as defined by InstanceType .
EbsBlockDeviceConfigs (list) --
An array of Amazon EBS volume specifications attached to a cluster instance.
(dict) --
Configuration of requested EBS block device associated with the instance group with count of volumes that will be associated to every instance.
VolumeSpecification (dict) -- [REQUIRED]
EBS volume specifications such as volume type, IOPS, and size (GiB) that will be requested for the EBS volume attached to an EC2 instance in the cluster.
VolumeType (string) -- [REQUIRED]
The volume type. Volume types supported are gp2, io1, standard.
Iops (integer) --
The number of I/O operations per second (IOPS) that the volume supports.
SizeInGB (integer) -- [REQUIRED]
The volume size, in gibibytes (GiB). This can be a number from 1 - 1024. If the volume type is EBS-optimized, the minimum value is 10.
VolumesPerInstance (integer) --
Number of EBS volumes with a specific volume configuration that will be associated with every instance in the instance group
EbsOptimized (boolean) --
Indicates whether an Amazon EBS volume is EBS-optimized.
Configurations (list) --
A configuration classification that applies when provisioning cluster instances, which can include configurations for applications and software that run on the cluster.
(dict) --
Note
Amazon EMR releases 4.x or later.
An optional configuration specification to be used when provisioning cluster instances, which can include configurations for applications and software bundled with Amazon EMR. A configuration consists of a classification, properties, and optional nested configurations. A classification refers to an application-specific configuration file. Properties are the settings you want to change in that file. For more information, see Configuring Applications .
Classification (string) --
The classification within a configuration.
Configurations (list) --
A list of additional configurations to apply within a configuration object.
Properties (dict) --
A set of properties specified within a configuration classification.
(string) --
(string) --
LaunchSpecifications (dict) --
The launch specification for the instance fleet.
SpotSpecification (dict) -- [REQUIRED]
The launch specification for Spot instances in the fleet, which determines the defined duration and provisioning timeout behavior.
TimeoutDurationMinutes (integer) -- [REQUIRED]
The spot provisioning timeout period in minutes. If Spot instances are not provisioned within this time period, the TimeOutAction is taken. Minimum value is 5 and maximum value is 1440. The timeout applies only during initial provisioning, when the cluster is first created.
TimeoutAction (string) -- [REQUIRED]
The action to take when TargetSpotCapacity has not been fulfilled when the TimeoutDurationMinutes has expired. Spot instances are not uprovisioned within the Spot provisioining timeout. Valid values are TERMINATE_CLUSTER and SWITCH_TO_ON_DEMAND to fulfill the remaining capacity.
BlockDurationMinutes (integer) --
The defined duration for Spot instances (also known as Spot blocks) in minutes. When specified, the Spot instance does not terminate before the defined duration expires, and defined duration pricing for Spot instances applies. Valid values are 60, 120, 180, 240, 300, or 360. The duration period starts as soon as a Spot instance receives its instance ID. At the end of the duration, Amazon EC2 marks the Spot instance for termination and provides a Spot instance termination notice, which gives the instance a two-minute warning before it terminates.
dict
Response Syntax
{
'ClusterId': 'string',
'InstanceFleetId': 'string'
}
Response Structure
(dict) --
ClusterId (string) --
The unique identifier of the cluster.
InstanceFleetId (string) --
The unique identifier of the instance fleet.
Modifies the target On-Demand and target Spot capacities for the instance fleet with the specified InstanceFleetID within the cluster specified using ClusterID. The call either succeeds or fails atomically.
Note
The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.
See also: AWS API Documentation
Request Syntax
client.modify_instance_fleet(
ClusterId='string',
InstanceFleet={
'InstanceFleetId': 'string',
'TargetOnDemandCapacity': 123,
'TargetSpotCapacity': 123
}
)
string
[REQUIRED]
The unique identifier of the cluster.
dict
[REQUIRED]
The unique identifier of the instance fleet.
InstanceFleetId (string) -- [REQUIRED]
A unique identifier for the instance fleet.
TargetOnDemandCapacity (integer) --
The target capacity of On-Demand units for the instance fleet. For more information see InstanceFleetConfig$TargetOnDemandCapacity .
TargetSpotCapacity (integer) --
The target capacity of Spot units for the instance fleet. For more information, see InstanceFleetConfig$TargetSpotCapacity .
None
Lists all available details about the instance fleets in a cluster.
Note
The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.
See also: AWS API Documentation
Request Syntax
client.list_instance_fleets(
ClusterId='string',
Marker='string'
)
string
[REQUIRED]
The unique identifier of the cluster.
string
The pagination token that indicates the next set of results to retrieve.
dict
Response Syntax
{
'InstanceFleets': [
{
'Id': 'string',
'Name': 'string',
'Status': {
'State': 'PROVISIONING'|'BOOTSTRAPPING'|'RUNNING'|'RESIZING'|'SUSPENDED'|'TERMINATING'|'TERMINATED',
'StateChangeReason': {
'Code': 'INTERNAL_ERROR'|'VALIDATION_ERROR'|'INSTANCE_FAILURE'|'CLUSTER_TERMINATED',
'Message': 'string'
},
'Timeline': {
'CreationDateTime': datetime(2015, 1, 1),
'ReadyDateTime': datetime(2015, 1, 1),
'EndDateTime': datetime(2015, 1, 1)
}
},
'InstanceFleetType': 'MASTER'|'CORE'|'TASK',
'TargetOnDemandCapacity': 123,
'TargetSpotCapacity': 123,
'ProvisionedOnDemandCapacity': 123,
'ProvisionedSpotCapacity': 123,
'InstanceTypeSpecifications': [
{
'InstanceType': 'string',
'WeightedCapacity': 123,
'BidPrice': 'string',
'BidPriceAsPercentageOfOnDemandPrice': 123.0,
'Configurations': [
{
'Classification': 'string',
'Configurations': {'... recursive ...'},
'Properties': {
'string': 'string'
}
},
],
'EbsBlockDevices': [
{
'VolumeSpecification': {
'VolumeType': 'string',
'Iops': 123,
'SizeInGB': 123
},
'Device': 'string'
},
],
'EbsOptimized': True|False
},
],
'LaunchSpecifications': {
'SpotSpecification': {
'TimeoutDurationMinutes': 123,
'TimeoutAction': 'SWITCH_TO_ON_DEMAND'|'TERMINATE_CLUSTER',
'BlockDurationMinutes': 123
}
}
},
],
'Marker': 'string'
}
Response Structure
(dict) --
InstanceFleets (list) --
The list of instance fleets for the cluster and given filters.
(dict) --
Describes an instance fleet, which is a group of EC2 instances that host a particular node type (master, core, or task) in an Amazon EMR cluster. Instance fleets can consist of a mix of instance types and On-Demand and Spot instances, which are provisioned to meet a defined target capacity.
Note
The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.
Id (string) --
The unique identifier of the instance fleet.
Name (string) --
A friendly name for the instance fleet.
Status (dict) --
The current status of the instance fleet.
State (string) --
A code representing the instance fleet status.
StateChangeReason (dict) --
Provides status change reason details for the instance fleet.
Code (string) --
A code corresponding to the reason the state change occurred.
Message (string) --
An explanatory message.
Timeline (dict) --
Provides historical timestamps for the instance fleet, including the time of creation, the time it became ready to run jobs, and the time of termination.
CreationDateTime (datetime) --
The time and date the instance fleet was created.
ReadyDateTime (datetime) --
The time and date the instance fleet was ready to run jobs.
EndDateTime (datetime) --
The time and date the instance fleet terminated.
InstanceFleetType (string) --
The node type that the instance fleet hosts. Valid values are MASTER, CORE, or TASK.
TargetOnDemandCapacity (integer) --
The target capacity of On-Demand units for the instance fleet, which determines how many On-Demand instances to provision. When the instance fleet launches, Amazon EMR tries to provision On-Demand instances as specified by InstanceTypeConfig . Each instance configuration has a specified WeightedCapacity . When an On-Demand instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units. You can use InstanceFleet$ProvisionedOnDemandCapacity to determine the Spot capacity units that have been provisioned for the instance fleet.
Note
If not specified or set to 0, only Spot instances are provisioned for the instance fleet using TargetSpotCapacity . At least one of TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1.
TargetSpotCapacity (integer) --
The target capacity of Spot units for the instance fleet, which determines how many Spot instances to provision. When the instance fleet launches, Amazon EMR tries to provision Spot instances as specified by InstanceTypeConfig . Each instance configuration has a specified WeightedCapacity . When a Spot instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units. You can use InstanceFleet$ProvisionedSpotCapacity to determine the Spot capacity units that have been provisioned for the instance fleet.
Note
If not specified or set to 0, only On-Demand instances are provisioned for the instance fleet. At least one of TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1.
ProvisionedOnDemandCapacity (integer) --
The number of On-Demand units that have been provisioned for the instance fleet to fulfill TargetOnDemandCapacity . This provisioned capacity might be less than or greater than TargetOnDemandCapacity .
ProvisionedSpotCapacity (integer) --
The number of Spot units that have been provisioned for this instance fleet to fulfill TargetSpotCapacity . This provisioned capacity might be less than or greater than TargetSpotCapacity .
InstanceTypeSpecifications (list) --
The specification for the instance types that comprise an instance fleet. Up to five unique instance specifications may be defined for each instance fleet.
(dict) --
The configuration specification for each instance type in an instance fleet.
Note
The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.
InstanceType (string) --
The EC2 instance type, for example m3.xlarge .
WeightedCapacity (integer) --
The number of units that a provisioned instance of this type provides toward fulfilling the target capacities defined in InstanceFleetConfig . Capacity values represent performance characteristics such as vCPUs, memory, or I/O. If not specified, the default value is 1.
BidPrice (string) --
The bid price for each EC2 Spot instance type as defined by InstanceType . Expressed in USD.
BidPriceAsPercentageOfOnDemandPrice (float) --
The bid price, as a percentage of On-Demand price, for each EC2 Spot instance as defined by InstanceType . Expressed as a number (for example, 20 specifies 20%).
Configurations (list) --
A configuration classification that applies when provisioning cluster instances, which can include configurations for applications and software bundled with Amazon EMR.
(dict) --
Note
Amazon EMR releases 4.x or later.
An optional configuration specification to be used when provisioning cluster instances, which can include configurations for applications and software bundled with Amazon EMR. A configuration consists of a classification, properties, and optional nested configurations. A classification refers to an application-specific configuration file. Properties are the settings you want to change in that file. For more information, see Configuring Applications .
Classification (string) --
The classification within a configuration.
Configurations (list) --
A list of additional configurations to apply within a configuration object.
Properties (dict) --
A set of properties specified within a configuration classification.
(string) --
(string) --
EbsBlockDevices (list) --
The configuration of Amazon Elastic Block Storage (EBS) attached to each instance as defined by InstanceType .
(dict) --
Configuration of requested EBS block device associated with the instance group.
VolumeSpecification (dict) --
EBS volume specifications such as volume type, IOPS, and size (GiB) that will be requested for the EBS volume attached to an EC2 instance in the cluster.
VolumeType (string) --
The volume type. Volume types supported are gp2, io1, standard.
Iops (integer) --
The number of I/O operations per second (IOPS) that the volume supports.
SizeInGB (integer) --
The volume size, in gibibytes (GiB). This can be a number from 1 - 1024. If the volume type is EBS-optimized, the minimum value is 10.
Device (string) --
The device name that is exposed to the instance, such as /dev/sdh.
EbsOptimized (boolean) --
Evaluates to TRUE when the specified InstanceType is EBS-optimized.
LaunchSpecifications (dict) --
Describes the launch specification for an instance fleet.
SpotSpecification (dict) --
The launch specification for Spot instances in the fleet, which determines the defined duration and provisioning timeout behavior.
TimeoutDurationMinutes (integer) --
The spot provisioning timeout period in minutes. If Spot instances are not provisioned within this time period, the TimeOutAction is taken. Minimum value is 5 and maximum value is 1440. The timeout applies only during initial provisioning, when the cluster is first created.
TimeoutAction (string) --
The action to take when TargetSpotCapacity has not been fulfilled when the TimeoutDurationMinutes has expired. Spot instances are not uprovisioned within the Spot provisioining timeout. Valid values are TERMINATE_CLUSTER and SWITCH_TO_ON_DEMAND to fulfill the remaining capacity.
BlockDurationMinutes (integer) --
The defined duration for Spot instances (also known as Spot blocks) in minutes. When specified, the Spot instance does not terminate before the defined duration expires, and defined duration pricing for Spot instances applies. Valid values are 60, 120, 180, 240, 300, or 360. The duration period starts as soon as a Spot instance receives its instance ID. At the end of the duration, Amazon EC2 marks the Spot instance for termination and provides a Spot instance termination notice, which gives the instance a two-minute warning before it terminates.
Marker (string) --
The pagination token that indicates the next set of results to retrieve.
{'Cluster': {'Ec2InstanceAttributes': {'RequestedEc2AvailabilityZones': ['string'],
'RequestedEc2SubnetIds': ['string']},
'InstanceCollectionType': 'INSTANCE_FLEET | INSTANCE_GROUP'}}
Provides cluster-level details including status, hardware and software configuration, VPC settings, and so on. For information about the cluster steps, see ListSteps .
See also: AWS API Documentation
Request Syntax
client.describe_cluster(
ClusterId='string'
)
string
[REQUIRED]
The identifier of the cluster to describe.
dict
Response Syntax
{
'Cluster': {
'Id': 'string',
'Name': 'string',
'Status': {
'State': 'STARTING'|'BOOTSTRAPPING'|'RUNNING'|'WAITING'|'TERMINATING'|'TERMINATED'|'TERMINATED_WITH_ERRORS',
'StateChangeReason': {
'Code': 'INTERNAL_ERROR'|'VALIDATION_ERROR'|'INSTANCE_FAILURE'|'BOOTSTRAP_FAILURE'|'USER_REQUEST'|'STEP_FAILURE'|'ALL_STEPS_COMPLETED',
'Message': 'string'
},
'Timeline': {
'CreationDateTime': datetime(2015, 1, 1),
'ReadyDateTime': datetime(2015, 1, 1),
'EndDateTime': datetime(2015, 1, 1)
}
},
'Ec2InstanceAttributes': {
'Ec2KeyName': 'string',
'Ec2SubnetId': 'string',
'RequestedEc2SubnetIds': [
'string',
],
'Ec2AvailabilityZone': 'string',
'RequestedEc2AvailabilityZones': [
'string',
],
'IamInstanceProfile': 'string',
'EmrManagedMasterSecurityGroup': 'string',
'EmrManagedSlaveSecurityGroup': 'string',
'ServiceAccessSecurityGroup': 'string',
'AdditionalMasterSecurityGroups': [
'string',
],
'AdditionalSlaveSecurityGroups': [
'string',
]
},
'InstanceCollectionType': 'INSTANCE_FLEET'|'INSTANCE_GROUP',
'LogUri': 'string',
'RequestedAmiVersion': 'string',
'RunningAmiVersion': 'string',
'ReleaseLabel': 'string',
'AutoTerminate': True|False,
'TerminationProtected': True|False,
'VisibleToAllUsers': True|False,
'Applications': [
{
'Name': 'string',
'Version': 'string',
'Args': [
'string',
],
'AdditionalInfo': {
'string': 'string'
}
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ServiceRole': 'string',
'NormalizedInstanceHours': 123,
'MasterPublicDnsName': 'string',
'Configurations': [
{
'Classification': 'string',
'Configurations': {'... recursive ...'},
'Properties': {
'string': 'string'
}
},
],
'SecurityConfiguration': 'string',
'AutoScalingRole': 'string',
'ScaleDownBehavior': 'TERMINATE_AT_INSTANCE_HOUR'|'TERMINATE_AT_TASK_COMPLETION'
}
}
Response Structure
(dict) --
This output contains the description of the cluster.
Cluster (dict) --
This output contains the details for the requested cluster.
Id (string) --
The unique identifier for the cluster.
Name (string) --
The name of the cluster.
Status (dict) --
The current status details about the cluster.
State (string) --
The current state of the cluster.
StateChangeReason (dict) --
The reason for the cluster status change.
Code (string) --
The programmatic code for the state change reason.
Message (string) --
The descriptive message for the state change reason.
Timeline (dict) --
A timeline that represents the status of a cluster over the lifetime of the cluster.
CreationDateTime (datetime) --
The creation date and time of the cluster.
ReadyDateTime (datetime) --
The date and time when the cluster was ready to execute steps.
EndDateTime (datetime) --
The date and time when the cluster was terminated.
Ec2InstanceAttributes (dict) --
Provides information about the EC2 instances in a cluster grouped by category. For example, key name, subnet ID, IAM instance profile, and so on.
Ec2KeyName (string) --
The name of the Amazon EC2 key pair to use when connecting with SSH into the master node as a user named "hadoop".
Ec2SubnetId (string) --
To launch the cluster in Amazon VPC, set this parameter to the identifier of the Amazon VPC subnet where you want the cluster to launch. If you do not specify this value, the cluster 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 cluster launched in a VPC.
RequestedEc2SubnetIds (list) --
Applies to clusters configured with the instance fleets option. Specifies the unique identifier of one or more Amazon EC2 subnets in which to launch EC2 cluster instances. Amazon EMR chooses the EC2 subnet with the best performance and cost characteristics from among the list of RequestedEc2SubnetIds and launches all cluster instances within that subnet. If this value is not specified, and the account supports EC2-Classic networks, the cluster launches instances in the EC2-Classic network and uses Requested
(string) --
Ec2AvailabilityZone (string) --
The Availability Zone in which the cluster will run.
RequestedEc2AvailabilityZones (list) --
Applies to clusters configured with the The list of availability zones to choose from. The service will choose the availability zone with the best mix of available capacity and lowest cost to launch the cluster. If you do not specify this value, the cluster is launched in any availability zone that the customer account has access to.
(string) --
IamInstanceProfile (string) --
The IAM role that was specified when the cluster was launched. The EC2 instances of the cluster assume this role.
EmrManagedMasterSecurityGroup (string) --
The identifier of the Amazon EC2 security group for the master node.
EmrManagedSlaveSecurityGroup (string) --
The identifier of the Amazon EC2 security group for the slave nodes.
ServiceAccessSecurityGroup (string) --
The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private subnets.
AdditionalMasterSecurityGroups (list) --
A list of additional Amazon EC2 security group IDs for the master node.
(string) --
AdditionalSlaveSecurityGroups (list) --
A list of additional Amazon EC2 security group IDs for the slave nodes.
(string) --
InstanceCollectionType (string) --
Note
The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.
The instance group configuration of the cluster. A value of INSTANCE_GROUP indicates a uniform instance group configuration. A value of INSTANCE_FLEET indicates an instance fleets configuration.
LogUri (string) --
The path to the Amazon S3 location where logs for this cluster are stored.
RequestedAmiVersion (string) --
The AMI version requested for this cluster.
RunningAmiVersion (string) --
The AMI version running on this cluster.
ReleaseLabel (string) --
The release label for the Amazon EMR release. For Amazon EMR 3.x and 2.x AMIs, use amiVersion instead instead of ReleaseLabel.
AutoTerminate (boolean) --
Specifies whether the cluster should terminate after completing all steps.
TerminationProtected (boolean) --
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.
VisibleToAllUsers (boolean) --
Indicates whether the cluster is visible to all IAM users of the AWS account associated with the cluster. If this value is set to true , all IAM users of that AWS account can view and manage the cluster 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.
Applications (list) --
The applications installed on this cluster.
(dict) --
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 Using 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 cluster using MapR M3 or M5 Edition, respectively.
Note
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.
Name (string) --
The name of the application.
Version (string) --
The version of the application.
Args (list) --
Arguments for Amazon EMR to pass to the application.
(string) --
AdditionalInfo (dict) --
This option is for advanced users only. This is meta information about third-party applications that third-party vendors use for testing purposes.
(string) --
(string) --
Tags (list) --
A list of tags associated with a cluster.
(dict) --
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 clusters to track your Amazon EMR resource allocation costs. For more information, see Tagging Amazon EMR Resources .
Key (string) --
A user-defined key, which is the minimum required information for a valid tag. For more information, see Tagging Amazon EMR Resources .
Value (string) --
A user-defined value, which is optional in a tag. For more information, see Tagging Amazon EMR Resources .
ServiceRole (string) --
The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.
NormalizedInstanceHours (integer) --
An approximation of the cost of the cluster, 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.
MasterPublicDnsName (string) --
The public DNS name of the master EC2 instance.
Configurations (list) --
Note
Amazon EMR releases 4.x or later.
The list of Configurations supplied to the EMR cluster.
(dict) --
Note
Amazon EMR releases 4.x or later.
An optional configuration specification to be used when provisioning cluster instances, which can include configurations for applications and software bundled with Amazon EMR. A configuration consists of a classification, properties, and optional nested configurations. A classification refers to an application-specific configuration file. Properties are the settings you want to change in that file. For more information, see Configuring Applications .
Classification (string) --
The classification within a configuration.
Configurations (list) --
A list of additional configurations to apply within a configuration object.
Properties (dict) --
A set of properties specified within a configuration classification.
(string) --
(string) --
SecurityConfiguration (string) --
The name of the security configuration applied to the cluster.
AutoScalingRole (string) --
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.
ScaleDownBehavior (string) --
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 is 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.
{'JobFlows': {'Instances': {'Placement': {'AvailabilityZones': ['string']}}}}
This API is deprecated and will eventually be removed. We recommend you use ListClusters , DescribeCluster , ListSteps , ListInstanceGroups and ListBootstrapActions instead.
DescribeJobFlows returns a list of job flows that match all of the supplied parameters. The parameters can include a list of job flow IDs, job flow states, and restrictions on job flow creation date and time.
Regardless of supplied parameters, only job flows created within the last two months are returned.
If no parameters are supplied, then job flows matching either of the following criteria are returned:
Job flows created and completed in the last two weeks
Job flows created within the last two months that are in one of the following states: RUNNING , WAITING , SHUTTING_DOWN , STARTING
Amazon EMR can return a maximum of 512 job flow descriptions.
!DANGER!
This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.
See also: AWS API Documentation
Request Syntax
client.describe_job_flows(
CreatedAfter=datetime(2015, 1, 1),
CreatedBefore=datetime(2015, 1, 1),
JobFlowIds=[
'string',
],
JobFlowStates=[
'STARTING'|'BOOTSTRAPPING'|'RUNNING'|'WAITING'|'SHUTTING_DOWN'|'TERMINATED'|'COMPLETED'|'FAILED',
]
)
datetime
Return only job flows created after this date and time.
datetime
Return only job flows created before this date and time.
list
Return only job flows whose job flow ID is contained in this list.
(string) --
list
Return only job flows whose state is contained in this list.
(string) --
The type of instance.
dict
Response Syntax
{
'JobFlows': [
{
'JobFlowId': 'string',
'Name': 'string',
'LogUri': 'string',
'AmiVersion': 'string',
'ExecutionStatusDetail': {
'State': 'STARTING'|'BOOTSTRAPPING'|'RUNNING'|'WAITING'|'SHUTTING_DOWN'|'TERMINATED'|'COMPLETED'|'FAILED',
'CreationDateTime': datetime(2015, 1, 1),
'StartDateTime': datetime(2015, 1, 1),
'ReadyDateTime': datetime(2015, 1, 1),
'EndDateTime': datetime(2015, 1, 1),
'LastStateChangeReason': 'string'
},
'Instances': {
'MasterInstanceType': 'string',
'MasterPublicDnsName': 'string',
'MasterInstanceId': 'string',
'SlaveInstanceType': 'string',
'InstanceCount': 123,
'InstanceGroups': [
{
'InstanceGroupId': 'string',
'Name': 'string',
'Market': 'ON_DEMAND'|'SPOT',
'InstanceRole': 'MASTER'|'CORE'|'TASK',
'BidPrice': 'string',
'InstanceType': 'string',
'InstanceRequestCount': 123,
'InstanceRunningCount': 123,
'State': 'PROVISIONING'|'BOOTSTRAPPING'|'RUNNING'|'RESIZING'|'SUSPENDED'|'TERMINATING'|'TERMINATED'|'ARRESTED'|'SHUTTING_DOWN'|'ENDED',
'LastStateChangeReason': 'string',
'CreationDateTime': datetime(2015, 1, 1),
'StartDateTime': datetime(2015, 1, 1),
'ReadyDateTime': datetime(2015, 1, 1),
'EndDateTime': datetime(2015, 1, 1)
},
],
'NormalizedInstanceHours': 123,
'Ec2KeyName': 'string',
'Ec2SubnetId': 'string',
'Placement': {
'AvailabilityZone': 'string',
'AvailabilityZones': [
'string',
]
},
'KeepJobFlowAliveWhenNoSteps': True|False,
'TerminationProtected': True|False,
'HadoopVersion': 'string'
},
'Steps': [
{
'StepConfig': {
'Name': 'string',
'ActionOnFailure': 'TERMINATE_JOB_FLOW'|'TERMINATE_CLUSTER'|'CANCEL_AND_WAIT'|'CONTINUE',
'HadoopJarStep': {
'Properties': [
{
'Key': 'string',
'Value': 'string'
},
],
'Jar': 'string',
'MainClass': 'string',
'Args': [
'string',
]
}
},
'ExecutionStatusDetail': {
'State': 'PENDING'|'RUNNING'|'CONTINUE'|'COMPLETED'|'CANCELLED'|'FAILED'|'INTERRUPTED',
'CreationDateTime': datetime(2015, 1, 1),
'StartDateTime': datetime(2015, 1, 1),
'EndDateTime': datetime(2015, 1, 1),
'LastStateChangeReason': 'string'
}
},
],
'BootstrapActions': [
{
'BootstrapActionConfig': {
'Name': 'string',
'ScriptBootstrapAction': {
'Path': 'string',
'Args': [
'string',
]
}
}
},
],
'SupportedProducts': [
'string',
],
'VisibleToAllUsers': True|False,
'JobFlowRole': 'string',
'ServiceRole': 'string',
'AutoScalingRole': 'string',
'ScaleDownBehavior': 'TERMINATE_AT_INSTANCE_HOUR'|'TERMINATE_AT_TASK_COMPLETION'
},
]
}
Response Structure
(dict) --
The output for the DescribeJobFlows operation.
JobFlows (list) --
A list of job flows matching the parameters supplied.
(dict) --
A description of a cluster (job flow).
JobFlowId (string) --
The job flow identifier.
Name (string) --
The name of the job flow.
LogUri (string) --
The location in Amazon S3 where log files for the job are stored.
AmiVersion (string) --
The version of the AMI used to initialize Amazon EC2 instances in the job flow. For a list of AMI versions currently supported by Amazon EMR, see AMI Versions Supported in EMR in the Amazon EMR Developer Guide.
ExecutionStatusDetail (dict) --
Describes the execution status of the job flow.
State (string) --
The state of the job flow.
CreationDateTime (datetime) --
The creation date and time of the job flow.
StartDateTime (datetime) --
The start date and time of the job flow.
ReadyDateTime (datetime) --
The date and time when the job flow was ready to start running bootstrap actions.
EndDateTime (datetime) --
The completion date and time of the job flow.
LastStateChangeReason (string) --
Description of the job flow last changed state.
Instances (dict) --
Describes the Amazon EC2 instances of the job flow.
MasterInstanceType (string) --
The Amazon EC2 master node instance type.
MasterPublicDnsName (string) --
The DNS name of the master node.
MasterInstanceId (string) --
The Amazon EC2 instance identifier of the master node.
SlaveInstanceType (string) --
The Amazon EC2 slave node instance type.
InstanceCount (integer) --
The number of Amazon EC2 instances in the cluster. If the value is 1, the same instance serves as both the master and slave node. If the value is greater than 1, one instance is the master node and all others are slave nodes.
InstanceGroups (list) --
Details about the instance groups in a cluster.
(dict) --
Detailed information about an instance group.
InstanceGroupId (string) --
Unique identifier for the instance group.
Name (string) --
Friendly name for the instance group.
Market (string) --
Market type of the EC2 instances used to create a cluster node.
InstanceRole (string) --
Instance group role in the cluster
BidPrice (string) --
Bid price for EC2 Instances when launching nodes as Spot Instances, expressed in USD.
InstanceType (string) --
EC2 instance type.
InstanceRequestCount (integer) --
Target number of instances to run in the instance group.
InstanceRunningCount (integer) --
Actual count of running instances.
State (string) --
State of instance group. The following values are deprecated: STARTING, TERMINATED, and FAILED.
LastStateChangeReason (string) --
Details regarding the state of the instance group.
CreationDateTime (datetime) --
The date/time the instance group was created.
StartDateTime (datetime) --
The date/time the instance group was started.
ReadyDateTime (datetime) --
The date/time the instance group was available to the cluster.
EndDateTime (datetime) --
The date/time the instance group was terminated.
NormalizedInstanceHours (integer) --
An approximation of the cost of the cluster, represented in m1.small/hours. This value is incremented one time for every hour that an m1.small runs. Larger instances are weighted more, so an Amazon 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.
Ec2KeyName (string) --
The name of an Amazon EC2 key pair that can be used to ssh to the master node.
Ec2SubnetId (string) --
For clusters launched within Amazon Virtual Private Cloud, this is the identifier of the subnet where the cluster was launched.
Placement (dict) --
The Amazon EC2 Availability Zone for the cluster.
AvailabilityZone (string) --
The Amazon EC2 Availability Zone for the cluster. AvailabilityZone is used for uniform instance groups, while AvailabilityZones (plural) is used for instance fleets.
AvailabilityZones (list) --
When multiple Availability Zones are specified, Amazon EMR evaluates them and launches instances in the optimal Availability Zone. AvailabilityZones is used for instance fleets, while AvailabilityZone (singular) is used for uniform instance groups.
Note
The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.
(string) --
KeepJobFlowAliveWhenNoSteps (boolean) --
Specifies whether the cluster should remain available after completing all steps.
TerminationProtected (boolean) --
Specifies whether the Amazon EC2 instances in the cluster are protected from termination by API calls, user intervention, or in the event of a job-flow error.
HadoopVersion (string) --
The Hadoop version for the cluster.
Steps (list) --
A list of steps run by the job flow.
(dict) --
Combines the execution state and configuration of a step.
StepConfig (dict) --
The step configuration.
Name (string) --
The name of the step.
ActionOnFailure (string) --
The action to take if the step fails.
HadoopJarStep (dict) --
The JAR file used for the step.
Properties (list) --
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.
(dict) --
A key value pair.
Key (string) --
The unique identifier of a key value pair.
Value (string) --
The value part of the identified key.
Jar (string) --
A path to a JAR file run during the step.
MainClass (string) --
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.
Args (list) --
A list of command line arguments passed to the JAR file's main function when executed.
(string) --
ExecutionStatusDetail (dict) --
The description of the step status.
State (string) --
The state of the step.
CreationDateTime (datetime) --
The creation date and time of the step.
StartDateTime (datetime) --
The start date and time of the step.
EndDateTime (datetime) --
The completion date and time of the step.
LastStateChangeReason (string) --
A description of the step's current state.
BootstrapActions (list) --
A list of the bootstrap actions run by the job flow.
(dict) --
Reports the configuration of a bootstrap action in a cluster (job flow).
BootstrapActionConfig (dict) --
A description of the bootstrap action.
Name (string) --
The name of the bootstrap action.
ScriptBootstrapAction (dict) --
The script run by the bootstrap action.
Path (string) --
Location of the script to run during a bootstrap action. Can be either a location in Amazon S3 or on a local file system.
Args (list) --
A list of command line arguments to pass to the bootstrap action script.
(string) --
SupportedProducts (list) --
A list of strings set by third party software when the job flow is launched. If you are not using third party software to manage the job flow this value is empty.
(string) --
VisibleToAllUsers (boolean) --
Specifies whether the cluster is visible to all IAM users of the AWS account associated with the cluster. 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 cluster. If it is set to false , only the IAM user that created the cluster can view and manage it. This value can be changed using the SetVisibleToAllUsers action.
JobFlowRole (string) --
The IAM role that was specified when the job flow was launched. The EC2 instances of the job flow assume this role.
ServiceRole (string) --
The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.
AutoScalingRole (string) --
An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole . The IAM role provides a way for the automatic scaling feature to get the required permissions it needs to launch and terminate EC2 instances in an instance group.
ScaleDownBehavior (string) --
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.
{'InstanceFleetId': 'string', 'InstanceFleetType': 'MASTER | CORE | TASK'}
Response {'Instances': {'InstanceFleetId': 'string',
'InstanceType': 'string',
'Market': 'ON_DEMAND | SPOT'}}
Provides information about the cluster instances that Amazon EMR provisions on behalf of a user when it creates the cluster. For example, this operation indicates when the EC2 instances reach the Ready state, when instances become available to Amazon EMR to use for jobs, and the IP addresses for cluster instances, etc.
See also: AWS API Documentation
Request Syntax
client.list_instances(
ClusterId='string',
InstanceGroupId='string',
InstanceGroupTypes=[
'MASTER'|'CORE'|'TASK',
],
InstanceFleetId='string',
InstanceFleetType='MASTER'|'CORE'|'TASK',
InstanceStates=[
'AWAITING_FULFILLMENT'|'PROVISIONING'|'BOOTSTRAPPING'|'RUNNING'|'TERMINATED',
],
Marker='string'
)
string
[REQUIRED]
The identifier of the cluster for which to list the instances.
string
The identifier of the instance group for which to list the instances.
list
The type of instance group for which to list the instances.
(string) --
string
The unique identifier of the instance fleet.
string
The node type of the instance fleet. For example MASTER, CORE, or TASK.
list
A list of instance states that will filter the instances returned with this request.
(string) --
string
The pagination token that indicates the next set of results to retrieve.
dict
Response Syntax
{
'Instances': [
{
'Id': 'string',
'Ec2InstanceId': 'string',
'PublicDnsName': 'string',
'PublicIpAddress': 'string',
'PrivateDnsName': 'string',
'PrivateIpAddress': 'string',
'Status': {
'State': 'AWAITING_FULFILLMENT'|'PROVISIONING'|'BOOTSTRAPPING'|'RUNNING'|'TERMINATED',
'StateChangeReason': {
'Code': 'INTERNAL_ERROR'|'VALIDATION_ERROR'|'INSTANCE_FAILURE'|'BOOTSTRAP_FAILURE'|'CLUSTER_TERMINATED',
'Message': 'string'
},
'Timeline': {
'CreationDateTime': datetime(2015, 1, 1),
'ReadyDateTime': datetime(2015, 1, 1),
'EndDateTime': datetime(2015, 1, 1)
}
},
'InstanceGroupId': 'string',
'InstanceFleetId': 'string',
'Market': 'ON_DEMAND'|'SPOT',
'InstanceType': 'string',
'EbsVolumes': [
{
'Device': 'string',
'VolumeId': 'string'
},
]
},
],
'Marker': 'string'
}
Response Structure
(dict) --
This output contains the list of instances.
Instances (list) --
The list of instances for the cluster and given filters.
(dict) --
Represents an EC2 instance provisioned as part of cluster.
Id (string) --
The unique identifier for the instance in Amazon EMR.
Ec2InstanceId (string) --
The unique identifier of the instance in Amazon EC2.
PublicDnsName (string) --
The public DNS name of the instance.
PublicIpAddress (string) --
The public IP address of the instance.
PrivateDnsName (string) --
The private DNS name of the instance.
PrivateIpAddress (string) --
The private IP address of the instance.
Status (dict) --
The current status of the instance.
State (string) --
The current state of the instance.
StateChangeReason (dict) --
The details of the status change reason for the instance.
Code (string) --
The programmable code for the state change reason.
Message (string) --
The status change reason description.
Timeline (dict) --
The timeline of the instance status over time.
CreationDateTime (datetime) --
The creation date and time of the instance.
ReadyDateTime (datetime) --
The date and time when the instance was ready to perform tasks.
EndDateTime (datetime) --
The date and time when the instance was terminated.
InstanceGroupId (string) --
The identifier of the instance group to which this instance belongs.
InstanceFleetId (string) --
The unique identifier of the instance fleet to which an EC2 instance belongs.
Market (string) --
The instance purchasing option. Valid values are ON_DEMAND or SPOT .
InstanceType (string) --
The EC2 instance type, for example m3.xlarge .
EbsVolumes (list) --
The list of EBS volumes that are attached to this instance.
(dict) --
EBS block device that's attached to an EC2 instance.
Device (string) --
The device name that is exposed to the instance, such as /dev/sdh.
VolumeId (string) --
The volume identifier of the EBS volume.
Marker (string) --
The pagination token that indicates the next set of results to retrieve.
{'Instances': {'Ec2SubnetIds': ['string'],
'InstanceFleets': [{'InstanceFleetType': 'MASTER | CORE | TASK',
'InstanceTypeConfigs': [{'BidPrice': 'string',
'BidPriceAsPercentageOfOnDemandPrice': 'double',
'Configurations': [{'Classification': 'string',
'Configurations': [],
'Properties': {'string': 'string'}}],
'EbsConfiguration': {'EbsBlockDeviceConfigs': [{'VolumeSpecification': {'Iops': 'integer',
'SizeInGB': 'integer',
'VolumeType': 'string'},
'VolumesPerInstance': 'integer'}],
'EbsOptimized': 'boolean'},
'InstanceType': 'string',
'WeightedCapacity': 'integer'}],
'LaunchSpecifications': {'SpotSpecification': {'BlockDurationMinutes': 'integer',
'TimeoutAction': 'SWITCH_TO_ON_DEMAND '
'| '
'TERMINATE_CLUSTER',
'TimeoutDurationMinutes': 'integer'}},
'Name': 'string',
'TargetOnDemandCapacity': 'integer',
'TargetSpotCapacity': 'integer'}],
'Placement': {'AvailabilityZones': ['string']}}}
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 more information on how to do this, see Add More than 256 Steps to a Cluster in the Amazon EMR Management Guide .
For long running clusters, we recommend that you periodically store your results.
Note
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.
See also: AWS API Documentation
Request Syntax
client.run_job_flow(
Name='string',
LogUri='string',
AdditionalInfo='string',
AmiVersion='string',
ReleaseLabel='string',
Instances={
'MasterInstanceType': 'string',
'SlaveInstanceType': 'string',
'InstanceCount': 123,
'InstanceGroups': [
{
'Name': 'string',
'Market': 'ON_DEMAND'|'SPOT',
'InstanceRole': 'MASTER'|'CORE'|'TASK',
'BidPrice': 'string',
'InstanceType': 'string',
'InstanceCount': 123,
'Configurations': [
{
'Classification': 'string',
'Configurations': {'... recursive ...'},
'Properties': {
'string': 'string'
}
},
],
'EbsConfiguration': {
'EbsBlockDeviceConfigs': [
{
'VolumeSpecification': {
'VolumeType': 'string',
'Iops': 123,
'SizeInGB': 123
},
'VolumesPerInstance': 123
},
],
'EbsOptimized': True|False
},
'AutoScalingPolicy': {
'Constraints': {
'MinCapacity': 123,
'MaxCapacity': 123
},
'Rules': [
{
'Name': 'string',
'Description': 'string',
'Action': {
'Market': 'ON_DEMAND'|'SPOT',
'SimpleScalingPolicyConfiguration': {
'AdjustmentType': 'CHANGE_IN_CAPACITY'|'PERCENT_CHANGE_IN_CAPACITY'|'EXACT_CAPACITY',
'ScalingAdjustment': 123,
'CoolDown': 123
}
},
'Trigger': {
'CloudWatchAlarmDefinition': {
'ComparisonOperator': 'GREATER_THAN_OR_EQUAL'|'GREATER_THAN'|'LESS_THAN'|'LESS_THAN_OR_EQUAL',
'EvaluationPeriods': 123,
'MetricName': 'string',
'Namespace': 'string',
'Period': 123,
'Statistic': 'SAMPLE_COUNT'|'AVERAGE'|'SUM'|'MINIMUM'|'MAXIMUM',
'Threshold': 123.0,
'Unit': 'NONE'|'SECONDS'|'MICRO_SECONDS'|'MILLI_SECONDS'|'BYTES'|'KILO_BYTES'|'MEGA_BYTES'|'GIGA_BYTES'|'TERA_BYTES'|'BITS'|'KILO_BITS'|'MEGA_BITS'|'GIGA_BITS'|'TERA_BITS'|'PERCENT'|'COUNT'|'BYTES_PER_SECOND'|'KILO_BYTES_PER_SECOND'|'MEGA_BYTES_PER_SECOND'|'GIGA_BYTES_PER_SECOND'|'TERA_BYTES_PER_SECOND'|'BITS_PER_SECOND'|'KILO_BITS_PER_SECOND'|'MEGA_BITS_PER_SECOND'|'GIGA_BITS_PER_SECOND'|'TERA_BITS_PER_SECOND'|'COUNT_PER_SECOND',
'Dimensions': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
},
]
}
},
],
'InstanceFleets': [
{
'Name': 'string',
'InstanceFleetType': 'MASTER'|'CORE'|'TASK',
'TargetOnDemandCapacity': 123,
'TargetSpotCapacity': 123,
'InstanceTypeConfigs': [
{
'InstanceType': 'string',
'WeightedCapacity': 123,
'BidPrice': 'string',
'BidPriceAsPercentageOfOnDemandPrice': 123.0,
'EbsConfiguration': {
'EbsBlockDeviceConfigs': [
{
'VolumeSpecification': {
'VolumeType': 'string',
'Iops': 123,
'SizeInGB': 123
},
'VolumesPerInstance': 123
},
],
'EbsOptimized': True|False
},
'Configurations': [
{
'Classification': 'string',
'Configurations': {'... recursive ...'},
'Properties': {
'string': 'string'
}
},
]
},
],
'LaunchSpecifications': {
'SpotSpecification': {
'TimeoutDurationMinutes': 123,
'TimeoutAction': 'SWITCH_TO_ON_DEMAND'|'TERMINATE_CLUSTER',
'BlockDurationMinutes': 123
}
}
},
],
'Ec2KeyName': 'string',
'Placement': {
'AvailabilityZone': 'string',
'AvailabilityZones': [
'string',
]
},
'KeepJobFlowAliveWhenNoSteps': True|False,
'TerminationProtected': True|False,
'HadoopVersion': 'string',
'Ec2SubnetId': 'string',
'Ec2SubnetIds': [
'string',
],
'EmrManagedMasterSecurityGroup': 'string',
'EmrManagedSlaveSecurityGroup': 'string',
'ServiceAccessSecurityGroup': 'string',
'AdditionalMasterSecurityGroups': [
'string',
],
'AdditionalSlaveSecurityGroups': [
'string',
]
},
Steps=[
{
'Name': 'string',
'ActionOnFailure': 'TERMINATE_JOB_FLOW'|'TERMINATE_CLUSTER'|'CANCEL_AND_WAIT'|'CONTINUE',
'HadoopJarStep': {
'Properties': [
{
'Key': 'string',
'Value': 'string'
},
],
'Jar': 'string',
'MainClass': 'string',
'Args': [
'string',
]
}
},
],
BootstrapActions=[
{
'Name': 'string',
'ScriptBootstrapAction': {
'Path': 'string',
'Args': [
'string',
]
}
},
],
SupportedProducts=[
'string',
],
NewSupportedProducts=[
{
'Name': 'string',
'Args': [
'string',
]
},
],
Applications=[
{
'Name': 'string',
'Version': 'string',
'Args': [
'string',
],
'AdditionalInfo': {
'string': 'string'
}
},
],
Configurations=[
{
'Classification': 'string',
'Configurations': {'... recursive ...'},
'Properties': {
'string': 'string'
}
},
],
VisibleToAllUsers=True|False,
JobFlowRole='string',
ServiceRole='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
SecurityConfiguration='string',
AutoScalingRole='string',
ScaleDownBehavior='TERMINATE_AT_INSTANCE_HOUR'|'TERMINATE_AT_TASK_COMPLETION'
)
string
[REQUIRED]
The name of the job flow.
string
The location in Amazon S3 to write the log files of the job flow. If a value is not provided, logs are not created.
string
A JSON string for selecting additional features.
string
Note
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, see AMI Versions Supported in Elastic MapReduce in the Amazon Elastic MapReduce Developer Guide.
Note
Previously, the EMR AMI version API parameter options allowed you to use latest for the latest AMI version rather than specify a numerical value. Some regions no longer support this deprecated option as they only have a newer release label version of EMR, which requires you to specify an EMR release label release (EMR 4.x or later).
string
Note
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.
dict
[REQUIRED]
A specification of the number and type of Amazon EC2 instances.
MasterInstanceType (string) --
The EC2 instance type of the master node.
SlaveInstanceType (string) --
The EC2 instance type of the slave nodes.
InstanceCount (integer) --
The number of EC2 instances in the cluster.
InstanceGroups (list) --
Configuration for the instance groups in a cluster.
(dict) --
Configuration defining a new instance group.
Name (string) --
Friendly name given to the instance group.
Market (string) --
Market type of the EC2 instances used to create a cluster node.
InstanceRole (string) -- [REQUIRED]
The role of the instance group in the cluster.
BidPrice (string) --
Bid price for each EC2 instance in the instance group when launching nodes as Spot Instances, expressed in USD.
InstanceType (string) -- [REQUIRED]
The EC2 instance type for all instances in the instance group.
InstanceCount (integer) -- [REQUIRED]
Target number of instances for the instance group.
Configurations (list) --
Note
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).
(dict) --
Note
Amazon EMR releases 4.x or later.
An optional configuration specification to be used when provisioning cluster instances, which can include configurations for applications and software bundled with Amazon EMR. A configuration consists of a classification, properties, and optional nested configurations. A classification refers to an application-specific configuration file. Properties are the settings you want to change in that file. For more information, see Configuring Applications .
Classification (string) --
The classification within a configuration.
Configurations (list) --
A list of additional configurations to apply within a configuration object.
Properties (dict) --
A set of properties specified within a configuration classification.
(string) --
(string) --
EbsConfiguration (dict) --
EBS configurations that will be attached to each EC2 instance in the instance group.
EbsBlockDeviceConfigs (list) --
An array of Amazon EBS volume specifications attached to a cluster instance.
(dict) --
Configuration of requested EBS block device associated with the instance group with count of volumes that will be associated to every instance.
VolumeSpecification (dict) -- [REQUIRED]
EBS volume specifications such as volume type, IOPS, and size (GiB) that will be requested for the EBS volume attached to an EC2 instance in the cluster.
VolumeType (string) -- [REQUIRED]
The volume type. Volume types supported are gp2, io1, standard.
Iops (integer) --
The number of I/O operations per second (IOPS) that the volume supports.
SizeInGB (integer) -- [REQUIRED]
The volume size, in gibibytes (GiB). This can be a number from 1 - 1024. If the volume type is EBS-optimized, the minimum value is 10.
VolumesPerInstance (integer) --
Number of EBS volumes with a specific volume configuration that will be associated with every instance in the instance group
EbsOptimized (boolean) --
Indicates whether an Amazon EBS volume is EBS-optimized.
AutoScalingPolicy (dict) --
An automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically adds and terminates EC2 instances in response to the value of a CloudWatch metric. See PutAutoScalingPolicy .
Constraints (dict) -- [REQUIRED]
The upper and lower EC2 instance limits for an automatic scaling policy. Automatic scaling activity will not cause an instance group to grow above or below these limits.
MinCapacity (integer) -- [REQUIRED]
The lower boundary of EC2 instances in an instance group below which scaling activities are not allowed to shrink. Scale-in activities will not terminate instances below this boundary.
MaxCapacity (integer) -- [REQUIRED]
The upper boundary of EC2 instances in an instance group beyond which scaling activities are not allowed to grow. Scale-out activities will not add instances beyond this boundary.
Rules (list) -- [REQUIRED]
The scale-in and scale-out rules that comprise the automatic scaling policy.
(dict) --
A scale-in or scale-out rule that defines scaling activity, including the CloudWatch metric alarm that triggers activity, how EC2 instances are added or removed, and the periodicity of adjustments. The automatic scaling policy for an instance group can comprise one or more automatic scaling rules.
Name (string) -- [REQUIRED]
The name used to identify an automatic scaling rule. Rule names must be unique within a scaling policy.
Description (string) --
A friendly, more verbose description of the automatic scaling rule.
Action (dict) -- [REQUIRED]
The conditions that trigger an automatic scaling activity.
Market (string) --
Not available for instance groups. Instance groups use the market type specified for the group.
SimpleScalingPolicyConfiguration (dict) -- [REQUIRED]
The type of adjustment the automatic scaling activity makes when triggered, and the periodicity of the adjustment.
AdjustmentType (string) --
The way in which EC2 instances are added (if ScalingAdjustment is a positive number) or terminated (if ScalingAdjustment is a negative number) each time the scaling activity is triggered. CHANGE_IN_CAPACITY is the default. CHANGE_IN_CAPACITY indicates that the EC2 instance count increments or decrements by ScalingAdjustment , which should be expressed as an integer. PERCENT_CHANGE_IN_CAPACITY indicates the instance count increments or decrements by the percentage specified by ScalingAdjustment , which should be expressed as a decimal. For example, 0.20 indicates an increase in 20% increments of cluster capacity. EXACT_CAPACITY indicates the scaling activity results in an instance group with the number of EC2 instances specified by ScalingAdjustment , which should be expressed as a positive integer.
ScalingAdjustment (integer) -- [REQUIRED]
The amount by which to scale in or scale out, based on the specified AdjustmentType . A positive value adds to the instance group's EC2 instance count while a negative number removes instances. If AdjustmentType is set to EXACT_CAPACITY , the number should only be a positive integer. If AdjustmentType is set to PERCENT_CHANGE_IN_CAPACITY , the value should express the percentage as a decimal. For example, -0.20 indicates a decrease in 20% increments of cluster capacity.
CoolDown (integer) --
The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling activities can start. The default value is 0.
Trigger (dict) -- [REQUIRED]
The CloudWatch alarm definition that determines when automatic scaling activity is triggered.
CloudWatchAlarmDefinition (dict) -- [REQUIRED]
The definition of a CloudWatch metric alarm. When the defined alarm conditions are met along with other trigger parameters, scaling activity begins.
ComparisonOperator (string) -- [REQUIRED]
Determines how the metric specified by MetricName is compared to the value specified by Threshold .
EvaluationPeriods (integer) --
The number of periods, expressed in seconds using Period , during which the alarm condition must exist before the alarm triggers automatic scaling activity. The default value is 1 .
MetricName (string) -- [REQUIRED]
The name of the CloudWatch metric that is watched to determine an alarm condition.
Namespace (string) --
The namespace for the CloudWatch metric. The default is AWS/ElasticMapReduce .
Period (integer) -- [REQUIRED]
The period, in seconds, over which the statistic is applied. EMR CloudWatch metrics are emitted every five minutes (300 seconds), so if an EMR CloudWatch metric is specified, specify 300 .
Statistic (string) --
The statistic to apply to the metric associated with the alarm. The default is AVERAGE .
Threshold (float) -- [REQUIRED]
The value against which the specified statistic is compared.
Unit (string) --
The unit of measure associated with the CloudWatch metric being watched. The value specified for Unit must correspond to the units specified in the CloudWatch metric.
Dimensions (list) --
A CloudWatch metric dimension.
(dict) --
A CloudWatch dimension, which is specified using a Key (known as a Name in CloudWatch), Value pair. By default, Amazon EMR uses one dimension whose Key is JobFlowID and Value is a variable representing the cluster ID, which is ${emr.clusterId} . This enables the rule to bootstrap when the cluster ID becomes available.
Key (string) --
The dimension name.
Value (string) --
The dimension value.
InstanceFleets (list) --
Note
The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.
Describes the EC2 instances and instance configurations for clusters that use the instance fleet configuration.
(dict) --
The configuration that defines an instance fleet.
Note
The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.
Name (string) --
The friendly name of the instance fleet.
InstanceFleetType (string) -- [REQUIRED]
The node type that the instance fleet hosts. Valid values are MASTER,CORE,and TASK.
TargetOnDemandCapacity (integer) --
The target capacity of On-Demand units for the instance fleet, which determines how many On-Demand instances to provision. When the instance fleet launches, Amazon EMR tries to provision On-Demand instances as specified by InstanceTypeConfig . Each instance configuration has a specified WeightedCapacity . When an On-Demand instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units.
Note
If not specified or set to 0, only Spot instances are provisioned for the instance fleet using TargetSpotCapacity . At least one of TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1.
TargetSpotCapacity (integer) --
The target capacity of Spot units for the instance fleet, which determines how many Spot instances to provision. When the instance fleet launches, Amazon EMR tries to provision Spot instances as specified by InstanceTypeConfig . Each instance configuration has a specified WeightedCapacity . When a Spot instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units.
Note
If not specified or set to 0, only On-Demand instances are provisioned for the instance fleet. At least one of TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1.
InstanceTypeConfigs (list) --
The instance type configurations that define the EC2 instances in the instance fleet.
(dict) --
An instance type configuration for each instance type in an instance fleet, which determines the EC2 instances Amazon EMR attempts to provision to fulfill On-Demand and Spot target capacities. There can be a maximum of 5 instance type configurations in a fleet.
Note
The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.
InstanceType (string) -- [REQUIRED]
An EC2 instance type, such as m3.xlarge .
WeightedCapacity (integer) --
The number of units that a provisioned instance of this type provides toward fulfilling the target capacities defined in InstanceFleetConfig . This value is 1 for a master instance fleet, and must be greater than 0 for core and task instance fleets.
BidPrice (string) --
The bid price for each EC2 Spot instance type as defined by InstanceType . Expressed in USD. If neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is provided, BidPriceAsPercentageOfOnDemandPrice defaults to 100%.
BidPriceAsPercentageOfOnDemandPrice (float) --
The bid price, as a percentage of On-Demand price, for each EC2 Spot instance as defined by InstanceType . Expressed as a number between 0 and 1000 (for example, 20 specifies 20%). If neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is provided, BidPriceAsPercentageOfOnDemandPrice defaults to 100%.
EbsConfiguration (dict) --
The configuration of Amazon Elastic Block Storage (EBS) attached to each instance as defined by InstanceType .
EbsBlockDeviceConfigs (list) --
An array of Amazon EBS volume specifications attached to a cluster instance.
(dict) --
Configuration of requested EBS block device associated with the instance group with count of volumes that will be associated to every instance.
VolumeSpecification (dict) -- [REQUIRED]
EBS volume specifications such as volume type, IOPS, and size (GiB) that will be requested for the EBS volume attached to an EC2 instance in the cluster.
VolumeType (string) -- [REQUIRED]
The volume type. Volume types supported are gp2, io1, standard.
Iops (integer) --
The number of I/O operations per second (IOPS) that the volume supports.
SizeInGB (integer) -- [REQUIRED]
The volume size, in gibibytes (GiB). This can be a number from 1 - 1024. If the volume type is EBS-optimized, the minimum value is 10.
VolumesPerInstance (integer) --
Number of EBS volumes with a specific volume configuration that will be associated with every instance in the instance group
EbsOptimized (boolean) --
Indicates whether an Amazon EBS volume is EBS-optimized.
Configurations (list) --
A configuration classification that applies when provisioning cluster instances, which can include configurations for applications and software that run on the cluster.
(dict) --
Note
Amazon EMR releases 4.x or later.
An optional configuration specification to be used when provisioning cluster instances, which can include configurations for applications and software bundled with Amazon EMR. A configuration consists of a classification, properties, and optional nested configurations. A classification refers to an application-specific configuration file. Properties are the settings you want to change in that file. For more information, see Configuring Applications .
Classification (string) --
The classification within a configuration.
Configurations (list) --
A list of additional configurations to apply within a configuration object.
Properties (dict) --
A set of properties specified within a configuration classification.
(string) --
(string) --
LaunchSpecifications (dict) --
The launch specification for the instance fleet.
SpotSpecification (dict) -- [REQUIRED]
The launch specification for Spot instances in the fleet, which determines the defined duration and provisioning timeout behavior.
TimeoutDurationMinutes (integer) -- [REQUIRED]
The spot provisioning timeout period in minutes. If Spot instances are not provisioned within this time period, the TimeOutAction is taken. Minimum value is 5 and maximum value is 1440. The timeout applies only during initial provisioning, when the cluster is first created.
TimeoutAction (string) -- [REQUIRED]
The action to take when TargetSpotCapacity has not been fulfilled when the TimeoutDurationMinutes has expired. Spot instances are not uprovisioned within the Spot provisioining timeout. Valid values are TERMINATE_CLUSTER and SWITCH_TO_ON_DEMAND to fulfill the remaining capacity.
BlockDurationMinutes (integer) --
The defined duration for Spot instances (also known as Spot blocks) in minutes. When specified, the Spot instance does not terminate before the defined duration expires, and defined duration pricing for Spot instances applies. Valid values are 60, 120, 180, 240, 300, or 360. The duration period starts as soon as a Spot instance receives its instance ID. At the end of the duration, Amazon EC2 marks the Spot instance for termination and provides a Spot instance termination notice, which gives the instance a two-minute warning before it terminates.
Ec2KeyName (string) --
The name of the EC2 key pair that can be used to ssh to the master node as the user called "hadoop."
Placement (dict) --
The Availability Zone in which the cluster runs.
AvailabilityZone (string) --
The Amazon EC2 Availability Zone for the cluster. AvailabilityZone is used for uniform instance groups, while AvailabilityZones (plural) is used for instance fleets.
AvailabilityZones (list) --
When multiple Availability Zones are specified, Amazon EMR evaluates them and launches instances in the optimal Availability Zone. AvailabilityZones is used for instance fleets, while AvailabilityZone (singular) is used for uniform instance groups.
Note
The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.
(string) --
KeepJobFlowAliveWhenNoSteps (boolean) --
Specifies whether the cluster should remain available after completing all steps.
TerminationProtected (boolean) --
Specifies whether to lock the cluster to prevent the Amazon EC2 instances from being terminated by API call, user intervention, or in the event of a job-flow error.
HadoopVersion (string) --
The Hadoop version for the cluster. 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.
Ec2SubnetId (string) --
Applies to clusters that use the uniform instance group configuration. To launch the cluster in Amazon Virtual Private Cloud (Amazon VPC), set this parameter to the identifier of the Amazon VPC subnet where you want the cluster to launch. If you do not specify this value, the cluster launches in the normal Amazon Web Services cloud, outside of an Amazon VPC, if the account launching the cluster supports EC2 Classic networks in the region where the cluster launches.
Amazon VPC currently does not support cluster compute quadruple extra large (cc1.4xlarge) instances. Thus you cannot specify the cc1.4xlarge instance type for clusters launched in an Amazon VPC.
Ec2SubnetIds (list) --
Applies to clusters that use the instance fleet configuration. When multiple EC2 subnet IDs are specified, Amazon EMR evaluates them and launches instances in the optimal subnet.
Note
The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.
(string) --
EmrManagedMasterSecurityGroup (string) --
The identifier of the Amazon EC2 security group for the master node.
EmrManagedSlaveSecurityGroup (string) --
The identifier of the Amazon EC2 security group for the slave nodes.
ServiceAccessSecurityGroup (string) --
The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private subnets.
AdditionalMasterSecurityGroups (list) --
A list of additional Amazon EC2 security group IDs for the master node.
(string) --
AdditionalSlaveSecurityGroups (list) --
A list of additional Amazon EC2 security group IDs for the slave nodes.
(string) --
list
A list of steps to run.
(dict) --
Specification of a cluster (job flow) step.
Name (string) -- [REQUIRED]
The name of the step.
ActionOnFailure (string) --
The action to take if the step fails.
HadoopJarStep (dict) -- [REQUIRED]
The JAR file used for the step.
Properties (list) --
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.
(dict) --
A key value pair.
Key (string) --
The unique identifier of a key value pair.
Value (string) --
The value part of the identified key.
Jar (string) -- [REQUIRED]
A path to a JAR file run during the step.
MainClass (string) --
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.
Args (list) --
A list of command line arguments passed to the JAR file's main function when executed.
(string) --
list
A list of bootstrap actions to run before Hadoop starts on the cluster nodes.
(dict) --
Configuration of a bootstrap action.
Name (string) -- [REQUIRED]
The name of the bootstrap action.
ScriptBootstrapAction (dict) -- [REQUIRED]
The script run by the bootstrap action.
Path (string) -- [REQUIRED]
Location of the script to run during a bootstrap action. Can be either a location in Amazon S3 or on a local file system.
Args (list) --
A list of command line arguments to pass to the bootstrap action script.
(string) --
list
Note
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. 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.
(string) --
list
Note
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" 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 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.
(dict) --
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.
Name (string) --
The name of the product configuration.
Args (list) --
The list of user-supplied arguments.
(string) --
list
Note
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.
(dict) --
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 Using 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 cluster using MapR M3 or M5 Edition, respectively.
Note
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.
Name (string) --
The name of the application.
Version (string) --
The version of the application.
Args (list) --
Arguments for Amazon EMR to pass to the application.
(string) --
AdditionalInfo (dict) --
This option is for advanced users only. This is meta information about third-party applications that third-party vendors use for testing purposes.
(string) --
(string) --
list
Note
Amazon EMR releases 4.x or later.
The list of configurations supplied for the EMR cluster you are creating.
(dict) --
Note
Amazon EMR releases 4.x or later.
An optional configuration specification to be used when provisioning cluster instances, which can include configurations for applications and software bundled with Amazon EMR. A configuration consists of a classification, properties, and optional nested configurations. A classification refers to an application-specific configuration file. Properties are the settings you want to change in that file. For more information, see Configuring Applications .
Classification (string) --
The classification within a configuration.
Configurations (list) --
A list of additional configurations to apply within a configuration object.
Properties (dict) --
A set of properties specified within a configuration classification.
(string) --
(string) --
boolean
Whether the cluster is visible to all IAM users of the AWS account associated with the cluster. 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 cluster. If it is set to false , only the IAM user that created the cluster can view and manage it.
string
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.
string
The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.
list
A list of tags to associate with a cluster and propagate to Amazon EC2 instances.
(dict) --
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 clusters to track your Amazon EMR resource allocation costs. For more information, see Tagging Amazon EMR Resources .
Key (string) --
A user-defined key, which is the minimum required information for a valid tag. For more information, see Tagging Amazon EMR Resources .
Value (string) --
A user-defined value, which is optional in a tag. For more information, see Tagging Amazon EMR Resources .
string
The name of a security configuration to apply to the cluster.
string
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.
string
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.
dict
Response Syntax
{
'JobFlowId': 'string'
}
Response Structure
(dict) --
The result of the RunJobFlow operation.
JobFlowId (string) --
An unique identifier for the job flow.