Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . deadline ]

create-queue

Description

Creates a queue to coordinate the order in which jobs run on a farm. A queue can also specify where to pull resources and indicate where to output completed jobs.

See also: AWS API Documentation

Synopsis

  create-queue
[--allowed-storage-profile-ids <value>]
[--client-token <value>]
[--default-budget-action <value>]
[--description <value>]
--display-name <value>
--farm-id <value>
[--job-attachment-settings <value>]
[--job-run-as-user <value>]
[--required-file-system-location-names <value>]
[--role-arn <value>]
[--tags <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>]

Options

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

The storage profile IDs to include in the queue.

(string)

Syntax:

"string" "string" ...

--client-token (string)

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

--default-budget-action (string)

The default action to take on a queue if a budget isn't configured.

Possible values:

• NONE
• STOP_SCHEDULING_AND_COMPLETE_TASKS
• STOP_SCHEDULING_AND_CANCEL_TASKS

--description (string)

The description of the queue.

--display-name (string)

The display name of the queue.

--farm-id (string)

The farm ID of the farm to connect to the queue.

--job-attachment-settings (structure)

The job attachment settings for the queue. These are the Amazon S3 bucket name and the Amazon S3 prefix.

rootPrefix -> (string)

The root prefix.

s3BucketName -> (string)

The Amazon S3 bucket name.

Shorthand Syntax:

rootPrefix=string,s3BucketName=string

JSON Syntax:

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

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

The jobs in the queue run as the specified POSIX user.

posix -> (structure)

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

group -> (string)

The name of the POSIX user's group.

user -> (string)

The name of the POSIX 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.

windows -> (structure)

Identifies a Microsoft Windows user.

passwordArn -> (string)

The password ARN for the Windows user.

user -> (string)

The user.

Shorthand Syntax:

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

JSON Syntax:

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

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

The file system location name to include in the queue.

(string)

Syntax:

"string" "string" ...

--role-arn (string)

The IAM role ARN that workers will use while running jobs for this queue.

--tags (map)

Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--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.

--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.

Output

queueId -> (string)

The queue ID.