describePipelineExecution method
Retrieves detailed information about a specific pipeline execution, including the overall execution status and the status of each individual compute node. Use this operation to monitor execution progress and inspect per-node results, environment variables, and error details.
May throw AccessDeniedException.
May throw InternalFailureException.
May throw InvalidRequestException.
May throw ResourceNotFoundException.
May throw ThrottlingException.
Parameter pipelineExecutionId :
The unique identifier of the pipeline execution.
Parameter pipelineName :
The name of the pipeline.
Parameter workspaceName :
The name of the workspace.
Parameter maxResults :
The maximum number of compute nodes to return per request. This is an
upper bound; the actual number of results may be less. Default: 50.
Parameter nextToken :
The token to be used for the next set of paginated results.
Implementation
Future<DescribePipelineExecutionResponse> describePipelineExecution({
required String pipelineExecutionId,
required String pipelineName,
required String workspaceName,
int? maxResults,
String? nextToken,
}) async {
_s.validateNumRange(
'maxResults',
maxResults,
1,
250,
);
final $query = <String, List<String>>{
if (maxResults != null) 'maxResults': [maxResults.toString()],
if (nextToken != null) 'nextToken': [nextToken],
};
final response = await _protocol.send(
payload: null,
method: 'GET',
requestUri:
'/workspaces/${Uri.encodeComponent(workspaceName)}/pipelines/${Uri.encodeComponent(pipelineName)}/executions/${Uri.encodeComponent(pipelineExecutionId)}',
queryParams: $query,
hostPrefix: 'data.',
exceptionFnMap: _exceptionFns,
);
return DescribePipelineExecutionResponse.fromJson(response);
}