openapi: 3.0.0 info: version: '2014-10-06' x-release: v4 title: 'AWS CodeDeploy Applications #X Amz Target=CodeDeploy 20141006.GetDeploymentTarget API' description: '

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.

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.

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.

CodeDeploy Components

Use the information in this guide to help you work with the following CodeDeploy components:

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.

CodeDeploy Information Resources

' 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.GetDeploymentTarget' paths: /#X-Amz-Target=CodeDeploy_20141006.GetDeploymentTarget: 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: GetDeploymentTarget description: ' Returns information about a deployment target. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetDeploymentTargetOutput' examples: GetDeploymentTarget200Example: summary: Default GetDeploymentTarget 200 response x-microcks-default: true value: deploymentTarget: example-value '480': description: InvalidDeploymentIdException content: application/json: schema: $ref: '#/components/schemas/InvalidDeploymentIdException' examples: GetDeploymentTarget480Example: summary: Default GetDeploymentTarget 480 response x-microcks-default: true value: example-value '481': description: DeploymentIdRequiredException content: application/json: schema: $ref: '#/components/schemas/DeploymentIdRequiredException' examples: GetDeploymentTarget481Example: summary: Default GetDeploymentTarget 481 response x-microcks-default: true value: example-value '482': description: DeploymentDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/DeploymentDoesNotExistException' examples: GetDeploymentTarget482Example: summary: Default GetDeploymentTarget 482 response x-microcks-default: true value: example-value '483': description: DeploymentNotStartedException content: application/json: schema: $ref: '#/components/schemas/DeploymentNotStartedException' examples: GetDeploymentTarget483Example: summary: Default GetDeploymentTarget 483 response x-microcks-default: true value: example-value '484': description: DeploymentTargetIdRequiredException content: application/json: schema: $ref: '#/components/schemas/DeploymentTargetIdRequiredException' examples: GetDeploymentTarget484Example: summary: Default GetDeploymentTarget 484 response x-microcks-default: true value: example-value '485': description: InvalidDeploymentTargetIdException content: application/json: schema: $ref: '#/components/schemas/InvalidDeploymentTargetIdException' examples: GetDeploymentTarget485Example: summary: Default GetDeploymentTarget 485 response x-microcks-default: true value: example-value '486': description: DeploymentTargetDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/DeploymentTargetDoesNotExistException' examples: GetDeploymentTarget486Example: summary: Default GetDeploymentTarget 486 response x-microcks-default: true value: example-value '487': description: InvalidInstanceNameException content: application/json: schema: $ref: '#/components/schemas/InvalidInstanceNameException' examples: GetDeploymentTarget487Example: summary: Default GetDeploymentTarget 487 response x-microcks-default: true value: example-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetDeploymentTargetInput' examples: GetDeploymentTargetRequestExample: summary: Default GetDeploymentTarget request x-microcks-default: true value: deploymentId: '500123' targetId: '500123' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - CodeDeploy_20141006.GetDeploymentTarget summary: Amazon CodeDeploy Get Deployment Target x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - '#X Amz Target=CodeDeploy 20141006.GetDeploymentTarget' components: schemas: TrafficWeight: type: number format: double LifecycleEvent: type: object properties: lifecycleEventName: allOf: - $ref: '#/components/schemas/LifecycleEventName' - description: The deployment lifecycle event name, such as ApplicationStop, BeforeInstall, AfterInstall, ApplicationStart, or ValidateService. 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: '

The deployment lifecycle event status:

