com.amazonaws.services.codedeploy

Interface AmazonCodeDeploy

All Known Subinterfaces:

AmazonCodeDeployAsync

All Known Implementing Classes:

AbstractAmazonCodeDeploy, AbstractAmazonCodeDeployAsync, AmazonCodeDeployAsyncClient, AmazonCodeDeployClient

public interface AmazonCodeDeploy

Interface for accessing CodeDeploy.

AWS CodeDeploy Overview

This reference guide provides descriptions of the AWS CodeDeploy APIs. For more information about AWS CodeDeploy, see the AWS CodeDeploy User Guide.

Using the APIs

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

• Applications are unique identifiers used by AWS CodeDeploy to ensure 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 success and failure conditions used by AWS CodeDeploy 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 instance.

• 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 stored in Amazon S3 buckets or GitHub repositories. These revisions contain source content (such as source code, web pages, executable files, and deployment scripts) along with an application specification (AppSpec) file. (The AppSpec file is unique to AWS CodeDeploy; it defines the deployment actions you want AWS CodeDeploy to execute.) Ffor application revisions stored in Amazon S3 buckets, an application revision is uniquely identified by its Amazon S3 object key and its ETag, version, or both. For application revisions stored in GitHub repositories, an application revision is uniquely identified by its repository name and commit ID. 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 tags to on-premises instances.
BatchGetApplicationRevisionsResult	batchGetApplicationRevisions(BatchGetApplicationRevisionsRequest batchGetApplicationRevisionsRequest) Gets information about one or more application revisions.
BatchGetApplicationsResult	batchGetApplications() Simplified method form for invoking the BatchGetApplications operation.
BatchGetApplicationsResult	batchGetApplications(BatchGetApplicationsRequest batchGetApplicationsRequest) Gets information about one or more applications.
BatchGetDeploymentGroupsResult	batchGetDeploymentGroups(BatchGetDeploymentGroupsRequest batchGetDeploymentGroupsRequest) Get information about one or more deployment groups.
BatchGetDeploymentInstancesResult	batchGetDeploymentInstances(BatchGetDeploymentInstancesRequest batchGetDeploymentInstancesRequest) Gets information about one or more instance that are part of a deployment group.
BatchGetDeploymentsResult	batchGetDeployments() Simplified method form for invoking the BatchGetDeployments operation.
BatchGetDeploymentsResult	batchGetDeployments(BatchGetDeploymentsRequest batchGetDeploymentsRequest) Gets information about one or more deployments.
BatchGetOnPremisesInstancesResult	batchGetOnPremisesInstances() Simplified method form for invoking the BatchGetOnPremisesInstances operation.
BatchGetOnPremisesInstancesResult	batchGetOnPremisesInstances(BatchGetOnPremisesInstancesRequest batchGetOnPremisesInstancesRequest) Gets information about one or more on-premises instances.
CreateApplicationResult	createApplication(CreateApplicationRequest createApplicationRequest) Creates an application.
CreateDeploymentResult	createDeployment(CreateDeploymentRequest createDeploymentRequest) Deploys an application revision through the specified deployment group.
CreateDeploymentConfigResult	createDeploymentConfig(CreateDeploymentConfigRequest createDeploymentConfigRequest) Creates a deployment configuration.
CreateDeploymentGroupResult	createDeploymentGroup(CreateDeploymentGroupRequest createDeploymentGroupRequest) Creates a deployment group to which application revisions will be deployed.
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() Simplified method form for invoking the ListApplications operation.
ListApplicationsResult	listApplications(ListApplicationsRequest listApplicationsRequest) Lists the applications registered with the applicable IAM user or AWS account.
ListDeploymentConfigsResult	listDeploymentConfigs() Simplified method form for invoking the ListDeploymentConfigs operation.
ListDeploymentConfigsResult	listDeploymentConfigs(ListDeploymentConfigsRequest 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 instance for a deployment associated with the applicable IAM user or AWS account.
ListDeploymentsResult	listDeployments() Simplified method form for invoking the ListDeployments operation.
ListDeploymentsResult	listDeployments(ListDeploymentsRequest listDeploymentsRequest) Lists the deployments in a deployment group for an application registered with the applicable IAM user or AWS account.
ListOnPremisesInstancesResult	listOnPremisesInstances() Simplified method form for invoking the ListOnPremisesInstances operation.
ListOnPremisesInstancesResult	listOnPremisesInstances(ListOnPremisesInstancesRequest listOnPremisesInstancesRequest) Gets a list of names for one or more on-premises instances.
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() Simplified method form for invoking the UpdateApplication operation.
void	updateApplication(UpdateApplicationRequest updateApplicationRequest) Changes the name of an application.
UpdateDeploymentGroupResult	updateDeploymentGroup(UpdateDeploymentGroupRequest updateDeploymentGroupRequest) Changes information about a deployment group.

Method Detail

setEndpoint

void setEndpoint(String endpoint)

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.

setRegion

void setRegion(Region region)

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. Must not be null and must be a region where the service is available.

See Also:

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

addTagsToOnPremisesInstances

void addTagsToOnPremisesInstances(AddTagsToOnPremisesInstancesRequest addTagsToOnPremisesInstancesRequest)

Adds tags to on-premises instances.

Parameters:

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

Throws:

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

TagRequiredException - A tag was not specified.

InvalidTagException - The specified tag was specified in an invalid format.

TagLimitExceededException - The maximum allowed number of tags was exceeded.

InstanceLimitExceededException - The maximum number of allowed on-premises instances in a single call was exceeded.

InstanceNotRegisteredException - The specified on-premises instance is not registered.

batchGetApplicationRevisions

BatchGetApplicationRevisionsResult batchGetApplicationRevisions(BatchGetApplicationRevisionsRequest batchGetApplicationRevisionsRequest)

Gets information about one or more application revisions.

Parameters:

batchGetApplicationRevisionsRequest - Represents the input of a batch get application revisions operation.

Returns:

Result of the BatchGetApplicationRevisions operation returned by the service.

Throws:

ApplicationDoesNotExistException - The application does not exist with the applicable IAM user or AWS account.

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

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

RevisionRequiredException - The revision ID was not specified.

InvalidRevisionException - The revision was specified in an invalid format.

BatchLimitExceededException - The maximum number of names or IDs allowed for this request (100) was exceeded.

batchGetApplications

BatchGetApplicationsResult batchGetApplications(BatchGetApplicationsRequest batchGetApplicationsRequest)

Gets information about one or more applications.

Parameters:

batchGetApplicationsRequest - Represents the input of a batch get applications operation.

Returns:

Result of the BatchGetApplications operation returned by the service.

Throws:

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

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

ApplicationDoesNotExistException - The application does not exist with the applicable IAM user or AWS account.

BatchLimitExceededException - The maximum number of names or IDs allowed for this request (100) was exceeded.

batchGetApplications

BatchGetApplicationsResult batchGetApplications()

Simplified method form for invoking the BatchGetApplications operation.

See Also:

batchGetApplications(BatchGetApplicationsRequest)

batchGetDeploymentGroups

BatchGetDeploymentGroupsResult batchGetDeploymentGroups(BatchGetDeploymentGroupsRequest batchGetDeploymentGroupsRequest)

Get information about one or more deployment groups.

Parameters:

batchGetDeploymentGroupsRequest - Represents the input of a batch get deployment groups operation.

Returns:

Result of the BatchGetDeploymentGroups operation returned by the service.

Throws:

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

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

ApplicationDoesNotExistException - The application does not exist with the applicable IAM user or AWS account.

DeploymentGroupNameRequiredException - The deployment group name was not specified.

InvalidDeploymentGroupNameException - The deployment group name was specified in an invalid format.

BatchLimitExceededException - The maximum number of names or IDs allowed for this request (100) was exceeded.

batchGetDeploymentInstances

BatchGetDeploymentInstancesResult batchGetDeploymentInstances(BatchGetDeploymentInstancesRequest batchGetDeploymentInstancesRequest)

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

Parameters:

batchGetDeploymentInstancesRequest - Represents the input of a batch get deployment instances operation.

Returns:

Result of the BatchGetDeploymentInstances operation returned by the service.

Throws:

DeploymentIdRequiredException - At least one deployment ID must be specified.

DeploymentDoesNotExistException - The deployment does not exist with the applicable IAM user or AWS account.

InstanceIdRequiredException - The instance ID was not specified.

InvalidDeploymentIdException - At least one of the deployment IDs was specified in an invalid format.

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

BatchLimitExceededException - The maximum number of names or IDs allowed for this request (100) was exceeded.

batchGetDeployments

BatchGetDeploymentsResult batchGetDeployments(BatchGetDeploymentsRequest batchGetDeploymentsRequest)

Gets information about one or more deployments.

Parameters:

batchGetDeploymentsRequest - Represents the input of a batch get deployments operation.

Returns:

Result of the BatchGetDeployments operation returned by the service.

Throws:

DeploymentIdRequiredException - At least one deployment ID must be specified.

InvalidDeploymentIdException - At least one of the deployment IDs was specified in an invalid format.

BatchLimitExceededException - The maximum number of names or IDs allowed for this request (100) was exceeded.

batchGetDeployments

BatchGetDeploymentsResult batchGetDeployments()

Simplified method form for invoking the BatchGetDeployments operation.

See Also:

batchGetDeployments(BatchGetDeploymentsRequest)

batchGetOnPremisesInstances

BatchGetOnPremisesInstancesResult batchGetOnPremisesInstances(BatchGetOnPremisesInstancesRequest batchGetOnPremisesInstancesRequest)

Gets information about one or more on-premises instances.

Parameters:

batchGetOnPremisesInstancesRequest - Represents the input of a batch get on-premises instances operation.

Returns:

Result of the BatchGetOnPremisesInstances operation returned by the service.

Throws:

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

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

BatchLimitExceededException - The maximum number of names or IDs allowed for this request (100) was exceeded.

batchGetOnPremisesInstances

BatchGetOnPremisesInstancesResult batchGetOnPremisesInstances()

Simplified method form for invoking the BatchGetOnPremisesInstances operation.

See Also:

batchGetOnPremisesInstances(BatchGetOnPremisesInstancesRequest)

createApplication

CreateApplicationResult createApplication(CreateApplicationRequest createApplicationRequest)

Creates an application.

Parameters:

createApplicationRequest - Represents the input of a create application operation.

Returns:

Result of the CreateApplication operation returned by the service.

Throws:

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

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

ApplicationAlreadyExistsException - An application with the specified name already exists with the applicable IAM user or AWS account.

ApplicationLimitExceededException - More applications were attempted to be created than are allowed.

createDeployment

CreateDeploymentResult createDeployment(CreateDeploymentRequest createDeploymentRequest)

Deploys an application revision through the specified deployment group.

Parameters:

createDeploymentRequest - Represents the input of a create deployment operation.

Returns:

Result of the CreateDeployment operation returned by the service.

Throws:

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

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

ApplicationDoesNotExistException - The application does not exist with the applicable IAM user or AWS account.

DeploymentGroupNameRequiredException - The deployment group name was not specified.

InvalidDeploymentGroupNameException - The deployment group name was specified in an invalid format.

DeploymentGroupDoesNotExistException - The named deployment group does not exist with the applicable IAM user or AWS account.

RevisionRequiredException - The revision ID was not specified.

InvalidRevisionException - The revision was specified in an invalid format.

InvalidDeploymentConfigNameException - The deployment configuration name was specified in an invalid format.

DeploymentConfigDoesNotExistException - The deployment configuration does not exist with the applicable IAM user or AWS account.

DescriptionTooLongException - The description is too long.

DeploymentLimitExceededException - The number of allowed deployments was exceeded.

createDeploymentConfig

CreateDeploymentConfigResult createDeploymentConfig(CreateDeploymentConfigRequest createDeploymentConfigRequest)

Creates a deployment configuration.

Parameters:

createDeploymentConfigRequest - Represents the input of a create deployment configuration operation.

Returns:

Result of the CreateDeploymentConfig operation returned by the service.

Throws:

InvalidDeploymentConfigNameException - The deployment configuration name was specified in an invalid format.

DeploymentConfigNameRequiredException - The deployment configuration name was not specified.

DeploymentConfigAlreadyExistsException - A deployment configuration with the specified name already exists with the applicable IAM user or AWS account.

InvalidMinimumHealthyHostValueException - The minimum healthy instance value was specified in an invalid format.

DeploymentConfigLimitExceededException - The deployment configurations limit was exceeded.

createDeploymentGroup

CreateDeploymentGroupResult createDeploymentGroup(CreateDeploymentGroupRequest createDeploymentGroupRequest)

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

Parameters:

createDeploymentGroupRequest - Represents the input of a create deployment group operation.

Returns:

Result of the CreateDeploymentGroup operation returned by the service.

Throws:

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

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

ApplicationDoesNotExistException - The application does not exist with the applicable IAM user or AWS account.

DeploymentGroupNameRequiredException - The deployment group name was not specified.

InvalidDeploymentGroupNameException - The deployment group name was specified in an invalid format.

DeploymentGroupAlreadyExistsException - A deployment group with the specified name already exists with the applicable IAM user or AWS account.

InvalidEC2TagException - The tag was specified in an invalid format.

InvalidTagException - The specified tag was specified in an invalid format.

InvalidAutoScalingGroupException - The Auto Scaling group was specified in an invalid format or does not exist.

InvalidDeploymentConfigNameException - The deployment configuration name was specified in an invalid format.

DeploymentConfigDoesNotExistException - The deployment configuration does not exist with the applicable IAM user or AWS account.

RoleRequiredException - The role ID was not specified.

InvalidRoleException - The service role ARN was specified in an invalid format. Or, if an Auto Scaling group was specified, the specified service role does not grant the appropriate permissions to Auto Scaling.

DeploymentGroupLimitExceededException - The deployment groups limit was exceeded.

LifecycleHookLimitExceededException - The limit for lifecycle hooks was exceeded.

InvalidTriggerConfigException - The trigger was specified in an invalid format.

TriggerTargetsLimitExceededException - The maximum allowed number of triggers was exceeded.

deleteApplication

void deleteApplication(DeleteApplicationRequest deleteApplicationRequest)

Deletes an application.

Parameters:

deleteApplicationRequest - Represents the input of a delete application operation.

Throws:

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

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

deleteDeploymentConfig

void deleteDeploymentConfig(DeleteDeploymentConfigRequest deleteDeploymentConfigRequest)

Deletes a deployment configuration.

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

Parameters:

deleteDeploymentConfigRequest - Represents the input of a delete deployment configuration operation.

Throws:

InvalidDeploymentConfigNameException - The deployment configuration name was specified in an invalid format.

DeploymentConfigNameRequiredException - The deployment configuration name was not specified.

DeploymentConfigInUseException - The deployment configuration is still in use.

InvalidOperationException - An invalid operation was detected.

deleteDeploymentGroup

DeleteDeploymentGroupResult deleteDeploymentGroup(DeleteDeploymentGroupRequest deleteDeploymentGroupRequest)

Deletes a deployment group.

Parameters:

deleteDeploymentGroupRequest - Represents the input of a delete deployment group operation.

Returns:

Result of the DeleteDeploymentGroup operation returned by the service.

Throws:

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

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

DeploymentGroupNameRequiredException - The deployment group name was not specified.

InvalidDeploymentGroupNameException - The deployment group name was specified in an invalid format.

InvalidRoleException - The service role ARN was specified in an invalid format. Or, if an Auto Scaling group was specified, the specified service role does not grant the appropriate permissions to Auto Scaling.

deregisterOnPremisesInstance

void deregisterOnPremisesInstance(DeregisterOnPremisesInstanceRequest deregisterOnPremisesInstanceRequest)

Deregisters an on-premises instance.

Parameters:

deregisterOnPremisesInstanceRequest - Represents the input of a deregister on-premises instance operation.

Throws:

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

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

getApplication

GetApplicationResult getApplication(GetApplicationRequest getApplicationRequest)

Gets information about an application.

Parameters:

getApplicationRequest - Represents the input of a get application operation.

Returns:

Result of the GetApplication operation returned by the service.

Throws:

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

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

ApplicationDoesNotExistException - The application does not exist with the applicable IAM user or AWS account.

getApplicationRevision

GetApplicationRevisionResult getApplicationRevision(GetApplicationRevisionRequest getApplicationRevisionRequest)

Gets information about an application revision.

Parameters:

getApplicationRevisionRequest - Represents the input of a get application revision operation.

Returns:

Result of the GetApplicationRevision operation returned by the service.

Throws:

ApplicationDoesNotExistException - The application does not exist with the applicable IAM user or AWS account.

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

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

RevisionDoesNotExistException - The named revision does not exist with the applicable IAM user or AWS account.

RevisionRequiredException - The revision ID was not specified.

InvalidRevisionException - The revision was specified in an invalid format.

getDeployment

GetDeploymentResult getDeployment(GetDeploymentRequest getDeploymentRequest)

Gets information about a deployment.

Parameters:

getDeploymentRequest - Represents the input of a get deployment operation.

Returns:

Result of the GetDeployment operation returned by the service.

Throws:

DeploymentIdRequiredException - At least one deployment ID must be specified.

InvalidDeploymentIdException - At least one of the deployment IDs was specified in an invalid format.

DeploymentDoesNotExistException - The deployment does not exist with the applicable IAM user or AWS account.

getDeploymentConfig

GetDeploymentConfigResult getDeploymentConfig(GetDeploymentConfigRequest getDeploymentConfigRequest)

Gets information about a deployment configuration.

Parameters:

getDeploymentConfigRequest - Represents the input of a get deployment configuration operation.

Returns:

Result of the GetDeploymentConfig operation returned by the service.

Throws:

InvalidDeploymentConfigNameException - The deployment configuration name was specified in an invalid format.

DeploymentConfigNameRequiredException - The deployment configuration name was not specified.

DeploymentConfigDoesNotExistException - The deployment configuration does not exist with the applicable IAM user or AWS account.

getDeploymentGroup

GetDeploymentGroupResult getDeploymentGroup(GetDeploymentGroupRequest getDeploymentGroupRequest)

Gets information about a deployment group.

Parameters:

getDeploymentGroupRequest - Represents the input of a get deployment group operation.

Returns:

Result of the GetDeploymentGroup operation returned by the service.

Throws:

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

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

ApplicationDoesNotExistException - The application does not exist with the applicable IAM user or AWS account.

DeploymentGroupNameRequiredException - The deployment group name was not specified.

InvalidDeploymentGroupNameException - The deployment group name was specified in an invalid format.

DeploymentGroupDoesNotExistException - The named deployment group does not exist with the applicable IAM user or AWS account.

getDeploymentInstance

GetDeploymentInstanceResult getDeploymentInstance(GetDeploymentInstanceRequest getDeploymentInstanceRequest)

Gets information about an instance as part of a deployment.

Parameters:

getDeploymentInstanceRequest - Represents the input of a get deployment instance operation.

Returns:

Result of the GetDeploymentInstance operation returned by the service.

Throws:

DeploymentIdRequiredException - At least one deployment ID must be specified.

DeploymentDoesNotExistException - The deployment does not exist with the applicable IAM user or AWS account.

InstanceIdRequiredException - The instance ID was not specified.

InvalidDeploymentIdException - At least one of the deployment IDs was specified in an invalid format.

InstanceDoesNotExistException - The specified instance does not exist in the deployment group.

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

getOnPremisesInstance

GetOnPremisesInstanceResult getOnPremisesInstance(GetOnPremisesInstanceRequest getOnPremisesInstanceRequest)

Gets information about an on-premises instance.

Parameters:

getOnPremisesInstanceRequest - Represents the input of a get on-premises instance operation.

Returns:

Result of the GetOnPremisesInstance operation returned by the service.

Throws:

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

InstanceNotRegisteredException - The specified on-premises instance is not registered.

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

listApplicationRevisions

ListApplicationRevisionsResult listApplicationRevisions(ListApplicationRevisionsRequest listApplicationRevisionsRequest)

Lists information about revisions for an application.

Parameters:

listApplicationRevisionsRequest - Represents the input of a list application revisions operation.

Returns:

Result of the ListApplicationRevisions operation returned by the service.

Throws:

ApplicationDoesNotExistException - The application does not exist with the applicable IAM user or AWS account.

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

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

InvalidSortByException - The column name to sort by is either not present or was specified in an invalid format.

InvalidSortOrderException - The sort order was specified in an invalid format.

InvalidBucketNameFilterException - The bucket name either doesn't exist or was specified in an invalid format.

InvalidKeyPrefixFilterException - The specified key prefix filter was specified in an invalid format.

BucketNameFilterRequiredException - A bucket name is required, but was not provided.

InvalidDeployedStateFilterException - The deployed state filter was specified in an invalid format.

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

listApplications

ListApplicationsResult listApplications(ListApplicationsRequest listApplicationsRequest)

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

Parameters:

listApplicationsRequest - Represents the input of a list applications operation.

Returns:

Result of the ListApplications operation returned by the service.

Throws:

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

listApplications

ListApplicationsResult listApplications()

Simplified method form for invoking the ListApplications operation.

See Also:

listApplications(ListApplicationsRequest)

listDeploymentConfigs

ListDeploymentConfigsResult listDeploymentConfigs(ListDeploymentConfigsRequest listDeploymentConfigsRequest)

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

Parameters:

listDeploymentConfigsRequest - Represents the input of a list deployment configurations operation.

Returns:

Result of the ListDeploymentConfigs operation returned by the service.

Throws:

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

listDeploymentConfigs

ListDeploymentConfigsResult listDeploymentConfigs()

Simplified method form for invoking the ListDeploymentConfigs operation.

See Also:

listDeploymentConfigs(ListDeploymentConfigsRequest)

listDeploymentGroups

ListDeploymentGroupsResult listDeploymentGroups(ListDeploymentGroupsRequest listDeploymentGroupsRequest)

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

Parameters:

listDeploymentGroupsRequest - Represents the input of a list deployment groups operation.

Returns:

Result of the ListDeploymentGroups operation returned by the service.

Throws:

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

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

ApplicationDoesNotExistException - The application does not exist with the applicable IAM user or AWS account.

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

listDeploymentInstances

ListDeploymentInstancesResult listDeploymentInstances(ListDeploymentInstancesRequest listDeploymentInstancesRequest)

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

Parameters:

listDeploymentInstancesRequest - Represents the input of a list deployment instances operation.

Returns:

Result of the ListDeploymentInstances operation returned by the service.

Throws:

DeploymentIdRequiredException - At least one deployment ID must be specified.

DeploymentDoesNotExistException - The deployment does not exist with the applicable IAM user or AWS account.

DeploymentNotStartedException - The specified deployment has not started.

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

InvalidDeploymentIdException - At least one of the deployment IDs was specified in an invalid format.

InvalidInstanceStatusException - The specified instance status does not exist.

listDeployments

ListDeploymentsResult listDeployments(ListDeploymentsRequest listDeploymentsRequest)

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

Parameters:

listDeploymentsRequest - Represents the input of a list deployments operation.

Returns:

Result of the ListDeployments operation returned by the service.

Throws:

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

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

ApplicationDoesNotExistException - The application does not exist with the applicable IAM user or AWS account.

InvalidDeploymentGroupNameException - The deployment group name was specified in an invalid format.

DeploymentGroupDoesNotExistException - The named deployment group does not exist with the applicable IAM user or AWS account.

DeploymentGroupNameRequiredException - The deployment group name was not specified.

InvalidTimeRangeException - The specified time range was specified in an invalid format.

InvalidDeploymentStatusException - The specified deployment status doesn't exist or cannot be determined.

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

listDeployments

ListDeploymentsResult listDeployments()

Simplified method form for invoking the ListDeployments operation.

See Also:

listDeployments(ListDeploymentsRequest)

listOnPremisesInstances

ListOnPremisesInstancesResult listOnPremisesInstances(ListOnPremisesInstancesRequest listOnPremisesInstancesRequest)

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

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

Parameters:

listOnPremisesInstancesRequest - Represents the input of a list on-premises instances operation.

Returns:

Result of the ListOnPremisesInstances operation returned by the service.

Throws:

InvalidRegistrationStatusException - The registration status was specified in an invalid format.

InvalidTagFilterException - The specified tag filter was specified in an invalid format.

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

listOnPremisesInstances

ListOnPremisesInstancesResult listOnPremisesInstances()

Simplified method form for invoking the ListOnPremisesInstances operation.

See Also:

listOnPremisesInstances(ListOnPremisesInstancesRequest)

registerApplicationRevision

void registerApplicationRevision(RegisterApplicationRevisionRequest registerApplicationRevisionRequest)

Registers with AWS CodeDeploy a revision for the specified application.

Parameters:

registerApplicationRevisionRequest - Represents the input of a register application revision operation.

Throws:

ApplicationDoesNotExistException - The application does not exist with the applicable IAM user or AWS account.

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

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

DescriptionTooLongException - The description is too long.

RevisionRequiredException - The revision ID was not specified.

InvalidRevisionException - The revision was specified in an invalid format.

registerOnPremisesInstance

void registerOnPremisesInstance(RegisterOnPremisesInstanceRequest registerOnPremisesInstanceRequest)

Registers an on-premises instance.

Parameters:

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

Throws:

InstanceNameAlreadyRegisteredException - The specified on-premises instance name is already registered.

IamUserArnAlreadyRegisteredException - The specified IAM user ARN is already registered with an on-premises instance.

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

IamUserArnRequiredException - An IAM user ARN was not specified.

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

InvalidIamUserArnException - The IAM user ARN was specified in an invalid format.

removeTagsFromOnPremisesInstances

void removeTagsFromOnPremisesInstances(RemoveTagsFromOnPremisesInstancesRequest removeTagsFromOnPremisesInstancesRequest)

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

Parameters:

removeTagsFromOnPremisesInstancesRequest - Represents the input of a remove tags from on-premises instances operation.

Throws:

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

TagRequiredException - A tag was not specified.

InvalidTagException - The specified tag was specified in an invalid format.

TagLimitExceededException - The maximum allowed number of tags was exceeded.

InstanceLimitExceededException - The maximum number of allowed on-premises instances in a single call was exceeded.

InstanceNotRegisteredException - The specified on-premises instance is not registered.

stopDeployment

StopDeploymentResult stopDeployment(StopDeploymentRequest stopDeploymentRequest)

Attempts to stop an ongoing deployment.

Parameters:

stopDeploymentRequest - Represents the input of a stop deployment operation.

Returns:

Result of the StopDeployment operation returned by the service.

Throws:

DeploymentIdRequiredException - At least one deployment ID must be specified.

DeploymentDoesNotExistException - The deployment does not exist with the applicable IAM user or AWS account.

DeploymentAlreadyCompletedException - The deployment is already complete.

InvalidDeploymentIdException - At least one of the deployment IDs was specified in an invalid format.

updateApplication

void updateApplication(UpdateApplicationRequest updateApplicationRequest)

Changes the name of an application.

Parameters:

updateApplicationRequest - Represents the input of an update application operation.

Throws:

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

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

ApplicationAlreadyExistsException - An application with the specified name already exists with the applicable IAM user or AWS account.

ApplicationDoesNotExistException - The application does not exist with the applicable IAM user or AWS account.

updateApplication

void updateApplication()

Simplified method form for invoking the UpdateApplication operation.

See Also:

updateApplication(UpdateApplicationRequest)

updateDeploymentGroup

UpdateDeploymentGroupResult updateDeploymentGroup(UpdateDeploymentGroupRequest updateDeploymentGroupRequest)

Changes information about a deployment group.

Parameters:

updateDeploymentGroupRequest - Represents the input of an update deployment group operation.

Returns:

Result of the UpdateDeploymentGroup operation returned by the service.

Throws:

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

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

ApplicationDoesNotExistException - The application does not exist with the applicable IAM user or AWS account.

InvalidDeploymentGroupNameException - The deployment group name was specified in an invalid format.

DeploymentGroupAlreadyExistsException - A deployment group with the specified name already exists with the applicable IAM user or AWS account.

DeploymentGroupNameRequiredException - The deployment group name was not specified.

DeploymentGroupDoesNotExistException - The named deployment group does not exist with the applicable IAM user or AWS account.

InvalidEC2TagException - The tag was specified in an invalid format.

InvalidTagException - The specified tag was specified in an invalid format.

InvalidAutoScalingGroupException - The Auto Scaling group was specified in an invalid format or does not exist.

InvalidDeploymentConfigNameException - The deployment configuration name was specified in an invalid format.

DeploymentConfigDoesNotExistException - The deployment configuration does not exist with the applicable IAM user or AWS account.

InvalidRoleException - The service role ARN was specified in an invalid format. Or, if an Auto Scaling group was specified, the specified service role does not grant the appropriate permissions to Auto Scaling.

LifecycleHookLimitExceededException - The limit for lifecycle hooks was exceeded.

InvalidTriggerConfigException - The trigger was specified in an invalid format.

TriggerTargetsLimitExceededException - The maximum allowed number of triggers was exceeded.

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.