Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

DescribeMigrationTask

Retrieves a list of all attributes associated with a specific migration task.

Request Syntax


{
   "MigrationTaskName": "string",
   "ProgressUpdateStream": "string"
}

Request Parameters

The request accepts the following data in JSON format.

MigrationTaskName

The identifier given to the MigrationTask. Do not store personal data in this field.

Type: String

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

Pattern: [^:|]+

Required: Yes

ProgressUpdateStream

The name of the ProgressUpdateStream.

Type: String

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

Pattern: [^/:|\000-\037]+

Required: Yes

Response Syntax


{
   "MigrationTask": { 
      "MigrationTaskName": "string",
      "ProgressUpdateStream": "string",
      "ResourceAttributeList": [ 
         { 
            "Type": "string",
            "Value": "string"
         }
      ],
      "Task": { 
         "ProgressPercent": number,
         "Status": "string",
         "StatusDetail": "string"
      },
      "UpdateDateTime": number
   }
}

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.

MigrationTask

Object encapsulating information about the migration task.

Type: MigrationTask object

Errors

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 400

HomeRegionNotSetException

The home region is not set. Set the home region to continue.

HTTP Status Code: 400

InternalServerError

Exception raised when an internal, configuration, or dependency error is encountered.

HTTP Status Code: 500

InvalidInputException

Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.

HTTP Status Code: 400

ResourceNotFoundException

Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.

HTTP Status Code: 400

ServiceUnavailableException

Exception raised when there is an internal, configuration, or dependency error encountered.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

Examples

Describe a migration task by listing all associated attributes

The following example lists all of the attributes associated with the values passed to the required parameters of MigrationTaskName and ProgressUpdateStream.

Sample Request



{
    "ProgressUpdateStream": "SMS",
    "MigrationTaskName": "sms-12de3cf1a"
}

Sample Response



{
    "MigrationTask": {
        "ProgressUpdateStream": "SMS", 
        "Task": {
            "Status": "IN_PROGRESS", 
            "StatusDetail": "Migration: Copying image data", 
            "ProgressPercent": 77
        }, 
        "UpdateDateTime": 1493750385.0, 
        "MigrationTaskName": "sms-12de3cf1a"
    }
}