MigrationHubOrchestrator ************************ Client ====== class MigrationHubOrchestrator.Client A low-level client representing AWS Migration Hub Orchestrator This API reference provides descriptions, syntax, and other details about each of the actions and data types for AWS Migration Hub Orchestrator. The topic for each action shows the API request parameters and responses. Alternatively, you can use one of the AWS SDKs to access an API that is tailored to the programming language or platform that you're using. import boto3 client = boto3.client('migrationhuborchestrator') These are the available methods: * can_paginate * close * create_template * create_workflow * create_workflow_step * create_workflow_step_group * delete_template * delete_workflow * delete_workflow_step * delete_workflow_step_group * get_paginator * get_template * get_template_step * get_template_step_group * get_waiter * get_workflow * get_workflow_step * get_workflow_step_group * list_plugins * list_tags_for_resource * list_template_step_groups * list_template_steps * list_templates * list_workflow_step_groups * list_workflow_steps * list_workflows * retry_workflow_step * start_workflow * stop_workflow * tag_resource * untag_resource * update_template * update_workflow * update_workflow_step * update_workflow_step_group Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListPlugins * ListTemplateStepGroups * ListTemplateSteps * ListTemplates * ListWorkflowStepGroups * ListWorkflowSteps * ListWorkflows MigrationHubOrchestrator / Paginator / ListTemplates ListTemplates ************* class MigrationHubOrchestrator.Paginator.ListTemplates paginator = client.get_paginator('list_templates') paginate(**kwargs) Creates an iterator that will paginate through responses from "MigrationHubOrchestrator.Client.list_templates()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( name='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **name** (*string*) -- The name of the template. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'templateSummary': [ { 'id': 'string', 'name': 'string', 'arn': 'string', 'description': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **templateSummary** *(list) --* The summary of the template. * *(dict) --* The summary of the template. * **id** *(string) --* The ID of the template. * **name** *(string) --* The name of the template. * **arn** *(string) --* The Amazon Resource Name (ARN) of the template. * **description** *(string) --* The description of the template. * **NextToken** *(string) --* A token to resume pagination. MigrationHubOrchestrator / Paginator / ListWorkflowSteps ListWorkflowSteps ***************** class MigrationHubOrchestrator.Paginator.ListWorkflowSteps paginator = client.get_paginator('list_workflow_steps') paginate(**kwargs) Creates an iterator that will paginate through responses from "MigrationHubOrchestrator.Client.list_workflow_steps()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( workflowId='string', stepGroupId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **workflowId** (*string*) -- **[REQUIRED]** The ID of the migration workflow. * **stepGroupId** (*string*) -- **[REQUIRED]** The ID of the step group. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'workflowStepsSummary': [ { 'stepId': 'string', 'name': 'string', 'stepActionType': 'MANUAL'|'AUTOMATED', 'owner': 'AWS_MANAGED'|'CUSTOM', 'previous': [ 'string', ], 'next': [ 'string', ], 'status': 'AWAITING_DEPENDENCIES'|'SKIPPED'|'READY'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'PAUSED'|'USER_ATTENTION_REQUIRED', 'statusMessage': 'string', 'noOfSrvCompleted': 123, 'noOfSrvFailed': 123, 'totalNoOfSrv': 123, 'description': 'string', 'scriptLocation': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **workflowStepsSummary** *(list) --* The summary of steps in a migration workflow. * *(dict) --* The summary of the step in a migration workflow. * **stepId** *(string) --* The ID of the step. * **name** *(string) --* The name of the step. * **stepActionType** *(string) --* The action type of the step. You must run and update the status of a manual step for the workflow to continue after the completion of the step. * **owner** *(string) --* The owner of the step. * **previous** *(list) --* The previous step. * *(string) --* * **next** *(list) --* The next step. * *(string) --* * **status** *(string) --* The status of the step. * **statusMessage** *(string) --* The status message of the migration workflow. * **noOfSrvCompleted** *(integer) --* The number of servers that have been migrated. * **noOfSrvFailed** *(integer) --* The number of servers that have failed to migrate. * **totalNoOfSrv** *(integer) --* The total number of servers that have been migrated. * **description** *(string) --* The description of the step. * **scriptLocation** *(string) --* The location of the script. * **NextToken** *(string) --* A token to resume pagination. MigrationHubOrchestrator / Paginator / ListPlugins ListPlugins *********** class MigrationHubOrchestrator.Paginator.ListPlugins paginator = client.get_paginator('list_plugins') paginate(**kwargs) Creates an iterator that will paginate through responses from "MigrationHubOrchestrator.Client.list_plugins()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'plugins': [ { 'pluginId': 'string', 'hostname': 'string', 'status': 'HEALTHY'|'UNHEALTHY', 'ipAddress': 'string', 'version': 'string', 'registeredTime': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **plugins** *(list) --* Migration Hub Orchestrator plugins. * *(dict) --* The summary of the Migration Hub Orchestrator plugin. * **pluginId** *(string) --* The ID of the plugin. * **hostname** *(string) --* The name of the host. * **status** *(string) --* The status of the plugin. * **ipAddress** *(string) --* The IP address at which the plugin is located. * **version** *(string) --* The version of the plugin. * **registeredTime** *(string) --* The time at which the plugin was registered. * **NextToken** *(string) --* A token to resume pagination. MigrationHubOrchestrator / Paginator / ListWorkflows ListWorkflows ************* class MigrationHubOrchestrator.Paginator.ListWorkflows paginator = client.get_paginator('list_workflows') paginate(**kwargs) Creates an iterator that will paginate through responses from "MigrationHubOrchestrator.Client.list_workflows()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( templateId='string', adsApplicationConfigurationName='string', status='CREATING'|'NOT_STARTED'|'CREATION_FAILED'|'STARTING'|'IN_PROGRESS'|'WORKFLOW_FAILED'|'PAUSED'|'PAUSING'|'PAUSING_FAILED'|'USER_ATTENTION_REQUIRED'|'DELETING'|'DELETION_FAILED'|'DELETED'|'COMPLETED', name='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **templateId** (*string*) -- The ID of the template. * **adsApplicationConfigurationName** (*string*) -- The name of the application configured in Application Discovery Service. * **status** (*string*) -- The status of the migration workflow. * **name** (*string*) -- The name of the migration workflow. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'migrationWorkflowSummary': [ { 'id': 'string', 'name': 'string', 'templateId': 'string', 'adsApplicationConfigurationName': 'string', 'status': 'CREATING'|'NOT_STARTED'|'CREATION_FAILED'|'STARTING'|'IN_PROGRESS'|'WORKFLOW_FAILED'|'PAUSED'|'PAUSING'|'PAUSING_FAILED'|'USER_ATTENTION_REQUIRED'|'DELETING'|'DELETION_FAILED'|'DELETED'|'COMPLETED', 'creationTime': datetime(2015, 1, 1), 'endTime': datetime(2015, 1, 1), 'statusMessage': 'string', 'completedSteps': 123, 'totalSteps': 123 }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **migrationWorkflowSummary** *(list) --* The summary of the migration workflow. * *(dict) --* The summary of a migration workflow. * **id** *(string) --* The ID of the migration workflow. * **name** *(string) --* The name of the migration workflow. * **templateId** *(string) --* The ID of the template. * **adsApplicationConfigurationName** *(string) --* The name of the application configured in Application Discovery Service. * **status** *(string) --* The status of the migration workflow. * **creationTime** *(datetime) --* The time at which the migration workflow was created. * **endTime** *(datetime) --* The time at which the migration workflow ended. * **statusMessage** *(string) --* The status message of the migration workflow. * **completedSteps** *(integer) --* The steps completed in the migration workflow. * **totalSteps** *(integer) --* All the steps in a migration workflow. * **NextToken** *(string) --* A token to resume pagination. MigrationHubOrchestrator / Paginator / ListTemplateStepGroups ListTemplateStepGroups ********************** class MigrationHubOrchestrator.Paginator.ListTemplateStepGroups paginator = client.get_paginator('list_template_step_groups') paginate(**kwargs) Creates an iterator that will paginate through responses from "MigrationHubOrchestrator.Client.list_template_step_groups()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( templateId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **templateId** (*string*) -- **[REQUIRED]** The ID of the template. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'templateStepGroupSummary': [ { 'id': 'string', 'name': 'string', 'previous': [ 'string', ], 'next': [ 'string', ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **templateStepGroupSummary** *(list) --* The summary of the step group in the template. * *(dict) --* The summary of the step group in the template. * **id** *(string) --* The ID of the step group. * **name** *(string) --* The name of the step group. * **previous** *(list) --* The previous step group. * *(string) --* * **next** *(list) --* The next step group. * *(string) --* * **NextToken** *(string) --* A token to resume pagination. MigrationHubOrchestrator / Paginator / ListTemplateSteps ListTemplateSteps ***************** class MigrationHubOrchestrator.Paginator.ListTemplateSteps paginator = client.get_paginator('list_template_steps') paginate(**kwargs) Creates an iterator that will paginate through responses from "MigrationHubOrchestrator.Client.list_template_steps()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( templateId='string', stepGroupId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **templateId** (*string*) -- **[REQUIRED]** The ID of the template. * **stepGroupId** (*string*) -- **[REQUIRED]** The ID of the step group. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'templateStepSummaryList': [ { 'id': 'string', 'stepGroupId': 'string', 'templateId': 'string', 'name': 'string', 'stepActionType': 'MANUAL'|'AUTOMATED', 'targetType': 'SINGLE'|'ALL'|'NONE', 'owner': 'AWS_MANAGED'|'CUSTOM', 'previous': [ 'string', ], 'next': [ 'string', ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **templateStepSummaryList** *(list) --* The list of summaries of steps in a template. * *(dict) --* The summary of the step. * **id** *(string) --* The ID of the step. * **stepGroupId** *(string) --* The ID of the step group. * **templateId** *(string) --* The ID of the template. * **name** *(string) --* The name of the step. * **stepActionType** *(string) --* The action type of the step. You must run and update the status of a manual step for the workflow to continue after the completion of the step. * **targetType** *(string) --* The servers on which to run the script. * **owner** *(string) --* The owner of the step. * **previous** *(list) --* The previous step. * *(string) --* * **next** *(list) --* The next step. * *(string) --* * **NextToken** *(string) --* A token to resume pagination. MigrationHubOrchestrator / Paginator / ListWorkflowStepGroups ListWorkflowStepGroups ********************** class MigrationHubOrchestrator.Paginator.ListWorkflowStepGroups paginator = client.get_paginator('list_workflow_step_groups') paginate(**kwargs) Creates an iterator that will paginate through responses from "MigrationHubOrchestrator.Client.list_workflow_step_groups()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( workflowId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **workflowId** (*string*) -- **[REQUIRED]** The ID of the migration workflow. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'workflowStepGroupsSummary': [ { 'id': 'string', 'name': 'string', 'owner': 'AWS_MANAGED'|'CUSTOM', 'status': 'AWAITING_DEPENDENCIES'|'READY'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'PAUSED'|'PAUSING'|'USER_ATTENTION_REQUIRED', 'previous': [ 'string', ], 'next': [ 'string', ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **workflowStepGroupsSummary** *(list) --* The summary of step groups in a migration workflow. * *(dict) --* The summary of a step group in a workflow. * **id** *(string) --* The ID of the step group. * **name** *(string) --* The name of the step group. * **owner** *(string) --* The owner of the step group. * **status** *(string) --* The status of the step group. * **previous** *(list) --* The previous step group. * *(string) --* * **next** *(list) --* The next step group. * *(string) --* * **NextToken** *(string) --* A token to resume pagination. MigrationHubOrchestrator / Client / list_workflow_steps list_workflow_steps ******************* MigrationHubOrchestrator.Client.list_workflow_steps(**kwargs) List the steps in a workflow. See also: AWS API Documentation **Request Syntax** response = client.list_workflow_steps( nextToken='string', maxResults=123, workflowId='string', stepGroupId='string' ) Parameters: * **nextToken** (*string*) -- The pagination token. * **maxResults** (*integer*) -- The maximum number of results that can be returned. * **workflowId** (*string*) -- **[REQUIRED]** The ID of the migration workflow. * **stepGroupId** (*string*) -- **[REQUIRED]** The ID of the step group. Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'workflowStepsSummary': [ { 'stepId': 'string', 'name': 'string', 'stepActionType': 'MANUAL'|'AUTOMATED', 'owner': 'AWS_MANAGED'|'CUSTOM', 'previous': [ 'string', ], 'next': [ 'string', ], 'status': 'AWAITING_DEPENDENCIES'|'SKIPPED'|'READY'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'PAUSED'|'USER_ATTENTION_REQUIRED', 'statusMessage': 'string', 'noOfSrvCompleted': 123, 'noOfSrvFailed': 123, 'totalNoOfSrv': 123, 'description': 'string', 'scriptLocation': 'string' }, ] } **Response Structure** * *(dict) --* * **nextToken** *(string) --* The pagination token. * **workflowStepsSummary** *(list) --* The summary of steps in a migration workflow. * *(dict) --* The summary of the step in a migration workflow. * **stepId** *(string) --* The ID of the step. * **name** *(string) --* The name of the step. * **stepActionType** *(string) --* The action type of the step. You must run and update the status of a manual step for the workflow to continue after the completion of the step. * **owner** *(string) --* The owner of the step. * **previous** *(list) --* The previous step. * *(string) --* * **next** *(list) --* The next step. * *(string) --* * **status** *(string) --* The status of the step. * **statusMessage** *(string) --* The status message of the migration workflow. * **noOfSrvCompleted** *(integer) --* The number of servers that have been migrated. * **noOfSrvFailed** *(integer) --* The number of servers that have failed to migrate. * **totalNoOfSrv** *(integer) --* The total number of servers that have been migrated. * **description** *(string) --* The description of the step. * **scriptLocation** *(string) --* The location of the script. **Exceptions** * "MigrationHubOrchestrator.Client.exceptions.ThrottlingException" * "MigrationHubOrchestrator.Client.exceptions.AccessDeniedExceptio n" * "MigrationHubOrchestrator.Client.exceptions.InternalServerExcept ion" * "MigrationHubOrchestrator.Client.exceptions.ValidationException" MigrationHubOrchestrator / Client / get_paginator get_paginator ************* MigrationHubOrchestrator.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. MigrationHubOrchestrator / Client / update_workflow_step_group update_workflow_step_group ************************** MigrationHubOrchestrator.Client.update_workflow_step_group(**kwargs) Update the step group in a migration workflow. See also: AWS API Documentation **Request Syntax** response = client.update_workflow_step_group( workflowId='string', id='string', name='string', description='string', next=[ 'string', ], previous=[ 'string', ] ) Parameters: * **workflowId** (*string*) -- **[REQUIRED]** The ID of the migration workflow. * **id** (*string*) -- **[REQUIRED]** The ID of the step group. * **name** (*string*) -- The name of the step group. * **description** (*string*) -- The description of the step group. * **next** (*list*) -- The next step group. * *(string) --* * **previous** (*list*) -- The previous step group. * *(string) --* Return type: dict Returns: **Response Syntax** { 'workflowId': 'string', 'name': 'string', 'id': 'string', 'description': 'string', 'tools': [ { 'name': 'string', 'url': 'string' }, ], 'next': [ 'string', ], 'previous': [ 'string', ], 'lastModifiedTime': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **workflowId** *(string) --* The ID of the migration workflow. * **name** *(string) --* The name of the step group. * **id** *(string) --* The ID of the step group. * **description** *(string) --* The description of the step group. * **tools** *(list) --* List of AWS services utilized in a migration workflow. * *(dict) --* List of AWS services utilized in a migration workflow. * **name** *(string) --* The name of an AWS service. * **url** *(string) --* The URL of an AWS service. * **next** *(list) --* The next step group. * *(string) --* * **previous** *(list) --* The previous step group. * *(string) --* * **lastModifiedTime** *(datetime) --* The time at which the step group was last modified. **Exceptions** * "MigrationHubOrchestrator.Client.exceptions.ThrottlingException" * "MigrationHubOrchestrator.Client.exceptions.AccessDeniedExceptio n" * "MigrationHubOrchestrator.Client.exceptions.InternalServerExcept ion" * "MigrationHubOrchestrator.Client.exceptions.ValidationException" * "MigrationHubOrchestrator.Client.exceptions.ResourceNotFoundExce ption" MigrationHubOrchestrator / Client / delete_template delete_template *************** MigrationHubOrchestrator.Client.delete_template(**kwargs) Deletes a migration workflow template. See also: AWS API Documentation **Request Syntax** response = client.delete_template( id='string' ) Parameters: **id** (*string*) -- **[REQUIRED]** The ID of the request to delete a migration workflow template. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "MigrationHubOrchestrator.Client.exceptions.ThrottlingException" * "MigrationHubOrchestrator.Client.exceptions.AccessDeniedExceptio n" * "MigrationHubOrchestrator.Client.exceptions.InternalServerExcept ion" * "MigrationHubOrchestrator.Client.exceptions.ValidationException" * "MigrationHubOrchestrator.Client.exceptions.ResourceNotFoundExce ption" MigrationHubOrchestrator / Client / get_template_step_group get_template_step_group *********************** MigrationHubOrchestrator.Client.get_template_step_group(**kwargs) Get a step group in a template. See also: AWS API Documentation **Request Syntax** response = client.get_template_step_group( templateId='string', id='string' ) Parameters: * **templateId** (*string*) -- **[REQUIRED]** The ID of the template. * **id** (*string*) -- **[REQUIRED]** The ID of the step group. Return type: dict Returns: **Response Syntax** { 'templateId': 'string', 'id': 'string', 'name': 'string', 'description': 'string', 'status': 'AWAITING_DEPENDENCIES'|'READY'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'PAUSED'|'PAUSING'|'USER_ATTENTION_REQUIRED', 'creationTime': datetime(2015, 1, 1), 'lastModifiedTime': datetime(2015, 1, 1), 'tools': [ { 'name': 'string', 'url': 'string' }, ], 'previous': [ 'string', ], 'next': [ 'string', ] } **Response Structure** * *(dict) --* * **templateId** *(string) --* The ID of the template. * **id** *(string) --* The ID of the step group. * **name** *(string) --* The name of the step group. * **description** *(string) --* The description of the step group. * **status** *(string) --* The status of the step group. * **creationTime** *(datetime) --* The time at which the step group was created. * **lastModifiedTime** *(datetime) --* The time at which the step group was last modified. * **tools** *(list) --* List of AWS services utilized in a migration workflow. * *(dict) --* List of AWS services utilized in a migration workflow. * **name** *(string) --* The name of an AWS service. * **url** *(string) --* The URL of an AWS service. * **previous** *(list) --* The previous step group. * *(string) --* * **next** *(list) --* The next step group. * *(string) --* **Exceptions** * "MigrationHubOrchestrator.Client.exceptions.ThrottlingException" * "MigrationHubOrchestrator.Client.exceptions.AccessDeniedExceptio n" * "MigrationHubOrchestrator.Client.exceptions.InternalServerExcept ion" * "MigrationHubOrchestrator.Client.exceptions.ValidationException" * "MigrationHubOrchestrator.Client.exceptions.ResourceNotFoundExce ption" MigrationHubOrchestrator / Client / can_paginate can_paginate ************ MigrationHubOrchestrator.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. MigrationHubOrchestrator / Client / get_workflow_step get_workflow_step ***************** MigrationHubOrchestrator.Client.get_workflow_step(**kwargs) Get a step in the migration workflow. See also: AWS API Documentation **Request Syntax** response = client.get_workflow_step( workflowId='string', stepGroupId='string', id='string' ) Parameters: * **workflowId** (*string*) -- **[REQUIRED]** The ID of the migration workflow. * **stepGroupId** (*string*) -- **[REQUIRED]** The ID of the step group. * **id** (*string*) -- **[REQUIRED]** The ID of the step. Return type: dict Returns: **Response Syntax** { 'name': 'string', 'stepGroupId': 'string', 'workflowId': 'string', 'stepId': 'string', 'description': 'string', 'stepActionType': 'MANUAL'|'AUTOMATED', 'owner': 'AWS_MANAGED'|'CUSTOM', 'workflowStepAutomationConfiguration': { 'scriptLocationS3Bucket': 'string', 'scriptLocationS3Key': { 'linux': 'string', 'windows': 'string' }, 'command': { 'linux': 'string', 'windows': 'string' }, 'runEnvironment': 'AWS'|'ONPREMISE', 'targetType': 'SINGLE'|'ALL'|'NONE' }, 'stepTarget': [ 'string', ], 'outputs': [ { 'name': 'string', 'dataType': 'STRING'|'INTEGER'|'STRINGLIST'|'STRINGMAP', 'required': True|False, 'value': { 'integerValue': 123, 'stringValue': 'string', 'listOfStringValue': [ 'string', ] } }, ], 'previous': [ 'string', ], 'next': [ 'string', ], 'status': 'AWAITING_DEPENDENCIES'|'SKIPPED'|'READY'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'PAUSED'|'USER_ATTENTION_REQUIRED', 'statusMessage': 'string', 'scriptOutputLocation': 'string', 'creationTime': datetime(2015, 1, 1), 'lastStartTime': datetime(2015, 1, 1), 'endTime': datetime(2015, 1, 1), 'noOfSrvCompleted': 123, 'noOfSrvFailed': 123, 'totalNoOfSrv': 123 } **Response Structure** * *(dict) --* * **name** *(string) --* The name of the step. * **stepGroupId** *(string) --* The ID of the step group. * **workflowId** *(string) --* The ID of the migration workflow. * **stepId** *(string) --* The ID of the step. * **description** *(string) --* The description of the step. * **stepActionType** *(string) --* The action type of the step. You must run and update the status of a manual step for the workflow to continue after the completion of the step. * **owner** *(string) --* The owner of the step. * **workflowStepAutomationConfiguration** *(dict) --* The custom script to run tests on source or target environments. * **scriptLocationS3Bucket** *(string) --* The Amazon S3 bucket where the script is located. * **scriptLocationS3Key** *(dict) --* The Amazon S3 key for the script location. * **linux** *(string) --* The script location for Linux. * **windows** *(string) --* The script location for Windows. * **command** *(dict) --* The command required to run the script. * **linux** *(string) --* Command for Linux. * **windows** *(string) --* Command for Windows. * **runEnvironment** *(string) --* The source or target environment. * **targetType** *(string) --* The servers on which to run the script. * **stepTarget** *(list) --* The servers on which a step will be run. * *(string) --* * **outputs** *(list) --* The outputs of the step. * *(dict) --* The output of a step. * **name** *(string) --* The name of the step. * **dataType** *(string) --* The data type of the output. * **required** *(boolean) --* Determine if an output is required from a step. * **value** *(dict) --* The value of the output. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "integerValue", "stringValue", "listOfStringValue". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **integerValue** *(integer) --* The integer value. * **stringValue** *(string) --* The string value. * **listOfStringValue** *(list) --* The list of string value. * *(string) --* * **previous** *(list) --* The previous step. * *(string) --* * **next** *(list) --* The next step. * *(string) --* * **status** *(string) --* The status of the step. * **statusMessage** *(string) --* The status message of the migration workflow. * **scriptOutputLocation** *(string) --* The output location of the script. * **creationTime** *(datetime) --* The time at which the step was created. * **lastStartTime** *(datetime) --* The time at which the workflow was last started. * **endTime** *(datetime) --* The time at which the step ended. * **noOfSrvCompleted** *(integer) --* The number of servers that have been migrated. * **noOfSrvFailed** *(integer) --* The number of servers that have failed to migrate. * **totalNoOfSrv** *(integer) --* The total number of servers that have been migrated. **Exceptions** * "MigrationHubOrchestrator.Client.exceptions.ThrottlingException" * "MigrationHubOrchestrator.Client.exceptions.AccessDeniedExceptio n" * "MigrationHubOrchestrator.Client.exceptions.InternalServerExcept ion" * "MigrationHubOrchestrator.Client.exceptions.ResourceNotFoundExce ption" MigrationHubOrchestrator / Client / stop_workflow stop_workflow ************* MigrationHubOrchestrator.Client.stop_workflow(**kwargs) Stop an ongoing migration workflow. See also: AWS API Documentation **Request Syntax** response = client.stop_workflow( id='string' ) Parameters: **id** (*string*) -- **[REQUIRED]** The ID of the migration workflow. Return type: dict Returns: **Response Syntax** { 'id': 'string', 'arn': 'string', 'status': 'CREATING'|'NOT_STARTED'|'CREATION_FAILED'|'STARTING'|'IN_PROGRESS'|'WORKFLOW_FAILED'|'PAUSED'|'PAUSING'|'PAUSING_FAILED'|'USER_ATTENTION_REQUIRED'|'DELETING'|'DELETION_FAILED'|'DELETED'|'COMPLETED', 'statusMessage': 'string', 'lastStopTime': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **id** *(string) --* The ID of the migration workflow. * **arn** *(string) --* The Amazon Resource Name (ARN) of the migration workflow. * **status** *(string) --* The status of the migration workflow. * **statusMessage** *(string) --* The status message of the migration workflow. * **lastStopTime** *(datetime) --* The time at which the migration workflow was stopped. **Exceptions** * "MigrationHubOrchestrator.Client.exceptions.ThrottlingException" * "MigrationHubOrchestrator.Client.exceptions.AccessDeniedExceptio n" * "MigrationHubOrchestrator.Client.exceptions.InternalServerExcept ion" * "MigrationHubOrchestrator.Client.exceptions.ValidationException" * "MigrationHubOrchestrator.Client.exceptions.ResourceNotFoundExce ption" MigrationHubOrchestrator / Client / delete_workflow delete_workflow *************** MigrationHubOrchestrator.Client.delete_workflow(**kwargs) Delete a migration workflow. You must pause a running workflow in Migration Hub Orchestrator console to delete it. See also: AWS API Documentation **Request Syntax** response = client.delete_workflow( id='string' ) Parameters: **id** (*string*) -- **[REQUIRED]** The ID of the migration workflow you want to delete. Return type: dict Returns: **Response Syntax** { 'id': 'string', 'arn': 'string', 'status': 'CREATING'|'NOT_STARTED'|'CREATION_FAILED'|'STARTING'|'IN_PROGRESS'|'WORKFLOW_FAILED'|'PAUSED'|'PAUSING'|'PAUSING_FAILED'|'USER_ATTENTION_REQUIRED'|'DELETING'|'DELETION_FAILED'|'DELETED'|'COMPLETED' } **Response Structure** * *(dict) --* * **id** *(string) --* The ID of the migration workflow. * **arn** *(string) --* The Amazon Resource Name (ARN) of the migration workflow. * **status** *(string) --* The status of the migration workflow. **Exceptions** * "MigrationHubOrchestrator.Client.exceptions.ThrottlingException" * "MigrationHubOrchestrator.Client.exceptions.AccessDeniedExceptio n" * "MigrationHubOrchestrator.Client.exceptions.InternalServerExcept ion" * "MigrationHubOrchestrator.Client.exceptions.ValidationException" * "MigrationHubOrchestrator.Client.exceptions.ResourceNotFoundExce ption" MigrationHubOrchestrator / Client / update_workflow_step update_workflow_step ******************** MigrationHubOrchestrator.Client.update_workflow_step(**kwargs) Update a step in a migration workflow. See also: AWS API Documentation **Request Syntax** response = client.update_workflow_step( id='string', stepGroupId='string', workflowId='string', name='string', description='string', stepActionType='MANUAL'|'AUTOMATED', workflowStepAutomationConfiguration={ 'scriptLocationS3Bucket': 'string', 'scriptLocationS3Key': { 'linux': 'string', 'windows': 'string' }, 'command': { 'linux': 'string', 'windows': 'string' }, 'runEnvironment': 'AWS'|'ONPREMISE', 'targetType': 'SINGLE'|'ALL'|'NONE' }, stepTarget=[ 'string', ], outputs=[ { 'name': 'string', 'dataType': 'STRING'|'INTEGER'|'STRINGLIST'|'STRINGMAP', 'required': True|False, 'value': { 'integerValue': 123, 'stringValue': 'string', 'listOfStringValue': [ 'string', ] } }, ], previous=[ 'string', ], next=[ 'string', ], status='AWAITING_DEPENDENCIES'|'SKIPPED'|'READY'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'PAUSED'|'USER_ATTENTION_REQUIRED' ) Parameters: * **id** (*string*) -- **[REQUIRED]** The ID of the step. * **stepGroupId** (*string*) -- **[REQUIRED]** The ID of the step group. * **workflowId** (*string*) -- **[REQUIRED]** The ID of the migration workflow. * **name** (*string*) -- The name of the step. * **description** (*string*) -- The description of the step. * **stepActionType** (*string*) -- The action type of the step. You must run and update the status of a manual step for the workflow to continue after the completion of the step. * **workflowStepAutomationConfiguration** (*dict*) -- The custom script to run tests on the source and target environments. * **scriptLocationS3Bucket** *(string) --* The Amazon S3 bucket where the script is located. * **scriptLocationS3Key** *(dict) --* The Amazon S3 key for the script location. * **linux** *(string) --* The script location for Linux. * **windows** *(string) --* The script location for Windows. * **command** *(dict) --* The command required to run the script. * **linux** *(string) --* Command for Linux. * **windows** *(string) --* Command for Windows. * **runEnvironment** *(string) --* The source or target environment. * **targetType** *(string) --* The servers on which to run the script. * **stepTarget** (*list*) -- The servers on which a step will be run. * *(string) --* * **outputs** (*list*) -- The outputs of a step. * *(dict) --* The output of a step. * **name** *(string) --* The name of the step. * **dataType** *(string) --* The data type of the output. * **required** *(boolean) --* Determine if an output is required from a step. * **value** *(dict) --* The value of the output. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "integerValue", "stringValue", "listOfStringValue". * **integerValue** *(integer) --* The integer value. * **stringValue** *(string) --* The string value. * **listOfStringValue** *(list) --* The list of string value. * *(string) --* * **previous** (*list*) -- The previous step. * *(string) --* * **next** (*list*) -- The next step. * *(string) --* * **status** (*string*) -- The status of the step. Return type: dict Returns: **Response Syntax** { 'id': 'string', 'stepGroupId': 'string', 'workflowId': 'string', 'name': 'string' } **Response Structure** * *(dict) --* * **id** *(string) --* The ID of the step. * **stepGroupId** *(string) --* The ID of the step group. * **workflowId** *(string) --* The ID of the migration workflow. * **name** *(string) --* The name of the step. **Exceptions** * "MigrationHubOrchestrator.Client.exceptions.ThrottlingException" * "MigrationHubOrchestrator.Client.exceptions.AccessDeniedExceptio n" * "MigrationHubOrchestrator.Client.exceptions.InternalServerExcept ion" * "MigrationHubOrchestrator.Client.exceptions.ValidationException" MigrationHubOrchestrator / Client / get_workflow get_workflow ************ MigrationHubOrchestrator.Client.get_workflow(**kwargs) Get migration workflow. See also: AWS API Documentation **Request Syntax** response = client.get_workflow( id='string' ) Parameters: **id** (*string*) -- **[REQUIRED]** The ID of the migration workflow. Return type: dict Returns: **Response Syntax** { 'id': 'string', 'arn': 'string', 'name': 'string', 'description': 'string', 'templateId': 'string', 'adsApplicationConfigurationId': 'string', 'adsApplicationName': 'string', 'status': 'CREATING'|'NOT_STARTED'|'CREATION_FAILED'|'STARTING'|'IN_PROGRESS'|'WORKFLOW_FAILED'|'PAUSED'|'PAUSING'|'PAUSING_FAILED'|'USER_ATTENTION_REQUIRED'|'DELETING'|'DELETION_FAILED'|'DELETED'|'COMPLETED', 'statusMessage': 'string', 'creationTime': datetime(2015, 1, 1), 'lastStartTime': datetime(2015, 1, 1), 'lastStopTime': datetime(2015, 1, 1), 'lastModifiedTime': datetime(2015, 1, 1), 'endTime': datetime(2015, 1, 1), 'tools': [ { 'name': 'string', 'url': 'string' }, ], 'totalSteps': 123, 'completedSteps': 123, 'workflowInputs': { 'string': { 'integerValue': 123, 'stringValue': 'string', 'listOfStringsValue': [ 'string', ], 'mapOfStringValue': { 'string': 'string' } } }, 'tags': { 'string': 'string' }, 'workflowBucket': 'string' } **Response Structure** * *(dict) --* * **id** *(string) --* The ID of the migration workflow. * **arn** *(string) --* The Amazon Resource Name (ARN) of the migration workflow. * **name** *(string) --* The name of the migration workflow. * **description** *(string) --* The description of the migration workflow. * **templateId** *(string) --* The ID of the template. * **adsApplicationConfigurationId** *(string) --* The configuration ID of the application configured in Application Discovery Service. * **adsApplicationName** *(string) --* The name of the application configured in Application Discovery Service. * **status** *(string) --* The status of the migration workflow. * **statusMessage** *(string) --* The status message of the migration workflow. * **creationTime** *(datetime) --* The time at which the migration workflow was created. * **lastStartTime** *(datetime) --* The time at which the migration workflow was last started. * **lastStopTime** *(datetime) --* The time at which the migration workflow was last stopped. * **lastModifiedTime** *(datetime) --* The time at which the migration workflow was last modified. * **endTime** *(datetime) --* The time at which the migration workflow ended. * **tools** *(list) --* List of AWS services utilized in a migration workflow. * *(dict) --* List of AWS services utilized in a migration workflow. * **name** *(string) --* The name of an AWS service. * **url** *(string) --* The URL of an AWS service. * **totalSteps** *(integer) --* The total number of steps in the migration workflow. * **completedSteps** *(integer) --* Get a list of completed steps in the migration workflow. * **workflowInputs** *(dict) --* The inputs required for creating the migration workflow. * *(string) --* * *(dict) --* A map of key value pairs that is generated when you create a migration workflow. The key value pairs will differ based on your selection of the template. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "integerValue", "stringValue", "listOfStringsValue", "mapOfStringValue". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **integerValue** *(integer) --* The value of the integer. * **stringValue** *(string) --* String value. * **listOfStringsValue** *(list) --* List of string values. * *(string) --* * **mapOfStringValue** *(dict) --* Map of string values. * *(string) --* * *(string) --* * **tags** *(dict) --* The tags added to the migration workflow. * *(string) --* * *(string) --* * **workflowBucket** *(string) --* The Amazon S3 bucket where the migration logs are stored. **Exceptions** * "MigrationHubOrchestrator.Client.exceptions.ThrottlingException" * "MigrationHubOrchestrator.Client.exceptions.AccessDeniedExceptio n" * "MigrationHubOrchestrator.Client.exceptions.InternalServerExcept ion" * "MigrationHubOrchestrator.Client.exceptions.ValidationException" * "MigrationHubOrchestrator.Client.exceptions.ResourceNotFoundExce ption" MigrationHubOrchestrator / Client / list_tags_for_resource list_tags_for_resource ********************** MigrationHubOrchestrator.Client.list_tags_for_resource(**kwargs) List the tags added to a resource. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( resourceArn='string' ) Parameters: **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource. Return type: dict Returns: **Response Syntax** { 'tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **tags** *(dict) --* The tags added to a resource. * *(string) --* * *(string) --* **Exceptions** * "MigrationHubOrchestrator.Client.exceptions.ValidationException" * "MigrationHubOrchestrator.Client.exceptions.ResourceNotFoundExce ption" MigrationHubOrchestrator / Client / list_template_steps list_template_steps ******************* MigrationHubOrchestrator.Client.list_template_steps(**kwargs) List the steps in a template. See also: AWS API Documentation **Request Syntax** response = client.list_template_steps( maxResults=123, nextToken='string', templateId='string', stepGroupId='string' ) Parameters: * **maxResults** (*integer*) -- The maximum number of results that can be returned. * **nextToken** (*string*) -- The pagination token. * **templateId** (*string*) -- **[REQUIRED]** The ID of the template. * **stepGroupId** (*string*) -- **[REQUIRED]** The ID of the step group. Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'templateStepSummaryList': [ { 'id': 'string', 'stepGroupId': 'string', 'templateId': 'string', 'name': 'string', 'stepActionType': 'MANUAL'|'AUTOMATED', 'targetType': 'SINGLE'|'ALL'|'NONE', 'owner': 'AWS_MANAGED'|'CUSTOM', 'previous': [ 'string', ], 'next': [ 'string', ] }, ] } **Response Structure** * *(dict) --* * **nextToken** *(string) --* The pagination token. * **templateStepSummaryList** *(list) --* The list of summaries of steps in a template. * *(dict) --* The summary of the step. * **id** *(string) --* The ID of the step. * **stepGroupId** *(string) --* The ID of the step group. * **templateId** *(string) --* The ID of the template. * **name** *(string) --* The name of the step. * **stepActionType** *(string) --* The action type of the step. You must run and update the status of a manual step for the workflow to continue after the completion of the step. * **targetType** *(string) --* The servers on which to run the script. * **owner** *(string) --* The owner of the step. * **previous** *(list) --* The previous step. * *(string) --* * **next** *(list) --* The next step. * *(string) --* **Exceptions** * "MigrationHubOrchestrator.Client.exceptions.ThrottlingException" * "MigrationHubOrchestrator.Client.exceptions.AccessDeniedExceptio n" * "MigrationHubOrchestrator.Client.exceptions.InternalServerExcept ion" * "MigrationHubOrchestrator.Client.exceptions.ValidationException" * "MigrationHubOrchestrator.Client.exceptions.ResourceNotFoundExce ption" MigrationHubOrchestrator / Client / untag_resource untag_resource ************** MigrationHubOrchestrator.Client.untag_resource(**kwargs) Deletes the tags for a resource. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( resourceArn='string', tagKeys=[ 'string', ] ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource from which you want to remove tags. * **tagKeys** (*list*) -- **[REQUIRED]** One or more tag keys. Specify only the tag keys, not the tag values. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "MigrationHubOrchestrator.Client.exceptions.ValidationException" * "MigrationHubOrchestrator.Client.exceptions.ResourceNotFoundExce ption" MigrationHubOrchestrator / Client / list_plugins list_plugins ************ MigrationHubOrchestrator.Client.list_plugins(**kwargs) List AWS Migration Hub Orchestrator plugins. See also: AWS API Documentation **Request Syntax** response = client.list_plugins( maxResults=123, nextToken='string' ) Parameters: * **maxResults** (*integer*) -- The maximum number of plugins that can be returned. * **nextToken** (*string*) -- The pagination token. Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'plugins': [ { 'pluginId': 'string', 'hostname': 'string', 'status': 'HEALTHY'|'UNHEALTHY', 'ipAddress': 'string', 'version': 'string', 'registeredTime': 'string' }, ] } **Response Structure** * *(dict) --* * **nextToken** *(string) --* The pagination token. * **plugins** *(list) --* Migration Hub Orchestrator plugins. * *(dict) --* The summary of the Migration Hub Orchestrator plugin. * **pluginId** *(string) --* The ID of the plugin. * **hostname** *(string) --* The name of the host. * **status** *(string) --* The status of the plugin. * **ipAddress** *(string) --* The IP address at which the plugin is located. * **version** *(string) --* The version of the plugin. * **registeredTime** *(string) --* The time at which the plugin was registered. **Exceptions** * "MigrationHubOrchestrator.Client.exceptions.AccessDeniedExceptio n" * "MigrationHubOrchestrator.Client.exceptions.InternalServerExcept ion" * "MigrationHubOrchestrator.Client.exceptions.ValidationException" MigrationHubOrchestrator / Client / get_waiter get_waiter ********** MigrationHubOrchestrator.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" MigrationHubOrchestrator / Client / delete_workflow_step delete_workflow_step ******************** MigrationHubOrchestrator.Client.delete_workflow_step(**kwargs) Delete a step in a migration workflow. Pause the workflow to delete a running step. See also: AWS API Documentation **Request Syntax** response = client.delete_workflow_step( id='string', stepGroupId='string', workflowId='string' ) Parameters: * **id** (*string*) -- **[REQUIRED]** The ID of the step you want to delete. * **stepGroupId** (*string*) -- **[REQUIRED]** The ID of the step group that contains the step you want to delete. * **workflowId** (*string*) -- **[REQUIRED]** The ID of the migration workflow. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "MigrationHubOrchestrator.Client.exceptions.ThrottlingException" * "MigrationHubOrchestrator.Client.exceptions.AccessDeniedExceptio n" * "MigrationHubOrchestrator.Client.exceptions.InternalServerExcept ion" * "MigrationHubOrchestrator.Client.exceptions.ValidationException" * "MigrationHubOrchestrator.Client.exceptions.ResourceNotFoundExce ption" MigrationHubOrchestrator / Client / retry_workflow_step retry_workflow_step ******************* MigrationHubOrchestrator.Client.retry_workflow_step(**kwargs) Retry a failed step in a migration workflow. See also: AWS API Documentation **Request Syntax** response = client.retry_workflow_step( workflowId='string', stepGroupId='string', id='string' ) Parameters: * **workflowId** (*string*) -- **[REQUIRED]** The ID of the migration workflow. * **stepGroupId** (*string*) -- **[REQUIRED]** The ID of the step group. * **id** (*string*) -- **[REQUIRED]** The ID of the step. Return type: dict Returns: **Response Syntax** { 'stepGroupId': 'string', 'workflowId': 'string', 'id': 'string', 'status': 'AWAITING_DEPENDENCIES'|'SKIPPED'|'READY'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'PAUSED'|'USER_ATTENTION_REQUIRED' } **Response Structure** * *(dict) --* * **stepGroupId** *(string) --* The ID of the step group. * **workflowId** *(string) --* The ID of the migration workflow. * **id** *(string) --* The ID of the step. * **status** *(string) --* The status of the step. **Exceptions** * "MigrationHubOrchestrator.Client.exceptions.ThrottlingException" * "MigrationHubOrchestrator.Client.exceptions.AccessDeniedExceptio n" * "MigrationHubOrchestrator.Client.exceptions.InternalServerExcept ion" * "MigrationHubOrchestrator.Client.exceptions.ResourceNotFoundExce ption" MigrationHubOrchestrator / Client / get_template get_template ************ MigrationHubOrchestrator.Client.get_template(**kwargs) Get the template you want to use for creating a migration workflow. See also: AWS API Documentation **Request Syntax** response = client.get_template( id='string' ) Parameters: **id** (*string*) -- **[REQUIRED]** The ID of the template. Return type: dict Returns: **Response Syntax** { 'id': 'string', 'templateArn': 'string', 'name': 'string', 'description': 'string', 'inputs': [ { 'inputName': 'string', 'dataType': 'STRING'|'INTEGER'|'STRINGLIST'|'STRINGMAP', 'required': True|False }, ], 'tools': [ { 'name': 'string', 'url': 'string' }, ], 'creationTime': datetime(2015, 1, 1), 'owner': 'string', 'status': 'CREATED'|'READY'|'PENDING_CREATION'|'CREATING'|'CREATION_FAILED', 'statusMessage': 'string', 'templateClass': 'string', 'tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **id** *(string) --* The ID of the template. * **templateArn** *(string) --* >The Amazon Resource Name (ARN) of the migration workflow template. The format for an Migration Hub Orchestrator template ARN is "arn:aws:migrationhub- orchestrator:region:account:template/template-abcd1234". For more information about ARNs, see Amazon Resource Names (ARNs) in the *AWS General Reference*. * **name** *(string) --* The name of the template. * **description** *(string) --* The time at which the template was last created. * **inputs** *(list) --* The inputs provided for the creation of the migration workflow. * *(dict) --* The input parameters of a template. * **inputName** *(string) --* The name of the template. * **dataType** *(string) --* The data type of the template input. * **required** *(boolean) --* Determine if an input is required from the template. * **tools** *(list) --* List of AWS services utilized in a migration workflow. * *(dict) --* List of AWS services utilized in a migration workflow. * **name** *(string) --* The name of an AWS service. * **url** *(string) --* The URL of an AWS service. * **creationTime** *(datetime) --* The time at which the template was last created. * **owner** *(string) --* The owner of the migration workflow template. * **status** *(string) --* The status of the template. * **statusMessage** *(string) --* The status message of retrieving migration workflow templates. * **templateClass** *(string) --* The class of the migration workflow template. The available template classes are: * A2C * MGN * SAP_MULTI * SQL_EC2 * SQL_RDS * VMIE * **tags** *(dict) --* The tags added to the migration workflow template. * *(string) --* * *(string) --* **Exceptions** * "MigrationHubOrchestrator.Client.exceptions.ThrottlingException" * "MigrationHubOrchestrator.Client.exceptions.AccessDeniedExceptio n" * "MigrationHubOrchestrator.Client.exceptions.InternalServerExcept ion" * "MigrationHubOrchestrator.Client.exceptions.ResourceNotFoundExce ption" MigrationHubOrchestrator / Client / create_workflow_step_group create_workflow_step_group ************************** MigrationHubOrchestrator.Client.create_workflow_step_group(**kwargs) Create a step group in a migration workflow. See also: AWS API Documentation **Request Syntax** response = client.create_workflow_step_group( workflowId='string', name='string', description='string', next=[ 'string', ], previous=[ 'string', ] ) Parameters: * **workflowId** (*string*) -- **[REQUIRED]** The ID of the migration workflow that will contain the step group. * **name** (*string*) -- **[REQUIRED]** The name of the step group. * **description** (*string*) -- The description of the step group. * **next** (*list*) -- The next step group. * *(string) --* * **previous** (*list*) -- The previous step group. * *(string) --* Return type: dict Returns: **Response Syntax** { 'workflowId': 'string', 'name': 'string', 'id': 'string', 'description': 'string', 'tools': [ { 'name': 'string', 'url': 'string' }, ], 'next': [ 'string', ], 'previous': [ 'string', ], 'creationTime': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **workflowId** *(string) --* The ID of the migration workflow that contains the step group. * **name** *(string) --* The name of the step group. * **id** *(string) --* The ID of the step group. * **description** *(string) --* The description of the step group. * **tools** *(list) --* List of AWS services utilized in a migration workflow. * *(dict) --* List of AWS services utilized in a migration workflow. * **name** *(string) --* The name of an AWS service. * **url** *(string) --* The URL of an AWS service. * **next** *(list) --* The next step group. * *(string) --* * **previous** *(list) --* The previous step group. * *(string) --* * **creationTime** *(datetime) --* The time at which the step group is created. **Exceptions** * "MigrationHubOrchestrator.Client.exceptions.ThrottlingException" * "MigrationHubOrchestrator.Client.exceptions.AccessDeniedExceptio n" * "MigrationHubOrchestrator.Client.exceptions.InternalServerExcept ion" * "MigrationHubOrchestrator.Client.exceptions.ValidationException" MigrationHubOrchestrator / Client / update_workflow update_workflow *************** MigrationHubOrchestrator.Client.update_workflow(**kwargs) Update a migration workflow. See also: AWS API Documentation **Request Syntax** response = client.update_workflow( id='string', name='string', description='string', inputParameters={ 'string': { 'integerValue': 123, 'stringValue': 'string', 'listOfStringsValue': [ 'string', ], 'mapOfStringValue': { 'string': 'string' } } }, stepTargets=[ 'string', ] ) Parameters: * **id** (*string*) -- **[REQUIRED]** The ID of the migration workflow. * **name** (*string*) -- The name of the migration workflow. * **description** (*string*) -- The description of the migration workflow. * **inputParameters** (*dict*) -- The input parameters required to update a migration workflow. * *(string) --* * *(dict) --* A map of key value pairs that is generated when you create a migration workflow. The key value pairs will differ based on your selection of the template. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "integerValue", "stringValue", "listOfStringsValue", "mapOfStringValue". * **integerValue** *(integer) --* The value of the integer. * **stringValue** *(string) --* String value. * **listOfStringsValue** *(list) --* List of string values. * *(string) --* * **mapOfStringValue** *(dict) --* Map of string values. * *(string) --* * *(string) --* * **stepTargets** (*list*) -- The servers on which a step will be run. * *(string) --* Return type: dict Returns: **Response Syntax** { 'id': 'string', 'arn': 'string', 'name': 'string', 'description': 'string', 'templateId': 'string', 'adsApplicationConfigurationId': 'string', 'workflowInputs': { 'string': { 'integerValue': 123, 'stringValue': 'string', 'listOfStringsValue': [ 'string', ], 'mapOfStringValue': { 'string': 'string' } } }, 'stepTargets': [ 'string', ], 'status': 'CREATING'|'NOT_STARTED'|'CREATION_FAILED'|'STARTING'|'IN_PROGRESS'|'WORKFLOW_FAILED'|'PAUSED'|'PAUSING'|'PAUSING_FAILED'|'USER_ATTENTION_REQUIRED'|'DELETING'|'DELETION_FAILED'|'DELETED'|'COMPLETED', 'creationTime': datetime(2015, 1, 1), 'lastModifiedTime': datetime(2015, 1, 1), 'tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **id** *(string) --* The ID of the migration workflow. * **arn** *(string) --* The Amazon Resource Name (ARN) of the migration workflow. * **name** *(string) --* The name of the migration workflow. * **description** *(string) --* The description of the migration workflow. * **templateId** *(string) --* The ID of the template. * **adsApplicationConfigurationId** *(string) --* The ID of the application configured in Application Discovery Service. * **workflowInputs** *(dict) --* The inputs required to update a migration workflow. * *(string) --* * *(dict) --* A map of key value pairs that is generated when you create a migration workflow. The key value pairs will differ based on your selection of the template. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "integerValue", "stringValue", "listOfStringsValue", "mapOfStringValue". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **integerValue** *(integer) --* The value of the integer. * **stringValue** *(string) --* String value. * **listOfStringsValue** *(list) --* List of string values. * *(string) --* * **mapOfStringValue** *(dict) --* Map of string values. * *(string) --* * *(string) --* * **stepTargets** *(list) --* The servers on which a step will be run. * *(string) --* * **status** *(string) --* The status of the migration workflow. * **creationTime** *(datetime) --* The time at which the migration workflow was created. * **lastModifiedTime** *(datetime) --* The time at which the migration workflow was last modified. * **tags** *(dict) --* The tags added to the migration workflow. * *(string) --* * *(string) --* **Exceptions** * "MigrationHubOrchestrator.Client.exceptions.ThrottlingException" * "MigrationHubOrchestrator.Client.exceptions.AccessDeniedExceptio n" * "MigrationHubOrchestrator.Client.exceptions.InternalServerExcept ion" * "MigrationHubOrchestrator.Client.exceptions.ValidationException" * "MigrationHubOrchestrator.Client.exceptions.ResourceNotFoundExce ption" MigrationHubOrchestrator / Client / list_template_step_groups list_template_step_groups ************************* MigrationHubOrchestrator.Client.list_template_step_groups(**kwargs) List the step groups in a template. See also: AWS API Documentation **Request Syntax** response = client.list_template_step_groups( maxResults=123, nextToken='string', templateId='string' ) Parameters: * **maxResults** (*integer*) -- The maximum number of results that can be returned. * **nextToken** (*string*) -- The pagination token. * **templateId** (*string*) -- **[REQUIRED]** The ID of the template. Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'templateStepGroupSummary': [ { 'id': 'string', 'name': 'string', 'previous': [ 'string', ], 'next': [ 'string', ] }, ] } **Response Structure** * *(dict) --* * **nextToken** *(string) --* The pagination token. * **templateStepGroupSummary** *(list) --* The summary of the step group in the template. * *(dict) --* The summary of the step group in the template. * **id** *(string) --* The ID of the step group. * **name** *(string) --* The name of the step group. * **previous** *(list) --* The previous step group. * *(string) --* * **next** *(list) --* The next step group. * *(string) --* **Exceptions** * "MigrationHubOrchestrator.Client.exceptions.ThrottlingException" * "MigrationHubOrchestrator.Client.exceptions.AccessDeniedExceptio n" * "MigrationHubOrchestrator.Client.exceptions.InternalServerExcept ion" * "MigrationHubOrchestrator.Client.exceptions.ResourceNotFoundExce ption" MigrationHubOrchestrator / Client / delete_workflow_step_group delete_workflow_step_group ************************** MigrationHubOrchestrator.Client.delete_workflow_step_group(**kwargs) Delete a step group in a migration workflow. See also: AWS API Documentation **Request Syntax** response = client.delete_workflow_step_group( workflowId='string', id='string' ) Parameters: * **workflowId** (*string*) -- **[REQUIRED]** The ID of the migration workflow. * **id** (*string*) -- **[REQUIRED]** The ID of the step group you want to delete. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "MigrationHubOrchestrator.Client.exceptions.ThrottlingException" * "MigrationHubOrchestrator.Client.exceptions.AccessDeniedExceptio n" * "MigrationHubOrchestrator.Client.exceptions.InternalServerExcept ion" * "MigrationHubOrchestrator.Client.exceptions.ValidationException" * "MigrationHubOrchestrator.Client.exceptions.ResourceNotFoundExce ption" MigrationHubOrchestrator / Client / create_template create_template *************** MigrationHubOrchestrator.Client.create_template(**kwargs) Creates a migration workflow template. See also: AWS API Documentation **Request Syntax** response = client.create_template( templateName='string', templateDescription='string', templateSource={ 'workflowId': 'string' }, clientToken='string', tags={ 'string': 'string' } ) Parameters: * **templateName** (*string*) -- **[REQUIRED]** The name of the migration workflow template. * **templateDescription** (*string*) -- A description of the migration workflow template. * **templateSource** (*dict*) -- **[REQUIRED]** The source of the migration workflow template. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "workflowId". * **workflowId** *(string) --* The ID of the workflow from the source migration workflow template. * **clientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Idempotency in the Smithy documentation. This field is autopopulated if not provided. * **tags** (*dict*) -- The tags to add to the migration workflow template. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'templateId': 'string', 'templateArn': 'string', 'tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **templateId** *(string) --* The ID of the migration workflow template. * **templateArn** *(string) --* The Amazon Resource Name (ARN) of the migration workflow template. The format for an Migration Hub Orchestrator template ARN is "arn:aws:migrationhub- orchestrator:region:account:template/template-abcd1234". For more information about ARNs, see Amazon Resource Names (ARNs) in the *AWS General Reference*. * **tags** *(dict) --* The tags added to the migration workflow template. * *(string) --* * *(string) --* **Exceptions** * "MigrationHubOrchestrator.Client.exceptions.ThrottlingException" * "MigrationHubOrchestrator.Client.exceptions.ConflictException" * "MigrationHubOrchestrator.Client.exceptions.AccessDeniedExceptio n" * "MigrationHubOrchestrator.Client.exceptions.InternalServerExcept ion" * "MigrationHubOrchestrator.Client.exceptions.ValidationException" MigrationHubOrchestrator / Client / create_workflow create_workflow *************** MigrationHubOrchestrator.Client.create_workflow(**kwargs) Create a workflow to orchestrate your migrations. See also: AWS API Documentation **Request Syntax** response = client.create_workflow( name='string', description='string', templateId='string', applicationConfigurationId='string', inputParameters={ 'string': { 'integerValue': 123, 'stringValue': 'string', 'listOfStringsValue': [ 'string', ], 'mapOfStringValue': { 'string': 'string' } } }, stepTargets=[ 'string', ], tags={ 'string': 'string' } ) Parameters: * **name** (*string*) -- **[REQUIRED]** The name of the migration workflow. * **description** (*string*) -- The description of the migration workflow. * **templateId** (*string*) -- **[REQUIRED]** The ID of the template. * **applicationConfigurationId** (*string*) -- The configuration ID of the application configured in Application Discovery Service. * **inputParameters** (*dict*) -- **[REQUIRED]** The input parameters required to create a migration workflow. * *(string) --* * *(dict) --* A map of key value pairs that is generated when you create a migration workflow. The key value pairs will differ based on your selection of the template. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "integerValue", "stringValue", "listOfStringsValue", "mapOfStringValue". * **integerValue** *(integer) --* The value of the integer. * **stringValue** *(string) --* String value. * **listOfStringsValue** *(list) --* List of string values. * *(string) --* * **mapOfStringValue** *(dict) --* Map of string values. * *(string) --* * *(string) --* * **stepTargets** (*list*) -- The servers on which a step will be run. * *(string) --* * **tags** (*dict*) -- The tags to add on a migration workflow. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'id': 'string', 'arn': 'string', 'name': 'string', 'description': 'string', 'templateId': 'string', 'adsApplicationConfigurationId': 'string', 'workflowInputs': { 'string': { 'integerValue': 123, 'stringValue': 'string', 'listOfStringsValue': [ 'string', ], 'mapOfStringValue': { 'string': 'string' } } }, 'stepTargets': [ 'string', ], 'status': 'CREATING'|'NOT_STARTED'|'CREATION_FAILED'|'STARTING'|'IN_PROGRESS'|'WORKFLOW_FAILED'|'PAUSED'|'PAUSING'|'PAUSING_FAILED'|'USER_ATTENTION_REQUIRED'|'DELETING'|'DELETION_FAILED'|'DELETED'|'COMPLETED', 'creationTime': datetime(2015, 1, 1), 'tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **id** *(string) --* The ID of the migration workflow. * **arn** *(string) --* The Amazon Resource Name (ARN) of the migration workflow. * **name** *(string) --* The name of the migration workflow. * **description** *(string) --* The description of the migration workflow. * **templateId** *(string) --* The ID of the template. * **adsApplicationConfigurationId** *(string) --* The configuration ID of the application configured in Application Discovery Service. * **workflowInputs** *(dict) --* The inputs for creating a migration workflow. * *(string) --* * *(dict) --* A map of key value pairs that is generated when you create a migration workflow. The key value pairs will differ based on your selection of the template. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "integerValue", "stringValue", "listOfStringsValue", "mapOfStringValue". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **integerValue** *(integer) --* The value of the integer. * **stringValue** *(string) --* String value. * **listOfStringsValue** *(list) --* List of string values. * *(string) --* * **mapOfStringValue** *(dict) --* Map of string values. * *(string) --* * *(string) --* * **stepTargets** *(list) --* The servers on which a step will be run. * *(string) --* * **status** *(string) --* The status of the migration workflow. * **creationTime** *(datetime) --* The time at which the migration workflow was created. * **tags** *(dict) --* The tags to add on a migration workflow. * *(string) --* * *(string) --* **Exceptions** * "MigrationHubOrchestrator.Client.exceptions.ThrottlingException" * "MigrationHubOrchestrator.Client.exceptions.AccessDeniedExceptio n" * "MigrationHubOrchestrator.Client.exceptions.InternalServerExcept ion" * "MigrationHubOrchestrator.Client.exceptions.ValidationException" MigrationHubOrchestrator / Client / start_workflow start_workflow ************** MigrationHubOrchestrator.Client.start_workflow(**kwargs) Start a migration workflow. See also: AWS API Documentation **Request Syntax** response = client.start_workflow( id='string' ) Parameters: **id** (*string*) -- **[REQUIRED]** The ID of the migration workflow. Return type: dict Returns: **Response Syntax** { 'id': 'string', 'arn': 'string', 'status': 'CREATING'|'NOT_STARTED'|'CREATION_FAILED'|'STARTING'|'IN_PROGRESS'|'WORKFLOW_FAILED'|'PAUSED'|'PAUSING'|'PAUSING_FAILED'|'USER_ATTENTION_REQUIRED'|'DELETING'|'DELETION_FAILED'|'DELETED'|'COMPLETED', 'statusMessage': 'string', 'lastStartTime': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **id** *(string) --* The ID of the migration workflow. * **arn** *(string) --* The Amazon Resource Name (ARN) of the migration workflow. * **status** *(string) --* The status of the migration workflow. * **statusMessage** *(string) --* The status message of the migration workflow. * **lastStartTime** *(datetime) --* The time at which the migration workflow was last started. **Exceptions** * "MigrationHubOrchestrator.Client.exceptions.ThrottlingException" * "MigrationHubOrchestrator.Client.exceptions.AccessDeniedExceptio n" * "MigrationHubOrchestrator.Client.exceptions.InternalServerExcept ion" * "MigrationHubOrchestrator.Client.exceptions.ValidationException" * "MigrationHubOrchestrator.Client.exceptions.ResourceNotFoundExce ption" MigrationHubOrchestrator / Client / get_template_step get_template_step ***************** MigrationHubOrchestrator.Client.get_template_step(**kwargs) Get a specific step in a template. See also: AWS API Documentation **Request Syntax** response = client.get_template_step( id='string', templateId='string', stepGroupId='string' ) Parameters: * **id** (*string*) -- **[REQUIRED]** The ID of the step. * **templateId** (*string*) -- **[REQUIRED]** The ID of the template. * **stepGroupId** (*string*) -- **[REQUIRED]** The ID of the step group. Return type: dict Returns: **Response Syntax** { 'id': 'string', 'stepGroupId': 'string', 'templateId': 'string', 'name': 'string', 'description': 'string', 'stepActionType': 'MANUAL'|'AUTOMATED', 'creationTime': 'string', 'previous': [ 'string', ], 'next': [ 'string', ], 'outputs': [ { 'name': 'string', 'dataType': 'STRING'|'INTEGER'|'STRINGLIST'|'STRINGMAP', 'required': True|False }, ], 'stepAutomationConfiguration': { 'scriptLocationS3Bucket': 'string', 'scriptLocationS3Key': { 'linux': 'string', 'windows': 'string' }, 'command': { 'linux': 'string', 'windows': 'string' }, 'runEnvironment': 'AWS'|'ONPREMISE', 'targetType': 'SINGLE'|'ALL'|'NONE' } } **Response Structure** * *(dict) --* * **id** *(string) --* The ID of the step. * **stepGroupId** *(string) --* The ID of the step group. * **templateId** *(string) --* The ID of the template. * **name** *(string) --* The name of the step. * **description** *(string) --* The description of the step. * **stepActionType** *(string) --* The action type of the step. You must run and update the status of a manual step for the workflow to continue after the completion of the step. * **creationTime** *(string) --* The time at which the step was created. * **previous** *(list) --* The previous step. * *(string) --* * **next** *(list) --* The next step. * *(string) --* * **outputs** *(list) --* The outputs of the step. * *(dict) --* The output of the step. * **name** *(string) --* The name of the step. * **dataType** *(string) --* The data type of the step output. * **required** *(boolean) --* Determine if an output is required from a step. * **stepAutomationConfiguration** *(dict) --* The custom script to run tests on source or target environments. * **scriptLocationS3Bucket** *(string) --* The Amazon S3 bucket where the script is located. * **scriptLocationS3Key** *(dict) --* The Amazon S3 key for the script location. * **linux** *(string) --* The script location for Linux. * **windows** *(string) --* The script location for Windows. * **command** *(dict) --* The command to run the script. * **linux** *(string) --* Command for Linux. * **windows** *(string) --* Command for Windows. * **runEnvironment** *(string) --* The source or target environment. * **targetType** *(string) --* The servers on which to run the script. **Exceptions** * "MigrationHubOrchestrator.Client.exceptions.ThrottlingException" * "MigrationHubOrchestrator.Client.exceptions.AccessDeniedExceptio n" * "MigrationHubOrchestrator.Client.exceptions.InternalServerExcept ion" * "MigrationHubOrchestrator.Client.exceptions.ValidationException" * "MigrationHubOrchestrator.Client.exceptions.ResourceNotFoundExce ption" MigrationHubOrchestrator / Client / close close ***** MigrationHubOrchestrator.Client.close() Closes underlying endpoint connections. MigrationHubOrchestrator / Client / update_template update_template *************** MigrationHubOrchestrator.Client.update_template(**kwargs) Updates a migration workflow template. See also: AWS API Documentation **Request Syntax** response = client.update_template( id='string', templateName='string', templateDescription='string', clientToken='string' ) Parameters: * **id** (*string*) -- **[REQUIRED]** The ID of the request to update a migration workflow template. * **templateName** (*string*) -- The name of the migration workflow template to update. * **templateDescription** (*string*) -- The description of the migration workflow template to update. * **clientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'templateId': 'string', 'templateArn': 'string', 'tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **templateId** *(string) --* The ID of the migration workflow template being updated. * **templateArn** *(string) --* The ARN of the migration workflow template being updated. The format for an Migration Hub Orchestrator template ARN is "arn:aws:migrationhub-orchestrator:region:account:template /template-abcd1234". For more information about ARNs, see Amazon Resource Names (ARNs) in the *AWS General Reference*. * **tags** *(dict) --* The tags added to the migration workflow template. * *(string) --* * *(string) --* **Exceptions** * "MigrationHubOrchestrator.Client.exceptions.ThrottlingException" * "MigrationHubOrchestrator.Client.exceptions.AccessDeniedExceptio n" * "MigrationHubOrchestrator.Client.exceptions.InternalServerExcept ion" * "MigrationHubOrchestrator.Client.exceptions.ValidationException" * "MigrationHubOrchestrator.Client.exceptions.ResourceNotFoundExce ption" MigrationHubOrchestrator / Client / get_workflow_step_group get_workflow_step_group *********************** MigrationHubOrchestrator.Client.get_workflow_step_group(**kwargs) Get the step group of a migration workflow. See also: AWS API Documentation **Request Syntax** response = client.get_workflow_step_group( id='string', workflowId='string' ) Parameters: * **id** (*string*) -- **[REQUIRED]** The ID of the step group. * **workflowId** (*string*) -- **[REQUIRED]** The ID of the migration workflow. Return type: dict Returns: **Response Syntax** { 'id': 'string', 'workflowId': 'string', 'name': 'string', 'description': 'string', 'status': 'AWAITING_DEPENDENCIES'|'READY'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'PAUSED'|'PAUSING'|'USER_ATTENTION_REQUIRED', 'owner': 'AWS_MANAGED'|'CUSTOM', 'creationTime': datetime(2015, 1, 1), 'lastModifiedTime': datetime(2015, 1, 1), 'endTime': datetime(2015, 1, 1), 'tools': [ { 'name': 'string', 'url': 'string' }, ], 'previous': [ 'string', ], 'next': [ 'string', ] } **Response Structure** * *(dict) --* * **id** *(string) --* The ID of the step group. * **workflowId** *(string) --* The ID of the migration workflow. * **name** *(string) --* The name of the step group. * **description** *(string) --* The description of the step group. * **status** *(string) --* The status of the step group. * **owner** *(string) --* The owner of the step group. * **creationTime** *(datetime) --* The time at which the step group was created. * **lastModifiedTime** *(datetime) --* The time at which the step group was last modified. * **endTime** *(datetime) --* The time at which the step group ended. * **tools** *(list) --* List of AWS services utilized in a migration workflow. * *(dict) --* List of AWS services utilized in a migration workflow. * **name** *(string) --* The name of an AWS service. * **url** *(string) --* The URL of an AWS service. * **previous** *(list) --* The previous step group. * *(string) --* * **next** *(list) --* The next step group. * *(string) --* **Exceptions** * "MigrationHubOrchestrator.Client.exceptions.ThrottlingException" * "MigrationHubOrchestrator.Client.exceptions.AccessDeniedExceptio n" * "MigrationHubOrchestrator.Client.exceptions.InternalServerExcept ion" * "MigrationHubOrchestrator.Client.exceptions.ValidationException" * "MigrationHubOrchestrator.Client.exceptions.ResourceNotFoundExce ption" MigrationHubOrchestrator / Client / list_workflows list_workflows ************** MigrationHubOrchestrator.Client.list_workflows(**kwargs) List the migration workflows. See also: AWS API Documentation **Request Syntax** response = client.list_workflows( maxResults=123, nextToken='string', templateId='string', adsApplicationConfigurationName='string', status='CREATING'|'NOT_STARTED'|'CREATION_FAILED'|'STARTING'|'IN_PROGRESS'|'WORKFLOW_FAILED'|'PAUSED'|'PAUSING'|'PAUSING_FAILED'|'USER_ATTENTION_REQUIRED'|'DELETING'|'DELETION_FAILED'|'DELETED'|'COMPLETED', name='string' ) Parameters: * **maxResults** (*integer*) -- The maximum number of results that can be returned. * **nextToken** (*string*) -- The pagination token. * **templateId** (*string*) -- The ID of the template. * **adsApplicationConfigurationName** (*string*) -- The name of the application configured in Application Discovery Service. * **status** (*string*) -- The status of the migration workflow. * **name** (*string*) -- The name of the migration workflow. Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'migrationWorkflowSummary': [ { 'id': 'string', 'name': 'string', 'templateId': 'string', 'adsApplicationConfigurationName': 'string', 'status': 'CREATING'|'NOT_STARTED'|'CREATION_FAILED'|'STARTING'|'IN_PROGRESS'|'WORKFLOW_FAILED'|'PAUSED'|'PAUSING'|'PAUSING_FAILED'|'USER_ATTENTION_REQUIRED'|'DELETING'|'DELETION_FAILED'|'DELETED'|'COMPLETED', 'creationTime': datetime(2015, 1, 1), 'endTime': datetime(2015, 1, 1), 'statusMessage': 'string', 'completedSteps': 123, 'totalSteps': 123 }, ] } **Response Structure** * *(dict) --* * **nextToken** *(string) --* The pagination token. * **migrationWorkflowSummary** *(list) --* The summary of the migration workflow. * *(dict) --* The summary of a migration workflow. * **id** *(string) --* The ID of the migration workflow. * **name** *(string) --* The name of the migration workflow. * **templateId** *(string) --* The ID of the template. * **adsApplicationConfigurationName** *(string) --* The name of the application configured in Application Discovery Service. * **status** *(string) --* The status of the migration workflow. * **creationTime** *(datetime) --* The time at which the migration workflow was created. * **endTime** *(datetime) --* The time at which the migration workflow ended. * **statusMessage** *(string) --* The status message of the migration workflow. * **completedSteps** *(integer) --* The steps completed in the migration workflow. * **totalSteps** *(integer) --* All the steps in a migration workflow. **Exceptions** * "MigrationHubOrchestrator.Client.exceptions.ThrottlingException" * "MigrationHubOrchestrator.Client.exceptions.AccessDeniedExceptio n" * "MigrationHubOrchestrator.Client.exceptions.InternalServerExcept ion" * "MigrationHubOrchestrator.Client.exceptions.ValidationException" * "MigrationHubOrchestrator.Client.exceptions.ResourceNotFoundExce ption" MigrationHubOrchestrator / Client / create_workflow_step create_workflow_step ******************** MigrationHubOrchestrator.Client.create_workflow_step(**kwargs) Create a step in the migration workflow. See also: AWS API Documentation **Request Syntax** response = client.create_workflow_step( name='string', stepGroupId='string', workflowId='string', stepActionType='MANUAL'|'AUTOMATED', description='string', workflowStepAutomationConfiguration={ 'scriptLocationS3Bucket': 'string', 'scriptLocationS3Key': { 'linux': 'string', 'windows': 'string' }, 'command': { 'linux': 'string', 'windows': 'string' }, 'runEnvironment': 'AWS'|'ONPREMISE', 'targetType': 'SINGLE'|'ALL'|'NONE' }, stepTarget=[ 'string', ], outputs=[ { 'name': 'string', 'dataType': 'STRING'|'INTEGER'|'STRINGLIST'|'STRINGMAP', 'required': True|False, 'value': { 'integerValue': 123, 'stringValue': 'string', 'listOfStringValue': [ 'string', ] } }, ], previous=[ 'string', ], next=[ 'string', ] ) Parameters: * **name** (*string*) -- **[REQUIRED]** The name of the step. * **stepGroupId** (*string*) -- **[REQUIRED]** The ID of the step group. * **workflowId** (*string*) -- **[REQUIRED]** The ID of the migration workflow. * **stepActionType** (*string*) -- **[REQUIRED]** The action type of the step. You must run and update the status of a manual step for the workflow to continue after the completion of the step. * **description** (*string*) -- The description of the step. * **workflowStepAutomationConfiguration** (*dict*) -- The custom script to run tests on source or target environments. * **scriptLocationS3Bucket** *(string) --* The Amazon S3 bucket where the script is located. * **scriptLocationS3Key** *(dict) --* The Amazon S3 key for the script location. * **linux** *(string) --* The script location for Linux. * **windows** *(string) --* The script location for Windows. * **command** *(dict) --* The command required to run the script. * **linux** *(string) --* Command for Linux. * **windows** *(string) --* Command for Windows. * **runEnvironment** *(string) --* The source or target environment. * **targetType** *(string) --* The servers on which to run the script. * **stepTarget** (*list*) -- The servers on which a step will be run. * *(string) --* * **outputs** (*list*) -- The key value pairs added for the expected output. * *(dict) --* The output of a step. * **name** *(string) --* The name of the step. * **dataType** *(string) --* The data type of the output. * **required** *(boolean) --* Determine if an output is required from a step. * **value** *(dict) --* The value of the output. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "integerValue", "stringValue", "listOfStringValue". * **integerValue** *(integer) --* The integer value. * **stringValue** *(string) --* The string value. * **listOfStringValue** *(list) --* The list of string value. * *(string) --* * **previous** (*list*) -- The previous step. * *(string) --* * **next** (*list*) -- The next step. * *(string) --* Return type: dict Returns: **Response Syntax** { 'id': 'string', 'stepGroupId': 'string', 'workflowId': 'string', 'name': 'string' } **Response Structure** * *(dict) --* * **id** *(string) --* The ID of the step. * **stepGroupId** *(string) --* The ID of the step group. * **workflowId** *(string) --* The ID of the migration workflow. * **name** *(string) --* The name of the step. **Exceptions** * "MigrationHubOrchestrator.Client.exceptions.ThrottlingException" * "MigrationHubOrchestrator.Client.exceptions.AccessDeniedExceptio n" * "MigrationHubOrchestrator.Client.exceptions.InternalServerExcept ion" * "MigrationHubOrchestrator.Client.exceptions.ValidationException" MigrationHubOrchestrator / Client / list_workflow_step_groups list_workflow_step_groups ************************* MigrationHubOrchestrator.Client.list_workflow_step_groups(**kwargs) List the step groups in a migration workflow. See also: AWS API Documentation **Request Syntax** response = client.list_workflow_step_groups( nextToken='string', maxResults=123, workflowId='string' ) Parameters: * **nextToken** (*string*) -- The pagination token. * **maxResults** (*integer*) -- The maximum number of results that can be returned. * **workflowId** (*string*) -- **[REQUIRED]** The ID of the migration workflow. Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'workflowStepGroupsSummary': [ { 'id': 'string', 'name': 'string', 'owner': 'AWS_MANAGED'|'CUSTOM', 'status': 'AWAITING_DEPENDENCIES'|'READY'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'PAUSED'|'PAUSING'|'USER_ATTENTION_REQUIRED', 'previous': [ 'string', ], 'next': [ 'string', ] }, ] } **Response Structure** * *(dict) --* * **nextToken** *(string) --* The pagination token. * **workflowStepGroupsSummary** *(list) --* The summary of step groups in a migration workflow. * *(dict) --* The summary of a step group in a workflow. * **id** *(string) --* The ID of the step group. * **name** *(string) --* The name of the step group. * **owner** *(string) --* The owner of the step group. * **status** *(string) --* The status of the step group. * **previous** *(list) --* The previous step group. * *(string) --* * **next** *(list) --* The next step group. * *(string) --* **Exceptions** * "MigrationHubOrchestrator.Client.exceptions.ThrottlingException" * "MigrationHubOrchestrator.Client.exceptions.AccessDeniedExceptio n" * "MigrationHubOrchestrator.Client.exceptions.InternalServerExcept ion" * "MigrationHubOrchestrator.Client.exceptions.ValidationException" * "MigrationHubOrchestrator.Client.exceptions.ResourceNotFoundExce ption" MigrationHubOrchestrator / Client / tag_resource tag_resource ************ MigrationHubOrchestrator.Client.tag_resource(**kwargs) Tag a resource by specifying its Amazon Resource Name (ARN). See also: AWS API Documentation **Request Syntax** response = client.tag_resource( resourceArn='string', tags={ 'string': 'string' } ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource to which you want to add tags. * **tags** (*dict*) -- **[REQUIRED]** A collection of labels, in the form of key:value pairs, that apply to this resource. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "MigrationHubOrchestrator.Client.exceptions.ValidationException" * "MigrationHubOrchestrator.Client.exceptions.ResourceNotFoundExce ption" MigrationHubOrchestrator / Client / list_templates list_templates ************** MigrationHubOrchestrator.Client.list_templates(**kwargs) List the templates available in Migration Hub Orchestrator to create a migration workflow. See also: AWS API Documentation **Request Syntax** response = client.list_templates( maxResults=123, nextToken='string', name='string' ) Parameters: * **maxResults** (*integer*) -- The maximum number of results that can be returned. * **nextToken** (*string*) -- The pagination token. * **name** (*string*) -- The name of the template. Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'templateSummary': [ { 'id': 'string', 'name': 'string', 'arn': 'string', 'description': 'string' }, ] } **Response Structure** * *(dict) --* * **nextToken** *(string) --* The pagination token. * **templateSummary** *(list) --* The summary of the template. * *(dict) --* The summary of the template. * **id** *(string) --* The ID of the template. * **name** *(string) --* The name of the template. * **arn** *(string) --* The Amazon Resource Name (ARN) of the template. * **description** *(string) --* The description of the template. **Exceptions** * "MigrationHubOrchestrator.Client.exceptions.ThrottlingException" * "MigrationHubOrchestrator.Client.exceptions.AccessDeniedExceptio n" * "MigrationHubOrchestrator.Client.exceptions.InternalServerExcept ion"