@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface WellArchitectedClient extends SdkClient
builder() method.
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default AssociateLensesResponse |
associateLenses(AssociateLensesRequest associateLensesRequest)
Associate a lens to a workload.
|
default AssociateLensesResponse |
associateLenses(Consumer<AssociateLensesRequest.Builder> associateLensesRequest)
Associate a lens to a workload.
|
static WellArchitectedClientBuilder |
builder()
Create a builder that can be used to configure and create a
WellArchitectedClient. |
static WellArchitectedClient |
create()
Create a
WellArchitectedClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateLensShareResponse |
createLensShare(Consumer<CreateLensShareRequest.Builder> createLensShareRequest)
Create a lens share.
|
default CreateLensShareResponse |
createLensShare(CreateLensShareRequest createLensShareRequest)
Create a lens share.
|
default CreateLensVersionResponse |
createLensVersion(Consumer<CreateLensVersionRequest.Builder> createLensVersionRequest)
Create a new lens version.
|
default CreateLensVersionResponse |
createLensVersion(CreateLensVersionRequest createLensVersionRequest)
Create a new lens version.
|
default CreateMilestoneResponse |
createMilestone(Consumer<CreateMilestoneRequest.Builder> createMilestoneRequest)
Create a milestone for an existing workload.
|
default CreateMilestoneResponse |
createMilestone(CreateMilestoneRequest createMilestoneRequest)
Create a milestone for an existing workload.
|
default CreateWorkloadResponse |
createWorkload(Consumer<CreateWorkloadRequest.Builder> createWorkloadRequest)
Create a new workload.
|
default CreateWorkloadResponse |
createWorkload(CreateWorkloadRequest createWorkloadRequest)
Create a new workload.
|
default CreateWorkloadShareResponse |
createWorkloadShare(Consumer<CreateWorkloadShareRequest.Builder> createWorkloadShareRequest)
Create a workload share.
|
default CreateWorkloadShareResponse |
createWorkloadShare(CreateWorkloadShareRequest createWorkloadShareRequest)
Create a workload share.
|
default DeleteLensResponse |
deleteLens(Consumer<DeleteLensRequest.Builder> deleteLensRequest)
Delete an existing lens.
|
default DeleteLensResponse |
deleteLens(DeleteLensRequest deleteLensRequest)
Delete an existing lens.
|
default DeleteLensShareResponse |
deleteLensShare(Consumer<DeleteLensShareRequest.Builder> deleteLensShareRequest)
Delete a lens share.
|
default DeleteLensShareResponse |
deleteLensShare(DeleteLensShareRequest deleteLensShareRequest)
Delete a lens share.
|
default DeleteWorkloadResponse |
deleteWorkload(Consumer<DeleteWorkloadRequest.Builder> deleteWorkloadRequest)
Delete an existing workload.
|
default DeleteWorkloadResponse |
deleteWorkload(DeleteWorkloadRequest deleteWorkloadRequest)
Delete an existing workload.
|
default DeleteWorkloadShareResponse |
deleteWorkloadShare(Consumer<DeleteWorkloadShareRequest.Builder> deleteWorkloadShareRequest)
Delete a workload share.
|
default DeleteWorkloadShareResponse |
deleteWorkloadShare(DeleteWorkloadShareRequest deleteWorkloadShareRequest)
Delete a workload share.
|
default DisassociateLensesResponse |
disassociateLenses(Consumer<DisassociateLensesRequest.Builder> disassociateLensesRequest)
Disassociate a lens from a workload.
|
default DisassociateLensesResponse |
disassociateLenses(DisassociateLensesRequest disassociateLensesRequest)
Disassociate a lens from a workload.
|
default ExportLensResponse |
exportLens(Consumer<ExportLensRequest.Builder> exportLensRequest)
Export an existing lens.
|
default ExportLensResponse |
exportLens(ExportLensRequest exportLensRequest)
Export an existing lens.
|
default GetAnswerResponse |
getAnswer(Consumer<GetAnswerRequest.Builder> getAnswerRequest)
Get the answer to a specific question in a workload review.
|
default GetAnswerResponse |
getAnswer(GetAnswerRequest getAnswerRequest)
Get the answer to a specific question in a workload review.
|
default GetLensResponse |
getLens(Consumer<GetLensRequest.Builder> getLensRequest)
Get an existing lens.
|
default GetLensResponse |
getLens(GetLensRequest getLensRequest)
Get an existing lens.
|
default GetLensReviewResponse |
getLensReview(Consumer<GetLensReviewRequest.Builder> getLensReviewRequest)
Get lens review.
|
default GetLensReviewResponse |
getLensReview(GetLensReviewRequest getLensReviewRequest)
Get lens review.
|
default GetLensReviewReportResponse |
getLensReviewReport(Consumer<GetLensReviewReportRequest.Builder> getLensReviewReportRequest)
Get lens review report.
|
default GetLensReviewReportResponse |
getLensReviewReport(GetLensReviewReportRequest getLensReviewReportRequest)
Get lens review report.
|
default GetLensVersionDifferenceResponse |
getLensVersionDifference(Consumer<GetLensVersionDifferenceRequest.Builder> getLensVersionDifferenceRequest)
Get lens version differences.
|
default GetLensVersionDifferenceResponse |
getLensVersionDifference(GetLensVersionDifferenceRequest getLensVersionDifferenceRequest)
Get lens version differences.
|
default GetMilestoneResponse |
getMilestone(Consumer<GetMilestoneRequest.Builder> getMilestoneRequest)
Get a milestone for an existing workload.
|
default GetMilestoneResponse |
getMilestone(GetMilestoneRequest getMilestoneRequest)
Get a milestone for an existing workload.
|
default GetWorkloadResponse |
getWorkload(Consumer<GetWorkloadRequest.Builder> getWorkloadRequest)
Get an existing workload.
|
default GetWorkloadResponse |
getWorkload(GetWorkloadRequest getWorkloadRequest)
Get an existing workload.
|
default ImportLensResponse |
importLens(Consumer<ImportLensRequest.Builder> importLensRequest)
Import a new lens.
|
default ImportLensResponse |
importLens(ImportLensRequest importLensRequest)
Import a new lens.
|
default ListAnswersResponse |
listAnswers(Consumer<ListAnswersRequest.Builder> listAnswersRequest)
List of answers.
|
default ListAnswersResponse |
listAnswers(ListAnswersRequest listAnswersRequest)
List of answers.
|
default ListAnswersIterable |
listAnswersPaginator(Consumer<ListAnswersRequest.Builder> listAnswersRequest)
List of answers.
|
default ListAnswersIterable |
listAnswersPaginator(ListAnswersRequest listAnswersRequest)
List of answers.
|
default ListCheckDetailsResponse |
listCheckDetails(Consumer<ListCheckDetailsRequest.Builder> listCheckDetailsRequest)
List of Trusted Advisor check details by account related to the workload.
|
default ListCheckDetailsResponse |
listCheckDetails(ListCheckDetailsRequest listCheckDetailsRequest)
List of Trusted Advisor check details by account related to the workload.
|
default ListCheckDetailsIterable |
listCheckDetailsPaginator(Consumer<ListCheckDetailsRequest.Builder> listCheckDetailsRequest)
List of Trusted Advisor check details by account related to the workload.
|
default ListCheckDetailsIterable |
listCheckDetailsPaginator(ListCheckDetailsRequest listCheckDetailsRequest)
List of Trusted Advisor check details by account related to the workload.
|
default ListCheckSummariesResponse |
listCheckSummaries(Consumer<ListCheckSummariesRequest.Builder> listCheckSummariesRequest)
List of Trusted Advisor checks summarized for all accounts related to the workload.
|
default ListCheckSummariesResponse |
listCheckSummaries(ListCheckSummariesRequest listCheckSummariesRequest)
List of Trusted Advisor checks summarized for all accounts related to the workload.
|
default ListCheckSummariesIterable |
listCheckSummariesPaginator(Consumer<ListCheckSummariesRequest.Builder> listCheckSummariesRequest)
List of Trusted Advisor checks summarized for all accounts related to the workload.
|
default ListCheckSummariesIterable |
listCheckSummariesPaginator(ListCheckSummariesRequest listCheckSummariesRequest)
List of Trusted Advisor checks summarized for all accounts related to the workload.
|
default ListLensesResponse |
listLenses(Consumer<ListLensesRequest.Builder> listLensesRequest)
List the available lenses.
|
default ListLensesResponse |
listLenses(ListLensesRequest listLensesRequest)
List the available lenses.
|
default ListLensesIterable |
listLensesPaginator(Consumer<ListLensesRequest.Builder> listLensesRequest)
List the available lenses.
|
default ListLensesIterable |
listLensesPaginator(ListLensesRequest listLensesRequest)
List the available lenses.
|
default ListLensReviewImprovementsResponse |
listLensReviewImprovements(Consumer<ListLensReviewImprovementsRequest.Builder> listLensReviewImprovementsRequest)
List lens review improvements.
|
default ListLensReviewImprovementsResponse |
listLensReviewImprovements(ListLensReviewImprovementsRequest listLensReviewImprovementsRequest)
List lens review improvements.
|
default ListLensReviewImprovementsIterable |
listLensReviewImprovementsPaginator(Consumer<ListLensReviewImprovementsRequest.Builder> listLensReviewImprovementsRequest)
List lens review improvements.
|
default ListLensReviewImprovementsIterable |
listLensReviewImprovementsPaginator(ListLensReviewImprovementsRequest listLensReviewImprovementsRequest)
List lens review improvements.
|
default ListLensReviewsResponse |
listLensReviews(Consumer<ListLensReviewsRequest.Builder> listLensReviewsRequest)
List lens reviews.
|
default ListLensReviewsResponse |
listLensReviews(ListLensReviewsRequest listLensReviewsRequest)
List lens reviews.
|
default ListLensReviewsIterable |
listLensReviewsPaginator(Consumer<ListLensReviewsRequest.Builder> listLensReviewsRequest)
List lens reviews.
|
default ListLensReviewsIterable |
listLensReviewsPaginator(ListLensReviewsRequest listLensReviewsRequest)
List lens reviews.
|
default ListLensSharesResponse |
listLensShares(Consumer<ListLensSharesRequest.Builder> listLensSharesRequest)
List the lens shares associated with the lens.
|
default ListLensSharesResponse |
listLensShares(ListLensSharesRequest listLensSharesRequest)
List the lens shares associated with the lens.
|
default ListLensSharesIterable |
listLensSharesPaginator(Consumer<ListLensSharesRequest.Builder> listLensSharesRequest)
List the lens shares associated with the lens.
|
default ListLensSharesIterable |
listLensSharesPaginator(ListLensSharesRequest listLensSharesRequest)
List the lens shares associated with the lens.
|
default ListMilestonesResponse |
listMilestones(Consumer<ListMilestonesRequest.Builder> listMilestonesRequest)
List all milestones for an existing workload.
|
default ListMilestonesResponse |
listMilestones(ListMilestonesRequest listMilestonesRequest)
List all milestones for an existing workload.
|
default ListMilestonesIterable |
listMilestonesPaginator(Consumer<ListMilestonesRequest.Builder> listMilestonesRequest)
List all milestones for an existing workload.
|
default ListMilestonesIterable |
listMilestonesPaginator(ListMilestonesRequest listMilestonesRequest)
List all milestones for an existing workload.
|
default ListNotificationsResponse |
listNotifications(Consumer<ListNotificationsRequest.Builder> listNotificationsRequest)
List lens notifications.
|
default ListNotificationsResponse |
listNotifications(ListNotificationsRequest listNotificationsRequest)
List lens notifications.
|
default ListNotificationsIterable |
listNotificationsPaginator(Consumer<ListNotificationsRequest.Builder> listNotificationsRequest)
List lens notifications.
|
default ListNotificationsIterable |
listNotificationsPaginator(ListNotificationsRequest listNotificationsRequest)
List lens notifications.
|
default ListShareInvitationsResponse |
listShareInvitations(Consumer<ListShareInvitationsRequest.Builder> listShareInvitationsRequest)
List the workload invitations.
|
default ListShareInvitationsResponse |
listShareInvitations(ListShareInvitationsRequest listShareInvitationsRequest)
List the workload invitations.
|
default ListShareInvitationsIterable |
listShareInvitationsPaginator(Consumer<ListShareInvitationsRequest.Builder> listShareInvitationsRequest)
List the workload invitations.
|
default ListShareInvitationsIterable |
listShareInvitationsPaginator(ListShareInvitationsRequest listShareInvitationsRequest)
List the workload invitations.
|
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
List the tags for a resource.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
List the tags for a resource.
|
default ListWorkloadsResponse |
listWorkloads(Consumer<ListWorkloadsRequest.Builder> listWorkloadsRequest)
List workloads.
|
default ListWorkloadsResponse |
listWorkloads(ListWorkloadsRequest listWorkloadsRequest)
List workloads.
|
default ListWorkloadSharesResponse |
listWorkloadShares(Consumer<ListWorkloadSharesRequest.Builder> listWorkloadSharesRequest)
List the workload shares associated with the workload.
|
default ListWorkloadSharesResponse |
listWorkloadShares(ListWorkloadSharesRequest listWorkloadSharesRequest)
List the workload shares associated with the workload.
|
default ListWorkloadSharesIterable |
listWorkloadSharesPaginator(Consumer<ListWorkloadSharesRequest.Builder> listWorkloadSharesRequest)
List the workload shares associated with the workload.
|
default ListWorkloadSharesIterable |
listWorkloadSharesPaginator(ListWorkloadSharesRequest listWorkloadSharesRequest)
List the workload shares associated with the workload.
|
default ListWorkloadsIterable |
listWorkloadsPaginator(Consumer<ListWorkloadsRequest.Builder> listWorkloadsRequest)
List workloads.
|
default ListWorkloadsIterable |
listWorkloadsPaginator(ListWorkloadsRequest listWorkloadsRequest)
List workloads.
|
static ServiceMetadata |
serviceMetadata() |
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds one or more tags to the specified resource.
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Adds one or more tags to the specified resource.
|
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Deletes specified tags from a resource.
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Deletes specified tags from a resource.
|
default UpdateAnswerResponse |
updateAnswer(Consumer<UpdateAnswerRequest.Builder> updateAnswerRequest)
Update the answer to a specific question in a workload review.
|
default UpdateAnswerResponse |
updateAnswer(UpdateAnswerRequest updateAnswerRequest)
Update the answer to a specific question in a workload review.
|
default UpdateGlobalSettingsResponse |
updateGlobalSettings(Consumer<UpdateGlobalSettingsRequest.Builder> updateGlobalSettingsRequest)
Updates whether the Amazon Web Services account is opted into organization sharing features.
|
default UpdateGlobalSettingsResponse |
updateGlobalSettings(UpdateGlobalSettingsRequest updateGlobalSettingsRequest)
Updates whether the Amazon Web Services account is opted into organization sharing features.
|
default UpdateLensReviewResponse |
updateLensReview(Consumer<UpdateLensReviewRequest.Builder> updateLensReviewRequest)
Update lens review.
|
default UpdateLensReviewResponse |
updateLensReview(UpdateLensReviewRequest updateLensReviewRequest)
Update lens review.
|
default UpdateShareInvitationResponse |
updateShareInvitation(Consumer<UpdateShareInvitationRequest.Builder> updateShareInvitationRequest)
Update a workload or custom lens share invitation.
|
default UpdateShareInvitationResponse |
updateShareInvitation(UpdateShareInvitationRequest updateShareInvitationRequest)
Update a workload or custom lens share invitation.
|
default UpdateWorkloadResponse |
updateWorkload(Consumer<UpdateWorkloadRequest.Builder> updateWorkloadRequest)
Update an existing workload.
|
default UpdateWorkloadResponse |
updateWorkload(UpdateWorkloadRequest updateWorkloadRequest)
Update an existing workload.
|
default UpdateWorkloadShareResponse |
updateWorkloadShare(Consumer<UpdateWorkloadShareRequest.Builder> updateWorkloadShareRequest)
Update a workload share.
|
default UpdateWorkloadShareResponse |
updateWorkloadShare(UpdateWorkloadShareRequest updateWorkloadShareRequest)
Update a workload share.
|
default UpgradeLensReviewResponse |
upgradeLensReview(Consumer<UpgradeLensReviewRequest.Builder> upgradeLensReviewRequest)
Upgrade lens review.
|
default UpgradeLensReviewResponse |
upgradeLensReview(UpgradeLensReviewRequest upgradeLensReviewRequest)
Upgrade lens review.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static WellArchitectedClient create()
WellArchitectedClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static WellArchitectedClientBuilder builder()
WellArchitectedClient.default AssociateLensesResponse associateLenses(AssociateLensesRequest associateLensesRequest) throws ValidationException, ResourceNotFoundException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
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.
associateLensesRequest - Input to associate lens reviews.ValidationException - The user input is not valid.ResourceNotFoundException - The requested resource was not found.ConflictException - The resource already exists.InternalServerException - There is a problem with the Well-Architected Tool API service.AccessDeniedException - User does not have sufficient access to perform this action.ThrottlingException - Request was denied due to request throttling.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.AwsServiceExceptiondefault AssociateLensesResponse associateLenses(Consumer<AssociateLensesRequest.Builder> associateLensesRequest) throws ValidationException, ResourceNotFoundException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
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 via AssociateLensesRequest.builder()
associateLensesRequest - A Consumer that will call methods on AssociateLensesInput.Builder to create a request.
Input to associate lens reviews.ValidationException - The user input is not valid.ResourceNotFoundException - The requested resource was not found.ConflictException - The resource already exists.InternalServerException - There is a problem with the Well-Architected Tool API service.AccessDeniedException - User does not have sufficient access to perform this action.ThrottlingException - Request was denied due to request throttling.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.AwsServiceExceptiondefault CreateLensShareResponse createLensShare(CreateLensShareRequest createLensShareRequest) throws ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Create a lens share.
The owner of a lens can share it with other Amazon Web Services accounts, IAM users, an organization, and organizational units (OUs) in the same Amazon Web Services Region. Shared access to a lens is not removed until the lens invitation is deleted.
Disclaimer
By sharing your custom lenses with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your custom lenses available to those other accounts. Those other accounts may continue to access and use your shared custom lenses even if you delete the custom lenses from your own Amazon Web Services account or terminate your Amazon Web Services account.
createLensShareRequest - ValidationException - The user input is not valid.ConflictException - The resource already exists.InternalServerException - There is a problem with the Well-Architected Tool API service.ResourceNotFoundException - The requested resource was not found.ServiceQuotaExceededException - The user has reached their resource quota.AccessDeniedException - User does not have sufficient access to perform this action.ThrottlingException - Request was denied due to request throttling.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.AwsServiceExceptiondefault CreateLensShareResponse createLensShare(Consumer<CreateLensShareRequest.Builder> createLensShareRequest) throws ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Create a lens share.
The owner of a lens can share it with other Amazon Web Services accounts, IAM users, an organization, and organizational units (OUs) in the same Amazon Web Services Region. Shared access to a lens is not removed until the lens invitation is deleted.
Disclaimer
By sharing your custom lenses with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your custom lenses available to those other accounts. Those other accounts may continue to access and use your shared custom lenses even if you delete the custom lenses from your own Amazon Web Services account or terminate your Amazon Web Services account.
This is a convenience which creates an instance of the CreateLensShareRequest.Builder avoiding the need
to create one manually via CreateLensShareRequest.builder()
createLensShareRequest - A Consumer that will call methods on CreateLensShareInput.Builder to create a request.ValidationException - The user input is not valid.ConflictException - The resource already exists.InternalServerException - There is a problem with the Well-Architected Tool API service.ResourceNotFoundException - The requested resource was not found.ServiceQuotaExceededException - The user has reached their resource quota.AccessDeniedException - User does not have sufficient access to perform this action.ThrottlingException - Request was denied due to request throttling.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.AwsServiceExceptiondefault CreateLensVersionResponse createLensVersion(CreateLensVersionRequest createLensVersionRequest) throws ValidationException, ResourceNotFoundException, ServiceQuotaExceededException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Create a new lens version.
A lens can have up to 100 versions.
After a lens has been imported, create a new lens version to publish it. The owner of a lens can share the lens with other Amazon Web Services accounts and IAM users in the same Amazon Web Services Region. Only the owner of a lens can delete it.
createLensVersionRequest - ValidationException - The user input is not valid.ResourceNotFoundException - The requested resource was not found.ServiceQuotaExceededException - The user has reached their resource quota.ConflictException - The resource already exists.InternalServerException - There is a problem with the Well-Architected Tool API service.AccessDeniedException - User does not have sufficient access to perform this action.ThrottlingException - Request was denied due to request throttling.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.AwsServiceExceptiondefault CreateLensVersionResponse createLensVersion(Consumer<CreateLensVersionRequest.Builder> createLensVersionRequest) throws ValidationException, ResourceNotFoundException, ServiceQuotaExceededException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Create a new lens version.
A lens can have up to 100 versions.
After a lens has been imported, create a new lens version to publish it. The owner of a lens can share the lens with other Amazon Web Services accounts and IAM users in the same Amazon Web Services Region. Only the owner of a lens can delete it.
This is a convenience which creates an instance of the CreateLensVersionRequest.Builder avoiding the need
to create one manually via CreateLensVersionRequest.builder()
createLensVersionRequest - A Consumer that will call methods on CreateLensVersionInput.Builder to create a request.ValidationException - The user input is not valid.ResourceNotFoundException - The requested resource was not found.ServiceQuotaExceededException - The user has reached their resource quota.ConflictException - The resource already exists.InternalServerException - There is a problem with the Well-Architected Tool API service.AccessDeniedException - User does not have sufficient access to perform this action.ThrottlingException - Request was denied due to request throttling.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.AwsServiceExceptiondefault CreateMilestoneResponse createMilestone(CreateMilestoneRequest createMilestoneRequest) throws ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Create a milestone for an existing workload.
createMilestoneRequest - Input for milestone creation.ValidationException - The user input is not valid.ConflictException - The resource already exists.InternalServerException - There is a problem with the Well-Architected Tool API service.ResourceNotFoundException - The requested resource was not found.ServiceQuotaExceededException - The user has reached their resource quota.AccessDeniedException - User does not have sufficient access to perform this action.ThrottlingException - Request was denied due to request throttling.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.AwsServiceExceptiondefault CreateMilestoneResponse createMilestone(Consumer<CreateMilestoneRequest.Builder> createMilestoneRequest) throws ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
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 via CreateMilestoneRequest.builder()
createMilestoneRequest - A Consumer that will call methods on CreateMilestoneInput.Builder to create a request.
Input for milestone creation.ValidationException - The user input is not valid.ConflictException - The resource already exists.InternalServerException - There is a problem with the Well-Architected Tool API service.ResourceNotFoundException - The requested resource was not found.ServiceQuotaExceededException - The user has reached their resource quota.AccessDeniedException - User does not have sufficient access to perform this action.ThrottlingException - Request was denied due to request throttling.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.AwsServiceExceptiondefault CreateWorkloadResponse createWorkload(CreateWorkloadRequest createWorkloadRequest) throws ValidationException, ConflictException, ServiceQuotaExceededException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Create a new workload.
The owner of a workload can share the workload with other Amazon Web Services accounts, IAM 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.
createWorkloadRequest - Input for workload creation.ValidationException - The user input is not valid.ConflictException - The resource already exists.ServiceQuotaExceededException - The user has reached their resource quota.InternalServerException - There is a problem with the Well-Architected Tool API service.AccessDeniedException - User does not have sufficient access to perform this action.ThrottlingException - Request was denied due to request throttling.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.AwsServiceExceptiondefault CreateWorkloadResponse createWorkload(Consumer<CreateWorkloadRequest.Builder> createWorkloadRequest) throws ValidationException, ConflictException, ServiceQuotaExceededException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Create a new workload.
The owner of a workload can share the workload with other Amazon Web Services accounts, IAM 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.
This is a convenience which creates an instance of the CreateWorkloadRequest.Builder avoiding the need to
create one manually via CreateWorkloadRequest.builder()
createWorkloadRequest - A Consumer that will call methods on CreateWorkloadInput.Builder to create a request.
Input for workload creation.ValidationException - The user input is not valid.ConflictException - The resource already exists.ServiceQuotaExceededException - The user has reached their resource quota.InternalServerException - There is a problem with the Well-Architected Tool API service.AccessDeniedException - User does not have sufficient access to perform this action.ThrottlingException - Request was denied due to request throttling.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.AwsServiceExceptiondefault CreateWorkloadShareResponse createWorkloadShare(CreateWorkloadShareRequest createWorkloadShareRequest) throws ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Create a workload share.
The owner of a workload can share it with other Amazon Web Services accounts and IAM users in the same Amazon Web Services Region. Shared access to a workload is not removed until the workload invitation is deleted.
For more information, see Sharing a Workload in the Well-Architected Tool User Guide.
createWorkloadShareRequest - Input for Create Workload ShareValidationException - The user input is not valid.ConflictException - The resource already exists.InternalServerException - There is a problem with the Well-Architected Tool API service.ResourceNotFoundException - The requested resource was not found.ServiceQuotaExceededException - The user has reached their resource quota.AccessDeniedException - User does not have sufficient access to perform this action.ThrottlingException - Request was denied due to request throttling.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.AwsServiceExceptiondefault CreateWorkloadShareResponse createWorkloadShare(Consumer<CreateWorkloadShareRequest.Builder> createWorkloadShareRequest) throws ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Create a workload share.
The owner of a workload can share it with other Amazon Web Services accounts and IAM users in the same Amazon Web Services Region. Shared access to a workload is not removed until the workload invitation is deleted.
For more information, see Sharing a Workload in the Well-Architected Tool User Guide.
This is a convenience which creates an instance of the CreateWorkloadShareRequest.Builder avoiding the
need to create one manually via CreateWorkloadShareRequest.builder()
createWorkloadShareRequest - A Consumer that will call methods on CreateWorkloadShareInput.Builder to create a request.
Input for Create Workload ShareValidationException - The user input is not valid.ConflictException - The resource already exists.InternalServerException - There is a problem with the Well-Architected Tool API service.ResourceNotFoundException - The requested resource was not found.ServiceQuotaExceededException - The user has reached their resource quota.AccessDeniedException - User does not have sufficient access to perform this action.ThrottlingException - Request was denied due to request throttling.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.AwsServiceExceptiondefault DeleteLensResponse deleteLens(DeleteLensRequest deleteLensRequest) throws ValidationException, ResourceNotFoundException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Delete an existing lens.
Only the owner of a lens can delete it. After the lens is deleted, Amazon Web Services accounts and IAM users that you shared the lens with can continue to use it, but they will no longer be able to apply it to new workloads.
Disclaimer
By sharing your custom lenses with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your custom lenses available to those other accounts. Those other accounts may continue to access and use your shared custom lenses even if you delete the custom lenses from your own Amazon Web Services account or terminate your Amazon Web Services account.
deleteLensRequest - ValidationException - The user input is not valid.ResourceNotFoundException - The requested resource was not found.ConflictException - The resource already exists.InternalServerException - There is a problem with the Well-Architected Tool API service.AccessDeniedException - User does not have sufficient access to perform this action.ThrottlingException - Request was denied due to request throttling.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.AwsServiceExceptiondefault DeleteLensResponse deleteLens(Consumer<DeleteLensRequest.Builder> deleteLensRequest) throws ValidationException, ResourceNotFoundException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Delete an existing lens.
Only the owner of a lens can delete it. After the lens is deleted, Amazon Web Services accounts and IAM users that you shared the lens with can continue to use it, but they will no longer be able to apply it to new workloads.
Disclaimer
By sharing your custom lenses with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your custom lenses available to those other accounts. Those other accounts may continue to access and use your shared custom lenses even if you delete the custom lenses from your own Amazon Web Services account or terminate your Amazon Web Services account.
This is a convenience which creates an instance of the DeleteLensRequest.Builder avoiding the need to
create one manually via DeleteLensRequest.builder()
deleteLensRequest - A Consumer that will call methods on DeleteLensInput.Builder to create a request.ValidationException - The user input is not valid.ResourceNotFoundException - The requested resource was not found.ConflictException - The resource already exists.InternalServerException - There is a problem with the Well-Architected Tool API service.AccessDeniedException - User does not have sufficient access to perform this action.ThrottlingException - Request was denied due to request throttling.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.AwsServiceExceptiondefault DeleteLensShareResponse deleteLensShare(DeleteLensShareRequest deleteLensShareRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Delete a lens share.
After the lens share is deleted, Amazon Web Services accounts, IAM users, organizations, and organizational units (OUs) that you shared the lens with can continue to use it, but they will no longer be able to apply it to new workloads.
Disclaimer
By sharing your custom lenses with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your custom lenses available to those other accounts. Those other accounts may continue to access and use your shared custom lenses even if you delete the custom lenses from your own Amazon Web Services account or terminate your Amazon Web Services account.
deleteLensShareRequest - ValidationException - The user input is not valid.InternalServerException - There is a problem with the Well-Architected Tool API service.ResourceNotFoundException - The requested resource was not found.ConflictException - The resource already exists.AccessDeniedException - User does not have sufficient access to perform this action.ThrottlingException - Request was denied due to request throttling.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.AwsServiceExceptiondefault DeleteLensShareResponse deleteLensShare(Consumer<DeleteLensShareRequest.Builder> deleteLensShareRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Delete a lens share.
After the lens share is deleted, Amazon Web Services accounts, IAM users, organizations, and organizational units (OUs) that you shared the lens with can continue to use it, but they will no longer be able to apply it to new workloads.
Disclaimer
By sharing your custom lenses with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your custom lenses available to those other accounts. Those other accounts may continue to access and use your shared custom lenses even if you delete the custom lenses from your own Amazon Web Services account or terminate your Amazon Web Services account.
This is a convenience which creates an instance of the DeleteLensShareRequest.Builder avoiding the need
to create one manually via DeleteLensShareRequest.builder()
deleteLensShareRequest - A Consumer that will call methods on DeleteLensShareInput.Builder to create a request.ValidationException - The user input is not valid.InternalServerException - There is a problem with the Well-Architected Tool API service.ResourceNotFoundException - The requested resource was not found.ConflictException - The resource already exists.AccessDeniedException - User does not have sufficient access to perform this action.ThrottlingException - Request was denied due to request throttling.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.AwsServiceExceptiondefault DeleteWorkloadResponse deleteWorkload(DeleteWorkloadRequest deleteWorkloadRequest) throws ValidationException, ResourceNotFoundException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Delete an existing workload.
deleteWorkloadRequest - Input for workload deletion.ValidationException - The user input is not valid.ResourceNotFoundException - The requested resource was not found.ConflictException - The resource already exists.InternalServerException - There is a problem with the Well-Architected Tool API service.AccessDeniedException - User does not have sufficient access to perform this action.ThrottlingException - Request was denied due to request throttling.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.AwsServiceExceptiondefault DeleteWorkloadResponse deleteWorkload(Consumer<DeleteWorkloadRequest.Builder> deleteWorkloadRequest) throws ValidationException, ResourceNotFoundException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Delete an existing workload.
This is a convenience which creates an instance of the DeleteWorkloadRequest.Builder avoiding the need to
create one manually via DeleteWorkloadRequest.builder()
deleteWorkloadRequest - A Consumer that will call methods on DeleteWorkloadInput.Builder to create a request.
Input for workload deletion.ValidationException - The user input is not valid.ResourceNotFoundException - The requested resource was not found.ConflictException - The resource already exists.InternalServerException - There is a problem with the Well-Architected Tool API service.AccessDeniedException - User does not have sufficient access to perform this action.ThrottlingException - Request was denied due to request throttling.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.AwsServiceExceptiondefault DeleteWorkloadShareResponse deleteWorkloadShare(DeleteWorkloadShareRequest deleteWorkloadShareRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Delete a workload share.
deleteWorkloadShareRequest - Input for Delete Workload ShareValidationException - The user input is not valid.InternalServerException - There is a problem with the Well-Architected Tool API service.ResourceNotFoundException - The requested resource was not found.ConflictException - The resource already exists.AccessDeniedException - User does not have sufficient access to perform this action.ThrottlingException - Request was denied due to request throttling.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.AwsServiceExceptiondefault DeleteWorkloadShareResponse deleteWorkloadShare(Consumer<DeleteWorkloadShareRequest.Builder> deleteWorkloadShareRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Delete a workload share.
This is a convenience which creates an instance of the DeleteWorkloadShareRequest.Builder avoiding the
need to create one manually via DeleteWorkloadShareRequest.builder()
deleteWorkloadShareRequest - A Consumer that will call methods on DeleteWorkloadShareInput.Builder to create a request.
Input for Delete Workload ShareValidationException - The user input is not valid.InternalServerException - There is a problem with the Well-Architected Tool API service.ResourceNotFoundException - The requested resource was not found.ConflictException - The resource already exists.AccessDeniedException - User does not have sufficient access to perform this action.ThrottlingException - Request was denied due to request throttling.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.AwsServiceExceptiondefault DisassociateLensesResponse disassociateLenses(DisassociateLensesRequest disassociateLensesRequest) throws ValidationException, ResourceNotFoundException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
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.
disassociateLensesRequest - Input to disassociate lens reviews.ValidationException - The user input is not valid.ResourceNotFoundException - The requested resource was not found.ConflictException - The resource already exists.InternalServerException - There is a problem with the Well-Architected Tool API service.AccessDeniedException - User does not have sufficient access to perform this action.ThrottlingException - Request was denied due to request throttling.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.AwsServiceExceptiondefault DisassociateLensesResponse disassociateLenses(Consumer<DisassociateLensesRequest.Builder> disassociateLensesRequest) throws ValidationException, ResourceNotFoundException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
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 via DisassociateLensesRequest.builder()
disassociateLensesRequest - A Consumer that will call methods on DisassociateLensesInput.Builder to create a request.
Input to disassociate lens reviews.ValidationException - The user input is not valid.ResourceNotFoundException - The requested resource was not found.ConflictException - The resource already exists.InternalServerException - There is a problem with the Well-Architected Tool API service.AccessDeniedException - User does not have sufficient access to perform this action.ThrottlingException - Request was denied due to request throttling.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.AwsServiceExceptiondefault ExportLensResponse exportLens(ExportLensRequest exportLensRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Export an existing lens.
Lenses are defined in JSON. For more information, see JSON format specification in the Well-Architected Tool User Guide. Only the owner of a lens can export it.
Disclaimer
Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your custom lenses. If your custom lens or those shared with you and used in your account do include or collect PII you are responsible for: ensuring that the included PII is processed in accordance with applicable law, providing adequate privacy notices, and obtaining necessary consents for processing such data.
exportLensRequest - 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.AwsServiceExceptiondefault ExportLensResponse exportLens(Consumer<ExportLensRequest.Builder> exportLensRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Export an existing lens.
Lenses are defined in JSON. For more information, see JSON format specification in the Well-Architected Tool User Guide. Only the owner of a lens can export it.
Disclaimer
Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your custom lenses. If your custom lens or those shared with you and used in your account do include or collect PII you are responsible for: ensuring that the included PII is processed in accordance with applicable law, providing adequate privacy notices, and obtaining necessary consents for processing such data.
This is a convenience which creates an instance of the ExportLensRequest.Builder avoiding the need to
create one manually via ExportLensRequest.builder()
exportLensRequest - A Consumer that will call methods on ExportLensInput.Builder to create a request.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.AwsServiceExceptiondefault GetAnswerResponse getAnswer(GetAnswerRequest getAnswerRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Get the answer to a specific question in a workload review.
getAnswerRequest - Input to get answer.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.AwsServiceExceptiondefault GetAnswerResponse getAnswer(Consumer<GetAnswerRequest.Builder> getAnswerRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
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 via GetAnswerRequest.builder()
getAnswerRequest - A Consumer that will call methods on GetAnswerInput.Builder to create a request. Input to
get answer.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.AwsServiceExceptiondefault GetLensResponse getLens(GetLensRequest getLensRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Get an existing lens.
getLensRequest - 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.AwsServiceExceptiondefault GetLensResponse getLens(Consumer<GetLensRequest.Builder> getLensRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Get an existing lens.
This is a convenience which creates an instance of the GetLensRequest.Builder avoiding the need to create
one manually via GetLensRequest.builder()
getLensRequest - A Consumer that will call methods on GetLensInput.Builder to create a request.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.AwsServiceExceptiondefault GetLensReviewResponse getLensReview(GetLensReviewRequest getLensReviewRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Get lens review.
getLensReviewRequest - Input to get lens review.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.AwsServiceExceptiondefault GetLensReviewResponse getLensReview(Consumer<GetLensReviewRequest.Builder> getLensReviewRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Get lens review.
This is a convenience which creates an instance of the GetLensReviewRequest.Builder avoiding the need to
create one manually via GetLensReviewRequest.builder()
getLensReviewRequest - A Consumer that will call methods on GetLensReviewInput.Builder to create a request. Input
to get lens review.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.AwsServiceExceptiondefault GetLensReviewReportResponse getLensReviewReport(GetLensReviewReportRequest getLensReviewReportRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Get lens review report.
getLensReviewReportRequest - Input to get lens review report.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.AwsServiceExceptiondefault GetLensReviewReportResponse getLensReviewReport(Consumer<GetLensReviewReportRequest.Builder> getLensReviewReportRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Get lens review report.
This is a convenience which creates an instance of the GetLensReviewReportRequest.Builder avoiding the
need to create one manually via GetLensReviewReportRequest.builder()
getLensReviewReportRequest - A Consumer that will call methods on GetLensReviewReportInput.Builder to create a request.
Input to get lens review report.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.AwsServiceExceptiondefault GetLensVersionDifferenceResponse getLensVersionDifference(GetLensVersionDifferenceRequest getLensVersionDifferenceRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Get lens version differences.
getLensVersionDifferenceRequest - 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.AwsServiceExceptiondefault GetLensVersionDifferenceResponse getLensVersionDifference(Consumer<GetLensVersionDifferenceRequest.Builder> getLensVersionDifferenceRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Get lens version differences.
This is a convenience which creates an instance of the GetLensVersionDifferenceRequest.Builder avoiding
the need to create one manually via GetLensVersionDifferenceRequest.builder()
getLensVersionDifferenceRequest - A Consumer that will call methods on GetLensVersionDifferenceInput.Builder to create a
request.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.AwsServiceExceptiondefault GetMilestoneResponse getMilestone(GetMilestoneRequest getMilestoneRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Get a milestone for an existing workload.
getMilestoneRequest - Input to get a milestone.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.AwsServiceExceptiondefault GetMilestoneResponse getMilestone(Consumer<GetMilestoneRequest.Builder> getMilestoneRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
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 via GetMilestoneRequest.builder()
getMilestoneRequest - A Consumer that will call methods on GetMilestoneInput.Builder to create a request. Input
to get a milestone.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.AwsServiceExceptiondefault GetWorkloadResponse getWorkload(GetWorkloadRequest getWorkloadRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Get an existing workload.
getWorkloadRequest - Input to get a workload.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.AwsServiceExceptiondefault GetWorkloadResponse getWorkload(Consumer<GetWorkloadRequest.Builder> getWorkloadRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Get an existing workload.
This is a convenience which creates an instance of the GetWorkloadRequest.Builder avoiding the need to
create one manually via GetWorkloadRequest.builder()
getWorkloadRequest - A Consumer that will call methods on GetWorkloadInput.Builder to create a request. Input
to get a workload.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.AwsServiceExceptiondefault ImportLensResponse importLens(ImportLensRequest importLensRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ServiceQuotaExceededException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Import a new lens.
The lens cannot be applied to workloads or shared with other Amazon Web Services accounts until it's published with CreateLensVersion
Lenses are defined in JSON. For more information, see JSON format specification in the Well-Architected Tool User Guide.
A custom lens cannot exceed 500 KB in size.
Disclaimer
Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your custom lenses. If your custom lens or those shared with you and used in your account do include or collect PII you are responsible for: ensuring that the included PII is processed in accordance with applicable law, providing adequate privacy notices, and obtaining necessary consents for processing such data.
importLensRequest - ValidationException - The user input is not valid.ConflictException - The resource already exists.ResourceNotFoundException - The requested resource was not found.ServiceQuotaExceededException - The user has reached their resource quota.InternalServerException - There is a problem with the Well-Architected Tool API service.AccessDeniedException - User does not have sufficient access to perform this action.ThrottlingException - Request was denied due to request throttling.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.AwsServiceExceptiondefault ImportLensResponse importLens(Consumer<ImportLensRequest.Builder> importLensRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ServiceQuotaExceededException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Import a new lens.
The lens cannot be applied to workloads or shared with other Amazon Web Services accounts until it's published with CreateLensVersion
Lenses are defined in JSON. For more information, see JSON format specification in the Well-Architected Tool User Guide.
A custom lens cannot exceed 500 KB in size.
Disclaimer
Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your custom lenses. If your custom lens or those shared with you and used in your account do include or collect PII you are responsible for: ensuring that the included PII is processed in accordance with applicable law, providing adequate privacy notices, and obtaining necessary consents for processing such data.
This is a convenience which creates an instance of the ImportLensRequest.Builder avoiding the need to
create one manually via ImportLensRequest.builder()
importLensRequest - A Consumer that will call methods on ImportLensInput.Builder to create a request.ValidationException - The user input is not valid.ConflictException - The resource already exists.ResourceNotFoundException - The requested resource was not found.ServiceQuotaExceededException - The user has reached their resource quota.InternalServerException - There is a problem with the Well-Architected Tool API service.AccessDeniedException - User does not have sufficient access to perform this action.ThrottlingException - Request was denied due to request throttling.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.AwsServiceExceptiondefault ListAnswersResponse listAnswers(ListAnswersRequest listAnswersRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List of answers.
listAnswersRequest - Input to list answers.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.AwsServiceExceptiondefault ListAnswersResponse listAnswers(Consumer<ListAnswersRequest.Builder> listAnswersRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List of answers.
This is a convenience which creates an instance of the ListAnswersRequest.Builder avoiding the need to
create one manually via ListAnswersRequest.builder()
listAnswersRequest - A Consumer that will call methods on ListAnswersInput.Builder to create a request. Input
to list answers.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.AwsServiceExceptiondefault ListAnswersIterable listAnswersPaginator(ListAnswersRequest listAnswersRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List of answers.
This is a variant of
listAnswers(software.amazon.awssdk.services.wellarchitected.model.ListAnswersRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.wellarchitected.paginators.ListAnswersIterable responses = client.listAnswersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.wellarchitected.paginators.ListAnswersIterable responses = client
.listAnswersPaginator(request);
for (software.amazon.awssdk.services.wellarchitected.model.ListAnswersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.wellarchitected.paginators.ListAnswersIterable responses = client.listAnswersPaginator(request);
responses.iterator().forEachRemaining(....);
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.
listAnswersRequest - Input to list answers.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.AwsServiceExceptiondefault ListAnswersIterable listAnswersPaginator(Consumer<ListAnswersRequest.Builder> listAnswersRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List of answers.
This is a variant of
listAnswers(software.amazon.awssdk.services.wellarchitected.model.ListAnswersRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.wellarchitected.paginators.ListAnswersIterable responses = client.listAnswersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.wellarchitected.paginators.ListAnswersIterable responses = client
.listAnswersPaginator(request);
for (software.amazon.awssdk.services.wellarchitected.model.ListAnswersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.wellarchitected.paginators.ListAnswersIterable responses = client.listAnswersPaginator(request);
responses.iterator().forEachRemaining(....);
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 via ListAnswersRequest.builder()
listAnswersRequest - A Consumer that will call methods on ListAnswersInput.Builder to create a request. Input
to list answers.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.AwsServiceExceptiondefault ListCheckDetailsResponse listCheckDetails(ListCheckDetailsRequest listCheckDetailsRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List of Trusted Advisor check details by account related to the workload.
listCheckDetailsRequest - 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.AwsServiceExceptiondefault ListCheckDetailsResponse listCheckDetails(Consumer<ListCheckDetailsRequest.Builder> listCheckDetailsRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
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 via ListCheckDetailsRequest.builder()
listCheckDetailsRequest - A Consumer that will call methods on ListCheckDetailsInput.Builder to create a request.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.AwsServiceExceptiondefault ListCheckDetailsIterable listCheckDetailsPaginator(ListCheckDetailsRequest listCheckDetailsRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List of Trusted Advisor check details by account related to the workload.
This is a variant of
listCheckDetails(software.amazon.awssdk.services.wellarchitected.model.ListCheckDetailsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.wellarchitected.paginators.ListCheckDetailsIterable responses = client.listCheckDetailsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.wellarchitected.paginators.ListCheckDetailsIterable responses = client
.listCheckDetailsPaginator(request);
for (software.amazon.awssdk.services.wellarchitected.model.ListCheckDetailsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.wellarchitected.paginators.ListCheckDetailsIterable responses = client.listCheckDetailsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
listCheckDetailsRequest - 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.AwsServiceExceptiondefault ListCheckDetailsIterable listCheckDetailsPaginator(Consumer<ListCheckDetailsRequest.Builder> listCheckDetailsRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List of Trusted Advisor check details by account related to the workload.
This is a variant of
listCheckDetails(software.amazon.awssdk.services.wellarchitected.model.ListCheckDetailsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.wellarchitected.paginators.ListCheckDetailsIterable responses = client.listCheckDetailsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.wellarchitected.paginators.ListCheckDetailsIterable responses = client
.listCheckDetailsPaginator(request);
for (software.amazon.awssdk.services.wellarchitected.model.ListCheckDetailsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.wellarchitected.paginators.ListCheckDetailsIterable responses = client.listCheckDetailsPaginator(request);
responses.iterator().forEachRemaining(....);
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 via ListCheckDetailsRequest.builder()
listCheckDetailsRequest - A Consumer that will call methods on ListCheckDetailsInput.Builder to create a request.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.AwsServiceExceptiondefault ListCheckSummariesResponse listCheckSummaries(ListCheckSummariesRequest listCheckSummariesRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List of Trusted Advisor checks summarized for all accounts related to the workload.
listCheckSummariesRequest - 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.AwsServiceExceptiondefault ListCheckSummariesResponse listCheckSummaries(Consumer<ListCheckSummariesRequest.Builder> listCheckSummariesRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
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 via ListCheckSummariesRequest.builder()
listCheckSummariesRequest - A Consumer that will call methods on ListCheckSummariesInput.Builder to create a request.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.AwsServiceExceptiondefault ListCheckSummariesIterable listCheckSummariesPaginator(ListCheckSummariesRequest listCheckSummariesRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List of Trusted Advisor checks summarized for all accounts related to the workload.
This is a variant of
listCheckSummaries(software.amazon.awssdk.services.wellarchitected.model.ListCheckSummariesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.wellarchitected.paginators.ListCheckSummariesIterable responses = client.listCheckSummariesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.wellarchitected.paginators.ListCheckSummariesIterable responses = client
.listCheckSummariesPaginator(request);
for (software.amazon.awssdk.services.wellarchitected.model.ListCheckSummariesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.wellarchitected.paginators.ListCheckSummariesIterable responses = client.listCheckSummariesPaginator(request);
responses.iterator().forEachRemaining(....);
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.
listCheckSummariesRequest - 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.AwsServiceExceptiondefault ListCheckSummariesIterable listCheckSummariesPaginator(Consumer<ListCheckSummariesRequest.Builder> listCheckSummariesRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List of Trusted Advisor checks summarized for all accounts related to the workload.
This is a variant of
listCheckSummaries(software.amazon.awssdk.services.wellarchitected.model.ListCheckSummariesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.wellarchitected.paginators.ListCheckSummariesIterable responses = client.listCheckSummariesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.wellarchitected.paginators.ListCheckSummariesIterable responses = client
.listCheckSummariesPaginator(request);
for (software.amazon.awssdk.services.wellarchitected.model.ListCheckSummariesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.wellarchitected.paginators.ListCheckSummariesIterable responses = client.listCheckSummariesPaginator(request);
responses.iterator().forEachRemaining(....);
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 via ListCheckSummariesRequest.builder()
listCheckSummariesRequest - A Consumer that will call methods on ListCheckSummariesInput.Builder to create a request.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.AwsServiceExceptiondefault ListLensReviewImprovementsResponse listLensReviewImprovements(ListLensReviewImprovementsRequest listLensReviewImprovementsRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List lens review improvements.
listLensReviewImprovementsRequest - Input to list lens review improvements.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.AwsServiceExceptiondefault ListLensReviewImprovementsResponse listLensReviewImprovements(Consumer<ListLensReviewImprovementsRequest.Builder> listLensReviewImprovementsRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List lens review improvements.
This is a convenience which creates an instance of the ListLensReviewImprovementsRequest.Builder avoiding
the need to create one manually via ListLensReviewImprovementsRequest.builder()
listLensReviewImprovementsRequest - A Consumer that will call methods on ListLensReviewImprovementsInput.Builder to create a
request. Input to list lens review improvements.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.AwsServiceExceptiondefault ListLensReviewImprovementsIterable listLensReviewImprovementsPaginator(ListLensReviewImprovementsRequest listLensReviewImprovementsRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List lens review improvements.
This is a variant of
listLensReviewImprovements(software.amazon.awssdk.services.wellarchitected.model.ListLensReviewImprovementsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.wellarchitected.paginators.ListLensReviewImprovementsIterable responses = client.listLensReviewImprovementsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.wellarchitected.paginators.ListLensReviewImprovementsIterable responses = client
.listLensReviewImprovementsPaginator(request);
for (software.amazon.awssdk.services.wellarchitected.model.ListLensReviewImprovementsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.wellarchitected.paginators.ListLensReviewImprovementsIterable responses = client.listLensReviewImprovementsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
listLensReviewImprovementsRequest - Input to list lens review improvements.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.AwsServiceExceptiondefault ListLensReviewImprovementsIterable listLensReviewImprovementsPaginator(Consumer<ListLensReviewImprovementsRequest.Builder> listLensReviewImprovementsRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List lens review improvements.
This is a variant of
listLensReviewImprovements(software.amazon.awssdk.services.wellarchitected.model.ListLensReviewImprovementsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.wellarchitected.paginators.ListLensReviewImprovementsIterable responses = client.listLensReviewImprovementsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.wellarchitected.paginators.ListLensReviewImprovementsIterable responses = client
.listLensReviewImprovementsPaginator(request);
for (software.amazon.awssdk.services.wellarchitected.model.ListLensReviewImprovementsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.wellarchitected.paginators.ListLensReviewImprovementsIterable responses = client.listLensReviewImprovementsPaginator(request);
responses.iterator().forEachRemaining(....);
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 via ListLensReviewImprovementsRequest.builder()
listLensReviewImprovementsRequest - A Consumer that will call methods on ListLensReviewImprovementsInput.Builder to create a
request. Input to list lens review improvements.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.AwsServiceExceptiondefault ListLensReviewsResponse listLensReviews(ListLensReviewsRequest listLensReviewsRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List lens reviews.
listLensReviewsRequest - Input to list lens reviews.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.AwsServiceExceptiondefault ListLensReviewsResponse listLensReviews(Consumer<ListLensReviewsRequest.Builder> listLensReviewsRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List lens reviews.
This is a convenience which creates an instance of the ListLensReviewsRequest.Builder avoiding the need
to create one manually via ListLensReviewsRequest.builder()
listLensReviewsRequest - A Consumer that will call methods on ListLensReviewsInput.Builder to create a request.
Input to list lens reviews.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.AwsServiceExceptiondefault ListLensReviewsIterable listLensReviewsPaginator(ListLensReviewsRequest listLensReviewsRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List lens reviews.
This is a variant of
listLensReviews(software.amazon.awssdk.services.wellarchitected.model.ListLensReviewsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.wellarchitected.paginators.ListLensReviewsIterable responses = client.listLensReviewsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.wellarchitected.paginators.ListLensReviewsIterable responses = client
.listLensReviewsPaginator(request);
for (software.amazon.awssdk.services.wellarchitected.model.ListLensReviewsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.wellarchitected.paginators.ListLensReviewsIterable responses = client.listLensReviewsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
listLensReviewsRequest - Input to list lens reviews.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.AwsServiceExceptiondefault ListLensReviewsIterable listLensReviewsPaginator(Consumer<ListLensReviewsRequest.Builder> listLensReviewsRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List lens reviews.
This is a variant of
listLensReviews(software.amazon.awssdk.services.wellarchitected.model.ListLensReviewsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.wellarchitected.paginators.ListLensReviewsIterable responses = client.listLensReviewsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.wellarchitected.paginators.ListLensReviewsIterable responses = client
.listLensReviewsPaginator(request);
for (software.amazon.awssdk.services.wellarchitected.model.ListLensReviewsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.wellarchitected.paginators.ListLensReviewsIterable responses = client.listLensReviewsPaginator(request);
responses.iterator().forEachRemaining(....);
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 via ListLensReviewsRequest.builder()
listLensReviewsRequest - A Consumer that will call methods on ListLensReviewsInput.Builder to create a request.
Input to list lens reviews.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.AwsServiceExceptiondefault ListLensSharesResponse listLensShares(ListLensSharesRequest listLensSharesRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List the lens shares associated with the lens.
listLensSharesRequest - 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.AwsServiceExceptiondefault ListLensSharesResponse listLensShares(Consumer<ListLensSharesRequest.Builder> listLensSharesRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List the lens shares associated with the lens.
This is a convenience which creates an instance of the ListLensSharesRequest.Builder avoiding the need to
create one manually via ListLensSharesRequest.builder()
listLensSharesRequest - A Consumer that will call methods on ListLensSharesInput.Builder to create a request.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.AwsServiceExceptiondefault ListLensSharesIterable listLensSharesPaginator(ListLensSharesRequest listLensSharesRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List the lens shares associated with the lens.
This is a variant of
listLensShares(software.amazon.awssdk.services.wellarchitected.model.ListLensSharesRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.wellarchitected.paginators.ListLensSharesIterable responses = client.listLensSharesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.wellarchitected.paginators.ListLensSharesIterable responses = client
.listLensSharesPaginator(request);
for (software.amazon.awssdk.services.wellarchitected.model.ListLensSharesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.wellarchitected.paginators.ListLensSharesIterable responses = client.listLensSharesPaginator(request);
responses.iterator().forEachRemaining(....);
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
listLensShares(software.amazon.awssdk.services.wellarchitected.model.ListLensSharesRequest)
operation.
listLensSharesRequest - 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.AwsServiceExceptiondefault ListLensSharesIterable listLensSharesPaginator(Consumer<ListLensSharesRequest.Builder> listLensSharesRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List the lens shares associated with the lens.
This is a variant of
listLensShares(software.amazon.awssdk.services.wellarchitected.model.ListLensSharesRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.wellarchitected.paginators.ListLensSharesIterable responses = client.listLensSharesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.wellarchitected.paginators.ListLensSharesIterable responses = client
.listLensSharesPaginator(request);
for (software.amazon.awssdk.services.wellarchitected.model.ListLensSharesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.wellarchitected.paginators.ListLensSharesIterable responses = client.listLensSharesPaginator(request);
responses.iterator().forEachRemaining(....);
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
listLensShares(software.amazon.awssdk.services.wellarchitected.model.ListLensSharesRequest)
operation.
This is a convenience which creates an instance of the ListLensSharesRequest.Builder avoiding the need to
create one manually via ListLensSharesRequest.builder()
listLensSharesRequest - A Consumer that will call methods on ListLensSharesInput.Builder to create a request.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.AwsServiceExceptiondefault ListLensesResponse listLenses(ListLensesRequest listLensesRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List the available lenses.
listLensesRequest - Input to list lenses.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.AwsServiceExceptiondefault ListLensesResponse listLenses(Consumer<ListLensesRequest.Builder> listLensesRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List the available lenses.
This is a convenience which creates an instance of the ListLensesRequest.Builder avoiding the need to
create one manually via ListLensesRequest.builder()
listLensesRequest - A Consumer that will call methods on ListLensesInput.Builder to create a request. Input to
list lenses.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.AwsServiceExceptiondefault ListLensesIterable listLensesPaginator(ListLensesRequest listLensesRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List the available lenses.
This is a variant of listLenses(software.amazon.awssdk.services.wellarchitected.model.ListLensesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.wellarchitected.paginators.ListLensesIterable responses = client.listLensesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.wellarchitected.paginators.ListLensesIterable responses = client.listLensesPaginator(request);
for (software.amazon.awssdk.services.wellarchitected.model.ListLensesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.wellarchitected.paginators.ListLensesIterable responses = client.listLensesPaginator(request);
responses.iterator().forEachRemaining(....);
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.
listLensesRequest - Input to list lenses.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.AwsServiceExceptiondefault ListLensesIterable listLensesPaginator(Consumer<ListLensesRequest.Builder> listLensesRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List the available lenses.
This is a variant of listLenses(software.amazon.awssdk.services.wellarchitected.model.ListLensesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.wellarchitected.paginators.ListLensesIterable responses = client.listLensesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.wellarchitected.paginators.ListLensesIterable responses = client.listLensesPaginator(request);
for (software.amazon.awssdk.services.wellarchitected.model.ListLensesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.wellarchitected.paginators.ListLensesIterable responses = client.listLensesPaginator(request);
responses.iterator().forEachRemaining(....);
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 via ListLensesRequest.builder()
listLensesRequest - A Consumer that will call methods on ListLensesInput.Builder to create a request. Input to
list lenses.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.AwsServiceExceptiondefault ListMilestonesResponse listMilestones(ListMilestonesRequest listMilestonesRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List all milestones for an existing workload.
listMilestonesRequest - Input to list all milestones for a workload.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.AwsServiceExceptiondefault ListMilestonesResponse listMilestones(Consumer<ListMilestonesRequest.Builder> listMilestonesRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
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 via ListMilestonesRequest.builder()
listMilestonesRequest - A Consumer that will call methods on ListMilestonesInput.Builder to create a request.
Input to list all milestones for a workload.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.AwsServiceExceptiondefault ListMilestonesIterable listMilestonesPaginator(ListMilestonesRequest listMilestonesRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List all milestones for an existing workload.
This is a variant of
listMilestones(software.amazon.awssdk.services.wellarchitected.model.ListMilestonesRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.wellarchitected.paginators.ListMilestonesIterable responses = client.listMilestonesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.wellarchitected.paginators.ListMilestonesIterable responses = client
.listMilestonesPaginator(request);
for (software.amazon.awssdk.services.wellarchitected.model.ListMilestonesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.wellarchitected.paginators.ListMilestonesIterable responses = client.listMilestonesPaginator(request);
responses.iterator().forEachRemaining(....);
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.
listMilestonesRequest - Input to list all milestones for a workload.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.AwsServiceExceptiondefault ListMilestonesIterable listMilestonesPaginator(Consumer<ListMilestonesRequest.Builder> listMilestonesRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List all milestones for an existing workload.
This is a variant of
listMilestones(software.amazon.awssdk.services.wellarchitected.model.ListMilestonesRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.wellarchitected.paginators.ListMilestonesIterable responses = client.listMilestonesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.wellarchitected.paginators.ListMilestonesIterable responses = client
.listMilestonesPaginator(request);
for (software.amazon.awssdk.services.wellarchitected.model.ListMilestonesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.wellarchitected.paginators.ListMilestonesIterable responses = client.listMilestonesPaginator(request);
responses.iterator().forEachRemaining(....);
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 via ListMilestonesRequest.builder()
listMilestonesRequest - A Consumer that will call methods on ListMilestonesInput.Builder to create a request.
Input to list all milestones for a workload.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.AwsServiceExceptiondefault ListNotificationsResponse listNotifications(ListNotificationsRequest listNotificationsRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List lens notifications.
listNotificationsRequest - 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.AwsServiceExceptiondefault ListNotificationsResponse listNotifications(Consumer<ListNotificationsRequest.Builder> listNotificationsRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List lens notifications.
This is a convenience which creates an instance of the ListNotificationsRequest.Builder avoiding the need
to create one manually via ListNotificationsRequest.builder()
listNotificationsRequest - A Consumer that will call methods on ListNotificationsInput.Builder to create a request.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.AwsServiceExceptiondefault ListNotificationsIterable listNotificationsPaginator(ListNotificationsRequest listNotificationsRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List lens notifications.
This is a variant of
listNotifications(software.amazon.awssdk.services.wellarchitected.model.ListNotificationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.wellarchitected.paginators.ListNotificationsIterable responses = client.listNotificationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.wellarchitected.paginators.ListNotificationsIterable responses = client
.listNotificationsPaginator(request);
for (software.amazon.awssdk.services.wellarchitected.model.ListNotificationsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.wellarchitected.paginators.ListNotificationsIterable responses = client.listNotificationsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
listNotificationsRequest - 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.AwsServiceExceptiondefault ListNotificationsIterable listNotificationsPaginator(Consumer<ListNotificationsRequest.Builder> listNotificationsRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List lens notifications.
This is a variant of
listNotifications(software.amazon.awssdk.services.wellarchitected.model.ListNotificationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.wellarchitected.paginators.ListNotificationsIterable responses = client.listNotificationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.wellarchitected.paginators.ListNotificationsIterable responses = client
.listNotificationsPaginator(request);
for (software.amazon.awssdk.services.wellarchitected.model.ListNotificationsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.wellarchitected.paginators.ListNotificationsIterable responses = client.listNotificationsPaginator(request);
responses.iterator().forEachRemaining(....);
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 via ListNotificationsRequest.builder()
listNotificationsRequest - A Consumer that will call methods on ListNotificationsInput.Builder to create a request.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.AwsServiceExceptiondefault ListShareInvitationsResponse listShareInvitations(ListShareInvitationsRequest listShareInvitationsRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List the workload invitations.
listShareInvitationsRequest - Input for List Share InvitationsValidationException - 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.AwsServiceExceptiondefault ListShareInvitationsResponse listShareInvitations(Consumer<ListShareInvitationsRequest.Builder> listShareInvitationsRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List the workload invitations.
This is a convenience which creates an instance of the ListShareInvitationsRequest.Builder avoiding the
need to create one manually via ListShareInvitationsRequest.builder()
listShareInvitationsRequest - A Consumer that will call methods on ListShareInvitationsInput.Builder to create a
request. Input for List Share InvitationsValidationException - 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.AwsServiceExceptiondefault ListShareInvitationsIterable listShareInvitationsPaginator(ListShareInvitationsRequest listShareInvitationsRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List the workload invitations.
This is a variant of
listShareInvitations(software.amazon.awssdk.services.wellarchitected.model.ListShareInvitationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.wellarchitected.paginators.ListShareInvitationsIterable responses = client.listShareInvitationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.wellarchitected.paginators.ListShareInvitationsIterable responses = client
.listShareInvitationsPaginator(request);
for (software.amazon.awssdk.services.wellarchitected.model.ListShareInvitationsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.wellarchitected.paginators.ListShareInvitationsIterable responses = client.listShareInvitationsPaginator(request);
responses.iterator().forEachRemaining(....);
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
listShareInvitations(software.amazon.awssdk.services.wellarchitected.model.ListShareInvitationsRequest)
operation.
listShareInvitationsRequest - Input for List Share InvitationsValidationException - 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.AwsServiceExceptiondefault ListShareInvitationsIterable listShareInvitationsPaginator(Consumer<ListShareInvitationsRequest.Builder> listShareInvitationsRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List the workload invitations.
This is a variant of
listShareInvitations(software.amazon.awssdk.services.wellarchitected.model.ListShareInvitationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.wellarchitected.paginators.ListShareInvitationsIterable responses = client.listShareInvitationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.wellarchitected.paginators.ListShareInvitationsIterable responses = client
.listShareInvitationsPaginator(request);
for (software.amazon.awssdk.services.wellarchitected.model.ListShareInvitationsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.wellarchitected.paginators.ListShareInvitationsIterable responses = client.listShareInvitationsPaginator(request);
responses.iterator().forEachRemaining(....);
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
listShareInvitations(software.amazon.awssdk.services.wellarchitected.model.ListShareInvitationsRequest)
operation.
This is a convenience which creates an instance of the ListShareInvitationsRequest.Builder avoiding the
need to create one manually via ListShareInvitationsRequest.builder()
listShareInvitationsRequest - A Consumer that will call methods on ListShareInvitationsInput.Builder to create a
request. Input for List Share InvitationsValidationException - 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.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, WellArchitectedException
List the tags for a resource.
The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.
listTagsForResourceRequest - 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.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, WellArchitectedException
List the tags for a resource.
The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceInput.Builder to create a request.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.AwsServiceExceptiondefault ListWorkloadSharesResponse listWorkloadShares(ListWorkloadSharesRequest listWorkloadSharesRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List the workload shares associated with the workload.
listWorkloadSharesRequest - Input for List Workload ShareValidationException - 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.AwsServiceExceptiondefault ListWorkloadSharesResponse listWorkloadShares(Consumer<ListWorkloadSharesRequest.Builder> listWorkloadSharesRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List the workload shares associated with the workload.
This is a convenience which creates an instance of the ListWorkloadSharesRequest.Builder avoiding the
need to create one manually via ListWorkloadSharesRequest.builder()
listWorkloadSharesRequest - A Consumer that will call methods on ListWorkloadSharesInput.Builder to create a request.
Input for List Workload ShareValidationException - 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.AwsServiceExceptiondefault ListWorkloadSharesIterable listWorkloadSharesPaginator(ListWorkloadSharesRequest listWorkloadSharesRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List the workload shares associated with the workload.
This is a variant of
listWorkloadShares(software.amazon.awssdk.services.wellarchitected.model.ListWorkloadSharesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.wellarchitected.paginators.ListWorkloadSharesIterable responses = client.listWorkloadSharesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.wellarchitected.paginators.ListWorkloadSharesIterable responses = client
.listWorkloadSharesPaginator(request);
for (software.amazon.awssdk.services.wellarchitected.model.ListWorkloadSharesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.wellarchitected.paginators.ListWorkloadSharesIterable responses = client.listWorkloadSharesPaginator(request);
responses.iterator().forEachRemaining(....);
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
listWorkloadShares(software.amazon.awssdk.services.wellarchitected.model.ListWorkloadSharesRequest)
operation.
listWorkloadSharesRequest - Input for List Workload ShareValidationException - 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.AwsServiceExceptiondefault ListWorkloadSharesIterable listWorkloadSharesPaginator(Consumer<ListWorkloadSharesRequest.Builder> listWorkloadSharesRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List the workload shares associated with the workload.
This is a variant of
listWorkloadShares(software.amazon.awssdk.services.wellarchitected.model.ListWorkloadSharesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.wellarchitected.paginators.ListWorkloadSharesIterable responses = client.listWorkloadSharesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.wellarchitected.paginators.ListWorkloadSharesIterable responses = client
.listWorkloadSharesPaginator(request);
for (software.amazon.awssdk.services.wellarchitected.model.ListWorkloadSharesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.wellarchitected.paginators.ListWorkloadSharesIterable responses = client.listWorkloadSharesPaginator(request);
responses.iterator().forEachRemaining(....);
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
listWorkloadShares(software.amazon.awssdk.services.wellarchitected.model.ListWorkloadSharesRequest)
operation.
This is a convenience which creates an instance of the ListWorkloadSharesRequest.Builder avoiding the
need to create one manually via ListWorkloadSharesRequest.builder()
listWorkloadSharesRequest - A Consumer that will call methods on ListWorkloadSharesInput.Builder to create a request.
Input for List Workload ShareValidationException - 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.AwsServiceExceptiondefault ListWorkloadsResponse listWorkloads(ListWorkloadsRequest listWorkloadsRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List workloads. Paginated.
listWorkloadsRequest - Input to list all workloads.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.AwsServiceExceptiondefault ListWorkloadsResponse listWorkloads(Consumer<ListWorkloadsRequest.Builder> listWorkloadsRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List workloads. Paginated.
This is a convenience which creates an instance of the ListWorkloadsRequest.Builder avoiding the need to
create one manually via ListWorkloadsRequest.builder()
listWorkloadsRequest - A Consumer that will call methods on ListWorkloadsInput.Builder to create a request. Input
to list all workloads.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.AwsServiceExceptiondefault ListWorkloadsIterable listWorkloadsPaginator(ListWorkloadsRequest listWorkloadsRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List workloads. Paginated.
This is a variant of
listWorkloads(software.amazon.awssdk.services.wellarchitected.model.ListWorkloadsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.wellarchitected.paginators.ListWorkloadsIterable responses = client.listWorkloadsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.wellarchitected.paginators.ListWorkloadsIterable responses = client
.listWorkloadsPaginator(request);
for (software.amazon.awssdk.services.wellarchitected.model.ListWorkloadsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.wellarchitected.paginators.ListWorkloadsIterable responses = client.listWorkloadsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
listWorkloadsRequest - Input to list all workloads.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.AwsServiceExceptiondefault ListWorkloadsIterable listWorkloadsPaginator(Consumer<ListWorkloadsRequest.Builder> listWorkloadsRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List workloads. Paginated.
This is a variant of
listWorkloads(software.amazon.awssdk.services.wellarchitected.model.ListWorkloadsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.wellarchitected.paginators.ListWorkloadsIterable responses = client.listWorkloadsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.wellarchitected.paginators.ListWorkloadsIterable responses = client
.listWorkloadsPaginator(request);
for (software.amazon.awssdk.services.wellarchitected.model.ListWorkloadsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.wellarchitected.paginators.ListWorkloadsIterable responses = client.listWorkloadsPaginator(request);
responses.iterator().forEachRemaining(....);
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 via ListWorkloadsRequest.builder()
listWorkloadsRequest - A Consumer that will call methods on ListWorkloadsInput.Builder to create a request. Input
to list all workloads.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.AwsServiceExceptiondefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, WellArchitectedException
Adds one or more tags to the specified resource.
The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.
tagResourceRequest - 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.AwsServiceExceptiondefault TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, WellArchitectedException
Adds one or more tags to the specified resource.
The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceInput.Builder to create a request.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.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, WellArchitectedException
Deletes specified tags from a resource.
The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.
To specify multiple tags, use separate tagKeys parameters, for example:
DELETE /tags/WorkloadArn?tagKeys=key1&tagKeys=key2
untagResourceRequest - 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.AwsServiceExceptiondefault UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, WellArchitectedException
Deletes specified tags from a resource.
The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.
To specify multiple tags, use separate tagKeys parameters, for example:
DELETE /tags/WorkloadArn?tagKeys=key1&tagKeys=key2
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceInput.Builder to create a request.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.AwsServiceExceptiondefault UpdateAnswerResponse updateAnswer(UpdateAnswerRequest updateAnswerRequest) throws ValidationException, ResourceNotFoundException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Update the answer to a specific question in a workload review.
updateAnswerRequest - Input to update answer.ValidationException - The user input is not valid.ResourceNotFoundException - The requested resource was not found.ConflictException - The resource already exists.InternalServerException - There is a problem with the Well-Architected Tool API service.AccessDeniedException - User does not have sufficient access to perform this action.ThrottlingException - Request was denied due to request throttling.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.AwsServiceExceptiondefault UpdateAnswerResponse updateAnswer(Consumer<UpdateAnswerRequest.Builder> updateAnswerRequest) throws ValidationException, ResourceNotFoundException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
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 via UpdateAnswerRequest.builder()
updateAnswerRequest - A Consumer that will call methods on UpdateAnswerInput.Builder to create a request. Input
to update answer.ValidationException - The user input is not valid.ResourceNotFoundException - The requested resource was not found.ConflictException - The resource already exists.InternalServerException - There is a problem with the Well-Architected Tool API service.AccessDeniedException - User does not have sufficient access to perform this action.ThrottlingException - Request was denied due to request throttling.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.AwsServiceExceptiondefault UpdateGlobalSettingsResponse updateGlobalSettings(UpdateGlobalSettingsRequest updateGlobalSettingsRequest) throws ValidationException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Updates whether the Amazon Web Services account is opted into organization sharing features.
updateGlobalSettingsRequest - ValidationException - The user input is not valid.ConflictException - The resource already exists.InternalServerException - There is a problem with the Well-Architected Tool API service.AccessDeniedException - User does not have sufficient access to perform this action.ThrottlingException - Request was denied due to request throttling.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.AwsServiceExceptiondefault UpdateGlobalSettingsResponse updateGlobalSettings(Consumer<UpdateGlobalSettingsRequest.Builder> updateGlobalSettingsRequest) throws ValidationException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Updates whether the Amazon Web Services account is opted into organization sharing features.
This is a convenience which creates an instance of the UpdateGlobalSettingsRequest.Builder avoiding the
need to create one manually via UpdateGlobalSettingsRequest.builder()
updateGlobalSettingsRequest - A Consumer that will call methods on UpdateGlobalSettingsInput.Builder to create a
request.ValidationException - The user input is not valid.ConflictException - The resource already exists.InternalServerException - There is a problem with the Well-Architected Tool API service.AccessDeniedException - User does not have sufficient access to perform this action.ThrottlingException - Request was denied due to request throttling.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.AwsServiceExceptiondefault UpdateLensReviewResponse updateLensReview(UpdateLensReviewRequest updateLensReviewRequest) throws ValidationException, ResourceNotFoundException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Update lens review.
updateLensReviewRequest - Input for update lens review.ValidationException - The user input is not valid.ResourceNotFoundException - The requested resource was not found.ConflictException - The resource already exists.InternalServerException - There is a problem with the Well-Architected Tool API service.AccessDeniedException - User does not have sufficient access to perform this action.ThrottlingException - Request was denied due to request throttling.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.AwsServiceExceptiondefault UpdateLensReviewResponse updateLensReview(Consumer<UpdateLensReviewRequest.Builder> updateLensReviewRequest) throws ValidationException, ResourceNotFoundException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Update lens review.
This is a convenience which creates an instance of the UpdateLensReviewRequest.Builder avoiding the need
to create one manually via UpdateLensReviewRequest.builder()
updateLensReviewRequest - A Consumer that will call methods on UpdateLensReviewInput.Builder to create a request.
Input for update lens review.ValidationException - The user input is not valid.ResourceNotFoundException - The requested resource was not found.ConflictException - The resource already exists.InternalServerException - There is a problem with the Well-Architected Tool API service.AccessDeniedException - User does not have sufficient access to perform this action.ThrottlingException - Request was denied due to request throttling.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.AwsServiceExceptiondefault UpdateShareInvitationResponse updateShareInvitation(UpdateShareInvitationRequest updateShareInvitationRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Update a workload or custom lens share invitation.
This API operation can be called independently of any resource. Previous documentation implied that a workload ARN must be specified.
updateShareInvitationRequest - Input for Update Share InvitationValidationException - The user input is not valid.InternalServerException - There is a problem with the Well-Architected Tool API service.ResourceNotFoundException - The requested resource was not found.ConflictException - The resource already exists.AccessDeniedException - User does not have sufficient access to perform this action.ThrottlingException - Request was denied due to request throttling.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.AwsServiceExceptiondefault UpdateShareInvitationResponse updateShareInvitation(Consumer<UpdateShareInvitationRequest.Builder> updateShareInvitationRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Update a workload or custom lens share invitation.
This API operation can be called independently of any resource. Previous documentation implied that a workload ARN must be specified.
This is a convenience which creates an instance of the UpdateShareInvitationRequest.Builder avoiding the
need to create one manually via UpdateShareInvitationRequest.builder()
updateShareInvitationRequest - A Consumer that will call methods on UpdateShareInvitationInput.Builder to create a
request. Input for Update Share InvitationValidationException - The user input is not valid.InternalServerException - There is a problem with the Well-Architected Tool API service.ResourceNotFoundException - The requested resource was not found.ConflictException - The resource already exists.AccessDeniedException - User does not have sufficient access to perform this action.ThrottlingException - Request was denied due to request throttling.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.AwsServiceExceptiondefault UpdateWorkloadResponse updateWorkload(UpdateWorkloadRequest updateWorkloadRequest) throws ValidationException, ResourceNotFoundException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Update an existing workload.
updateWorkloadRequest - Input to update a workload.ValidationException - The user input is not valid.ResourceNotFoundException - The requested resource was not found.ConflictException - The resource already exists.InternalServerException - There is a problem with the Well-Architected Tool API service.AccessDeniedException - User does not have sufficient access to perform this action.ThrottlingException - Request was denied due to request throttling.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.AwsServiceExceptiondefault UpdateWorkloadResponse updateWorkload(Consumer<UpdateWorkloadRequest.Builder> updateWorkloadRequest) throws ValidationException, ResourceNotFoundException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Update an existing workload.
This is a convenience which creates an instance of the UpdateWorkloadRequest.Builder avoiding the need to
create one manually via UpdateWorkloadRequest.builder()
updateWorkloadRequest - A Consumer that will call methods on UpdateWorkloadInput.Builder to create a request.
Input to update a workload.ValidationException - The user input is not valid.ResourceNotFoundException - The requested resource was not found.ConflictException - The resource already exists.InternalServerException - There is a problem with the Well-Architected Tool API service.AccessDeniedException - User does not have sufficient access to perform this action.ThrottlingException - Request was denied due to request throttling.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.AwsServiceExceptiondefault UpdateWorkloadShareResponse updateWorkloadShare(UpdateWorkloadShareRequest updateWorkloadShareRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Update a workload share.
updateWorkloadShareRequest - Input for Update Workload ShareValidationException - The user input is not valid.InternalServerException - There is a problem with the Well-Architected Tool API service.ResourceNotFoundException - The requested resource was not found.ConflictException - The resource already exists.AccessDeniedException - User does not have sufficient access to perform this action.ThrottlingException - Request was denied due to request throttling.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.AwsServiceExceptiondefault UpdateWorkloadShareResponse updateWorkloadShare(Consumer<UpdateWorkloadShareRequest.Builder> updateWorkloadShareRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Update a workload share.
This is a convenience which creates an instance of the UpdateWorkloadShareRequest.Builder avoiding the
need to create one manually via UpdateWorkloadShareRequest.builder()
updateWorkloadShareRequest - A Consumer that will call methods on UpdateWorkloadShareInput.Builder to create a request.
Input for Update Workload ShareValidationException - The user input is not valid.InternalServerException - There is a problem with the Well-Architected Tool API service.ResourceNotFoundException - The requested resource was not found.ConflictException - The resource already exists.AccessDeniedException - User does not have sufficient access to perform this action.ThrottlingException - Request was denied due to request throttling.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.AwsServiceExceptiondefault UpgradeLensReviewResponse upgradeLensReview(UpgradeLensReviewRequest upgradeLensReviewRequest) throws ValidationException, ResourceNotFoundException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Upgrade lens review.
upgradeLensReviewRequest - ValidationException - The user input is not valid.ResourceNotFoundException - The requested resource was not found.ConflictException - The resource already exists.InternalServerException - There is a problem with the Well-Architected Tool API service.AccessDeniedException - User does not have sufficient access to perform this action.ThrottlingException - Request was denied due to request throttling.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.AwsServiceExceptiondefault UpgradeLensReviewResponse upgradeLensReview(Consumer<UpgradeLensReviewRequest.Builder> upgradeLensReviewRequest) throws ValidationException, ResourceNotFoundException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Upgrade lens review.
This is a convenience which creates an instance of the UpgradeLensReviewRequest.Builder avoiding the need
to create one manually via UpgradeLensReviewRequest.builder()
upgradeLensReviewRequest - A Consumer that will call methods on UpgradeLensReviewInput.Builder to create a request.ValidationException - The user input is not valid.ResourceNotFoundException - The requested resource was not found.ConflictException - The resource already exists.InternalServerException - There is a problem with the Well-Architected Tool API service.AccessDeniedException - User does not have sufficient access to perform this action.ThrottlingException - Request was denied due to request throttling.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.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2022. All rights reserved.