Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
   /*
    * Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
    *
    * Licensed under the Apache License, Version 2.0 (the "License").
    * You may not use this file except in compliance with the License.
    * A copy of the License is located at
    *
    *  http://aws.amazon.com/apache2.0
    *
   * or in the "license" file accompanying this file. This file is distributed
   * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
   * express or implied. See the License for the specific language governing
   * permissions and limitations under the License.
   */
  package com.amazonaws.services.codedeploy;
  
  import com.amazonaws.*;
  
Interface for accessing CodeDeploy.

<fullname>AWS CodeDeploy</fullname> Overview

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

Using the APIs

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

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

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

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

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

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

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

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

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

  • Deployments represent the process of deploying revisions to instances.

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

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

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

 
 public 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 com.amazonaws.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.
 
     void setEndpoint(String endpoint);

    
An alternative to setEndpoint(java.lang.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 com.amazonaws.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.

 
     void setRegion(Region region);

    

Adds a tag to an on-premises instance.

Parameters:
addTagsToOnPremisesInstancesRequest Represents the input of an adds tags to on-premises instance operation.
Throws:
com.amazonaws.services.codedeploy.model.InstanceNameRequiredException An on-premises instance name was not specified.
com.amazonaws.services.codedeploy.model.TagRequiredException A tag was not specified.
com.amazonaws.services.codedeploy.model.InvalidTagException The specified tag was specified in an invalid format.
com.amazonaws.services.codedeploy.model.TagLimitExceededException The maximum allowed number of tags was exceeded.
com.amazonaws.services.codedeploy.model.InstanceLimitExceededException The maximum number of allowed on-premises instances was exceeded.
com.amazonaws.services.codedeploy.model.InstanceNotRegisteredException The specified on-premises instance is not registered.
 
             AddTagsToOnPremisesInstancesRequest addTagsToOnPremisesInstancesRequest);

    

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:
com.amazonaws.services.codedeploy.model.ApplicationNameRequiredException The minimum number of required application names was not specified.
com.amazonaws.services.codedeploy.model.InvalidApplicationNameException The application name was specified in an invalid format.
com.amazonaws.services.codedeploy.model.ApplicationDoesNotExistException The application does not exist with the applicable IAM user or AWS account.
 
             BatchGetApplicationsRequest batchGetApplicationsRequest);

    
Simplified method form for invoking the BatchGetApplications operation.

 

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:
com.amazonaws.services.codedeploy.model.DeploymentIdRequiredException At least one deployment ID must be specified.
com.amazonaws.services.codedeploy.model.InvalidDeploymentIdException At least one of the deployment IDs was specified in an invalid format.
 
             BatchGetDeploymentsRequest batchGetDeploymentsRequest);

    
Simplified method form for invoking the BatchGetDeployments operation.

 

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:
com.amazonaws.services.codedeploy.model.InstanceNameRequiredException An on-premises instance name was not specified.
com.amazonaws.services.codedeploy.model.InvalidInstanceNameException The specified on-premises instance name was specified in an invalid format.
 
             BatchGetOnPremisesInstancesRequest batchGetOnPremisesInstancesRequest);

    
Simplified method form for invoking the BatchGetOnPremisesInstances operation.

 

Creates a new application.

