Skip to content

Type definitions#

Index > MigrationHubOrchestrator > Type definitions

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

StepInputTypeDef#

# StepInputTypeDef definition

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

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[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,

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]],

CreateMigrationWorkflowRequestRequestTypeDef#

# CreateMigrationWorkflowRequestRequestTypeDef definition

class CreateMigrationWorkflowRequestRequestTypeDef(TypedDict):
    name: str,
    templateId: str,
    inputParameters: Mapping[str, StepInputTypeDef],  # (1)
    description: NotRequired[str],
    applicationConfigurationId: NotRequired[str],
    stepTargets: NotRequired[Sequence[str]],
    tags: NotRequired[Mapping[str, str]],
  1. See StepInputTypeDef

UpdateMigrationWorkflowRequestRequestTypeDef#

# UpdateMigrationWorkflowRequestRequestTypeDef definition

class UpdateMigrationWorkflowRequestRequestTypeDef(TypedDict):
    id: str,
    name: NotRequired[str],
    description: NotRequired[str],
    inputParameters: NotRequired[Mapping[str, StepInputTypeDef]],  # (1)
    stepTargets: NotRequired[Sequence[str]],
  1. See StepInputTypeDef

CreateMigrationWorkflowResponseTypeDef#

# CreateMigrationWorkflowResponseTypeDef definition

class CreateMigrationWorkflowResponseTypeDef(TypedDict):
    id: str,
    arn: str,
    name: str,
    description: str,
    templateId: str,
    adsApplicationConfigurationId: str,
    workflowInputs: Dict[str, StepInputTypeDef],  # (1)
    stepTargets: List[str],
    status: MigrationWorkflowStatusEnumType,  # (2)
    creationTime: datetime,
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See StepInputTypeDef
  2. See MigrationWorkflowStatusEnumType
  3. See ResponseMetadataTypeDef

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

UpdateMigrationWorkflowResponseTypeDef#

# UpdateMigrationWorkflowResponseTypeDef definition

class UpdateMigrationWorkflowResponseTypeDef(TypedDict):
    id: str,
    arn: str,
    name: str,
    description: str,
    templateId: str,
    adsApplicationConfigurationId: str,
    workflowInputs: Dict[str, StepInputTypeDef],  # (1)
    stepTargets: List[str],
    status: MigrationWorkflowStatusEnumType,  # (2)
    creationTime: datetime,
    lastModifiedTime: datetime,
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See StepInputTypeDef
  2. See MigrationWorkflowStatusEnumType
  3. 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 ResponseMetadataTypeDef

CreateTemplateRequestRequestTypeDef#

# CreateTemplateRequestRequestTypeDef definition

class CreateTemplateRequestRequestTypeDef(TypedDict):
    templateName: str,
    templateSource: TemplateSourceTypeDef,  # (1)
    templateDescription: NotRequired[str],
    clientToken: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
  1. See TemplateSourceTypeDef

CreateWorkflowStepGroupResponseTypeDef#

# CreateWorkflowStepGroupResponseTypeDef definition

class CreateWorkflowStepGroupResponseTypeDef(TypedDict):
    workflowId: str,
    name: str,
    id: str,
    description: str,
    tools: List[ToolTypeDef],  # (1)
    next: List[str],
    previous: List[str],
    creationTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ToolTypeDef
  2. See ResponseMetadataTypeDef

GetMigrationWorkflowResponseTypeDef#

# GetMigrationWorkflowResponseTypeDef definition

class GetMigrationWorkflowResponseTypeDef(TypedDict):
    id: str,
    arn: str,
    name: str,
    description: str,
    templateId: str,
    adsApplicationConfigurationId: str,
    adsApplicationName: str,
    status: MigrationWorkflowStatusEnumType,  # (1)
    statusMessage: str,
    creationTime: datetime,
    lastStartTime: datetime,
    lastStopTime: datetime,
    lastModifiedTime: datetime,
    endTime: datetime,
    tools: List[ToolTypeDef],  # (2)
    totalSteps: int,
    completedSteps: int,
    workflowInputs: Dict[str, StepInputTypeDef],  # (3)
    tags: Dict[str, str],
    workflowBucket: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See MigrationWorkflowStatusEnumType
  2. See ToolTypeDef
  3. See StepInputTypeDef
  4. See ResponseMetadataTypeDef

