GetJob - Amazon Braket

GetJob

Retrieves the specified Amazon Braket job.

Request Syntax

GET /job/jobArn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

jobArn

The ARN of the job to retrieve.

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "algorithmSpecification": { "containerImage": { "uri": "string" }, "scriptModeConfig": { "compressionType": "string", "entryPoint": "string", "s3Uri": "string" } }, "billableDuration": number, "checkpointConfig": { "localPath": "string", "s3Uri": "string" }, "createdAt": number, "deviceConfig": { "device": "string" }, "endedAt": number, "events": [ { "eventType": "string", "message": "string", "timeOfEvent": number } ], "failureReason": "string", "hyperParameters": { "string" : "string" }, "inputDataConfig": [ { "channelName": "string", "contentType": "string", "dataSource": { "s3DataSource": { "s3Uri": "string" } } } ], "instanceConfig": { "instanceType": "string", "volumeSizeInGb": number }, "jobArn": "string", "jobName": "string", "outputDataConfig": { "kmsKeyId": "string", "s3Path": "string" }, "roleArn": "string", "startedAt": number, "status": "string", "stoppingCondition": { "maxRuntimeInSeconds": number }, "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.

algorithmSpecification

Definition of the Amazon Braket job created. Specifies the container image the job uses, information about the Python scripts used for entry and training, and the user-defined metrics used to evaluation the job.

Type: AlgorithmSpecification object

billableDuration

The billable time the Amazon Braket job used to complete.

Type: Integer

checkpointConfig

Information about the output locations for job checkpoint data.

Type: JobCheckpointConfig object

createdAt

The date and time that the Amazon Braket job was created.

Type: Timestamp

deviceConfig

The quantum processing unit (QPU) or simulator used to run the Amazon Braket job.

Type: DeviceConfig object

endedAt

The date and time that the Amazon Braket job ended.

Type: Timestamp

events

Details about the type and time events occurred related to the Amazon Braket job.

Type: Array of JobEventDetails objects

Array Members: Minimum number of 0 items. Maximum number of 20 items.

failureReason

A description of the reason why an Amazon Braket job failed, if it failed.

Type: String

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

hyperParameters

Algorithm-specific parameters used by an Amazon Braket job that influence the quality of the traiing job. The values are set with a string of JSON key:value pairs, where the key is the name of the hyperparameter and the value is the value of th hyperparameter.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 100 items.

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

Value Length Constraints: Minimum length of 1. Maximum length of 2500.

inputDataConfig

A list of parameters that specify the name and type of input data and where it is located.

Type: Array of InputFileConfig objects

instanceConfig

The resource instances to use while running the hybrid job on Amazon Braket.

Type: InstanceConfig object

jobArn

The ARN of the Amazon Braket job.

Type: String

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

jobName

The name of the Amazon Braket job.

Type: String

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

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,50}$

outputDataConfig

The path to the S3 location where job artifacts are stored and the encryption key used to store them there.

Type: JobOutputDataConfig object

roleArn

The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform tasks on behalf of a user. It can access user resources, run an Amazon Braket job container on behalf of user, and output resources to the s3 buckets of a user.

Type: String

Pattern: ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$

startedAt

The date and time that the Amazon Braket job was started.

Type: Timestamp

status

The status of the Amazon Braket job.

Type: String

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

stoppingCondition

The user-defined criteria that specifies when to stop a job running.

Type: JobStoppingCondition object

tags

A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.

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: