AWS.CodeDeploy
AWS CodeDeploy
Overview This is the AWS CodeDeploy API Reference. This guide provides descriptions of the AWS CodeDeploy APIs. For additional information, see the AWS CodeDeploy User Guide.
Using the APIs You can use the AWS CodeDeploy APIs to work with the following items:
-
Applications are unique identifiers that AWS CodeDeploy uses to ensure that the correct combinations of revisions, deployment configurations, and deployment groups are being referenced during deployments.
You can use the AWS CodeDeploy APIs to create, delete, get, list, and update applications.
-
Deployment configurations are sets of deployment rules and deployment success and failure conditions that AWS CodeDeploy uses during deployments.
You can use the AWS CodeDeploy APIs to create, delete, get, and list deployment configurations.
-
Deployment groups are groups of instances to which application revisions can be deployed.
You can use the AWS CodeDeploy APIs to create, delete, get, list, and update deployment groups.
-
Instances represent Amazon EC2 instances to which application revisions are deployed. Instances are identified by their Amazon EC2 tags or Auto Scaling group names. Instances belong to deployment groups.
You can use the AWS CodeDeploy APIs to get and list instances.
-
Deployments represent the process of deploying revisions to instances.
You can use the AWS CodeDeploy APIs to create, get, list, and stop deployments.
-
Application revisions are archive files that are stored in Amazon S3 buckets or GitHub repositories. These revisions contain source content (such as source code, web pages, executable files, any deployment scripts, and similar) along with an Application Specification file (AppSpec file). (The AppSpec file is unique to AWS CodeDeploy; it defines a series of deployment actions that you want AWS CodeDeploy to execute.) An application revision is uniquely identified by its Amazon S3 object key and its ETag, version, or both (for application revisions that are stored in Amazon S3 buckets) or by its repository name and commit ID (for applications revisions that are stored in GitHub repositories). Application revisions are deployed through deployment groups.
You can use the AWS CodeDeploy APIs to get, list, and register application revisions.
Summary↑
| add_tags_to_on_premises_instances(client, input, options \\ []) | Adds tags to on-premises instances |
| batch_get_applications(client, input, options \\ []) | Gets information about one or more applications |
| batch_get_deployments(client, input, options \\ []) | Gets information about one or more deployments |
| batch_get_on_premises_instances(client, input, options \\ []) | Gets information about one or more on-premises instances |
| create_application(client, input, options \\ []) | Creates a new application |
| create_deployment(client, input, options \\ []) | Deploys an application revision through the specified deployment group |
| create_deployment_config(client, input, options \\ []) | Creates a new deployment configuration |
| create_deployment_group(client, input, options \\ []) | Creates a new deployment group for application revisions to be deployed to |
| delete_application(client, input, options \\ []) | Deletes an application |
| delete_deployment_config(client, input, options \\ []) | Deletes a deployment configuration |
| delete_deployment_group(client, input, options \\ []) | Deletes a deployment group |
| deregister_on_premises_instance(client, input, options \\ []) | Deregisters an on-premises instance |
| get_application(client, input, options \\ []) | Gets information about an application |
| get_application_revision(client, input, options \\ []) | Gets information about an application revision |
| get_deployment(client, input, options \\ []) | Gets information about a deployment |
| get_deployment_config(client, input, options \\ []) | Gets information about a deployment configuration |
| get_deployment_group(client, input, options \\ []) | Gets information about a deployment group |
| get_deployment_instance(client, input, options \\ []) | Gets information about an instance as part of a deployment |
| get_on_premises_instance(client, input, options \\ []) | Gets information about an on-premises instance |
| list_application_revisions(client, input, options \\ []) | Lists information about revisions for an application |
| list_applications(client, input, options \\ []) | Lists the applications registered with the applicable IAM user or AWS account |
| list_deployment_configs(client, input, options \\ []) | Lists the deployment configurations with the applicable IAM user or AWS account |
| list_deployment_groups(client, input, options \\ []) | Lists the deployment groups for an application registered with the applicable IAM user or AWS account |
| list_deployment_instances(client, input, options \\ []) | Lists the instances for a deployment associated with the applicable IAM user or AWS account |
| list_deployments(client, input, options \\ []) | Lists the deployments within a deployment group for an application registered with the applicable IAM user or AWS account |
| list_on_premises_instances(client, input, options \\ []) | Gets a list of one or more on-premises instance names |
| register_application_revision(client, input, options \\ []) | Registers with AWS CodeDeploy a revision for the specified application |
| register_on_premises_instance(client, input, options \\ []) | Registers an on-premises instance |
| remove_tags_from_on_premises_instances(client, input, options \\ []) | Removes one or more tags from one or more on-premises instances |
| stop_deployment(client, input, options \\ []) | Attempts to stop an ongoing deployment |
| update_application(client, input, options \\ []) | Changes an existing application's name |
| update_deployment_group(client, input, options \\ []) | Changes information about an existing deployment group |
Functions
Adds tags to on-premises instances.
Gets information about one or more applications.
Gets information about one or more deployments.
Gets information about one or more on-premises instances.
Creates a new application.
Deploys an application revision through the specified deployment group.
Creates a new deployment configuration.
Creates a new deployment group for application revisions to be deployed to.
Deletes an application.
Deletes a deployment configuration.
Deletes a deployment group.
Deregisters an on-premises instance.
Gets information about an application.
Gets information about an application revision.
Gets information about a deployment.
Gets information about a deployment configuration.
Gets information about a deployment group.
Gets information about an instance as part of a deployment.
Gets information about an on-premises instance.
Lists information about revisions for an application.
Lists the applications registered with the applicable IAM user or AWS account.
Lists the deployment configurations with the applicable IAM user or AWS account.
Lists the deployment groups for an application registered with the applicable IAM user or AWS account.
Lists the instances for a deployment associated with the applicable IAM user or AWS account.
Lists the deployments within a deployment group for an application registered with the applicable IAM user or AWS account.
Gets a list of one or more on-premises instance names.
Unless otherwise specified, both registered and deregistered on-premises instance names will be listed. To list only registered or deregistered on-premises instance names, use the registration status parameter.
Registers with AWS CodeDeploy a revision for the specified application.
Registers an on-premises instance.
Removes one or more tags from one or more on-premises instances.
Attempts to stop an ongoing deployment.
Changes an existing application's name.
Changes information about an existing deployment group.