updateJobQueue method

Future<UpdateJobQueueResponse> updateJobQueue({ required String jobQueue, List<ComputeEnvironmentOrder>? computeEnvironmentOrder, int? priority, JQState? state, })

Updates a job queue.

May throw ClientException. May throw ServerException.

Parameter jobQueue : The name or the Amazon Resource Name (ARN) of the job queue.

Parameter computeEnvironmentOrder : Details the set of compute environments mapped to a job queue and their order relative to each other. This is one of the parameters used by the job scheduler to determine which compute environment should run a given job. Compute environments must be in the VALID state before you can associate them with a job queue. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute environments can't be mixed.

Parameter priority : The priority of the job queue. Job queues with a higher priority (or a higher integer value for the priority parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order, for example, a job queue with a priority value of 10 is given scheduling preference over a job queue with a priority value of 1. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute environments cannot be mixed.

Parameter state : Describes the queue's ability to accept new jobs. If the job queue state is ENABLED, it is able to accept jobs. If the job queue state is DISABLED, new jobs cannot be added to the queue, but jobs already in the queue can finish.

Implementation

Future<UpdateJobQueueResponse> updateJobQueue({
  required String jobQueue,
  List<ComputeEnvironmentOrder>? computeEnvironmentOrder,
  int? priority,
  JQState? state,
}) async {
  ArgumentError.checkNotNull(jobQueue, 'jobQueue');
  final $payload = <String, dynamic>{
    'jobQueue': jobQueue,
    if (computeEnvironmentOrder != null)
      'computeEnvironmentOrder': computeEnvironmentOrder,
    if (priority != null) 'priority': priority,
    if (state != null) 'state': state.toValue(),
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri: '/v1/updatejobqueue',
    exceptionFnMap: _exceptionFns,
  );
  return UpdateJobQueueResponse.fromJson(response);
}