Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetWorkflow

Get migration workflow.

Request Syntax


GET /migrationworkflow/id 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

{
   "adsApplicationConfigurationId": "string",
   "adsApplicationName": "string",
   "arn": "string",
   "completedSteps": number,
   "creationTime": number,
   "description": "string",
   "endTime": number,
   "id": "string",
   "lastModifiedTime": number,
   "lastStartTime": number,
   "lastStopTime": number,
   "name": "string",
   "status": "string",
   "statusMessage": "string",
   "tags": { 
      "string" : "string" 
   },
   "templateId": "string",
   "tools": [ 
      { 
         "name": "string",
         "url": "string"
      }
   ],
   "totalSteps": number,
   "workflowBucket": "string",
   "workflowInputs": { 
      "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.

adsApplicationConfigurationId

The configuration ID of the application configured in Application Discovery Service.

Type: String

adsApplicationName

The name of the application configured in Application Discovery Service.

Type: String

arn

The Amazon Resource Name (ARN) of the migration workflow.

Type: String

completedSteps

Get a list of completed steps in the migration workflow.

Type: Integer

creationTime

The time at which the migration workflow was created.

Type: Timestamp

description

The description of the migration workflow.

Type: String

endTime

The time at which the migration workflow ended.

Type: Timestamp

id

The ID of the migration workflow.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [a-zA-Z0-9-]+

lastModifiedTime

The time at which the migration workflow was last modified.

Type: Timestamp

lastStartTime

The time at which the migration workflow was last started.

Type: Timestamp

lastStopTime

The time at which the migration workflow was last stopped.

Type: Timestamp

name

The name of the migration workflow.

Type: String

status

The status of the migration workflow.

Type: String

statusMessage

The status message of the migration workflow.

Type: String

tags

The tags added to the migration workflow.

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 100.

Key Pattern: [a-zA-Z0-9-_ ()]+

Value Length Constraints: Minimum length of 0. Maximum length of 100.

templateId

The ID of the template.

Type: String

tools

List of AWS services utilized in a migration workflow.

Type: Array of Tool objects

totalSteps

The total number of steps in the migration workflow.

Type: Integer

workflowBucket

The Amazon S3 bucket where the migration logs are stored.

Type: String

workflowInputs

The inputs required for creating the migration workflow.

Type: String to StepInput object map

Key Length Constraints: Minimum length of 1. Maximum length of 100.

Key Pattern: [a-zA-Z0-9-_ ()]+

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