Class AbstractAmazonCodeDeploy
- All Implemented Interfaces:
AmazonCodeDeploy
- Direct Known Subclasses:
AbstractAmazonCodeDeployAsync
AmazonCodeDeploy
. Convenient method forms
pass through to the corresponding overload that takes a request object, which
throws an UnsupportedOperationException
.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionAdds tags to on-premises instances.Gets information about one or more application revisions.Simplified method form for invoking the BatchGetApplications operation.Gets information about one or more applications.Get information about one or more deployment groups.Gets information about one or more instance that are part of a deployment group.Simplified method form for invoking the BatchGetDeployments operation.Gets information about one or more deployments.Simplified method form for invoking the BatchGetOnPremisesInstances operation.Gets information about one or more on-premises instances.Creates an application.createDeployment
(CreateDeploymentRequest request) Deploys an application revision through the specified deployment group.Creates a deployment configuration.Creates a deployment group to which application revisions will be deployed.Deletes an application.Deletes a deployment configuration.Deletes a deployment group.Deregisters an on-premises instance.getApplication
(GetApplicationRequest request) Gets information about an application.Gets information about an application revision.Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.getDeployment
(GetDeploymentRequest request) Gets information about a deployment.Gets information about a deployment configuration.Gets information about a deployment group.Gets information about an instance as part of a deployment.Gets information about an on-premises instance.Lists information about revisions for an application.Simplified method form for invoking the ListApplications operation.listApplications
(ListApplicationsRequest request) Lists the applications registered with the applicable IAM user or AWS account.Simplified method form for invoking the ListDeploymentConfigs operation.Lists the deployment configurations with the applicable IAM user or AWS account.Lists the deployment groups for an application registered with the applicable IAM user or AWS account.Lists the instance for a deployment associated with the applicable IAM user or AWS account.Simplified method form for invoking the ListDeployments operation.listDeployments
(ListDeploymentsRequest request) Lists the deployments in a deployment group for an application registered with the applicable IAM user or AWS account.Simplified method form for invoking the ListOnPremisesInstances operation.Gets a list of names for one or more on-premises instances.Registers with AWS CodeDeploy a revision for the specified application.Registers an on-premises instance.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
An alternative toAmazonCodeDeploy.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.stopDeployment
(StopDeploymentRequest request) Attempts to stop an ongoing deployment.Simplified method form for invoking the UpdateApplication operation.Changes the name of an application.Changes information about a deployment group.
-
Constructor Details
-
AbstractAmazonCodeDeploy
protected AbstractAmazonCodeDeploy()
-
-
Method Details
-
setEndpoint
Description copied from interface:AmazonCodeDeploy
Overrides the default endpoint for this client ("https://codedeploy.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.Callers can pass in just the endpoint (ex: "codedeploy.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://codedeploy.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's
ClientConfiguration
will be used, which by default is HTTPS.For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
- Specified by:
setEndpoint
in interfaceAmazonCodeDeploy
- 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
Description copied from interface:AmazonCodeDeploy
An alternative toAmazonCodeDeploy.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.
- Specified by:
setRegion
in interfaceAmazonCodeDeploy
- Parameters:
region
- The region this client will communicate with. SeeRegion.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:
-
addTagsToOnPremisesInstances
public AddTagsToOnPremisesInstancesResult addTagsToOnPremisesInstances(AddTagsToOnPremisesInstancesRequest request) Description copied from interface:AmazonCodeDeploy
Adds tags to on-premises instances.
- Specified by:
addTagsToOnPremisesInstances
in interfaceAmazonCodeDeploy
- Parameters:
request
- Represents the input of, and adds tags to, an on-premises instance operation.- Returns:
- Result of the AddTagsToOnPremisesInstances operation returned by the service.
-
batchGetApplicationRevisions
public BatchGetApplicationRevisionsResult batchGetApplicationRevisions(BatchGetApplicationRevisionsRequest request) Description copied from interface:AmazonCodeDeploy
Gets information about one or more application revisions.
- Specified by:
batchGetApplicationRevisions
in interfaceAmazonCodeDeploy
- Parameters:
request
- Represents the input of a batch get application revisions operation.- Returns:
- Result of the BatchGetApplicationRevisions operation returned by the service.
-
batchGetApplications
Description copied from interface:AmazonCodeDeploy
Gets information about one or more applications.
- Specified by:
batchGetApplications
in interfaceAmazonCodeDeploy
- Parameters:
request
- Represents the input of a batch get applications operation.- Returns:
- Result of the BatchGetApplications operation returned by the service.
-
batchGetApplications
Description copied from interface:AmazonCodeDeploy
Simplified method form for invoking the BatchGetApplications operation.- Specified by:
batchGetApplications
in interfaceAmazonCodeDeploy
- See Also:
-
batchGetDeploymentGroups
public BatchGetDeploymentGroupsResult batchGetDeploymentGroups(BatchGetDeploymentGroupsRequest request) Description copied from interface:AmazonCodeDeploy
Get information about one or more deployment groups.
- Specified by:
batchGetDeploymentGroups
in interfaceAmazonCodeDeploy
- Parameters:
request
- Represents the input of a batch get deployment groups operation.- Returns:
- Result of the BatchGetDeploymentGroups operation returned by the service.
-
batchGetDeploymentInstances
public BatchGetDeploymentInstancesResult batchGetDeploymentInstances(BatchGetDeploymentInstancesRequest request) Description copied from interface:AmazonCodeDeploy
Gets information about one or more instance that are part of a deployment group.
- Specified by:
batchGetDeploymentInstances
in interfaceAmazonCodeDeploy
- Parameters:
request
- Represents the input of a batch get deployment instances operation.- Returns:
- Result of the BatchGetDeploymentInstances operation returned by the service.
-
batchGetDeployments
Description copied from interface:AmazonCodeDeploy
Gets information about one or more deployments.
- Specified by:
batchGetDeployments
in interfaceAmazonCodeDeploy
- Parameters:
request
- Represents the input of a batch get deployments operation.- Returns:
- Result of the BatchGetDeployments operation returned by the service.
-
batchGetDeployments
Description copied from interface:AmazonCodeDeploy
Simplified method form for invoking the BatchGetDeployments operation.- Specified by:
batchGetDeployments
in interfaceAmazonCodeDeploy
- See Also:
-
batchGetOnPremisesInstances
public BatchGetOnPremisesInstancesResult batchGetOnPremisesInstances(BatchGetOnPremisesInstancesRequest request) Description copied from interface:AmazonCodeDeploy
Gets information about one or more on-premises instances.
- Specified by:
batchGetOnPremisesInstances
in interfaceAmazonCodeDeploy
- Parameters:
request
- Represents the input of a batch get on-premises instances operation.- Returns:
- Result of the BatchGetOnPremisesInstances operation returned by the service.
-
batchGetOnPremisesInstances
Description copied from interface:AmazonCodeDeploy
Simplified method form for invoking the BatchGetOnPremisesInstances operation.- Specified by:
batchGetOnPremisesInstances
in interfaceAmazonCodeDeploy
- See Also:
-
createApplication
Description copied from interface:AmazonCodeDeploy
Creates an application.
- Specified by:
createApplication
in interfaceAmazonCodeDeploy
- Parameters:
request
- Represents the input of a create application operation.- Returns:
- Result of the CreateApplication operation returned by the service.
-
createDeployment
Description copied from interface:AmazonCodeDeploy
Deploys an application revision through the specified deployment group.
- Specified by:
createDeployment
in interfaceAmazonCodeDeploy
- Parameters:
request
- Represents the input of a create deployment operation.- Returns:
- Result of the CreateDeployment operation returned by the service.
-
createDeploymentConfig
Description copied from interface:AmazonCodeDeploy
Creates a deployment configuration.
- Specified by:
createDeploymentConfig
in interfaceAmazonCodeDeploy
- Parameters:
request
- Represents the input of a create deployment configuration operation.- Returns:
- Result of the CreateDeploymentConfig operation returned by the service.
-
createDeploymentGroup
Description copied from interface:AmazonCodeDeploy
Creates a deployment group to which application revisions will be deployed.
- Specified by:
createDeploymentGroup
in interfaceAmazonCodeDeploy
- Parameters:
request
- Represents the input of a create deployment group operation.- Returns:
- Result of the CreateDeploymentGroup operation returned by the service.
-
deleteApplication
Description copied from interface:AmazonCodeDeploy
Deletes an application.
- Specified by:
deleteApplication
in interfaceAmazonCodeDeploy
- Parameters:
request
- Represents the input of a delete application operation.- Returns:
- Result of the DeleteApplication operation returned by the service.
-
deleteDeploymentConfig
Description copied from interface:AmazonCodeDeploy
Deletes a deployment configuration.
A deployment configuration cannot be deleted if it is currently in use. Predefined configurations cannot be deleted. - Specified by:
deleteDeploymentConfig
in interfaceAmazonCodeDeploy
- Parameters:
request
- Represents the input of a delete deployment configuration operation.- Returns:
- Result of the DeleteDeploymentConfig operation returned by the service.
-
deleteDeploymentGroup
Description copied from interface:AmazonCodeDeploy
Deletes a deployment group.
- Specified by:
deleteDeploymentGroup
in interfaceAmazonCodeDeploy
- Parameters:
request
- Represents the input of a delete deployment group operation.- Returns:
- Result of the DeleteDeploymentGroup operation returned by the service.
-
deregisterOnPremisesInstance
public DeregisterOnPremisesInstanceResult deregisterOnPremisesInstance(DeregisterOnPremisesInstanceRequest request) Description copied from interface:AmazonCodeDeploy
Deregisters an on-premises instance.
- Specified by:
deregisterOnPremisesInstance
in interfaceAmazonCodeDeploy
- Parameters:
request
- Represents the input of a deregister on-premises instance operation.- Returns:
- Result of the DeregisterOnPremisesInstance operation returned by the service.
-
getApplication
Description copied from interface:AmazonCodeDeploy
Gets information about an application.
- Specified by:
getApplication
in interfaceAmazonCodeDeploy
- Parameters:
request
- Represents the input of a get application operation.- Returns:
- Result of the GetApplication operation returned by the service.
-
getApplicationRevision
Description copied from interface:AmazonCodeDeploy
Gets information about an application revision.
- Specified by:
getApplicationRevision
in interfaceAmazonCodeDeploy
- Parameters:
request
- Represents the input of a get application revision operation.- Returns:
- Result of the GetApplicationRevision operation returned by the service.
-
getDeployment
Description copied from interface:AmazonCodeDeploy
Gets information about a deployment.
- Specified by:
getDeployment
in interfaceAmazonCodeDeploy
- Parameters:
request
- Represents the input of a get deployment operation.- Returns:
- Result of the GetDeployment operation returned by the service.
-
getDeploymentConfig
Description copied from interface:AmazonCodeDeploy
Gets information about a deployment configuration.
- Specified by:
getDeploymentConfig
in interfaceAmazonCodeDeploy
- Parameters:
request
- Represents the input of a get deployment configuration operation.- Returns:
- Result of the GetDeploymentConfig operation returned by the service.
-
getDeploymentGroup
Description copied from interface:AmazonCodeDeploy
Gets information about a deployment group.
- Specified by:
getDeploymentGroup
in interfaceAmazonCodeDeploy
- Parameters:
request
- Represents the input of a get deployment group operation.- Returns:
- Result of the GetDeploymentGroup operation returned by the service.
-
getDeploymentInstance
Description copied from interface:AmazonCodeDeploy
Gets information about an instance as part of a deployment.
- Specified by:
getDeploymentInstance
in interfaceAmazonCodeDeploy
- Parameters:
request
- Represents the input of a get deployment instance operation.- Returns:
- Result of the GetDeploymentInstance operation returned by the service.
-
getOnPremisesInstance
Description copied from interface:AmazonCodeDeploy
Gets information about an on-premises instance.
- Specified by:
getOnPremisesInstance
in interfaceAmazonCodeDeploy
- Parameters:
request
- Represents the input of a get on-premises instance operation.- Returns:
- Result of the GetOnPremisesInstance operation returned by the service.
-
listApplicationRevisions
public ListApplicationRevisionsResult listApplicationRevisions(ListApplicationRevisionsRequest request) Description copied from interface:AmazonCodeDeploy
Lists information about revisions for an application.
- Specified by:
listApplicationRevisions
in interfaceAmazonCodeDeploy
- Parameters:
request
- Represents the input of a list application revisions operation.- Returns:
- Result of the ListApplicationRevisions operation returned by the service.
-
listApplications
Description copied from interface:AmazonCodeDeploy
Lists the applications registered with the applicable IAM user or AWS account.
- Specified by:
listApplications
in interfaceAmazonCodeDeploy
- Parameters:
request
- Represents the input of a list applications operation.- Returns:
- Result of the ListApplications operation returned by the service.
-
listApplications
Description copied from interface:AmazonCodeDeploy
Simplified method form for invoking the ListApplications operation.- Specified by:
listApplications
in interfaceAmazonCodeDeploy
- See Also:
-
listDeploymentConfigs
Description copied from interface:AmazonCodeDeploy
Lists the deployment configurations with the applicable IAM user or AWS account.
- Specified by:
listDeploymentConfigs
in interfaceAmazonCodeDeploy
- Parameters:
request
- Represents the input of a list deployment configurations operation.- Returns:
- Result of the ListDeploymentConfigs operation returned by the service.
-
listDeploymentConfigs
Description copied from interface:AmazonCodeDeploy
Simplified method form for invoking the ListDeploymentConfigs operation.- Specified by:
listDeploymentConfigs
in interfaceAmazonCodeDeploy
- See Also:
-
listDeploymentGroups
Description copied from interface:AmazonCodeDeploy
Lists the deployment groups for an application registered with the applicable IAM user or AWS account.
- Specified by:
listDeploymentGroups
in interfaceAmazonCodeDeploy
- Parameters:
request
- Represents the input of a list deployment groups operation.- Returns:
- Result of the ListDeploymentGroups operation returned by the service.
-
listDeploymentInstances
public ListDeploymentInstancesResult listDeploymentInstances(ListDeploymentInstancesRequest request) Description copied from interface:AmazonCodeDeploy
Lists the instance for a deployment associated with the applicable IAM user or AWS account.
- Specified by:
listDeploymentInstances
in interfaceAmazonCodeDeploy
- Parameters:
request
- Represents the input of a list deployment instances operation.- Returns:
- Result of the ListDeploymentInstances operation returned by the service.
-
listDeployments
Description copied from interface:AmazonCodeDeploy
Lists the deployments in a deployment group for an application registered with the applicable IAM user or AWS account.
- Specified by:
listDeployments
in interfaceAmazonCodeDeploy
- Parameters:
request
- Represents the input of a list deployments operation.- Returns:
- Result of the ListDeployments operation returned by the service.
-
listDeployments
Description copied from interface:AmazonCodeDeploy
Simplified method form for invoking the ListDeployments operation.- Specified by:
listDeployments
in interfaceAmazonCodeDeploy
- See Also:
-
listOnPremisesInstances
public ListOnPremisesInstancesResult listOnPremisesInstances(ListOnPremisesInstancesRequest request) Description copied from interface:AmazonCodeDeploy
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.
- Specified by:
listOnPremisesInstances
in interfaceAmazonCodeDeploy
- Parameters:
request
- Represents the input of a list on-premises instances operation.- Returns:
- Result of the ListOnPremisesInstances operation returned by the service.
-
listOnPremisesInstances
Description copied from interface:AmazonCodeDeploy
Simplified method form for invoking the ListOnPremisesInstances operation.- Specified by:
listOnPremisesInstances
in interfaceAmazonCodeDeploy
- See Also:
-
registerApplicationRevision
public RegisterApplicationRevisionResult registerApplicationRevision(RegisterApplicationRevisionRequest request) Description copied from interface:AmazonCodeDeploy
Registers with AWS CodeDeploy a revision for the specified application.
- Specified by:
registerApplicationRevision
in interfaceAmazonCodeDeploy
- Parameters:
request
- Represents the input of a register application revision operation.- Returns:
- Result of the RegisterApplicationRevision operation returned by the service.
-
registerOnPremisesInstance
public RegisterOnPremisesInstanceResult registerOnPremisesInstance(RegisterOnPremisesInstanceRequest request) Description copied from interface:AmazonCodeDeploy
Registers an on-premises instance.
- Specified by:
registerOnPremisesInstance
in interfaceAmazonCodeDeploy
- Parameters:
request
- Represents the input of the register on-premises instance operation.- Returns:
- Result of the RegisterOnPremisesInstance operation returned by the service.
-
removeTagsFromOnPremisesInstances
public RemoveTagsFromOnPremisesInstancesResult removeTagsFromOnPremisesInstances(RemoveTagsFromOnPremisesInstancesRequest request) Description copied from interface:AmazonCodeDeploy
Removes one or more tags from one or more on-premises instances.
- Specified by:
removeTagsFromOnPremisesInstances
in interfaceAmazonCodeDeploy
- Parameters:
request
- Represents the input of a remove tags from on-premises instances operation.- Returns:
- Result of the RemoveTagsFromOnPremisesInstances operation returned by the service.
-
stopDeployment
Description copied from interface:AmazonCodeDeploy
Attempts to stop an ongoing deployment.
- Specified by:
stopDeployment
in interfaceAmazonCodeDeploy
- Parameters:
request
- Represents the input of a stop deployment operation.- Returns:
- Result of the StopDeployment operation returned by the service.
-
updateApplication
Description copied from interface:AmazonCodeDeploy
Changes the name of an application.
- Specified by:
updateApplication
in interfaceAmazonCodeDeploy
- Parameters:
request
- Represents the input of an update application operation.- Returns:
- Result of the UpdateApplication operation returned by the service.
-
updateApplication
Description copied from interface:AmazonCodeDeploy
Simplified method form for invoking the UpdateApplication operation.- Specified by:
updateApplication
in interfaceAmazonCodeDeploy
- See Also:
-
updateDeploymentGroup
Description copied from interface:AmazonCodeDeploy
Changes information about a deployment group.
- Specified by:
updateDeploymentGroup
in interfaceAmazonCodeDeploy
- Parameters:
request
- Represents the input of an update deployment group operation.- Returns:
- Result of the UpdateDeploymentGroup operation returned by the service.
-
shutdown
public void shutdown()Description copied from interface:AmazonCodeDeploy
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.- Specified by:
shutdown
in interfaceAmazonCodeDeploy
-
getCachedResponseMetadata
Description copied from interface:AmazonCodeDeploy
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.
- Specified by:
getCachedResponseMetadata
in interfaceAmazonCodeDeploy
- Parameters:
request
- The originally executed request.- Returns:
- The response metadata for the specified request, or null if none is available.
-