com.amazonaws.services.wellarchitected

Class AbstractAWSWellArchitected

java.lang.Object

com.amazonaws.services.wellarchitected.AbstractAWSWellArchitected

All Implemented Interfaces:

AWSWellArchitected

Direct Known Subclasses:

AbstractAWSWellArchitectedAsync

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

Abstract implementation of AWSWellArchitected. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary

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.
AssociateProfilesResult	associateProfiles(AssociateProfilesRequest request) Associate a profile with a workload.
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.
CreateProfileResult	createProfile(CreateProfileRequest request) Create a profile.
CreateProfileShareResult	createProfileShare(CreateProfileShareRequest request) Create a profile share.
CreateReviewTemplateResult	createReviewTemplate(CreateReviewTemplateRequest request) Create a review template.
CreateTemplateShareResult	createTemplateShare(CreateTemplateShareRequest request) Create a review template share.
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.
DeleteProfileResult	deleteProfile(DeleteProfileRequest request) Delete a profile.
DeleteProfileShareResult	deleteProfileShare(DeleteProfileShareRequest request) Delete a profile share.
DeleteReviewTemplateResult	deleteReviewTemplate(DeleteReviewTemplateRequest request) Delete a review template.
DeleteTemplateShareResult	deleteTemplateShare(DeleteTemplateShareRequest request) Delete a review template 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.
DisassociateProfilesResult	disassociateProfiles(DisassociateProfilesRequest request) Disassociate a profile 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.
GetConsolidatedReportResult	getConsolidatedReport(GetConsolidatedReportRequest request) Get a consolidated report of your workloads.
GetGlobalSettingsResult	getGlobalSettings(GetGlobalSettingsRequest request) Global settings for all workloads.
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.
GetProfileResult	getProfile(GetProfileRequest request) Get profile information.
GetProfileTemplateResult	getProfileTemplate(GetProfileTemplateRequest request) Get profile template.
GetReviewTemplateResult	getReviewTemplate(GetReviewTemplateRequest request) Get review template.
GetReviewTemplateAnswerResult	getReviewTemplateAnswer(GetReviewTemplateAnswerRequest request) Get review template answer.
GetReviewTemplateLensReviewResult	getReviewTemplateLensReview(GetReviewTemplateLensReviewRequest request) Get a lens review associated with a review template.
GetWorkloadResult	getWorkload(GetWorkloadRequest request) Get an existing workload.
ImportLensResult	importLens(ImportLensRequest request) Import a new custom lens or update an existing custom lens.
ListAnswersResult	listAnswers(ListAnswersRequest request) List of answers for a particular workload and lens.
ListCheckDetailsResult	listCheckDetails(ListCheckDetailsRequest request) List of Trusted Advisor check details by account related to the workload.
ListCheckSummariesResult	listCheckSummaries(ListCheckSummariesRequest request) List of Trusted Advisor checks summarized for all accounts related to the workload.
ListLensesResult	listLenses(ListLensesRequest request) List the available lenses.
ListLensReviewImprovementsResult	listLensReviewImprovements(ListLensReviewImprovementsRequest request) List the improvements of a particular lens review.
ListLensReviewsResult	listLensReviews(ListLensReviewsRequest request) List lens reviews for a particular workload.
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.
ListProfileNotificationsResult	listProfileNotifications(ListProfileNotificationsRequest request) List profile notifications.
ListProfilesResult	listProfiles(ListProfilesRequest request) List profiles.
ListProfileSharesResult	listProfileShares(ListProfileSharesRequest request) List profile shares.
ListReviewTemplateAnswersResult	listReviewTemplateAnswers(ListReviewTemplateAnswersRequest request) List the answers of a review template.
ListReviewTemplatesResult	listReviewTemplates(ListReviewTemplatesRequest request) List review templates.
ListShareInvitationsResult	listShareInvitations(ListShareInvitationsRequest request) List the share invitations.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) List the tags for a resource.
ListTemplateSharesResult	listTemplateShares(ListTemplateSharesRequest request) List review template shares.
ListWorkloadsResult	listWorkloads(ListWorkloadsRequest request) Paginated list of 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) Update whether the Amazon Web Services account is opted into organization sharing and discovery integration features.
UpdateIntegrationResult	updateIntegration(UpdateIntegrationRequest request) Update integration features.
UpdateLensReviewResult	updateLensReview(UpdateLensReviewRequest request) Update lens review for a particular workload.
UpdateProfileResult	updateProfile(UpdateProfileRequest request) Update a profile.
UpdateReviewTemplateResult	updateReviewTemplate(UpdateReviewTemplateRequest request) Update a review template.
UpdateReviewTemplateAnswerResult	updateReviewTemplateAnswer(UpdateReviewTemplateAnswerRequest request) Update a review template answer.
UpdateReviewTemplateLensReviewResult	updateReviewTemplateLensReview(UpdateReviewTemplateLensReviewRequest request) Update a lens review associated with a review template.
UpdateShareInvitationResult	updateShareInvitation(UpdateShareInvitationRequest request) Update a workload or custom lens share invitation.
UpdateWorkloadResult	updateWorkload(UpdateWorkloadRequest request) Update an existing workload.
UpdateWorkloadShareResult	updateWorkloadShare(UpdateWorkloadShareRequest request) Update a workload share.
UpgradeLensReviewResult	upgradeLensReview(UpgradeLensReviewRequest request) Upgrade lens review for a particular workload.
UpgradeProfileVersionResult	upgradeProfileVersion(UpgradeProfileVersionRequest request) Upgrade a profile.
UpgradeReviewTemplateLensReviewResult	upgradeReviewTemplateLensReview(UpgradeReviewTemplateLensReviewRequest request) Upgrade the lens review of a review template.

