com.amazonaws.services.codedeploy

Class AmazonCodeDeployClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.codedeploy.AmazonCodeDeployClient

All Implemented Interfaces:

AmazonCodeDeploy

Direct Known Subclasses:

AmazonCodeDeployAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonCodeDeployClient
extends AmazonWebServiceClient
implements AmazonCodeDeploy

Client for accessing CodeDeploy. All service calls made using this client are blocking, and will not return until the service call completes.

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

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.codedeploy.AmazonCodeDeploy

ENDPOINT_PREFIX

Constructor Summary

Constructors

Constructor and Description
AmazonCodeDeployClient() Deprecated. use AmazonCodeDeployClientBuilder.defaultClient()
AmazonCodeDeployClient(AWSCredentials awsCredentials) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AmazonCodeDeployClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
AmazonCodeDeployClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AmazonCodeDeployClient(AWSCredentialsProvider awsCredentialsProvider) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)
AmazonCodeDeployClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AmazonCodeDeployClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
AmazonCodeDeployClient(ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Method Summary

Modifier and Type	Method and Description
AddTagsToOnPremisesInstancesResult	addTagsToOnPremisesInstances(AddTagsToOnPremisesInstancesRequest request) Adds tags to on-premises instances.
BatchGetApplicationRevisionsResult	batchGetApplicationRevisions(BatchGetApplicationRevisionsRequest request) Gets information about one or more application revisions.
BatchGetApplicationsResult	batchGetApplications() Simplified method form for invoking the BatchGetApplications operation.
BatchGetApplicationsResult	batchGetApplications(BatchGetApplicationsRequest request) Gets information about one or more applications.
BatchGetDeploymentGroupsResult	batchGetDeploymentGroups(BatchGetDeploymentGroupsRequest request) Gets information about one or more deployment groups.
BatchGetDeploymentInstancesResult	batchGetDeploymentInstances(BatchGetDeploymentInstancesRequest request) Gets information about one or more instance that are part of a deployment group.
BatchGetDeploymentsResult	batchGetDeployments() Simplified method form for invoking the BatchGetDeployments operation.
BatchGetDeploymentsResult	batchGetDeployments(BatchGetDeploymentsRequest request) Gets information about one or more deployments.
BatchGetOnPremisesInstancesResult	batchGetOnPremisesInstances() Simplified method form for invoking the BatchGetOnPremisesInstances operation.
BatchGetOnPremisesInstancesResult	batchGetOnPremisesInstances(BatchGetOnPremisesInstancesRequest request) Gets information about one or more on-premises instances.
static AmazonCodeDeployClientBuilder	builder()
ContinueDeploymentResult	continueDeployment(ContinueDeploymentRequest request) 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.
CreateApplicationResult	createApplication(CreateApplicationRequest request) Creates an application.
CreateDeploymentResult	createDeployment(CreateDeploymentRequest request) Deploys an application revision through the specified deployment group.
CreateDeploymentConfigResult	createDeploymentConfig(CreateDeploymentConfigRequest request) Creates a deployment configuration.
CreateDeploymentGroupResult	createDeploymentGroup(CreateDeploymentGroupRequest request) Creates a deployment group to which application revisions will be deployed.
DeleteApplicationResult	deleteApplication(DeleteApplicationRequest request) Deletes an application.
DeleteDeploymentConfigResult	deleteDeploymentConfig(DeleteDeploymentConfigRequest request) Deletes a deployment configuration.
DeleteDeploymentGroupResult	deleteDeploymentGroup(DeleteDeploymentGroupRequest request) Deletes a deployment group.
DeregisterOnPremisesInstanceResult	deregisterOnPremisesInstance(DeregisterOnPremisesInstanceRequest request) Deregisters an on-premises instance.
GetApplicationResult	getApplication(GetApplicationRequest request) Gets information about an application.
GetApplicationRevisionResult	getApplicationRevision(GetApplicationRevisionRequest request) Gets information about an application revision.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
GetDeploymentResult	getDeployment(GetDeploymentRequest request) Gets information about a deployment.
GetDeploymentConfigResult	getDeploymentConfig(GetDeploymentConfigRequest request) Gets information about a deployment configuration.
GetDeploymentGroupResult	getDeploymentGroup(GetDeploymentGroupRequest request) Gets information about a deployment group.
GetDeploymentInstanceResult	getDeploymentInstance(GetDeploymentInstanceRequest request) Gets information about an instance as part of a deployment.
GetOnPremisesInstanceResult	getOnPremisesInstance(GetOnPremisesInstanceRequest request) Gets information about an on-premises instance.
ListApplicationRevisionsResult	listApplicationRevisions(ListApplicationRevisionsRequest request) Lists information about revisions for an application.
ListApplicationsResult	listApplications() Simplified method form for invoking the ListApplications operation.
ListApplicationsResult	listApplications(ListApplicationsRequest request) Lists the applications registered with the applicable IAM user or AWS account.
ListDeploymentConfigsResult	listDeploymentConfigs() Simplified method form for invoking the ListDeploymentConfigs operation.
ListDeploymentConfigsResult	listDeploymentConfigs(ListDeploymentConfigsRequest request) Lists the deployment configurations with the applicable IAM user or AWS account.
ListDeploymentGroupsResult	listDeploymentGroups(ListDeploymentGroupsRequest request) Lists the deployment groups for an application registered with the applicable IAM user or AWS account.
ListDeploymentInstancesResult	listDeploymentInstances(ListDeploymentInstancesRequest request) Lists the instance for a deployment associated with the applicable IAM user or AWS account.
ListDeploymentsResult	listDeployments() Simplified method form for invoking the ListDeployments operation.
ListDeploymentsResult	listDeployments(ListDeploymentsRequest request) Lists the deployments in a deployment group for an application registered with the applicable IAM user or AWS account.
ListGitHubAccountTokenNamesResult	listGitHubAccountTokenNames(ListGitHubAccountTokenNamesRequest request) Lists the names of stored connections to GitHub accounts.
ListOnPremisesInstancesResult	listOnPremisesInstances() Simplified method form for invoking the ListOnPremisesInstances operation.
ListOnPremisesInstancesResult	listOnPremisesInstances(ListOnPremisesInstancesRequest request) Gets a list of names for one or more on-premises instances.
RegisterApplicationRevisionResult	registerApplicationRevision(RegisterApplicationRevisionRequest request) Registers with AWS CodeDeploy a revision for the specified application.
RegisterOnPremisesInstanceResult	registerOnPremisesInstance(RegisterOnPremisesInstanceRequest request) Registers an on-premises instance.
RemoveTagsFromOnPremisesInstancesResult	removeTagsFromOnPremisesInstances(RemoveTagsFromOnPremisesInstancesRequest request) Removes one or more tags from one or more on-premises instances.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
SkipWaitTimeForInstanceTerminationResult	skipWaitTimeForInstanceTermination(SkipWaitTimeForInstanceTerminationRequest request) In a blue/green deployment, overrides any specified wait time and starts terminating instances immediately after the traffic routing is completed.
StopDeploymentResult	stopDeployment(StopDeploymentRequest request) Attempts to stop an ongoing deployment.
UpdateApplicationResult	updateApplication() Simplified method form for invoking the UpdateApplication operation.
UpdateApplicationResult	updateApplication(UpdateApplicationRequest request) Changes the name of an application.
UpdateDeploymentGroupResult	updateDeploymentGroup(UpdateDeploymentGroupRequest request) Changes information about a deployment group.
AmazonCodeDeployWaiters	waiters()

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.codedeploy.AmazonCodeDeploy

setEndpoint, setRegion

Constructor Detail

AmazonCodeDeployClient

@Deprecated
public AmazonCodeDeployClient()

Deprecated. use AmazonCodeDeployClientBuilder.defaultClient()

Constructs a new client to invoke service methods on CodeDeploy. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AmazonCodeDeployClient

@Deprecated
public AmazonCodeDeployClient(ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on CodeDeploy. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to CodeDeploy (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AmazonCodeDeployClient

@Deprecated
public AmazonCodeDeployClient(AWSCredentials awsCredentials)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AmazonCodeDeployClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();

Constructs a new client to invoke service methods on CodeDeploy using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AmazonCodeDeployClient

@Deprecated
public AmazonCodeDeployClient(AWSCredentials awsCredentials,
                                          ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on CodeDeploy using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to CodeDeploy (ex: proxy settings, retry counts, etc.).

AmazonCodeDeployClient

@Deprecated
public AmazonCodeDeployClient(AWSCredentialsProvider awsCredentialsProvider)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)

Constructs a new client to invoke service methods on CodeDeploy using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AmazonCodeDeployClient

@Deprecated
public AmazonCodeDeployClient(AWSCredentialsProvider awsCredentialsProvider,
                                          ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on CodeDeploy using the specified AWS account credentials provider and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to CodeDeploy (ex: proxy settings, retry counts, etc.).

AmazonCodeDeployClient

@Deprecated
public AmazonCodeDeployClient(AWSCredentialsProvider awsCredentialsProvider,
                                          ClientConfiguration clientConfiguration,
                                          RequestMetricCollector requestMetricCollector)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)

Constructs a new client to invoke service methods on CodeDeploy using the specified AWS account credentials provider, client configuration options, and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to CodeDeploy (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

Method Detail

builder

public static AmazonCodeDeployClientBuilder builder()

addTagsToOnPremisesInstances

public AddTagsToOnPremisesInstancesResult addTagsToOnPremisesInstances(AddTagsToOnPremisesInstancesRequest request)

Adds tags to on-premises instances.

Specified by:

addTagsToOnPremisesInstances in interface AmazonCodeDeploy

Parameters:

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

Returns:

Result of the AddTagsToOnPremisesInstances operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

batchGetApplicationRevisions

public BatchGetApplicationRevisionsResult batchGetApplicationRevisions(BatchGetApplicationRevisionsRequest request)

Gets information about one or more application revisions.

Specified by:

batchGetApplicationRevisions in interface AmazonCodeDeploy

Parameters:

batchGetApplicationRevisionsRequest - Represents the input of a BatchGetApplicationRevisions operation.

Returns:

Result of the BatchGetApplicationRevisions operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

batchGetApplications

public BatchGetApplicationsResult batchGetApplications(BatchGetApplicationsRequest request)

Gets information about one or more applications.

Specified by:

batchGetApplications in interface AmazonCodeDeploy

Parameters:

batchGetApplicationsRequest - Represents the input of a BatchGetApplications operation.

Returns:

Result of the BatchGetApplications operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

batchGetApplications

public BatchGetApplicationsResult batchGetApplications()

Description copied from interface: AmazonCodeDeploy

Simplified method form for invoking the BatchGetApplications operation.

Specified by:

batchGetApplications in interface AmazonCodeDeploy

See Also:

AmazonCodeDeploy.batchGetApplications(BatchGetApplicationsRequest)

batchGetDeploymentGroups

public BatchGetDeploymentGroupsResult batchGetDeploymentGroups(BatchGetDeploymentGroupsRequest request)

Gets information about one or more deployment groups.

Specified by:

batchGetDeploymentGroups in interface AmazonCodeDeploy

Parameters:

batchGetDeploymentGroupsRequest - Represents the input of a BatchGetDeploymentGroups operation.

Returns:

Result of the BatchGetDeploymentGroups operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

batchGetDeploymentInstances

public BatchGetDeploymentInstancesResult batchGetDeploymentInstances(BatchGetDeploymentInstancesRequest request)

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

Specified by:

batchGetDeploymentInstances in interface AmazonCodeDeploy

Parameters:

batchGetDeploymentInstancesRequest - Represents the input of a BatchGetDeploymentInstances operation.

Returns:

Result of the BatchGetDeploymentInstances operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

batchGetDeployments

public BatchGetDeploymentsResult batchGetDeployments(BatchGetDeploymentsRequest request)

Gets information about one or more deployments.

Specified by:

batchGetDeployments in interface AmazonCodeDeploy

Parameters:

batchGetDeploymentsRequest - Represents the input of a BatchGetDeployments operation.

Returns:

Result of the BatchGetDeployments operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

batchGetDeployments

public BatchGetDeploymentsResult batchGetDeployments()

Description copied from interface: AmazonCodeDeploy

Simplified method form for invoking the BatchGetDeployments operation.

Specified by:

batchGetDeployments in interface AmazonCodeDeploy

See Also:

AmazonCodeDeploy.batchGetDeployments(BatchGetDeploymentsRequest)

batchGetOnPremisesInstances

public BatchGetOnPremisesInstancesResult batchGetOnPremisesInstances(BatchGetOnPremisesInstancesRequest request)

Gets information about one or more on-premises instances.

Specified by:

batchGetOnPremisesInstances in interface AmazonCodeDeploy

Parameters:

batchGetOnPremisesInstancesRequest - Represents the input of a BatchGetOnPremisesInstances operation.

Returns:

Result of the BatchGetOnPremisesInstances operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

batchGetOnPremisesInstances

public BatchGetOnPremisesInstancesResult batchGetOnPremisesInstances()

Description copied from interface: AmazonCodeDeploy

Simplified method form for invoking the BatchGetOnPremisesInstances operation.

Specified by:

batchGetOnPremisesInstances in interface AmazonCodeDeploy

See Also:

AmazonCodeDeploy.batchGetOnPremisesInstances(BatchGetOnPremisesInstancesRequest)

continueDeployment

public ContinueDeploymentResult continueDeployment(ContinueDeploymentRequest request)

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.)

Specified by:

continueDeployment in interface AmazonCodeDeploy

Parameters:

continueDeploymentRequest -

Returns:

Result of the ContinueDeployment operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createApplication

public CreateApplicationResult createApplication(CreateApplicationRequest request)

Creates an application.

Specified by:

createApplication in interface AmazonCodeDeploy

Parameters:

createApplicationRequest - Represents the input of a CreateApplication operation.

Returns:

Result of the CreateApplication operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createDeployment

public CreateDeploymentResult createDeployment(CreateDeploymentRequest request)

Deploys an application revision through the specified deployment group.

Specified by:

createDeployment in interface AmazonCodeDeploy

Parameters:

createDeploymentRequest - Represents the input of a CreateDeployment operation.

Returns:

Result of the CreateDeployment operation returned by the service.

Throws:

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".

See Also:

AWS API Documentation

createDeploymentConfig

public CreateDeploymentConfigResult createDeploymentConfig(CreateDeploymentConfigRequest request)

Creates a deployment configuration.

Specified by:

createDeploymentConfig in interface AmazonCodeDeploy

Parameters:

createDeploymentConfigRequest - Represents the input of a CreateDeploymentConfig operation.

Returns:

Result of the CreateDeploymentConfig operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createDeploymentGroup

public CreateDeploymentGroupResult createDeploymentGroup(CreateDeploymentGroupRequest request)

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

Specified by:

createDeploymentGroup in interface AmazonCodeDeploy

Parameters:

createDeploymentGroupRequest - Represents the input of a CreateDeploymentGroup operation.

Returns:

Result of the CreateDeploymentGroup operation returned by the service.

Throws:

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.

InvalidEC2TagCombinationException - A call was submitted that specified both Ec2TagFilters and Ec2TagSet, but only one of these data types can be used in a single call.

InvalidOnPremisesTagCombinationException - A call was submitted that specified both OnPremisesTagFilters and OnPremisesTagSet, but only one of these data types can be used in a single call.

TagSetListLimitExceededException - The number of tag groups included in the tag set list exceeded the maximum allowed limit of 3.

See Also:

AWS API Documentation

deleteApplication

public DeleteApplicationResult deleteApplication(DeleteApplicationRequest request)

Deletes an application.

Specified by:

deleteApplication in interface AmazonCodeDeploy

Parameters:

deleteApplicationRequest - Represents the input of a DeleteApplication operation.

Returns:

Result of the DeleteApplication operation returned by the service.

Throws:

ApplicationNameRequiredException - The minimum number of required application names was not specified.

InvalidApplicationNameException - The application name was specified in an invalid format.

See Also:

AWS API Documentation

deleteDeploymentConfig

public DeleteDeploymentConfigResult deleteDeploymentConfig(DeleteDeploymentConfigRequest request)

Deletes a deployment configuration.

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

Specified by:

deleteDeploymentConfig in interface AmazonCodeDeploy

Parameters:

deleteDeploymentConfigRequest - Represents the input of a DeleteDeploymentConfig operation.

Returns:

Result of the DeleteDeploymentConfig operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteDeploymentGroup

public DeleteDeploymentGroupResult deleteDeploymentGroup(DeleteDeploymentGroupRequest request)

Deletes a deployment group.

Specified by:

deleteDeploymentGroup in interface AmazonCodeDeploy

Parameters:

deleteDeploymentGroupRequest - Represents the input of a DeleteDeploymentGroup operation.

Returns:

Result of the DeleteDeploymentGroup operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deregisterOnPremisesInstance

public DeregisterOnPremisesInstanceResult deregisterOnPremisesInstance(DeregisterOnPremisesInstanceRequest request)

Deregisters an on-premises instance.

Specified by:

deregisterOnPremisesInstance in interface AmazonCodeDeploy

Parameters:

deregisterOnPremisesInstanceRequest - Represents the input of a DeregisterOnPremisesInstance operation.

Returns:

Result of the DeregisterOnPremisesInstance operation returned by the service.

Throws:

InstanceNameRequiredException - An on-premises instance name was not specified.

InvalidInstanceNameException - The specified on-premises instance name was specified in an invalid format.

See Also:

AWS API Documentation

getApplication

public GetApplicationResult getApplication(GetApplicationRequest request)

Gets information about an application.

Specified by:

getApplication in interface AmazonCodeDeploy

Parameters:

getApplicationRequest - Represents the input of a GetApplication operation.

Returns:

Result of the GetApplication operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getApplicationRevision

public GetApplicationRevisionResult getApplicationRevision(GetApplicationRevisionRequest request)

Gets information about an application revision.

Specified by:

getApplicationRevision in interface AmazonCodeDeploy

Parameters:

getApplicationRevisionRequest - Represents the input of a GetApplicationRevision operation.

Returns:

Result of the GetApplicationRevision operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getDeployment

public GetDeploymentResult getDeployment(GetDeploymentRequest request)

Gets information about a deployment.

Specified by:

getDeployment in interface AmazonCodeDeploy

Parameters:

getDeploymentRequest - Represents the input of a GetDeployment operation.

Returns:

Result of the GetDeployment operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getDeploymentConfig

public GetDeploymentConfigResult getDeploymentConfig(GetDeploymentConfigRequest request)

Gets information about a deployment configuration.

Specified by:

getDeploymentConfig in interface AmazonCodeDeploy

Parameters:

getDeploymentConfigRequest - Represents the input of a GetDeploymentConfig operation.

Returns:

Result of the GetDeploymentConfig operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getDeploymentGroup

public GetDeploymentGroupResult getDeploymentGroup(GetDeploymentGroupRequest request)

Gets information about a deployment group.

Specified by:

getDeploymentGroup in interface AmazonCodeDeploy

Parameters:

getDeploymentGroupRequest - Represents the input of a GetDeploymentGroup operation.

Returns:

Result of the GetDeploymentGroup operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getDeploymentInstance

public GetDeploymentInstanceResult getDeploymentInstance(GetDeploymentInstanceRequest request)

Gets information about an instance as part of a deployment.

Specified by:

getDeploymentInstance in interface AmazonCodeDeploy

Parameters:

getDeploymentInstanceRequest - Represents the input of a GetDeploymentInstance operation.

Returns:

Result of the GetDeploymentInstance operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getOnPremisesInstance

public GetOnPremisesInstanceResult getOnPremisesInstance(GetOnPremisesInstanceRequest request)

Gets information about an on-premises instance.

Specified by:

getOnPremisesInstance in interface AmazonCodeDeploy

Parameters:

getOnPremisesInstanceRequest - Represents the input of a GetOnPremisesInstance operation.

Returns:

Result of the GetOnPremisesInstance operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listApplicationRevisions

public ListApplicationRevisionsResult listApplicationRevisions(ListApplicationRevisionsRequest request)

Lists information about revisions for an application.

Specified by:

listApplicationRevisions in interface AmazonCodeDeploy

Parameters:

listApplicationRevisionsRequest - Represents the input of a ListApplicationRevisions operation.

Returns:

Result of the ListApplicationRevisions operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listApplications

public ListApplicationsResult listApplications(ListApplicationsRequest request)

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

Specified by:

listApplications in interface AmazonCodeDeploy

Parameters:

listApplicationsRequest - Represents the input of a ListApplications operation.

Returns:

Result of the ListApplications operation returned by the service.

Throws:

InvalidNextTokenException - The next token was specified in an invalid format.

See Also:

AWS API Documentation

listApplications

public ListApplicationsResult listApplications()

Description copied from interface: AmazonCodeDeploy

Simplified method form for invoking the ListApplications operation.

Specified by:

listApplications in interface AmazonCodeDeploy

See Also:

AmazonCodeDeploy.listApplications(ListApplicationsRequest)

listDeploymentConfigs

public ListDeploymentConfigsResult listDeploymentConfigs(ListDeploymentConfigsRequest request)

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

Specified by:

listDeploymentConfigs in interface AmazonCodeDeploy

Parameters:

listDeploymentConfigsRequest - Represents the input of a ListDeploymentConfigs operation.

Returns:

Result of the ListDeploymentConfigs operation returned by the service.

Throws:

InvalidNextTokenException - The next token was specified in an invalid format.

See Also:

AWS API Documentation

listDeploymentConfigs

public ListDeploymentConfigsResult listDeploymentConfigs()

Description copied from interface: AmazonCodeDeploy

Simplified method form for invoking the ListDeploymentConfigs operation.

Specified by:

listDeploymentConfigs in interface AmazonCodeDeploy

See Also:

AmazonCodeDeploy.listDeploymentConfigs(ListDeploymentConfigsRequest)

listDeploymentGroups

public ListDeploymentGroupsResult listDeploymentGroups(ListDeploymentGroupsRequest request)

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

Specified by:

listDeploymentGroups in interface AmazonCodeDeploy

Parameters:

listDeploymentGroupsRequest - Represents the input of a ListDeploymentGroups operation.

Returns:

Result of the ListDeploymentGroups operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listDeploymentInstances

public ListDeploymentInstancesResult listDeploymentInstances(ListDeploymentInstancesRequest request)

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

Specified by:

listDeploymentInstances in interface AmazonCodeDeploy

Parameters:

listDeploymentInstancesRequest - Represents the input of a ListDeploymentInstances operation.

Returns:

Result of the ListDeploymentInstances operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listDeployments

public ListDeploymentsResult listDeployments(ListDeploymentsRequest request)

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

Specified by:

listDeployments in interface AmazonCodeDeploy

Parameters:

listDeploymentsRequest - Represents the input of a ListDeployments operation.

Returns:

Result of the ListDeployments operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listDeployments

public ListDeploymentsResult listDeployments()

Description copied from interface: AmazonCodeDeploy

Simplified method form for invoking the ListDeployments operation.

Specified by:

listDeployments in interface AmazonCodeDeploy

See Also:

AmazonCodeDeploy.listDeployments(ListDeploymentsRequest)

listGitHubAccountTokenNames

public ListGitHubAccountTokenNamesResult listGitHubAccountTokenNames(ListGitHubAccountTokenNamesRequest request)

Lists the names of stored connections to GitHub accounts.

Specified by:

listGitHubAccountTokenNames in interface AmazonCodeDeploy

Parameters:

listGitHubAccountTokenNamesRequest - Represents the input of a ListGitHubAccountTokenNames operation.

Returns:

Result of the ListGitHubAccountTokenNames operation returned by the service.

Throws:

InvalidNextTokenException - The next token was specified in an invalid format.

ResourceValidationException - The specified resource could not be validated.

See Also:

AWS API Documentation

listOnPremisesInstances

public ListOnPremisesInstancesResult listOnPremisesInstances(ListOnPremisesInstancesRequest request)

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.

Specified by:

listOnPremisesInstances in interface AmazonCodeDeploy

Parameters:

listOnPremisesInstancesRequest - Represents the input of a ListOnPremisesInstances operation.

Returns:

Result of the ListOnPremisesInstances operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listOnPremisesInstances

public ListOnPremisesInstancesResult listOnPremisesInstances()

Description copied from interface: AmazonCodeDeploy

Simplified method form for invoking the ListOnPremisesInstances operation.

Specified by:

listOnPremisesInstances in interface AmazonCodeDeploy

See Also:

AmazonCodeDeploy.listOnPremisesInstances(ListOnPremisesInstancesRequest)

registerApplicationRevision

public RegisterApplicationRevisionResult registerApplicationRevision(RegisterApplicationRevisionRequest request)

Registers with AWS CodeDeploy a revision for the specified application.

Specified by:

registerApplicationRevision in interface AmazonCodeDeploy

Parameters:

registerApplicationRevisionRequest - Represents the input of a RegisterApplicationRevision operation.

Returns:

Result of the RegisterApplicationRevision operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

registerOnPremisesInstance

public RegisterOnPremisesInstanceResult registerOnPremisesInstance(RegisterOnPremisesInstanceRequest request)

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.

Specified by:

registerOnPremisesInstance in interface AmazonCodeDeploy

Parameters:

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

Returns:

Result of the RegisterOnPremisesInstance operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

removeTagsFromOnPremisesInstances

public RemoveTagsFromOnPremisesInstancesResult removeTagsFromOnPremisesInstances(RemoveTagsFromOnPremisesInstancesRequest request)

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

Specified by:

removeTagsFromOnPremisesInstances in interface AmazonCodeDeploy

Parameters:

removeTagsFromOnPremisesInstancesRequest - Represents the input of a RemoveTagsFromOnPremisesInstances operation.

Returns:

Result of the RemoveTagsFromOnPremisesInstances operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

skipWaitTimeForInstanceTermination

public SkipWaitTimeForInstanceTerminationResult skipWaitTimeForInstanceTermination(SkipWaitTimeForInstanceTerminationRequest request)

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

Specified by:

skipWaitTimeForInstanceTermination in interface AmazonCodeDeploy

Parameters:

skipWaitTimeForInstanceTerminationRequest -

Returns:

Result of the SkipWaitTimeForInstanceTermination operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

stopDeployment

public StopDeploymentResult stopDeployment(StopDeploymentRequest request)

Attempts to stop an ongoing deployment.

Specified by:

stopDeployment in interface AmazonCodeDeploy

Parameters:

stopDeploymentRequest - Represents the input of a StopDeployment operation.

Returns:

Result of the StopDeployment operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateApplication

public UpdateApplicationResult updateApplication(UpdateApplicationRequest request)

Changes the name of an application.

Specified by:

updateApplication in interface AmazonCodeDeploy

Parameters:

updateApplicationRequest - Represents the input of an UpdateApplication operation.

Returns:

Result of the UpdateApplication operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateApplication

public UpdateApplicationResult updateApplication()

Description copied from interface: AmazonCodeDeploy

Simplified method form for invoking the UpdateApplication operation.

Specified by:

updateApplication in interface AmazonCodeDeploy

See Also:

AmazonCodeDeploy.updateApplication(UpdateApplicationRequest)

updateDeploymentGroup

public UpdateDeploymentGroupResult updateDeploymentGroup(UpdateDeploymentGroupRequest request)

Changes information about a deployment group.

Specified by:

updateDeploymentGroup in interface AmazonCodeDeploy

Parameters:

updateDeploymentGroupRequest - Represents the input of an UpdateDeploymentGroup operation.

Returns:

Result of the UpdateDeploymentGroup operation returned by the service.

Throws:

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.

InvalidEC2TagCombinationException - A call was submitted that specified both Ec2TagFilters and Ec2TagSet, but only one of these data types can be used in a single call.

InvalidOnPremisesTagCombinationException - A call was submitted that specified both OnPremisesTagFilters and OnPremisesTagSet, but only one of these data types can be used in a single call.

TagSetListLimitExceededException - The number of tag groups included in the tag set list exceeded the maximum allowed limit of 3.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AmazonCodeDeploy

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

waiters

public AmazonCodeDeployWaiters waiters()

Specified by:

waiters in interface AmazonCodeDeploy

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonCodeDeploy

Overrides:

shutdown in class AmazonWebServiceClient