openapi: 3.0.0
info:
  version: '2014-10-06'
  x-release: v4
  title: AWS CodeDeploy Applications 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: Applications
  description: Operations for creating and managing CodeDeploy applications
paths:
  /applications:
    post:
      operationId: CreateApplication
      summary: Amazon CodeDeploy Create an Application
      description: Creates an application. An application is a name that represents the compute platform on which you deploy (EC2/On-premises, Lambda, or ECS).
      tags:
      - Applications
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateApplicationRequest'
            examples:
              CreateApplicationRequestExample:
                summary: Default CreateApplication request
                x-microcks-default: true
                value:
                  applicationName: example-resource
                  computePlatform: Server
      responses:
        '200':
          description: Application created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateApplicationResponse'
              examples:
                CreateApplication200Example:
                  summary: Default CreateApplication 200 response
                  x-microcks-default: true
                  value:
                    applicationId: '500123'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidApplicationNameException'
              examples:
                CreateApplication400Example:
                  summary: Default CreateApplication 400 response
                  x-microcks-default: true
                  value:
                    message: example-value
        '409':
          description: Application already exists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationAlreadyExistsException'
              examples:
                CreateApplication409Example:
                  summary: Default CreateApplication 409 response
                  x-microcks-default: true
                  value:
                    message: example-value
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
              examples:
                CreateApplication500Example:
                  summary: Default CreateApplication 500 response
                  x-microcks-default: true
                  value:
                    message: example-value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    get:
      operationId: ListApplications
      summary: Amazon CodeDeploy List Applications
      description: Lists the applications registered with the user or AWS account.
      tags:
      - Applications
      parameters:
      - name: nextToken
        in: query
        description: Token for pagination.
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListApplicationsResponse'
              examples:
                ListApplications200Example:
                  summary: Default ListApplications 200 response
                  x-microcks-default: true
                  value:
                    applications:
                    - example-value
                    nextToken: example-value
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidNextTokenException'
              examples:
                ListApplications400Example:
                  summary: Default ListApplications 400 response
                  x-microcks-default: true
                  value:
                    message: example-value
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
              examples:
                ListApplications500Example:
                  summary: Default ListApplications 500 response
                  x-microcks-default: true
                  value:
                    message: example-value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /applications/{applicationName}:
    get:
      operationId: GetApplication
      summary: Amazon CodeDeploy Get Application Details
      description: Gets information about an application.
      tags:
      - Applications
      parameters:
      - name: applicationName
        in: path
        required: true
        description: The name of the application.
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApplicationResponse'
              examples:
                GetApplication200Example:
                  summary: Default GetApplication 200 response
                  x-microcks-default: true
                  value:
                    application:
                      applicationId: '500123'
                      applicationName: example-resource
                      computePlatform: example-value
                      createTime: example-value
                      linkedToGitHub: true
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidApplicationNameException'
              examples:
                GetApplication400Example:
                  summary: Default GetApplication 400 response
                  x-microcks-default: true
                  value:
                    message: example-value
        '404':
          description: Application not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationDoesNotExistException'
              examples:
                GetApplication404Example:
                  summary: Default GetApplication 404 response
                  x-microcks-default: true
                  value:
                    message: example-value
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
              examples:
                GetApplication500Example:
                  summary: Default GetApplication 500 response
                  x-microcks-default: true
                  value:
                    message: example-value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: DeleteApplication
      summary: Amazon CodeDeploy Delete an Application
      description: Deletes an application along with all associated deployment groups and revisions.
      tags:
      - Applications
      parameters:
      - name: applicationName
        in: path
        required: true
        description: The name of the application to delete.
        schema:
          type: string
      responses:
        '200':
          description: Application deleted
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidApplicationNameException'
              examples:
                DeleteApplication400Example:
                  summary: Default DeleteApplication 400 response
                  x-microcks-default: true
                  value:
                    message: example-value
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
              examples:
                DeleteApplication500Example:
                  summary: Default DeleteApplication 500 response
                  x-microcks-default: true
                  value:
                    message: example-value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    CreateApplicationRequest:
      type: object
      required:
      - applicationName
      properties:
        applicationName:
          type: string
          description: The name of the application.
        computePlatform:
          type: string
          description: The destination platform type for the deployment.
          enum:
          - Server
          - Lambda
          - ECS
    ApplicationAlreadyExistsException:
      type: object
      properties:
        message:
          type: string
    InvalidNextTokenException:
      type: object
      properties:
        message:
          type: string
    InternalServerException:
      type: object
      properties:
        message:
          type: string
    InvalidApplicationNameException:
      type: object
      properties:
        message:
          type: string
    ListApplicationsResponse:
      type: object
      properties:
        applications:
          type: array
          items:
            type: string
        nextToken:
          type: string
    GetApplicationResponse:
      type: object
      properties:
        application:
          type: object
          properties:
            applicationId:
              type: string
            applicationName:
              type: string
            computePlatform:
              type: string
            createTime:
              type: string
              format: date-time
            linkedToGitHub:
              type: boolean
    CreateApplicationResponse:
      type: object
      properties:
        applicationId:
          type: string
          description: A unique application ID.
    ApplicationDoesNotExistException:
      type: object
      properties:
        message:
          type: string
  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