launchwizard/aws.sdk.kotlin.services.launchwizard/LaunchWizardClient

LaunchWizardClient

interface LaunchWizardClient : SdkClient

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.

Types

Builder

class Builder : AbstractSdkClientBuilder<LaunchWizardClient.Config, LaunchWizardClient.Config.Builder, LaunchWizardClient>

Companion

object Companion : AbstractAwsSdkClientFactory<LaunchWizardClient.Config, LaunchWizardClient.Config.Builder, LaunchWizardClient, LaunchWizardClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

config

abstract override val config: LaunchWizardClient.Config

LaunchWizardClient's configuration

Functions

createDeployment

abstract suspend fun createDeployment(input: CreateDeploymentRequest): CreateDeploymentResponse

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.

deleteDeployment

abstract suspend fun deleteDeployment(input: DeleteDeploymentRequest): DeleteDeploymentResponse

Deletes a deployment.

getDeployment

abstract suspend fun getDeployment(input: GetDeploymentRequest): GetDeploymentResponse

Returns information about the deployment.

getWorkload

abstract suspend fun getWorkload(input: GetWorkloadRequest): GetWorkloadResponse

Returns information about a workload.

getWorkloadDeploymentPattern

abstract suspend fun getWorkloadDeploymentPattern(input: GetWorkloadDeploymentPatternRequest): GetWorkloadDeploymentPatternResponse

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.

listDeploymentEvents

abstract suspend fun listDeploymentEvents(input: ListDeploymentEventsRequest): ListDeploymentEventsResponse

Lists the events of a deployment.

listDeployments

abstract suspend fun listDeployments(input: ListDeploymentsRequest = ListDeploymentsRequest { }): ListDeploymentsResponse

Lists the deployments that have been created.

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

Lists the tags associated with a specified resource.

listWorkloadDeploymentPatterns

abstract suspend fun listWorkloadDeploymentPatterns(input: ListWorkloadDeploymentPatternsRequest): ListWorkloadDeploymentPatternsResponse

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

listWorkloads

abstract suspend fun listWorkloads(input: ListWorkloadsRequest = ListWorkloadsRequest { }): ListWorkloadsResponse

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

tagResource

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Adds the specified tags to the given resource.

untagResource

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Removes the specified tags from the given resource.

Inherited functions

expect abstract fun close()

createDeployment

inline suspend fun LaunchWizardClient.createDeployment(crossinline block: CreateDeploymentRequest.Builder.() -> Unit): CreateDeploymentResponse

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.

deleteDeployment

inline suspend fun LaunchWizardClient.deleteDeployment(crossinline block: DeleteDeploymentRequest.Builder.() -> Unit): DeleteDeploymentResponse

Deletes a deployment.

getDeployment

inline suspend fun LaunchWizardClient.getDeployment(crossinline block: GetDeploymentRequest.Builder.() -> Unit): GetDeploymentResponse

Returns information about the deployment.

getWorkload

inline suspend fun LaunchWizardClient.getWorkload(crossinline block: GetWorkloadRequest.Builder.() -> Unit): GetWorkloadResponse

Returns information about a workload.

getWorkloadDeploymentPattern

inline suspend fun LaunchWizardClient.getWorkloadDeploymentPattern(crossinline block: GetWorkloadDeploymentPatternRequest.Builder.() -> Unit): GetWorkloadDeploymentPatternResponse

listDeploymentEvents

inline suspend fun LaunchWizardClient.listDeploymentEvents(crossinline block: ListDeploymentEventsRequest.Builder.() -> Unit): ListDeploymentEventsResponse

Lists the events of a deployment.

listDeploymentEventsPaginated

fun LaunchWizardClient.listDeploymentEventsPaginated(initialRequest: ListDeploymentEventsRequest): Flow<ListDeploymentEventsResponse>

fun LaunchWizardClient.listDeploymentEventsPaginated(block: ListDeploymentEventsRequest.Builder.() -> Unit): Flow<ListDeploymentEventsResponse>

Paginate over ListDeploymentEventsResponse results.

listDeployments

inline suspend fun LaunchWizardClient.listDeployments(crossinline block: ListDeploymentsRequest.Builder.() -> Unit): ListDeploymentsResponse

Lists the deployments that have been created.

listDeploymentsPaginated

fun LaunchWizardClient.listDeploymentsPaginated(initialRequest: ListDeploymentsRequest = ListDeploymentsRequest { }): Flow<ListDeploymentsResponse>

fun LaunchWizardClient.listDeploymentsPaginated(block: ListDeploymentsRequest.Builder.() -> Unit): Flow<ListDeploymentsResponse>

Paginate over ListDeploymentsResponse results.

listTagsForResource

inline suspend fun LaunchWizardClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Lists the tags associated with a specified resource.

listWorkloadDeploymentPatterns

inline suspend fun LaunchWizardClient.listWorkloadDeploymentPatterns(crossinline block: ListWorkloadDeploymentPatternsRequest.Builder.() -> Unit): ListWorkloadDeploymentPatternsResponse

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

listWorkloadDeploymentPatternsPaginated

fun LaunchWizardClient.listWorkloadDeploymentPatternsPaginated(initialRequest: ListWorkloadDeploymentPatternsRequest): Flow<ListWorkloadDeploymentPatternsResponse>

fun LaunchWizardClient.listWorkloadDeploymentPatternsPaginated(block: ListWorkloadDeploymentPatternsRequest.Builder.() -> Unit): Flow<ListWorkloadDeploymentPatternsResponse>

Paginate over ListWorkloadDeploymentPatternsResponse results.

listWorkloads

inline suspend fun LaunchWizardClient.listWorkloads(crossinline block: ListWorkloadsRequest.Builder.() -> Unit): ListWorkloadsResponse

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

listWorkloadsPaginated

fun LaunchWizardClient.listWorkloadsPaginated(initialRequest: ListWorkloadsRequest = ListWorkloadsRequest { }): Flow<ListWorkloadsResponse>

fun LaunchWizardClient.listWorkloadsPaginated(block: ListWorkloadsRequest.Builder.() -> Unit): Flow<ListWorkloadsResponse>

Paginate over ListWorkloadsResponse results.

tagResource

inline suspend fun LaunchWizardClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Adds the specified tags to the given resource.

untagResource

inline suspend fun LaunchWizardClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes the specified tags from the given resource.

withConfig

fun LaunchWizardClient.withConfig(block: LaunchWizardClient.Config.Builder.() -> Unit): LaunchWizardClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.