Interface LaunchWizardClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface LaunchWizardClient
extends AwsClient

Service client for accessing AWS Launch Wizard. This can be created using the static builder() method.

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	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static LaunchWizardClientBuilder	builder()	Create a builder that can be used to configure and create a LaunchWizardClient.
static LaunchWizardClient	create()	Create a LaunchWizardClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateDeploymentResponse	createDeployment(Consumer<CreateDeploymentRequest.Builder> createDeploymentRequest)	Creates a deployment for the given workload.
default CreateDeploymentResponse	createDeployment(CreateDeploymentRequest createDeploymentRequest)	Creates a deployment for the given workload.
default DeleteDeploymentResponse	deleteDeployment(Consumer<DeleteDeploymentRequest.Builder> deleteDeploymentRequest)	Deletes a deployment.
default DeleteDeploymentResponse	deleteDeployment(DeleteDeploymentRequest deleteDeploymentRequest)	Deletes a deployment.
default GetDeploymentResponse	getDeployment(Consumer<GetDeploymentRequest.Builder> getDeploymentRequest)	Returns information about the deployment.
default GetDeploymentResponse	getDeployment(GetDeploymentRequest getDeploymentRequest)	Returns information about the deployment.
default GetWorkloadResponse	getWorkload(Consumer<GetWorkloadRequest.Builder> getWorkloadRequest)	Returns information about a workload.
default GetWorkloadResponse	getWorkload(GetWorkloadRequest getWorkloadRequest)	Returns information about a workload.
default GetWorkloadDeploymentPatternResponse	getWorkloadDeploymentPattern(Consumer<GetWorkloadDeploymentPatternRequest.Builder> getWorkloadDeploymentPatternRequest)	Returns details for a given workload and deployment pattern, including the available specifications.
default GetWorkloadDeploymentPatternResponse	getWorkloadDeploymentPattern(GetWorkloadDeploymentPatternRequest getWorkloadDeploymentPatternRequest)	Returns details for a given workload and deployment pattern, including the available specifications.
default ListDeploymentEventsResponse	listDeploymentEvents(Consumer<ListDeploymentEventsRequest.Builder> listDeploymentEventsRequest)	Lists the events of a deployment.
default ListDeploymentEventsResponse	listDeploymentEvents(ListDeploymentEventsRequest listDeploymentEventsRequest)	Lists the events of a deployment.
default ListDeploymentEventsIterable	listDeploymentEventsPaginator(Consumer<ListDeploymentEventsRequest.Builder> listDeploymentEventsRequest)	This is a variant of listDeploymentEvents(software.amazon.awssdk.services.launchwizard.model.ListDeploymentEventsRequest) operation.
default ListDeploymentEventsIterable	listDeploymentEventsPaginator(ListDeploymentEventsRequest listDeploymentEventsRequest)	This is a variant of listDeploymentEvents(software.amazon.awssdk.services.launchwizard.model.ListDeploymentEventsRequest) operation.
default ListDeploymentsResponse	listDeployments(Consumer<ListDeploymentsRequest.Builder> listDeploymentsRequest)	Lists the deployments that have been created.
default ListDeploymentsResponse	listDeployments(ListDeploymentsRequest listDeploymentsRequest)	Lists the deployments that have been created.
default ListDeploymentsIterable	listDeploymentsPaginator(Consumer<ListDeploymentsRequest.Builder> listDeploymentsRequest)	This is a variant of listDeployments(software.amazon.awssdk.services.launchwizard.model.ListDeploymentsRequest) operation.
default ListDeploymentsIterable	listDeploymentsPaginator(ListDeploymentsRequest listDeploymentsRequest)	This is a variant of listDeployments(software.amazon.awssdk.services.launchwizard.model.ListDeploymentsRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Lists the tags associated with a specified resource.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Lists the tags associated with a specified resource.
default ListWorkloadDeploymentPatternsResponse	listWorkloadDeploymentPatterns(Consumer<ListWorkloadDeploymentPatternsRequest.Builder> listWorkloadDeploymentPatternsRequest)	Lists the workload deployment patterns for a given workload name.
default ListWorkloadDeploymentPatternsResponse	listWorkloadDeploymentPatterns(ListWorkloadDeploymentPatternsRequest listWorkloadDeploymentPatternsRequest)	Lists the workload deployment patterns for a given workload name.
default ListWorkloadDeploymentPatternsIterable	listWorkloadDeploymentPatternsPaginator(Consumer<ListWorkloadDeploymentPatternsRequest.Builder> listWorkloadDeploymentPatternsRequest)	This is a variant of listWorkloadDeploymentPatterns(software.amazon.awssdk.services.launchwizard.model.ListWorkloadDeploymentPatternsRequest) operation.
default ListWorkloadDeploymentPatternsIterable	listWorkloadDeploymentPatternsPaginator(ListWorkloadDeploymentPatternsRequest listWorkloadDeploymentPatternsRequest)	This is a variant of listWorkloadDeploymentPatterns(software.amazon.awssdk.services.launchwizard.model.ListWorkloadDeploymentPatternsRequest) operation.
default ListWorkloadsResponse	listWorkloads(Consumer<ListWorkloadsRequest.Builder> listWorkloadsRequest)	Lists the available workload names.
default ListWorkloadsResponse	listWorkloads(ListWorkloadsRequest listWorkloadsRequest)	Lists the available workload names.
default ListWorkloadsIterable	listWorkloadsPaginator(Consumer<ListWorkloadsRequest.Builder> listWorkloadsRequest)	This is a variant of listWorkloads(software.amazon.awssdk.services.launchwizard.model.ListWorkloadsRequest) operation.
default ListWorkloadsIterable	listWorkloadsPaginator(ListWorkloadsRequest listWorkloadsRequest)	This is a variant of listWorkloads(software.amazon.awssdk.services.launchwizard.model.ListWorkloadsRequest) operation.
default LaunchWizardServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Adds the specified tags to the given resource.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Adds the specified tags to the given resource.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes the specified tags from the given resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes the specified tags from the given resource.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

createDeployment

default CreateDeploymentResponse createDeployment(CreateDeploymentRequest createDeploymentRequest)
                                           throws ResourceLimitException,
InternalServerException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
LaunchWizardException

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.

See Also:

• AWS API Documentation

createDeployment

default CreateDeploymentResponse createDeployment(Consumer<CreateDeploymentRequest.Builder> createDeploymentRequest)
                                           throws ResourceLimitException,
InternalServerException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
LaunchWizardException

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.

This is a convenience which creates an instance of the CreateDeploymentRequest.Builder avoiding the need to create one manually via CreateDeploymentRequest.builder()

Parameters:

createDeploymentRequest - A Consumer that will call methods on CreateDeploymentRequest.Builder to create a request.

Returns:

Result of the CreateDeployment operation returned by the service.

See Also:

• AWS API Documentation

deleteDeployment

default DeleteDeploymentResponse deleteDeployment(DeleteDeploymentRequest deleteDeploymentRequest)
                                           throws ResourceLimitException,
InternalServerException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
LaunchWizardException

Deletes a deployment.

Parameters:

deleteDeploymentRequest -

Returns:

Result of the DeleteDeployment operation returned by the service.

See Also:

• AWS API Documentation

deleteDeployment

default DeleteDeploymentResponse deleteDeployment(Consumer<DeleteDeploymentRequest.Builder> deleteDeploymentRequest)
                                           throws ResourceLimitException,
InternalServerException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
LaunchWizardException

Deletes a deployment.

This is a convenience which creates an instance of the DeleteDeploymentRequest.Builder avoiding the need to create one manually via DeleteDeploymentRequest.builder()

Parameters:

deleteDeploymentRequest - A Consumer that will call methods on DeleteDeploymentRequest.Builder to create a request.

Returns:

Result of the DeleteDeployment operation returned by the service.

See Also:

• AWS API Documentation

getDeployment

default GetDeploymentResponse getDeployment(GetDeploymentRequest getDeploymentRequest)
                                     throws InternalServerException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
LaunchWizardException

Returns information about the deployment.

Parameters:

getDeploymentRequest -

Returns:

Result of the GetDeployment operation returned by the service.

See Also:

• AWS API Documentation

getDeployment

default GetDeploymentResponse getDeployment(Consumer<GetDeploymentRequest.Builder> getDeploymentRequest)
                                     throws InternalServerException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
LaunchWizardException

Returns information about the deployment.

This is a convenience which creates an instance of the GetDeploymentRequest.Builder avoiding the need to create one manually via GetDeploymentRequest.builder()

Parameters:

getDeploymentRequest - A Consumer that will call methods on GetDeploymentRequest.Builder to create a request.

Returns:

Result of the GetDeployment operation returned by the service.

See Also:

• AWS API Documentation

getWorkload

default GetWorkloadResponse getWorkload(GetWorkloadRequest getWorkloadRequest)
                                 throws InternalServerException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
LaunchWizardException

Returns information about a workload.

Parameters:

getWorkloadRequest -

Returns:

Result of the GetWorkload operation returned by the service.

See Also:

• AWS API Documentation

getWorkload

default GetWorkloadResponse getWorkload(Consumer<GetWorkloadRequest.Builder> getWorkloadRequest)
                                 throws InternalServerException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
LaunchWizardException

Returns information about a workload.

This is a convenience which creates an instance of the GetWorkloadRequest.Builder avoiding the need to create one manually via GetWorkloadRequest.builder()

Parameters:

getWorkloadRequest - A Consumer that will call methods on GetWorkloadRequest.Builder to create a request.

Returns:

Result of the GetWorkload operation returned by the service.

See Also:

• AWS API Documentation

getWorkloadDeploymentPattern

default GetWorkloadDeploymentPatternResponse getWorkloadDeploymentPattern(GetWorkloadDeploymentPatternRequest getWorkloadDeploymentPatternRequest)
                                                                   throws InternalServerException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
LaunchWizardException

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.

See Also:

• AWS API Documentation

getWorkloadDeploymentPattern

default GetWorkloadDeploymentPatternResponse getWorkloadDeploymentPattern(Consumer<GetWorkloadDeploymentPatternRequest.Builder> getWorkloadDeploymentPatternRequest)
                                                                   throws InternalServerException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
LaunchWizardException

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.

This is a convenience which creates an instance of the GetWorkloadDeploymentPatternRequest.Builder avoiding the need to create one manually via GetWorkloadDeploymentPatternRequest.builder()

Parameters:

getWorkloadDeploymentPatternRequest - A Consumer that will call methods on GetWorkloadDeploymentPatternRequest.Builder to create a request.

Returns:

Result of the GetWorkloadDeploymentPattern operation returned by the service.

See Also:

• AWS API Documentation

listDeploymentEvents

default ListDeploymentEventsResponse listDeploymentEvents(ListDeploymentEventsRequest listDeploymentEventsRequest)
                                                   throws InternalServerException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
LaunchWizardException

Lists the events of a deployment.

Parameters:

listDeploymentEventsRequest -

Returns:

Result of the ListDeploymentEvents operation returned by the service.

See Also:

• AWS API Documentation

listDeploymentEvents

default ListDeploymentEventsResponse listDeploymentEvents(Consumer<ListDeploymentEventsRequest.Builder> listDeploymentEventsRequest)
                                                   throws InternalServerException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
LaunchWizardException

Lists the events of a deployment.

This is a convenience which creates an instance of the ListDeploymentEventsRequest.Builder avoiding the need to create one manually via ListDeploymentEventsRequest.builder()

Parameters:

listDeploymentEventsRequest - A Consumer that will call methods on ListDeploymentEventsRequest.Builder to create a request.

Returns:

Result of the ListDeploymentEvents operation returned by the service.

See Also:

• AWS API Documentation

listDeploymentEventsPaginator

default ListDeploymentEventsIterable listDeploymentEventsPaginator(ListDeploymentEventsRequest listDeploymentEventsRequest)
                                                            throws InternalServerException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
LaunchWizardException

This is a variant of listDeploymentEvents(software.amazon.awssdk.services.launchwizard.model.ListDeploymentEventsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.launchwizard.paginators.ListDeploymentEventsIterable responses = client.listDeploymentEventsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.launchwizard.paginators.ListDeploymentEventsIterable responses = client
             .listDeploymentEventsPaginator(request);
     for (software.amazon.awssdk.services.launchwizard.model.ListDeploymentEventsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.launchwizard.paginators.ListDeploymentEventsIterable responses = client.listDeploymentEventsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listDeploymentEvents(software.amazon.awssdk.services.launchwizard.model.ListDeploymentEventsRequest) operation.

Parameters:

listDeploymentEventsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listDeploymentEventsPaginator

default ListDeploymentEventsIterable listDeploymentEventsPaginator(Consumer<ListDeploymentEventsRequest.Builder> listDeploymentEventsRequest)
                                                            throws InternalServerException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
LaunchWizardException

This is a variant of listDeploymentEvents(software.amazon.awssdk.services.launchwizard.model.ListDeploymentEventsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.launchwizard.paginators.ListDeploymentEventsIterable responses = client.listDeploymentEventsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.launchwizard.paginators.ListDeploymentEventsIterable responses = client
             .listDeploymentEventsPaginator(request);
     for (software.amazon.awssdk.services.launchwizard.model.ListDeploymentEventsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.launchwizard.paginators.ListDeploymentEventsIterable responses = client.listDeploymentEventsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listDeploymentEvents(software.amazon.awssdk.services.launchwizard.model.ListDeploymentEventsRequest) operation.

This is a convenience which creates an instance of the ListDeploymentEventsRequest.Builder avoiding the need to create one manually via ListDeploymentEventsRequest.builder()

Parameters:

listDeploymentEventsRequest - A Consumer that will call methods on ListDeploymentEventsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listDeployments

default ListDeploymentsResponse listDeployments(ListDeploymentsRequest listDeploymentsRequest)
                                         throws InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
LaunchWizardException

Lists the deployments that have been created.

Parameters:

listDeploymentsRequest -

Returns:

Result of the ListDeployments operation returned by the service.

See Also:

• AWS API Documentation

listDeployments

default ListDeploymentsResponse listDeployments(Consumer<ListDeploymentsRequest.Builder> listDeploymentsRequest)
                                         throws InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
LaunchWizardException

Lists the deployments that have been created.

This is a convenience which creates an instance of the ListDeploymentsRequest.Builder avoiding the need to create one manually via ListDeploymentsRequest.builder()

Parameters:

listDeploymentsRequest - A Consumer that will call methods on ListDeploymentsRequest.Builder to create a request.

Returns:

Result of the ListDeployments operation returned by the service.

See Also:

• AWS API Documentation

listDeploymentsPaginator

default ListDeploymentsIterable listDeploymentsPaginator(ListDeploymentsRequest listDeploymentsRequest)
                                                  throws InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
LaunchWizardException

This is a variant of listDeployments(software.amazon.awssdk.services.launchwizard.model.ListDeploymentsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.launchwizard.paginators.ListDeploymentsIterable responses = client.listDeploymentsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.launchwizard.paginators.ListDeploymentsIterable responses = client
             .listDeploymentsPaginator(request);
     for (software.amazon.awssdk.services.launchwizard.model.ListDeploymentsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.launchwizard.paginators.ListDeploymentsIterable responses = client.listDeploymentsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listDeployments(software.amazon.awssdk.services.launchwizard.model.ListDeploymentsRequest) operation.

Parameters:

listDeploymentsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listDeploymentsPaginator

default ListDeploymentsIterable listDeploymentsPaginator(Consumer<ListDeploymentsRequest.Builder> listDeploymentsRequest)
                                                  throws InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
LaunchWizardException

This is a variant of listDeployments(software.amazon.awssdk.services.launchwizard.model.ListDeploymentsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.launchwizard.paginators.ListDeploymentsIterable responses = client.listDeploymentsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.launchwizard.paginators.ListDeploymentsIterable responses = client
             .listDeploymentsPaginator(request);
     for (software.amazon.awssdk.services.launchwizard.model.ListDeploymentsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.launchwizard.paginators.ListDeploymentsIterable responses = client.listDeploymentsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listDeployments(software.amazon.awssdk.services.launchwizard.model.ListDeploymentsRequest) operation.

This is a convenience which creates an instance of the ListDeploymentsRequest.Builder avoiding the need to create one manually via ListDeploymentsRequest.builder()

Parameters:

listDeploymentsRequest - A Consumer that will call methods on ListDeploymentsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws InternalServerException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
LaunchWizardException

Lists the tags associated with a specified resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws InternalServerException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
LaunchWizardException

Lists the tags associated with a specified resource.

This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listWorkloadDeploymentPatterns

default ListWorkloadDeploymentPatternsResponse listWorkloadDeploymentPatterns(ListWorkloadDeploymentPatternsRequest listWorkloadDeploymentPatternsRequest)
                                                                       throws InternalServerException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
LaunchWizardException

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.

See Also:

• AWS API Documentation

listWorkloadDeploymentPatterns

default ListWorkloadDeploymentPatternsResponse listWorkloadDeploymentPatterns(Consumer<ListWorkloadDeploymentPatternsRequest.Builder> listWorkloadDeploymentPatternsRequest)
                                                                       throws InternalServerException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
LaunchWizardException

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

This is a convenience which creates an instance of the ListWorkloadDeploymentPatternsRequest.Builder avoiding the need to create one manually via ListWorkloadDeploymentPatternsRequest.builder()

Parameters:

listWorkloadDeploymentPatternsRequest - A Consumer that will call methods on ListWorkloadDeploymentPatternsRequest.Builder to create a request.

Returns:

Result of the ListWorkloadDeploymentPatterns operation returned by the service.

See Also:

• AWS API Documentation

listWorkloadDeploymentPatternsPaginator

default ListWorkloadDeploymentPatternsIterable listWorkloadDeploymentPatternsPaginator(ListWorkloadDeploymentPatternsRequest listWorkloadDeploymentPatternsRequest)
                                                                                throws InternalServerException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
LaunchWizardException

This is a variant of listWorkloadDeploymentPatterns(software.amazon.awssdk.services.launchwizard.model.ListWorkloadDeploymentPatternsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.launchwizard.paginators.ListWorkloadDeploymentPatternsIterable responses = client.listWorkloadDeploymentPatternsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.launchwizard.paginators.ListWorkloadDeploymentPatternsIterable responses = client
             .listWorkloadDeploymentPatternsPaginator(request);
     for (software.amazon.awssdk.services.launchwizard.model.ListWorkloadDeploymentPatternsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.launchwizard.paginators.ListWorkloadDeploymentPatternsIterable responses = client.listWorkloadDeploymentPatternsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listWorkloadDeploymentPatterns(software.amazon.awssdk.services.launchwizard.model.ListWorkloadDeploymentPatternsRequest) operation.

Parameters:

listWorkloadDeploymentPatternsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listWorkloadDeploymentPatternsPaginator

default ListWorkloadDeploymentPatternsIterable listWorkloadDeploymentPatternsPaginator(Consumer<ListWorkloadDeploymentPatternsRequest.Builder> listWorkloadDeploymentPatternsRequest)
                                                                                throws InternalServerException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
LaunchWizardException

This is a variant of listWorkloadDeploymentPatterns(software.amazon.awssdk.services.launchwizard.model.ListWorkloadDeploymentPatternsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.launchwizard.paginators.ListWorkloadDeploymentPatternsIterable responses = client.listWorkloadDeploymentPatternsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.launchwizard.paginators.ListWorkloadDeploymentPatternsIterable responses = client
             .listWorkloadDeploymentPatternsPaginator(request);
     for (software.amazon.awssdk.services.launchwizard.model.ListWorkloadDeploymentPatternsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.launchwizard.paginators.ListWorkloadDeploymentPatternsIterable responses = client.listWorkloadDeploymentPatternsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listWorkloadDeploymentPatterns(software.amazon.awssdk.services.launchwizard.model.ListWorkloadDeploymentPatternsRequest) operation.

This is a convenience which creates an instance of the ListWorkloadDeploymentPatternsRequest.Builder avoiding the need to create one manually via ListWorkloadDeploymentPatternsRequest.builder()

Parameters:

listWorkloadDeploymentPatternsRequest - A Consumer that will call methods on ListWorkloadDeploymentPatternsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listWorkloads

default ListWorkloadsResponse listWorkloads(ListWorkloadsRequest listWorkloadsRequest)
                                     throws InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
LaunchWizardException

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.

See Also:

• AWS API Documentation

listWorkloads

default ListWorkloadsResponse listWorkloads(Consumer<ListWorkloadsRequest.Builder> listWorkloadsRequest)
                                     throws InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
LaunchWizardException

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

This is a convenience which creates an instance of the ListWorkloadsRequest.Builder avoiding the need to create one manually via ListWorkloadsRequest.builder()

Parameters:

listWorkloadsRequest - A Consumer that will call methods on ListWorkloadsRequest.Builder to create a request.

Returns:

Result of the ListWorkloads operation returned by the service.

See Also:

• AWS API Documentation

listWorkloadsPaginator

default ListWorkloadsIterable listWorkloadsPaginator(ListWorkloadsRequest listWorkloadsRequest)
                                              throws InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
LaunchWizardException

This is a variant of listWorkloads(software.amazon.awssdk.services.launchwizard.model.ListWorkloadsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.launchwizard.paginators.ListWorkloadsIterable responses = client.listWorkloadsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.launchwizard.paginators.ListWorkloadsIterable responses = client
             .listWorkloadsPaginator(request);
     for (software.amazon.awssdk.services.launchwizard.model.ListWorkloadsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.launchwizard.paginators.ListWorkloadsIterable responses = client.listWorkloadsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listWorkloads(software.amazon.awssdk.services.launchwizard.model.ListWorkloadsRequest) operation.

Parameters:

listWorkloadsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listWorkloadsPaginator

default ListWorkloadsIterable listWorkloadsPaginator(Consumer<ListWorkloadsRequest.Builder> listWorkloadsRequest)
                                              throws InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
LaunchWizardException

This is a variant of listWorkloads(software.amazon.awssdk.services.launchwizard.model.ListWorkloadsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.launchwizard.paginators.ListWorkloadsIterable responses = client.listWorkloadsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.launchwizard.paginators.ListWorkloadsIterable responses = client
             .listWorkloadsPaginator(request);
     for (software.amazon.awssdk.services.launchwizard.model.ListWorkloadsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.launchwizard.paginators.ListWorkloadsIterable responses = client.listWorkloadsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listWorkloads(software.amazon.awssdk.services.launchwizard.model.ListWorkloadsRequest) operation.

This is a convenience which creates an instance of the ListWorkloadsRequest.Builder avoiding the need to create one manually via ListWorkloadsRequest.builder()

Parameters:

listWorkloadsRequest - A Consumer that will call methods on ListWorkloadsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws InternalServerException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
LaunchWizardException

Adds the specified tags to the given resource.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws InternalServerException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
LaunchWizardException

Adds the specified tags to the given resource.

This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws InternalServerException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
LaunchWizardException

Removes the specified tags from the given resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws InternalServerException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
LaunchWizardException

Removes the specified tags from the given resource.

This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

create

static LaunchWizardClient create()

Create a LaunchWizardClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static LaunchWizardClientBuilder builder()

Create a builder that can be used to configure and create a LaunchWizardClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default LaunchWizardServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration