@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSWellArchitectedClient extends AmazonWebServiceClient implements AWSWellArchitected
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.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
public static AWSWellArchitectedClientBuilder builder()
public AssociateLensesResult associateLenses(AssociateLensesRequest request)
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.
associateLenses
in interface AWSWellArchitected
associateLensesRequest
- Input to associate lens reviews.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.public AssociateProfilesResult associateProfiles(AssociateProfilesRequest request)
Associate a profile with a workload.
associateProfiles
in interface AWSWellArchitected
associateProfilesRequest
- 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.public CreateLensShareResult createLensShare(CreateLensShareRequest request)
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.
createLensShare
in interface AWSWellArchitected
createLensShareRequest
- 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.public CreateLensVersionResult createLensVersion(CreateLensVersionRequest request)
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.
createLensVersion
in interface AWSWellArchitected
createLensVersionRequest
- 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.public CreateMilestoneResult createMilestone(CreateMilestoneRequest request)
Create a milestone for an existing workload.
createMilestone
in interface AWSWellArchitected
createMilestoneRequest
- Input for milestone creation.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.public CreateProfileResult createProfile(CreateProfileRequest request)
Create a profile.
createProfile
in interface AWSWellArchitected
createProfileRequest
- 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.public CreateProfileShareResult createProfileShare(CreateProfileShareRequest request)
Create a profile share.
createProfileShare
in interface AWSWellArchitected
createProfileShareRequest
- 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.public CreateReviewTemplateResult createReviewTemplate(CreateReviewTemplateRequest request)
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.
createReviewTemplate
in interface AWSWellArchitected
createReviewTemplateRequest
- 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.public CreateTemplateShareResult createTemplateShare(CreateTemplateShareRequest request)
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.
createTemplateShare
in interface AWSWellArchitected
createTemplateShareRequest
- 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.public CreateWorkloadResult createWorkload(CreateWorkloadRequest request)
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
createWorkload
in interface AWSWellArchitected
createWorkloadRequest
- Input for workload creation.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.public CreateWorkloadShareResult createWorkloadShare(CreateWorkloadShareRequest request)
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.
createWorkloadShare
in interface AWSWellArchitected
createWorkloadShareRequest
- Input for Create Workload ShareValidationException
- 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.public DeleteLensResult deleteLens(DeleteLensRequest request)
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.
deleteLens
in interface AWSWellArchitected
deleteLensRequest
- 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.public DeleteLensShareResult deleteLensShare(DeleteLensShareRequest request)
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.
deleteLensShare
in interface AWSWellArchitected
deleteLensShareRequest
- 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.public DeleteProfileResult deleteProfile(DeleteProfileRequest request)
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.
deleteProfile
in interface AWSWellArchitected
deleteProfileRequest
- 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.public DeleteProfileShareResult deleteProfileShare(DeleteProfileShareRequest request)
Delete a profile share.
deleteProfileShare
in interface AWSWellArchitected
deleteProfileShareRequest
- 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.public DeleteReviewTemplateResult deleteReviewTemplate(DeleteReviewTemplateRequest request)
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.
deleteReviewTemplate
in interface AWSWellArchitected
deleteReviewTemplateRequest
- 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.public DeleteTemplateShareResult deleteTemplateShare(DeleteTemplateShareRequest request)
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.
deleteTemplateShare
in interface AWSWellArchitected
deleteTemplateShareRequest
- 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.public DeleteWorkloadResult deleteWorkload(DeleteWorkloadRequest request)
Delete an existing workload.
deleteWorkload
in interface AWSWellArchitected
deleteWorkloadRequest
- Input for workload deletion.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.public DeleteWorkloadShareResult deleteWorkloadShare(DeleteWorkloadShareRequest request)
Delete a workload share.
deleteWorkloadShare
in interface AWSWellArchitected
deleteWorkloadShareRequest
- Input for Delete Workload ShareValidationException
- 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.public DisassociateLensesResult disassociateLenses(DisassociateLensesRequest request)
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.
disassociateLenses
in interface AWSWellArchitected
disassociateLensesRequest
- Input to disassociate lens reviews.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.public DisassociateProfilesResult disassociateProfiles(DisassociateProfilesRequest request)
Disassociate a profile from a workload.
disassociateProfiles
in interface AWSWellArchitected
disassociateProfilesRequest
- 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.public ExportLensResult exportLens(ExportLensRequest request)
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.
exportLens
in interface AWSWellArchitected
exportLensRequest
- 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.public GetAnswerResult getAnswer(GetAnswerRequest request)
Get the answer to a specific question in a workload review.
getAnswer
in interface AWSWellArchitected
getAnswerRequest
- Input to get answer.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.public GetConsolidatedReportResult getConsolidatedReport(GetConsolidatedReportRequest request)
Get a consolidated report of your workloads.
You can optionally choose to include workloads that have been shared with you.
getConsolidatedReport
in interface AWSWellArchitected
getConsolidatedReportRequest
- 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.public GetGlobalSettingsResult getGlobalSettings(GetGlobalSettingsRequest request)
Global settings for all workloads.
getGlobalSettings
in interface AWSWellArchitected
getGlobalSettingsRequest
- 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.public GetLensResult getLens(GetLensRequest request)
Get an existing lens.
getLens
in interface AWSWellArchitected
getLensRequest
- 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.public GetLensReviewResult getLensReview(GetLensReviewRequest request)
Get lens review.
getLensReview
in interface AWSWellArchitected
getLensReviewRequest
- Input to get lens review.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.public GetLensReviewReportResult getLensReviewReport(GetLensReviewReportRequest request)
Get lens review report.
getLensReviewReport
in interface AWSWellArchitected
getLensReviewReportRequest
- Input to get lens review report.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.public GetLensVersionDifferenceResult getLensVersionDifference(GetLensVersionDifferenceRequest request)
Get lens version differences.
getLensVersionDifference
in interface AWSWellArchitected
getLensVersionDifferenceRequest
- 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.public GetMilestoneResult getMilestone(GetMilestoneRequest request)
Get a milestone for an existing workload.
getMilestone
in interface AWSWellArchitected
getMilestoneRequest
- Input to get a milestone.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.public GetProfileResult getProfile(GetProfileRequest request)
Get profile information.
getProfile
in interface AWSWellArchitected
getProfileRequest
- 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.public GetProfileTemplateResult getProfileTemplate(GetProfileTemplateRequest request)
Get profile template.
getProfileTemplate
in interface AWSWellArchitected
getProfileTemplateRequest
- 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.public GetReviewTemplateResult getReviewTemplate(GetReviewTemplateRequest request)
Get review template.
getReviewTemplate
in interface AWSWellArchitected
getReviewTemplateRequest
- 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.public GetReviewTemplateAnswerResult getReviewTemplateAnswer(GetReviewTemplateAnswerRequest request)
Get review template answer.
getReviewTemplateAnswer
in interface AWSWellArchitected
getReviewTemplateAnswerRequest
- 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.public GetReviewTemplateLensReviewResult getReviewTemplateLensReview(GetReviewTemplateLensReviewRequest request)
Get a lens review associated with a review template.
getReviewTemplateLensReview
in interface AWSWellArchitected
getReviewTemplateLensReviewRequest
- 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.public GetWorkloadResult getWorkload(GetWorkloadRequest request)
Get an existing workload.
getWorkload
in interface AWSWellArchitected
getWorkloadRequest
- Input to get a workload.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.public ImportLensResult importLens(ImportLensRequest request)
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.
importLens
in interface AWSWellArchitected
importLensRequest
- 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.public ListAnswersResult listAnswers(ListAnswersRequest request)
List of answers for a particular workload and lens.
listAnswers
in interface AWSWellArchitected
listAnswersRequest
- Input to list answers.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.public ListCheckDetailsResult listCheckDetails(ListCheckDetailsRequest request)
List of Trusted Advisor check details by account related to the workload.
listCheckDetails
in interface AWSWellArchitected
listCheckDetailsRequest
- 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.public ListCheckSummariesResult listCheckSummaries(ListCheckSummariesRequest request)
List of Trusted Advisor checks summarized for all accounts related to the workload.
listCheckSummaries
in interface AWSWellArchitected
listCheckSummariesRequest
- 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.public ListLensReviewImprovementsResult listLensReviewImprovements(ListLensReviewImprovementsRequest request)
List the improvements of a particular lens review.
listLensReviewImprovements
in interface AWSWellArchitected
listLensReviewImprovementsRequest
- Input to list lens review improvements.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.public ListLensReviewsResult listLensReviews(ListLensReviewsRequest request)
List lens reviews for a particular workload.
listLensReviews
in interface AWSWellArchitected
listLensReviewsRequest
- Input to list lens reviews.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.public ListLensSharesResult listLensShares(ListLensSharesRequest request)
List the lens shares associated with the lens.
listLensShares
in interface AWSWellArchitected
listLensSharesRequest
- 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.public ListLensesResult listLenses(ListLensesRequest request)
List the available lenses.
listLenses
in interface AWSWellArchitected
listLensesRequest
- Input to list lenses.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.public ListMilestonesResult listMilestones(ListMilestonesRequest request)
List all milestones for an existing workload.
listMilestones
in interface AWSWellArchitected
listMilestonesRequest
- Input to list all milestones for a workload.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.public ListNotificationsResult listNotifications(ListNotificationsRequest request)
List lens notifications.
listNotifications
in interface AWSWellArchitected
listNotificationsRequest
- 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.public ListProfileNotificationsResult listProfileNotifications(ListProfileNotificationsRequest request)
List profile notifications.
listProfileNotifications
in interface AWSWellArchitected
listProfileNotificationsRequest
- 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.public ListProfileSharesResult listProfileShares(ListProfileSharesRequest request)
List profile shares.
listProfileShares
in interface AWSWellArchitected
listProfileSharesRequest
- 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.public ListProfilesResult listProfiles(ListProfilesRequest request)
List profiles.
listProfiles
in interface AWSWellArchitected
listProfilesRequest
- 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.public ListReviewTemplateAnswersResult listReviewTemplateAnswers(ListReviewTemplateAnswersRequest request)
List the answers of a review template.
listReviewTemplateAnswers
in interface AWSWellArchitected
listReviewTemplateAnswersRequest
- 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.public ListReviewTemplatesResult listReviewTemplates(ListReviewTemplatesRequest request)
List review templates.
listReviewTemplates
in interface AWSWellArchitected
listReviewTemplatesRequest
- 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.public ListShareInvitationsResult listShareInvitations(ListShareInvitationsRequest request)
List the share invitations.
WorkloadNamePrefix
, LensNamePrefix
, ProfileNamePrefix
, and
TemplateNamePrefix
are mutually exclusive. Use the parameter that matches your
ShareResourceType
.
listShareInvitations
in interface AWSWellArchitected
listShareInvitationsRequest
- Input for List Share InvitationsValidationException
- 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.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
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.
listTagsForResource
in interface AWSWellArchitected
listTagsForResourceRequest
- InternalServerException
- There is a problem with the Well-Architected Tool API service.ResourceNotFoundException
- The requested resource was not found.public ListTemplateSharesResult listTemplateShares(ListTemplateSharesRequest request)
List review template shares.
listTemplateShares
in interface AWSWellArchitected
listTemplateSharesRequest
- 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.public ListWorkloadSharesResult listWorkloadShares(ListWorkloadSharesRequest request)
List the workload shares associated with the workload.
listWorkloadShares
in interface AWSWellArchitected
listWorkloadSharesRequest
- Input for List Workload ShareValidationException
- 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.public ListWorkloadsResult listWorkloads(ListWorkloadsRequest request)
Paginated list of workloads.
listWorkloads
in interface AWSWellArchitected
listWorkloadsRequest
- Input to list all workloads.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.public TagResourceResult tagResource(TagResourceRequest request)
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.
tagResource
in interface AWSWellArchitected
tagResourceRequest
- InternalServerException
- There is a problem with the Well-Architected Tool API service.ResourceNotFoundException
- The requested resource was not found.public UntagResourceResult untagResource(UntagResourceRequest request)
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
untagResource
in interface AWSWellArchitected
untagResourceRequest
- InternalServerException
- There is a problem with the Well-Architected Tool API service.ResourceNotFoundException
- The requested resource was not found.public UpdateAnswerResult updateAnswer(UpdateAnswerRequest request)
Update the answer to a specific question in a workload review.
updateAnswer
in interface AWSWellArchitected
updateAnswerRequest
- Input to update answer.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.public UpdateGlobalSettingsResult updateGlobalSettings(UpdateGlobalSettingsRequest request)
Update whether the Amazon Web Services account is opted into organization sharing and discovery integration features.
updateGlobalSettings
in interface AWSWellArchitected
updateGlobalSettingsRequest
- 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.public UpdateIntegrationResult updateIntegration(UpdateIntegrationRequest request)
Update integration features.
updateIntegration
in interface AWSWellArchitected
updateIntegrationRequest
- 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.public UpdateLensReviewResult updateLensReview(UpdateLensReviewRequest request)
Update lens review for a particular workload.
updateLensReview
in interface AWSWellArchitected
updateLensReviewRequest
- Input for update lens review.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.public UpdateProfileResult updateProfile(UpdateProfileRequest request)
Update a profile.
updateProfile
in interface AWSWellArchitected
updateProfileRequest
- 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.public UpdateReviewTemplateResult updateReviewTemplate(UpdateReviewTemplateRequest request)
Update a review template.
updateReviewTemplate
in interface AWSWellArchitected
updateReviewTemplateRequest
- 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.public UpdateReviewTemplateAnswerResult updateReviewTemplateAnswer(UpdateReviewTemplateAnswerRequest request)
Update a review template answer.
updateReviewTemplateAnswer
in interface AWSWellArchitected
updateReviewTemplateAnswerRequest
- 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.public UpdateReviewTemplateLensReviewResult updateReviewTemplateLensReview(UpdateReviewTemplateLensReviewRequest request)
Update a lens review associated with a review template.
updateReviewTemplateLensReview
in interface AWSWellArchitected
updateReviewTemplateLensReviewRequest
- 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.public UpdateShareInvitationResult updateShareInvitation(UpdateShareInvitationRequest request)
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.
updateShareInvitation
in interface AWSWellArchitected
updateShareInvitationRequest
- Input for Update Share InvitationValidationException
- 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.public UpdateWorkloadResult updateWorkload(UpdateWorkloadRequest request)
Update an existing workload.
updateWorkload
in interface AWSWellArchitected
updateWorkloadRequest
- Input to update a workload.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.public UpdateWorkloadShareResult updateWorkloadShare(UpdateWorkloadShareRequest request)
Update a workload share.
updateWorkloadShare
in interface AWSWellArchitected
updateWorkloadShareRequest
- Input for Update Workload ShareValidationException
- 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.public UpgradeLensReviewResult upgradeLensReview(UpgradeLensReviewRequest request)
Upgrade lens review for a particular workload.
upgradeLensReview
in interface AWSWellArchitected
upgradeLensReviewRequest
- 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.public UpgradeProfileVersionResult upgradeProfileVersion(UpgradeProfileVersionRequest request)
Upgrade a profile.
upgradeProfileVersion
in interface AWSWellArchitected
upgradeProfileVersionRequest
- 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.public UpgradeReviewTemplateLensReviewResult upgradeReviewTemplateLensReview(UpgradeReviewTemplateLensReviewRequest request)
Upgrade the lens review of a review template.
upgradeReviewTemplateLensReview
in interface AWSWellArchitected
upgradeReviewTemplateLensReviewRequest
- 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.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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 the request.
getCachedResponseMetadata
in interface AWSWellArchitected
request
- The originally executed requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AWSWellArchitected
shutdown
in class AmazonWebServiceClient