AWSWellArchitected (AWS Java SDK for AWS Well-Architected Tool 1.12.783 API)

All Known Subinterfaces:

AWSWellArchitectedAsync

All Known Implementing Classes:

AbstractAWSWellArchitected, AbstractAWSWellArchitectedAsync, AWSWellArchitectedAsyncClient, AWSWellArchitectedClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSWellArchitected
```
Interface for accessing Well-Architected.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSWellArchitected instead.

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.

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`AssociateLensesResult`	`associateLenses(AssociateLensesRequest associateLensesRequest)` Associate a lens to a workload.
`AssociateProfilesResult`	`associateProfiles(AssociateProfilesRequest associateProfilesRequest)` Associate a profile with a workload.
`CreateLensShareResult`	`createLensShare(CreateLensShareRequest createLensShareRequest)` Create a lens share.
`CreateLensVersionResult`	`createLensVersion(CreateLensVersionRequest createLensVersionRequest)` Create a new lens version.
`CreateMilestoneResult`	`createMilestone(CreateMilestoneRequest createMilestoneRequest)` Create a milestone for an existing workload.
`CreateProfileResult`	`createProfile(CreateProfileRequest createProfileRequest)` Create a profile.
`CreateProfileShareResult`	`createProfileShare(CreateProfileShareRequest createProfileShareRequest)` Create a profile share.
`CreateReviewTemplateResult`	`createReviewTemplate(CreateReviewTemplateRequest createReviewTemplateRequest)` Create a review template.
`CreateTemplateShareResult`	`createTemplateShare(CreateTemplateShareRequest createTemplateShareRequest)` Create a review template share.
`CreateWorkloadResult`	`createWorkload(CreateWorkloadRequest createWorkloadRequest)` Create a new workload.
`CreateWorkloadShareResult`	`createWorkloadShare(CreateWorkloadShareRequest createWorkloadShareRequest)` Create a workload share.
`DeleteLensResult`	`deleteLens(DeleteLensRequest deleteLensRequest)` Delete an existing lens.
`DeleteLensShareResult`	`deleteLensShare(DeleteLensShareRequest deleteLensShareRequest)` Delete a lens share.
`DeleteProfileResult`	`deleteProfile(DeleteProfileRequest deleteProfileRequest)` Delete a profile.
`DeleteProfileShareResult`	`deleteProfileShare(DeleteProfileShareRequest deleteProfileShareRequest)` Delete a profile share.
`DeleteReviewTemplateResult`	`deleteReviewTemplate(DeleteReviewTemplateRequest deleteReviewTemplateRequest)` Delete a review template.
`DeleteTemplateShareResult`	`deleteTemplateShare(DeleteTemplateShareRequest deleteTemplateShareRequest)` Delete a review template share.
`DeleteWorkloadResult`	`deleteWorkload(DeleteWorkloadRequest deleteWorkloadRequest)` Delete an existing workload.
`DeleteWorkloadShareResult`	`deleteWorkloadShare(DeleteWorkloadShareRequest deleteWorkloadShareRequest)` Delete a workload share.
`DisassociateLensesResult`	`disassociateLenses(DisassociateLensesRequest disassociateLensesRequest)` Disassociate a lens from a workload.
`DisassociateProfilesResult`	`disassociateProfiles(DisassociateProfilesRequest disassociateProfilesRequest)` Disassociate a profile from a workload.
`ExportLensResult`	`exportLens(ExportLensRequest exportLensRequest)` Export an existing lens.
`GetAnswerResult`	`getAnswer(GetAnswerRequest getAnswerRequest)` Get the answer to a specific question in a workload review.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetConsolidatedReportResult`	`getConsolidatedReport(GetConsolidatedReportRequest getConsolidatedReportRequest)` Get a consolidated report of your workloads.
`GetGlobalSettingsResult`	`getGlobalSettings(GetGlobalSettingsRequest getGlobalSettingsRequest)` Global settings for all workloads.
`GetLensResult`	`getLens(GetLensRequest getLensRequest)` Get an existing lens.
`GetLensReviewResult`	`getLensReview(GetLensReviewRequest getLensReviewRequest)` Get lens review.
`GetLensReviewReportResult`	`getLensReviewReport(GetLensReviewReportRequest getLensReviewReportRequest)` Get lens review report.
`GetLensVersionDifferenceResult`	`getLensVersionDifference(GetLensVersionDifferenceRequest getLensVersionDifferenceRequest)` Get lens version differences.
`GetMilestoneResult`	`getMilestone(GetMilestoneRequest getMilestoneRequest)` Get a milestone for an existing workload.
`GetProfileResult`	`getProfile(GetProfileRequest getProfileRequest)` Get profile information.
`GetProfileTemplateResult`	`getProfileTemplate(GetProfileTemplateRequest getProfileTemplateRequest)` Get profile template.
`GetReviewTemplateResult`	`getReviewTemplate(GetReviewTemplateRequest getReviewTemplateRequest)` Get review template.
`GetReviewTemplateAnswerResult`	`getReviewTemplateAnswer(GetReviewTemplateAnswerRequest getReviewTemplateAnswerRequest)` Get review template answer.
`GetReviewTemplateLensReviewResult`	`getReviewTemplateLensReview(GetReviewTemplateLensReviewRequest getReviewTemplateLensReviewRequest)` Get a lens review associated with a review template.
`GetWorkloadResult`	`getWorkload(GetWorkloadRequest getWorkloadRequest)` Get an existing workload.
`ImportLensResult`	`importLens(ImportLensRequest importLensRequest)` Import a new custom lens or update an existing custom lens.
`ListAnswersResult`	`listAnswers(ListAnswersRequest listAnswersRequest)` List of answers for a particular workload and lens.
`ListCheckDetailsResult`	`listCheckDetails(ListCheckDetailsRequest listCheckDetailsRequest)` List of Trusted Advisor check details by account related to the workload.
`ListCheckSummariesResult`	`listCheckSummaries(ListCheckSummariesRequest listCheckSummariesRequest)` List of Trusted Advisor checks summarized for all accounts related to the workload.
`ListLensesResult`	`listLenses(ListLensesRequest listLensesRequest)` List the available lenses.
`ListLensReviewImprovementsResult`	`listLensReviewImprovements(ListLensReviewImprovementsRequest listLensReviewImprovementsRequest)` List the improvements of a particular lens review.
`ListLensReviewsResult`	`listLensReviews(ListLensReviewsRequest listLensReviewsRequest)` List lens reviews for a particular workload.
`ListLensSharesResult`	`listLensShares(ListLensSharesRequest listLensSharesRequest)` List the lens shares associated with the lens.
`ListMilestonesResult`	`listMilestones(ListMilestonesRequest listMilestonesRequest)` List all milestones for an existing workload.
`ListNotificationsResult`	`listNotifications(ListNotificationsRequest listNotificationsRequest)` List lens notifications.
`ListProfileNotificationsResult`	`listProfileNotifications(ListProfileNotificationsRequest listProfileNotificationsRequest)` List profile notifications.
`ListProfilesResult`	`listProfiles(ListProfilesRequest listProfilesRequest)` List profiles.
`ListProfileSharesResult`	`listProfileShares(ListProfileSharesRequest listProfileSharesRequest)` List profile shares.
`ListReviewTemplateAnswersResult`	`listReviewTemplateAnswers(ListReviewTemplateAnswersRequest listReviewTemplateAnswersRequest)` List the answers of a review template.
`ListReviewTemplatesResult`	`listReviewTemplates(ListReviewTemplatesRequest listReviewTemplatesRequest)` List review templates.
`ListShareInvitationsResult`	`listShareInvitations(ListShareInvitationsRequest listShareInvitationsRequest)` List the share invitations.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)` List the tags for a resource.
`ListTemplateSharesResult`	`listTemplateShares(ListTemplateSharesRequest listTemplateSharesRequest)` List review template shares.
`ListWorkloadsResult`	`listWorkloads(ListWorkloadsRequest listWorkloadsRequest)` Paginated list of workloads.
`ListWorkloadSharesResult`	`listWorkloadShares(ListWorkloadSharesRequest listWorkloadSharesRequest)` List the workload shares associated with the workload.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`TagResourceResult`	`tagResource(TagResourceRequest tagResourceRequest)` Adds one or more tags to the specified resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest untagResourceRequest)` Deletes specified tags from a resource.
`UpdateAnswerResult`	`updateAnswer(UpdateAnswerRequest updateAnswerRequest)` Update the answer to a specific question in a workload review.
`UpdateGlobalSettingsResult`	`updateGlobalSettings(UpdateGlobalSettingsRequest updateGlobalSettingsRequest)` Update whether the Amazon Web Services account is opted into organization sharing and discovery integration features.
`UpdateIntegrationResult`	`updateIntegration(UpdateIntegrationRequest updateIntegrationRequest)` Update integration features.
`UpdateLensReviewResult`	`updateLensReview(UpdateLensReviewRequest updateLensReviewRequest)` Update lens review for a particular workload.
`UpdateProfileResult`	`updateProfile(UpdateProfileRequest updateProfileRequest)` Update a profile.
`UpdateReviewTemplateResult`	`updateReviewTemplate(UpdateReviewTemplateRequest updateReviewTemplateRequest)` Update a review template.
`UpdateReviewTemplateAnswerResult`	`updateReviewTemplateAnswer(UpdateReviewTemplateAnswerRequest updateReviewTemplateAnswerRequest)` Update a review template answer.
`UpdateReviewTemplateLensReviewResult`	`updateReviewTemplateLensReview(UpdateReviewTemplateLensReviewRequest updateReviewTemplateLensReviewRequest)` Update a lens review associated with a review template.
`UpdateShareInvitationResult`	`updateShareInvitation(UpdateShareInvitationRequest updateShareInvitationRequest)` Update a workload or custom lens share invitation.
`UpdateWorkloadResult`	`updateWorkload(UpdateWorkloadRequest updateWorkloadRequest)` Update an existing workload.
`UpdateWorkloadShareResult`	`updateWorkloadShare(UpdateWorkloadShareRequest updateWorkloadShareRequest)` Update a workload share.
`UpgradeLensReviewResult`	`upgradeLensReview(UpgradeLensReviewRequest upgradeLensReviewRequest)` Upgrade lens review for a particular workload.
`UpgradeProfileVersionResult`	`upgradeProfileVersion(UpgradeProfileVersionRequest upgradeProfileVersionRequest)` Upgrade a profile.
`UpgradeReviewTemplateLensReviewResult`	`upgradeReviewTemplateLensReview(UpgradeReviewTemplateLensReviewRequest upgradeReviewTemplateLensReviewRequest)` Upgrade the lens review of a review template.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - associateLenses
```
AssociateLensesResult associateLenses(AssociateLensesRequest associateLensesRequest)
```
    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.
    
    Parameters:
    
    associateLensesRequest - Input to associate lens reviews.
    
    Returns:
    
    Result of the AssociateLenses operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    ResourceNotFoundException - The requested resource was not found.
    
    ConflictException - The resource has already been processed, was deleted, or is too large.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - associateProfiles
