listPipelineExecutionSteps method

Future<ListPipelineExecutionStepsResponse> listPipelineExecutionSteps({ int? maxResults, String? nextToken, String? pipelineExecutionArn, SortOrder? sortOrder, })

Gets a list of PipeLineExecutionStep objects.

May throw ResourceNotFound.

Parameter maxResults : The maximum number of pipeline execution steps to return in the response.

Parameter nextToken : If the result of the previous ListPipelineExecutionSteps request was truncated, the response includes a NextToken. To retrieve the next set of pipeline execution steps, use the token in the next request.

Parameter pipelineExecutionArn : The Amazon Resource Name (ARN) of the pipeline execution.

Parameter sortOrder : The field by which to sort results. The default is CreatedTime.

Implementation

Future<ListPipelineExecutionStepsResponse> listPipelineExecutionSteps({
  int? maxResults,
  String? nextToken,
  String? pipelineExecutionArn,
  SortOrder? sortOrder,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    100,
  );
  _s.validateStringLength(
    'nextToken',
    nextToken,
    0,
    8192,
  );
  _s.validateStringLength(
    'pipelineExecutionArn',
    pipelineExecutionArn,
    0,
    256,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'SageMaker.ListPipelineExecutionSteps'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      if (maxResults != null) 'MaxResults': maxResults,
      if (nextToken != null) 'NextToken': nextToken,
      if (pipelineExecutionArn != null)
        'PipelineExecutionArn': pipelineExecutionArn,
      if (sortOrder != null) 'SortOrder': sortOrder.toValue(),
    },
  );

  return ListPipelineExecutionStepsResponse.fromJson(jsonResponse.body);
}