Class GetPortfolioSummaryCommandProtected

Retrieves overall summary including the number of servers to rehost and the overall number of anti-patterns.

Example

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

import { MigrationHubStrategyClient, GetPortfolioSummaryCommand } from "@aws-sdk/client-migrationhubstrategy"; // ES Modules import
// const { MigrationHubStrategyClient, GetPortfolioSummaryCommand } = require("@aws-sdk/client-migrationhubstrategy"); // CommonJS import
const client = new MigrationHubStrategyClient(config);
const input = {};
const command = new GetPortfolioSummaryCommand(input);
const response = await client.send(command);
// { // GetPortfolioSummaryResponse
//   assessmentSummary: { // AssessmentSummary
//     listServerStrategySummary: [ // ListStrategySummary
//       { // StrategySummary
//         strategy: "STRING_VALUE",
//         count: Number("int"),
//       },
//     ],
//     listApplicationComponentStrategySummary: [
//       {
//         strategy: "STRING_VALUE",
//         count: Number("int"),
//       },
//     ],
//     listAntipatternSeveritySummary: [ // ListAntipatternSeveritySummary
//       { // AntipatternSeveritySummary
//         severity: "STRING_VALUE",
//         count: Number("int"),
//       },
//     ],
//     listApplicationComponentSummary: [ // ListApplicationComponentSummary
//       { // ApplicationComponentSummary
//         appType: "STRING_VALUE",
//         count: Number("int"),
//       },
//     ],
//     listServerSummary: [ // ListServerSummary
//       { // ServerSummary
//         ServerOsType: "STRING_VALUE",
//         count: Number("int"),
//       },
//     ],
//     antipatternReportS3Object: { // S3Object
//       s3Bucket: "STRING_VALUE",
//       s3key: "STRING_VALUE",
//     },
//     antipatternReportStatus: "STRING_VALUE",
//     antipatternReportStatusMessage: "STRING_VALUE",
//     lastAnalyzedTimestamp: new Date("TIMESTAMP"),
//     listApplicationComponentStatusSummary: [ // ListApplicationComponentStatusSummary
//       { // ApplicationComponentStatusSummary
//         srcCodeOrDbAnalysisStatus: "STRING_VALUE",
//         count: Number("int"),
//       },
//     ],
//     listServerStatusSummary: [ // ListServerStatusSummary
//       { // ServerStatusSummary
//         runTimeAssessmentStatus: "STRING_VALUE",
//         count: Number("int"),
//       },
//     ],
//   },
// };

Param

GetPortfolioSummaryCommandInput

Returns

GetPortfolioSummaryCommandOutput

See

• GetPortfolioSummaryCommandInput for command's input shape.
• GetPortfolioSummaryCommandOutput for command's response shape.
• config for MigrationHubStrategyClient's config shape.

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

ThrottlingException (client fault)

The request was denied due to request throttling.

Throws

MigrationHubStrategyServiceException

Base exception class for all service exceptions from MigrationHubStrategy service.