Implementation for accessing 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 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. |
|
|
BatchGetApplicationRevisions(BatchGetApplicationRevisionsRequest) | Gets information about one or more application revisions. |
|
|
BatchGetApplications(BatchGetApplicationsRequest) | Gets information about one or more applications. |
|
|
BatchGetDeploymentInstances(BatchGetDeploymentInstancesRequest) | Gets information about one or more instances that are part of a deployment group. |
|
|
BatchGetDeployments(BatchGetDeploymentsRequest) | Gets information about one or more deployments. |
|
|
BatchGetOnPremisesInstances(BatchGetOnPremisesInstancesRequest) | Gets information about one or more on-premises instances. |
|
|
BeginAddTagsToOnPremisesInstances(AddTagsToOnPremisesInstancesRequest, AsyncCallback, object) | Initiates the asynchronous execution of the AddTagsToOnPremisesInstances operation. |
|
|
BeginBatchGetApplicationRevisions(BatchGetApplicationRevisionsRequest, AsyncCallback, object) | Initiates the asynchronous execution of the BatchGetApplicationRevisions operation. |
|
|
BeginBatchGetApplications(BatchGetApplicationsRequest, AsyncCallback, object) | Initiates the asynchronous execution of the BatchGetApplications operation. |
|
|
BeginBatchGetDeploymentInstances(BatchGetDeploymentInstancesRequest, AsyncCallback, object) | Initiates the asynchronous execution of the BatchGetDeploymentInstances operation. |
|
|
BeginBatchGetDeployments(BatchGetDeploymentsRequest, AsyncCallback, object) | Initiates the asynchronous execution of the BatchGetDeployments operation. |
|
|
BeginBatchGetOnPremisesInstances(BatchGetOnPremisesInstancesRequest, AsyncCallback, object) | Initiates the asynchronous execution of the BatchGetOnPremisesInstances operation. |
|
|
BeginCreateApplication(CreateApplicationRequest, AsyncCallback, object) | Initiates the asynchronous execution of the CreateApplication operation. |
|
|
BeginCreateDeployment(CreateDeploymentRequest, AsyncCallback, object) | Initiates the asynchronous execution of the CreateDeployment operation. |
|
|
BeginCreateDeploymentConfig(CreateDeploymentConfigRequest, AsyncCallback, object) | Initiates the asynchronous execution of the CreateDeploymentConfig operation. |
|
|
BeginCreateDeploymentGroup(CreateDeploymentGroupRequest, AsyncCallback, object) | Initiates the asynchronous execution of the CreateDeploymentGroup operation. |
|
|
BeginDeleteApplication(DeleteApplicationRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DeleteApplication operation. |
|
|
BeginDeleteDeploymentConfig(DeleteDeploymentConfigRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DeleteDeploymentConfig operation. |
|
|
BeginDeleteDeploymentGroup(DeleteDeploymentGroupRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DeleteDeploymentGroup operation. |
|
|
BeginDeregisterOnPremisesInstance(DeregisterOnPremisesInstanceRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DeregisterOnPremisesInstance operation. |
|
|
BeginGetApplication(GetApplicationRequest, AsyncCallback, object) | Initiates the asynchronous execution of the GetApplication operation. |
|
|
BeginGetApplicationRevision(GetApplicationRevisionRequest, AsyncCallback, object) | Initiates the asynchronous execution of the GetApplicationRevision operation. |
|
|
BeginGetDeployment(GetDeploymentRequest, AsyncCallback, object) | Initiates the asynchronous execution of the GetDeployment operation. |
|
|
BeginGetDeploymentConfig(GetDeploymentConfigRequest, AsyncCallback, object) | Initiates the asynchronous execution of the GetDeploymentConfig operation. |
|
|
BeginGetDeploymentGroup(GetDeploymentGroupRequest, AsyncCallback, object) | Initiates the asynchronous execution of the GetDeploymentGroup operation. |
|
|
BeginGetDeploymentInstance(GetDeploymentInstanceRequest, AsyncCallback, object) | Initiates the asynchronous execution of the GetDeploymentInstance operation. |
|
|
BeginGetOnPremisesInstance(GetOnPremisesInstanceRequest, AsyncCallback, object) | Initiates the asynchronous execution of the GetOnPremisesInstance operation. |
|
|
BeginListApplicationRevisions(ListApplicationRevisionsRequest, AsyncCallback, object) | Initiates the asynchronous execution of the ListApplicationRevisions operation. |
|
|
BeginListApplications(ListApplicationsRequest, AsyncCallback, object) | Initiates the asynchronous execution of the ListApplications operation. |
|
|
BeginListDeploymentConfigs(ListDeploymentConfigsRequest, AsyncCallback, object) | Initiates the asynchronous execution of the ListDeploymentConfigs operation. |
|
|
BeginListDeploymentGroups(ListDeploymentGroupsRequest, AsyncCallback, object) | Initiates the asynchronous execution of the ListDeploymentGroups operation. |
|
|
BeginListDeploymentInstances(ListDeploymentInstancesRequest, AsyncCallback, object) | Initiates the asynchronous execution of the ListDeploymentInstances operation. |
|
|
BeginListDeployments(ListDeploymentsRequest, AsyncCallback, object) | Initiates the asynchronous execution of the ListDeployments operation. |
|
|
BeginListOnPremisesInstances(ListOnPremisesInstancesRequest, AsyncCallback, object) | Initiates the asynchronous execution of the ListOnPremisesInstances operation. |
|
|
BeginRegisterApplicationRevision(RegisterApplicationRevisionRequest, AsyncCallback, object) | Initiates the asynchronous execution of the RegisterApplicationRevision operation. |
|
|
BeginRegisterOnPremisesInstance(RegisterOnPremisesInstanceRequest, AsyncCallback, object) | Initiates the asynchronous execution of the RegisterOnPremisesInstance operation. |
|
|
BeginRemoveTagsFromOnPremisesInstances(RemoveTagsFromOnPremisesInstancesRequest, AsyncCallback, object) | Initiates the asynchronous execution of the RemoveTagsFromOnPremisesInstances operation. |
|
|
BeginStopDeployment(StopDeploymentRequest, AsyncCallback, object) | Initiates the asynchronous execution of the StopDeployment operation. |
|
|
BeginUpdateApplication(UpdateApplicationRequest, AsyncCallback, object) | Initiates the asynchronous execution of the UpdateApplication operation. |
|
|
BeginUpdateDeploymentGroup(UpdateDeploymentGroupRequest, AsyncCallback, object) | Initiates the asynchronous execution of the UpdateDeploymentGroup operation. |
|
|
CreateApplication(CreateApplicationRequest) | Creates a new application. |
|
|
CreateDeployment(CreateDeploymentRequest) | Deploys an application revision through the specified deployment group. |
|
|
CreateDeploymentConfig(CreateDeploymentConfigRequest) | Creates a new deployment configuration. |
|
|
CreateDeploymentGroup(CreateDeploymentGroupRequest) | Creates a new deployment group for application revisions to be deployed to. |
|
|
DeleteApplication(DeleteApplicationRequest) | Deletes an application. |
|
|
DeleteDeploymentConfig(DeleteDeploymentConfigRequest) |
Deletes a deployment configuration.
|
|
|
DeleteDeploymentGroup(DeleteDeploymentGroupRequest) | Deletes a deployment group. |
|
|
DeregisterOnPremisesInstance(DeregisterOnPremisesInstanceRequest) | Deregisters an on-premises instance. |
|
|
Dispose() | Inherited from Amazon.Runtime.AmazonServiceClient. |
|
|
EndAddTagsToOnPremisesInstances(IAsyncResult) | Finishes the asynchronous execution of the AddTagsToOnPremisesInstances operation. |
|
|
EndBatchGetApplicationRevisions(IAsyncResult) | Finishes the asynchronous execution of the BatchGetApplicationRevisions operation. |
|
|
EndBatchGetApplications(IAsyncResult) | Finishes the asynchronous execution of the BatchGetApplications operation. |
|
|
EndBatchGetDeploymentInstances(IAsyncResult) | Finishes the asynchronous execution of the BatchGetDeploymentInstances operation. |
|
|
EndBatchGetDeployments(IAsyncResult) | Finishes the asynchronous execution of the BatchGetDeployments operation. |
|
|
EndBatchGetOnPremisesInstances(IAsyncResult) | Finishes the asynchronous execution of the BatchGetOnPremisesInstances operation. |
|
|
EndCreateApplication(IAsyncResult) | Finishes the asynchronous execution of the CreateApplication operation. |
|
|
EndCreateDeployment(IAsyncResult) | Finishes the asynchronous execution of the CreateDeployment operation. |
|
|
EndCreateDeploymentConfig(IAsyncResult) | Finishes the asynchronous execution of the CreateDeploymentConfig operation. |
|
|
EndCreateDeploymentGroup(IAsyncResult) | Finishes the asynchronous execution of the CreateDeploymentGroup operation. |
|
|
EndDeleteApplication(IAsyncResult) | Finishes the asynchronous execution of the DeleteApplication operation. |
|
|
EndDeleteDeploymentConfig(IAsyncResult) | Finishes the asynchronous execution of the DeleteDeploymentConfig operation. |
|
|
EndDeleteDeploymentGroup(IAsyncResult) | Finishes the asynchronous execution of the DeleteDeploymentGroup operation. |
|
|
EndDeregisterOnPremisesInstance(IAsyncResult) | Finishes the asynchronous execution of the DeregisterOnPremisesInstance operation. |
|
|
EndGetApplication(IAsyncResult) | Finishes the asynchronous execution of the GetApplication operation. |
|
|
EndGetApplicationRevision(IAsyncResult) | Finishes the asynchronous execution of the GetApplicationRevision operation. |
|
|
EndGetDeployment(IAsyncResult) | Finishes the asynchronous execution of the GetDeployment operation. |
|
|
EndGetDeploymentConfig(IAsyncResult) | Finishes the asynchronous execution of the GetDeploymentConfig operation. |
|
|
EndGetDeploymentGroup(IAsyncResult) | Finishes the asynchronous execution of the GetDeploymentGroup operation. |
|
|
EndGetDeploymentInstance(IAsyncResult) | Finishes the asynchronous execution of the GetDeploymentInstance operation. |
|
|
EndGetOnPremisesInstance(IAsyncResult) | Finishes the asynchronous execution of the GetOnPremisesInstance operation. |
|
|
EndListApplicationRevisions(IAsyncResult) | Finishes the asynchronous execution of the ListApplicationRevisions operation. |
|
|
EndListApplications(IAsyncResult) | Finishes the asynchronous execution of the ListApplications operation. |
|
|
EndListDeploymentConfigs(IAsyncResult) | Finishes the asynchronous execution of the ListDeploymentConfigs operation. |
|
|
EndListDeploymentGroups(IAsyncResult) | Finishes the asynchronous execution of the ListDeploymentGroups operation. |
|
|
EndListDeploymentInstances(IAsyncResult) | Finishes the asynchronous execution of the ListDeploymentInstances operation. |
|
|
EndListDeployments(IAsyncResult) | Finishes the asynchronous execution of the ListDeployments operation. |
|
|
EndListOnPremisesInstances(IAsyncResult) | Finishes the asynchronous execution of the ListOnPremisesInstances operation. |
|
|
EndRegisterApplicationRevision(IAsyncResult) | Finishes the asynchronous execution of the RegisterApplicationRevision operation. |
|
|
EndRegisterOnPremisesInstance(IAsyncResult) | Finishes the asynchronous execution of the RegisterOnPremisesInstance operation. |
|
|
EndRemoveTagsFromOnPremisesInstances(IAsyncResult) | Finishes the asynchronous execution of the RemoveTagsFromOnPremisesInstances operation. |
|
|
EndStopDeployment(IAsyncResult) | Finishes the asynchronous execution of the StopDeployment operation. |
|
|
EndUpdateApplication(IAsyncResult) | Finishes the asynchronous execution of the UpdateApplication operation. |
|
|
EndUpdateDeploymentGroup(IAsyncResult) | Finishes the asynchronous execution of the UpdateDeploymentGroup operation. |
|
|
GetApplication(GetApplicationRequest) | Gets information about an application. |
|
|
GetApplicationRevision(GetApplicationRevisionRequest) | Gets information about an application revision. |
|
|
GetDeployment(GetDeploymentRequest) | Gets information about a deployment. |
|
|
GetDeploymentConfig(GetDeploymentConfigRequest) | Gets information about a deployment configuration. |
|
|
GetDeploymentGroup(GetDeploymentGroupRequest) | Gets information about a deployment group. |
|
|
GetDeploymentInstance(GetDeploymentInstanceRequest) | Gets information about an instance as part of a deployment. |
|
|
GetOnPremisesInstance(GetOnPremisesInstanceRequest) | Gets information about an on-premises instance. |
|
|
ListApplicationRevisions(ListApplicationRevisionsRequest) | Lists information about revisions for an application. |
|
|
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. |
|
|
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. |
|
|
ListDeploymentGroups(ListDeploymentGroupsRequest) | Lists the deployment groups for an application registered with the applicable IAM user or AWS account. |
|
|
ListDeploymentInstances(ListDeploymentInstancesRequest) | Lists the instances for a deployment associated with the applicable IAM user or AWS account. |
|
|
ListDeployments(ListDeploymentsRequest) | Lists the deployments within a deployment group for an application registered with the applicable IAM user or AWS account. |
|
|
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. |
|
|
RegisterApplicationRevision(RegisterApplicationRevisionRequest) | Registers with AWS CodeDeploy a revision for the specified application. |
|
|
RegisterOnPremisesInstance(RegisterOnPremisesInstanceRequest) | Registers an on-premises instance. |
|
|
RemoveTagsFromOnPremisesInstances(RemoveTagsFromOnPremisesInstancesRequest) | Removes one or more tags from one or more on-premises instances. |
|
|
StopDeployment(StopDeploymentRequest) | Attempts to stop an ongoing deployment. |
|
|
UpdateApplication(UpdateApplicationRequest) | Changes an existing application's name. |
|
|
UpdateDeploymentGroup(UpdateDeploymentGroupRequest) | Changes information about an existing deployment group. |
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