Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

@aws-sdk/client-wellarchitected

Well-Architected Tool

This is the Well-Architected Tool API Reference. The WA Tool API provides programmatic access to the Well-Architected Tool in the Amazon Web Services Management Console. For information about the Well-Architected Tool, see the Well-Architected Tool User Guide.

Index

Enumerations

AdditionalResourceType AnswerReason CheckFailureReason CheckProvider CheckStatus ChoiceReason ChoiceStatus DefinitionType DifferenceStatus DiscoveryIntegrationStatus ImportLensStatus LensStatus LensStatusType LensType MetricType NotificationType OrganizationSharingStatus PermissionType ProfileNotificationType ProfileOwnerType QuestionPriority QuestionType ReportFormat Risk ShareInvitationAction ShareResourceType ShareStatus TrustedAdvisorIntegrationStatus ValidationExceptionReason WorkloadEnvironment WorkloadImprovementStatus

Classes

AccessDeniedException AssociateLensesCommand AssociateProfilesCommand ConflictException CreateLensShareCommand CreateLensVersionCommand CreateMilestoneCommand CreateProfileCommand CreateProfileShareCommand CreateWorkloadCommand CreateWorkloadShareCommand DeleteLensCommand DeleteLensShareCommand DeleteProfileCommand DeleteProfileShareCommand DeleteWorkloadCommand DeleteWorkloadShareCommand DisassociateLensesCommand DisassociateProfilesCommand ExportLensCommand GetAnswerCommand GetConsolidatedReportCommand GetLensCommand GetLensReviewCommand GetLensReviewReportCommand GetLensVersionDifferenceCommand GetMilestoneCommand GetProfileCommand GetProfileTemplateCommand GetWorkloadCommand ImportLensCommand InternalServerException ListAnswersCommand ListCheckDetailsCommand ListCheckSummariesCommand ListLensReviewImprovementsCommand ListLensReviewsCommand ListLensSharesCommand ListLensesCommand ListMilestonesCommand ListNotificationsCommand ListProfileNotificationsCommand ListProfileSharesCommand ListProfilesCommand ListShareInvitationsCommand ListTagsForResourceCommand ListWorkloadSharesCommand ListWorkloadsCommand ResourceNotFoundException ServiceQuotaExceededException TagResourceCommand ThrottlingException UntagResourceCommand UpdateAnswerCommand UpdateGlobalSettingsCommand UpdateLensReviewCommand UpdateProfileCommand UpdateShareInvitationCommand UpdateWorkloadCommand UpdateWorkloadShareCommand UpgradeLensReviewCommand UpgradeProfileVersionCommand ValidationException WellArchitected WellArchitectedClient WellArchitectedServiceException

Interfaces

