@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonCodeDeploy extends Object implements AmazonCodeDeploy
AmazonCodeDeploy. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIXpublic void setEndpoint(String endpoint)
AmazonCodeDeploy
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: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
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.
setEndpoint in interface AmazonCodeDeployendpoint - 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.public void setRegion(Region region)
AmazonCodeDeployAmazonCodeDeploy.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.
setRegion in interface AmazonCodeDeployregion - 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)public AddTagsToOnPremisesInstancesResult addTagsToOnPremisesInstances(AddTagsToOnPremisesInstancesRequest request)
AmazonCodeDeployAdds tags to on-premises instances.
addTagsToOnPremisesInstances in interface AmazonCodeDeployrequest - Represents the input of, and adds tags to, an on-premises instance operation.public BatchGetApplicationRevisionsResult batchGetApplicationRevisions(BatchGetApplicationRevisionsRequest request)
AmazonCodeDeployGets information about one or more application revisions. The maximum number of application revisions that can be returned is 25.
batchGetApplicationRevisions in interface AmazonCodeDeployrequest - Represents the input of a BatchGetApplicationRevisions operation.public BatchGetApplicationsResult batchGetApplications(BatchGetApplicationsRequest request)
AmazonCodeDeployGets information about one or more applications. The maximum number of applications that can be returned is 100.
batchGetApplications in interface AmazonCodeDeployrequest - Represents the input of a BatchGetApplications operation.public BatchGetApplicationsResult batchGetApplications()
AmazonCodeDeploybatchGetApplications in interface AmazonCodeDeployAmazonCodeDeploy.batchGetApplications(BatchGetApplicationsRequest)public BatchGetDeploymentGroupsResult batchGetDeploymentGroups(BatchGetDeploymentGroupsRequest request)
AmazonCodeDeployGets information about one or more deployment groups.
batchGetDeploymentGroups in interface AmazonCodeDeployrequest - Represents the input of a BatchGetDeploymentGroups operation.@Deprecated public BatchGetDeploymentInstancesResult batchGetDeploymentInstances(BatchGetDeploymentInstancesRequest request)
AmazonCodeDeploy
This method works, but is deprecated. Use BatchGetDeploymentTargets instead.
Returns an array of one or more instances associated with a deployment. This method works with EC2/On-premises
and AWS Lambda compute platforms. The newer BatchGetDeploymentTargets works with all compute
platforms. The maximum number of instances that can be returned is 25.
batchGetDeploymentInstances in interface AmazonCodeDeployrequest - Represents the input of a BatchGetDeploymentInstances operation.public BatchGetDeploymentTargetsResult batchGetDeploymentTargets(BatchGetDeploymentTargetsRequest request)
AmazonCodeDeploy
Returns an array of one or more targets associated with a deployment. This method works with all compute types
and should be used instead of the deprecated BatchGetDeploymentInstances. The maximum number of
targets that can be returned is 25.
The type of targets returned depends on the deployment's compute platform or deployment method:
EC2/On-premises: Information about EC2 instance targets.
AWS Lambda: Information about Lambda functions targets.
Amazon ECS: Information about Amazon ECS service targets.
CloudFormation: Information about targets of blue/green deployments initiated by a CloudFormation stack update.
batchGetDeploymentTargets in interface AmazonCodeDeploypublic BatchGetDeploymentsResult batchGetDeployments(BatchGetDeploymentsRequest request)
AmazonCodeDeployGets information about one or more deployments. The maximum number of deployments that can be returned is 25.
batchGetDeployments in interface AmazonCodeDeployrequest - Represents the input of a BatchGetDeployments operation.public BatchGetDeploymentsResult batchGetDeployments()
AmazonCodeDeploybatchGetDeployments in interface AmazonCodeDeployAmazonCodeDeploy.batchGetDeployments(BatchGetDeploymentsRequest)public BatchGetOnPremisesInstancesResult batchGetOnPremisesInstances(BatchGetOnPremisesInstancesRequest request)
AmazonCodeDeployGets information about one or more on-premises instances. The maximum number of on-premises instances that can be returned is 25.
batchGetOnPremisesInstances in interface AmazonCodeDeployrequest - Represents the input of a BatchGetOnPremisesInstances operation.public BatchGetOnPremisesInstancesResult batchGetOnPremisesInstances()
AmazonCodeDeploybatchGetOnPremisesInstances in interface AmazonCodeDeployAmazonCodeDeploy.batchGetOnPremisesInstances(BatchGetOnPremisesInstancesRequest)public ContinueDeploymentResult continueDeployment(ContinueDeploymentRequest request)
AmazonCodeDeployFor 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.)
continueDeployment in interface AmazonCodeDeploypublic CreateApplicationResult createApplication(CreateApplicationRequest request)
AmazonCodeDeployCreates an application.
createApplication in interface AmazonCodeDeployrequest - Represents the input of a CreateApplication operation.public CreateDeploymentResult createDeployment(CreateDeploymentRequest request)
AmazonCodeDeployDeploys an application revision through the specified deployment group.
createDeployment in interface AmazonCodeDeployrequest - Represents the input of a CreateDeployment operation.public CreateDeploymentConfigResult createDeploymentConfig(CreateDeploymentConfigRequest request)
AmazonCodeDeployCreates a deployment configuration.
createDeploymentConfig in interface AmazonCodeDeployrequest - Represents the input of a CreateDeploymentConfig operation.public CreateDeploymentGroupResult createDeploymentGroup(CreateDeploymentGroupRequest request)
AmazonCodeDeployCreates a deployment group to which application revisions are deployed.
createDeploymentGroup in interface AmazonCodeDeployrequest - Represents the input of a CreateDeploymentGroup operation.public DeleteApplicationResult deleteApplication(DeleteApplicationRequest request)
AmazonCodeDeployDeletes an application.
deleteApplication in interface AmazonCodeDeployrequest - Represents the input of a DeleteApplication operation.public DeleteDeploymentConfigResult deleteDeploymentConfig(DeleteDeploymentConfigRequest request)
AmazonCodeDeployDeletes a deployment configuration.
A deployment configuration cannot be deleted if it is currently in use. Predefined configurations cannot be deleted.
deleteDeploymentConfig in interface AmazonCodeDeployrequest - Represents the input of a DeleteDeploymentConfig operation.public DeleteDeploymentGroupResult deleteDeploymentGroup(DeleteDeploymentGroupRequest request)
AmazonCodeDeployDeletes a deployment group.
deleteDeploymentGroup in interface AmazonCodeDeployrequest - Represents the input of a DeleteDeploymentGroup operation.public DeleteGitHubAccountTokenResult deleteGitHubAccountToken(DeleteGitHubAccountTokenRequest request)
AmazonCodeDeployDeletes a GitHub account connection.
deleteGitHubAccountToken in interface AmazonCodeDeployrequest - Represents the input of a DeleteGitHubAccount operation.public DeleteResourcesByExternalIdResult deleteResourcesByExternalId(DeleteResourcesByExternalIdRequest request)
AmazonCodeDeployDeletes resources linked to an external ID.
deleteResourcesByExternalId in interface AmazonCodeDeploypublic DeregisterOnPremisesInstanceResult deregisterOnPremisesInstance(DeregisterOnPremisesInstanceRequest request)
AmazonCodeDeployDeregisters an on-premises instance.
deregisterOnPremisesInstance in interface AmazonCodeDeployrequest - Represents the input of a DeregisterOnPremisesInstance operation.public GetApplicationResult getApplication(GetApplicationRequest request)
AmazonCodeDeployGets information about an application.
getApplication in interface AmazonCodeDeployrequest - Represents the input of a GetApplication operation.public GetApplicationRevisionResult getApplicationRevision(GetApplicationRevisionRequest request)
AmazonCodeDeployGets information about an application revision.
getApplicationRevision in interface AmazonCodeDeployrequest - Represents the input of a GetApplicationRevision operation.public GetDeploymentResult getDeployment(GetDeploymentRequest request)
AmazonCodeDeployGets information about a deployment.
The content property of the appSpecContent object in the returned revision is always
null. Use GetApplicationRevision and the sha256 property of the returned
appSpecContent object to get the content of the deployment’s AppSpec file.
getDeployment in interface AmazonCodeDeployrequest - Represents the input of a GetDeployment operation.public GetDeploymentConfigResult getDeploymentConfig(GetDeploymentConfigRequest request)
AmazonCodeDeployGets information about a deployment configuration.
getDeploymentConfig in interface AmazonCodeDeployrequest - Represents the input of a GetDeploymentConfig operation.public GetDeploymentGroupResult getDeploymentGroup(GetDeploymentGroupRequest request)
AmazonCodeDeployGets information about a deployment group.
getDeploymentGroup in interface AmazonCodeDeployrequest - Represents the input of a GetDeploymentGroup operation.@Deprecated public GetDeploymentInstanceResult getDeploymentInstance(GetDeploymentInstanceRequest request)
AmazonCodeDeployGets information about an instance as part of a deployment.
getDeploymentInstance in interface AmazonCodeDeployrequest - Represents the input of a GetDeploymentInstance operation.public GetDeploymentTargetResult getDeploymentTarget(GetDeploymentTargetRequest request)
AmazonCodeDeployReturns information about a deployment target.
getDeploymentTarget in interface AmazonCodeDeploypublic GetOnPremisesInstanceResult getOnPremisesInstance(GetOnPremisesInstanceRequest request)
AmazonCodeDeployGets information about an on-premises instance.
getOnPremisesInstance in interface AmazonCodeDeployrequest - Represents the input of a GetOnPremisesInstance operation.public ListApplicationRevisionsResult listApplicationRevisions(ListApplicationRevisionsRequest request)
AmazonCodeDeployLists information about revisions for an application.
listApplicationRevisions in interface AmazonCodeDeployrequest - Represents the input of a ListApplicationRevisions operation.public ListApplicationsResult listApplications(ListApplicationsRequest request)
AmazonCodeDeployLists the applications registered with the IAM user or AWS account.
listApplications in interface AmazonCodeDeployrequest - Represents the input of a ListApplications operation.public ListApplicationsResult listApplications()
AmazonCodeDeploylistApplications in interface AmazonCodeDeployAmazonCodeDeploy.listApplications(ListApplicationsRequest)public ListDeploymentConfigsResult listDeploymentConfigs(ListDeploymentConfigsRequest request)
AmazonCodeDeployLists the deployment configurations with the IAM user or AWS account.
listDeploymentConfigs in interface AmazonCodeDeployrequest - Represents the input of a ListDeploymentConfigs operation.public ListDeploymentConfigsResult listDeploymentConfigs()
AmazonCodeDeploylistDeploymentConfigs in interface AmazonCodeDeployAmazonCodeDeploy.listDeploymentConfigs(ListDeploymentConfigsRequest)public ListDeploymentGroupsResult listDeploymentGroups(ListDeploymentGroupsRequest request)
AmazonCodeDeployLists the deployment groups for an application registered with the IAM user or AWS account.
listDeploymentGroups in interface AmazonCodeDeployrequest - Represents the input of a ListDeploymentGroups operation.@Deprecated public ListDeploymentInstancesResult listDeploymentInstances(ListDeploymentInstancesRequest request)
AmazonCodeDeploy
The newer BatchGetDeploymentTargets should be used instead because it works with all compute types.
ListDeploymentInstances throws an exception if it is used with a compute platform other than
EC2/On-premises or AWS Lambda.
Lists the instance for a deployment associated with the IAM user or AWS account.
listDeploymentInstances in interface AmazonCodeDeployrequest - Represents the input of a ListDeploymentInstances operation.public ListDeploymentTargetsResult listDeploymentTargets(ListDeploymentTargetsRequest request)
AmazonCodeDeployReturns an array of target IDs that are associated a deployment.
listDeploymentTargets in interface AmazonCodeDeploypublic ListDeploymentsResult listDeployments(ListDeploymentsRequest request)
AmazonCodeDeployLists the deployments in a deployment group for an application registered with the IAM user or AWS account.
listDeployments in interface AmazonCodeDeployrequest - Represents the input of a ListDeployments operation.public ListDeploymentsResult listDeployments()
AmazonCodeDeploylistDeployments in interface AmazonCodeDeployAmazonCodeDeploy.listDeployments(ListDeploymentsRequest)public ListGitHubAccountTokenNamesResult listGitHubAccountTokenNames(ListGitHubAccountTokenNamesRequest request)
AmazonCodeDeployLists the names of stored connections to GitHub accounts.
listGitHubAccountTokenNames in interface AmazonCodeDeployrequest - Represents the input of a ListGitHubAccountTokenNames operation.public ListOnPremisesInstancesResult listOnPremisesInstances(ListOnPremisesInstancesRequest request)
AmazonCodeDeployGets a list of names for one or more on-premises instances.
Unless otherwise specified, both registered and deregistered on-premises instance names are listed. To list only registered or deregistered on-premises instance names, use the registration status parameter.
listOnPremisesInstances in interface AmazonCodeDeployrequest - Represents the input of a ListOnPremisesInstances operation.public ListOnPremisesInstancesResult listOnPremisesInstances()
AmazonCodeDeploylistOnPremisesInstances in interface AmazonCodeDeployAmazonCodeDeploy.listOnPremisesInstances(ListOnPremisesInstancesRequest)public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AmazonCodeDeployReturns a list of tags for the resource identified by a specified Amazon Resource Name (ARN). Tags are used to organize and categorize your CodeDeploy resources.
listTagsForResource in interface AmazonCodeDeploypublic PutLifecycleEventHookExecutionStatusResult putLifecycleEventHookExecutionStatus(PutLifecycleEventHookExecutionStatusRequest request)
AmazonCodeDeploy
Sets the result of a Lambda validation function. The function validates lifecycle hooks during a deployment that
uses the AWS Lambda or Amazon ECS compute platform. For AWS Lambda deployments, the available lifecycle hooks are
BeforeAllowTraffic and AfterAllowTraffic. For Amazon ECS deployments, the available
lifecycle hooks are BeforeInstall, AfterInstall, AfterAllowTestTraffic,
BeforeAllowTraffic, and AfterAllowTraffic. Lambda validation functions return
Succeeded or Failed. For more information, see AppSpec 'hooks' Section for an AWS Lambda Deployment and AppSpec 'hooks' Section for an Amazon ECS Deployment.
putLifecycleEventHookExecutionStatus in interface AmazonCodeDeploypublic RegisterApplicationRevisionResult registerApplicationRevision(RegisterApplicationRevisionRequest request)
AmazonCodeDeployRegisters with AWS CodeDeploy a revision for the specified application.
registerApplicationRevision in interface AmazonCodeDeployrequest - Represents the input of a RegisterApplicationRevision operation.public RegisterOnPremisesInstanceResult registerOnPremisesInstance(RegisterOnPremisesInstanceRequest request)
AmazonCodeDeployRegisters 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.
registerOnPremisesInstance in interface AmazonCodeDeployrequest - Represents the input of the register on-premises instance operation.public RemoveTagsFromOnPremisesInstancesResult removeTagsFromOnPremisesInstances(RemoveTagsFromOnPremisesInstancesRequest request)
AmazonCodeDeployRemoves one or more tags from one or more on-premises instances.
removeTagsFromOnPremisesInstances in interface AmazonCodeDeployrequest - Represents the input of a RemoveTagsFromOnPremisesInstances operation.@Deprecated public SkipWaitTimeForInstanceTerminationResult skipWaitTimeForInstanceTermination(SkipWaitTimeForInstanceTerminationRequest request)
AmazonCodeDeployIn a blue/green deployment, overrides any specified wait time and starts terminating instances immediately after the traffic routing is complete.
skipWaitTimeForInstanceTermination in interface AmazonCodeDeploypublic StopDeploymentResult stopDeployment(StopDeploymentRequest request)
AmazonCodeDeployAttempts to stop an ongoing deployment.
stopDeployment in interface AmazonCodeDeployrequest - Represents the input of a StopDeployment operation.public TagResourceResult tagResource(TagResourceRequest request)
AmazonCodeDeploy
Associates the list of tags in the input Tags parameter with the resource identified by the
ResourceArn input parameter.
tagResource in interface AmazonCodeDeploypublic UntagResourceResult untagResource(UntagResourceRequest request)
AmazonCodeDeploy
Disassociates a resource from a list of tags. The resource is identified by the ResourceArn input
parameter. The tags are identified by the list of keys in the TagKeys input parameter.
untagResource in interface AmazonCodeDeploypublic UpdateApplicationResult updateApplication(UpdateApplicationRequest request)
AmazonCodeDeployChanges the name of an application.
updateApplication in interface AmazonCodeDeployrequest - Represents the input of an UpdateApplication operation.public UpdateApplicationResult updateApplication()
AmazonCodeDeployupdateApplication in interface AmazonCodeDeployAmazonCodeDeploy.updateApplication(UpdateApplicationRequest)public UpdateDeploymentGroupResult updateDeploymentGroup(UpdateDeploymentGroupRequest request)
AmazonCodeDeployChanges information about a deployment group.
updateDeploymentGroup in interface AmazonCodeDeployrequest - Represents the input of an UpdateDeploymentGroup operation.public void shutdown()
AmazonCodeDeployshutdown in interface AmazonCodeDeploypublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonCodeDeployResponse 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.
getCachedResponseMetadata in interface AmazonCodeDeployrequest - The originally executed request.public AmazonCodeDeployWaiters waiters()
waiters in interface AmazonCodeDeploy