Amazon Web Services, Inc.

AWS Well-Architected Tool

Amazon Web Services Well-Architected This is the Amazon Web Services Well-Architected API Reference . Amazon Web Services Well-Architected helps you evaluate…

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Amazon Web Services Well-Architected This is the Amazon Web Services Well-Architected API Reference . Amazon Web Services Well-Architected helps you evaluate your architectures against Amazon Web Services best practices across operational excellence, security, reliability, performance efficiency, cost optimization, and sustainability. To view API actions organized by service, see API actions . Amazon Web Services Well-Architected Agent (preview) Describes the API operations for managing optimization profiles, goals, application context, and recommendations in the Amazon Web Services Well-Architected Agent. Through this API, you can create and configure agent profiles that define the scope of your Amazon Web Services environment to analyze, set optimization goals across cost, security, performance, and resilience pillars, start recommendation generation, retrieve prioritized recommendations with ready-to-deploy remediation scripts, and provide feedback to improve future recommendations. For more information, see What is Amazon Web Services Well-Architected Agent? Well-Architected Tool Describes the API operations for creating and managing workloads, conducting lens reviews, tracking milestones, managing custom lenses, sharing workloads across accounts, and managing profiles with the Well-Architected Tool. For more information, see What is Well-Architected Tool?

Endpoints 112

  • PATCHAssociate lenses/workloads/:WorkloadId/associateLensesAssociate 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…
  • PATCHAssociate profiles/workloads/:WorkloadId/associateProfilesAssociate a profile with a workload.
  • POSTCreate agent basic profile/api/v1/agent-basic-profileCreates a Basic profile for the calling account. No configuration input is required because the account and region are inferred from the caller. The profile…
  • GETList agent contexts/api/v1/agent-profiles/:profileArn/contexts?maxResults=0&nextToken=stringLists contexts associated with a profile.
  • POSTCreate agent context/api/v1/agent-profiles/:profileArn/contextsCreates a context associated with an optimization profile. Contexts provide application and environment information used during recommendation generation.
  • GETList agent goals/api/v1/agent-profiles/:profileArn/goals?maxResults=0&nextToken=stringLists optimization goals associated with a specified profile. Goals define specific targets and objectives for the optimization process.
  • POSTCreate agent goal/api/v1/agent-profiles/:profileArn/goalsCreates an optimization goal associated with a profile. Goals define specific targets and objectives for the optimization process.
  • POSTCreate agent organizational profile/api/v1/agent-organizational-profilesCreates an Organizational Profile for use with AWS Organizations integration. Organizational Profiles are scoped to an AWS Organization and do not require an…
  • GETList agent organizational reports/api/v1/agent-organizational-reports?maxResults=0&nextToken=string&state=stringLists Organizational Reports owned by the caller's account within the caller's AWS Organization, ordered by most recently created first. Supports pagination…
  • POSTCreate agent organizational report/api/v1/agent-organizational-reportsCreates an Organizational Report, which is an asynchronously-materialized, point-in-time snapshot of recommendations across all Agent Profiles within the…
  • GETList agent profiles/api/v1/agent-profiles?maxResults=0&nextToken=stringLists optimization profiles in your account. Profiles define the scope and configuration for generating optimization recommendations.
  • POSTCreate agent profile/api/v1/agent-profilesCreates an optimization profile that defines the scope and configuration for generating recommendations. A profile specifies the execution role, target…
  • GETList lens shares/lenses/:LensAlias/shares?SharedWithPrefix=string&NextToken=string&MaxResults=0&Status=stringList the lens shares associated with the lens.
  • POSTCreate lens share/lenses/:LensAlias/sharesCreate a lens share. The owner of a lens can share it with other Amazon Web Services accounts, users, an organization, and organizational units (OUs) in the…
  • POSTCreate lens version/lenses/:LensAlias/versionsCreate a new lens version. A lens can have up to 100 versions. Use this operation to publish a new lens version after you have imported a lens. The LensAlias…
  • POSTCreate milestone/workloads/:WorkloadId/milestonesCreate a milestone for an existing workload.
  • POSTCreate profile/profilesCreate a profile.
  • GETList profile shares/profiles/:ProfileArn/shares?SharedWithPrefix=string&NextToken=string&MaxResults=0&Status=stringList profile shares.
  • POSTCreate profile share/profiles/:ProfileArn/sharesCreate a profile share.
  • GETList review templates/reviewTemplates?NextToken=string&MaxResults=0List review templates.
  • POSTCreate review template/reviewTemplatesCreate a review template. Disclaimer Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via…
  • GETList template shares/templates/shares/:TemplateArn?SharedWithPrefix=string&NextToken=string&MaxResults=0&Status=stringList review template shares.
  • POSTCreate template share/templates/shares/:TemplateArnCreate a review template share. The owner of a review template can share it with other Amazon Web Services accounts, users, an organization, and…
  • POSTCreate workload/workloadsCreate a new workload. The owner of a workload can share the workload with other Amazon Web Services accounts, users, an organization, and organizational…
  • GETList workload shares/workloads/:WorkloadId/shares?SharedWithPrefix=string&NextToken=string&MaxResults=0&Status=stringList the workload shares associated with the workload.
  • POSTCreate workload share/workloads/:WorkloadId/sharesCreate a workload share. The owner of a workload can share it with other Amazon Web Services accounts and users in the same Amazon Web Services Region. Shared…
  • GETGet agent context/api/v1/agent-profiles/:profileArn/contexts/:idRetrieves detailed information about a specific context associated with a profile.
  • PUTUpdate agent context/api/v1/agent-profiles/:profileArn/contexts/:idUpdates an existing context associated with a profile.
  • DELETEDelete agent context/api/v1/agent-profiles/:profileArn/contexts/:idDeletes a context associated with a profile.
  • GETGet agent goal/api/v1/agent-profiles/:profileArn/goals/:idRetrieves detailed information about a specific optimization goal.
  • PUTUpdate agent goal/api/v1/agent-profiles/:profileArn/goals/:idUpdates the pillars and title of an existing goal associated with a profile.
  • DELETEDelete agent goal/api/v1/agent-profiles/:profileArn/goals/:idDeletes an optimization goal from a profile.
  • GETGet agent organizational report/api/v1/agent-organizational-reports/:reportIdRetrieves metadata and current state for a single Organizational Report. The coverageSummary is populated once the report reaches COMPLETED and is absent for…
  • DELETEDelete agent organizational report/api/v1/agent-organizational-reports/:reportIdDeletes an Organizational Report and its associated artifacts. The operation is idempotent, so repeated calls for a report that has already been deleted…
  • GETGet agent profile/api/v1/agent-profiles/:profileArnRetrieves detailed information about an optimization profile, including its configuration and metadata.
  • PUTUpdate agent profile/api/v1/agent-profiles/:profileArnUpdates an existing optimization profile's configuration, including its pillars, execution role, and aggregation settings. Include only the fields you want to…
  • DELETEDelete agent profile/api/v1/agent-profiles/:profileArnDeletes an optimization profile and its associated configuration. This action cannot be undone.
  • GETGet agent profile policy/api/v1/agent-profiles/:profileArn/policyRetrieves the resource-based policy attached to an Agent Profile. Only the profile owner can call this operation.
  • PUTPut agent profile policy/api/v1/agent-profiles/:profileArn/policyAttaches or replaces a resource-based policy on an Agent Profile. The policy controls cross-account access to the profile and its child resources such as…
  • DELETEDelete agent profile policy/api/v1/agent-profiles/:profileArn/policyRemoves the resource-based policy from an Agent Profile. This revokes all cross-account access previously granted by the policy. Only the profile owner can…
  • GETGet agent recommendation policy/api/v1/agent-recommendations/:recommendationArn/policyRetrieves the resource-based policy attached to an individual Agent Recommendation. The recommendation owner or any principal with profile write access on the…
  • PUTPut agent recommendation policy/api/v1/agent-recommendations/:recommendationArn/policyAttaches or replaces a resource-based policy on an individual Agent Recommendation. The policy controls cross-account access to the recommendation and its…
  • DELETEDelete agent recommendation policy/api/v1/agent-recommendations/:recommendationArn/policyRemoves the resource-based policy from an individual Agent Recommendation. This revokes all cross-account access previously granted by the policy. The…
  • GETGet lens/lenses/:LensAlias?LensVersion=stringGet an existing lens.
  • DELETEDelete lens/lenses/:LensAlias?ClientRequestToken=string&LensStatus=stringDelete an existing lens. Only the owner of a lens can delete it. After the lens is deleted, Amazon Web Services accounts and users that you shared the lens…
  • DELETEDelete lens share/lenses/:LensAlias/shares/:ShareId?ClientRequestToken=stringDelete a lens share. After the lens share is deleted, Amazon Web Services accounts, users, organizations, and organizational units (OUs) that you shared the…
  • GETGet profile/profiles/:ProfileArn?ProfileVersion=stringGet profile information.
  • DELETEDelete profile/profiles/:ProfileArn?ClientRequestToken=stringDelete a profile. Disclaimer By sharing your profile with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your profile…
  • PATCHUpdate profile/profiles/:ProfileArnUpdate a profile.
  • DELETEDelete profile share/profiles/:ProfileArn/shares/:ShareId?ClientRequestToken=stringDelete a profile share.
  • GETGet review template/reviewTemplates/:TemplateArnGet review template.
  • DELETEDelete review template/reviewTemplates/:TemplateArn?ClientRequestToken=stringDelete a review template. Only the owner of a review template can delete it. After the review template is deleted, Amazon Web Services accounts, users,…
  • PATCHUpdate review template/reviewTemplates/:TemplateArnUpdate a review template.
  • DELETEDelete template share/templates/shares/:TemplateArn/:ShareId?ClientRequestToken=stringDelete a review template share. After the review template share is deleted, Amazon Web Services accounts, users, organizations, and organizational units (OUs)…
  • GETGet workload/workloads/:WorkloadIdGet an existing workload.
  • DELETEDelete workload/workloads/:WorkloadId?ClientRequestToken=stringDelete an existing workload.
  • PATCHUpdate workload/workloads/:WorkloadIdUpdate an existing workload.
  • DELETEDelete workload share/workloads/:WorkloadId/shares/:ShareId?ClientRequestToken=stringDelete a workload share.
  • PATCHUpdate workload share/workloads/:WorkloadId/shares/:ShareIdUpdate a workload share.
  • PATCHDisassociate lenses/workloads/:WorkloadId/disassociateLensesDisassociate 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…
  • PATCHDisassociate profiles/workloads/:WorkloadId/disassociateProfilesDisassociate a profile from a workload.
  • GETExport lens/lenses/:LensAlias/export?LensVersion=stringExport an existing lens. Only the owner of a lens can export it. Lenses provided by Amazon Web Services (Amazon Web Services Official Content) cannot be…
  • GETGet agent organizational report data/api/v1/agent-organizational-reports/:reportId/data?format=stringRetrieves the data artifact for a completed Organizational Report as a short-lived presigned S3 URL. The response contains the URL in downloadUrl and its…
  • GETGet agent preferences/api/v1/agent-preferencesReturns the caller's complete set of Well-Architected Agent preferences with their current states.
  • PUTPut agent preferences/api/v1/agent-preferencesCreates or replaces the caller's Well-Architected Agent preferences. Each supplied update sets the desired state of one preference. Preferences not named in…
  • GETGet agent recommendation/api/v1/agent-recommendations/:recommendationArn?remediationType=stringApplication-level recommendations are a new recommendation format currently in beta. We are actively seeking customer feedback to improve their quality and…
  • GETGet agent recommendation generation/api/v1/agent-profiles/:profileArn/generations/:generationIdApplication-level recommendations are a new recommendation format currently in beta. We are actively seeking customer feedback to improve their quality and…
  • GETGet answer/workloads/:WorkloadId/lensReviews/:LensAlias/answers/:QuestionId?MilestoneNumber=0Get the answer to a specific question in a workload review.
  • PATCHUpdate answer/workloads/:WorkloadId/lensReviews/:LensAlias/answers/:QuestionIdUpdate the answer to a specific question in a workload review.
  • GETGet consolidated report/consolidatedReport?Format=string&IncludeSharedResources=true&NextToken=string&MaxResults=0Get a consolidated report of your workloads. You can optionally choose to include workloads that have been shared with you.
  • GETGet global settings/global-settingsGlobal settings for all workloads.
  • PATCHUpdate global settings/global-settingsUpdate whether the Amazon Web Services account is opted into organization sharing and discovery integration features.
  • GETGet lens review/workloads/:WorkloadId/lensReviews/:LensAlias?MilestoneNumber=0Get lens review.
  • PATCHUpdate lens review/workloads/:WorkloadId/lensReviews/:LensAliasUpdate lens review for a particular workload.
  • GETGet lens review report/workloads/:WorkloadId/lensReviews/:LensAlias/report?MilestoneNumber=0Get lens review report.
  • GETGet lens version difference/lenses/:LensAlias/versionDifference?BaseLensVersion=string&TargetLensVersion=stringGet lens version differences.
  • GETGet milestone/workloads/:WorkloadId/milestones/:MilestoneNumberGet a milestone for an existing workload.
  • GETGet profile template/profileTemplateGet profile template.
  • GETGet review template answer/reviewTemplates/:TemplateArn/lensReviews/:LensAlias/answers/:QuestionIdGet review template answer.
  • PATCHUpdate review template answer/reviewTemplates/:TemplateArn/lensReviews/:LensAlias/answers/:QuestionIdUpdate a review template answer.
  • GETGet review template lens review/reviewTemplates/:TemplateArn/lensReviews/:LensAliasGet a lens review associated with a review template.
  • PATCHUpdate review template lens review/reviewTemplates/:TemplateArn/lensReviews/:LensAliasUpdate a lens review associated with a review template.
  • PUTImport lens/importLensImport a new custom lens or update an existing custom lens. To update an existing custom lens, specify its ARN as the LensAlias . If no ARN is specified, a…
  • GETList agent recommendation generations/api/v1/agent-profiles/:profileArn/generations?RecommendationType=string&MaxResults=0&NextToken=stringApplication-level recommendations are a new recommendation format currently in beta. We are actively seeking customer feedback to improve their quality and…
  • POSTStart agent recommendation generation/api/v1/agent-profiles/:profileArn/generationsStarts a recommendation generation process for the specified agent profile. This asynchronous operation returns immediately. Use…
  • GETList agent recommendation items/api/v1/agent-recommendations/:recommendationArn/items?type=string&maxResults=0&nextToken=stringApplication-level recommendations are a new recommendation format currently in beta. We are actively seeking customer feedback to improve their quality and…
  • GETList agent recommendations/api/v1/agent-profiles/:profileArn/recommendations?maxResults=0&nextToken=string&state=string&pillar=stringApplication-level recommendations are a new recommendation format currently in beta. We are actively seeking customer feedback to improve their quality and…
  • GETList answers/workloads/:WorkloadId/lensReviews/:LensAlias/answers?PillarId=string&MilestoneNumber=0&NextToken=string&MaxResults=0&QuestionPriority=stringList of answers for a particular workload and lens.
  • POSTList check details/workloads/:WorkloadId/checksList of Trusted Advisor check details by account related to the workload.
  • POSTList check summaries/workloads/:WorkloadId/checkSummariesList of Trusted Advisor checks summarized for all accounts related to the workload.
  • GETList lens review improvements/workloads/:WorkloadId/lensReviews/:LensAlias/improvements?PillarId=string&MilestoneNumber=0&NextToken=string&MaxResults=0&QuestionPriority=stringList the improvements of a particular lens review.
  • GETList lens reviews/workloads/:WorkloadId/lensReviews?MilestoneNumber=0&NextToken=string&MaxResults=0List lens reviews for a particular workload.
  • GETList lenses/lenses?NextToken=string&MaxResults=0&LensType=string&LensStatus=string&LensName=stringList the available lenses.
  • POSTList milestones/workloads/:WorkloadId/milestonesSummariesList all milestones for an existing workload.
  • POSTList notifications/notificationsList lens notifications.
  • GETList profile notifications/profileNotifications?WorkloadId=string&NextToken=string&MaxResults=0List profile notifications.
  • GETList profiles/profileSummaries?ProfileNamePrefix=string&ProfileOwnerType=string&NextToken=string&MaxResults=0List profiles.
  • GETList review template answers/reviewTemplates/:TemplateArn/lensReviews/:LensAlias/answers?PillarId=string&NextToken=string&MaxResults=0List the answers of a review template.
  • GETList share invitations/shareInvitations?WorkloadNamePrefix=string&LensNamePrefix=string&ShareResourceType=string&NextToken=string&MaxResults=0&ProfileNamePrefix=string&TemplateNamePrefix=stringList the share invitations. WorkloadNamePrefix , LensNamePrefix , ProfileNamePrefix , and TemplateNamePrefix are mutually exclusive. Use the parameter that…
  • GETList tags for resource/tags/:WorkloadArnList the tags for a resource. The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN.
  • POSTTag resource/tags/:WorkloadArnAdds one or more tags to the specified resource. The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN.
  • DELETEUntag resource/tags/:WorkloadArn?tagKeys=Deletes specified tags from a resource. The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN. To specify…
  • POSTList workloads/workloadsSummariesPaginated list of workloads.
  • PUTPut agent recommendation feedback/api/v1/agent-recommendations/:recommendationArn/feedbackSubmits user feedback on a recommendation to help improve future optimization suggestions and track implementation outcomes.
  • POSTSend agent organizational report data to s3/api/v1/agent-organizational-reports/:reportId/send-to-s3Writes the data artifact for a completed Organizational Report directly into a caller-owned S3 bucket. The artifact is written in the requested format to the…
  • PUTUpdate agent organizational profile/api/v1/agent-organizational-profiles/:profileArnUpdates an Organizational Profile. Organizational Profiles are specific to Profiles created using AWS Organizations integration. Include only the fields you…
  • PATCHUpdate agent recommendation status/api/v1/agent-recommendations/:recommendationArn/statusUpdates the status of a recommendation to track its progress through the implementation lifecycle.
  • POSTUpdate integration/workloads/:WorkloadId/updateIntegrationUpdate integration features.
  • PATCHUpdate share invitation/shareInvitations/:ShareInvitationIdUpdate a workload or custom lens share invitation. This API operation can be called independently of any resource. Previous documentation implied that a…
  • PUTUpgrade lens review/workloads/:WorkloadId/lensReviews/:LensAlias/upgradeUpgrade lens review for a particular workload.
  • PUTUpgrade profile version/workloads/:WorkloadId/profiles/:ProfileArn/upgradeUpgrade a profile.
  • PUTUpgrade review template lens review/reviewTemplates/:TemplateArn/lensReviews/:LensAlias/upgradeUpgrade the lens review of a review template.

API details

Base URL
https://wellarchitected.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
112 operations on 75 pathsGET 46POST 24PATCH 15DELETE 15PUT 12
Description format
AWS Smithy model, API version 2020-03-31

How to test the AWS Well-Architected Tool in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Well-Architected Tool collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Associate lenses” (PATCH /workloads/:WorkloadId/associateLenses), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS Well-Architected Tool?

Amazon Web Services Well-Architected This is the Amazon Web Services Well-Architected API Reference . Amazon Web Services Well-Architected helps you evaluate… It is listed under Developer tools and has 112 endpoints.

Who publishes the AWS Well-Architected Tool?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWS Well-Architected Tool?

Requests go to https://wellarchitected.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWS Well-Architected Tool?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWS Well-Architected Tool have?

112 operations on 75 paths (46 GET, 24 POST, 15 PATCH, 15 DELETE, 12 PUT).

Is forking the AWS Well-Architected Tool free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.