AdditionalResources Answer AnswerSummary AssociateLensesCommandInput AssociateLensesCommandOutput AssociateLensesInput AssociateProfilesCommandInput AssociateProfilesCommandOutput AssociateProfilesInput BestPractice CheckDetail CheckSummary Choice ChoiceAnswer ChoiceAnswerSummary ChoiceContent ChoiceImprovementPlan ChoiceUpdate ClientDefaults ClientInputEndpointParameters ConsolidatedReportMetric CreateLensShareCommandInput CreateLensShareCommandOutput CreateLensShareInput CreateLensShareOutput CreateLensVersionCommandInput CreateLensVersionCommandOutput CreateLensVersionInput CreateLensVersionOutput CreateMilestoneCommandInput CreateMilestoneCommandOutput CreateMilestoneInput CreateMilestoneOutput CreateProfileCommandInput CreateProfileCommandOutput CreateProfileInput CreateProfileOutput CreateProfileShareCommandInput CreateProfileShareCommandOutput CreateProfileShareInput CreateProfileShareOutput CreateWorkloadCommandInput CreateWorkloadCommandOutput CreateWorkloadInput CreateWorkloadOutput CreateWorkloadShareCommandInput CreateWorkloadShareCommandOutput CreateWorkloadShareInput CreateWorkloadShareOutput DeleteLensCommandInput DeleteLensCommandOutput DeleteLensInput DeleteLensShareCommandInput DeleteLensShareCommandOutput DeleteLensShareInput DeleteProfileCommandInput DeleteProfileCommandOutput DeleteProfileInput DeleteProfileShareCommandInput DeleteProfileShareCommandOutput DeleteProfileShareInput DeleteWorkloadCommandInput DeleteWorkloadCommandOutput DeleteWorkloadInput DeleteWorkloadShareCommandInput DeleteWorkloadShareCommandOutput DeleteWorkloadShareInput DisassociateLensesCommandInput DisassociateLensesCommandOutput DisassociateLensesInput DisassociateProfilesCommandInput DisassociateProfilesCommandOutput DisassociateProfilesInput ExportLensCommandInput ExportLensCommandOutput ExportLensInput ExportLensOutput GetAnswerCommandInput GetAnswerCommandOutput GetAnswerInput GetAnswerOutput GetConsolidatedReportCommandInput GetConsolidatedReportCommandOutput GetConsolidatedReportInput GetConsolidatedReportOutput GetLensCommandInput GetLensCommandOutput GetLensInput GetLensOutput GetLensReviewCommandInput GetLensReviewCommandOutput GetLensReviewInput GetLensReviewOutput GetLensReviewReportCommandInput GetLensReviewReportCommandOutput GetLensReviewReportInput GetLensReviewReportOutput GetLensVersionDifferenceCommandInput GetLensVersionDifferenceCommandOutput GetLensVersionDifferenceInput GetLensVersionDifferenceOutput GetMilestoneCommandInput GetMilestoneCommandOutput GetMilestoneInput GetMilestoneOutput GetProfileCommandInput GetProfileCommandOutput GetProfileInput GetProfileOutput GetProfileTemplateCommandInput GetProfileTemplateCommandOutput GetProfileTemplateInput GetProfileTemplateOutput GetWorkloadCommandInput GetWorkloadCommandOutput GetWorkloadInput GetWorkloadOutput ImportLensCommandInput ImportLensCommandOutput ImportLensInput ImportLensOutput ImprovementSummary Lens LensMetric LensReview LensReviewReport LensReviewSummary LensShareSummary LensSummary LensUpgradeSummary ListAnswersCommandInput ListAnswersCommandOutput ListAnswersInput ListAnswersOutput ListCheckDetailsCommandInput ListCheckDetailsCommandOutput ListCheckDetailsInput ListCheckDetailsOutput ListCheckSummariesCommandInput ListCheckSummariesCommandOutput ListCheckSummariesInput ListCheckSummariesOutput ListLensReviewImprovementsCommandInput ListLensReviewImprovementsCommandOutput ListLensReviewImprovementsInput ListLensReviewImprovementsOutput ListLensReviewsCommandInput ListLensReviewsCommandOutput ListLensReviewsInput ListLensReviewsOutput ListLensSharesCommandInput ListLensSharesCommandOutput ListLensSharesInput ListLensSharesOutput ListLensesCommandInput ListLensesCommandOutput ListLensesInput ListLensesOutput ListMilestonesCommandInput ListMilestonesCommandOutput ListMilestonesInput ListMilestonesOutput ListNotificationsCommandInput ListNotificationsCommandOutput ListNotificationsInput ListNotificationsOutput ListProfileNotificationsCommandInput ListProfileNotificationsCommandOutput ListProfileNotificationsInput ListProfileNotificationsOutput ListProfileSharesCommandInput ListProfileSharesCommandOutput ListProfileSharesInput ListProfileSharesOutput ListProfilesCommandInput ListProfilesCommandOutput ListProfilesInput ListProfilesOutput ListShareInvitationsCommandInput ListShareInvitationsCommandOutput ListShareInvitationsInput ListShareInvitationsOutput ListTagsForResourceCommandInput ListTagsForResourceCommandOutput ListTagsForResourceInput ListTagsForResourceOutput ListWorkloadSharesCommandInput ListWorkloadSharesCommandOutput ListWorkloadSharesInput ListWorkloadSharesOutput ListWorkloadsCommandInput ListWorkloadsCommandOutput ListWorkloadsInput ListWorkloadsOutput Milestone MilestoneSummary NotificationSummary PillarDifference PillarMetric PillarReviewSummary Profile ProfileChoice ProfileNotificationSummary ProfileQuestion ProfileQuestionUpdate ProfileShareSummary ProfileSummary ProfileTemplate ProfileTemplateChoice ProfileTemplateQuestion QuestionDifference QuestionMetric ShareInvitation ShareInvitationSummary TagResourceCommandInput TagResourceCommandOutput TagResourceInput TagResourceOutput UntagResourceCommandInput UntagResourceCommandOutput UntagResourceInput UntagResourceOutput UpdateAnswerCommandInput UpdateAnswerCommandOutput UpdateAnswerInput UpdateAnswerOutput UpdateGlobalSettingsCommandInput UpdateGlobalSettingsCommandOutput UpdateGlobalSettingsInput UpdateLensReviewCommandInput UpdateLensReviewCommandOutput UpdateLensReviewInput UpdateLensReviewOutput UpdateProfileCommandInput UpdateProfileCommandOutput UpdateProfileInput UpdateProfileOutput UpdateShareInvitationCommandInput UpdateShareInvitationCommandOutput UpdateShareInvitationInput UpdateShareInvitationOutput UpdateWorkloadCommandInput UpdateWorkloadCommandOutput UpdateWorkloadInput UpdateWorkloadOutput UpdateWorkloadShareCommandInput UpdateWorkloadShareCommandOutput UpdateWorkloadShareInput UpdateWorkloadShareOutput UpgradeLensReviewCommandInput UpgradeLensReviewCommandOutput UpgradeLensReviewInput UpgradeProfileVersionCommandInput UpgradeProfileVersionCommandOutput UpgradeProfileVersionInput ValidationExceptionField VersionDifferences WellArchitectedClientConfig WellArchitectedClientResolvedConfig WellArchitectedPaginationConfiguration Workload WorkloadDiscoveryConfig WorkloadProfile WorkloadShare WorkloadShareSummary WorkloadSummary

Type Aliases

ServiceInputTypes ServiceOutputTypes WellArchitectedClientConfigType WellArchitectedClientResolvedConfigType

Functions

paginateGetConsolidatedReport paginateListAnswers paginateListCheckDetails paginateListCheckSummaries paginateListLensReviewImprovements paginateListLensReviews paginateListLensShares paginateListLenses paginateListMilestones paginateListNotifications paginateListProfileNotifications paginateListProfileShares paginateListProfiles paginateListShareInvitations paginateListWorkloadShares paginateListWorkloads

SDK - Clients

WellArchitected WellArchitectedClient

SDK - Commands

AssociateLensesCommand AssociateLensesCommandInput AssociateLensesCommandOutput AssociateProfilesCommand AssociateProfilesCommandInput AssociateProfilesCommandOutput CreateLensShareCommand CreateLensShareCommandInput CreateLensShareCommandOutput CreateLensVersionCommand CreateLensVersionCommandInput CreateLensVersionCommandOutput CreateMilestoneCommand CreateMilestoneCommandInput CreateMilestoneCommandOutput CreateProfileCommand CreateProfileCommandInput CreateProfileCommandOutput CreateProfileShareCommand CreateProfileShareCommandInput CreateProfileShareCommandOutput CreateWorkloadCommand CreateWorkloadCommandInput CreateWorkloadCommandOutput CreateWorkloadShareCommand CreateWorkloadShareCommandInput CreateWorkloadShareCommandOutput DeleteLensCommand DeleteLensCommandInput DeleteLensCommandOutput DeleteLensShareCommand DeleteLensShareCommandInput DeleteLensShareCommandOutput DeleteProfileCommand DeleteProfileCommandInput DeleteProfileCommandOutput DeleteProfileShareCommand DeleteProfileShareCommandInput DeleteProfileShareCommandOutput DeleteWorkloadCommand DeleteWorkloadCommandInput DeleteWorkloadCommandOutput DeleteWorkloadShareCommand DeleteWorkloadShareCommandInput DeleteWorkloadShareCommandOutput DisassociateLensesCommand DisassociateLensesCommandInput DisassociateLensesCommandOutput DisassociateProfilesCommand DisassociateProfilesCommandInput DisassociateProfilesCommandOutput ExportLensCommand ExportLensCommandInput ExportLensCommandOutput GetAnswerCommand GetAnswerCommandInput GetAnswerCommandOutput GetConsolidatedReportCommand GetConsolidatedReportCommandInput GetConsolidatedReportCommandOutput GetLensCommand GetLensCommandInput GetLensCommandOutput GetLensReviewCommand GetLensReviewCommandInput GetLensReviewCommandOutput GetLensReviewReportCommand GetLensReviewReportCommandInput GetLensReviewReportCommandOutput GetLensVersionDifferenceCommand GetLensVersionDifferenceCommandInput GetLensVersionDifferenceCommandOutput GetMilestoneCommand GetMilestoneCommandInput GetMilestoneCommandOutput GetProfileCommand GetProfileCommandInput GetProfileCommandOutput GetProfileTemplateCommand GetProfileTemplateCommandInput GetProfileTemplateCommandOutput GetWorkloadCommand GetWorkloadCommandInput GetWorkloadCommandOutput ImportLensCommand ImportLensCommandInput ImportLensCommandOutput ListAnswersCommand ListAnswersCommandInput ListAnswersCommandOutput ListCheckDetailsCommand ListCheckDetailsCommandInput ListCheckDetailsCommandOutput ListCheckSummariesCommand ListCheckSummariesCommandInput ListCheckSummariesCommandOutput ListLensesCommand ListLensesCommandInput ListLensesCommandOutput ListLensReviewImprovementsCommand ListLensReviewImprovementsCommandInput ListLensReviewImprovementsCommandOutput ListLensReviewsCommand ListLensReviewsCommandInput ListLensReviewsCommandOutput ListLensSharesCommand ListLensSharesCommandInput ListLensSharesCommandOutput ListMilestonesCommand ListMilestonesCommandInput ListMilestonesCommandOutput ListNotificationsCommand ListNotificationsCommandInput ListNotificationsCommandOutput ListProfileNotificationsCommand ListProfileNotificationsCommandInput ListProfileNotificationsCommandOutput ListProfilesCommand ListProfilesCommandInput ListProfilesCommandOutput ListProfileSharesCommand ListProfileSharesCommandInput ListProfileSharesCommandOutput ListShareInvitationsCommand ListShareInvitationsCommandInput ListShareInvitationsCommandOutput ListTagsForResourceCommand ListTagsForResourceCommandInput ListTagsForResourceCommandOutput ListWorkloadsCommand ListWorkloadsCommandInput ListWorkloadsCommandOutput ListWorkloadSharesCommand ListWorkloadSharesCommandInput ListWorkloadSharesCommandOutput TagResourceCommand TagResourceCommandInput TagResourceCommandOutput UntagResourceCommand UntagResourceCommandInput UntagResourceCommandOutput UpdateAnswerCommand UpdateAnswerCommandInput UpdateAnswerCommandOutput UpdateGlobalSettingsCommand UpdateGlobalSettingsCommandInput UpdateGlobalSettingsCommandOutput UpdateLensReviewCommand UpdateLensReviewCommandInput UpdateLensReviewCommandOutput UpdateProfileCommand UpdateProfileCommandInput UpdateProfileCommandOutput UpdateShareInvitationCommand UpdateShareInvitationCommandInput UpdateShareInvitationCommandOutput UpdateWorkloadCommand UpdateWorkloadCommandInput UpdateWorkloadCommandOutput UpdateWorkloadShareCommand UpdateWorkloadShareCommandInput UpdateWorkloadShareCommandOutput UpgradeLensReviewCommand UpgradeLensReviewCommandInput UpgradeLensReviewCommandOutput UpgradeProfileVersionCommand UpgradeProfileVersionCommandInput UpgradeProfileVersionCommandOutput

SDK - Paginators

paginateGetConsolidatedReport paginateListAnswers paginateListCheckDetails paginateListCheckSummaries paginateListLensReviewImprovements paginateListLensReviews paginateListLensShares paginateListLenses paginateListMilestones paginateListNotifications paginateListProfileNotifications paginateListProfileShares paginateListProfiles paginateListShareInvitations paginateListWorkloadShares paginateListWorkloads

SDK - Waiters

Settings

Member Visibility

Theme