describePipeline method

Future<DescribePipelineResponse> describePipeline({
  1. required String pipelineName,
  2. int? pipelineVersionId,
})

Describes the details of a pipeline.

May throw ResourceNotFound.

Parameter pipelineName : The name or Amazon Resource Name (ARN) of the pipeline to describe.

Parameter pipelineVersionId : The ID of the pipeline version to describe.

Implementation

Future<DescribePipelineResponse> describePipeline({
  required String pipelineName,
  int? pipelineVersionId,
}) async {
  _s.validateNumRange(
    'pipelineVersionId',
    pipelineVersionId,
    1,
    1152921504606846976,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'SageMaker.DescribePipeline'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'PipelineName': pipelineName,
      if (pipelineVersionId != null) 'PipelineVersionId': pipelineVersionId,
    },
  );

  return DescribePipelineResponse.fromJson(jsonResponse.body);
}