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

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, Base64String is returned. For JSON, Metrics is returned.

Valid Values: PDF | JSON

Required: Yes

IncludeSharedResources

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

Type: String

Metrics

The metrics that make up the consolidated report.

Only returned when JSON format is requested.

Type: Array of ConsolidatedReportMetric objects

NextToken

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

Type: String

Errors

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

AccessDeniedException

User does not have sufficient access to perform this action.

Message: Description of the error.

HTTP Status Code: 403

ConflictException

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

Message: Description of the error.
ResourceId: Identifier of the resource affected.
ResourceType: Type of the resource affected.

HTTP Status Code: 409

InternalServerException

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

Message: Description of the error.

HTTP Status Code: 500

ThrottlingException

Request was denied due to request throttling.

Message: Description of the error.
QuotaCode: Service Quotas requirement to identify originating quota.
ServiceCode: Service Quotas requirement to identify originating service.

HTTP Status Code: 429

ValidationException

The user input is not valid.

Fields: The fields that caused the error, if applicable.
Message: Description of the error.
Reason: The reason why the request failed validation.

HTTP Status Code: 400