Data retrieval APIs for AWS Well-Architected Tool
AWS Well-Architected Tool provides the following APIs for data retrieval.
| Actions | Description | Access level |
|---|---|---|
| ExportLens | Export an existing lens | Read |
| GetAnswer | Retrieve the specified answer from the specified lens review | Read |
| GetConsolidatedReport | Get consolidated report metrics or to generate the consolidated report PDF in this account | Read |
| GetGlobalSettings | Get all settings for the account | Read |
| GetLens | Get an existing lens | Read |
| GetLensReview | Retrieve the specified lens review of the specified workload | Read |
| GetLensReviewReport | Retrieve the report for the specified lens review | Read |
| GetLensVersionDifference | Get the difference between the specified lens version and latest available lens version | Read |
| GetMilestone | Retrieve the specified milestone of the specified workload | Read |
| GetProfile | Retrieve the specified profile | Read |
| GetProfileTemplate | Retrieve the specified profile template | Read |
| GetReviewTemplate | Retrieve the specified review template | Read |
| GetReviewTemplateAnswer | Retrieve the specified answer from the specified review template lens review | Read |
| GetReviewTemplateLensReview | Retrieve the specified lens review of the specified review template | Read |
| GetWorkload | Retrieve the specified workload | Read |
| ListAnswers | List the answers from the specified lens review | List |
| ListCheckDetails | List the check-details for the workload | List |
| ListCheckSummaries | List the check-summaries for the workload | List |
| ListLensReviewImprovements | List the improvements of the specified lens review | List |
| ListLensReviews | List the lens reviews of the specified workload | List |
| ListLensShares | List all shares created for a lens | List |
| ListLenses | List the lenses available to this account | List |
| ListMilestones | List the milestones of the specified workload | List |
| ListNotifications | List notifications related to the account or specified resource | List |
| ListProfileNotifications | List profile notifications related to specified resource | List |
| ListProfileShares | List all shares created for a profile | List |
| ListProfiles | List the profiles available to this account | List |
| ListReviewTemplateAnswers | List the answers from the specified review template lens review | List |
| ListReviewTemplates | List the review templates available to this account | List |
| ListShareInvitations | List the workload share invitations of the specified account or user | List |
| ListTagsForResource | List tags for a Well-Architected resource | Read |
| ListTemplateShares | List all shares created for a review template | List |
| ListWorkloadShares | List the workload shares of the specified workload | List |
| ListWorkloads | List the workloads in this account | List |
