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

get-quantum-task

Description

Retrieves the specified quantum task.

See also: AWS API Documentation

Synopsis

  get-quantum-task
[--additional-attribute-names <value>]
--quantum-task-arn <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

--additional-attribute-names (list)

A list of attributes to return information for.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  QueueInfo

--quantum-task-arn (string)

The ARN of the task 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

associations -> (list)

The list of Amazon Braket resources associated with the quantum task.

(structure)

The Amazon Braket resource and the association type.

arn -> (string)

The Amazon Braket resource arn.

type -> (string)

The association type for the specified Amazon Braket resource arn.

createdAt -> (timestamp)

The time at which the task was created.

deviceArn -> (string)

The ARN of the device the task was run on.

deviceParameters -> (string)

The parameters for the device on which the task ran.

endedAt -> (timestamp)

The time at which the task ended.

failureReason -> (string)

The reason that a task failed.

jobArn -> (string)

The ARN of the Amazon Braket job associated with the quantum task.

outputS3Bucket -> (string)

The S3 bucket where task results are stored.

outputS3Directory -> (string)

The folder in the S3 bucket where task results are stored.

quantumTaskArn -> (string)

The ARN of the task.

queueInfo -> (structure)

Queue information for the requested quantum task. Only returned if QueueInfo is specified in the additionalAttributeNames" field in the GetQuantumTask API request.

message -> (string)

Optional. Provides more information about the queue position. For example, if the task is complete and no longer in the queue, the message field contains that information.

position -> (string)

Current position of the task in the quantum tasks queue.

queue -> (string)

The name of the queue.

queuePriority -> (string)

Optional. Specifies the priority of the queue. Quantum tasks in a priority queue are processed before the tasks in a normal queue.

shots -> (long)

The number of shots used in the task.

status -> (string)

The status of the task.

tags -> (map)

The tags that belong to this task.

key -> (string)

value -> (string)