Parameters:
createApplicationRequest Represents the input of a create application operation.
Returns:
Result of the CreateApplication operation returned by the service.
Throws:
com.amazonaws.services.codedeploy.model.ApplicationNameRequiredException The minimum number of required application names was not specified.
com.amazonaws.services.codedeploy.model.InvalidApplicationNameException The application name was specified in an invalid format.
com.amazonaws.services.codedeploy.model.ApplicationAlreadyExistsException An application with the specified name already exists with the applicable IAM user or AWS account.
com.amazonaws.services.codedeploy.model.ApplicationLimitExceededException More applications were attempted to be created than were allowed.
 
             CreateApplicationRequest createApplicationRequest);

    

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:
com.amazonaws.services.codedeploy.model.ApplicationNameRequiredException The minimum number of required application names was not specified.
com.amazonaws.services.codedeploy.model.InvalidApplicationNameException The application name was specified in an invalid format.
com.amazonaws.services.codedeploy.model.ApplicationDoesNotExistException The application does not exist with the applicable IAM user or AWS account.
com.amazonaws.services.codedeploy.model.DeploymentGroupNameRequiredException The deployment group name was not specified.
com.amazonaws.services.codedeploy.model.InvalidDeploymentGroupNameException The deployment group name was specified in an invalid format.
com.amazonaws.services.codedeploy.model.DeploymentGroupDoesNotExistException The named deployment group does not exist with the applicable IAM user or AWS account.
com.amazonaws.services.codedeploy.model.RevisionRequiredException The revision ID was not specified.
com.amazonaws.services.codedeploy.model.InvalidRevisionException The revision was specified in an invalid format.
com.amazonaws.services.codedeploy.model.InvalidDeploymentConfigNameException The deployment configuration name was specified in an invalid format.
com.amazonaws.services.codedeploy.model.DeploymentConfigDoesNotExistException The deployment configuration does not exist with the applicable IAM user or AWS account.
com.amazonaws.services.codedeploy.model.DescriptionTooLongException The description that was provided is too long.
com.amazonaws.services.codedeploy.model.DeploymentLimitExceededException The number of allowed deployments was exceeded.
 
             CreateDeploymentRequest createDeploymentRequest);

    

Creates a new deployment configuration.

Parameters:
createDeploymentConfigRequest Represents the input of a create deployment configuration operation.
Returns:
Result of the CreateDeploymentConfig operation returned by the service.
Throws:
com.amazonaws.services.codedeploy.model.InvalidDeploymentConfigNameException The deployment configuration name was specified in an invalid format.
com.amazonaws.services.codedeploy.model.DeploymentConfigNameRequiredException The deployment configuration name was not specified.
com.amazonaws.services.codedeploy.model.DeploymentConfigAlreadyExistsException A deployment configuration with the specified name already exists with the applicable IAM user or AWS account.
com.amazonaws.services.codedeploy.model.InvalidMinimumHealthyHostValueException The minimum healthy instances value was specified in an invalid format.
com.amazonaws.services.codedeploy.model.DeploymentConfigLimitExceededException The deployment configurations limit was exceeded.
 
             CreateDeploymentConfigRequest createDeploymentConfigRequest);

    

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

Parameters:
createDeploymentGroupRequest Represents the input of a create deployment group operation.
Returns:
Result of the CreateDeploymentGroup operation returned by the service.
Throws:
com.amazonaws.services.codedeploy.model.ApplicationNameRequiredException The minimum number of required application names was not specified.
com.amazonaws.services.codedeploy.model.InvalidApplicationNameException The application name was specified in an invalid format.
com.amazonaws.services.codedeploy.model.ApplicationDoesNotExistException The application does not exist with the applicable IAM user or AWS account.
com.amazonaws.services.codedeploy.model.DeploymentGroupNameRequiredException The deployment group name was not specified.
com.amazonaws.services.codedeploy.model.InvalidDeploymentGroupNameException The deployment group name was specified in an invalid format.
com.amazonaws.services.codedeploy.model.DeploymentGroupAlreadyExistsException A deployment group with the specified name already exists with the applicable IAM user or AWS account.
com.amazonaws.services.codedeploy.model.InvalidEC2TagException The tag was specified in an invalid format.
com.amazonaws.services.codedeploy.model.InvalidTagException The specified tag was specified in an invalid format.
com.amazonaws.services.codedeploy.model.InvalidAutoScalingGroupException The Auto Scaling group was specified in an invalid format or does not exist.
com.amazonaws.services.codedeploy.model.InvalidDeploymentConfigNameException The deployment configuration name was specified in an invalid format.
com.amazonaws.services.codedeploy.model.DeploymentConfigDoesNotExistException The deployment configuration does not exist with the applicable IAM user or AWS account.
com.amazonaws.services.codedeploy.model.RoleRequiredException The role ID was not specified.
com.amazonaws.services.codedeploy.model.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.
com.amazonaws.services.codedeploy.model.DeploymentGroupLimitExceededException The deployment groups limit was exceeded.
 
             CreateDeploymentGroupRequest createDeploymentGroupRequest);

    

Deletes an application.

Parameters:
deleteApplicationRequest Represents the input of a delete application operation.
Throws:
com.amazonaws.services.codedeploy.model.ApplicationNameRequiredException The minimum number of required application names was not specified.
com.amazonaws.services.codedeploy.model.InvalidApplicationNameException The application name was specified in an invalid format.
 
     void deleteApplication(DeleteApplicationRequest deleteApplicationRequest);

    

