2019/04/01 - Amazon Elastic MapReduce - 3 updated api methods
Changes Amazon EMR adds the ability to modify instance group configurations on a running cluster through the new "configurations" field in the ModifyInstanceGroups API.
{'JobFlows': {'Instances': {'InstanceGroups': {'State': {'RECONFIGURING'}}}}}
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'|'RECONFIGURING'|'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) --
Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 and later, ReleaseLabel is used. To specify a custom AMI, use CustomAmiID .
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. If the cluster is on a private subnet, this is the private DNS name. On a public subnet, this is the public DNS name.
MasterInstanceId (string) --
The Amazon EC2 instance identifier of the master node.
SlaveInstanceType (string) --
The Amazon EC2 core and task 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 core and task node. If the value is greater than 1, one instance is the master node and all others are core and task 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) --
The maximum Spot price your are willing to pay for EC2 instances.
An optional, nullable field that applies if the MarketType for the instance group is specified as SPOT . Specified in USD. If the value is NULL and SPOT is specified, the maximum Spot price is set equal to the On-Demand price.
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 when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE. TERMINATE_JOB_FLOW is provided for backward compatibility. We recommend using TERMINATE_CLUSTER instead.
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.
{'InstanceGroups': {'ConfigurationsVersion': 'long',
'LastSuccessfullyAppliedConfigurations': [{'Classification': 'string',
'Configurations': (),
'Properties': {'string': 'string'}}],
'LastSuccessfullyAppliedConfigurationsVersion': 'long',
'Status': {'State': {'RECONFIGURING'}}}}
Provides all available details about the instance groups in a cluster.
See also: AWS API Documentation
Request Syntax
client.list_instance_groups(
ClusterId='string',
Marker='string'
)
string
[REQUIRED]
The identifier of the cluster for which to list the instance groups.
string
The pagination token that indicates the next set of results to retrieve.
dict
Response Syntax
{
'InstanceGroups': [
{
'Id': 'string',
'Name': 'string',
'Market': 'ON_DEMAND'|'SPOT',
'InstanceGroupType': 'MASTER'|'CORE'|'TASK',
'BidPrice': 'string',
'InstanceType': 'string',
'RequestedInstanceCount': 123,
'RunningInstanceCount': 123,
'Status': {
'State': 'PROVISIONING'|'BOOTSTRAPPING'|'RUNNING'|'RECONFIGURING'|'RESIZING'|'SUSPENDED'|'TERMINATING'|'TERMINATED'|'ARRESTED'|'SHUTTING_DOWN'|'ENDED',
'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)
}
},
'Configurations': [
{
'Classification': 'string',
'Configurations': {'... recursive ...'},
'Properties': {
'string': 'string'
}
},
],
'ConfigurationsVersion': 123,
'LastSuccessfullyAppliedConfigurations': [
{
'Classification': 'string',
'Configurations': {'... recursive ...'},
'Properties': {
'string': 'string'
}
},
],
'LastSuccessfullyAppliedConfigurationsVersion': 123,
'EbsBlockDevices': [
{
'VolumeSpecification': {
'VolumeType': 'string',
'Iops': 123,
'SizeInGB': 123
},
'Device': 'string'
},
],
'EbsOptimized': True|False,
'ShrinkPolicy': {
'DecommissionTimeout': 123,
'InstanceResizePolicy': {
'InstancesToTerminate': [
'string',
],
'InstancesToProtect': [
'string',
],
'InstanceTerminationTimeout': 123
}
},
'AutoScalingPolicy': {
'Status': {
'State': 'PENDING'|'ATTACHING'|'ATTACHED'|'DETACHING'|'DETACHED'|'FAILED',
'StateChangeReason': {
'Code': 'USER_REQUEST'|'PROVISION_FAILURE'|'CLEANUP_FAILURE',
'Message': 'string'
}
},
'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'
},
]
}
}
},
]
}
},
],
'Marker': 'string'
}
Response Structure
(dict) --
This input determines which instance groups to retrieve.
InstanceGroups (list) --
The list of instance groups for the cluster and given filters.
(dict) --
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.
Id (string) --
The identifier of the instance group.
Name (string) --
The name of the instance group.
Market (string) --
The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.
InstanceGroupType (string) --
The type of the instance group. Valid values are MASTER, CORE or TASK.
BidPrice (string) --
The maximum Spot price your are willing to pay for EC2 instances.
An optional, nullable field that applies if the MarketType for the instance group is specified as SPOT . Specify the maximum spot price in USD. If the value is NULL and SPOT is specified, the maximum Spot price is set equal to the On-Demand price.
InstanceType (string) --
The EC2 instance type for all instances in the instance group.
RequestedInstanceCount (integer) --
The target number of instances for the instance group.
RunningInstanceCount (integer) --
The number of instances currently running in this instance group.
Status (dict) --
The current status of the instance group.
State (string) --
The current state of the instance group.
StateChangeReason (dict) --
The status change reason details for the instance group.
Code (string) --
The programmable code for the state change reason.
Message (string) --
The status change reason description.
Timeline (dict) --
The timeline of the instance group status over time.
CreationDateTime (datetime) --
The creation date and time of the instance group.
ReadyDateTime (datetime) --
The date and time when the instance group became ready to perform tasks.
EndDateTime (datetime) --
The date and time when the instance group terminated.
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) --
ConfigurationsVersion (integer) --
The version number of the requested configuration specification for this instance group.
LastSuccessfullyAppliedConfigurations (list) --
A list of configurations that were successfully applied for an instance group last time.
(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) --
LastSuccessfullyAppliedConfigurationsVersion (integer) --
The version number of a configuration specification that was successfully applied for an instance group last time.
EbsBlockDevices (list) --
The EBS block devices that are mapped to this instance group.
(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) --
If the instance group is EBS-optimized. An Amazon EBS-optimized instance uses an optimized configuration stack and provides additional, dedicated capacity for Amazon EBS I/O.
ShrinkPolicy (dict) --
Policy for customizing shrink operations.
DecommissionTimeout (integer) --
The desired timeout for decommissioning an instance. Overrides the default YARN decommissioning timeout.
InstanceResizePolicy (dict) --
Custom policy for requesting termination protection or termination of specific instances when shrinking an instance group.
InstancesToTerminate (list) --
Specific list of instances to be terminated when shrinking an instance group.
(string) --
InstancesToProtect (list) --
Specific list of instances to be protected when shrinking an instance group.
(string) --
InstanceTerminationTimeout (integer) --
Decommissioning timeout override for the specific list of instances to be terminated.
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.
Status (dict) --
The status of an automatic scaling policy.
State (string) --
Indicates the status of the automatic scaling policy.
StateChangeReason (dict) --
The reason for a change in status.
Code (string) --
The code indicating the reason for the change in status. USER_REQUEST indicates that the scaling policy status was changed by a user. PROVISION_FAILURE indicates that the status change was because the policy failed to provision. CLEANUP_FAILURE indicates an error.
Message (string) --
A friendly, more verbose message that accompanies an automatic scaling policy state change.
Constraints (dict) --
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) --
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) --
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) --
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) --
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) --
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) --
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 an integer. For example, 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) --
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 an integer. For example, -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) --
The CloudWatch alarm definition that determines when automatic scaling activity is triggered.
CloudWatchAlarmDefinition (dict) --
The definition of a CloudWatch metric alarm. When the defined alarm conditions are met along with other trigger parameters, scaling activity begins.
ComparisonOperator (string) --
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) --
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) --
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) --
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.
Marker (string) --
The pagination token that indicates the next set of results to retrieve.
{'InstanceGroups': {'Configurations': [{'Classification': 'string',
'Configurations': (),
'Properties': {'string': 'string'}}]}}
ModifyInstanceGroups modifies the number of nodes and configuration settings of an instance group. The input parameters include the new target instance count for the group and the instance group ID. The call will either succeed or fail atomically.
See also: AWS API Documentation
Request Syntax
client.modify_instance_groups(
ClusterId='string',
InstanceGroups=[
{
'InstanceGroupId': 'string',
'InstanceCount': 123,
'EC2InstanceIdsToTerminate': [
'string',
],
'ShrinkPolicy': {
'DecommissionTimeout': 123,
'InstanceResizePolicy': {
'InstancesToTerminate': [
'string',
],
'InstancesToProtect': [
'string',
],
'InstanceTerminationTimeout': 123
}
},
'Configurations': [
{
'Classification': 'string',
'Configurations': {'... recursive ...'},
'Properties': {
'string': 'string'
}
},
]
},
]
)
string
The ID of the cluster to which the instance group belongs.
list
Instance groups to change.
(dict) --
Modify the size or configurations of an instance group.
InstanceGroupId (string) -- [REQUIRED]
Unique ID of the instance group to expand or shrink.
InstanceCount (integer) --
Target size for the instance group.
EC2InstanceIdsToTerminate (list) --
The EC2 InstanceIds to terminate. After you terminate the instances, the instance group will not return to its original requested size.
(string) --
ShrinkPolicy (dict) --
Policy for customizing shrink operations.
DecommissionTimeout (integer) --
The desired timeout for decommissioning an instance. Overrides the default YARN decommissioning timeout.
InstanceResizePolicy (dict) --
Custom policy for requesting termination protection or termination of specific instances when shrinking an instance group.
InstancesToTerminate (list) --
Specific list of instances to be terminated when shrinking an instance group.
(string) --
InstancesToProtect (list) --
Specific list of instances to be protected when shrinking an instance group.
(string) --
InstanceTerminationTimeout (integer) --
Decommissioning timeout override for the specific list of instances to be terminated.
Configurations (list) --
A list of new or modified configurations to apply for an instance group.
(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) --
None