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:
Application: 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.
Deployment group: 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.
Deployment configuration: A set of deployment rules and deployment success and failure conditions used by CodeDeploy during a deployment.
Deployment: 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.
Application revisions: 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.
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
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:
Pending: The deployment lifecycle event is pending.
InProgress: The deployment lifecycle event is in progress.
Succeeded: The deployment lifecycle event ran successfully.
Failed: The deployment lifecycle event has failed.
Skipped: The deployment lifecycle event has been skipped.
Unknown: The deployment lifecycle event is unknown.
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:
Success: The specified script ran.
ScriptMissing: The specified script was not found in the specified location.
ScriptNotExecutable: The specified script is not a recognized executable file type.
ScriptTimedOut: The specified script did not finish running in the specified time period.
ScriptFailed: The specified script failed to run as expected.
UnknownError: The specified script did not run for an unknown reason.
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 oflambdaTarget. '
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:
PRIMARY: Indicates the task set is serving production traffic.
ACTIVE: Indicates the task set is not serving production traffic.
DRAINING: Indicates the tasks in the task set are being stopped and their corresponding targets are being deregistered from their target group.
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