Deletes a deployment configuration.

<note>A deployment configuration cannot be deleted if it is currently in use. Also, predefined configurations cannot be deleted.</note>

Parameters:
deleteDeploymentConfigRequest Represents the input of a delete deployment configuration operation.
Throws:
com.amazonaws.services.codedeploy.model.InvalidDeploymentConfigNameException The deployment configuration name was specified in an invalid format.
com.amazonaws.services.codedeploy.model.DeploymentConfigNameRequiredException The deployment configuration name was not specified.
com.amazonaws.services.codedeploy.model.DeploymentConfigInUseException The deployment configuration is still in use.
com.amazonaws.services.codedeploy.model.InvalidOperationException An invalid operation was detected.
 
     void deleteDeploymentConfig(
             DeleteDeploymentConfigRequest deleteDeploymentConfigRequest);

    

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:
com.amazonaws.services.codedeploy.model.ApplicationNameRequiredException The minimum number of required application names was not specified.
com.amazonaws.services.codedeploy.model.InvalidApplicationNameException The application name was specified in an invalid format.
com.amazonaws.services.codedeploy.model.DeploymentGroupNameRequiredException The deployment group name was not specified.
com.amazonaws.services.codedeploy.model.InvalidDeploymentGroupNameException The deployment group name was specified in an invalid format.
com.amazonaws.services.codedeploy.model.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.
 
             DeleteDeploymentGroupRequest deleteDeploymentGroupRequest);

    

Deregisters an on-premises instance.

