AbstractAmazonCodeDeploy (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.codedeploy.AbstractAmazonCodeDeploy

All Implemented Interfaces:

AmazonCodeDeploy

Direct Known Subclasses:

AbstractAmazonCodeDeployAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonCodeDeploy
extends Object
implements AmazonCodeDeploy
```
Abstract implementation of AmazonCodeDeploy. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.codedeploy.AmazonCodeDeploy
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`AddTagsToOnPremisesInstancesResult`	`addTagsToOnPremisesInstances(AddTagsToOnPremisesInstancesRequest request)` Adds tags to on-premises instances.
`BatchGetApplicationRevisionsResult`	`batchGetApplicationRevisions(BatchGetApplicationRevisionsRequest request)` Gets information about one or more application revisions.
`BatchGetApplicationsResult`	`batchGetApplications()` Simplified method form for invoking the BatchGetApplications operation.
`BatchGetApplicationsResult`	`batchGetApplications(BatchGetApplicationsRequest request)` Gets information about one or more applications.
`BatchGetDeploymentGroupsResult`	`batchGetDeploymentGroups(BatchGetDeploymentGroupsRequest request)` Gets information about one or more deployment groups.
`BatchGetDeploymentInstancesResult`	`batchGetDeploymentInstances(BatchGetDeploymentInstancesRequest request)` Deprecated.
`BatchGetDeploymentsResult`	`batchGetDeployments()` Simplified method form for invoking the BatchGetDeployments operation.
`BatchGetDeploymentsResult`	`batchGetDeployments(BatchGetDeploymentsRequest request)` Gets information about one or more deployments.
`BatchGetDeploymentTargetsResult`	`batchGetDeploymentTargets(BatchGetDeploymentTargetsRequest request)` Returns an array of one or more targets associated with a deployment.
`BatchGetOnPremisesInstancesResult`	`batchGetOnPremisesInstances()` Simplified method form for invoking the BatchGetOnPremisesInstances operation.
`BatchGetOnPremisesInstancesResult`	`batchGetOnPremisesInstances(BatchGetOnPremisesInstancesRequest request)` Gets information about one or more on-premises instances.
`ContinueDeploymentResult`	`continueDeployment(ContinueDeploymentRequest request)` 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 request)` Creates an application.
`CreateDeploymentResult`	`createDeployment(CreateDeploymentRequest request)` Deploys an application revision through the specified deployment group.
`CreateDeploymentConfigResult`	`createDeploymentConfig(CreateDeploymentConfigRequest request)` Creates a deployment configuration.
`CreateDeploymentGroupResult`	`createDeploymentGroup(CreateDeploymentGroupRequest request)` Creates a deployment group to which application revisions are deployed.
`DeleteApplicationResult`	`deleteApplication(DeleteApplicationRequest request)` Deletes an application.
`DeleteDeploymentConfigResult`	`deleteDeploymentConfig(DeleteDeploymentConfigRequest request)` Deletes a deployment configuration.
`DeleteDeploymentGroupResult`	`deleteDeploymentGroup(DeleteDeploymentGroupRequest request)` Deletes a deployment group.
`DeleteGitHubAccountTokenResult`	`deleteGitHubAccountToken(DeleteGitHubAccountTokenRequest request)` Deletes a GitHub account connection.
`DeleteResourcesByExternalIdResult`	`deleteResourcesByExternalId(DeleteResourcesByExternalIdRequest request)` Deletes resources linked to an external ID.
`DeregisterOnPremisesInstanceResult`	`deregisterOnPremisesInstance(DeregisterOnPremisesInstanceRequest request)` Deregisters an on-premises instance.
`GetApplicationResult`	`getApplication(GetApplicationRequest request)` Gets information about an application.
`GetApplicationRevisionResult`	`getApplicationRevision(GetApplicationRevisionRequest request)` 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 request)` Gets information about a deployment.
`GetDeploymentConfigResult`	`getDeploymentConfig(GetDeploymentConfigRequest request)` Gets information about a deployment configuration.
`GetDeploymentGroupResult`	`getDeploymentGroup(GetDeploymentGroupRequest request)` Gets information about a deployment group.
`GetDeploymentInstanceResult`	`getDeploymentInstance(GetDeploymentInstanceRequest request)` Deprecated.
`GetDeploymentTargetResult`	`getDeploymentTarget(GetDeploymentTargetRequest request)` Returns information about a deployment target.
`GetOnPremisesInstanceResult`	`getOnPremisesInstance(GetOnPremisesInstanceRequest request)` Gets information about an on-premises instance.
`ListApplicationRevisionsResult`	`listApplicationRevisions(ListApplicationRevisionsRequest request)` Lists information about revisions for an application.
`ListApplicationsResult`	`listApplications()` Simplified method form for invoking the ListApplications operation.
`ListApplicationsResult`	`listApplications(ListApplicationsRequest request)` Lists the applications registered with the IAM user or Amazon Web Services account.
`ListDeploymentConfigsResult`	`listDeploymentConfigs()` Simplified method form for invoking the ListDeploymentConfigs operation.
`ListDeploymentConfigsResult`	`listDeploymentConfigs(ListDeploymentConfigsRequest request)` Lists the deployment configurations with the IAM user or Amazon Web Services account.
`ListDeploymentGroupsResult`	`listDeploymentGroups(ListDeploymentGroupsRequest request)` Lists the deployment groups for an application registered with the IAM user or Amazon Web Services account.
`ListDeploymentInstancesResult`	`listDeploymentInstances(ListDeploymentInstancesRequest request)` Deprecated.
`ListDeploymentsResult`	`listDeployments()` Simplified method form for invoking the ListDeployments operation.
`ListDeploymentsResult`	`listDeployments(ListDeploymentsRequest request)` Lists the deployments in a deployment group for an application registered with the IAM user or Amazon Web Services account.
`ListDeploymentTargetsResult`	`listDeploymentTargets(ListDeploymentTargetsRequest request)` Returns an array of target IDs that are associated a deployment.
`ListGitHubAccountTokenNamesResult`	`listGitHubAccountTokenNames(ListGitHubAccountTokenNamesRequest request)` Lists the names of stored connections to GitHub accounts.
`ListOnPremisesInstancesResult`	`listOnPremisesInstances()` Simplified method form for invoking the ListOnPremisesInstances operation.
`ListOnPremisesInstancesResult`	`listOnPremisesInstances(ListOnPremisesInstancesRequest request)` Gets a list of names for one or more on-premises instances.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Returns a list of tags for the resource identified by a specified Amazon Resource Name (ARN).
`PutLifecycleEventHookExecutionStatusResult`	`putLifecycleEventHookExecutionStatus(PutLifecycleEventHookExecutionStatusRequest request)` Sets the result of a Lambda validation function.
`RegisterApplicationRevisionResult`	`registerApplicationRevision(RegisterApplicationRevisionRequest request)` Registers with CodeDeploy a revision for the specified application.
`RegisterOnPremisesInstanceResult`	`registerOnPremisesInstance(RegisterOnPremisesInstanceRequest request)` Registers an on-premises instance.
`RemoveTagsFromOnPremisesInstancesResult`	`removeTagsFromOnPremisesInstances(RemoveTagsFromOnPremisesInstancesRequest request)` 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`	`setRegion(Region region)` An alternative to `AmazonCodeDeploy.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.
`SkipWaitTimeForInstanceTerminationResult`	`skipWaitTimeForInstanceTermination(SkipWaitTimeForInstanceTerminationRequest request)` Deprecated.
`StopDeploymentResult`	`stopDeployment(StopDeploymentRequest request)` Attempts to stop an ongoing deployment.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Associates the list of tags in the input `Tags` parameter with the resource identified by the `ResourceArn` input parameter.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Disassociates a resource from a list of tags.
`UpdateApplicationResult`	`updateApplication()` Simplified method form for invoking the UpdateApplication operation.
`UpdateApplicationResult`	`updateApplication(UpdateApplicationRequest request)` Changes the name of an application.
`UpdateDeploymentGroupResult`	`updateDeploymentGroup(UpdateDeploymentGroupRequest request)` Changes information about a deployment group.
`AmazonCodeDeployWaiters`	`waiters()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    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: 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.
    
    Specified by:
    
    setEndpoint in interface AmazonCodeDeploy
    
    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
