Interface for accessing CodeDeploy asynchronously. Each asynchronous method
will return a Java Future object representing the asynchronous operation;
overloads which accept an AsyncHandler can be used to receive
notification when an asynchronous operation completes.

<fullname>AWS CodeDeploy</fullname> 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.

addTagsToOnPremisesInstancesRequest
Represents the input of an adds tags to on-premises instance
operation.

asyncHandler
Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.

batchGetApplicationsRequest
Represents the input of a batch get applications operation.

asyncHandler
Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the BatchGetApplications
operation returned by the service.

batchGetDeploymentsRequest
Represents the input of a batch get deployments operation.

asyncHandler
Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the BatchGetDeployments
operation returned by the service.

batchGetOnPremisesInstancesRequest
Represents the input of a batch get on-premises instances
operation.

asyncHandler
Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the
BatchGetOnPremisesInstances operation returned by the service.

createApplicationRequest
Represents the input of a create application operation.

asyncHandler
Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the CreateApplication
operation returned by the service.

Deploys an application revision through the specified deployment group.

Parameters:

createDeploymentRequest
Represents the input of a create deployment operation.

asyncHandler
Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the CreateDeployment
operation returned by the service.

createDeploymentConfigRequest
Represents the input of a create deployment configuration
operation.

asyncHandler
Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the CreateDeploymentConfig
operation returned by the service.

Creates a new deployment group for application revisions to be deployed
to.

Parameters:

createDeploymentGroupRequest
Represents the input of a create deployment group operation.

asyncHandler
Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the CreateDeploymentGroup
operation returned by the service.

deleteApplicationRequest
Represents the input of a delete application operation.

asyncHandler
Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.

<note>A deployment configuration cannot be deleted if it is currently in
use. Also, predefined configurations cannot be deleted.</note>

Parameters:

deleteDeploymentConfigRequest
Represents the input of a delete deployment configuration
operation.

asyncHandler
Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.

deleteDeploymentGroupRequest
Represents the input of a delete deployment group operation.

asyncHandler
Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DeleteDeploymentGroup
operation returned by the service.

deregisterOnPremisesInstanceRequest
Represents the input of a deregister on-premises instance
operation.

asyncHandler
Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.

getApplicationRequest
Represents the input of a get application operation.

asyncHandler
Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the GetApplication
operation returned by the service.

getApplicationRevisionRequest
Represents the input of a get application revision operation.

asyncHandler
Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the GetApplicationRevision
operation returned by the service.

getDeploymentRequest
Represents the input of a get deployment operation.

asyncHandler
Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the GetDeployment
operation returned by the service.

getDeploymentConfigRequest
Represents the input of a get deployment configuration operation.

asyncHandler
Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the GetDeploymentConfig
operation returned by the service.

getDeploymentGroupRequest
Represents the input of a get deployment group operation.

asyncHandler
Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the GetDeploymentGroup
operation returned by the service.

getDeploymentInstanceRequest
Represents the input of a get deployment instance operation.

asyncHandler
Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the GetDeploymentInstance
operation returned by the service.

getOnPremisesInstanceRequest
Represents the input of a get on-premises instance operation.

asyncHandler
Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the GetOnPremisesInstance
operation returned by the service.

listApplicationRevisionsRequest
Represents the input of a list application revisions operation.

asyncHandler
Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the
ListApplicationRevisions operation returned by the service.

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

Parameters:

listApplicationsRequest
Represents the input of a list applications operation.

asyncHandler
Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListApplications
operation returned by the service.

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

Parameters:

listDeploymentConfigsRequest
Represents the input of a list deployment configurations
operation.

asyncHandler
Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListDeploymentConfigs
operation returned by the service.

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

Parameters:

listDeploymentGroupsRequest
Represents the input of a list deployment groups operation.

asyncHandler
Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListDeploymentGroups
operation returned by the service.

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

Parameters:

listDeploymentInstancesRequest
Represents the input of a list deployment instances operation.

asyncHandler
Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the
ListDeploymentInstances operation returned by the service.

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

Parameters:

listDeploymentsRequest
Represents the input of a list deployments operation.

asyncHandler
Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListDeployments
operation returned by the service.

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.

Parameters:

listOnPremisesInstancesRequest
Represents the input of a list on-premises instances operation.

Returns:

A Java Future containing the result of the
ListOnPremisesInstances operation returned by the service.

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.

Parameters:

listOnPremisesInstancesRequest
Represents the input of a list on-premises instances operation.

asyncHandler
Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the
ListOnPremisesInstances operation returned by the service.

Registers with AWS CodeDeploy a revision for the specified application.

Parameters:

registerApplicationRevisionRequest
Represents the input of a register application revision operation.

asyncHandler
Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.

asyncHandler
Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.

removeTagsFromOnPremisesInstancesRequest
Represents the input of a remove tags from on-premises instances
operation.

asyncHandler
Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.

stopDeploymentRequest
Represents the input of a stop deployment operation.

asyncHandler
Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the StopDeployment
operation returned by the service.

updateApplicationRequest
Represents the input of an update application operation.

asyncHandler
Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.

updateDeploymentGroupRequest
Represents the input of an update deployment group operation.

asyncHandler
Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the UpdateDeploymentGroup
operation returned by the service.