WellArchitected / Client / get_lens_review_report

get_lens_review_report#

WellArchitected.Client.get_lens_review_report(**kwargs)#

Get lens review report.

See also: AWS API Documentation

Request Syntax

response = client.get_lens_review_report(
    WorkloadId='string',
    LensAlias='string',
    MilestoneNumber=123
)
Parameters:

  • WorkloadId (string) –

    [REQUIRED]

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

  • LensAlias (string) –

    [REQUIRED]

    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-west-2::lens/serverless .

    For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-east-1:123456789012:lens/my-lens .

    Each lens is identified by its LensSummary$LensAlias.

  • MilestoneNumber (integer) –

    The milestone number.

    A workload can have a maximum of 100 milestones.

Return type:

dict

Returns:

Response Syntax

{
    'WorkloadId': 'string',
    'MilestoneNumber': 123,
    'LensReviewReport': {
        'LensAlias': 'string',
        'LensArn': 'string',
        'Base64String': 'string'
    }
}

Response Structure

  • (dict) –

    Output of a get lens review report 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.

    • LensReviewReport (dict) –

      A report of a lens review.

      • 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-west-2::lens/serverless .

        For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-east-1:123456789012:lens/my-lens .

        Each lens is identified by its LensSummary$LensAlias.

      • LensArn (string) –

        The ARN for the lens.

      • Base64String (string) –

        The Base64-encoded string representation of a lens review report.

        This data can be used to create a PDF file.

Exceptions

  • WellArchitected.Client.exceptions.ValidationException

  • WellArchitected.Client.exceptions.ResourceNotFoundException

  • WellArchitected.Client.exceptions.InternalServerException

  • WellArchitected.Client.exceptions.AccessDeniedException

  • WellArchitected.Client.exceptions.ThrottlingException