Amazon Well-Architected Tool Lens Review Report

arazzo: 1.0.1
info:
  title: Amazon Well-Architected Tool Lens Review Report
  summary: Find a lens review on a workload and generate its review report.
  description: >-
    Produce the review report for a lens applied to a workload. The workflow
    lists the lens reviews on the workload, reads the chosen lens review to
    confirm it exists, and then fetches the lens review report so it can be
    downloaded or rendered. Every step spells out its request inline so the flow
    can be read and executed without opening the underlying OpenAPI
    description.
  version: 1.0.0
sourceDescriptions:
- name: workloadsApi
  url: ../openapi/amazon-well-architected-tool-workloads-api-openapi.yml
  type: openapi
workflows:
- workflowId: lens-review-report
  summary: List lens reviews, open one, and fetch its review report.
  description: >-
    Lists the lens reviews on a workload, retrieves the lens review for the
    supplied lens alias, and then generates the lens review report for that
    lens.
  inputs:
    type: object
    required:
    - WorkloadId
    - LensAlias
    properties:
      WorkloadId:
        type: string
        description: The 32-character workload ID.
      LensAlias:
        type: string
        description: The alias or ARN of the lens to report on.
  steps:
  - stepId: listLensReviews
    description: >-
      List the lens reviews on the workload to confirm the target lens is
      applied.
    operationId: ListLensReviews
    parameters:
    - name: WorkloadId
      in: path
      value: $inputs.WorkloadId
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      lensReviewSummaries: $response.body#/LensReviewSummaries
  - stepId: getLensReview
    description: >-
      Read the lens review for the supplied lens alias to confirm it exists
      before generating the report.
    operationId: GetLensReview
    parameters:
    - name: WorkloadId
      in: path
      value: $inputs.WorkloadId
    - name: LensAlias
      in: path
      value: $inputs.LensAlias
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      lensReview: $response.body#/LensReview
  - stepId: getLensReviewReport
    description: >-
      Fetch the lens review report for the lens so it can be downloaded or
      rendered.
    operationId: GetLensReviewReport
    parameters:
    - name: WorkloadId
      in: path
      value: $inputs.WorkloadId
    - name: LensAlias
      in: path
      value: $inputs.LensAlias
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      lensReviewReport: $response.body#/LensReviewReport
  outputs:
    lensReviewSummaries: $steps.listLensReviews.outputs.lensReviewSummaries
    lensReviewReport: $steps.getLensReviewReport.outputs.lensReviewReport