Amazon Amplify

Amazon Amplify Amplify Jobs API

The Amplify Jobs API from Amazon Amplify — 2 operation(s) for amplify jobs.

GitHub OpenAPI
Business capability
Continuous Integration Management BC-4210.10

Operations 4

DELETE /apps/{appId}/branches/{branchName}/jobs/{jobId} Delete Job #
GET /apps/{appId}/branches/{branchName}/jobs/{jobId} Get Job #
GET /apps/{appId}/branches/{branchName}/jobs List Jobs #
POST /apps/{appId}/branches/{branchName}/jobs Start Job #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-amplify/openapi/amazon-amplify-jobs-api-openapi.yml

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-amplify:amazon-amplify-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.

GitHub Google LinkedIn

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

OpenAPI Specification

amazon-amplify-jobs-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: AWS Amplify Jobs API
  version: '2017-07-25'
  description: Generated from AWS's published Smithy model for AWS Amplify. 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://amplify.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /apps/{appId}/branches/{branchName}/jobs/{jobId}:
    delete:
      operationId: DeleteJob
      summary: Delete Job
      description: Deletes a job for a branch of an Amplify app.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteJobResult'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '429':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteJobRequest'
      tags:
      - Jobs
    get:
      operationId: GetJob
      summary: Get Job
      description: Returns a job for a branch of an Amplify app.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetJobResult'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '429':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetJobRequest'
      tags:
      - Jobs
  /apps/{appId}/branches/{branchName}/jobs:
    get:
      operationId: ListJobs
      summary: List Jobs
      description: Lists the jobs for a branch of an Amplify app.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListJobsResult'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '429':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListJobsRequest'
      tags:
      - Jobs
    post:
      operationId: StartJob
      summary: Start Job
      description: Starts a new job for a branch of an Amplify app.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartJobResult'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '429':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartJobRequest'
      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: amplify
  schemas:
    BadRequestException:
      type: object
      properties:
        message:
          type: string
    DeleteJobRequest:
      type: object
      properties:
        appId:
          type: string
          description: The unique ID for an Amplify app.
        branchName:
          type: string
          description: The name of the branch to use for the job.
        jobId:
          type: string
          description: The unique ID for the job.
      required:
      - appId
      - branchName
      - jobId
    DeleteJobResult:
      type: object
      properties:
        jobSummary:
          $ref: '#/components/schemas/JobSummary'
      required:
      - jobSummary
    GetJobRequest:
      type: object
      properties:
        appId:
          type: string
          description: The unique ID for an Amplify app.
        branchName:
          type: string
          description: The name of the branch to use for the job.
        jobId:
          type: string
          description: The unique ID for the job.
      required:
      - appId
      - branchName
      - jobId
    GetJobResult:
      type: object
      properties:
        job:
          $ref: '#/components/schemas/Job'
      required:
      - job
    InternalFailureException:
      type: object
      properties:
        message:
          type: string
    Job:
      type: object
      properties:
        summary:
          $ref: '#/components/schemas/JobSummary'
        steps:
          type: array
          items:
            $ref: '#/components/schemas/Step'
          description: The execution steps for an execution job, for an Amplify app.
      required:
      - summary
      - steps
    JobSummary:
      type: object
      properties:
        jobArn:
          type: string
          description: The Amazon Resource Name (ARN) for the job.
        jobId:
          type: string
          description: The unique ID for the job.
        commitId:
          type: string
          description: The commit ID from a third-party repository provider for the job.
        commitMessage:
          type: string
          description: The commit message from a third-party repository provider for the job.
        commitTime:
          type: string
          format: date-time
          description: The commit date and time for the job.
        startTime:
          type: string
          format: date-time
          description: The start date and time for the job.
        status:
          type: string
          enum:
          - CREATED
          - PENDING
          - PROVISIONING
          - RUNNING
          - FAILED
          - SUCCEED
          - CANCELLING
          - CANCELLED
          description: The current status for the job.
        endTime:
          type: string
          format: date-time
          description: The end date and time for the job.
        jobType:
          type: string
          enum:
          - RELEASE
          - RETRY
          - MANUAL
          - WEB_HOOK
          description: The type for the job. If the value is RELEASE, the job was manually released from its source by using
            the StartJob API. This value is available only for apps that are connected to a repository. If the value is RETRY,
            the job was manually retried using the StartJob API. If the value is WEB_HOOK, the job was automatically triggered
            by webhooks. If the value is MANUAL, the job is for a manually deployed app. Manually deployed apps are not connected
            to a Git repository.
        sourceUrl:
          type: string
          description: The source URL for the files to deploy. The source URL can be either an HTTP GET URL that is publicly
            accessible and downloads a single .zip file, or an Amazon S3 bucket and prefix.
        sourceUrlType:
          type: string
          enum:
          - ZIP
          - BUCKET_PREFIX
          description: The type of source specified by the sourceURL. If the value is ZIP, the source is a .zip file. If the
            value is BUCKET_PREFIX, the source is an Amazon S3 bucket and prefix. If no value is specified, the default is
            ZIP.
      required:
      - jobArn
      - jobId
      - commitId
      - commitMessage
      - commitTime
      - startTime
      - status
      - jobType
    LimitExceededException:
      type: object
      properties:
        message:
          type: string
    ListJobsRequest:
      type: object
      properties:
        appId:
          type: string
          description: The unique ID for an Amplify app.
        branchName:
          type: string
          description: The name of the branch to use for the request.
        nextToken:
          type: string
          description: A pagination token. Set to null to start listing steps from the start. If a non-null pagination token
            is returned in a result, pass its value in here to list more steps.
        maxResults:
          type: integer
          description: The maximum number of records to list in a single response.
      required:
      - appId
      - branchName
    ListJobsResult:
      type: object
      properties:
        jobSummaries:
          type: array
          items:
            $ref: '#/components/schemas/JobSummary'
          description: The result structure for the list job result request.
        nextToken:
          type: string
          description: A pagination token. If non-null the pagination token is returned in a result. Pass its value in another
            request to retrieve more entries.
      required:
      - jobSummaries
    NotFoundException:
      type: object
      properties:
        message:
          type: string
    StartJobRequest:
      type: object
      properties:
        appId:
          type: string
          description: The unique ID for an Amplify app.
        branchName:
          type: string
          description: The name of the branch to use for the job.
        jobId:
          type: string
          description: The unique ID for an existing job. This is required if the value of jobType is RETRY.
        jobType:
          type: string
          enum:
          - RELEASE
          - RETRY
          - MANUAL
          - WEB_HOOK
          description: Describes the type for the job. The job type RELEASE starts a new job with the latest change from the
            specified branch. This value is available only for apps that are connected to a repository. The job type RETRY
            retries an existing job. If the job type value is RETRY, the jobId is also required.
        jobReason:
          type: string
          description: A descriptive reason for starting the job.
        commitId:
          type: string
          description: The commit ID from a third-party repository provider for the job.
        commitMessage:
          type: string
          description: The commit message from a third-party repository provider for the job.
        commitTime:
          type: string
          format: date-time
          description: The commit date and time for the job.
      required:
      - appId
      - branchName
      - jobType
    StartJobResult:
      type: object
      properties:
        jobSummary:
          $ref: '#/components/schemas/JobSummary'
      required:
      - jobSummary
    Step:
      type: object
      properties:
        stepName:
          type: string
          description: The name of the execution step.
        startTime:
          type: string
          format: date-time
          description: The start date and time of the execution step.
        status:
          type: string
          enum:
          - CREATED
          - PENDING
          - PROVISIONING
          - RUNNING
          - FAILED
          - SUCCEED
          - CANCELLING
          - CANCELLED
          description: The status of the execution step.
        endTime:
          type: string
          format: date-time
          description: The end date and time of the execution step.
        logUrl:
          type: string
          description: The URL to the logs for the execution step.
        artifactsUrl:
          type: string
          description: The URL to the build artifact for the execution step.
        testArtifactsUrl:
          type: string
          description: The URL to the test artifact for the execution step.
        testConfigUrl:
          type: string
          description: The URL to the test configuration for the execution step.
        screenshots:
          type: object
          additionalProperties:
            type: string
          description: The list of screenshot URLs for the execution step, if relevant.
        statusReason:
          type: string
          description: The reason for the current step status.
        context:
          type: string
          description: The context for the current step. Includes a build image if the step is build.
      required:
      - stepName
      - startTime
      - status
      - endTime
    UnauthorizedException:
      type: object
      properties:
        message:
          type: string
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/amplify/service/2017-07-25/amplify-2017-07-25.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)