Methods inherited from class java.lang.Object

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

Method Detail

associateLenses

public AssociateLensesResult associateLenses(AssociateLensesRequest request)

Description copied from interface: AWSWellArchitected

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:

request - Input to associate lens reviews.

Returns:

Result of the AssociateLenses operation returned by the service.

See Also:

AWS API Documentation

associateProfiles

public AssociateProfilesResult associateProfiles(AssociateProfilesRequest request)

Description copied from interface: AWSWellArchitected

Associate a profile with a workload.

Specified by:

associateProfiles in interface AWSWellArchitected

Returns:

Result of the AssociateProfiles operation returned by the service.

See Also:

AWS API Documentation

createLensShare

public CreateLensShareResult createLensShare(CreateLensShareRequest request)

Description copied from interface: AWSWellArchitected

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.

Specified by:

createLensShare in interface AWSWellArchitected

Returns:

Result of the CreateLensShare operation returned by the service.

See Also:

AWS API Documentation

createLensVersion

public CreateLensVersionResult createLensVersion(CreateLensVersionRequest request)

Description copied from interface: AWSWellArchitected

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.

Specified by:

createLensVersion in interface AWSWellArchitected

Returns:

Result of the CreateLensVersion operation returned by the service.

See Also:

AWS API Documentation

createMilestone

public CreateMilestoneResult createMilestone(CreateMilestoneRequest request)

Description copied from interface: AWSWellArchitected

Create a milestone for an existing workload.

Specified by:

createMilestone in interface AWSWellArchitected

Parameters:

request - Input for milestone creation.

Returns:

Result of the CreateMilestone operation returned by the service.

See Also:

AWS API Documentation

createProfile

public CreateProfileResult createProfile(CreateProfileRequest request)

Description copied from interface: AWSWellArchitected

Create a profile.

Specified by:

createProfile in interface AWSWellArchitected

Returns:

Result of the CreateProfile operation returned by the service.

See Also:

AWS API Documentation

createProfileShare

public CreateProfileShareResult createProfileShare(CreateProfileShareRequest request)

Description copied from interface: AWSWellArchitected

Create a profile share.

Specified by:

createProfileShare in interface AWSWellArchitected

Returns:

Result of the CreateProfileShare operation returned by the service.

See Also:

AWS API Documentation

createReviewTemplate

public CreateReviewTemplateResult createReviewTemplate(CreateReviewTemplateRequest request)

Description copied from interface: AWSWellArchitected

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.

Specified by:

createReviewTemplate in interface AWSWellArchitected

Returns:

Result of the CreateReviewTemplate operation returned by the service.

See Also:

AWS API Documentation

createTemplateShare

public CreateTemplateShareResult createTemplateShare(CreateTemplateShareRequest request)

Description copied from interface: AWSWellArchitected

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.

Specified by:

createTemplateShare in interface AWSWellArchitected

Returns:

Result of the CreateTemplateShare operation returned by the service.

See Also:

AWS API Documentation

createWorkload

public CreateWorkloadResult createWorkload(CreateWorkloadRequest request)

Description copied from interface: AWSWellArchitected

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

Specified by:

createWorkload in interface AWSWellArchitected

Parameters:

request - Input for workload creation.

Returns:

Result of the CreateWorkload operation returned by the service.

See Also:

AWS API Documentation

createWorkloadShare

public CreateWorkloadShareResult createWorkloadShare(CreateWorkloadShareRequest request)

Description copied from interface: AWSWellArchitected

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.

Specified by:

createWorkloadShare in interface AWSWellArchitected

Parameters:

request - Input for Create Workload Share

Returns:

Result of the CreateWorkloadShare operation returned by the service.

See Also:

AWS API Documentation

deleteLens

public DeleteLensResult deleteLens(DeleteLensRequest request)

Description copied from interface: AWSWellArchitected

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.

Specified by:

deleteLens in interface AWSWellArchitected

Returns:

Result of the DeleteLens operation returned by the service.

See Also:

AWS API Documentation

deleteLensShare

public DeleteLensShareResult deleteLensShare(DeleteLensShareRequest request)

Description copied from interface: AWSWellArchitected

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.

Specified by:

deleteLensShare in interface AWSWellArchitected

Returns:

Result of the DeleteLensShare operation returned by the service.

See Also:

AWS API Documentation

deleteProfile

public DeleteProfileResult deleteProfile(DeleteProfileRequest request)

Description copied from interface: AWSWellArchitected

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.

Specified by:

deleteProfile in interface AWSWellArchitected

Returns:

Result of the DeleteProfile operation returned by the service.

See Also:

AWS API Documentation

deleteProfileShare

public DeleteProfileShareResult deleteProfileShare(DeleteProfileShareRequest request)

Description copied from interface: AWSWellArchitected

Delete a profile share.

Specified by:

deleteProfileShare in interface AWSWellArchitected

Returns:

Result of the DeleteProfileShare operation returned by the service.

See Also:

AWS API Documentation

deleteReviewTemplate

public DeleteReviewTemplateResult deleteReviewTemplate(DeleteReviewTemplateRequest request)

Description copied from interface: AWSWellArchitected

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.

Specified by:

deleteReviewTemplate in interface AWSWellArchitected

Returns:

Result of the DeleteReviewTemplate operation returned by the service.

See Also:

AWS API Documentation

deleteTemplateShare

public DeleteTemplateShareResult deleteTemplateShare(DeleteTemplateShareRequest request)

Description copied from interface: AWSWellArchitected

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.

Specified by:

deleteTemplateShare in interface AWSWellArchitected

Returns:

Result of the DeleteTemplateShare operation returned by the service.

See Also:

AWS API Documentation

deleteWorkload

public DeleteWorkloadResult deleteWorkload(DeleteWorkloadRequest request)

Description copied from interface: AWSWellArchitected

Delete an existing workload.

Specified by:

deleteWorkload in interface AWSWellArchitected

Parameters:

request - Input for workload deletion.

Returns:

Result of the DeleteWorkload operation returned by the service.

See Also:

AWS API Documentation

deleteWorkloadShare

public DeleteWorkloadShareResult deleteWorkloadShare(DeleteWorkloadShareRequest request)

Description copied from interface: AWSWellArchitected

Delete a workload share.

Specified by:

deleteWorkloadShare in interface AWSWellArchitected

Parameters:

request - Input for Delete Workload Share

Returns:

Result of the DeleteWorkloadShare operation returned by the service.

See Also:

AWS API Documentation

disassociateLenses

public DisassociateLensesResult disassociateLenses(DisassociateLensesRequest request)

Description copied from interface: AWSWellArchitected

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:

request - Input to disassociate lens reviews.

Returns:

Result of the DisassociateLenses operation returned by the service.

See Also:

AWS API Documentation

disassociateProfiles

public DisassociateProfilesResult disassociateProfiles(DisassociateProfilesRequest request)

Description copied from interface: AWSWellArchitected

Disassociate a profile from a workload.

Specified by:

disassociateProfiles in interface AWSWellArchitected

Returns:

Result of the DisassociateProfiles operation returned by the service.

See Also:

AWS API Documentation

exportLens

public ExportLensResult exportLens(ExportLensRequest request)

Description copied from interface: AWSWellArchitected

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.

Specified by:

exportLens in interface AWSWellArchitected

Returns:

Result of the ExportLens operation returned by the service.

See Also:

AWS API Documentation

getAnswer

public GetAnswerResult getAnswer(GetAnswerRequest request)

Description copied from interface: AWSWellArchitected

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

Specified by:

getAnswer in interface AWSWellArchitected

Parameters:

request - Input to get answer.

Returns:

Result of the GetAnswer operation returned by the service.

See Also:

AWS API Documentation

getConsolidatedReport

public GetConsolidatedReportResult getConsolidatedReport(GetConsolidatedReportRequest request)

Description copied from interface: AWSWellArchitected

Get a consolidated report of your workloads.

You can optionally choose to include workloads that have been shared with you.

Specified by:

getConsolidatedReport in interface AWSWellArchitected

Returns:

Result of the GetConsolidatedReport operation returned by the service.

See Also:

AWS API Documentation

getGlobalSettings

public GetGlobalSettingsResult getGlobalSettings(GetGlobalSettingsRequest request)

Description copied from interface: AWSWellArchitected

Global settings for all workloads.

Specified by:

getGlobalSettings in interface AWSWellArchitected

Returns:

Result of the GetGlobalSettings operation returned by the service.

See Also:

AWS API Documentation

getLens

public GetLensResult getLens(GetLensRequest request)

Description copied from interface: AWSWellArchitected

Get an existing lens.

Specified by:

getLens in interface AWSWellArchitected

Returns:

Result of the GetLens operation returned by the service.

See Also:

AWS API Documentation

getLensReview

public GetLensReviewResult getLensReview(GetLensReviewRequest request)

Description copied from interface: AWSWellArchitected

Get lens review.

Specified by:

getLensReview in interface AWSWellArchitected

Parameters:

request - Input to get lens review.

Returns:

Result of the GetLensReview operation returned by the service.

See Also:

AWS API Documentation

getLensReviewReport

public GetLensReviewReportResult getLensReviewReport(GetLensReviewReportRequest request)

Description copied from interface: AWSWellArchitected

Get lens review report.

Specified by:

getLensReviewReport in interface AWSWellArchitected

Parameters:

request - Input to get lens review report.

Returns:

Result of the GetLensReviewReport operation returned by the service.

See Also:

AWS API Documentation

getLensVersionDifference

public GetLensVersionDifferenceResult getLensVersionDifference(GetLensVersionDifferenceRequest request)

Description copied from interface: AWSWellArchitected

Get lens version differences.

Specified by:

getLensVersionDifference in interface AWSWellArchitected

Returns:

Result of the GetLensVersionDifference operation returned by the service.

See Also:

AWS API Documentation

getMilestone

public GetMilestoneResult getMilestone(GetMilestoneRequest request)

Description copied from interface: AWSWellArchitected

Get a milestone for an existing workload.

Specified by:

getMilestone in interface AWSWellArchitected

Parameters:

request - Input to get a milestone.

Returns:

Result of the GetMilestone operation returned by the service.

See Also:

AWS API Documentation

getProfile

public GetProfileResult getProfile(GetProfileRequest request)

Description copied from interface: AWSWellArchitected

Get profile information.

Specified by:

getProfile in interface AWSWellArchitected

Returns:

Result of the GetProfile operation returned by the service.

See Also:

AWS API Documentation

getProfileTemplate

public GetProfileTemplateResult getProfileTemplate(GetProfileTemplateRequest request)

Description copied from interface: AWSWellArchitected

Get profile template.

Specified by:

getProfileTemplate in interface AWSWellArchitected

Returns:

Result of the GetProfileTemplate operation returned by the service.

See Also:

AWS API Documentation

getReviewTemplate

public GetReviewTemplateResult getReviewTemplate(GetReviewTemplateRequest request)

Description copied from interface: AWSWellArchitected

Get review template.

Specified by:

getReviewTemplate in interface AWSWellArchitected

Returns:

Result of the GetReviewTemplate operation returned by the service.

See Also:

AWS API Documentation

getReviewTemplateAnswer

public GetReviewTemplateAnswerResult getReviewTemplateAnswer(GetReviewTemplateAnswerRequest request)

Description copied from interface: AWSWellArchitected

Get review template answer.

Specified by:

getReviewTemplateAnswer in interface AWSWellArchitected

Returns:

Result of the GetReviewTemplateAnswer operation returned by the service.

See Also:

AWS API Documentation

getReviewTemplateLensReview

public GetReviewTemplateLensReviewResult getReviewTemplateLensReview(GetReviewTemplateLensReviewRequest request)

Description copied from interface: AWSWellArchitected

Get a lens review associated with a review template.

Specified by:

getReviewTemplateLensReview in interface AWSWellArchitected

Returns:

Result of the GetReviewTemplateLensReview operation returned by the service.

See Also:

AWS API Documentation

getWorkload

public GetWorkloadResult getWorkload(GetWorkloadRequest request)

Description copied from interface: AWSWellArchitected

Get an existing workload.

Specified by:

getWorkload in interface AWSWellArchitected

Parameters:

request - Input to get a workload.

Returns:

Result of the GetWorkload operation returned by the service.

See Also:

AWS API Documentation

importLens

public ImportLensResult importLens(ImportLensRequest request)

Description copied from interface: AWSWellArchitected

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.

Specified by:

importLens in interface AWSWellArchitected

Returns:

Result of the ImportLens operation returned by the service.

See Also:

AWS API Documentation

listAnswers

public ListAnswersResult listAnswers(ListAnswersRequest request)

Description copied from interface: AWSWellArchitected

List of answers for a particular workload and lens.

Specified by:

listAnswers in interface AWSWellArchitected

Parameters:

request - Input to list answers.

Returns:

Result of the ListAnswers operation returned by the service.

See Also:

AWS API Documentation

listCheckDetails

public ListCheckDetailsResult listCheckDetails(ListCheckDetailsRequest request)

Description copied from interface: AWSWellArchitected

List of Trusted Advisor check details by account related to the workload.

Specified by:

listCheckDetails in interface AWSWellArchitected

Returns:

Result of the ListCheckDetails operation returned by the service.

See Also:

AWS API Documentation

listCheckSummaries

public ListCheckSummariesResult listCheckSummaries(ListCheckSummariesRequest request)

Description copied from interface: AWSWellArchitected

List of Trusted Advisor checks summarized for all accounts related to the workload.

Specified by:

listCheckSummaries in interface AWSWellArchitected

Returns:

