Amazon CodeDeploy #X Amz Target=CodeDeploy 20141006.GetDeploymentConfig API

openapi: 3.0.0
info:
  version: '2014-10-06'
  x-release: v4
  title: 'AWS CodeDeploy Applications #X Amz Target=CodeDeploy 20141006.GetDeploymentConfig 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: '#X Amz Target=CodeDeploy 20141006.GetDeploymentConfig'
paths:
  /#X-Amz-Target=CodeDeploy_20141006.GetDeploymentConfig:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: GetDeploymentConfig
      description: Gets information about a deployment configuration.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDeploymentConfigOutput'
              examples:
                GetDeploymentConfig200Example:
                  summary: Default GetDeploymentConfig 200 response
                  x-microcks-default: true
                  value:
                    deploymentConfigInfo: example-value
        '480':
          description: InvalidDeploymentConfigNameException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidDeploymentConfigNameException'
              examples:
                GetDeploymentConfig480Example:
                  summary: Default GetDeploymentConfig 480 response
                  x-microcks-default: true
                  value: example-value
        '481':
          description: DeploymentConfigNameRequiredException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentConfigNameRequiredException'
              examples:
                GetDeploymentConfig481Example:
                  summary: Default GetDeploymentConfig 481 response
                  x-microcks-default: true
                  value: example-value
        '482':
          description: DeploymentConfigDoesNotExistException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentConfigDoesNotExistException'
              examples:
                GetDeploymentConfig482Example:
                  summary: Default GetDeploymentConfig 482 response
                  x-microcks-default: true
                  value: example-value
        '483':
          description: InvalidComputePlatformException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidComputePlatformException'
              examples:
                GetDeploymentConfig483Example:
                  summary: Default GetDeploymentConfig 483 response
                  x-microcks-default: true
                  value: example-value
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetDeploymentConfigInput'
            examples:
              GetDeploymentConfigRequestExample:
                summary: Default GetDeploymentConfig request
                x-microcks-default: true
                value:
                  deploymentConfigName: example-resource
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - CodeDeploy_20141006.GetDeploymentConfig
      summary: Amazon CodeDeploy Get Deployment Config
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=CodeDeploy 20141006.GetDeploymentConfig'
components:
  schemas:
    ComputePlatform:
      type: string
      enum:
      - Server
      - Lambda
      - ECS
    MinimumHealthyHosts:
      type: object
      properties:
        type:
          allOf:
          - $ref: '#/components/schemas/MinimumHealthyHostsType'
          - description: '<p>The minimum healthy instance type:</p> <ul> <li> <p> <code>HOST_COUNT</code>: The minimum number of healthy instances as an absolute value.</p> </li> <li> <p> <code>FLEET_PERCENT</code>: The minimum number of healthy instances as a percentage of the total number of instances in the deployment.</p> </li> </ul> <p>In an example of nine instances, if a HOST_COUNT of six is specified, deploy to up to three instances at a time. The deployment is successful if six or more instances are deployed to successfully. Otherwise, the deployment fails. If a FLEET_PERCENT of 40 is specified, deploy to up to five instances at a time. The deployment is successful if four or more instances are deployed to successfully. Otherwise, the deployment fails.</p> <note> <p>In a call to the <code>GetDeploymentConfig</code>, CodeDeployDefault.OneAtATime returns a minimum healthy instance type of MOST_CONCURRENCY and a value of 1. This means a deployment to only one instance at a time. (You cannot set the type to MOST_CONCURRENCY, only to HOST_COUNT or FLEET_PERCENT.) In addition, with CodeDeployDefault.OneAtATime, CodeDeploy attempts to ensure that all instances but one are kept in a healthy state during the deployment. Although this allows one instance at a time to be taken offline for a new deployment, it also means that if the deployment to the last instance fails, the overall deployment is still successful.</p> </note> <p>For more information, see <a href="https://docs.aws.amazon.com/codedeploy/latest/userguide/instances-health.html">CodeDeploy Instance Health</a> in the <i>CodeDeploy User Guide</i>.</p>'
        value:
          allOf:
          - $ref: '#/components/schemas/MinimumHealthyHostsValue'
          - description: The minimum healthy instance value.
      description: Information about minimum healthy instance.
    TimeBasedCanary:
      type: object
      properties:
        canaryPercentage:
          allOf:
          - $ref: '#/components/schemas/Percentage'
          - description: The percentage of traffic to shift in the first increment of a <code>TimeBasedCanary</code> deployment.
        canaryInterval:
          allOf:
          - $ref: '#/components/schemas/WaitTimeInMins'
          - description: The number of minutes between the first and second traffic shifts of a <code>TimeBasedCanary</code> deployment.
      description: A configuration that shifts traffic from one version of a Lambda function or Amazon ECS task set to another in two increments. The original and target Lambda function versions or ECS task sets are specified in the deployment's AppSpec file.
    GetDeploymentConfigOutput:
      type: object
      properties:
        deploymentConfigInfo:
          allOf:
          - $ref: '#/components/schemas/DeploymentConfigInfo'
          - description: Information about the deployment configuration.
      description: Represents the output of a <code>GetDeploymentConfig</code> operation.
    TrafficRoutingConfig:
      type: object
      properties:
        type:
          allOf:
          - $ref: '#/components/schemas/TrafficRoutingType'
          - description: The type of traffic shifting (<code>TimeBasedCanary</code> or <code>TimeBasedLinear</code>) used by a deployment configuration.
        timeBasedCanary:
          allOf:
          - $ref: '#/components/schemas/TimeBasedCanary'
          - description: A configuration that shifts traffic from one version of a Lambda function or ECS task set to another in two increments. The original and target Lambda function versions or ECS task sets are specified in the deployment's AppSpec file.
        timeBasedLinear:
          allOf:
          - $ref: '#/components/schemas/TimeBasedLinear'
          - description: A configuration that shifts traffic from one version of a Lambda function or Amazon ECS task set to another in equal increments, with an equal number of minutes between each increment. The original and target Lambda function versions or Amazon ECS task sets are specified in the deployment's AppSpec file.
      description: The configuration that specifies how traffic is shifted from one version of a Lambda function to another version during an Lambda deployment, or from one Amazon ECS task set to another during an Amazon ECS deployment.
    Percentage:
      type: integer
    GetDeploymentConfigInput:
      type: object
      required:
      - deploymentConfigName
      title: GetDeploymentConfigInput
      properties:
        deploymentConfigName:
          allOf:
          - $ref: '#/components/schemas/DeploymentConfigName'
          - description: The name of a deployment configuration associated with the IAM user or Amazon Web Services account.
      description: Represents the input of a <code>GetDeploymentConfig</code> operation.
    InvalidDeploymentConfigNameException: {}
    MinimumHealthyHostsType:
      type: string
      enum:
      - HOST_COUNT
      - FLEET_PERCENT
    DeploymentConfigInfo:
      type: object
      properties:
        deploymentConfigId:
          allOf:
          - $ref: '#/components/schemas/DeploymentConfigId'
          - description: The deployment configuration ID.
        deploymentConfigName:
          allOf:
          - $ref: '#/components/schemas/DeploymentConfigName'
          - description: The deployment configuration name.
        minimumHealthyHosts:
          allOf:
          - $ref: '#/components/schemas/MinimumHealthyHosts'
          - description: Information about the number or percentage of minimum healthy instance.
        createTime:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The time at which the deployment configuration was created.
        computePlatform:
          allOf:
          - $ref: '#/components/schemas/ComputePlatform'
          - description: The destination platform type for the deployment (<code>Lambda</code>, <code>Server</code>, or <code>ECS</code>).
        trafficRoutingConfig:
          allOf:
          - $ref: '#/components/schemas/TrafficRoutingConfig'
          - description: The configuration that specifies how the deployment traffic is routed. Used for deployments with a Lambda or Amazon ECS compute platform only.
      description: Information about a deployment configuration.
    DeploymentConfigName:
      type: string
      minLength: 1
      maxLength: 100
    TimeBasedLinear:
      type: object
      properties:
        linearPercentage:
          allOf:
          - $ref: '#/components/schemas/Percentage'
          - description: The percentage of traffic that is shifted at the start of each increment of a <code>TimeBasedLinear</code> deployment.
        linearInterval:
          allOf:
          - $ref: '#/components/schemas/WaitTimeInMins'
          - description: The number of minutes between each incremental traffic shift of a <code>TimeBasedLinear</code> deployment.
      description: A configuration that shifts traffic from one version of a Lambda function or ECS task set to another in equal increments, with an equal number of minutes between each increment. The original and target Lambda function versions or ECS task sets are specified in the deployment's AppSpec file.
    TrafficRoutingType:
      type: string
      enum:
      - TimeBasedCanary
      - TimeBasedLinear
      - AllAtOnce
    MinimumHealthyHostsValue:
      type: integer
    WaitTimeInMins:
      type: integer
    DeploymentConfigDoesNotExistException: {}
    DeploymentConfigNameRequiredException: {}
    Timestamp:
      type: string
      format: date-time
    DeploymentConfigId:
      type: string
    InvalidComputePlatformException: {}
  parameters:
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
  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