openapi: 3.0.0
info:
  version: '2014-10-06'
  x-release: v4
  title: 'AWS CodeDeploy Applications #X Amz Target=CodeDeploy 20141006.BatchGetDeployments 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.BatchGetDeployments'
paths:
  /#X-Amz-Target=CodeDeploy_20141006.BatchGetDeployments:
    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: BatchGetDeployments
      description: Gets information about one or more deployments. The maximum number of deployments that can be returned is 25.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchGetDeploymentsOutput'
              examples:
                BatchGetDeployments200Example:
                  summary: Default BatchGetDeployments 200 response
                  x-microcks-default: true
                  value:
                    deploymentsInfo: example-value
        '480':
          description: DeploymentIdRequiredException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentIdRequiredException'
              examples:
                BatchGetDeployments480Example:
                  summary: Default BatchGetDeployments 480 response
                  x-microcks-default: true
                  value: example-value
        '481':
          description: InvalidDeploymentIdException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidDeploymentIdException'
              examples:
                BatchGetDeployments481Example:
                  summary: Default BatchGetDeployments 481 response
                  x-microcks-default: true
                  value: example-value
        '482':
          description: BatchLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchLimitExceededException'
              examples:
                BatchGetDeployments482Example:
                  summary: Default BatchGetDeployments 482 response
                  x-microcks-default: true
                  value: example-value
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchGetDeploymentsInput'
            examples:
              BatchGetDeploymentsRequestExample:
                summary: Default BatchGetDeployments request
                x-microcks-default: true
                value:
                  deploymentIds: '500123'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - CodeDeploy_20141006.BatchGetDeployments
      summary: Amazon CodeDeploy Batch Get Deployments
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=CodeDeploy 20141006.BatchGetDeployments'
components:
  schemas:
    ExternalId:
      type: string
    EC2TagFilter:
      type: object
      properties:
        Key:
          allOf:
          - $ref: '#/components/schemas/Key'
          - description: The tag filter key.
        Value:
          allOf:
          - $ref: '#/components/schemas/Value'
          - description: The tag filter value.
        Type:
          allOf:
          - $ref: '#/components/schemas/EC2TagFilterType'
          - description: '<p>The tag filter type:</p> <ul> <li> <p> <code>KEY_ONLY</code>: Key only.</p> </li> <li> <p> <code>VALUE_ONLY</code>: Value only.</p> </li> <li> <p> <code>KEY_AND_VALUE</code>: Key and value.</p> </li> </ul>'
      description: Information about an EC2 tag filter.
    Alarm:
      type: object
      properties:
        name:
          allOf:
          - $ref: '#/components/schemas/AlarmName'
          - description: The name of the alarm. Maximum length is 255 characters. Each alarm name can be used only once in a list of alarms.
      description: Information about an alarm.
    TargetGroupInfo:
      type: object
      properties:
        name:
          allOf:
          - $ref: '#/components/schemas/TargetGroupName'
          - description: 'For blue/green deployments, the name of the target group that instances in the original environment are deregistered from, and instances in the replacement environment are registered with. For in-place deployments, the name of the target group that instances are deregistered from, so they are not serving traffic during a deployment, and then re-registered with after the deployment is complete. '
      description: Information about a target group in Elastic Load Balancing to use in a deployment. Instances are registered as targets in a target group, and traffic is routed to the target group.
    RollbackInfo:
      type: object
      properties:
        rollbackDeploymentId:
          allOf:
          - $ref: '#/components/schemas/DeploymentId'
          - description: The ID of the deployment rollback.
        rollbackTriggeringDeploymentId:
          allOf:
          - $ref: '#/components/schemas/DeploymentId'
          - description: The deployment ID of the deployment that was underway and triggered a rollback deployment because it failed or was stopped.
        rollbackMessage:
          allOf:
          - $ref: '#/components/schemas/Description'
          - description: 'Information that describes the status of a deployment rollback (for example, whether the deployment can''t be rolled back, is in progress, failed, or succeeded). '
      description: Information about a deployment rollback.
    DeploymentStatusMessageList:
      type: array
      items:
        $ref: '#/components/schemas/ErrorMessage'
    AutoRollbackEventsList:
      type: array
      items:
        $ref: '#/components/schemas/AutoRollbackEvent'
    AppSpecContent:
      type: object
      properties:
        content:
          allOf:
          - $ref: '#/components/schemas/RawStringContent'
          - description: <p> The YAML-formatted or JSON-formatted revision string. </p> <p> For an Lambda deployment, the content includes a Lambda function name, the alias for its original version, and the alias for its replacement version. The deployment shifts traffic from the original version of the Lambda function to the replacement version. </p> <p> For an Amazon ECS deployment, the content includes the task name, information about the load balancer that serves traffic to the container, and more. </p> <p> For both types of deployments, the content can specify Lambda functions that run at specified hooks, such as <code>BeforeInstall</code>, during a deployment. </p>
        sha256:
          allOf:
          - $ref: '#/components/schemas/RawStringSha256'
          - description: ' The SHA256 hash value of the revision content. '
      description: ' A revision for an Lambda or Amazon ECS deployment that is a YAML-formatted or JSON-formatted string. For Lambda and Amazon ECS deployments, the revision is the same as the AppSpec file. This method replaces the deprecated <code>RawString</code> data type. '
    ErrorCode:
      type: string
      enum:
      - AGENT_ISSUE
      - ALARM_ACTIVE
      - APPLICATION_MISSING
      - AUTOSCALING_VALIDATION_ERROR
      - AUTO_SCALING_CONFIGURATION
      - AUTO_SCALING_IAM_ROLE_PERMISSIONS
      - CODEDEPLOY_RESOURCE_CANNOT_BE_FOUND
      - CUSTOMER_APPLICATION_UNHEALTHY
      - DEPLOYMENT_GROUP_MISSING
      - ECS_UPDATE_ERROR
      - ELASTIC_LOAD_BALANCING_INVALID
      - ELB_INVALID_INSTANCE
      - HEALTH_CONSTRAINTS
      - HEALTH_CONSTRAINTS_INVALID
      - HOOK_EXECUTION_FAILURE
      - IAM_ROLE_MISSING
      - IAM_ROLE_PERMISSIONS
      - INTERNAL_ERROR
      - INVALID_ECS_SERVICE
      - INVALID_LAMBDA_CONFIGURATION
      - INVALID_LAMBDA_FUNCTION
      - INVALID_REVISION
      - MANUAL_STOP
      - MISSING_BLUE_GREEN_DEPLOYMENT_CONFIGURATION
      - MISSING_ELB_INFORMATION
      - MISSING_GITHUB_TOKEN
      - NO_EC2_SUBSCRIPTION
      - NO_INSTANCES
      - OVER_MAX_INSTANCES
      - RESOURCE_LIMIT_EXCEEDED
      - REVISION_MISSING
      - THROTTLED
      - TIMEOUT
      - CLOUDFORMATION_STACK_FAILURE
    GitHubLocation:
      type: object
      properties:
        repository:
          allOf:
          - $ref: '#/components/schemas/Repository'
          - description: <p>The GitHub account and repository pair that stores a reference to the commit that represents the bundled artifacts for the application revision. </p> <p>Specified as account/repository.</p>
        commitId:
          allOf:
          - $ref: '#/components/schemas/CommitId'
          - description: The SHA1 commit ID of the GitHub commit that represents the bundled artifacts for the application revision.
      description: Information about the location of application artifacts stored in GitHub.
    RelatedDeployments:
      type: object
      properties:
        autoUpdateOutdatedInstancesRootDeploymentId:
          allOf:
          - $ref: '#/components/schemas/DeploymentId'
          - description: The deployment ID of the root deployment that triggered this deployment.
        autoUpdateOutdatedInstancesDeploymentIds:
          allOf:
          - $ref: '#/components/schemas/DeploymentsList'
          - description: The deployment IDs of 'auto-update outdated instances' deployments triggered by this deployment.
      description: Information about deployments related to the specified deployment.
    DeploymentCreator:
      type: string
      enum:
      - user
      - autoscaling
      - codeDeployRollback
      - CodeDeploy
      - CodeDeployAutoUpdate
      - CloudFormation
      - CloudFormationRollback
    BatchGetDeploymentsInput:
      type: object
      required:
      - deploymentIds
      title: BatchGetDeploymentsInput
      properties:
        deploymentIds:
          allOf:
          - $ref: '#/components/schemas/DeploymentsList'
          - description: ' A list of deployment IDs, separated by spaces. The maximum number of deployment IDs you can specify is 25.'
      description: ' Represents the input of a <code>BatchGetDeployments</code> operation. '
    RevisionLocation:
      type: object
      properties:
        revisionType:
          allOf:
          - $ref: '#/components/schemas/RevisionLocationType'
          - description: '<p>The type of application revision:</p> <ul> <li> <p>S3: An application revision stored in Amazon S3.</p> </li> <li> <p>GitHub: An application revision stored in GitHub (EC2/On-premises deployments only).</p> </li> <li> <p>String: A YAML-formatted or JSON-formatted string (Lambda deployments only).</p> </li> <li> <p>AppSpecContent: An <code>AppSpecContent</code> object that contains the contents of an AppSpec file for an Lambda or Amazon ECS deployment. The content is formatted as JSON or YAML stored as a RawString.</p> </li> </ul>'
        s3Location:
          allOf:
          - $ref: '#/components/schemas/S3Location'
          - description: 'Information about the location of a revision stored in Amazon S3. '
        gitHubLocation:
          allOf:
          - $ref: '#/components/schemas/GitHubLocation'
          - description: Information about the location of application artifacts stored in GitHub.
        string:
          allOf:
          - $ref: '#/components/schemas/RawString'
          - description: Information about the location of an Lambda deployment revision stored as a RawString.
        appSpecContent:
          allOf:
          - $ref: '#/components/schemas/AppSpecContent'
          - description: ' The content of an AppSpec file for an Lambda or Amazon ECS deployment. The content is formatted as JSON or YAML and stored as a RawString. '
      description: Information about the location of an application revision.
    ListenerArnList:
      type: array
      items:
        $ref: '#/components/schemas/ListenerArn'
    RawString:
      type: object
      deprecated: true
      properties:
        content:
          allOf:
          - $ref: '#/components/schemas/RawStringContent'
          - description: The YAML-formatted or JSON-formatted revision string. It includes information about which Lambda function to update and optional Lambda functions that validate deployment lifecycle events.
        sha256:
          allOf:
          - $ref: '#/components/schemas/RawStringSha256'
          - description: The SHA256 hash value of the revision content.
      description: A revision for an Lambda deployment that is a YAML-formatted or JSON-formatted string. For Lambda deployments, the revision is the same as the AppSpec file.RawString and String revision type are deprecated, use AppSpecContent type instead.
    S3Key:
      type: string
    AutoRollbackConfiguration:
      type: object
      properties:
        enabled:
          allOf:
          - $ref: '#/components/schemas/Boolean'
          - description: Indicates whether a defined automatic rollback configuration is currently enabled.
        events:
          allOf:
          - $ref: '#/components/schemas/AutoRollbackEventsList'
          - description: The event type or types that trigger a rollback.
      description: Information about a configuration for automatically rolling back to a previous version of an application revision when a deployment is not completed successfully.
    Value:
      type: string
    LoadBalancerInfo:
      type: object
      properties:
        elbInfoList:
          allOf:
          - $ref: '#/components/schemas/ELBInfoList'
          - description: <p>An array that contains information about the load balancer to use for load balancing in a deployment. In Elastic Load Balancing, load balancers are used with Classic Load Balancers.</p> <note> <p> Adding more than one load balancer to the array is not supported. </p> </note>
        targetGroupInfoList:
          allOf:
          - $ref: '#/components/schemas/TargetGroupInfoList'
          - description: <p>An array that contains information about the target group to use for load balancing in a deployment. In Elastic Load Balancing, target groups are used with Application Load Balancers.</p> <note> <p> Adding more than one target group to the array is not supported. </p> </note>
        targetGroupPairInfoList:
          allOf:
          - $ref: '#/components/schemas/TargetGroupPairInfoList'
          - description: ' The target group pair information. This is an array of <code>TargeGroupPairInfo</code> objects with a maximum size of one. '
      description: Information about the Elastic Load Balancing load balancer or target group used in a deployment.
    AutoScalingGroupName:
      type: string
    AutoRollbackEvent:
      type: string
      enum:
      - DEPLOYMENT_FAILURE
      - DEPLOYMENT_STOP_ON_ALARM
      - DEPLOYMENT_STOP_ON_REQUEST
    EC2TagSetList:
      type: array
      items:
        $ref: '#/components/schemas/EC2TagFilterList'
    TargetGroupInfoList:
      type: array
      items:
        $ref: '#/components/schemas/TargetGroupInfo'
    BundleType:
      type: string
      enum:
      - tar
      - tgz
      - zip
      - YAML
      - JSON
    BlueInstanceTerminationOption:
      type: object
      properties:
        action:
          allOf:
          - $ref: '#/components/schemas/InstanceAction'
          - description: '<p>The action to take on instances in the original environment after a successful blue/green deployment.</p> <ul> <li> <p> <code>TERMINATE</code>: Instances are terminated after a specified wait time.</p> </li> <li> <p> <code>KEEP_ALIVE</code>: Instances are left running after they are deregistered from the load balancer and removed from the deployment group.</p> </li> </ul>'
        terminationWaitTimeInMinutes:
          allOf:
          - $ref: '#/components/schemas/Duration'
          - description: <p>For an Amazon EC2 deployment, the number of minutes to wait after a successful blue/green deployment before terminating instances from the original environment.</p> <p> For an Amazon ECS deployment, the number of minutes before deleting the original (blue) task set. During an Amazon ECS deployment, CodeDeploy shifts traffic from the original (blue) task set to a replacement (green) task set. </p> <p> The maximum setting is 2880 minutes (2 days). </p>
      description: 'Information about whether instances in the original environment are terminated when a blue/green deployment is successful. <code>BlueInstanceTerminationOption</code> does not apply to Lambda deployments. '
    EC2TagFilterList:
      type: array
      items:
        $ref: '#/components/schemas/EC2TagFilter'
    Timestamp:
      type: string
      format: date-time
    EC2TagSet:
      type: object
      properties:
        ec2TagSetList:
          allOf:
          - $ref: '#/components/schemas/EC2TagSetList'
          - description: A list that contains other lists of Amazon EC2 instance tag groups. For an instance to be included in the deployment group, it must be identified by all of the tag groups in the list.
      description: Information about groups of Amazon EC2 instance tags.
    ELBInfo:
      type: object
      properties:
        name:
          allOf:
          - $ref: '#/components/schemas/ELBName'
          - description: For blue/green deployments, the name of the load balancer that is used to route traffic from original instances to replacement instances in a blue/green deployment. For in-place deployments, the name of the load balancer that instances are deregistered from so they are not serving traffic during a deployment, and then re-registered with after the deployment is complete.
      description: Information about a load balancer in Elastic Load Balancing to use in a deployment. Instances are registered directly with a load balancer, and traffic is routed to the load balancer.
    DeploymentReadyAction:
      type: string
      enum:
      - CONTINUE_DEPLOYMENT
      - STOP_DEPLOYMENT
    ELBInfoList:
      type: array
      items:
        $ref: '#/components/schemas/ELBInfo'
    GreenFleetProvisioningOption:
      type: object
      properties:
        action:
          allOf:
          - $ref: '#/components/schemas/GreenFleetProvisioningAction'
          - description: '<p>The method used to add instances to a replacement environment.</p> <ul> <li> <p> <code>DISCOVER_EXISTING</code>: Use instances that already exist or will be created manually.</p> </li> <li> <p> <code>COPY_AUTO_SCALING_GROUP</code>: Use settings from a specified Auto Scaling group to define and create instances in a new Auto Scaling group.</p> </li> </ul>'
      description: Information about the instances that belong to the replacement environment in a blue/green deployment.
    FileExistsBehavior:
      type: string
      enum:
      - DISALLOW
      - OVERWRITE
      - RETAIN
    InstanceCount:
      type: integer
    DeploymentIdRequiredException: {}
    InstanceAction:
      type: string
      enum:
      - TERMINATE
      - KEEP_ALIVE
    DeploymentGroupName:
      type: string
      minLength: 1
      maxLength: 100
    Key:
      type: string
    Description:
      type: string
    GreenFleetProvisioningAction:
      type: string
      enum:
      - DISCOVER_EXISTING
      - COPY_AUTO_SCALING_GROUP
    DeploymentsInfoList:
      type: array
      items:
        $ref: '#/components/schemas/DeploymentInfo'
    TargetGroupPairInfo:
      type: object
      properties:
        targetGroups:
          allOf:
          - $ref: '#/components/schemas/TargetGroupInfoList'
          - description: ' One pair of target groups. One is associated with the original task set. The second is associated with the task set that serves traffic after the deployment is complete. '
        prodTrafficRoute:
          allOf:
          - $ref: '#/components/schemas/TrafficRoute'
          - description: ' The path used by a load balancer to route production traffic when an Amazon ECS deployment is complete. '
        testTrafficRoute:
          allOf:
          - $ref: '#/components/schemas/TrafficRoute'
          - description: ' An optional path used by a load balancer to route test traffic after an Amazon ECS deployment. Validation can occur while test traffic is served during a deployment. '
      description: ' Information about two target groups and how traffic is routed during an Amazon ECS deployment. An optional test traffic route can be specified. '
    AdditionalDeploymentStatusInfo:
      type: string
      deprecated: true
      description: AdditionalDeploymentStatusInfo is deprecated, use DeploymentStatusMessageList instead.
    DeploymentStyle:
      type: object
      properties:
        deploymentType:
          allOf:
          - $ref: '#/components/schemas/DeploymentType'
          - description: Indicates whether to run an in-place deployment or a blue/green deployment.
        deploymentOption:
          allOf:
          - $ref: '#/components/schemas/DeploymentOption'
          - description: Indicates whether to route deployment traffic behind a load balancer.
      description: Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer.
    TargetGroupName:
      type: string
    BlueGreenDeploymentConfiguration:
      type: object
      properties:
        terminateBlueInstancesOnDeploymentSuccess:
          allOf:
          - $ref: '#/components/schemas/BlueInstanceTerminationOption'
          - description: Information about whether to terminate instances in the original fleet during a blue/green deployment.
        deploymentReadyOption:
          allOf:
          - $ref: '#/components/schemas/DeploymentReadyOption'
          - description: Information about the action to take when newly provisioned instances are ready to receive traffic in a blue/green deployment.
        greenFleetProvisioningOption:
          allOf:
          - $ref: '#/components/schemas/GreenFleetProvisioningOption'
          - description: Information about how instances are provisioned for a replacement environment in a blue/green deployment.
      description: Information about blue/green deployment options for a deployment group.
    Repository:
      type: string
    Boolean:
      type: boolean
    RawStringContent:
      type: string
    AlarmName:
      type: string
    AutoScalingGroupNameList:
      type: array
      items:
        $ref: '#/components/schemas/AutoScalingGroupName'
    ETag:
      type: string
    InvalidDeploymentIdException: {}
    DeploymentStatus:
      type: string
      enum:
      - Created
      - Queued
      - InProgress
      - Baking
      - Succeeded
      - Failed
      - Stopped
      - Ready
    RevisionLocationType:
      type: string
      enum:
      - S3
      - GitHub
      - String
      - AppSpecContent
    DeploymentsList:
      type: array
      items:
        $ref: '#/components/schemas/DeploymentId'
    DeploymentReadyOption:
      type: object
      properties:
        actionOnTimeout:
          allOf:
          - $ref: '#/components/schemas/DeploymentReadyAction'
          - description: '<p>Information about when to reroute traffic from an original environment to a replacement environment in a blue/green deployment.</p> <ul> <li> <p>CONTINUE_DEPLOYMENT: Register new instances with the load balancer immediately after the new application revision is installed on the instances in the replacement environment.</p> </li> <li> <p>STOP_DEPLOYMENT: Do not register new instances with a load balancer unless traffic rerouting is started using <a>ContinueDeployment</a>. If traffic rerouting is not started before the end of the specified wait period, the deployment status is changed to Stopped.</p> </li> </ul>'
        waitTimeInMinutes:
          allOf:
          - $ref: '#/components/schemas/Duration'
          - description: The number of minutes to wait before the status of a blue/green deployment is changed to Stopped if rerouting is not started manually. Applies only to the <code>STOP_DEPLOYMENT</code> option for <code>actionOnTimeout</code>.
      description: Information about how traffic is rerouted to instances in a replacement environment in a blue/green deployment.
    ErrorMessage:
      type: string
    S3Bucket:
      type: string
    TargetInstances:
      type: object
      properties:
        tagFilters:
          allOf:
          - $ref: '#/components/schemas/EC2TagFilterList'
          - description: The tag filter key, type, and value used to identify Amazon EC2 instances in a replacement environment for a blue/green deployment. Cannot be used in the same call as <code>ec2TagSet</code>.
        autoScalingGroups:
          allOf:
          - $ref: '#/components/schemas/AutoScalingGroupNameList'
          - description: The names of one or more Auto Scaling groups to identify a replacement environment for a blue/green deployment.
        ec2TagSet:
          allOf:
          - $ref: '#/components/schemas/EC2TagSet'
          - description: Information about the groups of Amazon EC2 instance tags that an instance must be identified by in order for it to be included in the replacement environment for a blue/green deployment. Cannot be used in the same call as <code>tagFilters</code>.
      description: Information about the instances to be used in the replacement environment in a blue/green deployment.
    DeploymentOption:
      type: string
      enum:
      - WITH_TRAFFIC_CONTROL
      - WITHOUT_TRAFFIC_CONTROL
    ListenerArn:
      type: string
    ComputePlatform:
      type: string
      enum:
      - Server
      - Lambda
      - ECS
    DeploymentOverview:
      type: object
      properties:
        Pending:
          allOf:
          - $ref: '#/components/schemas/InstanceCount'
          - description: The number of instances in the deployment in a pending state.
        InProgress:
          allOf:
          - $ref: '#/components/schemas/InstanceCount'
          - description: The number of instances in which the deployment is in progress.
        Succeeded:
          allOf:
          - $ref: '#/components/schemas/InstanceCount'
          - description: The number of instances in the deployment to which revisions have been successfully deployed.
        Failed:
          allOf:
          - $ref: '#/components/schemas/InstanceCount'
          - description: The number of instances in the deployment in a failed state.
        Skipped:
          allOf:
          - $ref: '#/components/schemas/InstanceCount'
          - description: The number of instances in the deployment in a skipped state.
        Ready:
          allOf:
          - $ref: '#/components/schemas/InstanceCount'
          - description: The number of instances in a replacement environment ready to receive traffic in a blue/green deployment.
      description: Information about the deployment status of the instances in the deployment.
    DeploymentId:
      type: string
    VersionId:
      type: string
    DeploymentType:
      type: string
      enum:
      - IN_PLACE
      - BLUE_GREEN
    AlarmList:
      type: array
      items:
        $ref: '#/components/schemas/Alarm'
    RawStringSha256:
      type: string
    ApplicationName:
      type: string
      minLength: 1
      maxLength: 100
    ErrorInformation:
      type: object
      properties:
        code:
          allOf:
          - $ref: '#/components/schemas/ErrorCode'
          - description: '<p>For more information, see <a href="https://docs.aws.amazon.com/codedeploy/latest/userguide/error-codes.html">Error Codes for CodeDeploy</a> in the <a href="https://docs.aws.amazon.com/codedeploy/latest/userguide">CodeDeploy User Guide</a>.</p> <p>The error code:</p> <ul> <li> <p>APPLICATION_MISSING: The application was missing. This error code is most likely raised if the application is deleted after the deployment is created, but before it is started.</p> </li> <li> <p>DEPLOYMENT_GROUP_MISSING: The deployment group was missing. This error code is most likely raised if the deployment group is deleted after the deployment is created, but before it is started.</p> </li> <li> <p>HEALTH_CONSTRAINTS: The deployment failed on too many instances to be successfully deployed within the instance health constraints specified.</p> </li> <li> <p>HEALTH_CONSTRAINTS_INVALID: The revision cannot be successfully deployed within the instance health constraints specified.</p> </li> <li> <p>IAM_ROLE_MISSING: The service role cannot be accessed.</p> </li> <li> <p>IAM_ROLE_PERMISSIONS: The service role does not have the correct permissions.</p> </li> <li> <p>INTERNAL_ERROR: There was an internal error.</p> </li> <li> <p>NO_EC2_SUBSCRIPTION: The calling account is not subscribed to Amazon EC2.</p> </li> <li> <p>NO_INSTANCES: No instances were specified, or no instances can be found.</p> </li> <li> <p>OVER_MAX_INSTANCES: The maximum number of instances was exceeded.</p> </li> <li> <p>THROTTLED: The operation was throttled because the calling account exceeded the throttling limits of one or more Amazon Web Services services.</p> </li> <li> <p>TIMEOUT: The deployment has timed out.</p> </li> <li> <p>REVISION_MISSING: The revision ID was missing. This error code is most likely raised if the revision is deleted after the deployment is created, but before it is started.</p> </li> </ul>'
        message:
          allOf:
          - $ref: '#/components/schemas/ErrorMessage'
          - description: An accompanying error message.
      description: Information about a deployment error.
    ELBName:
      type: string
    S3Location:
      type: object
      properties:
        bucket:
          allOf:
          - $ref: '#/components/schemas/S3Bucket'
          - description: The name of the Amazon S3 bucket where the application revision is stored.
        key:
          allOf:
          - $ref: '#/components/schemas/S3Key'
          - description: The name of the Amazon S3 object that represents the bundled artifacts for the application revision.
        bundleType:
          allOf:
          - $ref: '#/components/schemas/BundleType'
          - description: '<p>The file type of the application revision. Must be one of the following:</p> <ul> <li> <p> <code>tar</code>: A tar archive file.</p> </li> <li> <p> <code>tgz</code>: A compressed tar archive file.</p> </li> <li> <p> <code>zip</code>: A zip archive file.</p> </li> </ul>'
        version:
          allOf:
          - $ref: '#/components/schemas/VersionId'
          - description: <p>A specific version of the Amazon S3 object that represents the bundled artifacts for the application revision.</p> <p>If the version is not specified, the system uses the most recent version by default.</p>
        eTag:
          allOf:
          - $ref: '#/components/schemas/ETag'
          - description: <p>The ETag of the Amazon S3 object that represents the bundled artifacts for the application revision.</p> <p>If the ETag is not specified as an input parameter, ETag validation of the object is skipped.</p>
      description: Information about the location of application artifacts stored in Amazon S3.
    BatchGetDeploymentsOutput:
      type: object
      properties:
        deploymentsInfo:
          allOf:
          - $ref: '#/components/schemas/DeploymentsInfoList'
          - description: ' Information about the deployments. '
      description: ' Represents the output of a <code>BatchGetDeployments</code> operation. '
    BatchLimitExceededException: {}
    DeploymentConfigName:
      type: string
      minLength: 1
      maxLength: 100
    TrafficRoute:
      type: object
      properties:
        listenerArns:
          allOf:
          - $ref: '#/components/schemas/ListenerArnList'
          - description: ' The Amazon Resource Name (ARN) of one listener. The listener identifies the route between a target group and a load balancer. This is an array of strings with a maximum size of one. '
      description: ' Information about a listener. The listener contains the path used to route traffic that is received from the load balancer to a target group. '
    DeploymentInfo:
      type: object
      properties:
        applicationName:
          allOf:
          - $ref: '#/components/schemas/ApplicationName'
          - description: The application name.
        deploymentGroupName:
          allOf:
          - $ref: '#/components/schemas/DeploymentGroupName'
          - description: ' The deployment group name. '
        deploymentConfigName:
          allOf:
          - $ref: '#/components/schemas/DeploymentConfigName'
          - description: ' The deployment configuration name. '
        deploymentId:
          allOf:
          - $ref: '#/components/schemas/DeploymentId'
          - description: ' The unique ID of a deployment. '
        previousRevision:
          allOf:
          - $ref: '#/components/schemas/RevisionLocation'
          - description: Information about the application revision that was deployed to the deployment group before the most recent successful deployment.
        revision:
          allOf:
          - $ref: '#/components/schemas/RevisionLocation'
          - description: Information about the location of stored application artifacts and the service from which to retrieve them.
        status:
          allOf:
          - $ref: '#/components/schemas/DeploymentStatus'
          - description: The current state of the deployment as a whole.
        errorInformation:
          allOf:
          - $ref: '#/components/schemas/ErrorInformation'
          - description: Information about any error associated with this deployment.
        createTime:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: A timestamp that indicates when the deployment was created.
        startTime:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: <p>A timestamp that indicates when the deployment was deployed to the deployment group.</p> <p>In some cases, the reported value of the start time might be later than the complete time. This is due to differences in the clock settings of backend servers that participate in the deployment process.</p>
        completeTime:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: A timestamp that indicates when the deployment was complete.
        deploymentOverview:
          allOf:
          - $ref: '#/components/schemas/DeploymentOverview'
          - description: A summary of the deployment status of the instances in the deployment.
        description:
          allOf:
          - $ref: '#/components/schemas/Description'
          - description: A comment about the deployment.
        creator:
          allOf:
          - $ref: '#/components/schemas/DeploymentCreator'
          - description: '<p>The means by which the deployment was created:</p> <ul> <li> <p> <code>user</code>: A user created the deployment.</p> </li> <li> <p> <code>autoscaling</code>: Amazon EC2 Auto Scaling created the deployment.</p> </li> <li> <p> <code>codeDeployRollback</code>: A rollback process created the deployment.</p> </li> <li> <p> <code>CodeDeployAutoUpdate</code>: An auto-update process created the deployment when it detected outdated Amazon EC2 instances.</p> </li> </ul>'
        ignoreApplicationStopFailures:
          allOf:
          - $ref: '#/components/schemas/Boolean'
          - description: <p> If true, then if an <code>ApplicationStop</code>, <code>BeforeBlockTraffic</code>, or <code>AfterBlockTraffic</code> deployment lifecycle event to an instance fails, then the deployment continues to the next deployment lifecycle event. For example, if <code>ApplicationStop</code> fails, the deployment continues with DownloadBundle. If <code>BeforeBlockTraffic</code> fails, the deployment continues with <code>BlockTraffic</code>. If <code>AfterBlockTraffic</code> fails, the deployment continues with <code>ApplicationStop</code>. </p> <p> If false or not specified, then if a lifecycle event fails during a deployment to an instance, that deployment fails. If deployment to that instance is part of an overall deployment and the number of healthy hosts is not less than the minimum number of healthy hosts, then a deployment to the next instance is attempted. </p> <p> During a deployment, the CodeDeploy agent runs the scripts specified for <code>ApplicationStop</code>, <code>BeforeBlockTraffic</code>, and <code>AfterBlockTraffic</code> in the AppSpec file from the previous successful deployment. (All other scripts are run from the AppSpec file in the current deployment.) If one of these scripts contains an error and does not run successfully, the deployment can fail. </p> <p> If the cause of the failure is a script from the last successful deployment that will never run successfully, create a new deployment and use <code>ignoreApplicationStopFailures</code> to specify that the <code>ApplicationStop</code>, <code>BeforeBlockTraffic</code>, and <code>AfterBlockTraffic</code> failures should be ignored. </p>
        autoRollbackConfiguration:
          allOf:
          - $ref: '#/components/schemas/AutoRollbackConfiguration'
          - description: Information about the automatic rollback configuration associated with the deployment.
        updateOutdatedInstancesOnly:
          allOf:
          - $ref: '#/components/schemas/Boolean'
          - description: Indicates whether only instances that are not running the latest application revision are to be deployed to.
        rollbackInfo:
          allOf:
          - $ref: '#/components/schemas/RollbackInfo'
          - description: Information about a deployment rollback.
        deploymentStyle:
          allOf:
          - $ref: '#/components/schemas/DeploymentStyle'
          - description: Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer.
        targetInstances:
          allOf:
          - $ref: '#/components/schemas/TargetInstances'
          - description: Information about the instances that belong to the replacement environment in a blue/green deployment.
        instanceTerminationWaitTimeStarted:
          allOf:
          - $ref: '#/components/schemas/Boolean'
          - description: Indicates whether the wait period set for the termination of instances in the original environment has started. Status is 'false' if the KEEP_ALIVE option is specified. Otherwise, 'true' as soon as the termination wait period starts.
        blueGreenDeploymentConfiguration:
          allOf:
          - $ref: '#/components/schemas/BlueGreenDeploymentConfiguration'
          - description: Information about blue/green deployment options for this deployment.
        loadBalancerInfo:
          allOf:
          - $ref: '#/components/schemas/LoadBalancerInfo'
          - description: Information about the load balancer used in the deployment.
        additionalDeploymentStatusInfo:
          allOf:
          - $ref: '#/components/schemas/AdditionalDeploymentStatusInfo'
          - description: Provides information about the results of a deployment, such as whether instances in the original environment in a blue/green deployment were not terminated.
        fileExistsBehavior:
          allOf:
          - $ref: '#/components/schemas/FileExistsBehavior'
          - description: '<p>Information about how CodeDeploy handles files that already exist in a deployment target location but weren''t part of the previous successful deployment.</p> <ul> <li> <p> <code>DISALLOW</code>: The deployment fails. This is also the default behavior if no option is specified.</p> </li> <li> <p> <code>OVERWRITE</code>: The version of the file from the application revision currently being deployed replaces the version already on the instance.</p> </li> <li> <p> <code>RETAIN</code>: The version of the file already on the instance is kept and used as part of the new deployment.</p> </li> </ul>'
        deploymentStatusMessages:
          allOf:
          - $ref: '#/components/schemas/DeploymentStatusMessageList'
          - description: Messages that contain information about the status of a deployment.
        computePlatform:
          allOf:
          - $ref: '#/components/schemas/ComputePlatform'
          - description: The destination platform type for the deployment (<code>Lambda</code>, <code>Server</code>, or <code>ECS</code>).
        externalId:
          allOf:
          - $ref: '#/components/schemas/ExternalId'
          - description: The unique ID for an external resource (for example, a CloudFormation stack ID) that is linked to this deployment.
        relatedDeployments:
          $ref: '#/components/schemas/RelatedDeployments'
        overrideAlarmConfiguration:
          $ref: '#/components/schemas/AlarmConfiguration'
      description: Information about a deployment.
    EC2TagFilterType:
      type: string
      enum:
      - KEY_ONLY
      - VALUE_ONLY
      - KEY_AND_VALUE
    CommitId:
      type: string
    Duration:
      type: integer
    AlarmConfiguration:
      type: object
      properties:
        enabled:
          allOf:
          - $ref: '#/components/schemas/Boolean'
          - description: Indicates whether the alarm configuration is enabled.
        ignorePollAlarmFailure:
          allOf:
          - $ref: '#/components/schemas/Boolean'
          - description: '<p>Indicates whether a deployment should continue if information about the current state of alarms cannot be retrieved from Amazon CloudWatch. The default value is false.</p> <ul> <li> <p> <code>true</code>: The deployment proceeds even if alarm status information can''t be retrieved from Amazon CloudWatch.</p> </li> <li> <p> <code>false</code>: The deployment stops if alarm status information can''t be retrieved from Amazon CloudWatch.</p> </li> </ul>'
        alarms:
          allOf:
          - $ref: '#/components/schemas/AlarmList'
          - description: A list of alarms configured for the deployment or deployment group. A maximum of 10 alarms can be added.
      description: Information about alarms associated with a deployment or deployment group.
    TargetGroupPairInfoList:
      type: array
      items:
        $ref: '#/components/schemas/TargetGroupPairInfo'
  parameters:
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      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-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-Algorithm:
      name: X-Amz-Algorithm
      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