getWorkflowRun method

Future<GetWorkflowRunResponse> getWorkflowRun({
  1. required String name,
  2. required String runId,
  3. bool? includeGraph,
})

Retrieves the metadata for a given workflow run.

May throw InvalidInputException. May throw EntityNotFoundException. May throw InternalServiceException. May throw OperationTimeoutException.

Parameter name : Name of the workflow being run.

Parameter runId : The ID of the workflow run.

Parameter includeGraph : Specifies whether to include the workflow graph in response or not.

Implementation

Future<GetWorkflowRunResponse> getWorkflowRun({
  required String name,
  required String runId,
  bool? includeGraph,
}) async {
  ArgumentError.checkNotNull(name, 'name');
  _s.validateStringLength(
    'name',
    name,
    1,
    255,
    isRequired: true,
  );
  ArgumentError.checkNotNull(runId, 'runId');
  _s.validateStringLength(
    'runId',
    runId,
    1,
    255,
    isRequired: true,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AWSGlue.GetWorkflowRun'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'Name': name,
      'RunId': runId,
      if (includeGraph != null) 'IncludeGraph': includeGraph,
    },
  );

  return GetWorkflowRunResponse.fromJson(jsonResponse.body);
}