Skip to content

Update Lens Review

wellarchitected_update_lens_review R Documentation

Update lens review for a particular workload

Description

Update lens review for a particular workload.

Usage

wellarchitected_update_lens_review(WorkloadId, LensAlias, LensNotes,
  PillarNotes, JiraConfiguration)

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

The notes associated with the workload.

For a review template, these are the notes that will be associated with the workload when the template is applied.
PillarNotes

List of pillar notes of a lens review in a workload.

For a review template, these are the notes that will be associated with the workload when the template is applied.
JiraConfiguration

Configuration of the Jira integration.

Value

A list with the following syntax:

list(
  WorkloadId = "string",
  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$update_lens_review(
  WorkloadId = "string",
  LensAlias = "string",
  LensNotes = "string",
  PillarNotes = list(
    "string"
  ),
  JiraConfiguration = list(
    SelectedPillars = list(
      list(
        PillarId = "string",
        SelectedQuestionIds = list(
          "string"
        )
      )
    )
  )
)