AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Interface for accessing CodeDeploy AWS CodeDeploy

AWS CodeDeploy is a deployment service that automates application deployments to Amazon EC2 instances or on-premises instances running in your own facility.

You can deploy a nearly unlimited variety of application content, such as code, web and configuration files, executables, packages, scripts, multimedia files, and so on. AWS 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 AWS CodeDeploy.

AWS 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.

AWS CodeDeploy Components

Use the information in this guide to help you work with the following AWS CodeDeploy components:

This guide also contains information to help you get details about the instances in your deployments and to make on-premises instances available for AWS CodeDeploy deployments.

AWS CodeDeploy Information Resources

Inheritance Hierarchy

Amazon.CodeDeploy.IAmazonCodeDeploy

Namespace: Amazon.CodeDeploy
Assembly: AWSSDK.CodeDeploy.dll
Version: 3.x.y.z

Syntax

C#
public interface IAmazonCodeDeploy
         IAmazonService, IDisposable

The IAmazonCodeDeploy type exposes the following members

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method AddTagsToOnPremisesInstances(AddTagsToOnPremisesInstancesRequest)

Adds tags to on-premises instances.

Public Method AddTagsToOnPremisesInstancesAsync(AddTagsToOnPremisesInstancesRequest, CancellationToken)

Initiates the asynchronous execution of the AddTagsToOnPremisesInstances operation.

Public Method BatchGetApplicationRevisions(BatchGetApplicationRevisionsRequest)

Gets information about one or more application revisions.

Public Method BatchGetApplicationRevisionsAsync(BatchGetApplicationRevisionsRequest, CancellationToken)

Initiates the asynchronous execution of the BatchGetApplicationRevisions operation.

Public Method BatchGetApplications(BatchGetApplicationsRequest)

Gets information about one or more applications.

Public Method BatchGetApplicationsAsync(BatchGetApplicationsRequest, CancellationToken)

Initiates the asynchronous execution of the BatchGetApplications operation.

Public Method BatchGetDeploymentGroups(BatchGetDeploymentGroupsRequest)

Gets information about one or more deployment groups.

Public Method BatchGetDeploymentGroupsAsync(BatchGetDeploymentGroupsRequest, CancellationToken)

Initiates the asynchronous execution of the BatchGetDeploymentGroups operation.

Public Method BatchGetDeploymentInstances(BatchGetDeploymentInstancesRequest)

Gets information about one or more instance that are part of a deployment group.

Public Method BatchGetDeploymentInstancesAsync(BatchGetDeploymentInstancesRequest, CancellationToken)

Initiates the asynchronous execution of the BatchGetDeploymentInstances operation.

Public Method BatchGetDeployments(BatchGetDeploymentsRequest)

Gets information about one or more deployments.

Public Method BatchGetDeploymentsAsync(BatchGetDeploymentsRequest, CancellationToken)

Initiates the asynchronous execution of the BatchGetDeployments operation.

Public Method BatchGetOnPremisesInstances(BatchGetOnPremisesInstancesRequest)

Gets information about one or more on-premises instances.

Public Method BatchGetOnPremisesInstancesAsync(BatchGetOnPremisesInstancesRequest, CancellationToken)

Initiates the asynchronous execution of the BatchGetOnPremisesInstances operation.

Public Method ContinueDeployment(ContinueDeploymentRequest)

For a blue/green deployment, starts the process of rerouting traffic from instances in the original environment to instances in the replacement environment without waiting for a specified wait time to elapse. (Traffic rerouting, which is achieved by registering instances in the replacement environment with the load balancer, can start as soon as all instances have a status of Ready.)

Public Method ContinueDeploymentAsync(ContinueDeploymentRequest, CancellationToken)

Initiates the asynchronous execution of the ContinueDeployment operation.

Public Method CreateApplication(CreateApplicationRequest)

Creates an application.

Public Method CreateApplicationAsync(CreateApplicationRequest, CancellationToken)

Initiates the asynchronous execution of the CreateApplication operation.

Public Method CreateDeployment(CreateDeploymentRequest)

Deploys an application revision through the specified deployment group.

Public Method CreateDeploymentAsync(CreateDeploymentRequest, CancellationToken)

Initiates the asynchronous execution of the CreateDeployment operation.

