Get Lens Review

wellarchitected_get_lens_review

R Documentation

Get lens review¶

Description¶

Get lens review.

Usage¶

wellarchitected_get_lens_review(WorkloadId, LensAlias, MilestoneNumber)

Arguments¶

WorkloadId

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

LensAlias

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

MilestoneNumber

The milestone number.

A workload can have a maximum of 100 milestones.

Value¶

A list with the following syntax:

list(
  WorkloadId = "string",
  MilestoneNumber = 123,
  LensReview = list(
    LensAlias = "string",
    LensArn = "string",
    LensVersion = "string",
    LensName = "string",
    LensStatus = "CURRENT"|"NOT_CURRENT"|"DEPRECATED"|"DELETED"|"UNSHARED",
    PillarReviewSummaries = list(
      list(
        PillarId = "string",
        PillarName = "string",
        Notes = "string",
        RiskCounts = list(
          123
        ),
        PrioritizedRiskCounts = list(
          123
        )
      )
    ),
    JiraConfiguration = list(
      SelectedPillars = list(
        list(
          PillarId = "string",
          SelectedQuestionIds = list(
            "string"
          )
        )
      )
    ),
    UpdatedAt = as.POSIXct(
      "2015-01-01"
    ),
    Notes = "string",
    RiskCounts = list(
      123
    ),
    NextToken = "string",
    Profiles = list(
      list(
        ProfileArn = "string",
        ProfileVersion = "string"
      )
    ),
    PrioritizedRiskCounts = list(
      123
    )
  )
)

Request syntax¶

svc$get_lens_review(
  WorkloadId = "string",
  LensAlias = "string",
  MilestoneNumber = 123
)