```
public void setRegion(Region region)
```
    Description copied from interface: AmazonCodeDeploy
    
    An alternative to AmazonCodeDeploy.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 interface AmazonCodeDeploy
    
    Parameters:
    
    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.
    
    See Also:
    
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - addTagsToOnPremisesInstances
```
public AddTagsToOnPremisesInstancesResult addTagsToOnPremisesInstances(AddTagsToOnPremisesInstancesRequest request)
```
    Description copied from interface: AmazonCodeDeploy
    
    Adds tags to on-premises instances.
    
    Specified by:
    
    addTagsToOnPremisesInstances in interface AmazonCodeDeploy
    
    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.
    
    See Also:
    
    AWS API Documentation
  - batchGetApplicationRevisions
```
public BatchGetApplicationRevisionsResult batchGetApplicationRevisions(BatchGetApplicationRevisionsRequest request)
```
    Description copied from interface: AmazonCodeDeploy
    
    Gets information about one or more application revisions. The maximum number of application revisions that can be returned is 25.
    
    Specified by:
    
    batchGetApplicationRevisions in interface AmazonCodeDeploy
    
    Parameters:
    
    request - Represents the input of a BatchGetApplicationRevisions operation.
    
    Returns:
    
    Result of the BatchGetApplicationRevisions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - batchGetApplications
