EMR / Client / put_auto_scaling_policy

put_auto_scaling_policy#

EMR.Client.put_auto_scaling_policy(**kwargs)#

Creates or updates 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 also: AWS API Documentation

Request Syntax

response = client.put_auto_scaling_policy(
    ClusterId='string',
    InstanceGroupId='string',
    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'
                            },
                        ]
                    }
                }
            },
        ]
    }
)

Parameters:

ClusterId (string) –
[REQUIRED]

Specifies the ID of a cluster. The instance group to which the automatic scaling policy is applied is within this cluster.
InstanceGroupId (string) –
[REQUIRED]

Specifies the ID of the instance group to which the automatic scaling policy is applied.
AutoScalingPolicy (dict) –
[REQUIRED]

Specifies the definition of the automatic scaling policy.
- 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 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) – [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 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) – [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, in five-minute increments, 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.

Return type:

dict

Returns:

Response Syntax

{
    'ClusterId': 'string',
    'InstanceGroupId': 'string',
    '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'
                            },
                        ]
                    }
                }
            },
        ]
    },
    'ClusterArn': 'string'
}

Response Structure

(dict) –
- ClusterId (string) –
  
  Specifies the ID of a cluster. The instance group to which the automatic scaling policy is applied is within this cluster.
- InstanceGroupId (string) –
  
  Specifies the ID of the instance group to which the scaling policy is applied.
- AutoScalingPolicy (dict) –
  
  The automatic scaling policy definition.
  - 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, in five-minute increments, 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.
- ClusterArn (string) –
  
  The Amazon Resource Name (ARN) of the cluster.