migrationhub/aws.sdk.kotlin.services.migrationhub/MigrationHubClient

MigrationHubClient

interface MigrationHubClient : SdkClient

The AWS Migration Hub API methods help to obtain server and application migration status and integrate your resource-specific migration tool by providing a programmatic interface to Migration Hub.

Remember that you must set your AWS Migration Hub home region before you call any of these APIs, or a HomeRegionNotSetException error will be returned. Also, you must make the API calls while in your home region.

Types

Builder

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

Companion

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

Config

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

Properties

config

abstract override val config: MigrationHubClient.Config

MigrationHubClient's configuration

Functions

associateCreatedArtifact

abstract suspend fun associateCreatedArtifact(input: AssociateCreatedArtifactRequest): AssociateCreatedArtifactResponse

Associates a created artifact of an AWS cloud resource, the target receiving the migration, with the migration task performed by a migration tool. This API has the following traits:

associateDiscoveredResource

abstract suspend fun associateDiscoveredResource(input: AssociateDiscoveredResourceRequest): AssociateDiscoveredResourceResponse

Associates a discovered resource ID from Application Discovery Service with a migration task.

associateSourceResource

abstract suspend fun associateSourceResource(input: AssociateSourceResourceRequest): AssociateSourceResourceResponse

Associates a source resource with a migration task. For example, the source resource can be a source server, an application, or a migration wave.

createProgressUpdateStream

abstract suspend fun createProgressUpdateStream(input: CreateProgressUpdateStreamRequest): CreateProgressUpdateStreamResponse

Creates a progress update stream which is an AWS resource used for access control as well as a namespace for migration task names that is implicitly linked to your AWS account. It must uniquely identify the migration tool as it is used for all updates made by the tool; however, it does not need to be unique for each AWS account because it is scoped to the AWS account.

deleteProgressUpdateStream

abstract suspend fun deleteProgressUpdateStream(input: DeleteProgressUpdateStreamRequest): DeleteProgressUpdateStreamResponse

Deletes a progress update stream, including all of its tasks, which was previously created as an AWS resource used for access control. This API has the following traits:

describeApplicationState

abstract suspend fun describeApplicationState(input: DescribeApplicationStateRequest): DescribeApplicationStateResponse

Gets the migration status of an application.

describeMigrationTask

abstract suspend fun describeMigrationTask(input: DescribeMigrationTaskRequest): DescribeMigrationTaskResponse

Retrieves a list of all attributes associated with a specific migration task.

disassociateCreatedArtifact

abstract suspend fun disassociateCreatedArtifact(input: DisassociateCreatedArtifactRequest): DisassociateCreatedArtifactResponse

Disassociates a created artifact of an AWS resource with a migration task performed by a migration tool that was previously associated. This API has the following traits:

disassociateDiscoveredResource

abstract suspend fun disassociateDiscoveredResource(input: DisassociateDiscoveredResourceRequest): DisassociateDiscoveredResourceResponse

Disassociate an Application Discovery Service discovered resource from a migration task.

disassociateSourceResource

abstract suspend fun disassociateSourceResource(input: DisassociateSourceResourceRequest): DisassociateSourceResourceResponse

Removes the association between a source resource and a migration task.

importMigrationTask

abstract suspend fun importMigrationTask(input: ImportMigrationTaskRequest): ImportMigrationTaskResponse

Registers a new migration task which represents a server, database, etc., being migrated to AWS by a migration tool.

listApplicationStates

abstract suspend fun listApplicationStates(input: ListApplicationStatesRequest = ListApplicationStatesRequest { }): ListApplicationStatesResponse

Lists all the migration statuses for your applications. If you use the optional ApplicationIds parameter, only the migration statuses for those applications will be returned.

listCreatedArtifacts

abstract suspend fun listCreatedArtifacts(input: ListCreatedArtifactsRequest): ListCreatedArtifactsResponse

Lists the created artifacts attached to a given migration task in an update stream. This API has the following traits:

listDiscoveredResources

abstract suspend fun listDiscoveredResources(input: ListDiscoveredResourcesRequest): ListDiscoveredResourcesResponse

Lists discovered resources associated with the given MigrationTask.

listMigrationTasks

abstract suspend fun listMigrationTasks(input: ListMigrationTasksRequest = ListMigrationTasksRequest { }): ListMigrationTasksResponse

Lists all, or filtered by resource name, migration tasks associated with the user account making this call. This API has the following traits:

listMigrationTaskUpdates

abstract suspend fun listMigrationTaskUpdates(input: ListMigrationTaskUpdatesRequest): ListMigrationTaskUpdatesResponse

This is a paginated API that returns all the migration-task states for the specified MigrationTaskName and ProgressUpdateStream.

listProgressUpdateStreams

abstract suspend fun listProgressUpdateStreams(input: ListProgressUpdateStreamsRequest = ListProgressUpdateStreamsRequest { }): ListProgressUpdateStreamsResponse

Lists progress update streams associated with the user account making this call.

listSourceResources

abstract suspend fun listSourceResources(input: ListSourceResourcesRequest): ListSourceResourcesResponse

