/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.wellarchitected; import javax.annotation.Generated; import com.amazonaws.services.wellarchitected.model.*; /** * Interface for accessing Well-Architected asynchronously. Each asynchronous method will return a Java Future object * representing the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to receive * notification when an asynchronous operation completes. *
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.wellarchitected.AbstractAWSWellArchitectedAsync} instead. *
*
*
* 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. *
*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AWSWellArchitectedAsync extends 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. *
** 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. *
** Associate a profile with a workload. *
* * @param associateProfilesRequest * @return A Java Future containing the result of the AssociateProfiles operation returned by the service. * @sample AWSWellArchitectedAsync.AssociateProfiles * @see AWS API Documentation */ java.util.concurrent.Future* Associate a profile with a workload. *
* * @param associateProfilesRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the AssociateProfiles operation returned by the service. * @sample AWSWellArchitectedAsyncHandler.AssociateProfiles * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
** 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. *
** 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.
*
* 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.
*
* Create a milestone for an existing workload. *
* * @param createMilestoneRequest * Input for milestone creation. * @return A Java Future containing the result of the CreateMilestone operation returned by the service. * @sample AWSWellArchitectedAsync.CreateMilestone * @see AWS API Documentation */ java.util.concurrent.Future* Create a milestone for an existing workload. *
* * @param createMilestoneRequest * Input for milestone creation. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateMilestone operation returned by the service. * @sample AWSWellArchitectedAsyncHandler.CreateMilestone * @see AWS API Documentation */ java.util.concurrent.Future* Create a profile. *
* * @param createProfileRequest * @return A Java Future containing the result of the CreateProfile operation returned by the service. * @sample AWSWellArchitectedAsync.CreateProfile * @see AWS * API Documentation */ java.util.concurrent.Future* Create a profile. *
* * @param createProfileRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateProfile operation returned by the service. * @sample AWSWellArchitectedAsyncHandler.CreateProfile * @see AWS * API Documentation */ java.util.concurrent.Future* Create a profile share. *
* * @param createProfileShareRequest * @return A Java Future containing the result of the CreateProfileShare operation returned by the service. * @sample AWSWellArchitectedAsync.CreateProfileShare * @see AWS API Documentation */ java.util.concurrent.Future* Create a profile share. *
* * @param createProfileShareRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateProfileShare operation returned by the service. * @sample AWSWellArchitectedAsyncHandler.CreateProfileShare * @see AWS API Documentation */ java.util.concurrent.Future* 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.
*
* 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.
*
* 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. *
* * @param createWorkloadShareRequest * Input for Create Workload Share * @return A Java Future containing the result of the CreateWorkloadShare operation returned by the service. * @sample AWSWellArchitectedAsync.CreateWorkloadShare * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param createWorkloadShareRequest * Input for Create Workload Share * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateWorkloadShare operation returned by the service. * @sample AWSWellArchitectedAsyncHandler.CreateWorkloadShare * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
** 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. *
** 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. *
** 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. *
** 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. *
** 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. *
** Delete a profile share. *
* * @param deleteProfileShareRequest * @return A Java Future containing the result of the DeleteProfileShare operation returned by the service. * @sample AWSWellArchitectedAsync.DeleteProfileShare * @see AWS API Documentation */ java.util.concurrent.Future* Delete a profile share. *
* * @param deleteProfileShareRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteProfileShare operation returned by the service. * @sample AWSWellArchitectedAsyncHandler.DeleteProfileShare * @see AWS API Documentation */ java.util.concurrent.Future* Delete an existing workload. *
* * @param deleteWorkloadRequest * Input for workload deletion. * @return A Java Future containing the result of the DeleteWorkload operation returned by the service. * @sample AWSWellArchitectedAsync.DeleteWorkload * @see AWS * API Documentation */ java.util.concurrent.Future* Delete an existing workload. *
* * @param deleteWorkloadRequest * Input for workload deletion. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteWorkload operation returned by the service. * @sample AWSWellArchitectedAsyncHandler.DeleteWorkload * @see AWS * API Documentation */ java.util.concurrent.Future* Delete a workload share. *
* * @param deleteWorkloadShareRequest * Input for Delete Workload Share * @return A Java Future containing the result of the DeleteWorkloadShare operation returned by the service. * @sample AWSWellArchitectedAsync.DeleteWorkloadShare * @see AWS API Documentation */ java.util.concurrent.Future* Delete a workload share. *
* * @param deleteWorkloadShareRequest * Input for Delete Workload Share * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteWorkloadShare operation returned by the service. * @sample AWSWellArchitectedAsyncHandler.DeleteWorkloadShare * @see AWS API Documentation */ java.util.concurrent.Future* 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.
*
* 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.
*
* Disassociate a profile from a workload. *
* * @param disassociateProfilesRequest * @return A Java Future containing the result of the DisassociateProfiles operation returned by the service. * @sample AWSWellArchitectedAsync.DisassociateProfiles * @see AWS API Documentation */ java.util.concurrent.Future* Disassociate a profile from a workload. *
* * @param disassociateProfilesRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DisassociateProfiles operation returned by the service. * @sample AWSWellArchitectedAsyncHandler.DisassociateProfiles * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
** 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. *
** Get the answer to a specific question in a workload review. *
* * @param getAnswerRequest * Input to get answer. * @return A Java Future containing the result of the GetAnswer operation returned by the service. * @sample AWSWellArchitectedAsync.GetAnswer * @see AWS API * Documentation */ java.util.concurrent.Future* Get the answer to a specific question in a workload review. *
* * @param getAnswerRequest * Input to get answer. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetAnswer operation returned by the service. * @sample AWSWellArchitectedAsyncHandler.GetAnswer * @see AWS API * Documentation */ java.util.concurrent.Future* Get a consolidated report of your workloads. *
** You can optionally choose to include workloads that have been shared with you. *
* * @param getConsolidatedReportRequest * @return A Java Future containing the result of the GetConsolidatedReport operation returned by the service. * @sample AWSWellArchitectedAsync.GetConsolidatedReport * @see AWS API Documentation */ java.util.concurrent.Future* Get a consolidated report of your workloads. *
** You can optionally choose to include workloads that have been shared with you. *
* * @param getConsolidatedReportRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetConsolidatedReport operation returned by the service. * @sample AWSWellArchitectedAsyncHandler.GetConsolidatedReport * @see AWS API Documentation */ java.util.concurrent.Future* Get an existing lens. *
* * @param getLensRequest * @return A Java Future containing the result of the GetLens operation returned by the service. * @sample AWSWellArchitectedAsync.GetLens * @see AWS API * Documentation */ java.util.concurrent.Future* Get an existing lens. *
* * @param getLensRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetLens operation returned by the service. * @sample AWSWellArchitectedAsyncHandler.GetLens * @see AWS API * Documentation */ java.util.concurrent.Future* Get lens review. *
* * @param getLensReviewRequest * Input to get lens review. * @return A Java Future containing the result of the GetLensReview operation returned by the service. * @sample AWSWellArchitectedAsync.GetLensReview * @see AWS * API Documentation */ java.util.concurrent.Future* Get lens review. *
* * @param getLensReviewRequest * Input to get lens review. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetLensReview operation returned by the service. * @sample AWSWellArchitectedAsyncHandler.GetLensReview * @see AWS * API Documentation */ java.util.concurrent.Future* Get lens review report. *
* * @param getLensReviewReportRequest * Input to get lens review report. * @return A Java Future containing the result of the GetLensReviewReport operation returned by the service. * @sample AWSWellArchitectedAsync.GetLensReviewReport * @see AWS API Documentation */ java.util.concurrent.Future* Get lens review report. *
* * @param getLensReviewReportRequest * Input to get lens review report. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetLensReviewReport operation returned by the service. * @sample AWSWellArchitectedAsyncHandler.GetLensReviewReport * @see AWS API Documentation */ java.util.concurrent.Future* Get lens version differences. *
* * @param getLensVersionDifferenceRequest * @return A Java Future containing the result of the GetLensVersionDifference operation returned by the service. * @sample AWSWellArchitectedAsync.GetLensVersionDifference * @see AWS API Documentation */ java.util.concurrent.Future* Get lens version differences. *
* * @param getLensVersionDifferenceRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetLensVersionDifference operation returned by the service. * @sample AWSWellArchitectedAsyncHandler.GetLensVersionDifference * @see AWS API Documentation */ java.util.concurrent.Future* Get a milestone for an existing workload. *
* * @param getMilestoneRequest * Input to get a milestone. * @return A Java Future containing the result of the GetMilestone operation returned by the service. * @sample AWSWellArchitectedAsync.GetMilestone * @see AWS * API Documentation */ java.util.concurrent.Future* Get a milestone for an existing workload. *
* * @param getMilestoneRequest * Input to get a milestone. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetMilestone operation returned by the service. * @sample AWSWellArchitectedAsyncHandler.GetMilestone * @see AWS * API Documentation */ java.util.concurrent.Future* Get profile information. *
* * @param getProfileRequest * @return A Java Future containing the result of the GetProfile operation returned by the service. * @sample AWSWellArchitectedAsync.GetProfile * @see AWS API * Documentation */ java.util.concurrent.Future* Get profile information. *
* * @param getProfileRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetProfile operation returned by the service. * @sample AWSWellArchitectedAsyncHandler.GetProfile * @see AWS API * Documentation */ java.util.concurrent.Future* Get profile template. *
* * @param getProfileTemplateRequest * @return A Java Future containing the result of the GetProfileTemplate operation returned by the service. * @sample AWSWellArchitectedAsync.GetProfileTemplate * @see AWS API Documentation */ java.util.concurrent.Future* Get profile template. *
* * @param getProfileTemplateRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetProfileTemplate operation returned by the service. * @sample AWSWellArchitectedAsyncHandler.GetProfileTemplate * @see AWS API Documentation */ java.util.concurrent.Future* Get an existing workload. *
* * @param getWorkloadRequest * Input to get a workload. * @return A Java Future containing the result of the GetWorkload operation returned by the service. * @sample AWSWellArchitectedAsync.GetWorkload * @see AWS * API Documentation */ java.util.concurrent.Future* Get an existing workload. *
* * @param getWorkloadRequest * Input to get a workload. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetWorkload operation returned by the service. * @sample AWSWellArchitectedAsyncHandler.GetWorkload * @see AWS * API Documentation */ java.util.concurrent.Future* 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. *
** 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. *
** List of answers for a particular workload and lens. *
* * @param listAnswersRequest * Input to list answers. * @return A Java Future containing the result of the ListAnswers operation returned by the service. * @sample AWSWellArchitectedAsync.ListAnswers * @see AWS * API Documentation */ java.util.concurrent.Future* List of answers for a particular workload and lens. *
* * @param listAnswersRequest * Input to list answers. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListAnswers operation returned by the service. * @sample AWSWellArchitectedAsyncHandler.ListAnswers * @see AWS * API Documentation */ java.util.concurrent.Future* List of Trusted Advisor check details by account related to the workload. *
* * @param listCheckDetailsRequest * @return A Java Future containing the result of the ListCheckDetails operation returned by the service. * @sample AWSWellArchitectedAsync.ListCheckDetails * @see AWS API Documentation */ java.util.concurrent.Future* List of Trusted Advisor check details by account related to the workload. *
* * @param listCheckDetailsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListCheckDetails operation returned by the service. * @sample AWSWellArchitectedAsyncHandler.ListCheckDetails * @see AWS API Documentation */ java.util.concurrent.Future* List of Trusted Advisor checks summarized for all accounts related to the workload. *
* * @param listCheckSummariesRequest * @return A Java Future containing the result of the ListCheckSummaries operation returned by the service. * @sample AWSWellArchitectedAsync.ListCheckSummaries * @see AWS API Documentation */ java.util.concurrent.Future* List of Trusted Advisor checks summarized for all accounts related to the workload. *
* * @param listCheckSummariesRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListCheckSummaries operation returned by the service. * @sample AWSWellArchitectedAsyncHandler.ListCheckSummaries * @see AWS API Documentation */ java.util.concurrent.Future* List lens review improvements. *
* * @param listLensReviewImprovementsRequest * Input to list lens review improvements. * @return A Java Future containing the result of the ListLensReviewImprovements operation returned by the service. * @sample AWSWellArchitectedAsync.ListLensReviewImprovements * @see AWS API Documentation */ java.util.concurrent.Future* List lens review improvements. *
* * @param listLensReviewImprovementsRequest * Input to list lens review improvements. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListLensReviewImprovements operation returned by the service. * @sample AWSWellArchitectedAsyncHandler.ListLensReviewImprovements * @see AWS API Documentation */ java.util.concurrent.Future* List lens reviews for a particular workload. *
* * @param listLensReviewsRequest * Input to list lens reviews. * @return A Java Future containing the result of the ListLensReviews operation returned by the service. * @sample AWSWellArchitectedAsync.ListLensReviews * @see AWS API Documentation */ java.util.concurrent.Future* List lens reviews for a particular workload. *
* * @param listLensReviewsRequest * Input to list lens reviews. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListLensReviews operation returned by the service. * @sample AWSWellArchitectedAsyncHandler.ListLensReviews * @see AWS API Documentation */ java.util.concurrent.Future* List the lens shares associated with the lens. *
* * @param listLensSharesRequest * @return A Java Future containing the result of the ListLensShares operation returned by the service. * @sample AWSWellArchitectedAsync.ListLensShares * @see AWS * API Documentation */ java.util.concurrent.Future* List the lens shares associated with the lens. *
* * @param listLensSharesRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListLensShares operation returned by the service. * @sample AWSWellArchitectedAsyncHandler.ListLensShares * @see AWS * API Documentation */ java.util.concurrent.Future* List the available lenses. *
* * @param listLensesRequest * Input to list lenses. * @return A Java Future containing the result of the ListLenses operation returned by the service. * @sample AWSWellArchitectedAsync.ListLenses * @see AWS API * Documentation */ java.util.concurrent.Future* List the available lenses. *
* * @param listLensesRequest * Input to list lenses. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListLenses operation returned by the service. * @sample AWSWellArchitectedAsyncHandler.ListLenses * @see AWS API * Documentation */ java.util.concurrent.Future* List all milestones for an existing workload. *
* * @param listMilestonesRequest * Input to list all milestones for a workload. * @return A Java Future containing the result of the ListMilestones operation returned by the service. * @sample AWSWellArchitectedAsync.ListMilestones * @see AWS * API Documentation */ java.util.concurrent.Future* List all milestones for an existing workload. *
* * @param listMilestonesRequest * Input to list all milestones for a workload. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListMilestones operation returned by the service. * @sample AWSWellArchitectedAsyncHandler.ListMilestones * @see AWS * API Documentation */ java.util.concurrent.Future* List lens notifications. *
* * @param listNotificationsRequest * @return A Java Future containing the result of the ListNotifications operation returned by the service. * @sample AWSWellArchitectedAsync.ListNotifications * @see AWS API Documentation */ java.util.concurrent.Future* List lens notifications. *
* * @param listNotificationsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListNotifications operation returned by the service. * @sample AWSWellArchitectedAsyncHandler.ListNotifications * @see AWS API Documentation */ java.util.concurrent.Future* List profile notifications. *
* * @param listProfileNotificationsRequest * @return A Java Future containing the result of the ListProfileNotifications operation returned by the service. * @sample AWSWellArchitectedAsync.ListProfileNotifications * @see AWS API Documentation */ java.util.concurrent.Future* List profile notifications. *
* * @param listProfileNotificationsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListProfileNotifications operation returned by the service. * @sample AWSWellArchitectedAsyncHandler.ListProfileNotifications * @see AWS API Documentation */ java.util.concurrent.Future* List profile shares. *
* * @param listProfileSharesRequest * @return A Java Future containing the result of the ListProfileShares operation returned by the service. * @sample AWSWellArchitectedAsync.ListProfileShares * @see AWS API Documentation */ java.util.concurrent.Future* List profile shares. *
* * @param listProfileSharesRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListProfileShares operation returned by the service. * @sample AWSWellArchitectedAsyncHandler.ListProfileShares * @see AWS API Documentation */ java.util.concurrent.Future* List profiles. *
* * @param listProfilesRequest * @return A Java Future containing the result of the ListProfiles operation returned by the service. * @sample AWSWellArchitectedAsync.ListProfiles * @see AWS * API Documentation */ java.util.concurrent.Future* List profiles. *
* * @param listProfilesRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListProfiles operation returned by the service. * @sample AWSWellArchitectedAsyncHandler.ListProfiles * @see AWS * API Documentation */ java.util.concurrent.Future* List the workload invitations. *
* * @param listShareInvitationsRequest * Input for List Share Invitations * @return A Java Future containing the result of the ListShareInvitations operation returned by the service. * @sample AWSWellArchitectedAsync.ListShareInvitations * @see AWS API Documentation */ java.util.concurrent.Future* List the workload invitations. *
* * @param listShareInvitationsRequest * Input for List Share Invitations * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListShareInvitations operation returned by the service. * @sample AWSWellArchitectedAsyncHandler.ListShareInvitations * @see AWS API Documentation */ java.util.concurrent.Future* List the tags for a resource. *
** The WorkloadArn parameter can be a workload ARN, a custom lens ARN, or a profile ARN. *
** List the tags for a resource. *
** The WorkloadArn parameter can be a workload ARN, a custom lens ARN, or a profile ARN. *
** List the workload shares associated with the workload. *
* * @param listWorkloadSharesRequest * Input for List Workload Share * @return A Java Future containing the result of the ListWorkloadShares operation returned by the service. * @sample AWSWellArchitectedAsync.ListWorkloadShares * @see AWS API Documentation */ java.util.concurrent.Future* List the workload shares associated with the workload. *
* * @param listWorkloadSharesRequest * Input for List Workload Share * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListWorkloadShares operation returned by the service. * @sample AWSWellArchitectedAsyncHandler.ListWorkloadShares * @see AWS API Documentation */ java.util.concurrent.Future* Paginated list of workloads. *
* * @param listWorkloadsRequest * Input to list all workloads. * @return A Java Future containing the result of the ListWorkloads operation returned by the service. * @sample AWSWellArchitectedAsync.ListWorkloads * @see AWS * API Documentation */ java.util.concurrent.Future* Paginated list of workloads. *
* * @param listWorkloadsRequest * Input to list all workloads. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListWorkloads operation returned by the service. * @sample AWSWellArchitectedAsyncHandler.ListWorkloads * @see AWS * API Documentation */ java.util.concurrent.Future* Adds one or more tags to the specified resource. *
** The WorkloadArn parameter can be a workload ARN, a custom lens ARN, or a profile ARN. *
** Adds one or more tags to the specified resource. *
** The WorkloadArn parameter can be a workload ARN, a custom lens ARN, or a profile ARN. *
** Deletes specified tags from a resource. *
** The WorkloadArn parameter can be a workload ARN, a custom lens ARN, or a profile ARN. *
** To specify multiple tags, use separate tagKeys parameters, for example: *
*
* DELETE /tags/WorkloadArn?tagKeys=key1&tagKeys=key2
*
* Deletes specified tags from a resource. *
** The WorkloadArn parameter can be a workload ARN, a custom lens ARN, or a profile ARN. *
** To specify multiple tags, use separate tagKeys parameters, for example: *
*
* DELETE /tags/WorkloadArn?tagKeys=key1&tagKeys=key2
*
* Update the answer to a specific question in a workload review. *
* * @param updateAnswerRequest * Input to update answer. * @return A Java Future containing the result of the UpdateAnswer operation returned by the service. * @sample AWSWellArchitectedAsync.UpdateAnswer * @see AWS * API Documentation */ java.util.concurrent.Future* Update the answer to a specific question in a workload review. *
* * @param updateAnswerRequest * Input to update answer. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UpdateAnswer operation returned by the service. * @sample AWSWellArchitectedAsyncHandler.UpdateAnswer * @see AWS * API Documentation */ java.util.concurrent.Future* Updates whether the Amazon Web Services account is opted into organization sharing and discovery integration * features. *
* * @param updateGlobalSettingsRequest * @return A Java Future containing the result of the UpdateGlobalSettings operation returned by the service. * @sample AWSWellArchitectedAsync.UpdateGlobalSettings * @see AWS API Documentation */ java.util.concurrent.Future* Updates whether the Amazon Web Services account is opted into organization sharing and discovery integration * features. *
* * @param updateGlobalSettingsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UpdateGlobalSettings operation returned by the service. * @sample AWSWellArchitectedAsyncHandler.UpdateGlobalSettings * @see AWS API Documentation */ java.util.concurrent.Future* Update lens review for a particular workload. *
* * @param updateLensReviewRequest * Input for update lens review. * @return A Java Future containing the result of the UpdateLensReview operation returned by the service. * @sample AWSWellArchitectedAsync.UpdateLensReview * @see AWS API Documentation */ java.util.concurrent.Future* Update lens review for a particular workload. *
* * @param updateLensReviewRequest * Input for update lens review. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UpdateLensReview operation returned by the service. * @sample AWSWellArchitectedAsyncHandler.UpdateLensReview * @see AWS API Documentation */ java.util.concurrent.Future* Update a profile. *
* * @param updateProfileRequest * @return A Java Future containing the result of the UpdateProfile operation returned by the service. * @sample AWSWellArchitectedAsync.UpdateProfile * @see AWS * API Documentation */ java.util.concurrent.Future* Update a profile. *
* * @param updateProfileRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UpdateProfile operation returned by the service. * @sample AWSWellArchitectedAsyncHandler.UpdateProfile * @see AWS * API Documentation */ java.util.concurrent.Future* 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. *
** 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. *
** Update an existing workload. *
* * @param updateWorkloadRequest * Input to update a workload. * @return A Java Future containing the result of the UpdateWorkload operation returned by the service. * @sample AWSWellArchitectedAsync.UpdateWorkload * @see AWS * API Documentation */ java.util.concurrent.Future* Update an existing workload. *
* * @param updateWorkloadRequest * Input to update a workload. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UpdateWorkload operation returned by the service. * @sample AWSWellArchitectedAsyncHandler.UpdateWorkload * @see AWS * API Documentation */ java.util.concurrent.Future* Update a workload share. *
* * @param updateWorkloadShareRequest * Input for Update Workload Share * @return A Java Future containing the result of the UpdateWorkloadShare operation returned by the service. * @sample AWSWellArchitectedAsync.UpdateWorkloadShare * @see AWS API Documentation */ java.util.concurrent.Future* Update a workload share. *
* * @param updateWorkloadShareRequest * Input for Update Workload Share * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UpdateWorkloadShare operation returned by the service. * @sample AWSWellArchitectedAsyncHandler.UpdateWorkloadShare * @see AWS API Documentation */ java.util.concurrent.Future* Upgrade lens review for a particular workload. *
* * @param upgradeLensReviewRequest * @return A Java Future containing the result of the UpgradeLensReview operation returned by the service. * @sample AWSWellArchitectedAsync.UpgradeLensReview * @see AWS API Documentation */ java.util.concurrent.Future* Upgrade lens review for a particular workload. *
* * @param upgradeLensReviewRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UpgradeLensReview operation returned by the service. * @sample AWSWellArchitectedAsyncHandler.UpgradeLensReview * @see AWS API Documentation */ java.util.concurrent.Future* Upgrade a profile. *
* * @param upgradeProfileVersionRequest * @return A Java Future containing the result of the UpgradeProfileVersion operation returned by the service. * @sample AWSWellArchitectedAsync.UpgradeProfileVersion * @see AWS API Documentation */ java.util.concurrent.Future* Upgrade a profile. *
* * @param upgradeProfileVersionRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UpgradeProfileVersion operation returned by the service. * @sample AWSWellArchitectedAsyncHandler.UpgradeProfileVersion * @see AWS API Documentation */ java.util.concurrent.Future