AutoCloseable@Generated("software.amazon.awssdk:codegen") public interface CodeDeployClient extends AutoCloseable
builder() method.
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
| Modifier and Type | Field | Description |
|---|---|---|
static String |
SERVICE_NAME |
| Modifier and Type | Method | Description |
|---|---|---|
default AddTagsToOnPremisesInstancesResponse |
addTagsToOnPremisesInstances(AddTagsToOnPremisesInstancesRequest addTagsToOnPremisesInstancesRequest) |
Adds tags to on-premises instances.
|
default BatchGetApplicationRevisionsResponse |
batchGetApplicationRevisions(BatchGetApplicationRevisionsRequest batchGetApplicationRevisionsRequest) |
Gets information about one or more application revisions.
|
default BatchGetApplicationsResponse |
batchGetApplications(BatchGetApplicationsRequest batchGetApplicationsRequest) |
Gets information about one or more applications.
|
default BatchGetDeploymentGroupsResponse |
batchGetDeploymentGroups(BatchGetDeploymentGroupsRequest batchGetDeploymentGroupsRequest) |
Gets information about one or more deployment groups.
|
default BatchGetDeploymentInstancesResponse |
batchGetDeploymentInstances(BatchGetDeploymentInstancesRequest batchGetDeploymentInstancesRequest) |
Gets information about one or more instance that are part of a deployment group.
|
default BatchGetDeploymentsResponse |
batchGetDeployments(BatchGetDeploymentsRequest batchGetDeploymentsRequest) |
Gets information about one or more deployments.
|
default BatchGetOnPremisesInstancesResponse |
batchGetOnPremisesInstances(BatchGetOnPremisesInstancesRequest batchGetOnPremisesInstancesRequest) |
Gets information about one or more on-premises instances.
|
static CodeDeployClientBuilder |
builder() |
Create a builder that can be used to configure and create a
CodeDeployClient. |
default 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 CodeDeployClient |
create() |
Create a
CodeDeployClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateApplicationResponse |
createApplication(CreateApplicationRequest createApplicationRequest) |
Creates an application.
|
default CreateDeploymentResponse |
createDeployment(CreateDeploymentRequest createDeploymentRequest) |
Deploys an application revision through the specified deployment group.
|
default CreateDeploymentConfigResponse |
createDeploymentConfig(CreateDeploymentConfigRequest createDeploymentConfigRequest) |
Creates a deployment configuration.
|
default CreateDeploymentGroupResponse |
createDeploymentGroup(CreateDeploymentGroupRequest createDeploymentGroupRequest) |
Creates a deployment group to which application revisions will be deployed.
|
default DeleteApplicationResponse |
deleteApplication(DeleteApplicationRequest deleteApplicationRequest) |
Deletes an application.
|
default DeleteDeploymentConfigResponse |
deleteDeploymentConfig(DeleteDeploymentConfigRequest deleteDeploymentConfigRequest) |
Deletes a deployment configuration.
|
default DeleteDeploymentGroupResponse |
deleteDeploymentGroup(DeleteDeploymentGroupRequest deleteDeploymentGroupRequest) |
Deletes a deployment group.
|
default DeregisterOnPremisesInstanceResponse |
deregisterOnPremisesInstance(DeregisterOnPremisesInstanceRequest deregisterOnPremisesInstanceRequest) |
Deregisters an on-premises instance.
|
default GetApplicationResponse |
getApplication(GetApplicationRequest getApplicationRequest) |
Gets information about an application.
|
default GetApplicationRevisionResponse |
getApplicationRevision(GetApplicationRevisionRequest getApplicationRevisionRequest) |
Gets information about an application revision.
|
default GetDeploymentResponse |
getDeployment(GetDeploymentRequest getDeploymentRequest) |
Gets information about a deployment.
|
default GetDeploymentConfigResponse |
getDeploymentConfig(GetDeploymentConfigRequest getDeploymentConfigRequest) |
Gets information about a deployment configuration.
|
default GetDeploymentGroupResponse |
getDeploymentGroup(GetDeploymentGroupRequest getDeploymentGroupRequest) |
Gets information about a deployment group.
|
default GetDeploymentInstanceResponse |
getDeploymentInstance(GetDeploymentInstanceRequest getDeploymentInstanceRequest) |
Gets information about an instance as part of a deployment.
|
default GetOnPremisesInstanceResponse |
getOnPremisesInstance(GetOnPremisesInstanceRequest getOnPremisesInstanceRequest) |
Gets information about an on-premises instance.
|
default ListApplicationRevisionsResponse |
listApplicationRevisions(ListApplicationRevisionsRequest listApplicationRevisionsRequest) |
Lists information about revisions for an application.
|
default ListApplicationsResponse |
listApplications(ListApplicationsRequest listApplicationsRequest) |
Lists the applications registered with the applicable IAM user or AWS account.
|
default ListDeploymentConfigsResponse |
listDeploymentConfigs(ListDeploymentConfigsRequest listDeploymentConfigsRequest) |
Lists the deployment configurations with the applicable IAM user or AWS account.
|
default ListDeploymentGroupsResponse |
listDeploymentGroups(ListDeploymentGroupsRequest listDeploymentGroupsRequest) |
Lists the deployment groups for an application registered with the applicable IAM user or AWS account.
|
default ListDeploymentInstancesResponse |
listDeploymentInstances(ListDeploymentInstancesRequest listDeploymentInstancesRequest) |
Lists the instance for a deployment associated with the applicable IAM user or AWS account.
|
default ListDeploymentsResponse |
listDeployments(ListDeploymentsRequest listDeploymentsRequest) |
Lists the deployments in a deployment group for an application registered with the applicable IAM user or AWS
account.
|
default ListGitHubAccountTokenNamesResponse |
listGitHubAccountTokenNames(ListGitHubAccountTokenNamesRequest listGitHubAccountTokenNamesRequest) |
Lists the names of stored connections to GitHub accounts.
|
default ListOnPremisesInstancesResponse |
listOnPremisesInstances(ListOnPremisesInstancesRequest listOnPremisesInstancesRequest) |
Gets a list of names for one or more on-premises instances.
|
default RegisterApplicationRevisionResponse |
registerApplicationRevision(RegisterApplicationRevisionRequest registerApplicationRevisionRequest) |
Registers with AWS CodeDeploy a revision for the specified application.
|
default RegisterOnPremisesInstanceResponse |
registerOnPremisesInstance(RegisterOnPremisesInstanceRequest registerOnPremisesInstanceRequest) |
Registers an on-premises instance.
|
default RemoveTagsFromOnPremisesInstancesResponse |
removeTagsFromOnPremisesInstances(RemoveTagsFromOnPremisesInstancesRequest removeTagsFromOnPremisesInstancesRequest) |
Removes one or more tags from one or more on-premises instances.
|
static ServiceMetadata |
serviceMetadata() |
|
default 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 StopDeploymentResponse |
stopDeployment(StopDeploymentRequest stopDeploymentRequest) |
Attempts to stop an ongoing deployment.
|
default UpdateApplicationResponse |
updateApplication(UpdateApplicationRequest updateApplicationRequest) |
Changes the name of an application.
|
default UpdateDeploymentGroupResponse |
updateDeploymentGroup(UpdateDeploymentGroupRequest updateDeploymentGroupRequest) |
Changes information about a deployment group.
|
CodeDeployClientWaiters |
waiters() |
closestatic final String SERVICE_NAME
static CodeDeployClient create()
CodeDeployClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static CodeDeployClientBuilder builder()
CodeDeployClient.default AddTagsToOnPremisesInstancesResponse addTagsToOnPremisesInstances(AddTagsToOnPremisesInstancesRequest addTagsToOnPremisesInstancesRequest) throws InstanceNameRequiredException, TagRequiredException, InvalidTagException, TagLimitExceededException, InstanceLimitExceededException, InstanceNotRegisteredException, SdkBaseException, SdkClientException, CodeDeployException
Adds tags to on-premises instances.
addTagsToOnPremisesInstancesRequest - Represents the input of, and adds tags to, an on-premises instance operation.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault BatchGetApplicationRevisionsResponse batchGetApplicationRevisions(BatchGetApplicationRevisionsRequest batchGetApplicationRevisionsRequest) throws ApplicationDoesNotExistException, ApplicationNameRequiredException, InvalidApplicationNameException, RevisionRequiredException, InvalidRevisionException, BatchLimitExceededException, SdkBaseException, SdkClientException, CodeDeployException
Gets information about one or more application revisions.
batchGetApplicationRevisionsRequest - Represents the input of a BatchGetApplicationRevisions operation.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault BatchGetApplicationsResponse batchGetApplications(BatchGetApplicationsRequest batchGetApplicationsRequest) throws ApplicationNameRequiredException, InvalidApplicationNameException, ApplicationDoesNotExistException, BatchLimitExceededException, SdkBaseException, SdkClientException, CodeDeployException
Gets information about one or more applications.
batchGetApplicationsRequest - Represents the input of a BatchGetApplications operation.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault BatchGetDeploymentGroupsResponse batchGetDeploymentGroups(BatchGetDeploymentGroupsRequest batchGetDeploymentGroupsRequest) throws ApplicationNameRequiredException, InvalidApplicationNameException, ApplicationDoesNotExistException, DeploymentGroupNameRequiredException, InvalidDeploymentGroupNameException, BatchLimitExceededException, SdkBaseException, SdkClientException, CodeDeployException
Gets information about one or more deployment groups.
batchGetDeploymentGroupsRequest - Represents the input of a BatchGetDeploymentGroups operation.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault BatchGetDeploymentInstancesResponse batchGetDeploymentInstances(BatchGetDeploymentInstancesRequest batchGetDeploymentInstancesRequest) throws DeploymentIdRequiredException, DeploymentDoesNotExistException, InstanceIdRequiredException, InvalidDeploymentIdException, InvalidInstanceNameException, BatchLimitExceededException, SdkBaseException, SdkClientException, CodeDeployException
Gets information about one or more instance that are part of a deployment group.
batchGetDeploymentInstancesRequest - Represents the input of a BatchGetDeploymentInstances operation.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault BatchGetDeploymentsResponse batchGetDeployments(BatchGetDeploymentsRequest batchGetDeploymentsRequest) throws DeploymentIdRequiredException, InvalidDeploymentIdException, BatchLimitExceededException, SdkBaseException, SdkClientException, CodeDeployException
Gets information about one or more deployments.
batchGetDeploymentsRequest - Represents the input of a BatchGetDeployments operation.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault BatchGetOnPremisesInstancesResponse batchGetOnPremisesInstances(BatchGetOnPremisesInstancesRequest batchGetOnPremisesInstancesRequest) throws InstanceNameRequiredException, InvalidInstanceNameException, BatchLimitExceededException, SdkBaseException, SdkClientException, CodeDeployException
Gets information about one or more on-premises instances.
batchGetOnPremisesInstancesRequest - Represents the input of a BatchGetOnPremisesInstances operation.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ContinueDeploymentResponse continueDeployment(ContinueDeploymentRequest continueDeploymentRequest) throws DeploymentIdRequiredException, DeploymentDoesNotExistException, DeploymentAlreadyCompletedException, InvalidDeploymentIdException, DeploymentIsNotInReadyStateException, UnsupportedActionForDeploymentTypeException, SdkBaseException, SdkClientException, CodeDeployException
For a blue/green deployment, starts the process of rerouting traffic from instances in the original environment to instances in the replacement environment without waiting for a specified wait time to elapse. (Traffic rerouting, which is achieved by registering instances in the replacement environment with the load balancer, can start as soon as all instances have a status of Ready.)
continueDeploymentRequest - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateApplicationResponse createApplication(CreateApplicationRequest createApplicationRequest) throws ApplicationNameRequiredException, InvalidApplicationNameException, ApplicationAlreadyExistsException, ApplicationLimitExceededException, SdkBaseException, SdkClientException, CodeDeployException
Creates an application.
createApplicationRequest - Represents the input of a CreateApplication operation.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateDeploymentResponse createDeployment(CreateDeploymentRequest createDeploymentRequest) throws ApplicationNameRequiredException, InvalidApplicationNameException, ApplicationDoesNotExistException, DeploymentGroupNameRequiredException, InvalidDeploymentGroupNameException, DeploymentGroupDoesNotExistException, RevisionRequiredException, RevisionDoesNotExistException, InvalidRevisionException, InvalidDeploymentConfigNameException, DeploymentConfigDoesNotExistException, DescriptionTooLongException, DeploymentLimitExceededException, InvalidTargetInstancesException, InvalidAutoRollbackConfigException, InvalidLoadBalancerInfoException, InvalidFileExistsBehaviorException, SdkBaseException, SdkClientException, CodeDeployException
Deploys an application revision through the specified deployment group.
createDeploymentRequest - Represents the input of a CreateDeployment operation.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateDeploymentConfigResponse createDeploymentConfig(CreateDeploymentConfigRequest createDeploymentConfigRequest) throws InvalidDeploymentConfigNameException, DeploymentConfigNameRequiredException, DeploymentConfigAlreadyExistsException, InvalidMinimumHealthyHostValueException, DeploymentConfigLimitExceededException, SdkBaseException, SdkClientException, CodeDeployException
Creates a deployment configuration.
createDeploymentConfigRequest - Represents the input of a CreateDeploymentConfig operation.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateDeploymentGroupResponse createDeploymentGroup(CreateDeploymentGroupRequest createDeploymentGroupRequest) throws ApplicationNameRequiredException, InvalidApplicationNameException, ApplicationDoesNotExistException, DeploymentGroupNameRequiredException, InvalidDeploymentGroupNameException, DeploymentGroupAlreadyExistsException, InvalidEC2TagException, InvalidTagException, InvalidAutoScalingGroupException, InvalidDeploymentConfigNameException, DeploymentConfigDoesNotExistException, RoleRequiredException, InvalidRoleException, DeploymentGroupLimitExceededException, LifecycleHookLimitExceededException, InvalidTriggerConfigException, TriggerTargetsLimitExceededException, InvalidAlarmConfigException, AlarmsLimitExceededException, InvalidAutoRollbackConfigException, InvalidLoadBalancerInfoException, InvalidDeploymentStyleException, InvalidBlueGreenDeploymentConfigurationException, SdkBaseException, SdkClientException, CodeDeployException
Creates a deployment group to which application revisions will be deployed.
createDeploymentGroupRequest - Represents the input of a CreateDeploymentGroup operation.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteApplicationResponse deleteApplication(DeleteApplicationRequest deleteApplicationRequest) throws ApplicationNameRequiredException, InvalidApplicationNameException, SdkBaseException, SdkClientException, CodeDeployException
Deletes an application.
deleteApplicationRequest - Represents the input of a DeleteApplication operation.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteDeploymentConfigResponse deleteDeploymentConfig(DeleteDeploymentConfigRequest deleteDeploymentConfigRequest) throws InvalidDeploymentConfigNameException, DeploymentConfigNameRequiredException, DeploymentConfigInUseException, InvalidOperationException, SdkBaseException, SdkClientException, CodeDeployException
Deletes a deployment configuration.
A deployment configuration cannot be deleted if it is currently in use. Predefined configurations cannot be deleted.
deleteDeploymentConfigRequest - Represents the input of a DeleteDeploymentConfig operation.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteDeploymentGroupResponse deleteDeploymentGroup(DeleteDeploymentGroupRequest deleteDeploymentGroupRequest) throws ApplicationNameRequiredException, InvalidApplicationNameException, DeploymentGroupNameRequiredException, InvalidDeploymentGroupNameException, InvalidRoleException, SdkBaseException, SdkClientException, CodeDeployException
Deletes a deployment group.
deleteDeploymentGroupRequest - Represents the input of a DeleteDeploymentGroup operation.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeregisterOnPremisesInstanceResponse deregisterOnPremisesInstance(DeregisterOnPremisesInstanceRequest deregisterOnPremisesInstanceRequest) throws InstanceNameRequiredException, InvalidInstanceNameException, SdkBaseException, SdkClientException, CodeDeployException
Deregisters an on-premises instance.
deregisterOnPremisesInstanceRequest - Represents the input of a DeregisterOnPremisesInstance operation.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetApplicationResponse getApplication(GetApplicationRequest getApplicationRequest) throws ApplicationNameRequiredException, InvalidApplicationNameException, ApplicationDoesNotExistException, SdkBaseException, SdkClientException, CodeDeployException
Gets information about an application.
getApplicationRequest - Represents the input of a GetApplication operation.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetApplicationRevisionResponse getApplicationRevision(GetApplicationRevisionRequest getApplicationRevisionRequest) throws ApplicationDoesNotExistException, ApplicationNameRequiredException, InvalidApplicationNameException, RevisionDoesNotExistException, RevisionRequiredException, InvalidRevisionException, SdkBaseException, SdkClientException, CodeDeployException
Gets information about an application revision.
getApplicationRevisionRequest - Represents the input of a GetApplicationRevision operation.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetDeploymentResponse getDeployment(GetDeploymentRequest getDeploymentRequest) throws DeploymentIdRequiredException, InvalidDeploymentIdException, DeploymentDoesNotExistException, SdkBaseException, SdkClientException, CodeDeployException
Gets information about a deployment.
getDeploymentRequest - Represents the input of a GetDeployment operation.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetDeploymentConfigResponse getDeploymentConfig(GetDeploymentConfigRequest getDeploymentConfigRequest) throws InvalidDeploymentConfigNameException, DeploymentConfigNameRequiredException, DeploymentConfigDoesNotExistException, SdkBaseException, SdkClientException, CodeDeployException
Gets information about a deployment configuration.
getDeploymentConfigRequest - Represents the input of a GetDeploymentConfig operation.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetDeploymentGroupResponse getDeploymentGroup(GetDeploymentGroupRequest getDeploymentGroupRequest) throws ApplicationNameRequiredException, InvalidApplicationNameException, ApplicationDoesNotExistException, DeploymentGroupNameRequiredException, InvalidDeploymentGroupNameException, DeploymentGroupDoesNotExistException, SdkBaseException, SdkClientException, CodeDeployException
Gets information about a deployment group.
getDeploymentGroupRequest - Represents the input of a GetDeploymentGroup operation.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetDeploymentInstanceResponse getDeploymentInstance(GetDeploymentInstanceRequest getDeploymentInstanceRequest) throws DeploymentIdRequiredException, DeploymentDoesNotExistException, InstanceIdRequiredException, InvalidDeploymentIdException, InstanceDoesNotExistException, InvalidInstanceNameException, SdkBaseException, SdkClientException, CodeDeployException
Gets information about an instance as part of a deployment.
getDeploymentInstanceRequest - Represents the input of a GetDeploymentInstance operation.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetOnPremisesInstanceResponse getOnPremisesInstance(GetOnPremisesInstanceRequest getOnPremisesInstanceRequest) throws InstanceNameRequiredException, InstanceNotRegisteredException, InvalidInstanceNameException, SdkBaseException, SdkClientException, CodeDeployException
Gets information about an on-premises instance.
getOnPremisesInstanceRequest - Represents the input of a GetOnPremisesInstance operation.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListApplicationRevisionsResponse listApplicationRevisions(ListApplicationRevisionsRequest listApplicationRevisionsRequest) throws ApplicationDoesNotExistException, ApplicationNameRequiredException, InvalidApplicationNameException, InvalidSortByException, InvalidSortOrderException, InvalidBucketNameFilterException, InvalidKeyPrefixFilterException, BucketNameFilterRequiredException, InvalidDeployedStateFilterException, InvalidNextTokenException, SdkBaseException, SdkClientException, CodeDeployException
Lists information about revisions for an application.
listApplicationRevisionsRequest - Represents the input of a ListApplicationRevisions operation.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListApplicationsResponse listApplications(ListApplicationsRequest listApplicationsRequest) throws InvalidNextTokenException, SdkBaseException, SdkClientException, CodeDeployException
Lists the applications registered with the applicable IAM user or AWS account.
listApplicationsRequest - Represents the input of a ListApplications operation.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListDeploymentConfigsResponse listDeploymentConfigs(ListDeploymentConfigsRequest listDeploymentConfigsRequest) throws InvalidNextTokenException, SdkBaseException, SdkClientException, CodeDeployException
Lists the deployment configurations with the applicable IAM user or AWS account.
listDeploymentConfigsRequest - Represents the input of a ListDeploymentConfigs operation.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListDeploymentGroupsResponse listDeploymentGroups(ListDeploymentGroupsRequest listDeploymentGroupsRequest) throws ApplicationNameRequiredException, InvalidApplicationNameException, ApplicationDoesNotExistException, InvalidNextTokenException, SdkBaseException, SdkClientException, CodeDeployException
Lists the deployment groups for an application registered with the applicable IAM user or AWS account.
listDeploymentGroupsRequest - Represents the input of a ListDeploymentGroups operation.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListDeploymentInstancesResponse listDeploymentInstances(ListDeploymentInstancesRequest listDeploymentInstancesRequest) throws DeploymentIdRequiredException, DeploymentDoesNotExistException, DeploymentNotStartedException, InvalidNextTokenException, InvalidDeploymentIdException, InvalidInstanceStatusException, InvalidInstanceTypeException, InvalidDeploymentInstanceTypeException, SdkBaseException, SdkClientException, CodeDeployException
Lists the instance for a deployment associated with the applicable IAM user or AWS account.
listDeploymentInstancesRequest - Represents the input of a ListDeploymentInstances operation.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListDeploymentsResponse listDeployments(ListDeploymentsRequest listDeploymentsRequest) throws ApplicationNameRequiredException, InvalidApplicationNameException, ApplicationDoesNotExistException, InvalidDeploymentGroupNameException, DeploymentGroupDoesNotExistException, DeploymentGroupNameRequiredException, InvalidTimeRangeException, InvalidDeploymentStatusException, InvalidNextTokenException, SdkBaseException, SdkClientException, CodeDeployException
Lists the deployments in a deployment group for an application registered with the applicable IAM user or AWS account.
listDeploymentsRequest - Represents the input of a ListDeployments operation.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListGitHubAccountTokenNamesResponse listGitHubAccountTokenNames(ListGitHubAccountTokenNamesRequest listGitHubAccountTokenNamesRequest) throws InvalidNextTokenException, ResourceValidationException, SdkBaseException, SdkClientException, CodeDeployException
Lists the names of stored connections to GitHub accounts.
listGitHubAccountTokenNamesRequest - Represents the input of a ListGitHubAccountTokenNames operation.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListOnPremisesInstancesResponse listOnPremisesInstances(ListOnPremisesInstancesRequest listOnPremisesInstancesRequest) throws InvalidRegistrationStatusException, InvalidTagFilterException, InvalidNextTokenException, SdkBaseException, SdkClientException, CodeDeployException
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.
listOnPremisesInstancesRequest - Represents the input of a ListOnPremisesInstances operation.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RegisterApplicationRevisionResponse registerApplicationRevision(RegisterApplicationRevisionRequest registerApplicationRevisionRequest) throws ApplicationDoesNotExistException, ApplicationNameRequiredException, InvalidApplicationNameException, DescriptionTooLongException, RevisionRequiredException, InvalidRevisionException, SdkBaseException, SdkClientException, CodeDeployException
Registers with AWS CodeDeploy a revision for the specified application.
registerApplicationRevisionRequest - Represents the input of a RegisterApplicationRevision operation.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RegisterOnPremisesInstanceResponse registerOnPremisesInstance(RegisterOnPremisesInstanceRequest registerOnPremisesInstanceRequest) throws InstanceNameAlreadyRegisteredException, IamArnRequiredException, IamSessionArnAlreadyRegisteredException, IamUserArnAlreadyRegisteredException, InstanceNameRequiredException, IamUserArnRequiredException, InvalidInstanceNameException, InvalidIamSessionArnException, InvalidIamUserArnException, MultipleIamArnsProvidedException, SdkBaseException, SdkClientException, CodeDeployException
Registers an on-premises instance.
Only one IAM ARN (an IAM session ARN or IAM user ARN) is supported in the request. You cannot use both.
registerOnPremisesInstanceRequest - Represents the input of the register on-premises instance operation.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RemoveTagsFromOnPremisesInstancesResponse removeTagsFromOnPremisesInstances(RemoveTagsFromOnPremisesInstancesRequest removeTagsFromOnPremisesInstancesRequest) throws InstanceNameRequiredException, TagRequiredException, InvalidTagException, TagLimitExceededException, InstanceLimitExceededException, InstanceNotRegisteredException, SdkBaseException, SdkClientException, CodeDeployException
Removes one or more tags from one or more on-premises instances.
removeTagsFromOnPremisesInstancesRequest - Represents the input of a RemoveTagsFromOnPremisesInstances operation.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault SkipWaitTimeForInstanceTerminationResponse skipWaitTimeForInstanceTermination(SkipWaitTimeForInstanceTerminationRequest skipWaitTimeForInstanceTerminationRequest) throws DeploymentIdRequiredException, DeploymentDoesNotExistException, DeploymentAlreadyCompletedException, InvalidDeploymentIdException, DeploymentNotStartedException, UnsupportedActionForDeploymentTypeException, SdkBaseException, SdkClientException, CodeDeployException
In a blue/green deployment, overrides any specified wait time and starts terminating instances immediately after the traffic routing is completed.
skipWaitTimeForInstanceTerminationRequest - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault StopDeploymentResponse stopDeployment(StopDeploymentRequest stopDeploymentRequest) throws DeploymentIdRequiredException, DeploymentDoesNotExistException, DeploymentAlreadyCompletedException, InvalidDeploymentIdException, SdkBaseException, SdkClientException, CodeDeployException
Attempts to stop an ongoing deployment.
stopDeploymentRequest - Represents the input of a StopDeployment operation.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UpdateApplicationResponse updateApplication(UpdateApplicationRequest updateApplicationRequest) throws ApplicationNameRequiredException, InvalidApplicationNameException, ApplicationAlreadyExistsException, ApplicationDoesNotExistException, SdkBaseException, SdkClientException, CodeDeployException
Changes the name of an application.
updateApplicationRequest - Represents the input of an UpdateApplication operation.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UpdateDeploymentGroupResponse updateDeploymentGroup(UpdateDeploymentGroupRequest updateDeploymentGroupRequest) throws ApplicationNameRequiredException, InvalidApplicationNameException, ApplicationDoesNotExistException, InvalidDeploymentGroupNameException, DeploymentGroupAlreadyExistsException, DeploymentGroupNameRequiredException, DeploymentGroupDoesNotExistException, InvalidEC2TagException, InvalidTagException, InvalidAutoScalingGroupException, InvalidDeploymentConfigNameException, DeploymentConfigDoesNotExistException, InvalidRoleException, LifecycleHookLimitExceededException, InvalidTriggerConfigException, TriggerTargetsLimitExceededException, InvalidAlarmConfigException, AlarmsLimitExceededException, InvalidAutoRollbackConfigException, InvalidLoadBalancerInfoException, InvalidDeploymentStyleException, InvalidBlueGreenDeploymentConfigurationException, SdkBaseException, SdkClientException, CodeDeployException
Changes information about a deployment group.
updateDeploymentGroupRequest - Represents the input of an UpdateDeploymentGroup operation.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typestatic ServiceMetadata serviceMetadata()
CodeDeployClientWaiters waiters()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.