openapi: 3.0.0
info:
  version: '2014-10-06'
  x-release: v4
  title: 'AWS CodeDeploy Applications #X Amz Target=CodeDeploy 20141006.PutLifecycleEventHookExecutionStatus 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.PutLifecycleEventHookExecutionStatus'
paths:
  /#X-Amz-Target=CodeDeploy_20141006.PutLifecycleEventHookExecutionStatus:
    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: PutLifecycleEventHookExecutionStatus
      description: ' Sets the result of a Lambda validation function. The function validates lifecycle hooks during a deployment that uses the Lambda or Amazon ECS compute platform. For Lambda deployments, the available lifecycle hooks are <code>BeforeAllowTraffic</code> and <code>AfterAllowTraffic</code>. For Amazon ECS deployments, the available lifecycle hooks are <code>BeforeInstall</code>, <code>AfterInstall</code>, <code>AfterAllowTestTraffic</code>, <code>BeforeAllowTraffic</code>, and <code>AfterAllowTraffic</code>. Lambda validation functions return <code>Succeeded</code> or <code>Failed</code>. For more information, see <a href="https://docs.aws.amazon.com/codedeploy/latest/userguide/reference-appspec-file-structure-hooks.html#appspec-hooks-lambda">AppSpec ''hooks'' Section for an Lambda Deployment </a> and <a href="https://docs.aws.amazon.com/codedeploy/latest/userguide/reference-appspec-file-structure-hooks.html#appspec-hooks-ecs">AppSpec ''hooks'' Section for an Amazon ECS Deployment</a>.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutLifecycleEventHookExecutionStatusOutput'
              examples:
                PutLifecycleEventHookExecutionStatus200Example:
                  summary: Default PutLifecycleEventHookExecutionStatus 200 response
                  x-microcks-default: true
                  value:
                    lifecycleEventHookExecutionId: '500123'
        '480':
          description: InvalidLifecycleEventHookExecutionStatusException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidLifecycleEventHookExecutionStatusException'
              examples:
                PutLifecycleEventHookExecutionStatus480Example:
                  summary: Default PutLifecycleEventHookExecutionStatus 480 response
                  x-microcks-default: true
                  value: ACTIVE
        '481':
          description: InvalidLifecycleEventHookExecutionIdException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidLifecycleEventHookExecutionIdException'
              examples:
                PutLifecycleEventHookExecutionStatus481Example:
                  summary: Default PutLifecycleEventHookExecutionStatus 481 response
                  x-microcks-default: true
                  value: ACTIVE
        '482':
          description: LifecycleEventAlreadyCompletedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LifecycleEventAlreadyCompletedException'
              examples:
                PutLifecycleEventHookExecutionStatus482Example:
                  summary: Default PutLifecycleEventHookExecutionStatus 482 response
                  x-microcks-default: true
                  value: ACTIVE
        '483':
          description: DeploymentIdRequiredException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentIdRequiredException'
              examples:
                PutLifecycleEventHookExecutionStatus483Example:
                  summary: Default PutLifecycleEventHookExecutionStatus 483 response
                  x-microcks-default: true
                  value: ACTIVE
        '484':
          description: DeploymentDoesNotExistException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentDoesNotExistException'
              examples:
                PutLifecycleEventHookExecutionStatus484Example:
                  summary: Default PutLifecycleEventHookExecutionStatus 484 response
                  x-microcks-default: true
                  value: ACTIVE
        '485':
          description: InvalidDeploymentIdException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidDeploymentIdException'
              examples:
                PutLifecycleEventHookExecutionStatus485Example:
                  summary: Default PutLifecycleEventHookExecutionStatus 485 response
                  x-microcks-default: true
                  value: ACTIVE
        '486':
          description: UnsupportedActionForDeploymentTypeException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnsupportedActionForDeploymentTypeException'
              examples:
                PutLifecycleEventHookExecutionStatus486Example:
                  summary: Default PutLifecycleEventHookExecutionStatus 486 response
                  x-microcks-default: true
                  value: ACTIVE
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutLifecycleEventHookExecutionStatusInput'
            examples:
              PutLifecycleEventHookExecutionStatusRequestExample:
                summary: Default PutLifecycleEventHookExecutionStatus request
                x-microcks-default: true
                value:
                  deploymentId: '500123'
                  lifecycleEventHookExecutionId: '500123'
                  status: ACTIVE
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - CodeDeploy_20141006.PutLifecycleEventHookExecutionStatus
      summary: Amazon CodeDeploy Put Lifecycle Event Hook Execution Status
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=CodeDeploy 20141006.PutLifecycleEventHookExecutionStatus'
components:
  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
  schemas:
    DeploymentId:
      type: string
    DeploymentDoesNotExistException: {}
    LifecycleEventStatus:
      type: string
      enum:
      - Pending
      - InProgress
      - Succeeded
      - Failed
      - Skipped
      - Unknown
    DeploymentIdRequiredException: {}
    InvalidDeploymentIdException: {}
    PutLifecycleEventHookExecutionStatusInput:
      type: object
      title: PutLifecycleEventHookExecutionStatusInput
      properties:
        deploymentId:
          allOf:
          - $ref: '#/components/schemas/DeploymentId'
          - description: ' The unique ID of a deployment. Pass this ID to a Lambda function that validates a deployment lifecycle event. '
        lifecycleEventHookExecutionId:
          allOf:
          - $ref: '#/components/schemas/LifecycleEventHookExecutionId'
          - description: ' The execution ID of a deployment''s lifecycle hook. A deployment lifecycle hook is specified in the <code>hooks</code> section of the AppSpec file. '
        status:
          allOf:
          - $ref: '#/components/schemas/LifecycleEventStatus'
          - description: The result of a Lambda function that validates a deployment lifecycle event. The values listed in <b>Valid Values</b> are valid for lifecycle statuses in general; however, only <code>Succeeded</code> and <code>Failed</code> can be passed successfully in your API call.
    PutLifecycleEventHookExecutionStatusOutput:
      type: object
      properties:
        lifecycleEventHookExecutionId:
          allOf:
          - $ref: '#/components/schemas/LifecycleEventHookExecutionId'
          - description: The execution ID of the lifecycle event hook. A hook is specified in the <code>hooks</code> section of the deployment's AppSpec file.
    InvalidLifecycleEventHookExecutionIdException: {}
    InvalidLifecycleEventHookExecutionStatusException: {}
    LifecycleEventAlreadyCompletedException: {}
    LifecycleEventHookExecutionId:
      type: string
    UnsupportedActionForDeploymentTypeException: {}
  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