AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . deadline ]

update-queue

Description

Updates a queue.

See also: AWS API Documentation

Synopsis

  update-queue
--farm-id <value>
--queue-id <value>
[--client-token <value>]
[--display-name <value>]
[--description <value>]
[--default-budget-action <value>]
[--job-attachment-settings <value>]
[--role-arn <value>]
[--job-run-as-user <value>]
[--required-file-system-location-names-to-add <value>]
[--required-file-system-location-names-to-remove <value>]
[--allowed-storage-profile-ids-to-add <value>]
[--allowed-storage-profile-ids-to-remove <value>]
[--scheduling-configuration <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]

Options

--farm-id (string)

The farm ID to update in the queue.

--queue-id (string)

The queue ID to update.

--client-token (string)

The idempotency token to update in the queue.

--display-name (string)

The display name of the queue to update.

Warning

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

--description (string)

The description of the queue to update.

Warning

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

--default-budget-action (string)

The default action to take for a queue update if a budget isn’t configured.

Possible values:

  • NONE
  • STOP_SCHEDULING_AND_COMPLETE_TASKS
  • STOP_SCHEDULING_AND_CANCEL_TASKS

--job-attachment-settings (structure)

The job attachment settings to update for the queue.

s3BucketName -> (string)

The Amazon S3 bucket name.

rootPrefix -> (string)

The root prefix.

Shorthand Syntax:

s3BucketName=string,rootPrefix=string

JSON Syntax:

{
  "s3BucketName": "string",
  "rootPrefix": "string"
}

--role-arn (string)

The IAM role ARN that’s used to run jobs from this queue.

--job-run-as-user (structure)

Update the jobs in the queue to run as a specified POSIX user.

posix -> (structure)

The user and group that the jobs in the queue run as.

user -> (string)

The name of the POSIX user.

group -> (string)

The name of the POSIX user’s group.

windows -> (structure)

Identifies a Microsoft Windows user.

user -> (string)

The user.

passwordArn -> (string)

The password ARN for the Windows user.

runAs -> (string)

Specifies whether the job should run using the queue’s system user or if the job should run using the worker agent system user.

Shorthand Syntax:

posix={user=string,group=string},windows={user=string,passwordArn=string},runAs=string

JSON Syntax:

{
  "posix": {
    "user": "string",
    "group": "string"
  },
  "windows": {
    "user": "string",
    "passwordArn": "string"
  },
  "runAs": "QUEUE_CONFIGURED_USER"|"WORKER_AGENT_USER"
}

--required-file-system-location-names-to-add (list)

The required file system location names to add to the queue.

(string)

Syntax:

"string" "string" ...

--required-file-system-location-names-to-remove (list)

The required file system location names to remove from the queue.

(string)

Syntax:

"string" "string" ...

--allowed-storage-profile-ids-to-add (list)

The storage profile IDs to add.

(string)

Syntax:

"string" "string" ...

--allowed-storage-profile-ids-to-remove (list)

The storage profile ID to remove.

(string)

Syntax:

"string" "string" ...

--scheduling-configuration (tagged union structure)

The scheduling configuration for the queue. This configuration determines how workers are assigned to jobs in the queue.

When updating the scheduling configuration, the entire configuration is replaced.

In-progress tasks run to completion before the new scheduling configuration takes effect.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: priorityFifo, priorityBalanced, weightedBalanced.

priorityFifo -> (structure)

Workers are assigned to the highest-priority job first. When multiple jobs share the same priority, the job submitted earliest receives workers first. This is the default scheduling configuration for new queues.

priorityBalanced -> (structure)

Workers are distributed evenly across all jobs at the highest priority level. When workers cannot be evenly divided, the extra workers are assigned to the jobs submitted earliest. If a job has fewer remaining tasks than its share of workers, the surplus workers are redistributed to other jobs at the same priority level.

renderingTaskBuffer -> (integer)

The rendering task buffer controls worker stickiness. A worker only switches from its current job to another job at the same priority if the other job has fewer rendering tasks by more than this buffer value. Higher values make workers stickier to their current jobs. The default value is 1 .

weightedBalanced -> (structure)

Workers are assigned to jobs based on a weighted formula that considers job priority, error count, submission time, and the number of tasks currently rendering. Each factor has a configurable weight that determines its influence on scheduling decisions.

priorityWeight -> (double)

The weight applied to job priority in the scheduling formula. Higher values give more influence to job priority. A value of 0 means priority is ignored. The default value is 100.0 .

errorWeight -> (double)

The weight applied to the number of errors on a job. A negative value means jobs without errors are scheduled first. A value of 0 means errors are ignored. The default value is -10.0 .

submissionTimeWeight -> (double)

The weight applied to job submission time. A positive value means earlier jobs are scheduled first. A value of 0 means submission time is ignored. The default value is 3.0 .

renderingTaskWeight -> (double)

The weight applied to the number of tasks currently rendering on a job. A negative value means jobs that are not already rendering are scheduled next. A value of 0 means the rendering state is ignored. The default value is -100.0 .

renderingTaskBuffer -> (integer)

The rendering task buffer is subtracted from the number of rendering tasks before applying the rendering task weight. This creates a stickiness effect where workers prefer to stay with their current job. Higher values make workers stickier. The default value is 1 . The buffer is only applied in the weight calculation for a job if the worker is currently assigned to that job.

maxPriorityOverride -> (tagged union structure)

Overrides the weighted scheduling formula for jobs at the maximum priority (100). When set, jobs with priority 100 are always scheduled first regardless of their calculated weight. When absent, maximum priority jobs use the standard weighted formula.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: alwaysScheduleFirst.

alwaysScheduleFirst -> (structure)

Jobs at the maximum priority (100) are always scheduled before other jobs, regardless of the weighted scheduling formula. If multiple jobs have priority 100, ties are broken using the standard weighted formula.

minPriorityOverride -> (tagged union structure)

Overrides the weighted scheduling formula for jobs at the minimum priority (0). When set, jobs with priority 0 are always scheduled last regardless of their calculated weight. When absent, minimum priority jobs use the standard weighted formula.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: alwaysScheduleLast.

alwaysScheduleLast -> (structure)

Jobs at the minimum priority (0) are always scheduled after all other jobs, regardless of the weighted scheduling formula. If multiple jobs have priority 0, ties are broken using the standard weighted formula.

Shorthand Syntax:

priorityFifo={},priorityBalanced={renderingTaskBuffer=integer},weightedBalanced={priorityWeight=double,errorWeight=double,submissionTimeWeight=double,renderingTaskWeight=double,renderingTaskBuffer=integer,maxPriorityOverride={alwaysScheduleFirst={}},minPriorityOverride={alwaysScheduleLast={}}}

JSON Syntax:

{
  "priorityFifo": {

  },
  "priorityBalanced": {
    "renderingTaskBuffer": integer
  },
  "weightedBalanced": {
    "priorityWeight": double,
    "errorWeight": double,
    "submissionTimeWeight": double,
    "renderingTaskWeight": double,
    "renderingTaskBuffer": integer,
    "maxPriorityOverride": {
      "alwaysScheduleFirst": {

      }
    },
    "minPriorityOverride": {
      "alwaysScheduleLast": {

      }
    }
  }
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

None