com.amazonaws.services.codedeploy

Interface AmazonCodeDeploy

All Known Subinterfaces:

AmazonCodeDeployAsync

All Known Implementing Classes:

AmazonCodeDeployAsyncClient, AmazonCodeDeployClient

public interface AmazonCodeDeploy

Interface for accessing AmazonCodeDeploy. AWS CodeDeploy Overview

This is the AWS CodeDeploy API Reference. This guide provides descriptions of the AWS CodeDeploy APIs. For additional information, see the AWS CodeDeploy User Guide .

Using the APIs

You can use the AWS CodeDeploy APIs to work with the following items:

• Applications are unique identifiers that AWS CodeDeploy uses to ensure that the correct combinations of revisions, deployment configurations, and deployment groups are being referenced during deployments.

  You can use the AWS CodeDeploy APIs to create, delete, get, list, and update applications.

• Deployment configurations are sets of deployment rules and deployment success and failure conditions that AWS CodeDeploy uses during deployments.

  You can use the AWS CodeDeploy APIs to create, delete, get, and list deployment configurations.

• Deployment groups are groups of instances to which application revisions can be deployed.

  You can use the AWS CodeDeploy APIs to create, delete, get, list, and update deployment groups.

• Instances represent Amazon EC2 instances to which application revisions are deployed. Instances are identified by their Amazon EC2 tags or Auto Scaling group names. Instances belong to deployment groups.

  You can use the AWS CodeDeploy APIs to get and list instances.

• Deployments represent the process of deploying revisions to instances.

  You can use the AWS CodeDeploy APIs to create, get, list, and stop deployments.

• Application revisions are archive files that are stored in Amazon S3 buckets or GitHub repositories. These revisions contain source content (such as source code, web pages, executable files, any deployment scripts, and similar) along with an Application Specification file (AppSpec file). (The AppSpec file is unique to AWS CodeDeploy; it defines a series of deployment actions that you want AWS CodeDeploy to execute.) An application revision is uniquely identified by its Amazon S3 object key and its ETag, version, or both (for application revisions that are stored in Amazon S3 buckets) or by its repository name and commit ID (for applications revisions that are stored in GitHub repositories). Application revisions are deployed through deployment groups.

  You can use the AWS CodeDeploy APIs to get, list, and register application revisions.

Method Summary

Methods

