get-quantum-task¶
Description¶
Retrieves the specified quantum task.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
get-quantum-task
--quantum-task-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--quantum-task-arn (string)
the ARN of the task to retrieve.
--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.
See ‘aws help’ for descriptions of global parameters.
Output¶
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.
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.
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)