Result of the ListCheckSummaries operation returned by the service.

See Also:

AWS API Documentation

listLensReviewImprovements

public ListLensReviewImprovementsResult listLensReviewImprovements(ListLensReviewImprovementsRequest request)

Description copied from interface: AWSWellArchitected

List the improvements of a particular lens review.

Specified by:

listLensReviewImprovements in interface AWSWellArchitected

Parameters:

request - Input to list lens review improvements.

Returns:

Result of the ListLensReviewImprovements operation returned by the service.

See Also:

AWS API Documentation

listLensReviews

public ListLensReviewsResult listLensReviews(ListLensReviewsRequest request)

Description copied from interface: AWSWellArchitected

List lens reviews for a particular workload.

Specified by:

listLensReviews in interface AWSWellArchitected

Parameters:

request - Input to list lens reviews.

Returns:

Result of the ListLensReviews operation returned by the service.

See Also:

AWS API Documentation

listLensShares

public ListLensSharesResult listLensShares(ListLensSharesRequest request)

Description copied from interface: AWSWellArchitected

List the lens shares associated with the lens.

Specified by:

listLensShares in interface AWSWellArchitected

Returns:

Result of the ListLensShares operation returned by the service.

See Also:

AWS API Documentation

listLenses

public ListLensesResult listLenses(ListLensesRequest request)

Description copied from interface: AWSWellArchitected

List the available lenses.

Specified by:

listLenses in interface AWSWellArchitected

Parameters:

request - Input to list lenses.

Returns:

Result of the ListLenses operation returned by the service.

See Also:

AWS API Documentation

listMilestones

public ListMilestonesResult listMilestones(ListMilestonesRequest request)

Description copied from interface: AWSWellArchitected

List all milestones for an existing workload.

Specified by:

listMilestones in interface AWSWellArchitected

Parameters:

request - Input to list all milestones for a workload.

Returns:

Result of the ListMilestones operation returned by the service.

See Also:

AWS API Documentation

listNotifications

public ListNotificationsResult listNotifications(ListNotificationsRequest request)

Description copied from interface: AWSWellArchitected

List lens notifications.

Specified by:

listNotifications in interface AWSWellArchitected

Returns:

Result of the ListNotifications operation returned by the service.

See Also:

AWS API Documentation

listProfileNotifications

public ListProfileNotificationsResult listProfileNotifications(ListProfileNotificationsRequest request)

Description copied from interface: AWSWellArchitected

List profile notifications.

Specified by:

listProfileNotifications in interface AWSWellArchitected

Returns:

Result of the ListProfileNotifications operation returned by the service.

See Also:

AWS API Documentation

listProfileShares

public ListProfileSharesResult listProfileShares(ListProfileSharesRequest request)

Description copied from interface: AWSWellArchitected

List profile shares.

Specified by:

listProfileShares in interface AWSWellArchitected

Returns:

Result of the ListProfileShares operation returned by the service.

See Also:

AWS API Documentation

listProfiles

public ListProfilesResult listProfiles(ListProfilesRequest request)

Description copied from interface: AWSWellArchitected

List profiles.

Specified by:

listProfiles in interface AWSWellArchitected

Returns:

Result of the ListProfiles operation returned by the service.

See Also:

AWS API Documentation

listReviewTemplateAnswers

public ListReviewTemplateAnswersResult listReviewTemplateAnswers(ListReviewTemplateAnswersRequest request)

Description copied from interface: AWSWellArchitected

List the answers of a review template.

Specified by:

listReviewTemplateAnswers in interface AWSWellArchitected

Returns:

Result of the ListReviewTemplateAnswers operation returned by the service.

See Also:

AWS API Documentation

listReviewTemplates

public ListReviewTemplatesResult listReviewTemplates(ListReviewTemplatesRequest request)

Description copied from interface: AWSWellArchitected

List review templates.

Specified by:

listReviewTemplates in interface AWSWellArchitected

Returns:

Result of the ListReviewTemplates operation returned by the service.

See Also:

AWS API Documentation

listShareInvitations

public ListShareInvitationsResult listShareInvitations(ListShareInvitationsRequest request)

Description copied from interface: AWSWellArchitected

List the share invitations.

WorkloadNamePrefix, LensNamePrefix, ProfileNamePrefix, and TemplateNamePrefix are mutually exclusive. Use the parameter that matches your ShareResourceType.

Specified by:

listShareInvitations in interface AWSWellArchitected

Parameters:

request - Input for List Share Invitations

Returns:

Result of the ListShareInvitations operation returned by the service.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Description copied from interface: AWSWellArchitected

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.

Specified by:

listTagsForResource in interface AWSWellArchitected

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

AWS API Documentation

listTemplateShares

public ListTemplateSharesResult listTemplateShares(ListTemplateSharesRequest request)

Description copied from interface: AWSWellArchitected

List review template shares.

Specified by:

listTemplateShares in interface AWSWellArchitected

Returns:

Result of the ListTemplateShares operation returned by the service.

See Also:

AWS API Documentation

listWorkloadShares

public ListWorkloadSharesResult listWorkloadShares(ListWorkloadSharesRequest request)

Description copied from interface: AWSWellArchitected

List the workload shares associated with the workload.

Specified by:

listWorkloadShares in interface AWSWellArchitected

Parameters:

request - Input for List Workload Share

Returns:

Result of the ListWorkloadShares operation returned by the service.

See Also:

AWS API Documentation

listWorkloads

public ListWorkloadsResult listWorkloads(ListWorkloadsRequest request)

Description copied from interface: AWSWellArchitected

Paginated list of workloads.

Specified by:

listWorkloads in interface AWSWellArchitected

Parameters:

request - Input to list all workloads.

Returns:

Result of the ListWorkloads operation returned by the service.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Description copied from interface: AWSWellArchitected

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.

Specified by:

tagResource in interface AWSWellArchitected

Returns:

Result of the TagResource operation returned by the service.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Description copied from interface: AWSWellArchitected

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

Specified by:

untagResource in interface AWSWellArchitected

Returns:

Result of the UntagResource operation returned by the service.

See Also:

AWS API Documentation

updateAnswer

public UpdateAnswerResult updateAnswer(UpdateAnswerRequest request)

Description copied from interface: AWSWellArchitected

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

Specified by:

updateAnswer in interface AWSWellArchitected

Parameters:

request - Input to update answer.

Returns:

Result of the UpdateAnswer operation returned by the service.

See Also:

AWS API Documentation

updateGlobalSettings

public UpdateGlobalSettingsResult updateGlobalSettings(UpdateGlobalSettingsRequest request)

Description copied from interface: AWSWellArchitected

Update whether the Amazon Web Services account is opted into organization sharing and discovery integration features.

Specified by:

updateGlobalSettings in interface AWSWellArchitected

Returns:

Result of the UpdateGlobalSettings operation returned by the service.

See Also:

AWS API Documentation

updateIntegration

public UpdateIntegrationResult updateIntegration(UpdateIntegrationRequest request)

Description copied from interface: AWSWellArchitected

Update integration features.

Specified by:

updateIntegration in interface AWSWellArchitected

Returns:

Result of the UpdateIntegration operation returned by the service.

See Also:

AWS API Documentation

updateLensReview

public UpdateLensReviewResult updateLensReview(UpdateLensReviewRequest request)

Description copied from interface: AWSWellArchitected

Update lens review for a particular workload.

Specified by:

updateLensReview in interface AWSWellArchitected

Parameters:

request - Input for update lens review.

Returns:

Result of the UpdateLensReview operation returned by the service.

See Also:

AWS API Documentation

updateProfile

public UpdateProfileResult updateProfile(UpdateProfileRequest request)

Description copied from interface: AWSWellArchitected

Update a profile.

Specified by:

updateProfile in interface AWSWellArchitected

