com.amazonaws.services.wellarchitected

Interface AWSWellArchitected

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.

AWS Well-Architected Tool

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.

Managing workloads:

• CreateWorkload: Define a new workload.

• ListWorkloads: List workloads.

• GetWorkload: Get the properties of a workload.

• UpdateWorkload: Update the properties of a workload.

• DeleteWorkload: Delete a workload.

Managing milestones:

• CreateMilestone: Create a milestone.

• ListMilestones: List milestones.

• GetMilestone: Get the properties of a milestone.

Managing lenses:

• ListLenses: List the available lenses.

• AssociateLenses: Add one or more lenses to a workload.

• DisassociateLenses: Remove one or more lenses from a workload.

• ListNotifications: List lens notifications for a workload.

• GetLensVersionDifference: Get the differences between the version of a lens used in a workload and the latest version.

• UpgradeLensReview: Upgrade a workload to use the latest version of a lens.

Managing reviews:

• ListLensReviews: List reviews associated with a workload.

• GetLensReview: Get pillar and risk data associated with a workload review.

• GetLensReviewReport: Get the report associated with a workload review.

• UpdateLensReview: Update the notes associated with a workload review.

• ListAnswers: List the questions and answers in a workload review.

• UpdateAnswer: Update the answer to a specific question in a workload review.

• ListLensReviewImprovements: List the improvement plan associated with a workload review.

Managing workload shares:

• ListWorkloadShares: List the workload shares associated with a workload.

• CreateWorkloadShare: Create a workload share.

• UpdateWorkloadShare: Update a workload share.

• DeleteWorkloadShare: Delete a workload share.

Managing workload share invitations:

• ListShareInvitations: List workload share invitations.

• UpdateShareInvitation: Update a workload share invitation.

For information about the AWS Well-Architected Tool, see the AWS 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.

Method Summary

Modifier and Type	Method and Description
AssociateLensesResult	associateLenses(AssociateLensesRequest associateLensesRequest) Associate a lens to a workload.
CreateMilestoneResult	createMilestone(CreateMilestoneRequest createMilestoneRequest) Create a milestone for an existing workload.
CreateWorkloadResult	createWorkload(CreateWorkloadRequest createWorkloadRequest) Create a new workload.
CreateWorkloadShareResult	createWorkloadShare(CreateWorkloadShareRequest createWorkloadShareRequest) Create a workload 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.
GetAnswerResult	getAnswer(GetAnswerRequest getAnswerRequest) Get lens 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.
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.
GetWorkloadResult	getWorkload(GetWorkloadRequest getWorkloadRequest) Get an existing workload.
ListAnswersResult	listAnswers(ListAnswersRequest listAnswersRequest) List of answers.
ListLensesResult	listLenses(ListLensesRequest listLensesRequest) List the available lenses.
ListLensReviewImprovementsResult	listLensReviewImprovements(ListLensReviewImprovementsRequest listLensReviewImprovementsRequest) List lens review improvements.
ListLensReviewsResult	listLensReviews(ListLensReviewsRequest listLensReviewsRequest) List lens reviews.
ListMilestonesResult	listMilestones(ListMilestonesRequest listMilestonesRequest) List all milestones for an existing workload.
ListNotificationsResult	listNotifications(ListNotificationsRequest listNotificationsRequest) List lens notifications.
ListShareInvitationsResult	listShareInvitations(ListShareInvitationsRequest listShareInvitationsRequest) List the workload invitations.
ListWorkloadsResult	listWorkloads(ListWorkloadsRequest listWorkloadsRequest) List 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.
UpdateAnswerResult	updateAnswer(UpdateAnswerRequest updateAnswerRequest) Update the answer.
UpdateLensReviewResult	updateLensReview(UpdateLensReviewRequest updateLensReviewRequest) Update lens review.
UpdateShareInvitationResult	updateShareInvitation(UpdateShareInvitationRequest updateShareInvitationRequest) Update a workload invitation.
UpdateWorkloadResult	updateWorkload(UpdateWorkloadRequest updateWorkloadRequest) Update an existing workload.
UpdateWorkloadShareResult	updateWorkloadShare(UpdateWorkloadShareRequest updateWorkloadShareRequest) Update a workload share.
UpgradeLensReviewResult	upgradeLensReview(UpgradeLensReviewRequest upgradeLensReviewRequest) Upgrade lens review.

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.

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 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.

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 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.

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 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.

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 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.

See Also:

AWS API Documentation

createWorkloadShare

CreateWorkloadShareResult createWorkloadShare(CreateWorkloadShareRequest createWorkloadShareRequest)

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.

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 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.

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 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.

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 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.

See Also:

AWS API Documentation

disassociateLenses

DisassociateLensesResult disassociateLenses(DisassociateLensesRequest disassociateLensesRequest)

Disassociate a lens from a workload.

The AWS 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 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.

See Also:

AWS API Documentation

getAnswer

GetAnswerResult getAnswer(GetAnswerRequest getAnswerRequest)

Get lens 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 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.

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 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.

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 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.

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 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.

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 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.

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 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.

See Also:

AWS API Documentation

listAnswers

ListAnswersResult listAnswers(ListAnswersRequest listAnswersRequest)

List of answers.

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 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.

See Also:

AWS API Documentation

listLensReviewImprovements

ListLensReviewImprovementsResult listLensReviewImprovements(ListLensReviewImprovementsRequest listLensReviewImprovementsRequest)

List lens review improvements.

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 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.

See Also:

AWS API Documentation

listLensReviews

ListLensReviewsResult listLensReviews(ListLensReviewsRequest listLensReviewsRequest)

List lens reviews.

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 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.

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 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.

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 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.

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 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.

See Also:

AWS API Documentation

listShareInvitations

ListShareInvitationsResult listShareInvitations(ListShareInvitationsRequest listShareInvitationsRequest)

List the workload invitations.

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 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.

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 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.

See Also:

AWS API Documentation

listWorkloads

ListWorkloadsResult listWorkloads(ListWorkloadsRequest listWorkloadsRequest)

List workloads. Paginated.

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 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.

See Also:

AWS API Documentation

updateAnswer

UpdateAnswerResult updateAnswer(UpdateAnswerRequest updateAnswerRequest)

Update the answer.

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 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.

See Also:

AWS API Documentation

updateLensReview

UpdateLensReviewResult updateLensReview(UpdateLensReviewRequest updateLensReviewRequest)

Update lens review.

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 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.

See Also:

AWS API Documentation

updateShareInvitation

UpdateShareInvitationResult updateShareInvitation(UpdateShareInvitationRequest updateShareInvitationRequest)

Update a workload invitation.

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 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.

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 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.

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 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.

See Also:

AWS API Documentation

upgradeLensReview

UpgradeLensReviewResult upgradeLensReview(UpgradeLensReviewRequest upgradeLensReviewRequest)

Upgrade lens review.

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 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.

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.