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