migrationhuborchestrator/aws.sdk.kotlin.services.migrationhuborchestrator/MigrationHubOrchestratorClient

MigrationHubOrchestratorClient

interface MigrationHubOrchestratorClient : SdkClient

This API reference provides descriptions, syntax, and other details about each of the actions and data types for AWS Migration Hub Orchestrator. he topic for each action shows the API request parameters and the response. Alternatively, you can use one of the AWS SDKs to access an API that is tailored to the programming language or platform that you're using.

Properties

Link copied to clipboard
abstract override val config: MigrationHubOrchestratorClient.Config

MigrationHubOrchestratorClient's configuration

Functions

Link copied to clipboard
abstract suspend fun createWorkflow(input: CreateWorkflowRequest): CreateWorkflowResponse

Create a workflow to orchestrate your migrations.

Link copied to clipboard
abstract suspend fun createWorkflowStep(input: CreateWorkflowStepRequest): CreateWorkflowStepResponse

Create a step in the migration workflow.

Link copied to clipboard
abstract suspend fun createWorkflowStepGroup(input: CreateWorkflowStepGroupRequest): CreateWorkflowStepGroupResponse

Create a step group in a migration workflow.

Link copied to clipboard
abstract suspend fun deleteWorkflow(input: DeleteWorkflowRequest): DeleteWorkflowResponse

Delete a migration workflow. You must pause a running workflow in Migration Hub Orchestrator console to delete it.

Link copied to clipboard
abstract suspend fun deleteWorkflowStep(input: DeleteWorkflowStepRequest): DeleteWorkflowStepResponse

Delete a step in a migration workflow. Pause the workflow to delete a running step.

Link copied to clipboard
abstract suspend fun deleteWorkflowStepGroup(input: DeleteWorkflowStepGroupRequest): DeleteWorkflowStepGroupResponse

Delete a step group in a migration workflow.

Link copied to clipboard
abstract suspend fun getTemplate(input: GetTemplateRequest): GetTemplateResponse

Get the template you want to use for creating a migration workflow.

Link copied to clipboard
abstract suspend fun getTemplateStep(input: GetTemplateStepRequest): GetTemplateStepResponse

Get a specific step in a template.

Link copied to clipboard
abstract suspend fun getTemplateStepGroup(input: GetTemplateStepGroupRequest): GetTemplateStepGroupResponse

Get a step group in a template.

Link copied to clipboard
abstract suspend fun getWorkflow(input: GetWorkflowRequest): GetWorkflowResponse

Get migration workflow.

Link copied to clipboard
abstract suspend fun getWorkflowStep(input: GetWorkflowStepRequest): GetWorkflowStepResponse

Get a step in the migration workflow.

Link copied to clipboard
abstract suspend fun getWorkflowStepGroup(input: GetWorkflowStepGroupRequest): GetWorkflowStepGroupResponse

Get the step group of a migration workflow.

Link copied to clipboard
abstract suspend fun listPlugins(input: ListPluginsRequest = ListPluginsRequest { }): ListPluginsResponse

List AWS Migration Hub Orchestrator plugins.

Link copied to clipboard
abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

List the tags added to a resource.

Link copied to clipboard
abstract suspend fun listTemplates(input: ListTemplatesRequest = ListTemplatesRequest { }): ListTemplatesResponse

List the templates available in Migration Hub Orchestrator to create a migration workflow.

Link copied to clipboard
abstract suspend fun listTemplateStepGroups(input: ListTemplateStepGroupsRequest): ListTemplateStepGroupsResponse

List the step groups in a template.

Link copied to clipboard
abstract suspend fun listTemplateSteps(input: ListTemplateStepsRequest): ListTemplateStepsResponse

List the steps in a template.

Link copied to clipboard
abstract suspend fun listWorkflows(input: ListWorkflowsRequest = ListWorkflowsRequest { }): ListWorkflowsResponse

List the migration workflows.

Link copied to clipboard
abstract suspend fun listWorkflowStepGroups(input: ListWorkflowStepGroupsRequest): ListWorkflowStepGroupsResponse

List the step groups in a migration workflow.

