MigrationHubOrchestratorClient

Index > MigrationHubOrchestrator > MigrationHubOrchestratorClient

Auto-generated documentation for MigrationHubOrchestrator type annotations stubs module mypy-boto3-migrationhuborchestrator.

MigrationHubOrchestratorClient

Type annotations and code completion for boto3.client("migrationhuborchestrator"). boto3 documentation

Usage example

from boto3.session import Session
from mypy_boto3_migrationhuborchestrator.client import MigrationHubOrchestratorClient

def get_migrationhuborchestrator_client() -> MigrationHubOrchestratorClient:
    return Session().client("migrationhuborchestrator")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("migrationhuborchestrator").exceptions structure.

Usage example

client = boto3.client("migrationhuborchestrator")

try:
    do_something(client)
except (
    client.AccessDeniedException,
    client.ClientError,
    client.InternalServerException,
    client.ResourceNotFoundException,
    client.ThrottlingException,
    client.ValidationException,
) as e:
    print(e)

Type checking example

from mypy_boto3_migrationhuborchestrator.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("migrationhuborchestrator").can_paginate method. boto3 documentation

Method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("migrationhuborchestrator").close method. boto3 documentation

Method definition

def close(
    self,
) -> None:
    ...

create_workflow

Create a workflow to orchestrate your migrations.

Type annotations and code completion for boto3.client("migrationhuborchestrator").create_workflow method. boto3 documentation

Method definition

def create_workflow(
    self,
    *,
    name: str,
    templateId: str,
    applicationConfigurationId: str,
    inputParameters: Mapping[str, StepInputTypeDef],  # (1)
    description: str = ...,
    stepTargets: Sequence[str] = ...,
    tags: Mapping[str, str] = ...,
) -> CreateMigrationWorkflowResponseTypeDef:  # (2)
    ...

1. See StepInputTypeDef
2. See CreateMigrationWorkflowResponseTypeDef

Usage example with kwargs

kwargs: CreateMigrationWorkflowRequestRequestTypeDef = {  # (1)
    "name": ...,
    "templateId": ...,
    "applicationConfigurationId": ...,
    "inputParameters": ...,
}

parent.create_workflow(**kwargs)

1. See CreateMigrationWorkflowRequestRequestTypeDef

create_workflow_step

Create a step in the migration workflow.

Type annotations and code completion for boto3.client("migrationhuborchestrator").create_workflow_step method. boto3 documentation

Method definition

def create_workflow_step(
    self,
    *,
    name: str,
    stepGroupId: str,
    workflowId: str,
    stepActionType: StepActionTypeType,  # (1)
    description: str = ...,
    workflowStepAutomationConfiguration: WorkflowStepAutomationConfigurationTypeDef = ...,  # (2)
    stepTarget: Sequence[str] = ...,
    outputs: Sequence[WorkflowStepOutputTypeDef] = ...,  # (3)
    previous: Sequence[str] = ...,
    next: Sequence[str] = ...,
) -> CreateWorkflowStepResponseTypeDef:  # (4)
    ...

1. See StepActionTypeType
2. See WorkflowStepAutomationConfigurationTypeDef
3. See WorkflowStepOutputTypeDef
4. See CreateWorkflowStepResponseTypeDef

Usage example with kwargs

kwargs: CreateWorkflowStepRequestRequestTypeDef = {  # (1)
    "name": ...,
    "stepGroupId": ...,
    "workflowId": ...,
    "stepActionType": ...,
}

parent.create_workflow_step(**kwargs)

1. See CreateWorkflowStepRequestRequestTypeDef

create_workflow_step_group

Create a step group in a migration workflow.

Type annotations and code completion for boto3.client("migrationhuborchestrator").create_workflow_step_group method. boto3 documentation

Method definition

def create_workflow_step_group(
    self,
    *,
    workflowId: str,
    name: str,
    description: str = ...,
    next: Sequence[str] = ...,
    previous: Sequence[str] = ...,
) -> CreateWorkflowStepGroupResponseTypeDef:  # (1)
    ...