```
AssociateProfilesResult associateProfiles(AssociateProfilesRequest associateProfilesRequest)
```
    Associate a profile with a workload.
    
    Parameters:
    
    associateProfilesRequest -
    
    Returns:
    
    Result of the AssociateProfiles operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    ResourceNotFoundException - The requested resource was not found.
    
    ConflictException - The resource has already been processed, was deleted, or is too large.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - createLensShare
```
CreateLensShareResult createLensShare(CreateLensShareRequest createLensShareRequest)
```
    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.
    
    Parameters:
    
    createLensShareRequest -
    
    Returns:
    
    Result of the CreateLensShare operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    ConflictException - The resource has already been processed, was deleted, or is too large.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    ResourceNotFoundException - The requested resource was not found.
    
    ServiceQuotaExceededException - The user has reached their resource quota.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - createLensVersion
```
CreateLensVersionResult createLensVersion(CreateLensVersionRequest createLensVersionRequest)
```
    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.
    
    Parameters:
    
    createLensVersionRequest -
    
    Returns:
    
    Result of the CreateLensVersion operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    ResourceNotFoundException - The requested resource was not found.
    
    ServiceQuotaExceededException - The user has reached their resource quota.
    
    ConflictException - The resource has already been processed, was deleted, or is too large.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - createMilestone
```
CreateMilestoneResult createMilestone(CreateMilestoneRequest createMilestoneRequest)
```
    Create a milestone for an existing workload.
    
    Parameters:
    
    createMilestoneRequest - Input for milestone creation.
    
    Returns:
    
    Result of the CreateMilestone operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    ConflictException - The resource has already been processed, was deleted, or is too large.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    ResourceNotFoundException - The requested resource was not found.
    
    ServiceQuotaExceededException - The user has reached their resource quota.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - createProfile
```
CreateProfileResult createProfile(CreateProfileRequest createProfileRequest)
```
    Create a profile.
    
    Parameters:
    
    createProfileRequest -
    
    Returns:
    
    Result of the CreateProfile operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    ConflictException - The resource has already been processed, was deleted, or is too large.
    
    ServiceQuotaExceededException - The user has reached their resource quota.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - createProfileShare
```
CreateProfileShareResult createProfileShare(CreateProfileShareRequest createProfileShareRequest)
```
    Create a profile share.
    
    Parameters:
    
    createProfileShareRequest -
    
    Returns:
    
    Result of the CreateProfileShare operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    ConflictException - The resource has already been processed, was deleted, or is too large.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    ResourceNotFoundException - The requested resource was not found.
    
    ServiceQuotaExceededException - The user has reached their resource quota.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - createReviewTemplate
```
CreateReviewTemplateResult createReviewTemplate(CreateReviewTemplateRequest createReviewTemplateRequest)
```
    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.
    
    Parameters:
    
    createReviewTemplateRequest -
    
    Returns:
    
    Result of the CreateReviewTemplate operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    ConflictException - The resource has already been processed, was deleted, or is too large.
    
    ServiceQuotaExceededException - The user has reached their resource quota.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ResourceNotFoundException - The requested resource was not found.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - createTemplateShare
```
CreateTemplateShareResult createTemplateShare(CreateTemplateShareRequest createTemplateShareRequest)
```
    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.
    
    Parameters:
    
    createTemplateShareRequest -
    
    Returns:
    
    Result of the CreateTemplateShare operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    ConflictException - The resource has already been processed, was deleted, or is too large.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    ResourceNotFoundException - The requested resource was not found.
    
    ServiceQuotaExceededException - The user has reached their resource quota.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - createWorkload
```
CreateWorkloadResult createWorkload(CreateWorkloadRequest createWorkloadRequest)
```
    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
    Parameters:
    
    createWorkloadRequest - Input for workload creation.
    
    Returns:
    
    Result of the CreateWorkload operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    ConflictException - The resource has already been processed, was deleted, or is too large.
    
    ServiceQuotaExceededException - The user has reached their resource quota.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ResourceNotFoundException - The requested resource was not found.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - createWorkloadShare
