@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonCodeDeployAsync extends AmazonCodeDeploy
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonCodeDeployAsync instead.
CodeDeploy is a deployment service that automates application deployments to Amazon EC2 instances, on-premises instances running in your own facility, serverless Lambda functions, or applications in an Amazon ECS service.
You can deploy a nearly unlimited variety of application content, such as an updated Lambda function, updated applications in an Amazon ECS service, code, web and configuration files, executables, packages, scripts, multimedia files, and so on. 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 CodeDeploy.
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.
CodeDeploy Components
Use the information in this guide to help you work with the following CodeDeploy components:
Application: A name that uniquely identifies the application you want to deploy. CodeDeploy uses this name, which functions as a container, to ensure the correct combination of revision, deployment configuration, and deployment group are referenced during a deployment.
Deployment group: A set of individual instances, CodeDeploy Lambda deployment configuration settings, or an Amazon ECS service and network details. A Lambda deployment group specifies how to route traffic to a new version of a Lambda function. An Amazon ECS deployment group specifies the service created in Amazon ECS to deploy, a load balancer, and a listener to reroute production traffic to an updated containerized application. An Amazon EC2/On-premises deployment group contains individually tagged instances, Amazon EC2 instances in Amazon EC2 Auto Scaling groups, or both. All deployment groups can specify optional trigger, alarm, and rollback settings.
Deployment configuration: A set of deployment rules and deployment success and failure conditions used by CodeDeploy during a deployment.
Deployment: The process and the components used when updating a Lambda function, a containerized application in an Amazon ECS service, or of installing content on one or more instances.
Application revisions: For an Lambda deployment, this is an AppSpec file that specifies the Lambda function to be updated and one or more functions to validate deployment lifecycle events. For an Amazon ECS deployment, this is an AppSpec file that specifies the Amazon ECS task definition, container, and port where production traffic is rerouted. For an EC2/On-premises deployment, this is an archive file that contains source content—source code, webpages, executable files, and deployment scripts—along with an AppSpec file. Revisions are stored in Amazon S3 buckets or GitHub repositories. For Amazon S3, a revision is uniquely identified by its Amazon S3 object key and its ETag, version, or both. For GitHub, a revision is uniquely identified by its commit ID.
This guide also contains information to help you get details about the instances in your deployments, to make on-premises instances available for CodeDeploy deployments, to get details about a Lambda function deployment, and to get details about Amazon ECS service deployments.
CodeDeploy Information Resources
ENDPOINT_PREFIXaddTagsToOnPremisesInstances, batchGetApplicationRevisions, batchGetApplications, batchGetApplications, batchGetDeploymentGroups, batchGetDeploymentInstances, batchGetDeployments, batchGetDeployments, batchGetDeploymentTargets, batchGetOnPremisesInstances, batchGetOnPremisesInstances, continueDeployment, createApplication, createDeployment, createDeploymentConfig, createDeploymentGroup, deleteApplication, deleteDeploymentConfig, deleteDeploymentGroup, deleteGitHubAccountToken, deleteResourcesByExternalId, deregisterOnPremisesInstance, getApplication, getApplicationRevision, getCachedResponseMetadata, getDeployment, getDeploymentConfig, getDeploymentGroup, getDeploymentInstance, getDeploymentTarget, getOnPremisesInstance, listApplicationRevisions, listApplications, listApplications, listDeploymentConfigs, listDeploymentConfigs, listDeploymentGroups, listDeploymentInstances, listDeployments, listDeployments, listDeploymentTargets, listGitHubAccountTokenNames, listOnPremisesInstances, listOnPremisesInstances, listTagsForResource, putLifecycleEventHookExecutionStatus, registerApplicationRevision, registerOnPremisesInstance, removeTagsFromOnPremisesInstances, setEndpoint, setRegion, shutdown, skipWaitTimeForInstanceTermination, stopDeployment, tagResource, untagResource, updateApplication, updateApplication, updateDeploymentGroup, waitersFuture<AddTagsToOnPremisesInstancesResult> addTagsToOnPremisesInstancesAsync(AddTagsToOnPremisesInstancesRequest addTagsToOnPremisesInstancesRequest)
Adds tags to on-premises instances.
addTagsToOnPremisesInstancesRequest - Represents the input of, and adds tags to, an on-premises instance operation.Future<AddTagsToOnPremisesInstancesResult> addTagsToOnPremisesInstancesAsync(AddTagsToOnPremisesInstancesRequest addTagsToOnPremisesInstancesRequest, AsyncHandler<AddTagsToOnPremisesInstancesRequest,AddTagsToOnPremisesInstancesResult> asyncHandler)
Adds tags to on-premises instances.
addTagsToOnPremisesInstancesRequest - Represents the input of, and adds tags to, an 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.Future<BatchGetApplicationRevisionsResult> batchGetApplicationRevisionsAsync(BatchGetApplicationRevisionsRequest batchGetApplicationRevisionsRequest)
Gets information about one or more application revisions. The maximum number of application revisions that can be returned is 25.
batchGetApplicationRevisionsRequest - Represents the input of a BatchGetApplicationRevisions operation.Future<BatchGetApplicationRevisionsResult> batchGetApplicationRevisionsAsync(BatchGetApplicationRevisionsRequest batchGetApplicationRevisionsRequest, AsyncHandler<BatchGetApplicationRevisionsRequest,BatchGetApplicationRevisionsResult> asyncHandler)
Gets information about one or more application revisions. The maximum number of application revisions that can be returned is 25.
batchGetApplicationRevisionsRequest - Represents the input of a BatchGetApplicationRevisions 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.Future<BatchGetApplicationsResult> batchGetApplicationsAsync(BatchGetApplicationsRequest batchGetApplicationsRequest)
Gets information about one or more applications. The maximum number of applications that can be returned is 100.
batchGetApplicationsRequest - Represents the input of a BatchGetApplications operation.Future<BatchGetApplicationsResult> batchGetApplicationsAsync(BatchGetApplicationsRequest batchGetApplicationsRequest, AsyncHandler<BatchGetApplicationsRequest,BatchGetApplicationsResult> asyncHandler)
Gets information about one or more applications. The maximum number of applications that can be returned is 100.
batchGetApplicationsRequest - Represents the input of a BatchGetApplications 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.Future<BatchGetApplicationsResult> batchGetApplicationsAsync()
Future<BatchGetApplicationsResult> batchGetApplicationsAsync(AsyncHandler<BatchGetApplicationsRequest,BatchGetApplicationsResult> asyncHandler)
Future<BatchGetDeploymentGroupsResult> batchGetDeploymentGroupsAsync(BatchGetDeploymentGroupsRequest batchGetDeploymentGroupsRequest)
Gets information about one or more deployment groups.
batchGetDeploymentGroupsRequest - Represents the input of a BatchGetDeploymentGroups operation.Future<BatchGetDeploymentGroupsResult> batchGetDeploymentGroupsAsync(BatchGetDeploymentGroupsRequest batchGetDeploymentGroupsRequest, AsyncHandler<BatchGetDeploymentGroupsRequest,BatchGetDeploymentGroupsResult> asyncHandler)
Gets information about one or more deployment groups.
batchGetDeploymentGroupsRequest - Represents the input of a BatchGetDeploymentGroups 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.@Deprecated Future<BatchGetDeploymentInstancesResult> batchGetDeploymentInstancesAsync(BatchGetDeploymentInstancesRequest batchGetDeploymentInstancesRequest)
This method works, but is deprecated. Use BatchGetDeploymentTargets instead.
Returns an array of one or more instances associated with a deployment. This method works with EC2/On-premises
and Lambda compute platforms. The newer BatchGetDeploymentTargets works with all compute platforms.
The maximum number of instances that can be returned is 25.
batchGetDeploymentInstancesRequest - Represents the input of a BatchGetDeploymentInstances operation.@Deprecated Future<BatchGetDeploymentInstancesResult> batchGetDeploymentInstancesAsync(BatchGetDeploymentInstancesRequest batchGetDeploymentInstancesRequest, AsyncHandler<BatchGetDeploymentInstancesRequest,BatchGetDeploymentInstancesResult> asyncHandler)
This method works, but is deprecated. Use BatchGetDeploymentTargets instead.
Returns an array of one or more instances associated with a deployment. This method works with EC2/On-premises
and Lambda compute platforms. The newer BatchGetDeploymentTargets works with all compute platforms.
The maximum number of instances that can be returned is 25.
batchGetDeploymentInstancesRequest - Represents the input of a BatchGetDeploymentInstances 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.Future<BatchGetDeploymentTargetsResult> batchGetDeploymentTargetsAsync(BatchGetDeploymentTargetsRequest batchGetDeploymentTargetsRequest)
Returns an array of one or more targets associated with a deployment. This method works with all compute types
and should be used instead of the deprecated BatchGetDeploymentInstances. The maximum number of
targets that can be returned is 25.
The type of targets returned depends on the deployment's compute platform or deployment method:
EC2/On-premises: Information about Amazon EC2 instance targets.
Lambda: Information about Lambda functions targets.
Amazon ECS: Information about Amazon ECS service targets.
CloudFormation: Information about targets of blue/green deployments initiated by a CloudFormation stack update.
batchGetDeploymentTargetsRequest - Future<BatchGetDeploymentTargetsResult> batchGetDeploymentTargetsAsync(BatchGetDeploymentTargetsRequest batchGetDeploymentTargetsRequest, AsyncHandler<BatchGetDeploymentTargetsRequest,BatchGetDeploymentTargetsResult> asyncHandler)
Returns an array of one or more targets associated with a deployment. This method works with all compute types
and should be used instead of the deprecated BatchGetDeploymentInstances. The maximum number of
targets that can be returned is 25.
The type of targets returned depends on the deployment's compute platform or deployment method:
EC2/On-premises: Information about Amazon EC2 instance targets.
Lambda: Information about Lambda functions targets.
Amazon ECS: Information about Amazon ECS service targets.
CloudFormation: Information about targets of blue/green deployments initiated by a CloudFormation stack update.
batchGetDeploymentTargetsRequest - 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.Future<BatchGetDeploymentsResult> batchGetDeploymentsAsync(BatchGetDeploymentsRequest batchGetDeploymentsRequest)
Gets information about one or more deployments. The maximum number of deployments that can be returned is 25.
batchGetDeploymentsRequest - Represents the input of a BatchGetDeployments operation.Future<BatchGetDeploymentsResult> batchGetDeploymentsAsync(BatchGetDeploymentsRequest batchGetDeploymentsRequest, AsyncHandler<BatchGetDeploymentsRequest,BatchGetDeploymentsResult> asyncHandler)
Gets information about one or more deployments. The maximum number of deployments that can be returned is 25.
batchGetDeploymentsRequest - Represents the input of a BatchGetDeployments 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.Future<BatchGetDeploymentsResult> batchGetDeploymentsAsync()
Future<BatchGetDeploymentsResult> batchGetDeploymentsAsync(AsyncHandler<BatchGetDeploymentsRequest,BatchGetDeploymentsResult> asyncHandler)
Future<BatchGetOnPremisesInstancesResult> batchGetOnPremisesInstancesAsync(BatchGetOnPremisesInstancesRequest batchGetOnPremisesInstancesRequest)
Gets information about one or more on-premises instances. The maximum number of on-premises instances that can be returned is 25.
batchGetOnPremisesInstancesRequest - Represents the input of a BatchGetOnPremisesInstances operation.Future<BatchGetOnPremisesInstancesResult> batchGetOnPremisesInstancesAsync(BatchGetOnPremisesInstancesRequest batchGetOnPremisesInstancesRequest, AsyncHandler<BatchGetOnPremisesInstancesRequest,BatchGetOnPremisesInstancesResult> asyncHandler)
Gets information about one or more on-premises instances. The maximum number of on-premises instances that can be returned is 25.
batchGetOnPremisesInstancesRequest - Represents the input of a BatchGetOnPremisesInstances 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.Future<BatchGetOnPremisesInstancesResult> batchGetOnPremisesInstancesAsync()
Future<BatchGetOnPremisesInstancesResult> batchGetOnPremisesInstancesAsync(AsyncHandler<BatchGetOnPremisesInstancesRequest,BatchGetOnPremisesInstancesResult> asyncHandler)
Future<ContinueDeploymentResult> continueDeploymentAsync(ContinueDeploymentRequest 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.)
continueDeploymentRequest - Future<ContinueDeploymentResult> continueDeploymentAsync(ContinueDeploymentRequest continueDeploymentRequest, AsyncHandler<ContinueDeploymentRequest,ContinueDeploymentResult> asyncHandler)
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.)
continueDeploymentRequest - 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.Future<CreateApplicationResult> createApplicationAsync(CreateApplicationRequest createApplicationRequest)
Creates an application.
createApplicationRequest - Represents the input of a CreateApplication operation.Future<CreateApplicationResult> createApplicationAsync(CreateApplicationRequest createApplicationRequest, AsyncHandler<CreateApplicationRequest,CreateApplicationResult> asyncHandler)
Creates an application.
createApplicationRequest - Represents the input of a CreateApplication 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.Future<CreateDeploymentResult> createDeploymentAsync(CreateDeploymentRequest createDeploymentRequest)
Deploys an application revision through the specified deployment group.
createDeploymentRequest - Represents the input of a CreateDeployment operation.Future<CreateDeploymentResult> createDeploymentAsync(CreateDeploymentRequest createDeploymentRequest, AsyncHandler<CreateDeploymentRequest,CreateDeploymentResult> asyncHandler)
Deploys an application revision through the specified deployment group.
createDeploymentRequest - Represents the input of a CreateDeployment 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.Future<CreateDeploymentConfigResult> createDeploymentConfigAsync(CreateDeploymentConfigRequest createDeploymentConfigRequest)
Creates a deployment configuration.
createDeploymentConfigRequest - Represents the input of a CreateDeploymentConfig operation.Future<CreateDeploymentConfigResult> createDeploymentConfigAsync(CreateDeploymentConfigRequest createDeploymentConfigRequest, AsyncHandler<CreateDeploymentConfigRequest,CreateDeploymentConfigResult> asyncHandler)
Creates a deployment configuration.
createDeploymentConfigRequest - Represents the input of a CreateDeploymentConfig 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.Future<CreateDeploymentGroupResult> createDeploymentGroupAsync(CreateDeploymentGroupRequest createDeploymentGroupRequest)
Creates a deployment group to which application revisions are deployed.
createDeploymentGroupRequest - Represents the input of a CreateDeploymentGroup operation.Future<CreateDeploymentGroupResult> createDeploymentGroupAsync(CreateDeploymentGroupRequest createDeploymentGroupRequest, AsyncHandler<CreateDeploymentGroupRequest,CreateDeploymentGroupResult> asyncHandler)
Creates a deployment group to which application revisions are deployed.
createDeploymentGroupRequest - Represents the input of a CreateDeploymentGroup 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.Future<DeleteApplicationResult> deleteApplicationAsync(DeleteApplicationRequest deleteApplicationRequest)
Deletes an application.
deleteApplicationRequest - Represents the input of a DeleteApplication operation.Future<DeleteApplicationResult> deleteApplicationAsync(DeleteApplicationRequest deleteApplicationRequest, AsyncHandler<DeleteApplicationRequest,DeleteApplicationResult> asyncHandler)
Deletes an application.
deleteApplicationRequest - Represents the input of a DeleteApplication 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.Future<DeleteDeploymentConfigResult> deleteDeploymentConfigAsync(DeleteDeploymentConfigRequest deleteDeploymentConfigRequest)
Deletes a deployment configuration.
A deployment configuration cannot be deleted if it is currently in use. Predefined configurations cannot be deleted.
deleteDeploymentConfigRequest - Represents the input of a DeleteDeploymentConfig operation.Future<DeleteDeploymentConfigResult> deleteDeploymentConfigAsync(DeleteDeploymentConfigRequest deleteDeploymentConfigRequest, AsyncHandler<DeleteDeploymentConfigRequest,DeleteDeploymentConfigResult> asyncHandler)
Deletes a deployment configuration.
A deployment configuration cannot be deleted if it is currently in use. Predefined configurations cannot be deleted.
deleteDeploymentConfigRequest - Represents the input of a DeleteDeploymentConfig 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.Future<DeleteDeploymentGroupResult> deleteDeploymentGroupAsync(DeleteDeploymentGroupRequest deleteDeploymentGroupRequest)
Deletes a deployment group.
deleteDeploymentGroupRequest - Represents the input of a DeleteDeploymentGroup operation.Future<DeleteDeploymentGroupResult> deleteDeploymentGroupAsync(DeleteDeploymentGroupRequest deleteDeploymentGroupRequest, AsyncHandler<DeleteDeploymentGroupRequest,DeleteDeploymentGroupResult> asyncHandler)
Deletes a deployment group.
deleteDeploymentGroupRequest - Represents the input of a DeleteDeploymentGroup 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.Future<DeleteGitHubAccountTokenResult> deleteGitHubAccountTokenAsync(DeleteGitHubAccountTokenRequest deleteGitHubAccountTokenRequest)
Deletes a GitHub account connection.
deleteGitHubAccountTokenRequest - Represents the input of a DeleteGitHubAccount operation.Future<DeleteGitHubAccountTokenResult> deleteGitHubAccountTokenAsync(DeleteGitHubAccountTokenRequest deleteGitHubAccountTokenRequest, AsyncHandler<DeleteGitHubAccountTokenRequest,DeleteGitHubAccountTokenResult> asyncHandler)
Deletes a GitHub account connection.
deleteGitHubAccountTokenRequest - Represents the input of a DeleteGitHubAccount 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.Future<DeleteResourcesByExternalIdResult> deleteResourcesByExternalIdAsync(DeleteResourcesByExternalIdRequest deleteResourcesByExternalIdRequest)
Deletes resources linked to an external ID.
deleteResourcesByExternalIdRequest - Future<DeleteResourcesByExternalIdResult> deleteResourcesByExternalIdAsync(DeleteResourcesByExternalIdRequest deleteResourcesByExternalIdRequest, AsyncHandler<DeleteResourcesByExternalIdRequest,DeleteResourcesByExternalIdResult> asyncHandler)
Deletes resources linked to an external ID.
deleteResourcesByExternalIdRequest - 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.Future<DeregisterOnPremisesInstanceResult> deregisterOnPremisesInstanceAsync(DeregisterOnPremisesInstanceRequest deregisterOnPremisesInstanceRequest)
Deregisters an on-premises instance.
deregisterOnPremisesInstanceRequest - Represents the input of a DeregisterOnPremisesInstance operation.Future<DeregisterOnPremisesInstanceResult> deregisterOnPremisesInstanceAsync(DeregisterOnPremisesInstanceRequest deregisterOnPremisesInstanceRequest, AsyncHandler<DeregisterOnPremisesInstanceRequest,DeregisterOnPremisesInstanceResult> asyncHandler)
Deregisters an on-premises instance.
deregisterOnPremisesInstanceRequest - Represents the input of a DeregisterOnPremisesInstance 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.Future<GetApplicationResult> getApplicationAsync(GetApplicationRequest getApplicationRequest)
Gets information about an application.
getApplicationRequest - Represents the input of a GetApplication operation.Future<GetApplicationResult> getApplicationAsync(GetApplicationRequest getApplicationRequest, AsyncHandler<GetApplicationRequest,GetApplicationResult> asyncHandler)
Gets information about an application.
getApplicationRequest - Represents the input of a GetApplication 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.Future<GetApplicationRevisionResult> getApplicationRevisionAsync(GetApplicationRevisionRequest getApplicationRevisionRequest)
Gets information about an application revision.
getApplicationRevisionRequest - Represents the input of a GetApplicationRevision operation.Future<GetApplicationRevisionResult> getApplicationRevisionAsync(GetApplicationRevisionRequest getApplicationRevisionRequest, AsyncHandler<GetApplicationRevisionRequest,GetApplicationRevisionResult> asyncHandler)
Gets information about an application revision.
getApplicationRevisionRequest - Represents the input of a GetApplicationRevision 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.Future<GetDeploymentResult> getDeploymentAsync(GetDeploymentRequest getDeploymentRequest)
Gets information about a deployment.
The content property of the appSpecContent object in the returned revision is always
null. Use GetApplicationRevision and the sha256 property of the returned
appSpecContent object to get the content of the deployment’s AppSpec file.
getDeploymentRequest - Represents the input of a GetDeployment operation.Future<GetDeploymentResult> getDeploymentAsync(GetDeploymentRequest getDeploymentRequest, AsyncHandler<GetDeploymentRequest,GetDeploymentResult> asyncHandler)
Gets information about a deployment.
The content property of the appSpecContent object in the returned revision is always
null. Use GetApplicationRevision and the sha256 property of the returned
appSpecContent object to get the content of the deployment’s AppSpec file.
getDeploymentRequest - Represents the input of a GetDeployment 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.Future<GetDeploymentConfigResult> getDeploymentConfigAsync(GetDeploymentConfigRequest getDeploymentConfigRequest)
Gets information about a deployment configuration.
getDeploymentConfigRequest - Represents the input of a GetDeploymentConfig operation.Future<GetDeploymentConfigResult> getDeploymentConfigAsync(GetDeploymentConfigRequest getDeploymentConfigRequest, AsyncHandler<GetDeploymentConfigRequest,GetDeploymentConfigResult> asyncHandler)
Gets information about a deployment configuration.
getDeploymentConfigRequest - Represents the input of a GetDeploymentConfig 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.Future<GetDeploymentGroupResult> getDeploymentGroupAsync(GetDeploymentGroupRequest getDeploymentGroupRequest)
Gets information about a deployment group.
getDeploymentGroupRequest - Represents the input of a GetDeploymentGroup operation.Future<GetDeploymentGroupResult> getDeploymentGroupAsync(GetDeploymentGroupRequest getDeploymentGroupRequest, AsyncHandler<GetDeploymentGroupRequest,GetDeploymentGroupResult> asyncHandler)
Gets information about a deployment group.
getDeploymentGroupRequest - Represents the input of a GetDeploymentGroup 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.@Deprecated Future<GetDeploymentInstanceResult> getDeploymentInstanceAsync(GetDeploymentInstanceRequest getDeploymentInstanceRequest)
Gets information about an instance as part of a deployment.
getDeploymentInstanceRequest - Represents the input of a GetDeploymentInstance operation.@Deprecated Future<GetDeploymentInstanceResult> getDeploymentInstanceAsync(GetDeploymentInstanceRequest getDeploymentInstanceRequest, AsyncHandler<GetDeploymentInstanceRequest,GetDeploymentInstanceResult> asyncHandler)
Gets information about an instance as part of a deployment.
getDeploymentInstanceRequest - Represents the input of a GetDeploymentInstance 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.Future<GetDeploymentTargetResult> getDeploymentTargetAsync(GetDeploymentTargetRequest getDeploymentTargetRequest)
Returns information about a deployment target.
getDeploymentTargetRequest - Future<GetDeploymentTargetResult> getDeploymentTargetAsync(GetDeploymentTargetRequest getDeploymentTargetRequest, AsyncHandler<GetDeploymentTargetRequest,GetDeploymentTargetResult> asyncHandler)
Returns information about a deployment target.
getDeploymentTargetRequest - 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.Future<GetOnPremisesInstanceResult> getOnPremisesInstanceAsync(GetOnPremisesInstanceRequest getOnPremisesInstanceRequest)
Gets information about an on-premises instance.
getOnPremisesInstanceRequest - Represents the input of a GetOnPremisesInstance operation.Future<GetOnPremisesInstanceResult> getOnPremisesInstanceAsync(GetOnPremisesInstanceRequest getOnPremisesInstanceRequest, AsyncHandler<GetOnPremisesInstanceRequest,GetOnPremisesInstanceResult> asyncHandler)
Gets information about an on-premises instance.
getOnPremisesInstanceRequest - Represents the input of a GetOnPremisesInstance 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.Future<ListApplicationRevisionsResult> listApplicationRevisionsAsync(ListApplicationRevisionsRequest listApplicationRevisionsRequest)
Lists information about revisions for an application.
listApplicationRevisionsRequest - Represents the input of a ListApplicationRevisions operation.Future<ListApplicationRevisionsResult> listApplicationRevisionsAsync(ListApplicationRevisionsRequest listApplicationRevisionsRequest, AsyncHandler<ListApplicationRevisionsRequest,ListApplicationRevisionsResult> asyncHandler)
Lists information about revisions for an application.
listApplicationRevisionsRequest - Represents the input of a ListApplicationRevisions 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.Future<ListApplicationsResult> listApplicationsAsync(ListApplicationsRequest listApplicationsRequest)
Lists the applications registered with the IAM user or Amazon Web Services account.
listApplicationsRequest - Represents the input of a ListApplications operation.Future<ListApplicationsResult> listApplicationsAsync(ListApplicationsRequest listApplicationsRequest, AsyncHandler<ListApplicationsRequest,ListApplicationsResult> asyncHandler)
Lists the applications registered with the IAM user or Amazon Web Services account.
listApplicationsRequest - Represents the input of a ListApplications 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.Future<ListApplicationsResult> listApplicationsAsync()
Future<ListApplicationsResult> listApplicationsAsync(AsyncHandler<ListApplicationsRequest,ListApplicationsResult> asyncHandler)
Future<ListDeploymentConfigsResult> listDeploymentConfigsAsync(ListDeploymentConfigsRequest listDeploymentConfigsRequest)
Lists the deployment configurations with the IAM user or Amazon Web Services account.
listDeploymentConfigsRequest - Represents the input of a ListDeploymentConfigs operation.Future<ListDeploymentConfigsResult> listDeploymentConfigsAsync(ListDeploymentConfigsRequest listDeploymentConfigsRequest, AsyncHandler<ListDeploymentConfigsRequest,ListDeploymentConfigsResult> asyncHandler)
Lists the deployment configurations with the IAM user or Amazon Web Services account.
listDeploymentConfigsRequest - Represents the input of a ListDeploymentConfigs 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.Future<ListDeploymentConfigsResult> listDeploymentConfigsAsync()
Future<ListDeploymentConfigsResult> listDeploymentConfigsAsync(AsyncHandler<ListDeploymentConfigsRequest,ListDeploymentConfigsResult> asyncHandler)
Future<ListDeploymentGroupsResult> listDeploymentGroupsAsync(ListDeploymentGroupsRequest listDeploymentGroupsRequest)
Lists the deployment groups for an application registered with the IAM user or Amazon Web Services account.
listDeploymentGroupsRequest - Represents the input of a ListDeploymentGroups operation.Future<ListDeploymentGroupsResult> listDeploymentGroupsAsync(ListDeploymentGroupsRequest listDeploymentGroupsRequest, AsyncHandler<ListDeploymentGroupsRequest,ListDeploymentGroupsResult> asyncHandler)
Lists the deployment groups for an application registered with the IAM user or Amazon Web Services account.
listDeploymentGroupsRequest - Represents the input of a ListDeploymentGroups 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.@Deprecated Future<ListDeploymentInstancesResult> listDeploymentInstancesAsync(ListDeploymentInstancesRequest listDeploymentInstancesRequest)
The newer BatchGetDeploymentTargets should be used instead because it works with all compute types.
ListDeploymentInstances throws an exception if it is used with a compute platform other than
EC2/On-premises or Lambda.
Lists the instance for a deployment associated with the IAM user or Amazon Web Services account.
listDeploymentInstancesRequest - Represents the input of a ListDeploymentInstances operation.@Deprecated Future<ListDeploymentInstancesResult> listDeploymentInstancesAsync(ListDeploymentInstancesRequest listDeploymentInstancesRequest, AsyncHandler<ListDeploymentInstancesRequest,ListDeploymentInstancesResult> asyncHandler)
The newer BatchGetDeploymentTargets should be used instead because it works with all compute types.
ListDeploymentInstances throws an exception if it is used with a compute platform other than
EC2/On-premises or Lambda.
Lists the instance for a deployment associated with the IAM user or Amazon Web Services account.
listDeploymentInstancesRequest - Represents the input of a ListDeploymentInstances 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.Future<ListDeploymentTargetsResult> listDeploymentTargetsAsync(ListDeploymentTargetsRequest listDeploymentTargetsRequest)
Returns an array of target IDs that are associated a deployment.
listDeploymentTargetsRequest - Future<ListDeploymentTargetsResult> listDeploymentTargetsAsync(ListDeploymentTargetsRequest listDeploymentTargetsRequest, AsyncHandler<ListDeploymentTargetsRequest,ListDeploymentTargetsResult> asyncHandler)
Returns an array of target IDs that are associated a deployment.
listDeploymentTargetsRequest - 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.Future<ListDeploymentsResult> listDeploymentsAsync(ListDeploymentsRequest listDeploymentsRequest)
Lists the deployments in a deployment group for an application registered with the IAM user or Amazon Web Services account.
listDeploymentsRequest - Represents the input of a ListDeployments operation.Future<ListDeploymentsResult> listDeploymentsAsync(ListDeploymentsRequest listDeploymentsRequest, AsyncHandler<ListDeploymentsRequest,ListDeploymentsResult> asyncHandler)
Lists the deployments in a deployment group for an application registered with the IAM user or Amazon Web Services account.
listDeploymentsRequest - Represents the input of a ListDeployments 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.Future<ListDeploymentsResult> listDeploymentsAsync()
Future<ListDeploymentsResult> listDeploymentsAsync(AsyncHandler<ListDeploymentsRequest,ListDeploymentsResult> asyncHandler)
Future<ListGitHubAccountTokenNamesResult> listGitHubAccountTokenNamesAsync(ListGitHubAccountTokenNamesRequest listGitHubAccountTokenNamesRequest)
Lists the names of stored connections to GitHub accounts.
listGitHubAccountTokenNamesRequest - Represents the input of a ListGitHubAccountTokenNames operation.Future<ListGitHubAccountTokenNamesResult> listGitHubAccountTokenNamesAsync(ListGitHubAccountTokenNamesRequest listGitHubAccountTokenNamesRequest, AsyncHandler<ListGitHubAccountTokenNamesRequest,ListGitHubAccountTokenNamesResult> asyncHandler)
Lists the names of stored connections to GitHub accounts.
listGitHubAccountTokenNamesRequest - Represents the input of a ListGitHubAccountTokenNames 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.Future<ListOnPremisesInstancesResult> listOnPremisesInstancesAsync(ListOnPremisesInstancesRequest listOnPremisesInstancesRequest)
Gets a list of names for one or more on-premises instances.
Unless otherwise specified, both registered and deregistered on-premises instance names are listed. To list only registered or deregistered on-premises instance names, use the registration status parameter.
listOnPremisesInstancesRequest - Represents the input of a ListOnPremisesInstances operation.Future<ListOnPremisesInstancesResult> listOnPremisesInstancesAsync(ListOnPremisesInstancesRequest listOnPremisesInstancesRequest, AsyncHandler<ListOnPremisesInstancesRequest,ListOnPremisesInstancesResult> asyncHandler)
Gets a list of names for one or more on-premises instances.
Unless otherwise specified, both registered and deregistered on-premises instance names are listed. To list only registered or deregistered on-premises instance names, use the registration status parameter.
listOnPremisesInstancesRequest - Represents the input of a ListOnPremisesInstances 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.Future<ListOnPremisesInstancesResult> listOnPremisesInstancesAsync()
Future<ListOnPremisesInstancesResult> listOnPremisesInstancesAsync(AsyncHandler<ListOnPremisesInstancesRequest,ListOnPremisesInstancesResult> asyncHandler)
Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of tags for the resource identified by a specified Amazon Resource Name (ARN). Tags are used to organize and categorize your CodeDeploy resources.
listTagsForResourceRequest - Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Returns a list of tags for the resource identified by a specified Amazon Resource Name (ARN). Tags are used to organize and categorize your CodeDeploy resources.
listTagsForResourceRequest - 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.Future<PutLifecycleEventHookExecutionStatusResult> putLifecycleEventHookExecutionStatusAsync(PutLifecycleEventHookExecutionStatusRequest putLifecycleEventHookExecutionStatusRequest)
Sets the result of a Lambda validation function. The function validates lifecycle hooks during a deployment that
uses the Lambda or Amazon ECS compute platform. For Lambda deployments, the available lifecycle hooks are
BeforeAllowTraffic and AfterAllowTraffic. For Amazon ECS deployments, the available
lifecycle hooks are BeforeInstall, AfterInstall, AfterAllowTestTraffic,
BeforeAllowTraffic, and AfterAllowTraffic. Lambda validation functions return
Succeeded or Failed. For more information, see AppSpec 'hooks' Section for an Lambda Deployment and AppSpec 'hooks' Section for an Amazon ECS Deployment.
putLifecycleEventHookExecutionStatusRequest - Future<PutLifecycleEventHookExecutionStatusResult> putLifecycleEventHookExecutionStatusAsync(PutLifecycleEventHookExecutionStatusRequest putLifecycleEventHookExecutionStatusRequest, AsyncHandler<PutLifecycleEventHookExecutionStatusRequest,PutLifecycleEventHookExecutionStatusResult> asyncHandler)
Sets the result of a Lambda validation function. The function validates lifecycle hooks during a deployment that
uses the Lambda or Amazon ECS compute platform. For Lambda deployments, the available lifecycle hooks are
BeforeAllowTraffic and AfterAllowTraffic. For Amazon ECS deployments, the available
lifecycle hooks are BeforeInstall, AfterInstall, AfterAllowTestTraffic,
BeforeAllowTraffic, and AfterAllowTraffic. Lambda validation functions return
Succeeded or Failed. For more information, see AppSpec 'hooks' Section for an Lambda Deployment and AppSpec 'hooks' Section for an Amazon ECS Deployment.
putLifecycleEventHookExecutionStatusRequest - 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.Future<RegisterApplicationRevisionResult> registerApplicationRevisionAsync(RegisterApplicationRevisionRequest registerApplicationRevisionRequest)
Registers with CodeDeploy a revision for the specified application.
registerApplicationRevisionRequest - Represents the input of a RegisterApplicationRevision operation.Future<RegisterApplicationRevisionResult> registerApplicationRevisionAsync(RegisterApplicationRevisionRequest registerApplicationRevisionRequest, AsyncHandler<RegisterApplicationRevisionRequest,RegisterApplicationRevisionResult> asyncHandler)
Registers with CodeDeploy a revision for the specified application.
registerApplicationRevisionRequest - Represents the input of a RegisterApplicationRevision 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.Future<RegisterOnPremisesInstanceResult> registerOnPremisesInstanceAsync(RegisterOnPremisesInstanceRequest 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.
registerOnPremisesInstanceRequest - Represents the input of the register on-premises instance operation.Future<RegisterOnPremisesInstanceResult> registerOnPremisesInstanceAsync(RegisterOnPremisesInstanceRequest registerOnPremisesInstanceRequest, AsyncHandler<RegisterOnPremisesInstanceRequest,RegisterOnPremisesInstanceResult> asyncHandler)
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.
registerOnPremisesInstanceRequest - Represents the input of the register 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.Future<RemoveTagsFromOnPremisesInstancesResult> removeTagsFromOnPremisesInstancesAsync(RemoveTagsFromOnPremisesInstancesRequest removeTagsFromOnPremisesInstancesRequest)
Removes one or more tags from one or more on-premises instances.
removeTagsFromOnPremisesInstancesRequest - Represents the input of a RemoveTagsFromOnPremisesInstances operation.Future<RemoveTagsFromOnPremisesInstancesResult> removeTagsFromOnPremisesInstancesAsync(RemoveTagsFromOnPremisesInstancesRequest removeTagsFromOnPremisesInstancesRequest, AsyncHandler<RemoveTagsFromOnPremisesInstancesRequest,RemoveTagsFromOnPremisesInstancesResult> asyncHandler)
Removes one or more tags from one or more on-premises instances.
removeTagsFromOnPremisesInstancesRequest - Represents the input of a RemoveTagsFromOnPremisesInstances 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.@Deprecated Future<SkipWaitTimeForInstanceTerminationResult> skipWaitTimeForInstanceTerminationAsync(SkipWaitTimeForInstanceTerminationRequest skipWaitTimeForInstanceTerminationRequest)
In a blue/green deployment, overrides any specified wait time and starts terminating instances immediately after the traffic routing is complete.
skipWaitTimeForInstanceTerminationRequest - @Deprecated Future<SkipWaitTimeForInstanceTerminationResult> skipWaitTimeForInstanceTerminationAsync(SkipWaitTimeForInstanceTerminationRequest skipWaitTimeForInstanceTerminationRequest, AsyncHandler<SkipWaitTimeForInstanceTerminationRequest,SkipWaitTimeForInstanceTerminationResult> asyncHandler)
In a blue/green deployment, overrides any specified wait time and starts terminating instances immediately after the traffic routing is complete.
skipWaitTimeForInstanceTerminationRequest - 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.Future<StopDeploymentResult> stopDeploymentAsync(StopDeploymentRequest stopDeploymentRequest)
Attempts to stop an ongoing deployment.
stopDeploymentRequest - Represents the input of a StopDeployment operation.Future<StopDeploymentResult> stopDeploymentAsync(StopDeploymentRequest stopDeploymentRequest, AsyncHandler<StopDeploymentRequest,StopDeploymentResult> asyncHandler)
Attempts to stop an ongoing deployment.
stopDeploymentRequest - Represents the input of a StopDeployment 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.Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest)
Associates the list of tags in the input Tags parameter with the resource identified by the
ResourceArn input parameter.
tagResourceRequest - Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Associates the list of tags in the input Tags parameter with the resource identified by the
ResourceArn input parameter.
tagResourceRequest - 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.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
Disassociates a resource from a list of tags. The resource is identified by the ResourceArn input
parameter. The tags are identified by the list of keys in the TagKeys input parameter.
untagResourceRequest - Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Disassociates a resource from a list of tags. The resource is identified by the ResourceArn input
parameter. The tags are identified by the list of keys in the TagKeys input parameter.
untagResourceRequest - 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.Future<UpdateApplicationResult> updateApplicationAsync(UpdateApplicationRequest updateApplicationRequest)
Changes the name of an application.
updateApplicationRequest - Represents the input of an UpdateApplication operation.Future<UpdateApplicationResult> updateApplicationAsync(UpdateApplicationRequest updateApplicationRequest, AsyncHandler<UpdateApplicationRequest,UpdateApplicationResult> asyncHandler)
Changes the name of an application.
updateApplicationRequest - Represents the input of an UpdateApplication 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.Future<UpdateApplicationResult> updateApplicationAsync()
Future<UpdateApplicationResult> updateApplicationAsync(AsyncHandler<UpdateApplicationRequest,UpdateApplicationResult> asyncHandler)
Future<UpdateDeploymentGroupResult> updateDeploymentGroupAsync(UpdateDeploymentGroupRequest updateDeploymentGroupRequest)
Changes information about a deployment group.
updateDeploymentGroupRequest - Represents the input of an UpdateDeploymentGroup operation.Future<UpdateDeploymentGroupResult> updateDeploymentGroupAsync(UpdateDeploymentGroupRequest updateDeploymentGroupRequest, AsyncHandler<UpdateDeploymentGroupRequest,UpdateDeploymentGroupResult> asyncHandler)
Changes information about a deployment group.
updateDeploymentGroupRequest - Represents the input of an UpdateDeploymentGroup 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.