Returns:

Result of the UpdateProfile operation returned by the service.

See Also:

AWS API Documentation

updateReviewTemplate

public UpdateReviewTemplateResult updateReviewTemplate(UpdateReviewTemplateRequest request)

Description copied from interface: AWSWellArchitected

Update a review template.

Specified by:

updateReviewTemplate in interface AWSWellArchitected

Returns:

Result of the UpdateReviewTemplate operation returned by the service.

See Also:

AWS API Documentation

updateReviewTemplateAnswer

public UpdateReviewTemplateAnswerResult updateReviewTemplateAnswer(UpdateReviewTemplateAnswerRequest request)

Description copied from interface: AWSWellArchitected

Update a review template answer.

Specified by:

updateReviewTemplateAnswer in interface AWSWellArchitected

Returns:

Result of the UpdateReviewTemplateAnswer operation returned by the service.

See Also:

AWS API Documentation

updateReviewTemplateLensReview

public UpdateReviewTemplateLensReviewResult updateReviewTemplateLensReview(UpdateReviewTemplateLensReviewRequest request)

Description copied from interface: AWSWellArchitected

Update a lens review associated with a review template.

Specified by:

updateReviewTemplateLensReview in interface AWSWellArchitected

Returns:

Result of the UpdateReviewTemplateLensReview operation returned by the service.

See Also:

AWS API Documentation

updateShareInvitation

public UpdateShareInvitationResult updateShareInvitation(UpdateShareInvitationRequest request)

Description copied from interface: AWSWellArchitected

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.

Specified by:

updateShareInvitation in interface AWSWellArchitected

Parameters:

request - Input for Update Share Invitation

Returns:

Result of the UpdateShareInvitation operation returned by the service.

See Also:

AWS API Documentation

updateWorkload

public UpdateWorkloadResult updateWorkload(UpdateWorkloadRequest request)

Description copied from interface: AWSWellArchitected

Update an existing workload.

Specified by:

updateWorkload in interface AWSWellArchitected

Parameters:

request - Input to update a workload.

Returns:

Result of the UpdateWorkload operation returned by the service.

See Also:

AWS API Documentation

updateWorkloadShare

public UpdateWorkloadShareResult updateWorkloadShare(UpdateWorkloadShareRequest request)

Description copied from interface: AWSWellArchitected

Update a workload share.

Specified by:

updateWorkloadShare in interface AWSWellArchitected

Parameters:

request - Input for Update Workload Share

Returns:

Result of the UpdateWorkloadShare operation returned by the service.

See Also:

AWS API Documentation

upgradeLensReview

public UpgradeLensReviewResult upgradeLensReview(UpgradeLensReviewRequest request)

Description copied from interface: AWSWellArchitected

Upgrade lens review for a particular workload.

Specified by:

upgradeLensReview in interface AWSWellArchitected

Returns:

Result of the UpgradeLensReview operation returned by the service.

See Also:

AWS API Documentation

upgradeProfileVersion

public UpgradeProfileVersionResult upgradeProfileVersion(UpgradeProfileVersionRequest request)

Description copied from interface: AWSWellArchitected

Upgrade a profile.

Specified by:

upgradeProfileVersion in interface AWSWellArchitected

Returns:

Result of the UpgradeProfileVersion operation returned by the service.

See Also:

AWS API Documentation

upgradeReviewTemplateLensReview

public UpgradeReviewTemplateLensReviewResult upgradeReviewTemplateLensReview(UpgradeReviewTemplateLensReviewRequest request)

Description copied from interface: AWSWellArchitected

Upgrade the lens review of a review template.

Specified by:

upgradeReviewTemplateLensReview in interface AWSWellArchitected

Returns:

Result of the UpgradeReviewTemplateLensReview operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Description copied from interface: AWSWellArchitected

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.

Specified by:

shutdown in interface AWSWellArchitected

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Description copied from interface: AWSWellArchitected

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.

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.