2022/09/29 - AWS Migration Hub Orchestrator - 28 new api methods
Changes Introducing AWS MigrationHubOrchestrator. This is the first public release of AWS MigrationHubOrchestrator.
List AWS Migration Hub Orchestrator plugins.
See also: AWS API Documentation
Request Syntax
client.list_plugins(
maxResults=123,
nextToken='string'
)
integer
The maximum number of plugins that can be returned.
string
The pagination token.
dict
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.
Stop an ongoing migration workflow.
See also: AWS API Documentation
Request Syntax
client.stop_workflow(
id='string'
)
string
[REQUIRED]
The ID of the migration workflow.
dict
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.
Create a step in the migration workflow.
See also: AWS API Documentation
Request Syntax
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',
]
)
string
[REQUIRED]
The name of the step.
string
[REQUIRED]
The ID of the step group.
string
[REQUIRED]
The ID of the migration workflow.
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.
string
The description of the step.
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.
list
The servers on which a step will be run.
(string) --
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) --
list
The previous step.
(string) --
list
The next step.
(string) --
dict
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.
List the step groups in a template.
See also: AWS API Documentation
Request Syntax
client.list_template_step_groups(
maxResults=123,
nextToken='string',
templateId='string'
)
integer
The maximum number of results that can be returned.
string
The pagination token.
string
[REQUIRED]
The ID of the template.
dict
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) --
Get the step group of a migration workflow.
See also: AWS API Documentation
Request Syntax
client.get_workflow_step_group(
id='string',
workflowId='string'
)
string
[REQUIRED]
The ID of the step group.
string
[REQUIRED]
The ID of the migration workflow.
dict
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) --
Get a step in the migration workflow.
See also: AWS API Documentation
Request Syntax
client.get_workflow_step(
workflowId='string',
stepGroupId='string',
id='string'
)
string
[REQUIRED]
The ID of the migration workflow.
string
[REQUIRED]
desThe ID of the step group.
string
[REQUIRED]
The ID of the step.
dict
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'|'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.
Create a workflow to orchestrate your migrations.
See also: AWS API Documentation
Request Syntax
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'
}
)
string
[REQUIRED]
The name of the migration workflow.
string
The description of the migration workflow.
string
[REQUIRED]
The ID of the template.
string
[REQUIRED]
The configuration ID of the application configured in Application Discovery Service.
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) --
list
The servers on which a step will be run.
(string) --
dict
The tags to add on a migration workflow.
(string) --
(string) --
dict
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) --
Deletes the tags for a resource.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource from which you want to remove tags.
list
[REQUIRED]
One or more tag keys. Specify only the tag keys, not the tag values.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Create a step group in a migration workflow.
See also: AWS API Documentation
Request Syntax
client.create_workflow_step_group(
workflowId='string',
name='string',
description='string',
next=[
'string',
],
previous=[
'string',
]
)
string
[REQUIRED]
The ID of the migration workflow that will contain the step group.
string
[REQUIRED]
The name of the step group.
string
The description of the step group.
list
The next step group.
(string) --
list
The previous step group.
(string) --
dict
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.
Get migration workflow.
See also: AWS API Documentation
Request Syntax
client.get_workflow(
id='string'
)
string
[REQUIRED]
The ID of the migration workflow.
dict
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.
Delete a step in a migration workflow. Pause the workflow to delete a running step.
See also: AWS API Documentation
Request Syntax
client.delete_workflow_step(
id='string',
stepGroupId='string',
workflowId='string'
)
string
[REQUIRED]
The ID of the step you want to delete.
string
[REQUIRED]
The ID of the step group that contains the step you want to delete.
string
[REQUIRED]
The ID of the migration workflow.
dict
Response Syntax
{}
Response Structure
(dict) --
Get the template you want to use for creating a migration workflow.
See also: AWS API Documentation
Request Syntax
client.get_template(
id='string'
)
string
[REQUIRED]
The ID of the template.
dict
Response Syntax
{
'id': 'string',
'name': 'string',
'description': 'string',
'inputs': [
{
'inputName': 'string',
'dataType': 'STRING'|'INTEGER'|'STRINGLIST'|'STRINGMAP',
'required': True|False
},
],
'tools': [
{
'name': 'string',
'url': 'string'
},
],
'status': 'CREATED',
'creationTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
id (string) --
The ID of the template.
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.
status (string) --
The status of the template.
creationTime (datetime) --
The time at which the template was last created.
Delete a step group in a migration workflow.
See also: AWS API Documentation
Request Syntax
client.delete_workflow_step_group(
workflowId='string',
id='string'
)
string
[REQUIRED]
The ID of the migration workflow.
string
[REQUIRED]
The ID of the step group you want to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
List the templates available in Migration Hub Orchestrator to create a migration workflow.
See also: AWS API Documentation
Request Syntax
client.list_templates(
maxResults=123,
nextToken='string',
name='string'
)
integer
The maximum number of results that can be returned.
string
The pagination token.
string
The name of the template.
dict
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.
List the migration workflows.
See also: AWS API Documentation
Request Syntax
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'
)
integer
The maximum number of results that can be returned.
string
The pagination token.
string
The ID of the template.
string
The name of the application configured in Application Discovery Service.
string
The status of the migration workflow.
string
The name of the migration workflow.
dict
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.
Get a step group in a template.
See also: AWS API Documentation
Request Syntax
client.get_template_step_group(
templateId='string',
id='string'
)
string
[REQUIRED]
The ID of the template.
string
[REQUIRED]
The ID of the step group.
dict
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) --
Update a migration workflow.
See also: AWS API Documentation
Request Syntax
client.update_workflow(
id='string',
name='string',
description='string',
inputParameters={
'string': {
'integerValue': 123,
'stringValue': 'string',
'listOfStringsValue': [
'string',
],
'mapOfStringValue': {
'string': 'string'
}
}
},
stepTargets=[
'string',
]
)
string
[REQUIRED]
The ID of the migration workflow.
string
The name of the migration workflow.
string
The description of the migration workflow.
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) --
list
The servers on which a step will be run.
(string) --
dict
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) --
Get a specific step in a template.
See also: AWS API Documentation
Request Syntax
client.get_template_step(
id='string',
templateId='string',
stepGroupId='string'
)
string
[REQUIRED]
The ID of the step.
string
[REQUIRED]
The ID of the template.
string
[REQUIRED]
The ID of the step group.
dict
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.
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
client.delete_workflow(
id='string'
)
string
[REQUIRED]
The ID of the migration workflow you want to delete.
dict
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.
Update the step group in a migration workflow.
See also: AWS API Documentation
Request Syntax
client.update_workflow_step_group(
workflowId='string',
id='string',
name='string',
description='string',
next=[
'string',
],
previous=[
'string',
]
)
string
[REQUIRED]
The ID of the migration workflow.
string
[REQUIRED]
The ID of the step group.
string
The name of the step group.
string
The description of the step group.
list
The next step group.
(string) --
list
The previous step group.
(string) --
dict
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.
Retry a failed step in a migration workflow.
See also: AWS API Documentation
Request Syntax
client.retry_workflow_step(
workflowId='string',
stepGroupId='string',
id='string'
)
string
[REQUIRED]
The ID of the migration workflow.
string
[REQUIRED]
The ID of the step group.
string
[REQUIRED]
The ID of the step.
dict
Response Syntax
{
'stepGroupId': 'string',
'workflowId': 'string',
'id': 'string',
'status': 'AWAITING_DEPENDENCIES'|'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.
List the steps in a workflow.
See also: AWS API Documentation
Request Syntax
client.list_workflow_steps(
nextToken='string',
maxResults=123,
workflowId='string',
stepGroupId='string'
)
string
The pagination token.
integer
The maximum number of results that can be returned.
string
[REQUIRED]
The ID of the migration workflow.
string
[REQUIRED]
The ID of the step group.
dict
Response Syntax
{
'nextToken': 'string',
'workflowStepsSummary': [
{
'stepId': 'string',
'name': 'string',
'stepActionType': 'MANUAL'|'AUTOMATED',
'owner': 'AWS_MANAGED'|'CUSTOM',
'previous': [
'string',
],
'next': [
'string',
],
'status': 'AWAITING_DEPENDENCIES'|'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.
List the step groups in a migration workflow.
See also: AWS API Documentation
Request Syntax
client.list_workflow_step_groups(
nextToken='string',
maxResults=123,
workflowId='string'
)
string
The pagination token.
integer
The maximum number of results that can be returned.
string
[REQUIRED]
The ID of the migration workflow.
dict
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) --
Tag a resource by specifying its Amazon Resource Name (ARN).
See also: AWS API Documentation
Request Syntax
client.tag_resource(
resourceArn='string',
tags={
'string': 'string'
}
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource to which you want to add tags.
dict
[REQUIRED]
A collection of labels, in the form of key:value pairs, that apply to this resource.
(string) --
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
List the steps in a template.
See also: AWS API Documentation
Request Syntax
client.list_template_steps(
maxResults=123,
nextToken='string',
templateId='string',
stepGroupId='string'
)
integer
The maximum number of results that can be returned.
string
The pagination token.
string
[REQUIRED]
The ID of the template.
string
[REQUIRED]
The ID of the step group.
dict
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) --
Update a step in a migration workflow.
See also: AWS API Documentation
Request Syntax
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'|'READY'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'PAUSED'|'USER_ATTENTION_REQUIRED'
)
string
[REQUIRED]
The ID of the step.
string
[REQUIRED]
The ID of the step group.
string
[REQUIRED]
The ID of the migration workflow.
string
The name of the step.
string
The description of the step.
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.
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.
list
The servers on which a step will be run.
(string) --
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) --
list
The previous step.
(string) --
list
The next step.
(string) --
string
The status of the step.
dict
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.
Start a migration workflow.
See also: AWS API Documentation
Request Syntax
client.start_workflow(
id='string'
)
string
[REQUIRED]
The ID of the migration workflow.
dict
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.
List the tags added to a resource.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
resourceArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
dict
Response Syntax
{
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
tags (dict) --
The tags added to a resource.
(string) --
(string) --