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

public class AmazonCodeDeployClient
extends AmazonWebServiceClient
implements AmazonCodeDeploy

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

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 , which 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 work with applications by calling CreateApplication, DeleteApplication, GetApplication, ListApplications, BatchGetApplications, and UpdateApplication to create, delete, and get information about applications, and to change information about an application, respectively.

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

  You can work with deployment configurations by calling CreateDeploymentConfig, DeleteDeploymentConfig, GetDeploymentConfig, and ListDeploymentConfigs to create, delete, and get information about deployment configurations, respectively.

• Deployment groups , which represent groups of Amazon EC2 instances to which application revisions can be deployed.

  You can work with deployment groups by calling CreateDeploymentGroup, DeleteDeploymentGroup, GetDeploymentGroup, ListDeploymentGroups, and UpdateDeploymentGroup to create, delete, and get information about single and multiple deployment groups, and to change information about a deployment group, respectively.

• Deployment instances (also known simply as instances ), which represent Amazon EC2 instances to which application revisions are deployed. Deployment instances are identified by their Amazon EC2 tags or Auto Scaling group names. Deployment instances belong to deployment groups.

  You can work with deployment instances by calling GetDeploymentInstance and ListDeploymentInstances to get information about single and multiple deployment instances, respectively.

• Deployments , which represent the process of deploying revisions to deployment groups.

  You can work with deployments by calling CreateDeployment, GetDeployment, ListDeployments, BatchGetDeployments, and StopDeployment to create and get information about deployments, and to stop a deployment, respectively.

• Application revisions (also known simply as revisions ), which 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. Application revisions are deployed to deployment groups.

  You can work with application revisions by calling GetApplicationRevision, ListApplicationRevisions, and RegisterApplicationRevision to get information about application revisions and to inform AWS CodeDeploy about an application revision, respectively.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<com.amazonaws.transform.JsonErrorUnmarshaller>	jsonErrorUnmarshallers List of exception unmarshallers for all AmazonCodeDeploy exceptions.

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Constructor Summary

Constructors