```
public BatchGetApplicationsResult batchGetApplications(BatchGetApplicationsRequest request)
```
    Description copied from interface: AmazonCodeDeploy
    
    Gets information about one or more applications. The maximum number of applications that can be returned is 100.
    
    Specified by:
    
    batchGetApplications in interface AmazonCodeDeploy
    
    Parameters:
    
    request - Represents the input of a BatchGetApplications operation.
    
    Returns:
    
    Result of the BatchGetApplications operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - batchGetApplications
```
public BatchGetApplicationsResult batchGetApplications()
```
    Description copied from interface: AmazonCodeDeploy
    
    Simplified method form for invoking the BatchGetApplications operation.
    
    Specified by:
    
    batchGetApplications in interface AmazonCodeDeploy
    
    See Also:
    
    AmazonCodeDeploy.batchGetApplications(BatchGetApplicationsRequest)
  - batchGetDeploymentGroups
```
public BatchGetDeploymentGroupsResult batchGetDeploymentGroups(BatchGetDeploymentGroupsRequest request)
```
    Description copied from interface: AmazonCodeDeploy
    
    Gets information about one or more deployment groups.
    
    Specified by:
    
    batchGetDeploymentGroups in interface AmazonCodeDeploy
    
    Parameters:
    
    request - Represents the input of a BatchGetDeploymentGroups operation.
    
    Returns:
    
    Result of the BatchGetDeploymentGroups operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - batchGetDeploymentInstances
```
@Deprecated
public BatchGetDeploymentInstancesResult batchGetDeploymentInstances(BatchGetDeploymentInstancesRequest request)
```
    Deprecated.
    
    Description copied from interface: 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 Lambda compute platforms. The newer BatchGetDeploymentTargets works with all compute platforms. The maximum number of instances that can be returned is 25.
    
    Specified by:
    
    batchGetDeploymentInstances in interface AmazonCodeDeploy
    
    Parameters:
    
    request - Represents the input of a BatchGetDeploymentInstances operation.
    
    Returns:
    
    Result of the BatchGetDeploymentInstances operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - batchGetDeploymentTargets
```
public BatchGetDeploymentTargetsResult batchGetDeploymentTargets(BatchGetDeploymentTargetsRequest request)
```
    Description copied from interface: 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 Amazon EC2 instance targets.
    - 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.
    Specified by:
    
    batchGetDeploymentTargets in interface AmazonCodeDeploy
    
    Returns:
    
    Result of the BatchGetDeploymentTargets operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - batchGetDeployments
```
public BatchGetDeploymentsResult batchGetDeployments(BatchGetDeploymentsRequest request)
```
    Description copied from interface: AmazonCodeDeploy
    
    Gets information about one or more deployments. The maximum number of deployments that can be returned is 25.
    
    Specified by:
    
    batchGetDeployments in interface AmazonCodeDeploy
    
    Parameters:
    
    request - Represents the input of a BatchGetDeployments operation.
    
    Returns:
    
    Result of the BatchGetDeployments operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - batchGetDeployments
```
public BatchGetDeploymentsResult batchGetDeployments()
```
    Description copied from interface: AmazonCodeDeploy
    
    Simplified method form for invoking the BatchGetDeployments operation.
    
    Specified by:
    
    batchGetDeployments in interface AmazonCodeDeploy
    
    See Also:
    
    AmazonCodeDeploy.batchGetDeployments(BatchGetDeploymentsRequest)
  - batchGetOnPremisesInstances