Parameters:
deregisterOnPremisesInstanceRequest Represents the input of a deregister on-premises instance operation.
Throws:
com.amazonaws.services.codedeploy.model.InstanceNameRequiredException An on-premises instance name was not specified.
com.amazonaws.services.codedeploy.model.InvalidInstanceNameException The specified on-premises instance name was specified in an invalid format.
 
             DeregisterOnPremisesInstanceRequest deregisterOnPremisesInstanceRequest);

    

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:
com.amazonaws.services.codedeploy.model.ApplicationNameRequiredException The minimum number of required application names was not specified.
com.amazonaws.services.codedeploy.model.InvalidApplicationNameException The application name was specified in an invalid format.
com.amazonaws.services.codedeploy.model.ApplicationDoesNotExistException The application does not exist with the applicable IAM user or AWS account.
 
             GetApplicationRequest getApplicationRequest);

    

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:
com.amazonaws.services.codedeploy.model.ApplicationDoesNotExistException The application does not exist with the applicable IAM user or AWS account.
com.amazonaws.services.codedeploy.model.ApplicationNameRequiredException The minimum number of required application names was not specified.
com.amazonaws.services.codedeploy.model.InvalidApplicationNameException The application name was specified in an invalid format.
com.amazonaws.services.codedeploy.model.RevisionDoesNotExistException The named revision does not exist with the applicable IAM user or AWS account.
com.amazonaws.services.codedeploy.model.RevisionRequiredException The revision ID was not specified.
com.amazonaws.services.codedeploy.model.InvalidRevisionException The revision was specified in an invalid format.
 
             GetApplicationRevisionRequest getApplicationRevisionRequest);

    

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:
com.amazonaws.services.codedeploy.model.DeploymentIdRequiredException At least one deployment ID must be specified.
com.amazonaws.services.codedeploy.model.InvalidDeploymentIdException At least one of the deployment IDs was specified in an invalid format.
com.amazonaws.services.codedeploy.model.DeploymentDoesNotExistException The deployment does not exist with the applicable IAM user or AWS account.
 
     GetDeploymentResult getDeployment(GetDeploymentRequest getDeploymentRequest);

    

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:
com.amazonaws.services.codedeploy.model.InvalidDeploymentConfigNameException The deployment configuration name was specified in an invalid format.
com.amazonaws.services.codedeploy.model.DeploymentConfigNameRequiredException The deployment configuration name was not specified.
com.amazonaws.services.codedeploy.model.DeploymentConfigDoesNotExistException The deployment configuration does not exist with the applicable IAM user or AWS account.
 
             GetDeploymentConfigRequest getDeploymentConfigRequest);

    

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:
com.amazonaws.services.codedeploy.model.ApplicationNameRequiredException The minimum number of required application names was not specified.
com.amazonaws.services.codedeploy.model.InvalidApplicationNameException The application name was specified in an invalid format.
com.amazonaws.services.codedeploy.model.ApplicationDoesNotExistException The application does not exist with the applicable IAM user or AWS account.
com.amazonaws.services.codedeploy.model.DeploymentGroupNameRequiredException The deployment group name was not specified.
com.amazonaws.services.codedeploy.model.InvalidDeploymentGroupNameException The deployment group name was specified in an invalid format.
com.amazonaws.services.codedeploy.model.DeploymentGroupDoesNotExistException The named deployment group does not exist with the applicable IAM user or AWS account.
 
             GetDeploymentGroupRequest getDeploymentGroupRequest);

    

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:
com.amazonaws.services.codedeploy.model.DeploymentIdRequiredException At least one deployment ID must be specified.
com.amazonaws.services.codedeploy.model.DeploymentDoesNotExistException The deployment does not exist with the applicable IAM user or AWS account.
com.amazonaws.services.codedeploy.model.InstanceIdRequiredException The instance ID was not specified.
com.amazonaws.services.codedeploy.model.InvalidDeploymentIdException At least one of the deployment IDs was specified in an invalid format.
com.amazonaws.services.codedeploy.model.InstanceDoesNotExistException The specified instance does not exist in the deployment group.
 
             GetDeploymentInstanceRequest getDeploymentInstanceRequest);

    

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:
com.amazonaws.services.codedeploy.model.InstanceNameRequiredException An on-premises instance name was not specified.
com.amazonaws.services.codedeploy.model.InstanceNotRegisteredException The specified on-premises instance is not registered.
com.amazonaws.services.codedeploy.model.InvalidInstanceNameException The specified on-premises instance name was specified in an invalid format.
 
             GetOnPremisesInstanceRequest getOnPremisesInstanceRequest);

    

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:
com.amazonaws.services.codedeploy.model.ApplicationDoesNotExistException The application does not exist with the applicable IAM user or AWS account.
com.amazonaws.services.codedeploy.model.ApplicationNameRequiredException The minimum number of required application names was not specified.
com.amazonaws.services.codedeploy.model.InvalidApplicationNameException The application name was specified in an invalid format.
com.amazonaws.services.codedeploy.model.InvalidSortByException The column name to sort by is either not present or was specified in an invalid format.
com.amazonaws.services.codedeploy.model.InvalidSortOrderException The sort order was specified in an invalid format.
com.amazonaws.services.codedeploy.model.InvalidBucketNameFilterException The bucket name either doesn't exist or was specified in an invalid format.
com.amazonaws.services.codedeploy.model.InvalidKeyPrefixFilterException The specified key prefix filter was specified in an invalid format.
com.amazonaws.services.codedeploy.model.BucketNameFilterRequiredException A bucket name is required but was not provided.
com.amazonaws.services.codedeploy.model.InvalidDeployedStateFilterException The deployed state filter was specified in an invalid format.
com.amazonaws.services.codedeploy.model.InvalidNextTokenException The next token was specified in an invalid format.
 
             ListApplicationRevisionsRequest listApplicationRevisionsRequest);

    

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:
com.amazonaws.services.codedeploy.model.InvalidNextTokenException The next token was specified in an invalid format.
 
             ListApplicationsRequest listApplicationsRequest);

    
Simplified method form for invoking the ListApplications operation.

 

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:
com.amazonaws.services.codedeploy.model.InvalidNextTokenException The next token was specified in an invalid format.
 
             ListDeploymentConfigsRequest listDeploymentConfigsRequest);

    
Simplified method form for invoking the ListDeploymentConfigs operation.

 

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:
com.amazonaws.services.codedeploy.model.ApplicationNameRequiredException The minimum number of required application names was not specified.
com.amazonaws.services.codedeploy.model.InvalidApplicationNameException The application name was specified in an invalid format.
com.amazonaws.services.codedeploy.model.ApplicationDoesNotExistException The application does not exist with the applicable IAM user or AWS account.
com.amazonaws.services.codedeploy.model.InvalidNextTokenException The next token was specified in an invalid format.
 
             ListDeploymentGroupsRequest listDeploymentGroupsRequest);

    

