autoscaling_describe_scheduled_actions: Describes the actions scheduled for your Auto Scaling group...

Description Usage Arguments Value Request syntax Examples

View source: R/autoscaling_operations.R

Description

Describes the actions scheduled for your Auto Scaling group that haven't run or that have not reached their end time. To describe the actions that have already run, call the describe_scaling_activities API.

Usage

1
2
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. You can specify up to 50 actions. If you omit this parameter, all scheduled actions are described. If you specify an unknown scheduled action, it is ignored with no error.

StartTime

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

EndTime

The latest scheduled start time to return. If scheduled action names are provided, this parameter 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:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
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
    )
  ),
  NextToken = "string"
)

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
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

1
2
3
4
5
6
7
8
## Not run: 
# This example describes the scheduled actions for the specified Auto
# Scaling group.
svc$describe_scheduled_actions(
  AutoScalingGroupName = "my-auto-scaling-group"
)

## End(Not run)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.