Lists all the source resource that are associated with the specified MigrationTaskName and ProgressUpdateStream.

notifyApplicationState

abstract suspend fun notifyApplicationState(input: NotifyApplicationStateRequest): NotifyApplicationStateResponse

Sets the migration state of an application. For a given application identified by the value passed to ApplicationId, its status is set or updated by passing one of three values to Status: NOT_STARTED | IN_PROGRESS | COMPLETED.

notifyMigrationTaskState

abstract suspend fun notifyMigrationTaskState(input: NotifyMigrationTaskStateRequest): NotifyMigrationTaskStateResponse

Notifies Migration Hub of the current status, progress, or other detail regarding a migration task. This API has the following traits:

putResourceAttributes

abstract suspend fun putResourceAttributes(input: PutResourceAttributesRequest): PutResourceAttributesResponse

Provides identifying details of the resource being migrated so that it can be associated in the Application Discovery Service repository. This association occurs asynchronously after PutResourceAttributes returns.

Inherited functions

associateCreatedArtifact

inline suspend fun MigrationHubClient.associateCreatedArtifact(crossinline block: AssociateCreatedArtifactRequest.Builder.() -> Unit): AssociateCreatedArtifactResponse

Associates a created artifact of an AWS cloud resource, the target receiving the migration, with the migration task performed by a migration tool. This API has the following traits:

associateDiscoveredResource

inline suspend fun MigrationHubClient.associateDiscoveredResource(crossinline block: AssociateDiscoveredResourceRequest.Builder.() -> Unit): AssociateDiscoveredResourceResponse

Associates a discovered resource ID from Application Discovery Service with a migration task.

associateSourceResource

inline suspend fun MigrationHubClient.associateSourceResource(crossinline block: AssociateSourceResourceRequest.Builder.() -> Unit): AssociateSourceResourceResponse

Associates a source resource with a migration task. For example, the source resource can be a source server, an application, or a migration wave.

expect abstract fun close()

createProgressUpdateStream

inline suspend fun MigrationHubClient.createProgressUpdateStream(crossinline block: CreateProgressUpdateStreamRequest.Builder.() -> Unit): CreateProgressUpdateStreamResponse

deleteProgressUpdateStream

inline suspend fun MigrationHubClient.deleteProgressUpdateStream(crossinline block: DeleteProgressUpdateStreamRequest.Builder.() -> Unit): DeleteProgressUpdateStreamResponse

Deletes a progress update stream, including all of its tasks, which was previously created as an AWS resource used for access control. This API has the following traits:

describeApplicationState

inline suspend fun MigrationHubClient.describeApplicationState(crossinline block: DescribeApplicationStateRequest.Builder.() -> Unit): DescribeApplicationStateResponse

Gets the migration status of an application.

describeMigrationTask

inline suspend fun MigrationHubClient.describeMigrationTask(crossinline block: DescribeMigrationTaskRequest.Builder.() -> Unit): DescribeMigrationTaskResponse

Retrieves a list of all attributes associated with a specific migration task.

disassociateCreatedArtifact

inline suspend fun MigrationHubClient.disassociateCreatedArtifact(crossinline block: DisassociateCreatedArtifactRequest.Builder.() -> Unit): DisassociateCreatedArtifactResponse

Disassociates a created artifact of an AWS resource with a migration task performed by a migration tool that was previously associated. This API has the following traits:

disassociateDiscoveredResource

inline suspend fun MigrationHubClient.disassociateDiscoveredResource(crossinline block: DisassociateDiscoveredResourceRequest.Builder.() -> Unit): DisassociateDiscoveredResourceResponse

Disassociate an Application Discovery Service discovered resource from a migration task.

disassociateSourceResource

inline suspend fun MigrationHubClient.disassociateSourceResource(crossinline block: DisassociateSourceResourceRequest.Builder.() -> Unit): DisassociateSourceResourceResponse

Removes the association between a source resource and a migration task.

importMigrationTask

inline suspend fun MigrationHubClient.importMigrationTask(crossinline block: ImportMigrationTaskRequest.Builder.() -> Unit): ImportMigrationTaskResponse

Registers a new migration task which represents a server, database, etc., being migrated to AWS by a migration tool.

listApplicationStates

inline suspend fun MigrationHubClient.listApplicationStates(crossinline block: ListApplicationStatesRequest.Builder.() -> Unit): ListApplicationStatesResponse

Lists all the migration statuses for your applications. If you use the optional ApplicationIds parameter, only the migration statuses for those applications will be returned.

listApplicationStatesPaginated

fun MigrationHubClient.listApplicationStatesPaginated(initialRequest: ListApplicationStatesRequest = ListApplicationStatesRequest { }): Flow<ListApplicationStatesResponse>

fun MigrationHubClient.listApplicationStatesPaginated(block: ListApplicationStatesRequest.Builder.() -> Unit): Flow<ListApplicationStatesResponse>

Paginate over ListApplicationStatesResponse results.

listCreatedArtifacts

inline suspend fun MigrationHubClient.listCreatedArtifacts(crossinline block: ListCreatedArtifactsRequest.Builder.() -> Unit): ListCreatedArtifactsResponse