```
public BatchGetOnPremisesInstancesResult batchGetOnPremisesInstances(BatchGetOnPremisesInstancesRequest request)
```
    Description copied from interface: AmazonCodeDeploy
    
    Gets information about one or more on-premises instances. The maximum number of on-premises instances that can be returned is 25.
    
    Specified by:
    
    batchGetOnPremisesInstances in interface AmazonCodeDeploy
    
    Parameters:
    
    request - Represents the input of a BatchGetOnPremisesInstances operation.
    
    Returns:
    
    Result of the BatchGetOnPremisesInstances operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - batchGetOnPremisesInstances
```
public BatchGetOnPremisesInstancesResult batchGetOnPremisesInstances()
```
    Description copied from interface: AmazonCodeDeploy
    
    Simplified method form for invoking the BatchGetOnPremisesInstances operation.
    
    Specified by:
    
    batchGetOnPremisesInstances in interface AmazonCodeDeploy
    
    See Also:
    
    AmazonCodeDeploy.batchGetOnPremisesInstances(BatchGetOnPremisesInstancesRequest)
  - continueDeployment
```
public ContinueDeploymentResult continueDeployment(ContinueDeploymentRequest request)
```
    Description copied from interface: AmazonCodeDeploy
    
    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.)
    
    Specified by:
    
    continueDeployment in interface AmazonCodeDeploy
    
    Returns:
    
    Result of the ContinueDeployment operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createApplication
```
public CreateApplicationResult createApplication(CreateApplicationRequest request)
```
    Description copied from interface: AmazonCodeDeploy
    
    Creates an application.
    
    Specified by:
    
    createApplication in interface AmazonCodeDeploy
    
    Parameters:
    
    request - Represents the input of a CreateApplication operation.
    
    Returns:
    
    Result of the CreateApplication operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createDeployment
```
public CreateDeploymentResult createDeployment(CreateDeploymentRequest request)
```
    Description copied from interface: AmazonCodeDeploy
    
    Deploys an application revision through the specified deployment group.
    
    Specified by:
    
    createDeployment in interface AmazonCodeDeploy
    
    Parameters:
    
    request - Represents the input of a CreateDeployment operation.
    
    Returns:
    
    Result of the CreateDeployment operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createDeploymentConfig
```
public CreateDeploymentConfigResult createDeploymentConfig(CreateDeploymentConfigRequest request)
```
    Description copied from interface: AmazonCodeDeploy
    
    Creates a deployment configuration.
    
    Specified by:
    
    createDeploymentConfig in interface AmazonCodeDeploy
    
    Parameters:
    
    request - Represents the input of a CreateDeploymentConfig operation.
    
    Returns:
    
    Result of the CreateDeploymentConfig operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createDeploymentGroup
```
public CreateDeploymentGroupResult createDeploymentGroup(CreateDeploymentGroupRequest request)
```
    Description copied from interface: AmazonCodeDeploy
    
    Creates a deployment group to which application revisions are deployed.
    
    Specified by:
    
    createDeploymentGroup in interface AmazonCodeDeploy
    
    Parameters:
    
    request - Represents the input of a CreateDeploymentGroup operation.
    
    Returns:
    
    Result of the CreateDeploymentGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteApplication
```
public DeleteApplicationResult deleteApplication(DeleteApplicationRequest request)
```
    Description copied from interface: AmazonCodeDeploy
    
    Deletes an application.
    
    Specified by:
    
    deleteApplication in interface AmazonCodeDeploy
    
    Parameters:
    
    request - Represents the input of a DeleteApplication operation.
    
    Returns:
    
    Result of the DeleteApplication operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteDeploymentConfig
```
public DeleteDeploymentConfigResult deleteDeploymentConfig(DeleteDeploymentConfigRequest request)
```
    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 interface AmazonCodeDeploy
    
    Parameters:
    
    request - Represents the input of a DeleteDeploymentConfig operation.
    
    Returns:
    
    Result of the DeleteDeploymentConfig operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteDeploymentGroup
```
public DeleteDeploymentGroupResult deleteDeploymentGroup(DeleteDeploymentGroupRequest request)
```
    Description copied from interface: AmazonCodeDeploy
    
    Deletes a deployment group.
    
    Specified by:
    
    deleteDeploymentGroup in interface AmazonCodeDeploy
    
    Parameters:
    
    request - Represents the input of a DeleteDeploymentGroup operation.
    
    Returns:
    
    Result of the DeleteDeploymentGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteGitHubAccountToken
```
public DeleteGitHubAccountTokenResult deleteGitHubAccountToken(DeleteGitHubAccountTokenRequest request)
```
    Description copied from interface: AmazonCodeDeploy
    
    Deletes a GitHub account connection.
    
    Specified by:
    
    deleteGitHubAccountToken in interface AmazonCodeDeploy
    
    Parameters:
    
    request - Represents the input of a DeleteGitHubAccount operation.
    
    Returns:
    
    Result of the DeleteGitHubAccountToken operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteResourcesByExternalId
```
public DeleteResourcesByExternalIdResult deleteResourcesByExternalId(DeleteResourcesByExternalIdRequest request)
```
    Description copied from interface: AmazonCodeDeploy
    
    Deletes resources linked to an external ID.
    
    Specified by:
    
    deleteResourcesByExternalId in interface AmazonCodeDeploy
    
    Returns:
    
    Result of the DeleteResourcesByExternalId operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deregisterOnPremisesInstance
```
public DeregisterOnPremisesInstanceResult deregisterOnPremisesInstance(DeregisterOnPremisesInstanceRequest request)
```
    Description copied from interface: AmazonCodeDeploy
    
    Deregisters an on-premises instance.
    
    Specified by:
    
    deregisterOnPremisesInstance in interface AmazonCodeDeploy
    
    Parameters:
    
    request - Represents the input of a DeregisterOnPremisesInstance operation.
    
    Returns:
    
    Result of the DeregisterOnPremisesInstance operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getApplication
```
public GetApplicationResult getApplication(GetApplicationRequest request)
```
    Description copied from interface: AmazonCodeDeploy
    
    Gets information about an application.
    
    Specified by:
    
    getApplication in interface AmazonCodeDeploy
    
    Parameters:
    
    request - Represents the input of a GetApplication operation.
    
    Returns:
    
    Result of the GetApplication operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getApplicationRevision
```
public GetApplicationRevisionResult getApplicationRevision(GetApplicationRevisionRequest request)
```
    Description copied from interface: AmazonCodeDeploy
    
    Gets information about an application revision.
    
    Specified by:
    
    getApplicationRevision in interface AmazonCodeDeploy
    
    Parameters:
    
    request - Represents the input of a GetApplicationRevision operation.
    
    Returns:
    
    Result of the GetApplicationRevision operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getDeployment
```
public GetDeploymentResult getDeployment(GetDeploymentRequest request)
```
    Description copied from interface: AmazonCodeDeploy
    
    Gets 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.
    
    Specified by:
    
    getDeployment in interface AmazonCodeDeploy
    
    Parameters:
    
    request - Represents the input of a GetDeployment operation.
    
    Returns:
    
    Result of the GetDeployment operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getDeploymentConfig
```
public GetDeploymentConfigResult getDeploymentConfig(GetDeploymentConfigRequest request)
```
    Description copied from interface: AmazonCodeDeploy
    
    Gets information about a deployment configuration.
    
    Specified by:
    
    getDeploymentConfig in interface AmazonCodeDeploy
    
    Parameters:
    
    request - Represents the input of a GetDeploymentConfig operation.
    
    Returns:
    
    Result of the GetDeploymentConfig operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getDeploymentGroup
```
public GetDeploymentGroupResult getDeploymentGroup(GetDeploymentGroupRequest request)
```
    Description copied from interface: AmazonCodeDeploy
    
    Gets information about a deployment group.
    
    Specified by:
    
    getDeploymentGroup in interface AmazonCodeDeploy
    
    Parameters:
    
    request - Represents the input of a GetDeploymentGroup operation.
    
    Returns:
    
    Result of the GetDeploymentGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getDeploymentInstance
```
@Deprecated
public GetDeploymentInstanceResult getDeploymentInstance(GetDeploymentInstanceRequest request)
```
    Deprecated.
    
    Description copied from interface: AmazonCodeDeploy
    
    Gets information about an instance as part of a deployment.
    
    Specified by:
    
    getDeploymentInstance in interface AmazonCodeDeploy
    
    Parameters:
    
    request - Represents the input of a GetDeploymentInstance operation.
    
    Returns:
    
    Result of the GetDeploymentInstance operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getDeploymentTarget