' description: Information about a deployment lifecycle event. TargetGroupName: type: string DeploymentId: type: string 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. LifecycleErrorCode: type: string enum: - Success - ScriptMissing - ScriptNotExecutable - ScriptTimedOut - ScriptFailed - UnknownError DeploymentDoesNotExistException: {} CloudFormationResourceType: type: string TargetLabel: type: string enum: - Blue - Green LambdaFunctionInfo: type: object properties: functionName: allOf: - $ref: '#/components/schemas/LambdaFunctionName' - description: ' The name of a Lambda function. ' functionAlias: allOf: - $ref: '#/components/schemas/LambdaFunctionAlias' - description: ' The alias of a Lambda function. For more information, see Lambda Function Aliases in the Lambda Developer Guide.' currentVersion: allOf: - $ref: '#/components/schemas/Version' - description: ' The version of a Lambda function that production traffic points to. ' targetVersion: allOf: - $ref: '#/components/schemas/Version' - description: ' The version of a Lambda function that production traffic points to after the Lambda function is deployed. ' targetVersionWeight: allOf: - $ref: '#/components/schemas/TrafficWeight' - description: ' The percentage of production traffic that the target version of a Lambda function receives. ' description: ' Information about a Lambda function specified in a deployment. ' Version: type: string LifecycleEventStatus: type: string enum: - Pending - InProgress - Succeeded - Failed - Skipped - Unknown LambdaFunctionName: type: string ECSTaskSetStatus: type: string DeploymentTargetIdRequiredException: {} TargetId: type: string DeploymentNotStartedException: {} DeploymentTarget: type: object properties: deploymentTargetType: allOf: - $ref: '#/components/schemas/DeploymentTargetType' - description: The deployment type that is specific to the deployment's compute platform or deployments initiated by a CloudFormation stack update. instanceTarget: allOf: - $ref: '#/components/schemas/InstanceTarget' - description: ' Information about the target for a deployment that uses the EC2/On-premises compute platform. ' lambdaTarget: allOf: - $ref: '#/components/schemas/LambdaTarget' - description: ' Information about the target for a deployment that uses the Lambda compute platform. ' ecsTarget: allOf: - $ref: '#/components/schemas/ECSTarget' - description: ' Information about the target for a deployment that uses the Amazon ECS compute platform. ' cloudFormationTarget: $ref: '#/components/schemas/CloudFormationTarget' description: ' Information about the deployment target. ' InvalidInstanceNameException: {} GetDeploymentTargetOutput: type: object properties: deploymentTarget: allOf: - $ref: '#/components/schemas/DeploymentTarget' - description: ' A deployment target that contains information about a deployment such as its status, lifecycle events, and when it was last updated. It also contains metadata about the deployment target. The deployment target metadata depends on the deployment target''s type (instanceTarget, lambdaTarget, or ecsTarget). ' TargetStatus: type: string enum: - Pending - InProgress - Succeeded - Failed - Skipped - Unknown - Ready CloudFormationTarget: type: object properties: deploymentId: allOf: - $ref: '#/components/schemas/DeploymentId' - description: The unique ID of an CloudFormation blue/green deployment. targetId: allOf: - $ref: '#/components/schemas/TargetId' - description: ' The unique ID of a deployment target that has a type of CloudFormationTarget. ' lastUpdatedAt: allOf: - $ref: '#/components/schemas/Time' - description: ' The date and time when the target application was updated by an CloudFormation blue/green deployment. ' lifecycleEvents: allOf: - $ref: '#/components/schemas/LifecycleEventList' - description: ' The lifecycle events of the CloudFormation blue/green deployment to this target application. ' status: allOf: - $ref: '#/components/schemas/TargetStatus' - description: ' The status of an CloudFormation blue/green deployment''s target application. ' resourceType: allOf: - $ref: '#/components/schemas/CloudFormationResourceType' - description: The resource type for the CloudFormation blue/green deployment. targetVersionWeight: allOf: - $ref: '#/components/schemas/TrafficWeight' - description: The percentage of production traffic that the target version of an CloudFormation blue/green deployment receives. description: ' Information about the target to be updated by an CloudFormation blue/green deployment. This target type is used for all deployments initiated by a CloudFormation stack update.' Diagnostics: type: object properties: errorCode: allOf: - $ref: '#/components/schemas/LifecycleErrorCode' - description: '

The associated error code:

' 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:

The last portion of the diagnostic log.