Constructor and Description
AmazonCodeDeployClient() Constructs a new client to invoke service methods on AmazonCodeDeploy.
AmazonCodeDeployClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on AmazonCodeDeploy using the specified AWS account credentials.
AmazonCodeDeployClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonCodeDeploy using the specified AWS account credentials and client configuration options.
AmazonCodeDeployClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on AmazonCodeDeploy using the specified AWS account credentials provider.
AmazonCodeDeployClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonCodeDeploy using the specified AWS account credentials provider and client configuration options.
AmazonCodeDeployClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Constructs a new client to invoke service methods on AmazonCodeDeploy using the specified AWS account credentials provider, client configuration options and request metric collector.
AmazonCodeDeployClient(ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonCodeDeploy.

Method Summary

Methods

Modifier and Type	Method and Description
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.
CreateApplicationResult	createApplication(CreateApplicationRequest createApplicationRequest) Creates a new application.
CreateDeploymentResult	createDeployment(CreateDeploymentRequest createDeploymentRequest) Deploys an application revision to 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.
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 Amazon EC2 instance as part of a deployment.
ListApplicationRevisionsResult	listApplicationRevisions(ListApplicationRevisionsRequest listApplicationRevisionsRequest) Lists information about revisions for an application.
ListApplicationsResult	listApplications() Lists the applications registered within the AWS user account.
ListApplicationsResult	listApplications(ListApplicationsRequest listApplicationsRequest) Lists the applications registered within the AWS user account.
ListDeploymentConfigsResult	listDeploymentConfigs() Lists the deployment configurations within the AWS user account.
ListDeploymentConfigsResult	listDeploymentConfigs(ListDeploymentConfigsRequest listDeploymentConfigsRequest) Lists the deployment configurations within the AWS user account.
ListDeploymentGroupsResult	listDeploymentGroups(ListDeploymentGroupsRequest listDeploymentGroupsRequest) Lists the deployment groups for an application registered within the AWS user account.
ListDeploymentInstancesResult	listDeploymentInstances(ListDeploymentInstancesRequest listDeploymentInstancesRequest) Lists the Amazon EC2 instances for a deployment within the AWS user account.
ListDeploymentsResult	listDeployments() Lists the deployments under a deployment group for an application registered within the AWS user account.
ListDeploymentsResult	listDeployments(ListDeploymentsRequest listDeploymentsRequest) Lists the deployments under a deployment group for an application registered within the AWS user account.
void	registerApplicationRevision(RegisterApplicationRevisionRequest registerApplicationRevisionRequest) Registers with AWS CodeDeploy a revision for the specified application.
void	setEndpoint(String endpoint) Overrides the default endpoint for this client ("https://codedeploy.us-east-1.amazonaws.com/").
void	setEndpoint(String endpoint, String serviceName, String regionId)
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.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configSigner, configSigner, convertToHttpRequest, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setConfiguration, setRegion, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

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

setRegion, shutdown

Field Detail

jsonErrorUnmarshallers

protected List<com.amazonaws.transform.JsonErrorUnmarshaller> jsonErrorUnmarshallers

List of exception unmarshallers for all AmazonCodeDeploy exceptions.

Constructor Detail

AmazonCodeDeployClient

public AmazonCodeDeployClient()

Constructs a new client to invoke service methods on AmazonCodeDeploy. 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

public AmazonCodeDeployClient(ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonCodeDeploy. 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 AmazonCodeDeploy (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AmazonCodeDeployClient

public AmazonCodeDeployClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on AmazonCodeDeploy 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

public AmazonCodeDeployClient(AWSCredentials awsCredentials,
                      ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonCodeDeploy 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 AmazonCodeDeploy (ex: proxy settings, retry counts, etc.).

AmazonCodeDeployClient

public AmazonCodeDeployClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on AmazonCodeDeploy 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

public AmazonCodeDeployClient(AWSCredentialsProvider awsCredentialsProvider,
                      ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonCodeDeploy 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 AmazonCodeDeploy (ex: proxy settings, retry counts, etc.).

AmazonCodeDeployClient

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

Constructs a new client to invoke service methods on AmazonCodeDeploy 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 AmazonCodeDeploy (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

Method Detail

getDeploymentGroup

public GetDeploymentGroupResult getDeploymentGroup(GetDeploymentGroupRequest getDeploymentGroupRequest)

Gets information about a deployment group.

Specified by:

getDeploymentGroup in interface AmazonCodeDeploy

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.

updateApplication

public void updateApplication(UpdateApplicationRequest updateApplicationRequest)

Changes an existing application's name.

Specified by:

updateApplication in interface AmazonCodeDeploy

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.

createDeploymentConfig

public CreateDeploymentConfigResult createDeploymentConfig(CreateDeploymentConfigRequest createDeploymentConfigRequest)

Creates a new deployment configuration.

Specified by:

createDeploymentConfig in interface AmazonCodeDeploy

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

public ListDeploymentInstancesResult listDeploymentInstances(ListDeploymentInstancesRequest listDeploymentInstancesRequest)

Lists the Amazon EC2 instances for a deployment within the AWS user account.

Specified by:

listDeploymentInstances in interface AmazonCodeDeploy

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.

listApplications

public ListApplicationsResult listApplications(ListApplicationsRequest listApplicationsRequest)

Lists the applications registered within the AWS user account.

Specified by:

listApplications in interface AmazonCodeDeploy

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.

registerApplicationRevision

public void registerApplicationRevision(RegisterApplicationRevisionRequest registerApplicationRevisionRequest)

Registers with AWS CodeDeploy a revision for the specified application.

Specified by:

registerApplicationRevision in interface AmazonCodeDeploy

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.

getDeploymentConfig

public GetDeploymentConfigResult getDeploymentConfig(GetDeploymentConfigRequest getDeploymentConfigRequest)

Gets information about a deployment configuration.

Specified by:

getDeploymentConfig in interface AmazonCodeDeploy

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.

listDeploymentGroups

public ListDeploymentGroupsResult listDeploymentGroups(ListDeploymentGroupsRequest listDeploymentGroupsRequest)

Lists the deployment groups for an application registered within the AWS user account.

Specified by:

listDeploymentGroups in interface AmazonCodeDeploy

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.

batchGetApplications

public BatchGetApplicationsResult batchGetApplications(BatchGetApplicationsRequest batchGetApplicationsRequest)

Gets information about one or more applications.

Specified by:

batchGetApplications in interface AmazonCodeDeploy

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.

deleteDeploymentGroup

public DeleteDeploymentGroupResult deleteDeploymentGroup(DeleteDeploymentGroupRequest deleteDeploymentGroupRequest)

Deletes a deployment group.

Specified by:

deleteDeploymentGroup in interface AmazonCodeDeploy

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.

listApplicationRevisions

public ListApplicationRevisionsResult listApplicationRevisions(ListApplicationRevisionsRequest listApplicationRevisionsRequest)

Lists information about revisions for an application.

Specified by:

listApplicationRevisions in interface AmazonCodeDeploy

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

public UpdateDeploymentGroupResult updateDeploymentGroup(UpdateDeploymentGroupRequest updateDeploymentGroupRequest)

Changes information about an existing deployment group.

Specified by:

updateDeploymentGroup in interface AmazonCodeDeploy

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

InvalidDeploymentGroupNameException

DeploymentConfigDoesNotExistException

InvalidApplicationNameException

InvalidAutoScalingGroupException

DeploymentGroupNameRequiredException

InvalidDeploymentConfigNameException

DeploymentGroupAlreadyExistsException

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.

listDeployments

public ListDeploymentsResult listDeployments(ListDeploymentsRequest listDeploymentsRequest)

Lists the deployments under a deployment group for an application registered within the AWS user account.

Specified by:

listDeployments in interface AmazonCodeDeploy

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.

getApplication

public GetApplicationResult getApplication(GetApplicationRequest getApplicationRequest)

Gets information about an application.

Specified by:

getApplication in interface AmazonCodeDeploy

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.

createApplication

public CreateApplicationResult createApplication(CreateApplicationRequest createApplicationRequest)

Creates a new application.

Specified by:

createApplication in interface AmazonCodeDeploy

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.

stopDeployment

public StopDeploymentResult stopDeployment(StopDeploymentRequest stopDeploymentRequest)

Attempts to stop an ongoing deployment.

Specified by:

stopDeployment in interface AmazonCodeDeploy

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.

createDeploymentGroup

public CreateDeploymentGroupResult createDeploymentGroup(CreateDeploymentGroupRequest createDeploymentGroupRequest)

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

Specified by:

createDeploymentGroup in interface AmazonCodeDeploy

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

InvalidApplicationNameException

InvalidAutoScalingGroupException

DeploymentGroupNameRequiredException

InvalidDeploymentConfigNameException

DeploymentGroupAlreadyExistsException

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.

deleteApplication

public void deleteApplication(DeleteApplicationRequest deleteApplicationRequest)

Deletes an application.

Specified by:

deleteApplication in interface AmazonCodeDeploy

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.

batchGetDeployments

public BatchGetDeploymentsResult batchGetDeployments(BatchGetDeploymentsRequest batchGetDeploymentsRequest)

Gets information about one or more deployments.

Specified by:

batchGetDeployments in interface AmazonCodeDeploy

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.

deleteDeploymentConfig

public void deleteDeploymentConfig(DeleteDeploymentConfigRequest deleteDeploymentConfigRequest)

Deletes a deployment configuration.

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

Specified by:

deleteDeploymentConfig in interface AmazonCodeDeploy

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.

getDeployment

public GetDeploymentResult getDeployment(GetDeploymentRequest getDeploymentRequest)

Gets information about a deployment.

Specified by:

getDeployment in interface AmazonCodeDeploy

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

public CreateDeploymentResult createDeployment(CreateDeploymentRequest createDeploymentRequest)

Deploys an application revision to the specified deployment group.

Specified by:

createDeployment in interface AmazonCodeDeploy

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.

getDeploymentInstance

public GetDeploymentInstanceResult getDeploymentInstance(GetDeploymentInstanceRequest getDeploymentInstanceRequest)

Gets information about an Amazon EC2 instance as part of a deployment.

Specified by:

getDeploymentInstance in interface AmazonCodeDeploy

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.

listDeploymentConfigs

public ListDeploymentConfigsResult listDeploymentConfigs(ListDeploymentConfigsRequest listDeploymentConfigsRequest)

Lists the deployment configurations within the AWS user account.

Specified by:

listDeploymentConfigs in interface AmazonCodeDeploy

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.

getApplicationRevision

public GetApplicationRevisionResult getApplicationRevision(GetApplicationRevisionRequest getApplicationRevisionRequest)

Gets information about an application revision.

Specified by:

getApplicationRevision in interface AmazonCodeDeploy

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.

updateApplication

public void updateApplication()
                       throws AmazonServiceException,
                              AmazonClientException

Changes an existing application's name.

Specified by:

updateApplication in interface 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

public ListApplicationsResult listApplications()
                                        throws AmazonServiceException,
                                               AmazonClientException

Lists the applications registered within the AWS user account.

Specified by:

listApplications in interface 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.

batchGetApplications

public BatchGetApplicationsResult batchGetApplications()
                                                throws AmazonServiceException,
                                                       AmazonClientException

Gets information about one or more applications.

Specified by:

batchGetApplications in interface 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.

listDeployments

public ListDeploymentsResult listDeployments()
                                      throws AmazonServiceException,
                                             AmazonClientException

Lists the deployments under a deployment group for an application registered within the AWS user account.

Specified by:

listDeployments in interface 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.

batchGetDeployments

public BatchGetDeploymentsResult batchGetDeployments()
                                              throws AmazonServiceException,
                                                     AmazonClientException

Gets information about one or more deployments.

Specified by:

batchGetDeployments in interface 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.

listDeploymentConfigs

public ListDeploymentConfigsResult listDeploymentConfigs()
                                                  throws AmazonServiceException,
                                                         AmazonClientException

Lists the deployment configurations within the AWS user account.

Specified by:

listDeploymentConfigs in interface 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.

setEndpoint

public void setEndpoint(String endpoint)

Description copied from interface: AmazonCodeDeploy

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.

Specified by:

setEndpoint in interface AmazonCodeDeploy

Overrides:

setEndpoint in class AmazonWebServiceClient

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.

setEndpoint

public void setEndpoint(String endpoint,
               String serviceName,
               String regionId)
                 throws IllegalArgumentException

Overrides:

setEndpoint in class AmazonWebServiceClient

Throws:

IllegalArgumentException

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.