```
public GetDeploymentTargetResult getDeploymentTarget(GetDeploymentTargetRequest request)
```
    Description copied from interface: AmazonCodeDeploy
    
    Returns information about a deployment target.
    
    Specified by:
    
    getDeploymentTarget in interface AmazonCodeDeploy
    
    Returns:
    
    Result of the GetDeploymentTarget operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getOnPremisesInstance
```
public GetOnPremisesInstanceResult getOnPremisesInstance(GetOnPremisesInstanceRequest request)
```
    Description copied from interface: AmazonCodeDeploy
    
    Gets information about an on-premises instance.
    
    Specified by:
    
    getOnPremisesInstance in interface AmazonCodeDeploy
    
    Parameters:
    
    request - Represents the input of a GetOnPremisesInstance operation.
    
    Returns:
    
    Result of the GetOnPremisesInstance operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listApplicationRevisions
```
public ListApplicationRevisionsResult listApplicationRevisions(ListApplicationRevisionsRequest request)
```
    Description copied from interface: AmazonCodeDeploy
    
    Lists information about revisions for an application.
    
    Specified by:
    
    listApplicationRevisions in interface AmazonCodeDeploy
    
    Parameters:
    
    request - Represents the input of a ListApplicationRevisions operation.
    
    Returns:
    
    Result of the ListApplicationRevisions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listApplications
```
public ListApplicationsResult listApplications(ListApplicationsRequest request)
```
    Description copied from interface: AmazonCodeDeploy
    
    Lists the applications registered with the IAM user or Amazon Web Services account.
    
    Specified by:
    
    listApplications in interface AmazonCodeDeploy
    
    Parameters:
    
    request - Represents the input of a ListApplications operation.
    
    Returns:
    
    Result of the ListApplications operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listApplications
```
public ListApplicationsResult listApplications()
```
    Description copied from interface: AmazonCodeDeploy
    
    Simplified method form for invoking the ListApplications operation.
    
    Specified by:
    
    listApplications in interface AmazonCodeDeploy
    
    See Also:
    
    AmazonCodeDeploy.listApplications(ListApplicationsRequest)
  - listDeploymentConfigs
```
public ListDeploymentConfigsResult listDeploymentConfigs(ListDeploymentConfigsRequest request)
```
    Description copied from interface: AmazonCodeDeploy
    
    Lists the deployment configurations with the IAM user or Amazon Web Services account.
    
    Specified by:
    
    listDeploymentConfigs in interface AmazonCodeDeploy
    
    Parameters:
    
    request - Represents the input of a ListDeploymentConfigs operation.
    
    Returns:
    
    Result of the ListDeploymentConfigs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDeploymentConfigs
```
public ListDeploymentConfigsResult listDeploymentConfigs()
```
    Description copied from interface: AmazonCodeDeploy
    
    Simplified method form for invoking the ListDeploymentConfigs operation.
    
    Specified by:
    
    listDeploymentConfigs in interface AmazonCodeDeploy
    
    See Also:
    
    AmazonCodeDeploy.listDeploymentConfigs(ListDeploymentConfigsRequest)
  - listDeploymentGroups
```
public ListDeploymentGroupsResult listDeploymentGroups(ListDeploymentGroupsRequest request)
```
    Description copied from interface: AmazonCodeDeploy
    
    Lists the deployment groups for an application registered with the IAM user or Amazon Web Services account.
    
    Specified by:
    
    listDeploymentGroups in interface AmazonCodeDeploy
    
    Parameters:
    
    request - Represents the input of a ListDeploymentGroups operation.
    
    Returns:
    
    Result of the ListDeploymentGroups operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDeploymentInstances
```
@Deprecated
public ListDeploymentInstancesResult listDeploymentInstances(ListDeploymentInstancesRequest request)
```
    Deprecated.
    
    Description copied from interface: 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 Lambda.
    
    Lists the instance for a deployment associated with the IAM user or Amazon Web Services account.
    
    Specified by:
    
    listDeploymentInstances in interface AmazonCodeDeploy
    
    Parameters:
    
    request - Represents the input of a ListDeploymentInstances operation.
    
    Returns:
    
    Result of the ListDeploymentInstances operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDeploymentTargets
```
public ListDeploymentTargetsResult listDeploymentTargets(ListDeploymentTargetsRequest request)
```
    Description copied from interface: AmazonCodeDeploy
    
    Returns an array of target IDs that are associated a deployment.
    
    Specified by:
    
    listDeploymentTargets in interface AmazonCodeDeploy
    
    Returns:
    
    Result of the ListDeploymentTargets operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDeployments
```
public ListDeploymentsResult listDeployments(ListDeploymentsRequest request)
```
    Description copied from interface: AmazonCodeDeploy
    
    Lists the deployments in a deployment group for an application registered with the IAM user or Amazon Web Services account.
    
    Specified by:
    
    listDeployments in interface AmazonCodeDeploy
    
    Parameters:
    
    request - Represents the input of a ListDeployments operation.
    
    Returns:
    
    Result of the ListDeployments operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDeployments
```
public ListDeploymentsResult listDeployments()
```
    Description copied from interface: AmazonCodeDeploy
    
    Simplified method form for invoking the ListDeployments operation.
    
    Specified by:
    
    listDeployments in interface AmazonCodeDeploy
    
    See Also:
    
    AmazonCodeDeploy.listDeployments(ListDeploymentsRequest)
  - listGitHubAccountTokenNames
```
public ListGitHubAccountTokenNamesResult listGitHubAccountTokenNames(ListGitHubAccountTokenNamesRequest request)
```
    Description copied from interface: AmazonCodeDeploy
    
    Lists the names of stored connections to GitHub accounts.
    
    Specified by:
    
    listGitHubAccountTokenNames in interface AmazonCodeDeploy
    
    Parameters:
    
    request - Represents the input of a ListGitHubAccountTokenNames operation.
    
    Returns:
    
    Result of the ListGitHubAccountTokenNames operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - 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 are listed. To list only registered or deregistered on-premises instance names, use the registration status parameter.
    
    Specified by:
    
    listOnPremisesInstances in interface AmazonCodeDeploy
    
    Parameters:
    
    request - Represents the input of a ListOnPremisesInstances operation.
    
    Returns:
    
    Result of the ListOnPremisesInstances operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listOnPremisesInstances
```
public ListOnPremisesInstancesResult listOnPremisesInstances()
```
    Description copied from interface: AmazonCodeDeploy
    
    Simplified method form for invoking the ListOnPremisesInstances operation.
    
    Specified by:
    
    listOnPremisesInstances in interface AmazonCodeDeploy
    
    See Also:
    
    AmazonCodeDeploy.listOnPremisesInstances(ListOnPremisesInstancesRequest)
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AmazonCodeDeploy
    
    Returns 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.
    
    Specified by:
    
    listTagsForResource in interface AmazonCodeDeploy
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putLifecycleEventHookExecutionStatus
```
public PutLifecycleEventHookExecutionStatusResult putLifecycleEventHookExecutionStatus(PutLifecycleEventHookExecutionStatusRequest request)
```
    Description copied from interface: AmazonCodeDeploy
    
    Sets the result of a Lambda validation function. The function validates lifecycle hooks during a deployment that uses the Lambda or Amazon ECS compute platform. For 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 Lambda Deployment and AppSpec 'hooks' Section for an Amazon ECS Deployment.
    
    Specified by:
    
    putLifecycleEventHookExecutionStatus in interface AmazonCodeDeploy
    
    Returns:
    
    Result of the PutLifecycleEventHookExecutionStatus operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - registerApplicationRevision
```
public RegisterApplicationRevisionResult registerApplicationRevision(RegisterApplicationRevisionRequest request)
```
    Description copied from interface: AmazonCodeDeploy
    
    Registers with CodeDeploy a revision for the specified application.
    
    Specified by:
    
    registerApplicationRevision in interface AmazonCodeDeploy
    
    Parameters:
    
    request - Represents the input of a RegisterApplicationRevision operation.
    
    Returns:
    
    Result of the RegisterApplicationRevision operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - registerOnPremisesInstance
```
public RegisterOnPremisesInstanceResult registerOnPremisesInstance(RegisterOnPremisesInstanceRequest request)
```
    Description copied from interface: AmazonCodeDeploy
    
    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.
    
    Specified by:
    
    registerOnPremisesInstance in interface AmazonCodeDeploy
    
    Parameters:
    
    request - Represents the input of the register on-premises instance operation.
    
    Returns:
    
    Result of the RegisterOnPremisesInstance operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - 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 interface AmazonCodeDeploy
    
    Parameters:
    
    request - Represents the input of a RemoveTagsFromOnPremisesInstances operation.
    
    Returns:
    
    Result of the RemoveTagsFromOnPremisesInstances operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - skipWaitTimeForInstanceTermination