Public Method CreateDeploymentConfig(CreateDeploymentConfigRequest)

Creates a deployment configuration.

Public Method CreateDeploymentConfigAsync(CreateDeploymentConfigRequest, CancellationToken)

Initiates the asynchronous execution of the CreateDeploymentConfig operation.

Public Method CreateDeploymentGroup(CreateDeploymentGroupRequest)

Creates a deployment group to which application revisions will be deployed.

Public Method CreateDeploymentGroupAsync(CreateDeploymentGroupRequest, CancellationToken)

Initiates the asynchronous execution of the CreateDeploymentGroup operation.

Public Method DeleteApplication(DeleteApplicationRequest)

Deletes an application.

Public Method DeleteApplicationAsync(DeleteApplicationRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteApplication operation.

Public Method DeleteDeploymentConfig(DeleteDeploymentConfigRequest)

Deletes a deployment configuration.

A deployment configuration cannot be deleted if it is currently in use. Predefined configurations cannot be deleted.

Public Method DeleteDeploymentConfigAsync(DeleteDeploymentConfigRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteDeploymentConfig operation.

Public Method DeleteDeploymentGroup(DeleteDeploymentGroupRequest)

Deletes a deployment group.

Public Method DeleteDeploymentGroupAsync(DeleteDeploymentGroupRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteDeploymentGroup operation.

Public Method DeregisterOnPremisesInstance(DeregisterOnPremisesInstanceRequest)

Deregisters an on-premises instance.

Public Method DeregisterOnPremisesInstanceAsync(DeregisterOnPremisesInstanceRequest, CancellationToken)

Initiates the asynchronous execution of the DeregisterOnPremisesInstance operation.

Public Method GetApplication(GetApplicationRequest)

Gets information about an application.

Public Method GetApplicationAsync(GetApplicationRequest, CancellationToken)

Initiates the asynchronous execution of the GetApplication operation.

Public Method GetApplicationRevision(GetApplicationRevisionRequest)

Gets information about an application revision.

Public Method GetApplicationRevisionAsync(GetApplicationRevisionRequest, CancellationToken)

Initiates the asynchronous execution of the GetApplicationRevision operation.

Public Method GetDeployment(GetDeploymentRequest)

Gets information about a deployment.

Public Method GetDeploymentAsync(GetDeploymentRequest, CancellationToken)

Initiates the asynchronous execution of the GetDeployment operation.

Public Method GetDeploymentConfig(GetDeploymentConfigRequest)

Gets information about a deployment configuration.

Public Method GetDeploymentConfigAsync(GetDeploymentConfigRequest, CancellationToken)

Initiates the asynchronous execution of the GetDeploymentConfig operation.

Public Method GetDeploymentGroup(GetDeploymentGroupRequest)

Gets information about a deployment group.

Public Method GetDeploymentGroupAsync(GetDeploymentGroupRequest, CancellationToken)

Initiates the asynchronous execution of the GetDeploymentGroup operation.

Public Method GetDeploymentInstance(GetDeploymentInstanceRequest)

Gets information about an instance as part of a deployment.

Public Method GetDeploymentInstanceAsync(GetDeploymentInstanceRequest, CancellationToken)

Initiates the asynchronous execution of the GetDeploymentInstance operation.

Public Method GetOnPremisesInstance(GetOnPremisesInstanceRequest)

Gets information about an on-premises instance.

Public Method GetOnPremisesInstanceAsync(GetOnPremisesInstanceRequest, CancellationToken)

Initiates the asynchronous execution of the GetOnPremisesInstance operation.

Public Method ListApplicationRevisions(ListApplicationRevisionsRequest)

Lists information about revisions for an application.

Public Method ListApplicationRevisionsAsync(ListApplicationRevisionsRequest, CancellationToken)

Initiates the asynchronous execution of the ListApplicationRevisions operation.

Public Method ListApplications()

Lists the applications registered with the applicable IAM user or AWS account.

Public Method ListApplications(ListApplicationsRequest)

Lists the applications registered with the applicable IAM user or AWS account.

Public Method ListApplicationsAsync(CancellationToken)

Lists the applications registered with the applicable IAM user or AWS account.

Public Method ListApplicationsAsync(ListApplicationsRequest, CancellationToken)

Initiates the asynchronous execution of the ListApplications operation.

Public Method ListDeploymentConfigs()

Lists the deployment configurations with the applicable IAM user or AWS account.

Public Method ListDeploymentConfigs(ListDeploymentConfigsRequest)

Lists the deployment configurations with the applicable IAM user or AWS account.

Public Method ListDeploymentConfigsAsync(CancellationToken)

Lists the deployment configurations with the applicable IAM user or AWS account.

Public Method ListDeploymentConfigsAsync(ListDeploymentConfigsRequest, CancellationToken)

Initiates the asynchronous execution of the ListDeploymentConfigs operation.

Public Method ListDeploymentGroups(ListDeploymentGroupsRequest)

Lists the deployment groups for an application registered with the applicable IAM user or AWS account.

Public Method ListDeploymentGroupsAsync(ListDeploymentGroupsRequest, CancellationToken)

Initiates the asynchronous execution of the ListDeploymentGroups operation.

Public Method ListDeploymentInstances(ListDeploymentInstancesRequest)

Lists the instance for a deployment associated with the applicable IAM user or AWS account.

Public Method ListDeploymentInstancesAsync(ListDeploymentInstancesRequest, CancellationToken)

Initiates the asynchronous execution of the ListDeploymentInstances operation.

Public Method ListDeployments(ListDeploymentsRequest)

Lists the deployments in a deployment group for an application registered with the applicable IAM user or AWS account.

Public Method ListDeploymentsAsync(ListDeploymentsRequest, CancellationToken)

Initiates the asynchronous execution of the ListDeployments operation.

Public Method ListGitHubAccountTokenNames(ListGitHubAccountTokenNamesRequest)

Lists the names of stored connections to GitHub accounts.

Public Method ListGitHubAccountTokenNamesAsync(ListGitHubAccountTokenNamesRequest, CancellationToken)

Initiates the asynchronous execution of the ListGitHubAccountTokenNames operation.

Public Method ListOnPremisesInstances(ListOnPremisesInstancesRequest)

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.

Public Method ListOnPremisesInstancesAsync(ListOnPremisesInstancesRequest, CancellationToken)

Initiates the asynchronous execution of the ListOnPremisesInstances operation.

Public Method RegisterApplicationRevision(RegisterApplicationRevisionRequest)

Registers with AWS CodeDeploy a revision for the specified application.

Public Method RegisterApplicationRevisionAsync(RegisterApplicationRevisionRequest, CancellationToken)

Initiates the asynchronous execution of the RegisterApplicationRevision operation.

Public Method RegisterOnPremisesInstance(RegisterOnPremisesInstanceRequest)

Registers 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.

Public Method RegisterOnPremisesInstanceAsync(RegisterOnPremisesInstanceRequest, CancellationToken)

Initiates the asynchronous execution of the RegisterOnPremisesInstance operation.

Public Method RemoveTagsFromOnPremisesInstances(RemoveTagsFromOnPremisesInstancesRequest)

Removes one or more tags from one or more on-premises instances.

Public Method RemoveTagsFromOnPremisesInstancesAsync(RemoveTagsFromOnPremisesInstancesRequest, CancellationToken)

Initiates the asynchronous execution of the RemoveTagsFromOnPremisesInstances operation.

Public Method SkipWaitTimeForInstanceTermination(SkipWaitTimeForInstanceTerminationRequest)

In a blue/green deployment, overrides any specified wait time and starts terminating instances immediately after the traffic routing is completed.

Public Method SkipWaitTimeForInstanceTerminationAsync(SkipWaitTimeForInstanceTerminationRequest, CancellationToken)

Initiates the asynchronous execution of the SkipWaitTimeForInstanceTermination operation.

Public Method StopDeployment(StopDeploymentRequest)

Attempts to stop an ongoing deployment.

Public Method StopDeploymentAsync(StopDeploymentRequest, CancellationToken)

Initiates the asynchronous execution of the StopDeployment operation.

Public Method UpdateApplication(UpdateApplicationRequest)

Changes the name of an application.

Public Method UpdateApplicationAsync(UpdateApplicationRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateApplication operation.

Public Method UpdateDeploymentGroup(UpdateDeploymentGroupRequest)

Changes information about a deployment group.

Public Method UpdateDeploymentGroupAsync(UpdateDeploymentGroupRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateDeploymentGroup operation.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms