consolidated_reports

Creates, updates, deletes, gets or lists a consolidated_reports resource.

Overview

Name	consolidated_reports
Type	Resource
Id	aws.wellarchitected.consolidated_reports

Fields

The following fields are returned by SELECT queries:

get_consolidated_report

Name	Datatype	Description
base_64_string	string	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.
metrics	array	The metrics that make up the consolidated report. Only returned when JSON format is requested.
next_token	string	The token to use to retrieve the next set of results. (pattern: <code>[A-Za-z0-9+/=_-]+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_consolidated_report	select	Format, region	IncludeSharedResources, NextToken, MaxResults	Get a consolidated report of your workloads. You can optionally choose to include workloads that have been shared with you.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
Format	string	The format of the consolidated report. For PDF, Base64String is returned. For JSON, Metrics is returned.
region	string	AWS region (default: us-east-1)
IncludeSharedResources	boolean	Set to true to have shared resources included in the report.
MaxResults	integer	The maximum number of results to return for this request.
NextToken	string

SELECT examples

get_consolidated_report

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

SELECT
base_64_string,
metrics,
next_token
FROM aws.wellarchitected.consolidated_reports
WHERE Format = '{{ Format }}' -- required
AND region = '{{ region }}' -- required
AND IncludeSharedResources = '{{ IncludeSharedResources }}'
AND NextToken = '{{ NextToken }}'
AND MaxResults = '{{ MaxResults }}'
;