Skip to content

Gets information about the scheduled actions that haven't run or that have not reached their end time

Description

Gets information about the scheduled actions that haven't run or that have not reached their end time.

To describe the scaling activities for scheduled actions that have already run, call the describe_scaling_activities API.

Usage

autoscaling_describe_scheduled_actions(AutoScalingGroupName,
  ScheduledActionNames, StartTime, EndTime, NextToken, MaxRecords)

Arguments

  • AutoScalingGroupName

    The name of the Auto Scaling group.

  • ScheduledActionNames

    The names of one or more scheduled actions. If you omit this property, all scheduled actions are described. If you specify an unknown scheduled action, it is ignored with no error.

    Array Members: Maximum number of 50 actions.

  • StartTime

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

  • EndTime

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

  • NextToken

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

  • MaxRecords

    The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

Value

A list with the following syntax:

list(
  ScheduledUpdateGroupActions = list(
    list(
      AutoScalingGroupName = "string",
      ScheduledActionName = "string",
      ScheduledActionARN = "string",
      Time = as.POSIXct(
        "2015-01-01"
      ),
      StartTime = as.POSIXct(
        "2015-01-01"
      ),
      EndTime = as.POSIXct(
        "2015-01-01"
      ),
      Recurrence = "string",
      MinSize = 123,
      MaxSize = 123,
      DesiredCapacity = 123,
      TimeZone = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_scheduled_actions(
  AutoScalingGroupName = "string",
  ScheduledActionNames = list(
    "string"
  ),
  StartTime = as.POSIXct(
    "2015-01-01"
  ),
  EndTime = as.POSIXct(
    "2015-01-01"
  ),
  NextToken = "string",
  MaxRecords = 123
)

Examples

# This example describes the scheduled actions for the specified Auto
# Scaling group.
svc$describe_scheduled_actions(
  AutoScalingGroupName = "my-auto-scaling-group"
)