AWSLaunchWizardClient (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.launchwizard

Class AWSLaunchWizardClient

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.launchwizard.AWSLaunchWizardClient

All Implemented Interfaces:

AWSLaunchWizard

Direct Known Subclasses:

AWSLaunchWizardAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSLaunchWizardClient
extends AmazonWebServiceClient
implements AWSLaunchWizard 
```
Client for accessing AWS Launch Wizard. All service calls made using this client are blocking, and will not return until the service call completes.

Launch Wizard offers a guided way of sizing, configuring, and deploying Amazon Web Services resources for third party applications, such as Microsoft SQL Server Always On and HANA based SAP systems, without the need to manually identify and provision individual Amazon Web Services resources.

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  LOGGING_AWS_REQUEST_METRIC
- Fields inherited from interface com.amazonaws.services.launchwizard.AWSLaunchWizard
  ENDPOINT_PREFIX

Method Summary

All Methods
Modifier and Type	Method and Description
`static AWSLaunchWizardClientBuilder`	`builder ()`
`CreateDeploymentResult`	`createDeployment (CreateDeploymentRequest request)` Creates a deployment for the given workload.
`DeleteDeploymentResult`	`deleteDeployment (DeleteDeploymentRequest request)` Deletes a deployment.
`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)` Returns information about the deployment.
`GetWorkloadResult`	`getWorkload (GetWorkloadRequest request)` Returns information about a workload.
`GetWorkloadDeploymentPatternResult`	`getWorkloadDeploymentPattern (GetWorkloadDeploymentPatternRequest request)` Returns details for a given workload and deployment pattern, including the available specifications.
`ListDeploymentEventsResult`	`listDeploymentEvents (ListDeploymentEventsRequest request)` Lists the events of a deployment.
`ListDeploymentsResult`	`listDeployments (ListDeploymentsRequest request)` Lists the deployments that have been created.
`ListTagsForResourceResult`	`listTagsForResource (ListTagsForResourceRequest request)` Lists the tags associated with a specified resource.
`ListWorkloadDeploymentPatternsResult`	`listWorkloadDeploymentPatterns (ListWorkloadDeploymentPatternsRequest request)` Lists the workload deployment patterns for a given workload name.
`ListWorkloadsResult`	`listWorkloads (ListWorkloadsRequest request)` Lists the available workload names.
`void`	`shutdown ()` Shuts down this client object, releasing any resources that might be held open.
`TagResourceResult`	`tagResource (TagResourceRequest request)` Adds the specified tags to the given resource.
`UntagResourceResult`	`untagResource (UntagResourceRequest request)` Removes the specified tags from the given resource.

Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

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

- Method Detail
  - builder
```
public static AWSLaunchWizardClientBuilder builder()
```
  - createDeployment
```
public CreateDeploymentResult createDeployment(CreateDeploymentRequest request)
```
    Creates a deployment for the given workload. Deployments created by this operation are not available in the Launch Wizard console to use the Clone deployment action on.
    
    Specified by:
    
    createDeployment in interface AWSLaunchWizard
    
    Parameters:
    
    createDeploymentRequest -
    
    Returns:
    
    Result of the CreateDeployment operation returned by the service.
    
    Throws:
    
    ResourceLimitException - You have exceeded an Launch Wizard resource limit. For example, you might have too many deployments in progress.
    
    InternalServerException - An internal error has occurred. Retry your request, but if the problem persists, contact us with details by posting a question on re:Post.
    
    ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.
    
    ResourceNotFoundException - The specified workload or deployment resource can't be found.
    
    See Also:
    
    AWS API Documentation
  - deleteDeployment
```
public DeleteDeploymentResult deleteDeployment(DeleteDeploymentRequest request)
```
    Deletes a deployment.
    
    Specified by:
    
    deleteDeployment in interface AWSLaunchWizard
    
    Parameters:
    
    deleteDeploymentRequest -
    
    Returns:
    
    Result of the DeleteDeployment operation returned by the service.
    
    Throws:
    
    ResourceLimitException - You have exceeded an Launch Wizard resource limit. For example, you might have too many deployments in progress.
    
    InternalServerException - An internal error has occurred. Retry your request, but if the problem persists, contact us with details by posting a question on re:Post.
    
    ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.
    
    ResourceNotFoundException - The specified workload or deployment resource can't be found.
    
    See Also:
    
    AWS API Documentation
  - getDeployment
```
public GetDeploymentResult getDeployment(GetDeploymentRequest request)
```
    Returns information about the deployment.
    
    Specified by:
    
    getDeployment in interface AWSLaunchWizard
    
    Parameters:
    
    getDeploymentRequest -
    
    Returns:
    
    Result of the GetDeployment operation returned by the service.
    
    Throws:
    
    InternalServerException - An internal error has occurred. Retry your request, but if the problem persists, contact us with details by posting a question on re:Post.
    
    ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.
    
    ResourceNotFoundException - The specified workload or deployment resource can't be found.
    
    See Also:
    
    AWS API Documentation
  - getWorkload
```
public GetWorkloadResult getWorkload(GetWorkloadRequest request)
```
    Returns information about a workload.
    
    Specified by:
    
    getWorkload in interface AWSLaunchWizard
    
    Parameters:
    
    getWorkloadRequest -
    
    Returns:
    
    Result of the GetWorkload operation returned by the service.
    
    Throws:
    
    InternalServerException - An internal error has occurred. Retry your request, but if the problem persists, contact us with details by posting a question on re:Post.
    
    ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.
    
    ResourceNotFoundException - The specified workload or deployment resource can't be found.
    
    See Also:
    
    AWS API Documentation
  - getWorkloadDeploymentPattern
```
public GetWorkloadDeploymentPatternResult getWorkloadDeploymentPattern(GetWorkloadDeploymentPatternRequest request)
```
    Returns details for a given workload and deployment pattern, including the available specifications. You can use the ListWorkloads operation to discover the available workload names and the ListWorkloadDeploymentPatterns operation to discover the available deployment pattern names of a given workload.
    
    Specified by:
    
    getWorkloadDeploymentPattern in interface AWSLaunchWizard
    
    Parameters:
    
    getWorkloadDeploymentPatternRequest -
    
    Returns:
    
    Result of the GetWorkloadDeploymentPattern operation returned by the service.
    
    Throws:
    
    InternalServerException - An internal error has occurred. Retry your request, but if the problem persists, contact us with details by posting a question on re:Post.
    
    ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.
    
    ResourceNotFoundException - The specified workload or deployment resource can't be found.
    
    See Also:
    
    AWS API Documentation
  - listDeploymentEvents
```
public ListDeploymentEventsResult listDeploymentEvents(ListDeploymentEventsRequest request)
```
    Lists the events of a deployment.
    
    Specified by:
    
    listDeploymentEvents in interface AWSLaunchWizard
    
    Parameters:
    
    listDeploymentEventsRequest -
    
    Returns:
    
    Result of the ListDeploymentEvents operation returned by the service.
    
    Throws:
    
    InternalServerException - An internal error has occurred. Retry your request, but if the problem persists, contact us with details by posting a question on re:Post.
    
    ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.
    
    ResourceNotFoundException - The specified workload or deployment resource can't be found.
    
    See Also:
    
    AWS API Documentation
  - listDeployments
```
public ListDeploymentsResult listDeployments(ListDeploymentsRequest request)
```
    Lists the deployments that have been created.
    
    Specified by:
    
    listDeployments in interface AWSLaunchWizard
    
    Parameters:
    
    listDeploymentsRequest -
    
    Returns:
    
    Result of the ListDeployments operation returned by the service.
    
    Throws:
    
    InternalServerException - An internal error has occurred. Retry your request, but if the problem persists, contact us with details by posting a question on re:Post.
    
    ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Lists the tags associated with a specified resource.
    
    Specified by:
    
    listTagsForResource in interface AWSLaunchWizard
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    InternalServerException - An internal error has occurred. Retry your request, but if the problem persists, contact us with details by posting a question on re:Post.
    
    ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.
    
    ResourceNotFoundException - The specified workload or deployment resource can't be found.
    
    See Also:
    
    AWS API Documentation
  - listWorkloadDeploymentPatterns
```
public ListWorkloadDeploymentPatternsResult listWorkloadDeploymentPatterns(ListWorkloadDeploymentPatternsRequest request)
```
    Lists the workload deployment patterns for a given workload name. You can use the ListWorkloads operation to discover the available workload names.
    
    Specified by:
    
    listWorkloadDeploymentPatterns in interface AWSLaunchWizard
    
    Parameters:
    
    listWorkloadDeploymentPatternsRequest -
    
    Returns:
    
    Result of the ListWorkloadDeploymentPatterns operation returned by the service.
    
    Throws:
    
    InternalServerException - An internal error has occurred. Retry your request, but if the problem persists, contact us with details by posting a question on re:Post.
    
    ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.
    
    ResourceNotFoundException - The specified workload or deployment resource can't be found.
    
    See Also:
    
    AWS API Documentation
  - listWorkloads
```
public ListWorkloadsResult listWorkloads(ListWorkloadsRequest request)
```
    Lists the available workload names. You can use the ListWorkloadDeploymentPatterns operation to discover the available deployment patterns for a given workload.
    
    Specified by:
    
    listWorkloads in interface AWSLaunchWizard
    
    Parameters:
    
    listWorkloadsRequest -
    
    Returns:
    
    Result of the ListWorkloads operation returned by the service.
    
    Throws:
    
    InternalServerException - An internal error has occurred. Retry your request, but if the problem persists, contact us with details by posting a question on re:Post.
    
    ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Adds the specified tags to the given resource.
    
    Specified by:
    
    tagResource in interface AWSLaunchWizard
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    InternalServerException - An internal error has occurred. Retry your request, but if the problem persists, contact us with details by posting a question on re:Post.
    
    ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.
    
    ResourceNotFoundException - The specified workload or deployment resource can't be found.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Removes the specified tags from the given resource.
    
    Specified by:
    
    untagResource in interface AWSLaunchWizard
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    InternalServerException - An internal error has occurred. Retry your request, but if the problem persists, contact us with details by posting a question on re:Post.
    
    ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.
    
    ResourceNotFoundException - The specified workload or deployment resource can't be found.
    
    See Also:
    
    AWS API Documentation
  - getCachedResponseMetadata
```
public 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. 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 the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSLaunchWizard
    
    Parameters:
    
    request - The originally executed request
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - shutdown
```
public void shutdown()
```
    Description copied from class: AmazonWebServiceClient
    
    Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AWSLaunchWizard
    
    Overrides:
    
    shutdown in class AmazonWebServiceClient

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class AWSLaunchWizardClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.launchwizard.AWSLaunchWizard

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Method Detail

builder

createDeployment

deleteDeployment

getDeployment

getWorkload

getWorkloadDeploymentPattern

listDeploymentEvents

listDeployments

listTagsForResource

listWorkloadDeploymentPatterns

listWorkloads

tagResource

untagResource

getCachedResponseMetadata

shutdown