```
CreateWorkloadShareResult createWorkloadShare(CreateWorkloadShareRequest createWorkloadShareRequest)
```
    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.
    
    Parameters:
    
    createWorkloadShareRequest - Input for Create Workload Share
    
    Returns:
    
    Result of the CreateWorkloadShare operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    ConflictException - The resource has already been processed, was deleted, or is too large.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    ResourceNotFoundException - The requested resource was not found.
    
    ServiceQuotaExceededException - The user has reached their resource quota.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - deleteLens
```
DeleteLensResult deleteLens(DeleteLensRequest deleteLensRequest)
```
    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.
    
    Parameters:
    
    deleteLensRequest -
    
    Returns:
    
    Result of the DeleteLens operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    ResourceNotFoundException - The requested resource was not found.
    
    ConflictException - The resource has already been processed, was deleted, or is too large.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - deleteLensShare
```
DeleteLensShareResult deleteLensShare(DeleteLensShareRequest deleteLensShareRequest)
```
    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.
    
    Parameters:
    
    deleteLensShareRequest -
    
    Returns:
    
    Result of the DeleteLensShare operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    ResourceNotFoundException - The requested resource was not found.
    
    ConflictException - The resource has already been processed, was deleted, or is too large.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - deleteProfile
```
DeleteProfileResult deleteProfile(DeleteProfileRequest deleteProfileRequest)
```
    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.
    
    Parameters:
    
    deleteProfileRequest -
    
    Returns:
    
    Result of the DeleteProfile operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    ResourceNotFoundException - The requested resource was not found.
    
    ConflictException - The resource has already been processed, was deleted, or is too large.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - deleteProfileShare
```
DeleteProfileShareResult deleteProfileShare(DeleteProfileShareRequest deleteProfileShareRequest)
```
    Delete a profile share.
    
    Parameters:
    
    deleteProfileShareRequest -
    
    Returns:
    
    Result of the DeleteProfileShare operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    ResourceNotFoundException - The requested resource was not found.
    
    ConflictException - The resource has already been processed, was deleted, or is too large.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - deleteReviewTemplate
```
DeleteReviewTemplateResult deleteReviewTemplate(DeleteReviewTemplateRequest deleteReviewTemplateRequest)
```
    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.
    
    Parameters:
    
    deleteReviewTemplateRequest -
    
    Returns:
    
    Result of the DeleteReviewTemplate operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    ResourceNotFoundException - The requested resource was not found.
    
    ConflictException - The resource has already been processed, was deleted, or is too large.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - deleteTemplateShare
```
DeleteTemplateShareResult deleteTemplateShare(DeleteTemplateShareRequest deleteTemplateShareRequest)
```
    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.
    
    Parameters:
    
    deleteTemplateShareRequest -
    
    Returns:
    
    Result of the DeleteTemplateShare operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    ResourceNotFoundException - The requested resource was not found.
    
    ConflictException - The resource has already been processed, was deleted, or is too large.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - deleteWorkload
```
DeleteWorkloadResult deleteWorkload(DeleteWorkloadRequest deleteWorkloadRequest)
```
    Delete an existing workload.
    
    Parameters:
    
    deleteWorkloadRequest - Input for workload deletion.
    
    Returns:
    
    Result of the DeleteWorkload operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    ResourceNotFoundException - The requested resource was not found.
    
    ConflictException - The resource has already been processed, was deleted, or is too large.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - deleteWorkloadShare
```
DeleteWorkloadShareResult deleteWorkloadShare(DeleteWorkloadShareRequest deleteWorkloadShareRequest)
```
    Delete a workload share.
    
    Parameters:
    
    deleteWorkloadShareRequest - Input for Delete Workload Share
    
    Returns:
    
    Result of the DeleteWorkloadShare operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    ResourceNotFoundException - The requested resource was not found.
    
    ConflictException - The resource has already been processed, was deleted, or is too large.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - disassociateLenses
```
DisassociateLensesResult disassociateLenses(DisassociateLensesRequest disassociateLensesRequest)
```
    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.
    
    Parameters:
    
    disassociateLensesRequest - Input to disassociate lens reviews.
    
    Returns:
    
    Result of the DisassociateLenses operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    ResourceNotFoundException - The requested resource was not found.
    
    ConflictException - The resource has already been processed, was deleted, or is too large.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - disassociateProfiles
```
DisassociateProfilesResult disassociateProfiles(DisassociateProfilesRequest disassociateProfilesRequest)
```
    Disassociate a profile from a workload.
    
    Parameters:
    
    disassociateProfilesRequest -
    
    Returns:
    
    Result of the DisassociateProfiles operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    ResourceNotFoundException - The requested resource was not found.
    
    ConflictException - The resource has already been processed, was deleted, or is too large.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - exportLens
```
ExportLensResult exportLens(ExportLensRequest exportLensRequest)
```
    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.
    
    Parameters:
    
    exportLensRequest -
    
    Returns:
    
    Result of the ExportLens operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    ResourceNotFoundException - The requested resource was not found.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - getAnswer
