Amazon CodeDeploy Deployments API

openapi: 3.0.0
info:
  version: '2014-10-06'
  x-release: v4
  title: AWS CodeDeploy Applications Deployments API
  description: '<p>CodeDeploy is a deployment service that automates application deployments to Amazon EC2 instances, on-premises instances running in your own facility, serverless Lambda functions, or applications in an Amazon ECS service.</p> <p>You can deploy a nearly unlimited variety of application content, such as an updated Lambda function, updated applications in an Amazon ECS service, code, web and configuration files, executables, packages, scripts, multimedia files, and so on. CodeDeploy can deploy application content stored in Amazon S3 buckets, GitHub repositories, or Bitbucket repositories. You do not need to make changes to your existing code before you can use CodeDeploy.</p> <p>CodeDeploy makes it easier for you to rapidly release new features, helps you avoid downtime during application deployment, and handles the complexity of updating your applications, without many of the risks associated with error-prone manual deployments.</p> <p> <b>CodeDeploy Components</b> </p> <p>Use the information in this guide to help you work with the following CodeDeploy components:</p> <ul> <li> <p> <b>Application</b>: A name that uniquely identifies the application you want to deploy. CodeDeploy uses this name, which functions as a container, to ensure the correct combination of revision, deployment configuration, and deployment group are referenced during a deployment.</p> </li> <li> <p> <b>Deployment group</b>: A set of individual instances, CodeDeploy Lambda deployment configuration settings, or an Amazon ECS service and network details. A Lambda deployment group specifies how to route traffic to a new version of a Lambda function. An Amazon ECS deployment group specifies the service created in Amazon ECS to deploy, a load balancer, and a listener to reroute production traffic to an updated containerized application. An Amazon EC2/On-premises deployment group contains individually tagged instances, Amazon EC2 instances in Amazon EC2 Auto Scaling groups, or both. All deployment groups can specify optional trigger, alarm, and rollback settings.</p> </li> <li> <p> <b>Deployment configuration</b>: A set of deployment rules and deployment success and failure conditions used by CodeDeploy during a deployment.</p> </li> <li> <p> <b>Deployment</b>: The process and the components used when updating a Lambda function, a containerized application in an Amazon ECS service, or of installing content on one or more instances. </p> </li> <li> <p> <b>Application revisions</b>: For an Lambda deployment, this is an AppSpec file that specifies the Lambda function to be updated and one or more functions to validate deployment lifecycle events. For an Amazon ECS deployment, this is an AppSpec file that specifies the Amazon ECS task definition, container, and port where production traffic is rerouted. For an EC2/On-premises deployment, this is an archive file that contains source content—source code, webpages, executable files, and deployment scripts—along with an AppSpec file. Revisions are stored in Amazon S3 buckets or GitHub repositories. For Amazon S3, a revision is uniquely identified by its Amazon S3 object key and its ETag, version, or both. For GitHub, a revision is uniquely identified by its commit ID.</p> </li> </ul> <p>This guide also contains information to help you get details about the instances in your deployments, to make on-premises instances available for CodeDeploy deployments, to get details about a Lambda function deployment, and to get details about Amazon ECS service deployments.</p> <p> <b>CodeDeploy Information Resources</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/codedeploy/latest/userguide">CodeDeploy User Guide</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/codedeploy/latest/APIReference/">CodeDeploy API Reference Guide</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/cli/latest/reference/deploy/index.html">CLI Reference for CodeDeploy</a> </p> </li> <li> <p> <a href="https://forums.aws.amazon.com/forum.jspa?forumID=179">CodeDeploy Developer Forum</a> </p> </li> </ul>'
  x-logo:
    url: https://twitter.com/awscloud/profile_image?size=original
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: codedeploy
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/codedeploy-2014-10-06.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://codedeploy.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The CodeDeploy multi-region endpoint
- url: https://codedeploy.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The CodeDeploy multi-region endpoint
- url: http://codedeploy.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The CodeDeploy endpoint for China (Beijing) and China (Ningxia)
- url: https://codedeploy.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The CodeDeploy endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Deployments
  description: Operations for creating and monitoring deployments
