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.AccessDeniedException

  • MigrationHubOrchestrator.Client.exceptions.InternalServerException

  • MigrationHubOrchestrator.Client.exceptions.ValidationException

  • MigrationHubOrchestrator.Client.exceptions.ResourceNotFoundException