updatePipelineExecution method

Future<UpdatePipelineExecutionResponse> updatePipelineExecution({ required String pipelineExecutionArn, String? pipelineExecutionDescription, String? pipelineExecutionDisplayName, })

Updates a pipeline execution.

May throw ResourceNotFound.

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

Parameter pipelineExecutionDescription : The description of the pipeline execution.

Parameter pipelineExecutionDisplayName : The display name of the pipeline execution.

Implementation

Future<UpdatePipelineExecutionResponse> updatePipelineExecution({
  required String pipelineExecutionArn,
  String? pipelineExecutionDescription,
  String? pipelineExecutionDisplayName,
}) async {
  ArgumentError.checkNotNull(pipelineExecutionArn, 'pipelineExecutionArn');
  _s.validateStringLength(
    'pipelineExecutionArn',
    pipelineExecutionArn,
    0,
    256,
    isRequired: true,
  );
  _s.validateStringLength(
    'pipelineExecutionDescription',
    pipelineExecutionDescription,
    0,
    3072,
  );
  _s.validateStringLength(
    'pipelineExecutionDisplayName',
    pipelineExecutionDisplayName,
    1,
    82,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'SageMaker.UpdatePipelineExecution'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'PipelineExecutionArn': pipelineExecutionArn,
      if (pipelineExecutionDescription != null)
        'PipelineExecutionDescription': pipelineExecutionDescription,
      if (pipelineExecutionDisplayName != null)
        'PipelineExecutionDisplayName': pipelineExecutionDisplayName,
    },
  );

  return UpdatePipelineExecutionResponse.fromJson(jsonResponse.body);
}