GET

/consolidatedReport#Format

http://wellarchitected.{region}.amazonaws.com/consolidatedReport#Format

Get a consolidated report of your workloads. You can optionally choose to include workloads that have been shared with you.

Access Token Required: API Key

Query Params

Formatstringrequired

The format of the consolidated report. For <code>PDF</code>, <code>Base64String</code> is returned. For <code>JSON</code>, <code>Metrics</code> is returned.

Allowed:

IncludeSharedResourcesboolean

Set to <code>true</code> to have shared resources included in the report.

NextTokenstring

MaxResultsinteger

The maximum number of results to return for this request.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://wellarchitected.{region}.amazonaws.com/consolidatedReport#Format' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET