com.amazonaws.services.wellarchitected

Class AWSWellArchitectedClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.wellarchitected.AWSWellArchitectedClient

All Implemented Interfaces:

AWSWellArchitected

Direct Known Subclasses:

AWSWellArchitectedAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSWellArchitectedClient
extends AmazonWebServiceClient
implements AWSWellArchitected

Client for accessing Well-Architected. All service calls made using this client are blocking, and will not return until the service call completes.

Well-Architected Tool

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

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.wellarchitected.AWSWellArchitected

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
AssociateLensesResult	associateLenses(AssociateLensesRequest request) Associate a lens to a workload.
static AWSWellArchitectedClientBuilder	builder()
CreateLensShareResult	createLensShare(CreateLensShareRequest request) Create a lens share.
CreateLensVersionResult	createLensVersion(CreateLensVersionRequest request) Create a new lens version.
CreateMilestoneResult	createMilestone(CreateMilestoneRequest request) Create a milestone for an existing workload.
CreateWorkloadResult	createWorkload(CreateWorkloadRequest request) Create a new workload.
CreateWorkloadShareResult	createWorkloadShare(CreateWorkloadShareRequest request) Create a workload share.
DeleteLensResult	deleteLens(DeleteLensRequest request) Delete an existing lens.
DeleteLensShareResult	deleteLensShare(DeleteLensShareRequest request) Delete a lens share.
DeleteWorkloadResult	deleteWorkload(DeleteWorkloadRequest request) Delete an existing workload.
DeleteWorkloadShareResult	deleteWorkloadShare(DeleteWorkloadShareRequest request) Delete a workload share.
DisassociateLensesResult	disassociateLenses(DisassociateLensesRequest request) Disassociate a lens from a workload.
ExportLensResult	exportLens(ExportLensRequest request) Export an existing lens.
GetAnswerResult	getAnswer(GetAnswerRequest request) Get the answer to a specific question in a workload review.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
GetLensResult	getLens(GetLensRequest request) Get an existing lens.
GetLensReviewResult	getLensReview(GetLensReviewRequest request) Get lens review.
GetLensReviewReportResult	getLensReviewReport(GetLensReviewReportRequest request) Get lens review report.
GetLensVersionDifferenceResult	getLensVersionDifference(GetLensVersionDifferenceRequest request) Get lens version differences.
GetMilestoneResult	getMilestone(GetMilestoneRequest request) Get a milestone for an existing workload.
GetWorkloadResult	getWorkload(GetWorkloadRequest request) Get an existing workload.
ImportLensResult	importLens(ImportLensRequest request) Import a new lens.
ListAnswersResult	listAnswers(ListAnswersRequest request) List of answers.
ListLensesResult	listLenses(ListLensesRequest request) List the available lenses.
ListLensReviewImprovementsResult	listLensReviewImprovements(ListLensReviewImprovementsRequest request) List lens review improvements.
ListLensReviewsResult	listLensReviews(ListLensReviewsRequest request) List lens reviews.
ListLensSharesResult	listLensShares(ListLensSharesRequest request) List the lens shares associated with the lens.
ListMilestonesResult	listMilestones(ListMilestonesRequest request) List all milestones for an existing workload.
ListNotificationsResult	listNotifications(ListNotificationsRequest request) List lens notifications.
ListShareInvitationsResult	listShareInvitations(ListShareInvitationsRequest request) List the workload invitations.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) List the tags for a resource.
ListWorkloadsResult	listWorkloads(ListWorkloadsRequest request) List workloads.
ListWorkloadSharesResult	listWorkloadShares(ListWorkloadSharesRequest request) List the workload shares associated with the workload.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest request) Adds one or more tags to the specified resource.
UntagResourceResult	untagResource(UntagResourceRequest request) Deletes specified tags from a resource.
UpdateAnswerResult	updateAnswer(UpdateAnswerRequest request) Update the answer to a specific question in a workload review.
UpdateGlobalSettingsResult	updateGlobalSettings(UpdateGlobalSettingsRequest request) Updates whether the Amazon Web Services account is opted into organization sharing features.
UpdateLensReviewResult	updateLensReview(UpdateLensReviewRequest request) Update lens review.
UpdateShareInvitationResult	updateShareInvitation(UpdateShareInvitationRequest request) Update a workload invitation.
UpdateWorkloadResult	updateWorkload(UpdateWorkloadRequest request) Update an existing workload.
UpdateWorkloadShareResult	updateWorkloadShare(UpdateWorkloadShareRequest request) Update a workload share.
UpgradeLensReviewResult	upgradeLensReview(UpgradeLensReviewRequest request) Upgrade lens review.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AWSWellArchitectedClientBuilder builder()

