StopWorkflow
Stop an ongoing migration workflow.
Request Syntax
POST /migrationworkflow/id/stop HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- id
-
The ID of the migration workflow.
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[a-zA-Z0-9-]+Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"arn": "string",
"id": "string",
"lastStopTime": number,
"status": "string",
"statusMessage": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- arn
-
The Amazon Resource Name (ARN) of the migration workflow.
Type: String
- id
-
The ID of the migration workflow.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[a-zA-Z0-9-]+ - lastStopTime
-
The time at which the migration workflow was stopped.
Type: Timestamp
- status
-
The status of the migration workflow.
Type: String
Valid Values:
CREATING | NOT_STARTED | CREATION_FAILED | STARTING | IN_PROGRESS | WORKFLOW_FAILED | PAUSED | PAUSING | PAUSING_FAILED | USER_ATTENTION_REQUIRED | DELETING | DELETION_FAILED | DELETED | COMPLETED - statusMessage
-
The status message of the migration workflow.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- InternalServerException
-
An internal error has occurred.
HTTP Status Code: 500
- ResourceNotFoundException
-
The resource is not available.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
