@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonCodeDeploy
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonCodeDeploy instead.
AWS CodeDeploy is a deployment service that automates application deployments to Amazon EC2 instances or on-premises instances running in your own facility.
You can deploy a nearly unlimited variety of application content, such as code, web and configuration files, executables, packages, scripts, multimedia files, and so on. AWS CodeDeploy can deploy application content stored in Amazon S3 buckets, GitHub repositories, or Bitbucket repositories. You do not need to make changes to your existing code before you can use AWS CodeDeploy.
AWS CodeDeploy makes it easier for you to rapidly release new features, helps you avoid downtime during application deployment, and handles the complexity of updating your applications, without many of the risks associated with error-prone manual deployments.
AWS CodeDeploy Components
Use the information in this guide to help you work with the following AWS CodeDeploy components:
Application: A name that uniquely identifies the application you want to deploy. AWS CodeDeploy uses this name, which functions as a container, to ensure the correct combination of revision, deployment configuration, and deployment group are referenced during a deployment.
Deployment group: A set of individual instances. A deployment group contains individually tagged instances, Amazon EC2 instances in Auto Scaling groups, or both.
Deployment configuration: A set of deployment rules and deployment success and failure conditions used by AWS CodeDeploy during a deployment.
Deployment: The process, and the components involved in the process, of installing content on one or more instances.
Application revisions: An archive file containing source content—source code, web pages, executable files, and deployment scripts—along with an application specification file (AppSpec file). Revisions are stored in Amazon S3 buckets or GitHub repositories. For Amazon S3, a revision is uniquely identified by its Amazon S3 object key and its ETag, version, or both. For GitHub, a revision is uniquely identified by its commit ID.
This guide also contains information to help you get details about the instances in your deployments and to make on-premises instances available for AWS CodeDeploy deployments.
AWS CodeDeploy Information Resources
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
AddTagsToOnPremisesInstancesResult |
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)
Gets 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.
|
ContinueDeploymentResult |
continueDeployment(ContinueDeploymentRequest continueDeploymentRequest)
For a blue/green deployment, starts the process of rerouting traffic from instances in the original environment
to instances in the replacement environment without waiting for a specified wait time to elapse.
|
CreateApplicationResult |
createApplication(CreateApplicationRequest 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.
|
DeleteApplicationResult |
deleteApplication(DeleteApplicationRequest deleteApplicationRequest)
Deletes an application.
|
DeleteDeploymentConfigResult |
deleteDeploymentConfig(DeleteDeploymentConfigRequest deleteDeploymentConfigRequest)
Deletes a deployment configuration.
|
DeleteDeploymentGroupResult |
deleteDeploymentGroup(DeleteDeploymentGroupRequest deleteDeploymentGroupRequest)
Deletes a deployment group.
|
DeregisterOnPremisesInstanceResult |
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.
|
ListGitHubAccountTokenNamesResult |
listGitHubAccountTokenNames(ListGitHubAccountTokenNamesRequest listGitHubAccountTokenNamesRequest)
Lists the names of stored connections to GitHub accounts.
|
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.
|
RegisterApplicationRevisionResult |
registerApplicationRevision(RegisterApplicationRevisionRequest registerApplicationRevisionRequest)
Registers with AWS CodeDeploy a revision for the specified application.
|
RegisterOnPremisesInstanceResult |
registerOnPremisesInstance(RegisterOnPremisesInstanceRequest registerOnPremisesInstanceRequest)
Registers an on-premises instance.
|
RemoveTagsFromOnPremisesInstancesResult |
removeTagsFromOnPremisesInstances(RemoveTagsFromOnPremisesInstancesRequest removeTagsFromOnPremisesInstancesRequest)
Removes one or more tags from one or more on-premises instances.
|
void |
setEndpoint(String endpoint)
Deprecated.
use
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion)); |
void |
setRegion(Region region)
Deprecated.
use
AwsClientBuilder#setRegion(String) |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
SkipWaitTimeForInstanceTerminationResult |
skipWaitTimeForInstanceTermination(SkipWaitTimeForInstanceTerminationRequest skipWaitTimeForInstanceTerminationRequest)
In a blue/green deployment, overrides any specified wait time and starts terminating instances immediately after
the traffic routing is completed.
|
StopDeploymentResult |
stopDeployment(StopDeploymentRequest stopDeploymentRequest)
Attempts to stop an ongoing deployment.
|
UpdateApplicationResult |
updateApplication()
Simplified method form for invoking the UpdateApplication operation.
|
UpdateApplicationResult |
updateApplication(UpdateApplicationRequest updateApplicationRequest)
Changes the name of an application.
|
UpdateDeploymentGroupResult |
updateDeploymentGroup(UpdateDeploymentGroupRequest updateDeploymentGroupRequest)
Changes information about a deployment group.
|
AmazonCodeDeployWaiters |
waiters() |
static final String ENDPOINT_PREFIX
@Deprecated void setEndpoint(String endpoint)
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
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.
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.@Deprecated void setRegion(Region region)
AwsClientBuilder#setRegion(String)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.
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.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)AddTagsToOnPremisesInstancesResult addTagsToOnPremisesInstances(AddTagsToOnPremisesInstancesRequest addTagsToOnPremisesInstancesRequest)
Adds tags to on-premises instances.
addTagsToOnPremisesInstancesRequest - Represents the input of, and adds tags to, an on-premises instance operation.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.BatchGetApplicationRevisionsResult batchGetApplicationRevisions(BatchGetApplicationRevisionsRequest batchGetApplicationRevisionsRequest)
Gets information about one or more application revisions.
batchGetApplicationRevisionsRequest - Represents the input of a BatchGetApplicationRevisions operation.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.BatchGetApplicationsResult batchGetApplications(BatchGetApplicationsRequest batchGetApplicationsRequest)
Gets information about one or more applications.
batchGetApplicationsRequest - Represents the input of a BatchGetApplications operation.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.BatchGetApplicationsResult batchGetApplications()
BatchGetDeploymentGroupsResult batchGetDeploymentGroups(BatchGetDeploymentGroupsRequest batchGetDeploymentGroupsRequest)
Gets information about one or more deployment groups.
batchGetDeploymentGroupsRequest - Represents the input of a BatchGetDeploymentGroups operation.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.BatchGetDeploymentInstancesResult batchGetDeploymentInstances(BatchGetDeploymentInstancesRequest batchGetDeploymentInstancesRequest)
Gets information about one or more instance that are part of a deployment group.
batchGetDeploymentInstancesRequest - Represents the input of a BatchGetDeploymentInstances operation.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.BatchGetDeploymentsResult batchGetDeployments(BatchGetDeploymentsRequest batchGetDeploymentsRequest)
Gets information about one or more deployments.
batchGetDeploymentsRequest - Represents the input of a BatchGetDeployments operation.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.BatchGetDeploymentsResult batchGetDeployments()
BatchGetOnPremisesInstancesResult batchGetOnPremisesInstances(BatchGetOnPremisesInstancesRequest batchGetOnPremisesInstancesRequest)
Gets information about one or more on-premises instances.
batchGetOnPremisesInstancesRequest - Represents the input of a BatchGetOnPremisesInstances operation.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.BatchGetOnPremisesInstancesResult batchGetOnPremisesInstances()
ContinueDeploymentResult continueDeployment(ContinueDeploymentRequest continueDeploymentRequest)
For a blue/green deployment, starts the process of rerouting traffic from instances in the original environment to instances in the replacement environment without waiting for a specified wait time to elapse. (Traffic rerouting, which is achieved by registering instances in the replacement environment with the load balancer, can start as soon as all instances have a status of Ready.)
continueDeploymentRequest - DeploymentIdRequiredException - At least one deployment ID must be specified.DeploymentDoesNotExistException - The deployment does not exist with the applicable IAM user or AWS account.DeploymentAlreadyCompletedException - The deployment is already complete.InvalidDeploymentIdException - At least one of the deployment IDs was specified in an invalid format.DeploymentIsNotInReadyStateException - The deployment does not have a status of Ready and can't continue yet.UnsupportedActionForDeploymentTypeException - A call was submitted that is not supported for the specified deployment type.CreateApplicationResult createApplication(CreateApplicationRequest createApplicationRequest)
Creates an application.
createApplicationRequest - Represents the input of a CreateApplication operation.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.CreateDeploymentResult createDeployment(CreateDeploymentRequest createDeploymentRequest)
Deploys an application revision through the specified deployment group.
createDeploymentRequest - Represents the input of a CreateDeployment operation.ApplicationNameRequiredException - The minimum number of required application names was not specified.InvalidApplicationNameException - The application name was specified in an invalid format.ApplicationDoesNotExistException - The application does not exist with the applicable IAM user or AWS account.DeploymentGroupNameRequiredException - The deployment group name was not specified.InvalidDeploymentGroupNameException - The deployment group name was specified in an invalid format.DeploymentGroupDoesNotExistException - The named deployment group does not exist with the applicable IAM user or AWS account.RevisionRequiredException - The revision ID was not specified.RevisionDoesNotExistException - The named revision does not exist with the applicable IAM user or AWS account.InvalidRevisionException - The revision was specified in an invalid format.InvalidDeploymentConfigNameException - The deployment configuration name was specified in an invalid format.DeploymentConfigDoesNotExistException - The deployment configuration does not exist with the applicable IAM user or AWS account.DescriptionTooLongException - The description is too long.DeploymentLimitExceededException - The number of allowed deployments was exceeded.InvalidTargetInstancesException - The target instance configuration is invalid. Possible causes include:
Configuration data for target instances was entered for an in-place deployment.
The limit of 10 tags for a tag type was exceeded.
The combined length of the tag names exceeded the limit.
A specified tag is not currently applied to any instances.
InvalidAutoRollbackConfigException - The automatic rollback configuration was specified in an invalid format. For example, automatic rollback
is enabled but an invalid triggering event type or no event types were listed.InvalidLoadBalancerInfoException - An invalid load balancer name, or no load balancer name, was specified.InvalidFileExistsBehaviorException - An invalid fileExistsBehavior option was specified to determine how AWS CodeDeploy handles files or
directories that already exist in a deployment target location but weren't part of the previous
successful deployment. Valid values include "DISALLOW", "OVERWRITE", and "RETAIN".CreateDeploymentConfigResult createDeploymentConfig(CreateDeploymentConfigRequest createDeploymentConfigRequest)
Creates a deployment configuration.
createDeploymentConfigRequest - Represents the input of a CreateDeploymentConfig operation.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.CreateDeploymentGroupResult createDeploymentGroup(CreateDeploymentGroupRequest createDeploymentGroupRequest)
Creates a deployment group to which application revisions will be deployed.
createDeploymentGroupRequest - Represents the input of a CreateDeploymentGroup operation.ApplicationNameRequiredException - The minimum number of required application names was not specified.InvalidApplicationNameException - The application name was specified in an invalid format.ApplicationDoesNotExistException - The application does not exist with the applicable IAM user or AWS account.DeploymentGroupNameRequiredException - The deployment group name was not specified.InvalidDeploymentGroupNameException - The deployment group name was specified in an invalid format.DeploymentGroupAlreadyExistsException - A deployment group with the specified name already exists with the applicable IAM user or AWS account.InvalidEC2TagException - The tag was specified in an invalid format.InvalidTagException - The specified tag was specified in an invalid format.InvalidAutoScalingGroupException - The Auto Scaling group was specified in an invalid format or does not exist.InvalidDeploymentConfigNameException - The deployment configuration name was specified in an invalid format.DeploymentConfigDoesNotExistException - The deployment configuration does not exist with the applicable IAM user or AWS account.RoleRequiredException - The role ID was not specified.InvalidRoleException - The service role ARN was specified in an invalid format. Or, if an Auto Scaling group was specified, the
specified service role does not grant the appropriate permissions to Auto Scaling.DeploymentGroupLimitExceededException - The deployment groups limit was exceeded.LifecycleHookLimitExceededException - The limit for lifecycle hooks was exceeded.InvalidTriggerConfigException - The trigger was specified in an invalid format.TriggerTargetsLimitExceededException - The maximum allowed number of triggers was exceeded.InvalidAlarmConfigException - The format of the alarm configuration is invalid. Possible causes include:
The alarm list is null.
The alarm object is null.
The alarm name is empty or null or exceeds the 255 character limit.
Two alarms with the same name have been specified.
The alarm configuration is enabled but the alarm list is empty.
AlarmsLimitExceededException - The maximum number of alarms for a deployment group (10) was exceeded.InvalidAutoRollbackConfigException - The automatic rollback configuration was specified in an invalid format. For example, automatic rollback
is enabled but an invalid triggering event type or no event types were listed.InvalidLoadBalancerInfoException - An invalid load balancer name, or no load balancer name, was specified.InvalidDeploymentStyleException - An invalid deployment style was specified. Valid deployment types include "IN_PLACE" and "BLUE_GREEN".
Valid deployment options include "WITH_TRAFFIC_CONTROL" and "WITHOUT_TRAFFIC_CONTROL".InvalidBlueGreenDeploymentConfigurationException - The configuration for the blue/green deployment group was provided in an invalid format. For information
about deployment configuration format, see CreateDeploymentConfig.InvalidEC2TagCombinationException - A call was submitted that specified both Ec2TagFilters and Ec2TagSet, but only one of these data types
can be used in a single call.InvalidOnPremisesTagCombinationException - A call was submitted that specified both OnPremisesTagFilters and OnPremisesTagSet, but only one of these
data types can be used in a single call.TagSetListLimitExceededException - The number of tag groups included in the tag set list exceeded the maximum allowed limit of 3.DeleteApplicationResult deleteApplication(DeleteApplicationRequest deleteApplicationRequest)
Deletes an application.
deleteApplicationRequest - Represents the input of a DeleteApplication operation.ApplicationNameRequiredException - The minimum number of required application names was not specified.InvalidApplicationNameException - The application name was specified in an invalid format.DeleteDeploymentConfigResult deleteDeploymentConfig(DeleteDeploymentConfigRequest deleteDeploymentConfigRequest)
Deletes a deployment configuration.
A deployment configuration cannot be deleted if it is currently in use. Predefined configurations cannot be deleted.
deleteDeploymentConfigRequest - Represents the input of a DeleteDeploymentConfig operation.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.DeleteDeploymentGroupResult deleteDeploymentGroup(DeleteDeploymentGroupRequest deleteDeploymentGroupRequest)
Deletes a deployment group.
deleteDeploymentGroupRequest - Represents the input of a DeleteDeploymentGroup operation.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.DeregisterOnPremisesInstanceResult deregisterOnPremisesInstance(DeregisterOnPremisesInstanceRequest deregisterOnPremisesInstanceRequest)
Deregisters an on-premises instance.
deregisterOnPremisesInstanceRequest - Represents the input of a DeregisterOnPremisesInstance operation.InstanceNameRequiredException - An on-premises instance name was not specified.InvalidInstanceNameException - The specified on-premises instance name was specified in an invalid format.GetApplicationResult getApplication(GetApplicationRequest getApplicationRequest)
Gets information about an application.
getApplicationRequest - Represents the input of a GetApplication operation.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.GetApplicationRevisionResult getApplicationRevision(GetApplicationRevisionRequest getApplicationRevisionRequest)
Gets information about an application revision.
getApplicationRevisionRequest - Represents the input of a GetApplicationRevision operation.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.GetDeploymentResult getDeployment(GetDeploymentRequest getDeploymentRequest)
Gets information about a deployment.
getDeploymentRequest - Represents the input of a GetDeployment operation.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.GetDeploymentConfigResult getDeploymentConfig(GetDeploymentConfigRequest getDeploymentConfigRequest)
Gets information about a deployment configuration.
getDeploymentConfigRequest - Represents the input of a GetDeploymentConfig operation.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.GetDeploymentGroupResult getDeploymentGroup(GetDeploymentGroupRequest getDeploymentGroupRequest)
Gets information about a deployment group.
getDeploymentGroupRequest - Represents the input of a GetDeploymentGroup operation.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.GetDeploymentInstanceResult getDeploymentInstance(GetDeploymentInstanceRequest getDeploymentInstanceRequest)
Gets information about an instance as part of a deployment.
getDeploymentInstanceRequest - Represents the input of a GetDeploymentInstance operation.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.GetOnPremisesInstanceResult getOnPremisesInstance(GetOnPremisesInstanceRequest getOnPremisesInstanceRequest)
Gets information about an on-premises instance.
getOnPremisesInstanceRequest - Represents the input of a GetOnPremisesInstance operation.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.ListApplicationRevisionsResult listApplicationRevisions(ListApplicationRevisionsRequest listApplicationRevisionsRequest)
Lists information about revisions for an application.
listApplicationRevisionsRequest - Represents the input of a ListApplicationRevisions operation.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.ListApplicationsResult listApplications(ListApplicationsRequest listApplicationsRequest)
Lists the applications registered with the applicable IAM user or AWS account.
listApplicationsRequest - Represents the input of a ListApplications operation.InvalidNextTokenException - The next token was specified in an invalid format.ListApplicationsResult listApplications()
ListDeploymentConfigsResult listDeploymentConfigs(ListDeploymentConfigsRequest listDeploymentConfigsRequest)
Lists the deployment configurations with the applicable IAM user or AWS account.
listDeploymentConfigsRequest - Represents the input of a ListDeploymentConfigs operation.InvalidNextTokenException - The next token was specified in an invalid format.ListDeploymentConfigsResult listDeploymentConfigs()
ListDeploymentGroupsResult listDeploymentGroups(ListDeploymentGroupsRequest listDeploymentGroupsRequest)
Lists the deployment groups for an application registered with the applicable IAM user or AWS account.
listDeploymentGroupsRequest - Represents the input of a ListDeploymentGroups operation.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.ListDeploymentInstancesResult listDeploymentInstances(ListDeploymentInstancesRequest listDeploymentInstancesRequest)
Lists the instance for a deployment associated with the applicable IAM user or AWS account.
listDeploymentInstancesRequest - Represents the input of a ListDeploymentInstances operation.DeploymentIdRequiredException - At least one deployment ID must be specified.DeploymentDoesNotExistException - The deployment does not exist with the applicable IAM user or AWS account.DeploymentNotStartedException - The specified deployment has not started.InvalidNextTokenException - The next token was specified in an invalid format.InvalidDeploymentIdException - At least one of the deployment IDs was specified in an invalid format.InvalidInstanceStatusException - The specified instance status does not exist.InvalidInstanceTypeException - An invalid instance type was specified for instances in a blue/green deployment. Valid values include
"Blue" for an original environment and "Green" for a replacement environment.InvalidDeploymentInstanceTypeException - An instance type was specified for an in-place deployment. Instance types are supported for blue/green
deployments only.ListDeploymentsResult listDeployments(ListDeploymentsRequest listDeploymentsRequest)
Lists the deployments in a deployment group for an application registered with the applicable IAM user or AWS account.
listDeploymentsRequest - Represents the input of a ListDeployments operation.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.ListDeploymentsResult listDeployments()
listDeployments(ListDeploymentsRequest)ListGitHubAccountTokenNamesResult listGitHubAccountTokenNames(ListGitHubAccountTokenNamesRequest listGitHubAccountTokenNamesRequest)
Lists the names of stored connections to GitHub accounts.
listGitHubAccountTokenNamesRequest - Represents the input of a ListGitHubAccountTokenNames operation.InvalidNextTokenException - The next token was specified in an invalid format.ResourceValidationException - The specified resource could not be validated.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.
listOnPremisesInstancesRequest - Represents the input of a ListOnPremisesInstances operation.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.ListOnPremisesInstancesResult listOnPremisesInstances()
RegisterApplicationRevisionResult registerApplicationRevision(RegisterApplicationRevisionRequest registerApplicationRevisionRequest)
Registers with AWS CodeDeploy a revision for the specified application.
registerApplicationRevisionRequest - Represents the input of a RegisterApplicationRevision operation.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.RegisterOnPremisesInstanceResult registerOnPremisesInstance(RegisterOnPremisesInstanceRequest registerOnPremisesInstanceRequest)
Registers an on-premises instance.
Only one IAM ARN (an IAM session ARN or IAM user ARN) is supported in the request. You cannot use both.
registerOnPremisesInstanceRequest - Represents the input of the register on-premises instance operation.InstanceNameAlreadyRegisteredException - The specified on-premises instance name is already registered.IamArnRequiredException - No IAM ARN was included in the request. You must use an IAM session ARN or IAM user ARN in the request.IamSessionArnAlreadyRegisteredException - The request included an IAM session ARN that has already been used to register a different instance.IamUserArnAlreadyRegisteredException - The specified IAM user ARN is already registered with an on-premises instance.InstanceNameRequiredException - An on-premises instance name was not specified.IamUserArnRequiredException - An IAM user ARN was not specified.InvalidInstanceNameException - The specified on-premises instance name was specified in an invalid format.InvalidIamSessionArnException - The IAM session ARN was specified in an invalid format.InvalidIamUserArnException - The IAM user ARN was specified in an invalid format.MultipleIamArnsProvidedException - Both an IAM user ARN and an IAM session ARN were included in the request. Use only one ARN type.RemoveTagsFromOnPremisesInstancesResult removeTagsFromOnPremisesInstances(RemoveTagsFromOnPremisesInstancesRequest removeTagsFromOnPremisesInstancesRequest)
Removes one or more tags from one or more on-premises instances.
removeTagsFromOnPremisesInstancesRequest - Represents the input of a RemoveTagsFromOnPremisesInstances operation.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.SkipWaitTimeForInstanceTerminationResult skipWaitTimeForInstanceTermination(SkipWaitTimeForInstanceTerminationRequest skipWaitTimeForInstanceTerminationRequest)
In a blue/green deployment, overrides any specified wait time and starts terminating instances immediately after the traffic routing is completed.
skipWaitTimeForInstanceTerminationRequest - DeploymentIdRequiredException - At least one deployment ID must be specified.DeploymentDoesNotExistException - The deployment does not exist with the applicable IAM user or AWS account.DeploymentAlreadyCompletedException - The deployment is already complete.InvalidDeploymentIdException - At least one of the deployment IDs was specified in an invalid format.DeploymentNotStartedException - The specified deployment has not started.UnsupportedActionForDeploymentTypeException - A call was submitted that is not supported for the specified deployment type.StopDeploymentResult stopDeployment(StopDeploymentRequest stopDeploymentRequest)
Attempts to stop an ongoing deployment.
stopDeploymentRequest - Represents the input of a StopDeployment operation.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.UpdateApplicationResult updateApplication(UpdateApplicationRequest updateApplicationRequest)
Changes the name of an application.
updateApplicationRequest - Represents the input of an UpdateApplication operation.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.UpdateApplicationResult updateApplication()
UpdateDeploymentGroupResult updateDeploymentGroup(UpdateDeploymentGroupRequest updateDeploymentGroupRequest)
Changes information about a deployment group.
updateDeploymentGroupRequest - Represents the input of an UpdateDeploymentGroup operation.ApplicationNameRequiredException - The minimum number of required application names was not specified.InvalidApplicationNameException - The application name was specified in an invalid format.ApplicationDoesNotExistException - The application does not exist with the applicable IAM user or AWS account.InvalidDeploymentGroupNameException - The deployment group name was specified in an invalid format.DeploymentGroupAlreadyExistsException - A deployment group with the specified name already exists with the applicable IAM user or AWS account.DeploymentGroupNameRequiredException - The deployment group name was not specified.DeploymentGroupDoesNotExistException - The named deployment group does not exist with the applicable IAM user or AWS account.InvalidEC2TagException - The tag was specified in an invalid format.InvalidTagException - The specified tag was specified in an invalid format.InvalidAutoScalingGroupException - The Auto Scaling group was specified in an invalid format or does not exist.InvalidDeploymentConfigNameException - The deployment configuration name was specified in an invalid format.DeploymentConfigDoesNotExistException - The deployment configuration does not exist with the applicable IAM user or AWS account.InvalidRoleException - The service role ARN was specified in an invalid format. Or, if an Auto Scaling group was specified, the
specified service role does not grant the appropriate permissions to Auto Scaling.LifecycleHookLimitExceededException - The limit for lifecycle hooks was exceeded.InvalidTriggerConfigException - The trigger was specified in an invalid format.TriggerTargetsLimitExceededException - The maximum allowed number of triggers was exceeded.InvalidAlarmConfigException - The format of the alarm configuration is invalid. Possible causes include:
The alarm list is null.
The alarm object is null.
The alarm name is empty or null or exceeds the 255 character limit.
Two alarms with the same name have been specified.
The alarm configuration is enabled but the alarm list is empty.
AlarmsLimitExceededException - The maximum number of alarms for a deployment group (10) was exceeded.InvalidAutoRollbackConfigException - The automatic rollback configuration was specified in an invalid format. For example, automatic rollback
is enabled but an invalid triggering event type or no event types were listed.InvalidLoadBalancerInfoException - An invalid load balancer name, or no load balancer name, was specified.InvalidDeploymentStyleException - An invalid deployment style was specified. Valid deployment types include "IN_PLACE" and "BLUE_GREEN".
Valid deployment options include "WITH_TRAFFIC_CONTROL" and "WITHOUT_TRAFFIC_CONTROL".InvalidBlueGreenDeploymentConfigurationException - The configuration for the blue/green deployment group was provided in an invalid format. For information
about deployment configuration format, see CreateDeploymentConfig.InvalidEC2TagCombinationException - A call was submitted that specified both Ec2TagFilters and Ec2TagSet, but only one of these data types
can be used in a single call.InvalidOnPremisesTagCombinationException - A call was submitted that specified both OnPremisesTagFilters and OnPremisesTagSet, but only one of these
data types can be used in a single call.TagSetListLimitExceededException - The number of tag groups included in the tag set list exceeded the maximum allowed limit of 3.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request - The originally executed request.AmazonCodeDeployWaiters waiters()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.