describeScheduledActions method

Future<ScheduledActionsMessage> describeScheduledActions({ bool? active, DateTime? endTime, List<ScheduledActionFilter>? filters, String? marker, int? maxRecords, String? scheduledActionName, DateTime? startTime, ScheduledActionTypeValues? targetActionType, })

Describes properties of scheduled actions.

May throw ScheduledActionNotFoundFault. May throw UnauthorizedOperation.

Parameter active : If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions.

Parameter endTime : The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations before this time are retrieved.

Parameter filters : List of scheduled action filters.

Parameter marker : An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeScheduledActions request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Parameter maxRecords : The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

Parameter scheduledActionName : The name of the scheduled action to retrieve.

Parameter startTime : The start time in UTC of the scheduled actions to retrieve. Only active scheduled actions that have invocations after this time are retrieved.

Parameter targetActionType : The type of the scheduled actions to retrieve.

Implementation

Future<ScheduledActionsMessage> describeScheduledActions({
  bool? active,
  DateTime? endTime,
  List<ScheduledActionFilter>? filters,
  String? marker,
  int? maxRecords,
  String? scheduledActionName,
  DateTime? startTime,
  ScheduledActionTypeValues? targetActionType,
}) async {
  _s.validateStringLength(
    'marker',
    marker,
    0,
    2147483647,
  );
  _s.validateStringLength(
    'scheduledActionName',
    scheduledActionName,
    0,
    2147483647,
  );
  final $request = <String, dynamic>{};
  active?.also((arg) => $request['Active'] = arg);
  endTime?.also((arg) => $request['EndTime'] = _s.iso8601ToJson(arg));
  filters?.also((arg) => $request['Filters'] = arg);
  marker?.also((arg) => $request['Marker'] = arg);
  maxRecords?.also((arg) => $request['MaxRecords'] = arg);
  scheduledActionName?.also((arg) => $request['ScheduledActionName'] = arg);
  startTime?.also((arg) => $request['StartTime'] = _s.iso8601ToJson(arg));
  targetActionType
      ?.also((arg) => $request['TargetActionType'] = arg.toValue());
  final $result = await _protocol.send(
    $request,
    action: 'DescribeScheduledActions',
    version: '2012-12-01',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['DescribeScheduledActionsMessage'],
    shapes: shapes,
    resultWrapper: 'DescribeScheduledActionsResult',
  );
  return ScheduledActionsMessage.fromXml($result);
}