The #X Amz Target=CodeDeploy 20141006.BatchGetDeploymentTargets API from Amazon CodeDeploy — 1 operation(s) for #x amz target=codedeploy 20141006.batchgetdeploymenttargets.
openapi: 3.0.0
info:
version: '2014-10-06'
x-release: v4
title: 'AWS CodeDeploy Applications #X Amz Target=CodeDeploy 20141006.BatchGetDeploymentTargets 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.BatchGetDeploymentTargets'
paths:
/#X-Amz-Target=CodeDeploy_20141006.BatchGetDeploymentTargets:
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: 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
content:
application/json:
schema:
$ref: '#/components/schemas/DeploymentIdRequiredException'
examples:
BatchGetDeploymentTargets481Example:
summary: Default BatchGetDeploymentTargets 481 response
x-microcks-default: true
value: example-value
'482':
description: DeploymentDoesNotExistException
content:
application/json:
schema:
$ref: '#/components/schemas/DeploymentDoesNotExistException'
examples:
BatchGetDeploymentTargets482Example:
summary: Default BatchGetDeploymentTargets 482 response
x-microcks-default: true
value: example-value
'483':
description: DeploymentNotStartedException
content:
application/json:
schema:
$ref: '#/components/schemas/DeploymentNotStartedException'
examples:
BatchGetDeploymentTargets483Example:
summary: Default BatchGetDeploymentTargets 483 response
x-microcks-default: true
value: example-value
'484':
description: DeploymentTargetIdRequiredException
content:
application/json:
schema:
$ref: '#/components/schemas/DeploymentTargetIdRequiredException'
examples:
BatchGetDeploymentTargets484Example:
summary: Default BatchGetDeploymentTargets 484 response
x-microcks-default: true
value: example-value
'485':
description: InvalidDeploymentTargetIdException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidDeploymentTargetIdException'
examples:
BatchGetDeploymentTargets485Example:
summary: Default BatchGetDeploymentTargets 485 response
x-microcks-default: true
value: example-value
'486':
description: DeploymentTargetDoesNotExistException
content:
application/json:
schema:
$ref: '#/components/schemas/DeploymentTargetDoesNotExistException'
examples:
BatchGetDeploymentTargets486Example:
summary: Default BatchGetDeploymentTargets 486 response
x-microcks-default: true
value: example-value
'487':
description: DeploymentTargetListSizeExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/DeploymentTargetListSizeExceededException'
examples:
BatchGetDeploymentTargets487Example:
summary: Default BatchGetDeploymentTargets 487 response
x-microcks-default: true
value: example-value
'488':
description: InstanceDoesNotExistException
content:
application/json:
schema:
$ref: '#/components/schemas/InstanceDoesNotExistException'
examples:
BatchGetDeploymentTargets488Example:
summary: Default BatchGetDeploymentTargets 488 response
x-microcks-default: true
value: example-value
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BatchGetDeploymentTargetsInput'
examples:
BatchGetDeploymentTargetsRequestExample:
summary: Default BatchGetDeploymentTargets request
x-microcks-default: true
value:
deploymentId: '500123'
targetIds: '500123'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- CodeDeploy_20141006.BatchGetDeploymentTargets
summary: Amazon CodeDeploy Batch Get Deployment Targets
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#X Amz Target=CodeDeploy 20141006.BatchGetDeploymentTargets'
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 <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.
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 <a href="https://docs.aws.amazon.com/lambda/latest/dg/aliases-intro.html">Lambda Function Aliases</a> in the <i>Lambda Developer Guide</i>.'
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
BatchGetDeploymentTargetsOutput:
type: object
properties:
deploymentTargets:
allOf:
- $ref: '#/components/schemas/DeploymentTargetList'
- description: '<p> A list of target objects for a deployment. Each target object contains details about the target, such as its status and lifecycle events. The type of the target objects depends on the deployment'' compute platform. </p> <ul> <li> <p> <b>EC2/On-premises</b>: Each target object is an Amazon EC2 or on-premises instance. </p> </li> <li> <p> <b>Lambda</b>: The target object is a specific version of an Lambda function. </p> </li> <li> <p> <b>Amazon ECS</b>: The target object is an Amazon ECS service. </p> </li> <li> <p> <b>CloudFormation</b>: The target object is an CloudFormation blue/green deployment. </p> </li> </ul>'
ECSTaskSetStatus:
type: string
DeploymentTargetIdRequiredException: {}
TargetId:
type: string
TargetIdList:
type: array
items:
$ref: '#/components/schemas/TargetId'
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. '
DeploymentTargetListSizeExceededException: {}
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 <code>CloudFormationTarget</code>. '
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.'
TargetStatus:
type: string
enum:
- Pending
- InProgress
- Succeeded
- Failed
- Skipped
- Unknown
- Ready
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.
LifecycleEventName:
type: string
LifecycleEventList:
type: array
items:
$ref: '#/components/schemas/LifecycleEvent'
DeploymentIdRequiredException: {}
InvalidDeploymentIdException: {}
DeploymentTargetType:
type: string
enum:
- InstanceTarget
- LambdaTarget
- ECSTarget
- CloudFormationTarget
LogTail:
type: string
DeploymentTargetList:
type: array
items:
$ref: '#/components/schemas/DeploymentTarget'
BatchGetDeploymentTargetsInput:
type: object
title: BatchGetDeploymentTargetsInput
properties:
deploymentId:
allOf:
- $ref: '#/components/schemas/DeploymentId'
- description: ' The unique ID of a deployment. '
targetIds:
allOf:
- $ref: '#/components/schemas/TargetIdList'
- description: <p> The unique IDs of the deployment targets. The compute platform of the deployment determines the type of the targets and their formats. The maximum number of deployment target IDs you can specify is 25.</p> <ul> <li> <p> For deployments that use the EC2/On-premises compute platform, the target IDs are Amazon EC2 or on-premises instances IDs, and their target type is <code>instanceTarget</code>. </p> </li> <li> <p> For deployments that use the Lambda compute platform, the target IDs are the names of Lambda functions, and their target type is <code>instanceTarget</code>. </p> </li> <li> <p> For deployments that use the Amazon ECS compute platform, the target IDs are pairs of Amazon ECS clusters and services specified using the format <code><clustername>:<servicename></code>. Their target type is <code>ecsTarget</code>. </p> </li> <li> <p> For deployments that are deployed with CloudFormation, the target IDs are CloudFormation stack IDs. Their target type is <code>cloudFormationTarget</code>. </p> </li> </ul>
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 <code>lambdaTarget</code>. '
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 <code>LambdaFunctionInfo</code> object that describes a target Lambda function. '
description: ' Information about the target Lambda function during an Lambda deployment. '
InstanceDoesNotExistException: {}
Time:
type: string
format: date-time
Timestamp:
type: string
format: date-time
ECSTaskSetList:
type: array
items:
$ref: '#/components/schemas/ECSTaskSet'
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 <code>ecsTarget</code>. '
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 <code>ECSTaskSet</code> 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 <code>ECSTaskSet</code>. '
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 <code>PENDING</code> status during an Amazon ECS deployment. A task in the <code>PENDING</code> state is preparing to enter the <code>RUNNING</code> state. A task set enters the <code>PENDING</code> status when it launches for the first time, or when it is restarted after being in the <code>STOPPED</code> state. '
runningCount:
allOf:
- $ref: '#/components/schemas/ECSTaskSetCount'
- description: ' The number of tasks in the task set that are in the <code>RUNNING</code> status during an Amazon ECS deployment. A task in the <code>RUNNING</code> state is running and ready for use. '
status:
allOf:
- $ref: '#/components/schemas/ECSTaskSetStatus'
- description: '<p> The status of the task set. There are three valid task set statuses: </p> <ul> <li> <p> <code>PRIMARY</code>: Indicates the task set is serving production traffic. </p> </li> <li> <p> <code>ACTIVE</code>: Indicates the task set is not serving production traffic. </p> </li> <li> <p> <code>DRAINING</code>: Indicates the tasks in the task set are being stopped and their corresponding targets are being deregistered from their target group. </p> </li> </ul>'
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 (<code>BLUE</code>) or a replacement target (<code>GREEN</code>). '
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 <code>instanceTarget</code>. '
targetArn:
allOf:
- $ref: '#/components/schemas/TargetArn'
-
# --- truncated at 32 KB (34 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-codedeploy/refs/heads/main/openapi/amazon-codedeploy-x-amz-target-codedeploy-20141006-batchgetdeploymenttargets-api-openapi.yml