Interface WellArchitectedClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface WellArchitectedClient extends AwsClient
Service client for accessing Well-Architected. This can be created using the staticbuilder()method.Well-Architected Tool This is the Well-Architected Tool API Reference. The WA Tool API provides programmatic access to the Well-Architected Tool in the Amazon Web Services Management Console. For information about the Well-Architected Tool, see the Well-Architected Tool User Guide.
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
associateLenses
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.
- Parameters:
associateLensesRequest- Input to associate lens reviews.- Returns:
- Result of the AssociateLenses operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ResourceNotFoundException- The requested resource was not found.ConflictException- The resource has already been processed, was deleted, or is too large.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
associateLenses
default 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.Builderavoiding the need to create one manually viaAssociateLensesRequest.builder()- Parameters:
associateLensesRequest- AConsumerthat will call methods onAssociateLensesRequest.Builderto create a request. Input to associate lens reviews.- Returns:
- Result of the AssociateLenses operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ResourceNotFoundException- The requested resource was not found.ConflictException- The resource has already been processed, was deleted, or is too large.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
associateProfiles
default AssociateProfilesResponse associateProfiles(AssociateProfilesRequest associateProfilesRequest) throws ValidationException, ResourceNotFoundException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Associate a profile with a workload.
- Parameters:
associateProfilesRequest-- Returns:
- Result of the AssociateProfiles operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ResourceNotFoundException- The requested resource was not found.ConflictException- The resource has already been processed, was deleted, or is too large.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
associateProfiles
default AssociateProfilesResponse associateProfiles(Consumer<AssociateProfilesRequest.Builder> associateProfilesRequest) throws ValidationException, ResourceNotFoundException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Associate a profile with a workload.
This is a convenience which creates an instance of the
AssociateProfilesRequest.Builderavoiding the need to create one manually viaAssociateProfilesRequest.builder()- Parameters:
associateProfilesRequest- AConsumerthat will call methods onAssociateProfilesRequest.Builderto create a request.- Returns:
- Result of the AssociateProfiles operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ResourceNotFoundException- The requested resource was not found.ConflictException- The resource has already been processed, was deleted, or is too large.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createLensShare
default 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, users, an organization, and organizational units (OUs) in the same Amazon Web Services Region. Lenses provided by Amazon Web Services (Amazon Web Services Official Content) cannot be shared.
Shared access to a lens is not removed until the lens invitation is deleted.
If you share a lens with an organization or OU, all accounts in the organization or OU are granted access to the lens.
For more information, see Sharing a custom lens in the Well-Architected Tool User Guide.
Disclaimer
By sharing your custom lenses with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your custom lenses available to those other accounts. Those other accounts may continue to access and use your shared custom lenses even if you delete the custom lenses from your own Amazon Web Services account or terminate your Amazon Web Services account.
- Parameters:
createLensShareRequest-- Returns:
- Result of the CreateLensShare operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ConflictException- The resource has already been processed, was deleted, or is too large.InternalServerException- There is a problem with the Well-Architected Tool API service.ResourceNotFoundException- The requested resource was not found.ServiceQuotaExceededException- The user has reached their resource quota.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createLensShare
default 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, users, an organization, and organizational units (OUs) in the same Amazon Web Services Region. Lenses provided by Amazon Web Services (Amazon Web Services Official Content) cannot be shared.
Shared access to a lens is not removed until the lens invitation is deleted.
If you share a lens with an organization or OU, all accounts in the organization or OU are granted access to the lens.
For more information, see Sharing a custom lens in the Well-Architected Tool User Guide.
Disclaimer
By sharing your custom lenses with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your custom lenses available to those other accounts. Those other accounts may continue to access and use your shared custom lenses even if you delete the custom lenses from your own Amazon Web Services account or terminate your Amazon Web Services account.
This is a convenience which creates an instance of the
CreateLensShareRequest.Builderavoiding the need to create one manually viaCreateLensShareRequest.builder()- Parameters:
createLensShareRequest- AConsumerthat will call methods onCreateLensShareRequest.Builderto create a request.- Returns:
- Result of the CreateLensShare operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ConflictException- The resource has already been processed, was deleted, or is too large.InternalServerException- There is a problem with the Well-Architected Tool API service.ResourceNotFoundException- The requested resource was not found.ServiceQuotaExceededException- The user has reached their resource quota.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createLensVersion
default 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.
Use this operation to publish a new lens version after you have imported a lens. The
LensAliasis used to identify the lens to be published. The owner of a lens can share the lens with other Amazon Web Services accounts and users in the same Amazon Web Services Region. Only the owner of a lens can delete it.- Parameters:
createLensVersionRequest-- Returns:
- Result of the CreateLensVersion operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ResourceNotFoundException- The requested resource was not found.ServiceQuotaExceededException- The user has reached their resource quota.ConflictException- The resource has already been processed, was deleted, or is too large.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createLensVersion
default 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.
Use this operation to publish a new lens version after you have imported a lens. The
LensAliasis used to identify the lens to be published. The owner of a lens can share the lens with other Amazon Web Services accounts and users in the same Amazon Web Services Region. Only the owner of a lens can delete it.
This is a convenience which creates an instance of the
CreateLensVersionRequest.Builderavoiding the need to create one manually viaCreateLensVersionRequest.builder()- Parameters:
createLensVersionRequest- AConsumerthat will call methods onCreateLensVersionRequest.Builderto create a request.- Returns:
- Result of the CreateLensVersion operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ResourceNotFoundException- The requested resource was not found.ServiceQuotaExceededException- The user has reached their resource quota.ConflictException- The resource has already been processed, was deleted, or is too large.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createMilestone
default CreateMilestoneResponse createMilestone(CreateMilestoneRequest createMilestoneRequest) throws ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Create a milestone for an existing workload.
- Parameters:
createMilestoneRequest- Input for milestone creation.- Returns:
- Result of the CreateMilestone operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ConflictException- The resource has already been processed, was deleted, or is too large.InternalServerException- There is a problem with the Well-Architected Tool API service.ResourceNotFoundException- The requested resource was not found.ServiceQuotaExceededException- The user has reached their resource quota.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createMilestone
default 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.Builderavoiding the need to create one manually viaCreateMilestoneRequest.builder()- Parameters:
createMilestoneRequest- AConsumerthat will call methods onCreateMilestoneRequest.Builderto create a request. Input for milestone creation.- Returns:
- Result of the CreateMilestone operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ConflictException- The resource has already been processed, was deleted, or is too large.InternalServerException- There is a problem with the Well-Architected Tool API service.ResourceNotFoundException- The requested resource was not found.ServiceQuotaExceededException- The user has reached their resource quota.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createProfile
default CreateProfileResponse createProfile(CreateProfileRequest createProfileRequest) throws ValidationException, ConflictException, ServiceQuotaExceededException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Create a profile.
- Parameters:
createProfileRequest-- Returns:
- Result of the CreateProfile operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ConflictException- The resource has already been processed, was deleted, or is too large.ServiceQuotaExceededException- The user has reached their resource quota.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createProfile
default CreateProfileResponse createProfile(Consumer<CreateProfileRequest.Builder> createProfileRequest) throws ValidationException, ConflictException, ServiceQuotaExceededException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Create a profile.
This is a convenience which creates an instance of the
CreateProfileRequest.Builderavoiding the need to create one manually viaCreateProfileRequest.builder()- Parameters:
createProfileRequest- AConsumerthat will call methods onCreateProfileRequest.Builderto create a request.- Returns:
- Result of the CreateProfile operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ConflictException- The resource has already been processed, was deleted, or is too large.ServiceQuotaExceededException- The user has reached their resource quota.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createProfileShare
default CreateProfileShareResponse createProfileShare(CreateProfileShareRequest createProfileShareRequest) throws ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Create a profile share.
- Parameters:
createProfileShareRequest-- Returns:
- Result of the CreateProfileShare operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ConflictException- The resource has already been processed, was deleted, or is too large.InternalServerException- There is a problem with the Well-Architected Tool API service.ResourceNotFoundException- The requested resource was not found.ServiceQuotaExceededException- The user has reached their resource quota.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createProfileShare
default CreateProfileShareResponse createProfileShare(Consumer<CreateProfileShareRequest.Builder> createProfileShareRequest) throws ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Create a profile share.
This is a convenience which creates an instance of the
CreateProfileShareRequest.Builderavoiding the need to create one manually viaCreateProfileShareRequest.builder()- Parameters:
createProfileShareRequest- AConsumerthat will call methods onCreateProfileShareRequest.Builderto create a request.- Returns:
- Result of the CreateProfileShare operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ConflictException- The resource has already been processed, was deleted, or is too large.InternalServerException- There is a problem with the Well-Architected Tool API service.ResourceNotFoundException- The requested resource was not found.ServiceQuotaExceededException- The user has reached their resource quota.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createReviewTemplate
default CreateReviewTemplateResponse createReviewTemplate(CreateReviewTemplateRequest createReviewTemplateRequest) throws ValidationException, ConflictException, ServiceQuotaExceededException, InternalServerException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Create a review template.
Disclaimer
Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your review templates. If your review template or those shared with you and used in your account do include or collect PII you are responsible for: ensuring that the included PII is processed in accordance with applicable law, providing adequate privacy notices, and obtaining necessary consents for processing such data.
- Parameters:
createReviewTemplateRequest-- Returns:
- Result of the CreateReviewTemplate operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ConflictException- The resource has already been processed, was deleted, or is too large.ServiceQuotaExceededException- The user has reached their resource quota.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ResourceNotFoundException- The requested resource was not found.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createReviewTemplate
default CreateReviewTemplateResponse createReviewTemplate(Consumer<CreateReviewTemplateRequest.Builder> createReviewTemplateRequest) throws ValidationException, ConflictException, ServiceQuotaExceededException, InternalServerException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Create a review template.
Disclaimer
Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your review templates. If your review template or those shared with you and used in your account do include or collect PII you are responsible for: ensuring that the included PII is processed in accordance with applicable law, providing adequate privacy notices, and obtaining necessary consents for processing such data.
This is a convenience which creates an instance of the
CreateReviewTemplateRequest.Builderavoiding the need to create one manually viaCreateReviewTemplateRequest.builder()- Parameters:
createReviewTemplateRequest- AConsumerthat will call methods onCreateReviewTemplateRequest.Builderto create a request.- Returns:
- Result of the CreateReviewTemplate operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ConflictException- The resource has already been processed, was deleted, or is too large.ServiceQuotaExceededException- The user has reached their resource quota.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ResourceNotFoundException- The requested resource was not found.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createTemplateShare
default CreateTemplateShareResponse createTemplateShare(CreateTemplateShareRequest createTemplateShareRequest) throws ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Create a review template share.
The owner of a review template can share it with other Amazon Web Services accounts, users, an organization, and organizational units (OUs) in the same Amazon Web Services Region.
Shared access to a review template is not removed until the review template share invitation is deleted.
If you share a review template with an organization or OU, all accounts in the organization or OU are granted access to the review template.
Disclaimer
By sharing your review template with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your review template available to those other accounts.
- Parameters:
createTemplateShareRequest-- Returns:
- Result of the CreateTemplateShare operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ConflictException- The resource has already been processed, was deleted, or is too large.InternalServerException- There is a problem with the Well-Architected Tool API service.ResourceNotFoundException- The requested resource was not found.ServiceQuotaExceededException- The user has reached their resource quota.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createTemplateShare
default CreateTemplateShareResponse createTemplateShare(Consumer<CreateTemplateShareRequest.Builder> createTemplateShareRequest) throws ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Create a review template share.
The owner of a review template can share it with other Amazon Web Services accounts, users, an organization, and organizational units (OUs) in the same Amazon Web Services Region.
Shared access to a review template is not removed until the review template share invitation is deleted.
If you share a review template with an organization or OU, all accounts in the organization or OU are granted access to the review template.
Disclaimer
By sharing your review template with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your review template available to those other accounts.
This is a convenience which creates an instance of the
CreateTemplateShareRequest.Builderavoiding the need to create one manually viaCreateTemplateShareRequest.builder()- Parameters:
createTemplateShareRequest- AConsumerthat will call methods onCreateTemplateShareRequest.Builderto create a request.- Returns:
- Result of the CreateTemplateShare operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ConflictException- The resource has already been processed, was deleted, or is too large.InternalServerException- There is a problem with the Well-Architected Tool API service.ResourceNotFoundException- The requested resource was not found.ServiceQuotaExceededException- The user has reached their resource quota.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createWorkload
default CreateWorkloadResponse createWorkload(CreateWorkloadRequest createWorkloadRequest) throws ValidationException, ConflictException, ServiceQuotaExceededException, InternalServerException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Create a new workload.
The owner of a workload can share the workload with other Amazon Web Services accounts, users, an organization, and organizational units (OUs) in the same Amazon Web Services Region. Only the owner of a workload can delete it.
For more information, see Defining a Workload in the Well-Architected Tool User Guide.
Either
AwsRegions,NonAwsRegions, or both must be specified when creating a workload.You also must specify
ReviewOwner, even though the parameter is listed as not being required in the following section.When creating a workload using a review template, you must have the following IAM permissions:
-
wellarchitected:GetReviewTemplate -
wellarchitected:GetReviewTemplateAnswer -
wellarchitected:ListReviewTemplateAnswers -
wellarchitected:GetReviewTemplateLensReview
- Parameters:
createWorkloadRequest- Input for workload creation.- Returns:
- Result of the CreateWorkload operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ConflictException- The resource has already been processed, was deleted, or is too large.ServiceQuotaExceededException- The user has reached their resource quota.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ResourceNotFoundException- The requested resource was not found.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
createWorkload
default CreateWorkloadResponse createWorkload(Consumer<CreateWorkloadRequest.Builder> createWorkloadRequest) throws ValidationException, ConflictException, ServiceQuotaExceededException, InternalServerException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Create a new workload.
The owner of a workload can share the workload with other Amazon Web Services accounts, users, an organization, and organizational units (OUs) in the same Amazon Web Services Region. Only the owner of a workload can delete it.
For more information, see Defining a Workload in the Well-Architected Tool User Guide.
Either
AwsRegions,NonAwsRegions, or both must be specified when creating a workload.You also must specify
ReviewOwner, even though the parameter is listed as not being required in the following section.When creating a workload using a review template, you must have the following IAM permissions:
-
wellarchitected:GetReviewTemplate -
wellarchitected:GetReviewTemplateAnswer -
wellarchitected:ListReviewTemplateAnswers -
wellarchitected:GetReviewTemplateLensReview
This is a convenience which creates an instance of the
CreateWorkloadRequest.Builderavoiding the need to create one manually viaCreateWorkloadRequest.builder()- Parameters:
createWorkloadRequest- AConsumerthat will call methods onCreateWorkloadRequest.Builderto create a request. Input for workload creation.- Returns:
- Result of the CreateWorkload operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ConflictException- The resource has already been processed, was deleted, or is too large.ServiceQuotaExceededException- The user has reached their resource quota.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ResourceNotFoundException- The requested resource was not found.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
createWorkloadShare
default 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 users in the same Amazon Web Services Region. Shared access to a workload is not removed until the workload invitation is deleted.
If you share a workload with an organization or OU, all accounts in the organization or OU are granted access to the workload.
For more information, see Sharing a workload in the Well-Architected Tool User Guide.
- Parameters:
createWorkloadShareRequest- Input for Create Workload Share- Returns:
- Result of the CreateWorkloadShare operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ConflictException- The resource has already been processed, was deleted, or is too large.InternalServerException- There is a problem with the Well-Architected Tool API service.ResourceNotFoundException- The requested resource was not found.ServiceQuotaExceededException- The user has reached their resource quota.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createWorkloadShare
default 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 users in the same Amazon Web Services Region. Shared access to a workload is not removed until the workload invitation is deleted.
If you share a workload with an organization or OU, all accounts in the organization or OU are granted access to the workload.
For more information, see Sharing a workload in the Well-Architected Tool User Guide.
This is a convenience which creates an instance of the
CreateWorkloadShareRequest.Builderavoiding the need to create one manually viaCreateWorkloadShareRequest.builder()- Parameters:
createWorkloadShareRequest- AConsumerthat will call methods onCreateWorkloadShareRequest.Builderto create a request. Input for Create Workload Share- Returns:
- Result of the CreateWorkloadShare operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ConflictException- The resource has already been processed, was deleted, or is too large.InternalServerException- There is a problem with the Well-Architected Tool API service.ResourceNotFoundException- The requested resource was not found.ServiceQuotaExceededException- The user has reached their resource quota.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteLens
default 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 users that you shared the lens with can continue to use it, but they will no longer be able to apply it to new workloads.
Disclaimer
By sharing your custom lenses with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your custom lenses available to those other accounts. Those other accounts may continue to access and use your shared custom lenses even if you delete the custom lenses from your own Amazon Web Services account or terminate your Amazon Web Services account.
- Parameters:
deleteLensRequest-- Returns:
- Result of the DeleteLens operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ResourceNotFoundException- The requested resource was not found.ConflictException- The resource has already been processed, was deleted, or is too large.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteLens
default 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 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.Builderavoiding the need to create one manually viaDeleteLensRequest.builder()- Parameters:
deleteLensRequest- AConsumerthat will call methods onDeleteLensRequest.Builderto create a request.- Returns:
- Result of the DeleteLens operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ResourceNotFoundException- The requested resource was not found.ConflictException- The resource has already been processed, was deleted, or is too large.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteLensShare
default 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, 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.
- Parameters:
deleteLensShareRequest-- Returns:
- Result of the DeleteLensShare operation returned by the service.
- Throws:
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 has already been processed, was deleted, or is too large.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteLensShare
default 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, 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.Builderavoiding the need to create one manually viaDeleteLensShareRequest.builder()- Parameters:
deleteLensShareRequest- AConsumerthat will call methods onDeleteLensShareRequest.Builderto create a request.- Returns:
- Result of the DeleteLensShare operation returned by the service.
- Throws:
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 has already been processed, was deleted, or is too large.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteProfile
default DeleteProfileResponse deleteProfile(DeleteProfileRequest deleteProfileRequest) throws ValidationException, ResourceNotFoundException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Delete a profile.
Disclaimer
By sharing your profile with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your profile available to those other accounts. Those other accounts may continue to access and use your shared profile even if you delete the profile from your own Amazon Web Services account or terminate your Amazon Web Services account.
- Parameters:
deleteProfileRequest-- Returns:
- Result of the DeleteProfile operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ResourceNotFoundException- The requested resource was not found.ConflictException- The resource has already been processed, was deleted, or is too large.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteProfile
default DeleteProfileResponse deleteProfile(Consumer<DeleteProfileRequest.Builder> deleteProfileRequest) throws ValidationException, ResourceNotFoundException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Delete a profile.
Disclaimer
By sharing your profile with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your profile available to those other accounts. Those other accounts may continue to access and use your shared profile even if you delete the profile from your own Amazon Web Services account or terminate your Amazon Web Services account.
This is a convenience which creates an instance of the
DeleteProfileRequest.Builderavoiding the need to create one manually viaDeleteProfileRequest.builder()- Parameters:
deleteProfileRequest- AConsumerthat will call methods onDeleteProfileRequest.Builderto create a request.- Returns:
- Result of the DeleteProfile operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ResourceNotFoundException- The requested resource was not found.ConflictException- The resource has already been processed, was deleted, or is too large.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteProfileShare
default DeleteProfileShareResponse deleteProfileShare(DeleteProfileShareRequest deleteProfileShareRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Delete a profile share.
- Parameters:
deleteProfileShareRequest-- Returns:
- Result of the DeleteProfileShare operation returned by the service.
- Throws:
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 has already been processed, was deleted, or is too large.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteProfileShare
default DeleteProfileShareResponse deleteProfileShare(Consumer<DeleteProfileShareRequest.Builder> deleteProfileShareRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Delete a profile share.
This is a convenience which creates an instance of the
DeleteProfileShareRequest.Builderavoiding the need to create one manually viaDeleteProfileShareRequest.builder()- Parameters:
deleteProfileShareRequest- AConsumerthat will call methods onDeleteProfileShareRequest.Builderto create a request.- Returns:
- Result of the DeleteProfileShare operation returned by the service.
- Throws:
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 has already been processed, was deleted, or is too large.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteReviewTemplate
default DeleteReviewTemplateResponse deleteReviewTemplate(DeleteReviewTemplateRequest deleteReviewTemplateRequest) throws ValidationException, ResourceNotFoundException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Delete a review template.
Only the owner of a review template can delete it.
After the review template is deleted, Amazon Web Services accounts, users, organizations, and organizational units (OUs) that you shared the review template with will no longer be able to apply it to new workloads.
- Parameters:
deleteReviewTemplateRequest-- Returns:
- Result of the DeleteReviewTemplate operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ResourceNotFoundException- The requested resource was not found.ConflictException- The resource has already been processed, was deleted, or is too large.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteReviewTemplate
default DeleteReviewTemplateResponse deleteReviewTemplate(Consumer<DeleteReviewTemplateRequest.Builder> deleteReviewTemplateRequest) throws ValidationException, ResourceNotFoundException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Delete a review template.
Only the owner of a review template can delete it.
After the review template is deleted, Amazon Web Services accounts, users, organizations, and organizational units (OUs) that you shared the review template with will no longer be able to apply it to new workloads.
This is a convenience which creates an instance of the
DeleteReviewTemplateRequest.Builderavoiding the need to create one manually viaDeleteReviewTemplateRequest.builder()- Parameters:
deleteReviewTemplateRequest- AConsumerthat will call methods onDeleteReviewTemplateRequest.Builderto create a request.- Returns:
- Result of the DeleteReviewTemplate operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ResourceNotFoundException- The requested resource was not found.ConflictException- The resource has already been processed, was deleted, or is too large.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteTemplateShare
default DeleteTemplateShareResponse deleteTemplateShare(DeleteTemplateShareRequest deleteTemplateShareRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Delete a review template share.
After the review template share is deleted, Amazon Web Services accounts, users, organizations, and organizational units (OUs) that you shared the review template with will no longer be able to apply it to new workloads.
- Parameters:
deleteTemplateShareRequest-- Returns:
- Result of the DeleteTemplateShare operation returned by the service.
- Throws:
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 has already been processed, was deleted, or is too large.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteTemplateShare
default DeleteTemplateShareResponse deleteTemplateShare(Consumer<DeleteTemplateShareRequest.Builder> deleteTemplateShareRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Delete a review template share.
After the review template share is deleted, Amazon Web Services accounts, users, organizations, and organizational units (OUs) that you shared the review template with will no longer be able to apply it to new workloads.
This is a convenience which creates an instance of the
DeleteTemplateShareRequest.Builderavoiding the need to create one manually viaDeleteTemplateShareRequest.builder()- Parameters:
deleteTemplateShareRequest- AConsumerthat will call methods onDeleteTemplateShareRequest.Builderto create a request.- Returns:
- Result of the DeleteTemplateShare operation returned by the service.
- Throws:
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 has already been processed, was deleted, or is too large.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteWorkload
default DeleteWorkloadResponse deleteWorkload(DeleteWorkloadRequest deleteWorkloadRequest) throws ValidationException, ResourceNotFoundException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Delete an existing workload.
- Parameters:
deleteWorkloadRequest- Input for workload deletion.- Returns:
- Result of the DeleteWorkload operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ResourceNotFoundException- The requested resource was not found.ConflictException- The resource has already been processed, was deleted, or is too large.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteWorkload
default 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.Builderavoiding the need to create one manually viaDeleteWorkloadRequest.builder()- Parameters:
deleteWorkloadRequest- AConsumerthat will call methods onDeleteWorkloadRequest.Builderto create a request. Input for workload deletion.- Returns:
- Result of the DeleteWorkload operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ResourceNotFoundException- The requested resource was not found.ConflictException- The resource has already been processed, was deleted, or is too large.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteWorkloadShare
default DeleteWorkloadShareResponse deleteWorkloadShare(DeleteWorkloadShareRequest deleteWorkloadShareRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Delete a workload share.
- Parameters:
deleteWorkloadShareRequest- Input for Delete Workload Share- Returns:
- Result of the DeleteWorkloadShare operation returned by the service.
- Throws:
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 has already been processed, was deleted, or is too large.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteWorkloadShare
default 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.Builderavoiding the need to create one manually viaDeleteWorkloadShareRequest.builder()- Parameters:
deleteWorkloadShareRequest- AConsumerthat will call methods onDeleteWorkloadShareRequest.Builderto create a request. Input for Delete Workload Share- Returns:
- Result of the DeleteWorkloadShare operation returned by the service.
- Throws:
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 has already been processed, was deleted, or is too large.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.AwsServiceException- See Also:
- AWS API Documentation
-
disassociateLenses
default 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.- Parameters:
disassociateLensesRequest- Input to disassociate lens reviews.- Returns:
- Result of the DisassociateLenses operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ResourceNotFoundException- The requested resource was not found.ConflictException- The resource has already been processed, was deleted, or is too large.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
disassociateLenses
default 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.Builderavoiding the need to create one manually viaDisassociateLensesRequest.builder()- Parameters:
disassociateLensesRequest- AConsumerthat will call methods onDisassociateLensesRequest.Builderto create a request. Input to disassociate lens reviews.- Returns:
- Result of the DisassociateLenses operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ResourceNotFoundException- The requested resource was not found.ConflictException- The resource has already been processed, was deleted, or is too large.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
disassociateProfiles
default DisassociateProfilesResponse disassociateProfiles(DisassociateProfilesRequest disassociateProfilesRequest) throws ValidationException, ResourceNotFoundException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Disassociate a profile from a workload.
- Parameters:
disassociateProfilesRequest-- Returns:
- Result of the DisassociateProfiles operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ResourceNotFoundException- The requested resource was not found.ConflictException- The resource has already been processed, was deleted, or is too large.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
disassociateProfiles
default DisassociateProfilesResponse disassociateProfiles(Consumer<DisassociateProfilesRequest.Builder> disassociateProfilesRequest) throws ValidationException, ResourceNotFoundException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Disassociate a profile from a workload.
This is a convenience which creates an instance of the
DisassociateProfilesRequest.Builderavoiding the need to create one manually viaDisassociateProfilesRequest.builder()- Parameters:
disassociateProfilesRequest- AConsumerthat will call methods onDisassociateProfilesRequest.Builderto create a request.- Returns:
- Result of the DisassociateProfiles operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ResourceNotFoundException- The requested resource was not found.ConflictException- The resource has already been processed, was deleted, or is too large.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
exportLens
default ExportLensResponse exportLens(ExportLensRequest exportLensRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Export an existing lens.
Only the owner of a lens can export it. Lenses provided by Amazon Web Services (Amazon Web Services Official Content) cannot be exported.
Lenses are defined in JSON. For more information, see JSON format specification in the Well-Architected Tool User Guide.
Disclaimer
Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your custom lenses. If your custom lens or those shared with you and used in your account do include or collect PII you are responsible for: ensuring that the included PII is processed in accordance with applicable law, providing adequate privacy notices, and obtaining necessary consents for processing such data.
- Parameters:
exportLensRequest-- Returns:
- Result of the ExportLens operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
exportLens
default ExportLensResponse exportLens(Consumer<ExportLensRequest.Builder> exportLensRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Export an existing lens.
Only the owner of a lens can export it. Lenses provided by Amazon Web Services (Amazon Web Services Official Content) cannot be exported.
Lenses are defined in JSON. For more information, see JSON format specification in the Well-Architected Tool User Guide.
Disclaimer
Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your custom lenses. If your custom lens or those shared with you and used in your account do include or collect PII you are responsible for: ensuring that the included PII is processed in accordance with applicable law, providing adequate privacy notices, and obtaining necessary consents for processing such data.
This is a convenience which creates an instance of the
ExportLensRequest.Builderavoiding the need to create one manually viaExportLensRequest.builder()- Parameters:
exportLensRequest- AConsumerthat will call methods onExportLensRequest.Builderto create a request.- Returns:
- Result of the ExportLens operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getAnswer
default GetAnswerResponse getAnswer(GetAnswerRequest getAnswerRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Get the answer to a specific question in a workload review.
- Parameters:
getAnswerRequest- Input to get answer.- Returns:
- Result of the GetAnswer operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getAnswer
default 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.Builderavoiding the need to create one manually viaGetAnswerRequest.builder()- Parameters:
getAnswerRequest- AConsumerthat will call methods onGetAnswerRequest.Builderto create a request. Input to get answer.- Returns:
- Result of the GetAnswer operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getConsolidatedReport
default GetConsolidatedReportResponse getConsolidatedReport(GetConsolidatedReportRequest getConsolidatedReportRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, ConflictException, AwsServiceException, SdkClientException, WellArchitectedException
Get a consolidated report of your workloads.
You can optionally choose to include workloads that have been shared with you.
- Parameters:
getConsolidatedReportRequest-- Returns:
- Result of the GetConsolidatedReport operation returned by the service.
- Throws:
ValidationException- The user input is not valid.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.ConflictException- The resource has already been processed, was deleted, or is too large.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getConsolidatedReport
default GetConsolidatedReportResponse getConsolidatedReport(Consumer<GetConsolidatedReportRequest.Builder> getConsolidatedReportRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, ConflictException, AwsServiceException, SdkClientException, WellArchitectedException
Get a consolidated report of your workloads.
You can optionally choose to include workloads that have been shared with you.
This is a convenience which creates an instance of the
GetConsolidatedReportRequest.Builderavoiding the need to create one manually viaGetConsolidatedReportRequest.builder()- Parameters:
getConsolidatedReportRequest- AConsumerthat will call methods onGetConsolidatedReportRequest.Builderto create a request.- Returns:
- Result of the GetConsolidatedReport operation returned by the service.
- Throws:
ValidationException- The user input is not valid.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.ConflictException- The resource has already been processed, was deleted, or is too large.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getConsolidatedReportPaginator
default GetConsolidatedReportIterable getConsolidatedReportPaginator(GetConsolidatedReportRequest getConsolidatedReportRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, ConflictException, AwsServiceException, SdkClientException, WellArchitectedException
This is a variant of
getConsolidatedReport(software.amazon.awssdk.services.wellarchitected.model.GetConsolidatedReportRequest)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
2) Using For loopsoftware.amazon.awssdk.services.wellarchitected.paginators.GetConsolidatedReportIterable responses = client.getConsolidatedReportPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.wellarchitected.paginators.GetConsolidatedReportIterable responses = client .getConsolidatedReportPaginator(request); for (software.amazon.awssdk.services.wellarchitected.model.GetConsolidatedReportResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.wellarchitected.paginators.GetConsolidatedReportIterable responses = client.getConsolidatedReportPaginator(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
getConsolidatedReport(software.amazon.awssdk.services.wellarchitected.model.GetConsolidatedReportRequest)operation.- Parameters:
getConsolidatedReportRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ValidationException- The user input is not valid.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.ConflictException- The resource has already been processed, was deleted, or is too large.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getConsolidatedReportPaginator
default GetConsolidatedReportIterable getConsolidatedReportPaginator(Consumer<GetConsolidatedReportRequest.Builder> getConsolidatedReportRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, ConflictException, AwsServiceException, SdkClientException, WellArchitectedException
This is a variant of
getConsolidatedReport(software.amazon.awssdk.services.wellarchitected.model.GetConsolidatedReportRequest)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
2) Using For loopsoftware.amazon.awssdk.services.wellarchitected.paginators.GetConsolidatedReportIterable responses = client.getConsolidatedReportPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.wellarchitected.paginators.GetConsolidatedReportIterable responses = client .getConsolidatedReportPaginator(request); for (software.amazon.awssdk.services.wellarchitected.model.GetConsolidatedReportResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.wellarchitected.paginators.GetConsolidatedReportIterable responses = client.getConsolidatedReportPaginator(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
getConsolidatedReport(software.amazon.awssdk.services.wellarchitected.model.GetConsolidatedReportRequest)operation.
This is a convenience which creates an instance of the
GetConsolidatedReportRequest.Builderavoiding the need to create one manually viaGetConsolidatedReportRequest.builder()- Parameters:
getConsolidatedReportRequest- AConsumerthat will call methods onGetConsolidatedReportRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ValidationException- The user input is not valid.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.ConflictException- The resource has already been processed, was deleted, or is too large.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getGlobalSettings
default GetGlobalSettingsResponse getGlobalSettings(GetGlobalSettingsRequest getGlobalSettingsRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Global settings for all workloads.
- Parameters:
getGlobalSettingsRequest-- Returns:
- Result of the GetGlobalSettings operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getGlobalSettings
default GetGlobalSettingsResponse getGlobalSettings(Consumer<GetGlobalSettingsRequest.Builder> getGlobalSettingsRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Global settings for all workloads.
This is a convenience which creates an instance of the
GetGlobalSettingsRequest.Builderavoiding the need to create one manually viaGetGlobalSettingsRequest.builder()- Parameters:
getGlobalSettingsRequest- AConsumerthat will call methods onGetGlobalSettingsRequest.Builderto create a request.- Returns:
- Result of the GetGlobalSettings operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getLens
default GetLensResponse getLens(GetLensRequest getLensRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Get an existing lens.
- Parameters:
getLensRequest-- Returns:
- Result of the GetLens operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getLens
default 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.Builderavoiding the need to create one manually viaGetLensRequest.builder()- Parameters:
getLensRequest- AConsumerthat will call methods onGetLensRequest.Builderto create a request.- Returns:
- Result of the GetLens operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getLensReview
default GetLensReviewResponse getLensReview(GetLensReviewRequest getLensReviewRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Get lens review.
- Parameters:
getLensReviewRequest- Input to get lens review.- Returns:
- Result of the GetLensReview operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getLensReview
default 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.Builderavoiding the need to create one manually viaGetLensReviewRequest.builder()- Parameters:
getLensReviewRequest- AConsumerthat will call methods onGetLensReviewRequest.Builderto create a request. Input to get lens review.- Returns:
- Result of the GetLensReview operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getLensReviewReport
default GetLensReviewReportResponse getLensReviewReport(GetLensReviewReportRequest getLensReviewReportRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Get lens review report.
- Parameters:
getLensReviewReportRequest- Input to get lens review report.- Returns:
- Result of the GetLensReviewReport operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getLensReviewReport
default 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.Builderavoiding the need to create one manually viaGetLensReviewReportRequest.builder()- Parameters:
getLensReviewReportRequest- AConsumerthat will call methods onGetLensReviewReportRequest.Builderto create a request. Input to get lens review report.- Returns:
- Result of the GetLensReviewReport operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getLensVersionDifference
default GetLensVersionDifferenceResponse getLensVersionDifference(GetLensVersionDifferenceRequest getLensVersionDifferenceRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Get lens version differences.
- Parameters:
getLensVersionDifferenceRequest-- Returns:
- Result of the GetLensVersionDifference operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getLensVersionDifference
default 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.Builderavoiding the need to create one manually viaGetLensVersionDifferenceRequest.builder()- Parameters:
getLensVersionDifferenceRequest- AConsumerthat will call methods onGetLensVersionDifferenceRequest.Builderto create a request.- Returns:
- Result of the GetLensVersionDifference operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getMilestone
default GetMilestoneResponse getMilestone(GetMilestoneRequest getMilestoneRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Get a milestone for an existing workload.
- Parameters:
getMilestoneRequest- Input to get a milestone.- Returns:
- Result of the GetMilestone operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getMilestone
default 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.Builderavoiding the need to create one manually viaGetMilestoneRequest.builder()- Parameters:
getMilestoneRequest- AConsumerthat will call methods onGetMilestoneRequest.Builderto create a request. Input to get a milestone.- Returns:
- Result of the GetMilestone operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getProfile
default GetProfileResponse getProfile(GetProfileRequest getProfileRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Get profile information.
- Parameters:
getProfileRequest-- Returns:
- Result of the GetProfile operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getProfile
default GetProfileResponse getProfile(Consumer<GetProfileRequest.Builder> getProfileRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Get profile information.
This is a convenience which creates an instance of the
GetProfileRequest.Builderavoiding the need to create one manually viaGetProfileRequest.builder()- Parameters:
getProfileRequest- AConsumerthat will call methods onGetProfileRequest.Builderto create a request.- Returns:
- Result of the GetProfile operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getProfileTemplate
default GetProfileTemplateResponse getProfileTemplate(GetProfileTemplateRequest getProfileTemplateRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Get profile template.
- Parameters:
getProfileTemplateRequest-- Returns:
- Result of the GetProfileTemplate operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getProfileTemplate
default GetProfileTemplateResponse getProfileTemplate(Consumer<GetProfileTemplateRequest.Builder> getProfileTemplateRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Get profile template.
This is a convenience which creates an instance of the
GetProfileTemplateRequest.Builderavoiding the need to create one manually viaGetProfileTemplateRequest.builder()- Parameters:
getProfileTemplateRequest- AConsumerthat will call methods onGetProfileTemplateRequest.Builderto create a request.- Returns:
- Result of the GetProfileTemplate operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getReviewTemplate
default GetReviewTemplateResponse getReviewTemplate(GetReviewTemplateRequest getReviewTemplateRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Get review template.
- Parameters:
getReviewTemplateRequest-- Returns:
- Result of the GetReviewTemplate operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getReviewTemplate
default GetReviewTemplateResponse getReviewTemplate(Consumer<GetReviewTemplateRequest.Builder> getReviewTemplateRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Get review template.
This is a convenience which creates an instance of the
GetReviewTemplateRequest.Builderavoiding the need to create one manually viaGetReviewTemplateRequest.builder()- Parameters:
getReviewTemplateRequest- AConsumerthat will call methods onGetReviewTemplateRequest.Builderto create a request.- Returns:
- Result of the GetReviewTemplate operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getReviewTemplateAnswer
default GetReviewTemplateAnswerResponse getReviewTemplateAnswer(GetReviewTemplateAnswerRequest getReviewTemplateAnswerRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Get review template answer.
- Parameters:
getReviewTemplateAnswerRequest-- Returns:
- Result of the GetReviewTemplateAnswer operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getReviewTemplateAnswer
default GetReviewTemplateAnswerResponse getReviewTemplateAnswer(Consumer<GetReviewTemplateAnswerRequest.Builder> getReviewTemplateAnswerRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Get review template answer.
This is a convenience which creates an instance of the
GetReviewTemplateAnswerRequest.Builderavoiding the need to create one manually viaGetReviewTemplateAnswerRequest.builder()- Parameters:
getReviewTemplateAnswerRequest- AConsumerthat will call methods onGetReviewTemplateAnswerRequest.Builderto create a request.- Returns:
- Result of the GetReviewTemplateAnswer operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getReviewTemplateLensReview
default GetReviewTemplateLensReviewResponse getReviewTemplateLensReview(GetReviewTemplateLensReviewRequest getReviewTemplateLensReviewRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Get a lens review associated with a review template.
- Parameters:
getReviewTemplateLensReviewRequest-- Returns:
- Result of the GetReviewTemplateLensReview operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getReviewTemplateLensReview
default GetReviewTemplateLensReviewResponse getReviewTemplateLensReview(Consumer<GetReviewTemplateLensReviewRequest.Builder> getReviewTemplateLensReviewRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Get a lens review associated with a review template.
This is a convenience which creates an instance of the
GetReviewTemplateLensReviewRequest.Builderavoiding the need to create one manually viaGetReviewTemplateLensReviewRequest.builder()- Parameters:
getReviewTemplateLensReviewRequest- AConsumerthat will call methods onGetReviewTemplateLensReviewRequest.Builderto create a request.- Returns:
- Result of the GetReviewTemplateLensReview operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getWorkload
default GetWorkloadResponse getWorkload(GetWorkloadRequest getWorkloadRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Get an existing workload.
- Parameters:
getWorkloadRequest- Input to get a workload.- Returns:
- Result of the GetWorkload operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getWorkload
default 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.Builderavoiding the need to create one manually viaGetWorkloadRequest.builder()- Parameters:
getWorkloadRequest- AConsumerthat will call methods onGetWorkloadRequest.Builderto create a request. Input to get a workload.- Returns:
- Result of the GetWorkload operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
importLens
default ImportLensResponse importLens(ImportLensRequest importLensRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ServiceQuotaExceededException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Import a new custom lens or update an existing custom lens.
To update an existing custom lens, specify its ARN as the
LensAlias. If no ARN is specified, a new custom lens is created.The new or updated lens will have a status of
DRAFT. The lens cannot be applied to workloads or shared with other Amazon Web Services accounts until it's published with CreateLensVersion.Lenses are defined in JSON. For more information, see JSON format specification in the Well-Architected Tool User Guide.
A custom lens cannot exceed 500 KB in size.
Disclaimer
Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your custom lenses. If your custom lens or those shared with you and used in your account do include or collect PII you are responsible for: ensuring that the included PII is processed in accordance with applicable law, providing adequate privacy notices, and obtaining necessary consents for processing such data.
- Parameters:
importLensRequest-- Returns:
- Result of the ImportLens operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ConflictException- The resource has already been processed, was deleted, or is too large.ResourceNotFoundException- The requested resource was not found.ServiceQuotaExceededException- The user has reached their resource quota.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
importLens
default ImportLensResponse importLens(Consumer<ImportLensRequest.Builder> importLensRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ServiceQuotaExceededException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Import a new custom lens or update an existing custom lens.
To update an existing custom lens, specify its ARN as the
LensAlias. If no ARN is specified, a new custom lens is created.The new or updated lens will have a status of
DRAFT. The lens cannot be applied to workloads or shared with other Amazon Web Services accounts until it's published with CreateLensVersion.Lenses are defined in JSON. For more information, see JSON format specification in the Well-Architected Tool User Guide.
A custom lens cannot exceed 500 KB in size.
Disclaimer
Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your custom lenses. If your custom lens or those shared with you and used in your account do include or collect PII you are responsible for: ensuring that the included PII is processed in accordance with applicable law, providing adequate privacy notices, and obtaining necessary consents for processing such data.
This is a convenience which creates an instance of the
ImportLensRequest.Builderavoiding the need to create one manually viaImportLensRequest.builder()- Parameters:
importLensRequest- AConsumerthat will call methods onImportLensRequest.Builderto create a request.- Returns:
- Result of the ImportLens operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ConflictException- The resource has already been processed, was deleted, or is too large.ResourceNotFoundException- The requested resource was not found.ServiceQuotaExceededException- The user has reached their resource quota.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAnswers
default ListAnswersResponse listAnswers(ListAnswersRequest listAnswersRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List of answers for a particular workload and lens.
- Parameters:
listAnswersRequest- Input to list answers.- Returns:
- Result of the ListAnswers operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAnswers
default ListAnswersResponse listAnswers(Consumer<ListAnswersRequest.Builder> listAnswersRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List of answers for a particular workload and lens.
This is a convenience which creates an instance of the
ListAnswersRequest.Builderavoiding the need to create one manually viaListAnswersRequest.builder()- Parameters:
listAnswersRequest- AConsumerthat will call methods onListAnswersRequest.Builderto create a request. Input to list answers.- Returns:
- Result of the ListAnswers operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAnswersPaginator
default ListAnswersIterable listAnswersPaginator(ListAnswersRequest listAnswersRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
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
2) Using For loopsoftware.amazon.awssdk.services.wellarchitected.paginators.ListAnswersIterable responses = client.listAnswersPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
listAnswersRequest- Input to list answers.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAnswersPaginator
default ListAnswersIterable listAnswersPaginator(Consumer<ListAnswersRequest.Builder> listAnswersRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
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
2) Using For loopsoftware.amazon.awssdk.services.wellarchitected.paginators.ListAnswersIterable responses = client.listAnswersPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListAnswersRequest.builder()- Parameters:
listAnswersRequest- AConsumerthat will call methods onListAnswersRequest.Builderto create a request. Input to list answers.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listCheckDetails
default 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.
- Parameters:
listCheckDetailsRequest-- Returns:
- Result of the ListCheckDetails operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listCheckDetails
default 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.Builderavoiding the need to create one manually viaListCheckDetailsRequest.builder()- Parameters:
listCheckDetailsRequest- AConsumerthat will call methods onListCheckDetailsRequest.Builderto create a request.- Returns:
- Result of the ListCheckDetails operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listCheckDetailsPaginator
default ListCheckDetailsIterable listCheckDetailsPaginator(ListCheckDetailsRequest listCheckDetailsRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
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
2) Using For loopsoftware.amazon.awssdk.services.wellarchitected.paginators.ListCheckDetailsIterable responses = client.listCheckDetailsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
listCheckDetailsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listCheckDetailsPaginator
default ListCheckDetailsIterable listCheckDetailsPaginator(Consumer<ListCheckDetailsRequest.Builder> listCheckDetailsRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
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
2) Using For loopsoftware.amazon.awssdk.services.wellarchitected.paginators.ListCheckDetailsIterable responses = client.listCheckDetailsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListCheckDetailsRequest.builder()- Parameters:
listCheckDetailsRequest- AConsumerthat will call methods onListCheckDetailsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listCheckSummaries
default 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.
- Parameters:
listCheckSummariesRequest-- Returns:
- Result of the ListCheckSummaries operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listCheckSummaries
default 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.Builderavoiding the need to create one manually viaListCheckSummariesRequest.builder()- Parameters:
listCheckSummariesRequest- AConsumerthat will call methods onListCheckSummariesRequest.Builderto create a request.- Returns:
- Result of the ListCheckSummaries operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listCheckSummariesPaginator
default ListCheckSummariesIterable listCheckSummariesPaginator(ListCheckSummariesRequest listCheckSummariesRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
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
2) Using For loopsoftware.amazon.awssdk.services.wellarchitected.paginators.ListCheckSummariesIterable responses = client.listCheckSummariesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
listCheckSummariesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listCheckSummariesPaginator
default ListCheckSummariesIterable listCheckSummariesPaginator(Consumer<ListCheckSummariesRequest.Builder> listCheckSummariesRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
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
2) Using For loopsoftware.amazon.awssdk.services.wellarchitected.paginators.ListCheckSummariesIterable responses = client.listCheckSummariesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListCheckSummariesRequest.builder()- Parameters:
listCheckSummariesRequest- AConsumerthat will call methods onListCheckSummariesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listLensReviewImprovements
default ListLensReviewImprovementsResponse listLensReviewImprovements(ListLensReviewImprovementsRequest listLensReviewImprovementsRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List the improvements of a particular lens review.
- Parameters:
listLensReviewImprovementsRequest- Input to list lens review improvements.- Returns:
- Result of the ListLensReviewImprovements operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listLensReviewImprovements
default ListLensReviewImprovementsResponse listLensReviewImprovements(Consumer<ListLensReviewImprovementsRequest.Builder> listLensReviewImprovementsRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List the improvements of a particular lens review.
This is a convenience which creates an instance of the
ListLensReviewImprovementsRequest.Builderavoiding the need to create one manually viaListLensReviewImprovementsRequest.builder()- Parameters:
listLensReviewImprovementsRequest- AConsumerthat will call methods onListLensReviewImprovementsRequest.Builderto create a request. Input to list lens review improvements.- Returns:
- Result of the ListLensReviewImprovements operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listLensReviewImprovementsPaginator
default ListLensReviewImprovementsIterable listLensReviewImprovementsPaginator(ListLensReviewImprovementsRequest listLensReviewImprovementsRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
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
2) Using For loopsoftware.amazon.awssdk.services.wellarchitected.paginators.ListLensReviewImprovementsIterable responses = client.listLensReviewImprovementsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
listLensReviewImprovementsRequest- Input to list lens review improvements.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listLensReviewImprovementsPaginator
default ListLensReviewImprovementsIterable listLensReviewImprovementsPaginator(Consumer<ListLensReviewImprovementsRequest.Builder> listLensReviewImprovementsRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
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
2) Using For loopsoftware.amazon.awssdk.services.wellarchitected.paginators.ListLensReviewImprovementsIterable responses = client.listLensReviewImprovementsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListLensReviewImprovementsRequest.builder()- Parameters:
listLensReviewImprovementsRequest- AConsumerthat will call methods onListLensReviewImprovementsRequest.Builderto create a request. Input to list lens review improvements.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listLensReviews
default ListLensReviewsResponse listLensReviews(ListLensReviewsRequest listLensReviewsRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List lens reviews for a particular workload.
- Parameters:
listLensReviewsRequest- Input to list lens reviews.- Returns:
- Result of the ListLensReviews operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listLensReviews
default ListLensReviewsResponse listLensReviews(Consumer<ListLensReviewsRequest.Builder> listLensReviewsRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List lens reviews for a particular workload.
This is a convenience which creates an instance of the
ListLensReviewsRequest.Builderavoiding the need to create one manually viaListLensReviewsRequest.builder()- Parameters:
listLensReviewsRequest- AConsumerthat will call methods onListLensReviewsRequest.Builderto create a request. Input to list lens reviews.- Returns:
- Result of the ListLensReviews operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listLensReviewsPaginator
default ListLensReviewsIterable listLensReviewsPaginator(ListLensReviewsRequest listLensReviewsRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
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
2) Using For loopsoftware.amazon.awssdk.services.wellarchitected.paginators.ListLensReviewsIterable responses = client.listLensReviewsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
listLensReviewsRequest- Input to list lens reviews.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listLensReviewsPaginator
default ListLensReviewsIterable listLensReviewsPaginator(Consumer<ListLensReviewsRequest.Builder> listLensReviewsRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
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
2) Using For loopsoftware.amazon.awssdk.services.wellarchitected.paginators.ListLensReviewsIterable responses = client.listLensReviewsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListLensReviewsRequest.builder()- Parameters:
listLensReviewsRequest- AConsumerthat will call methods onListLensReviewsRequest.Builderto create a request. Input to list lens reviews.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listLensShares
default ListLensSharesResponse listLensShares(ListLensSharesRequest listLensSharesRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List the lens shares associated with the lens.
- Parameters:
listLensSharesRequest-- Returns:
- Result of the ListLensShares operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listLensShares
default 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.Builderavoiding the need to create one manually viaListLensSharesRequest.builder()- Parameters:
listLensSharesRequest- AConsumerthat will call methods onListLensSharesRequest.Builderto create a request.- Returns:
- Result of the ListLensShares operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listLensSharesPaginator
default ListLensSharesIterable listLensSharesPaginator(ListLensSharesRequest listLensSharesRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
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
2) Using For loopsoftware.amazon.awssdk.services.wellarchitected.paginators.ListLensSharesIterable responses = client.listLensSharesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
listLensSharesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listLensSharesPaginator
default ListLensSharesIterable listLensSharesPaginator(Consumer<ListLensSharesRequest.Builder> listLensSharesRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
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
2) Using For loopsoftware.amazon.awssdk.services.wellarchitected.paginators.ListLensSharesIterable responses = client.listLensSharesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListLensSharesRequest.builder()- Parameters:
listLensSharesRequest- AConsumerthat will call methods onListLensSharesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listLenses
default ListLensesResponse listLenses(ListLensesRequest listLensesRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List the available lenses.
- Parameters:
listLensesRequest- Input to list lenses.- Returns:
- Result of the ListLenses operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listLenses
default 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.Builderavoiding the need to create one manually viaListLensesRequest.builder()- Parameters:
listLensesRequest- AConsumerthat will call methods onListLensesRequest.Builderto create a request. Input to list lenses.- Returns:
- Result of the ListLenses operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listLensesPaginator
default ListLensesIterable listLensesPaginator(ListLensesRequest listLensesRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
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
2) Using For loopsoftware.amazon.awssdk.services.wellarchitected.paginators.ListLensesIterable responses = client.listLensesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
listLensesRequest- Input to list lenses.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listLensesPaginator
default ListLensesIterable listLensesPaginator(Consumer<ListLensesRequest.Builder> listLensesRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
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
2) Using For loopsoftware.amazon.awssdk.services.wellarchitected.paginators.ListLensesIterable responses = client.listLensesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListLensesRequest.builder()- Parameters:
listLensesRequest- AConsumerthat will call methods onListLensesRequest.Builderto create a request. Input to list lenses.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listMilestones
default ListMilestonesResponse listMilestones(ListMilestonesRequest listMilestonesRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List all milestones for an existing workload.
- Parameters:
listMilestonesRequest- Input to list all milestones for a workload.- Returns:
- Result of the ListMilestones operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listMilestones
default 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.Builderavoiding the need to create one manually viaListMilestonesRequest.builder()- Parameters:
listMilestonesRequest- AConsumerthat will call methods onListMilestonesRequest.Builderto create a request. Input to list all milestones for a workload.- Returns:
- Result of the ListMilestones operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listMilestonesPaginator
default ListMilestonesIterable listMilestonesPaginator(ListMilestonesRequest listMilestonesRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
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
2) Using For loopsoftware.amazon.awssdk.services.wellarchitected.paginators.ListMilestonesIterable responses = client.listMilestonesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
listMilestonesRequest- Input to list all milestones for a workload.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listMilestonesPaginator
default ListMilestonesIterable listMilestonesPaginator(Consumer<ListMilestonesRequest.Builder> listMilestonesRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
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
2) Using For loopsoftware.amazon.awssdk.services.wellarchitected.paginators.ListMilestonesIterable responses = client.listMilestonesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListMilestonesRequest.builder()- Parameters:
listMilestonesRequest- AConsumerthat will call methods onListMilestonesRequest.Builderto create a request. Input to list all milestones for a workload.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listNotifications
default ListNotificationsResponse listNotifications(ListNotificationsRequest listNotificationsRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List lens notifications.
- Parameters:
listNotificationsRequest-- Returns:
- Result of the ListNotifications operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listNotifications
default 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.Builderavoiding the need to create one manually viaListNotificationsRequest.builder()- Parameters:
listNotificationsRequest- AConsumerthat will call methods onListNotificationsRequest.Builderto create a request.- Returns:
- Result of the ListNotifications operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listNotificationsPaginator
default ListNotificationsIterable listNotificationsPaginator(ListNotificationsRequest listNotificationsRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
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
2) Using For loopsoftware.amazon.awssdk.services.wellarchitected.paginators.ListNotificationsIterable responses = client.listNotificationsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
listNotificationsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listNotificationsPaginator
default ListNotificationsIterable listNotificationsPaginator(Consumer<ListNotificationsRequest.Builder> listNotificationsRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
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
2) Using For loopsoftware.amazon.awssdk.services.wellarchitected.paginators.ListNotificationsIterable responses = client.listNotificationsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListNotificationsRequest.builder()- Parameters:
listNotificationsRequest- AConsumerthat will call methods onListNotificationsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listProfileNotifications
default ListProfileNotificationsResponse listProfileNotifications(ListProfileNotificationsRequest listProfileNotificationsRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List profile notifications.
- Parameters:
listProfileNotificationsRequest-- Returns:
- Result of the ListProfileNotifications operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listProfileNotifications
default ListProfileNotificationsResponse listProfileNotifications(Consumer<ListProfileNotificationsRequest.Builder> listProfileNotificationsRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List profile notifications.
This is a convenience which creates an instance of the
ListProfileNotificationsRequest.Builderavoiding the need to create one manually viaListProfileNotificationsRequest.builder()- Parameters:
listProfileNotificationsRequest- AConsumerthat will call methods onListProfileNotificationsRequest.Builderto create a request.- Returns:
- Result of the ListProfileNotifications operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listProfileNotificationsPaginator
default ListProfileNotificationsIterable listProfileNotificationsPaginator(ListProfileNotificationsRequest listProfileNotificationsRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
This is a variant of
listProfileNotifications(software.amazon.awssdk.services.wellarchitected.model.ListProfileNotificationsRequest)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
2) Using For loopsoftware.amazon.awssdk.services.wellarchitected.paginators.ListProfileNotificationsIterable responses = client.listProfileNotificationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.wellarchitected.paginators.ListProfileNotificationsIterable responses = client .listProfileNotificationsPaginator(request); for (software.amazon.awssdk.services.wellarchitected.model.ListProfileNotificationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.wellarchitected.paginators.ListProfileNotificationsIterable responses = client.listProfileNotificationsPaginator(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
listProfileNotifications(software.amazon.awssdk.services.wellarchitected.model.ListProfileNotificationsRequest)operation.- Parameters:
listProfileNotificationsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listProfileNotificationsPaginator
default ListProfileNotificationsIterable listProfileNotificationsPaginator(Consumer<ListProfileNotificationsRequest.Builder> listProfileNotificationsRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
This is a variant of
listProfileNotifications(software.amazon.awssdk.services.wellarchitected.model.ListProfileNotificationsRequest)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
2) Using For loopsoftware.amazon.awssdk.services.wellarchitected.paginators.ListProfileNotificationsIterable responses = client.listProfileNotificationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.wellarchitected.paginators.ListProfileNotificationsIterable responses = client .listProfileNotificationsPaginator(request); for (software.amazon.awssdk.services.wellarchitected.model.ListProfileNotificationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.wellarchitected.paginators.ListProfileNotificationsIterable responses = client.listProfileNotificationsPaginator(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
listProfileNotifications(software.amazon.awssdk.services.wellarchitected.model.ListProfileNotificationsRequest)operation.
This is a convenience which creates an instance of the
ListProfileNotificationsRequest.Builderavoiding the need to create one manually viaListProfileNotificationsRequest.builder()- Parameters:
listProfileNotificationsRequest- AConsumerthat will call methods onListProfileNotificationsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listProfileShares
default ListProfileSharesResponse listProfileShares(ListProfileSharesRequest listProfileSharesRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List profile shares.
- Parameters:
listProfileSharesRequest-- Returns:
- Result of the ListProfileShares operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listProfileShares
default ListProfileSharesResponse listProfileShares(Consumer<ListProfileSharesRequest.Builder> listProfileSharesRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List profile shares.
This is a convenience which creates an instance of the
ListProfileSharesRequest.Builderavoiding the need to create one manually viaListProfileSharesRequest.builder()- Parameters:
listProfileSharesRequest- AConsumerthat will call methods onListProfileSharesRequest.Builderto create a request.- Returns:
- Result of the ListProfileShares operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listProfileSharesPaginator
default ListProfileSharesIterable listProfileSharesPaginator(ListProfileSharesRequest listProfileSharesRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
This is a variant of
listProfileShares(software.amazon.awssdk.services.wellarchitected.model.ListProfileSharesRequest)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
2) Using For loopsoftware.amazon.awssdk.services.wellarchitected.paginators.ListProfileSharesIterable responses = client.listProfileSharesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.wellarchitected.paginators.ListProfileSharesIterable responses = client .listProfileSharesPaginator(request); for (software.amazon.awssdk.services.wellarchitected.model.ListProfileSharesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.wellarchitected.paginators.ListProfileSharesIterable responses = client.listProfileSharesPaginator(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
listProfileShares(software.amazon.awssdk.services.wellarchitected.model.ListProfileSharesRequest)operation.- Parameters:
listProfileSharesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listProfileSharesPaginator
default ListProfileSharesIterable listProfileSharesPaginator(Consumer<ListProfileSharesRequest.Builder> listProfileSharesRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
This is a variant of
listProfileShares(software.amazon.awssdk.services.wellarchitected.model.ListProfileSharesRequest)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
2) Using For loopsoftware.amazon.awssdk.services.wellarchitected.paginators.ListProfileSharesIterable responses = client.listProfileSharesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.wellarchitected.paginators.ListProfileSharesIterable responses = client .listProfileSharesPaginator(request); for (software.amazon.awssdk.services.wellarchitected.model.ListProfileSharesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.wellarchitected.paginators.ListProfileSharesIterable responses = client.listProfileSharesPaginator(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
listProfileShares(software.amazon.awssdk.services.wellarchitected.model.ListProfileSharesRequest)operation.
This is a convenience which creates an instance of the
ListProfileSharesRequest.Builderavoiding the need to create one manually viaListProfileSharesRequest.builder()- Parameters:
listProfileSharesRequest- AConsumerthat will call methods onListProfileSharesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listProfiles
default ListProfilesResponse listProfiles(ListProfilesRequest listProfilesRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List profiles.
- Parameters:
listProfilesRequest-- Returns:
- Result of the ListProfiles operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listProfiles
default ListProfilesResponse listProfiles(Consumer<ListProfilesRequest.Builder> listProfilesRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List profiles.
This is a convenience which creates an instance of the
ListProfilesRequest.Builderavoiding the need to create one manually viaListProfilesRequest.builder()- Parameters:
listProfilesRequest- AConsumerthat will call methods onListProfilesRequest.Builderto create a request.- Returns:
- Result of the ListProfiles operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listProfilesPaginator
default ListProfilesIterable listProfilesPaginator(ListProfilesRequest listProfilesRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
This is a variant of
listProfiles(software.amazon.awssdk.services.wellarchitected.model.ListProfilesRequest)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
2) Using For loopsoftware.amazon.awssdk.services.wellarchitected.paginators.ListProfilesIterable responses = client.listProfilesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.wellarchitected.paginators.ListProfilesIterable responses = client .listProfilesPaginator(request); for (software.amazon.awssdk.services.wellarchitected.model.ListProfilesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.wellarchitected.paginators.ListProfilesIterable responses = client.listProfilesPaginator(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
listProfiles(software.amazon.awssdk.services.wellarchitected.model.ListProfilesRequest)operation.- Parameters:
listProfilesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listProfilesPaginator
default ListProfilesIterable listProfilesPaginator(Consumer<ListProfilesRequest.Builder> listProfilesRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
This is a variant of
listProfiles(software.amazon.awssdk.services.wellarchitected.model.ListProfilesRequest)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
2) Using For loopsoftware.amazon.awssdk.services.wellarchitected.paginators.ListProfilesIterable responses = client.listProfilesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.wellarchitected.paginators.ListProfilesIterable responses = client .listProfilesPaginator(request); for (software.amazon.awssdk.services.wellarchitected.model.ListProfilesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.wellarchitected.paginators.ListProfilesIterable responses = client.listProfilesPaginator(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
listProfiles(software.amazon.awssdk.services.wellarchitected.model.ListProfilesRequest)operation.
This is a convenience which creates an instance of the
ListProfilesRequest.Builderavoiding the need to create one manually viaListProfilesRequest.builder()- Parameters:
listProfilesRequest- AConsumerthat will call methods onListProfilesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listReviewTemplateAnswers
default ListReviewTemplateAnswersResponse listReviewTemplateAnswers(ListReviewTemplateAnswersRequest listReviewTemplateAnswersRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List the answers of a review template.
- Parameters:
listReviewTemplateAnswersRequest-- Returns:
- Result of the ListReviewTemplateAnswers operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listReviewTemplateAnswers
default ListReviewTemplateAnswersResponse listReviewTemplateAnswers(Consumer<ListReviewTemplateAnswersRequest.Builder> listReviewTemplateAnswersRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List the answers of a review template.
This is a convenience which creates an instance of the
ListReviewTemplateAnswersRequest.Builderavoiding the need to create one manually viaListReviewTemplateAnswersRequest.builder()- Parameters:
listReviewTemplateAnswersRequest- AConsumerthat will call methods onListReviewTemplateAnswersRequest.Builderto create a request.- Returns:
- Result of the ListReviewTemplateAnswers operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listReviewTemplateAnswersPaginator
default ListReviewTemplateAnswersIterable listReviewTemplateAnswersPaginator(ListReviewTemplateAnswersRequest listReviewTemplateAnswersRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
This is a variant of
listReviewTemplateAnswers(software.amazon.awssdk.services.wellarchitected.model.ListReviewTemplateAnswersRequest)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
2) Using For loopsoftware.amazon.awssdk.services.wellarchitected.paginators.ListReviewTemplateAnswersIterable responses = client.listReviewTemplateAnswersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.wellarchitected.paginators.ListReviewTemplateAnswersIterable responses = client .listReviewTemplateAnswersPaginator(request); for (software.amazon.awssdk.services.wellarchitected.model.ListReviewTemplateAnswersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.wellarchitected.paginators.ListReviewTemplateAnswersIterable responses = client.listReviewTemplateAnswersPaginator(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
listReviewTemplateAnswers(software.amazon.awssdk.services.wellarchitected.model.ListReviewTemplateAnswersRequest)operation.- Parameters:
listReviewTemplateAnswersRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listReviewTemplateAnswersPaginator
default ListReviewTemplateAnswersIterable listReviewTemplateAnswersPaginator(Consumer<ListReviewTemplateAnswersRequest.Builder> listReviewTemplateAnswersRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
This is a variant of
listReviewTemplateAnswers(software.amazon.awssdk.services.wellarchitected.model.ListReviewTemplateAnswersRequest)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
2) Using For loopsoftware.amazon.awssdk.services.wellarchitected.paginators.ListReviewTemplateAnswersIterable responses = client.listReviewTemplateAnswersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.wellarchitected.paginators.ListReviewTemplateAnswersIterable responses = client .listReviewTemplateAnswersPaginator(request); for (software.amazon.awssdk.services.wellarchitected.model.ListReviewTemplateAnswersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.wellarchitected.paginators.ListReviewTemplateAnswersIterable responses = client.listReviewTemplateAnswersPaginator(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
listReviewTemplateAnswers(software.amazon.awssdk.services.wellarchitected.model.ListReviewTemplateAnswersRequest)operation.
This is a convenience which creates an instance of the
ListReviewTemplateAnswersRequest.Builderavoiding the need to create one manually viaListReviewTemplateAnswersRequest.builder()- Parameters:
listReviewTemplateAnswersRequest- AConsumerthat will call methods onListReviewTemplateAnswersRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listReviewTemplates
default ListReviewTemplatesResponse listReviewTemplates(ListReviewTemplatesRequest listReviewTemplatesRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List review templates.
- Parameters:
listReviewTemplatesRequest-- Returns:
- Result of the ListReviewTemplates operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listReviewTemplates
default ListReviewTemplatesResponse listReviewTemplates(Consumer<ListReviewTemplatesRequest.Builder> listReviewTemplatesRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List review templates.
This is a convenience which creates an instance of the
ListReviewTemplatesRequest.Builderavoiding the need to create one manually viaListReviewTemplatesRequest.builder()- Parameters:
listReviewTemplatesRequest- AConsumerthat will call methods onListReviewTemplatesRequest.Builderto create a request.- Returns:
- Result of the ListReviewTemplates operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listReviewTemplatesPaginator
default ListReviewTemplatesIterable listReviewTemplatesPaginator(ListReviewTemplatesRequest listReviewTemplatesRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
This is a variant of
listReviewTemplates(software.amazon.awssdk.services.wellarchitected.model.ListReviewTemplatesRequest)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
2) Using For loopsoftware.amazon.awssdk.services.wellarchitected.paginators.ListReviewTemplatesIterable responses = client.listReviewTemplatesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.wellarchitected.paginators.ListReviewTemplatesIterable responses = client .listReviewTemplatesPaginator(request); for (software.amazon.awssdk.services.wellarchitected.model.ListReviewTemplatesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.wellarchitected.paginators.ListReviewTemplatesIterable responses = client.listReviewTemplatesPaginator(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
listReviewTemplates(software.amazon.awssdk.services.wellarchitected.model.ListReviewTemplatesRequest)operation.- Parameters:
listReviewTemplatesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listReviewTemplatesPaginator
default ListReviewTemplatesIterable listReviewTemplatesPaginator(Consumer<ListReviewTemplatesRequest.Builder> listReviewTemplatesRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
This is a variant of
listReviewTemplates(software.amazon.awssdk.services.wellarchitected.model.ListReviewTemplatesRequest)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
2) Using For loopsoftware.amazon.awssdk.services.wellarchitected.paginators.ListReviewTemplatesIterable responses = client.listReviewTemplatesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.wellarchitected.paginators.ListReviewTemplatesIterable responses = client .listReviewTemplatesPaginator(request); for (software.amazon.awssdk.services.wellarchitected.model.ListReviewTemplatesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.wellarchitected.paginators.ListReviewTemplatesIterable responses = client.listReviewTemplatesPaginator(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
listReviewTemplates(software.amazon.awssdk.services.wellarchitected.model.ListReviewTemplatesRequest)operation.
This is a convenience which creates an instance of the
ListReviewTemplatesRequest.Builderavoiding the need to create one manually viaListReviewTemplatesRequest.builder()- Parameters:
listReviewTemplatesRequest- AConsumerthat will call methods onListReviewTemplatesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listShareInvitations
default ListShareInvitationsResponse listShareInvitations(ListShareInvitationsRequest listShareInvitationsRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List the share invitations.
WorkloadNamePrefix,LensNamePrefix,ProfileNamePrefix, andTemplateNamePrefixare mutually exclusive. Use the parameter that matches yourShareResourceType.- Parameters:
listShareInvitationsRequest- Input for List Share Invitations- Returns:
- Result of the ListShareInvitations operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listShareInvitations
default ListShareInvitationsResponse listShareInvitations(Consumer<ListShareInvitationsRequest.Builder> listShareInvitationsRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List the share invitations.
WorkloadNamePrefix,LensNamePrefix,ProfileNamePrefix, andTemplateNamePrefixare mutually exclusive. Use the parameter that matches yourShareResourceType.
This is a convenience which creates an instance of the
ListShareInvitationsRequest.Builderavoiding the need to create one manually viaListShareInvitationsRequest.builder()- Parameters:
listShareInvitationsRequest- AConsumerthat will call methods onListShareInvitationsRequest.Builderto create a request. Input for List Share Invitations- Returns:
- Result of the ListShareInvitations operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listShareInvitationsPaginator
default ListShareInvitationsIterable listShareInvitationsPaginator(ListShareInvitationsRequest listShareInvitationsRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
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
2) Using For loopsoftware.amazon.awssdk.services.wellarchitected.paginators.ListShareInvitationsIterable responses = client.listShareInvitationsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
listShareInvitationsRequest- Input for List Share Invitations- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listShareInvitationsPaginator
default ListShareInvitationsIterable listShareInvitationsPaginator(Consumer<ListShareInvitationsRequest.Builder> listShareInvitationsRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
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
2) Using For loopsoftware.amazon.awssdk.services.wellarchitected.paginators.ListShareInvitationsIterable responses = client.listShareInvitationsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListShareInvitationsRequest.builder()- Parameters:
listShareInvitationsRequest- AConsumerthat will call methods onListShareInvitationsRequest.Builderto create a request. Input for List Share Invitations- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, WellArchitectedException
List the tags for a resource.
The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN.
- Parameters:
listTagsForResourceRequest-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, WellArchitectedException
List the tags for a resource.
The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTemplateShares
default ListTemplateSharesResponse listTemplateShares(ListTemplateSharesRequest listTemplateSharesRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List review template shares.
- Parameters:
listTemplateSharesRequest-- Returns:
- Result of the ListTemplateShares operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTemplateShares
default ListTemplateSharesResponse listTemplateShares(Consumer<ListTemplateSharesRequest.Builder> listTemplateSharesRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List review template shares.
This is a convenience which creates an instance of the
ListTemplateSharesRequest.Builderavoiding the need to create one manually viaListTemplateSharesRequest.builder()- Parameters:
listTemplateSharesRequest- AConsumerthat will call methods onListTemplateSharesRequest.Builderto create a request.- Returns:
- Result of the ListTemplateShares operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTemplateSharesPaginator
default ListTemplateSharesIterable listTemplateSharesPaginator(ListTemplateSharesRequest listTemplateSharesRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
This is a variant of
listTemplateShares(software.amazon.awssdk.services.wellarchitected.model.ListTemplateSharesRequest)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
2) Using For loopsoftware.amazon.awssdk.services.wellarchitected.paginators.ListTemplateSharesIterable responses = client.listTemplateSharesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.wellarchitected.paginators.ListTemplateSharesIterable responses = client .listTemplateSharesPaginator(request); for (software.amazon.awssdk.services.wellarchitected.model.ListTemplateSharesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.wellarchitected.paginators.ListTemplateSharesIterable responses = client.listTemplateSharesPaginator(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
listTemplateShares(software.amazon.awssdk.services.wellarchitected.model.ListTemplateSharesRequest)operation.- Parameters:
listTemplateSharesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTemplateSharesPaginator
default ListTemplateSharesIterable listTemplateSharesPaginator(Consumer<ListTemplateSharesRequest.Builder> listTemplateSharesRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
This is a variant of
listTemplateShares(software.amazon.awssdk.services.wellarchitected.model.ListTemplateSharesRequest)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
2) Using For loopsoftware.amazon.awssdk.services.wellarchitected.paginators.ListTemplateSharesIterable responses = client.listTemplateSharesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.wellarchitected.paginators.ListTemplateSharesIterable responses = client .listTemplateSharesPaginator(request); for (software.amazon.awssdk.services.wellarchitected.model.ListTemplateSharesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.wellarchitected.paginators.ListTemplateSharesIterable responses = client.listTemplateSharesPaginator(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
listTemplateShares(software.amazon.awssdk.services.wellarchitected.model.ListTemplateSharesRequest)operation.
This is a convenience which creates an instance of the
ListTemplateSharesRequest.Builderavoiding the need to create one manually viaListTemplateSharesRequest.builder()- Parameters:
listTemplateSharesRequest- AConsumerthat will call methods onListTemplateSharesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkloadShares
default ListWorkloadSharesResponse listWorkloadShares(ListWorkloadSharesRequest listWorkloadSharesRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
List the workload shares associated with the workload.
- Parameters:
listWorkloadSharesRequest- Input for List Workload Share- Returns:
- Result of the ListWorkloadShares operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkloadShares
default 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.Builderavoiding the need to create one manually viaListWorkloadSharesRequest.builder()- Parameters:
listWorkloadSharesRequest- AConsumerthat will call methods onListWorkloadSharesRequest.Builderto create a request. Input for List Workload Share- Returns:
- Result of the ListWorkloadShares operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkloadSharesPaginator
default ListWorkloadSharesIterable listWorkloadSharesPaginator(ListWorkloadSharesRequest listWorkloadSharesRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
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
2) Using For loopsoftware.amazon.awssdk.services.wellarchitected.paginators.ListWorkloadSharesIterable responses = client.listWorkloadSharesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
listWorkloadSharesRequest- Input for List Workload Share- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkloadSharesPaginator
default ListWorkloadSharesIterable listWorkloadSharesPaginator(Consumer<ListWorkloadSharesRequest.Builder> listWorkloadSharesRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
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
2) Using For loopsoftware.amazon.awssdk.services.wellarchitected.paginators.ListWorkloadSharesIterable responses = client.listWorkloadSharesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListWorkloadSharesRequest.builder()- Parameters:
listWorkloadSharesRequest- AConsumerthat will call methods onListWorkloadSharesRequest.Builderto create a request. Input for List Workload Share- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkloads
default ListWorkloadsResponse listWorkloads(ListWorkloadsRequest listWorkloadsRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Paginated list of workloads.
- Parameters:
listWorkloadsRequest- Input to list all workloads.- Returns:
- Result of the ListWorkloads operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkloads
default ListWorkloadsResponse listWorkloads(Consumer<ListWorkloadsRequest.Builder> listWorkloadsRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Paginated list of workloads.
This is a convenience which creates an instance of the
ListWorkloadsRequest.Builderavoiding the need to create one manually viaListWorkloadsRequest.builder()- Parameters:
listWorkloadsRequest- AConsumerthat will call methods onListWorkloadsRequest.Builderto create a request. Input to list all workloads.- Returns:
- Result of the ListWorkloads operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkloadsPaginator
default ListWorkloadsIterable listWorkloadsPaginator(ListWorkloadsRequest listWorkloadsRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
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
2) Using For loopsoftware.amazon.awssdk.services.wellarchitected.paginators.ListWorkloadsIterable responses = client.listWorkloadsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
listWorkloadsRequest- Input to list all workloads.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkloadsPaginator
default ListWorkloadsIterable listWorkloadsPaginator(Consumer<ListWorkloadsRequest.Builder> listWorkloadsRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
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
2) Using For loopsoftware.amazon.awssdk.services.wellarchitected.paginators.ListWorkloadsIterable responses = client.listWorkloadsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListWorkloadsRequest.builder()- Parameters:
listWorkloadsRequest- AConsumerthat will call methods onListWorkloadsRequest.Builderto create a request. Input to list all workloads.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, WellArchitectedException
Adds one or more tags to the specified resource.
The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN.
- Parameters:
tagResourceRequest-- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default 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 a workload ARN, a custom lens ARN, a profile ARN, or review template ARN.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, WellArchitectedException
Deletes specified tags from a resource.
The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN.
To specify multiple tags, use separate tagKeys parameters, for example:
DELETE /tags/WorkloadArn?tagKeys=key1&tagKeys=key2- Parameters:
untagResourceRequest-- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, WellArchitectedException
Deletes specified tags from a resource.
The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN.
To specify multiple tags, use separate tagKeys parameters, for example:
DELETE /tags/WorkloadArn?tagKeys=key1&tagKeys=key2
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateAnswer
default 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.
- Parameters:
updateAnswerRequest- Input to update answer.- Returns:
- Result of the UpdateAnswer operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ResourceNotFoundException- The requested resource was not found.ConflictException- The resource has already been processed, was deleted, or is too large.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateAnswer
default 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.Builderavoiding the need to create one manually viaUpdateAnswerRequest.builder()- Parameters:
updateAnswerRequest- AConsumerthat will call methods onUpdateAnswerRequest.Builderto create a request. Input to update answer.- Returns:
- Result of the UpdateAnswer operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ResourceNotFoundException- The requested resource was not found.ConflictException- The resource has already been processed, was deleted, or is too large.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateGlobalSettings
default UpdateGlobalSettingsResponse updateGlobalSettings(UpdateGlobalSettingsRequest updateGlobalSettingsRequest) throws ValidationException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Update whether the Amazon Web Services account is opted into organization sharing and discovery integration features.
- Parameters:
updateGlobalSettingsRequest-- Returns:
- Result of the UpdateGlobalSettings operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ConflictException- The resource has already been processed, was deleted, or is too large.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateGlobalSettings
default UpdateGlobalSettingsResponse updateGlobalSettings(Consumer<UpdateGlobalSettingsRequest.Builder> updateGlobalSettingsRequest) throws ValidationException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Update whether the Amazon Web Services account is opted into organization sharing and discovery integration features.
This is a convenience which creates an instance of the
UpdateGlobalSettingsRequest.Builderavoiding the need to create one manually viaUpdateGlobalSettingsRequest.builder()- Parameters:
updateGlobalSettingsRequest- AConsumerthat will call methods onUpdateGlobalSettingsRequest.Builderto create a request.- Returns:
- Result of the UpdateGlobalSettings operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ConflictException- The resource has already been processed, was deleted, or is too large.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateIntegration
default UpdateIntegrationResponse updateIntegration(UpdateIntegrationRequest updateIntegrationRequest) throws ValidationException, ConflictException, ResourceNotFoundException, AccessDeniedException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Update integration features.
- Parameters:
updateIntegrationRequest-- Returns:
- Result of the UpdateIntegration operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ConflictException- The resource has already been processed, was deleted, or is too large.ResourceNotFoundException- The requested resource was not found.AccessDeniedException- User does not have sufficient access to perform this action.InternalServerException- There is a problem with the Well-Architected Tool API service.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateIntegration
default UpdateIntegrationResponse updateIntegration(Consumer<UpdateIntegrationRequest.Builder> updateIntegrationRequest) throws ValidationException, ConflictException, ResourceNotFoundException, AccessDeniedException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Update integration features.
This is a convenience which creates an instance of the
UpdateIntegrationRequest.Builderavoiding the need to create one manually viaUpdateIntegrationRequest.builder()- Parameters:
updateIntegrationRequest- AConsumerthat will call methods onUpdateIntegrationRequest.Builderto create a request.- Returns:
- Result of the UpdateIntegration operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ConflictException- The resource has already been processed, was deleted, or is too large.ResourceNotFoundException- The requested resource was not found.AccessDeniedException- User does not have sufficient access to perform this action.InternalServerException- There is a problem with the Well-Architected Tool API service.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateLensReview
default UpdateLensReviewResponse updateLensReview(UpdateLensReviewRequest updateLensReviewRequest) throws ValidationException, ResourceNotFoundException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Update lens review for a particular workload.
- Parameters:
updateLensReviewRequest- Input for update lens review.- Returns:
- Result of the UpdateLensReview operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ResourceNotFoundException- The requested resource was not found.ConflictException- The resource has already been processed, was deleted, or is too large.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateLensReview
default UpdateLensReviewResponse updateLensReview(Consumer<UpdateLensReviewRequest.Builder> updateLensReviewRequest) throws ValidationException, ResourceNotFoundException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Update lens review for a particular workload.
This is a convenience which creates an instance of the
UpdateLensReviewRequest.Builderavoiding the need to create one manually viaUpdateLensReviewRequest.builder()- Parameters:
updateLensReviewRequest- AConsumerthat will call methods onUpdateLensReviewRequest.Builderto create a request. Input for update lens review.- Returns:
- Result of the UpdateLensReview operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ResourceNotFoundException- The requested resource was not found.ConflictException- The resource has already been processed, was deleted, or is too large.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateProfile
default UpdateProfileResponse updateProfile(UpdateProfileRequest updateProfileRequest) throws ValidationException, ResourceNotFoundException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Update a profile.
- Parameters:
updateProfileRequest-- Returns:
- Result of the UpdateProfile operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ResourceNotFoundException- The requested resource was not found.ConflictException- The resource has already been processed, was deleted, or is too large.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateProfile
default UpdateProfileResponse updateProfile(Consumer<UpdateProfileRequest.Builder> updateProfileRequest) throws ValidationException, ResourceNotFoundException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Update a profile.
This is a convenience which creates an instance of the
UpdateProfileRequest.Builderavoiding the need to create one manually viaUpdateProfileRequest.builder()- Parameters:
updateProfileRequest- AConsumerthat will call methods onUpdateProfileRequest.Builderto create a request.- Returns:
- Result of the UpdateProfile operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ResourceNotFoundException- The requested resource was not found.ConflictException- The resource has already been processed, was deleted, or is too large.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateReviewTemplate
default UpdateReviewTemplateResponse updateReviewTemplate(UpdateReviewTemplateRequest updateReviewTemplateRequest) throws ValidationException, ResourceNotFoundException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Update a review template.
- Parameters:
updateReviewTemplateRequest-- Returns:
- Result of the UpdateReviewTemplate operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ResourceNotFoundException- The requested resource was not found.ConflictException- The resource has already been processed, was deleted, or is too large.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateReviewTemplate
default UpdateReviewTemplateResponse updateReviewTemplate(Consumer<UpdateReviewTemplateRequest.Builder> updateReviewTemplateRequest) throws ValidationException, ResourceNotFoundException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Update a review template.
This is a convenience which creates an instance of the
UpdateReviewTemplateRequest.Builderavoiding the need to create one manually viaUpdateReviewTemplateRequest.builder()- Parameters:
updateReviewTemplateRequest- AConsumerthat will call methods onUpdateReviewTemplateRequest.Builderto create a request.- Returns:
- Result of the UpdateReviewTemplate operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ResourceNotFoundException- The requested resource was not found.ConflictException- The resource has already been processed, was deleted, or is too large.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateReviewTemplateAnswer
default UpdateReviewTemplateAnswerResponse updateReviewTemplateAnswer(UpdateReviewTemplateAnswerRequest updateReviewTemplateAnswerRequest) throws ValidationException, ResourceNotFoundException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Update a review template answer.
- Parameters:
updateReviewTemplateAnswerRequest-- Returns:
- Result of the UpdateReviewTemplateAnswer operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ResourceNotFoundException- The requested resource was not found.ConflictException- The resource has already been processed, was deleted, or is too large.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateReviewTemplateAnswer
default UpdateReviewTemplateAnswerResponse updateReviewTemplateAnswer(Consumer<UpdateReviewTemplateAnswerRequest.Builder> updateReviewTemplateAnswerRequest) throws ValidationException, ResourceNotFoundException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Update a review template answer.
This is a convenience which creates an instance of the
UpdateReviewTemplateAnswerRequest.Builderavoiding the need to create one manually viaUpdateReviewTemplateAnswerRequest.builder()- Parameters:
updateReviewTemplateAnswerRequest- AConsumerthat will call methods onUpdateReviewTemplateAnswerRequest.Builderto create a request.- Returns:
- Result of the UpdateReviewTemplateAnswer operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ResourceNotFoundException- The requested resource was not found.ConflictException- The resource has already been processed, was deleted, or is too large.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateReviewTemplateLensReview
default UpdateReviewTemplateLensReviewResponse updateReviewTemplateLensReview(UpdateReviewTemplateLensReviewRequest updateReviewTemplateLensReviewRequest) throws ValidationException, ResourceNotFoundException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Update a lens review associated with a review template.
- Parameters:
updateReviewTemplateLensReviewRequest-- Returns:
- Result of the UpdateReviewTemplateLensReview operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ResourceNotFoundException- The requested resource was not found.ConflictException- The resource has already been processed, was deleted, or is too large.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateReviewTemplateLensReview
default UpdateReviewTemplateLensReviewResponse updateReviewTemplateLensReview(Consumer<UpdateReviewTemplateLensReviewRequest.Builder> updateReviewTemplateLensReviewRequest) throws ValidationException, ResourceNotFoundException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Update a lens review associated with a review template.
This is a convenience which creates an instance of the
UpdateReviewTemplateLensReviewRequest.Builderavoiding the need to create one manually viaUpdateReviewTemplateLensReviewRequest.builder()- Parameters:
updateReviewTemplateLensReviewRequest- AConsumerthat will call methods onUpdateReviewTemplateLensReviewRequest.Builderto create a request.- Returns:
- Result of the UpdateReviewTemplateLensReview operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ResourceNotFoundException- The requested resource was not found.ConflictException- The resource has already been processed, was deleted, or is too large.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateShareInvitation
default 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.
- Parameters:
updateShareInvitationRequest- Input for Update Share Invitation- Returns:
- Result of the UpdateShareInvitation operation returned by the service.
- Throws:
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 has already been processed, was deleted, or is too large.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.AwsServiceException- See Also:
- AWS API Documentation
-
updateShareInvitation
default 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.Builderavoiding the need to create one manually viaUpdateShareInvitationRequest.builder()- Parameters:
updateShareInvitationRequest- AConsumerthat will call methods onUpdateShareInvitationRequest.Builderto create a request. Input for Update Share Invitation- Returns:
- Result of the UpdateShareInvitation operation returned by the service.
- Throws:
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 has already been processed, was deleted, or is too large.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.AwsServiceException- See Also:
- AWS API Documentation
-
updateWorkload
default UpdateWorkloadResponse updateWorkload(UpdateWorkloadRequest updateWorkloadRequest) throws ValidationException, ResourceNotFoundException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Update an existing workload.
- Parameters:
updateWorkloadRequest- Input to update a workload.- Returns:
- Result of the UpdateWorkload operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ResourceNotFoundException- The requested resource was not found.ConflictException- The resource has already been processed, was deleted, or is too large.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateWorkload
default 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.Builderavoiding the need to create one manually viaUpdateWorkloadRequest.builder()- Parameters:
updateWorkloadRequest- AConsumerthat will call methods onUpdateWorkloadRequest.Builderto create a request. Input to update a workload.- Returns:
- Result of the UpdateWorkload operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ResourceNotFoundException- The requested resource was not found.ConflictException- The resource has already been processed, was deleted, or is too large.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateWorkloadShare
default UpdateWorkloadShareResponse updateWorkloadShare(UpdateWorkloadShareRequest updateWorkloadShareRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Update a workload share.
- Parameters:
updateWorkloadShareRequest- Input for Update Workload Share- Returns:
- Result of the UpdateWorkloadShare operation returned by the service.
- Throws:
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 has already been processed, was deleted, or is too large.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.AwsServiceException- See Also:
- AWS API Documentation
-
updateWorkloadShare
default 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.Builderavoiding the need to create one manually viaUpdateWorkloadShareRequest.builder()- Parameters:
updateWorkloadShareRequest- AConsumerthat will call methods onUpdateWorkloadShareRequest.Builderto create a request. Input for Update Workload Share- Returns:
- Result of the UpdateWorkloadShare operation returned by the service.
- Throws:
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 has already been processed, was deleted, or is too large.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.AwsServiceException- See Also:
- AWS API Documentation
-
upgradeLensReview
default UpgradeLensReviewResponse upgradeLensReview(UpgradeLensReviewRequest upgradeLensReviewRequest) throws ValidationException, ResourceNotFoundException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, WellArchitectedException
Upgrade lens review for a particular workload.
- Parameters:
upgradeLensReviewRequest-- Returns:
- Result of the UpgradeLensReview operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ResourceNotFoundException- The requested resource was not found.ConflictException- The resource has already been processed, was deleted, or is too large.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.ServiceQuotaExceededException- The user has reached their resource quota.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
upgradeLensReview
default UpgradeLensReviewResponse upgradeLensReview(Consumer<UpgradeLensReviewRequest.Builder> upgradeLensReviewRequest) throws ValidationException, ResourceNotFoundException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, WellArchitectedException
Upgrade lens review for a particular workload.
This is a convenience which creates an instance of the
UpgradeLensReviewRequest.Builderavoiding the need to create one manually viaUpgradeLensReviewRequest.builder()- Parameters:
upgradeLensReviewRequest- AConsumerthat will call methods onUpgradeLensReviewRequest.Builderto create a request.- Returns:
- Result of the UpgradeLensReview operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ResourceNotFoundException- The requested resource was not found.ConflictException- The resource has already been processed, was deleted, or is too large.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.ServiceQuotaExceededException- The user has reached their resource quota.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
upgradeProfileVersion
default UpgradeProfileVersionResponse upgradeProfileVersion(UpgradeProfileVersionRequest upgradeProfileVersionRequest) throws ValidationException, ResourceNotFoundException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, WellArchitectedException
Upgrade a profile.
- Parameters:
upgradeProfileVersionRequest-- Returns:
- Result of the UpgradeProfileVersion operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ResourceNotFoundException- The requested resource was not found.ConflictException- The resource has already been processed, was deleted, or is too large.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.ServiceQuotaExceededException- The user has reached their resource quota.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
upgradeProfileVersion
default UpgradeProfileVersionResponse upgradeProfileVersion(Consumer<UpgradeProfileVersionRequest.Builder> upgradeProfileVersionRequest) throws ValidationException, ResourceNotFoundException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, WellArchitectedException
Upgrade a profile.
This is a convenience which creates an instance of the
UpgradeProfileVersionRequest.Builderavoiding the need to create one manually viaUpgradeProfileVersionRequest.builder()- Parameters:
upgradeProfileVersionRequest- AConsumerthat will call methods onUpgradeProfileVersionRequest.Builderto create a request.- Returns:
- Result of the UpgradeProfileVersion operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ResourceNotFoundException- The requested resource was not found.ConflictException- The resource has already been processed, was deleted, or is too large.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.ServiceQuotaExceededException- The user has reached their resource quota.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
upgradeReviewTemplateLensReview
default UpgradeReviewTemplateLensReviewResponse upgradeReviewTemplateLensReview(UpgradeReviewTemplateLensReviewRequest upgradeReviewTemplateLensReviewRequest) throws ValidationException, ResourceNotFoundException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Upgrade the lens review of a review template.
- Parameters:
upgradeReviewTemplateLensReviewRequest-- Returns:
- Result of the UpgradeReviewTemplateLensReview operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ResourceNotFoundException- The requested resource was not found.ConflictException- The resource has already been processed, was deleted, or is too large.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
upgradeReviewTemplateLensReview
default UpgradeReviewTemplateLensReviewResponse upgradeReviewTemplateLensReview(Consumer<UpgradeReviewTemplateLensReviewRequest.Builder> upgradeReviewTemplateLensReviewRequest) throws ValidationException, ResourceNotFoundException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, WellArchitectedException
Upgrade the lens review of a review template.
This is a convenience which creates an instance of the
UpgradeReviewTemplateLensReviewRequest.Builderavoiding the need to create one manually viaUpgradeReviewTemplateLensReviewRequest.builder()- Parameters:
upgradeReviewTemplateLensReviewRequest- AConsumerthat will call methods onUpgradeReviewTemplateLensReviewRequest.Builderto create a request.- Returns:
- Result of the UpgradeReviewTemplateLensReview operation returned by the service.
- Throws:
ValidationException- The user input is not valid.ResourceNotFoundException- The requested resource was not found.ConflictException- The resource has already been processed, was deleted, or is too large.InternalServerException- There is a problem with the Well-Architected Tool API service.AccessDeniedException- User does not have sufficient access to perform this action.ThrottlingException- Request was denied due to request throttling.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WellArchitectedException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
create
static WellArchitectedClient create()
Create aWellArchitectedClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static WellArchitectedClientBuilder builder()
Create a builder that can be used to configure and create aWellArchitectedClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default WellArchitectedServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-