Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

AWS Braket HybridJobs API

Hybrid quantum-classical job orchestration.

AWS Braket HybridJobs API is one of 5 APIs that AWS Braket publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 3 JSON Schema definitions.

Tagged areas include HybridJobs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 3 JSON Schemas.

This API exposes 4 operations across 4 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version 2019-09-01.

Requests are made against 3 base URLs: https://braket.us-east-1.amazonaws.com, https://braket.us-west-2.amazonaws.com, https://braket.eu-north-1.amazonaws.com.

4 operations 4 paths 3 schemas 1 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2019-09-01
Servers
https://braket.us-east-1.amazonaws.com
https://braket.us-west-2.amazonaws.com
https://braket.eu-north-1.amazonaws.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

AWS Braket HybridJobs API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (SigV4). By default, every request must be authenticated.

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 1 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

HybridJobs 4

Hybrid quantum-classical job orchestration.

POST
/job
AWS Braket Create A Hybrid Job
createJob body → 201400403409410424402429
GET
/job/{jobArn}
AWS Braket Get A Hybrid Job
getJob 1 param → 200
PUT
/job/{jobArn}/cancel
AWS Braket Cancel A Hybrid Job
cancelJob 1 param → 200
POST
/jobs
AWS Braket Search Hybrid Jobs
searchJobs body → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Job (16 properties), CreateJobRequest (13 properties), JobSummary (8 properties). Each schema is shown below with its type and property counts.

Job
object
16 properties
JobSummary
object
8 properties
CreateJobRequest
object
13 properties 7 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aws-braket-hybridjobs-api-openapi.yml Raw ↑

Other APIs AWS Braket publishes across the network.

AWS Braket Devices API
AWS Braket Tags API
AWS Braket QuantumTasks API
AWS Braket SpendingLimits API