associateLenses

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.

Specified by:

associateLenses in interface AWSWellArchitected

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 Well-Architected Tool API service.

AccessDeniedException - User does not have sufficient access to perform this action.

ThrottlingException - Request was denied due to request throttling.

See Also:

AWS API Documentation

createLensShare

public CreateLensShareResult createLensShare(CreateLensShareRequest request)

Create a lens share.

The owner of a lens can share it with other Amazon Web Services accounts and IAM users in the same Amazon Web Services Region. Shared access to a lens is not removed until the lens invitation is deleted.

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.

Specified by:

createLensShare in interface AWSWellArchitected

Parameters:

createLensShareRequest -

Returns:

Result of the CreateLensShare 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 Well-Architected Tool API service.

ResourceNotFoundException - The requested resource was not found.

ServiceQuotaExceededException - The user has reached their resource quota.

AccessDeniedException - User does not have sufficient access to perform this action.

ThrottlingException - Request was denied due to request throttling.

See Also:

AWS API Documentation

createLensVersion

public CreateLensVersionResult createLensVersion(CreateLensVersionRequest request)

Create a new lens version.

A lens can have up to 100 versions.

After a lens has been imported, create a new lens version to publish it. The owner of a lens can share the lens with other Amazon Web Services accounts and IAM users in the same Amazon Web Services Region. Only the owner of a lens can delete it.

Specified by:

createLensVersion in interface AWSWellArchitected

Parameters:

createLensVersionRequest -

Returns:

Result of the CreateLensVersion operation returned by the service.

Throws:

ValidationException - The user input is not valid.

ResourceNotFoundException - The requested resource was not found.

ServiceQuotaExceededException - The user has reached their resource quota.

ConflictException - The resource already exists.

InternalServerException - There is a problem with the Well-Architected Tool API service.

AccessDeniedException - User does not have sufficient access to perform this action.

ThrottlingException - Request was denied due to request throttling.

See Also:

AWS API Documentation

createMilestone

public CreateMilestoneResult createMilestone(CreateMilestoneRequest request)

Create a milestone for an existing workload.

Specified by:

createMilestone in interface AWSWellArchitected

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

public CreateWorkloadResult createWorkload(CreateWorkloadRequest request)

Create a new workload.

The owner of a workload can share the workload with other Amazon Web Services accounts and IAM users 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.

Specified by:

createWorkload in interface AWSWellArchitected

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

public CreateWorkloadShareResult createWorkloadShare(CreateWorkloadShareRequest request)

Create a workload share.

The owner of a workload can share it with other Amazon Web Services accounts and IAM users in the same Amazon Web Services Region. Shared access to a workload is not removed until the workload invitation is deleted.

For more information, see Sharing a Workload in the Well-Architected Tool User Guide.

Specified by:

createWorkloadShare in interface AWSWellArchitected

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 Well-Architected Tool API service.

ResourceNotFoundException - The requested resource was not found.

ServiceQuotaExceededException - The user has reached their resource quota.

AccessDeniedException - User does not have sufficient access to perform this action.

ThrottlingException - Request was denied due to request throttling.

See Also:

AWS API Documentation

deleteLens

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

Specified by:

deleteLens in interface AWSWellArchitected

Parameters:

deleteLensRequest -

Returns:

Result of the DeleteLens operation returned by the service.

Throws:

ValidationException - The user input is not valid.

ResourceNotFoundException - The requested resource was not found.

ConflictException - The resource already exists.

InternalServerException - There is a problem with the Well-Architected Tool API service.

AccessDeniedException - User does not have sufficient access to perform this action.

ThrottlingException - Request was denied due to request throttling.

See Also:

AWS API Documentation

deleteLensShare