```
GetAnswerResult getAnswer(GetAnswerRequest getAnswerRequest)
```
    Get the answer to a specific question in a workload review.
    
    Parameters:
    
    getAnswerRequest - Input to get answer.
    
    Returns:
    
    Result of the GetAnswer operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    ResourceNotFoundException - The requested resource was not found.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - getConsolidatedReport
```
GetConsolidatedReportResult getConsolidatedReport(GetConsolidatedReportRequest getConsolidatedReportRequest)
```
    Get a consolidated report of your workloads.
    
    You can optionally choose to include workloads that have been shared with you.
    
    Parameters:
    
    getConsolidatedReportRequest -
    
    Returns:
    
    Result of the GetConsolidatedReport operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    ConflictException - The resource has already been processed, was deleted, or is too large.
    
    See Also:
    
    AWS API Documentation
  - getGlobalSettings
```
GetGlobalSettingsResult getGlobalSettings(GetGlobalSettingsRequest getGlobalSettingsRequest)
```
    Global settings for all workloads.
    
    Parameters:
    
    getGlobalSettingsRequest -
    
    Returns:
    
    Result of the GetGlobalSettings operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - getLens
```
GetLensResult getLens(GetLensRequest getLensRequest)
```
    Get an existing lens.
    
    Parameters:
    
    getLensRequest -
    
    Returns:
    
    Result of the GetLens operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    ResourceNotFoundException - The requested resource was not found.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - getLensReview
```
GetLensReviewResult getLensReview(GetLensReviewRequest getLensReviewRequest)
```
    Get lens review.
    
    Parameters:
    
    getLensReviewRequest - Input to get lens review.
    
    Returns:
    
    Result of the GetLensReview operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    ResourceNotFoundException - The requested resource was not found.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - getLensReviewReport
```
GetLensReviewReportResult getLensReviewReport(GetLensReviewReportRequest getLensReviewReportRequest)
```
    Get lens review report.
    
    Parameters:
    
    getLensReviewReportRequest - Input to get lens review report.
    
    Returns:
    
    Result of the GetLensReviewReport operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    ResourceNotFoundException - The requested resource was not found.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - getLensVersionDifference
```
GetLensVersionDifferenceResult getLensVersionDifference(GetLensVersionDifferenceRequest getLensVersionDifferenceRequest)
```
    Get lens version differences.
    
    Parameters:
    
    getLensVersionDifferenceRequest -
    
    Returns:
    
    Result of the GetLensVersionDifference operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    ResourceNotFoundException - The requested resource was not found.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - getMilestone
```
GetMilestoneResult getMilestone(GetMilestoneRequest getMilestoneRequest)
```
    Get a milestone for an existing workload.
    
    Parameters:
    
    getMilestoneRequest - Input to get a milestone.
    
    Returns:
    
    Result of the GetMilestone operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    ResourceNotFoundException - The requested resource was not found.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - getProfile
```
GetProfileResult getProfile(GetProfileRequest getProfileRequest)
```
    Get profile information.
    
    Parameters:
    
    getProfileRequest -
    
    Returns:
    
    Result of the GetProfile operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    ResourceNotFoundException - The requested resource was not found.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - getProfileTemplate
```
GetProfileTemplateResult getProfileTemplate(GetProfileTemplateRequest getProfileTemplateRequest)
```
    Get profile template.
    
    Parameters:
    
    getProfileTemplateRequest -
    
    Returns:
    
    Result of the GetProfileTemplate operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    ResourceNotFoundException - The requested resource was not found.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - getReviewTemplate
```
GetReviewTemplateResult getReviewTemplate(GetReviewTemplateRequest getReviewTemplateRequest)
```
    Get review template.
    
    Parameters:
    
    getReviewTemplateRequest -
    
    Returns:
    
    Result of the GetReviewTemplate operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    ResourceNotFoundException - The requested resource was not found.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - getReviewTemplateAnswer
```
GetReviewTemplateAnswerResult getReviewTemplateAnswer(GetReviewTemplateAnswerRequest getReviewTemplateAnswerRequest)
```
    Get review template answer.
    
    Parameters:
    
    getReviewTemplateAnswerRequest -
    
    Returns:
    
    Result of the GetReviewTemplateAnswer operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    ResourceNotFoundException - The requested resource was not found.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - getReviewTemplateLensReview
```
GetReviewTemplateLensReviewResult getReviewTemplateLensReview(GetReviewTemplateLensReviewRequest getReviewTemplateLensReviewRequest)
```
    Get a lens review associated with a review template.
    
    Parameters:
    
    getReviewTemplateLensReviewRequest -
    
    Returns:
    
    Result of the GetReviewTemplateLensReview operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    ResourceNotFoundException - The requested resource was not found.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - getWorkload
```
GetWorkloadResult getWorkload(GetWorkloadRequest getWorkloadRequest)
```
    Get an existing workload.
    
    Parameters:
    
    getWorkloadRequest - Input to get a workload.
    
    Returns:
    
    Result of the GetWorkload operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    ResourceNotFoundException - The requested resource was not found.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - importLens
