updateStep method

Future<void> updateStep({
  1. required String farmId,
  2. required String jobId,
  3. required String queueId,
  4. required String stepId,
  5. required StepTargetTaskRunStatus targetTaskRunStatus,
  6. String? clientToken,
})

Updates a step.

May throw AccessDeniedException. May throw ConflictException. May throw InternalServerErrorException. May throw ResourceNotFoundException. May throw ThrottlingException. May throw ValidationException.

Parameter farmId : The farm ID to update.

Parameter jobId : The job ID to update.

Parameter queueId : The queue ID to update.

Parameter stepId : The step ID to update.

Parameter targetTaskRunStatus : The task status to update the step's tasks to.

Parameter clientToken : The unique token which the server uses to recognize retries of the same request.

Implementation

Future<void> updateStep({
  required String farmId,
  required String jobId,
  required String queueId,
  required String stepId,
  required StepTargetTaskRunStatus targetTaskRunStatus,
  String? clientToken,
}) async {
  final headers = <String, String>{
    if (clientToken != null) 'X-Amz-Client-Token': clientToken.toString(),
  };
  final $payload = <String, dynamic>{
    'targetTaskRunStatus': targetTaskRunStatus.value,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'PATCH',
    requestUri:
        '/2023-10-12/farms/${Uri.encodeComponent(farmId)}/queues/${Uri.encodeComponent(queueId)}/jobs/${Uri.encodeComponent(jobId)}/steps/${Uri.encodeComponent(stepId)}',
    headers: headers,
    exceptionFnMap: _exceptionFns,
  );
}