public DeleteLensShareResult deleteLensShare(DeleteLensShareRequest request)

Delete a lens share.

After the lens share is deleted, Amazon Web Services accounts and IAM 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.

Specified by:

deleteLensShare in interface AWSWellArchitected

Parameters:

deleteLensShareRequest -

Returns:

Result of the DeleteLensShare operation returned by the service.

Throws:

ValidationException - The user input is not valid.

InternalServerException - There is a problem with the Well-Architected Tool API service.

ResourceNotFoundException - The requested resource was not found.

ConflictException - The resource 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

deleteWorkload

public DeleteWorkloadResult deleteWorkload(DeleteWorkloadRequest request)

Delete an existing workload.

Specified by:

deleteWorkload in interface AWSWellArchitected

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

public DeleteWorkloadShareResult deleteWorkloadShare(DeleteWorkloadShareRequest request)

Delete a workload share.

Specified by:

deleteWorkloadShare in interface AWSWellArchitected

Parameters:

deleteWorkloadShareRequest - Input for Delete Workload Share

Returns:

Result of the DeleteWorkloadShare operation returned by the service.

Throws:

ValidationException - The user input is not valid.

InternalServerException - There is a problem with the Well-Architected Tool API service.

ResourceNotFoundException - The requested resource was not found.

ConflictException - The resource 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

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.

Specified by:

disassociateLenses in interface AWSWellArchitected

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 Well-Architected Tool API service.

AccessDeniedException - User does not have sufficient access to perform this action.

ThrottlingException - Request was denied due to request throttling.

See Also:

AWS API Documentation

exportLens

public ExportLensResult exportLens(ExportLensRequest request)

Export an existing lens.

Lenses are defined in JSON. For more information, see JSON format specification in the Well-Architected Tool User Guide. Only the owner of a lens can export it.

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.

Specified by:

exportLens in interface AWSWellArchitected

Parameters:

exportLensRequest -

Returns:

Result of the ExportLens operation returned by the service.

Throws:

ValidationException - The user input is not valid.

ResourceNotFoundException - The requested resource was not found.

InternalServerException - There is a problem with the Well-Architected Tool API service.

AccessDeniedException - User does not have sufficient access to perform this action.

ThrottlingException - Request was denied due to request throttling.

See Also:

AWS API Documentation

getAnswer

public GetAnswerResult getAnswer(GetAnswerRequest request)

Get the answer to a specific question in a workload review.

Specified by:

getAnswer in interface AWSWellArchitected

Parameters:

getAnswerRequest - Input to get answer.

Returns:

Result of the GetAnswer operation returned by the service.

Throws:

ValidationException - The user input is not valid.

ResourceNotFoundException - The requested resource was not found.

InternalServerException - There is a problem with the Well-Architected Tool API service.

AccessDeniedException - User does not have sufficient access to perform this action.

ThrottlingException - Request was denied due to request throttling.

See Also:

AWS API Documentation

getLens

public GetLensResult getLens(GetLensRequest request)

Get an existing lens.

Specified by:

getLens in interface AWSWellArchitected

Parameters:

getLensRequest -

Returns:

Result of the GetLens operation returned by the service.

Throws:

ValidationException - The user input is not valid.

ResourceNotFoundException - The requested resource was not found.

InternalServerException - There is a problem with the Well-Architected Tool API service.

AccessDeniedException - User does not have sufficient access to perform this action.

ThrottlingException - Request was denied due to request throttling.

See Also:

AWS API Documentation

getLensReview

public GetLensReviewResult getLensReview(GetLensReviewRequest request)

Get lens review.

Specified by:

getLensReview in interface AWSWellArchitected

Parameters:

getLensReviewRequest - Input to get lens review.

Returns:

Result of the GetLensReview operation returned by the service.

Throws:

ValidationException - The user input is not valid.

ResourceNotFoundException - The requested resource was not found.

InternalServerException - There is a problem with the Well-Architected Tool API service.

AccessDeniedException - User does not have sufficient access to perform this action.

ThrottlingException - Request was denied due to request throttling.

See Also:

AWS API Documentation

getLensReviewReport

public GetLensReviewReportResult getLensReviewReport(GetLensReviewReportRequest request)

Get lens review report.

Specified by:

