# Data retrieval APIs for AWS Well-Architected Tool
<a name="awswell-architectedtool"></a>

AWS Well-Architected Tool provides the following APIs for data retrieval.


****  

| Actions | Description | Access level | 
| --- | --- | --- | 
| <a name="wellarchitected-ExportLens"></a>[https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_ExportLens.html](https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_ExportLens.html) | Export an existing lens | Read | 
| <a name="wellarchitected-GetAnswer"></a>[https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_GetAnswer.html](https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_GetAnswer.html) | Retrieve the specified answer from the specified lens review | Read | 
| <a name="wellarchitected-GetConsolidatedReport"></a>[https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_GetConsolidatedReport.html](https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_GetConsolidatedReport.html) | Get consolidated report metrics or to generate the consolidated report PDF in this account | Read | 
| <a name="wellarchitected-GetGlobalSettings"></a>[https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_GetGlobalSettings.html](https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_GetGlobalSettings.html) | Get all settings for the account | Read | 
| <a name="wellarchitected-GetLens"></a>[https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_DeleteLensShare.html](https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_DeleteLensShare.html) | Get an existing lens | Read | 
| <a name="wellarchitected-GetLensReview"></a>[https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_GetLensReview.html](https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_GetLensReview.html) | Retrieve the specified lens review of the specified workload | Read | 
| <a name="wellarchitected-GetLensReviewReport"></a>[https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_GetLensReviewReport.html](https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_GetLensReviewReport.html) | Retrieve the report for the specified lens review | Read | 
| <a name="wellarchitected-GetLensVersionDifference"></a>[https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_GetLensVersionDifference.html](https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_GetLensVersionDifference.html) | Get the difference between the specified lens version and latest available lens version | Read | 
| <a name="wellarchitected-GetMilestone"></a>[https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_GetMilestone.html](https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_GetMilestone.html) | Retrieve the specified milestone of the specified workload | Read | 
| <a name="wellarchitected-GetProfile"></a>[https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_GetProfile.html](https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_GetProfile.html) | Retrieve the specified profile | Read | 
| <a name="wellarchitected-GetProfileTemplate"></a>[https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_GetProfileTemplate.html](https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_GetProfileTemplate.html) | Retrieve the specified profile template | Read | 
| <a name="wellarchitected-GetReviewTemplate"></a>[https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_GetReviewTemplate.html](https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_GetReviewTemplate.html) | Retrieve the specified review template | Read | 
| <a name="wellarchitected-GetReviewTemplateAnswer"></a>[https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_GetReviewTemplateAnswer.html](https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_GetReviewTemplateAnswer.html) | Retrieve the specified answer from the specified review template lens review | Read | 
| <a name="wellarchitected-GetReviewTemplateLensReview"></a>[https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_GetReviewTemplateLensReview.html](https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_GetReviewTemplateLensReview.html) | Retrieve the specified lens review of the specified review template | Read | 
| <a name="wellarchitected-GetWorkload"></a>[https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_GetWorkload.html](https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_GetWorkload.html) | Retrieve the specified workload | Read | 
| <a name="wellarchitected-ListAnswers"></a>[https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_ListAnswers.html](https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_ListAnswers.html) | List the answers from the specified lens review | List | 
| <a name="wellarchitected-ListCheckDetails"></a>[https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_ListCheckDetails.html](https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_ListCheckDetails.html) | List the check-details for the workload | List | 
| <a name="wellarchitected-ListCheckSummaries"></a>[https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_ListCheckSummaries.html](https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_ListCheckSummaries.html) | List the check-summaries for the workload | List | 
| <a name="wellarchitected-ListLensReviewImprovements"></a>[https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_ListLensReviewImprovements.html](https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_ListLensReviewImprovements.html) | List the improvements of the specified lens review | List | 
| <a name="wellarchitected-ListLensReviews"></a>[https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_ListLensReviews.html](https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_ListLensReviews.html) | List the lens reviews of the specified workload | List | 
| <a name="wellarchitected-ListLensShares"></a>[https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_ListLensShares.html](https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_ListLensShares.html) | List all shares created for a lens | List | 
| <a name="wellarchitected-ListLenses"></a>[https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_ListLenses.html](https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_ListLenses.html) | List the lenses available to this account | List | 
| <a name="wellarchitected-ListMilestones"></a>[https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_ListMilestones.html](https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_ListMilestones.html) | List the milestones of the specified workload | List | 
| <a name="wellarchitected-ListNotifications"></a>[https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_ListNotifications.html](https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_ListNotifications.html) | List notifications related to the account or specified resource | List | 
| <a name="wellarchitected-ListProfileNotifications"></a>[https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_ListProfileNotifications.html](https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_ListProfileNotifications.html) | List profile notifications related to specified resource | List | 
| <a name="wellarchitected-ListProfileShares"></a>[https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_ListProfileShares.html](https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_ListProfileShares.html) | List all shares created for a profile | List | 
| <a name="wellarchitected-ListProfiles"></a>[https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_ListProfiles.html](https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_ListProfiles.html) | List the profiles available to this account | List | 
| <a name="wellarchitected-ListReviewTemplateAnswers"></a>[https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_ListReviewTemplateAnswers.html](https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_ListReviewTemplateAnswers.html) | List the answers from the specified review template lens review | List | 
| <a name="wellarchitected-ListReviewTemplates"></a>[https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_ListReviewTemplates.html](https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_ListReviewTemplates.html) | List the review templates available to this account | List | 
| <a name="wellarchitected-ListShareInvitations"></a>[https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_ListShareInvitations.html](https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_ListShareInvitations.html) | List the workload share invitations of the specified account or user | List | 
| <a name="wellarchitected-ListTagsForResource"></a>[https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_ListTagsForResource.html](https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_ListTagsForResource.html) | List tags for a Well-Architected resource | Read | 
| <a name="wellarchitected-ListTemplateShares"></a>[https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_ListTemplateShares.html](https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_ListTemplateShares.html) | List all shares created for a review template | List | 
| <a name="wellarchitected-ListWorkloadShares"></a>[https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_ListWorkloadShares.html](https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_ListWorkloadShares.html) | List the workload shares of the specified workload | List | 
| <a name="wellarchitected-ListWorkloads"></a>[https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_ListWorkloads.html](https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_ListWorkloads.html) | List the workloads in this account | List |