GetTemplateStepGroupResponseTypeDef#

# GetTemplateStepGroupResponseTypeDef definition

class GetTemplateStepGroupResponseTypeDef(TypedDict):
    templateId: str,
    id: str,
    name: str,
    description: str,
    status: StepGroupStatusType,  # (1)
    creationTime: datetime,
    lastModifiedTime: datetime,
    tools: List[ToolTypeDef],  # (2)
    previous: List[str],
    next: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See StepGroupStatusType
  2. See ToolTypeDef
  3. See ResponseMetadataTypeDef

GetWorkflowStepGroupResponseTypeDef#

# GetWorkflowStepGroupResponseTypeDef definition

class GetWorkflowStepGroupResponseTypeDef(TypedDict):
    id: str,
    workflowId: str,
    name: str,
    description: str,
    status: StepGroupStatusType,  # (1)
    owner: OwnerType,  # (2)
    creationTime: datetime,
    lastModifiedTime: datetime,
    endTime: datetime,
    tools: List[ToolTypeDef],  # (3)
    previous: List[str],
    next: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See StepGroupStatusType
  2. See OwnerType
  3. See ToolTypeDef
  4. See ResponseMetadataTypeDef

UpdateWorkflowStepGroupResponseTypeDef#

# UpdateWorkflowStepGroupResponseTypeDef definition

class UpdateWorkflowStepGroupResponseTypeDef(TypedDict):
    workflowId: str,
    name: str,
    id: str,
    description: str,
    tools: List[ToolTypeDef],  # (1)
    next: List[str],
    previous: List[str],
    lastModifiedTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ToolTypeDef
  2. See ResponseMetadataTypeDef

GetMigrationWorkflowTemplateResponseTypeDef#

# GetMigrationWorkflowTemplateResponseTypeDef definition

class GetMigrationWorkflowTemplateResponseTypeDef(TypedDict):
    id: str,
    templateArn: str,
    name: str,
    description: str,
    inputs: List[TemplateInputTypeDef],  # (1)
    tools: List[ToolTypeDef],  # (2)
    creationTime: datetime,
    owner: str,
    status: TemplateStatusType,  # (3)
    statusMessage: str,
    templateClass: str,
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See TemplateInputTypeDef
  2. See ToolTypeDef
  3. See TemplateStatusType
  4. See ResponseMetadataTypeDef

ListMigrationWorkflowTemplatesRequestListTemplatesPaginateTypeDef#

# ListMigrationWorkflowTemplatesRequestListTemplatesPaginateTypeDef definition

class ListMigrationWorkflowTemplatesRequestListTemplatesPaginateTypeDef(TypedDict):
    name: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListMigrationWorkflowsRequestListWorkflowsPaginateTypeDef#

# ListMigrationWorkflowsRequestListWorkflowsPaginateTypeDef definition

class ListMigrationWorkflowsRequestListWorkflowsPaginateTypeDef(TypedDict):
    templateId: NotRequired[str],
    adsApplicationConfigurationName: NotRequired[str],
    status: NotRequired[MigrationWorkflowStatusEnumType],  # (1)
    name: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See MigrationWorkflowStatusEnumType
  2. See PaginatorConfigTypeDef

ListPluginsRequestListPluginsPaginateTypeDef#

# ListPluginsRequestListPluginsPaginateTypeDef definition

class ListPluginsRequestListPluginsPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListTemplateStepGroupsRequestListTemplateStepGroupsPaginateTypeDef#

# ListTemplateStepGroupsRequestListTemplateStepGroupsPaginateTypeDef definition

class ListTemplateStepGroupsRequestListTemplateStepGroupsPaginateTypeDef(TypedDict):
    templateId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListTemplateStepsRequestListTemplateStepsPaginateTypeDef#

# ListTemplateStepsRequestListTemplateStepsPaginateTypeDef definition