getLensReviewReport in interface AWSWellArchitected

Parameters:

getLensReviewReportRequest - Input to get lens review report.

Returns:

Result of the GetLensReviewReport operation returned by the service.

Throws:

ValidationException - The user input is not valid.

ResourceNotFoundException - The requested resource was not found.

InternalServerException - There is a problem with the Well-Architected Tool API service.

AccessDeniedException - User does not have sufficient access to perform this action.

ThrottlingException - Request was denied due to request throttling.

See Also:

AWS API Documentation

getLensVersionDifference

public GetLensVersionDifferenceResult getLensVersionDifference(GetLensVersionDifferenceRequest request)

Get lens version differences.

Specified by:

getLensVersionDifference in interface AWSWellArchitected

Parameters:

getLensVersionDifferenceRequest -

Returns:

Result of the GetLensVersionDifference operation returned by the service.

Throws:

ValidationException - The user input is not valid.

ResourceNotFoundException - The requested resource was not found.

InternalServerException - There is a problem with the Well-Architected Tool API service.

AccessDeniedException - User does not have sufficient access to perform this action.

ThrottlingException - Request was denied due to request throttling.

See Also:

AWS API Documentation

getMilestone

public GetMilestoneResult getMilestone(GetMilestoneRequest request)

Get a milestone for an existing workload.

Specified by:

getMilestone in interface AWSWellArchitected

Parameters:

getMilestoneRequest - Input to get a milestone.

Returns:

Result of the GetMilestone operation returned by the service.

Throws:

ValidationException - The user input is not valid.

ResourceNotFoundException - The requested resource was not found.

InternalServerException - There is a problem with the Well-Architected Tool API service.

AccessDeniedException - User does not have sufficient access to perform this action.

ThrottlingException - Request was denied due to request throttling.

See Also:

AWS API Documentation

getWorkload

public GetWorkloadResult getWorkload(GetWorkloadRequest request)

Get an existing workload.

Specified by:

getWorkload in interface AWSWellArchitected

Parameters:

getWorkloadRequest - Input to get a workload.

Returns:

Result of the GetWorkload operation returned by the service.

Throws:

ValidationException - The user input is not valid.

ResourceNotFoundException - The requested resource was not found.

InternalServerException - There is a problem with the Well-Architected Tool API service.

AccessDeniedException - User does not have sufficient access to perform this action.

ThrottlingException - Request was denied due to request throttling.

See Also:

AWS API Documentation

importLens

public ImportLensResult importLens(ImportLensRequest request)

Import a new lens.

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.

Specified by:

importLens in interface AWSWellArchitected

Parameters:

importLensRequest -

Returns:

Result of the ImportLens operation returned by the service.

Throws:

ValidationException - The user input is not valid.

ConflictException - The resource already exists.

ResourceNotFoundException - The requested resource was not found.

ServiceQuotaExceededException - The user has reached their resource quota.

InternalServerException - There is a problem with the Well-Architected Tool API service.

AccessDeniedException - User does not have sufficient access to perform this action.

ThrottlingException - Request was denied due to request throttling.

See Also:

AWS API Documentation

listAnswers

public ListAnswersResult listAnswers(ListAnswersRequest request)

List of answers.

Specified by:

listAnswers in interface AWSWellArchitected

Parameters:

listAnswersRequest - Input to list answers.

Returns:

Result of the ListAnswers operation returned by the service.

Throws:

ValidationException - The user input is not valid.

InternalServerException - There is a problem with the Well-Architected Tool API service.

ResourceNotFoundException - The requested resource was not found.

AccessDeniedException - User does not have sufficient access to perform this action.

ThrottlingException - Request was denied due to request throttling.

See Also:

AWS API Documentation

listLensReviewImprovements

public ListLensReviewImprovementsResult listLensReviewImprovements(ListLensReviewImprovementsRequest request)

List lens review improvements.

Specified by:

listLensReviewImprovements in interface AWSWellArchitected

Parameters:

listLensReviewImprovementsRequest - Input to list lens review improvements.

Returns:

Result of the ListLensReviewImprovements operation returned by the service.

Throws:

ValidationException - The user input is not valid.

InternalServerException - There is a problem with the Well-Architected Tool API service.

ResourceNotFoundException - The requested resource was not found.

AccessDeniedException - User does not have sufficient access to perform this action.

ThrottlingException - Request was denied due to request throttling.

See Also:

AWS API Documentation

listLensReviews

public ListLensReviewsResult listLensReviews(ListLensReviewsRequest request)

List lens reviews.

Specified by:

listLensReviews in interface AWSWellArchitected

Parameters:

listLensReviewsRequest - Input to list lens reviews.

Returns:

Result of the ListLensReviews operation returned by the service.

Throws:

ValidationException - The user input is not valid.

InternalServerException - There is a problem with the Well-Architected Tool API service.

ResourceNotFoundException - The requested resource was not found.

AccessDeniedException - User does not have sufficient access to perform this action.

ThrottlingException - Request was denied due to request throttling.

See Also:

AWS API Documentation

listLensShares

public ListLensSharesResult listLensShares(ListLensSharesRequest request)

List the lens shares associated with the lens.

Specified by:

listLensShares in interface AWSWellArchitected

Parameters:

listLensSharesRequest -

Returns:

Result of the ListLensShares operation returned by the service.

Throws:

ValidationException - The user input is not valid.

InternalServerException - There is a problem with the Well-Architected Tool API service.

ResourceNotFoundException - The requested resource was not found.

AccessDeniedException - User does not have sufficient access to perform this action.

ThrottlingException - Request was denied due to request throttling.

See Also:

AWS API Documentation

listLenses

public ListLensesResult listLenses(ListLensesRequest request)

List the available lenses.

Specified by:

listLenses in interface AWSWellArchitected

Parameters:

listLensesRequest - Input to list lenses.

Returns:

Result of the ListLenses operation returned by the service.

Throws:

ValidationException - The user input is not valid.

InternalServerException - There is a problem with the Well-Architected Tool API service.

AccessDeniedException - User does not have sufficient access to perform this action.

ThrottlingException - Request was denied due to request throttling.

See Also:

AWS API Documentation

listMilestones

public ListMilestonesResult listMilestones(ListMilestonesRequest request)

List all milestones for an existing workload.

Specified by:

listMilestones in interface AWSWellArchitected

Parameters:

listMilestonesRequest - Input to list all milestones for a workload.

Returns:

Result of the ListMilestones operation returned by the service.

Throws:

ValidationException - The user input is not valid.

InternalServerException - There is a problem with the Well-Architected Tool API service.

ResourceNotFoundException - The requested resource was not found.

AccessDeniedException - User does not have sufficient access to perform this action.

ThrottlingException - Request was denied due to request throttling.

See Also:

AWS API Documentation

listNotifications

public ListNotificationsResult listNotifications(ListNotificationsRequest request)

List lens notifications.

Specified by:

listNotifications in interface AWSWellArchitected

Parameters:

listNotificationsRequest -

Returns:

Result of the ListNotifications operation returned by the service.

Throws:

ValidationException - The user input is not valid.

InternalServerException - There is a problem with the Well-Architected Tool API service.

AccessDeniedException - User does not have sufficient access to perform this action.

ThrottlingException - Request was denied due to request throttling.

See Also:

AWS API Documentation

listShareInvitations

public ListShareInvitationsResult listShareInvitations(ListShareInvitationsRequest request)

List the workload invitations.

Specified by:

listShareInvitations in interface AWSWellArchitected

Parameters:

listShareInvitationsRequest - Input for List Share Invitations

Returns:

Result of the ListShareInvitations operation returned by the service.

Throws:

ValidationException - The user input is not valid.

InternalServerException - There is a problem with the Well-Architected Tool API service.

AccessDeniedException - User does not have sufficient access to perform this action.

ThrottlingException - Request was denied due to request throttling.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

List the tags for a resource.

The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.

Specified by:

listTagsForResource in interface AWSWellArchitected

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

InternalServerException - There is a problem with the Well-Architected Tool API service.

ResourceNotFoundException - The requested resource was not found.

See Also:

AWS API Documentation

listWorkloadShares

public ListWorkloadSharesResult listWorkloadShares(ListWorkloadSharesRequest request)

List the workload shares associated with the workload.

Specified by:

