WellArchitected / Client / list_lens_reviews

list_lens_reviews#

WellArchitected.Client.list_lens_reviews(**kwargs)#

List lens reviews for a particular workload.

See also: AWS API Documentation

Request Syntax

response = client.list_lens_reviews(
    WorkloadId='string',
    MilestoneNumber=123,
    NextToken='string',
    MaxResults=123
)
Parameters:

  • WorkloadId (string) –

    [REQUIRED]

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

  • MilestoneNumber (integer) –

    The milestone number.

    A workload can have a maximum of 100 milestones.

  • 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.

Return type:

dict

Returns:

Response Syntax

{
    'WorkloadId': 'string',
    'MilestoneNumber': 123,
    'LensReviewSummaries': [
        {
            'LensAlias': 'string',
            'LensArn': 'string',
            'LensVersion': 'string',
            'LensName': 'string',
            'LensStatus': 'CURRENT'|'NOT_CURRENT'|'DEPRECATED'|'DELETED'|'UNSHARED',
            'UpdatedAt': datetime(2015, 1, 1),
            'RiskCounts': {
                'string': 123
            },
            'Profiles': [
                {
                    'ProfileArn': 'string',
                    'ProfileVersion': 'string'
                },
            ],
            'PrioritizedRiskCounts': {
                'string': 123
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    Output of a list lens reviews call.

    • WorkloadId (string) –

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

    • MilestoneNumber (integer) –

      The milestone number.

      A workload can have a maximum of 100 milestones.

    • LensReviewSummaries (list) –

      List of lens summaries of lens reviews of a workload.

      • (dict) –

        A lens review summary of a workload.

        • LensAlias (string) –

          The alias of the lens.

          For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

          For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

          Each lens is identified by its LensSummary$LensAlias.

        • LensArn (string) –

          The ARN for the lens.

        • LensVersion (string) –

          The version of the lens.

        • LensName (string) –

          The full name of the lens.

        • LensStatus (string) –

          The status of the lens.

        • UpdatedAt (datetime) –

          The date and time recorded.

        • RiskCounts (dict) –

          A map from risk names to the count of how many questions have that rating.

          • (string) –

            The risk for a given workload, lens review, pillar, or question.

            • (integer) –

              A non-negative integer that denotes how many.

        • Profiles (list) –

          The profiles associated with the workload.

          • (dict) –

            The profile associated with a workload.

            • ProfileArn (string) –

              The profile ARN.

            • ProfileVersion (string) –

              The profile version.

        • PrioritizedRiskCounts (dict) –

          A map from risk names to the count of how many questions have that rating.

          • (string) –

            The risk for a given workload, lens review, pillar, or question.

            • (integer) –

              A non-negative integer that denotes how many.

    • NextToken (string) –

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

Exceptions