describeMaintenanceWindowExecutionTaskInvocations method

Future<DescribeMaintenanceWindowExecutionTaskInvocationsResult> describeMaintenanceWindowExecutionTaskInvocations({ required String taskId, required String windowExecutionId, List<MaintenanceWindowFilter>? filters, int? maxResults, String? nextToken, })

Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution.

May throw DoesNotExistException. May throw InternalServerError.

Parameter taskId : The ID of the specific task in the maintenance window task that should be retrieved.

Parameter windowExecutionId : The ID of the maintenance window execution the task is part of.

Parameter filters : Optional filters used to scope down the returned task invocations. The supported filter key is STATUS with the corresponding values PENDING, IN_PROGRESS, SUCCESS, FAILED, TIMED_OUT, CANCELLING, and CANCELLED.

Parameter maxResults : The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

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

Implementation

Future<DescribeMaintenanceWindowExecutionTaskInvocationsResult>
    describeMaintenanceWindowExecutionTaskInvocations({
  required String taskId,
  required String windowExecutionId,
  List<MaintenanceWindowFilter>? filters,
  int? maxResults,
  String? nextToken,
}) async {
  ArgumentError.checkNotNull(taskId, 'taskId');
  _s.validateStringLength(
    'taskId',
    taskId,
    36,
    36,
    isRequired: true,
  );
  ArgumentError.checkNotNull(windowExecutionId, 'windowExecutionId');
  _s.validateStringLength(
    'windowExecutionId',
    windowExecutionId,
    36,
    36,
    isRequired: true,
  );
  _s.validateNumRange(
    'maxResults',
    maxResults,
    10,
    100,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target':
        'AmazonSSM.DescribeMaintenanceWindowExecutionTaskInvocations'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'TaskId': taskId,
      'WindowExecutionId': windowExecutionId,
      if (filters != null) 'Filters': filters,
      if (maxResults != null) 'MaxResults': maxResults,
      if (nextToken != null) 'NextToken': nextToken,
    },
  );

  return DescribeMaintenanceWindowExecutionTaskInvocationsResult.fromJson(
      jsonResponse.body);
}