Modifier and Type	Method and Description
void	addTagsToOnPremisesInstances(AddTagsToOnPremisesInstancesRequest addTagsToOnPremisesInstancesRequest) Adds a tag to an on-premises instance.
BatchGetApplicationsResult	batchGetApplications() Gets information about one or more applications.
BatchGetApplicationsResult	batchGetApplications(BatchGetApplicationsRequest batchGetApplicationsRequest) Gets information about one or more applications.
BatchGetDeploymentsResult	batchGetDeployments() Gets information about one or more deployments.
BatchGetDeploymentsResult	batchGetDeployments(BatchGetDeploymentsRequest batchGetDeploymentsRequest) Gets information about one or more deployments.
BatchGetOnPremisesInstancesResult	batchGetOnPremisesInstances() Gets information about one or more on-premises instances.
BatchGetOnPremisesInstancesResult	batchGetOnPremisesInstances(BatchGetOnPremisesInstancesRequest batchGetOnPremisesInstancesRequest) Gets information about one or more on-premises instances.
CreateApplicationResult	createApplication(CreateApplicationRequest createApplicationRequest) Creates a new application.
CreateDeploymentResult	createDeployment(CreateDeploymentRequest createDeploymentRequest) Deploys an application revision through the specified deployment group.
CreateDeploymentConfigResult	createDeploymentConfig(CreateDeploymentConfigRequest createDeploymentConfigRequest) Creates a new deployment configuration.
CreateDeploymentGroupResult	createDeploymentGroup(CreateDeploymentGroupRequest createDeploymentGroupRequest) Creates a new deployment group for application revisions to be deployed to.
void	deleteApplication(DeleteApplicationRequest deleteApplicationRequest) Deletes an application.
void	deleteDeploymentConfig(DeleteDeploymentConfigRequest deleteDeploymentConfigRequest) Deletes a deployment configuration.
DeleteDeploymentGroupResult	deleteDeploymentGroup(DeleteDeploymentGroupRequest deleteDeploymentGroupRequest) Deletes a deployment group.
void	deregisterOnPremisesInstance(DeregisterOnPremisesInstanceRequest deregisterOnPremisesInstanceRequest) Deregisters an on-premises instance.
GetApplicationResult	getApplication(GetApplicationRequest getApplicationRequest) Gets information about an application.
GetApplicationRevisionResult	getApplicationRevision(GetApplicationRevisionRequest getApplicationRevisionRequest) 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 getDeploymentRequest) Gets information about a deployment.
GetDeploymentConfigResult	getDeploymentConfig(GetDeploymentConfigRequest getDeploymentConfigRequest) Gets information about a deployment configuration.
GetDeploymentGroupResult	getDeploymentGroup(GetDeploymentGroupRequest getDeploymentGroupRequest) Gets information about a deployment group.
GetDeploymentInstanceResult	getDeploymentInstance(GetDeploymentInstanceRequest getDeploymentInstanceRequest) Gets information about an instance as part of a deployment.
GetOnPremisesInstanceResult	getOnPremisesInstance(GetOnPremisesInstanceRequest getOnPremisesInstanceRequest) Gets information about an on-premises instance.
ListApplicationRevisionsResult	listApplicationRevisions(ListApplicationRevisionsRequest listApplicationRevisionsRequest) Lists information about revisions for an application.
ListApplicationsResult	listApplications() Lists the applications registered with the applicable IAM user or AWS account.
ListApplicationsResult	listApplications(ListApplicationsRequest listApplicationsRequest) Lists the applications registered with the applicable IAM user or AWS account.
ListDeploymentConfigsResult	listDeploymentConfigs() Lists the deployment configurations with the applicable IAM user or AWS account.
ListDeploymentConfigsResult	listDeploymentConfigs(ListDeploymentConfigsRequest listDeploymentConfigsRequest) Lists the deployment configurations with the applicable IAM user or AWS account.
ListDeploymentGroupsResult	listDeploymentGroups(ListDeploymentGroupsRequest listDeploymentGroupsRequest) Lists the deployment groups for an application registered with the applicable IAM user or AWS account.
ListDeploymentInstancesResult	listDeploymentInstances(ListDeploymentInstancesRequest listDeploymentInstancesRequest) Lists the instances for a deployment associated with the applicable IAM user or AWS account.
ListDeploymentsResult	listDeployments() Lists the deployments within a deployment group for an application registered with the applicable IAM user or AWS account.
ListDeploymentsResult	listDeployments(ListDeploymentsRequest listDeploymentsRequest) Lists the deployments within a deployment group for an application registered with the applicable IAM user or AWS account.
ListOnPremisesInstancesResult	listOnPremisesInstances() Gets a list of one or more on-premises instance names.
ListOnPremisesInstancesResult	listOnPremisesInstances(ListOnPremisesInstancesRequest listOnPremisesInstancesRequest) Gets a list of one or more on-premises instance names.
void	registerApplicationRevision(RegisterApplicationRevisionRequest registerApplicationRevisionRequest) Registers with AWS CodeDeploy a revision for the specified application.
void	registerOnPremisesInstance(RegisterOnPremisesInstanceRequest registerOnPremisesInstanceRequest) Registers an on-premises instance.
void	removeTagsFromOnPremisesInstances(RemoveTagsFromOnPremisesInstancesRequest removeTagsFromOnPremisesInstancesRequest) Removes one or more tags from one or more on-premises instances.
void	setEndpoint(String endpoint) Overrides the default endpoint for this client ("https://codedeploy.us-east-1.amazonaws.com/").
void	setRegion(Region region) An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StopDeploymentResult	stopDeployment(StopDeploymentRequest stopDeploymentRequest) Attempts to stop an ongoing deployment.
void	updateApplication() Changes an existing application's name.
void	updateApplication(UpdateApplicationRequest updateApplicationRequest) Changes an existing application's name.
UpdateDeploymentGroupResult	updateDeploymentGroup(UpdateDeploymentGroupRequest updateDeploymentGroupRequest) Changes information about an existing deployment group.

Method Detail

setEndpoint

void setEndpoint(String endpoint)
                 throws IllegalArgumentException

