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.voidsetEndpoint(String endpoint) Overrides the default endpoint for this client ("https://codedeploy.us-east-1.amazonaws.com").voidAn alternative toAmazonCodeDeploy.setEndpoint(String), sets the regional endpoint for this client's service calls.voidshutdown()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:AmazonCodeDeployOverrides 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
ClientConfigurationwill 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:
setEndpointin 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:AmazonCodeDeployAn 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
ClientConfigurationsupplied 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:
setRegionin 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:AmazonCodeDeployAdds tags to on-premises instances.
- Specified by:
addTagsToOnPremisesInstancesin 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:AmazonCodeDeployGets information about one or more application revisions.
- Specified by:
batchGetApplicationRevisionsin 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:AmazonCodeDeployGets information about one or more applications.
- Specified by:
batchGetApplicationsin 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:AmazonCodeDeploySimplified method form for invoking the BatchGetApplications operation.- Specified by:
batchGetApplicationsin interfaceAmazonCodeDeploy- See Also:
-
batchGetDeploymentGroups
public BatchGetDeploymentGroupsResult batchGetDeploymentGroups(BatchGetDeploymentGroupsRequest request) Description copied from interface:AmazonCodeDeployGet information about one or more deployment groups.
- Specified by:
batchGetDeploymentGroupsin 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:AmazonCodeDeployGets information about one or more instance that are part of a deployment group.
- Specified by:
batchGetDeploymentInstancesin 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:AmazonCodeDeployGets information about one or more deployments.
- Specified by:
batchGetDeploymentsin 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:AmazonCodeDeploySimplified method form for invoking the BatchGetDeployments operation.- Specified by:
batchGetDeploymentsin interfaceAmazonCodeDeploy- See Also:
-
batchGetOnPremisesInstances
public BatchGetOnPremisesInstancesResult batchGetOnPremisesInstances(BatchGetOnPremisesInstancesRequest request) Description copied from interface:AmazonCodeDeployGets information about one or more on-premises instances.
- Specified by:
batchGetOnPremisesInstancesin 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:AmazonCodeDeploySimplified method form for invoking the BatchGetOnPremisesInstances operation.- Specified by:
batchGetOnPremisesInstancesin interfaceAmazonCodeDeploy- See Also:
-
createApplication
Description copied from interface:AmazonCodeDeployCreates an application.
- Specified by:
createApplicationin 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:AmazonCodeDeployDeploys an application revision through the specified deployment group.
- Specified by:
createDeploymentin 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:AmazonCodeDeployCreates a deployment configuration.
- Specified by:
createDeploymentConfigin 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:AmazonCodeDeployCreates a deployment group to which application revisions will be deployed.
- Specified by:
createDeploymentGroupin 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:AmazonCodeDeployDeletes an application.
- Specified by:
deleteApplicationin 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:AmazonCodeDeployDeletes a deployment configuration.
A deployment configuration cannot be deleted if it is currently in use. Predefined configurations cannot be deleted. - Specified by:
deleteDeploymentConfigin 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:AmazonCodeDeployDeletes a deployment group.
- Specified by:
deleteDeploymentGroupin 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:AmazonCodeDeployDeregisters an on-premises instance.
- Specified by:
deregisterOnPremisesInstancein 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:AmazonCodeDeployGets information about an application.
- Specified by:
getApplicationin 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:AmazonCodeDeployGets information about an application revision.
- Specified by:
getApplicationRevisionin 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:AmazonCodeDeployGets information about a deployment.
- Specified by:
getDeploymentin 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:AmazonCodeDeployGets information about a deployment configuration.
- Specified by:
getDeploymentConfigin 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:AmazonCodeDeployGets information about a deployment group.
- Specified by:
getDeploymentGroupin 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:AmazonCodeDeployGets information about an instance as part of a deployment.
- Specified by:
getDeploymentInstancein 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:AmazonCodeDeployGets information about an on-premises instance.
- Specified by:
getOnPremisesInstancein 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:AmazonCodeDeployLists information about revisions for an application.
- Specified by:
listApplicationRevisionsin 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:AmazonCodeDeployLists the applications registered with the applicable IAM user or AWS account.
- Specified by:
listApplicationsin 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:AmazonCodeDeploySimplified method form for invoking the ListApplications operation.- Specified by:
listApplicationsin interfaceAmazonCodeDeploy- See Also:
-
listDeploymentConfigs
Description copied from interface:AmazonCodeDeployLists the deployment configurations with the applicable IAM user or AWS account.
- Specified by:
listDeploymentConfigsin 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:AmazonCodeDeploySimplified method form for invoking the ListDeploymentConfigs operation.- Specified by:
listDeploymentConfigsin interfaceAmazonCodeDeploy- See Also:
-
listDeploymentGroups
Description copied from interface:AmazonCodeDeployLists the deployment groups for an application registered with the applicable IAM user or AWS account.
- Specified by:
listDeploymentGroupsin 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:AmazonCodeDeployLists the instance for a deployment associated with the applicable IAM user or AWS account.
- Specified by:
listDeploymentInstancesin 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:AmazonCodeDeployLists the deployments in a deployment group for an application registered with the applicable IAM user or AWS account.
- Specified by:
listDeploymentsin 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:AmazonCodeDeploySimplified method form for invoking the ListDeployments operation.- Specified by:
listDeploymentsin interfaceAmazonCodeDeploy- See Also:
-
listOnPremisesInstances
public ListOnPremisesInstancesResult listOnPremisesInstances(ListOnPremisesInstancesRequest request) Description copied from interface:AmazonCodeDeployGets 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:
listOnPremisesInstancesin 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:AmazonCodeDeploySimplified method form for invoking the ListOnPremisesInstances operation.- Specified by:
listOnPremisesInstancesin interfaceAmazonCodeDeploy- See Also:
-
registerApplicationRevision
public RegisterApplicationRevisionResult registerApplicationRevision(RegisterApplicationRevisionRequest request) Description copied from interface:AmazonCodeDeployRegisters with AWS CodeDeploy a revision for the specified application.
- Specified by:
registerApplicationRevisionin 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:AmazonCodeDeployRegisters an on-premises instance.
- Specified by:
registerOnPremisesInstancein 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:AmazonCodeDeployRemoves one or more tags from one or more on-premises instances.
- Specified by:
removeTagsFromOnPremisesInstancesin 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:AmazonCodeDeployAttempts to stop an ongoing deployment.
- Specified by:
stopDeploymentin 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:AmazonCodeDeployChanges the name of an application.
- Specified by:
updateApplicationin 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:AmazonCodeDeploySimplified method form for invoking the UpdateApplication operation.- Specified by:
updateApplicationin interfaceAmazonCodeDeploy- See Also:
-
updateDeploymentGroup
Description copied from interface:AmazonCodeDeployChanges information about a deployment group.
- Specified by:
updateDeploymentGroupin 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:AmazonCodeDeployShuts 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:
shutdownin interfaceAmazonCodeDeploy
-
getCachedResponseMetadata
Description copied from interface:AmazonCodeDeployReturns 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:
getCachedResponseMetadatain interfaceAmazonCodeDeploy- Parameters:
request- The originally executed request.- Returns:
- The response metadata for the specified request, or null if none is available.
-