Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetQuantumTask

Retrieves the specified quantum task.

Request Syntax


GET /quantum-task/quantumTaskArn?additionalAttributeNames=additionalAttributeNames HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

additionalAttributeNames

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

Valid Values: QueueInfo

quantumTaskArn

The ARN of the quantum task to retrieve.

Length Constraints: Minimum length of 0. Maximum length of 256.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "associations": [ 
      { 
         "arn": "string",
         "type": "string"
      }
   ],
   "createdAt": "string",
   "deviceArn": "string",
   "deviceParameters": "string",
   "endedAt": "string",
   "failureReason": "string",
   "jobArn": "string",
   "outputS3Bucket": "string",
   "outputS3Directory": "string",
   "quantumTaskArn": "string",
   "queueInfo": { 
      "message": "string",
      "position": "string",
      "queue": "string",
      "queuePriority": "string"
   },
   "shots": number,
   "status": "string",
   "tags": { 
      "string" : "string" 
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

associations

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

Type: Array of Association objects

createdAt

The time at which the quantum task was created.

Type: Timestamp

deviceArn

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

deviceParameters

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

Type: String

endedAt

The time at which the quantum task ended.

Type: Timestamp

failureReason

The reason that a quantum task failed.

Type: String

jobArn

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

Type: String

Pattern: ^arn:aws[a-z\-]*:braket:[a-z0-9\-]+:[0-9]{12}:job/.*$

outputS3Bucket

The S3 bucket where quantum task results are stored.

Type: String

outputS3Directory

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

Type: String

quantumTaskArn

The ARN of the quantum task.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

queueInfo

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

Type: QuantumTaskQueueInfo object

shots

The number of shots used in the quantum task.

Type: Long

status

The status of the quantum task.

Type: String

tags

The tags that belong to this quantum task.

Type: String to string map

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient permissions to perform this action.

HTTP Status Code: 403

InternalServiceException

The request failed because of an unknown error.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404

ThrottlingException

The API throttling rate limit is exceeded.

HTTP Status Code: 429

ValidationException

The input request failed to satisfy constraints expected by Amazon Braket.

HTTP Status Code: 400