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

DescribeScheduledActions

Description

Lists the actions scheduled for your Auto Scaling group that haven't been executed. To list the actions that were already executed, use DescribeScalingActivities.

Request Parameters

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

AutoScalingGroupName

The name of the group.

Type: String

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

Required: No

EndTime

The latest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.

Type: DateTime

Required: No

MaxRecords

The maximum number of items to return with this call.

Type: Integer

Required: No

NextToken

The token for the next set of items to return. (You received this token from a previous call.)

Type: String

Required: No

ScheduledActionNames.member.N

Describes one or more scheduled actions. If you omit this list, the call describes all scheduled actions. If you specify an unknown scheduled action it is ignored with no error.

You can describe up to a maximum of 50 instances with a single call. If there are more items to return, the call returns a token. To get the next set of items, repeat the call with the returned token in the NextToken parameter.

Type: String list

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

Required: No

StartTime

The earliest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.

Type: DateTime

Required: No

Response Elements

The following elements are returned in a structure named DescribeScheduledActionsResult.

NextToken

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Type: String

ScheduledUpdateGroupActions

The scheduled actions.

Type: ScheduledUpdateGroupAction list

Errors

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

InvalidNextToken

The NextToken value is not valid.

HTTP Status Code: 400