AWS CodeDeploy
CodeDeploy is a deployment service that automates application deployments to Amazon EC2 instances, on-premises instances running in your own facility,…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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
CodeDeploy User Guide
CodeDeploy API Reference Guide
CLI Reference for CodeDeploy
CodeDeploy Developer Forum
Endpoints 47
- POSTAdd tags to on premises instances
/#X-Amz-Target=CodeDeploy_20141006.AddTagsToOnPremisesInstancesAdds tags to on-premises instances. - POSTBatch get application revisions
/#X-Amz-Target=CodeDeploy_20141006.BatchGetApplicationRevisionsGets information about one or more application revisions. The maximum number of application revisions that can be returned is 25. - POSTBatch get applications
/#X-Amz-Target=CodeDeploy_20141006.BatchGetApplicationsGets information about one or more applications. The maximum number of applications that can be returned is 100. - POSTBatch get deployment groups
/#X-Amz-Target=CodeDeploy_20141006.BatchGetDeploymentGroupsGets information about one or more deployment groups. - POSTBatch get deployment instances
/#X-Amz-Target=CodeDeploy_20141006.BatchGetDeploymentInstancesDeprecated. This method works, but is deprecated. Use BatchGetDeploymentTargets instead. Returns an array of one or more instances associated with a… - POSTBatch get deployment targets
/#X-Amz-Target=CodeDeploy_20141006.BatchGetDeploymentTargetsReturns 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… - POSTBatch get deployments
/#X-Amz-Target=CodeDeploy_20141006.BatchGetDeploymentsGets information about one or more deployments. The maximum number of deployments that can be returned is 25. - POSTBatch get on premises instances
/#X-Amz-Target=CodeDeploy_20141006.BatchGetOnPremisesInstancesGets information about one or more on-premises instances. The maximum number of on-premises instances that can be returned is 25. - POSTContinue deployment
/#X-Amz-Target=CodeDeploy_20141006.ContinueDeploymentFor a blue/green deployment, starts the process of rerouting traffic from instances in the original environment to instances in the replacement environment… - POSTCreate application
/#X-Amz-Target=CodeDeploy_20141006.CreateApplicationCreates an application. - POSTCreate deployment
/#X-Amz-Target=CodeDeploy_20141006.CreateDeploymentDeploys an application revision through the specified deployment group. - POSTCreate deployment config
/#X-Amz-Target=CodeDeploy_20141006.CreateDeploymentConfigCreates a deployment configuration. - POSTCreate deployment group
/#X-Amz-Target=CodeDeploy_20141006.CreateDeploymentGroupCreates a deployment group to which application revisions are deployed. - POSTDelete application
/#X-Amz-Target=CodeDeploy_20141006.DeleteApplicationDeletes an application. - POSTDelete deployment config
/#X-Amz-Target=CodeDeploy_20141006.DeleteDeploymentConfigDeletes a deployment configuration. A deployment configuration cannot be deleted if it is currently in use. Predefined configurations cannot be deleted. - POSTDelete deployment group
/#X-Amz-Target=CodeDeploy_20141006.DeleteDeploymentGroupDeletes a deployment group. - POSTDelete git hub account token
/#X-Amz-Target=CodeDeploy_20141006.DeleteGitHubAccountTokenDeletes a GitHub account connection. - POSTDelete resources by external id
/#X-Amz-Target=CodeDeploy_20141006.DeleteResourcesByExternalIdDeletes resources linked to an external ID. This action only applies if you have configured blue/green deployments through CloudFormation. It is not necessary… - POSTDeregister on premises instance
/#X-Amz-Target=CodeDeploy_20141006.DeregisterOnPremisesInstanceDeregisters an on-premises instance. - POSTGet application
/#X-Amz-Target=CodeDeploy_20141006.GetApplicationGets information about an application. - POSTGet application revision
/#X-Amz-Target=CodeDeploy_20141006.GetApplicationRevisionGets information about an application revision. - POSTGet deployment
/#X-Amz-Target=CodeDeploy_20141006.GetDeploymentGets information about a deployment. The content property of the appSpecContent object in the returned revision is always null. Use GetApplicationRevision and… - POSTGet deployment config
/#X-Amz-Target=CodeDeploy_20141006.GetDeploymentConfigGets information about a deployment configuration. - POSTGet deployment group
/#X-Amz-Target=CodeDeploy_20141006.GetDeploymentGroupGets information about a deployment group. - POSTGet deployment instance
/#X-Amz-Target=CodeDeploy_20141006.GetDeploymentInstanceDeprecated. Gets information about an instance as part of a deployment. - POSTGet deployment target
/#X-Amz-Target=CodeDeploy_20141006.GetDeploymentTargetReturns information about a deployment target. - POSTGet on premises instance
/#X-Amz-Target=CodeDeploy_20141006.GetOnPremisesInstanceGets information about an on-premises instance. - POSTList application revisions
/#X-Amz-Target=CodeDeploy_20141006.ListApplicationRevisionsLists information about revisions for an application. - POSTList applications
/#X-Amz-Target=CodeDeploy_20141006.ListApplicationsLists the applications registered with the user or Amazon Web Services account. - POSTList deployment configs
/#X-Amz-Target=CodeDeploy_20141006.ListDeploymentConfigsLists the deployment configurations with the user or Amazon Web Services account. - POSTList deployment groups
/#X-Amz-Target=CodeDeploy_20141006.ListDeploymentGroupsLists the deployment groups for an application registered with the Amazon Web Services user or Amazon Web Services account. - POSTList deployment instances
/#X-Amz-Target=CodeDeploy_20141006.ListDeploymentInstancesDeprecated. The newer BatchGetDeploymentTargets should be used instead because it works with all compute types. ListDeploymentInstances throws an exception if… - POSTList deployment targets
/#X-Amz-Target=CodeDeploy_20141006.ListDeploymentTargetsReturns an array of target IDs that are associated a deployment. - POSTList deployments
/#X-Amz-Target=CodeDeploy_20141006.ListDeploymentsLists the deployments in a deployment group for an application registered with the user or Amazon Web Services account. - POSTList git hub account token names
/#X-Amz-Target=CodeDeploy_20141006.ListGitHubAccountTokenNamesLists the names of stored connections to GitHub accounts. - POSTList on premises instances
/#X-Amz-Target=CodeDeploy_20141006.ListOnPremisesInstancesGets a list of names for one or more on-premises instances. Unless otherwise specified, both registered and deregistered on-premises instance names are… - POSTList tags for resource
/#X-Amz-Target=CodeDeploy_20141006.ListTagsForResourceReturns a list of tags for the resource identified by a specified Amazon Resource Name (ARN). Tags are used to organize and categorize your CodeDeploy… - POSTPut lifecycle event hook execution status
/#X-Amz-Target=CodeDeploy_20141006.PutLifecycleEventHookExecutionStatusSets the result of a Lambda validation function. The function validates lifecycle hooks during a deployment that uses the Lambda or Amazon ECS compute… - POSTRegister application revision
/#X-Amz-Target=CodeDeploy_20141006.RegisterApplicationRevisionRegisters with CodeDeploy a revision for the specified application. - POSTRegister on premises instance
/#X-Amz-Target=CodeDeploy_20141006.RegisterOnPremisesInstanceRegisters an on-premises instance. Only one IAM ARN (an IAM session ARN or IAM user ARN) is supported in the request. You cannot use both. - POSTRemove tags from on premises instances
/#X-Amz-Target=CodeDeploy_20141006.RemoveTagsFromOnPremisesInstancesRemoves one or more tags from one or more on-premises instances. - POSTSkip wait time for instance termination
/#X-Amz-Target=CodeDeploy_20141006.SkipWaitTimeForInstanceTerminationDeprecated. In a blue/green deployment, overrides any specified wait time and starts terminating instances immediately after the traffic routing is complete. - POSTStop deployment
/#X-Amz-Target=CodeDeploy_20141006.StopDeploymentAttempts to stop an ongoing deployment. - POSTTag resource
/#X-Amz-Target=CodeDeploy_20141006.TagResourceAssociates the list of tags in the input Tags parameter with the resource identified by the ResourceArn input parameter. - POSTUntag resource
/#X-Amz-Target=CodeDeploy_20141006.UntagResourceDisassociates a resource from a list of tags. The resource is identified by the ResourceArn input parameter. The tags are identified by the list of keys in… - POSTUpdate application
/#X-Amz-Target=CodeDeploy_20141006.UpdateApplicationChanges the name of an application. - POSTUpdate deployment group
/#X-Amz-Target=CodeDeploy_20141006.UpdateDeploymentGroupChanges information about a deployment group.
API details
- Base URL
https://codedeploy.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 47 operations on 47 pathsPOST 47
4 marked deprecated - Description format
- AWS Smithy model, API version
2014-10-06 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the AWS CodeDeploy in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the AWS CodeDeploy collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Add tags to on premises instances” (POST /#X-Amz-Target=CodeDeploy_20141006.AddTagsToOnPremisesInstances), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the AWS CodeDeploy?
CodeDeploy is a deployment service that automates application deployments to Amazon EC2 instances, on-premises instances running in your own facility,… It is listed under Developer tools and has 47 endpoints.
Who publishes the AWS CodeDeploy?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the AWS CodeDeploy?
Requests go to https://codedeploy.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the AWS CodeDeploy?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the AWS CodeDeploy have?
47 operations on 47 paths (47 POST).
Is forking the AWS CodeDeploy free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.