cloudcontrol/aws.sdk.kotlin.services.cloudcontrol/CloudControlClient

CloudControlClient

interface CloudControlClient : SdkClient

For more information about Amazon Web Services Cloud Control API, see the Amazon Web Services Cloud Control API User Guide.

Types

Builder

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

Companion

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

Config

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

Properties

config

abstract override val config: CloudControlClient.Config

CloudControlClient's configuration

Functions

cancelResourceRequest

abstract suspend fun cancelResourceRequest(input: CancelResourceRequestRequest): CancelResourceRequestResponse

Cancels the specified resource operation request. For more information, see Canceling resource operation requests in the Amazon Web Services Cloud Control API User Guide.

createResource

abstract suspend fun createResource(input: CreateResourceRequest): CreateResourceResponse

Creates the specified resource. For more information, see Creating a resource in the Amazon Web Services Cloud Control API User Guide.

deleteResource

abstract suspend fun deleteResource(input: DeleteResourceRequest): DeleteResourceResponse

Deletes the specified resource. For details, see Deleting a resource in the Amazon Web Services Cloud Control API User Guide.

getResource

abstract suspend fun getResource(input: GetResourceRequest): GetResourceResponse

Returns information about the current state of the specified resource. For details, see Reading a resource's current state.

getResourceRequestStatus

abstract suspend fun getResourceRequestStatus(input: GetResourceRequestStatusRequest): GetResourceRequestStatusResponse

Returns the current status of a resource operation request. For more information, see Tracking the progress of resource operation requests in the Amazon Web Services Cloud Control API User Guide.

listResourceRequests

abstract suspend fun listResourceRequests(input: ListResourceRequestsRequest = ListResourceRequestsRequest { }): ListResourceRequestsResponse

Returns existing resource operation requests. This includes requests of all status types. For more information, see Listing active resource operation requests in the Amazon Web Services Cloud Control API User Guide.

listResources

abstract suspend fun listResources(input: ListResourcesRequest): ListResourcesResponse

Returns information about the specified resources. For more information, see Discovering resources in the Amazon Web Services Cloud Control API User Guide.

updateResource

abstract suspend fun updateResource(input: UpdateResourceRequest): UpdateResourceResponse

Updates the specified property values in the resource.

Inherited functions

cancelResourceRequest

inline suspend fun CloudControlClient.cancelResourceRequest(crossinline block: CancelResourceRequestRequest.Builder.() -> Unit): CancelResourceRequestResponse

Cancels the specified resource operation request. For more information, see Canceling resource operation requests in the Amazon Web Services Cloud Control API User Guide.

expect abstract fun close()

createResource

inline suspend fun CloudControlClient.createResource(crossinline block: CreateResourceRequest.Builder.() -> Unit): CreateResourceResponse

Creates the specified resource. For more information, see Creating a resource in the Amazon Web Services Cloud Control API User Guide.

deleteResource

inline suspend fun CloudControlClient.deleteResource(crossinline block: DeleteResourceRequest.Builder.() -> Unit): DeleteResourceResponse

Deletes the specified resource. For details, see Deleting a resource in the Amazon Web Services Cloud Control API User Guide.

getResource

inline suspend fun CloudControlClient.getResource(crossinline block: GetResourceRequest.Builder.() -> Unit): GetResourceResponse

Returns information about the current state of the specified resource. For details, see Reading a resource's current state.

getResourceRequestStatus

inline suspend fun CloudControlClient.getResourceRequestStatus(crossinline block: GetResourceRequestStatusRequest.Builder.() -> Unit): GetResourceRequestStatusResponse

Returns the current status of a resource operation request. For more information, see Tracking the progress of resource operation requests in the Amazon Web Services Cloud Control API User Guide.

listResourceRequests

inline suspend fun CloudControlClient.listResourceRequests(crossinline block: ListResourceRequestsRequest.Builder.() -> Unit): ListResourceRequestsResponse

listResourceRequestsPaginated

fun CloudControlClient.listResourceRequestsPaginated(initialRequest: ListResourceRequestsRequest = ListResourceRequestsRequest { }): Flow<ListResourceRequestsResponse>

fun CloudControlClient.listResourceRequestsPaginated(block: ListResourceRequestsRequest.Builder.() -> Unit): Flow<ListResourceRequestsResponse>

Paginate over ListResourceRequestsResponse results.

listResources

inline suspend fun CloudControlClient.listResources(crossinline block: ListResourcesRequest.Builder.() -> Unit): ListResourcesResponse

Returns information about the specified resources. For more information, see Discovering resources in the Amazon Web Services Cloud Control API User Guide.

listResourcesPaginated

fun CloudControlClient.listResourcesPaginated(initialRequest: ListResourcesRequest): Flow<ListResourcesResponse>

fun CloudControlClient.listResourcesPaginated(block: ListResourcesRequest.Builder.() -> Unit): Flow<ListResourcesResponse>

Paginate over ListResourcesResponse results.

updateResource

inline suspend fun CloudControlClient.updateResource(crossinline block: UpdateResourceRequest.Builder.() -> Unit): UpdateResourceResponse

Updates the specified property values in the resource.

waitUntilResourceRequestSuccess

suspend fun CloudControlClient.waitUntilResourceRequestSuccess(block: GetResourceRequestStatusRequest.Builder.() -> Unit): Outcome<GetResourceRequestStatusResponse>

suspend fun CloudControlClient.waitUntilResourceRequestSuccess(request: GetResourceRequestStatusRequest, retryStrategy: RetryStrategy? = null): Outcome<GetResourceRequestStatusResponse>

Wait until resource operation request is successful

withConfig

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

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.