com.amazonaws.services.launchwizard

Interface AWSLaunchWizard

All Known Subinterfaces:

AWSLaunchWizardAsync

All Known Implementing Classes:

AbstractAWSLaunchWizard, AbstractAWSLaunchWizardAsync, AWSLaunchWizardAsyncClient, AWSLaunchWizardClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSLaunchWizard

Interface for accessing AWS Launch Wizard.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSLaunchWizard instead.

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

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

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

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createDeployment

CreateDeploymentResult createDeployment(CreateDeploymentRequest createDeploymentRequest)

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.

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

DeleteDeploymentResult deleteDeployment(DeleteDeploymentRequest deleteDeploymentRequest)

Deletes a deployment.

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

GetDeploymentResult getDeployment(GetDeploymentRequest getDeploymentRequest)

Returns information about the deployment.

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

GetWorkloadResult getWorkload(GetWorkloadRequest getWorkloadRequest)

Returns information about a workload.

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

GetWorkloadDeploymentPatternResult getWorkloadDeploymentPattern(GetWorkloadDeploymentPatternRequest getWorkloadDeploymentPatternRequest)

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.

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

ListDeploymentEventsResult listDeploymentEvents(ListDeploymentEventsRequest listDeploymentEventsRequest)

Lists the events of a deployment.

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

ListDeploymentsResult listDeployments(ListDeploymentsRequest listDeploymentsRequest)

Lists the deployments that have been created.

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

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Lists the tags associated with a specified resource.

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

ListWorkloadDeploymentPatternsResult listWorkloadDeploymentPatterns(ListWorkloadDeploymentPatternsRequest listWorkloadDeploymentPatternsRequest)

Lists the workload deployment patterns for a given workload name. You can use the ListWorkloads operation to discover the available workload names.

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

ListWorkloadsResult listWorkloads(ListWorkloadsRequest listWorkloadsRequest)

Lists the available workload names. You can use the ListWorkloadDeploymentPatterns operation to discover the available deployment patterns for a given workload.

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

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Adds the specified tags to the given resource.

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

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes the specified tags from the given resource.

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

shutdown

void shutdown()

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.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.