describeScheduledActions method

Future<ScheduledActionsType> describeScheduledActions({ String? autoScalingGroupName, DateTime? endTime, int? maxRecords, String? nextToken, List<String>? scheduledActionNames, DateTime? startTime, })

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 DescribeScalingActivities API.

May throw InvalidNextToken. May throw ResourceContentionFault.

Parameter autoScalingGroupName : The name of the Auto Scaling group.

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

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

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

Parameter 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.

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

Implementation

Future<ScheduledActionsType> describeScheduledActions({
  String? autoScalingGroupName,
  DateTime? endTime,
  int? maxRecords,
  String? nextToken,
  List<String>? scheduledActionNames,
  DateTime? startTime,
}) async {
  _s.validateStringLength(
    'autoScalingGroupName',
    autoScalingGroupName,
    1,
    255,
  );
  final $request = <String, dynamic>{};
  autoScalingGroupName?.also((arg) => $request['AutoScalingGroupName'] = arg);
  endTime?.also((arg) => $request['EndTime'] = _s.iso8601ToJson(arg));
  maxRecords?.also((arg) => $request['MaxRecords'] = arg);
  nextToken?.also((arg) => $request['NextToken'] = arg);
  scheduledActionNames?.also((arg) => $request['ScheduledActionNames'] = arg);
  startTime?.also((arg) => $request['StartTime'] = _s.iso8601ToJson(arg));
  final $result = await _protocol.send(
    $request,
    action: 'DescribeScheduledActions',
    version: '2011-01-01',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['DescribeScheduledActionsType'],
    shapes: shapes,
    resultWrapper: 'DescribeScheduledActionsResult',
  );
  return ScheduledActionsType.fromXml($result);
}