Auto Scaling
API Reference (API Version 2011-01-01)
« PreviousNext »
View the PDF for this guide.Go to the AWS Discussion Forum for this product.Did this page help you?  Yes | No |  Tell us about it...

PutScheduledUpdateGroupAction

Description

Creates or updates a scheduled scaling action for an Auto Scaling group. When updating a scheduled scaling action, if you leave a parameter unspecified, the corresponding value remains unchanged in the affected Auto Scaling group.

For information on creating or updating a scheduled action for your Auto Scaling group, see Scale Based on a Schedule.

Note

Auto Scaling supports the date and time expressed in "YYYY-MM-DDThh:mm:ssZ" format in UTC/GMT only.

Request Parameters

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

AutoScalingGroupName

The name or ARN of the Auto Scaling group.

Type: String

Length constraints: Minimum length of 1. Maximum length of 1600.

Required: Yes

DesiredCapacity

The number of Amazon EC2 instances that should be running in the group.

Type: Integer

Required: No

EndTime

The time for this action to end.

Type: DateTime

Required: No

MaxSize

The maximum size for the Auto Scaling group.

Type: Integer

Required: No

MinSize

The minimum size for the new Auto Scaling group.

Type: Integer

Required: No

Recurrence

The time when recurring future actions will start. Start time is specified by the user following the Unix cron syntax format. For information about cron syntax, go to Wikipedia, The Free Encyclopedia.

When StartTime and EndTime are specified with Recurrence, they form the boundaries of when the recurring action will start and stop.

Type: String

Length constraints: Minimum length of 1. Maximum length of 255.

Required: No

ScheduledActionName

The name of this scaling action.

Type: String

Length constraints: Minimum length of 1. Maximum length of 255.

Required: Yes

StartTime

The time for this action to start, as in --start-time 2010-06-01T00:00:00Z.

If you try to schedule your action in the past, Auto Scaling returns an error message.

When StartTime and EndTime are specified with Recurrence, they form the boundaries of when the recurring action will start and stop.

Type: DateTime

Required: No

Time

Time is deprecated.

The time for this action to start. Time is an alias for StartTime and can be specified instead of StartTime, or vice versa. If both Time and StartTime are specified, their values should be identical. Otherwise, PutScheduledUpdateGroupAction will return an error.

Type: DateTime

Required: No

Errors

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

AlreadyExists

The named Auto Scaling group or launch configuration already exists.

HTTP Status Code: 400

LimitExceeded

The quota for capacity groups or launch configurations for this customer has already been reached.

HTTP Status Code: 400

Examples

Schedule based on a specific date and time

Sample Request

https://autoscaling.amazonaws.com/?AutoScalingGroupName=my-test-asg
&ScheduledActionName=ScaleUp
&StartTime=2013-05-25T08:00:00Z
&DesiredCapacity=3
&Version=2011-01-01
&Action=PutScheduledUpdateGroupAction
&AUTHPARAMS 

Sample Response

<PutScheduledUpdateGroupActionResponse xmlns="http://autoscaling.amazonaws.com/doc/2011-01-01/">
  <ResponseMetadata>
    <RequestId>3bc8c9bc-6a62-11e2-8a51-4b8a1EXAMPLE</RequestId>
  </ResponseMetadata>
  </PutScheduledUpdateGroupActionResponse>

Recurring Schedule

Sample Request

https://autoscaling.amazonaws.com/?AutoScalingGroupName=my-test-asg
&ScheduledActionName=scaleup-schedule-year
&Recurrence="30 0 1 1,6,12 *"
&DesiredCapacity=3
&Version=2011-01-01
&Action=PutScheduledUpdateGroupAction
&AUTHPARAMS 

Sample Response

<PutScheduledUpdateGroupActionResponse xmlns="http://autoscaling.amazonaws.com/doc/2011-01-01/">
  <ResponseMetadata>
    <RequestId>3bc8c9bc-6a62-11e2-8a51-4b8a1EXAMPLE</RequestId>
  </ResponseMetadata>
  </PutScheduledUpdateGroupActionResponse>