Interface WellArchitectedAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in
some cases such as credentials retrieval and endpoint discovery as part of the async API call.
This is the Well-Architected Tool API Reference. The WA Tool API provides programmatic access to the Well-Architected Tool in the Amazon Web Services Management Console. For information about the Well-Architected Tool, see the Well-Architected Tool User Guide.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptiondefault CompletableFuture
<AssociateLensesResponse> associateLenses
(Consumer<AssociateLensesRequest.Builder> associateLensesRequest) Associate a lens to a workload.default CompletableFuture
<AssociateLensesResponse> associateLenses
(AssociateLensesRequest associateLensesRequest) Associate a lens to a workload.associateProfiles
(Consumer<AssociateProfilesRequest.Builder> associateProfilesRequest) Associate a profile with a workload.associateProfiles
(AssociateProfilesRequest associateProfilesRequest) Associate a profile with a workload.builder()
Create a builder that can be used to configure and create aWellArchitectedAsyncClient
.static WellArchitectedAsyncClient
create()
Create aWellArchitectedAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CompletableFuture
<CreateLensShareResponse> createLensShare
(Consumer<CreateLensShareRequest.Builder> createLensShareRequest) Create a lens share.default CompletableFuture
<CreateLensShareResponse> createLensShare
(CreateLensShareRequest createLensShareRequest) Create a lens share.createLensVersion
(Consumer<CreateLensVersionRequest.Builder> createLensVersionRequest) Create a new lens version.createLensVersion
(CreateLensVersionRequest createLensVersionRequest) Create a new lens version.default CompletableFuture
<CreateMilestoneResponse> createMilestone
(Consumer<CreateMilestoneRequest.Builder> createMilestoneRequest) Create a milestone for an existing workload.default CompletableFuture
<CreateMilestoneResponse> createMilestone
(CreateMilestoneRequest createMilestoneRequest) Create a milestone for an existing workload.default CompletableFuture
<CreateProfileResponse> createProfile
(Consumer<CreateProfileRequest.Builder> createProfileRequest) Create a profile.default CompletableFuture
<CreateProfileResponse> createProfile
(CreateProfileRequest createProfileRequest) Create a profile.createProfileShare
(Consumer<CreateProfileShareRequest.Builder> createProfileShareRequest) Create a profile share.createProfileShare
(CreateProfileShareRequest createProfileShareRequest) Create a profile share.createReviewTemplate
(Consumer<CreateReviewTemplateRequest.Builder> createReviewTemplateRequest) Create a review template.createReviewTemplate
(CreateReviewTemplateRequest createReviewTemplateRequest) Create a review template.createTemplateShare
(Consumer<CreateTemplateShareRequest.Builder> createTemplateShareRequest) Create a review template share.createTemplateShare
(CreateTemplateShareRequest createTemplateShareRequest) Create a review template share.default CompletableFuture
<CreateWorkloadResponse> createWorkload
(Consumer<CreateWorkloadRequest.Builder> createWorkloadRequest) Create a new workload.default CompletableFuture
<CreateWorkloadResponse> createWorkload
(CreateWorkloadRequest createWorkloadRequest) Create a new workload.createWorkloadShare
(Consumer<CreateWorkloadShareRequest.Builder> createWorkloadShareRequest) Create a workload share.createWorkloadShare
(CreateWorkloadShareRequest createWorkloadShareRequest) Create a workload share.default CompletableFuture
<DeleteLensResponse> deleteLens
(Consumer<DeleteLensRequest.Builder> deleteLensRequest) Delete an existing lens.default CompletableFuture
<DeleteLensResponse> deleteLens
(DeleteLensRequest deleteLensRequest) Delete an existing lens.default CompletableFuture
<DeleteLensShareResponse> deleteLensShare
(Consumer<DeleteLensShareRequest.Builder> deleteLensShareRequest) Delete a lens share.default CompletableFuture
<DeleteLensShareResponse> deleteLensShare
(DeleteLensShareRequest deleteLensShareRequest) Delete a lens share.default CompletableFuture
<DeleteProfileResponse> deleteProfile
(Consumer<DeleteProfileRequest.Builder> deleteProfileRequest) Delete a profile.default CompletableFuture
<DeleteProfileResponse> deleteProfile
(DeleteProfileRequest deleteProfileRequest) Delete a profile.deleteProfileShare
(Consumer<DeleteProfileShareRequest.Builder> deleteProfileShareRequest) Delete a profile share.deleteProfileShare
(DeleteProfileShareRequest deleteProfileShareRequest) Delete a profile share.deleteReviewTemplate
(Consumer<DeleteReviewTemplateRequest.Builder> deleteReviewTemplateRequest) Delete a review template.deleteReviewTemplate
(DeleteReviewTemplateRequest deleteReviewTemplateRequest) Delete a review template.deleteTemplateShare
(Consumer<DeleteTemplateShareRequest.Builder> deleteTemplateShareRequest) Delete a review template share.deleteTemplateShare
(DeleteTemplateShareRequest deleteTemplateShareRequest) Delete a review template share.default CompletableFuture
<DeleteWorkloadResponse> deleteWorkload
(Consumer<DeleteWorkloadRequest.Builder> deleteWorkloadRequest) Delete an existing workload.default CompletableFuture
<DeleteWorkloadResponse> deleteWorkload
(DeleteWorkloadRequest deleteWorkloadRequest) Delete an existing workload.deleteWorkloadShare
(Consumer<DeleteWorkloadShareRequest.Builder> deleteWorkloadShareRequest) Delete a workload share.deleteWorkloadShare
(DeleteWorkloadShareRequest deleteWorkloadShareRequest) Delete a workload share.disassociateLenses
(Consumer<DisassociateLensesRequest.Builder> disassociateLensesRequest) Disassociate a lens from a workload.disassociateLenses
(DisassociateLensesRequest disassociateLensesRequest) Disassociate a lens from a workload.disassociateProfiles
(Consumer<DisassociateProfilesRequest.Builder> disassociateProfilesRequest) Disassociate a profile from a workload.disassociateProfiles
(DisassociateProfilesRequest disassociateProfilesRequest) Disassociate a profile from a workload.default CompletableFuture
<ExportLensResponse> exportLens
(Consumer<ExportLensRequest.Builder> exportLensRequest) Export an existing lens.default CompletableFuture
<ExportLensResponse> exportLens
(ExportLensRequest exportLensRequest) Export an existing lens.default CompletableFuture
<GetAnswerResponse> getAnswer
(Consumer<GetAnswerRequest.Builder> getAnswerRequest) Get the answer to a specific question in a workload review.default CompletableFuture
<GetAnswerResponse> getAnswer
(GetAnswerRequest getAnswerRequest) Get the answer to a specific question in a workload review.getConsolidatedReport
(Consumer<GetConsolidatedReportRequest.Builder> getConsolidatedReportRequest) Get a consolidated report of your workloads.getConsolidatedReport
(GetConsolidatedReportRequest getConsolidatedReportRequest) Get a consolidated report of your workloads.default GetConsolidatedReportPublisher
getConsolidatedReportPaginator
(Consumer<GetConsolidatedReportRequest.Builder> getConsolidatedReportRequest) This is a variant ofgetConsolidatedReport(software.amazon.awssdk.services.wellarchitected.model.GetConsolidatedReportRequest)
operation.default GetConsolidatedReportPublisher
getConsolidatedReportPaginator
(GetConsolidatedReportRequest getConsolidatedReportRequest) This is a variant ofgetConsolidatedReport(software.amazon.awssdk.services.wellarchitected.model.GetConsolidatedReportRequest)
operation.getGlobalSettings
(Consumer<GetGlobalSettingsRequest.Builder> getGlobalSettingsRequest) Global settings for all workloads.getGlobalSettings
(GetGlobalSettingsRequest getGlobalSettingsRequest) Global settings for all workloads.default CompletableFuture
<GetLensResponse> getLens
(Consumer<GetLensRequest.Builder> getLensRequest) Get an existing lens.default CompletableFuture
<GetLensResponse> getLens
(GetLensRequest getLensRequest) Get an existing lens.default CompletableFuture
<GetLensReviewResponse> getLensReview
(Consumer<GetLensReviewRequest.Builder> getLensReviewRequest) Get lens review.default CompletableFuture
<GetLensReviewResponse> getLensReview
(GetLensReviewRequest getLensReviewRequest) Get lens review.getLensReviewReport
(Consumer<GetLensReviewReportRequest.Builder> getLensReviewReportRequest) Get lens review report.getLensReviewReport
(GetLensReviewReportRequest getLensReviewReportRequest) Get lens review report.getLensVersionDifference
(Consumer<GetLensVersionDifferenceRequest.Builder> getLensVersionDifferenceRequest) Get lens version differences.getLensVersionDifference
(GetLensVersionDifferenceRequest getLensVersionDifferenceRequest) Get lens version differences.default CompletableFuture
<GetMilestoneResponse> getMilestone
(Consumer<GetMilestoneRequest.Builder> getMilestoneRequest) Get a milestone for an existing workload.default CompletableFuture
<GetMilestoneResponse> getMilestone
(GetMilestoneRequest getMilestoneRequest) Get a milestone for an existing workload.default CompletableFuture
<GetProfileResponse> getProfile
(Consumer<GetProfileRequest.Builder> getProfileRequest) Get profile information.default CompletableFuture
<GetProfileResponse> getProfile
(GetProfileRequest getProfileRequest) Get profile information.getProfileTemplate
(Consumer<GetProfileTemplateRequest.Builder> getProfileTemplateRequest) Get profile template.getProfileTemplate
(GetProfileTemplateRequest getProfileTemplateRequest) Get profile template.getReviewTemplate
(Consumer<GetReviewTemplateRequest.Builder> getReviewTemplateRequest) Get review template.getReviewTemplate
(GetReviewTemplateRequest getReviewTemplateRequest) Get review template.getReviewTemplateAnswer
(Consumer<GetReviewTemplateAnswerRequest.Builder> getReviewTemplateAnswerRequest) Get review template answer.getReviewTemplateAnswer
(GetReviewTemplateAnswerRequest getReviewTemplateAnswerRequest) Get review template answer.getReviewTemplateLensReview
(Consumer<GetReviewTemplateLensReviewRequest.Builder> getReviewTemplateLensReviewRequest) Get a lens review associated with a review template.getReviewTemplateLensReview
(GetReviewTemplateLensReviewRequest getReviewTemplateLensReviewRequest) Get a lens review associated with a review template.default CompletableFuture
<GetWorkloadResponse> getWorkload
(Consumer<GetWorkloadRequest.Builder> getWorkloadRequest) Get an existing workload.default CompletableFuture
<GetWorkloadResponse> getWorkload
(GetWorkloadRequest getWorkloadRequest) Get an existing workload.default CompletableFuture
<ImportLensResponse> importLens
(Consumer<ImportLensRequest.Builder> importLensRequest) Import a new custom lens or update an existing custom lens.default CompletableFuture
<ImportLensResponse> importLens
(ImportLensRequest importLensRequest) Import a new custom lens or update an existing custom lens.default CompletableFuture
<ListAnswersResponse> listAnswers
(Consumer<ListAnswersRequest.Builder> listAnswersRequest) List of answers for a particular workload and lens.default CompletableFuture
<ListAnswersResponse> listAnswers
(ListAnswersRequest listAnswersRequest) List of answers for a particular workload and lens.default ListAnswersPublisher
listAnswersPaginator
(Consumer<ListAnswersRequest.Builder> listAnswersRequest) This is a variant oflistAnswers(software.amazon.awssdk.services.wellarchitected.model.ListAnswersRequest)
operation.default ListAnswersPublisher
listAnswersPaginator
(ListAnswersRequest listAnswersRequest) This is a variant oflistAnswers(software.amazon.awssdk.services.wellarchitected.model.ListAnswersRequest)
operation.listCheckDetails
(Consumer<ListCheckDetailsRequest.Builder> listCheckDetailsRequest) List of Trusted Advisor check details by account related to the workload.listCheckDetails
(ListCheckDetailsRequest listCheckDetailsRequest) List of Trusted Advisor check details by account related to the workload.default ListCheckDetailsPublisher
listCheckDetailsPaginator
(Consumer<ListCheckDetailsRequest.Builder> listCheckDetailsRequest) This is a variant oflistCheckDetails(software.amazon.awssdk.services.wellarchitected.model.ListCheckDetailsRequest)
operation.default ListCheckDetailsPublisher
listCheckDetailsPaginator
(ListCheckDetailsRequest listCheckDetailsRequest) This is a variant oflistCheckDetails(software.amazon.awssdk.services.wellarchitected.model.ListCheckDetailsRequest)
operation.listCheckSummaries
(Consumer<ListCheckSummariesRequest.Builder> listCheckSummariesRequest) List of Trusted Advisor checks summarized for all accounts related to the workload.listCheckSummaries
(ListCheckSummariesRequest listCheckSummariesRequest) List of Trusted Advisor checks summarized for all accounts related to the workload.default ListCheckSummariesPublisher
listCheckSummariesPaginator
(Consumer<ListCheckSummariesRequest.Builder> listCheckSummariesRequest) This is a variant oflistCheckSummaries(software.amazon.awssdk.services.wellarchitected.model.ListCheckSummariesRequest)
operation.default ListCheckSummariesPublisher
listCheckSummariesPaginator
(ListCheckSummariesRequest listCheckSummariesRequest) This is a variant oflistCheckSummaries(software.amazon.awssdk.services.wellarchitected.model.ListCheckSummariesRequest)
operation.default CompletableFuture
<ListLensesResponse> listLenses
(Consumer<ListLensesRequest.Builder> listLensesRequest) List the available lenses.default CompletableFuture
<ListLensesResponse> listLenses
(ListLensesRequest listLensesRequest) List the available lenses.default ListLensesPublisher
listLensesPaginator
(Consumer<ListLensesRequest.Builder> listLensesRequest) This is a variant oflistLenses(software.amazon.awssdk.services.wellarchitected.model.ListLensesRequest)
operation.default ListLensesPublisher
listLensesPaginator
(ListLensesRequest listLensesRequest) This is a variant oflistLenses(software.amazon.awssdk.services.wellarchitected.model.ListLensesRequest)
operation.listLensReviewImprovements
(Consumer<ListLensReviewImprovementsRequest.Builder> listLensReviewImprovementsRequest) List the improvements of a particular lens review.listLensReviewImprovements
(ListLensReviewImprovementsRequest listLensReviewImprovementsRequest) List the improvements of a particular lens review.listLensReviewImprovementsPaginator
(Consumer<ListLensReviewImprovementsRequest.Builder> listLensReviewImprovementsRequest) This is a variant oflistLensReviewImprovements(software.amazon.awssdk.services.wellarchitected.model.ListLensReviewImprovementsRequest)
operation.listLensReviewImprovementsPaginator
(ListLensReviewImprovementsRequest listLensReviewImprovementsRequest) This is a variant oflistLensReviewImprovements(software.amazon.awssdk.services.wellarchitected.model.ListLensReviewImprovementsRequest)
operation.default CompletableFuture
<ListLensReviewsResponse> listLensReviews
(Consumer<ListLensReviewsRequest.Builder> listLensReviewsRequest) List lens reviews for a particular workload.default CompletableFuture
<ListLensReviewsResponse> listLensReviews
(ListLensReviewsRequest listLensReviewsRequest) List lens reviews for a particular workload.default ListLensReviewsPublisher
listLensReviewsPaginator
(Consumer<ListLensReviewsRequest.Builder> listLensReviewsRequest) This is a variant oflistLensReviews(software.amazon.awssdk.services.wellarchitected.model.ListLensReviewsRequest)
operation.default ListLensReviewsPublisher
listLensReviewsPaginator
(ListLensReviewsRequest listLensReviewsRequest) This is a variant oflistLensReviews(software.amazon.awssdk.services.wellarchitected.model.ListLensReviewsRequest)
operation.default CompletableFuture
<ListLensSharesResponse> listLensShares
(Consumer<ListLensSharesRequest.Builder> listLensSharesRequest) List the lens shares associated with the lens.default CompletableFuture
<ListLensSharesResponse> listLensShares
(ListLensSharesRequest listLensSharesRequest) List the lens shares associated with the lens.default ListLensSharesPublisher
listLensSharesPaginator
(Consumer<ListLensSharesRequest.Builder> listLensSharesRequest) This is a variant oflistLensShares(software.amazon.awssdk.services.wellarchitected.model.ListLensSharesRequest)
operation.default ListLensSharesPublisher
listLensSharesPaginator
(ListLensSharesRequest listLensSharesRequest) This is a variant oflistLensShares(software.amazon.awssdk.services.wellarchitected.model.ListLensSharesRequest)
operation.default CompletableFuture
<ListMilestonesResponse> listMilestones
(Consumer<ListMilestonesRequest.Builder> listMilestonesRequest) List all milestones for an existing workload.default CompletableFuture
<ListMilestonesResponse> listMilestones
(ListMilestonesRequest listMilestonesRequest) List all milestones for an existing workload.default ListMilestonesPublisher
listMilestonesPaginator
(Consumer<ListMilestonesRequest.Builder> listMilestonesRequest) This is a variant oflistMilestones(software.amazon.awssdk.services.wellarchitected.model.ListMilestonesRequest)
operation.default ListMilestonesPublisher
listMilestonesPaginator
(ListMilestonesRequest listMilestonesRequest) This is a variant oflistMilestones(software.amazon.awssdk.services.wellarchitected.model.ListMilestonesRequest)
operation.listNotifications
(Consumer<ListNotificationsRequest.Builder> listNotificationsRequest) List lens notifications.listNotifications
(ListNotificationsRequest listNotificationsRequest) List lens notifications.default ListNotificationsPublisher
listNotificationsPaginator
(Consumer<ListNotificationsRequest.Builder> listNotificationsRequest) This is a variant oflistNotifications(software.amazon.awssdk.services.wellarchitected.model.ListNotificationsRequest)
operation.default ListNotificationsPublisher
listNotificationsPaginator
(ListNotificationsRequest listNotificationsRequest) This is a variant oflistNotifications(software.amazon.awssdk.services.wellarchitected.model.ListNotificationsRequest)
operation.listProfileNotifications
(Consumer<ListProfileNotificationsRequest.Builder> listProfileNotificationsRequest) List profile notifications.listProfileNotifications
(ListProfileNotificationsRequest listProfileNotificationsRequest) List profile notifications.listProfileNotificationsPaginator
(Consumer<ListProfileNotificationsRequest.Builder> listProfileNotificationsRequest) This is a variant oflistProfileNotifications(software.amazon.awssdk.services.wellarchitected.model.ListProfileNotificationsRequest)
operation.listProfileNotificationsPaginator
(ListProfileNotificationsRequest listProfileNotificationsRequest) This is a variant oflistProfileNotifications(software.amazon.awssdk.services.wellarchitected.model.ListProfileNotificationsRequest)
operation.default CompletableFuture
<ListProfilesResponse> listProfiles
(Consumer<ListProfilesRequest.Builder> listProfilesRequest) List profiles.default CompletableFuture
<ListProfilesResponse> listProfiles
(ListProfilesRequest listProfilesRequest) List profiles.listProfileShares
(Consumer<ListProfileSharesRequest.Builder> listProfileSharesRequest) List profile shares.listProfileShares
(ListProfileSharesRequest listProfileSharesRequest) List profile shares.default ListProfileSharesPublisher
listProfileSharesPaginator
(Consumer<ListProfileSharesRequest.Builder> listProfileSharesRequest) This is a variant oflistProfileShares(software.amazon.awssdk.services.wellarchitected.model.ListProfileSharesRequest)
operation.default ListProfileSharesPublisher
listProfileSharesPaginator
(ListProfileSharesRequest listProfileSharesRequest) This is a variant oflistProfileShares(software.amazon.awssdk.services.wellarchitected.model.ListProfileSharesRequest)
operation.default ListProfilesPublisher
listProfilesPaginator
(Consumer<ListProfilesRequest.Builder> listProfilesRequest) This is a variant oflistProfiles(software.amazon.awssdk.services.wellarchitected.model.ListProfilesRequest)
operation.default ListProfilesPublisher
listProfilesPaginator
(ListProfilesRequest listProfilesRequest) This is a variant oflistProfiles(software.amazon.awssdk.services.wellarchitected.model.ListProfilesRequest)
operation.listReviewTemplateAnswers
(Consumer<ListReviewTemplateAnswersRequest.Builder> listReviewTemplateAnswersRequest) List the answers of a review template.listReviewTemplateAnswers
(ListReviewTemplateAnswersRequest listReviewTemplateAnswersRequest) List the answers of a review template.listReviewTemplateAnswersPaginator
(Consumer<ListReviewTemplateAnswersRequest.Builder> listReviewTemplateAnswersRequest) This is a variant oflistReviewTemplateAnswers(software.amazon.awssdk.services.wellarchitected.model.ListReviewTemplateAnswersRequest)
operation.listReviewTemplateAnswersPaginator
(ListReviewTemplateAnswersRequest listReviewTemplateAnswersRequest) This is a variant oflistReviewTemplateAnswers(software.amazon.awssdk.services.wellarchitected.model.ListReviewTemplateAnswersRequest)
operation.listReviewTemplates
(Consumer<ListReviewTemplatesRequest.Builder> listReviewTemplatesRequest) List review templates.listReviewTemplates
(ListReviewTemplatesRequest listReviewTemplatesRequest) List review templates.default ListReviewTemplatesPublisher
listReviewTemplatesPaginator
(Consumer<ListReviewTemplatesRequest.Builder> listReviewTemplatesRequest) This is a variant oflistReviewTemplates(software.amazon.awssdk.services.wellarchitected.model.ListReviewTemplatesRequest)
operation.default ListReviewTemplatesPublisher
listReviewTemplatesPaginator
(ListReviewTemplatesRequest listReviewTemplatesRequest) This is a variant oflistReviewTemplates(software.amazon.awssdk.services.wellarchitected.model.ListReviewTemplatesRequest)
operation.listShareInvitations
(Consumer<ListShareInvitationsRequest.Builder> listShareInvitationsRequest) List the share invitations.listShareInvitations
(ListShareInvitationsRequest listShareInvitationsRequest) List the share invitations.default ListShareInvitationsPublisher
listShareInvitationsPaginator
(Consumer<ListShareInvitationsRequest.Builder> listShareInvitationsRequest) This is a variant oflistShareInvitations(software.amazon.awssdk.services.wellarchitected.model.ListShareInvitationsRequest)
operation.default ListShareInvitationsPublisher
listShareInvitationsPaginator
(ListShareInvitationsRequest listShareInvitationsRequest) This is a variant oflistShareInvitations(software.amazon.awssdk.services.wellarchitected.model.ListShareInvitationsRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) List the tags for a resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) List the tags for a resource.listTemplateShares
(Consumer<ListTemplateSharesRequest.Builder> listTemplateSharesRequest) List review template shares.listTemplateShares
(ListTemplateSharesRequest listTemplateSharesRequest) List review template shares.default ListTemplateSharesPublisher
listTemplateSharesPaginator
(Consumer<ListTemplateSharesRequest.Builder> listTemplateSharesRequest) This is a variant oflistTemplateShares(software.amazon.awssdk.services.wellarchitected.model.ListTemplateSharesRequest)
operation.default ListTemplateSharesPublisher
listTemplateSharesPaginator
(ListTemplateSharesRequest listTemplateSharesRequest) This is a variant oflistTemplateShares(software.amazon.awssdk.services.wellarchitected.model.ListTemplateSharesRequest)
operation.default CompletableFuture
<ListWorkloadsResponse> listWorkloads
(Consumer<ListWorkloadsRequest.Builder> listWorkloadsRequest) Paginated list of workloads.default CompletableFuture
<ListWorkloadsResponse> listWorkloads
(ListWorkloadsRequest listWorkloadsRequest) Paginated list of workloads.listWorkloadShares
(Consumer<ListWorkloadSharesRequest.Builder> listWorkloadSharesRequest) List the workload shares associated with the workload.listWorkloadShares
(ListWorkloadSharesRequest listWorkloadSharesRequest) List the workload shares associated with the workload.default ListWorkloadSharesPublisher
listWorkloadSharesPaginator
(Consumer<ListWorkloadSharesRequest.Builder> listWorkloadSharesRequest) This is a variant oflistWorkloadShares(software.amazon.awssdk.services.wellarchitected.model.ListWorkloadSharesRequest)
operation.default ListWorkloadSharesPublisher
listWorkloadSharesPaginator
(ListWorkloadSharesRequest listWorkloadSharesRequest) This is a variant oflistWorkloadShares(software.amazon.awssdk.services.wellarchitected.model.ListWorkloadSharesRequest)
operation.default ListWorkloadsPublisher
listWorkloadsPaginator
(Consumer<ListWorkloadsRequest.Builder> listWorkloadsRequest) This is a variant oflistWorkloads(software.amazon.awssdk.services.wellarchitected.model.ListWorkloadsRequest)
operation.default ListWorkloadsPublisher
listWorkloadsPaginator
(ListWorkloadsRequest listWorkloadsRequest) This is a variant oflistWorkloads(software.amazon.awssdk.services.wellarchitected.model.ListWorkloadsRequest)
operation.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds one or more tags to the specified resource.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Adds one or more tags to the specified resource.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Deletes specified tags from a resource.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Deletes specified tags from a resource.default CompletableFuture
<UpdateAnswerResponse> updateAnswer
(Consumer<UpdateAnswerRequest.Builder> updateAnswerRequest) Update the answer to a specific question in a workload review.default CompletableFuture
<UpdateAnswerResponse> updateAnswer
(UpdateAnswerRequest updateAnswerRequest) Update the answer to a specific question in a workload review.updateGlobalSettings
(Consumer<UpdateGlobalSettingsRequest.Builder> updateGlobalSettingsRequest) Update whether the Amazon Web Services account is opted into organization sharing and discovery integration features.updateGlobalSettings
(UpdateGlobalSettingsRequest updateGlobalSettingsRequest) Update whether the Amazon Web Services account is opted into organization sharing and discovery integration features.updateIntegration
(Consumer<UpdateIntegrationRequest.Builder> updateIntegrationRequest) Update integration features.updateIntegration
(UpdateIntegrationRequest updateIntegrationRequest) Update integration features.updateLensReview
(Consumer<UpdateLensReviewRequest.Builder> updateLensReviewRequest) Update lens review for a particular workload.updateLensReview
(UpdateLensReviewRequest updateLensReviewRequest) Update lens review for a particular workload.default CompletableFuture
<UpdateProfileResponse> updateProfile
(Consumer<UpdateProfileRequest.Builder> updateProfileRequest) Update a profile.default CompletableFuture
<UpdateProfileResponse> updateProfile
(UpdateProfileRequest updateProfileRequest) Update a profile.updateReviewTemplate
(Consumer<UpdateReviewTemplateRequest.Builder> updateReviewTemplateRequest) Update a review template.updateReviewTemplate
(UpdateReviewTemplateRequest updateReviewTemplateRequest) Update a review template.updateReviewTemplateAnswer
(Consumer<UpdateReviewTemplateAnswerRequest.Builder> updateReviewTemplateAnswerRequest) Update a review template answer.updateReviewTemplateAnswer
(UpdateReviewTemplateAnswerRequest updateReviewTemplateAnswerRequest) Update a review template answer.updateReviewTemplateLensReview
(Consumer<UpdateReviewTemplateLensReviewRequest.Builder> updateReviewTemplateLensReviewRequest) Update a lens review associated with a review template.updateReviewTemplateLensReview
(UpdateReviewTemplateLensReviewRequest updateReviewTemplateLensReviewRequest) Update a lens review associated with a review template.updateShareInvitation
(Consumer<UpdateShareInvitationRequest.Builder> updateShareInvitationRequest) Update a workload or custom lens share invitation.updateShareInvitation
(UpdateShareInvitationRequest updateShareInvitationRequest) Update a workload or custom lens share invitation.default CompletableFuture
<UpdateWorkloadResponse> updateWorkload
(Consumer<UpdateWorkloadRequest.Builder> updateWorkloadRequest) Update an existing workload.default CompletableFuture
<UpdateWorkloadResponse> updateWorkload
(UpdateWorkloadRequest updateWorkloadRequest) Update an existing workload.updateWorkloadShare
(Consumer<UpdateWorkloadShareRequest.Builder> updateWorkloadShareRequest) Update a workload share.updateWorkloadShare
(UpdateWorkloadShareRequest updateWorkloadShareRequest) Update a workload share.upgradeLensReview
(Consumer<UpgradeLensReviewRequest.Builder> upgradeLensReviewRequest) Upgrade lens review for a particular workload.upgradeLensReview
(UpgradeLensReviewRequest upgradeLensReviewRequest) Upgrade lens review for a particular workload.upgradeProfileVersion
(Consumer<UpgradeProfileVersionRequest.Builder> upgradeProfileVersionRequest) Upgrade a profile.upgradeProfileVersion
(UpgradeProfileVersionRequest upgradeProfileVersionRequest) Upgrade a profile.upgradeReviewTemplateLensReview
(Consumer<UpgradeReviewTemplateLensReviewRequest.Builder> upgradeReviewTemplateLensReviewRequest) Upgrade the lens review of a review template.upgradeReviewTemplateLensReview
(UpgradeReviewTemplateLensReviewRequest upgradeReviewTemplateLensReviewRequest) Upgrade the lens review of a review template.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
associateLenses
default CompletableFuture<AssociateLensesResponse> associateLenses(AssociateLensesRequest associateLensesRequest) 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.
- Parameters:
associateLensesRequest
- Input to associate lens reviews.- Returns:
- A Java Future containing the result of the AssociateLenses operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- ConflictException The resource has already been processed, was deleted, or is too large.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
associateLenses
default CompletableFuture<AssociateLensesResponse> associateLenses(Consumer<AssociateLensesRequest.Builder> associateLensesRequest) 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.
This is a convenience which creates an instance of the
AssociateLensesRequest.Builder
avoiding the need to create one manually viaAssociateLensesRequest.builder()
- Parameters:
associateLensesRequest
- AConsumer
that will call methods onAssociateLensesRequest.Builder
to create a request. Input to associate lens reviews.- Returns:
- A Java Future containing the result of the AssociateLenses operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- ConflictException The resource has already been processed, was deleted, or is too large.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
associateProfiles
default CompletableFuture<AssociateProfilesResponse> associateProfiles(AssociateProfilesRequest associateProfilesRequest) Associate a profile with a workload.
- Parameters:
associateProfilesRequest
-- Returns:
- A Java Future containing the result of the AssociateProfiles operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- ConflictException The resource has already been processed, was deleted, or is too large.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
associateProfiles
default CompletableFuture<AssociateProfilesResponse> associateProfiles(Consumer<AssociateProfilesRequest.Builder> associateProfilesRequest) Associate a profile with a workload.
This is a convenience which creates an instance of the
AssociateProfilesRequest.Builder
avoiding the need to create one manually viaAssociateProfilesRequest.builder()
- Parameters:
associateProfilesRequest
- AConsumer
that will call methods onAssociateProfilesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AssociateProfiles operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- ConflictException The resource has already been processed, was deleted, or is too large.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createLensVersion
default CompletableFuture<CreateLensVersionResponse> createLensVersion(CreateLensVersionRequest createLensVersionRequest) 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.- Parameters:
createLensVersionRequest
-- Returns:
- A Java Future containing the result of the CreateLensVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- ServiceQuotaExceededException The user has reached their resource quota.
- ConflictException The resource has already been processed, was deleted, or is too large.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createLensVersion
default CompletableFuture<CreateLensVersionResponse> createLensVersion(Consumer<CreateLensVersionRequest.Builder> createLensVersionRequest) 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.
This is a convenience which creates an instance of the
CreateLensVersionRequest.Builder
avoiding the need to create one manually viaCreateLensVersionRequest.builder()
- Parameters:
createLensVersionRequest
- AConsumer
that will call methods onCreateLensVersionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateLensVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- ServiceQuotaExceededException The user has reached their resource quota.
- ConflictException The resource has already been processed, was deleted, or is too large.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createMilestone
default CompletableFuture<CreateMilestoneResponse> createMilestone(CreateMilestoneRequest createMilestoneRequest) Create a milestone for an existing workload.
- Parameters:
createMilestoneRequest
- Input for milestone creation.- Returns:
- A Java Future containing the result of the CreateMilestone operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ConflictException The resource has already been processed, was deleted, or is too large.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- ResourceNotFoundException The requested resource was not found.
- ServiceQuotaExceededException The user has reached their resource quota.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createMilestone
default CompletableFuture<CreateMilestoneResponse> createMilestone(Consumer<CreateMilestoneRequest.Builder> createMilestoneRequest) Create a milestone for an existing workload.
This is a convenience which creates an instance of the
CreateMilestoneRequest.Builder
avoiding the need to create one manually viaCreateMilestoneRequest.builder()
- Parameters:
createMilestoneRequest
- AConsumer
that will call methods onCreateMilestoneRequest.Builder
to create a request. Input for milestone creation.- Returns:
- A Java Future containing the result of the CreateMilestone operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ConflictException The resource has already been processed, was deleted, or is too large.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- ResourceNotFoundException The requested resource was not found.
- ServiceQuotaExceededException The user has reached their resource quota.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createProfile
default CompletableFuture<CreateProfileResponse> createProfile(CreateProfileRequest createProfileRequest) Create a profile.
- Parameters:
createProfileRequest
-- Returns:
- A Java Future containing the result of the CreateProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ConflictException The resource has already been processed, was deleted, or is too large.
- ServiceQuotaExceededException The user has reached their resource quota.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createProfile
default CompletableFuture<CreateProfileResponse> createProfile(Consumer<CreateProfileRequest.Builder> createProfileRequest) Create a profile.
This is a convenience which creates an instance of the
CreateProfileRequest.Builder
avoiding the need to create one manually viaCreateProfileRequest.builder()
- Parameters:
createProfileRequest
- AConsumer
that will call methods onCreateProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ConflictException The resource has already been processed, was deleted, or is too large.
- ServiceQuotaExceededException The user has reached their resource quota.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createReviewTemplate
default CompletableFuture<CreateReviewTemplateResponse> createReviewTemplate(CreateReviewTemplateRequest createReviewTemplateRequest) 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.
- Parameters:
createReviewTemplateRequest
-- Returns:
- A Java Future containing the result of the CreateReviewTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ConflictException The resource has already been processed, was deleted, or is too large.
- ServiceQuotaExceededException The user has reached their resource quota.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ResourceNotFoundException The requested resource was not found.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createReviewTemplate
default CompletableFuture<CreateReviewTemplateResponse> createReviewTemplate(Consumer<CreateReviewTemplateRequest.Builder> createReviewTemplateRequest) 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.
This is a convenience which creates an instance of the
CreateReviewTemplateRequest.Builder
avoiding the need to create one manually viaCreateReviewTemplateRequest.builder()
- Parameters:
createReviewTemplateRequest
- AConsumer
that will call methods onCreateReviewTemplateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateReviewTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ConflictException The resource has already been processed, was deleted, or is too large.
- ServiceQuotaExceededException The user has reached their resource quota.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ResourceNotFoundException The requested resource was not found.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createWorkload
default CompletableFuture<CreateWorkloadResponse> createWorkload(CreateWorkloadRequest createWorkloadRequest) 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
- Parameters:
createWorkloadRequest
- Input for workload creation.- Returns:
- A Java Future containing the result of the CreateWorkload operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ConflictException The resource has already been processed, was deleted, or is too large.
- ServiceQuotaExceededException The user has reached their resource quota.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ResourceNotFoundException The requested resource was not found.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createWorkload
default CompletableFuture<CreateWorkloadResponse> createWorkload(Consumer<CreateWorkloadRequest.Builder> createWorkloadRequest) 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
This is a convenience which creates an instance of the
CreateWorkloadRequest.Builder
avoiding the need to create one manually viaCreateWorkloadRequest.builder()
- Parameters:
createWorkloadRequest
- AConsumer
that will call methods onCreateWorkloadRequest.Builder
to create a request. Input for workload creation.- Returns:
- A Java Future containing the result of the CreateWorkload operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ConflictException The resource has already been processed, was deleted, or is too large.
- ServiceQuotaExceededException The user has reached their resource quota.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ResourceNotFoundException The requested resource was not found.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
deleteLens
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.
- Parameters:
deleteLensRequest
-- Returns:
- A Java Future containing the result of the DeleteLens operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- ConflictException The resource has already been processed, was deleted, or is too large.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteLens
default CompletableFuture<DeleteLensResponse> deleteLens(Consumer<DeleteLensRequest.Builder> deleteLensRequest) 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.
This is a convenience which creates an instance of the
DeleteLensRequest.Builder
avoiding the need to create one manually viaDeleteLensRequest.builder()
- Parameters:
deleteLensRequest
- AConsumer
that will call methods onDeleteLensRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteLens operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- ConflictException The resource has already been processed, was deleted, or is too large.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteProfile
default CompletableFuture<DeleteProfileResponse> deleteProfile(DeleteProfileRequest deleteProfileRequest) 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.
- Parameters:
deleteProfileRequest
-- Returns:
- A Java Future containing the result of the DeleteProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- ConflictException The resource has already been processed, was deleted, or is too large.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteProfile
default CompletableFuture<DeleteProfileResponse> deleteProfile(Consumer<DeleteProfileRequest.Builder> deleteProfileRequest) 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.
This is a convenience which creates an instance of the
DeleteProfileRequest.Builder
avoiding the need to create one manually viaDeleteProfileRequest.builder()
- Parameters:
deleteProfileRequest
- AConsumer
that will call methods onDeleteProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- ConflictException The resource has already been processed, was deleted, or is too large.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteReviewTemplate
default CompletableFuture<DeleteReviewTemplateResponse> deleteReviewTemplate(DeleteReviewTemplateRequest deleteReviewTemplateRequest) 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.
- Parameters:
deleteReviewTemplateRequest
-- Returns:
- A Java Future containing the result of the DeleteReviewTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- ConflictException The resource has already been processed, was deleted, or is too large.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteReviewTemplate
default CompletableFuture<DeleteReviewTemplateResponse> deleteReviewTemplate(Consumer<DeleteReviewTemplateRequest.Builder> deleteReviewTemplateRequest) 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.
This is a convenience which creates an instance of the
DeleteReviewTemplateRequest.Builder
avoiding the need to create one manually viaDeleteReviewTemplateRequest.builder()
- Parameters:
deleteReviewTemplateRequest
- AConsumer
that will call methods onDeleteReviewTemplateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteReviewTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- ConflictException The resource has already been processed, was deleted, or is too large.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteWorkload
default CompletableFuture<DeleteWorkloadResponse> deleteWorkload(DeleteWorkloadRequest deleteWorkloadRequest) Delete an existing workload.
- Parameters:
deleteWorkloadRequest
- Input for workload deletion.- Returns:
- A Java Future containing the result of the DeleteWorkload operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- ConflictException The resource has already been processed, was deleted, or is too large.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteWorkload
default CompletableFuture<DeleteWorkloadResponse> deleteWorkload(Consumer<DeleteWorkloadRequest.Builder> deleteWorkloadRequest) Delete an existing workload.
This is a convenience which creates an instance of the
DeleteWorkloadRequest.Builder
avoiding the need to create one manually viaDeleteWorkloadRequest.builder()
- Parameters:
deleteWorkloadRequest
- AConsumer
that will call methods onDeleteWorkloadRequest.Builder
to create a request. Input for workload deletion.- Returns:
- A Java Future containing the result of the DeleteWorkload operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- ConflictException The resource has already been processed, was deleted, or is too large.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disassociateLenses
default CompletableFuture<DisassociateLensesResponse> disassociateLenses(DisassociateLensesRequest disassociateLensesRequest) 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.- Parameters:
disassociateLensesRequest
- Input to disassociate lens reviews.- Returns:
- A Java Future containing the result of the DisassociateLenses operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- ConflictException The resource has already been processed, was deleted, or is too large.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disassociateLenses
default CompletableFuture<DisassociateLensesResponse> disassociateLenses(Consumer<DisassociateLensesRequest.Builder> disassociateLensesRequest) 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.
This is a convenience which creates an instance of the
DisassociateLensesRequest.Builder
avoiding the need to create one manually viaDisassociateLensesRequest.builder()
- Parameters:
disassociateLensesRequest
- AConsumer
that will call methods onDisassociateLensesRequest.Builder
to create a request. Input to disassociate lens reviews.- Returns:
- A Java Future containing the result of the DisassociateLenses operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- ConflictException The resource has already been processed, was deleted, or is too large.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disassociateProfiles
default CompletableFuture<DisassociateProfilesResponse> disassociateProfiles(DisassociateProfilesRequest disassociateProfilesRequest) Disassociate a profile from a workload.
- Parameters:
disassociateProfilesRequest
-- Returns:
- A Java Future containing the result of the DisassociateProfiles operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- ConflictException The resource has already been processed, was deleted, or is too large.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disassociateProfiles
default CompletableFuture<DisassociateProfilesResponse> disassociateProfiles(Consumer<DisassociateProfilesRequest.Builder> disassociateProfilesRequest) Disassociate a profile from a workload.
This is a convenience which creates an instance of the
DisassociateProfilesRequest.Builder
avoiding the need to create one manually viaDisassociateProfilesRequest.builder()
- Parameters:
disassociateProfilesRequest
- AConsumer
that will call methods onDisassociateProfilesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DisassociateProfiles operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- ConflictException The resource has already been processed, was deleted, or is too large.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
exportLens
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.
- Parameters:
exportLensRequest
-- Returns:
- A Java Future containing the result of the ExportLens operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
exportLens
default CompletableFuture<ExportLensResponse> exportLens(Consumer<ExportLensRequest.Builder> exportLensRequest) 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.
This is a convenience which creates an instance of the
ExportLensRequest.Builder
avoiding the need to create one manually viaExportLensRequest.builder()
- Parameters:
exportLensRequest
- AConsumer
that will call methods onExportLensRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ExportLens operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAnswer
Get the answer to a specific question in a workload review.
- Parameters:
getAnswerRequest
- Input to get answer.- Returns:
- A Java Future containing the result of the GetAnswer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAnswer
default CompletableFuture<GetAnswerResponse> getAnswer(Consumer<GetAnswerRequest.Builder> getAnswerRequest) Get the answer to a specific question in a workload review.
This is a convenience which creates an instance of the
GetAnswerRequest.Builder
avoiding the need to create one manually viaGetAnswerRequest.builder()
- Parameters:
getAnswerRequest
- AConsumer
that will call methods onGetAnswerRequest.Builder
to create a request. Input to get answer.- Returns:
- A Java Future containing the result of the GetAnswer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getConsolidatedReport
default CompletableFuture<GetConsolidatedReportResponse> getConsolidatedReport(GetConsolidatedReportRequest getConsolidatedReportRequest) Get a consolidated report of your workloads.
You can optionally choose to include workloads that have been shared with you.
- Parameters:
getConsolidatedReportRequest
-- Returns:
- A Java Future containing the result of the GetConsolidatedReport operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- ConflictException The resource has already been processed, was deleted, or is too large.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getConsolidatedReport
default CompletableFuture<GetConsolidatedReportResponse> getConsolidatedReport(Consumer<GetConsolidatedReportRequest.Builder> getConsolidatedReportRequest) Get a consolidated report of your workloads.
You can optionally choose to include workloads that have been shared with you.
This is a convenience which creates an instance of the
GetConsolidatedReportRequest.Builder
avoiding the need to create one manually viaGetConsolidatedReportRequest.builder()
- Parameters:
getConsolidatedReportRequest
- AConsumer
that will call methods onGetConsolidatedReportRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetConsolidatedReport operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- ConflictException The resource has already been processed, was deleted, or is too large.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getConsolidatedReportPaginator
default GetConsolidatedReportPublisher getConsolidatedReportPaginator(GetConsolidatedReportRequest getConsolidatedReportRequest) This is a variant of
getConsolidatedReport(software.amazon.awssdk.services.wellarchitected.model.GetConsolidatedReportRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.wellarchitected.paginators.GetConsolidatedReportPublisher publisher = client.getConsolidatedReportPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.wellarchitected.paginators.GetConsolidatedReportPublisher publisher = client.getConsolidatedReportPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.wellarchitected.model.GetConsolidatedReportResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.wellarchitected.model.GetConsolidatedReportResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getConsolidatedReport(software.amazon.awssdk.services.wellarchitected.model.GetConsolidatedReportRequest)
operation.- Parameters:
getConsolidatedReportRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- ConflictException The resource has already been processed, was deleted, or is too large.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getConsolidatedReportPaginator
default GetConsolidatedReportPublisher getConsolidatedReportPaginator(Consumer<GetConsolidatedReportRequest.Builder> getConsolidatedReportRequest) This is a variant of
getConsolidatedReport(software.amazon.awssdk.services.wellarchitected.model.GetConsolidatedReportRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.wellarchitected.paginators.GetConsolidatedReportPublisher publisher = client.getConsolidatedReportPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.wellarchitected.paginators.GetConsolidatedReportPublisher publisher = client.getConsolidatedReportPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.wellarchitected.model.GetConsolidatedReportResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.wellarchitected.model.GetConsolidatedReportResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getConsolidatedReport(software.amazon.awssdk.services.wellarchitected.model.GetConsolidatedReportRequest)
operation.
This is a convenience which creates an instance of the
GetConsolidatedReportRequest.Builder
avoiding the need to create one manually viaGetConsolidatedReportRequest.builder()
- Parameters:
getConsolidatedReportRequest
- AConsumer
that will call methods onGetConsolidatedReportRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- ConflictException The resource has already been processed, was deleted, or is too large.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getGlobalSettings
default CompletableFuture<GetGlobalSettingsResponse> getGlobalSettings(GetGlobalSettingsRequest getGlobalSettingsRequest) Global settings for all workloads.
- Parameters:
getGlobalSettingsRequest
-- Returns:
- A Java Future containing the result of the GetGlobalSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getGlobalSettings
default CompletableFuture<GetGlobalSettingsResponse> getGlobalSettings(Consumer<GetGlobalSettingsRequest.Builder> getGlobalSettingsRequest) Global settings for all workloads.
This is a convenience which creates an instance of the
GetGlobalSettingsRequest.Builder
avoiding the need to create one manually viaGetGlobalSettingsRequest.builder()
- Parameters:
getGlobalSettingsRequest
- AConsumer
that will call methods onGetGlobalSettingsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetGlobalSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getLens
Get an existing lens.
- Parameters:
getLensRequest
-- Returns:
- A Java Future containing the result of the GetLens operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getLens
Get an existing lens.
This is a convenience which creates an instance of the
GetLensRequest.Builder
avoiding the need to create one manually viaGetLensRequest.builder()
- Parameters:
getLensRequest
- AConsumer
that will call methods onGetLensRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetLens operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getLensReview
default CompletableFuture<GetLensReviewResponse> getLensReview(GetLensReviewRequest getLensReviewRequest) Get lens review.
- Parameters:
getLensReviewRequest
- Input to get lens review.- Returns:
- A Java Future containing the result of the GetLensReview operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getLensReview
default CompletableFuture<GetLensReviewResponse> getLensReview(Consumer<GetLensReviewRequest.Builder> getLensReviewRequest) Get lens review.
This is a convenience which creates an instance of the
GetLensReviewRequest.Builder
avoiding the need to create one manually viaGetLensReviewRequest.builder()
- Parameters:
getLensReviewRequest
- AConsumer
that will call methods onGetLensReviewRequest.Builder
to create a request. Input to get lens review.- Returns:
- A Java Future containing the result of the GetLensReview operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getLensReviewReport
default CompletableFuture<GetLensReviewReportResponse> getLensReviewReport(GetLensReviewReportRequest getLensReviewReportRequest) Get lens review report.
- Parameters:
getLensReviewReportRequest
- Input to get lens review report.- Returns:
- A Java Future containing the result of the GetLensReviewReport operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getLensReviewReport
default CompletableFuture<GetLensReviewReportResponse> getLensReviewReport(Consumer<GetLensReviewReportRequest.Builder> getLensReviewReportRequest) Get lens review report.
This is a convenience which creates an instance of the
GetLensReviewReportRequest.Builder
avoiding the need to create one manually viaGetLensReviewReportRequest.builder()
- Parameters:
getLensReviewReportRequest
- AConsumer
that will call methods onGetLensReviewReportRequest.Builder
to create a request. Input to get lens review report.- Returns:
- A Java Future containing the result of the GetLensReviewReport operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getLensVersionDifference
default CompletableFuture<GetLensVersionDifferenceResponse> getLensVersionDifference(GetLensVersionDifferenceRequest getLensVersionDifferenceRequest) Get lens version differences.
- Parameters:
getLensVersionDifferenceRequest
-- Returns:
- A Java Future containing the result of the GetLensVersionDifference operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getLensVersionDifference
default CompletableFuture<GetLensVersionDifferenceResponse> getLensVersionDifference(Consumer<GetLensVersionDifferenceRequest.Builder> getLensVersionDifferenceRequest) Get lens version differences.
This is a convenience which creates an instance of the
GetLensVersionDifferenceRequest.Builder
avoiding the need to create one manually viaGetLensVersionDifferenceRequest.builder()
- Parameters:
getLensVersionDifferenceRequest
- AConsumer
that will call methods onGetLensVersionDifferenceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetLensVersionDifference operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMilestone
default CompletableFuture<GetMilestoneResponse> getMilestone(GetMilestoneRequest getMilestoneRequest) Get a milestone for an existing workload.
- Parameters:
getMilestoneRequest
- Input to get a milestone.- Returns:
- A Java Future containing the result of the GetMilestone operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMilestone
default CompletableFuture<GetMilestoneResponse> getMilestone(Consumer<GetMilestoneRequest.Builder> getMilestoneRequest) Get a milestone for an existing workload.
This is a convenience which creates an instance of the
GetMilestoneRequest.Builder
avoiding the need to create one manually viaGetMilestoneRequest.builder()
- Parameters:
getMilestoneRequest
- AConsumer
that will call methods onGetMilestoneRequest.Builder
to create a request. Input to get a milestone.- Returns:
- A Java Future containing the result of the GetMilestone operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getProfile
Get profile information.
- Parameters:
getProfileRequest
-- Returns:
- A Java Future containing the result of the GetProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getProfile
default CompletableFuture<GetProfileResponse> getProfile(Consumer<GetProfileRequest.Builder> getProfileRequest) Get profile information.
This is a convenience which creates an instance of the
GetProfileRequest.Builder
avoiding the need to create one manually viaGetProfileRequest.builder()
- Parameters:
getProfileRequest
- AConsumer
that will call methods onGetProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getProfileTemplate
default CompletableFuture<GetProfileTemplateResponse> getProfileTemplate(GetProfileTemplateRequest getProfileTemplateRequest) Get profile template.
- Parameters:
getProfileTemplateRequest
-- Returns:
- A Java Future containing the result of the GetProfileTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getProfileTemplate
default CompletableFuture<GetProfileTemplateResponse> getProfileTemplate(Consumer<GetProfileTemplateRequest.Builder> getProfileTemplateRequest) Get profile template.
This is a convenience which creates an instance of the
GetProfileTemplateRequest.Builder
avoiding the need to create one manually viaGetProfileTemplateRequest.builder()
- Parameters:
getProfileTemplateRequest
- AConsumer
that will call methods onGetProfileTemplateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetProfileTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReviewTemplate
default CompletableFuture<GetReviewTemplateResponse> getReviewTemplate(GetReviewTemplateRequest getReviewTemplateRequest) Get review template.
- Parameters:
getReviewTemplateRequest
-- Returns:
- A Java Future containing the result of the GetReviewTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReviewTemplate
default CompletableFuture<GetReviewTemplateResponse> getReviewTemplate(Consumer<GetReviewTemplateRequest.Builder> getReviewTemplateRequest) Get review template.
This is a convenience which creates an instance of the
GetReviewTemplateRequest.Builder
avoiding the need to create one manually viaGetReviewTemplateRequest.builder()
- Parameters:
getReviewTemplateRequest
- AConsumer
that will call methods onGetReviewTemplateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetReviewTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReviewTemplateAnswer
default CompletableFuture<GetReviewTemplateAnswerResponse> getReviewTemplateAnswer(GetReviewTemplateAnswerRequest getReviewTemplateAnswerRequest) Get review template answer.
- Parameters:
getReviewTemplateAnswerRequest
-- Returns:
- A Java Future containing the result of the GetReviewTemplateAnswer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReviewTemplateAnswer
default CompletableFuture<GetReviewTemplateAnswerResponse> getReviewTemplateAnswer(Consumer<GetReviewTemplateAnswerRequest.Builder> getReviewTemplateAnswerRequest) Get review template answer.
This is a convenience which creates an instance of the
GetReviewTemplateAnswerRequest.Builder
avoiding the need to create one manually viaGetReviewTemplateAnswerRequest.builder()
- Parameters:
getReviewTemplateAnswerRequest
- AConsumer
that will call methods onGetReviewTemplateAnswerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetReviewTemplateAnswer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReviewTemplateLensReview
default CompletableFuture<GetReviewTemplateLensReviewResponse> getReviewTemplateLensReview(GetReviewTemplateLensReviewRequest getReviewTemplateLensReviewRequest) Get a lens review associated with a review template.
- Parameters:
getReviewTemplateLensReviewRequest
-- Returns:
- A Java Future containing the result of the GetReviewTemplateLensReview operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReviewTemplateLensReview
default CompletableFuture<GetReviewTemplateLensReviewResponse> getReviewTemplateLensReview(Consumer<GetReviewTemplateLensReviewRequest.Builder> getReviewTemplateLensReviewRequest) Get a lens review associated with a review template.
This is a convenience which creates an instance of the
GetReviewTemplateLensReviewRequest.Builder
avoiding the need to create one manually viaGetReviewTemplateLensReviewRequest.builder()
- Parameters:
getReviewTemplateLensReviewRequest
- AConsumer
that will call methods onGetReviewTemplateLensReviewRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetReviewTemplateLensReview operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getWorkload
Get an existing workload.
- Parameters:
getWorkloadRequest
- Input to get a workload.- Returns:
- A Java Future containing the result of the GetWorkload operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getWorkload
default CompletableFuture<GetWorkloadResponse> getWorkload(Consumer<GetWorkloadRequest.Builder> getWorkloadRequest) Get an existing workload.
This is a convenience which creates an instance of the
GetWorkloadRequest.Builder
avoiding the need to create one manually viaGetWorkloadRequest.builder()
- Parameters:
getWorkloadRequest
- AConsumer
that will call methods onGetWorkloadRequest.Builder
to create a request. Input to get a workload.- Returns:
- A Java Future containing the result of the GetWorkload operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
importLens
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.
- Parameters:
importLensRequest
-- Returns:
- A Java Future containing the result of the ImportLens operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ConflictException The resource has already been processed, was deleted, or is too large.
- ResourceNotFoundException The requested resource was not found.
- ServiceQuotaExceededException The user has reached their resource quota.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
importLens
default CompletableFuture<ImportLensResponse> importLens(Consumer<ImportLensRequest.Builder> importLensRequest) 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.
This is a convenience which creates an instance of the
ImportLensRequest.Builder
avoiding the need to create one manually viaImportLensRequest.builder()
- Parameters:
importLensRequest
- AConsumer
that will call methods onImportLensRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ImportLens operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ConflictException The resource has already been processed, was deleted, or is too large.
- ResourceNotFoundException The requested resource was not found.
- ServiceQuotaExceededException The user has reached their resource quota.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAnswers
List of answers for a particular workload and lens.
- Parameters:
listAnswersRequest
- Input to list answers.- Returns:
- A Java Future containing the result of the ListAnswers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- ResourceNotFoundException The requested resource was not found.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAnswers
default CompletableFuture<ListAnswersResponse> listAnswers(Consumer<ListAnswersRequest.Builder> listAnswersRequest) List of answers for a particular workload and lens.
This is a convenience which creates an instance of the
ListAnswersRequest.Builder
avoiding the need to create one manually viaListAnswersRequest.builder()
- Parameters:
listAnswersRequest
- AConsumer
that will call methods onListAnswersRequest.Builder
to create a request. Input to list answers.- Returns:
- A Java Future containing the result of the ListAnswers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- ResourceNotFoundException The requested resource was not found.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAnswersPaginator
This is a variant of
listAnswers(software.amazon.awssdk.services.wellarchitected.model.ListAnswersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.wellarchitected.paginators.ListAnswersPublisher publisher = client.listAnswersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.wellarchitected.paginators.ListAnswersPublisher publisher = client.listAnswersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.wellarchitected.model.ListAnswersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.wellarchitected.model.ListAnswersResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAnswers(software.amazon.awssdk.services.wellarchitected.model.ListAnswersRequest)
operation.- Parameters:
listAnswersRequest
- Input to list answers.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- ResourceNotFoundException The requested resource was not found.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAnswersPaginator
default ListAnswersPublisher listAnswersPaginator(Consumer<ListAnswersRequest.Builder> listAnswersRequest) This is a variant of
listAnswers(software.amazon.awssdk.services.wellarchitected.model.ListAnswersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.wellarchitected.paginators.ListAnswersPublisher publisher = client.listAnswersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.wellarchitected.paginators.ListAnswersPublisher publisher = client.listAnswersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.wellarchitected.model.ListAnswersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.wellarchitected.model.ListAnswersResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAnswers(software.amazon.awssdk.services.wellarchitected.model.ListAnswersRequest)
operation.
This is a convenience which creates an instance of the
ListAnswersRequest.Builder
avoiding the need to create one manually viaListAnswersRequest.builder()
- Parameters:
listAnswersRequest
- AConsumer
that will call methods onListAnswersRequest.Builder
to create a request. Input to list answers.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- ResourceNotFoundException The requested resource was not found.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCheckDetails
default CompletableFuture<ListCheckDetailsResponse> listCheckDetails(ListCheckDetailsRequest listCheckDetailsRequest) List of Trusted Advisor check details by account related to the workload.
- Parameters:
listCheckDetailsRequest
-- Returns:
- A Java Future containing the result of the ListCheckDetails operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCheckDetails
default CompletableFuture<ListCheckDetailsResponse> listCheckDetails(Consumer<ListCheckDetailsRequest.Builder> listCheckDetailsRequest) List of Trusted Advisor check details by account related to the workload.
This is a convenience which creates an instance of the
ListCheckDetailsRequest.Builder
avoiding the need to create one manually viaListCheckDetailsRequest.builder()
- Parameters:
listCheckDetailsRequest
- AConsumer
that will call methods onListCheckDetailsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListCheckDetails operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCheckDetailsPaginator
default ListCheckDetailsPublisher listCheckDetailsPaginator(ListCheckDetailsRequest listCheckDetailsRequest) This is a variant of
listCheckDetails(software.amazon.awssdk.services.wellarchitected.model.ListCheckDetailsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.wellarchitected.paginators.ListCheckDetailsPublisher publisher = client.listCheckDetailsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.wellarchitected.paginators.ListCheckDetailsPublisher publisher = client.listCheckDetailsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.wellarchitected.model.ListCheckDetailsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.wellarchitected.model.ListCheckDetailsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCheckDetails(software.amazon.awssdk.services.wellarchitected.model.ListCheckDetailsRequest)
operation.- Parameters:
listCheckDetailsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCheckDetailsPaginator
default ListCheckDetailsPublisher listCheckDetailsPaginator(Consumer<ListCheckDetailsRequest.Builder> listCheckDetailsRequest) This is a variant of
listCheckDetails(software.amazon.awssdk.services.wellarchitected.model.ListCheckDetailsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.wellarchitected.paginators.ListCheckDetailsPublisher publisher = client.listCheckDetailsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.wellarchitected.paginators.ListCheckDetailsPublisher publisher = client.listCheckDetailsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.wellarchitected.model.ListCheckDetailsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.wellarchitected.model.ListCheckDetailsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCheckDetails(software.amazon.awssdk.services.wellarchitected.model.ListCheckDetailsRequest)
operation.
This is a convenience which creates an instance of the
ListCheckDetailsRequest.Builder
avoiding the need to create one manually viaListCheckDetailsRequest.builder()
- Parameters:
listCheckDetailsRequest
- AConsumer
that will call methods onListCheckDetailsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCheckSummaries
default CompletableFuture<ListCheckSummariesResponse> listCheckSummaries(ListCheckSummariesRequest listCheckSummariesRequest) List of Trusted Advisor checks summarized for all accounts related to the workload.
- Parameters:
listCheckSummariesRequest
-- Returns:
- A Java Future containing the result of the ListCheckSummaries operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCheckSummaries
default CompletableFuture<ListCheckSummariesResponse> listCheckSummaries(Consumer<ListCheckSummariesRequest.Builder> listCheckSummariesRequest) List of Trusted Advisor checks summarized for all accounts related to the workload.
This is a convenience which creates an instance of the
ListCheckSummariesRequest.Builder
avoiding the need to create one manually viaListCheckSummariesRequest.builder()
- Parameters:
listCheckSummariesRequest
- AConsumer
that will call methods onListCheckSummariesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListCheckSummaries operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCheckSummariesPaginator
default ListCheckSummariesPublisher listCheckSummariesPaginator(ListCheckSummariesRequest listCheckSummariesRequest) This is a variant of
listCheckSummaries(software.amazon.awssdk.services.wellarchitected.model.ListCheckSummariesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.wellarchitected.paginators.ListCheckSummariesPublisher publisher = client.listCheckSummariesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.wellarchitected.paginators.ListCheckSummariesPublisher publisher = client.listCheckSummariesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.wellarchitected.model.ListCheckSummariesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.wellarchitected.model.ListCheckSummariesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCheckSummaries(software.amazon.awssdk.services.wellarchitected.model.ListCheckSummariesRequest)
operation.- Parameters:
listCheckSummariesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCheckSummariesPaginator
default ListCheckSummariesPublisher listCheckSummariesPaginator(Consumer<ListCheckSummariesRequest.Builder> listCheckSummariesRequest) This is a variant of
listCheckSummaries(software.amazon.awssdk.services.wellarchitected.model.ListCheckSummariesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.wellarchitected.paginators.ListCheckSummariesPublisher publisher = client.listCheckSummariesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.wellarchitected.paginators.ListCheckSummariesPublisher publisher = client.listCheckSummariesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.wellarchitected.model.ListCheckSummariesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.wellarchitected.model.ListCheckSummariesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCheckSummaries(software.amazon.awssdk.services.wellarchitected.model.ListCheckSummariesRequest)
operation.
This is a convenience which creates an instance of the
ListCheckSummariesRequest.Builder
avoiding the need to create one manually viaListCheckSummariesRequest.builder()
- Parameters:
listCheckSummariesRequest
- AConsumer
that will call methods onListCheckSummariesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listLensReviewImprovements
default CompletableFuture<ListLensReviewImprovementsResponse> listLensReviewImprovements(ListLensReviewImprovementsRequest listLensReviewImprovementsRequest) List the improvements of a particular lens review.
- Parameters:
listLensReviewImprovementsRequest
- Input to list lens review improvements.- Returns:
- A Java Future containing the result of the ListLensReviewImprovements operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- ResourceNotFoundException The requested resource was not found.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listLensReviewImprovements
default CompletableFuture<ListLensReviewImprovementsResponse> listLensReviewImprovements(Consumer<ListLensReviewImprovementsRequest.Builder> listLensReviewImprovementsRequest) List the improvements of a particular lens review.
This is a convenience which creates an instance of the
ListLensReviewImprovementsRequest.Builder
avoiding the need to create one manually viaListLensReviewImprovementsRequest.builder()
- Parameters:
listLensReviewImprovementsRequest
- AConsumer
that will call methods onListLensReviewImprovementsRequest.Builder
to create a request. Input to list lens review improvements.- Returns:
- A Java Future containing the result of the ListLensReviewImprovements operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- ResourceNotFoundException The requested resource was not found.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listLensReviewImprovementsPaginator
default ListLensReviewImprovementsPublisher listLensReviewImprovementsPaginator(ListLensReviewImprovementsRequest listLensReviewImprovementsRequest) This is a variant of
listLensReviewImprovements(software.amazon.awssdk.services.wellarchitected.model.ListLensReviewImprovementsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.wellarchitected.paginators.ListLensReviewImprovementsPublisher publisher = client.listLensReviewImprovementsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.wellarchitected.paginators.ListLensReviewImprovementsPublisher publisher = client.listLensReviewImprovementsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.wellarchitected.model.ListLensReviewImprovementsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.wellarchitected.model.ListLensReviewImprovementsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listLensReviewImprovements(software.amazon.awssdk.services.wellarchitected.model.ListLensReviewImprovementsRequest)
operation.- Parameters:
listLensReviewImprovementsRequest
- Input to list lens review improvements.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- ResourceNotFoundException The requested resource was not found.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listLensReviewImprovementsPaginator
default ListLensReviewImprovementsPublisher listLensReviewImprovementsPaginator(Consumer<ListLensReviewImprovementsRequest.Builder> listLensReviewImprovementsRequest) This is a variant of
listLensReviewImprovements(software.amazon.awssdk.services.wellarchitected.model.ListLensReviewImprovementsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.wellarchitected.paginators.ListLensReviewImprovementsPublisher publisher = client.listLensReviewImprovementsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.wellarchitected.paginators.ListLensReviewImprovementsPublisher publisher = client.listLensReviewImprovementsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.wellarchitected.model.ListLensReviewImprovementsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.wellarchitected.model.ListLensReviewImprovementsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listLensReviewImprovements(software.amazon.awssdk.services.wellarchitected.model.ListLensReviewImprovementsRequest)
operation.
This is a convenience which creates an instance of the
ListLensReviewImprovementsRequest.Builder
avoiding the need to create one manually viaListLensReviewImprovementsRequest.builder()
- Parameters:
listLensReviewImprovementsRequest
- AConsumer
that will call methods onListLensReviewImprovementsRequest.Builder
to create a request. Input to list lens review improvements.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- ResourceNotFoundException The requested resource was not found.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listLensReviews
default CompletableFuture<ListLensReviewsResponse> listLensReviews(ListLensReviewsRequest listLensReviewsRequest) List lens reviews for a particular workload.
- Parameters:
listLensReviewsRequest
- Input to list lens reviews.- Returns:
- A Java Future containing the result of the ListLensReviews operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- ResourceNotFoundException The requested resource was not found.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listLensReviews
default CompletableFuture<ListLensReviewsResponse> listLensReviews(Consumer<ListLensReviewsRequest.Builder> listLensReviewsRequest) List lens reviews for a particular workload.
This is a convenience which creates an instance of the
ListLensReviewsRequest.Builder
avoiding the need to create one manually viaListLensReviewsRequest.builder()
- Parameters:
listLensReviewsRequest
- AConsumer
that will call methods onListLensReviewsRequest.Builder
to create a request. Input to list lens reviews.- Returns:
- A Java Future containing the result of the ListLensReviews operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- ResourceNotFoundException The requested resource was not found.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listLensReviewsPaginator
default ListLensReviewsPublisher listLensReviewsPaginator(ListLensReviewsRequest listLensReviewsRequest) This is a variant of
listLensReviews(software.amazon.awssdk.services.wellarchitected.model.ListLensReviewsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.wellarchitected.paginators.ListLensReviewsPublisher publisher = client.listLensReviewsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.wellarchitected.paginators.ListLensReviewsPublisher publisher = client.listLensReviewsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.wellarchitected.model.ListLensReviewsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.wellarchitected.model.ListLensReviewsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listLensReviews(software.amazon.awssdk.services.wellarchitected.model.ListLensReviewsRequest)
operation.- Parameters:
listLensReviewsRequest
- Input to list lens reviews.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- ResourceNotFoundException The requested resource was not found.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listLensReviewsPaginator
default ListLensReviewsPublisher listLensReviewsPaginator(Consumer<ListLensReviewsRequest.Builder> listLensReviewsRequest) This is a variant of
listLensReviews(software.amazon.awssdk.services.wellarchitected.model.ListLensReviewsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.wellarchitected.paginators.ListLensReviewsPublisher publisher = client.listLensReviewsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.wellarchitected.paginators.ListLensReviewsPublisher publisher = client.listLensReviewsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.wellarchitected.model.ListLensReviewsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.wellarchitected.model.ListLensReviewsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listLensReviews(software.amazon.awssdk.services.wellarchitected.model.ListLensReviewsRequest)
operation.
This is a convenience which creates an instance of the
ListLensReviewsRequest.Builder
avoiding the need to create one manually viaListLensReviewsRequest.builder()
- Parameters:
listLensReviewsRequest
- AConsumer
that will call methods onListLensReviewsRequest.Builder
to create a request. Input to list lens reviews.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- ResourceNotFoundException The requested resource was not found.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listLenses
List the available lenses.
- Parameters:
listLensesRequest
- Input to list lenses.- Returns:
- A Java Future containing the result of the ListLenses operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listLenses
default CompletableFuture<ListLensesResponse> listLenses(Consumer<ListLensesRequest.Builder> listLensesRequest) List the available lenses.
This is a convenience which creates an instance of the
ListLensesRequest.Builder
avoiding the need to create one manually viaListLensesRequest.builder()
- Parameters:
listLensesRequest
- AConsumer
that will call methods onListLensesRequest.Builder
to create a request. Input to list lenses.- Returns:
- A Java Future containing the result of the ListLenses operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listLensesPaginator
This is a variant of
listLenses(software.amazon.awssdk.services.wellarchitected.model.ListLensesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.wellarchitected.paginators.ListLensesPublisher publisher = client.listLensesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.wellarchitected.paginators.ListLensesPublisher publisher = client.listLensesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.wellarchitected.model.ListLensesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.wellarchitected.model.ListLensesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listLenses(software.amazon.awssdk.services.wellarchitected.model.ListLensesRequest)
operation.- Parameters:
listLensesRequest
- Input to list lenses.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listLensesPaginator
default ListLensesPublisher listLensesPaginator(Consumer<ListLensesRequest.Builder> listLensesRequest) This is a variant of
listLenses(software.amazon.awssdk.services.wellarchitected.model.ListLensesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.wellarchitected.paginators.ListLensesPublisher publisher = client.listLensesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.wellarchitected.paginators.ListLensesPublisher publisher = client.listLensesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.wellarchitected.model.ListLensesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.wellarchitected.model.ListLensesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listLenses(software.amazon.awssdk.services.wellarchitected.model.ListLensesRequest)
operation.
This is a convenience which creates an instance of the
ListLensesRequest.Builder
avoiding the need to create one manually viaListLensesRequest.builder()
- Parameters:
listLensesRequest
- AConsumer
that will call methods onListLensesRequest.Builder
to create a request. Input to list lenses.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMilestones
default CompletableFuture<ListMilestonesResponse> listMilestones(ListMilestonesRequest listMilestonesRequest) List all milestones for an existing workload.
- Parameters:
listMilestonesRequest
- Input to list all milestones for a workload.- Returns:
- A Java Future containing the result of the ListMilestones operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- ResourceNotFoundException The requested resource was not found.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMilestones
default CompletableFuture<ListMilestonesResponse> listMilestones(Consumer<ListMilestonesRequest.Builder> listMilestonesRequest) List all milestones for an existing workload.
This is a convenience which creates an instance of the
ListMilestonesRequest.Builder
avoiding the need to create one manually viaListMilestonesRequest.builder()
- Parameters:
listMilestonesRequest
- AConsumer
that will call methods onListMilestonesRequest.Builder
to create a request. Input to list all milestones for a workload.- Returns:
- A Java Future containing the result of the ListMilestones operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- ResourceNotFoundException The requested resource was not found.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMilestonesPaginator
default ListMilestonesPublisher listMilestonesPaginator(ListMilestonesRequest listMilestonesRequest) This is a variant of
listMilestones(software.amazon.awssdk.services.wellarchitected.model.ListMilestonesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.wellarchitected.paginators.ListMilestonesPublisher publisher = client.listMilestonesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.wellarchitected.paginators.ListMilestonesPublisher publisher = client.listMilestonesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.wellarchitected.model.ListMilestonesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.wellarchitected.model.ListMilestonesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMilestones(software.amazon.awssdk.services.wellarchitected.model.ListMilestonesRequest)
operation.- Parameters:
listMilestonesRequest
- Input to list all milestones for a workload.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- ResourceNotFoundException The requested resource was not found.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMilestonesPaginator
default ListMilestonesPublisher listMilestonesPaginator(Consumer<ListMilestonesRequest.Builder> listMilestonesRequest) This is a variant of
listMilestones(software.amazon.awssdk.services.wellarchitected.model.ListMilestonesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.wellarchitected.paginators.ListMilestonesPublisher publisher = client.listMilestonesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.wellarchitected.paginators.ListMilestonesPublisher publisher = client.listMilestonesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.wellarchitected.model.ListMilestonesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.wellarchitected.model.ListMilestonesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMilestones(software.amazon.awssdk.services.wellarchitected.model.ListMilestonesRequest)
operation.
This is a convenience which creates an instance of the
ListMilestonesRequest.Builder
avoiding the need to create one manually viaListMilestonesRequest.builder()
- Parameters:
listMilestonesRequest
- AConsumer
that will call methods onListMilestonesRequest.Builder
to create a request. Input to list all milestones for a workload.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- ResourceNotFoundException The requested resource was not found.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listNotifications
default CompletableFuture<ListNotificationsResponse> listNotifications(ListNotificationsRequest listNotificationsRequest) List lens notifications.
- Parameters:
listNotificationsRequest
-- Returns:
- A Java Future containing the result of the ListNotifications operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listNotifications
default CompletableFuture<ListNotificationsResponse> listNotifications(Consumer<ListNotificationsRequest.Builder> listNotificationsRequest) List lens notifications.
This is a convenience which creates an instance of the
ListNotificationsRequest.Builder
avoiding the need to create one manually viaListNotificationsRequest.builder()
- Parameters:
listNotificationsRequest
- AConsumer
that will call methods onListNotificationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListNotifications operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listNotificationsPaginator
default ListNotificationsPublisher listNotificationsPaginator(ListNotificationsRequest listNotificationsRequest) This is a variant of
listNotifications(software.amazon.awssdk.services.wellarchitected.model.ListNotificationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.wellarchitected.paginators.ListNotificationsPublisher publisher = client.listNotificationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.wellarchitected.paginators.ListNotificationsPublisher publisher = client.listNotificationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.wellarchitected.model.ListNotificationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.wellarchitected.model.ListNotificationsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listNotifications(software.amazon.awssdk.services.wellarchitected.model.ListNotificationsRequest)
operation.- Parameters:
listNotificationsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listNotificationsPaginator
default ListNotificationsPublisher listNotificationsPaginator(Consumer<ListNotificationsRequest.Builder> listNotificationsRequest) This is a variant of
listNotifications(software.amazon.awssdk.services.wellarchitected.model.ListNotificationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.wellarchitected.paginators.ListNotificationsPublisher publisher = client.listNotificationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.wellarchitected.paginators.ListNotificationsPublisher publisher = client.listNotificationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.wellarchitected.model.ListNotificationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.wellarchitected.model.ListNotificationsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listNotifications(software.amazon.awssdk.services.wellarchitected.model.ListNotificationsRequest)
operation.
This is a convenience which creates an instance of the
ListNotificationsRequest.Builder
avoiding the need to create one manually viaListNotificationsRequest.builder()
- Parameters:
listNotificationsRequest
- AConsumer
that will call methods onListNotificationsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProfileNotifications
default CompletableFuture<ListProfileNotificationsResponse> listProfileNotifications(ListProfileNotificationsRequest listProfileNotificationsRequest) List profile notifications.
- Parameters:
listProfileNotificationsRequest
-- Returns:
- A Java Future containing the result of the ListProfileNotifications operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProfileNotifications
default CompletableFuture<ListProfileNotificationsResponse> listProfileNotifications(Consumer<ListProfileNotificationsRequest.Builder> listProfileNotificationsRequest) List profile notifications.
This is a convenience which creates an instance of the
ListProfileNotificationsRequest.Builder
avoiding the need to create one manually viaListProfileNotificationsRequest.builder()
- Parameters:
listProfileNotificationsRequest
- AConsumer
that will call methods onListProfileNotificationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListProfileNotifications operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProfileNotificationsPaginator
default ListProfileNotificationsPublisher listProfileNotificationsPaginator(ListProfileNotificationsRequest listProfileNotificationsRequest) This is a variant of
listProfileNotifications(software.amazon.awssdk.services.wellarchitected.model.ListProfileNotificationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.wellarchitected.paginators.ListProfileNotificationsPublisher publisher = client.listProfileNotificationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.wellarchitected.paginators.ListProfileNotificationsPublisher publisher = client.listProfileNotificationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.wellarchitected.model.ListProfileNotificationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.wellarchitected.model.ListProfileNotificationsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProfileNotifications(software.amazon.awssdk.services.wellarchitected.model.ListProfileNotificationsRequest)
operation.- Parameters:
listProfileNotificationsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProfileNotificationsPaginator
default ListProfileNotificationsPublisher listProfileNotificationsPaginator(Consumer<ListProfileNotificationsRequest.Builder> listProfileNotificationsRequest) This is a variant of
listProfileNotifications(software.amazon.awssdk.services.wellarchitected.model.ListProfileNotificationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.wellarchitected.paginators.ListProfileNotificationsPublisher publisher = client.listProfileNotificationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.wellarchitected.paginators.ListProfileNotificationsPublisher publisher = client.listProfileNotificationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.wellarchitected.model.ListProfileNotificationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.wellarchitected.model.ListProfileNotificationsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProfileNotifications(software.amazon.awssdk.services.wellarchitected.model.ListProfileNotificationsRequest)
operation.
This is a convenience which creates an instance of the
ListProfileNotificationsRequest.Builder
avoiding the need to create one manually viaListProfileNotificationsRequest.builder()
- Parameters:
listProfileNotificationsRequest
- AConsumer
that will call methods onListProfileNotificationsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProfiles
default CompletableFuture<ListProfilesResponse> listProfiles(ListProfilesRequest listProfilesRequest) List profiles.
- Parameters:
listProfilesRequest
-- Returns:
- A Java Future containing the result of the ListProfiles operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProfiles
default CompletableFuture<ListProfilesResponse> listProfiles(Consumer<ListProfilesRequest.Builder> listProfilesRequest) List profiles.
This is a convenience which creates an instance of the
ListProfilesRequest.Builder
avoiding the need to create one manually viaListProfilesRequest.builder()
- Parameters:
listProfilesRequest
- AConsumer
that will call methods onListProfilesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListProfiles operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProfilesPaginator
This is a variant of
listProfiles(software.amazon.awssdk.services.wellarchitected.model.ListProfilesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.wellarchitected.paginators.ListProfilesPublisher publisher = client.listProfilesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.wellarchitected.paginators.ListProfilesPublisher publisher = client.listProfilesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.wellarchitected.model.ListProfilesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.wellarchitected.model.ListProfilesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProfiles(software.amazon.awssdk.services.wellarchitected.model.ListProfilesRequest)
operation.- Parameters:
listProfilesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProfilesPaginator
default ListProfilesPublisher listProfilesPaginator(Consumer<ListProfilesRequest.Builder> listProfilesRequest) This is a variant of
listProfiles(software.amazon.awssdk.services.wellarchitected.model.ListProfilesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.wellarchitected.paginators.ListProfilesPublisher publisher = client.listProfilesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.wellarchitected.paginators.ListProfilesPublisher publisher = client.listProfilesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.wellarchitected.model.ListProfilesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.wellarchitected.model.ListProfilesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProfiles(software.amazon.awssdk.services.wellarchitected.model.ListProfilesRequest)
operation.
This is a convenience which creates an instance of the
ListProfilesRequest.Builder
avoiding the need to create one manually viaListProfilesRequest.builder()
- Parameters:
listProfilesRequest
- AConsumer
that will call methods onListProfilesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReviewTemplateAnswers
default CompletableFuture<ListReviewTemplateAnswersResponse> listReviewTemplateAnswers(ListReviewTemplateAnswersRequest listReviewTemplateAnswersRequest) List the answers of a review template.
- Parameters:
listReviewTemplateAnswersRequest
-- Returns:
- A Java Future containing the result of the ListReviewTemplateAnswers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- ResourceNotFoundException The requested resource was not found.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReviewTemplateAnswers
default CompletableFuture<ListReviewTemplateAnswersResponse> listReviewTemplateAnswers(Consumer<ListReviewTemplateAnswersRequest.Builder> listReviewTemplateAnswersRequest) List the answers of a review template.
This is a convenience which creates an instance of the
ListReviewTemplateAnswersRequest.Builder
avoiding the need to create one manually viaListReviewTemplateAnswersRequest.builder()
- Parameters:
listReviewTemplateAnswersRequest
- AConsumer
that will call methods onListReviewTemplateAnswersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListReviewTemplateAnswers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- ResourceNotFoundException The requested resource was not found.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReviewTemplateAnswersPaginator
default ListReviewTemplateAnswersPublisher listReviewTemplateAnswersPaginator(ListReviewTemplateAnswersRequest listReviewTemplateAnswersRequest) This is a variant of
listReviewTemplateAnswers(software.amazon.awssdk.services.wellarchitected.model.ListReviewTemplateAnswersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.wellarchitected.paginators.ListReviewTemplateAnswersPublisher publisher = client.listReviewTemplateAnswersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.wellarchitected.paginators.ListReviewTemplateAnswersPublisher publisher = client.listReviewTemplateAnswersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.wellarchitected.model.ListReviewTemplateAnswersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.wellarchitected.model.ListReviewTemplateAnswersResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listReviewTemplateAnswers(software.amazon.awssdk.services.wellarchitected.model.ListReviewTemplateAnswersRequest)
operation.- Parameters:
listReviewTemplateAnswersRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- ResourceNotFoundException The requested resource was not found.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReviewTemplateAnswersPaginator
default ListReviewTemplateAnswersPublisher listReviewTemplateAnswersPaginator(Consumer<ListReviewTemplateAnswersRequest.Builder> listReviewTemplateAnswersRequest) This is a variant of
listReviewTemplateAnswers(software.amazon.awssdk.services.wellarchitected.model.ListReviewTemplateAnswersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.wellarchitected.paginators.ListReviewTemplateAnswersPublisher publisher = client.listReviewTemplateAnswersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.wellarchitected.paginators.ListReviewTemplateAnswersPublisher publisher = client.listReviewTemplateAnswersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.wellarchitected.model.ListReviewTemplateAnswersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.wellarchitected.model.ListReviewTemplateAnswersResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listReviewTemplateAnswers(software.amazon.awssdk.services.wellarchitected.model.ListReviewTemplateAnswersRequest)
operation.
This is a convenience which creates an instance of the
ListReviewTemplateAnswersRequest.Builder
avoiding the need to create one manually viaListReviewTemplateAnswersRequest.builder()
- Parameters:
listReviewTemplateAnswersRequest
- AConsumer
that will call methods onListReviewTemplateAnswersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- ResourceNotFoundException The requested resource was not found.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReviewTemplates
default CompletableFuture<ListReviewTemplatesResponse> listReviewTemplates(ListReviewTemplatesRequest listReviewTemplatesRequest) List review templates.
- Parameters:
listReviewTemplatesRequest
-- Returns:
- A Java Future containing the result of the ListReviewTemplates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReviewTemplates
default CompletableFuture<ListReviewTemplatesResponse> listReviewTemplates(Consumer<ListReviewTemplatesRequest.Builder> listReviewTemplatesRequest) List review templates.
This is a convenience which creates an instance of the
ListReviewTemplatesRequest.Builder
avoiding the need to create one manually viaListReviewTemplatesRequest.builder()
- Parameters:
listReviewTemplatesRequest
- AConsumer
that will call methods onListReviewTemplatesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListReviewTemplates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReviewTemplatesPaginator
default ListReviewTemplatesPublisher listReviewTemplatesPaginator(ListReviewTemplatesRequest listReviewTemplatesRequest) This is a variant of
listReviewTemplates(software.amazon.awssdk.services.wellarchitected.model.ListReviewTemplatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.wellarchitected.paginators.ListReviewTemplatesPublisher publisher = client.listReviewTemplatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.wellarchitected.paginators.ListReviewTemplatesPublisher publisher = client.listReviewTemplatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.wellarchitected.model.ListReviewTemplatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.wellarchitected.model.ListReviewTemplatesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listReviewTemplates(software.amazon.awssdk.services.wellarchitected.model.ListReviewTemplatesRequest)
operation.- Parameters:
listReviewTemplatesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReviewTemplatesPaginator
default ListReviewTemplatesPublisher listReviewTemplatesPaginator(Consumer<ListReviewTemplatesRequest.Builder> listReviewTemplatesRequest) This is a variant of
listReviewTemplates(software.amazon.awssdk.services.wellarchitected.model.ListReviewTemplatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.wellarchitected.paginators.ListReviewTemplatesPublisher publisher = client.listReviewTemplatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.wellarchitected.paginators.ListReviewTemplatesPublisher publisher = client.listReviewTemplatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.wellarchitected.model.ListReviewTemplatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.wellarchitected.model.ListReviewTemplatesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listReviewTemplates(software.amazon.awssdk.services.wellarchitected.model.ListReviewTemplatesRequest)
operation.
This is a convenience which creates an instance of the
ListReviewTemplatesRequest.Builder
avoiding the need to create one manually viaListReviewTemplatesRequest.builder()
- Parameters:
listReviewTemplatesRequest
- AConsumer
that will call methods onListReviewTemplatesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) 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.
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException There is a problem with the Well-Architected Tool API service.
- ResourceNotFoundException The requested resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) 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.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException There is a problem with the Well-Architected Tool API service.
- ResourceNotFoundException The requested resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listWorkloads
default CompletableFuture<ListWorkloadsResponse> listWorkloads(ListWorkloadsRequest listWorkloadsRequest) Paginated list of workloads.
- Parameters:
listWorkloadsRequest
- Input to list all workloads.- Returns:
- A Java Future containing the result of the ListWorkloads operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listWorkloads
default CompletableFuture<ListWorkloadsResponse> listWorkloads(Consumer<ListWorkloadsRequest.Builder> listWorkloadsRequest) Paginated list of workloads.
This is a convenience which creates an instance of the
ListWorkloadsRequest.Builder
avoiding the need to create one manually viaListWorkloadsRequest.builder()
- Parameters:
listWorkloadsRequest
- AConsumer
that will call methods onListWorkloadsRequest.Builder
to create a request. Input to list all workloads.- Returns:
- A Java Future containing the result of the ListWorkloads operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listWorkloadsPaginator
This is a variant of
listWorkloads(software.amazon.awssdk.services.wellarchitected.model.ListWorkloadsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.wellarchitected.paginators.ListWorkloadsPublisher publisher = client.listWorkloadsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.wellarchitected.paginators.ListWorkloadsPublisher publisher = client.listWorkloadsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.wellarchitected.model.ListWorkloadsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.wellarchitected.model.ListWorkloadsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listWorkloads(software.amazon.awssdk.services.wellarchitected.model.ListWorkloadsRequest)
operation.- Parameters:
listWorkloadsRequest
- Input to list all workloads.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listWorkloadsPaginator
default ListWorkloadsPublisher listWorkloadsPaginator(Consumer<ListWorkloadsRequest.Builder> listWorkloadsRequest) This is a variant of
listWorkloads(software.amazon.awssdk.services.wellarchitected.model.ListWorkloadsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.wellarchitected.paginators.ListWorkloadsPublisher publisher = client.listWorkloadsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.wellarchitected.paginators.ListWorkloadsPublisher publisher = client.listWorkloadsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.wellarchitected.model.ListWorkloadsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.wellarchitected.model.ListWorkloadsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listWorkloads(software.amazon.awssdk.services.wellarchitected.model.ListWorkloadsRequest)
operation.
This is a convenience which creates an instance of the
ListWorkloadsRequest.Builder
avoiding the need to create one manually viaListWorkloadsRequest.builder()
- Parameters:
listWorkloadsRequest
- AConsumer
that will call methods onListWorkloadsRequest.Builder
to create a request. Input to list all workloads.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
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.
- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException There is a problem with the Well-Architected Tool API service.
- ResourceNotFoundException The requested resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) 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.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException There is a problem with the Well-Architected Tool API service.
- ResourceNotFoundException The requested resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) 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
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException There is a problem with the Well-Architected Tool API service.
- ResourceNotFoundException The requested resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) 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
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException There is a problem with the Well-Architected Tool API service.
- ResourceNotFoundException The requested resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateAnswer
default CompletableFuture<UpdateAnswerResponse> updateAnswer(UpdateAnswerRequest updateAnswerRequest) Update the answer to a specific question in a workload review.
- Parameters:
updateAnswerRequest
- Input to update answer.- Returns:
- A Java Future containing the result of the UpdateAnswer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- ConflictException The resource has already been processed, was deleted, or is too large.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateAnswer
default CompletableFuture<UpdateAnswerResponse> updateAnswer(Consumer<UpdateAnswerRequest.Builder> updateAnswerRequest) Update the answer to a specific question in a workload review.
This is a convenience which creates an instance of the
UpdateAnswerRequest.Builder
avoiding the need to create one manually viaUpdateAnswerRequest.builder()
- Parameters:
updateAnswerRequest
- AConsumer
that will call methods onUpdateAnswerRequest.Builder
to create a request. Input to update answer.- Returns:
- A Java Future containing the result of the UpdateAnswer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- ConflictException The resource has already been processed, was deleted, or is too large.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateGlobalSettings
default CompletableFuture<UpdateGlobalSettingsResponse> updateGlobalSettings(UpdateGlobalSettingsRequest updateGlobalSettingsRequest) Update whether the Amazon Web Services account is opted into organization sharing and discovery integration features.
- Parameters:
updateGlobalSettingsRequest
-- Returns:
- A Java Future containing the result of the UpdateGlobalSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ConflictException The resource has already been processed, was deleted, or is too large.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateGlobalSettings
default CompletableFuture<UpdateGlobalSettingsResponse> updateGlobalSettings(Consumer<UpdateGlobalSettingsRequest.Builder> updateGlobalSettingsRequest) Update whether the Amazon Web Services account is opted into organization sharing and discovery integration features.
This is a convenience which creates an instance of the
UpdateGlobalSettingsRequest.Builder
avoiding the need to create one manually viaUpdateGlobalSettingsRequest.builder()
- Parameters:
updateGlobalSettingsRequest
- AConsumer
that will call methods onUpdateGlobalSettingsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateGlobalSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ConflictException The resource has already been processed, was deleted, or is too large.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateIntegration
default CompletableFuture<UpdateIntegrationResponse> updateIntegration(UpdateIntegrationRequest updateIntegrationRequest) Update integration features.
- Parameters:
updateIntegrationRequest
-- Returns:
- A Java Future containing the result of the UpdateIntegration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ConflictException The resource has already been processed, was deleted, or is too large.
- ResourceNotFoundException The requested resource was not found.
- AccessDeniedException User does not have sufficient access to perform this action.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateIntegration
default CompletableFuture<UpdateIntegrationResponse> updateIntegration(Consumer<UpdateIntegrationRequest.Builder> updateIntegrationRequest) Update integration features.
This is a convenience which creates an instance of the
UpdateIntegrationRequest.Builder
avoiding the need to create one manually viaUpdateIntegrationRequest.builder()
- Parameters:
updateIntegrationRequest
- AConsumer
that will call methods onUpdateIntegrationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateIntegration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ConflictException The resource has already been processed, was deleted, or is too large.
- ResourceNotFoundException The requested resource was not found.
- AccessDeniedException User does not have sufficient access to perform this action.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateLensReview
default CompletableFuture<UpdateLensReviewResponse> updateLensReview(UpdateLensReviewRequest updateLensReviewRequest) Update lens review for a particular workload.
- Parameters:
updateLensReviewRequest
- Input for update lens review.- Returns:
- A Java Future containing the result of the UpdateLensReview operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- ConflictException The resource has already been processed, was deleted, or is too large.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateLensReview
default CompletableFuture<UpdateLensReviewResponse> updateLensReview(Consumer<UpdateLensReviewRequest.Builder> updateLensReviewRequest) Update lens review for a particular workload.
This is a convenience which creates an instance of the
UpdateLensReviewRequest.Builder
avoiding the need to create one manually viaUpdateLensReviewRequest.builder()
- Parameters:
updateLensReviewRequest
- AConsumer
that will call methods onUpdateLensReviewRequest.Builder
to create a request. Input for update lens review.- Returns:
- A Java Future containing the result of the UpdateLensReview operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- ConflictException The resource has already been processed, was deleted, or is too large.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateProfile
default CompletableFuture<UpdateProfileResponse> updateProfile(UpdateProfileRequest updateProfileRequest) Update a profile.
- Parameters:
updateProfileRequest
-- Returns:
- A Java Future containing the result of the UpdateProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- ConflictException The resource has already been processed, was deleted, or is too large.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateProfile
default CompletableFuture<UpdateProfileResponse> updateProfile(Consumer<UpdateProfileRequest.Builder> updateProfileRequest) Update a profile.
This is a convenience which creates an instance of the
UpdateProfileRequest.Builder
avoiding the need to create one manually viaUpdateProfileRequest.builder()
- Parameters:
updateProfileRequest
- AConsumer
that will call methods onUpdateProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- ConflictException The resource has already been processed, was deleted, or is too large.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateReviewTemplate
default CompletableFuture<UpdateReviewTemplateResponse> updateReviewTemplate(UpdateReviewTemplateRequest updateReviewTemplateRequest) Update a review template.
- Parameters:
updateReviewTemplateRequest
-- Returns:
- A Java Future containing the result of the UpdateReviewTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- ConflictException The resource has already been processed, was deleted, or is too large.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateReviewTemplate
default CompletableFuture<UpdateReviewTemplateResponse> updateReviewTemplate(Consumer<UpdateReviewTemplateRequest.Builder> updateReviewTemplateRequest) Update a review template.
This is a convenience which creates an instance of the
UpdateReviewTemplateRequest.Builder
avoiding the need to create one manually viaUpdateReviewTemplateRequest.builder()
- Parameters:
updateReviewTemplateRequest
- AConsumer
that will call methods onUpdateReviewTemplateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateReviewTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- ConflictException The resource has already been processed, was deleted, or is too large.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateReviewTemplateAnswer
default CompletableFuture<UpdateReviewTemplateAnswerResponse> updateReviewTemplateAnswer(UpdateReviewTemplateAnswerRequest updateReviewTemplateAnswerRequest) Update a review template answer.
- Parameters:
updateReviewTemplateAnswerRequest
-- Returns:
- A Java Future containing the result of the UpdateReviewTemplateAnswer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- ConflictException The resource has already been processed, was deleted, or is too large.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateReviewTemplateAnswer
default CompletableFuture<UpdateReviewTemplateAnswerResponse> updateReviewTemplateAnswer(Consumer<UpdateReviewTemplateAnswerRequest.Builder> updateReviewTemplateAnswerRequest) Update a review template answer.
This is a convenience which creates an instance of the
UpdateReviewTemplateAnswerRequest.Builder
avoiding the need to create one manually viaUpdateReviewTemplateAnswerRequest.builder()
- Parameters:
updateReviewTemplateAnswerRequest
- AConsumer
that will call methods onUpdateReviewTemplateAnswerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateReviewTemplateAnswer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- ConflictException The resource has already been processed, was deleted, or is too large.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateReviewTemplateLensReview
default CompletableFuture<UpdateReviewTemplateLensReviewResponse> updateReviewTemplateLensReview(UpdateReviewTemplateLensReviewRequest updateReviewTemplateLensReviewRequest) Update a lens review associated with a review template.
- Parameters:
updateReviewTemplateLensReviewRequest
-- Returns:
- A Java Future containing the result of the UpdateReviewTemplateLensReview operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- ConflictException The resource has already been processed, was deleted, or is too large.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateReviewTemplateLensReview
default CompletableFuture<UpdateReviewTemplateLensReviewResponse> updateReviewTemplateLensReview(Consumer<UpdateReviewTemplateLensReviewRequest.Builder> updateReviewTemplateLensReviewRequest) Update a lens review associated with a review template.
This is a convenience which creates an instance of the
UpdateReviewTemplateLensReviewRequest.Builder
avoiding the need to create one manually viaUpdateReviewTemplateLensReviewRequest.builder()
- Parameters:
updateReviewTemplateLensReviewRequest
- AConsumer
that will call methods onUpdateReviewTemplateLensReviewRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateReviewTemplateLensReview operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- ConflictException The resource has already been processed, was deleted, or is too large.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateWorkload
default CompletableFuture<UpdateWorkloadResponse> updateWorkload(UpdateWorkloadRequest updateWorkloadRequest) Update an existing workload.
- Parameters:
updateWorkloadRequest
- Input to update a workload.- Returns:
- A Java Future containing the result of the UpdateWorkload operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- ConflictException The resource has already been processed, was deleted, or is too large.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateWorkload
default CompletableFuture<UpdateWorkloadResponse> updateWorkload(Consumer<UpdateWorkloadRequest.Builder> updateWorkloadRequest) Update an existing workload.
This is a convenience which creates an instance of the
UpdateWorkloadRequest.Builder
avoiding the need to create one manually viaUpdateWorkloadRequest.builder()
- Parameters:
updateWorkloadRequest
- AConsumer
that will call methods onUpdateWorkloadRequest.Builder
to create a request. Input to update a workload.- Returns:
- A Java Future containing the result of the UpdateWorkload operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- ConflictException The resource has already been processed, was deleted, or is too large.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
upgradeLensReview
default CompletableFuture<UpgradeLensReviewResponse> upgradeLensReview(UpgradeLensReviewRequest upgradeLensReviewRequest) Upgrade lens review for a particular workload.
- Parameters:
upgradeLensReviewRequest
-- Returns:
- A Java Future containing the result of the UpgradeLensReview operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- ConflictException The resource has already been processed, was deleted, or is too large.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- ServiceQuotaExceededException The user has reached their resource quota.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
upgradeLensReview
default CompletableFuture<UpgradeLensReviewResponse> upgradeLensReview(Consumer<UpgradeLensReviewRequest.Builder> upgradeLensReviewRequest) Upgrade lens review for a particular workload.
This is a convenience which creates an instance of the
UpgradeLensReviewRequest.Builder
avoiding the need to create one manually viaUpgradeLensReviewRequest.builder()
- Parameters:
upgradeLensReviewRequest
- AConsumer
that will call methods onUpgradeLensReviewRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpgradeLensReview operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- ConflictException The resource has already been processed, was deleted, or is too large.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- ServiceQuotaExceededException The user has reached their resource quota.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
upgradeProfileVersion
default CompletableFuture<UpgradeProfileVersionResponse> upgradeProfileVersion(UpgradeProfileVersionRequest upgradeProfileVersionRequest) Upgrade a profile.
- Parameters:
upgradeProfileVersionRequest
-- Returns:
- A Java Future containing the result of the UpgradeProfileVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- ConflictException The resource has already been processed, was deleted, or is too large.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- ServiceQuotaExceededException The user has reached their resource quota.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
upgradeProfileVersion
default CompletableFuture<UpgradeProfileVersionResponse> upgradeProfileVersion(Consumer<UpgradeProfileVersionRequest.Builder> upgradeProfileVersionRequest) Upgrade a profile.
This is a convenience which creates an instance of the
UpgradeProfileVersionRequest.Builder
avoiding the need to create one manually viaUpgradeProfileVersionRequest.builder()
- Parameters:
upgradeProfileVersionRequest
- AConsumer
that will call methods onUpgradeProfileVersionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpgradeProfileVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- ConflictException The resource has already been processed, was deleted, or is too large.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- ServiceQuotaExceededException The user has reached their resource quota.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
upgradeReviewTemplateLensReview
default CompletableFuture<UpgradeReviewTemplateLensReviewResponse> upgradeReviewTemplateLensReview(UpgradeReviewTemplateLensReviewRequest upgradeReviewTemplateLensReviewRequest) Upgrade the lens review of a review template.
- Parameters:
upgradeReviewTemplateLensReviewRequest
-- Returns:
- A Java Future containing the result of the UpgradeReviewTemplateLensReview operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- ConflictException The resource has already been processed, was deleted, or is too large.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
upgradeReviewTemplateLensReview
default CompletableFuture<UpgradeReviewTemplateLensReviewResponse> upgradeReviewTemplateLensReview(Consumer<UpgradeReviewTemplateLensReviewRequest.Builder> upgradeReviewTemplateLensReviewRequest) Upgrade the lens review of a review template.
This is a convenience which creates an instance of the
UpgradeReviewTemplateLensReviewRequest.Builder
avoiding the need to create one manually viaUpgradeReviewTemplateLensReviewRequest.builder()
- Parameters:
upgradeReviewTemplateLensReviewRequest
- AConsumer
that will call methods onUpgradeReviewTemplateLensReviewRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpgradeReviewTemplateLensReview operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The user input is not valid.
- ResourceNotFoundException The requested resource was not found.
- ConflictException The resource has already been processed, was deleted, or is too large.
- InternalServerException There is a problem with the Well-Architected Tool API service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WellArchitectedException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aWellArchitectedAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aWellArchitectedAsyncClient
.
-