Amazon Well-Architected Tool Workloads API

The Workloads API from Amazon Well-Architected Tool — 23 operation(s) for workloads.

Operations 27

PATCH /workloads/{WorkloadId}/associateLenses Amazon Well-Architected Tool Associate Lenses #
PATCH /workloads/{WorkloadId}/associateProfiles Amazon Well-Architected Tool Associate Profiles #
POST /workloads/{WorkloadId}/milestones Amazon Well-Architected Tool Create Milestone #
POST /workloads Amazon Well-Architected Tool Create Workload #
POST /workloads/{WorkloadId}/shares Amazon Well-Architected Tool Create Workload Share #
GET /workloads/{WorkloadId}/shares Amazon Well-Architected Tool List Workload Shares #
DELETE /workloads/{WorkloadId}#ClientRequestToken Amazon Well-Architected Tool Delete Workload #
DELETE /workloads/{WorkloadId}/shares/{ShareId}#ClientRequestToken Amazon Well-Architected Tool Delete Workload Share #
PATCH /workloads/{WorkloadId}/disassociateLenses Amazon Well-Architected Tool Disassociate Lenses #
PATCH /workloads/{WorkloadId}/disassociateProfiles Amazon Well-Architected Tool Disassociate Profiles #
GET /workloads/{WorkloadId}/lensReviews/{LensAlias}/answers/{QuestionId} Amazon Well-Architected Tool Get Answer #
PATCH /workloads/{WorkloadId}/lensReviews/{LensAlias}/answers/{QuestionId} Amazon Well-Architected Tool Update Answer #
GET /workloads/{WorkloadId}/lensReviews/{LensAlias} Amazon Well-Architected Tool Get Lens Review #
PATCH /workloads/{WorkloadId}/lensReviews/{LensAlias} Amazon Well-Architected Tool Update Lens Review #
GET /workloads/{WorkloadId}/lensReviews/{LensAlias}/report Amazon Well-Architected Tool Get Lens Review Report #
GET /workloads/{WorkloadId}/milestones/{MilestoneNumber} Amazon Well-Architected Tool Get Milestone #
GET /workloads/{WorkloadId} Amazon Well-Architected Tool Get Workload #
PATCH /workloads/{WorkloadId} Amazon Well-Architected Tool Update Workload #
GET /workloads/{WorkloadId}/lensReviews/{LensAlias}/answers Amazon Well-Architected Tool List Answers #
POST /workloads/{WorkloadId}/checks Amazon Well-Architected Tool List Check Details #
POST /workloads/{WorkloadId}/checkSummaries Amazon Well-Architected Tool List Check Summaries #
GET /workloads/{WorkloadId}/lensReviews/{LensAlias}/improvements Amazon Well-Architected Tool List Lens Review Improvements #
GET /workloads/{WorkloadId}/lensReviews Amazon Well-Architected Tool List Lens Reviews #
POST /workloads/{WorkloadId}/milestonesSummaries Amazon Well-Architected Tool List Milestones #
PATCH /workloads/{WorkloadId}/shares/{ShareId} Amazon Well-Architected Tool Update Workload Share #
PUT /workloads/{WorkloadId}/lensReviews/{LensAlias}/upgrade Amazon Well-Architected Tool Upgrade Lens Review #
PUT /workloads/{WorkloadId}/profiles/{ProfileArn}/upgrade Amazon Well-Architected Tool Upgrade Profile Version #

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-workloads-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

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

OpenAPI Specification

amazon-well-architected-tool-workloads-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  version: '2020-03-31'
  x-release: v4
  title: AWS Well-Architected Tool Workloads API
  description: 'Well-Architected Tool

    This is the Well-Architected Tool API Reference. The WA Tool API provides programmatic access to the Well-Architected Tool in the Amazon Web Services Management Console. For information about the Well-Architected Tool, see the Well-Architected Tool User Guide.'
  x-logo:
    url: https://twitter.com/awscloud/profile_image?size=original
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: wellarchitected
  x-aws-signingName: wellarchitected
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/wellarchitected-2020-03-31.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://wellarchitected.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Well-Architected multi-region endpoint
- url: https://wellarchitected.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Well-Architected multi-region endpoint
- url: http://wellarchitected.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Well-Architected endpoint for China (Beijing) and China (Ningxia)
- url: https://wellarchitected.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Well-Architected endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:


# --- truncated at 32 KB (148 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-well-architected-tool/refs/heads/main/openapi/amazon-well-architected-tool-workloads-api-openapi.yml