/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.codedeploy; import javax.annotation.Generated; import com.amazonaws.services.codedeploy.model.*; /** * Interface for accessing CodeDeploy asynchronously. Each asynchronous method will return a Java Future object * representing the asynchronous operation; overloads which accept an {@code 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 * {@link com.amazonaws.services.codedeploy.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 *
** Adds tags to on-premises instances. *
* * @param addTagsToOnPremisesInstancesRequest * Represents the input of, and adds tags to, an on-premises instance operation. * @return A Java Future containing the result of the AddTagsToOnPremisesInstances operation returned by the * service. * @sample AmazonCodeDeployAsync.AddTagsToOnPremisesInstances * @see AWS API Documentation */ java.util.concurrent.Future* Adds tags to on-premises instances. *
* * @param addTagsToOnPremisesInstancesRequest * Represents the input of, and adds tags to, an on-premises instance operation. * @param 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. * @return A Java Future containing the result of the AddTagsToOnPremisesInstances operation returned by the * service. * @sample AmazonCodeDeployAsyncHandler.AddTagsToOnPremisesInstances * @see AWS API Documentation */ java.util.concurrent.Future* Gets information about one or more application revisions. The maximum number of application revisions that can be * returned is 25. *
* * @param batchGetApplicationRevisionsRequest * Represents the input of aBatchGetApplicationRevisions
operation.
* @return A Java Future containing the result of the BatchGetApplicationRevisions operation returned by the
* service.
* @sample AmazonCodeDeployAsync.BatchGetApplicationRevisions
* @see AWS API Documentation
*/
java.util.concurrent.Future* Gets information about one or more application revisions. The maximum number of application revisions that can be * returned is 25. *
* * @param batchGetApplicationRevisionsRequest * Represents the input of aBatchGetApplicationRevisions
operation.
* @param 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.
* @return A Java Future containing the result of the BatchGetApplicationRevisions operation returned by the
* service.
* @sample AmazonCodeDeployAsyncHandler.BatchGetApplicationRevisions
* @see AWS API Documentation
*/
java.util.concurrent.Future* Gets information about one or more applications. The maximum number of applications that can be returned is 100. *
* * @param batchGetApplicationsRequest * Represents the input of aBatchGetApplications
operation.
* @return A Java Future containing the result of the BatchGetApplications operation returned by the service.
* @sample AmazonCodeDeployAsync.BatchGetApplications
* @see AWS API Documentation
*/
java.util.concurrent.Future* Gets information about one or more applications. The maximum number of applications that can be returned is 100. *
* * @param batchGetApplicationsRequest * Represents the input of aBatchGetApplications
operation.
* @param 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.
* @return A Java Future containing the result of the BatchGetApplications operation returned by the service.
* @sample AmazonCodeDeployAsyncHandler.BatchGetApplications
* @see AWS API Documentation
*/
java.util.concurrent.Future* Gets information about one or more deployment groups. *
* * @param batchGetDeploymentGroupsRequest * Represents the input of aBatchGetDeploymentGroups
operation.
* @return A Java Future containing the result of the BatchGetDeploymentGroups operation returned by the service.
* @sample AmazonCodeDeployAsync.BatchGetDeploymentGroups
* @see AWS API Documentation
*/
java.util.concurrent.Future* Gets information about one or more deployment groups. *
* * @param batchGetDeploymentGroupsRequest * Represents the input of aBatchGetDeploymentGroups
operation.
* @param 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.
* @return A Java Future containing the result of the BatchGetDeploymentGroups operation returned by the service.
* @sample AmazonCodeDeployAsyncHandler.BatchGetDeploymentGroups
* @see AWS API Documentation
*/
java.util.concurrent.Future
* 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.
*
BatchGetDeploymentInstances
operation.
* @return A Java Future containing the result of the BatchGetDeploymentInstances operation returned by the service.
* @sample AmazonCodeDeployAsync.BatchGetDeploymentInstances
* @see AWS API Documentation
*/
@Deprecated
java.util.concurrent.Future
* 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.
*
BatchGetDeploymentInstances
operation.
* @param 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.
* @return A Java Future containing the result of the BatchGetDeploymentInstances operation returned by the service.
* @sample AmazonCodeDeployAsyncHandler.BatchGetDeploymentInstances
* @see AWS API Documentation
*/
@Deprecated
java.util.concurrent.Future
* 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. *
*
* 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. *
** Gets information about one or more deployments. The maximum number of deployments that can be returned is 25. *
* * @param batchGetDeploymentsRequest * Represents the input of aBatchGetDeployments
operation.
* @return A Java Future containing the result of the BatchGetDeployments operation returned by the service.
* @sample AmazonCodeDeployAsync.BatchGetDeployments
* @see AWS
* API Documentation
*/
java.util.concurrent.Future* Gets information about one or more deployments. The maximum number of deployments that can be returned is 25. *
* * @param batchGetDeploymentsRequest * Represents the input of aBatchGetDeployments
operation.
* @param 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.
* @return A Java Future containing the result of the BatchGetDeployments operation returned by the service.
* @sample AmazonCodeDeployAsyncHandler.BatchGetDeployments
* @see AWS
* API Documentation
*/
java.util.concurrent.Future* Gets information about one or more on-premises instances. The maximum number of on-premises instances that can be * returned is 25. *
* * @param batchGetOnPremisesInstancesRequest * Represents the input of aBatchGetOnPremisesInstances
operation.
* @return A Java Future containing the result of the BatchGetOnPremisesInstances operation returned by the service.
* @sample AmazonCodeDeployAsync.BatchGetOnPremisesInstances
* @see AWS API Documentation
*/
java.util.concurrent.Future* Gets information about one or more on-premises instances. The maximum number of on-premises instances that can be * returned is 25. *
* * @param batchGetOnPremisesInstancesRequest * Represents the input of aBatchGetOnPremisesInstances
operation.
* @param 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.
* @return A Java Future containing the result of the BatchGetOnPremisesInstances operation returned by the service.
* @sample AmazonCodeDeployAsyncHandler.BatchGetOnPremisesInstances
* @see AWS API Documentation
*/
java.util.concurrent.Future* 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.) *
* * @param continueDeploymentRequest * @return A Java Future containing the result of the ContinueDeployment operation returned by the service. * @sample AmazonCodeDeployAsync.ContinueDeployment * @see AWS * API Documentation */ java.util.concurrent.Future* 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.) *
* * @param continueDeploymentRequest * @param 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. * @return A Java Future containing the result of the ContinueDeployment operation returned by the service. * @sample AmazonCodeDeployAsyncHandler.ContinueDeployment * @see AWS * API Documentation */ java.util.concurrent.Future* Creates an application. *
* * @param createApplicationRequest * Represents the input of aCreateApplication
operation.
* @return A Java Future containing the result of the CreateApplication operation returned by the service.
* @sample AmazonCodeDeployAsync.CreateApplication
* @see AWS
* API Documentation
*/
java.util.concurrent.Future* Creates an application. *
* * @param createApplicationRequest * Represents the input of aCreateApplication
operation.
* @param 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.
* @return A Java Future containing the result of the CreateApplication operation returned by the service.
* @sample AmazonCodeDeployAsyncHandler.CreateApplication
* @see AWS
* API Documentation
*/
java.util.concurrent.Future* Deploys an application revision through the specified deployment group. *
* * @param createDeploymentRequest * Represents the input of aCreateDeployment
operation.
* @return A Java Future containing the result of the CreateDeployment operation returned by the service.
* @sample AmazonCodeDeployAsync.CreateDeployment
* @see AWS
* API Documentation
*/
java.util.concurrent.Future* Deploys an application revision through the specified deployment group. *
* * @param createDeploymentRequest * Represents the input of aCreateDeployment
operation.
* @param 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.
* @return A Java Future containing the result of the CreateDeployment operation returned by the service.
* @sample AmazonCodeDeployAsyncHandler.CreateDeployment
* @see AWS
* API Documentation
*/
java.util.concurrent.Future* Creates a deployment configuration. *
* * @param createDeploymentConfigRequest * Represents the input of aCreateDeploymentConfig
operation.
* @return A Java Future containing the result of the CreateDeploymentConfig operation returned by the service.
* @sample AmazonCodeDeployAsync.CreateDeploymentConfig
* @see AWS API Documentation
*/
java.util.concurrent.Future* Creates a deployment configuration. *
* * @param createDeploymentConfigRequest * Represents the input of aCreateDeploymentConfig
operation.
* @param 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.
* @return A Java Future containing the result of the CreateDeploymentConfig operation returned by the service.
* @sample AmazonCodeDeployAsyncHandler.CreateDeploymentConfig
* @see AWS API Documentation
*/
java.util.concurrent.Future* Creates a deployment group to which application revisions are deployed. *
* * @param createDeploymentGroupRequest * Represents the input of aCreateDeploymentGroup
operation.
* @return A Java Future containing the result of the CreateDeploymentGroup operation returned by the service.
* @sample AmazonCodeDeployAsync.CreateDeploymentGroup
* @see AWS API Documentation
*/
java.util.concurrent.Future* Creates a deployment group to which application revisions are deployed. *
* * @param createDeploymentGroupRequest * Represents the input of aCreateDeploymentGroup
operation.
* @param 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.
* @return A Java Future containing the result of the CreateDeploymentGroup operation returned by the service.
* @sample AmazonCodeDeployAsyncHandler.CreateDeploymentGroup
* @see AWS API Documentation
*/
java.util.concurrent.Future* Deletes an application. *
* * @param deleteApplicationRequest * Represents the input of aDeleteApplication
operation.
* @return A Java Future containing the result of the DeleteApplication operation returned by the service.
* @sample AmazonCodeDeployAsync.DeleteApplication
* @see AWS
* API Documentation
*/
java.util.concurrent.Future* Deletes an application. *
* * @param deleteApplicationRequest * Represents the input of aDeleteApplication
operation.
* @param 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.
* @return A Java Future containing the result of the DeleteApplication operation returned by the service.
* @sample AmazonCodeDeployAsyncHandler.DeleteApplication
* @see AWS
* API Documentation
*/
java.util.concurrent.Future* Deletes a deployment configuration. *
** A deployment configuration cannot be deleted if it is currently in use. Predefined configurations cannot be * deleted. *
*DeleteDeploymentConfig
operation.
* @return A Java Future containing the result of the DeleteDeploymentConfig operation returned by the service.
* @sample AmazonCodeDeployAsync.DeleteDeploymentConfig
* @see AWS API Documentation
*/
java.util.concurrent.Future* Deletes a deployment configuration. *
** A deployment configuration cannot be deleted if it is currently in use. Predefined configurations cannot be * deleted. *
*DeleteDeploymentConfig
operation.
* @param 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.
* @return A Java Future containing the result of the DeleteDeploymentConfig operation returned by the service.
* @sample AmazonCodeDeployAsyncHandler.DeleteDeploymentConfig
* @see AWS API Documentation
*/
java.util.concurrent.Future* Deletes a deployment group. *
* * @param deleteDeploymentGroupRequest * Represents the input of aDeleteDeploymentGroup
operation.
* @return A Java Future containing the result of the DeleteDeploymentGroup operation returned by the service.
* @sample AmazonCodeDeployAsync.DeleteDeploymentGroup
* @see AWS API Documentation
*/
java.util.concurrent.Future* Deletes a deployment group. *
* * @param deleteDeploymentGroupRequest * Represents the input of aDeleteDeploymentGroup
operation.
* @param 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.
* @return A Java Future containing the result of the DeleteDeploymentGroup operation returned by the service.
* @sample AmazonCodeDeployAsyncHandler.DeleteDeploymentGroup
* @see AWS API Documentation
*/
java.util.concurrent.Future* Deletes a GitHub account connection. *
* * @param deleteGitHubAccountTokenRequest * Represents the input of aDeleteGitHubAccount
operation.
* @return A Java Future containing the result of the DeleteGitHubAccountToken operation returned by the service.
* @sample AmazonCodeDeployAsync.DeleteGitHubAccountToken
* @see AWS API Documentation
*/
java.util.concurrent.Future* Deletes a GitHub account connection. *
* * @param deleteGitHubAccountTokenRequest * Represents the input of aDeleteGitHubAccount
operation.
* @param 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.
* @return A Java Future containing the result of the DeleteGitHubAccountToken operation returned by the service.
* @sample AmazonCodeDeployAsyncHandler.DeleteGitHubAccountToken
* @see AWS API Documentation
*/
java.util.concurrent.Future* Deletes resources linked to an external ID. *
* * @param deleteResourcesByExternalIdRequest * @return A Java Future containing the result of the DeleteResourcesByExternalId operation returned by the service. * @sample AmazonCodeDeployAsync.DeleteResourcesByExternalId * @see AWS API Documentation */ java.util.concurrent.Future* Deletes resources linked to an external ID. *
* * @param deleteResourcesByExternalIdRequest * @param 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. * @return A Java Future containing the result of the DeleteResourcesByExternalId operation returned by the service. * @sample AmazonCodeDeployAsyncHandler.DeleteResourcesByExternalId * @see AWS API Documentation */ java.util.concurrent.Future* Deregisters an on-premises instance. *
* * @param deregisterOnPremisesInstanceRequest * Represents the input of aDeregisterOnPremisesInstance
operation.
* @return A Java Future containing the result of the DeregisterOnPremisesInstance operation returned by the
* service.
* @sample AmazonCodeDeployAsync.DeregisterOnPremisesInstance
* @see AWS API Documentation
*/
java.util.concurrent.Future* Deregisters an on-premises instance. *
* * @param deregisterOnPremisesInstanceRequest * Represents the input of aDeregisterOnPremisesInstance
operation.
* @param 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.
* @return A Java Future containing the result of the DeregisterOnPremisesInstance operation returned by the
* service.
* @sample AmazonCodeDeployAsyncHandler.DeregisterOnPremisesInstance
* @see AWS API Documentation
*/
java.util.concurrent.Future* Gets information about an application. *
* * @param getApplicationRequest * Represents the input of aGetApplication
operation.
* @return A Java Future containing the result of the GetApplication operation returned by the service.
* @sample AmazonCodeDeployAsync.GetApplication
* @see AWS API
* Documentation
*/
java.util.concurrent.Future* Gets information about an application. *
* * @param getApplicationRequest * Represents the input of aGetApplication
operation.
* @param 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.
* @return A Java Future containing the result of the GetApplication operation returned by the service.
* @sample AmazonCodeDeployAsyncHandler.GetApplication
* @see AWS API
* Documentation
*/
java.util.concurrent.Future* Gets information about an application revision. *
* * @param getApplicationRevisionRequest * Represents the input of aGetApplicationRevision
operation.
* @return A Java Future containing the result of the GetApplicationRevision operation returned by the service.
* @sample AmazonCodeDeployAsync.GetApplicationRevision
* @see AWS API Documentation
*/
java.util.concurrent.Future* Gets information about an application revision. *
* * @param getApplicationRevisionRequest * Represents the input of aGetApplicationRevision
operation.
* @param 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.
* @return A Java Future containing the result of the GetApplicationRevision operation returned by the service.
* @sample AmazonCodeDeployAsyncHandler.GetApplicationRevision
* @see AWS API Documentation
*/
java.util.concurrent.Future* 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.
*
GetDeployment
operation.
* @return A Java Future containing the result of the GetDeployment operation returned by the service.
* @sample AmazonCodeDeployAsync.GetDeployment
* @see AWS API
* Documentation
*/
java.util.concurrent.Future* 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.
*
GetDeployment
operation.
* @param 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.
* @return A Java Future containing the result of the GetDeployment operation returned by the service.
* @sample AmazonCodeDeployAsyncHandler.GetDeployment
* @see AWS API
* Documentation
*/
java.util.concurrent.Future* Gets information about a deployment configuration. *
* * @param getDeploymentConfigRequest * Represents the input of aGetDeploymentConfig
operation.
* @return A Java Future containing the result of the GetDeploymentConfig operation returned by the service.
* @sample AmazonCodeDeployAsync.GetDeploymentConfig
* @see AWS
* API Documentation
*/
java.util.concurrent.Future* Gets information about a deployment configuration. *
* * @param getDeploymentConfigRequest * Represents the input of aGetDeploymentConfig
operation.
* @param 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.
* @return A Java Future containing the result of the GetDeploymentConfig operation returned by the service.
* @sample AmazonCodeDeployAsyncHandler.GetDeploymentConfig
* @see AWS
* API Documentation
*/
java.util.concurrent.Future* Gets information about a deployment group. *
* * @param getDeploymentGroupRequest * Represents the input of aGetDeploymentGroup
operation.
* @return A Java Future containing the result of the GetDeploymentGroup operation returned by the service.
* @sample AmazonCodeDeployAsync.GetDeploymentGroup
* @see AWS
* API Documentation
*/
java.util.concurrent.Future* Gets information about a deployment group. *
* * @param getDeploymentGroupRequest * Represents the input of aGetDeploymentGroup
operation.
* @param 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.
* @return A Java Future containing the result of the GetDeploymentGroup operation returned by the service.
* @sample AmazonCodeDeployAsyncHandler.GetDeploymentGroup
* @see AWS
* API Documentation
*/
java.util.concurrent.Future* Gets information about an instance as part of a deployment. *
* * @param getDeploymentInstanceRequest * Represents the input of aGetDeploymentInstance
operation.
* @return A Java Future containing the result of the GetDeploymentInstance operation returned by the service.
* @sample AmazonCodeDeployAsync.GetDeploymentInstance
* @see AWS API Documentation
*/
@Deprecated
java.util.concurrent.Future* Gets information about an instance as part of a deployment. *
* * @param getDeploymentInstanceRequest * Represents the input of aGetDeploymentInstance
operation.
* @param 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.
* @return A Java Future containing the result of the GetDeploymentInstance operation returned by the service.
* @sample AmazonCodeDeployAsyncHandler.GetDeploymentInstance
* @see AWS API Documentation
*/
@Deprecated
java.util.concurrent.Future* Returns information about a deployment target. *
* * @param getDeploymentTargetRequest * @return A Java Future containing the result of the GetDeploymentTarget operation returned by the service. * @sample AmazonCodeDeployAsync.GetDeploymentTarget * @see AWS * API Documentation */ java.util.concurrent.Future* Returns information about a deployment target. *
* * @param getDeploymentTargetRequest * @param 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. * @return A Java Future containing the result of the GetDeploymentTarget operation returned by the service. * @sample AmazonCodeDeployAsyncHandler.GetDeploymentTarget * @see AWS * API Documentation */ java.util.concurrent.Future* Gets information about an on-premises instance. *
* * @param getOnPremisesInstanceRequest * Represents the input of aGetOnPremisesInstance
operation.
* @return A Java Future containing the result of the GetOnPremisesInstance operation returned by the service.
* @sample AmazonCodeDeployAsync.GetOnPremisesInstance
* @see AWS API Documentation
*/
java.util.concurrent.Future* Gets information about an on-premises instance. *
* * @param getOnPremisesInstanceRequest * Represents the input of aGetOnPremisesInstance
operation.
* @param 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.
* @return A Java Future containing the result of the GetOnPremisesInstance operation returned by the service.
* @sample AmazonCodeDeployAsyncHandler.GetOnPremisesInstance
* @see AWS API Documentation
*/
java.util.concurrent.Future* Lists information about revisions for an application. *
* * @param listApplicationRevisionsRequest * Represents the input of aListApplicationRevisions
operation.
* @return A Java Future containing the result of the ListApplicationRevisions operation returned by the service.
* @sample AmazonCodeDeployAsync.ListApplicationRevisions
* @see AWS API Documentation
*/
java.util.concurrent.Future* Lists information about revisions for an application. *
* * @param listApplicationRevisionsRequest * Represents the input of aListApplicationRevisions
operation.
* @param 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.
* @return A Java Future containing the result of the ListApplicationRevisions operation returned by the service.
* @sample AmazonCodeDeployAsyncHandler.ListApplicationRevisions
* @see AWS API Documentation
*/
java.util.concurrent.Future* Lists the applications registered with the IAM user or Amazon Web Services account. *
* * @param listApplicationsRequest * Represents the input of aListApplications
operation.
* @return A Java Future containing the result of the ListApplications operation returned by the service.
* @sample AmazonCodeDeployAsync.ListApplications
* @see AWS
* API Documentation
*/
java.util.concurrent.Future* Lists the applications registered with the IAM user or Amazon Web Services account. *
* * @param listApplicationsRequest * Represents the input of aListApplications
operation.
* @param 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.
* @return A Java Future containing the result of the ListApplications operation returned by the service.
* @sample AmazonCodeDeployAsyncHandler.ListApplications
* @see AWS
* API Documentation
*/
java.util.concurrent.Future* Lists the deployment configurations with the IAM user or Amazon Web Services account. *
* * @param listDeploymentConfigsRequest * Represents the input of aListDeploymentConfigs
operation.
* @return A Java Future containing the result of the ListDeploymentConfigs operation returned by the service.
* @sample AmazonCodeDeployAsync.ListDeploymentConfigs
* @see AWS API Documentation
*/
java.util.concurrent.Future* Lists the deployment configurations with the IAM user or Amazon Web Services account. *
* * @param listDeploymentConfigsRequest * Represents the input of aListDeploymentConfigs
operation.
* @param 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.
* @return A Java Future containing the result of the ListDeploymentConfigs operation returned by the service.
* @sample AmazonCodeDeployAsyncHandler.ListDeploymentConfigs
* @see AWS API Documentation
*/
java.util.concurrent.Future* Lists the deployment groups for an application registered with the IAM user or Amazon Web Services account. *
* * @param listDeploymentGroupsRequest * Represents the input of aListDeploymentGroups
operation.
* @return A Java Future containing the result of the ListDeploymentGroups operation returned by the service.
* @sample AmazonCodeDeployAsync.ListDeploymentGroups
* @see AWS API Documentation
*/
java.util.concurrent.Future* Lists the deployment groups for an application registered with the IAM user or Amazon Web Services account. *
* * @param listDeploymentGroupsRequest * Represents the input of aListDeploymentGroups
operation.
* @param 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.
* @return A Java Future containing the result of the ListDeploymentGroups operation returned by the service.
* @sample AmazonCodeDeployAsyncHandler.ListDeploymentGroups
* @see AWS API Documentation
*/
java.util.concurrent.Future
* 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. *
* * @param listDeploymentInstancesRequest * Represents the input of aListDeploymentInstances
operation.
* @return A Java Future containing the result of the ListDeploymentInstances operation returned by the service.
* @sample AmazonCodeDeployAsync.ListDeploymentInstances
* @see AWS API Documentation
*/
@Deprecated
java.util.concurrent.Future
* 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. *
* * @param listDeploymentInstancesRequest * Represents the input of aListDeploymentInstances
operation.
* @param 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.
* @return A Java Future containing the result of the ListDeploymentInstances operation returned by the service.
* @sample AmazonCodeDeployAsyncHandler.ListDeploymentInstances
* @see AWS API Documentation
*/
@Deprecated
java.util.concurrent.Future* Returns an array of target IDs that are associated a deployment. *
* * @param listDeploymentTargetsRequest * @return A Java Future containing the result of the ListDeploymentTargets operation returned by the service. * @sample AmazonCodeDeployAsync.ListDeploymentTargets * @see AWS API Documentation */ java.util.concurrent.Future* Returns an array of target IDs that are associated a deployment. *
* * @param listDeploymentTargetsRequest * @param 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. * @return A Java Future containing the result of the ListDeploymentTargets operation returned by the service. * @sample AmazonCodeDeployAsyncHandler.ListDeploymentTargets * @see AWS API Documentation */ java.util.concurrent.Future* Lists the deployments in a deployment group for an application registered with the IAM user or Amazon Web * Services account. *
* * @param listDeploymentsRequest * Represents the input of aListDeployments
operation.
* @return A Java Future containing the result of the ListDeployments operation returned by the service.
* @sample AmazonCodeDeployAsync.ListDeployments
* @see AWS API
* Documentation
*/
java.util.concurrent.Future* Lists the deployments in a deployment group for an application registered with the IAM user or Amazon Web * Services account. *
* * @param listDeploymentsRequest * Represents the input of aListDeployments
operation.
* @param 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.
* @return A Java Future containing the result of the ListDeployments operation returned by the service.
* @sample AmazonCodeDeployAsyncHandler.ListDeployments
* @see AWS API
* Documentation
*/
java.util.concurrent.Future* Lists the names of stored connections to GitHub accounts. *
* * @param listGitHubAccountTokenNamesRequest * Represents the input of aListGitHubAccountTokenNames
operation.
* @return A Java Future containing the result of the ListGitHubAccountTokenNames operation returned by the service.
* @sample AmazonCodeDeployAsync.ListGitHubAccountTokenNames
* @see AWS API Documentation
*/
java.util.concurrent.Future* Lists the names of stored connections to GitHub accounts. *
* * @param listGitHubAccountTokenNamesRequest * Represents the input of aListGitHubAccountTokenNames
operation.
* @param 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.
* @return A Java Future containing the result of the ListGitHubAccountTokenNames operation returned by the service.
* @sample AmazonCodeDeployAsyncHandler.ListGitHubAccountTokenNames
* @see AWS API Documentation
*/
java.util.concurrent.Future* 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. *
* * @param listOnPremisesInstancesRequest * Represents the input of aListOnPremisesInstances
operation.
* @return A Java Future containing the result of the ListOnPremisesInstances operation returned by the service.
* @sample AmazonCodeDeployAsync.ListOnPremisesInstances
* @see AWS API Documentation
*/
java.util.concurrent.Future* 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. *
* * @param listOnPremisesInstancesRequest * Represents the input of aListOnPremisesInstances
operation.
* @param 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.
* @return A Java Future containing the result of the ListOnPremisesInstances operation returned by the service.
* @sample AmazonCodeDeployAsyncHandler.ListOnPremisesInstances
* @see AWS API Documentation
*/
java.util.concurrent.Future* 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. *
* * @param listTagsForResourceRequest * @return A Java Future containing the result of the ListTagsForResource operation returned by the service. * @sample AmazonCodeDeployAsync.ListTagsForResource * @see AWS * API Documentation */ java.util.concurrent.Future* 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. *
* * @param listTagsForResourceRequest * @param 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. * @return A Java Future containing the result of the ListTagsForResource operation returned by the service. * @sample AmazonCodeDeployAsyncHandler.ListTagsForResource * @see AWS * API Documentation */ java.util.concurrent.Future
* 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.
*
* 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.
*
* Registers with CodeDeploy a revision for the specified application. *
* * @param registerApplicationRevisionRequest * Represents the input of a RegisterApplicationRevision operation. * @return A Java Future containing the result of the RegisterApplicationRevision operation returned by the service. * @sample AmazonCodeDeployAsync.RegisterApplicationRevision * @see AWS API Documentation */ java.util.concurrent.Future* Registers with CodeDeploy a revision for the specified application. *
* * @param registerApplicationRevisionRequest * Represents the input of a RegisterApplicationRevision operation. * @param 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. * @return A Java Future containing the result of the RegisterApplicationRevision operation returned by the service. * @sample AmazonCodeDeployAsyncHandler.RegisterApplicationRevision * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
** 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. *
** Removes one or more tags from one or more on-premises instances. *
* * @param removeTagsFromOnPremisesInstancesRequest * Represents the input of aRemoveTagsFromOnPremisesInstances
operation.
* @return A Java Future containing the result of the RemoveTagsFromOnPremisesInstances operation returned by the
* service.
* @sample AmazonCodeDeployAsync.RemoveTagsFromOnPremisesInstances
* @see AWS API Documentation
*/
java.util.concurrent.Future* Removes one or more tags from one or more on-premises instances. *
* * @param removeTagsFromOnPremisesInstancesRequest * Represents the input of aRemoveTagsFromOnPremisesInstances
operation.
* @param 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.
* @return A Java Future containing the result of the RemoveTagsFromOnPremisesInstances operation returned by the
* service.
* @sample AmazonCodeDeployAsyncHandler.RemoveTagsFromOnPremisesInstances
* @see AWS API Documentation
*/
java.util.concurrent.Future* In a blue/green deployment, overrides any specified wait time and starts terminating instances immediately after * the traffic routing is complete. *
* * @param skipWaitTimeForInstanceTerminationRequest * @return A Java Future containing the result of the SkipWaitTimeForInstanceTermination operation returned by the * service. * @sample AmazonCodeDeployAsync.SkipWaitTimeForInstanceTermination * @see AWS API Documentation */ @Deprecated java.util.concurrent.Future* In a blue/green deployment, overrides any specified wait time and starts terminating instances immediately after * the traffic routing is complete. *
* * @param skipWaitTimeForInstanceTerminationRequest * @param 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. * @return A Java Future containing the result of the SkipWaitTimeForInstanceTermination operation returned by the * service. * @sample AmazonCodeDeployAsyncHandler.SkipWaitTimeForInstanceTermination * @see AWS API Documentation */ @Deprecated java.util.concurrent.Future* Attempts to stop an ongoing deployment. *
* * @param stopDeploymentRequest * Represents the input of aStopDeployment
operation.
* @return A Java Future containing the result of the StopDeployment operation returned by the service.
* @sample AmazonCodeDeployAsync.StopDeployment
* @see AWS API
* Documentation
*/
java.util.concurrent.Future* Attempts to stop an ongoing deployment. *
* * @param stopDeploymentRequest * Represents the input of aStopDeployment
operation.
* @param 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.
* @return A Java Future containing the result of the StopDeployment operation returned by the service.
* @sample AmazonCodeDeployAsyncHandler.StopDeployment
* @see AWS API
* Documentation
*/
java.util.concurrent.Future
* Associates the list of tags in the input Tags
parameter with the resource identified by the
* ResourceArn
input parameter.
*
* Associates the list of tags in the input Tags
parameter with the resource identified by the
* ResourceArn
input parameter.
*
* 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.
*
* 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.
*
* Changes the name of an application. *
* * @param updateApplicationRequest * Represents the input of anUpdateApplication
operation.
* @return A Java Future containing the result of the UpdateApplication operation returned by the service.
* @sample AmazonCodeDeployAsync.UpdateApplication
* @see AWS
* API Documentation
*/
java.util.concurrent.Future* Changes the name of an application. *
* * @param updateApplicationRequest * Represents the input of anUpdateApplication
operation.
* @param 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.
* @return A Java Future containing the result of the UpdateApplication operation returned by the service.
* @sample AmazonCodeDeployAsyncHandler.UpdateApplication
* @see AWS
* API Documentation
*/
java.util.concurrent.Future* Changes information about a deployment group. *
* * @param updateDeploymentGroupRequest * Represents the input of anUpdateDeploymentGroup
operation.
* @return A Java Future containing the result of the UpdateDeploymentGroup operation returned by the service.
* @sample AmazonCodeDeployAsync.UpdateDeploymentGroup
* @see AWS API Documentation
*/
java.util.concurrent.Future* Changes information about a deployment group. *
* * @param updateDeploymentGroupRequest * Represents the input of anUpdateDeploymentGroup
operation.
* @param 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.
* @return A Java Future containing the result of the UpdateDeploymentGroup operation returned by the service.
* @sample AmazonCodeDeployAsyncHandler.UpdateDeploymentGroup
* @see AWS API Documentation
*/
java.util.concurrent.Future