list_lens_review_improvements

WellArchitected.Client.list_lens_review_improvements(**kwargs)

List lens review improvements.

See also: AWS API Documentation

Request Syntax

response = client.list_lens_review_improvements(
    WorkloadId='string',
    LensAlias='string',
    PillarId='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.

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

• PillarId (string) --

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

  A pillar is identified by its PillarReviewSummary$PillarId.

• 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,
    'LensAlias': 'string',
    'LensArn': 'string',
    'ImprovementSummaries': [
        {
            'QuestionId': 'string',
            'PillarId': 'string',
            'QuestionTitle': 'string',
            'Risk': 'UNANSWERED'|'HIGH'|'MEDIUM'|'NONE'|'NOT_APPLICABLE',
            'ImprovementPlanUrl': 'string',
            'ImprovementPlans': [
                {
                    'ChoiceId': 'string',
                    'DisplayText': 'string',
                    'ImprovementPlanUrl': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  Output of a list lens review improvements 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.

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

  • ImprovementSummaries (list) --

    List of improvement summaries of lens review in a workload.

    • (dict) --

      An improvement summary of a lens review in a workload.

      • QuestionId (string) --

        The ID of the question.

      • PillarId (string) --

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

        A pillar is identified by its PillarReviewSummary$PillarId.

      • QuestionTitle (string) --

        The title of the question.

      • Risk (string) --

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

      • ImprovementPlanUrl (string) --

        The improvement plan URL for a question.

        This value is only available if the question has been answered.

      • ImprovementPlans (list) --

        The improvement plan details.

        • (dict) --

          The choice level improvement plan.

          • ChoiceId (string) --

            The ID of a choice.

          • DisplayText (string) --

            The display text for the improvement plan.

          • ImprovementPlanUrl (string) --

            The improvement plan URL for a question.

            This value is only available if the question has been answered.

  • NextToken (string) --

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

Exceptions

• WellArchitected.Client.exceptions.ValidationException
• WellArchitected.Client.exceptions.InternalServerException
• WellArchitected.Client.exceptions.ResourceNotFoundException
• WellArchitected.Client.exceptions.AccessDeniedException
• WellArchitected.Client.exceptions.ThrottlingException