commonMain.aws.sdk.kotlin.services.migrationhubconfig.MigrationHubConfigClient.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of migrationhubconfig-jvm Show documentation
Show all versions of migrationhubconfig-jvm Show documentation
The AWS SDK for Kotlin client for MigrationHub Config
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!
package aws.sdk.kotlin.services.migrationhubconfig
import aws.sdk.kotlin.runtime.auth.credentials.DefaultChainCredentialsProvider
import aws.sdk.kotlin.runtime.auth.credentials.internal.manage
import aws.sdk.kotlin.runtime.client.AwsSdkClientConfig
import aws.sdk.kotlin.runtime.config.AbstractAwsSdkClientFactory
import aws.sdk.kotlin.runtime.config.endpoints.resolveEndpointUrl
import aws.sdk.kotlin.runtime.config.profile.AwsProfile
import aws.sdk.kotlin.runtime.config.profile.AwsSharedConfig
import aws.sdk.kotlin.runtime.http.retries.AwsRetryPolicy
import aws.sdk.kotlin.services.migrationhubconfig.auth.DefaultMigrationHubConfigAuthSchemeProvider
import aws.sdk.kotlin.services.migrationhubconfig.auth.MigrationHubConfigAuthSchemeProvider
import aws.sdk.kotlin.services.migrationhubconfig.endpoints.DefaultMigrationHubConfigEndpointProvider
import aws.sdk.kotlin.services.migrationhubconfig.endpoints.MigrationHubConfigEndpointParameters
import aws.sdk.kotlin.services.migrationhubconfig.endpoints.MigrationHubConfigEndpointProvider
import aws.sdk.kotlin.services.migrationhubconfig.model.CreateHomeRegionControlRequest
import aws.sdk.kotlin.services.migrationhubconfig.model.CreateHomeRegionControlResponse
import aws.sdk.kotlin.services.migrationhubconfig.model.DeleteHomeRegionControlRequest
import aws.sdk.kotlin.services.migrationhubconfig.model.DeleteHomeRegionControlResponse
import aws.sdk.kotlin.services.migrationhubconfig.model.DescribeHomeRegionControlsRequest
import aws.sdk.kotlin.services.migrationhubconfig.model.DescribeHomeRegionControlsResponse
import aws.sdk.kotlin.services.migrationhubconfig.model.GetHomeRegionRequest
import aws.sdk.kotlin.services.migrationhubconfig.model.GetHomeRegionResponse
import aws.smithy.kotlin.runtime.auth.awscredentials.CredentialsProvider
import aws.smithy.kotlin.runtime.auth.awscredentials.CredentialsProviderConfig
import aws.smithy.kotlin.runtime.awsprotocol.ClockSkewInterceptor
import aws.smithy.kotlin.runtime.client.AbstractSdkClientBuilder
import aws.smithy.kotlin.runtime.client.AbstractSdkClientFactory
import aws.smithy.kotlin.runtime.client.LogMode
import aws.smithy.kotlin.runtime.client.RetryClientConfig
import aws.smithy.kotlin.runtime.client.RetryStrategyClientConfig
import aws.smithy.kotlin.runtime.client.RetryStrategyClientConfigImpl
import aws.smithy.kotlin.runtime.client.SdkClient
import aws.smithy.kotlin.runtime.client.SdkClientConfig
import aws.smithy.kotlin.runtime.http.auth.AuthScheme
import aws.smithy.kotlin.runtime.http.auth.HttpAuthConfig
import aws.smithy.kotlin.runtime.http.config.HttpClientConfig
import aws.smithy.kotlin.runtime.http.config.HttpEngineConfig
import aws.smithy.kotlin.runtime.http.engine.HttpClientEngine
import aws.smithy.kotlin.runtime.http.engine.HttpEngineConfigImpl
import aws.smithy.kotlin.runtime.http.interceptors.HttpInterceptor
import aws.smithy.kotlin.runtime.net.url.Url
import aws.smithy.kotlin.runtime.retries.RetryStrategy
import aws.smithy.kotlin.runtime.retries.policy.RetryPolicy
import aws.smithy.kotlin.runtime.telemetry.Global
import aws.smithy.kotlin.runtime.telemetry.TelemetryConfig
import aws.smithy.kotlin.runtime.telemetry.TelemetryProvider
import aws.smithy.kotlin.runtime.util.LazyAsyncValue
import kotlin.collections.List
import kotlin.jvm.JvmStatic
public const val ServiceId: String = "MigrationHub Config"
public const val SdkVersion: String = "1.3.10"
public const val ServiceApiVersion: String = "2019-06-30"
/**
* The AWS Migration Hub home region APIs are available specifically for working with your Migration Hub home region. You can use these APIs to determine a home region, as well as to create and work with controls that describe the home region.
* + You must make API calls for write actions (create, notify, associate, disassociate, import, or put) while in your home region, or a `HomeRegionNotSetException` error is returned.
* + API calls for read actions (list, describe, stop, and delete) are permitted outside of your home region.
* + If you call a write API outside the home region, an `InvalidInputException` is returned.
* + You can call `GetHomeRegion` action to obtain the account's Migration Hub home region.
*
* For specific API usage, see the sections that follow in this AWS Migration Hub Home Region API reference.
*/
public interface MigrationHubConfigClient : SdkClient {
/**
* MigrationHubConfigClient's configuration
*/
public override val config: Config
public companion object : AbstractAwsSdkClientFactory()
{
@JvmStatic
override fun builder(): Builder = Builder()
override fun finalizeConfig(builder: Builder) {
super.finalizeConfig(builder)
builder.config.interceptors.add(0, ClockSkewInterceptor())
}
override suspend fun finalizeEnvironmentalConfig(builder: Builder, sharedConfig: LazyAsyncValue, activeProfile: LazyAsyncValue) {
super.finalizeEnvironmentalConfig(builder, sharedConfig, activeProfile)
builder.config.endpointUrl = builder.config.endpointUrl ?: resolveEndpointUrl(
sharedConfig,
"MigrationHubConfig",
"MIGRATIONHUB_CONFIG",
"migrationhub_config",
)
}
}
public class Builder internal constructor(): AbstractSdkClientBuilder() {
override val config: Config.Builder = Config.Builder()
override fun newClient(config: Config): MigrationHubConfigClient = DefaultMigrationHubConfigClient(config)
}
public class Config private constructor(builder: Builder) : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig by builder.buildHttpEngineConfig(), RetryClientConfig, RetryStrategyClientConfig by builder.buildRetryStrategyClientConfig(), SdkClientConfig, TelemetryConfig {
override val clientName: String = builder.clientName
override val region: String? = builder.region
override val authSchemes: kotlin.collections.List = builder.authSchemes
override val credentialsProvider: CredentialsProvider = builder.credentialsProvider ?: DefaultChainCredentialsProvider(httpClient = httpClient, region = region).manage()
public val endpointProvider: MigrationHubConfigEndpointProvider = builder.endpointProvider ?: DefaultMigrationHubConfigEndpointProvider()
public val endpointUrl: Url? = builder.endpointUrl
override val interceptors: kotlin.collections.List = builder.interceptors
override val logMode: LogMode = builder.logMode ?: LogMode.Default
override val retryPolicy: RetryPolicy = builder.retryPolicy ?: AwsRetryPolicy.Default
override val telemetryProvider: TelemetryProvider = builder.telemetryProvider ?: TelemetryProvider.Global
override val useDualStack: Boolean = builder.useDualStack ?: false
override val useFips: Boolean = builder.useFips ?: false
override val applicationId: String? = builder.applicationId
public val authSchemeProvider: MigrationHubConfigAuthSchemeProvider = builder.authSchemeProvider ?: DefaultMigrationHubConfigAuthSchemeProvider()
public companion object {
public inline operator fun invoke(block: Builder.() -> kotlin.Unit): Config = Builder().apply(block).build()
}
public fun toBuilder(): Builder = Builder().apply {
clientName = [email protected]
region = [email protected]
authSchemes = [email protected]
credentialsProvider = [email protected]
endpointProvider = [email protected]
endpointUrl = [email protected]
httpClient = [email protected]
interceptors = [email protected]()
logMode = [email protected]
retryPolicy = [email protected]
retryStrategy = [email protected]
telemetryProvider = [email protected]
useDualStack = [email protected]
useFips = [email protected]
applicationId = [email protected]
authSchemeProvider = [email protected]
}
public class Builder : AwsSdkClientConfig.Builder, CredentialsProviderConfig.Builder, HttpAuthConfig.Builder, HttpClientConfig.Builder, HttpEngineConfig.Builder by HttpEngineConfigImpl.BuilderImpl(), RetryClientConfig.Builder, RetryStrategyClientConfig.Builder by RetryStrategyClientConfigImpl.BuilderImpl(), SdkClientConfig.Builder, TelemetryConfig.Builder {
/**
* A reader-friendly name for the client.
*/
override var clientName: String = "MigrationHub Config"
/**
* The AWS region (e.g. `us-west-2`) to make requests to. See about AWS
* [global infrastructure](https://aws.amazon.com/about-aws/global-infrastructure/regions_az/) for more
* information
*/
override var region: String? = null
/**
* Register new or override default [AuthScheme]s configured for this client. By default, the set
* of auth schemes configured comes from the service model. An auth scheme configured explicitly takes
* precedence over the defaults and can be used to customize identity resolution and signing for specific
* authentication schemes.
*/
override var authSchemes: kotlin.collections.List = emptyList()
/**
* The AWS credentials provider to use for authenticating requests. If not provided a
* [aws.sdk.kotlin.runtime.auth.credentials.DefaultChainCredentialsProvider] instance will be used.
* NOTE: The caller is responsible for managing the lifetime of the provider when set. The SDK
* client will not close it when the client is closed.
*/
override var credentialsProvider: CredentialsProvider? = null
/**
* The endpoint provider used to determine where to make service requests. **This is an advanced config
* option.**
*
* Endpoint resolution occurs as part of the workflow for every request made via the service client.
*
* The inputs to endpoint resolution are defined on a per-service basis (see [EndpointParameters]).
*/
public var endpointProvider: MigrationHubConfigEndpointProvider? = null
/**
* A custom endpoint to route requests to. The endpoint set here is passed to the configured
* [endpointProvider], which may inspect and modify it as needed.
*
* Setting a custom endpointUrl should generally be preferred to overriding the [endpointProvider] and is
* the recommended way to route requests to development or preview instances of a service.
*
* **This is an advanced config option.**
*/
public var endpointUrl: Url? = null
/**
* Add an [aws.smithy.kotlin.runtime.client.Interceptor] that will have access to read and modify
* the request and response objects as they are processed by the SDK.
* Interceptors added using this method are executed in the order they are configured and are always
* later than any added automatically by the SDK.
*/
override var interceptors: kotlin.collections.MutableList = kotlin.collections.mutableListOf()
/**
* Configure events that will be logged. By default clients will not output
* raw requests or responses. Use this setting to opt-in to additional debug logging.
*
* This can be used to configure logging of requests, responses, retries, etc of SDK clients.
*
* **NOTE**: Logging of raw requests or responses may leak sensitive information! It may also have
* performance considerations when dumping the request/response body. This is primarily a tool for
* debug purposes.
*/
override var logMode: LogMode? = null
/**
* The policy to use for evaluating operation results and determining whether/how to retry.
*/
override var retryPolicy: RetryPolicy? = null
/**
* The telemetry provider used to instrument the SDK operations with. By default, the global telemetry
* provider will be used.
*/
override var telemetryProvider: TelemetryProvider? = null
/**
* Flag to toggle whether to use dual-stack endpoints when making requests.
* See [https://docs.aws.amazon.com/sdkref/latest/guide/feature-endpoints.html] for more information.
* ` Disabled by default.
*/
override var useDualStack: Boolean? = null
/**
* Flag to toggle whether to use [FIPS](https://aws.amazon.com/compliance/fips/) endpoints when making requests.
* ` Disabled by default.
*/
override var useFips: Boolean? = null
/**
* An optional application specific identifier.
* When set it will be appended to the User-Agent header of every request in the form of: `app/{applicationId}`.
* When not explicitly set, the value will be loaded from the following locations:
*
* - JVM System Property: `aws.userAgentAppId`
* - Environment variable: `AWS_SDK_UA_APP_ID`
* - Shared configuration profile attribute: `sdk_ua_app_id`
*
* See [shared configuration settings](https://docs.aws.amazon.com/sdkref/latest/guide/settings-reference.html)
* reference for more information on environment variables and shared config settings.
*/
override var applicationId: String? = null
/**
* Configure the provider used to resolve the authentication scheme to use for a particular operation.
*/
public var authSchemeProvider: MigrationHubConfigAuthSchemeProvider? = null
override fun build(): Config = Config(this)
}
}
/**
* This API sets up the home region for the calling account only.
*/
public suspend fun createHomeRegionControl(input: CreateHomeRegionControlRequest): CreateHomeRegionControlResponse
/**
* This operation deletes the home region configuration for the calling account. The operation does not delete discovery or migration tracking data in the home region.
*/
public suspend fun deleteHomeRegionControl(input: DeleteHomeRegionControlRequest): DeleteHomeRegionControlResponse
/**
* This API permits filtering on the `ControlId` and `HomeRegion` fields.
*/
public suspend fun describeHomeRegionControls(input: DescribeHomeRegionControlsRequest = DescribeHomeRegionControlsRequest { }): DescribeHomeRegionControlsResponse
/**
* Returns the calling account’s home region, if configured. This API is used by other AWS services to determine the regional endpoint for calling AWS Application Discovery Service and Migration Hub. You must call `GetHomeRegion` at least once before you call any other AWS Application Discovery Service and AWS Migration Hub APIs, to obtain the account's Migration Hub home region.
*/
public suspend fun getHomeRegion(input: GetHomeRegionRequest = GetHomeRegionRequest { }): GetHomeRegionResponse
}
/**
* 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.
*
* Any resources created on your behalf will be shared between clients, and will only be closed when ALL clients using them are closed.
* If you provide a resource (e.g. [HttpClientEngine]) to the SDK, you are responsible for managing the lifetime of that resource.
*/
public fun MigrationHubConfigClient.withConfig(block: MigrationHubConfigClient.Config.Builder.() -> Unit): MigrationHubConfigClient {
val newConfig = config.toBuilder().apply(block).build()
return DefaultMigrationHubConfigClient(newConfig)
}
/**
* This API sets up the home region for the calling account only.
*/
public suspend inline fun MigrationHubConfigClient.createHomeRegionControl(crossinline block: CreateHomeRegionControlRequest.Builder.() -> Unit): CreateHomeRegionControlResponse = createHomeRegionControl(CreateHomeRegionControlRequest.Builder().apply(block).build())
/**
* This operation deletes the home region configuration for the calling account. The operation does not delete discovery or migration tracking data in the home region.
*/
public suspend inline fun MigrationHubConfigClient.deleteHomeRegionControl(crossinline block: DeleteHomeRegionControlRequest.Builder.() -> Unit): DeleteHomeRegionControlResponse = deleteHomeRegionControl(DeleteHomeRegionControlRequest.Builder().apply(block).build())
/**
* This API permits filtering on the `ControlId` and `HomeRegion` fields.
*/
public suspend inline fun MigrationHubConfigClient.describeHomeRegionControls(crossinline block: DescribeHomeRegionControlsRequest.Builder.() -> Unit): DescribeHomeRegionControlsResponse = describeHomeRegionControls(DescribeHomeRegionControlsRequest.Builder().apply(block).build())
/**
* Returns the calling account’s home region, if configured. This API is used by other AWS services to determine the regional endpoint for calling AWS Application Discovery Service and Migration Hub. You must call `GetHomeRegion` at least once before you call any other AWS Application Discovery Service and AWS Migration Hub APIs, to obtain the account's Migration Hub home region.
*/
public suspend inline fun MigrationHubConfigClient.getHomeRegion(crossinline block: GetHomeRegionRequest.Builder.() -> Unit): GetHomeRegionResponse = getHomeRegion(GetHomeRegionRequest.Builder().apply(block).build())