Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Class GetAssessmentCommandProtected

Retrieves the status of an on-going assessment.

Example

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

import { MigrationHubStrategyClient, GetAssessmentCommand } from "@aws-sdk/client-migrationhubstrategy"; // ES Modules import
// const { MigrationHubStrategyClient, GetAssessmentCommand } = require("@aws-sdk/client-migrationhubstrategy"); // CommonJS import
const client = new MigrationHubStrategyClient(config);
const input = { // GetAssessmentRequest
id: "STRING_VALUE", // required
};
const command = new GetAssessmentCommand(input);
const response = await client.send(command);
// { // GetAssessmentResponse
// id: "STRING_VALUE",
// dataCollectionDetails: { // DataCollectionDetails
// status: "STRING_VALUE",
// servers: Number("int"),
// failed: Number("int"),
// success: Number("int"),
// inProgress: Number("int"),
// startTime: new Date("TIMESTAMP"),
// completionTime: new Date("TIMESTAMP"),
// statusMessage: "STRING_VALUE",
// },
// assessmentTargets: [ // AssessmentTargets
// { // AssessmentTarget
// condition: "STRING_VALUE", // required
// name: "STRING_VALUE", // required
// values: [ // AssessmentTargetValues // required
// "STRING_VALUE",
// ],
// },
// ],
// };

Param

GetAssessmentCommandInput

Returns

GetAssessmentCommandOutput

See

Throws

AccessDeniedException (client fault)

The user does not have permission to perform the action. Check the AWS Identity and Access Management (IAM) policy associated with this user.

Throws

InternalServerException (server fault)

The server experienced an internal error. Try again.

Throws

ResourceNotFoundException (client fault)

The specified ID in the request is not found.

Throws

ThrottlingException (client fault)

The request was denied due to request throttling.

Throws

MigrationHubStrategyServiceException

Base exception class for all service exceptions from MigrationHubStrategy service.

Hierarchy

Constructors

Properties

Methods

Constructors

Properties

Methods