Amazon Well-Architected Tool

Amazon Well-Architected Tool Well Architected Tool Answers API

The Well Architected Tool Answers API from Amazon Well-Architected Tool — 2 operation(s) for well architected tool answers.

Documentation GitHub OpenAPI

Operations 3

GET /reviewTemplates/{TemplateArn}/lensReviews/{LensAlias}/answers/{QuestionId} Get Review Template Answer #

PATCH /reviewTemplates/{TemplateArn}/lensReviews/{LensAlias}/answers/{QuestionId} Update Review Template Answer #

GET /reviewTemplates/{TemplateArn}/lensReviews/{LensAlias}/answers List Review Template Answers #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/amazon-well-architected-tool/openapi/amazon-well-architected-tool-answers-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-well-architected-tool:amazon-well-architected-tool-answers-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: AWS Well-Architected Tool Answers API
  version: '2020-03-31'
  description: Generated from AWS's published Smithy model for AWS Well-Architected Tool. 3 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://wellarchitected.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Answers
paths:
  /reviewTemplates/{TemplateArn}/lensReviews/{LensAlias}/answers/{QuestionId}:
    get:
      operationId: GetReviewTemplateAnswer
      summary: Get Review Template Answer
      description: Get review template answer.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetReviewTemplateAnswerOutput'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetReviewTemplateAnswerInput'
      tags:
      - Answers
    patch:
      operationId: UpdateReviewTemplateAnswer
      summary: Update Review Template Answer
      description: Update a review template answer.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateReviewTemplateAnswerOutput'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateReviewTemplateAnswerInput'
      tags:
      - Answers
  /reviewTemplates/{TemplateArn}/lensReviews/{LensAlias}/answers:
    get:
      operationId: ListReviewTemplateAnswers
      summary: List Review Template Answers
      description: List the answers of a review template.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReviewTemplateAnswersOutput'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListReviewTemplateAnswersInput'
      tags:
      - Answers
