GetQuantumTask - Braket

GetQuantumTask

Retrieves the specified quantum task.

Request Syntax

GET /quantum-task/quantumTaskArn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

quantumTaskArn

the ARN of the task to retrieve.

Length Constraints: Minimum length of 1. 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 { "createdAt": number, "deviceArn": "string", "deviceParameters": "string", "endedAt": number, "failureReason": "string", "outputS3Bucket": "string", "outputS3Directory": "string", "quantumTaskArn": "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.

createdAt

The time at which the task was created.

Type: Timestamp

deviceArn

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

Type: String

endedAt

The time at which the task ended.

Type: Timestamp

failureReason

The reason that a task failed.

Type: String

outputS3Bucket

The S3 bucket where task results are stored.

Type: String

outputS3Directory

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

Type: String

quantumTaskArn

The ARN of the task.

Type: String

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

shots

The number of shots used in the task.

Type: Long

status

The status of the task.

Type: String

Valid Values: CREATED | QUEUED | RUNNING | COMPLETED | FAILED | CANCELLING | CANCELLED

tags

The tags that belong to this 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 access to perform this action.

HTTP Status Code: 403

InternalServiceException

The request processing has failed because of an unknown error, exception, or failure.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404

ThrottlingException

The throttling rate limit is met.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: