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)
...
# create_template method usage example with argument unpacking
kwargs: CreateTemplateRequestRequestTypeDef = { # (1)
"templateName": ...,
"templateSource": ...,
}
parent.create_template(**kwargs)
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, StepInputUnionTypeDef], # (1)
description: str = ...,
applicationConfigurationId: str = ...,
stepTargets: Sequence[str] = ...,
tags: Mapping[str, str] = ...,
) -> CreateMigrationWorkflowResponseTypeDef: # (2)
...
# create_workflow method usage example with argument unpacking
kwargs: CreateMigrationWorkflowRequestRequestTypeDef = { # (1)
"name": ...,
"templateId": ...,
"inputParameters": ...,
}
parent.create_workflow(**kwargs)
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[WorkflowStepUnionTypeDef] = ..., # (3)
previous: Sequence[str] = ...,
next: Sequence[str] = ...,
) -> CreateWorkflowStepResponseTypeDef: # (4)
...
- See StepActionTypeType
- See WorkflowStepAutomationConfigurationTypeDef
- See WorkflowStepOutputTypeDef WorkflowStepExtraOutputTypeDef
- See CreateWorkflowStepResponseTypeDef
# create_workflow_step method usage example with argument unpacking
kwargs: CreateWorkflowStepRequestRequestTypeDef = { # (1)
"name": ...,
"stepGroupId": ...,
"workflowId": ...,
"stepActionType": ...,
}
parent.create_workflow_step(**kwargs)
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)
...
# create_workflow_step_group method usage example with argument unpacking
kwargs: CreateWorkflowStepGroupRequestRequestTypeDef = { # (1)
"workflowId": ...,
"name": ...,
}
parent.create_workflow_step_group(**kwargs)
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)
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)
...
# delete_workflow method usage example with argument unpacking
kwargs: DeleteMigrationWorkflowRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.delete_workflow(**kwargs)
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)
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)
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)
...
# get_template method usage example with argument unpacking
kwargs: GetMigrationWorkflowTemplateRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.get_template(**kwargs)
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)
...
# get_template_step method usage example with argument unpacking
kwargs: GetTemplateStepRequestRequestTypeDef = { # (1)
"id": ...,
"templateId": ...,
"stepGroupId": ...,
}
parent.get_template_step(**kwargs)
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
# get_template_step_group method definition
def get_template_step_group(
self,
*,
templateId: str,
id: str,
) -> GetTemplateStepGroupResponseTypeDef: # (1)
...
# get_template_step_group method usage example with argument unpacking
kwargs: GetTemplateStepGroupRequestRequestTypeDef = { # (1)
"templateId": ...,
"id": ...,
}
parent.get_template_step_group(**kwargs)
get_workflow#
Get migration workflow.
Type annotations and code completion for boto3.client("migrationhuborchestrator").get_workflow
method.
boto3 documentation
# get_workflow method definition
def get_workflow(
self,
*,
id: str,
) -> GetMigrationWorkflowResponseTypeDef: # (1)
...
# get_workflow method usage example with argument unpacking
kwargs: GetMigrationWorkflowRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.get_workflow(**kwargs)
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
# get_workflow_step method definition
def get_workflow_step(
self,
*,
workflowId: str,
stepGroupId: str,
id: str,
) -> GetWorkflowStepResponseTypeDef: # (1)
...
# get_workflow_step method usage example with argument unpacking
kwargs: GetWorkflowStepRequestRequestTypeDef = { # (1)
"workflowId": ...,
"stepGroupId": ...,
"id": ...,
}
parent.get_workflow_step(**kwargs)
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
# get_workflow_step_group method definition
def get_workflow_step_group(
self,
*,
id: str,
workflowId: str,
) -> GetWorkflowStepGroupResponseTypeDef: # (1)
...
# get_workflow_step_group method usage example with argument unpacking
kwargs: GetWorkflowStepGroupRequestRequestTypeDef = { # (1)
"id": ...,
"workflowId": ...,
}
parent.get_workflow_step_group(**kwargs)
list_plugins#
List AWS Migration Hub Orchestrator plugins.
Type annotations and code completion for boto3.client("migrationhuborchestrator").list_plugins
method.
boto3 documentation
# list_plugins method definition
def list_plugins(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
) -> ListPluginsResponseTypeDef: # (1)
...
# list_plugins method usage example with argument unpacking
kwargs: ListPluginsRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_plugins(**kwargs)
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
# list_tags_for_resource method definition
def list_tags_for_resource(
self,
*,
resourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
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
# list_template_step_groups method definition
def list_template_step_groups(
self,
*,
templateId: str,
maxResults: int = ...,
nextToken: str = ...,
) -> ListTemplateStepGroupsResponseTypeDef: # (1)
...
# list_template_step_groups method usage example with argument unpacking
kwargs: ListTemplateStepGroupsRequestRequestTypeDef = { # (1)
"templateId": ...,
}
parent.list_template_step_groups(**kwargs)
list_template_steps#
List the steps in a template.
Type annotations and code completion for boto3.client("migrationhuborchestrator").list_template_steps
method.
boto3 documentation
# list_template_steps method definition
def list_template_steps(
self,
*,
templateId: str,
stepGroupId: str,
maxResults: int = ...,
nextToken: str = ...,
) -> ListTemplateStepsResponseTypeDef: # (1)
...
# list_template_steps method usage example with argument unpacking
kwargs: ListTemplateStepsRequestRequestTypeDef = { # (1)
"templateId": ...,
"stepGroupId": ...,
}
parent.list_template_steps(**kwargs)
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
# list_templates method definition
def list_templates(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
name: str = ...,
) -> ListMigrationWorkflowTemplatesResponseTypeDef: # (1)
...
# list_templates method usage example with argument unpacking
kwargs: ListMigrationWorkflowTemplatesRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_templates(**kwargs)
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
# list_workflow_step_groups method definition
def list_workflow_step_groups(
self,
*,
workflowId: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListWorkflowStepGroupsResponseTypeDef: # (1)
...
# list_workflow_step_groups method usage example with argument unpacking
kwargs: ListWorkflowStepGroupsRequestRequestTypeDef = { # (1)
"workflowId": ...,
}
parent.list_workflow_step_groups(**kwargs)
list_workflow_steps#
List the steps in a workflow.
Type annotations and code completion for boto3.client("migrationhuborchestrator").list_workflow_steps
method.
boto3 documentation
# list_workflow_steps method definition
def list_workflow_steps(
self,
*,
workflowId: str,
stepGroupId: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListWorkflowStepsResponseTypeDef: # (1)
...
# list_workflow_steps method usage example with argument unpacking
kwargs: ListWorkflowStepsRequestRequestTypeDef = { # (1)
"workflowId": ...,
"stepGroupId": ...,
}
parent.list_workflow_steps(**kwargs)
list_workflows#
List the migration workflows.
Type annotations and code completion for boto3.client("migrationhuborchestrator").list_workflows
method.
boto3 documentation
# list_workflows method definition
def list_workflows(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
templateId: str = ...,
adsApplicationConfigurationName: str = ...,
status: MigrationWorkflowStatusEnumType = ..., # (1)
name: str = ...,
) -> ListMigrationWorkflowsResponseTypeDef: # (2)
...
# list_workflows method usage example with argument unpacking
kwargs: ListMigrationWorkflowsRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_workflows(**kwargs)
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
# retry_workflow_step method definition
def retry_workflow_step(
self,
*,
workflowId: str,
stepGroupId: str,
id: str,
) -> RetryWorkflowStepResponseTypeDef: # (1)
...
# retry_workflow_step method usage example with argument unpacking
kwargs: RetryWorkflowStepRequestRequestTypeDef = { # (1)
"workflowId": ...,
"stepGroupId": ...,
"id": ...,
}
parent.retry_workflow_step(**kwargs)
start_workflow#
Start a migration workflow.
Type annotations and code completion for boto3.client("migrationhuborchestrator").start_workflow
method.
boto3 documentation
# start_workflow method definition
def start_workflow(
self,
*,
id: str,
) -> StartMigrationWorkflowResponseTypeDef: # (1)
...
# start_workflow method usage example with argument unpacking
kwargs: StartMigrationWorkflowRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.start_workflow(**kwargs)
stop_workflow#
Stop an ongoing migration workflow.
Type annotations and code completion for boto3.client("migrationhuborchestrator").stop_workflow
method.
boto3 documentation
# stop_workflow method definition
def stop_workflow(
self,
*,
id: str,
) -> StopMigrationWorkflowResponseTypeDef: # (1)
...
# stop_workflow method usage example with argument unpacking
kwargs: StopMigrationWorkflowRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.stop_workflow(**kwargs)
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
# tag_resource method definition
def tag_resource(
self,
*,
resourceArn: str,
tags: Mapping[str, str],
) -> Dict[str, Any]:
...
# tag_resource method usage example with argument unpacking
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource#
Deletes the tags for a resource.
Type annotations and code completion for boto3.client("migrationhuborchestrator").untag_resource
method.
boto3 documentation
# untag_resource method definition
def untag_resource(
self,
*,
resourceArn: str,
tagKeys: Sequence[str],
) -> Dict[str, Any]:
...
# untag_resource method usage example with argument unpacking
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)
update_template#
Updates a migration workflow template.
Type annotations and code completion for boto3.client("migrationhuborchestrator").update_template
method.
boto3 documentation
# update_template method definition
def update_template(
self,
*,
id: str,
templateName: str = ...,
templateDescription: str = ...,
clientToken: str = ...,
) -> UpdateTemplateResponseTypeDef: # (1)
...
# update_template method usage example with argument unpacking
kwargs: UpdateTemplateRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.update_template(**kwargs)
update_workflow#
Update a migration workflow.
Type annotations and code completion for boto3.client("migrationhuborchestrator").update_workflow
method.
boto3 documentation
# update_workflow method definition
def update_workflow(
self,
*,
id: str,
name: str = ...,
description: str = ...,
inputParameters: Mapping[str, StepInputTypeDef] = ..., # (1)
stepTargets: Sequence[str] = ...,
) -> UpdateMigrationWorkflowResponseTypeDef: # (2)
...
# update_workflow method usage example with argument unpacking
kwargs: UpdateMigrationWorkflowRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.update_workflow(**kwargs)
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
# update_workflow_step 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)
...
- See StepActionTypeType
- See WorkflowStepAutomationConfigurationTypeDef
- See WorkflowStepOutputTypeDef
- See StepStatusType
- See UpdateWorkflowStepResponseTypeDef
# update_workflow_step method usage example with argument unpacking
kwargs: UpdateWorkflowStepRequestRequestTypeDef = { # (1)
"id": ...,
"stepGroupId": ...,
"workflowId": ...,
}
parent.update_workflow_step(**kwargs)
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
# update_workflow_step_group method definition
def update_workflow_step_group(
self,
*,
workflowId: str,
id: str,
name: str = ...,
description: str = ...,
next: Sequence[str] = ...,
previous: Sequence[str] = ...,
) -> UpdateWorkflowStepGroupResponseTypeDef: # (1)
...
# update_workflow_step_group method usage example with argument unpacking
kwargs: UpdateWorkflowStepGroupRequestRequestTypeDef = { # (1)
"workflowId": ...,
"id": ...,
}
parent.update_workflow_step_group(**kwargs)
get_paginator#
Type annotations and code completion for boto3.client("migrationhuborchestrator").get_paginator
method with overloads.
client.get_paginator("list_plugins")
-> ListPluginsPaginatorclient.get_paginator("list_template_step_groups")
-> ListTemplateStepGroupsPaginatorclient.get_paginator("list_template_steps")
-> ListTemplateStepsPaginatorclient.get_paginator("list_templates")
-> ListTemplatesPaginatorclient.get_paginator("list_workflow_step_groups")
-> ListWorkflowStepGroupsPaginatorclient.get_paginator("list_workflow_steps")
-> ListWorkflowStepsPaginatorclient.get_paginator("list_workflows")
-> ListWorkflowsPaginator