Skip to content

Type definitions#

Index > MigrationHubOrchestrator > Type definitions

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

StepInputUnionTypeDef#

# StepInputUnionTypeDef definition

StepInputUnionTypeDef = Union[
    StepInputTypeDef,  # (1)
    StepInputOutputTypeDef,  # (2)
]
  1. See StepInputTypeDef
  2. See StepInputOutputTypeDef

WorkflowStepUnionTypeDef#

# WorkflowStepUnionTypeDef definition

WorkflowStepUnionTypeDef = Union[
    WorkflowStepOutputTypeDef,  # (1)
    WorkflowStepOutputTypeDef,  # (1)
]
  1. See WorkflowStepOutputTypeDef
  2. See WorkflowStepOutputTypeDef

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

StepInputOutputTypeDef#

# StepInputOutputTypeDef definition

class StepInputOutputTypeDef(TypedDict):
    integerValue: NotRequired[int],
    stringValue: NotRequired[str],
    listOfStringsValue: NotRequired[List[str]],
    mapOfStringValue: NotRequired[Dict[str, str]],

TemplateSourceTypeDef#

# TemplateSourceTypeDef definition

class TemplateSourceTypeDef(TypedDict):
    workflowId: NotRequired[str],

CreateWorkflowStepGroupRequestRequestTypeDef#

# CreateWorkflowStepGroupRequestRequestTypeDef definition

class CreateWorkflowStepGroupRequestRequestTypeDef(TypedDict):
    workflowId: str,
    name: str,
    description: NotRequired[str],
    next: NotRequired[Sequence[str]],
    previous: NotRequired[Sequence[str]],

ToolTypeDef#

# ToolTypeDef definition

class ToolTypeDef(TypedDict):
    name: NotRequired[str],
    url: NotRequired[str],

DeleteMigrationWorkflowRequestRequestTypeDef#

# DeleteMigrationWorkflowRequestRequestTypeDef definition

class DeleteMigrationWorkflowRequestRequestTypeDef(TypedDict):
    id: str,

DeleteTemplateRequestRequestTypeDef#

# DeleteTemplateRequestRequestTypeDef definition

class DeleteTemplateRequestRequestTypeDef(TypedDict):
    id: str,

DeleteWorkflowStepGroupRequestRequestTypeDef#

# DeleteWorkflowStepGroupRequestRequestTypeDef definition

class DeleteWorkflowStepGroupRequestRequestTypeDef(TypedDict):
    workflowId: str,
    id: str,

DeleteWorkflowStepRequestRequestTypeDef#

# DeleteWorkflowStepRequestRequestTypeDef definition

class DeleteWorkflowStepRequestRequestTypeDef(TypedDict):
    id: str,
    stepGroupId: str,
    workflowId: str,

GetMigrationWorkflowRequestRequestTypeDef#

# GetMigrationWorkflowRequestRequestTypeDef definition

class GetMigrationWorkflowRequestRequestTypeDef(TypedDict):
    id: str,

GetMigrationWorkflowTemplateRequestRequestTypeDef#

# GetMigrationWorkflowTemplateRequestRequestTypeDef definition

class GetMigrationWorkflowTemplateRequestRequestTypeDef(TypedDict):
    id: str,

TemplateInputTypeDef#

# TemplateInputTypeDef definition

class TemplateInputTypeDef(TypedDict):
    inputName: NotRequired[str],
    dataType: NotRequired[DataTypeType],  # (1)
    required: NotRequired[bool],
  1. See DataTypeType

GetTemplateStepGroupRequestRequestTypeDef#

# GetTemplateStepGroupRequestRequestTypeDef definition

class GetTemplateStepGroupRequestRequestTypeDef(TypedDict):
    templateId: str,
    id: str,

GetTemplateStepRequestRequestTypeDef#

# GetTemplateStepRequestRequestTypeDef definition

class GetTemplateStepRequestRequestTypeDef(TypedDict):
    id: str,
    templateId: str,
    stepGroupId: str,

StepOutputTypeDef#

# StepOutputTypeDef definition

class StepOutputTypeDef(TypedDict):
    name: NotRequired[str],
    dataType: NotRequired[DataTypeType],  # (1)
    required: NotRequired[bool],
  1. See DataTypeType

GetWorkflowStepGroupRequestRequestTypeDef#

# GetWorkflowStepGroupRequestRequestTypeDef definition

class GetWorkflowStepGroupRequestRequestTypeDef(TypedDict):
    id: str,
    workflowId: str,

GetWorkflowStepRequestRequestTypeDef#

# GetWorkflowStepRequestRequestTypeDef definition

class GetWorkflowStepRequestRequestTypeDef(TypedDict):
    workflowId: str,
    stepGroupId: str,
    id: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListMigrationWorkflowTemplatesRequestRequestTypeDef#

# ListMigrationWorkflowTemplatesRequestRequestTypeDef definition

class ListMigrationWorkflowTemplatesRequestRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    name: NotRequired[str],

TemplateSummaryTypeDef#

# TemplateSummaryTypeDef definition

