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

GetJob

Retrieves the specified Amazon Braket hybrid job.

Request Syntax


GET /job/jobArn?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

jobArn

The ARN of the hybrid 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"
      }
   },
   "associations": [ 
      { 
         "arn": "string",
         "type": "string"
      }
   ],
   "billableDuration": number,
   "checkpointConfig": { 
      "localPath": "string",
      "s3Uri": "string"
   },
   "createdAt": "string",
   "deviceConfig": { 
      "device": "string"
   },
   "endedAt": "string",
   "events": [ 
      { 
         "eventType": "string",
         "message": "string",
         "timeOfEvent": "string"
      }
   ],
   "failureReason": "string",
   "hyperParameters": { 
      "string" : "string" 
   },
   "inputDataConfig": [ 
      { 
         "channelName": "string",
         "contentType": "string",
         "dataSource": { 
            "s3DataSource": { 
               "s3Uri": "string"
            }
         }
      }
   ],
   "instanceConfig": { 
      "instanceCount": number,
      "instanceType": "string",
      "volumeSizeInGb": number
   },
   "jobArn": "string",
   "jobName": "string",
   "outputDataConfig": { 
      "kmsKeyId": "string",
      "s3Path": "string"
   },
   "queueInfo": { 
      "message": "string",
      "position": "string",
      "queue": "string"
   },
   "roleArn": "string",
   "startedAt": "string",
   "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 hybrid job created. Provides information about the container image used, and the Python scripts used for training.

Type: AlgorithmSpecification object

associations

The list of Amazon Braket resources associated with the hybrid job.

Type: Array of Association objects

billableDuration

The billable time for which the Amazon Braket hybrid job used to complete.

Type: Integer

checkpointConfig

Information about the output locations for hybrid job checkpoint data.

Type: JobCheckpointConfig object

createdAt

The time at which the Amazon Braket hybrid job was created.

Type: Timestamp

deviceConfig

The primary device used by the Amazon Braket hybrid job.

Type: DeviceConfig object

endedAt

The time at which the Amazon Braket hybrid job ended.

Type: Timestamp

events

Details about the time and type of events occurred related to the Amazon Braket hybrid 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 hybrid 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 hybrid job that influence the quality of the traiing job. The values are set with a map 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.

Value Pattern: ^.*$

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

Type: String

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

jobName

The name of the Amazon Braket hybrid 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 hybrid job artifacts are stored and the encryption key used to store them there.

Type: JobOutputDataConfig object

queueInfo

Queue information for the requested hybrid job. Only returned if QueueInfo is specified in the additionalAttributeNames" field in the GetJob API request.

Type: HybridJobQueueInfo 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 results and other hybrid job details 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 time at which the Amazon Braket hybrid job was started.

Type: Timestamp

status

The status of the Amazon Braket hybrid job.

Type: String

stoppingCondition

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

Type: JobStoppingCondition object

tags

The tags associated with this hybrid job.

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