paths:
  /deployments:
    post:
      operationId: CreateDeployment
      summary: Amazon CodeDeploy Create a Deployment
      description: Deploys an application revision through the specified deployment group.
      tags:
      - Deployments
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDeploymentRequest'
            examples:
              CreateDeploymentRequestExample:
                summary: Default CreateDeployment request
                x-microcks-default: true
                value:
                  applicationName: example-resource
                  deploymentGroupName: example-resource
                  revision:
                    revisionType: S3
                    s3Location:
                      bucket: example-value
                      key: example-value
                      bundleType: tar
                    gitHubLocation:
                      repository: example-value
                      commitId: '500123'
                  description: Example description
                  autoRollbackConfiguration:
                    enabled: true
                    events:
                    - DEPLOYMENT_FAILURE
      responses:
        '200':
          description: Deployment created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateDeploymentResponse'
              examples:
                CreateDeployment200Example:
                  summary: Default CreateDeployment 200 response
                  x-microcks-default: true
                  value:
                    deploymentId: '500123'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidDeploymentGroupNameException'
              examples:
                CreateDeployment400Example:
                  summary: Default CreateDeployment 400 response
                  x-microcks-default: true
                  value:
                    message: example-value
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
              examples:
                CreateDeployment500Example:
                  summary: Default CreateDeployment 500 response
                  x-microcks-default: true
                  value:
                    message: example-value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    get:
      operationId: ListDeployments
      summary: Amazon CodeDeploy List Deployments
      description: Lists the deployments in a deployment group for an application registered with the user or AWS account.
      tags:
      - Deployments
      parameters:
      - name: applicationName
        in: query
        description: The name of the application.
        schema:
          type: string
      - name: deploymentGroupName
        in: query
        description: The name of the deployment group.
        schema:
          type: string
      - name: nextToken
        in: query
        description: Token for pagination.
        schema:
          type: string
      - name: includeOnlyStatuses
        in: query
        description: Filter by deployment status.
        schema:
          type: array
          items:
            type: string
            enum:
            - Created
            - Queued
            - InProgress
            - Baking
            - Succeeded
            - Failed
            - Stopped
            - Ready
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDeploymentsResponse'
              examples:
                ListDeployments200Example:
                  summary: Default ListDeployments 200 response
                  x-microcks-default: true
                  value:
                    deployments:
                    - example-value
                    nextToken: example-value
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidApplicationNameException'
              examples:
                ListDeployments400Example:
                  summary: Default ListDeployments 400 response
                  x-microcks-default: true
                  value:
                    message: example-value
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
              examples:
                ListDeployments500Example:
                  summary: Default ListDeployments 500 response
                  x-microcks-default: true
                  value:
                    message: example-value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /deployments/{deploymentId}:
    get:
      operationId: GetDeployment
      summary: Amazon CodeDeploy Get Deployment Details
      description: Gets information about a deployment, including details about the deployment status.
      tags:
      - Deployments
      parameters:
      - name: deploymentId
        in: path
        required: true
        description: The unique ID of a deployment.
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDeploymentResponse'
              examples:
                GetDeployment200Example:
                  summary: Default GetDeployment 200 response
                  x-microcks-default: true
                  value:
                    deploymentInfo:
                      deploymentId: '500123'
                      applicationName: example-resource
                      deploymentGroupName: example-resource
                      status: Created
                      createTime: example-value
                      startTime: example-value
                      completeTime: example-value
                      description: Example description
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidDeploymentIdException'
              examples:
                GetDeployment400Example:
                  summary: Default GetDeployment 400 response
                  x-microcks-default: true
                  value:
                    message: example-value
        '404':
          description: Deployment not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentDoesNotExistException'
              examples:
                GetDeployment404Example:
                  summary: Default GetDeployment 404 response
                  x-microcks-default: true
                  value:
                    message: example-value
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
              examples:
                GetDeployment500Example:
                  summary: Default GetDeployment 500 response
                  x-microcks-default: true
                  value:
                    message: example-value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    DeploymentDoesNotExistException:
      type: object
      properties:
        message:
          type: string
    InvalidApplicationNameException:
      type: object
      properties:
        message:
          type: string
    InternalServerException:
      type: object
      properties:
        message:
          type: string
    InvalidDeploymentGroupNameException:
      type: object
      properties:
        message:
          type: string
    ListDeploymentsResponse:
      type: object
      properties:
        deployments:
          type: array
          items:
            type: string
        nextToken:
          type: string
    CreateDeploymentResponse:
      type: object
      properties:
        deploymentId:
          type: string
    GetDeploymentResponse:
      type: object
      properties:
        deploymentInfo:
          type: object
          properties:
            deploymentId:
              type: string
            applicationName:
              type: string
            deploymentGroupName:
              type: string
            status:
              type: string
              enum:
              - Created
              - Queued
              - InProgress
              - Baking
              - Succeeded
              - Failed
              - Stopped
              - Ready
            createTime:
              type: string
              format: date-time
            startTime:
              type: string
              format: date-time
            completeTime:
              type: string
              format: date-time
            description:
              type: string
            creator:
              type: string
            computePlatform:
              type: string
    InvalidDeploymentIdException:
      type: object
      properties:
        message:
          type: string
    CreateDeploymentRequest:
      type: object
      required:
      - applicationName
      - deploymentGroupName
      properties:
        applicationName:
          type: string
          description: The name of the application.
        deploymentGroupName:
          type: string
          description: The name of the deployment group.
        revision:
          type: object
          properties:
            revisionType:
              type: string
              enum:
              - S3
              - GitHub
              - String
              - AppSpecContent
            s3Location:
              type: object
              properties:
                bucket:
                  type: string
                key:
                  type: string
                bundleType:
                  type: string
                  enum:
                  - tar
                  - tgz
                  - zip
                  - YAML
                  - JSON
            gitHubLocation:
              type: object
              properties:
                repository:
                  type: string
                commitId:
                  type: string
        description:
          type: string
          description: A comment about the deployment.
        autoRollbackConfiguration:
          type: object
          properties:
            enabled:
              type: boolean
            events:
              type: array
              items:
                type: string
                enum:
                - DEPLOYMENT_FAILURE
                - DEPLOYMENT_STOP_ON_ALARM
                - DEPLOYMENT_STOP_ON_REQUEST
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/codedeploy/
x-hasEquivalentPaths: true