Menu
Amazon Elastic MapReduce
API Reference (API Version 2009-03-31)

PutAutoScalingPolicy

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.

Request Syntax

{ "AutoScalingPolicy": { "Constraints": { "MaxCapacity": number, "MinCapacity": number }, "Rules": [ { "Action": { "Market": "string", "SimpleScalingPolicyConfiguration": { "AdjustmentType": "string", "CoolDown": number, "ScalingAdjustment": number } }, "Description": "string", "Name": "string", "Trigger": { "CloudWatchAlarmDefinition": { "ComparisonOperator": "string", "Dimensions": [ { "Key": "string", "Value": "string" } ], "EvaluationPeriods": number, "MetricName": "string", "Namespace": "string", "Period": number, "Statistic": "string", "Threshold": number, "Unit": "string" } } } ] }, "ClusterId": "string", "InstanceGroupId": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

AutoScalingPolicy

Specifies the definition of the automatic scaling policy.

Type: AutoScalingPolicy object

Required: Yes

ClusterId

Specifies the ID of a cluster. The instance group to which the automatic scaling policy is applied is within this cluster.

Type: String

Required: Yes

InstanceGroupId

Specifies the ID of the instance group to which the automatic scaling policy is applied.

Type: String

Required: Yes

Response Syntax

{ "AutoScalingPolicy": { "Constraints": { "MaxCapacity": number, "MinCapacity": number }, "Rules": [ { "Action": { "Market": "string", "SimpleScalingPolicyConfiguration": { "AdjustmentType": "string", "CoolDown": number, "ScalingAdjustment": number } }, "Description": "string", "Name": "string", "Trigger": { "CloudWatchAlarmDefinition": { "ComparisonOperator": "string", "Dimensions": [ { "Key": "string", "Value": "string" } ], "EvaluationPeriods": number, "MetricName": "string", "Namespace": "string", "Period": number, "Statistic": "string", "Threshold": number, "Unit": "string" } } } ], "Status": { "State": "string", "StateChangeReason": { "Code": "string", "Message": "string" } } }, "ClusterId": "string", "InstanceGroupId": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AutoScalingPolicy

The automatic scaling policy definition.

Type: AutoScalingPolicyDescription object

ClusterId

Specifies the ID of a cluster. The instance group to which the automatic scaling policy is applied is within this cluster.

Type: String

InstanceGroupId

Specifies the ID of the instance group to which the scaling policy is applied.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: