ListMigrationTaskUpdatesCommand

Suggest an Edit

This is a paginated API that returns all the migration-task states for the specified MigrationTaskName and ProgressUpdateStream.

Example Syntax

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

import { MigrationHubClient, ListMigrationTaskUpdatesCommand } from "@aws-sdk/client-migration-hub"; // ES Modules import
// const { MigrationHubClient, ListMigrationTaskUpdatesCommand } = require("@aws-sdk/client-migration-hub"); // CommonJS import
const client = new MigrationHubClient(config);
const input = { // ListMigrationTaskUpdatesRequest
  ProgressUpdateStream: "STRING_VALUE", // required
  MigrationTaskName: "STRING_VALUE", // required
  NextToken: "STRING_VALUE",
  MaxResults: Number("int"),
};
const command = new ListMigrationTaskUpdatesCommand(input);
const response = await client.send(command);
// { // ListMigrationTaskUpdatesResult
//   NextToken: "STRING_VALUE",
//   MigrationTaskUpdateList: [ // MigrationTaskUpdateList
//     { // MigrationTaskUpdate
//       UpdateDateTime: new Date("TIMESTAMP"),
//       UpdateType: "MIGRATION_TASK_STATE_UPDATED",
//       MigrationTaskState: { // Task
//         Status: "NOT_STARTED" || "IN_PROGRESS" || "FAILED" || "COMPLETED", // required
//         StatusDetail: "STRING_VALUE",
//         ProgressPercent: Number("int"),
//       },
//     },
//   ],
// };

ListMigrationTaskUpdatesCommand Input

See ListMigrationTaskUpdatesCommandInput for more details

Parameter
Type
Description
MigrationTaskName
Required
string | undefined

A unique identifier that references the migration task. Do not include sensitive data in this field.

ProgressUpdateStream
Required
string | undefined

The name of the progress-update stream, which is used for access control as well as a namespace for migration-task names that is implicitly linked to your AWS account. The progress-update stream must uniquely identify the migration tool as it is used for all updates made by the tool; however, it does not need to be unique for each AWS account because it is scoped to the AWS account.

MaxResults
number | undefined

The maximum number of results to include in the response. If more results exist than the value that you specify here for MaxResults, the response will include a token that you can use to retrieve the next set of results.

NextToken
string | undefined

If NextToken was returned by a previous call, there are more results available. The value of NextToken is a unique pagination token for each page. To retrieve the next page of results, specify the NextToken value that the previous call returned. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

ListMigrationTaskUpdatesCommand Output

See ListMigrationTaskUpdatesCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
MigrationTaskUpdateList
MigrationTaskUpdate[] | undefined

The list of migration-task updates.

NextToken
string | undefined

If the response includes a NextToken value, that means that there are more results available. The value of NextToken is a unique pagination token for each page. To retrieve the next page of results, call this API again and specify this NextToken value in the request. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

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.