[ aws . braket ]

get-quantum-task

Description

Retrieves the specified quantum task.

See also: AWS API Documentation

Synopsis

  get-quantum-task
--quantum-task-arn <value>
[--additional-attribute-names <value>]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--quantum-task-arn (string)

The ARN of the quantum task to retrieve.

--additional-attribute-names (list)

A list of attributes to return additional information for. Only the QueueInfo additional attribute name is currently supported.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  QueueInfo

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
• yaml
• yaml-stream

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

quantumTaskArn -> (string)

The ARN of the quantum task.

status -> (string)

The status of the quantum task.

failureReason -> (string)

The reason that a quantum task failed.

deviceArn -> (string)

The ARN of the device the quantum task was run on.

deviceParameters -> (string)

The parameters for the device on which the quantum task ran.

shots -> (long)

The number of shots used in the quantum task.

outputS3Bucket -> (string)

The S3 bucket where quantum task results are stored.

outputS3Directory -> (string)

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

createdAt -> (timestamp)

The time at which the quantum task was created.

endedAt -> (timestamp)

The time at which the quantum task ended.

tags -> (map)

The tags that belong to this quantum task.

key -> (string)

value -> (string)

jobArn -> (string)

The ARN of the Amazon Braket job associated with the quantum 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.

queue -> (string)

The name of the queue.

position -> (string)

Current position of the quantum task in the quantum tasks queue.

queuePriority -> (string)

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

message -> (string)

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

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.

numSuccessfulShots -> (long)

The number of successful shots for the quantum task. This is available after a successfully completed quantum task.

actionMetadata -> (structure)

Metadata about the action performed by the quantum task, including information about the type of action and program counts.

actionType -> (string)

The type of action associated with the quantum task.

programCount -> (long)

The number of programs in a program set. This is only available for a Program Set.

executableCount -> (long)

The number of executables in a program set. This is only available for a Program Set.