get_consolidated_report ¶

def get_consolidated_report(
    self,
    *,
    config_overrides: Optional[WellArchitectedClientConfig] = None,
    format: Optional[
        "capo_wellarchitected.types.report_format.ReportFormat"
    ] = None,
    include_shared_resources: Optional[
        "capo_wellarchitected.types.include_shared_resources.IncludeSharedResources"
    ] = None,
    next_token: Optional["capo_wellarchitected.types.next_token.NextToken"] = None,
    max_results: Optional[
        "capo_wellarchitected.types.max_results.MaxResults"
    ] = None,
) -> "capo_wellarchitected.types.get_consolidated_report_output.GetConsolidatedReportOutput":
    """<p>Get a consolidated report of your workloads.</p> <p>You can optionally choose to include workloads that have been shared with you.</p>

    Args:
        format: <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: <p>Set to <code>true</code> to have shared resources included in the report.</p>
        max_results: <p>The maximum number of results to return for this request.</p>

    Raises:
        capo_wellarchitected.errors.access_denied_exception.AccessDeniedException: <p>User does not have sufficient access to perform this action.</p>
        capo_wellarchitected.errors.conflict_exception.ConflictException: <p>The resource has already been processed, was deleted, or is too large.</p>
        capo_wellarchitected.errors.internal_server_exception.InternalServerException: <p>There is a problem with the Well-Architected Tool API service.</p>
        capo_wellarchitected.errors.throttling_exception.ThrottlingException: <p>Request was denied due to request throttling.</p>
        capo_wellarchitected.errors.validation_exception.ValidationException: <p>The user input is not valid.</p>
        capo_wellarchitected.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_wellarchitected.types.get_consolidated_report_input.GetConsolidatedReportInput]",
    ) -> OperationResponse[
        "capo_wellarchitected.types.get_consolidated_report_output.GetConsolidatedReportOutput"
    ]:
        import capo_wellarchitected._operations.well_architected_api_service_lambda.get_consolidated_report

        output, http_response = (
            capo_wellarchitected._operations.well_architected_api_service_lambda.get_consolidated_report.get_consolidated_report(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetConsolidatedReport")
    )
    input_: capo_wellarchitected.types.get_consolidated_report_input.GetConsolidatedReportInput = {}
    if format is not None:
        input_["format"] = format
    if include_shared_resources is not None:
        input_["include_shared_resources"] = include_shared_resources
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output