WellArchitected / Client / list_check_summaries

list_check_summaries#

WellArchitected.Client.list_check_summaries(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.list_check_summaries(
    WorkloadId='string',
    NextToken='string',
    MaxResults=123,
    LensArn='string',
    PillarId='string',
    QuestionId='string',
    ChoiceId='string'
)
Parameters:

  • WorkloadId (string) –

    [REQUIRED]

    The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

  • NextToken (string) – The token to use to retrieve the next set of results.

  • MaxResults (integer) – The maximum number of results to return for this request.

  • LensArn (string) –

    [REQUIRED]

    Well-Architected Lens ARN.

  • PillarId (string) –

    [REQUIRED]

    The ID used to identify a pillar, for example, security.

    A pillar is identified by its PillarReviewSummary$PillarId.

  • QuestionId (string) –

    [REQUIRED]

    The ID of the question.

  • ChoiceId (string) –

    [REQUIRED]

    The ID of a choice.

Return type:

dict

Returns:

Response Syntax

{
    'CheckSummaries': [
        {
            'Id': 'string',
            'Name': 'string',
            'Provider': 'TRUSTED_ADVISOR',
            'Description': 'string',
            'UpdatedAt': datetime(2015, 1, 1),
            'LensArn': 'string',
            'PillarId': 'string',
            'QuestionId': 'string',
            'ChoiceId': 'string',
            'Status': 'OKAY'|'WARNING'|'ERROR'|'NOT_AVAILABLE'|'FETCH_FAILED',
            'AccountSummary': {
                'string': 123
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • CheckSummaries (list) –

      List of Trusted Advisor summaries related to the Well-Architected best practice.

      • (dict) –

        Trusted Advisor check summary.

        • Id (string) –

          Trusted Advisor check ID.

        • Name (string) –

          Trusted Advisor check name.

        • Provider (string) –

          Provider of the check related to the best practice.

        • Description (string) –

          Trusted Advisor check description.

        • UpdatedAt (datetime) –

          The date and time recorded.

        • LensArn (string) –

          Well-Architected Lens ARN associated to the check.

        • PillarId (string) –

          The ID used to identify a pillar, for example, security.

          A pillar is identified by its PillarReviewSummary$PillarId.

        • QuestionId (string) –

          The ID of the question.

        • ChoiceId (string) –

          The ID of a choice.

        • Status (string) –

          Status associated to the check.

        • AccountSummary (dict) –

          Account summary associated to the check.

          • (string) –

            • (integer) –

    • NextToken (string) –

      The token to use to retrieve the next set of results.

Exceptions