class TemplateSummaryTypeDef(TypedDict):
    id: NotRequired[str],
    name: NotRequired[str],
    arn: NotRequired[str],
    description: NotRequired[str],

ListMigrationWorkflowsRequestRequestTypeDef#

# ListMigrationWorkflowsRequestRequestTypeDef definition

class ListMigrationWorkflowsRequestRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    templateId: NotRequired[str],
    adsApplicationConfigurationName: NotRequired[str],
    status: NotRequired[MigrationWorkflowStatusEnumType],  # (1)
    name: NotRequired[str],
  1. See MigrationWorkflowStatusEnumType

MigrationWorkflowSummaryTypeDef#

# MigrationWorkflowSummaryTypeDef definition

class MigrationWorkflowSummaryTypeDef(TypedDict):
    id: NotRequired[str],
    name: NotRequired[str],
    templateId: NotRequired[str],
    adsApplicationConfigurationName: NotRequired[str],
    status: NotRequired[MigrationWorkflowStatusEnumType],  # (1)
    creationTime: NotRequired[datetime],
    endTime: NotRequired[datetime],
    statusMessage: NotRequired[str],
    completedSteps: NotRequired[int],
    totalSteps: NotRequired[int],
  1. See MigrationWorkflowStatusEnumType

ListPluginsRequestRequestTypeDef#

# ListPluginsRequestRequestTypeDef definition

class ListPluginsRequestRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

PluginSummaryTypeDef#

# PluginSummaryTypeDef definition

class PluginSummaryTypeDef(TypedDict):
    pluginId: NotRequired[str],
    hostname: NotRequired[str],
    status: NotRequired[PluginHealthType],  # (1)
    ipAddress: NotRequired[str],
    version: NotRequired[str],
    registeredTime: NotRequired[str],
  1. See PluginHealthType

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

ListTemplateStepGroupsRequestRequestTypeDef#

# ListTemplateStepGroupsRequestRequestTypeDef definition

class ListTemplateStepGroupsRequestRequestTypeDef(TypedDict):
    templateId: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

TemplateStepGroupSummaryTypeDef#

# TemplateStepGroupSummaryTypeDef definition

class TemplateStepGroupSummaryTypeDef(TypedDict):
    id: NotRequired[str],
    name: NotRequired[str],
    previous: NotRequired[List[str]],
    next: NotRequired[List[str]],

ListTemplateStepsRequestRequestTypeDef#

# ListTemplateStepsRequestRequestTypeDef definition

class ListTemplateStepsRequestRequestTypeDef(TypedDict):
    templateId: str,
    stepGroupId: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

TemplateStepSummaryTypeDef#

# TemplateStepSummaryTypeDef definition

class TemplateStepSummaryTypeDef(TypedDict):
    id: NotRequired[str],
    stepGroupId: NotRequired[str],
    templateId: NotRequired[str],
    name: NotRequired[str],
    stepActionType: NotRequired[StepActionTypeType],  # (1)
    targetType: NotRequired[TargetTypeType],  # (2)
    owner: NotRequired[OwnerType],  # (3)
    previous: NotRequired[List[str]],
    next: NotRequired[List[str]],
  1. See StepActionTypeType
  2. See TargetTypeType
  3. See OwnerType

ListWorkflowStepGroupsRequestRequestTypeDef#

# ListWorkflowStepGroupsRequestRequestTypeDef definition

class ListWorkflowStepGroupsRequestRequestTypeDef(TypedDict):
    workflowId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

WorkflowStepGroupSummaryTypeDef#

# WorkflowStepGroupSummaryTypeDef definition

class WorkflowStepGroupSummaryTypeDef(TypedDict):
    id: NotRequired[str],
    name: NotRequired[str],
    owner: NotRequired[OwnerType],  # (1)
    status: NotRequired[StepGroupStatusType],  # (2)
    previous: NotRequired[List[str]],
    next: NotRequired[List[str]],
  1. See OwnerType
  2. See StepGroupStatusType

ListWorkflowStepsRequestRequestTypeDef#

# ListWorkflowStepsRequestRequestTypeDef definition

class ListWorkflowStepsRequestRequestTypeDef(TypedDict):
    workflowId: str,
    stepGroupId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

WorkflowStepSummaryTypeDef#

# WorkflowStepSummaryTypeDef definition

class WorkflowStepSummaryTypeDef(TypedDict):
    stepId: NotRequired[str],
    name: NotRequired[str],
    stepActionType: NotRequired[StepActionTypeType],  # (1)
    owner: NotRequired[OwnerType],  # (2)
    previous: NotRequired[List[str]],
    next: NotRequired[List[str]],
    status: NotRequired[StepStatusType],  # (3)
    statusMessage: NotRequired[str],
    noOfSrvCompleted: NotRequired[int],
    noOfSrvFailed: NotRequired[int],
    totalNoOfSrv: NotRequired[int],
    description: NotRequired[str],
    scriptLocation: NotRequired[str],
  1. See StepActionTypeType
  2. See OwnerType
  3. See StepStatusType

PlatformCommandTypeDef#

# PlatformCommandTypeDef definition

