Amazon Braket Jobs API

Manage hybrid quantum-classical jobs

GitHub OpenAPI

Operations 4

POST /jobs Search Jobs #
POST /job Create Job #
GET /job/{jobArn} Get Job #
PUT /job/{jobArn}/cancel Cancel Job #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-braket:amazon-braket-jobs-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-braket-jobs-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Braket Jobs API
  version: '2019-09-01'
  description: Generated from AWS's published Smithy model for Braket. 4 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://braket.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /jobs:
    post:
      operationId: SearchJobs
      summary: Search Jobs
      description: Searches for Amazon Braket hybrid jobs that match the specified filter values.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchJobsResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchJobsRequest'
      tags:
      - Jobs
  /job:
    post:
      operationId: CreateJob
      summary: Create Job
      description: Creates an Amazon Braket hybrid job.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateJobResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '424':
          description: DeviceOfflineException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceOfflineException'
        '410':
          description: DeviceRetiredException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceRetiredException'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateJobRequest'
      tags:
      - Jobs
  /job/{jobArn}:
    get:
      operationId: GetJob
      summary: Get Job
      description: Retrieves the specified Amazon Braket hybrid job.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetJobResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetJobRequest'
      tags:
      - Jobs
  /job/{jobArn}/cancel:
    put:
      operationId: CancelJob
      summary: Cancel Job
      description: Cancels an Amazon Braket hybrid job.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelJobResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelJobRequest'
      tags:
      - Jobs
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: braket
  schemas:
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
    AlgorithmSpecification:
      type: object
      properties:
        scriptModeConfig:
          $ref: '#/components/schemas/ScriptModeConfig'
        containerImage:
          $ref: '#/components/schemas/ContainerImage'
    Association:
      type: object
      properties:
        arn:
          type: string
          description: The Amazon Braket resource arn.
        type:
          type: string
          description: The association type for the specified Amazon Braket resource arn.
      required:
      - arn
      - type
    CancelJobRequest:
      type: object
      properties:
        jobArn:
          type: string
          description: The ARN of the Amazon Braket hybrid job to cancel.
      required:
      - jobArn
    CancelJobResponse:
      type: object
      properties:
        jobArn:
          type: string
          description: The ARN of the Amazon Braket job.
        cancellationStatus:
          type: string
          description: The status of the hybrid job.
      required:
      - jobArn
      - cancellationStatus
    ConflictException:
      type: object
      properties:
        message:
          type: string
    ContainerImage:
      type: object
      properties:
        uri:
          type: string
          description: The URI locating the container image.
      required:
      - uri
    CreateJobRequest:
      type: object
      properties:
        clientToken:
          type: string
          description: The client token associated with this request that guarantees that the request is idempotent.
        algorithmSpecification:
          $ref: '#/components/schemas/AlgorithmSpecification'
        inputDataConfig:
          type: array
          items:
            $ref: '#/components/schemas/InputFileConfig'
          description: A list of parameters that specify the name and type of input data and where it is located.
        outputDataConfig:
          $ref: '#/components/schemas/JobOutputDataConfig'
        checkpointConfig:
          $ref: '#/components/schemas/JobCheckpointConfig'
        jobName:
          type: string
          description: The name of the Amazon Braket hybrid job.
        roleArn:
          type: string
          description: 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 hybrid job details to the users' s3 buckets.
        stoppingCondition:
          $ref: '#/components/schemas/JobStoppingCondition'
        instanceConfig:
          $ref: '#/components/schemas/InstanceConfig'
        hyperParameters:
          type: object
          additionalProperties:
            type: string
          description: Algorithm-specific parameters used by an Amazon Braket hybrid job that influence the quality of the
            training 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 the hyperparameter. Do not include any security-sensitive information including
            account access IDs, secrets, or tokens in any hyperparameter fields. As part of the shared responsibility model,
            you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused
            by security-sensitive information included i
        deviceConfig:
          $ref: '#/components/schemas/DeviceConfig'
        tags:
          type: object
          additionalProperties:
            type: string
          description: Tags to be added to the hybrid job you're creating.
        associations:
          type: array
          items:
            $ref: '#/components/schemas/Association'
          description: The list of Amazon Braket resources associated with the hybrid job.
      required:
      - clientToken
      - algorithmSpecification
      - outputDataConfig
      - jobName
      - roleArn
      - instanceConfig
      - deviceConfig
    CreateJobResponse:
      type: object
      properties:
        jobArn:
          type: string
          description: The ARN of the Amazon Braket hybrid job created.
      required:
      - jobArn
    DataSource:
      type: object
      properties:
        s3DataSource:
          $ref: '#/components/schemas/S3DataSource'
      required:
      - s3DataSource
    DeviceConfig:
      type: object
      properties:
        device:
          type: string
          description: The primary device ARN used to create and run an Amazon Braket hybrid job.
      required:
      - device
    DeviceOfflineException:
      type: object
      properties:
        message:
          type: string
    DeviceRetiredException:
      type: object
      properties:
        message:
          type: string
    GetJobRequest:
      type: object
      properties:
        jobArn:
          type: string
          description: The ARN of the hybrid job to retrieve.
        additionalAttributeNames:
          type: array
          items:
            type: string
          description: A list of attributes to return additional information for. Only the QueueInfo additional attribute
            name is currently supported.
      required:
      - jobArn
    GetJobResponse:
      type: object
      properties:
        status:
          type: string
          description: The status of the Amazon Braket hybrid job.
        jobArn:
          type: string
          description: The ARN of the Amazon Braket hybrid job.
        roleArn:
          type: string
          description: 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.
        failureReason:
          type: string
          description: A description of the reason why an Amazon Braket hybrid job failed, if it failed.
        jobName:
          type: string
          description: The name of the Amazon Braket hybrid job.
        hyperParameters:
          type: object
          additionalProperties:
            type: string
          description: 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.
        inputDataConfig:
          type: array
          items:
            $ref: '#/components/schemas/InputFileConfig'
          description: A list of parameters that specify the name and type of input data and where it is located.
        outputDataConfig:
          $ref: '#/components/schemas/JobOutputDataConfig'
        stoppingCondition:
          $ref: '#/components/schemas/JobStoppingCondition'
        checkpointConfig:
          $ref: '#/components/schemas/JobCheckpointConfig'
        algorithmSpecification:
          $ref: '#/components/schemas/AlgorithmSpecification'
        instanceConfig:
          $ref: '#/components/schemas/InstanceConfig'
        createdAt:
          type: string
          description: The time at which the Amazon Braket hybrid job was created.
        startedAt:
          type: string
          description: The time at which the Amazon Braket hybrid job was started.
        endedAt:
          type: string
          description: The time at which the Amazon Braket hybrid job ended.
        billableDuration:
          type: integer
          description: The billable time for which the Amazon Braket hybrid job used to complete.
        deviceConfig:
          $ref: '#/components/schemas/DeviceConfig'
        events:
          type: array
          items:
            $ref: '#/components/schemas/JobEventDetails'
          description: Details about the time and type of events occurred related to the Amazon Braket hybrid job.
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags associated with this hybrid job.
        queueInfo:
          $ref: '#/components/schemas/HybridJobQueueInfo'
        associations:
          type: array
          items:
            $ref: '#/components/schemas/Association'
          description: The list of Amazon Braket resources associated with the hybrid job.
      required:
      - status
      - jobArn
      - roleArn
      - jobName
      - outputDataConfig
      - algorithmSpecification
      - instanceConfig
      - createdAt
    HybridJobQueueInfo:
      type: object
      properties:
        queue:
          type: string
          description: The name of the queue.
        position:
          type: string
          description: Current position of the hybrid job in the jobs queue.
        message:
          type: string
          description: Optional. Provides more information about the queue position. For example, if the hybrid job is complete
            and no longer in the queue, the message field contains that information.
      required:
      - queue
      - position
    InputFileConfig:
      type: object
      properties:
        channelName:
          type: string
          description: A named input source that an Amazon Braket hybrid job can consume.
        contentType:
          type: string
          description: The MIME type of the data.
        dataSource:
          $ref: '#/components/schemas/DataSource'
      required:
      - channelName
      - dataSource
    InstanceConfig:
      type: object
      properties:
        instanceType:
          type: string
          description: Configures the type of resource instances to use while running an Amazon Braket hybrid job.
        volumeSizeInGb:
          type: integer
          description: The size of the storage volume, in GB, to provision.
        instanceCount:
          type: integer
          description: Configures the number of resource instances to use while running an Amazon Braket hybrid job on Amazon
            Braket. The default value is 1.
      required:
      - instanceType
      - volumeSizeInGb
    InternalServiceException:
      type: object
      properties:
        message:
          type: string
    JobCheckpointConfig:
      type: object
      properties:
        localPath:
          type: string
          description: (Optional) The local directory where checkpoint data is stored. The default directory is /opt/braket/checkpoints/.
        s3Uri:
          type: string
          description: Identifies the S3 path where you want Amazon Braket to store checkpoint data. For example, s3://bucket-name/key-name-prefix.
      required:
      - s3Uri
    JobEventDetails:
      type: object
      properties:
        eventType:
          type: string
          description: The type of event that occurred related to the Amazon Braket hybrid job.
        timeOfEvent:
          type: string
          description: The time of the event that occurred related to the Amazon Braket hybrid job.
        message:
          type: string
          description: A message describing the event that occurred related to the Amazon Braket hybrid job.
    JobOutputDataConfig:
      type: object
      properties:
        kmsKeyId:
          type: string
          description: The AWS Key Management Service (AWS KMS) key that Amazon Braket uses to encrypt the hybrid job training
            artifacts at rest using Amazon S3 server-side encryption.
        s3Path:
          type: string
          description: Identifies the S3 path where you want Amazon Braket to store the hybrid job training artifacts. For
            example, s3://bucket-name/key-name-prefix.
      required:
      - s3Path
    JobStoppingCondition:
      type: object
      properties:
        maxRuntimeInSeconds:
          type: integer
          description: The maximum length of time, in seconds, that an Amazon Braket hybrid job can run.
    JobSummary:
      type: object
      properties:
        status:
          type: string
          description: The status of the Amazon Braket hybrid job.
        jobArn:
          type: string
          description: The ARN of the Amazon Braket hybrid job.
        jobName:
          type: string
          description: The name of the Amazon Braket hybrid job.
        device:
          type: string
          description: The primary device used by an Amazon Braket hybrid job.
        createdAt:
          type: string
          description: The time at which the Amazon Braket hybrid job was created.
        startedAt:
          type: string
          description: The time at which the Amazon Braket hybrid job was started.
        endedAt:
          type: string
          description: The time at which the Amazon Braket hybrid job ended.
        tags:
          type: object
          additionalProperties:
            type: string
          description: Displays the key, value pairs of tags associated with this hybrid job.
      required:
      - status
      - jobArn
      - jobName
      - device
      - createdAt
    ProgramSetValidationFailure:
      type: object
      properties:
        programIndex:
          type: integer
          description: The index of the program within the program set that failed validation.
        inputsIndex:
          type: integer
          description: The index of the input within the program set that failed validation.
        errors:
          type: array
          items:
            type: string
          description: A list of error messages describing the validation failures that occurred.
      required:
      - programIndex
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    S3DataSource:
      type: object
      properties:
        s3Uri:
          type: string
          description: Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest
            that locates the S3 data source.
      required:
      - s3Uri
    ScriptModeConfig:
      type: object
      properties:
        entryPoint:
          type: string
          description: The entry point in the algorithm scripts from where the execution begins in the hybrid job.
        s3Uri:
          type: string
          description: The URI that specifies the S3 path to the algorithm scripts used by an Amazon Braket hybrid job.
        compressionType:
          type: string
          description: The type of compression used to store the algorithm scripts in Amazon S3 storage.
      required:
      - entryPoint
      - s3Uri
    SearchJobsFilter:
      type: object
      properties:
        name:
          type: string
          description: The name of the hybrid job parameter to filter based on. Filter name can be either jobArn or createdAt.
        values:
          type: array
          items:
            type: string
          description: The values used to filter hybrid jobs based on the filter name and operator.
        operator:
          type: string
          description: An operator to use for the filter.
      required:
      - name
      - values
      - operator
    SearchJobsRequest:
      type: object
      properties:
        nextToken:
          type: string
          description: A token used for pagination of results returned in the response. Use the token returned from the previous
            request to continue search where the previous request ended.
        maxResults:
          type: integer
          description: The maximum number of results to return in the response.
        filters:
          type: array
          items:
            $ref: '#/components/schemas/SearchJobsFilter'
          description: Array of SearchJobsFilter objects to use when searching for hybrid jobs.
      required:
      - filters
    SearchJobsResponse:
      type: object
      properties:
        jobs:
          type: array
          items:
            $ref: '#/components/schemas/JobSummary'
          description: An array of JobSummary objects for devices that match the specified filter values.
        nextToken:
          type: string
          description: A token used for pagination of results, or null if there are no additional results. Use the token value
            in a subsequent request to continue search where the previous request ended.
      required:
      - jobs
    ServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
    ValidationException:
      type: object
      properties:
        message:
          type: string
        reason:
          type: string
          description: The reason for validation failure.
        programSetValidationFailures:
          type: array
          items:
            $ref: '#/components/schemas/ProgramSetValidationFailure'
          description: The validation failures in the program set submitted in the request.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/braket/service/2019-09-01/braket-2019-09-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)