Link copied to clipboard
abstract suspend fun listWorkflowSteps(input: ListWorkflowStepsRequest): ListWorkflowStepsResponse

List the steps in a workflow.

Link copied to clipboard
abstract suspend fun retryWorkflowStep(input: RetryWorkflowStepRequest): RetryWorkflowStepResponse

Retry a failed step in a migration workflow.

Link copied to clipboard
abstract suspend fun startWorkflow(input: StartWorkflowRequest): StartWorkflowResponse

Start a migration workflow.

Link copied to clipboard
abstract suspend fun stopWorkflow(input: StopWorkflowRequest): StopWorkflowResponse

Stop an ongoing migration workflow.

Link copied to clipboard
abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Tag a resource by specifying its Amazon Resource Name (ARN).

Link copied to clipboard
abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Deletes the tags for a resource.

Link copied to clipboard
abstract suspend fun updateWorkflow(input: UpdateWorkflowRequest): UpdateWorkflowResponse

Update a migration workflow.

Link copied to clipboard
abstract suspend fun updateWorkflowStep(input: UpdateWorkflowStepRequest): UpdateWorkflowStepResponse

Update a step in a migration workflow.

Link copied to clipboard
abstract suspend fun updateWorkflowStepGroup(input: UpdateWorkflowStepGroupRequest): UpdateWorkflowStepGroupResponse

Update the step group in a migration workflow.

Inherited functions

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard
inline suspend fun MigrationHubOrchestratorClient.createWorkflow(crossinline block: CreateWorkflowRequest.Builder.() -> Unit): CreateWorkflowResponse

Create a workflow to orchestrate your migrations.

Link copied to clipboard
inline suspend fun MigrationHubOrchestratorClient.createWorkflowStep(crossinline block: CreateWorkflowStepRequest.Builder.() -> Unit): CreateWorkflowStepResponse

Create a step in the migration workflow.

Link copied to clipboard
inline suspend fun MigrationHubOrchestratorClient.createWorkflowStepGroup(crossinline block: CreateWorkflowStepGroupRequest.Builder.() -> Unit): CreateWorkflowStepGroupResponse

Create a step group in a migration workflow.

Link copied to clipboard
inline suspend fun MigrationHubOrchestratorClient.deleteWorkflow(crossinline block: DeleteWorkflowRequest.Builder.() -> Unit): DeleteWorkflowResponse

Delete a migration workflow. You must pause a running workflow in Migration Hub Orchestrator console to delete it.

Link copied to clipboard
inline suspend fun MigrationHubOrchestratorClient.deleteWorkflowStep(crossinline block: DeleteWorkflowStepRequest.Builder.() -> Unit): DeleteWorkflowStepResponse

Delete a step in a migration workflow. Pause the workflow to delete a running step.

Link copied to clipboard
inline suspend fun MigrationHubOrchestratorClient.deleteWorkflowStepGroup(crossinline block: DeleteWorkflowStepGroupRequest.Builder.() -> Unit): DeleteWorkflowStepGroupResponse

Delete a step group in a migration workflow.

Link copied to clipboard
inline suspend fun MigrationHubOrchestratorClient.getTemplate(crossinline block: GetTemplateRequest.Builder.() -> Unit): GetTemplateResponse

Get the template you want to use for creating a migration workflow.

Link copied to clipboard
inline suspend fun MigrationHubOrchestratorClient.getTemplateStep(crossinline block: GetTemplateStepRequest.Builder.() -> Unit): GetTemplateStepResponse

Get a specific step in a template.

Link copied to clipboard
inline suspend fun MigrationHubOrchestratorClient.getTemplateStepGroup(crossinline block: GetTemplateStepGroupRequest.Builder.() -> Unit): GetTemplateStepGroupResponse

Get a step group in a template.

Link copied to clipboard
inline suspend fun MigrationHubOrchestratorClient.getWorkflow(crossinline block: GetWorkflowRequest.Builder.() -> Unit): GetWorkflowResponse

Get migration workflow.

Link copied to clipboard
inline suspend fun MigrationHubOrchestratorClient.getWorkflowStep(crossinline block: GetWorkflowStepRequest.Builder.() -> Unit): GetWorkflowStepResponse