listWorkloadShares in interface AWSWellArchitected

Parameters:

listWorkloadSharesRequest - Input for List Workload Share

Returns:

Result of the ListWorkloadShares operation returned by the service.

Throws:

ValidationException - The user input is not valid.

InternalServerException - There is a problem with the Well-Architected Tool API service.

ResourceNotFoundException - The requested resource was not found.

AccessDeniedException - User does not have sufficient access to perform this action.

ThrottlingException - Request was denied due to request throttling.

See Also:

AWS API Documentation

listWorkloads

public ListWorkloadsResult listWorkloads(ListWorkloadsRequest request)

List workloads. Paginated.

Specified by:

listWorkloads in interface AWSWellArchitected

Parameters:

listWorkloadsRequest - Input to list all workloads.

Returns:

Result of the ListWorkloads operation returned by the service.

Throws:

ValidationException - The user input is not valid.

InternalServerException - There is a problem with the Well-Architected Tool API service.

AccessDeniedException - User does not have sufficient access to perform this action.

ThrottlingException - Request was denied due to request throttling.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Adds one or more tags to the specified resource.

The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.

Specified by:

tagResource in interface AWSWellArchitected

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

InternalServerException - There is a problem with the Well-Architected Tool API service.

ResourceNotFoundException - The requested resource was not found.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Deletes specified tags from a resource.

The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.

To specify multiple tags, use separate tagKeys parameters, for example:

DELETE /tags/WorkloadArn?tagKeys=key1&tagKeys=key2

Specified by:

untagResource in interface AWSWellArchitected

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

InternalServerException - There is a problem with the Well-Architected Tool API service.

ResourceNotFoundException - The requested resource was not found.

See Also:

AWS API Documentation

updateAnswer

public UpdateAnswerResult updateAnswer(UpdateAnswerRequest request)

Update the answer to a specific question in a workload review.

Specified by:

updateAnswer in interface AWSWellArchitected

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 Well-Architected Tool API service.

AccessDeniedException - User does not have sufficient access to perform this action.

ThrottlingException - Request was denied due to request throttling.

See Also:

AWS API Documentation

updateGlobalSettings

public UpdateGlobalSettingsResult updateGlobalSettings(UpdateGlobalSettingsRequest request)

Updates whether the Amazon Web Services account is opted into organization sharing features.

Specified by:

updateGlobalSettings in interface AWSWellArchitected

Parameters:

updateGlobalSettingsRequest -

Returns:

Result of the UpdateGlobalSettings 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 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

public UpdateLensReviewResult updateLensReview(UpdateLensReviewRequest request)

Update lens review.

Specified by:

updateLensReview in interface AWSWellArchitected

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

public UpdateShareInvitationResult updateShareInvitation(UpdateShareInvitationRequest request)

Update a workload invitation.

Specified by:

updateShareInvitation in interface AWSWellArchitected

Parameters:

updateShareInvitationRequest - Input for Update Share Invitation

Returns:

Result of the UpdateShareInvitation operation returned by the service.

Throws:

ValidationException - The user input is not valid.

InternalServerException - There is a problem with the Well-Architected Tool API service.

ResourceNotFoundException - The requested resource was not found.

ConflictException - The resource 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

public UpdateWorkloadResult updateWorkload(UpdateWorkloadRequest request)

Update an existing workload.

Specified by:

updateWorkload in interface AWSWellArchitected

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

public UpdateWorkloadShareResult updateWorkloadShare(UpdateWorkloadShareRequest request)

Update a workload share.

Specified by:

updateWorkloadShare in interface AWSWellArchitected

Parameters:

updateWorkloadShareRequest - Input for Update Workload Share

Returns:

Result of the UpdateWorkloadShare operation returned by the service.

Throws:

ValidationException - The user input is not valid.

InternalServerException - There is a problem with the Well-Architected Tool API service.

ResourceNotFoundException - The requested resource was not found.

ConflictException - The resource 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

public UpgradeLensReviewResult upgradeLensReview(UpgradeLensReviewRequest request)

Upgrade lens review.

Specified by:

upgradeLensReview in interface AWSWellArchitected

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

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AWSWellArchitected

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSWellArchitected

Overrides:

shutdown in class AmazonWebServiceClient