migrationhuborchestrator/aws.sdk.kotlin.services.migrationhuborchestrator

Package-level declarations

Types

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. The topic for each action shows the API request parameters and responses. 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

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

createTemplate

inline suspend fun MigrationHubOrchestratorClient.createTemplate(crossinline block: CreateTemplateRequest.Builder.() -> Unit): CreateTemplateResponse

Creates a migration workflow template.

createWorkflow

inline suspend fun MigrationHubOrchestratorClient.createWorkflow(crossinline block: CreateWorkflowRequest.Builder.() -> Unit): CreateWorkflowResponse

Create a workflow to orchestrate your migrations.

createWorkflowStep

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

Create a step in the migration workflow.

createWorkflowStepGroup

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

Create a step group in a migration workflow.

deleteTemplate

inline suspend fun MigrationHubOrchestratorClient.deleteTemplate(crossinline block: DeleteTemplateRequest.Builder.() -> Unit): DeleteTemplateResponse

Deletes a migration workflow template.

deleteWorkflow

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.

deleteWorkflowStep

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.

deleteWorkflowStepGroup

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

Delete a step group in a migration workflow.

getTemplate

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

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

getTemplateStep

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

Get a specific step in a template.

getTemplateStepGroup

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

Get a step group in a template.

getWorkflow

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

Get migration workflow.

getWorkflowStep

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

Get a step in the migration workflow.

getWorkflowStepGroup

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

Get the step group of a migration workflow.

listPlugins

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

List AWS Migration Hub Orchestrator plugins.

listTagsForResource

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

List the tags added to a resource.

listTemplates

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

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

listTemplateStepGroups

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

List the step groups in a template.

listTemplateSteps

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

List the steps in a template.

listWorkflows

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

List the migration workflows.

listWorkflowStepGroups

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

List the step groups in a migration workflow.

listWorkflowSteps

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

List the steps in a workflow.

retryWorkflowStep

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

Retry a failed step in a migration workflow.

startWorkflow

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

Start a migration workflow.

stopWorkflow

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

Stop an ongoing migration workflow.

tagResource

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

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

untagResource

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

Deletes the tags for a resource.

updateTemplate

inline suspend fun MigrationHubOrchestratorClient.updateTemplate(crossinline block: UpdateTemplateRequest.Builder.() -> Unit): UpdateTemplateResponse

Updates a migration workflow template.

updateWorkflow

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

Update a migration workflow.

updateWorkflowStep

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

Update a step in a migration workflow.

updateWorkflowStepGroup

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

Update the step group in a migration workflow.

withConfig

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.