DescribeMigrationTaskCommand

Suggest an Edit

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { MigrationHubClient, DescribeMigrationTaskCommand } from "@aws-sdk/client-migration-hub"; // ES Modules import
// const { MigrationHubClient, DescribeMigrationTaskCommand } = require("@aws-sdk/client-migration-hub"); // CommonJS import
const client = new MigrationHubClient(config);
const input = { // DescribeMigrationTaskRequest
  ProgressUpdateStream: "STRING_VALUE", // required
  MigrationTaskName: "STRING_VALUE", // required
};
const command = new DescribeMigrationTaskCommand(input);
const response = await client.send(command);
// { // DescribeMigrationTaskResult
//   MigrationTask: { // MigrationTask
//     ProgressUpdateStream: "STRING_VALUE",
//     MigrationTaskName: "STRING_VALUE",
//     Task: { // Task
//       Status: "NOT_STARTED" || "IN_PROGRESS" || "FAILED" || "COMPLETED", // required
//       StatusDetail: "STRING_VALUE",
//       ProgressPercent: Number("int"),
//     },
//     UpdateDateTime: new Date("TIMESTAMP"),
//     ResourceAttributeList: [ // LatestResourceAttributeList
//       { // ResourceAttribute
//         Type: "IPV4_ADDRESS" || "IPV6_ADDRESS" || "MAC_ADDRESS" || "FQDN" || "VM_MANAGER_ID" || "VM_MANAGED_OBJECT_REFERENCE" || "VM_NAME" || "VM_PATH" || "BIOS_ID" || "MOTHERBOARD_SERIAL_NUMBER", // required
//         Value: "STRING_VALUE", // required
//       },
//     ],
//   },
// };

DescribeMigrationTaskCommand Input

See DescribeMigrationTaskCommandInput for more details

Parameter
Type
Description
MigrationTaskName
Required
string | undefined

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

ProgressUpdateStream
Required
string | undefined

The name of the ProgressUpdateStream.

DescribeMigrationTaskCommand Output

See DescribeMigrationTaskCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
MigrationTask
MigrationTask | undefined

Object encapsulating information about the migration task.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

HomeRegionNotSetException
client

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

InternalServerError
server

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

InvalidInputException
client

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

ResourceNotFoundException
client

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.

ServiceUnavailableException
server

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

ThrottlingException
client

The request was denied due to request throttling.

MigrationHubServiceException
Base exception class for all service exceptions from MigrationHub service.