If available, CodeDeploy returns up to the last 4 KB of the diagnostic log.

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: {} DeploymentTargetType: type: string enum: - InstanceTarget - LambdaTarget - ECSTarget - CloudFormationTarget LogTail: type: string ECSTaskSetCount: type: integer LifecycleMessage: type: string TargetArn: type: string LambdaTarget: type: object properties: deploymentId: allOf: - $ref: '#/components/schemas/DeploymentId' - description: ' The unique ID of a deployment. ' targetId: allOf: - $ref: '#/components/schemas/TargetId' - description: ' The unique ID of a deployment target that has a type of lambdaTarget. ' targetArn: allOf: - $ref: '#/components/schemas/TargetArn' - description: ' The Amazon Resource Name (ARN) of the target. ' status: allOf: - $ref: '#/components/schemas/TargetStatus' - description: ' The status an Lambda deployment''s target Lambda function. ' lastUpdatedAt: allOf: - $ref: '#/components/schemas/Time' - description: ' The date and time when the target Lambda function was updated by a deployment. ' lifecycleEvents: allOf: - $ref: '#/components/schemas/LifecycleEventList' - description: ' The lifecycle events of the deployment to this target Lambda function. ' lambdaFunctionInfo: allOf: - $ref: '#/components/schemas/LambdaFunctionInfo' - description: ' A LambdaFunctionInfo object that describes a target Lambda function. ' description: ' Information about the target Lambda function during an Lambda deployment. ' Time: type: string format: date-time Timestamp: type: string format: date-time ECSTaskSetList: type: array items: $ref: '#/components/schemas/ECSTaskSet' GetDeploymentTargetInput: type: object title: GetDeploymentTargetInput properties: deploymentId: allOf: - $ref: '#/components/schemas/DeploymentId' - description: ' The unique ID of a deployment. ' targetId: allOf: - $ref: '#/components/schemas/TargetId' - description: ' The unique ID of a deployment target. ' DeploymentTargetDoesNotExistException: {} ECSTarget: type: object properties: deploymentId: allOf: - $ref: '#/components/schemas/DeploymentId' - description: ' The unique ID of a deployment. ' targetId: allOf: - $ref: '#/components/schemas/TargetId' - description: ' The unique ID of a deployment target that has a type of ecsTarget. ' targetArn: allOf: - $ref: '#/components/schemas/TargetArn' - description: ' The Amazon Resource Name (ARN) of the target. ' lastUpdatedAt: allOf: - $ref: '#/components/schemas/Time' - description: ' The date and time when the target Amazon ECS application was updated by a deployment. ' lifecycleEvents: allOf: - $ref: '#/components/schemas/LifecycleEventList' - description: ' The lifecycle events of the deployment to this target Amazon ECS application. ' status: allOf: - $ref: '#/components/schemas/TargetStatus' - description: ' The status an Amazon ECS deployment''s target ECS application. ' taskSetsInfo: allOf: - $ref: '#/components/schemas/ECSTaskSetList' - description: ' The ECSTaskSet objects associated with the ECS target. ' description: ' Information about the target of an Amazon ECS deployment. ' ECSTaskSet: type: object properties: identifer: allOf: - $ref: '#/components/schemas/ECSTaskSetIdentifier' - description: ' A unique ID of an ECSTaskSet. ' desiredCount: allOf: - $ref: '#/components/schemas/ECSTaskSetCount' - description: ' The number of tasks in a task set. During a deployment that uses the Amazon ECS compute type, CodeDeploy instructs Amazon ECS to create a new task set and uses this value to determine how many tasks to create. After the updated task set is created, CodeDeploy shifts traffic to the new task set. ' pendingCount: allOf: - $ref: '#/components/schemas/ECSTaskSetCount' - description: ' The number of tasks in the task set that are in the PENDING status during an Amazon ECS deployment. A task in the PENDING state is preparing to enter the RUNNING state. A task set enters the PENDING status when it launches for the first time, or when it is restarted after being in the STOPPED state. ' runningCount: allOf: - $ref: '#/components/schemas/ECSTaskSetCount' - description: ' The number of tasks in the task set that are in the RUNNING status during an Amazon ECS deployment. A task in the RUNNING state is running and ready for use. ' status: allOf: - $ref: '#/components/schemas/ECSTaskSetStatus' - description: '

The status of the task set. There are three valid task set statuses:

' trafficWeight: allOf: - $ref: '#/components/schemas/TrafficWeight' - description: ' The percentage of traffic served by this task set. ' targetGroup: allOf: - $ref: '#/components/schemas/TargetGroupInfo' - description: ' The target group associated with the task set. The target group is used by CodeDeploy to manage traffic to a task set. ' taskSetLabel: allOf: - $ref: '#/components/schemas/TargetLabel' - description: ' A label that identifies whether the ECS task set is an original target (BLUE) or a replacement target (GREEN). ' description: ' Information about a set of Amazon ECS tasks in an CodeDeploy deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic. An CodeDeploy application that uses the Amazon ECS compute platform deploys a containerized application in an Amazon ECS service as a task set. ' ScriptName: type: string InvalidDeploymentTargetIdException: {} LambdaFunctionAlias: type: string ECSTaskSetIdentifier: type: string InstanceTarget: type: object properties: deploymentId: allOf: - $ref: '#/components/schemas/DeploymentId' - description: ' The unique ID of a deployment. ' targetId: allOf: - $ref: '#/components/schemas/TargetId' - description: ' The unique ID of a deployment target that has a type of instanceTarget. ' targetArn: allOf: - $ref: '#/components/schemas/TargetArn' - description: ' The Amazon Resource Name (ARN) of the target. ' status: allOf: - $ref: '#/components/schemas/TargetStatus' - description: ' The status an EC2/On-premises deployment''s target instance. ' lastUpdatedAt: allOf: - $ref: '#/components/schemas/Time' - description: ' The date and time when the target instance was updated by a deployment. ' lifecycleEvents: allOf: - $ref: '#/components/schemas/LifecycleEventList' - description: ' The lifecycle events of the deployment to this target instance. ' instanceLabel: allOf: - $ref: '#/components/schemas/TargetLabel' - description: ' A label that identifies whether the instance is an original target (BLUE) or a replacement target (GREEN). ' description: ' A target Amazon EC2 or on-premises instance during a deployment that uses the EC2/On-premises compute platform. ' parameters: X-Amz-Algorithm: name: X-Amz-Algorithm 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-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