describeScheduledActions method

Future<ScheduledActionsType> describeScheduledActions({
  1. String? autoScalingGroupName,
  2. DateTime? endTime,
  3. int? maxRecords,
  4. String? nextToken,
  5. List<String>? scheduledActionNames,
  6. DateTime? startTime,
})

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

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

Implementation

Future<ScheduledActionsType> describeScheduledActions({
  String? autoScalingGroupName,
  DateTime? endTime,
  int? maxRecords,
  String? nextToken,
  List<String>? scheduledActionNames,
  DateTime? startTime,
}) async {
  final $request = <String, String>{
    if (autoScalingGroupName != null)
      'AutoScalingGroupName': autoScalingGroupName,
    if (endTime != null) 'EndTime': _s.iso8601ToJson(endTime),
    if (maxRecords != null) 'MaxRecords': maxRecords.toString(),
    if (nextToken != null) 'NextToken': nextToken,
    if (scheduledActionNames != null)
      if (scheduledActionNames.isEmpty)
        'ScheduledActionNames': ''
      else
        for (var i1 = 0; i1 < scheduledActionNames.length; i1++)
          'ScheduledActionNames.member.${i1 + 1}': scheduledActionNames[i1],
    if (startTime != null) 'StartTime': _s.iso8601ToJson(startTime),
  };
  final $result = await _protocol.send(
    $request,
    action: 'DescribeScheduledActions',
    version: '2011-01-01',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    resultWrapper: 'DescribeScheduledActionsResult',
  );
  return ScheduledActionsType.fromXml($result);
}