AWS CLI Command Reference

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 ]

get-queue

Description

Gets a queue.

See also: AWS API Documentation

Synopsis

  get-queue
--farm-id <value>
--queue-id <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

--farm-id (string)

The farm ID of the farm in the queue.

--queue-id (string)

The queue ID for the queue to retrieve.

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

Output

queueId -> (string)

The queue ID.

displayName -> (string)

The display name of the queue.

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.

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.

farmId -> (string)

The farm ID for the queue.

status -> (string)

The status of the queue.

  • ACTIVE –The queue is active.
  • SCHEDULING –The queue is scheduling.
  • SCHEDULING_BLOCKED –The queue scheduling is blocked. See the provided reason.

defaultBudgetAction -> (string)

The default action taken on a queue if a budget wasn't configured.

blockedReason -> (string)

The reason the queue was blocked.

jobAttachmentSettings -> (structure)

The job attachment settings for the queue.

s3BucketName -> (string)

The Amazon S3 bucket name.

rootPrefix -> (string)

The root prefix.

roleArn -> (string)

The IAM role ARN.

requiredFileSystemLocationNames -> (list)

A list of the required file system location names in the queue.

(string)

allowedStorageProfileIds -> (list)

The storage profile IDs for the queue.

(string)

jobRunAsUser -> (structure)

The jobs in the queue ran as this 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.

createdAt -> (timestamp)

The date and time the resource was created.

createdBy -> (string)

The user or system that created this resource.

updatedAt -> (timestamp)

The date and time the resource was updated.

updatedBy -> (string)

The user or system that updated this resource.