Overrides the default endpoint for this client ("https://codedeploy.us-east-1.amazonaws.com/"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "codedeploy.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "https://codedeploy.us-east-1.amazonaws.com/"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

endpoint - The endpoint (ex: "codedeploy.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "https://codedeploy.us-east-1.amazonaws.com/") of the region specific AWS endpoint this client will communicate with.

Throws:

IllegalArgumentException - If any problems are detected with the specified endpoint.

setRegion

void setRegion(Region region)
               throws IllegalArgumentException

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region.

Throws:

IllegalArgumentException - If the given region is null, or if this service isn't available in the given region. See Region.isServiceSupported(String)

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)

deregisterOnPremisesInstance

void deregisterOnPremisesInstance(DeregisterOnPremisesInstanceRequest deregisterOnPremisesInstanceRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

Deregisters an on-premises instance.

Parameters:

deregisterOnPremisesInstanceRequest - Container for the necessary parameters to execute the DeregisterOnPremisesInstance service method on AmazonCodeDeploy.

Throws:

InvalidInstanceNameException

InstanceNameRequiredException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCodeDeploy indicating either a problem with the data in the request, or a server side issue.

updateApplication

void updateApplication(UpdateApplicationRequest updateApplicationRequest)
                       throws AmazonServiceException,
                              AmazonClientException

Changes an existing application's name.

Parameters:

updateApplicationRequest - Container for the necessary parameters to execute the UpdateApplication service method on AmazonCodeDeploy.

Throws:

InvalidApplicationNameException

ApplicationAlreadyExistsException

ApplicationDoesNotExistException

ApplicationNameRequiredException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCodeDeploy indicating either a problem with the data in the request, or a server side issue.

listApplications

ListApplicationsResult listApplications(ListApplicationsRequest listApplicationsRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

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

Parameters:

listApplicationsRequest - Container for the necessary parameters to execute the ListApplications service method on AmazonCodeDeploy.

Returns:

The response from the ListApplications service method, as returned by AmazonCodeDeploy.

Throws:

InvalidNextTokenException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCodeDeploy indicating either a problem with the data in the request, or a server side issue.

deleteDeploymentGroup

DeleteDeploymentGroupResult deleteDeploymentGroup(DeleteDeploymentGroupRequest deleteDeploymentGroupRequest)
                                                  throws AmazonServiceException,
                                                         AmazonClientException

Deletes a deployment group.

Parameters:

deleteDeploymentGroupRequest - Container for the necessary parameters to execute the DeleteDeploymentGroup service method on AmazonCodeDeploy.

Returns:

The response from the DeleteDeploymentGroup service method, as returned by AmazonCodeDeploy.

Throws:

InvalidRoleException

InvalidDeploymentGroupNameException

InvalidApplicationNameException

DeploymentGroupNameRequiredException

ApplicationNameRequiredException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCodeDeploy indicating either a problem with the data in the request, or a server side issue.

addTagsToOnPremisesInstances

void addTagsToOnPremisesInstances(AddTagsToOnPremisesInstancesRequest addTagsToOnPremisesInstancesRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

Adds a tag to an on-premises instance.

Parameters:

addTagsToOnPremisesInstancesRequest - Container for the necessary parameters to execute the AddTagsToOnPremisesInstances service method on AmazonCodeDeploy.

Throws:

InstanceNotRegisteredException

TagLimitExceededException

InstanceLimitExceededException

InvalidTagException

InstanceNameRequiredException

TagRequiredException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCodeDeploy indicating either a problem with the data in the request, or a server side issue.

listDeployments

ListDeploymentsResult listDeployments(ListDeploymentsRequest listDeploymentsRequest)
                                      throws AmazonServiceException,
                                             AmazonClientException

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

Parameters:

listDeploymentsRequest - Container for the necessary parameters to execute the ListDeployments service method on AmazonCodeDeploy.

Returns:

The response from the ListDeployments service method, as returned by AmazonCodeDeploy.

Throws:

DeploymentGroupDoesNotExistException

InvalidDeploymentGroupNameException

InvalidApplicationNameException

InvalidTimeRangeException

DeploymentGroupNameRequiredException

InvalidNextTokenException

ApplicationDoesNotExistException

InvalidDeploymentStatusException

ApplicationNameRequiredException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCodeDeploy indicating either a problem with the data in the request, or a server side issue.

stopDeployment

StopDeploymentResult stopDeployment(StopDeploymentRequest stopDeploymentRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

Attempts to stop an ongoing deployment.

Parameters:

stopDeploymentRequest - Container for the necessary parameters to execute the StopDeployment service method on AmazonCodeDeploy.

Returns:

The response from the StopDeployment service method, as returned by AmazonCodeDeploy.

Throws:

InvalidDeploymentIdException

DeploymentAlreadyCompletedException

DeploymentIdRequiredException

DeploymentDoesNotExistException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCodeDeploy indicating either a problem with the data in the request, or a server side issue.

createApplication

CreateApplicationResult createApplication(CreateApplicationRequest createApplicationRequest)
                                          throws AmazonServiceException,
                                                 AmazonClientException

Creates a new application.

Parameters:

createApplicationRequest - Container for the necessary parameters to execute the CreateApplication service method on AmazonCodeDeploy.

Returns:

The response from the CreateApplication service method, as returned by AmazonCodeDeploy.

Throws:

InvalidApplicationNameException

ApplicationAlreadyExistsException

ApplicationLimitExceededException

ApplicationNameRequiredException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCodeDeploy indicating either a problem with the data in the request, or a server side issue.

getApplication

GetApplicationResult getApplication(GetApplicationRequest getApplicationRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

Gets information about an application.

Parameters:

getApplicationRequest - Container for the necessary parameters to execute the GetApplication service method on AmazonCodeDeploy.

Returns:

The response from the GetApplication service method, as returned by AmazonCodeDeploy.

Throws:

InvalidApplicationNameException

ApplicationDoesNotExistException

ApplicationNameRequiredException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCodeDeploy indicating either a problem with the data in the request, or a server side issue.

createDeploymentGroup

CreateDeploymentGroupResult createDeploymentGroup(CreateDeploymentGroupRequest createDeploymentGroupRequest)
                                                  throws AmazonServiceException,
                                                         AmazonClientException

Creates a new deployment group for application revisions to be deployed to.

Parameters:

createDeploymentGroupRequest - Container for the necessary parameters to execute the CreateDeploymentGroup service method on AmazonCodeDeploy.

Returns:

The response from the CreateDeploymentGroup service method, as returned by AmazonCodeDeploy.

Throws:

RoleRequiredException

InvalidRoleException

InvalidDeploymentGroupNameException

DeploymentConfigDoesNotExistException

InvalidAutoScalingGroupException

InvalidApplicationNameException

DeploymentGroupNameRequiredException

InvalidDeploymentConfigNameException

DeploymentGroupAlreadyExistsException

InvalidTagException

DeploymentGroupLimitExceededException

ApplicationDoesNotExistException

ApplicationNameRequiredException

InvalidEC2TagException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCodeDeploy indicating either a problem with the data in the request, or a server side issue.

batchGetOnPremisesInstances

BatchGetOnPremisesInstancesResult batchGetOnPremisesInstances(BatchGetOnPremisesInstancesRequest batchGetOnPremisesInstancesRequest)
                                                              throws AmazonServiceException,
                                                                     AmazonClientException

Gets information about one or more on-premises instances.

Parameters:

batchGetOnPremisesInstancesRequest - Container for the necessary parameters to execute the BatchGetOnPremisesInstances service method on AmazonCodeDeploy.

Returns:

The response from the BatchGetOnPremisesInstances service method, as returned by AmazonCodeDeploy.

Throws:

InvalidInstanceNameException

InstanceNameRequiredException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCodeDeploy indicating either a problem with the data in the request, or a server side issue.

batchGetDeployments

BatchGetDeploymentsResult batchGetDeployments(BatchGetDeploymentsRequest batchGetDeploymentsRequest)
                                              throws AmazonServiceException,
                                                     AmazonClientException

Gets information about one or more deployments.

Parameters:

batchGetDeploymentsRequest - Container for the necessary parameters to execute the BatchGetDeployments service method on AmazonCodeDeploy.

Returns:

The response from the BatchGetDeployments service method, as returned by AmazonCodeDeploy.

Throws:

InvalidDeploymentIdException

DeploymentIdRequiredException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCodeDeploy indicating either a problem with the data in the request, or a server side issue.

getDeploymentInstance

GetDeploymentInstanceResult getDeploymentInstance(GetDeploymentInstanceRequest getDeploymentInstanceRequest)
                                                  throws AmazonServiceException,
                                                         AmazonClientException

Gets information about an instance as part of a deployment.

Parameters:

getDeploymentInstanceRequest - Container for the necessary parameters to execute the GetDeploymentInstance service method on AmazonCodeDeploy.

Returns:

The response from the GetDeploymentInstance service method, as returned by AmazonCodeDeploy.

Throws:

InvalidDeploymentIdException

InstanceIdRequiredException

DeploymentIdRequiredException

DeploymentDoesNotExistException

InstanceDoesNotExistException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCodeDeploy indicating either a problem with the data in the request, or a server side issue.

getApplicationRevision

GetApplicationRevisionResult getApplicationRevision(GetApplicationRevisionRequest getApplicationRevisionRequest)
                                                    throws AmazonServiceException,
                                                           AmazonClientException

Gets information about an application revision.

Parameters:

getApplicationRevisionRequest - Container for the necessary parameters to execute the GetApplicationRevision service method on AmazonCodeDeploy.

Returns:

The response from the GetApplicationRevision service method, as returned by AmazonCodeDeploy.

Throws:

InvalidRevisionException

RevisionRequiredException

InvalidApplicationNameException

RevisionDoesNotExistException

ApplicationDoesNotExistException

ApplicationNameRequiredException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCodeDeploy indicating either a problem with the data in the request, or a server side issue.

registerOnPremisesInstance

void registerOnPremisesInstance(RegisterOnPremisesInstanceRequest registerOnPremisesInstanceRequest)
                                throws AmazonServiceException,
                                       AmazonClientException

Registers an on-premises instance.

Parameters:

registerOnPremisesInstanceRequest - Container for the necessary parameters to execute the RegisterOnPremisesInstance service method on AmazonCodeDeploy.

Throws:

InvalidIamUserArnException

InvalidInstanceNameException

InstanceNameRequiredException

InstanceNameAlreadyRegisteredException

IamUserArnAlreadyRegisteredException

IamUserArnRequiredException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCodeDeploy indicating either a problem with the data in the request, or a server side issue.

getDeploymentGroup

GetDeploymentGroupResult getDeploymentGroup(GetDeploymentGroupRequest getDeploymentGroupRequest)
                                            throws AmazonServiceException,
                                                   AmazonClientException

Gets information about a deployment group.

Parameters:

getDeploymentGroupRequest - Container for the necessary parameters to execute the GetDeploymentGroup service method on AmazonCodeDeploy.

Returns:

The response from the GetDeploymentGroup service method, as returned by AmazonCodeDeploy.

Throws:

DeploymentGroupDoesNotExistException

InvalidDeploymentGroupNameException

InvalidApplicationNameException

DeploymentGroupNameRequiredException

ApplicationDoesNotExistException

ApplicationNameRequiredException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCodeDeploy indicating either a problem with the data in the request, or a server side issue.

createDeploymentConfig

CreateDeploymentConfigResult createDeploymentConfig(CreateDeploymentConfigRequest createDeploymentConfigRequest)
                                                    throws AmazonServiceException,
                                                           AmazonClientException

Creates a new deployment configuration.

Parameters:

createDeploymentConfigRequest - Container for the necessary parameters to execute the CreateDeploymentConfig service method on AmazonCodeDeploy.

Returns:

The response from the CreateDeploymentConfig service method, as returned by AmazonCodeDeploy.

Throws:

DeploymentConfigLimitExceededException

InvalidMinimumHealthyHostValueException

InvalidDeploymentConfigNameException

DeploymentConfigAlreadyExistsException

DeploymentConfigNameRequiredException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCodeDeploy indicating either a problem with the data in the request, or a server side issue.

listDeploymentInstances

ListDeploymentInstancesResult listDeploymentInstances(ListDeploymentInstancesRequest listDeploymentInstancesRequest)
                                                      throws AmazonServiceException,
                                                             AmazonClientException

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

Parameters:

listDeploymentInstancesRequest - Container for the necessary parameters to execute the ListDeploymentInstances service method on AmazonCodeDeploy.

Returns:

The response from the ListDeploymentInstances service method, as returned by AmazonCodeDeploy.

Throws:

InvalidDeploymentIdException

InvalidInstanceStatusException

DeploymentIdRequiredException

DeploymentDoesNotExistException

DeploymentNotStartedException

InvalidNextTokenException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCodeDeploy indicating either a problem with the data in the request, or a server side issue.

listOnPremisesInstances

ListOnPremisesInstancesResult listOnPremisesInstances(ListOnPremisesInstancesRequest listOnPremisesInstancesRequest)
                                                      throws AmazonServiceException,
                                                             AmazonClientException

Gets a list of one or more on-premises instance names.

Unless otherwise specified, both registered and deregistered on-premises instance names will be listed. To list only registered or deregistered on-premises instance names, use the registration status parameter.

Parameters:

listOnPremisesInstancesRequest - Container for the necessary parameters to execute the ListOnPremisesInstances service method on AmazonCodeDeploy.

Returns:

The response from the ListOnPremisesInstances service method, as returned by AmazonCodeDeploy.

Throws:

InvalidTagFilterException

InvalidRegistrationStatusException

InvalidNextTokenException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCodeDeploy indicating either a problem with the data in the request, or a server side issue.

listDeploymentGroups

ListDeploymentGroupsResult listDeploymentGroups(ListDeploymentGroupsRequest listDeploymentGroupsRequest)
                                                throws AmazonServiceException,
                                                       AmazonClientException

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

Parameters:

listDeploymentGroupsRequest - Container for the necessary parameters to execute the ListDeploymentGroups service method on AmazonCodeDeploy.

Returns:

The response from the ListDeploymentGroups service method, as returned by AmazonCodeDeploy.

Throws:

InvalidApplicationNameException

InvalidNextTokenException

ApplicationDoesNotExistException

ApplicationNameRequiredException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCodeDeploy indicating either a problem with the data in the request, or a server side issue.

getDeploymentConfig

GetDeploymentConfigResult getDeploymentConfig(GetDeploymentConfigRequest getDeploymentConfigRequest)
                                              throws AmazonServiceException,
                                                     AmazonClientException

Gets information about a deployment configuration.

Parameters:

getDeploymentConfigRequest - Container for the necessary parameters to execute the GetDeploymentConfig service method on AmazonCodeDeploy.

Returns:

The response from the GetDeploymentConfig service method, as returned by AmazonCodeDeploy.

Throws:

DeploymentConfigDoesNotExistException

InvalidDeploymentConfigNameException

DeploymentConfigNameRequiredException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCodeDeploy indicating either a problem with the data in the request, or a server side issue.

registerApplicationRevision

void registerApplicationRevision(RegisterApplicationRevisionRequest registerApplicationRevisionRequest)
                                 throws AmazonServiceException,
                                        AmazonClientException

Registers with AWS CodeDeploy a revision for the specified application.

Parameters:

registerApplicationRevisionRequest - Container for the necessary parameters to execute the RegisterApplicationRevision service method on AmazonCodeDeploy.

Throws:

InvalidRevisionException

RevisionRequiredException

InvalidApplicationNameException

DescriptionTooLongException

ApplicationDoesNotExistException

ApplicationNameRequiredException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCodeDeploy indicating either a problem with the data in the request, or a server side issue.

batchGetApplications

BatchGetApplicationsResult batchGetApplications(BatchGetApplicationsRequest batchGetApplicationsRequest)
                                                throws AmazonServiceException,
                                                       AmazonClientException

Gets information about one or more applications.

Parameters:

batchGetApplicationsRequest - Container for the necessary parameters to execute the BatchGetApplications service method on AmazonCodeDeploy.

Returns:

The response from the BatchGetApplications service method, as returned by AmazonCodeDeploy.

Throws:

InvalidApplicationNameException

ApplicationDoesNotExistException

ApplicationNameRequiredException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCodeDeploy indicating either a problem with the data in the request, or a server side issue.

getOnPremisesInstance

GetOnPremisesInstanceResult getOnPremisesInstance(GetOnPremisesInstanceRequest getOnPremisesInstanceRequest)
                                                  throws AmazonServiceException,
                                                         AmazonClientException

Gets information about an on-premises instance.

Parameters:

getOnPremisesInstanceRequest - Container for the necessary parameters to execute the GetOnPremisesInstance service method on AmazonCodeDeploy.

Returns:

The response from the GetOnPremisesInstance service method, as returned by AmazonCodeDeploy.

Throws:

InstanceNotRegisteredException

InvalidInstanceNameException

InstanceNameRequiredException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCodeDeploy indicating either a problem with the data in the request, or a server side issue.

listApplicationRevisions

ListApplicationRevisionsResult listApplicationRevisions(ListApplicationRevisionsRequest listApplicationRevisionsRequest)
                                                        throws AmazonServiceException,
                                                               AmazonClientException

Lists information about revisions for an application.

Parameters:

listApplicationRevisionsRequest - Container for the necessary parameters to execute the ListApplicationRevisions service method on AmazonCodeDeploy.

Returns:

The response from the ListApplicationRevisions service method, as returned by AmazonCodeDeploy.

Throws:

InvalidSortByException

InvalidApplicationNameException

InvalidKeyPrefixFilterException

InvalidNextTokenException

BucketNameFilterRequiredException

InvalidSortOrderException

InvalidDeployedStateFilterException

ApplicationDoesNotExistException

ApplicationNameRequiredException

InvalidBucketNameFilterException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCodeDeploy indicating either a problem with the data in the request, or a server side issue.

updateDeploymentGroup

UpdateDeploymentGroupResult updateDeploymentGroup(UpdateDeploymentGroupRequest updateDeploymentGroupRequest)
                                                  throws AmazonServiceException,
                                                         AmazonClientException

Changes information about an existing deployment group.

Parameters:

updateDeploymentGroupRequest - Container for the necessary parameters to execute the UpdateDeploymentGroup service method on AmazonCodeDeploy.

Returns:

The response from the UpdateDeploymentGroup service method, as returned by AmazonCodeDeploy.

Throws:

InvalidRoleException

DeploymentGroupDoesNotExistException

InvalidDeploymentGroupNameException

DeploymentConfigDoesNotExistException

InvalidApplicationNameException

InvalidAutoScalingGroupException

DeploymentGroupNameRequiredException

InvalidDeploymentConfigNameException

DeploymentGroupAlreadyExistsException

InvalidTagException

ApplicationDoesNotExistException

ApplicationNameRequiredException

InvalidEC2TagException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCodeDeploy indicating either a problem with the data in the request, or a server side issue.

deleteDeploymentConfig

void deleteDeploymentConfig(DeleteDeploymentConfigRequest deleteDeploymentConfigRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

Deletes a deployment configuration.

NOTE:A deployment configuration cannot be deleted if it is currently in use. Also, predefined configurations cannot be deleted.

Parameters:

deleteDeploymentConfigRequest - Container for the necessary parameters to execute the DeleteDeploymentConfig service method on AmazonCodeDeploy.

Throws:

InvalidOperationException

InvalidDeploymentConfigNameException

DeploymentConfigInUseException

DeploymentConfigNameRequiredException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCodeDeploy indicating either a problem with the data in the request, or a server side issue.

deleteApplication

void deleteApplication(DeleteApplicationRequest deleteApplicationRequest)
                       throws AmazonServiceException,
                              AmazonClientException

Deletes an application.

Parameters:

deleteApplicationRequest - Container for the necessary parameters to execute the DeleteApplication service method on AmazonCodeDeploy.

Throws:

InvalidApplicationNameException

ApplicationNameRequiredException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCodeDeploy indicating either a problem with the data in the request, or a server side issue.

getDeployment

GetDeploymentResult getDeployment(GetDeploymentRequest getDeploymentRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

Gets information about a deployment.

Parameters:

getDeploymentRequest - Container for the necessary parameters to execute the GetDeployment service method on AmazonCodeDeploy.

Returns:

The response from the GetDeployment service method, as returned by AmazonCodeDeploy.

Throws:

InvalidDeploymentIdException

DeploymentIdRequiredException

DeploymentDoesNotExistException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCodeDeploy indicating either a problem with the data in the request, or a server side issue.

createDeployment

CreateDeploymentResult createDeployment(CreateDeploymentRequest createDeploymentRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

Deploys an application revision through the specified deployment group.

Parameters:

createDeploymentRequest - Container for the necessary parameters to execute the CreateDeployment service method on AmazonCodeDeploy.

Returns:

The response from the CreateDeployment service method, as returned by AmazonCodeDeploy.

Throws:

InvalidRevisionException

DeploymentGroupDoesNotExistException

RevisionRequiredException

InvalidDeploymentGroupNameException

DeploymentConfigDoesNotExistException

InvalidApplicationNameException

DeploymentGroupNameRequiredException

DescriptionTooLongException

InvalidDeploymentConfigNameException

DeploymentLimitExceededException

ApplicationDoesNotExistException

ApplicationNameRequiredException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCodeDeploy indicating either a problem with the data in the request, or a server side issue.

removeTagsFromOnPremisesInstances

void removeTagsFromOnPremisesInstances(RemoveTagsFromOnPremisesInstancesRequest removeTagsFromOnPremisesInstancesRequest)
                                       throws AmazonServiceException,
                                              AmazonClientException

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

Parameters:

removeTagsFromOnPremisesInstancesRequest - Container for the necessary parameters to execute the RemoveTagsFromOnPremisesInstances service method on AmazonCodeDeploy.

Throws:

InstanceNotRegisteredException

TagLimitExceededException

InstanceLimitExceededException

InvalidTagException

InstanceNameRequiredException

TagRequiredException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCodeDeploy indicating either a problem with the data in the request, or a server side issue.

listDeploymentConfigs

ListDeploymentConfigsResult listDeploymentConfigs(ListDeploymentConfigsRequest listDeploymentConfigsRequest)
                                                  throws AmazonServiceException,
                                                         AmazonClientException

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

Parameters:

listDeploymentConfigsRequest - Container for the necessary parameters to execute the ListDeploymentConfigs service method on AmazonCodeDeploy.

Returns:

The response from the ListDeploymentConfigs service method, as returned by AmazonCodeDeploy.

Throws:

InvalidNextTokenException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCodeDeploy indicating either a problem with the data in the request, or a server side issue.

updateApplication

void updateApplication()
                       throws AmazonServiceException,
                              AmazonClientException

Changes an existing application's name.

Throws:

InvalidApplicationNameException

ApplicationAlreadyExistsException

ApplicationDoesNotExistException

ApplicationNameRequiredException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCodeDeploy indicating either a problem with the data in the request, or a server side issue.

listApplications

ListApplicationsResult listApplications()
                                        throws AmazonServiceException,
                                               AmazonClientException

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

Returns:

The response from the ListApplications service method, as returned by AmazonCodeDeploy.

Throws:

InvalidNextTokenException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCodeDeploy indicating either a problem with the data in the request, or a server side issue.

listDeployments

ListDeploymentsResult listDeployments()
                                      throws AmazonServiceException,
                                             AmazonClientException

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

Returns:

The response from the ListDeployments service method, as returned by AmazonCodeDeploy.

Throws:

DeploymentGroupDoesNotExistException

InvalidDeploymentGroupNameException

InvalidApplicationNameException

InvalidTimeRangeException

DeploymentGroupNameRequiredException

InvalidNextTokenException

ApplicationDoesNotExistException

InvalidDeploymentStatusException

ApplicationNameRequiredException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCodeDeploy indicating either a problem with the data in the request, or a server side issue.

batchGetOnPremisesInstances

BatchGetOnPremisesInstancesResult batchGetOnPremisesInstances()
                                                              throws AmazonServiceException,
                                                                     AmazonClientException

Gets information about one or more on-premises instances.

Returns:

The response from the BatchGetOnPremisesInstances service method, as returned by AmazonCodeDeploy.

Throws:

InvalidInstanceNameException

InstanceNameRequiredException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCodeDeploy indicating either a problem with the data in the request, or a server side issue.

batchGetDeployments

BatchGetDeploymentsResult batchGetDeployments()
                                              throws AmazonServiceException,
                                                     AmazonClientException

Gets information about one or more deployments.

Returns:

The response from the BatchGetDeployments service method, as returned by AmazonCodeDeploy.

Throws:

InvalidDeploymentIdException

DeploymentIdRequiredException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCodeDeploy indicating either a problem with the data in the request, or a server side issue.

listOnPremisesInstances

ListOnPremisesInstancesResult listOnPremisesInstances()
                                                      throws AmazonServiceException,
                                                             AmazonClientException

Gets a list of one or more on-premises instance names.

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.

Returns:

The response from the ListOnPremisesInstances service method, as returned by AmazonCodeDeploy.

Throws:

InvalidTagFilterException

InvalidRegistrationStatusException

InvalidNextTokenException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCodeDeploy indicating either a problem with the data in the request, or a server side issue.

batchGetApplications

BatchGetApplicationsResult batchGetApplications()
                                                throws AmazonServiceException,
                                                       AmazonClientException

Gets information about one or more applications.

Returns:

The response from the BatchGetApplications service method, as returned by AmazonCodeDeploy.

Throws:

InvalidApplicationNameException

ApplicationDoesNotExistException

ApplicationNameRequiredException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCodeDeploy indicating either a problem with the data in the request, or a server side issue.

listDeploymentConfigs

ListDeploymentConfigsResult listDeploymentConfigs()
                                                  throws AmazonServiceException,
                                                         AmazonClientException

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

Returns:

The response from the ListDeploymentConfigs service method, as returned by AmazonCodeDeploy.

Throws:

InvalidNextTokenException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCodeDeploy indicating either a problem with the data in the request, or a server side issue.

shutdown

void shutdown()

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.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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