1. See CreateWorkflowStepGroupResponseTypeDef

Usage example with kwargs

kwargs: CreateWorkflowStepGroupRequestRequestTypeDef = {  # (1)
    "workflowId": ...,
    "name": ...,
}

parent.create_workflow_step_group(**kwargs)

1. See CreateWorkflowStepGroupRequestRequestTypeDef

delete_workflow

Delete a migration workflow.

Type annotations and code completion for boto3.client("migrationhuborchestrator").delete_workflow method. boto3 documentation

Method definition

def delete_workflow(
    self,
    *,
    id: str,
) -> DeleteMigrationWorkflowResponseTypeDef:  # (1)
    ...

1. See DeleteMigrationWorkflowResponseTypeDef

Usage example with kwargs

kwargs: DeleteMigrationWorkflowRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.delete_workflow(**kwargs)

1. See DeleteMigrationWorkflowRequestRequestTypeDef

delete_workflow_step

Delete a step in a migration workflow.

Type annotations and code completion for boto3.client("migrationhuborchestrator").delete_workflow_step method. boto3 documentation

Method definition

def delete_workflow_step(
    self,
    *,
    id: str,
    stepGroupId: str,
    workflowId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DeleteWorkflowStepRequestRequestTypeDef = {  # (1)
    "id": ...,
    "stepGroupId": ...,
    "workflowId": ...,
}

parent.delete_workflow_step(**kwargs)

1. See DeleteWorkflowStepRequestRequestTypeDef

delete_workflow_step_group

Delete a step group in a migration workflow.

Type annotations and code completion for boto3.client("migrationhuborchestrator").delete_workflow_step_group method. boto3 documentation

Method definition

def delete_workflow_step_group(
    self,
    *,
    workflowId: str,
    id: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DeleteWorkflowStepGroupRequestRequestTypeDef = {  # (1)
    "workflowId": ...,
    "id": ...,
}

parent.delete_workflow_step_group(**kwargs)

1. See DeleteWorkflowStepGroupRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("migrationhuborchestrator").generate_presigned_url method. boto3 documentation

Method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_template

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

Type annotations and code completion for boto3.client("migrationhuborchestrator").get_template method. boto3 documentation

Method definition

def get_template(
    self,
    *,
    id: str,
) -> GetMigrationWorkflowTemplateResponseTypeDef:  # (1)
    ...

1. See GetMigrationWorkflowTemplateResponseTypeDef

Usage example with kwargs

kwargs: GetMigrationWorkflowTemplateRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.get_template(**kwargs)

1. See GetMigrationWorkflowTemplateRequestRequestTypeDef

get_template_step

Get a specific step in a template.

Type annotations and code completion for boto3.client("migrationhuborchestrator").get_template_step method. boto3 documentation

Method definition

def get_template_step(
    self,
    *,
    id: str,
    templateId: str,
    stepGroupId: str,
) -> GetTemplateStepResponseTypeDef:  # (1)
    ...

1. See GetTemplateStepResponseTypeDef

Usage example with kwargs

kwargs: GetTemplateStepRequestRequestTypeDef = {  # (1)
    "id": ...,
    "templateId": ...,
    "stepGroupId": ...,
}

parent.get_template_step(**kwargs)

1. See GetTemplateStepRequestRequestTypeDef

get_template_step_group

Get a step group in a template.

Type annotations and code completion for boto3.client("migrationhuborchestrator").get_template_step_group method. boto3 documentation

Method definition

def get_template_step_group(
    self,
    *,
    templateId: str,
    id: str,
) -> GetTemplateStepGroupResponseTypeDef:  # (1)
    ...

1. See GetTemplateStepGroupResponseTypeDef

Usage example with kwargs

kwargs: GetTemplateStepGroupRequestRequestTypeDef = {  # (1)
    "templateId": ...,
    "id": ...,
}

parent.get_template_step_group(**kwargs)

1. See GetTemplateStepGroupRequestRequestTypeDef

get_workflow

Get migration workflow.

Type annotations and code completion for boto3.client("migrationhuborchestrator").get_workflow method. boto3 documentation

Method definition

def get_workflow(
    self,
    *,
    id: str,
) -> GetMigrationWorkflowResponseTypeDef:  # (1)
    ...

1. See GetMigrationWorkflowResponseTypeDef

Usage example with kwargs

kwargs: GetMigrationWorkflowRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.get_workflow(**kwargs)

1. See GetMigrationWorkflowRequestRequestTypeDef

get_workflow_step

Get a step in the migration workflow.

Type annotations and code completion for boto3.client("migrationhuborchestrator").get_workflow_step method. boto3 documentation

Method definition

def get_workflow_step(
    self,
    *,
    workflowId: str,
    stepGroupId: str,
    id: str,
) -> GetWorkflowStepResponseTypeDef:  # (1)
    ...

1. See GetWorkflowStepResponseTypeDef

Usage example with kwargs

kwargs: GetWorkflowStepRequestRequestTypeDef = {  # (1)
    "workflowId": ...,
    "stepGroupId": ...,
    "id": ...,
}

parent.get_workflow_step(**kwargs)

1. See GetWorkflowStepRequestRequestTypeDef

get_workflow_step_group

Get the step group of a migration workflow.

Type annotations and code completion for boto3.client("migrationhuborchestrator").get_workflow_step_group method. boto3 documentation

Method definition

def get_workflow_step_group(
    self,
    *,
    id: str,
    workflowId: str,
) -> GetWorkflowStepGroupResponseTypeDef:  # (1)
    ...

1. See GetWorkflowStepGroupResponseTypeDef

Usage example with kwargs

kwargs: GetWorkflowStepGroupRequestRequestTypeDef = {  # (1)
    "id": ...,
    "workflowId": ...,
}

parent.get_workflow_step_group(**kwargs)

1. See GetWorkflowStepGroupRequestRequestTypeDef

list_plugins

List AWS Migration Hub Orchestrator plugins.

Type annotations and code completion for boto3.client("migrationhuborchestrator").list_plugins method. boto3 documentation

Method definition

def list_plugins(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListPluginsResponseTypeDef:  # (1)
    ...

1. See ListPluginsResponseTypeDef

Usage example with kwargs

kwargs: ListPluginsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_plugins(**kwargs)

1. See ListPluginsRequestRequestTypeDef

list_tags_for_resource

List the tags added to a resource.

Type annotations and code completion for boto3.client("migrationhuborchestrator").list_tags_for_resource method. boto3 documentation

Method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

Usage example with kwargs

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

list_template_step_groups

List the step groups in a template.

Type annotations and code completion for boto3.client("migrationhuborchestrator").list_template_step_groups method. boto3 documentation

Method definition

def list_template_step_groups(
    self,
    *,
    templateId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListTemplateStepGroupsResponseTypeDef:  # (1)
    ...

1. See ListTemplateStepGroupsResponseTypeDef

Usage example with kwargs

kwargs: ListTemplateStepGroupsRequestRequestTypeDef = {  # (1)
    "templateId": ...,
}

parent.list_template_step_groups(**kwargs)

1. See ListTemplateStepGroupsRequestRequestTypeDef

list_template_steps

List the steps in a template.

Type annotations and code completion for boto3.client("migrationhuborchestrator").list_template_steps method. boto3 documentation

Method definition

def list_template_steps(
    self,
    *,
    templateId: str,
    stepGroupId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListTemplateStepsResponseTypeDef:  # (1)
    ...

1. See ListTemplateStepsResponseTypeDef

Usage example with kwargs

kwargs: ListTemplateStepsRequestRequestTypeDef = {  # (1)
    "templateId": ...,
    "stepGroupId": ...,
}

parent.list_template_steps(**kwargs)

1. See ListTemplateStepsRequestRequestTypeDef

list_templates

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

Type annotations and code completion for boto3.client("migrationhuborchestrator").list_templates method. boto3 documentation

Method definition

def list_templates(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
    name: str = ...,
) -> ListMigrationWorkflowTemplatesResponseTypeDef:  # (1)
    ...

1. See ListMigrationWorkflowTemplatesResponseTypeDef

Usage example with kwargs

kwargs: ListMigrationWorkflowTemplatesRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_templates(**kwargs)

1. See ListMigrationWorkflowTemplatesRequestRequestTypeDef

list_workflow_step_groups

List the step groups in a migration workflow.

Type annotations and code completion for boto3.client("migrationhuborchestrator").list_workflow_step_groups method. boto3 documentation

Method definition

def list_workflow_step_groups(
    self,
    *,
    workflowId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListWorkflowStepGroupsResponseTypeDef:  # (1)
    ...

1. See ListWorkflowStepGroupsResponseTypeDef

Usage example with kwargs

kwargs: ListWorkflowStepGroupsRequestRequestTypeDef = {  # (1)
    "workflowId": ...,
}

parent.list_workflow_step_groups(**kwargs)

1. See ListWorkflowStepGroupsRequestRequestTypeDef

list_workflow_steps

List the steps in a workflow.

Type annotations and code completion for boto3.client("migrationhuborchestrator").list_workflow_steps method. boto3 documentation

Method definition

def list_workflow_steps(
    self,
    *,
    workflowId: str,
    stepGroupId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListWorkflowStepsResponseTypeDef:  # (1)
    ...

1. See ListWorkflowStepsResponseTypeDef

Usage example with kwargs

kwargs: ListWorkflowStepsRequestRequestTypeDef = {  # (1)
    "workflowId": ...,
    "stepGroupId": ...,
}

parent.list_workflow_steps(**kwargs)

1. See ListWorkflowStepsRequestRequestTypeDef

list_workflows

List the migration workflows.

Type annotations and code completion for boto3.client("migrationhuborchestrator").list_workflows method. boto3 documentation

Method definition

def list_workflows(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
    templateId: str = ...,
    adsApplicationConfigurationName: str = ...,
    status: MigrationWorkflowStatusEnumType = ...,  # (1)
    name: str = ...,
) -> ListMigrationWorkflowsResponseTypeDef:  # (2)
    ...

1. See MigrationWorkflowStatusEnumType
2. See ListMigrationWorkflowsResponseTypeDef

Usage example with kwargs

kwargs: ListMigrationWorkflowsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_workflows(**kwargs)

1. See ListMigrationWorkflowsRequestRequestTypeDef

retry_workflow_step

Retry a failed step in a migration workflow.

Type annotations and code completion for boto3.client("migrationhuborchestrator").retry_workflow_step method. boto3 documentation

Method definition

def retry_workflow_step(
    self,
    *,
    workflowId: str,
    stepGroupId: str,
    id: str,
) -> RetryWorkflowStepResponseTypeDef:  # (1)
    ...

1. See RetryWorkflowStepResponseTypeDef

Usage example with kwargs

kwargs: RetryWorkflowStepRequestRequestTypeDef = {  # (1)
    "workflowId": ...,
    "stepGroupId": ...,
    "id": ...,
}

parent.retry_workflow_step(**kwargs)

1. See RetryWorkflowStepRequestRequestTypeDef

start_workflow

Start a migration workflow.

Type annotations and code completion for boto3.client("migrationhuborchestrator").start_workflow method. boto3 documentation

Method definition

def start_workflow(
    self,
    *,
    id: str,
) -> StartMigrationWorkflowResponseTypeDef:  # (1)
    ...

1. See StartMigrationWorkflowResponseTypeDef

Usage example with kwargs

kwargs: StartMigrationWorkflowRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.start_workflow(**kwargs)

1. See StartMigrationWorkflowRequestRequestTypeDef

stop_workflow

Stop an ongoing migration workflow.

Type annotations and code completion for boto3.client("migrationhuborchestrator").stop_workflow method. boto3 documentation

Method definition

def stop_workflow(
    self,
    *,
    id: str,
) -> StopMigrationWorkflowResponseTypeDef:  # (1)
    ...

1. See StopMigrationWorkflowResponseTypeDef

Usage example with kwargs

kwargs: StopMigrationWorkflowRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.stop_workflow(**kwargs)

1. See StopMigrationWorkflowRequestRequestTypeDef

tag_resource

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

Type annotations and code completion for boto3.client("migrationhuborchestrator").tag_resource method. boto3 documentation

Method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Deletes the tags for a resource.

Type annotations and code completion for boto3.client("migrationhuborchestrator").untag_resource method. boto3 documentation

Method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_workflow

Update a migration workflow.

Type annotations and code completion for boto3.client("migrationhuborchestrator").update_workflow method. boto3 documentation

Method definition

def update_workflow(
    self,
    *,
    id: str,
    name: str = ...,
    description: str = ...,
    inputParameters: Mapping[str, StepInputTypeDef] = ...,  # (1)
    stepTargets: Sequence[str] = ...,
) -> UpdateMigrationWorkflowResponseTypeDef:  # (2)
    ...

1. See StepInputTypeDef
2. See UpdateMigrationWorkflowResponseTypeDef

Usage example with kwargs

kwargs: UpdateMigrationWorkflowRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.update_workflow(**kwargs)

1. See UpdateMigrationWorkflowRequestRequestTypeDef

update_workflow_step

Update a step in a migration workflow.

Type annotations and code completion for boto3.client("migrationhuborchestrator").update_workflow_step method. boto3 documentation

Method definition

def update_workflow_step(
    self,
    *,
    id: str,
    stepGroupId: str,
    workflowId: str,
    name: str = ...,
    description: str = ...,
    stepActionType: StepActionTypeType = ...,  # (1)
    workflowStepAutomationConfiguration: WorkflowStepAutomationConfigurationTypeDef = ...,  # (2)
    stepTarget: Sequence[str] = ...,
    outputs: Sequence[WorkflowStepOutputTypeDef] = ...,  # (3)
    previous: Sequence[str] = ...,
    next: Sequence[str] = ...,
    status: StepStatusType = ...,  # (4)
) -> UpdateWorkflowStepResponseTypeDef:  # (5)
    ...

1. See StepActionTypeType
2. See WorkflowStepAutomationConfigurationTypeDef
3. See WorkflowStepOutputTypeDef
4. See StepStatusType
5. See UpdateWorkflowStepResponseTypeDef

Usage example with kwargs

kwargs: UpdateWorkflowStepRequestRequestTypeDef = {  # (1)
    "id": ...,
    "stepGroupId": ...,
    "workflowId": ...,
}

parent.update_workflow_step(**kwargs)

1. See UpdateWorkflowStepRequestRequestTypeDef

update_workflow_step_group

Update the step group in a migration workflow.

Type annotations and code completion for boto3.client("migrationhuborchestrator").update_workflow_step_group method. boto3 documentation

Method definition

def update_workflow_step_group(
    self,
    *,
    workflowId: str,
    id: str,
    name: str = ...,
    description: str = ...,
    next: Sequence[str] = ...,
    previous: Sequence[str] = ...,
) -> UpdateWorkflowStepGroupResponseTypeDef:  # (1)
    ...

1. See UpdateWorkflowStepGroupResponseTypeDef

Usage example with kwargs

kwargs: UpdateWorkflowStepGroupRequestRequestTypeDef = {  # (1)
    "workflowId": ...,
    "id": ...,
}

parent.update_workflow_step_group(**kwargs)

1. See UpdateWorkflowStepGroupRequestRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("migrationhuborchestrator").get_paginator method with overloads.

• client.get_paginator("list_plugins") -> ListPluginsPaginator
• client.get_paginator("list_template_step_groups") -> ListTemplateStepGroupsPaginator
• client.get_paginator("list_template_steps") -> ListTemplateStepsPaginator
• client.get_paginator("list_templates") -> ListTemplatesPaginator
• client.get_paginator("list_workflow_step_groups") -> ListWorkflowStepGroupsPaginator
• client.get_paginator("list_workflow_steps") -> ListWorkflowStepsPaginator
• client.get_paginator("list_workflows") -> ListWorkflowsPaginator