Package software.amazon.awssdk.services.codedeploy

Interface CodeDeployAsyncClient

All Superinterfaces:

AutoCloseable

@Generated("software.amazon.awssdk:codegen")
public interface CodeDeployAsyncClient
extends AutoCloseable

Service client for accessing CodeDeploy asynchronously. This can be created using the static builder() method. AWS CodeDeploy

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

You can deploy a nearly unlimited variety of application content, such as code, web and configuration files, executables, packages, scripts, multimedia files, and so on. AWS CodeDeploy can deploy application content stored in Amazon S3 buckets, GitHub repositories, or Bitbucket repositories. You do not need to make changes to your existing code before you can use AWS CodeDeploy.

AWS CodeDeploy makes it easier for you to rapidly release new features, helps you avoid downtime during application deployment, and handles the complexity of updating your applications, without many of the risks associated with error-prone manual deployments.

AWS CodeDeploy Components

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

• Application: A name that uniquely identifies the application you want to deploy. AWS 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. A deployment group contains individually tagged instances, Amazon EC2 instances in Auto Scaling groups, or both.

• Deployment configuration: A set of deployment rules and deployment success and failure conditions used by AWS CodeDeploy during a deployment.

• Deployment: The process, and the components involved in the process, of installing content on one or more instances.

• Application revisions: An archive file containing source content—source code, web pages, executable files, and deployment scripts—along with an application specification file (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 and to make on-premises instances available for AWS CodeDeploy deployments.

AWS CodeDeploy Information Resources

• AWS CodeDeploy User Guide

• AWS CodeDeploy API Reference Guide

• AWS CLI Reference for AWS CodeDeploy

• AWS CodeDeploy Developer Forum

Method Summary

Modifier and Type	Method	Description
default CompletableFuture<AddTagsToOnPremisesInstancesResponse>	addTagsToOnPremisesInstances(AddTagsToOnPremisesInstancesRequest addTagsToOnPremisesInstancesRequest)	Adds tags to on-premises instances.
default CompletableFuture<BatchGetApplicationRevisionsResponse>	batchGetApplicationRevisions(BatchGetApplicationRevisionsRequest batchGetApplicationRevisionsRequest)	Gets information about one or more application revisions.
default CompletableFuture<BatchGetApplicationsResponse>	batchGetApplications(BatchGetApplicationsRequest batchGetApplicationsRequest)	Gets information about one or more applications.
default CompletableFuture<BatchGetDeploymentGroupsResponse>	batchGetDeploymentGroups(BatchGetDeploymentGroupsRequest batchGetDeploymentGroupsRequest)	Gets information about one or more deployment groups.
default CompletableFuture<BatchGetDeploymentInstancesResponse>	batchGetDeploymentInstances(BatchGetDeploymentInstancesRequest batchGetDeploymentInstancesRequest)	Gets information about one or more instance that are part of a deployment group.
default CompletableFuture<BatchGetDeploymentsResponse>	batchGetDeployments(BatchGetDeploymentsRequest batchGetDeploymentsRequest)	Gets information about one or more deployments.
default CompletableFuture<BatchGetOnPremisesInstancesResponse>	batchGetOnPremisesInstances(BatchGetOnPremisesInstancesRequest batchGetOnPremisesInstancesRequest)	Gets information about one or more on-premises instances.
static CodeDeployAsyncClientBuilder	builder()	Create a builder that can be used to configure and create a CodeDeployAsyncClient.
default CompletableFuture<ContinueDeploymentResponse>	continueDeployment(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.
static CodeDeployAsyncClient	create()	Create a CodeDeployAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CompletableFuture<CreateApplicationResponse>	createApplication(CreateApplicationRequest createApplicationRequest)	Creates an application.
default CompletableFuture<CreateDeploymentResponse>	createDeployment(CreateDeploymentRequest createDeploymentRequest)	Deploys an application revision through the specified deployment group.
default CompletableFuture<CreateDeploymentConfigResponse>	createDeploymentConfig(CreateDeploymentConfigRequest createDeploymentConfigRequest)	Creates a deployment configuration.
default CompletableFuture<CreateDeploymentGroupResponse>	createDeploymentGroup(CreateDeploymentGroupRequest createDeploymentGroupRequest)	Creates a deployment group to which application revisions will be deployed.
default CompletableFuture<DeleteApplicationResponse>	deleteApplication(DeleteApplicationRequest deleteApplicationRequest)	Deletes an application.
default CompletableFuture<DeleteDeploymentConfigResponse>	deleteDeploymentConfig(DeleteDeploymentConfigRequest deleteDeploymentConfigRequest)	Deletes a deployment configuration.
default CompletableFuture<DeleteDeploymentGroupResponse>	deleteDeploymentGroup(DeleteDeploymentGroupRequest deleteDeploymentGroupRequest)	Deletes a deployment group.
default CompletableFuture<DeregisterOnPremisesInstanceResponse>	deregisterOnPremisesInstance(DeregisterOnPremisesInstanceRequest deregisterOnPremisesInstanceRequest)	Deregisters an on-premises instance.
default CompletableFuture<GetApplicationResponse>	getApplication(GetApplicationRequest getApplicationRequest)	Gets information about an application.
default CompletableFuture<GetApplicationRevisionResponse>	getApplicationRevision(GetApplicationRevisionRequest getApplicationRevisionRequest)	Gets information about an application revision.
default CompletableFuture<GetDeploymentResponse>	getDeployment(GetDeploymentRequest getDeploymentRequest)	Gets information about a deployment.
default CompletableFuture<GetDeploymentConfigResponse>	getDeploymentConfig(GetDeploymentConfigRequest getDeploymentConfigRequest)	Gets information about a deployment configuration.
default CompletableFuture<GetDeploymentGroupResponse>	getDeploymentGroup(GetDeploymentGroupRequest getDeploymentGroupRequest)	Gets information about a deployment group.
default CompletableFuture<GetDeploymentInstanceResponse>	getDeploymentInstance(GetDeploymentInstanceRequest getDeploymentInstanceRequest)	Gets information about an instance as part of a deployment.
default CompletableFuture<GetOnPremisesInstanceResponse>	getOnPremisesInstance(GetOnPremisesInstanceRequest getOnPremisesInstanceRequest)	Gets information about an on-premises instance.
default CompletableFuture<ListApplicationRevisionsResponse>	listApplicationRevisions(ListApplicationRevisionsRequest listApplicationRevisionsRequest)	Lists information about revisions for an application.
default CompletableFuture<ListApplicationsResponse>	listApplications(ListApplicationsRequest listApplicationsRequest)	Lists the applications registered with the applicable IAM user or AWS account.
default CompletableFuture<ListDeploymentConfigsResponse>	listDeploymentConfigs(ListDeploymentConfigsRequest listDeploymentConfigsRequest)	Lists the deployment configurations with the applicable IAM user or AWS account.
default CompletableFuture<ListDeploymentGroupsResponse>	listDeploymentGroups(ListDeploymentGroupsRequest listDeploymentGroupsRequest)	Lists the deployment groups for an application registered with the applicable IAM user or AWS account.
default CompletableFuture<ListDeploymentInstancesResponse>	listDeploymentInstances(ListDeploymentInstancesRequest listDeploymentInstancesRequest)	Lists the instance for a deployment associated with the applicable IAM user or AWS account.
default CompletableFuture<ListDeploymentsResponse>	listDeployments(ListDeploymentsRequest listDeploymentsRequest)	Lists the deployments in a deployment group for an application registered with the applicable IAM user or AWS account.
default CompletableFuture<ListGitHubAccountTokenNamesResponse>	listGitHubAccountTokenNames(ListGitHubAccountTokenNamesRequest listGitHubAccountTokenNamesRequest)	Lists the names of stored connections to GitHub accounts.
default CompletableFuture<ListOnPremisesInstancesResponse>	listOnPremisesInstances(ListOnPremisesInstancesRequest listOnPremisesInstancesRequest)	Gets a list of names for one or more on-premises instances.
default CompletableFuture<RegisterApplicationRevisionResponse>	registerApplicationRevision(RegisterApplicationRevisionRequest registerApplicationRevisionRequest)	Registers with AWS CodeDeploy a revision for the specified application.
default CompletableFuture<RegisterOnPremisesInstanceResponse>	registerOnPremisesInstance(RegisterOnPremisesInstanceRequest registerOnPremisesInstanceRequest)	Registers an on-premises instance.
default CompletableFuture<RemoveTagsFromOnPremisesInstancesResponse>	removeTagsFromOnPremisesInstances(RemoveTagsFromOnPremisesInstancesRequest removeTagsFromOnPremisesInstancesRequest)	Removes one or more tags from one or more on-premises instances.
default CompletableFuture<SkipWaitTimeForInstanceTerminationResponse>	skipWaitTimeForInstanceTermination(SkipWaitTimeForInstanceTerminationRequest skipWaitTimeForInstanceTerminationRequest)	In a blue/green deployment, overrides any specified wait time and starts terminating instances immediately after the traffic routing is completed.
default CompletableFuture<StopDeploymentResponse>	stopDeployment(StopDeploymentRequest stopDeploymentRequest)	Attempts to stop an ongoing deployment.
default CompletableFuture<UpdateApplicationResponse>	updateApplication(UpdateApplicationRequest updateApplicationRequest)	Changes the name of an application.
default CompletableFuture<UpdateDeploymentGroupResponse>	updateDeploymentGroup(UpdateDeploymentGroupRequest updateDeploymentGroupRequest)	Changes information about a deployment group.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

create

static CodeDeployAsyncClient create()

Create a CodeDeployAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static CodeDeployAsyncClientBuilder builder()

Create a builder that can be used to configure and create a CodeDeployAsyncClient.

addTagsToOnPremisesInstances

default CompletableFuture<AddTagsToOnPremisesInstancesResponse> addTagsToOnPremisesInstances(AddTagsToOnPremisesInstancesRequest addTagsToOnPremisesInstancesRequest)

Adds tags to on-premises instances.

Parameters:

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

Returns:

A Java Future containing the result of the AddTagsToOnPremisesInstances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InstanceNameRequiredException An on-premises instance name was not specified.
• TagRequiredException A tag was not specified.
• InvalidTagException The specified tag was specified in an invalid format.
• TagLimitExceededException The maximum allowed number of tags was exceeded.
• InstanceLimitExceededException The maximum number of allowed on-premises instances in a single call was exceeded.
• InstanceNotRegisteredException The specified on-premises instance is not registered.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

batchGetApplicationRevisions

default CompletableFuture<BatchGetApplicationRevisionsResponse> batchGetApplicationRevisions(BatchGetApplicationRevisionsRequest batchGetApplicationRevisionsRequest)

Gets information about one or more application revisions.

Parameters:

batchGetApplicationRevisionsRequest - Represents the input of a BatchGetApplicationRevisions operation.

Returns:

A Java Future containing the result of the BatchGetApplicationRevisions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ApplicationDoesNotExistException The application does not exist with the applicable IAM user or AWS account.
• ApplicationNameRequiredException The minimum number of required application names was not specified.
• InvalidApplicationNameException The application name was specified in an invalid format.
• RevisionRequiredException The revision ID was not specified.
• InvalidRevisionException The revision was specified in an invalid format.
• BatchLimitExceededException The maximum number of names or IDs allowed for this request (100) was exceeded.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

batchGetApplications

default CompletableFuture<BatchGetApplicationsResponse> batchGetApplications(BatchGetApplicationsRequest batchGetApplicationsRequest)

Gets information about one or more applications.

Parameters:

batchGetApplicationsRequest - Represents the input of a BatchGetApplications operation.

Returns:

A Java Future containing the result of the BatchGetApplications operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ApplicationNameRequiredException The minimum number of required application names was not specified.
• InvalidApplicationNameException The application name was specified in an invalid format.
• ApplicationDoesNotExistException The application does not exist with the applicable IAM user or AWS account.
• BatchLimitExceededException The maximum number of names or IDs allowed for this request (100) was exceeded.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

batchGetDeploymentGroups

default CompletableFuture<BatchGetDeploymentGroupsResponse> batchGetDeploymentGroups(BatchGetDeploymentGroupsRequest batchGetDeploymentGroupsRequest)

Gets information about one or more deployment groups.

Parameters:

batchGetDeploymentGroupsRequest - Represents the input of a BatchGetDeploymentGroups operation.

Returns:

A Java Future containing the result of the BatchGetDeploymentGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ApplicationNameRequiredException The minimum number of required application names was not specified.
• InvalidApplicationNameException The application name was specified in an invalid format.
• ApplicationDoesNotExistException The application does not exist with the applicable IAM user or AWS account.
• DeploymentGroupNameRequiredException The deployment group name was not specified.
• InvalidDeploymentGroupNameException The deployment group name was specified in an invalid format.
• BatchLimitExceededException The maximum number of names or IDs allowed for this request (100) was exceeded.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

batchGetDeploymentInstances

default CompletableFuture<BatchGetDeploymentInstancesResponse> batchGetDeploymentInstances(BatchGetDeploymentInstancesRequest batchGetDeploymentInstancesRequest)

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

Parameters:

batchGetDeploymentInstancesRequest - Represents the input of a BatchGetDeploymentInstances operation.

Returns:

A Java Future containing the result of the BatchGetDeploymentInstances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• DeploymentIdRequiredException At least one deployment ID must be specified.
• DeploymentDoesNotExistException The deployment does not exist with the applicable IAM user or AWS account.
• InstanceIdRequiredException The instance ID was not specified.
• InvalidDeploymentIdException At least one of the deployment IDs was specified in an invalid format.
• InvalidInstanceNameException The specified on-premises instance name was specified in an invalid format.
• BatchLimitExceededException The maximum number of names or IDs allowed for this request (100) was exceeded.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

batchGetDeployments

default CompletableFuture<BatchGetDeploymentsResponse> batchGetDeployments(BatchGetDeploymentsRequest batchGetDeploymentsRequest)

Gets information about one or more deployments.

Parameters:

batchGetDeploymentsRequest - Represents the input of a BatchGetDeployments operation.

Returns:

A Java Future containing the result of the BatchGetDeployments operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• DeploymentIdRequiredException At least one deployment ID must be specified.
• InvalidDeploymentIdException At least one of the deployment IDs was specified in an invalid format.
• BatchLimitExceededException The maximum number of names or IDs allowed for this request (100) was exceeded.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

batchGetOnPremisesInstances

default CompletableFuture<BatchGetOnPremisesInstancesResponse> batchGetOnPremisesInstances(BatchGetOnPremisesInstancesRequest batchGetOnPremisesInstancesRequest)

Gets information about one or more on-premises instances.

Parameters:

batchGetOnPremisesInstancesRequest - Represents the input of a BatchGetOnPremisesInstances operation.

Returns:

A Java Future containing the result of the BatchGetOnPremisesInstances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InstanceNameRequiredException An on-premises instance name was not specified.
• InvalidInstanceNameException The specified on-premises instance name was specified in an invalid format.
• BatchLimitExceededException The maximum number of names or IDs allowed for this request (100) was exceeded.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

continueDeployment

default CompletableFuture<ContinueDeploymentResponse> continueDeployment(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.)

Parameters:

continueDeploymentRequest -

Returns:

A Java Future containing the result of the ContinueDeployment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• DeploymentIdRequiredException At least one deployment ID must be specified.
• DeploymentDoesNotExistException The deployment does not exist with the applicable IAM user or AWS account.
• DeploymentAlreadyCompletedException The deployment is already complete.
• InvalidDeploymentIdException At least one of the deployment IDs was specified in an invalid format.
• DeploymentIsNotInReadyStateException The deployment does not have a status of Ready and can't continue yet.
• UnsupportedActionForDeploymentTypeException A call was submitted that is not supported for the specified deployment type.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

createApplication

default CompletableFuture<CreateApplicationResponse> createApplication(CreateApplicationRequest createApplicationRequest)

Creates an application.

Parameters:

createApplicationRequest - Represents the input of a CreateApplication operation.

Returns:

A Java Future containing the result of the CreateApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ApplicationNameRequiredException The minimum number of required application names was not specified.
• InvalidApplicationNameException The application name was specified in an invalid format.
• ApplicationAlreadyExistsException An application with the specified name already exists with the applicable IAM user or AWS account.
• ApplicationLimitExceededException More applications were attempted to be created than are allowed.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

createDeployment

default CompletableFuture<CreateDeploymentResponse> createDeployment(CreateDeploymentRequest createDeploymentRequest)

Deploys an application revision through the specified deployment group.

Parameters:

createDeploymentRequest - Represents the input of a CreateDeployment operation.

Returns:

A Java Future containing the result of the CreateDeployment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ApplicationNameRequiredException The minimum number of required application names was not specified.
• InvalidApplicationNameException The application name was specified in an invalid format.
• ApplicationDoesNotExistException The application does not exist with the applicable IAM user or AWS account.
• DeploymentGroupNameRequiredException The deployment group name was not specified.
• InvalidDeploymentGroupNameException The deployment group name was specified in an invalid format.
• DeploymentGroupDoesNotExistException The named deployment group does not exist with the applicable IAM user or AWS account.
• RevisionRequiredException The revision ID was not specified.
• RevisionDoesNotExistException The named revision does not exist with the applicable IAM user or AWS account.
• InvalidRevisionException The revision was specified in an invalid format.
• InvalidDeploymentConfigNameException The deployment configuration name was specified in an invalid format.
• DeploymentConfigDoesNotExistException The deployment configuration does not exist with the applicable IAM user or AWS account.
• DescriptionTooLongException The description is too long.
• DeploymentLimitExceededException The number of allowed deployments was exceeded.
• InvalidTargetInstancesException The target instance configuration is invalid. Possible causes include:

  • Configuration data for target instances was entered for an in-place deployment.

  • The limit of 10 tags for a tag type was exceeded.

  • The combined length of the tag names exceeded the limit.

  • A specified tag is not currently applied to any instances.

  • InvalidAutoRollbackConfigException The automatic rollback configuration was specified in an invalid format. For example, automatic rollback is enabled but an invalid triggering event type or no event types were listed.
  • InvalidLoadBalancerInfoException An invalid load balancer name, or no load balancer name, was specified.
  • InvalidFileExistsBehaviorException An invalid fileExistsBehavior option was specified to determine how AWS CodeDeploy handles files or directories that already exist in a deployment target location but weren't part of the previous successful deployment. Valid values include "DISALLOW", "OVERWRITE", and "RETAIN".
  • SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
  • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
  • CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

createDeploymentConfig

default CompletableFuture<CreateDeploymentConfigResponse> createDeploymentConfig(CreateDeploymentConfigRequest createDeploymentConfigRequest)

Creates a deployment configuration.

Parameters:

createDeploymentConfigRequest - Represents the input of a CreateDeploymentConfig operation.

Returns:

A Java Future containing the result of the CreateDeploymentConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidDeploymentConfigNameException The deployment configuration name was specified in an invalid format.
• DeploymentConfigNameRequiredException The deployment configuration name was not specified.
• DeploymentConfigAlreadyExistsException A deployment configuration with the specified name already exists with the applicable IAM user or AWS account.
• InvalidMinimumHealthyHostValueException The minimum healthy instance value was specified in an invalid format.
• DeploymentConfigLimitExceededException The deployment configurations limit was exceeded.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

createDeploymentGroup

default CompletableFuture<CreateDeploymentGroupResponse> createDeploymentGroup(CreateDeploymentGroupRequest createDeploymentGroupRequest)

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

Parameters:

createDeploymentGroupRequest - Represents the input of a CreateDeploymentGroup operation.

Returns:

A Java Future containing the result of the CreateDeploymentGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ApplicationNameRequiredException The minimum number of required application names was not specified.
• InvalidApplicationNameException The application name was specified in an invalid format.
• ApplicationDoesNotExistException The application does not exist with the applicable IAM user or AWS account.
• DeploymentGroupNameRequiredException The deployment group name was not specified.
• InvalidDeploymentGroupNameException The deployment group name was specified in an invalid format.
• DeploymentGroupAlreadyExistsException A deployment group with the specified name already exists with the applicable IAM user or AWS account.
• InvalidEC2TagException The tag was specified in an invalid format.
• InvalidTagException The specified tag was specified in an invalid format.
• InvalidAutoScalingGroupException The Auto Scaling group was specified in an invalid format or does not exist.
• InvalidDeploymentConfigNameException The deployment configuration name was specified in an invalid format.
• DeploymentConfigDoesNotExistException The deployment configuration does not exist with the applicable IAM user or AWS account.
• RoleRequiredException The role ID was not specified.
• InvalidRoleException The service role ARN was specified in an invalid format. Or, if an Auto Scaling group was specified, the specified service role does not grant the appropriate permissions to Auto Scaling.
• DeploymentGroupLimitExceededException The deployment groups limit was exceeded.
• LifecycleHookLimitExceededException The limit for lifecycle hooks was exceeded.
• InvalidTriggerConfigException The trigger was specified in an invalid format.
• TriggerTargetsLimitExceededException The maximum allowed number of triggers was exceeded.
• InvalidAlarmConfigException The format of the alarm configuration is invalid. Possible causes include:

  • The alarm list is null.

  • The alarm object is null.

  • The alarm name is empty or null or exceeds the 255 character limit.

  • Two alarms with the same name have been specified.

  • The alarm configuration is enabled but the alarm list is empty.

  • AlarmsLimitExceededException The maximum number of alarms for a deployment group (10) was exceeded.
  • InvalidAutoRollbackConfigException The automatic rollback configuration was specified in an invalid format. For example, automatic rollback is enabled but an invalid triggering event type or no event types were listed.
  • InvalidLoadBalancerInfoException An invalid load balancer name, or no load balancer name, was specified.
  • InvalidDeploymentStyleException An invalid deployment style was specified. Valid deployment types include "IN_PLACE" and "BLUE_GREEN". Valid deployment options include "WITH_TRAFFIC_CONTROL" and "WITHOUT_TRAFFIC_CONTROL".
  • InvalidBlueGreenDeploymentConfigurationException The configuration for the blue/green deployment group was provided in an invalid format. For information about deployment configuration format, see CreateDeploymentConfig.
  • SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
  • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
  • CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

deleteApplication

default CompletableFuture<DeleteApplicationResponse> deleteApplication(DeleteApplicationRequest deleteApplicationRequest)

Deletes an application.

Parameters:

deleteApplicationRequest - Represents the input of a DeleteApplication operation.

Returns:

A Java Future containing the result of the DeleteApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ApplicationNameRequiredException The minimum number of required application names was not specified.
• InvalidApplicationNameException The application name was specified in an invalid format.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

deleteDeploymentConfig

default CompletableFuture<DeleteDeploymentConfigResponse> deleteDeploymentConfig(DeleteDeploymentConfigRequest deleteDeploymentConfigRequest)

Deletes a deployment configuration.

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

Parameters:

deleteDeploymentConfigRequest - Represents the input of a DeleteDeploymentConfig operation.

Returns:

A Java Future containing the result of the DeleteDeploymentConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidDeploymentConfigNameException The deployment configuration name was specified in an invalid format.
• DeploymentConfigNameRequiredException The deployment configuration name was not specified.
• DeploymentConfigInUseException The deployment configuration is still in use.
• InvalidOperationException An invalid operation was detected.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

deleteDeploymentGroup

default CompletableFuture<DeleteDeploymentGroupResponse> deleteDeploymentGroup(DeleteDeploymentGroupRequest deleteDeploymentGroupRequest)

Deletes a deployment group.

Parameters:

deleteDeploymentGroupRequest - Represents the input of a DeleteDeploymentGroup operation.

Returns:

A Java Future containing the result of the DeleteDeploymentGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ApplicationNameRequiredException The minimum number of required application names was not specified.
• InvalidApplicationNameException The application name was specified in an invalid format.
• DeploymentGroupNameRequiredException The deployment group name was not specified.
• InvalidDeploymentGroupNameException The deployment group name was specified in an invalid format.
• InvalidRoleException The service role ARN was specified in an invalid format. Or, if an Auto Scaling group was specified, the specified service role does not grant the appropriate permissions to Auto Scaling.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

deregisterOnPremisesInstance

default CompletableFuture<DeregisterOnPremisesInstanceResponse> deregisterOnPremisesInstance(DeregisterOnPremisesInstanceRequest deregisterOnPremisesInstanceRequest)

Deregisters an on-premises instance.

Parameters:

deregisterOnPremisesInstanceRequest - Represents the input of a DeregisterOnPremisesInstance operation.

Returns:

A Java Future containing the result of the DeregisterOnPremisesInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InstanceNameRequiredException An on-premises instance name was not specified.
• InvalidInstanceNameException The specified on-premises instance name was specified in an invalid format.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

getApplication

default CompletableFuture<GetApplicationResponse> getApplication(GetApplicationRequest getApplicationRequest)

Gets information about an application.

Parameters:

getApplicationRequest - Represents the input of a GetApplication operation.

Returns:

A Java Future containing the result of the GetApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ApplicationNameRequiredException The minimum number of required application names was not specified.
• InvalidApplicationNameException The application name was specified in an invalid format.
• ApplicationDoesNotExistException The application does not exist with the applicable IAM user or AWS account.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

getApplicationRevision

default CompletableFuture<GetApplicationRevisionResponse> getApplicationRevision(GetApplicationRevisionRequest getApplicationRevisionRequest)

Gets information about an application revision.

Parameters:

getApplicationRevisionRequest - Represents the input of a GetApplicationRevision operation.

Returns:

A Java Future containing the result of the GetApplicationRevision operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ApplicationDoesNotExistException The application does not exist with the applicable IAM user or AWS account.
• ApplicationNameRequiredException The minimum number of required application names was not specified.
• InvalidApplicationNameException The application name was specified in an invalid format.
• RevisionDoesNotExistException The named revision does not exist with the applicable IAM user or AWS account.
• RevisionRequiredException The revision ID was not specified.
• InvalidRevisionException The revision was specified in an invalid format.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

getDeployment

default CompletableFuture<GetDeploymentResponse> getDeployment(GetDeploymentRequest getDeploymentRequest)

Gets information about a deployment.

Parameters:

getDeploymentRequest - Represents the input of a GetDeployment operation.

Returns:

A Java Future containing the result of the GetDeployment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• DeploymentIdRequiredException At least one deployment ID must be specified.
• InvalidDeploymentIdException At least one of the deployment IDs was specified in an invalid format.
• DeploymentDoesNotExistException The deployment does not exist with the applicable IAM user or AWS account.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

getDeploymentConfig

default CompletableFuture<GetDeploymentConfigResponse> getDeploymentConfig(GetDeploymentConfigRequest getDeploymentConfigRequest)

Gets information about a deployment configuration.

Parameters:

getDeploymentConfigRequest - Represents the input of a GetDeploymentConfig operation.

Returns:

A Java Future containing the result of the GetDeploymentConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidDeploymentConfigNameException The deployment configuration name was specified in an invalid format.
• DeploymentConfigNameRequiredException The deployment configuration name was not specified.
• DeploymentConfigDoesNotExistException The deployment configuration does not exist with the applicable IAM user or AWS account.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

getDeploymentGroup

default CompletableFuture<GetDeploymentGroupResponse> getDeploymentGroup(GetDeploymentGroupRequest getDeploymentGroupRequest)

Gets information about a deployment group.

Parameters:

getDeploymentGroupRequest - Represents the input of a GetDeploymentGroup operation.

Returns:

A Java Future containing the result of the GetDeploymentGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ApplicationNameRequiredException The minimum number of required application names was not specified.
• InvalidApplicationNameException The application name was specified in an invalid format.
• ApplicationDoesNotExistException The application does not exist with the applicable IAM user or AWS account.
• DeploymentGroupNameRequiredException The deployment group name was not specified.
• InvalidDeploymentGroupNameException The deployment group name was specified in an invalid format.
• DeploymentGroupDoesNotExistException The named deployment group does not exist with the applicable IAM user or AWS account.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

getDeploymentInstance

default CompletableFuture<GetDeploymentInstanceResponse> getDeploymentInstance(GetDeploymentInstanceRequest getDeploymentInstanceRequest)

Gets information about an instance as part of a deployment.

Parameters:

getDeploymentInstanceRequest - Represents the input of a GetDeploymentInstance operation.

Returns:

A Java Future containing the result of the GetDeploymentInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• DeploymentIdRequiredException At least one deployment ID must be specified.
• DeploymentDoesNotExistException The deployment does not exist with the applicable IAM user or AWS account.
• InstanceIdRequiredException The instance ID was not specified.
• InvalidDeploymentIdException At least one of the deployment IDs was specified in an invalid format.
• InstanceDoesNotExistException The specified instance does not exist in the deployment group.
• InvalidInstanceNameException The specified on-premises instance name was specified in an invalid format.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

getOnPremisesInstance

default CompletableFuture<GetOnPremisesInstanceResponse> getOnPremisesInstance(GetOnPremisesInstanceRequest getOnPremisesInstanceRequest)

Gets information about an on-premises instance.

Parameters:

getOnPremisesInstanceRequest - Represents the input of a GetOnPremisesInstance operation.

Returns:

A Java Future containing the result of the GetOnPremisesInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InstanceNameRequiredException An on-premises instance name was not specified.
• InstanceNotRegisteredException The specified on-premises instance is not registered.
• InvalidInstanceNameException The specified on-premises instance name was specified in an invalid format.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listApplicationRevisions

default CompletableFuture<ListApplicationRevisionsResponse> listApplicationRevisions(ListApplicationRevisionsRequest listApplicationRevisionsRequest)

Lists information about revisions for an application.

Parameters:

listApplicationRevisionsRequest - Represents the input of a ListApplicationRevisions operation.

Returns:

A Java Future containing the result of the ListApplicationRevisions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ApplicationDoesNotExistException The application does not exist with the applicable IAM user or AWS account.
• ApplicationNameRequiredException The minimum number of required application names was not specified.
• InvalidApplicationNameException The application name was specified in an invalid format.
• InvalidSortByException The column name to sort by is either not present or was specified in an invalid format.
• InvalidSortOrderException The sort order was specified in an invalid format.
• InvalidBucketNameFilterException The bucket name either doesn't exist or was specified in an invalid format.
• InvalidKeyPrefixFilterException The specified key prefix filter was specified in an invalid format.
• BucketNameFilterRequiredException A bucket name is required, but was not provided.
• InvalidDeployedStateFilterException The deployed state filter was specified in an invalid format.
• InvalidNextTokenException The next token was specified in an invalid format.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listApplications

default CompletableFuture<ListApplicationsResponse> listApplications(ListApplicationsRequest listApplicationsRequest)

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

Parameters:

listApplicationsRequest - Represents the input of a ListApplications operation.

Returns:

A Java Future containing the result of the ListApplications operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidNextTokenException The next token was specified in an invalid format.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listDeploymentConfigs

default CompletableFuture<ListDeploymentConfigsResponse> listDeploymentConfigs(ListDeploymentConfigsRequest listDeploymentConfigsRequest)

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

Parameters:

listDeploymentConfigsRequest - Represents the input of a ListDeploymentConfigs operation.

Returns:

A Java Future containing the result of the ListDeploymentConfigs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidNextTokenException The next token was specified in an invalid format.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listDeploymentGroups

default CompletableFuture<ListDeploymentGroupsResponse> listDeploymentGroups(ListDeploymentGroupsRequest listDeploymentGroupsRequest)

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

Parameters:

listDeploymentGroupsRequest - Represents the input of a ListDeploymentGroups operation.

Returns:

A Java Future containing the result of the ListDeploymentGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ApplicationNameRequiredException The minimum number of required application names was not specified.
• InvalidApplicationNameException The application name was specified in an invalid format.
• ApplicationDoesNotExistException The application does not exist with the applicable IAM user or AWS account.
• InvalidNextTokenException The next token was specified in an invalid format.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listDeploymentInstances

default CompletableFuture<ListDeploymentInstancesResponse> listDeploymentInstances(ListDeploymentInstancesRequest listDeploymentInstancesRequest)

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

Parameters:

listDeploymentInstancesRequest - Represents the input of a ListDeploymentInstances operation.

Returns:

A Java Future containing the result of the ListDeploymentInstances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• DeploymentIdRequiredException At least one deployment ID must be specified.
• DeploymentDoesNotExistException The deployment does not exist with the applicable IAM user or AWS account.
• DeploymentNotStartedException The specified deployment has not started.
• InvalidNextTokenException The next token was specified in an invalid format.
• InvalidDeploymentIdException At least one of the deployment IDs was specified in an invalid format.
• InvalidInstanceStatusException The specified instance status does not exist.
• InvalidInstanceTypeException An invalid instance type was specified for instances in a blue/green deployment. Valid values include "Blue" for an original environment and "Green" for a replacement environment.
• InvalidDeploymentInstanceTypeException An instance type was specified for an in-place deployment. Instance types are supported for blue/green deployments only.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listDeployments

default CompletableFuture<ListDeploymentsResponse> listDeployments(ListDeploymentsRequest listDeploymentsRequest)

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

Parameters:

listDeploymentsRequest - Represents the input of a ListDeployments operation.

Returns:

A Java Future containing the result of the ListDeployments operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ApplicationNameRequiredException The minimum number of required application names was not specified.
• InvalidApplicationNameException The application name was specified in an invalid format.
• ApplicationDoesNotExistException The application does not exist with the applicable IAM user or AWS account.
• InvalidDeploymentGroupNameException The deployment group name was specified in an invalid format.
• DeploymentGroupDoesNotExistException The named deployment group does not exist with the applicable IAM user or AWS account.
• DeploymentGroupNameRequiredException The deployment group name was not specified.
• InvalidTimeRangeException The specified time range was specified in an invalid format.
• InvalidDeploymentStatusException The specified deployment status doesn't exist or cannot be determined.
• InvalidNextTokenException The next token was specified in an invalid format.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listGitHubAccountTokenNames

default CompletableFuture<ListGitHubAccountTokenNamesResponse> listGitHubAccountTokenNames(ListGitHubAccountTokenNamesRequest listGitHubAccountTokenNamesRequest)

Lists the names of stored connections to GitHub accounts.

Parameters:

listGitHubAccountTokenNamesRequest - Represents the input of a ListGitHubAccountTokenNames operation.

Returns:

A Java Future containing the result of the ListGitHubAccountTokenNames operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidNextTokenException The next token was specified in an invalid format.
• ResourceValidationException The specified resource could not be validated.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listOnPremisesInstances

default CompletableFuture<ListOnPremisesInstancesResponse> listOnPremisesInstances(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 will be listed. To list only registered or deregistered on-premises instance names, use the registration status parameter.

Parameters:

listOnPremisesInstancesRequest - Represents the input of a ListOnPremisesInstances operation.

Returns:

A Java Future containing the result of the ListOnPremisesInstances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidRegistrationStatusException The registration status was specified in an invalid format.
• InvalidTagFilterException The specified tag filter was specified in an invalid format.
• InvalidNextTokenException The next token was specified in an invalid format.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

registerApplicationRevision

default CompletableFuture<RegisterApplicationRevisionResponse> registerApplicationRevision(RegisterApplicationRevisionRequest registerApplicationRevisionRequest)

Registers with AWS CodeDeploy a revision for the specified application.

Parameters:

registerApplicationRevisionRequest - Represents the input of a RegisterApplicationRevision operation.

Returns:

A Java Future containing the result of the RegisterApplicationRevision operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ApplicationDoesNotExistException The application does not exist with the applicable IAM user or AWS account.
• ApplicationNameRequiredException The minimum number of required application names was not specified.
• InvalidApplicationNameException The application name was specified in an invalid format.
• DescriptionTooLongException The description is too long.
• RevisionRequiredException The revision ID was not specified.
• InvalidRevisionException The revision was specified in an invalid format.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

registerOnPremisesInstance

default CompletableFuture<RegisterOnPremisesInstanceResponse> registerOnPremisesInstance(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.

Parameters:

registerOnPremisesInstanceRequest - Represents the input of the register on-premises instance operation.

Returns:

A Java Future containing the result of the RegisterOnPremisesInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InstanceNameAlreadyRegisteredException The specified on-premises instance name is already registered.
• IamArnRequiredException No IAM ARN was included in the request. You must use an IAM session ARN or IAM user ARN in the request.
• IamSessionArnAlreadyRegisteredException The request included an IAM session ARN that has already been used to register a different instance.
• IamUserArnAlreadyRegisteredException The specified IAM user ARN is already registered with an on-premises instance.
• InstanceNameRequiredException An on-premises instance name was not specified.
• IamUserArnRequiredException An IAM user ARN was not specified.
• InvalidInstanceNameException The specified on-premises instance name was specified in an invalid format.
• InvalidIamSessionArnException The IAM session ARN was specified in an invalid format.
• InvalidIamUserArnException The IAM user ARN was specified in an invalid format.
• MultipleIamArnsProvidedException Both an IAM user ARN and an IAM session ARN were included in the request. Use only one ARN type.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

removeTagsFromOnPremisesInstances

default CompletableFuture<RemoveTagsFromOnPremisesInstancesResponse> removeTagsFromOnPremisesInstances(RemoveTagsFromOnPremisesInstancesRequest removeTagsFromOnPremisesInstancesRequest)

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

Parameters:

removeTagsFromOnPremisesInstancesRequest - Represents the input of a RemoveTagsFromOnPremisesInstances operation.

Returns:

A Java Future containing the result of the RemoveTagsFromOnPremisesInstances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InstanceNameRequiredException An on-premises instance name was not specified.
• TagRequiredException A tag was not specified.
• InvalidTagException The specified tag was specified in an invalid format.
• TagLimitExceededException The maximum allowed number of tags was exceeded.
• InstanceLimitExceededException The maximum number of allowed on-premises instances in a single call was exceeded.
• InstanceNotRegisteredException The specified on-premises instance is not registered.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

skipWaitTimeForInstanceTermination

default CompletableFuture<SkipWaitTimeForInstanceTerminationResponse> skipWaitTimeForInstanceTermination(SkipWaitTimeForInstanceTerminationRequest skipWaitTimeForInstanceTerminationRequest)

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

Parameters:

skipWaitTimeForInstanceTerminationRequest -

Returns:

A Java Future containing the result of the SkipWaitTimeForInstanceTermination operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• DeploymentIdRequiredException At least one deployment ID must be specified.
• DeploymentDoesNotExistException The deployment does not exist with the applicable IAM user or AWS account.
• DeploymentAlreadyCompletedException The deployment is already complete.
• InvalidDeploymentIdException At least one of the deployment IDs was specified in an invalid format.
• DeploymentNotStartedException The specified deployment has not started.
• UnsupportedActionForDeploymentTypeException A call was submitted that is not supported for the specified deployment type.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

stopDeployment

default CompletableFuture<StopDeploymentResponse> stopDeployment(StopDeploymentRequest stopDeploymentRequest)

Attempts to stop an ongoing deployment.

Parameters:

stopDeploymentRequest - Represents the input of a StopDeployment operation.

Returns:

A Java Future containing the result of the StopDeployment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• DeploymentIdRequiredException At least one deployment ID must be specified.
• DeploymentDoesNotExistException The deployment does not exist with the applicable IAM user or AWS account.
• DeploymentAlreadyCompletedException The deployment is already complete.
• InvalidDeploymentIdException At least one of the deployment IDs was specified in an invalid format.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

updateApplication

default CompletableFuture<UpdateApplicationResponse> updateApplication(UpdateApplicationRequest updateApplicationRequest)

Changes the name of an application.

Parameters:

updateApplicationRequest - Represents the input of an UpdateApplication operation.

Returns:

A Java Future containing the result of the UpdateApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ApplicationNameRequiredException The minimum number of required application names was not specified.
• InvalidApplicationNameException The application name was specified in an invalid format.
• ApplicationAlreadyExistsException An application with the specified name already exists with the applicable IAM user or AWS account.
• ApplicationDoesNotExistException The application does not exist with the applicable IAM user or AWS account.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

updateDeploymentGroup

default CompletableFuture<UpdateDeploymentGroupResponse> updateDeploymentGroup(UpdateDeploymentGroupRequest updateDeploymentGroupRequest)

Changes information about a deployment group.

Parameters:

updateDeploymentGroupRequest - Represents the input of an UpdateDeploymentGroup operation.

Returns:

A Java Future containing the result of the UpdateDeploymentGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ApplicationNameRequiredException The minimum number of required application names was not specified.
• InvalidApplicationNameException The application name was specified in an invalid format.
• ApplicationDoesNotExistException The application does not exist with the applicable IAM user or AWS account.
• InvalidDeploymentGroupNameException The deployment group name was specified in an invalid format.
• DeploymentGroupAlreadyExistsException A deployment group with the specified name already exists with the applicable IAM user or AWS account.
• DeploymentGroupNameRequiredException The deployment group name was not specified.
• DeploymentGroupDoesNotExistException The named deployment group does not exist with the applicable IAM user or AWS account.
• InvalidEC2TagException The tag was specified in an invalid format.
• InvalidTagException The specified tag was specified in an invalid format.
• InvalidAutoScalingGroupException The Auto Scaling group was specified in an invalid format or does not exist.
• InvalidDeploymentConfigNameException The deployment configuration name was specified in an invalid format.
• DeploymentConfigDoesNotExistException The deployment configuration does not exist with the applicable IAM user or AWS account.
• InvalidRoleException The service role ARN was specified in an invalid format. Or, if an Auto Scaling group was specified, the specified service role does not grant the appropriate permissions to Auto Scaling.
• LifecycleHookLimitExceededException The limit for lifecycle hooks was exceeded.
• InvalidTriggerConfigException The trigger was specified in an invalid format.
• TriggerTargetsLimitExceededException The maximum allowed number of triggers was exceeded.
• InvalidAlarmConfigException The format of the alarm configuration is invalid. Possible causes include:

  • The alarm list is null.

  • The alarm object is null.

  • The alarm name is empty or null or exceeds the 255 character limit.

  • Two alarms with the same name have been specified.

  • The alarm configuration is enabled but the alarm list is empty.

  • AlarmsLimitExceededException The maximum number of alarms for a deployment group (10) was exceeded.
  • InvalidAutoRollbackConfigException The automatic rollback configuration was specified in an invalid format. For example, automatic rollback is enabled but an invalid triggering event type or no event types were listed.
  • InvalidLoadBalancerInfoException An invalid load balancer name, or no load balancer name, was specified.
  • InvalidDeploymentStyleException An invalid deployment style was specified. Valid deployment types include "IN_PLACE" and "BLUE_GREEN". Valid deployment options include "WITH_TRAFFIC_CONTROL" and "WITHOUT_TRAFFIC_CONTROL".
  • InvalidBlueGreenDeploymentConfigurationException The configuration for the blue/green deployment group was provided in an invalid format. For information about deployment configuration format, see CreateDeploymentConfig.
  • SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
  • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
  • CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation