Amazon Well-Architected Tool

Amazon Well-Architected Tool Well Architected Tool Reviewtemplates API

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

Documentation GitHub OpenAPI

Business capability

IT Strategy & Architecture Management BC-600.10

Operations 5

POST /reviewTemplates Create Review Template #

GET /reviewTemplates List Review Templates #

DELETE /reviewTemplates/{TemplateArn} Delete Review Template #

GET /reviewTemplates/{TemplateArn} Get Review Template #

PATCH /reviewTemplates/{TemplateArn} Update Review Template #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/amazon-well-architected-tool/openapi/amazon-well-architected-tool-reviewtemplates-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-reviewtemplates-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 Reviewtemplates API
  version: '2020-03-31'
  description: Generated from AWS's published Smithy model for AWS Well-Architected Tool. 5 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: Reviewtemplates
paths:
  /reviewTemplates:
    post:
      operationId: CreateReviewTemplate
      summary: Create Review Template
      description: 'Create a review template. Disclaimer Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your review templates. If your review template or those shared with you and used in your account do include or collect PII you are responsible for: ensuring that the included PII is processed in accordance with applicable law, providing adequate privacy notices, and obtaining necessary consents for processing such data.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateReviewTemplateOutput'
        '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'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '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/CreateReviewTemplateInput'
      tags:
      - Reviewtemplates
    get:
      operationId: ListReviewTemplates
      summary: List Review Templates
      description: List review templates.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReviewTemplatesOutput'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '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/ListReviewTemplatesInput'
      tags:
      - Reviewtemplates
  /reviewTemplates/{TemplateArn}:
    delete:
      operationId: DeleteReviewTemplate
      summary: Delete Review Template
      description: Delete a review template. Only the owner of a review template can delete it. After the review template is deleted, Amazon Web Services accounts, users, organizations, and organizational units (OUs) that you shared the review template with will no longer be able to apply it to new workloads.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '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/DeleteReviewTemplateInput'
      tags:
      - Reviewtemplates
    get:
      operationId: GetReviewTemplate
      summary: Get Review Template
      description: Get review template.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetReviewTemplateOutput'
        '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/GetReviewTemplateInput'
      tags:
      - Reviewtemplates
    patch:
      operationId: UpdateReviewTemplate
      summary: Update Review Template
      description: Update a review template.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateReviewTemplateOutput'
        '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/UpdateReviewTemplateInput'
      tags:
      - Reviewtemplates
components:
  schemas:
    ListReviewTemplatesOutput:
      type: object
      properties:
        ReviewTemplates:
          type: array
          items:
            $ref: '#/components/schemas/ReviewTemplateSummary'
          description: List of review templates.
        NextToken:
          type: string
    UpdateReviewTemplateOutput:
      type: object
      properties:
        ReviewTemplate:
          $ref: '#/components/schemas/ReviewTemplate'
    CreateReviewTemplateInput:
      type: object
      properties:
        TemplateName:
          type: string
          description: Name of the review template.
        Description:
          type: string
          description: The review template description.
        Lenses:
          type: array
          items:
            type: string
          description: Lenses applied to the review template.
        Notes:
          type: string
        Tags:
          type: object
          additionalProperties:
            type: string
          description: The tags assigned to the review template.
        ClientRequestToken:
          type: string
      required:
      - TemplateName
      - Description
      - Lenses
      - ClientRequestToken
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    ValidationExceptionField:
      type: object
      properties:
        Name:
          type: string
        Message:
          type: string
      required:
      - Name
      - Message
    DeleteReviewTemplateInput:
      type: object
      properties:
        TemplateArn:
          type: string
          description: The review template ARN.
        ClientRequestToken:
          type: string
      required:
      - TemplateArn
      - ClientRequestToken
    ReviewTemplateSummary:
      type: object
      properties:
        Description:
          type: string
          description: Description of the review template.
        Lenses:
          type: array
          items:
            type: string
          description: Lenses associated with the review template.
        Owner:
          type: string
        UpdatedAt:
          type: string
          description: The date and time when the review template was last updated.
        TemplateArn:
          type: string
          description: The review template ARN.
        TemplateName:
          type: string
          description: The name of the review template.
        UpdateStatus:
          type: string
          enum:
          - CURRENT
          - LENS_NOT_CURRENT
          description: The latest status of a review template.
    ConflictException:
      type: object
      properties:
        Message:
          type: string
        ResourceId:
          type: string
        ResourceType:
          type: string
      required:
      - Message
      - ResourceId
      - ResourceType
    ServiceQuotaExceededException:
      type: object
      properties:
        Message:
          type: string
        ResourceId:
          type: string
        ResourceType:
          type: string
        QuotaCode:
          type: string
        ServiceCode:
          type: string
      required:
      - Message
      - QuotaCode
      - ServiceCode
    GetReviewTemplateInput:
      type: object
      properties:
        TemplateArn:
          type: string
          description: The review template ARN.
      required:
      - TemplateArn
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
        ResourceId:
          type: string
        ResourceType:
          type: string
      required:
      - Message
      - ResourceId
      - ResourceType
    ListReviewTemplatesInput:
      type: object
      properties:
        NextToken:
          type: string
        MaxResults:
          type: integer
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
        QuotaCode:
          type: string
        ServiceCode:
          type: string
      required:
      - Message
    ReviewTemplate:
      type: object
      properties:
        Description:
          type: string
          description: The review template description.
        Lenses:
          type: array
          items:
            type: string
          description: The lenses applied to the review template.
        Notes:
          type: string
        QuestionCounts:
          type: object
          additionalProperties:
            type: integer
          description: A count of how many total questions are answered and unanswered in the review template.
        Owner:
          type: string
        UpdatedAt:
          type: string
          description: The date and time when the review template was last updated.
        TemplateArn:
          type: string
          description: The review template ARN.
        TemplateName:
          type: string
          description: The name of the review template.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: The tags assigned to the review template.
        UpdateStatus:
          type: string
          enum:
          - CURRENT
          - LENS_NOT_CURRENT
          description: The latest status of a review template.
        ShareInvitationId:
          type: string
          description: The ID assigned to the template share invitation.
    UpdateReviewTemplateInput:
      type: object
      properties:
        TemplateArn:
          type: string
          description: The review template ARN.
        TemplateName:
          type: string
          description: The review template name.
        Description:
          type: string
          description: The review template description.
        Notes:
          type: string
        LensesToAssociate:
          type: array
          items:
            type: string
          description: A list of lens aliases or ARNs to apply to the review template.
        LensesToDisassociate:
          type: array
          items:
            type: string
          description: A list of lens aliases or ARNs to unapply to the review template. The wellarchitected lens cannot be unapplied.
      required:
      - TemplateArn
    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
    GetReviewTemplateOutput:
      type: object
      properties:
        ReviewTemplate:
          $ref: '#/components/schemas/ReviewTemplate'
    CreateReviewTemplateOutput:
      type: object
      properties:
        TemplateArn:
          type: string
          description: The review template ARN.
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
  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)