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.AccessDeniedException
MigrationHubOrchestrator.Client.exceptions.InternalServerException
MigrationHubOrchestrator.Client.exceptions.ValidationException