class ListTemplateStepsRequestListTemplateStepsPaginateTypeDef(TypedDict):
    templateId: str,
    stepGroupId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListWorkflowStepGroupsRequestListWorkflowStepGroupsPaginateTypeDef#

# ListWorkflowStepGroupsRequestListWorkflowStepGroupsPaginateTypeDef definition

class ListWorkflowStepGroupsRequestListWorkflowStepGroupsPaginateTypeDef(TypedDict):
    workflowId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListWorkflowStepsRequestListWorkflowStepsPaginateTypeDef#

# ListWorkflowStepsRequestListWorkflowStepsPaginateTypeDef definition

class ListWorkflowStepsRequestListWorkflowStepsPaginateTypeDef(TypedDict):
    workflowId: str,
    stepGroupId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListMigrationWorkflowTemplatesResponseTypeDef#

# ListMigrationWorkflowTemplatesResponseTypeDef definition

class ListMigrationWorkflowTemplatesResponseTypeDef(TypedDict):
    nextToken: str,
    templateSummary: List[TemplateSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TemplateSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListMigrationWorkflowsResponseTypeDef#

# ListMigrationWorkflowsResponseTypeDef definition

class ListMigrationWorkflowsResponseTypeDef(TypedDict):
    nextToken: str,
    migrationWorkflowSummary: List[MigrationWorkflowSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MigrationWorkflowSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListPluginsResponseTypeDef#

# ListPluginsResponseTypeDef definition

class ListPluginsResponseTypeDef(TypedDict):
    nextToken: str,
    plugins: List[PluginSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PluginSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListTemplateStepGroupsResponseTypeDef#

# ListTemplateStepGroupsResponseTypeDef definition

class ListTemplateStepGroupsResponseTypeDef(TypedDict):
    nextToken: str,
    templateStepGroupSummary: List[TemplateStepGroupSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TemplateStepGroupSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListTemplateStepsResponseTypeDef#

# ListTemplateStepsResponseTypeDef definition

class ListTemplateStepsResponseTypeDef(TypedDict):
    nextToken: str,
    templateStepSummaryList: List[TemplateStepSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TemplateStepSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListWorkflowStepGroupsResponseTypeDef#

# ListWorkflowStepGroupsResponseTypeDef definition

class ListWorkflowStepGroupsResponseTypeDef(TypedDict):
    nextToken: str,
    workflowStepGroupsSummary: List[WorkflowStepGroupSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See WorkflowStepGroupSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListWorkflowStepsResponseTypeDef#

# ListWorkflowStepsResponseTypeDef definition

class ListWorkflowStepsResponseTypeDef(TypedDict):
    nextToken: str,
    workflowStepsSummary: List[WorkflowStepSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See WorkflowStepSummaryTypeDef
  2. See ResponseMetadataTypeDef

StepAutomationConfigurationTypeDef#

# StepAutomationConfigurationTypeDef definition

class StepAutomationConfigurationTypeDef(TypedDict):
    scriptLocationS3Bucket: NotRequired[str],
    scriptLocationS3Key: NotRequired[PlatformScriptKeyTypeDef],  # (1)
    command: NotRequired[PlatformCommandTypeDef],  # (2)
    runEnvironment: NotRequired[RunEnvironmentType],  # (3)
    targetType: NotRequired[TargetTypeType],  # (4)
  1. See PlatformScriptKeyTypeDef
  2. See PlatformCommandTypeDef
  3. See RunEnvironmentType
  4. See TargetTypeType

WorkflowStepAutomationConfigurationTypeDef#

# WorkflowStepAutomationConfigurationTypeDef definition

class WorkflowStepAutomationConfigurationTypeDef(TypedDict):
    scriptLocationS3Bucket: NotRequired[str],
    scriptLocationS3Key: NotRequired[PlatformScriptKeyTypeDef],  # (1)
    command: NotRequired[PlatformCommandTypeDef],  # (2)
    runEnvironment: NotRequired[RunEnvironmentType],  # (3)
    targetType: NotRequired[TargetTypeType],  # (4)
  1. See PlatformScriptKeyTypeDef
  2. See PlatformCommandTypeDef
  3. See RunEnvironmentType
  4. See TargetTypeType

WorkflowStepOutputTypeDef#

# WorkflowStepOutputTypeDef definition

class WorkflowStepOutputTypeDef(TypedDict):
    name: NotRequired[str],
    dataType: NotRequired[DataTypeType],  # (1)
    required: NotRequired[bool],
    value: NotRequired[WorkflowStepOutputUnionTypeDef],  # (2)
  1. See DataTypeType
  2. See WorkflowStepOutputUnionTypeDef

GetTemplateStepResponseTypeDef#

# GetTemplateStepResponseTypeDef definition

class GetTemplateStepResponseTypeDef(TypedDict):
    id: str,
    stepGroupId: str,
    templateId: str,
    name: str,
    description: str,
    stepActionType: StepActionTypeType,  # (1)
    creationTime: str,
    previous: List[str],
    next: List[str],
    outputs: List[StepOutputTypeDef],  # (2)
    stepAutomationConfiguration: StepAutomationConfigurationTypeDef,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See StepActionTypeType
  2. See StepOutputTypeDef
  3. See StepAutomationConfigurationTypeDef
  4. See ResponseMetadataTypeDef

CreateWorkflowStepRequestRequestTypeDef#

# CreateWorkflowStepRequestRequestTypeDef definition

class CreateWorkflowStepRequestRequestTypeDef(TypedDict):
    name: str,
    stepGroupId: str,
    workflowId: str,
    stepActionType: StepActionTypeType,  # (1)
    description: NotRequired[str],
    workflowStepAutomationConfiguration: NotRequired[WorkflowStepAutomationConfigurationTypeDef],  # (2)
    stepTarget: NotRequired[Sequence[str]],
    outputs: NotRequired[Sequence[WorkflowStepOutputTypeDef]],  # (3)
    previous: NotRequired[Sequence[str]],
    next: NotRequired[Sequence[str]],
  1. See StepActionTypeType
  2. See WorkflowStepAutomationConfigurationTypeDef
  3. See WorkflowStepOutputTypeDef

GetWorkflowStepResponseTypeDef#

# GetWorkflowStepResponseTypeDef definition

class GetWorkflowStepResponseTypeDef(TypedDict):
    name: str,
    stepGroupId: str,
    workflowId: str,
    stepId: str,
    description: str,
    stepActionType: StepActionTypeType,  # (1)
    owner: OwnerType,  # (2)
    workflowStepAutomationConfiguration: WorkflowStepAutomationConfigurationTypeDef,  # (3)
    stepTarget: List[str],
    outputs: List[WorkflowStepOutputTypeDef],  # (4)
    previous: List[str],
    next: List[str],
    status: StepStatusType,  # (5)
    statusMessage: str,
    scriptOutputLocation: str,
    creationTime: datetime,
    lastStartTime: datetime,
    endTime: datetime,
    noOfSrvCompleted: int,
    noOfSrvFailed: int,
    totalNoOfSrv: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)
  1. See StepActionTypeType
  2. See OwnerType
  3. See WorkflowStepAutomationConfigurationTypeDef
  4. See WorkflowStepOutputTypeDef
  5. See StepStatusType
  6. See ResponseMetadataTypeDef

UpdateWorkflowStepRequestRequestTypeDef#

# UpdateWorkflowStepRequestRequestTypeDef definition

class UpdateWorkflowStepRequestRequestTypeDef(TypedDict):
    id: str,
    stepGroupId: str,
    workflowId: str,
    name: NotRequired[str],
    description: NotRequired[str],
    stepActionType: NotRequired[StepActionTypeType],  # (1)
    workflowStepAutomationConfiguration: NotRequired[WorkflowStepAutomationConfigurationTypeDef],  # (2)
    stepTarget: NotRequired[Sequence[str]],
    outputs: NotRequired[Sequence[WorkflowStepOutputTypeDef]],  # (3)
    previous: NotRequired[Sequence[str]],
    next: NotRequired[Sequence[str]],
    status: NotRequired[StepStatusType],  # (4)
  1. See StepActionTypeType
  2. See WorkflowStepAutomationConfigurationTypeDef
  3. See WorkflowStepOutputTypeDef
  4. See StepStatusType