```
ImportLensResult importLens(ImportLensRequest importLensRequest)
```
    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.
    
    Parameters:
    
    importLensRequest -
    
    Returns:
    
    Result of the ImportLens operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    ConflictException - The resource has already been processed, was deleted, or is too large.
    
    ResourceNotFoundException - The requested resource was not found.
    
    ServiceQuotaExceededException - The user has reached their resource quota.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - listAnswers
```
ListAnswersResult listAnswers(ListAnswersRequest listAnswersRequest)
```
    List of answers for a particular workload and lens.
    
    Parameters:
    
    listAnswersRequest - Input to list answers.
    
    Returns:
    
    Result of the ListAnswers operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    ResourceNotFoundException - The requested resource was not found.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - listCheckDetails
```
ListCheckDetailsResult listCheckDetails(ListCheckDetailsRequest listCheckDetailsRequest)
```
    List of Trusted Advisor check details by account related to the workload.
    
    Parameters:
    
    listCheckDetailsRequest -
    
    Returns:
    
    Result of the ListCheckDetails operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    ResourceNotFoundException - The requested resource was not found.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - listCheckSummaries
```
ListCheckSummariesResult listCheckSummaries(ListCheckSummariesRequest listCheckSummariesRequest)
```
    List of Trusted Advisor checks summarized for all accounts related to the workload.
    
    Parameters:
    
    listCheckSummariesRequest -
    
    Returns:
    
    Result of the ListCheckSummaries operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    ResourceNotFoundException - The requested resource was not found.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - listLensReviewImprovements
```
ListLensReviewImprovementsResult listLensReviewImprovements(ListLensReviewImprovementsRequest listLensReviewImprovementsRequest)
```
    List the improvements of a particular lens review.
    
    Parameters:
    
    listLensReviewImprovementsRequest - Input to list lens review improvements.
    
    Returns:
    
    Result of the ListLensReviewImprovements operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    ResourceNotFoundException - The requested resource was not found.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - listLensReviews
```
ListLensReviewsResult listLensReviews(ListLensReviewsRequest listLensReviewsRequest)
```
    List lens reviews for a particular workload.
    
    Parameters:
    
    listLensReviewsRequest - Input to list lens reviews.
    
    Returns:
    
    Result of the ListLensReviews operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    ResourceNotFoundException - The requested resource was not found.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - listLensShares
```
ListLensSharesResult listLensShares(ListLensSharesRequest listLensSharesRequest)
```
    List the lens shares associated with the lens.
    
    Parameters:
    
    listLensSharesRequest -
    
    Returns:
    
    Result of the ListLensShares operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    ResourceNotFoundException - The requested resource was not found.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - listLenses
```
ListLensesResult listLenses(ListLensesRequest listLensesRequest)
```
    List the available lenses.
    
    Parameters:
    
    listLensesRequest - Input to list lenses.
    
    Returns:
    
    Result of the ListLenses operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - listMilestones
```
ListMilestonesResult listMilestones(ListMilestonesRequest listMilestonesRequest)
```
    List all milestones for an existing workload.
    
    Parameters:
    
    listMilestonesRequest - Input to list all milestones for a workload.
    
    Returns:
    
    Result of the ListMilestones operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    ResourceNotFoundException - The requested resource was not found.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - listNotifications
```
ListNotificationsResult listNotifications(ListNotificationsRequest listNotificationsRequest)
```
    List lens notifications.
    
    Parameters:
    
    listNotificationsRequest -
    
    Returns:
    
    Result of the ListNotifications operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - listProfileNotifications
```
ListProfileNotificationsResult listProfileNotifications(ListProfileNotificationsRequest listProfileNotificationsRequest)
```
    List profile notifications.
    
    Parameters:
    
    listProfileNotificationsRequest -
    
    Returns:
    
    Result of the ListProfileNotifications operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - listProfileShares
```
ListProfileSharesResult listProfileShares(ListProfileSharesRequest listProfileSharesRequest)
```
    List profile shares.
    
    Parameters:
    
    listProfileSharesRequest -
    
    Returns:
    
    Result of the ListProfileShares operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    ResourceNotFoundException - The requested resource was not found.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - listProfiles
```
ListProfilesResult listProfiles(ListProfilesRequest listProfilesRequest)
```
    List profiles.
    
    Parameters:
    
    listProfilesRequest -
    
    Returns:
    
    Result of the ListProfiles operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - listReviewTemplateAnswers
```
ListReviewTemplateAnswersResult listReviewTemplateAnswers(ListReviewTemplateAnswersRequest listReviewTemplateAnswersRequest)
```
    List the answers of a review template.
    
    Parameters:
    
    listReviewTemplateAnswersRequest -
    
    Returns:
    
    Result of the ListReviewTemplateAnswers operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    ResourceNotFoundException - The requested resource was not found.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - listReviewTemplates
```
ListReviewTemplatesResult listReviewTemplates(ListReviewTemplatesRequest listReviewTemplatesRequest)
```
    List review templates.
    
    Parameters:
    
    listReviewTemplatesRequest -
    
    Returns:
    
    Result of the ListReviewTemplates operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - listShareInvitations
