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

  • MigrationHubOrchestrator.Client.exceptions.InternalServerException

  • MigrationHubOrchestrator.Client.exceptions.ValidationException

  • MigrationHubOrchestrator.Client.exceptions.ResourceNotFoundException