Lists the instances 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:
com.amazonaws.services.codedeploy.model.DeploymentIdRequiredException At least one deployment ID must be specified.
com.amazonaws.services.codedeploy.model.DeploymentDoesNotExistException The deployment does not exist with the applicable IAM user or AWS account.
com.amazonaws.services.codedeploy.model.DeploymentNotStartedException The specified deployment has not started.
com.amazonaws.services.codedeploy.model.InvalidNextTokenException The next token was specified in an invalid format.
com.amazonaws.services.codedeploy.model.InvalidDeploymentIdException At least one of the deployment IDs was specified in an invalid format.
com.amazonaws.services.codedeploy.model.InvalidInstanceStatusException The specified instance status does not exist.
 
             ListDeploymentInstancesRequest listDeploymentInstancesRequest);

    

Lists the deployments within 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:
com.amazonaws.services.codedeploy.model.ApplicationNameRequiredException The minimum number of required application names was not specified.
com.amazonaws.services.codedeploy.model.InvalidApplicationNameException The application name was specified in an invalid format.
com.amazonaws.services.codedeploy.model.ApplicationDoesNotExistException The application does not exist with the applicable IAM user or AWS account.
com.amazonaws.services.codedeploy.model.InvalidDeploymentGroupNameException The deployment group name was specified in an invalid format.
com.amazonaws.services.codedeploy.model.DeploymentGroupDoesNotExistException The named deployment group does not exist with the applicable IAM user or AWS account.
com.amazonaws.services.codedeploy.model.DeploymentGroupNameRequiredException The deployment group name was not specified.
com.amazonaws.services.codedeploy.model.InvalidTimeRangeException The specified time range was specified in an invalid format.
com.amazonaws.services.codedeploy.model.InvalidDeploymentStatusException The specified deployment status doesn't exist or cannot be determined.
com.amazonaws.services.codedeploy.model.InvalidNextTokenException The next token was specified in an invalid format.
 
             ListDeploymentsRequest listDeploymentsRequest);

    
Simplified method form for invoking the ListDeployments operation.

 

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

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

Parameters:
listOnPremisesInstancesRequest Represents the input of a list on-premises instances operation.
Returns:
Result of the ListOnPremisesInstances operation returned by the service.
Throws:
com.amazonaws.services.codedeploy.model.InvalidRegistrationStatusException The registration status was specified in an invalid format.
com.amazonaws.services.codedeploy.model.InvalidTagFilterException The specified tag filter was specified in an invalid format.
com.amazonaws.services.codedeploy.model.InvalidNextTokenException The next token was specified in an invalid format.
 
             ListOnPremisesInstancesRequest listOnPremisesInstancesRequest);

    
Simplified method form for invoking the ListOnPremisesInstances operation.

 

Registers with AWS CodeDeploy a revision for the specified application.

Parameters:
registerApplicationRevisionRequest Represents the input of a register application revision operation.
Throws:
com.amazonaws.services.codedeploy.model.ApplicationDoesNotExistException The application does not exist with the applicable IAM user or AWS account.
com.amazonaws.services.codedeploy.model.ApplicationNameRequiredException The minimum number of required application names was not specified.
com.amazonaws.services.codedeploy.model.InvalidApplicationNameException The application name was specified in an invalid format.
com.amazonaws.services.codedeploy.model.DescriptionTooLongException The description that was provided is too long.
com.amazonaws.services.codedeploy.model.RevisionRequiredException The revision ID was not specified.
com.amazonaws.services.codedeploy.model.InvalidRevisionException The revision was specified in an invalid format.
 
             RegisterApplicationRevisionRequest registerApplicationRevisionRequest);

    

Registers an on-premises instance.