```
ListShareInvitationsResult listShareInvitations(ListShareInvitationsRequest listShareInvitationsRequest)
```
    List the share invitations.
    
    WorkloadNamePrefix, LensNamePrefix, ProfileNamePrefix, and TemplateNamePrefix are mutually exclusive. Use the parameter that matches your ShareResourceType.
    
    Parameters:
    
    listShareInvitationsRequest - Input for List Share Invitations
    
    Returns:
    
    Result of the ListShareInvitations operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
```
    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.
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    ResourceNotFoundException - The requested resource was not found.
    
    See Also:
    
    AWS API Documentation
  - listTemplateShares
```
ListTemplateSharesResult listTemplateShares(ListTemplateSharesRequest listTemplateSharesRequest)
```
    List review template shares.
    
    Parameters:
    
    listTemplateSharesRequest -
    
    Returns:
    
    Result of the ListTemplateShares operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    ResourceNotFoundException - The requested resource was not found.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - listWorkloadShares
```
ListWorkloadSharesResult listWorkloadShares(ListWorkloadSharesRequest listWorkloadSharesRequest)
```
    List the workload shares associated with the workload.
    
    Parameters:
    
    listWorkloadSharesRequest - Input for List Workload Share
    
    Returns:
    
    Result of the ListWorkloadShares operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    ResourceNotFoundException - The requested resource was not found.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - listWorkloads
```
ListWorkloadsResult listWorkloads(ListWorkloadsRequest listWorkloadsRequest)
```
    Paginated list of workloads.
    
    Parameters:
    
    listWorkloadsRequest - Input to list all workloads.
    
    Returns:
    
    Result of the ListWorkloads operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
```
    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.
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    ResourceNotFoundException - The requested resource was not found.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
```
    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
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    ResourceNotFoundException - The requested resource was not found.
    
    See Also:
    
    AWS API Documentation
  - updateAnswer
```
UpdateAnswerResult updateAnswer(UpdateAnswerRequest updateAnswerRequest)
```
    Update the answer to a specific question in a workload review.
    
    Parameters:
    
    updateAnswerRequest - Input to update answer.
    
    Returns:
    
    Result of the UpdateAnswer operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    ResourceNotFoundException - The requested resource was not found.
    
    ConflictException - The resource has already been processed, was deleted, or is too large.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - updateGlobalSettings
```
UpdateGlobalSettingsResult updateGlobalSettings(UpdateGlobalSettingsRequest updateGlobalSettingsRequest)
```
    Update whether the Amazon Web Services account is opted into organization sharing and discovery integration features.
    
    Parameters:
    
    updateGlobalSettingsRequest -
    
    Returns:
    
    Result of the UpdateGlobalSettings operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    ConflictException - The resource has already been processed, was deleted, or is too large.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - updateIntegration
```
UpdateIntegrationResult updateIntegration(UpdateIntegrationRequest updateIntegrationRequest)
```
    Update integration features.
    
    Parameters:
    
    updateIntegrationRequest -
    
    Returns:
    
    Result of the UpdateIntegration operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    ConflictException - The resource has already been processed, was deleted, or is too large.
    
    ResourceNotFoundException - The requested resource was not found.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - updateLensReview
```
UpdateLensReviewResult updateLensReview(UpdateLensReviewRequest updateLensReviewRequest)
```
    Update lens review for a particular workload.
    
    Parameters:
    
    updateLensReviewRequest - Input for update lens review.
    
    Returns:
    
    Result of the UpdateLensReview operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    ResourceNotFoundException - The requested resource was not found.
    
    ConflictException - The resource has already been processed, was deleted, or is too large.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - updateProfile
```
UpdateProfileResult updateProfile(UpdateProfileRequest updateProfileRequest)
```
    Update a profile.
    
    Parameters:
    
    updateProfileRequest -
    
    Returns:
    
    Result of the UpdateProfile operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    ResourceNotFoundException - The requested resource was not found.
    
    ConflictException - The resource has already been processed, was deleted, or is too large.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - updateReviewTemplate
```
UpdateReviewTemplateResult updateReviewTemplate(UpdateReviewTemplateRequest updateReviewTemplateRequest)
```
    Update a review template.
    
    Parameters:
    
    updateReviewTemplateRequest -
    
    Returns:
    
    Result of the UpdateReviewTemplate operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    ResourceNotFoundException - The requested resource was not found.
    
    ConflictException - The resource has already been processed, was deleted, or is too large.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - updateReviewTemplateAnswer
```
UpdateReviewTemplateAnswerResult updateReviewTemplateAnswer(UpdateReviewTemplateAnswerRequest updateReviewTemplateAnswerRequest)
```
    Update a review template answer.
    
    Parameters:
    
    updateReviewTemplateAnswerRequest -
    
    Returns:
    
    Result of the UpdateReviewTemplateAnswer operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    ResourceNotFoundException - The requested resource was not found.
    
    ConflictException - The resource has already been processed, was deleted, or is too large.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - updateReviewTemplateLensReview
```
UpdateReviewTemplateLensReviewResult updateReviewTemplateLensReview(UpdateReviewTemplateLensReviewRequest updateReviewTemplateLensReviewRequest)
```
    Update a lens review associated with a review template.
    
    Parameters:
    
    updateReviewTemplateLensReviewRequest -
    
    Returns:
    
    Result of the UpdateReviewTemplateLensReview operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    ResourceNotFoundException - The requested resource was not found.
    
    ConflictException - The resource has already been processed, was deleted, or is too large.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - updateShareInvitation
```
UpdateShareInvitationResult updateShareInvitation(UpdateShareInvitationRequest updateShareInvitationRequest)
```
    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.
    
    Parameters:
    
    updateShareInvitationRequest - Input for Update Share Invitation
    
    Returns:
    
    Result of the UpdateShareInvitation operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    ResourceNotFoundException - The requested resource was not found.
    
    ConflictException - The resource has already been processed, was deleted, or is too large.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - updateWorkload
```
UpdateWorkloadResult updateWorkload(UpdateWorkloadRequest updateWorkloadRequest)
```
    Update an existing workload.
    
    Parameters:
    
    updateWorkloadRequest - Input to update a workload.
    
    Returns:
    
    Result of the UpdateWorkload operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    ResourceNotFoundException - The requested resource was not found.
    
    ConflictException - The resource has already been processed, was deleted, or is too large.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - updateWorkloadShare
```
UpdateWorkloadShareResult updateWorkloadShare(UpdateWorkloadShareRequest updateWorkloadShareRequest)
```
    Update a workload share.
    
    Parameters:
    
    updateWorkloadShareRequest - Input for Update Workload Share
    
    Returns:
    
    Result of the UpdateWorkloadShare operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    ResourceNotFoundException - The requested resource was not found.
    
    ConflictException - The resource has already been processed, was deleted, or is too large.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - upgradeLensReview
```
UpgradeLensReviewResult upgradeLensReview(UpgradeLensReviewRequest upgradeLensReviewRequest)
```
    Upgrade lens review for a particular workload.
    
    Parameters:
    
    upgradeLensReviewRequest -
    
    Returns:
    
    Result of the UpgradeLensReview operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    ResourceNotFoundException - The requested resource was not found.
    
    ConflictException - The resource has already been processed, was deleted, or is too large.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    ServiceQuotaExceededException - The user has reached their resource quota.
    
    See Also:
    
    AWS API Documentation
  - upgradeProfileVersion
```
UpgradeProfileVersionResult upgradeProfileVersion(UpgradeProfileVersionRequest upgradeProfileVersionRequest)
```
    Upgrade a profile.
    
    Parameters:
    
    upgradeProfileVersionRequest -
    
    Returns:
    
    Result of the UpgradeProfileVersion operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    ResourceNotFoundException - The requested resource was not found.
    
    ConflictException - The resource has already been processed, was deleted, or is too large.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    ServiceQuotaExceededException - The user has reached their resource quota.
    
    See Also:
    
    AWS API Documentation
  - upgradeReviewTemplateLensReview
```
UpgradeReviewTemplateLensReviewResult upgradeReviewTemplateLensReview(UpgradeReviewTemplateLensReviewRequest upgradeReviewTemplateLensReviewRequest)
```
    Upgrade the lens review of a review template.
    
    Parameters:
    
    upgradeReviewTemplateLensReviewRequest -
    
    Returns:
    
    Result of the UpgradeReviewTemplateLensReview operation returned by the service.
    
    Throws:
    
    ValidationException - The user input is not valid.
    
    ResourceNotFoundException - The requested resource was not found.
    
    ConflictException - The resource has already been processed, was deleted, or is too large.
    
    InternalServerException - There is a problem with the Well-Architected Tool API service.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - getCachedResponseMetadata
```
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Interface AWSWellArchitected

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

