1---2name: aws-well-architected-tool3description: AWS Well-Architected Tool API skill. Use when working with AWS Well-Architected Tool for workloads, lenses, profiles. Covers 72 endpoints.4---5
6# AWS Well-Architected Tool
7API version: 2020-03-31
8
9## Auth
10AWS SigV4
11
12## Base URL
13Not specified.
14
15## Setup
161. Configure auth: AWS SigV4
172. GET /consolidatedReport -- verify access
183. POST /lenses/{LensAlias}/shares -- create first shares
19
20## Endpoints
21
2272 endpoints across 15 groups. See references/api-spec.lap for full details.
23
24### workloads
25| Method | Path | Description |
26|--------|------|-------------|
27| PATCH | /workloads/{WorkloadId}/associateLenses | 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. |
28| PATCH | /workloads/{WorkloadId}/associateProfiles | Associate a profile with a workload. |
29| POST | /workloads/{WorkloadId}/milestones | Create a milestone for an existing workload. |
30| POST | /workloads | 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 |
31| POST | /workloads/{WorkloadId}/shares | Create 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 access to a workload is not removed until the workload invitation is deleted. If you share a workload with an organization or OU, all accounts in the organization or OU are granted access to the workload. For more information, see Sharing a workload in the Well-Architected Tool User Guide. |
32| DELETE | /workloads/{WorkloadId} | Delete an existing workload. |
33| DELETE | /workloads/{WorkloadId}/shares/{ShareId} | Delete a workload share. |
34| PATCH | /workloads/{WorkloadId}/disassociateLenses | 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. |
35| PATCH | /workloads/{WorkloadId}/disassociateProfiles | Disassociate a profile from a workload. |
36| GET | /workloads/{WorkloadId}/lensReviews/{LensAlias}/answers/{QuestionId} | Get the answer to a specific question in a workload review. |
37| GET | /workloads/{WorkloadId}/lensReviews/{LensAlias} | Get lens review. |
38| GET | /workloads/{WorkloadId}/lensReviews/{LensAlias}/report | Get lens review report. |
39| GET | /workloads/{WorkloadId}/milestones/{MilestoneNumber} | Get a milestone for an existing workload. |
40| GET | /workloads/{WorkloadId} | Get an existing workload. |
41| GET | /workloads/{WorkloadId}/lensReviews/{LensAlias}/answers | List of answers for a particular workload and lens. |
42| POST | /workloads/{WorkloadId}/checks | List of Trusted Advisor check details by account related to the workload. |
43| POST | /workloads/{WorkloadId}/checkSummaries | List of Trusted Advisor checks summarized for all accounts related to the workload. |
44| GET | /workloads/{WorkloadId}/lensReviews/{LensAlias}/improvements | List the improvements of a particular lens review. |
45| GET | /workloads/{WorkloadId}/lensReviews | List lens reviews for a particular workload. |
46| POST | /workloads/{WorkloadId}/milestonesSummaries | List all milestones for an existing workload. |
47| GET | /workloads/{WorkloadId}/shares | List the workload shares associated with the workload. |
48| PATCH | /workloads/{WorkloadId}/lensReviews/{LensAlias}/answers/{QuestionId} | Update the answer to a specific question in a workload review. |
49| POST | /workloads/{WorkloadId}/updateIntegration | Update integration features. |
50| PATCH | /workloads/{WorkloadId}/lensReviews/{LensAlias} | Update lens review for a particular workload. |
51| PATCH | /workloads/{WorkloadId} | Update an existing workload. |
52| PATCH | /workloads/{WorkloadId}/shares/{ShareId} | Update a workload share. |
53| PUT | /workloads/{WorkloadId}/lensReviews/{LensAlias}/upgrade | Upgrade lens review for a particular workload. |
54| PUT | /workloads/{WorkloadId}/profiles/{ProfileArn}/upgrade | Upgrade a profile. |
55
56### lenses
57| Method | Path | Description |
58|--------|------|-------------|
59| POST | /lenses/{LensAlias}/shares | Create 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 same Amazon Web Services Region. Lenses provided by Amazon Web Services (Amazon Web Services Official Content) cannot be shared. Shared access to a lens is not removed until the lens invitation is deleted. If you share a lens with an organization or OU, all accounts in the organization or OU are granted access to the lens. For more information, see Sharing a custom lens in the Well-Architected Tool User Guide. Disclaimer By sharing your custom lenses with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your custom lenses available to those other accounts. Those other accounts may continue to access and use your shared custom lenses even if you delete the custom lenses from your own Amazon Web Services account or terminate your Amazon Web Services account. |
60| POST | /lenses/{LensAlias}/versions | Create 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 is used to identify the lens to be published. The owner of a lens can share the lens with other Amazon Web Services accounts and users in the same Amazon Web Services Region. Only the owner of a lens can delete it. |
61| DELETE | /lenses/{LensAlias} | Delete 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 with can continue to use it, but they will no longer be able to apply it to new workloads. Disclaimer By sharing your custom lenses with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your custom lenses available to those other accounts. Those other accounts may continue to access and use your shared custom lenses even if you delete the custom lenses from your own Amazon Web Services account or terminate your Amazon Web Services account. |
62| DELETE | /lenses/{LensAlias}/shares/{ShareId} | Delete a lens share. After the lens share is deleted, Amazon Web Services accounts, users, organizations, and organizational units (OUs) that you shared the lens with can continue to use it, but they will no longer be able to apply it to new workloads. Disclaimer By sharing your custom lenses with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your custom lenses available to those other accounts. Those other accounts may continue to access and use your shared custom lenses even if you delete the custom lenses from your own Amazon Web Services account or terminate your Amazon Web Services account. |
63| GET | /lenses/{LensAlias}/export | Export 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 exported. Lenses are defined in JSON. For more information, see JSON format specification in the Well-Architected Tool User Guide. Disclaimer Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your custom lenses. If your custom lens 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. |
64| GET | /lenses/{LensAlias} | Get an existing lens. |
65| GET | /lenses/{LensAlias}/versionDifference | Get lens version differences. |
66| GET | /lenses/{LensAlias}/shares | List the lens shares associated with the lens. |
67| GET | /lenses | List the available lenses. |
68
69### profiles
70| Method | Path | Description |
71|--------|------|-------------|
72| POST | /profiles | Create a profile. |
73| POST | /profiles/{ProfileArn}/shares | Create a profile share. |
74| DELETE | /profiles/{ProfileArn} | Delete a profile. Disclaimer By sharing your profile with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your profile available to those other accounts. Those other accounts may continue to access and use your shared profile even if you delete the profile from your own Amazon Web Services account or terminate your Amazon Web Services account. |
75| DELETE | /profiles/{ProfileArn}/shares/{ShareId} | Delete a profile share. |
76| GET | /profiles/{ProfileArn} | Get profile information. |
77| GET | /profiles/{ProfileArn}/shares | List profile shares. |
78| PATCH | /profiles/{ProfileArn} | Update a profile. |
79
80### reviewTemplates
81| Method | Path | Description |
82|--------|------|-------------|
83| POST | /reviewTemplates | 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. |
84| DELETE | /reviewTemplates/{TemplateArn} | 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. |
85| GET | /reviewTemplates/{TemplateArn} | Get review template. |
86| GET | /reviewTemplates/{TemplateArn}/lensReviews/{LensAlias}/answers/{QuestionId} | Get review template answer. |
87| GET | /reviewTemplates/{TemplateArn}/lensReviews/{LensAlias} | Get a lens review associated with a review template. |
88| GET | /reviewTemplates/{TemplateArn}/lensReviews/{LensAlias}/answers | List the answers of a review template. |
89| GET | /reviewTemplates | List review templates. |
90| PATCH | /reviewTemplates/{TemplateArn} | Update a review template. |
91| PATCH | /reviewTemplates/{TemplateArn}/lensReviews/{LensAlias}/answers/{QuestionId} | Update a review template answer. |
92| PATCH | /reviewTemplates/{TemplateArn}/lensReviews/{LensAlias} | Update a lens review associated with a review template. |
93| PUT | /reviewTemplates/{TemplateArn}/lensReviews/{LensAlias}/upgrade | Upgrade the lens review of a review template. |
94
95### templates
96| Method | Path | Description |
97|--------|------|-------------|
98| POST | /templates/shares/{TemplateArn} | 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. |
99| DELETE | /templates/shares/{TemplateArn}/{ShareId} | 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. |
100| GET | /templates/shares/{TemplateArn} | List review template shares. |
101
102### consolidatedReport
103| Method | Path | Description |
104|--------|------|-------------|
105| GET | /consolidatedReport | Get a consolidated report of your workloads. You can optionally choose to include workloads that have been shared with you. |
106
107### global-settings
108| Method | Path | Description |
109|--------|------|-------------|
110| GET | /global-settings | Global settings for all workloads. |
111| PATCH | /global-settings | Update whether the Amazon Web Services account is opted into organization sharing and discovery integration features. |
112
113### profileTemplate
114| Method | Path | Description |
115|--------|------|-------------|
116| GET | /profileTemplate | Get profile template. |
117
118### importLens
119| Method | Path | Description |
120|--------|------|-------------|
121| PUT | /importLens | Import 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 new custom lens is created. The new or updated lens will have a status of DRAFT. The lens cannot be applied to workloads or shared with other Amazon Web Services accounts until it's published with CreateLensVersion. Lenses are defined in JSON. For more information, see JSON format specification in the Well-Architected Tool User Guide. A custom lens cannot exceed 500 KB in size. Disclaimer Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your custom lenses. If your custom lens 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. |
122
123### notifications
124| Method | Path | Description |
125|--------|------|-------------|
126| POST | /notifications | List lens notifications. |
127
128### profileNotifications
129| Method | Path | Description |
130|--------|------|-------------|
131| GET | /profileNotifications/ | List profile notifications. |
132
133### profileSummaries
134| Method | Path | Description |
135|--------|------|-------------|
136| GET | /profileSummaries | List profiles. |
137
138### shareInvitations
139| Method | Path | Description |
140|--------|------|-------------|
141| GET | /shareInvitations | List the share invitations. WorkloadNamePrefix, LensNamePrefix, ProfileNamePrefix, and TemplateNamePrefix are mutually exclusive. Use the parameter that matches your ShareResourceType. |
142| PATCH | /shareInvitations/{ShareInvitationId} | Update a workload or custom lens share invitation. This API operation can be called independently of any resource. Previous documentation implied that a workload ARN must be specified. |
143
144### tags
145| Method | Path | Description |
146|--------|------|-------------|
147| GET | /tags/{WorkloadArn} | List the tags for a resource. The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN. |
148| POST | /tags/{WorkloadArn} | Adds 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. |
149| DELETE | /tags/{WorkloadArn} | 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 multiple tags, use separate tagKeys parameters, for example: DELETE /tags/WorkloadArn?tagKeys=key1&tagKeys=key2 |
150
151### workloadsSummaries
152| Method | Path | Description |
153|--------|------|-------------|
154| POST | /workloadsSummaries | Paginated list of workloads. |
155
156## Common Questions
157
158Match user requests to endpoints in references/api-spec.lap. Key patterns:
159- "Create a share?" -> POST /lenses/{LensAlias}/shares
160- "Create a version?" -> POST /lenses/{LensAlias}/versions
161- "Create a milestone?" -> POST /workloads/{WorkloadId}/milestones
162- "Create a profile?" -> POST /profiles
163- "Create a share?" -> POST /profiles/{ProfileArn}/shares
164- "Create a reviewTemplate?" -> POST /reviewTemplates
165- "Create a workload?" -> POST /workloads
166- "Create a share?" -> POST /workloads/{WorkloadId}/shares
167- "Delete a lens?" -> DELETE /lenses/{LensAlias}
168- "Delete a share?" -> DELETE /lenses/{LensAlias}/shares/{ShareId}
169- "Delete a profile?" -> DELETE /profiles/{ProfileArn}
170- "Delete a share?" -> DELETE /profiles/{ProfileArn}/shares/{ShareId}
171- "Delete a reviewTemplate?" -> DELETE /reviewTemplates/{TemplateArn}
172- "Delete a share?" -> DELETE /templates/shares/{TemplateArn}/{ShareId}
173- "Delete a workload?" -> DELETE /workloads/{WorkloadId}
174- "Delete a share?" -> DELETE /workloads/{WorkloadId}/shares/{ShareId}
175- "List all export?" -> GET /lenses/{LensAlias}/export
176- "Get answer details?" -> GET /workloads/{WorkloadId}/lensReviews/{LensAlias}/answers/{QuestionId}
177- "List all consolidatedReport?" -> GET /consolidatedReport
178- "List all global-settings?" -> GET /global-settings
179- "Get lens details?" -> GET /lenses/{LensAlias}
180- "Get lensReview details?" -> GET /workloads/{WorkloadId}/lensReviews/{LensAlias}
181- "List all report?" -> GET /workloads/{WorkloadId}/lensReviews/{LensAlias}/report
182- "List all versionDifference?" -> GET /lenses/{LensAlias}/versionDifference
183- "Get milestone details?" -> GET /workloads/{WorkloadId}/milestones/{MilestoneNumber}
184- "Get profile details?" -> GET /profiles/{ProfileArn}
185- "List all profileTemplate?" -> GET /profileTemplate
186- "Get reviewTemplate details?" -> GET /reviewTemplates/{TemplateArn}
187- "Get answer details?" -> GET /reviewTemplates/{TemplateArn}/lensReviews/{LensAlias}/answers/{QuestionId}
188- "Get lensReview details?" -> GET /reviewTemplates/{TemplateArn}/lensReviews/{LensAlias}
189- "Get workload details?" -> GET /workloads/{WorkloadId}
190- "List all answers?" -> GET /workloads/{WorkloadId}/lensReviews/{LensAlias}/answers
191- "Create a check?" -> POST /workloads/{WorkloadId}/checks
192- "Create a checkSummary?" -> POST /workloads/{WorkloadId}/checkSummaries
193- "List all improvements?" -> GET /workloads/{WorkloadId}/lensReviews/{LensAlias}/improvements
194- "List all lensReviews?" -> GET /workloads/{WorkloadId}/lensReviews
195- "List all shares?" -> GET /lenses/{LensAlias}/shares
196- "List all lenses?" -> GET /lenses
197- "Create a milestonesSummary?" -> POST /workloads/{WorkloadId}/milestonesSummaries
198- "Create a notification?" -> POST /notifications
199- "List all profileNotifications?" -> GET /profileNotifications/
200- "List all shares?" -> GET /profiles/{ProfileArn}/shares
201- "List all profileSummaries?" -> GET /profileSummaries
202- "List all answers?" -> GET /reviewTemplates/{TemplateArn}/lensReviews/{LensAlias}/answers
203- "List all reviewTemplates?" -> GET /reviewTemplates
204- "List all shareInvitations?" -> GET /shareInvitations
205- "Get tag details?" -> GET /tags/{WorkloadArn}
206- "Get share details?" -> GET /templates/shares/{TemplateArn}
207- "List all shares?" -> GET /workloads/{WorkloadId}/shares
208- "Create a workloadsSummary?" -> POST /workloadsSummaries
209- "Delete a tag?" -> DELETE /tags/{WorkloadArn}
210- "Partially update a answer?" -> PATCH /workloads/{WorkloadId}/lensReviews/{LensAlias}/answers/{QuestionId}
211- "Create a updateIntegration?" -> POST /workloads/{WorkloadId}/updateIntegration
212- "Partially update a lensReview?" -> PATCH /workloads/{WorkloadId}/lensReviews/{LensAlias}
213- "Partially update a profile?" -> PATCH /profiles/{ProfileArn}
214- "Partially update a reviewTemplate?" -> PATCH /reviewTemplates/{TemplateArn}
215- "Partially update a answer?" -> PATCH /reviewTemplates/{TemplateArn}/lensReviews/{LensAlias}/answers/{QuestionId}
216- "Partially update a lensReview?" -> PATCH /reviewTemplates/{TemplateArn}/lensReviews/{LensAlias}
217- "Partially update a shareInvitation?" -> PATCH /shareInvitations/{ShareInvitationId}
218- "Partially update a workload?" -> PATCH /workloads/{WorkloadId}
219- "Partially update a share?" -> PATCH /workloads/{WorkloadId}/shares/{ShareId}
220- "How to authenticate?" -> See Auth section
221
222## Response Tips
223- Check response schemas in references/api-spec.lap for field details
224- Create/update endpoints typically return the created/updated object
225
226## References
227- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas
228
229> Generated from the official API spec by [LAP](https://lap.sh)