ListWorkflows
List the migration workflows.
Request Syntax
GET /migrationworkflows?adsApplicationConfigurationName=adsApplicationConfigurationName&maxResults=maxResults&name=name&nextToken=nextToken&status=status&templateId=templateId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- adsApplicationConfigurationName
-
The name of the application configured in Application Discovery Service.
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[-a-zA-Z0-9_.+]+[-a-zA-Z0-9_.+ ]* - maxResults
-
The maximum number of results that can be returned.
Valid Range: Minimum value of 0. Maximum value of 100.
- name
-
The name of the migration workflow.
- nextToken
-
The pagination token.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern:
.*\S.* - status
-
The status of the migration workflow.
Valid Values:
CREATING | NOT_STARTED | CREATION_FAILED | STARTING | IN_PROGRESS | WORKFLOW_FAILED | PAUSED | PAUSING | PAUSING_FAILED | USER_ATTENTION_REQUIRED | DELETING | DELETION_FAILED | DELETED | COMPLETED - templateId
-
The ID of the template.
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[-a-zA-Z0-9_.+]+[-a-zA-Z0-9_.+ ]*
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"migrationWorkflowSummary": [
{
"adsApplicationConfigurationName": "string",
"completedSteps": number,
"creationTime": number,
"endTime": number,
"id": "string",
"name": "string",
"status": "string",
"statusMessage": "string",
"templateId": "string",
"totalSteps": number
}
],
"nextToken": "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.
- migrationWorkflowSummary
-
The summary of the migration workflow.
Type: Array of MigrationWorkflowSummary objects
- nextToken
-
The pagination token.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern:
.*\S.*
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:
