migrationhubconfig/aws.sdk.kotlin.services.migrationhubconfig/MigrationHubConfigClient

MigrationHubConfigClient

interface MigrationHubConfigClient : SdkClient

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.

Types

Builder

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

Companion

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

Config

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

Properties

config

abstract override val config: MigrationHubConfigClient.Config

MigrationHubConfigClient's configuration

Functions

createHomeRegionControl

abstract suspend fun createHomeRegionControl(input: CreateHomeRegionControlRequest): CreateHomeRegionControlResponse

This API sets up the home region for the calling account only.

deleteHomeRegionControl

abstract suspend fun deleteHomeRegionControl(input: DeleteHomeRegionControlRequest): DeleteHomeRegionControlResponse

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.

describeHomeRegionControls

abstract suspend fun describeHomeRegionControls(input: DescribeHomeRegionControlsRequest = DescribeHomeRegionControlsRequest { }): DescribeHomeRegionControlsResponse

This API permits filtering on the ControlId and HomeRegion fields.

getHomeRegion

abstract suspend fun getHomeRegion(input: GetHomeRegionRequest = GetHomeRegionRequest { }): GetHomeRegionResponse

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.

Inherited functions

expect abstract fun close()

createHomeRegionControl

inline suspend fun MigrationHubConfigClient.createHomeRegionControl(crossinline block: CreateHomeRegionControlRequest.Builder.() -> Unit): CreateHomeRegionControlResponse

This API sets up the home region for the calling account only.

deleteHomeRegionControl

inline suspend fun MigrationHubConfigClient.deleteHomeRegionControl(crossinline block: DeleteHomeRegionControlRequest.Builder.() -> Unit): DeleteHomeRegionControlResponse

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.

describeHomeRegionControls

inline suspend fun MigrationHubConfigClient.describeHomeRegionControls(crossinline block: DescribeHomeRegionControlsRequest.Builder.() -> Unit): DescribeHomeRegionControlsResponse

This API permits filtering on the ControlId and HomeRegion fields.

describeHomeRegionControlsPaginated

fun MigrationHubConfigClient.describeHomeRegionControlsPaginated(initialRequest: DescribeHomeRegionControlsRequest = DescribeHomeRegionControlsRequest { }): Flow<DescribeHomeRegionControlsResponse>

fun MigrationHubConfigClient.describeHomeRegionControlsPaginated(block: DescribeHomeRegionControlsRequest.Builder.() -> Unit): Flow<DescribeHomeRegionControlsResponse>

Paginate over DescribeHomeRegionControlsResponse results.

getHomeRegion

inline suspend fun MigrationHubConfigClient.getHomeRegion(crossinline block: GetHomeRegionRequest.Builder.() -> Unit): GetHomeRegionResponse

withConfig

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

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.