Skip to content

list_check_summaries

list_check_summaries(
    workload_id: WorkloadId,
    *,
    config_overrides: Optional[WellArchitectedClientConfig] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
    lens_arn: Optional[LensArn] = None,
    pillar_id: Optional[PillarId] = None,
    question_id: Optional[QuestionId] = None,
    choice_id: Optional[ChoiceId] = None,
) -> ListCheckSummariesOutput

List of Trusted Advisor checks summarized for all accounts related to the workload.

Parameters:

  • lens_arn (Optional[LensArn], default: None ) –

    Well-Architected Lens ARN.

Raises:

Source code in docs_src/capo_wellarchitected/_services/well_architected.py
def list_check_summaries(
    self,
    workload_id: "capo_wellarchitected.types.workload_id.WorkloadId",
    *,
    config_overrides: Optional[WellArchitectedClientConfig] = None,
    next_token: Optional["capo_wellarchitected.types.next_token.NextToken"] = None,
    max_results: Optional[
        "capo_wellarchitected.types.max_results.MaxResults"
    ] = None,
    lens_arn: Optional["capo_wellarchitected.types.lens_arn.LensArn"] = None,
    pillar_id: Optional["capo_wellarchitected.types.pillar_id.PillarId"] = None,
    question_id: Optional[
        "capo_wellarchitected.types.question_id.QuestionId"
    ] = None,
    choice_id: Optional["capo_wellarchitected.types.choice_id.ChoiceId"] = None,
) -> "capo_wellarchitected.types.list_check_summaries_output.ListCheckSummariesOutput":
    """<p>List of Trusted Advisor checks summarized for all accounts related to the workload.</p>

    Args:
        lens_arn: <p>Well-Architected Lens ARN.</p>

    Raises:
        capo_wellarchitected.errors.access_denied_exception.AccessDeniedException: <p>User does not have sufficient access to perform this action.</p>
        capo_wellarchitected.errors.internal_server_exception.InternalServerException: <p>There is a problem with the Well-Architected Tool API service.</p>
        capo_wellarchitected.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource was not found.</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.list_check_summaries_input.ListCheckSummariesInput]",
    ) -> OperationResponse[
        "capo_wellarchitected.types.list_check_summaries_output.ListCheckSummariesOutput"
    ]:
        import capo_wellarchitected._operations.well_architected_api_service_lambda.list_check_summaries

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListCheckSummaries")
    )
    input_: capo_wellarchitected.types.list_check_summaries_input.ListCheckSummariesInput = {
        "workload_id": workload_id
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if lens_arn is not None:
        input_["lens_arn"] = lens_arn
    if pillar_id is not None:
        input_["pillar_id"] = pillar_id
    if question_id is not None:
        input_["question_id"] = question_id
    if choice_id is not None:
        input_["choice_id"] = choice_id

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