putJobFailureResult method

Future<void> putJobFailureResult({
  1. required FailureDetails failureDetails,
  2. required String jobId,
})

Represents the failure of a job as returned to the pipeline by a job worker. Used for custom actions only.

May throw ValidationException. May throw JobNotFoundException. May throw InvalidJobStateException.

Parameter failureDetails : The details about the failure of a job.

Parameter jobId : The unique system-generated ID of the job that failed. This is the same ID returned from PollForJobs.

Implementation

Future<void> putJobFailureResult({
  required FailureDetails failureDetails,
  required String jobId,
}) async {
  ArgumentError.checkNotNull(failureDetails, 'failureDetails');
  ArgumentError.checkNotNull(jobId, 'jobId');
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'CodePipeline_20150709.PutJobFailureResult'
  };
  await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'failureDetails': failureDetails,
      'jobId': jobId,
    },
  );
}