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 APIsYou 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.
Inheritance Hierarchy
Namespace: Amazon.CodeDeploy
Assembly: AWSSDK.dll
Version: (assembly version)
Syntax
public class AmazonCodeDeployClient : AmazonServiceClient IAmazonCodeDeploy, IDisposable
The AmazonCodeDeployClient type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
AmazonCodeDeployClient() |
Constructs AmazonCodeDeployClient with the credentials loaded from the application's
default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="AWSProfileName" value="AWS Default"/>
</appSettings>
</configuration>
|
|
|
AmazonCodeDeployClient(RegionEndpoint) |
Constructs AmazonCodeDeployClient with the credentials loaded from the application's
default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="AWSProfileName" value="AWS Default"/>
</appSettings>
</configuration>
|
|
|
AmazonCodeDeployClient(AmazonCodeDeployConfig) |
Constructs AmazonCodeDeployClient with the credentials loaded from the application's
default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="AWSProfileName" value="AWS Default"/>
</appSettings>
</configuration>
|
|
|
AmazonCodeDeployClient(AWSCredentials) | Constructs AmazonCodeDeployClient with AWS Credentials |
|
|
AmazonCodeDeployClient(AWSCredentials, RegionEndpoint) | Constructs AmazonCodeDeployClient with AWS Credentials |
|
|
AmazonCodeDeployClient(AWSCredentials, AmazonCodeDeployConfig) | Constructs AmazonCodeDeployClient with AWS Credentials and an AmazonCodeDeployClient Configuration object. |
|
|
AmazonCodeDeployClient(string, string) | Constructs AmazonCodeDeployClient with AWS Access Key ID and AWS Secret Key |
|
|
AmazonCodeDeployClient(string, string, RegionEndpoint) | Constructs AmazonCodeDeployClient with AWS Access Key ID and AWS Secret Key |
|
|
AmazonCodeDeployClient(string, string, AmazonCodeDeployConfig) | Constructs AmazonCodeDeployClient with AWS Access Key ID, AWS Secret Key and an AmazonCodeDeployClient Configuration object. |
|
|
AmazonCodeDeployClient(string, string, string) | Constructs AmazonCodeDeployClient with AWS Access Key ID and AWS Secret Key |
|
|
AmazonCodeDeployClient(string, string, string, RegionEndpoint) | Constructs AmazonCodeDeployClient with AWS Access Key ID and AWS Secret Key |
|
|
AmazonCodeDeployClient(string, string, string, AmazonCodeDeployConfig) | Constructs AmazonCodeDeployClient with AWS Access Key ID, AWS Secret Key and an AmazonCodeDeployClient Configuration object. |
Methods
| Name | Description | |
|---|---|---|
|
|
AddTagsToOnPremisesInstances(AddTagsToOnPremisesInstancesRequest) | Adds tags to on-premises instances. |
|
|
AddTagsToOnPremisesInstancesAsync(AddTagsToOnPremisesInstancesRequest, CancellationToken) | Initiates the asynchronous execution of the AddTagsToOnPremisesInstances operation. |
|
|
BatchGetApplicationRevisions(BatchGetApplicationRevisionsRequest) | Gets information about one or more application revisions. |
|
|
BatchGetApplicationRevisionsAsync(BatchGetApplicationRevisionsRequest, CancellationToken) | Initiates the asynchronous execution of the BatchGetApplicationRevisions operation. |
|
|
BatchGetApplications(BatchGetApplicationsRequest) | Gets information about one or more applications. |
|
|
BatchGetApplicationsAsync(BatchGetApplicationsRequest, CancellationToken) | Initiates the asynchronous execution of the BatchGetApplications operation. |
|
|
BatchGetDeploymentInstances(BatchGetDeploymentInstancesRequest) | Gets information about one or more instances that are part of a deployment group. |
|
|
BatchGetDeploymentInstancesAsync(BatchGetDeploymentInstancesRequest, CancellationToken) | Initiates the asynchronous execution of the BatchGetDeploymentInstances operation. |
|
|
BatchGetDeployments(BatchGetDeploymentsRequest) | Gets information about one or more deployments. |
|
|
BatchGetDeploymentsAsync(BatchGetDeploymentsRequest, CancellationToken) | Initiates the asynchronous execution of the BatchGetDeployments operation. |
|
|
BatchGetOnPremisesInstances(BatchGetOnPremisesInstancesRequest) | Gets information about one or more on-premises instances. |
|
|
BatchGetOnPremisesInstancesAsync(BatchGetOnPremisesInstancesRequest, CancellationToken) | Initiates the asynchronous execution of the BatchGetOnPremisesInstances operation. |
|
|
CreateApplication(CreateApplicationRequest) | Creates a new application. |
|
|
CreateApplicationAsync(CreateApplicationRequest, CancellationToken) | Initiates the asynchronous execution of the CreateApplication operation. |
|
|
CreateDeployment(CreateDeploymentRequest) | Deploys an application revision through the specified deployment group. |
|
|
CreateDeploymentAsync(CreateDeploymentRequest, CancellationToken) | Initiates the asynchronous execution of the CreateDeployment operation. |
|
|
CreateDeploymentConfig(CreateDeploymentConfigRequest) | Creates a new deployment configuration. |
|
|
CreateDeploymentConfigAsync(CreateDeploymentConfigRequest, CancellationToken) | Initiates the asynchronous execution of the CreateDeploymentConfig operation. |
|
|
CreateDeploymentGroup(CreateDeploymentGroupRequest) | Creates a new deployment group for application revisions to be deployed to. |
|
|
CreateDeploymentGroupAsync(CreateDeploymentGroupRequest, CancellationToken) | Initiates the asynchronous execution of the CreateDeploymentGroup operation. |
|
|
DeleteApplication(DeleteApplicationRequest) | Deletes an application. |
|
|
DeleteApplicationAsync(DeleteApplicationRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteApplication operation. |
|
|
DeleteDeploymentConfig(DeleteDeploymentConfigRequest) |
Deletes a deployment configuration.
|
|
|
DeleteDeploymentConfigAsync(DeleteDeploymentConfigRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteDeploymentConfig operation. |
|
|
DeleteDeploymentGroup(DeleteDeploymentGroupRequest) | Deletes a deployment group. |
|
|
DeleteDeploymentGroupAsync(DeleteDeploymentGroupRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteDeploymentGroup operation. |
|
|
DeregisterOnPremisesInstance(DeregisterOnPremisesInstanceRequest) | Deregisters an on-premises instance. |
|
|
DeregisterOnPremisesInstanceAsync(DeregisterOnPremisesInstanceRequest, CancellationToken) | Initiates the asynchronous execution of the DeregisterOnPremisesInstance operation. |
|
|
Dispose() | Inherited from Amazon.Runtime.AmazonServiceClient. |
|
|
GetApplication(GetApplicationRequest) | Gets information about an application. |
|
|
GetApplicationAsync(GetApplicationRequest, CancellationToken) | Initiates the asynchronous execution of the GetApplication operation. |
|
|
GetApplicationRevision(GetApplicationRevisionRequest) | Gets information about an application revision. |
|
|
GetApplicationRevisionAsync(GetApplicationRevisionRequest, CancellationToken) | Initiates the asynchronous execution of the GetApplicationRevision operation. |
|
|
GetDeployment(GetDeploymentRequest) | Gets information about a deployment. |
|
|
GetDeploymentAsync(GetDeploymentRequest, CancellationToken) | Initiates the asynchronous execution of the GetDeployment operation. |
|
|
GetDeploymentConfig(GetDeploymentConfigRequest) | Gets information about a deployment configuration. |
|
|
GetDeploymentConfigAsync(GetDeploymentConfigRequest, CancellationToken) | Initiates the asynchronous execution of the GetDeploymentConfig operation. |
|
|
GetDeploymentGroup(GetDeploymentGroupRequest) | Gets information about a deployment group. |
|
|
GetDeploymentGroupAsync(GetDeploymentGroupRequest, CancellationToken) | Initiates the asynchronous execution of the GetDeploymentGroup operation. |
|
|
GetDeploymentInstance(GetDeploymentInstanceRequest) | Gets information about an instance as part of a deployment. |
|
|
GetDeploymentInstanceAsync(GetDeploymentInstanceRequest, CancellationToken) | Initiates the asynchronous execution of the GetDeploymentInstance operation. |
|
|
GetOnPremisesInstance(GetOnPremisesInstanceRequest) | Gets information about an on-premises instance. |
|
|
GetOnPremisesInstanceAsync(GetOnPremisesInstanceRequest, CancellationToken) | Initiates the asynchronous execution of the GetOnPremisesInstance operation. |
|
|
ListApplicationRevisions(ListApplicationRevisionsRequest) | Lists information about revisions for an application. |
|
|
ListApplicationRevisionsAsync(ListApplicationRevisionsRequest, CancellationToken) | Initiates the asynchronous execution of the ListApplicationRevisions operation. |
|
|
ListApplications() | Lists the applications registered with the applicable IAM user or AWS account. |
|
|
ListApplications(ListApplicationsRequest) | Lists the applications registered with the applicable IAM user or AWS account. |
|
|
ListApplicationsAsync(ListApplicationsRequest, CancellationToken) | Initiates the asynchronous execution of the ListApplications operation. |
|
|
ListDeploymentConfigs() | Lists the deployment configurations with the applicable IAM user or AWS account. |
|
|
ListDeploymentConfigs(ListDeploymentConfigsRequest) | Lists the deployment configurations with the applicable IAM user or AWS account. |
|
|
ListDeploymentConfigsAsync(ListDeploymentConfigsRequest, CancellationToken) | Initiates the asynchronous execution of the ListDeploymentConfigs operation. |
|
|
ListDeploymentGroups(ListDeploymentGroupsRequest) | Lists the deployment groups for an application registered with the applicable IAM user or AWS account. |
|
|
ListDeploymentGroupsAsync(ListDeploymentGroupsRequest, CancellationToken) | Initiates the asynchronous execution of the ListDeploymentGroups operation. |
|
|
ListDeploymentInstances(ListDeploymentInstancesRequest) | Lists the instances for a deployment associated with the applicable IAM user or AWS account. |
|
|
ListDeploymentInstancesAsync(ListDeploymentInstancesRequest, CancellationToken) | Initiates the asynchronous execution of the ListDeploymentInstances operation. |
|
|
ListDeployments(ListDeploymentsRequest) | Lists the deployments within a deployment group for an application registered with the applicable IAM user or AWS account. |
|
|
ListDeploymentsAsync(ListDeploymentsRequest, CancellationToken) | Initiates the asynchronous execution of the ListDeployments operation. |
|
|
ListOnPremisesInstances(ListOnPremisesInstancesRequest) |
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. |
|
|
ListOnPremisesInstancesAsync(ListOnPremisesInstancesRequest, CancellationToken) | Initiates the asynchronous execution of the ListOnPremisesInstances operation. |
|
|
RegisterApplicationRevision(RegisterApplicationRevisionRequest) | Registers with AWS CodeDeploy a revision for the specified application. |
|
|
RegisterApplicationRevisionAsync(RegisterApplicationRevisionRequest, CancellationToken) | Initiates the asynchronous execution of the RegisterApplicationRevision operation. |
|
|
RegisterOnPremisesInstance(RegisterOnPremisesInstanceRequest) | Registers an on-premises instance. |
|
|
RegisterOnPremisesInstanceAsync(RegisterOnPremisesInstanceRequest, CancellationToken) | Initiates the asynchronous execution of the RegisterOnPremisesInstance operation. |
|
|
RemoveTagsFromOnPremisesInstances(RemoveTagsFromOnPremisesInstancesRequest) | Removes one or more tags from one or more on-premises instances. |
|
|
RemoveTagsFromOnPremisesInstancesAsync(RemoveTagsFromOnPremisesInstancesRequest, CancellationToken) | Initiates the asynchronous execution of the RemoveTagsFromOnPremisesInstances operation. |
|
|
StopDeployment(StopDeploymentRequest) | Attempts to stop an ongoing deployment. |
|
|
StopDeploymentAsync(StopDeploymentRequest, CancellationToken) | Initiates the asynchronous execution of the StopDeployment operation. |
|
|
UpdateApplication(UpdateApplicationRequest) | Changes an existing application's name. |
|
|
UpdateApplicationAsync(UpdateApplicationRequest, CancellationToken) | Initiates the asynchronous execution of the UpdateApplication operation. |
|
|
UpdateDeploymentGroup(UpdateDeploymentGroupRequest) | Changes information about an existing deployment group. |
|
|
UpdateDeploymentGroupAsync(UpdateDeploymentGroupRequest, CancellationToken) | Initiates the asynchronous execution of the UpdateDeploymentGroup operation. |
Events
| Name | Description | |
|---|---|---|
|
|
AfterResponseEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
|
|
BeforeRequestEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
|
|
ExceptionEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
Version Information
.NET Framework:
Supported in: 4.5, 4.0, 3.5