associateLenses

associateProfiles

createLensShare

createLensVersion

createMilestone

createProfile

createProfileShare

createReviewTemplate

createTemplateShare

createWorkload

createWorkloadShare

deleteLens

deleteLensShare

deleteProfile

deleteProfileShare

deleteReviewTemplate

deleteTemplateShare

deleteWorkload

deleteWorkloadShare

disassociateLenses

disassociateProfiles

exportLens

getAnswer

getConsolidatedReport

getGlobalSettings

getLens

getLensReview

getLensReviewReport

getLensVersionDifference

getMilestone

getProfile

getProfileTemplate

getReviewTemplate

getReviewTemplateAnswer

getReviewTemplateLensReview

getWorkload

importLens

listAnswers

listCheckDetails

listCheckSummaries

listLensReviewImprovements

listLensReviews

listLensShares

listLenses

listMilestones

listNotifications

listProfileNotifications

listProfileShares

listProfiles

listReviewTemplateAnswers

listReviewTemplates

listShareInvitations

listTagsForResource

listTemplateShares

listWorkloadShares

listWorkloads

tagResource

untagResource

updateAnswer

updateGlobalSettings

updateIntegration

updateLensReview

updateProfile

updateReviewTemplate

updateReviewTemplateAnswer

updateReviewTemplateLensReview

updateShareInvitation

updateWorkload

updateWorkloadShare

upgradeLensReview

upgradeProfileVersion

upgradeReviewTemplateLensReview

shutdown

getCachedResponseMetadata