Skip to content

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

# MigrationHubOrchestratorClient 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.

# Exceptions.exceptions usage example

client = boto3.client("migrationhuborchestrator")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions 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

# can_paginate 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

# close method definition

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

create_template#

Creates a migration workflow template.

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

# create_template method definition

def create_template(
    self,
    *,
    templateName: str,
    templateSource: TemplateSourceTypeDef,  # (1)
    templateDescription: str = ...,
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateTemplateResponseTypeDef:  # (2)
    ...
  1. See TemplateSourceTypeDef
  2. See CreateTemplateResponseTypeDef
# create_template method usage example with argument unpacking

kwargs: CreateTemplateRequestRequestTypeDef = {  # (1)
    "templateName": ...,
    "templateSource": ...,
}

parent.create_template(**kwargs)
  1. See CreateTemplateRequestRequestTypeDef

create_workflow#

Create a workflow to orchestrate your migrations.

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

# create_workflow method definition

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

kwargs: CreateMigrationWorkflowRequestRequestTypeDef = {  # (1)
    "name": ...,
    "templateId": ...,
    "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

# create_workflow_step 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
# create_workflow_step method usage example with argument unpacking

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

# create_workflow_step_group 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
# create_workflow_step_group method usage example with argument unpacking

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

parent.create_workflow_step_group(**kwargs)
  1. See CreateWorkflowStepGroupRequestRequestTypeDef

delete_template#

Deletes a migration workflow template.

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

# delete_template method definition

def delete_template(
    self,
    *,
    id: str,
) -> Dict[str, Any]:
    ...
# delete_template method usage example with argument unpacking

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

parent.delete_template(**kwargs)
  1. See DeleteTemplateRequestRequestTypeDef

delete_workflow#

Delete a migration workflow.

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

# delete_workflow method definition

def delete_workflow(
    self,
    *,
    id: str,
) -> DeleteMigrationWorkflowResponseTypeDef:  # (1)
    ...
  1. See DeleteMigrationWorkflowResponseTypeDef
# delete_workflow method usage example with argument unpacking

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

# delete_workflow_step method definition

def delete_workflow_step(
    self,
    *,
    id: str,
    stepGroupId: str,
    workflowId: str,
) -> Dict[str, Any]:
    ...
# delete_workflow_step method usage example with argument unpacking

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

# delete_workflow_step_group method definition

def delete_workflow_step_group(
    self,
    *,
    workflowId: str,
    id: str,
) -> Dict[str, Any]:
    ...
# delete_workflow_step_group method usage example with argument unpacking

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

# generate_presigned_url 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

# get_template method definition

def get_template(
    self,
    *,
    id: str,
) -> GetMigrationWorkflowTemplateResponseTypeDef:  # (1)
    ...
  1. See GetMigrationWorkflowTemplateResponseTypeDef
# get_template method usage example with argument unpacking

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

# get_template_step method definition

def get_template_step(
    self,
    *,
    id: str,
    templateId: str,
    stepGroupId: str,
) -> GetTemplateStepResponseTypeDef:  # (1)
    ...
  1. See GetTemplateStepResponseTypeDef
# get_template_step method usage example with argument unpacking

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.