GetConsolidatedReport
Get a consolidated report of your workloads.
You can optionally choose to include workloads that have been shared with you.
Request Syntax
GET /consolidatedReport?Format=Format&IncludeSharedResources=IncludeSharedResources&MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- Format
-
The format of the consolidated report.
For
PDF,Base64Stringis returned. ForJSON,Metricsis returned.Valid Values:
PDF | JSONRequired: Yes
-
Set to
trueto have shared resources included in the report. - MaxResults
-
The maximum number of results to return for this request.
Valid Range: Minimum value of 1. Maximum value of 15.
- NextToken
-
The token to use to retrieve the next set of results.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Base64String": "string",
"Metrics": [
{
"Lenses": [
{
"LensArn": "string",
"Pillars": [
{
"PillarId": "string",
"Questions": [
{
"BestPractices": [
{
"ChoiceId": "string",
"ChoiceTitle": "string"
}
],
"QuestionId": "string",
"Risk": "string"
}
],
"RiskCounts": {
"string" : number
}
}
],
"RiskCounts": {
"string" : number
}
}
],
"LensesAppliedCount": number,
"MetricType": "string",
"RiskCounts": {
"string" : number
},
"UpdatedAt": number,
"WorkloadArn": "string",
"WorkloadId": "string",
"WorkloadName": "string"
}
],
"NextToken": "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.
- Base64String
-
The Base64-encoded string representation of a lens review report.
This data can be used to create a PDF file.
Only returned by GetConsolidatedReport when
PDFformat is requested.Type: String
- Metrics
-
The metrics that make up the consolidated report.
Only returned when
JSONformat is requested.Type: Array of ConsolidatedReportMetric objects