Amazon CodeDeploy
Amazon CodeDeploy API

The Amazon CodeDeploy REST API enables programmatic management of applications, deployment groups, deployment configurations, and deployments. Create and update deployment groups, trigger deployments to EC2, Lambda, ECS, and on-premises targets, monitor deployment status, and manage deployment lifecycle hooks and rollback policies.
Documentation GitHub OpenAPI
OpenAPI Specification

openapi: 3.0.0
info:
  version: '2014-10-06'
  x-release: v4
  title: AWS CodeDeploy
  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
externalDocs:
  description: Amazon Web Services documentation
  url: 'https://docs.aws.amazon.com/codedeploy/'
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)
x-hasEquivalentPaths: true
paths:
  /#X-Amz-Target=CodeDeploy_20141006.AddTagsToOnPremisesInstances:
    post:
      operationId: AddTagsToOnPremisesInstances
      description: Adds tags to on-premises instances.
      responses:
        '200':
          description: Success
        '480':
          description: InstanceNameRequiredException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstanceNameRequiredException'
              examples:
                AddTagsToOnPremisesInstances480Example:
                  summary: Default AddTagsToOnPremisesInstances 480 response
                  x-microcks-default: true
                  value: example-value
        '481':
          description: InvalidInstanceNameException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidInstanceNameException'
              examples:
                AddTagsToOnPremisesInstances481Example:
                  summary: Default AddTagsToOnPremisesInstances 481 response
                  x-microcks-default: true
                  value: example-value
        '482':
          description: TagRequiredException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagRequiredException'
              examples:
                AddTagsToOnPremisesInstances482Example:
                  summary: Default AddTagsToOnPremisesInstances 482 response
                  x-microcks-default: true
                  value: example-value
        '483':
          description: InvalidTagException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidTagException'
              examples:
                AddTagsToOnPremisesInstances483Example:
                  summary: Default AddTagsToOnPremisesInstances 483 response
                  x-microcks-default: true
                  value: example-value
        '484':
          description: TagLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagLimitExceededException'
              examples:
                AddTagsToOnPremisesInstances484Example:
                  summary: Default AddTagsToOnPremisesInstances 484 response
                  x-microcks-default: true
                  value: example-value
        '485':
          description: InstanceLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstanceLimitExceededException'
              examples:
                AddTagsToOnPremisesInstances485Example:
                  summary: Default AddTagsToOnPremisesInstances 485 response
                  x-microcks-default: true
                  value: example-value
        '486':
          description: InstanceNotRegisteredException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstanceNotRegisteredException'
              examples:
                AddTagsToOnPremisesInstances486Example:
                  summary: Default AddTagsToOnPremisesInstances 486 response
                  x-microcks-default: true
                  value: example-value
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddTagsToOnPremisesInstancesInput'
            examples:
              AddTagsToOnPremisesInstancesRequestExample:
                summary: Default AddTagsToOnPremisesInstances request
                x-microcks-default: true
                value:
                  tags: example-value
                  instanceNames: example-resource
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - CodeDeploy_20141006.AddTagsToOnPremisesInstances
      summary: Amazon CodeDeploy Add Tags to on Premises Instances
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    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'
  /#X-Amz-Target=CodeDeploy_20141006.BatchGetApplicationRevisions:
    post:
      operationId: BatchGetApplicationRevisions
      description: Gets information about one or more application revisions. The maximum number of application revisions that can be returned is 25.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchGetApplicationRevisionsOutput'
              examples:
                BatchGetApplicationRevisions200Example:
                  summary: Default BatchGetApplicationRevisions 200 response
                  x-microcks-default: true
                  value:
                    applicationName: example-resource
                    errorMessage: example-value
                    revisions: example-value
        '480':
          description: ApplicationDoesNotExistException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationDoesNotExistException'
              examples:
                BatchGetApplicationRevisions480Example:
                  summary: Default BatchGetApplicationRevisions 480 response
                  x-microcks-default: true
                  value: example-value
        '481':
          description: ApplicationNameRequiredException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationNameRequiredException'
              examples:
                BatchGetApplicationRevisions481Example:
                  summary: Default BatchGetApplicationRevisions 481 response
                  x-microcks-default: true
                  value: example-value
        '482':
          description: InvalidApplicationNameException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidApplicationNameException'
              examples:
                BatchGetApplicationRevisions482Example:
                  summary: Default BatchGetApplicationRevisions 482 response
                  x-microcks-default: true
                  value: example-value
        '483':
          description: RevisionRequiredException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RevisionRequiredException'
              examples:
                BatchGetApplicationRevisions483Example:
                  summary: Default BatchGetApplicationRevisions 483 response
                  x-microcks-default: true
                  value: example-value
        '484':
          description: InvalidRevisionException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRevisionException'
              examples:
                BatchGetApplicationRevisions484Example:
                  summary: Default BatchGetApplicationRevisions 484 response
                  x-microcks-default: true
                  value: example-value
        '485':
          description: BatchLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchLimitExceededException'
              examples:
                BatchGetApplicationRevisions485Example:
                  summary: Default BatchGetApplicationRevisions 485 response
                  x-microcks-default: true
                  value: example-value
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchGetApplicationRevisionsInput'
            examples:
              BatchGetApplicationRevisionsRequestExample:
                summary: Default BatchGetApplicationRevisions request
                x-microcks-default: true
                value:
                  applicationName: example-resource
                  revisions: example-value
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - CodeDeploy_20141006.BatchGetApplicationRevisions
      summary: Amazon CodeDeploy Batch Get Application Revisions
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    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'
  /#X-Amz-Target=CodeDeploy_20141006.BatchGetApplications:
    post:
      operationId: BatchGetApplications
      description: Gets information about one or more applications. The maximum number of applications that can be returned is 100.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchGetApplicationsOutput'
              examples:
                BatchGetApplications200Example:
                  summary: Default BatchGetApplications 200 response
                  x-microcks-default: true
                  value:
                    applicationsInfo: example-value
        '480':
          description: ApplicationNameRequiredException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationNameRequiredException'
              examples:
                BatchGetApplications480Example:
                  summary: Default BatchGetApplications 480 response
                  x-microcks-default: true
                  value: example-value
        '481':
          description: InvalidApplicationNameException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidApplicationNameException'
              examples:
                BatchGetApplications481Example:
                  summary: Default BatchGetApplications 481 response
                  x-microcks-default: true
                  value: example-value
        '482':
          description: ApplicationDoesNotExistException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationDoesNotExistException'
              examples:
                BatchGetApplications482Example:
                  summary: Default BatchGetApplications 482 response
                  x-microcks-default: true
                  value: example-value
        '483':
          description: BatchLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchLimitExceededException'
              examples:
                BatchGetApplications483Example:
                  summary: Default BatchGetApplications 483 response
                  x-microcks-default: true
                  value: example-value
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchGetApplicationsInput'
            examples:
              BatchGetApplicationsRequestExample:
                summary: Default BatchGetApplications request
                x-microcks-default: true
                value:
                  applicationNames: example-resource
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - CodeDeploy_20141006.BatchGetApplications
      summary: Amazon CodeDeploy Batch Get Applications
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    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'
  /#X-Amz-Target=CodeDeploy_20141006.BatchGetDeploymentGroups:
    post:
      operationId: BatchGetDeploymentGroups
      description: Gets information about one or more deployment groups.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchGetDeploymentGroupsOutput'
              examples:
                BatchGetDeploymentGroups200Example:
                  summary: Default BatchGetDeploymentGroups 200 response
                  x-microcks-default: true
                  value:
                    deploymentGroupsInfo: example-value
                    errorMessage: example-value
        '480':
          description: ApplicationNameRequiredException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationNameRequiredException'
              examples:
                BatchGetDeploymentGroups480Example:
                  summary: Default BatchGetDeploymentGroups 480 response
                  x-microcks-default: true
                  value: example-value
        '481':
          description: InvalidApplicationNameException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidApplicationNameException'
              examples:
                BatchGetDeploymentGroups481Example:
                  summary: Default BatchGetDeploymentGroups 481 response
                  x-microcks-default: true
                  value: example-value
        '482':
          description: ApplicationDoesNotExistException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationDoesNotExistException'
              examples:
                BatchGetDeploymentGroups482Example:
                  summary: Default BatchGetDeploymentGroups 482 response
                  x-microcks-default: true
                  value: example-value
        '483':
          description: DeploymentGroupNameRequiredException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentGroupNameRequiredException'
              examples:
                BatchGetDeploymentGroups483Example:
                  summary: Default BatchGetDeploymentGroups 483 response
                  x-microcks-default: true
                  value: example-value
        '484':
          description: InvalidDeploymentGroupNameException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidDeploymentGroupNameException'
              examples:
                BatchGetDeploymentGroups484Example:
                  summary: Default BatchGetDeploymentGroups 484 response
                  x-microcks-default: true
                  value: example-value
        '485':
          description: BatchLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchLimitExceededException'
              examples:
                BatchGetDeploymentGroups485Example:
                  summary: Default BatchGetDeploymentGroups 485 response
                  x-microcks-default: true
                  value: example-value
        '486':
          description: DeploymentConfigDoesNotExistException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentConfigDoesNotExistException'
              examples:
                BatchGetDeploymentGroups486Example:
                  summary: Default BatchGetDeploymentGroups 486 response
                  x-microcks-default: true
                  value: example-value
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchGetDeploymentGroupsInput'
            examples:
              BatchGetDeploymentGroupsRequestExample:
                summary: Default BatchGetDeploymentGroups request
                x-microcks-default: true
                value:
                  applicationName: example-resource
                  deploymentGroupNames: example-resource
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - CodeDeploy_20141006.BatchGetDeploymentGroups
      summary: Amazon CodeDeploy Batch Get Deployment Groups
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    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'
  /#X-Amz-Target=CodeDeploy_20141006.BatchGetDeploymentInstances:
    post:
      deprecated: true
      operationId: BatchGetDeploymentInstances
      description: '<note> <p> This method works, but is deprecated. Use <code>BatchGetDeploymentTargets</code> instead. </p> </note> <p> Returns an array of one or more instances associated with a deployment.
        This method works with EC2/On-premises and Lambda compute platforms. The newer <code>BatchGetDeploymentTargets</code> works with all compute platforms. The maximum number of instances that can be
        returned is 25.</p>'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchGetDeploymentInstancesOutput'
              examples:
                BatchGetDeploymentInstances200Example:
                  summary: Default BatchGetDeploymentInstances 200 response
                  x-microcks-default: true
                  value:
                    instancesSummary: example-value
                    errorMessage: example-value
        '480':
          description: DeploymentIdRequiredException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentIdRequiredException'
              examples:
                BatchGetDeploymentInstances480Example:
                  summary: Default BatchGetDeploymentInstances 480 response
                  x-microcks-default: true
                  value: example-value
        '481':
          description: DeploymentDoesNotExistException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentDoesNotExistException'
              examples:
                BatchGetDeploymentInstances481Example:
                  summary: Default BatchGetDeploymentInstances 481 response
                  x-microcks-default: true
                  value: example-value
        '482':
          description: InstanceIdRequiredException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstanceIdRequiredException'
              examples:
                BatchGetDeploymentInstances482Example:
                  summary: Default BatchGetDeploymentInstances 482 response
                  x-microcks-default: true
                  value: example-value
        '483':
          description: InvalidDeploymentIdException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidDeploymentIdException'
              examples:
                BatchGetDeploymentInstances483Example:
                  summary: Default BatchGetDeploymentInstances 483 response
                  x-microcks-default: true
                  value: example-value
        '484':
          description: InvalidInstanceNameException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidInstanceNameException'
              examples:
                BatchGetDeploymentInstances484Example:
                  summary: Default BatchGetDeploymentInstances 484 response
                  x-microcks-default: true
                  value: example-value
        '485':
          description: BatchLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchLimitExceededException'
              examples:
                BatchGetDeploymentInstances485Example:
                  summary: Default BatchGetDeploymentInstances 485 response
                  x-microcks-default: true
                  value: example-value
        '486':
          description: InvalidComputePlatformException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidComputePlatformException'
              examples:
                BatchGetDeploymentInstances486Example:
                  summary: Default BatchGetDeploymentInstances 486 response
                  x-microcks-default: true
                  value: example-value
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchGetDeploymentInstancesInput'
            examples:
              BatchGetDeploymentInstancesRequestExample:
                summary: Default BatchGetDeploymentInstances request
                x-microcks-default: true
                value:
                  deploymentId: '500123'
                  instanceIds: '500123'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - CodeDeploy_20141006.BatchGetDeploymentInstances
      summary: Amazon CodeDeploy Batch Get Deployment Instances
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    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'
  /#X-Amz-Target=CodeDeploy_20141006.BatchGetDeploymentTargets:
    post:
      operationId: BatchGetDeploymentTargets
      description: '<p> Returns an array of one or more targets associated with a deployment. This method works with all compute types and should be used instead of the deprecated <code>BatchGetDeploymentInstances</code>.
        The maximum number of targets that can be returned is 25.</p> <p> The type of targets returned depends on the deployment''s compute platform or deployment method: </p> <ul> <li> <p> <b>EC2/On-premises</b>:
        Information about Amazon EC2 instance targets. </p> </li> <li> <p> <b>Lambda</b>: Information about Lambda functions targets. </p> </li> <li> <p> <b>Amazon ECS</b>: Information about Amazon ECS
        service targets. </p> </li> <li> <p> <b>CloudFormation</b>: Information about targets of blue/green deployments initiated by a CloudFormation stack update.</p> </li> </ul>'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchGetDeploymentTargetsOutput'
              examples:
                BatchGetDeploymentTargets200Example:
                  summary: Default BatchGetDeploymentTargets 200 response
                  x-microcks-default: true
                  value:
                    deploymentTargets: example-value
        '480':
          description: InvalidDeploymentIdException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidDeploymentIdException'
              examples:
                BatchGetDeploymentTargets480Example:
                  summary: Default BatchGetDeploymentTargets 480 response
                  x-microcks-default: true
                  value: example-value
        '481':
          description: DeploymentIdRequiredException


# --- truncated at 32 KB (397 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-codedeploy/refs/heads/main/openapi/amazon-codedeploy-openapi-original.yaml
Amazon CodeDeploy API

Documentation

Specifications

Other Resources

OpenAPI Specification