Get a step in the migration workflow.

Link copied to clipboard
inline suspend fun MigrationHubOrchestratorClient.getWorkflowStepGroup(crossinline block: GetWorkflowStepGroupRequest.Builder.() -> Unit): GetWorkflowStepGroupResponse

Get the step group of a migration workflow.

Link copied to clipboard
inline suspend fun MigrationHubOrchestratorClient.listPlugins(crossinline block: ListPluginsRequest.Builder.() -> Unit): ListPluginsResponse

List AWS Migration Hub Orchestrator plugins.

Link copied to clipboard
inline suspend fun MigrationHubOrchestratorClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

List the tags added to a resource.

Link copied to clipboard
inline suspend fun MigrationHubOrchestratorClient.listTemplates(crossinline block: ListTemplatesRequest.Builder.() -> Unit): ListTemplatesResponse

List the templates available in Migration Hub Orchestrator to create a migration workflow.

Link copied to clipboard
inline suspend fun MigrationHubOrchestratorClient.listTemplateStepGroups(crossinline block: ListTemplateStepGroupsRequest.Builder.() -> Unit): ListTemplateStepGroupsResponse

List the step groups in a template.

Link copied to clipboard
inline suspend fun MigrationHubOrchestratorClient.listTemplateSteps(crossinline block: ListTemplateStepsRequest.Builder.() -> Unit): ListTemplateStepsResponse

List the steps in a template.

Link copied to clipboard
inline suspend fun MigrationHubOrchestratorClient.listWorkflows(crossinline block: ListWorkflowsRequest.Builder.() -> Unit): ListWorkflowsResponse

List the migration workflows.

Link copied to clipboard
inline suspend fun MigrationHubOrchestratorClient.listWorkflowStepGroups(crossinline block: ListWorkflowStepGroupsRequest.Builder.() -> Unit): ListWorkflowStepGroupsResponse

List the step groups in a migration workflow.

Link copied to clipboard
inline suspend fun MigrationHubOrchestratorClient.listWorkflowSteps(crossinline block: ListWorkflowStepsRequest.Builder.() -> Unit): ListWorkflowStepsResponse

List the steps in a workflow.

Link copied to clipboard
inline suspend fun MigrationHubOrchestratorClient.retryWorkflowStep(crossinline block: RetryWorkflowStepRequest.Builder.() -> Unit): RetryWorkflowStepResponse

Retry a failed step in a migration workflow.

Link copied to clipboard
inline suspend fun MigrationHubOrchestratorClient.startWorkflow(crossinline block: StartWorkflowRequest.Builder.() -> Unit): StartWorkflowResponse

Start a migration workflow.

Link copied to clipboard
inline suspend fun MigrationHubOrchestratorClient.stopWorkflow(crossinline block: StopWorkflowRequest.Builder.() -> Unit): StopWorkflowResponse

Stop an ongoing migration workflow.

Link copied to clipboard
inline suspend fun MigrationHubOrchestratorClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Tag a resource by specifying its Amazon Resource Name (ARN).

Link copied to clipboard
inline suspend fun MigrationHubOrchestratorClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Deletes the tags for a resource.

Link copied to clipboard
inline suspend fun MigrationHubOrchestratorClient.updateWorkflow(crossinline block: UpdateWorkflowRequest.Builder.() -> Unit): UpdateWorkflowResponse

Update a migration workflow.

Link copied to clipboard
inline suspend fun MigrationHubOrchestratorClient.updateWorkflowStep(crossinline block: UpdateWorkflowStepRequest.Builder.() -> Unit): UpdateWorkflowStepResponse

Update a step in a migration workflow.

Link copied to clipboard
inline suspend fun MigrationHubOrchestratorClient.updateWorkflowStepGroup(crossinline block: UpdateWorkflowStepGroupRequest.Builder.() -> Unit): UpdateWorkflowStepGroupResponse

Update the step group in a migration workflow.

Link copied to clipboard
fun MigrationHubOrchestratorClient.withConfig(block: MigrationHubOrchestratorClient.Config.Builder.() -> Unit): MigrationHubOrchestratorClient

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.