class PlatformCommandTypeDef(TypedDict):
    linux: NotRequired[str],
    windows: NotRequired[str],

PlatformScriptKeyTypeDef#

# PlatformScriptKeyTypeDef definition

class PlatformScriptKeyTypeDef(TypedDict):
    linux: NotRequired[str],
    windows: NotRequired[str],

RetryWorkflowStepRequestRequestTypeDef#

# RetryWorkflowStepRequestRequestTypeDef definition

class RetryWorkflowStepRequestRequestTypeDef(TypedDict):
    workflowId: str,
    stepGroupId: str,
    id: str,

StartMigrationWorkflowRequestRequestTypeDef#

# StartMigrationWorkflowRequestRequestTypeDef definition

class StartMigrationWorkflowRequestRequestTypeDef(TypedDict):
    id: str,

StepInputTypeDef#

# StepInputTypeDef definition

class StepInputTypeDef(TypedDict):
    integerValue: NotRequired[int],
    stringValue: NotRequired[str],
    listOfStringsValue: NotRequired[Sequence[str]],
    mapOfStringValue: NotRequired[Mapping[str, str]],

StopMigrationWorkflowRequestRequestTypeDef#

# StopMigrationWorkflowRequestRequestTypeDef definition

class StopMigrationWorkflowRequestRequestTypeDef(TypedDict):
    id: str,

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Mapping[str, str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

UpdateTemplateRequestRequestTypeDef#

# UpdateTemplateRequestRequestTypeDef definition

class UpdateTemplateRequestRequestTypeDef(TypedDict):
    id: str,
    templateName: NotRequired[str],
    templateDescription: NotRequired[str],
    clientToken: NotRequired[str],

UpdateWorkflowStepGroupRequestRequestTypeDef#

# UpdateWorkflowStepGroupRequestRequestTypeDef definition

class UpdateWorkflowStepGroupRequestRequestTypeDef(TypedDict):
    workflowId: str,
    id: str,
    name: NotRequired[str],
    description: NotRequired[str],
    next: NotRequired[Sequence[str]],
    previous: NotRequired[Sequence[str]],

WorkflowStepOutputUnionTypeDef#

# WorkflowStepOutputUnionTypeDef definition

class WorkflowStepOutputUnionTypeDef(TypedDict):
    integerValue: NotRequired[int],
    stringValue: NotRequired[str],
    listOfStringValue: NotRequired[Sequence[str]],

WorkflowStepOutputUnionOutputTypeDef#

# WorkflowStepOutputUnionOutputTypeDef definition

class WorkflowStepOutputUnionOutputTypeDef(TypedDict):
    integerValue: NotRequired[int],
    stringValue: NotRequired[str],
    listOfStringValue: NotRequired[List[str]],

CreateTemplateResponseTypeDef#

# CreateTemplateResponseTypeDef definition

class CreateTemplateResponseTypeDef(TypedDict):
    templateId: str,
    templateArn: str,
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateWorkflowStepResponseTypeDef#

# CreateWorkflowStepResponseTypeDef definition

class CreateWorkflowStepResponseTypeDef(TypedDict):
    id: str,
    stepGroupId: str,
    workflowId: str,
    name: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteMigrationWorkflowResponseTypeDef#

# DeleteMigrationWorkflowResponseTypeDef definition

class DeleteMigrationWorkflowResponseTypeDef(TypedDict):
    id: str,
    arn: str,
    status: MigrationWorkflowStatusEnumType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MigrationWorkflowStatusEnumType
  2. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

RetryWorkflowStepResponseTypeDef#

# RetryWorkflowStepResponseTypeDef definition

class RetryWorkflowStepResponseTypeDef(TypedDict):
    stepGroupId: str,
    workflowId: str,
    id: str,
    status: StepStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See StepStatusType
  2. See ResponseMetadataTypeDef

StartMigrationWorkflowResponseTypeDef#

# StartMigrationWorkflowResponseTypeDef definition

class StartMigrationWorkflowResponseTypeDef(TypedDict):
    id: str,
    arn: str,
    status: MigrationWorkflowStatusEnumType,  # (1)
    statusMessage: str,
    lastStartTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MigrationWorkflowStatusEnumType
  2. See ResponseMetadataTypeDef

StopMigrationWorkflowResponseTypeDef#

# StopMigrationWorkflowResponseTypeDef definition

class StopMigrationWorkflowResponseTypeDef(TypedDict):
    id: str,
    arn: str,
    status: MigrationWorkflowStatusEnumType,  # (1)
    statusMessage: str,
    lastStopTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MigrationWorkflowStatusEnumType
  2. See ResponseMetadataTypeDef

UpdateTemplateResponseTypeDef#

# UpdateTemplateResponseTypeDef definition

class UpdateTemplateResponseTypeDef(TypedDict):
    templateId: str,
    templateArn: str,
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateWorkflowStepResponseTypeDef#

# UpdateWorkflowStepResponseTypeDef definition

class UpdateWorkflowStepResponseTypeDef(TypedDict):
    id: str,
    stepGroupId: str,
    workflowId: str,
    name: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See