components:
  schemas:
    ChoiceAnswer:
      type: object
      properties:
        ChoiceId:
          type: string
        Status:
          type: string
          enum:
          - SELECTED
          - NOT_APPLICABLE
          - UNSELECTED
          description: The status of a choice.
        Reason:
          type: string
          enum:
          - OUT_OF_SCOPE
          - BUSINESS_PRIORITIES
          - ARCHITECTURE_CONSTRAINTS
          - OTHER
          - NONE
          description: The reason why a choice is non-applicable to a question in your workload.
        Notes:
          type: string
          description: The notes associated with a choice.
    UpdateReviewTemplateAnswerInput:
      type: object
      properties:
        TemplateArn:
          type: string
          description: The review template ARN.
        LensAlias:
          type: string
        QuestionId:
          type: string
        SelectedChoices:
          type: array
          items:
            type: string
        ChoiceUpdates:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ChoiceUpdate'
          description: A list of choices to be updated.
        Notes:
          type: string
        IsApplicable:
          type: boolean
        Reason:
          type: string
          enum:
          - OUT_OF_SCOPE
          - BUSINESS_PRIORITIES
          - ARCHITECTURE_CONSTRAINTS
          - OTHER
          - NONE
          description: The update reason.
      required:
      - TemplateArn
      - LensAlias
      - QuestionId
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    Choice:
      type: object
      properties:
        ChoiceId:
          type: string
        Title:
          type: string
        Description:
          type: string
        HelpfulResource:
          $ref: '#/components/schemas/ChoiceContent'
        ImprovementPlan:
          $ref: '#/components/schemas/ChoiceContent'
        AdditionalResources:
          type: array
          items:
            $ref: '#/components/schemas/AdditionalResources'
          description: 'The additional resources for a choice in a custom lens. A choice can have up to two additional resources: one of type HELPFUL_RESOURCE, one of type IMPROVEMENT_PLAN, or both.'
    ListReviewTemplateAnswersInput:
      type: object
      properties:
        TemplateArn:
          type: string
          description: The ARN of the review template.
        LensAlias:
          type: string
        PillarId:
          type: string
        NextToken:
          type: string
        MaxResults:
          type: integer
          description: The maximum number of results to return for this request.
      required:
      - TemplateArn
      - LensAlias
    ChoiceAnswerSummary:
      type: object
      properties:
        ChoiceId:
          type: string
        Status:
          type: string
          enum:
          - SELECTED
          - NOT_APPLICABLE
          - UNSELECTED
          description: The status of a choice.
        Reason:
          type: string
          enum:
          - OUT_OF_SCOPE
          - BUSINESS_PRIORITIES
          - ARCHITECTURE_CONSTRAINTS
          - OTHER
          - NONE
          description: The reason why a choice is non-applicable to a question in your workload.
    UpdateReviewTemplateAnswerOutput:
      type: object
      properties:
        TemplateArn:
          type: string
          description: The review template ARN.
        LensAlias:
          type: string
        Answer:
          $ref: '#/components/schemas/ReviewTemplateAnswer'
    ValidationExceptionField:
      type: object
      properties:
        Name:
          type: string
        Message:
          type: string
      required:
      - Name
      - Message
    ChoiceUpdate:
      type: object
      properties:
        Status:
          type: string
          enum:
          - SELECTED
          - NOT_APPLICABLE
          - UNSELECTED
          description: The status of a choice.
        Reason:
          type: string
          enum:
          - OUT_OF_SCOPE
          - BUSINESS_PRIORITIES
          - ARCHITECTURE_CONSTRAINTS
          - OTHER
          - NONE
          description: The reason why a choice is non-applicable to a question in your workload.
        Notes:
          type: string
          description: The notes associated with a choice.
      required:
      - Status
    ConflictException:
      type: object
      properties:
        Message:
          type: string
        ResourceId:
          type: string
        ResourceType:
          type: string
      required:
      - Message
      - ResourceId
      - ResourceType
    GetReviewTemplateAnswerInput:
      type: object
      properties:
        TemplateArn:
          type: string
          description: The review template ARN.
        LensAlias:
          type: string
        QuestionId:
          type: string
      required:
      - TemplateArn
      - LensAlias
      - QuestionId
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
        ResourceId:
          type: string
        ResourceType:
          type: string
      required:
      - Message
      - ResourceId
      - ResourceType
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
        QuotaCode:
          type: string
        ServiceCode:
          type: string
      required:
      - Message
    AdditionalResources:
      type: object
      properties:
        Type:
          type: string
          enum:
          - HELPFUL_RESOURCE
          - IMPROVEMENT_PLAN
          description: Type of additional resource for a custom lens.
        Content:
          type: array
          items:
            $ref: '#/components/schemas/ChoiceContent'
          description: The URLs for additional resources, either helpful resources or improvement plans, for a custom lens. Up to five additional URLs can be specified.
    ChoiceContent:
      type: object
      properties:
        DisplayText:
          type: string
          description: The display text for the choice content.
        Url:
          type: string
          description: The URL for the choice content.
    ValidationException:
      type: object
      properties:
        Message:
          type: string
        Reason:
          type: string
          enum:
          - UNKNOWN_OPERATION
          - CANNOT_PARSE
          - FIELD_VALIDATION_FAILED
          - OTHER
        Fields:
          type: array
          items:
            $ref: '#/components/schemas/ValidationExceptionField'
      required:
      - Message
    ReviewTemplateAnswer:
      type: object
      properties:
        QuestionId:
          type: string
        PillarId:
          type: string
        QuestionTitle:
          type: string
        QuestionDescription:
          type: string
        ImprovementPlanUrl:
          type: string
        HelpfulResourceUrl:
          type: string
        HelpfulResourceDisplayText:
          type: string
          description: The helpful resource text to be displayed for a custom lens. This field does not apply to Amazon Web Services official lenses.
        Choices:
          type: array
          items:
            $ref: '#/components/schemas/Choice'
        SelectedChoices:
          type: array
          items:
            type: string
        ChoiceAnswers:
          type: array
          items:
            $ref: '#/components/schemas/ChoiceAnswer'
          description: A list of selected choices to a question in your review template.
        IsApplicable:
          type: boolean
        AnswerStatus:
          type: string
          enum:
          - UNANSWERED
          - ANSWERED
          description: The status of whether or not this question has been answered.
        Notes:
          type: string
        Reason:
          type: string
          enum:
          - OUT_OF_SCOPE
          - BUSINESS_PRIORITIES
          - ARCHITECTURE_CONSTRAINTS
          - OTHER
          - NONE
          description: The reason why the question is not applicable to your review template.
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    ListReviewTemplateAnswersOutput:
      type: object
      properties:
        TemplateArn:
          type: string
          description: The ARN of the review template.
        LensAlias:
          type: string
        AnswerSummaries:
          type: array
          items:
            $ref: '#/components/schemas/ReviewTemplateAnswerSummary'
          description: List of answer summaries of a lens review in a review template.
        NextToken:
          type: string
    ReviewTemplateAnswerSummary:
      type: object
      properties:
        QuestionId:
          type: string
        PillarId:
          type: string
        QuestionTitle:
          type: string
        Choices:
          type: array
          items:
            $ref: '#/components/schemas/Choice'
        SelectedChoices:
          type: array
          items:
            type: string
        ChoiceAnswerSummaries:
          type: array
          items:
            $ref: '#/components/schemas/ChoiceAnswerSummary'
          description: A list of selected choices to a question in the review template.
        IsApplicable:
          type: boolean
        AnswerStatus:
          type: string
          enum:
          - UNANSWERED
          - ANSWERED
          description: The status of whether or not this question has been answered.
        Reason:
          type: string
          enum:
          - OUT_OF_SCOPE
          - BUSINESS_PRIORITIES
          - ARCHITECTURE_CONSTRAINTS
          - OTHER
          - NONE
          description: The reason why a choice is not-applicable to a question in the review template.
        QuestionType:
          type: string
          enum:
          - PRIORITIZED
          - NON_PRIORITIZED
          description: The type of question.
    GetReviewTemplateAnswerOutput:
      type: object
      properties:
        TemplateArn:
          type: string
          description: The review template ARN.
        LensAlias:
          type: string
        Answer:
          $ref: '#/components/schemas/ReviewTemplateAnswer'
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: wellarchitected
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/wellarchitected/service/2020-03-31/wellarchitected-2020-03-31.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)