@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSWellArchitectedClient extends AmazonWebServiceClient implements AWSWellArchitected
This is the AWS Well-Architected Tool API Reference. The AWS Well-Architected Tool API provides programmatic access to the AWS Well-Architected Tool in the AWS Management Console. For information about the AWS Well-Architected Tool, see the AWS 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.
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 already exists.InternalServerException
- There is a problem with the AWS 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 already exists.InternalServerException
- There is a problem with the AWS 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 AWS accounts and IAM users in the same AWS Region. Only the owner of a workload can delete it.
For more information, see Defining a Workload in the AWS Well-Architected Tool User Guide.
createWorkload
in interface AWSWellArchitected
createWorkloadRequest
- Input for workload creation.ValidationException
- The user input is not valid.ConflictException
- The resource already exists.ServiceQuotaExceededException
- The user has reached their resource quota.InternalServerException
- There is a problem with the AWS 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 CreateWorkloadShareResult createWorkloadShare(CreateWorkloadShareRequest request)
Create a workload share.
The owner of a workload can share it with other AWS accounts and IAM users in the same AWS Region. Shared access to a workload is not removed until the workload invitation is deleted.
For more information, see Sharing a Workload in the AWS Well-Architected Tool User Guide.
createWorkloadShare
in interface AWSWellArchitected
createWorkloadShareRequest
- Input for Create Workload ShareValidationException
- The user input is not valid.ConflictException
- The resource already exists.InternalServerException
- There is a problem with the AWS 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 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 already exists.InternalServerException
- There is a problem with the AWS 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 AWS Well-Architected Tool API service.ResourceNotFoundException
- The requested resource was not found.ConflictException
- The resource already exists.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.
The AWS 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 already exists.InternalServerException
- There is a problem with the AWS 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 lens 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 AWS 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 AWS 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 AWS 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 AWS 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 AWS 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 AWS 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.
listAnswers
in interface AWSWellArchitected
listAnswersRequest
- Input to list answers.ValidationException
- The user input is not valid.InternalServerException
- There is a problem with the AWS 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 ListLensReviewImprovementsResult listLensReviewImprovements(ListLensReviewImprovementsRequest request)
List lens review improvements.
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 AWS 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.
listLensReviews
in interface AWSWellArchitected
listLensReviewsRequest
- Input to list lens reviews.ValidationException
- The user input is not valid.InternalServerException
- There is a problem with the AWS 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 AWS 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 AWS 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 AWS 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 workload invitations.
listShareInvitations
in interface AWSWellArchitected
listShareInvitationsRequest
- Input for List Share InvitationsValidationException
- The user input is not valid.InternalServerException
- There is a problem with the AWS 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.
listTagsForResource
in interface AWSWellArchitected
listTagsForResourceRequest
- InternalServerException
- There is a problem with the AWS Well-Architected Tool API service.ResourceNotFoundException
- The requested resource was not found.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 AWS 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)
List workloads. Paginated.
listWorkloads
in interface AWSWellArchitected
listWorkloadsRequest
- Input to list all workloads.ValidationException
- The user input is not valid.InternalServerException
- There is a problem with the AWS 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.
tagResource
in interface AWSWellArchitected
tagResourceRequest
- InternalServerException
- There is a problem with the AWS Well-Architected Tool API service.ResourceNotFoundException
- The requested resource was not found.public UntagResourceResult untagResource(UntagResourceRequest request)
Deletes specified tags from a resource.
untagResource
in interface AWSWellArchitected
untagResourceRequest
- InternalServerException
- There is a problem with the AWS 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 already exists.InternalServerException
- There is a problem with the AWS 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 UpdateLensReviewResult updateLensReview(UpdateLensReviewRequest request)
Update lens review.
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 already exists.InternalServerException
- There is a problem with the AWS 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 invitation.
updateShareInvitation
in interface AWSWellArchitected
updateShareInvitationRequest
- Input for Update Share InvitationValidationException
- The user input is not valid.InternalServerException
- There is a problem with the AWS Well-Architected Tool API service.ResourceNotFoundException
- The requested resource was not found.ConflictException
- The resource already exists.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 already exists.InternalServerException
- There is a problem with the AWS 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 AWS Well-Architected Tool API service.ResourceNotFoundException
- The requested resource was not found.ConflictException
- The resource already exists.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.
upgradeLensReview
in interface AWSWellArchitected
upgradeLensReviewRequest
- ValidationException
- The user input is not valid.ResourceNotFoundException
- The requested resource was not found.ConflictException
- The resource already exists.InternalServerException
- There is a problem with the AWS 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