AWS App Runner Deployments API

Manage deployments and operations

GitHub OpenAPI
Business capability
Deployment Orchestration BC-4210.40

Operations 2

POST /#StartDeployment Start Deployment #
POST /#ListOperations List Operations #

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/aws-app-runner:aws-app-runner-deployments-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

aws-app-runner-deployments-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: AWS App Runner Deployments API
  version: '2020-05-15'
  description: Generated from AWS's published Smithy model for AWS App Runner. 2 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://apprunner.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#StartDeployment:
    post:
      operationId: StartDeployment
      summary: Start Deployment
      description: Initiate a manual deployment of the latest commit in a source code repository or the latest image in a
        source image repository to an App Runner service. For a source code repository, App Runner retrieves the commit and
        builds a Docker image. For a source image repository, App Runner retrieves the latest Docker image. In both cases,
        App Runner then deploys the new image to your service and starts a new container instance. This is an asynchronous
        operation. On a successful call, you can use the returned OperationId and the ListOperations call to track the operation's
        progress.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/StartDeploymentResponse'
        '500':
          description: InternalServiceErrorException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServiceErrorException'
        '400':
          description: InvalidRequestException; ResourceNotFoundException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AppRunner.StartDeployment
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/StartDeploymentRequest'
      tags:
      - Deployments
  /#ListOperations:
    post:
      operationId: ListOperations
      summary: List Operations
      description: Return a list of operations that occurred on an App Runner service. The resulting list of OperationSummary
        objects is sorted in reverse chronological order. The first object on the list represents the last started operation.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ListOperationsResponse'
        '500':
          description: InternalServiceErrorException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServiceErrorException'
        '400':
          description: InvalidRequestException; ResourceNotFoundException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AppRunner.ListOperations
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/ListOperationsRequest'
      tags:
      - Deployments
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: apprunner
  schemas:
    InternalServiceErrorException:
      type: object
      properties:
        Message:
          type: string
    InvalidRequestException:
      type: object
      properties:
        Message:
          type: string
    ListOperationsRequest:
      type: object
      properties:
        ServiceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the App Runner service that you want a list of operations for.
        NextToken:
          type: string
          description: A token from a previous result page. It's used for a paginated request. The request retrieves the next
            result page. All other parameter values must be identical to the ones specified in the initial request. If you
            don't specify NextToken, the request retrieves the first result page.
        MaxResults:
          type: integer
          description: The maximum number of results to include in each response (result page). It's used for a paginated
            request. If you don't specify MaxResults, the request retrieves all available results in a single response.
      required:
      - ServiceArn
    ListOperationsResponse:
      type: object
      properties:
        OperationSummaryList:
          type: array
          items:
            $ref: '#/components/schemas/OperationSummary'
          description: A list of operation summary information records. In a paginated request, the request returns up to
            MaxResults records for each call.
        NextToken:
          type: string
          description: The token that you can pass in a subsequent request to get the next result page. It's returned in a
            paginated request.
    OperationSummary:
      type: object
      properties:
        Id:
          type: string
          description: A unique ID of this operation. It's unique in the scope of the App Runner service.
        Type:
          type: string
          enum:
          - START_DEPLOYMENT
          - CREATE_SERVICE
          - PAUSE_SERVICE
          - RESUME_SERVICE
          - DELETE_SERVICE
          - UPDATE_SERVICE
          description: The type of operation. It indicates a specific action that occured.
        Status:
          type: string
          enum:
          - PENDING
          - IN_PROGRESS
          - FAILED
          - SUCCEEDED
          - ROLLBACK_IN_PROGRESS
          - ROLLBACK_FAILED
          - ROLLBACK_SUCCEEDED
          description: The current state of the operation.
        TargetArn:
          type: string
          description: The Amazon Resource Name (ARN) of the resource that the operation acted on (for example, an App Runner
            service).
        StartedAt:
          type: string
          format: date-time
          description: The time when the operation started. It's in the Unix time stamp format.
        EndedAt:
          type: string
          format: date-time
          description: The time when the operation ended. It's in the Unix time stamp format.
        UpdatedAt:
          type: string
          format: date-time
          description: The time when the operation was last updated. It's in the Unix time stamp format.
    StartDeploymentRequest:
      type: object
      properties:
        ServiceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the App Runner service that you want to manually deploy to.
      required:
      - ServiceArn
    StartDeploymentResponse:
      type: object
      properties:
        OperationId:
          type: string
          description: The unique ID of the asynchronous operation that this request started. You can use it combined with
            the ListOperations call to track the operation's progress.
      required:
      - OperationId
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/apprunner/service/2020-05-15/apprunner-2020-05-15.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)