aws-elixir v0.1.0 AWS.CodeDeploy
AWS CodeDeploy
Overview This reference guide provides descriptions of the AWS CodeDeploy APIs. For more information about AWS CodeDeploy, see the AWS CodeDeploy User Guide.
Using the APIs You can use the AWS CodeDeploy APIs to work with the following:
- Applications are unique identifiers used by AWS CodeDeploy to ensure 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 success and failure conditions used by AWS CodeDeploy 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 instance.
- 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 stored in Amazon S3 buckets or GitHub repositories. These revisions contain source content (such as source code, web pages, executable files, and deployment scripts) along with an application specification (AppSpec) file. (The AppSpec file is unique to AWS CodeDeploy; it defines the deployment actions you want AWS CodeDeploy to execute.) Ffor application revisions stored in Amazon S3 buckets, an application revision is uniquely identified by its Amazon S3 object key and its ETag, version, or both. For application revisions stored in GitHub repositories, an application revision is uniquely identified by its repository name and commit ID. Application revisions are deployed through deployment groups. You can use the AWS CodeDeploy APIs to get, list, and register application revisions.
Summary
Functions
Adds tags to on-premises instances
Gets information about one or more application revisions
Gets information about one or more applications
Get information about one or more deployment groups
Gets information about one or more instance that are part of a deployment group
Gets information about one or more deployments
Gets information about one or more on-premises instances
Creates an application
Deploys an application revision through the specified deployment group
Creates a deployment configuration
Creates a deployment group to which application revisions will be deployed
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 instance for a deployment associated with the applicable IAM user or AWS account
Lists the deployments in a deployment group for an application registered with the applicable IAM user or AWS account
Gets a list of names for one or more on-premises instances
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 the name of an application
Changes information about a deployment group
Functions
Gets information about one or more application revisions.
Gets information about one or more applications.
Get information about one or more deployment groups.
Gets information about one or more instance that are part of a deployment group.
Gets information about one or more on-premises instances.
Deploys an application revision through the specified deployment group.
Creates a deployment group to which application revisions will be deployed.
Deletes a deployment configuration.
Gets information about an application revision.
Gets information about a deployment configuration.
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 instance for a deployment associated with the applicable IAM user or AWS account.
Lists the deployments in a deployment group for an application registered with the applicable IAM user or AWS account.
Gets a list of names for one or more on-premises instances.
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.
Removes one or more tags from one or more on-premises instances.