Amazon Well-Architected Tool

Amazon Well-Architected Tool Well Architected Tool Templates API

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

GitHub OpenAPI

Operations 3

POST /templates/shares/{TemplateArn} Create Template Share #
GET /templates/shares/{TemplateArn} List Template Shares #
DELETE /templates/shares/{TemplateArn}/{ShareId} Delete Template Share #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-well-architected-tool/openapi/amazon-well-architected-tool-templates-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-templates-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

amazon-well-architected-tool-templates-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: AWS Well-Architected Tool Templates 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: Templates
paths:
  /templates/shares/{TemplateArn}:
    post:
      operationId: CreateTemplateShare
      summary: Create Template Share
      description: Create a review template share. The owner of a review template can share it with other Amazon Web Services accounts, users, an organization, and organizational units (OUs) in the same Amazon Web Services Region. Shared access to a review template is not removed until the review template share invitation is deleted. If you share a review template with an organization or OU, all accounts in the organization or OU are granted access to the review template. Disclaimer By sharing your review template with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your review template available to those other accounts.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateTemplateShareOutput'
        '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/CreateTemplateShareInput'
      tags:
      - Templates
    get:
      operationId: ListTemplateShares
      summary: List Template Shares
      description: List review template shares.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListTemplateSharesOutput'
        '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/ListTemplateSharesInput'
      tags:
      - Templates
  /templates/shares/{TemplateArn}/{ShareId}:
    delete:
      operationId: DeleteTemplateShare
      summary: Delete Template Share
      description: Delete a review template share. After the review template share 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/DeleteTemplateShareInput'
      tags:
      - Templates
components:
  schemas:
    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
    ServiceQuotaExceededException:
      type: object
      properties:
        Message:
          type: string
        ResourceId:
          type: string
        ResourceType:
          type: string
        QuotaCode:
          type: string
        ServiceCode:
          type: string
      required:
      - Message
      - QuotaCode
      - ServiceCode
    CreateTemplateShareOutput:
      type: object
      properties:
        TemplateArn:
          type: string
          description: The review template ARN.
        ShareId:
          type: string
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
        ResourceId:
          type: string
        ResourceType:
          type: string
      required:
      - Message
      - ResourceId
      - ResourceType
    DeleteTemplateShareInput:
      type: object
      properties:
        ShareId:
          type: string
        TemplateArn:
          type: string
          description: The review template ARN.
        ClientRequestToken:
          type: string
      required:
      - ShareId
      - TemplateArn
      - ClientRequestToken
    ListTemplateSharesOutput:
      type: object
      properties:
        TemplateArn:
          type: string
          description: The review template ARN.
        TemplateShareSummaries:
          type: array
          items:
            $ref: '#/components/schemas/TemplateShareSummary'
          description: A review template share summary return object.
        NextToken:
          type: string
    ValidationExceptionField:
      type: object
      properties:
        Name:
          type: string
        Message:
          type: string
      required:
      - Name
      - Message
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    CreateTemplateShareInput:
      type: object
      properties:
        TemplateArn:
          type: string
          description: The review template ARN.
        SharedWith:
          type: string
        ClientRequestToken:
          type: string
      required:
      - TemplateArn
      - SharedWith
      - ClientRequestToken
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
        QuotaCode:
          type: string
        ServiceCode:
          type: string
      required:
      - Message
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    TemplateShareSummary:
      type: object
      properties:
        ShareId:
          type: string
        SharedWith:
          type: string
        Status:
          type: string
          enum:
          - ACCEPTED
          - REJECTED
          - PENDING
          - REVOKED
          - EXPIRED
          - ASSOCIATING
          - ASSOCIATED
          - FAILED
        StatusMessage:
          type: string
          description: Review template share invitation status message.
    ListTemplateSharesInput:
      type: object
      properties:
        TemplateArn:
          type: string
          description: The review template ARN.
        SharedWithPrefix:
          type: string
          description: The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the profile is shared.
        NextToken:
          type: string
        MaxResults:
          type: integer
          description: The maximum number of results to return for this request.
        Status:
          type: string
          enum:
          - ACCEPTED
          - REJECTED
          - PENDING
          - REVOKED
          - EXPIRED
          - ASSOCIATING
          - ASSOCIATED
          - FAILED
      required:
      - TemplateArn
    ConflictException:
      type: object
      properties:
        Message:
          type: string
        ResourceId:
          type: string
        ResourceType:
          type: string
      required:
      - Message
      - ResourceId
      - ResourceType
  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)