@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSWellArchitected extends Object implements AWSWellArchitected
AWSWellArchitected
. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
public AssociateLensesResult associateLenses(AssociateLensesRequest request)
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.
associateLenses
in interface AWSWellArchitected
request
- Input to associate lens reviews.public CreateLensShareResult createLensShare(CreateLensShareRequest request)
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.
createLensShare
in interface AWSWellArchitected
public CreateLensVersionResult createLensVersion(CreateLensVersionRequest request)
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.
createLensVersion
in interface AWSWellArchitected
public CreateMilestoneResult createMilestone(CreateMilestoneRequest request)
AWSWellArchitected
Create a milestone for an existing workload.
createMilestone
in interface AWSWellArchitected
request
- Input for milestone creation.public CreateWorkloadResult createWorkload(CreateWorkloadRequest request)
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.
createWorkload
in interface AWSWellArchitected
request
- Input for workload creation.public CreateWorkloadShareResult createWorkloadShare(CreateWorkloadShareRequest request)
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.
createWorkloadShare
in interface AWSWellArchitected
request
- Input for Create Workload Sharepublic DeleteLensResult deleteLens(DeleteLensRequest request)
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.
deleteLens
in interface AWSWellArchitected
public DeleteLensShareResult deleteLensShare(DeleteLensShareRequest request)
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.
deleteLensShare
in interface AWSWellArchitected
public DeleteWorkloadResult deleteWorkload(DeleteWorkloadRequest request)
AWSWellArchitected
Delete an existing workload.
deleteWorkload
in interface AWSWellArchitected
request
- Input for workload deletion.public DeleteWorkloadShareResult deleteWorkloadShare(DeleteWorkloadShareRequest request)
AWSWellArchitected
Delete a workload share.
deleteWorkloadShare
in interface AWSWellArchitected
request
- Input for Delete Workload Sharepublic DisassociateLensesResult disassociateLenses(DisassociateLensesRequest request)
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.
disassociateLenses
in interface AWSWellArchitected
request
- Input to disassociate lens reviews.public ExportLensResult exportLens(ExportLensRequest request)
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.
exportLens
in interface AWSWellArchitected
public GetAnswerResult getAnswer(GetAnswerRequest request)
AWSWellArchitected
Get the answer to a specific question in a workload review.
getAnswer
in interface AWSWellArchitected
request
- Input to get answer.public GetConsolidatedReportResult getConsolidatedReport(GetConsolidatedReportRequest request)
AWSWellArchitected
Get a consolidated report of your workloads.
You can optionally choose to include workloads that have been shared with you.
getConsolidatedReport
in interface AWSWellArchitected
public GetLensResult getLens(GetLensRequest request)
AWSWellArchitected
Get an existing lens.
getLens
in interface AWSWellArchitected
public GetLensReviewResult getLensReview(GetLensReviewRequest request)
AWSWellArchitected
Get lens review.
getLensReview
in interface AWSWellArchitected
request
- Input to get lens review.public GetLensReviewReportResult getLensReviewReport(GetLensReviewReportRequest request)
AWSWellArchitected
Get lens review report.
getLensReviewReport
in interface AWSWellArchitected
request
- Input to get lens review report.public GetLensVersionDifferenceResult getLensVersionDifference(GetLensVersionDifferenceRequest request)
AWSWellArchitected
Get lens version differences.
getLensVersionDifference
in interface AWSWellArchitected
public GetMilestoneResult getMilestone(GetMilestoneRequest request)
AWSWellArchitected
Get a milestone for an existing workload.
getMilestone
in interface AWSWellArchitected
request
- Input to get a milestone.public GetWorkloadResult getWorkload(GetWorkloadRequest request)
AWSWellArchitected
Get an existing workload.
getWorkload
in interface AWSWellArchitected
request
- Input to get a workload.public ImportLensResult importLens(ImportLensRequest request)
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.
importLens
in interface AWSWellArchitected
public ListAnswersResult listAnswers(ListAnswersRequest request)
AWSWellArchitected
List of answers for a particular workload and lens.
listAnswers
in interface AWSWellArchitected
request
- Input to list answers.public ListCheckDetailsResult listCheckDetails(ListCheckDetailsRequest request)
AWSWellArchitected
List of Trusted Advisor check details by account related to the workload.
listCheckDetails
in interface AWSWellArchitected
public ListCheckSummariesResult listCheckSummaries(ListCheckSummariesRequest request)
AWSWellArchitected
List of Trusted Advisor checks summarized for all accounts related to the workload.
listCheckSummaries
in interface AWSWellArchitected
public ListLensReviewImprovementsResult listLensReviewImprovements(ListLensReviewImprovementsRequest request)
AWSWellArchitected
List lens review improvements.
listLensReviewImprovements
in interface AWSWellArchitected
request
- Input to list lens review improvements.public ListLensReviewsResult listLensReviews(ListLensReviewsRequest request)
AWSWellArchitected
List lens reviews for a particular workload.
listLensReviews
in interface AWSWellArchitected
request
- Input to list lens reviews.public ListLensSharesResult listLensShares(ListLensSharesRequest request)
AWSWellArchitected
List the lens shares associated with the lens.
listLensShares
in interface AWSWellArchitected
public ListLensesResult listLenses(ListLensesRequest request)
AWSWellArchitected
List the available lenses.
listLenses
in interface AWSWellArchitected
request
- Input to list lenses.public ListMilestonesResult listMilestones(ListMilestonesRequest request)
AWSWellArchitected
List all milestones for an existing workload.
listMilestones
in interface AWSWellArchitected
request
- Input to list all milestones for a workload.public ListNotificationsResult listNotifications(ListNotificationsRequest request)
AWSWellArchitected
List lens notifications.
listNotifications
in interface AWSWellArchitected
public ListShareInvitationsResult listShareInvitations(ListShareInvitationsRequest request)
AWSWellArchitected
List the workload invitations.
listShareInvitations
in interface AWSWellArchitected
request
- Input for List Share Invitationspublic ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AWSWellArchitected
List the tags for a resource.
The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.
listTagsForResource
in interface AWSWellArchitected
public ListWorkloadSharesResult listWorkloadShares(ListWorkloadSharesRequest request)
AWSWellArchitected
List the workload shares associated with the workload.
listWorkloadShares
in interface AWSWellArchitected
request
- Input for List Workload Sharepublic ListWorkloadsResult listWorkloads(ListWorkloadsRequest request)
AWSWellArchitected
Paginated list of workloads.
listWorkloads
in interface AWSWellArchitected
request
- Input to list all workloads.public TagResourceResult tagResource(TagResourceRequest request)
AWSWellArchitected
Adds one or more tags to the specified resource.
The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.
tagResource
in interface AWSWellArchitected
public UntagResourceResult untagResource(UntagResourceRequest request)
AWSWellArchitected
Deletes specified tags from a resource.
The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.
To specify multiple tags, use separate tagKeys parameters, for example:
DELETE /tags/WorkloadArn?tagKeys=key1&tagKeys=key2
untagResource
in interface AWSWellArchitected
public UpdateAnswerResult updateAnswer(UpdateAnswerRequest request)
AWSWellArchitected
Update the answer to a specific question in a workload review.
updateAnswer
in interface AWSWellArchitected
request
- Input to update answer.public UpdateGlobalSettingsResult updateGlobalSettings(UpdateGlobalSettingsRequest request)
AWSWellArchitected
Updates whether the Amazon Web Services account is opted into organization sharing features.
updateGlobalSettings
in interface AWSWellArchitected
public UpdateLensReviewResult updateLensReview(UpdateLensReviewRequest request)
AWSWellArchitected
Update lens review for a particular workload.
updateLensReview
in interface AWSWellArchitected
request
- Input for update lens review.public UpdateShareInvitationResult updateShareInvitation(UpdateShareInvitationRequest request)
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.
updateShareInvitation
in interface AWSWellArchitected
request
- Input for Update Share Invitationpublic UpdateWorkloadResult updateWorkload(UpdateWorkloadRequest request)
AWSWellArchitected
Update an existing workload.
updateWorkload
in interface AWSWellArchitected
request
- Input to update a workload.public UpdateWorkloadShareResult updateWorkloadShare(UpdateWorkloadShareRequest request)
AWSWellArchitected
Update a workload share.
updateWorkloadShare
in interface AWSWellArchitected
request
- Input for Update Workload Sharepublic UpgradeLensReviewResult upgradeLensReview(UpgradeLensReviewRequest request)
AWSWellArchitected
Upgrade lens review for a particular workload.
upgradeLensReview
in interface AWSWellArchitected
public void shutdown()
AWSWellArchitected
shutdown
in interface AWSWellArchitected
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSWellArchitected
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.
getCachedResponseMetadata
in interface AWSWellArchitected
request
- The originally executed request.