aws-well-architected-tool — quality + safety report

---
name: aws-well-architected-tool
description: "AWS Well-Architected Tool API skill. Use when working with AWS Well-Architected Tool for workloads, lenses, profiles. Covers 72 endpoints."
version: 1.0.0
generator: lapsh
---

# AWS Well-Architected Tool
API version: 2020-03-31

## Auth
AWS SigV4

## Base URL
Not specified.

## Setup
1. Configure auth: AWS SigV4
2. GET /consolidatedReport -- verify access
3. POST /lenses/{LensAlias}/shares -- create first shares

## Endpoints

72 endpoints across 15 groups. See references/api-spec.lap for full details.

### workloads
| Method | Path | Description |
|--------|------|-------------|
| 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. |
| PATCH | /workloads/{WorkloadId}/associateProfiles | Associate a profile with a workload. |
| POST | /workloads/{WorkloadId}/milestones | Create a milestone for an existing workload. |
| 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 |
| 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. |
| DELETE | /workloads/{WorkloadId} | Delete an existing workload. |
| DELETE | /workloads/{WorkloadId}/shares/{ShareId} | Delete a workload share. |
| 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. |
| PATCH | /workloads/{WorkloadId}/disassociateProfiles | Disassociate a profile from a workload. |
| GET | /workloads/{WorkloadId}/lensReviews/{LensAlias}/answers/{QuestionId} | Get the answer to a specific question in a workload review. |
| GET | /workloads/{WorkloadId}/lensReviews/{LensAlias} | Get lens review. |
| GET | /workloads/{WorkloadId}/lensReviews/{LensAlias}/report | Get lens review report. |
| GET | /workloads/{WorkloadId}/milestones/{MilestoneNumber} | Get a milestone for an existing workload. |
| GET | /workloads/{WorkloadId} | Get an existing workload. |
| GET | /workloads/{WorkloadId}/lensReviews/{LensAlias}/answers | List of answers for a particular workload and lens. |
| POST | /workloads/{WorkloadId}/checks | List of Trusted Advisor check details by account related to the workload. |
| POST | /workloads/{WorkloadId}/checkSummaries | List of Trusted Advisor checks summarized for all accounts related to the workload. |
| GET | /workloads/{WorkloadId}/lensReviews/{LensAlias}/improvements | List the improvements of a particular lens review. |
| GET | /workloads/{WorkloadId}/lensReviews | List lens reviews for a particular workload. |
| POST | /workloads/{WorkloadId}/milestonesSummaries | List all milestones for an existing workload. |
| GET | /workloads/{WorkloadId}/shares | List the workload shares associated with the workload. |
| PATCH | /workloads/{WorkloadId}/lensReviews/{LensAlias}/answers/{QuestionId} | Update the answer to a specific question in a workload review. |
| POST | /workloads/{WorkloadId}/updateIntegration | Update integration features. |
| PATCH | /workloads/{WorkloadId}/lensReviews/{LensAlias} | Update lens review for a particular workload. |
| PATCH | /workloads/{WorkloadId} | Update an existing workload. |
| PATCH | /workloads/{WorkloadId}/shares/{ShareId} | Update a workload share. |
| PUT | /workloads/{WorkloadId}/lensReviews/{LensAlias}/upgrade | Upgrade lens review for a particular workload. |
| PUT | /workloads/{WorkloadId}/profiles/{ProfileArn}/upgrade | Upgrade a profile. |

### lenses
| Method | Path | Description |
|--------|------|-------------|
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| GET | /lenses/{LensAlias} | Get an existing lens. |
| GET | /lenses/{LensAlias}/versionDifference | Get lens version differences. |
| GET | /lenses/{LensAlias}/shares | List the lens shares associated with the lens. |
| GET | /lenses | List the available lenses. |

### profiles
| Method | Path | Description |
|--------|------|-------------|
| POST | /profiles | Create a profile. |
| POST | /profiles/{ProfileArn}/shares | Create a profile share. |
| 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. |
| DELETE | /profiles/{ProfileArn}/shares/{ShareId} | Delete a profile share. |
| GET | /profiles/{ProfileArn} | Get profile information. |
| GET | /profiles/{ProfileArn}/shares | List profile shares. |
| PATCH | /profiles/{ProfileArn} | Update a profile. |

### reviewTemplates
| Method | Path | Description |
|--------|------|-------------|
| 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. |
| 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. |
| GET | /reviewTemplates/{TemplateArn} | Get review template. |
| GET | /reviewTemplates/{TemplateArn}/lensReviews/{LensAlias}/answers/{QuestionId} | Get review template answer. |
| GET | /reviewTemplates/{TemplateArn}/lensReviews/{LensAlias} | Get a lens review associated with a review template. |
| GET | /reviewTemplates/{TemplateArn}/lensReviews/{LensAlias}/answers | List the answers of a review template. |
| GET | /reviewTemplates | List review templates. |
| PATCH | /reviewTemplates/{TemplateArn} | Update a review template. |
| PATCH | /reviewTemplates/{TemplateArn}/lensReviews/{LensAlias}/answers/{QuestionId} | Update a review template answer. |
| PATCH | /reviewTemplates/{TemplateArn}/lensReviews/{LensAlias} | Update a lens review associated with a review template. |
| PUT | /reviewTemplates/{TemplateArn}/lensReviews/{LensAlias}/upgrade | Upgrade the lens review of a review template. |

### templates
| Method | Path | Description |
|--------|------|-------------|
| POST | /templates/shares/{TemplateArn} | Create a review template share. The owner of a review template can share it with other Amazon Web Services account

… (truncated)