Lists the created artifacts attached to a given migration task in an update stream. This API has the following traits:

listCreatedArtifactsPaginated

fun MigrationHubClient.listCreatedArtifactsPaginated(initialRequest: ListCreatedArtifactsRequest): Flow<ListCreatedArtifactsResponse>

fun MigrationHubClient.listCreatedArtifactsPaginated(block: ListCreatedArtifactsRequest.Builder.() -> Unit): Flow<ListCreatedArtifactsResponse>

Paginate over ListCreatedArtifactsResponse results.

listDiscoveredResources

inline suspend fun MigrationHubClient.listDiscoveredResources(crossinline block: ListDiscoveredResourcesRequest.Builder.() -> Unit): ListDiscoveredResourcesResponse

Lists discovered resources associated with the given MigrationTask.

listDiscoveredResourcesPaginated

fun MigrationHubClient.listDiscoveredResourcesPaginated(initialRequest: ListDiscoveredResourcesRequest): Flow<ListDiscoveredResourcesResponse>

fun MigrationHubClient.listDiscoveredResourcesPaginated(block: ListDiscoveredResourcesRequest.Builder.() -> Unit): Flow<ListDiscoveredResourcesResponse>

Paginate over ListDiscoveredResourcesResponse results.

listMigrationTasks

inline suspend fun MigrationHubClient.listMigrationTasks(crossinline block: ListMigrationTasksRequest.Builder.() -> Unit): ListMigrationTasksResponse

Lists all, or filtered by resource name, migration tasks associated with the user account making this call. This API has the following traits:

listMigrationTasksPaginated

fun MigrationHubClient.listMigrationTasksPaginated(initialRequest: ListMigrationTasksRequest = ListMigrationTasksRequest { }): Flow<ListMigrationTasksResponse>

fun MigrationHubClient.listMigrationTasksPaginated(block: ListMigrationTasksRequest.Builder.() -> Unit): Flow<ListMigrationTasksResponse>

Paginate over ListMigrationTasksResponse results.

listMigrationTaskUpdates

inline suspend fun MigrationHubClient.listMigrationTaskUpdates(crossinline block: ListMigrationTaskUpdatesRequest.Builder.() -> Unit): ListMigrationTaskUpdatesResponse

This is a paginated API that returns all the migration-task states for the specified MigrationTaskName and ProgressUpdateStream.

listMigrationTaskUpdatesPaginated

fun MigrationHubClient.listMigrationTaskUpdatesPaginated(initialRequest: ListMigrationTaskUpdatesRequest): Flow<ListMigrationTaskUpdatesResponse>

fun MigrationHubClient.listMigrationTaskUpdatesPaginated(block: ListMigrationTaskUpdatesRequest.Builder.() -> Unit): Flow<ListMigrationTaskUpdatesResponse>

Paginate over ListMigrationTaskUpdatesResponse results.

listProgressUpdateStreams

inline suspend fun MigrationHubClient.listProgressUpdateStreams(crossinline block: ListProgressUpdateStreamsRequest.Builder.() -> Unit): ListProgressUpdateStreamsResponse

Lists progress update streams associated with the user account making this call.

listProgressUpdateStreamsPaginated

fun MigrationHubClient.listProgressUpdateStreamsPaginated(initialRequest: ListProgressUpdateStreamsRequest = ListProgressUpdateStreamsRequest { }): Flow<ListProgressUpdateStreamsResponse>

fun MigrationHubClient.listProgressUpdateStreamsPaginated(block: ListProgressUpdateStreamsRequest.Builder.() -> Unit): Flow<ListProgressUpdateStreamsResponse>

Paginate over ListProgressUpdateStreamsResponse results.

listSourceResources

inline suspend fun MigrationHubClient.listSourceResources(crossinline block: ListSourceResourcesRequest.Builder.() -> Unit): ListSourceResourcesResponse

Lists all the source resource that are associated with the specified MigrationTaskName and ProgressUpdateStream.

listSourceResourcesPaginated

fun MigrationHubClient.listSourceResourcesPaginated(initialRequest: ListSourceResourcesRequest): Flow<ListSourceResourcesResponse>

fun MigrationHubClient.listSourceResourcesPaginated(block: ListSourceResourcesRequest.Builder.() -> Unit): Flow<ListSourceResourcesResponse>

Paginate over ListSourceResourcesResponse results.

notifyApplicationState

inline suspend fun MigrationHubClient.notifyApplicationState(crossinline block: NotifyApplicationStateRequest.Builder.() -> Unit): NotifyApplicationStateResponse

notifyMigrationTaskState

inline suspend fun MigrationHubClient.notifyMigrationTaskState(crossinline block: NotifyMigrationTaskStateRequest.Builder.() -> Unit): NotifyMigrationTaskStateResponse

Notifies Migration Hub of the current status, progress, or other detail regarding a migration task. This API has the following traits:

putResourceAttributes

inline suspend fun MigrationHubClient.putResourceAttributes(crossinline block: PutResourceAttributesRequest.Builder.() -> Unit): PutResourceAttributesResponse

withConfig

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

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.