POST

/job

http://braket.{region}.amazonaws.com/job

Creates an Amazon Braket job.

Access Token Required: API Key

Body Params

tagsobject

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

jobNamestringrequired

The name of the Amazon Braket job.

roleArnstringrequired

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 users' s3 buckets.

clientTokenstringrequired

A unique token that guarantees that the call to this API is idempotent.

deviceConfigobjectrequired

Configures the quantum processing units (QPUs) or simulator used to create and run an Amazon Braket job.

instanceConfigobjectrequired

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

hyperParametersobject

Algorithm-specific parameters used by an Amazon Braket job that influence the quality of the training 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.

inputDataConfigarray

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

checkpointConfigobject

Contains information about the output locations for job checkpoint data.

outputDataConfigobjectrequired

Specifies the path to the S3 location where you want to store job artifacts and the encryption key used to store them.

stoppingConditionobject

Specifies limits for how long an Amazon Braket job can run.

algorithmSpecificationobjectrequired

Defines the Amazon Braket job to be created. Specifies the container image the job uses and the paths to the Python scripts used for entry and training.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://braket.{region}.amazonaws.com/job' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}