Skip to content

GetConsolidatedReportInput

Source code in docs_src/capo_wellarchitected/types/get_consolidated_report_input.py
class GetConsolidatedReportInput(TypedDict, closed=True):
    format: NotRequired["capo_wellarchitected.types.report_format.ReportFormat"]
    """<p>The format of the consolidated report.</p> <p>For <code>PDF</code>, <code>Base64String</code> is returned. For <code>JSON</code>, <code>Metrics</code> is returned.</p>"""
    include_shared_resources: NotRequired[
        "capo_wellarchitected.types.include_shared_resources.IncludeSharedResources"
    ]
    """<p>Set to <code>true</code> to have shared resources included in the report.</p>"""
    next_token: NotRequired["capo_wellarchitected.types.next_token.NextToken"]
    max_results: NotRequired["capo_wellarchitected.types.max_results.MaxResults"]
    """<p>The maximum number of results to return for this request.</p>"""

format instance-attribute

format: NotRequired[ReportFormat]

The format of the consolidated report.

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

include_shared_resources instance-attribute

include_shared_resources: NotRequired[IncludeSharedResources]

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

max_results instance-attribute

max_results: NotRequired[MaxResults]

The maximum number of results to return for this request.

next_token instance-attribute

next_token: NotRequired[NextToken]