GetConsolidatedReport - AWS Well-Architected Tool


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.


The format of the consolidated report.

For PDF, Base64String is returned. For JSON, Metrics is returned.

Valid Values: PDF | JSON

Required: Yes


Set to true to have shared resources included in the report.


The maximum number of results to return for this request.

Valid Range: Minimum value of 1. Maximum value of 15.


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.


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 PDF format is requested.

Type: String


The metrics that make up the consolidated report.

Only returned when JSON format is requested.

Type: Array of ConsolidatedReportMetric objects


The token to use to retrieve the next set of results.

Type: String


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


User does not have sufficient access to perform this action.

HTTP Status Code: 403


The resource has already been processed, was deleted, or is too large.

HTTP Status Code: 409


There is a problem with the AWS Well-Architected Tool API service.

HTTP Status Code: 500


Request was denied due to request throttling.

HTTP Status Code: 429


The user input is not valid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: