updateJobExecution method

Future<UpdateJobExecutionResponse> updateJobExecution({ required String jobId, required JobExecutionStatus status, required String thingName, int? executionNumber, int? expectedVersion, bool? includeJobDocument, bool? includeJobExecutionState, Map<String, String>? statusDetails, int? stepTimeoutInMinutes, })

Updates the status of a job execution.

May throw InvalidRequestException. May throw ResourceNotFoundException. May throw ThrottlingException. May throw ServiceUnavailableException. May throw CertificateValidationException. May throw InvalidStateTransitionException.

Parameter jobId : The unique identifier assigned to this job when it was created.

Parameter status : The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.

Parameter thingName : The name of the thing associated with the device.

Parameter executionNumber : Optional. A number that identifies a particular job execution on a particular device.

Parameter expectedVersion : Optional. The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)

Parameter includeJobDocument : Optional. When set to true, the response contains the job document. The default is false.

Parameter includeJobExecutionState : Optional. When included and set to true, the response contains the JobExecutionState data. The default is false.

Parameter statusDetails : Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.

Parameter stepTimeoutInMinutes : Specifies the amount of time this device has to finish execution of this job. If the job execution status is not set to a terminal state before this timer expires, or before the timer is reset (by again calling UpdateJobExecution, setting the status to IN_PROGRESS and specifying a new timeout value in this field) the job execution status will be automatically set to TIMED_OUT. Note that setting or resetting this timeout has no effect on that job execution timeout which may have been specified when the job was created (CreateJob using field timeoutConfig).

Implementation

Future<UpdateJobExecutionResponse> updateJobExecution({
  required String jobId,
  required JobExecutionStatus status,
  required String thingName,
  int? executionNumber,
  int? expectedVersion,
  bool? includeJobDocument,
  bool? includeJobExecutionState,
  Map<String, String>? statusDetails,
  int? stepTimeoutInMinutes,
}) async {
  ArgumentError.checkNotNull(jobId, 'jobId');
  _s.validateStringLength(
    'jobId',
    jobId,
    1,
    64,
    isRequired: true,
  );
  ArgumentError.checkNotNull(status, 'status');
  ArgumentError.checkNotNull(thingName, 'thingName');
  _s.validateStringLength(
    'thingName',
    thingName,
    1,
    128,
    isRequired: true,
  );
  final $payload = <String, dynamic>{
    'status': status.toValue(),
    if (executionNumber != null) 'executionNumber': executionNumber,
    if (expectedVersion != null) 'expectedVersion': expectedVersion,
    if (includeJobDocument != null) 'includeJobDocument': includeJobDocument,
    if (includeJobExecutionState != null)
      'includeJobExecutionState': includeJobExecutionState,
    if (statusDetails != null) 'statusDetails': statusDetails,
    if (stepTimeoutInMinutes != null)
      'stepTimeoutInMinutes': stepTimeoutInMinutes,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri:
        '/things/${Uri.encodeComponent(thingName)}/jobs/${Uri.encodeComponent(jobId)}',
    exceptionFnMap: _exceptionFns,
  );
  return UpdateJobExecutionResponse.fromJson(response);
}