```
@Deprecated
public SkipWaitTimeForInstanceTerminationResult skipWaitTimeForInstanceTermination(SkipWaitTimeForInstanceTerminationRequest request)
```
    Deprecated.
    
    Description copied from interface: AmazonCodeDeploy
    
    In a blue/green deployment, overrides any specified wait time and starts terminating instances immediately after the traffic routing is complete.
    
    Specified by:
    
    skipWaitTimeForInstanceTermination in interface AmazonCodeDeploy
    
    Returns:
    
    Result of the SkipWaitTimeForInstanceTermination operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - stopDeployment
```
public StopDeploymentResult stopDeployment(StopDeploymentRequest request)
```
    Description copied from interface: AmazonCodeDeploy
    
    Attempts to stop an ongoing deployment.
    
    Specified by:
    
    stopDeployment in interface AmazonCodeDeploy
    
    Parameters:
    
    request - Represents the input of a StopDeployment operation.
    
    Returns:
    
    Result of the StopDeployment operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AmazonCodeDeploy
    
    Associates the list of tags in the input Tags parameter with the resource identified by the ResourceArn input parameter.
    
    Specified by:
    
    tagResource in interface AmazonCodeDeploy
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: 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.
    
    Specified by:
    
    untagResource in interface AmazonCodeDeploy
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateApplication
```
public UpdateApplicationResult updateApplication(UpdateApplicationRequest request)
```
    Description copied from interface: AmazonCodeDeploy
    
    Changes the name of an application.
    
    Specified by:
    
    updateApplication in interface AmazonCodeDeploy
    
    Parameters:
    
    request - Represents the input of an UpdateApplication operation.
    
    Returns:
    
    Result of the UpdateApplication operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateApplication
```
public UpdateApplicationResult updateApplication()
```
    Description copied from interface: AmazonCodeDeploy
    
    Simplified method form for invoking the UpdateApplication operation.
    
    Specified by:
    
    updateApplication in interface AmazonCodeDeploy
    
    See Also:
    
    AmazonCodeDeploy.updateApplication(UpdateApplicationRequest)
  - updateDeploymentGroup
```
public UpdateDeploymentGroupResult updateDeploymentGroup(UpdateDeploymentGroupRequest request)
```
    Description copied from interface: AmazonCodeDeploy
    
    Changes information about a deployment group.
    
    Specified by:
    
    updateDeploymentGroup in interface AmazonCodeDeploy
    
    Parameters:
    
    request - Represents the input of an UpdateDeploymentGroup operation.
    
    Returns:
    
    Result of the UpdateDeploymentGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - 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 interface AmazonCodeDeploy
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    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 interface AmazonCodeDeploy
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - waiters
```
public AmazonCodeDeployWaiters waiters()
```
    Specified by:
    
    waiters in interface AmazonCodeDeploy

Did this page help you?

Class AbstractAmazonCodeDeploy

Field Summary

Fields inherited from interface com.amazonaws.services.codedeploy.AmazonCodeDeploy

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setEndpoint

setRegion

addTagsToOnPremisesInstances

batchGetApplicationRevisions

batchGetApplications

batchGetApplications

batchGetDeploymentGroups

batchGetDeploymentInstances

batchGetDeploymentTargets

batchGetDeployments

batchGetDeployments

batchGetOnPremisesInstances

batchGetOnPremisesInstances

continueDeployment

createApplication

createDeployment

createDeploymentConfig

createDeploymentGroup

deleteApplication

deleteDeploymentConfig

deleteDeploymentGroup

deleteGitHubAccountToken

deleteResourcesByExternalId

deregisterOnPremisesInstance

getApplication

getApplicationRevision

getDeployment

getDeploymentConfig

getDeploymentGroup

getDeploymentInstance

getDeploymentTarget

getOnPremisesInstance

listApplicationRevisions

listApplications

listApplications

listDeploymentConfigs

listDeploymentConfigs

listDeploymentGroups

listDeploymentInstances

listDeploymentTargets

listDeployments

listDeployments

listGitHubAccountTokenNames

listOnPremisesInstances

listOnPremisesInstances

listTagsForResource

putLifecycleEventHookExecutionStatus

registerApplicationRevision

registerOnPremisesInstance

removeTagsFromOnPremisesInstances

skipWaitTimeForInstanceTermination

stopDeployment

tagResource

untagResource

updateApplication

updateApplication

updateDeploymentGroup

shutdown

getCachedResponseMetadata

waiters