Parameters:
registerOnPremisesInstanceRequest Represents the input of register on-premises instance operation.
Throws:
com.amazonaws.services.codedeploy.model.InstanceNameAlreadyRegisteredException The specified on-premises instance name is already registered.
com.amazonaws.services.codedeploy.model.IamUserArnAlreadyRegisteredException The specified IAM user ARN is already registered with an on-premises instance.
com.amazonaws.services.codedeploy.model.InstanceNameRequiredException An on-premises instance name was not specified.
com.amazonaws.services.codedeploy.model.IamUserArnRequiredException An IAM user ARN was not specified.
com.amazonaws.services.codedeploy.model.InvalidInstanceNameException The specified on-premises instance name was specified in an invalid format.
com.amazonaws.services.codedeploy.model.InvalidIamUserArnException The IAM user ARN was specified in an invalid format.
 
             RegisterOnPremisesInstanceRequest registerOnPremisesInstanceRequest);

    

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:
com.amazonaws.services.codedeploy.model.InstanceNameRequiredException An on-premises instance name was not specified.
com.amazonaws.services.codedeploy.model.TagRequiredException A tag was not specified.
com.amazonaws.services.codedeploy.model.InvalidTagException The specified tag was specified in an invalid format.
com.amazonaws.services.codedeploy.model.TagLimitExceededException The maximum allowed number of tags was exceeded.
com.amazonaws.services.codedeploy.model.InstanceLimitExceededException The maximum number of allowed on-premises instances was exceeded.
com.amazonaws.services.codedeploy.model.InstanceNotRegisteredException The specified on-premises instance is not registered.
 
             RemoveTagsFromOnPremisesInstancesRequest removeTagsFromOnPremisesInstancesRequest);

    

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:
com.amazonaws.services.codedeploy.model.DeploymentIdRequiredException At least one deployment ID must be specified.
com.amazonaws.services.codedeploy.model.DeploymentDoesNotExistException The deployment does not exist with the applicable IAM user or AWS account.
com.amazonaws.services.codedeploy.model.DeploymentAlreadyCompletedException The deployment is already completed.
com.amazonaws.services.codedeploy.model.InvalidDeploymentIdException At least one of the deployment IDs was specified in an invalid format.
 
             StopDeploymentRequest stopDeploymentRequest);

    

Changes an existing application's name.

Parameters:
updateApplicationRequest Represents the input of an update application operation.
Throws:
com.amazonaws.services.codedeploy.model.ApplicationNameRequiredException The minimum number of required application names was not specified.
com.amazonaws.services.codedeploy.model.InvalidApplicationNameException The application name was specified in an invalid format.
com.amazonaws.services.codedeploy.model.ApplicationAlreadyExistsException An application with the specified name already exists with the applicable IAM user or AWS account.
com.amazonaws.services.codedeploy.model.ApplicationDoesNotExistException The application does not exist with the applicable IAM user or AWS account.
 
     void updateApplication(UpdateApplicationRequest updateApplicationRequest);

    
Simplified method form for invoking the UpdateApplication operation.

 
     void updateApplication();

    

Changes information about an existing deployment group.

Parameters:
updateDeploymentGroupRequest Represents the input of an update deployment group operation.
Returns:
Result of the UpdateDeploymentGroup operation returned by the service.
Throws:
com.amazonaws.services.codedeploy.model.ApplicationNameRequiredException The minimum number of required application names was not specified.
com.amazonaws.services.codedeploy.model.InvalidApplicationNameException The application name was specified in an invalid format.
com.amazonaws.services.codedeploy.model.ApplicationDoesNotExistException The application does not exist with the applicable IAM user or AWS account.
com.amazonaws.services.codedeploy.model.InvalidDeploymentGroupNameException The deployment group name was specified in an invalid format.
com.amazonaws.services.codedeploy.model.DeploymentGroupAlreadyExistsException A deployment group with the specified name already exists with the applicable IAM user or AWS account.
com.amazonaws.services.codedeploy.model.DeploymentGroupNameRequiredException The deployment group name was not specified.
com.amazonaws.services.codedeploy.model.DeploymentGroupDoesNotExistException The named deployment group does not exist with the applicable IAM user or AWS account.
com.amazonaws.services.codedeploy.model.InvalidEC2TagException The tag was specified in an invalid format.
com.amazonaws.services.codedeploy.model.InvalidTagException The specified tag was specified in an invalid format.
com.amazonaws.services.codedeploy.model.InvalidAutoScalingGroupException The Auto Scaling group was specified in an invalid format or does not exist.
com.amazonaws.services.codedeploy.model.InvalidDeploymentConfigNameException The deployment configuration name was specified in an invalid format.
com.amazonaws.services.codedeploy.model.DeploymentConfigDoesNotExistException The deployment configuration does not exist with the applicable IAM user or AWS account.
com.amazonaws.services.codedeploy.model.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.
            UpdateDeploymentGroupRequest updateDeploymentGroupRequest);

    
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.
    void shutdown();

    
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.
New to GrepCode? Check out our FAQ X