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

openapi: 3.0.0
info:
  version: '2014-10-06'
  x-release: v4
  title: 'AWS CodeDeploy Applications #X Amz Target=CodeDeploy 20141006.GetDeploymentInstance 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.GetDeploymentInstance'
paths:
  /#X-Amz-Target=CodeDeploy_20141006.GetDeploymentInstance:
    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:
      deprecated: true
      operationId: GetDeploymentInstance
      description: Gets information about an instance as part of a deployment.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDeploymentInstanceOutput'
              examples:
                GetDeploymentInstance200Example:
                  summary: Default GetDeploymentInstance 200 response
                  x-microcks-default: true
                  value:
                    instanceSummary: example-value
        '480':
          description: DeploymentIdRequiredException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentIdRequiredException'
              examples:
                GetDeploymentInstance480Example:
                  summary: Default GetDeploymentInstance 480 response
                  x-microcks-default: true
                  value: example-value
        '481':
          description: DeploymentDoesNotExistException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentDoesNotExistException'
              examples:
                GetDeploymentInstance481Example:
                  summary: Default GetDeploymentInstance 481 response
                  x-microcks-default: true
                  value: example-value
        '482':
          description: InstanceIdRequiredException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstanceIdRequiredException'
              examples:
                GetDeploymentInstance482Example:
                  summary: Default GetDeploymentInstance 482 response
                  x-microcks-default: true
                  value: example-value
        '483':
          description: InvalidDeploymentIdException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidDeploymentIdException'
              examples:
                GetDeploymentInstance483Example:
                  summary: Default GetDeploymentInstance 483 response
                  x-microcks-default: true
                  value: example-value
        '484':
          description: InstanceDoesNotExistException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstanceDoesNotExistException'
              examples:
                GetDeploymentInstance484Example:
                  summary: Default GetDeploymentInstance 484 response
                  x-microcks-default: true
                  value: example-value
        '485':
          description: InvalidInstanceNameException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidInstanceNameException'
              examples:
                GetDeploymentInstance485Example:
                  summary: Default GetDeploymentInstance 485 response
                  x-microcks-default: true
                  value: example-value
        '486':
          description: InvalidComputePlatformException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidComputePlatformException'
              examples:
                GetDeploymentInstance486Example:
                  summary: Default GetDeploymentInstance 486 response
                  x-microcks-default: true
                  value: example-value
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetDeploymentInstanceInput'
            examples:
              GetDeploymentInstanceRequestExample:
                summary: Default GetDeploymentInstance request
                x-microcks-default: true
                value:
                  deploymentId: '500123'
                  instanceId: '500123'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - CodeDeploy_20141006.GetDeploymentInstance
      summary: Amazon CodeDeploy Get Deployment Instance
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=CodeDeploy 20141006.GetDeploymentInstance'
components:
  schemas:
    LifecycleEvent:
      type: object
      properties:
        lifecycleEventName:
          allOf:
          - $ref: '#/components/schemas/LifecycleEventName'
          - description: The deployment lifecycle event name, such as <code>ApplicationStop</code>, <code>BeforeInstall</code>, <code>AfterInstall</code>, <code>ApplicationStart</code>, or <code>ValidateService</code>.
        diagnostics:
          allOf:
          - $ref: '#/components/schemas/Diagnostics'
          - description: Diagnostic information about the deployment lifecycle event.
        startTime:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: A timestamp that indicates when the deployment lifecycle event started.
        endTime:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: A timestamp that indicates when the deployment lifecycle event ended.
        status:
          allOf:
          - $ref: '#/components/schemas/LifecycleEventStatus'
          - description: '<p>The deployment lifecycle event status:</p> <ul> <li> <p>Pending: The deployment lifecycle event is pending.</p> </li> <li> <p>InProgress: The deployment lifecycle event is in progress.</p> </li> <li> <p>Succeeded: The deployment lifecycle event ran successfully.</p> </li> <li> <p>Failed: The deployment lifecycle event has failed.</p> </li> <li> <p>Skipped: The deployment lifecycle event has been skipped.</p> </li> <li> <p>Unknown: The deployment lifecycle event is unknown.</p> </li> </ul>'
      description: Information about a deployment lifecycle event.
    DeploymentId:
      type: string
    LifecycleErrorCode:
      type: string
      enum:
      - Success
      - ScriptMissing
      - ScriptNotExecutable
      - ScriptTimedOut
      - ScriptFailed
      - UnknownError
    DeploymentDoesNotExistException: {}
    InstanceType:
      type: string
      enum:
      - Blue
      - Green
    LifecycleEventStatus:
      type: string
      enum:
      - Pending
      - InProgress
      - Succeeded
      - Failed
      - Skipped
      - Unknown
    GetDeploymentInstanceInput:
      type: object
      required:
      - deploymentId
      - instanceId
      title: GetDeploymentInstanceInput
      properties:
        deploymentId:
          allOf:
          - $ref: '#/components/schemas/DeploymentId'
          - description: ' The unique ID of a deployment. '
        instanceId:
          allOf:
          - $ref: '#/components/schemas/InstanceId'
          - description: ' The unique ID of an instance in the deployment group. '
      description: ' Represents the input of a <code>GetDeploymentInstance</code> operation. '
    InstanceSummary:
      type: object
      deprecated: true
      properties:
        deploymentId:
          allOf:
          - $ref: '#/components/schemas/DeploymentId'
          - description: ' The unique ID of a deployment. '
        instanceId:
          allOf:
          - $ref: '#/components/schemas/InstanceId'
          - description: The instance ID.
        status:
          allOf:
          - $ref: '#/components/schemas/InstanceStatus'
          - description: '<p>The deployment status for this instance:</p> <ul> <li> <p> <code>Pending</code>: The deployment is pending for this instance.</p> </li> <li> <p> <code>In Progress</code>: The deployment is in progress for this instance.</p> </li> <li> <p> <code>Succeeded</code>: The deployment has succeeded for this instance.</p> </li> <li> <p> <code>Failed</code>: The deployment has failed for this instance.</p> </li> <li> <p> <code>Skipped</code>: The deployment has been skipped for this instance.</p> </li> <li> <p> <code>Unknown</code>: The deployment status is unknown for this instance.</p> </li> </ul>'
        lastUpdatedAt:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: A timestamp that indicates when the instance information was last updated.
        lifecycleEvents:
          allOf:
          - $ref: '#/components/schemas/LifecycleEventList'
          - description: A list of lifecycle events for this instance.
        instanceType:
          allOf:
          - $ref: '#/components/schemas/InstanceType'
          - description: '<p>Information about which environment an instance belongs to in a blue/green deployment.</p> <ul> <li> <p>BLUE: The instance is part of the original environment.</p> </li> <li> <p>GREEN: The instance is part of the replacement environment.</p> </li> </ul>'
      description: Information about an instance in a deployment.InstanceSummary is deprecated, use DeploymentTarget instead.
    InvalidInstanceNameException: {}
    Diagnostics:
      type: object
      properties:
        errorCode:
          allOf:
          - $ref: '#/components/schemas/LifecycleErrorCode'
          - description: '<p>The associated error code:</p> <ul> <li> <p>Success: The specified script ran.</p> </li> <li> <p>ScriptMissing: The specified script was not found in the specified location.</p> </li> <li> <p>ScriptNotExecutable: The specified script is not a recognized executable file type.</p> </li> <li> <p>ScriptTimedOut: The specified script did not finish running in the specified time period.</p> </li> <li> <p>ScriptFailed: The specified script failed to run as expected.</p> </li> <li> <p>UnknownError: The specified script did not run for an unknown reason.</p> </li> </ul>'
        scriptName:
          allOf:
          - $ref: '#/components/schemas/ScriptName'
          - description: The name of the script.
        message:
          allOf:
          - $ref: '#/components/schemas/LifecycleMessage'
          - description: The message associated with the error.
        logTail:
          allOf:
          - $ref: '#/components/schemas/LogTail'
          - description: <p>The last portion of the diagnostic log.</p> <p>If available, CodeDeploy returns up to the last 4 KB of the diagnostic log.</p>
      description: Diagnostic information about executable scripts that are part of a deployment.
    LifecycleEventList:
      type: array
      items:
        $ref: '#/components/schemas/LifecycleEvent'
    DeploymentIdRequiredException: {}
    LifecycleEventName:
      type: string
    InvalidDeploymentIdException: {}
    InstanceId:
      type: string
    LogTail:
      type: string
    LifecycleMessage:
      type: string
    InstanceDoesNotExistException: {}
    InstanceStatus:
      type: string
      deprecated: true
      enum:
      - Pending
      - InProgress
      - Succeeded
      - Failed
      - Skipped
      - Unknown
      - Ready
      description: InstanceStatus is deprecated, use TargetStatus instead.
    Timestamp:
      type: string
      format: date-time
    GetDeploymentInstanceOutput:
      type: object
      properties:
        instanceSummary:
          allOf:
          - $ref: '#/components/schemas/InstanceSummary'
          - description: ' Information about the instance. '
      description: ' Represents the output of a <code>GetDeploymentInstance</code> operation. '
    InstanceIdRequiredException: {}
    ScriptName:
      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