Amazon CodeDeploy #X Amz Target=CodeDeploy 20141006.GetDeployment API
The #X Amz Target=CodeDeploy 20141006.GetDeployment API from Amazon CodeDeploy — 1 operation(s) for #x amz target=codedeploy 20141006.getdeployment.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-codedeploy-x-amz-target-codedeploy-20141006-getdeployment-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
version: 1.0.0
x-release: v4
title: 'AWS CodeDeploy Applications #X Amz Target=CodeDeploy 20141006.GetDeployment #X Amz Target=CodeDeploy 20141006.GetDeployment #X Amz Target=CodeDeploy 20141006.GetDeployment 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
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.GetDeployment'
paths:
/#X-Amz-Target=CodeDeploy_20141006.GetDeployment:
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: GetDeployment
description: <p>Gets information about a deployment.</p> <note> <p> The <code>content</code> property of the <code>appSpecContent</code> object in the returned revision is always null. Use <code>GetApplicationRevision</code> and the <code>sha256</code> property of the returned <code>appSpecContent</code> object to get the content of the deployment’s AppSpec file. </p> </note>
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetDeploymentOutput'
examples:
GetDeployment200Example:
summary: Default GetDeployment 200 response
x-microcks-default: true
value:
deploymentInfo: example-value
'480':
description: DeploymentIdRequiredException
content:
application/json:
schema:
$ref: '#/components/schemas/DeploymentIdRequiredException'
examples:
GetDeployment480Example:
summary: Default GetDeployment 480 response
x-microcks-default: true
value: example-value
'481':
description: InvalidDeploymentIdException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidDeploymentIdException'
examples:
GetDeployment481Example:
summary: Default GetDeployment 481 response
x-microcks-default: true
value: example-value
'482':
description: DeploymentDoesNotExistException
content:
application/json:
schema:
$ref: '#/components/schemas/DeploymentDoesNotExistException'
examples:
GetDeployment482Example:
summary: Default GetDeployment 482 response
x-microcks-default: true
value: example-value
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetDeploymentInput'
examples:
GetDeploymentRequestExample:
summary: Default GetDeployment request
x-microcks-default: true
value:
deploymentId: '500123'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- CodeDeploy_20141006.GetDeployment
summary: Amazon CodeDeploy Get Deployment
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#X Amz Target=CodeDeploy 20141006.GetDeployment'
components:
schemas:
Alarm:
type: object
properties:
name:
allOf:
- $ref: '#/components/schemas/AlarmName'
- description: The name of the alarm. Maximum length is 255 characters. Each alarm name can be used only once in a list of alarms.
description: Information about an alarm.
DeploymentStatus:
type: string
enum:
- Created
- Queued
- InProgress
- Baking
- Succeeded
- Failed
- Stopped
- Ready
DeploymentInfo:
type: object
properties:
applicationName:
allOf:
- $ref: '#/components/schemas/ApplicationName'
- description: The application name.
deploymentGroupName:
allOf:
- $ref: '#/components/schemas/DeploymentGroupName'
- description: ' The deployment group name. '
deploymentConfigName:
allOf:
- $ref: '#/components/schemas/DeploymentConfigName'
- description: ' The deployment configuration name. '
deploymentId:
allOf:
- $ref: '#/components/schemas/DeploymentId'
- description: ' The unique ID of a deployment. '
previousRevision:
allOf:
- $ref: '#/components/schemas/RevisionLocation'
- description: Information about the application revision that was deployed to the deployment group before the most recent successful deployment.
revision:
allOf:
- $ref: '#/components/schemas/RevisionLocation'
- description: Information about the location of stored application artifacts and the service from which to retrieve them.
status:
allOf:
- $ref: '#/components/schemas/DeploymentStatus'
- description: The current state of the deployment as a whole.
errorInformation:
allOf:
- $ref: '#/components/schemas/ErrorInformation'
- description: Information about any error associated with this deployment.
createTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: A timestamp that indicates when the deployment was created.
startTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: <p>A timestamp that indicates when the deployment was deployed to the deployment group.</p> <p>In some cases, the reported value of the start time might be later than the complete time. This is due to differences in the clock settings of backend servers that participate in the deployment process.</p>
completeTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: A timestamp that indicates when the deployment was complete.
deploymentOverview:
allOf:
- $ref: '#/components/schemas/DeploymentOverview'
- description: A summary of the deployment status of the instances in the deployment.
description:
allOf:
- $ref: '#/components/schemas/Description'
- description: A comment about the deployment.
creator:
allOf:
- $ref: '#/components/schemas/DeploymentCreator'
- description: '<p>The means by which the deployment was created:</p> <ul> <li> <p> <code>user</code>: A user created the deployment.</p> </li> <li> <p> <code>autoscaling</code>: Amazon EC2 Auto Scaling created the deployment.</p> </li> <li> <p> <code>codeDeployRollback</code>: A rollback process created the deployment.</p> </li> <li> <p> <code>CodeDeployAutoUpdate</code>: An auto-update process created the deployment when it detected outdated Amazon EC2 instances.</p> </li> </ul>'
ignoreApplicationStopFailures:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: <p> If true, then if an <code>ApplicationStop</code>, <code>BeforeBlockTraffic</code>, or <code>AfterBlockTraffic</code> deployment lifecycle event to an instance fails, then the deployment continues to the next deployment lifecycle event. For example, if <code>ApplicationStop</code> fails, the deployment continues with DownloadBundle. If <code>BeforeBlockTraffic</code> fails, the deployment continues with <code>BlockTraffic</code>. If <code>AfterBlockTraffic</code> fails, the deployment continues with <code>ApplicationStop</code>. </p> <p> If false or not specified, then if a lifecycle event fails during a deployment to an instance, that deployment fails. If deployment to that instance is part of an overall deployment and the number of healthy hosts is not less than the minimum number of healthy hosts, then a deployment to the next instance is attempted. </p> <p> During a deployment, the CodeDeploy agent runs the scripts specified for <code>ApplicationStop</code>, <code>BeforeBlockTraffic</code>, and <code>AfterBlockTraffic</code> in the AppSpec file from the previous successful deployment. (All other scripts are run from the AppSpec file in the current deployment.) If one of these scripts contains an error and does not run successfully, the deployment can fail. </p> <p> If the cause of the failure is a script from the last successful deployment that will never run successfully, create a new deployment and use <code>ignoreApplicationStopFailures</code> to specify that the <code>ApplicationStop</code>, <code>BeforeBlockTraffic</code>, and <code>AfterBlockTraffic</code> failures should be ignored. </p>
autoRollbackConfiguration:
allOf:
- $ref: '#/components/schemas/AutoRollbackConfiguration'
- description: Information about the automatic rollback configuration associated with the deployment.
updateOutdatedInstancesOnly:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Indicates whether only instances that are not running the latest application revision are to be deployed to.
rollbackInfo:
allOf:
- $ref: '#/components/schemas/RollbackInfo'
- description: Information about a deployment rollback.
deploymentStyle:
allOf:
- $ref: '#/components/schemas/DeploymentStyle'
- description: Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer.
targetInstances:
allOf:
- $ref: '#/components/schemas/TargetInstances'
- description: Information about the instances that belong to the replacement environment in a blue/green deployment.
instanceTerminationWaitTimeStarted:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Indicates whether the wait period set for the termination of instances in the original environment has started. Status is 'false' if the KEEP_ALIVE option is specified. Otherwise, 'true' as soon as the termination wait period starts.
blueGreenDeploymentConfiguration:
allOf:
- $ref: '#/components/schemas/BlueGreenDeploymentConfiguration'
- description: Information about blue/green deployment options for this deployment.
loadBalancerInfo:
allOf:
- $ref: '#/components/schemas/LoadBalancerInfo'
- description: Information about the load balancer used in the deployment.
additionalDeploymentStatusInfo:
allOf:
- $ref: '#/components/schemas/AdditionalDeploymentStatusInfo'
- description: Provides information about the results of a deployment, such as whether instances in the original environment in a blue/green deployment were not terminated.
fileExistsBehavior:
allOf:
- $ref: '#/components/schemas/FileExistsBehavior'
- description: '<p>Information about how CodeDeploy handles files that already exist in a deployment target location but weren''t part of the previous successful deployment.</p> <ul> <li> <p> <code>DISALLOW</code>: The deployment fails. This is also the default behavior if no option is specified.</p> </li> <li> <p> <code>OVERWRITE</code>: The version of the file from the application revision currently being deployed replaces the version already on the instance.</p> </li> <li> <p> <code>RETAIN</code>: The version of the file already on the instance is kept and used as part of the new deployment.</p> </li> </ul>'
deploymentStatusMessages:
allOf:
- $ref: '#/components/schemas/DeploymentStatusMessageList'
- description: Messages that contain information about the status of a deployment.
computePlatform:
allOf:
- $ref: '#/components/schemas/ComputePlatform'
- description: The destination platform type for the deployment (<code>Lambda</code>, <code>Server</code>, or <code>ECS</code>).
externalId:
allOf:
- $ref: '#/components/schemas/ExternalId'
- description: The unique ID for an external resource (for example, a CloudFormation stack ID) that is linked to this deployment.
relatedDeployments:
$ref: '#/components/schemas/RelatedDeployments'
overrideAlarmConfiguration:
$ref: '#/components/schemas/AlarmConfiguration'
description: Information about a deployment.
EC2TagSetList:
type: array
items:
$ref: '#/components/schemas/EC2TagFilterList'
TargetGroupName:
type: string
RollbackInfo:
type: object
properties:
rollbackDeploymentId:
allOf:
- $ref: '#/components/schemas/DeploymentId'
- description: The ID of the deployment rollback.
rollbackTriggeringDeploymentId:
allOf:
- $ref: '#/components/schemas/DeploymentId'
- description: The deployment ID of the deployment that was underway and triggered a rollback deployment because it failed or was stopped.
rollbackMessage:
allOf:
- $ref: '#/components/schemas/Description'
- description: 'Information that describes the status of a deployment rollback (for example, whether the deployment can''t be rolled back, is in progress, failed, or succeeded). '
description: Information about a deployment rollback.
ErrorInformation:
type: object
properties:
code:
allOf:
- $ref: '#/components/schemas/ErrorCode'
- description: '<p>For more information, see <a href="https://docs.aws.amazon.com/codedeploy/latest/userguide/error-codes.html">Error Codes for CodeDeploy</a> in the <a href="https://docs.aws.amazon.com/codedeploy/latest/userguide">CodeDeploy User Guide</a>.</p> <p>The error code:</p> <ul> <li> <p>APPLICATION_MISSING: The application was missing. This error code is most likely raised if the application is deleted after the deployment is created, but before it is started.</p> </li> <li> <p>DEPLOYMENT_GROUP_MISSING: The deployment group was missing. This error code is most likely raised if the deployment group is deleted after the deployment is created, but before it is started.</p> </li> <li> <p>HEALTH_CONSTRAINTS: The deployment failed on too many instances to be successfully deployed within the instance health constraints specified.</p> </li> <li> <p>HEALTH_CONSTRAINTS_INVALID: The revision cannot be successfully deployed within the instance health constraints specified.</p> </li> <li> <p>IAM_ROLE_MISSING: The service role cannot be accessed.</p> </li> <li> <p>IAM_ROLE_PERMISSIONS: The service role does not have the correct permissions.</p> </li> <li> <p>INTERNAL_ERROR: There was an internal error.</p> </li> <li> <p>NO_EC2_SUBSCRIPTION: The calling account is not subscribed to Amazon EC2.</p> </li> <li> <p>NO_INSTANCES: No instances were specified, or no instances can be found.</p> </li> <li> <p>OVER_MAX_INSTANCES: The maximum number of instances was exceeded.</p> </li> <li> <p>THROTTLED: The operation was throttled because the calling account exceeded the throttling limits of one or more Amazon Web Services services.</p> </li> <li> <p>TIMEOUT: The deployment has timed out.</p> </li> <li> <p>REVISION_MISSING: The revision ID was missing. This error code is most likely raised if the revision is deleted after the deployment is created, but before it is started.</p> </li> </ul>'
message:
allOf:
- $ref: '#/components/schemas/ErrorMessage'
- description: An accompanying error message.
description: Information about a deployment error.
FileExistsBehavior:
type: string
enum:
- DISALLOW
- OVERWRITE
- RETAIN
Timestamp:
type: string
format: date-time
RevisionLocationType:
type: string
enum:
- S3
- GitHub
- String
- AppSpecContent
ELBInfoList:
type: array
items:
$ref: '#/components/schemas/ELBInfo'
ListenerArn:
type: string
InvalidDeploymentIdException: {}
AutoRollbackEventsList:
type: array
items:
$ref: '#/components/schemas/AutoRollbackEvent'
LoadBalancerInfo:
type: object
properties:
elbInfoList:
allOf:
- $ref: '#/components/schemas/ELBInfoList'
- description: <p>An array that contains information about the load balancer to use for load balancing in a deployment. In Elastic Load Balancing, load balancers are used with Classic Load Balancers.</p> <note> <p> Adding more than one load balancer to the array is not supported. </p> </note>
targetGroupInfoList:
allOf:
- $ref: '#/components/schemas/TargetGroupInfoList'
- description: <p>An array that contains information about the target group to use for load balancing in a deployment. In Elastic Load Balancing, target groups are used with Application Load Balancers.</p> <note> <p> Adding more than one target group to the array is not supported. </p> </note>
targetGroupPairInfoList:
allOf:
- $ref: '#/components/schemas/TargetGroupPairInfoList'
- description: ' The target group pair information. This is an array of <code>TargeGroupPairInfo</code> objects with a maximum size of one. '
description: Information about the Elastic Load Balancing load balancer or target group used in a deployment.
AdditionalDeploymentStatusInfo:
type: string
deprecated: true
description: AdditionalDeploymentStatusInfo is deprecated, use DeploymentStatusMessageList instead.
AutoScalingGroupName:
type: string
InstanceAction:
type: string
enum:
- TERMINATE
- KEEP_ALIVE
EC2TagFilter:
type: object
properties:
Key:
allOf:
- $ref: '#/components/schemas/Key'
- description: The tag filter key.
Value:
allOf:
- $ref: '#/components/schemas/Value'
- description: The tag filter value.
Type:
allOf:
- $ref: '#/components/schemas/EC2TagFilterType'
- description: '<p>The tag filter type:</p> <ul> <li> <p> <code>KEY_ONLY</code>: Key only.</p> </li> <li> <p> <code>VALUE_ONLY</code>: Value only.</p> </li> <li> <p> <code>KEY_AND_VALUE</code>: Key and value.</p> </li> </ul>'
description: Information about an EC2 tag filter.
Key:
type: string
ELBName:
type: string
TargetInstances:
type: object
properties:
tagFilters:
allOf:
- $ref: '#/components/schemas/EC2TagFilterList'
- description: The tag filter key, type, and value used to identify Amazon EC2 instances in a replacement environment for a blue/green deployment. Cannot be used in the same call as <code>ec2TagSet</code>.
autoScalingGroups:
allOf:
- $ref: '#/components/schemas/AutoScalingGroupNameList'
- description: The names of one or more Auto Scaling groups to identify a replacement environment for a blue/green deployment.
ec2TagSet:
allOf:
- $ref: '#/components/schemas/EC2TagSet'
- description: Information about the groups of Amazon EC2 instance tags that an instance must be identified by in order for it to be included in the replacement environment for a blue/green deployment. Cannot be used in the same call as <code>tagFilters</code>.
description: Information about the instances to be used in the replacement environment in a blue/green deployment.
Repository:
type: string
TrafficRoute:
type: object
properties:
listenerArns:
allOf:
- $ref: '#/components/schemas/ListenerArnList'
- description: ' The Amazon Resource Name (ARN) of one listener. The listener identifies the route between a target group and a load balancer. This is an array of strings with a maximum size of one. '
description: ' Information about a listener. The listener contains the path used to route traffic that is received from the load balancer to a target group. '
S3Location:
type: object
properties:
bucket:
allOf:
- $ref: '#/components/schemas/S3Bucket'
- description: The name of the Amazon S3 bucket where the application revision is stored.
key:
allOf:
- $ref: '#/components/schemas/S3Key'
- description: The name of the Amazon S3 object that represents the bundled artifacts for the application revision.
bundleType:
allOf:
- $ref: '#/components/schemas/BundleType'
- description: '<p>The file type of the application revision. Must be one of the following:</p> <ul> <li> <p> <code>tar</code>: A tar archive file.</p> </li> <li> <p> <code>tgz</code>: A compressed tar archive file.</p> </li> <li> <p> <code>zip</code>: A zip archive file.</p> </li> </ul>'
version:
allOf:
- $ref: '#/components/schemas/VersionId'
- description: <p>A specific version of the Amazon S3 object that represents the bundled artifacts for the application revision.</p> <p>If the version is not specified, the system uses the most recent version by default.</p>
eTag:
allOf:
- $ref: '#/components/schemas/ETag'
- description: <p>The ETag of the Amazon S3 object that represents the bundled artifacts for the application revision.</p> <p>If the ETag is not specified as an input parameter, ETag validation of the object is skipped.</p>
description: Information about the location of application artifacts stored in Amazon S3.
S3Bucket:
type: string
AlarmName:
type: string
DeploymentReadyOption:
type: object
properties:
actionOnTimeout:
allOf:
- $ref: '#/components/schemas/DeploymentReadyAction'
- description: '<p>Information about when to reroute traffic from an original environment to a replacement environment in a blue/green deployment.</p> <ul> <li> <p>CONTINUE_DEPLOYMENT: Register new instances with the load balancer immediately after the new application revision is installed on the instances in the replacement environment.</p> </li> <li> <p>STOP_DEPLOYMENT: Do not register new instances with a load balancer unless traffic rerouting is started using <a>ContinueDeployment</a>. If traffic rerouting is not started before the end of the specified wait period, the deployment status is changed to Stopped.</p> </li> </ul>'
waitTimeInMinutes:
allOf:
- $ref: '#/components/schemas/Duration'
- description: The number of minutes to wait before the status of a blue/green deployment is changed to Stopped if rerouting is not started manually. Applies only to the <code>STOP_DEPLOYMENT</code> option for <code>actionOnTimeout</code>.
description: Information about how traffic is rerouted to instances in a replacement environment in a blue/green deployment.
BundleType:
type: string
enum:
- tar
- tgz
- zip
- YAML
- JSON
ExternalId:
type: string
S3Key:
type: string
GreenFleetProvisioningOption:
type: object
properties:
action:
allOf:
- $ref: '#/components/schemas/GreenFleetProvisioningAction'
- description: '<p>The method used to add instances to a replacement environment.</p> <ul> <li> <p> <code>DISCOVER_EXISTING</code>: Use instances that already exist or will be created manually.</p> </li> <li> <p> <code>COPY_AUTO_SCALING_GROUP</code>: Use settings from a specified Auto Scaling group to define and create instances in a new Auto Scaling group.</p> </li> </ul>'
description: Information about the instances that belong to the replacement environment in a blue/green deployment.
DeploymentId:
type: string
RevisionLocation:
type: object
properties:
revisionType:
allOf:
- $ref: '#/components/schemas/RevisionLocationType'
- description: '<p>The type of application revision:</p> <ul> <li> <p>S3: An application revision stored in Amazon S3.</p> </li> <li> <p>GitHub: An application revision stored in GitHub (EC2/On-premises deployments only).</p> </li> <li> <p>String: A YAML-formatted or JSON-formatted string (Lambda deployments only).</p> </li> <li> <p>AppSpecContent: An <code>AppSpecContent</code> object that contains the contents of an AppSpec file for an Lambda or Amazon ECS deployment. The content is formatted as JSON or YAML stored as a RawString.</p> </li> </ul>'
s3Location:
allOf:
- $ref: '#/components/schemas/S3Location'
- description: 'Information about the location of a revision stored in Amazon S3. '
gitHubLocation:
allOf:
- $ref: '#/components/schemas/GitHubLocation'
- description: Information about the location of application artifacts stored in GitHub.
string:
allOf:
- $ref: '#/components/schemas/RawString'
- description: Information about the location of an Lambda deployment revision stored as a Ra
# --- truncated at 32 KB (49 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-codedeploy/refs/heads/main/openapi/amazon-codedeploy-x-amz-target-codedeploy-20141006-getdeployment-api-openapi.yml