Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetPortfolioSummary

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

Request Syntax


GET /get-portfolio-summary HTTP/1.1

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "assessmentSummary": { 
      "antipatternReportS3Object": { 
         "s3Bucket": "string",
         "s3key": "string"
      },
      "antipatternReportStatus": "string",
      "antipatternReportStatusMessage": "string",
      "lastAnalyzedTimestamp": number,
      "listAntipatternSeveritySummary": [ 
         { 
            "count": number,
            "severity": "string"
         }
      ],
      "listApplicationComponentStatusSummary": [ 
         { 
            "count": number,
            "srcCodeOrDbAnalysisStatus": "string"
         }
      ],
      "listApplicationComponentStrategySummary": [ 
         { 
            "count": number,
            "strategy": "string"
         }
      ],
      "listApplicationComponentSummary": [ 
         { 
            "appType": "string",
            "count": number
         }
      ],
      "listServerStatusSummary": [ 
         { 
            "count": number,
            "runTimeAssessmentStatus": "string"
         }
      ],
      "listServerStrategySummary": [ 
         { 
            "count": number,
            "strategy": "string"
         }
      ],
      "listServerSummary": [ 
         { 
            "count": number,
            "ServerOsType": "string"
         }
      ]
   }
}

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.

assessmentSummary

An assessment summary for the portfolio including the number of servers to rehost and the overall number of anti-patterns.

Type: AssessmentSummary object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

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

HTTP Status Code: 403

InternalServerException

The server experienced an internal error. Try again.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429