Amazon Web Services Workloads API
The Workloads API from Amazon Web Services — 21 operation(s) for workloads.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-web-services-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
openapi: 3.2.0
info:
title: Amazon Web Services wellarchitected 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.'
tags:
- name: Workloads
paths:
/workloads/{WorkloadId}/associateLenses:
PATCH:
summary: Amazon Web Services Associatelenses
description: Associate a lens to a workload. Up to 10 lenses can be associated with a workload in a single API operation. A maximum of 20 lenses can be associated with a workload. Disclaimer By accessing and/or applying custom lenses created by another Amazon Web Services user or account, you acknowledge that custom lenses created by other users and shared with you are Third Party Content as defined in the Amazon Web Services Customer Agreement.
operationId: amazonWebServicesAssociateLenses
tags:
- Workloads
/workloads/{WorkloadId}/associateProfiles:
PATCH:
summary: Amazon Web Services Associateprofiles
description: Associate a profile with a workload.
operationId: amazonWebServicesAssociateProfiles
tags:
- Workloads
/workloads/{WorkloadId}/milestones:
POST:
summary: Amazon Web Services Createmilestone
description: Create a milestone for an existing workload.
operationId: amazonWebServicesCreateMilestone
tags:
- Workloads
/workloads:
POST:
summary: Amazon Web Services Createworkload
description: 'Create a new workload. The owner of a workload can share the workload with other Amazon Web Services accounts, users, an organization, and organizational units (OUs) in the same Amazon Web Services Region. Only the owner of a workload can delete it. For more information, see Defining a Workload in the Well-Architected Tool User Guide. Either AwsRegions, NonAwsRegions, or both must be specified when creating a workload. You also must specify ReviewOwner, even though the parameter is listed as not being required in the following section. When creating a workload using a review template, you must have the following IAM permissions: wellarchitected:GetReviewTemplate wellarchitected:GetReviewTemplateAnswer wellarchitected:ListReviewTemplateAnswers wellarchitected:GetReviewTemplateLensReview'
operationId: amazonWebServicesCreateWorkload
tags:
- Workloads
/workloads/{WorkloadId}/shares:
GET:
summary: Amazon Web Services Listworkloadshares
description: List the workload shares associated with the workload.
operationId: amazonWebServicesListWorkloadShares
tags:
- Workloads
/workloads/{WorkloadId}:
PATCH:
summary: Amazon Web Services Updateworkload
description: Update an existing workload.
operationId: amazonWebServicesUpdateWorkload
tags:
- Workloads
/workloads/{WorkloadId}/shares/{ShareId}:
PATCH:
summary: Amazon Web Services Updateworkloadshare
description: Update a workload share.
operationId: amazonWebServicesUpdateWorkloadShare
tags:
- Workloads
/workloads/{WorkloadId}/disassociateLenses:
PATCH:
summary: Amazon Web Services Disassociatelenses
description: Disassociate a lens from a workload. Up to 10 lenses can be disassociated from a workload in a single API operation. The Amazon Web Services Well-Architected Framework lens (wellarchitected) cannot be removed from a workload.
operationId: amazonWebServicesDisassociateLenses
tags:
- Workloads
/workloads/{WorkloadId}/disassociateProfiles:
PATCH:
summary: Amazon Web Services Disassociateprofiles
description: Disassociate a profile from a workload.
operationId: amazonWebServicesDisassociateProfiles
tags:
- Workloads
/workloads/{WorkloadId}/lensReviews/{LensAlias}/answers/{QuestionId}:
PATCH:
summary: Amazon Web Services Updateanswer
description: Update the answer to a specific question in a workload review.
operationId: amazonWebServicesUpdateAnswer
tags:
- Workloads
/workloads/{WorkloadId}/lensReviews/{LensAlias}:
PATCH:
summary: Amazon Web Services Updatelensreview
description: Update lens review for a particular workload.
operationId: amazonWebServicesUpdateLensReview
tags:
- Workloads
/workloads/{WorkloadId}/lensReviews/{LensAlias}/report:
GET:
summary: Amazon Web Services Getlensreviewreport
description: Get lens review report.
operationId: amazonWebServicesGetLensReviewReport
tags:
- Workloads
/workloads/{WorkloadId}/milestones/{MilestoneNumber}:
GET:
summary: Amazon Web Services Getmilestone
description: Get a milestone for an existing workload.
operationId: amazonWebServicesGetMilestone
tags:
- Workloads
/workloads/{WorkloadId}/lensReviews/{LensAlias}/answers:
GET:
summary: Amazon Web Services Listanswers
description: List of answers for a particular workload and lens.
operationId: amazonWebServicesListAnswers
tags:
- Workloads
/workloads/{WorkloadId}/checks:
POST:
summary: Amazon Web Services Listcheckdetails
description: List of Trusted Advisor check details by account related to the workload.
operationId: amazonWebServicesListCheckDetails
tags:
- Workloads
/workloads/{WorkloadId}/checkSummaries:
POST:
summary: Amazon Web Services Listchecksummaries
description: List of Trusted Advisor checks summarized for all accounts related to the workload.
operationId: amazonWebServicesListCheckSummaries
tags:
- Workloads
/workloads/{WorkloadId}/lensReviews/{LensAlias}/improvements:
GET:
summary: Amazon Web Services Listlensreviewimprovements
description: List lens review improvements.
operationId: amazonWebServicesListLensReviewImprovements
tags:
- Workloads
/workloads/{WorkloadId}/lensReviews:
GET:
summary: Amazon Web Services Listlensreviews
description: List lens reviews for a particular workload.
operationId: amazonWebServicesListLensReviews
tags:
- Workloads
/workloads/{WorkloadId}/milestonesSummaries:
POST:
summary: Amazon Web Services Listmilestones
description: List all milestones for an existing workload.
operationId: amazonWebServicesListMilestones
tags:
- Workloads
/workloads/{WorkloadId}/lensReviews/{LensAlias}/upgrade:
PUT:
summary: Amazon Web Services Upgradelensreview
description: Upgrade lens review for a particular workload.
operationId: amazonWebServicesUpgradeLensReview
tags:
- Workloads
/workloads/{WorkloadId}/profiles/{ProfileArn}/upgrade:
PUT:
summary: Amazon Web Services Upgradeprofileversion
description: Upgrade a profile.
operationId: amazonWebServicesUpgradeProfileVersion
tags:
- Workloads