Interface AccessAnalyzerAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
Identity and Access Management Access Analyzer helps identify potential resource-access risks by enabling you to identify any policies that grant access to an external principal. It does this by using logic-based reasoning to analyze resource-based policies in your Amazon Web Services environment. An external principal can be another Amazon Web Services account, a root user, an IAM user or role, a federated user, an Amazon Web Services service, or an anonymous user. You can also use IAM Access Analyzer to preview and validate public and cross-account access to your resources before deploying permissions changes. This guide describes the Identity and Access Management Access Analyzer operations that you can call programmatically. For general information about IAM Access Analyzer, see Identity and Access Management Access Analyzer in the IAM User Guide.
To start using IAM Access Analyzer, you first need to create an analyzer.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionapplyArchiveRule
(Consumer<ApplyArchiveRuleRequest.Builder> applyArchiveRuleRequest) Retroactively applies the archive rule to existing findings that meet the archive rule criteria.applyArchiveRule
(ApplyArchiveRuleRequest applyArchiveRuleRequest) Retroactively applies the archive rule to existing findings that meet the archive rule criteria.builder()
Create a builder that can be used to configure and create aAccessAnalyzerAsyncClient
.cancelPolicyGeneration
(Consumer<CancelPolicyGenerationRequest.Builder> cancelPolicyGenerationRequest) Cancels the requested policy generation.cancelPolicyGeneration
(CancelPolicyGenerationRequest cancelPolicyGenerationRequest) Cancels the requested policy generation.static AccessAnalyzerAsyncClient
create()
Create aAccessAnalyzerAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createAccessPreview
(Consumer<CreateAccessPreviewRequest.Builder> createAccessPreviewRequest) Creates an access preview that allows you to preview IAM Access Analyzer findings for your resource before deploying resource permissions.createAccessPreview
(CreateAccessPreviewRequest createAccessPreviewRequest) Creates an access preview that allows you to preview IAM Access Analyzer findings for your resource before deploying resource permissions.default CompletableFuture
<CreateAnalyzerResponse> createAnalyzer
(Consumer<CreateAnalyzerRequest.Builder> createAnalyzerRequest) Creates an analyzer for your account.default CompletableFuture
<CreateAnalyzerResponse> createAnalyzer
(CreateAnalyzerRequest createAnalyzerRequest) Creates an analyzer for your account.createArchiveRule
(Consumer<CreateArchiveRuleRequest.Builder> createArchiveRuleRequest) Creates an archive rule for the specified analyzer.createArchiveRule
(CreateArchiveRuleRequest createArchiveRuleRequest) Creates an archive rule for the specified analyzer.default CompletableFuture
<DeleteAnalyzerResponse> deleteAnalyzer
(Consumer<DeleteAnalyzerRequest.Builder> deleteAnalyzerRequest) Deletes the specified analyzer.default CompletableFuture
<DeleteAnalyzerResponse> deleteAnalyzer
(DeleteAnalyzerRequest deleteAnalyzerRequest) Deletes the specified analyzer.deleteArchiveRule
(Consumer<DeleteArchiveRuleRequest.Builder> deleteArchiveRuleRequest) Deletes the specified archive rule.deleteArchiveRule
(DeleteArchiveRuleRequest deleteArchiveRuleRequest) Deletes the specified archive rule.getAccessPreview
(Consumer<GetAccessPreviewRequest.Builder> getAccessPreviewRequest) Retrieves information about an access preview for the specified analyzer.getAccessPreview
(GetAccessPreviewRequest getAccessPreviewRequest) Retrieves information about an access preview for the specified analyzer.getAnalyzedResource
(Consumer<GetAnalyzedResourceRequest.Builder> getAnalyzedResourceRequest) Retrieves information about a resource that was analyzed.getAnalyzedResource
(GetAnalyzedResourceRequest getAnalyzedResourceRequest) Retrieves information about a resource that was analyzed.default CompletableFuture
<GetAnalyzerResponse> getAnalyzer
(Consumer<GetAnalyzerRequest.Builder> getAnalyzerRequest) Retrieves information about the specified analyzer.default CompletableFuture
<GetAnalyzerResponse> getAnalyzer
(GetAnalyzerRequest getAnalyzerRequest) Retrieves information about the specified analyzer.default CompletableFuture
<GetArchiveRuleResponse> getArchiveRule
(Consumer<GetArchiveRuleRequest.Builder> getArchiveRuleRequest) Retrieves information about an archive rule.default CompletableFuture
<GetArchiveRuleResponse> getArchiveRule
(GetArchiveRuleRequest getArchiveRuleRequest) Retrieves information about an archive rule.default CompletableFuture
<GetFindingResponse> getFinding
(Consumer<GetFindingRequest.Builder> getFindingRequest) Retrieves information about the specified finding.default CompletableFuture
<GetFindingResponse> getFinding
(GetFindingRequest getFindingRequest) Retrieves information about the specified finding.getGeneratedPolicy
(Consumer<GetGeneratedPolicyRequest.Builder> getGeneratedPolicyRequest) Retrieves the policy that was generated usingStartPolicyGeneration
.getGeneratedPolicy
(GetGeneratedPolicyRequest getGeneratedPolicyRequest) Retrieves the policy that was generated usingStartPolicyGeneration
.listAccessPreviewFindings
(Consumer<ListAccessPreviewFindingsRequest.Builder> listAccessPreviewFindingsRequest) Retrieves a list of access preview findings generated by the specified access preview.listAccessPreviewFindings
(ListAccessPreviewFindingsRequest listAccessPreviewFindingsRequest) Retrieves a list of access preview findings generated by the specified access preview.listAccessPreviewFindingsPaginator
(Consumer<ListAccessPreviewFindingsRequest.Builder> listAccessPreviewFindingsRequest) Retrieves a list of access preview findings generated by the specified access preview.listAccessPreviewFindingsPaginator
(ListAccessPreviewFindingsRequest listAccessPreviewFindingsRequest) Retrieves a list of access preview findings generated by the specified access preview.listAccessPreviews
(Consumer<ListAccessPreviewsRequest.Builder> listAccessPreviewsRequest) Retrieves a list of access previews for the specified analyzer.listAccessPreviews
(ListAccessPreviewsRequest listAccessPreviewsRequest) Retrieves a list of access previews for the specified analyzer.default ListAccessPreviewsPublisher
listAccessPreviewsPaginator
(Consumer<ListAccessPreviewsRequest.Builder> listAccessPreviewsRequest) Retrieves a list of access previews for the specified analyzer.default ListAccessPreviewsPublisher
listAccessPreviewsPaginator
(ListAccessPreviewsRequest listAccessPreviewsRequest) Retrieves a list of access previews for the specified analyzer.listAnalyzedResources
(Consumer<ListAnalyzedResourcesRequest.Builder> listAnalyzedResourcesRequest) Retrieves a list of resources of the specified type that have been analyzed by the specified analyzer..listAnalyzedResources
(ListAnalyzedResourcesRequest listAnalyzedResourcesRequest) Retrieves a list of resources of the specified type that have been analyzed by the specified analyzer..default ListAnalyzedResourcesPublisher
listAnalyzedResourcesPaginator
(Consumer<ListAnalyzedResourcesRequest.Builder> listAnalyzedResourcesRequest) Retrieves a list of resources of the specified type that have been analyzed by the specified analyzer..default ListAnalyzedResourcesPublisher
listAnalyzedResourcesPaginator
(ListAnalyzedResourcesRequest listAnalyzedResourcesRequest) Retrieves a list of resources of the specified type that have been analyzed by the specified analyzer..default CompletableFuture
<ListAnalyzersResponse> listAnalyzers
(Consumer<ListAnalyzersRequest.Builder> listAnalyzersRequest) Retrieves a list of analyzers.default CompletableFuture
<ListAnalyzersResponse> listAnalyzers
(ListAnalyzersRequest listAnalyzersRequest) Retrieves a list of analyzers.default ListAnalyzersPublisher
listAnalyzersPaginator
(Consumer<ListAnalyzersRequest.Builder> listAnalyzersRequest) Retrieves a list of analyzers.default ListAnalyzersPublisher
listAnalyzersPaginator
(ListAnalyzersRequest listAnalyzersRequest) Retrieves a list of analyzers.listArchiveRules
(Consumer<ListArchiveRulesRequest.Builder> listArchiveRulesRequest) Retrieves a list of archive rules created for the specified analyzer.listArchiveRules
(ListArchiveRulesRequest listArchiveRulesRequest) Retrieves a list of archive rules created for the specified analyzer.default ListArchiveRulesPublisher
listArchiveRulesPaginator
(Consumer<ListArchiveRulesRequest.Builder> listArchiveRulesRequest) Retrieves a list of archive rules created for the specified analyzer.default ListArchiveRulesPublisher
listArchiveRulesPaginator
(ListArchiveRulesRequest listArchiveRulesRequest) Retrieves a list of archive rules created for the specified analyzer.default CompletableFuture
<ListFindingsResponse> listFindings
(Consumer<ListFindingsRequest.Builder> listFindingsRequest) Retrieves a list of findings generated by the specified analyzer.default CompletableFuture
<ListFindingsResponse> listFindings
(ListFindingsRequest listFindingsRequest) Retrieves a list of findings generated by the specified analyzer.default ListFindingsPublisher
listFindingsPaginator
(Consumer<ListFindingsRequest.Builder> listFindingsRequest) Retrieves a list of findings generated by the specified analyzer.default ListFindingsPublisher
listFindingsPaginator
(ListFindingsRequest listFindingsRequest) Retrieves a list of findings generated by the specified analyzer.listPolicyGenerations
(Consumer<ListPolicyGenerationsRequest.Builder> listPolicyGenerationsRequest) Lists all of the policy generations requested in the last seven days.listPolicyGenerations
(ListPolicyGenerationsRequest listPolicyGenerationsRequest) Lists all of the policy generations requested in the last seven days.default ListPolicyGenerationsPublisher
listPolicyGenerationsPaginator
(Consumer<ListPolicyGenerationsRequest.Builder> listPolicyGenerationsRequest) Lists all of the policy generations requested in the last seven days.default ListPolicyGenerationsPublisher
listPolicyGenerationsPaginator
(ListPolicyGenerationsRequest listPolicyGenerationsRequest) Lists all of the policy generations requested in the last seven days.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Retrieves a list of tags applied to the specified resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Retrieves a list of tags applied to the specified resource.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstartPolicyGeneration
(Consumer<StartPolicyGenerationRequest.Builder> startPolicyGenerationRequest) Starts the policy generation request.startPolicyGeneration
(StartPolicyGenerationRequest startPolicyGenerationRequest) Starts the policy generation request.startResourceScan
(Consumer<StartResourceScanRequest.Builder> startResourceScanRequest) Immediately starts a scan of the policies applied to the specified resource.startResourceScan
(StartResourceScanRequest startResourceScanRequest) Immediately starts a scan of the policies applied to the specified resource.default CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds a tag to the specified resource.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Adds a tag to the specified resource.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes a tag from the specified resource.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Removes a tag from the specified resource.updateArchiveRule
(Consumer<UpdateArchiveRuleRequest.Builder> updateArchiveRuleRequest) Updates the criteria and values for the specified archive rule.updateArchiveRule
(UpdateArchiveRuleRequest updateArchiveRuleRequest) Updates the criteria and values for the specified archive rule.default CompletableFuture
<UpdateFindingsResponse> updateFindings
(Consumer<UpdateFindingsRequest.Builder> updateFindingsRequest) Updates the status for the specified findings.default CompletableFuture
<UpdateFindingsResponse> updateFindings
(UpdateFindingsRequest updateFindingsRequest) Updates the status for the specified findings.default CompletableFuture
<ValidatePolicyResponse> validatePolicy
(Consumer<ValidatePolicyRequest.Builder> validatePolicyRequest) Requests the validation of a policy and returns a list of findings.default CompletableFuture
<ValidatePolicyResponse> validatePolicy
(ValidatePolicyRequest validatePolicyRequest) Requests the validation of a policy and returns a list of findings.default ValidatePolicyPublisher
validatePolicyPaginator
(Consumer<ValidatePolicyRequest.Builder> validatePolicyRequest) Requests the validation of a policy and returns a list of findings.default ValidatePolicyPublisher
validatePolicyPaginator
(ValidatePolicyRequest validatePolicyRequest) Requests the validation of a policy and returns a list of findings.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
applyArchiveRule
default CompletableFuture<ApplyArchiveRuleResponse> applyArchiveRule(ApplyArchiveRuleRequest applyArchiveRuleRequest) Retroactively applies the archive rule to existing findings that meet the archive rule criteria.
- Parameters:
applyArchiveRuleRequest
- Retroactively applies an archive rule.- Returns:
- A Java Future containing the result of the ApplyArchiveRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource could not be found.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
applyArchiveRule
default CompletableFuture<ApplyArchiveRuleResponse> applyArchiveRule(Consumer<ApplyArchiveRuleRequest.Builder> applyArchiveRuleRequest) Retroactively applies the archive rule to existing findings that meet the archive rule criteria.
This is a convenience which creates an instance of the
ApplyArchiveRuleRequest.Builder
avoiding the need to create one manually viaApplyArchiveRuleRequest.builder()
- Parameters:
applyArchiveRuleRequest
- AConsumer
that will call methods onApplyArchiveRuleRequest.Builder
to create a request. Retroactively applies an archive rule.- Returns:
- A Java Future containing the result of the ApplyArchiveRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource could not be found.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
cancelPolicyGeneration
default CompletableFuture<CancelPolicyGenerationResponse> cancelPolicyGeneration(CancelPolicyGenerationRequest cancelPolicyGenerationRequest) Cancels the requested policy generation.
- Parameters:
cancelPolicyGenerationRequest
-- Returns:
- A Java Future containing the result of the CancelPolicyGeneration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
cancelPolicyGeneration
default CompletableFuture<CancelPolicyGenerationResponse> cancelPolicyGeneration(Consumer<CancelPolicyGenerationRequest.Builder> cancelPolicyGenerationRequest) Cancels the requested policy generation.
This is a convenience which creates an instance of the
CancelPolicyGenerationRequest.Builder
avoiding the need to create one manually viaCancelPolicyGenerationRequest.builder()
- Parameters:
cancelPolicyGenerationRequest
- AConsumer
that will call methods onCancelPolicyGenerationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CancelPolicyGeneration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAccessPreview
default CompletableFuture<CreateAccessPreviewResponse> createAccessPreview(CreateAccessPreviewRequest createAccessPreviewRequest) Creates an access preview that allows you to preview IAM Access Analyzer findings for your resource before deploying resource permissions.
- Parameters:
createAccessPreviewRequest
-- Returns:
- A Java Future containing the result of the CreateAccessPreview operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource could not be found.
- ConflictException A conflict exception error.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ServiceQuotaExceededException Service quote met error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAccessPreview
default CompletableFuture<CreateAccessPreviewResponse> createAccessPreview(Consumer<CreateAccessPreviewRequest.Builder> createAccessPreviewRequest) Creates an access preview that allows you to preview IAM Access Analyzer findings for your resource before deploying resource permissions.
This is a convenience which creates an instance of the
CreateAccessPreviewRequest.Builder
avoiding the need to create one manually viaCreateAccessPreviewRequest.builder()
- Parameters:
createAccessPreviewRequest
- AConsumer
that will call methods onCreateAccessPreviewRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateAccessPreview operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource could not be found.
- ConflictException A conflict exception error.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ServiceQuotaExceededException Service quote met error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAnalyzer
default CompletableFuture<CreateAnalyzerResponse> createAnalyzer(CreateAnalyzerRequest createAnalyzerRequest) Creates an analyzer for your account.
- Parameters:
createAnalyzerRequest
- Creates an analyzer.- Returns:
- A Java Future containing the result of the CreateAnalyzer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConflictException A conflict exception error.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ServiceQuotaExceededException Service quote met error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAnalyzer
default CompletableFuture<CreateAnalyzerResponse> createAnalyzer(Consumer<CreateAnalyzerRequest.Builder> createAnalyzerRequest) Creates an analyzer for your account.
This is a convenience which creates an instance of the
CreateAnalyzerRequest.Builder
avoiding the need to create one manually viaCreateAnalyzerRequest.builder()
- Parameters:
createAnalyzerRequest
- AConsumer
that will call methods onCreateAnalyzerRequest.Builder
to create a request. Creates an analyzer.- Returns:
- A Java Future containing the result of the CreateAnalyzer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConflictException A conflict exception error.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ServiceQuotaExceededException Service quote met error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createArchiveRule
default CompletableFuture<CreateArchiveRuleResponse> createArchiveRule(CreateArchiveRuleRequest createArchiveRuleRequest) Creates an archive rule for the specified analyzer. Archive rules automatically archive new findings that meet the criteria you define when you create the rule.
To learn about filter keys that you can use to create an archive rule, see IAM Access Analyzer filter keys in the IAM User Guide.
- Parameters:
createArchiveRuleRequest
- Creates an archive rule.- Returns:
- A Java Future containing the result of the CreateArchiveRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource could not be found.
- ConflictException A conflict exception error.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ServiceQuotaExceededException Service quote met error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createArchiveRule
default CompletableFuture<CreateArchiveRuleResponse> createArchiveRule(Consumer<CreateArchiveRuleRequest.Builder> createArchiveRuleRequest) Creates an archive rule for the specified analyzer. Archive rules automatically archive new findings that meet the criteria you define when you create the rule.
To learn about filter keys that you can use to create an archive rule, see IAM Access Analyzer filter keys in the IAM User Guide.
This is a convenience which creates an instance of the
CreateArchiveRuleRequest.Builder
avoiding the need to create one manually viaCreateArchiveRuleRequest.builder()
- Parameters:
createArchiveRuleRequest
- AConsumer
that will call methods onCreateArchiveRuleRequest.Builder
to create a request. Creates an archive rule.- Returns:
- A Java Future containing the result of the CreateArchiveRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource could not be found.
- ConflictException A conflict exception error.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ServiceQuotaExceededException Service quote met error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAnalyzer
default CompletableFuture<DeleteAnalyzerResponse> deleteAnalyzer(DeleteAnalyzerRequest deleteAnalyzerRequest) Deletes the specified analyzer. When you delete an analyzer, IAM Access Analyzer is disabled for the account or organization in the current or specific Region. All findings that were generated by the analyzer are deleted. You cannot undo this action.
- Parameters:
deleteAnalyzerRequest
- Deletes an analyzer.- Returns:
- A Java Future containing the result of the DeleteAnalyzer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource could not be found.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAnalyzer
default CompletableFuture<DeleteAnalyzerResponse> deleteAnalyzer(Consumer<DeleteAnalyzerRequest.Builder> deleteAnalyzerRequest) Deletes the specified analyzer. When you delete an analyzer, IAM Access Analyzer is disabled for the account or organization in the current or specific Region. All findings that were generated by the analyzer are deleted. You cannot undo this action.
This is a convenience which creates an instance of the
DeleteAnalyzerRequest.Builder
avoiding the need to create one manually viaDeleteAnalyzerRequest.builder()
- Parameters:
deleteAnalyzerRequest
- AConsumer
that will call methods onDeleteAnalyzerRequest.Builder
to create a request. Deletes an analyzer.- Returns:
- A Java Future containing the result of the DeleteAnalyzer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource could not be found.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteArchiveRule
default CompletableFuture<DeleteArchiveRuleResponse> deleteArchiveRule(DeleteArchiveRuleRequest deleteArchiveRuleRequest) Deletes the specified archive rule.
- Parameters:
deleteArchiveRuleRequest
- Deletes an archive rule.- Returns:
- A Java Future containing the result of the DeleteArchiveRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource could not be found.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteArchiveRule
default CompletableFuture<DeleteArchiveRuleResponse> deleteArchiveRule(Consumer<DeleteArchiveRuleRequest.Builder> deleteArchiveRuleRequest) Deletes the specified archive rule.
This is a convenience which creates an instance of the
DeleteArchiveRuleRequest.Builder
avoiding the need to create one manually viaDeleteArchiveRuleRequest.builder()
- Parameters:
deleteArchiveRuleRequest
- AConsumer
that will call methods onDeleteArchiveRuleRequest.Builder
to create a request. Deletes an archive rule.- Returns:
- A Java Future containing the result of the DeleteArchiveRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource could not be found.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAccessPreview
default CompletableFuture<GetAccessPreviewResponse> getAccessPreview(GetAccessPreviewRequest getAccessPreviewRequest) Retrieves information about an access preview for the specified analyzer.
- Parameters:
getAccessPreviewRequest
-- Returns:
- A Java Future containing the result of the GetAccessPreview operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource could not be found.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAccessPreview
default CompletableFuture<GetAccessPreviewResponse> getAccessPreview(Consumer<GetAccessPreviewRequest.Builder> getAccessPreviewRequest) Retrieves information about an access preview for the specified analyzer.
This is a convenience which creates an instance of the
GetAccessPreviewRequest.Builder
avoiding the need to create one manually viaGetAccessPreviewRequest.builder()
- Parameters:
getAccessPreviewRequest
- AConsumer
that will call methods onGetAccessPreviewRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetAccessPreview operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource could not be found.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAnalyzedResource
default CompletableFuture<GetAnalyzedResourceResponse> getAnalyzedResource(GetAnalyzedResourceRequest getAnalyzedResourceRequest) Retrieves information about a resource that was analyzed.
- Parameters:
getAnalyzedResourceRequest
- Retrieves an analyzed resource.- Returns:
- A Java Future containing the result of the GetAnalyzedResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource could not be found.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAnalyzedResource
default CompletableFuture<GetAnalyzedResourceResponse> getAnalyzedResource(Consumer<GetAnalyzedResourceRequest.Builder> getAnalyzedResourceRequest) Retrieves information about a resource that was analyzed.
This is a convenience which creates an instance of the
GetAnalyzedResourceRequest.Builder
avoiding the need to create one manually viaGetAnalyzedResourceRequest.builder()
- Parameters:
getAnalyzedResourceRequest
- AConsumer
that will call methods onGetAnalyzedResourceRequest.Builder
to create a request. Retrieves an analyzed resource.- Returns:
- A Java Future containing the result of the GetAnalyzedResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource could not be found.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAnalyzer
Retrieves information about the specified analyzer.
- Parameters:
getAnalyzerRequest
- Retrieves an analyzer.- Returns:
- A Java Future containing the result of the GetAnalyzer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource could not be found.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAnalyzer
default CompletableFuture<GetAnalyzerResponse> getAnalyzer(Consumer<GetAnalyzerRequest.Builder> getAnalyzerRequest) Retrieves information about the specified analyzer.
This is a convenience which creates an instance of the
GetAnalyzerRequest.Builder
avoiding the need to create one manually viaGetAnalyzerRequest.builder()
- Parameters:
getAnalyzerRequest
- AConsumer
that will call methods onGetAnalyzerRequest.Builder
to create a request. Retrieves an analyzer.- Returns:
- A Java Future containing the result of the GetAnalyzer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource could not be found.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getArchiveRule
default CompletableFuture<GetArchiveRuleResponse> getArchiveRule(GetArchiveRuleRequest getArchiveRuleRequest) Retrieves information about an archive rule.
To learn about filter keys that you can use to create an archive rule, see IAM Access Analyzer filter keys in the IAM User Guide.
- Parameters:
getArchiveRuleRequest
- Retrieves an archive rule.- Returns:
- A Java Future containing the result of the GetArchiveRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource could not be found.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getArchiveRule
default CompletableFuture<GetArchiveRuleResponse> getArchiveRule(Consumer<GetArchiveRuleRequest.Builder> getArchiveRuleRequest) Retrieves information about an archive rule.
To learn about filter keys that you can use to create an archive rule, see IAM Access Analyzer filter keys in the IAM User Guide.
This is a convenience which creates an instance of the
GetArchiveRuleRequest.Builder
avoiding the need to create one manually viaGetArchiveRuleRequest.builder()
- Parameters:
getArchiveRuleRequest
- AConsumer
that will call methods onGetArchiveRuleRequest.Builder
to create a request. Retrieves an archive rule.- Returns:
- A Java Future containing the result of the GetArchiveRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource could not be found.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getFinding
Retrieves information about the specified finding.
- Parameters:
getFindingRequest
- Retrieves a finding.- Returns:
- A Java Future containing the result of the GetFinding operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource could not be found.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getFinding
default CompletableFuture<GetFindingResponse> getFinding(Consumer<GetFindingRequest.Builder> getFindingRequest) Retrieves information about the specified finding.
This is a convenience which creates an instance of the
GetFindingRequest.Builder
avoiding the need to create one manually viaGetFindingRequest.builder()
- Parameters:
getFindingRequest
- AConsumer
that will call methods onGetFindingRequest.Builder
to create a request. Retrieves a finding.- Returns:
- A Java Future containing the result of the GetFinding operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource could not be found.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getGeneratedPolicy
default CompletableFuture<GetGeneratedPolicyResponse> getGeneratedPolicy(GetGeneratedPolicyRequest getGeneratedPolicyRequest) Retrieves the policy that was generated using
StartPolicyGeneration
.- Parameters:
getGeneratedPolicyRequest
-- Returns:
- A Java Future containing the result of the GetGeneratedPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getGeneratedPolicy
default CompletableFuture<GetGeneratedPolicyResponse> getGeneratedPolicy(Consumer<GetGeneratedPolicyRequest.Builder> getGeneratedPolicyRequest) Retrieves the policy that was generated using
StartPolicyGeneration
.
This is a convenience which creates an instance of the
GetGeneratedPolicyRequest.Builder
avoiding the need to create one manually viaGetGeneratedPolicyRequest.builder()
- Parameters:
getGeneratedPolicyRequest
- AConsumer
that will call methods onGetGeneratedPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetGeneratedPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAccessPreviewFindings
default CompletableFuture<ListAccessPreviewFindingsResponse> listAccessPreviewFindings(ListAccessPreviewFindingsRequest listAccessPreviewFindingsRequest) Retrieves a list of access preview findings generated by the specified access preview.
- Parameters:
listAccessPreviewFindingsRequest
-- Returns:
- A Java Future containing the result of the ListAccessPreviewFindings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource could not be found.
- ConflictException A conflict exception error.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAccessPreviewFindings
default CompletableFuture<ListAccessPreviewFindingsResponse> listAccessPreviewFindings(Consumer<ListAccessPreviewFindingsRequest.Builder> listAccessPreviewFindingsRequest) Retrieves a list of access preview findings generated by the specified access preview.
This is a convenience which creates an instance of the
ListAccessPreviewFindingsRequest.Builder
avoiding the need to create one manually viaListAccessPreviewFindingsRequest.builder()
- Parameters:
listAccessPreviewFindingsRequest
- AConsumer
that will call methods onListAccessPreviewFindingsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAccessPreviewFindings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource could not be found.
- ConflictException A conflict exception error.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAccessPreviewFindingsPaginator
default ListAccessPreviewFindingsPublisher listAccessPreviewFindingsPaginator(ListAccessPreviewFindingsRequest listAccessPreviewFindingsRequest) Retrieves a list of access preview findings generated by the specified access preview.
This is a variant of
listAccessPreviewFindings(software.amazon.awssdk.services.accessanalyzer.model.ListAccessPreviewFindingsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.accessanalyzer.paginators.ListAccessPreviewFindingsPublisher publisher = client.listAccessPreviewFindingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.accessanalyzer.paginators.ListAccessPreviewFindingsPublisher publisher = client.listAccessPreviewFindingsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.accessanalyzer.model.ListAccessPreviewFindingsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.accessanalyzer.model.ListAccessPreviewFindingsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAccessPreviewFindings(software.amazon.awssdk.services.accessanalyzer.model.ListAccessPreviewFindingsRequest)
operation.- Parameters:
listAccessPreviewFindingsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource could not be found.
- ConflictException A conflict exception error.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAccessPreviewFindingsPaginator
default ListAccessPreviewFindingsPublisher listAccessPreviewFindingsPaginator(Consumer<ListAccessPreviewFindingsRequest.Builder> listAccessPreviewFindingsRequest) Retrieves a list of access preview findings generated by the specified access preview.
This is a variant of
listAccessPreviewFindings(software.amazon.awssdk.services.accessanalyzer.model.ListAccessPreviewFindingsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.accessanalyzer.paginators.ListAccessPreviewFindingsPublisher publisher = client.listAccessPreviewFindingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.accessanalyzer.paginators.ListAccessPreviewFindingsPublisher publisher = client.listAccessPreviewFindingsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.accessanalyzer.model.ListAccessPreviewFindingsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.accessanalyzer.model.ListAccessPreviewFindingsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAccessPreviewFindings(software.amazon.awssdk.services.accessanalyzer.model.ListAccessPreviewFindingsRequest)
operation.This is a convenience which creates an instance of the
ListAccessPreviewFindingsRequest.Builder
avoiding the need to create one manually viaListAccessPreviewFindingsRequest.builder()
- Parameters:
listAccessPreviewFindingsRequest
- AConsumer
that will call methods onListAccessPreviewFindingsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource could not be found.
- ConflictException A conflict exception error.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAccessPreviews
default CompletableFuture<ListAccessPreviewsResponse> listAccessPreviews(ListAccessPreviewsRequest listAccessPreviewsRequest) Retrieves a list of access previews for the specified analyzer.
- Parameters:
listAccessPreviewsRequest
-- Returns:
- A Java Future containing the result of the ListAccessPreviews operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource could not be found.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAccessPreviews
default CompletableFuture<ListAccessPreviewsResponse> listAccessPreviews(Consumer<ListAccessPreviewsRequest.Builder> listAccessPreviewsRequest) Retrieves a list of access previews for the specified analyzer.
This is a convenience which creates an instance of the
ListAccessPreviewsRequest.Builder
avoiding the need to create one manually viaListAccessPreviewsRequest.builder()
- Parameters:
listAccessPreviewsRequest
- AConsumer
that will call methods onListAccessPreviewsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAccessPreviews operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource could not be found.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAccessPreviewsPaginator
default ListAccessPreviewsPublisher listAccessPreviewsPaginator(ListAccessPreviewsRequest listAccessPreviewsRequest) Retrieves a list of access previews for the specified analyzer.
This is a variant of
listAccessPreviews(software.amazon.awssdk.services.accessanalyzer.model.ListAccessPreviewsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.accessanalyzer.paginators.ListAccessPreviewsPublisher publisher = client.listAccessPreviewsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.accessanalyzer.paginators.ListAccessPreviewsPublisher publisher = client.listAccessPreviewsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.accessanalyzer.model.ListAccessPreviewsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.accessanalyzer.model.ListAccessPreviewsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAccessPreviews(software.amazon.awssdk.services.accessanalyzer.model.ListAccessPreviewsRequest)
operation.- Parameters:
listAccessPreviewsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource could not be found.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAccessPreviewsPaginator
default ListAccessPreviewsPublisher listAccessPreviewsPaginator(Consumer<ListAccessPreviewsRequest.Builder> listAccessPreviewsRequest) Retrieves a list of access previews for the specified analyzer.
This is a variant of
listAccessPreviews(software.amazon.awssdk.services.accessanalyzer.model.ListAccessPreviewsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.accessanalyzer.paginators.ListAccessPreviewsPublisher publisher = client.listAccessPreviewsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.accessanalyzer.paginators.ListAccessPreviewsPublisher publisher = client.listAccessPreviewsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.accessanalyzer.model.ListAccessPreviewsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.accessanalyzer.model.ListAccessPreviewsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAccessPreviews(software.amazon.awssdk.services.accessanalyzer.model.ListAccessPreviewsRequest)
operation.This is a convenience which creates an instance of the
ListAccessPreviewsRequest.Builder
avoiding the need to create one manually viaListAccessPreviewsRequest.builder()
- Parameters:
listAccessPreviewsRequest
- AConsumer
that will call methods onListAccessPreviewsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource could not be found.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAnalyzedResources
default CompletableFuture<ListAnalyzedResourcesResponse> listAnalyzedResources(ListAnalyzedResourcesRequest listAnalyzedResourcesRequest) Retrieves a list of resources of the specified type that have been analyzed by the specified analyzer..
- Parameters:
listAnalyzedResourcesRequest
- Retrieves a list of resources that have been analyzed.- Returns:
- A Java Future containing the result of the ListAnalyzedResources operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource could not be found.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAnalyzedResources
default CompletableFuture<ListAnalyzedResourcesResponse> listAnalyzedResources(Consumer<ListAnalyzedResourcesRequest.Builder> listAnalyzedResourcesRequest) Retrieves a list of resources of the specified type that have been analyzed by the specified analyzer..
This is a convenience which creates an instance of the
ListAnalyzedResourcesRequest.Builder
avoiding the need to create one manually viaListAnalyzedResourcesRequest.builder()
- Parameters:
listAnalyzedResourcesRequest
- AConsumer
that will call methods onListAnalyzedResourcesRequest.Builder
to create a request. Retrieves a list of resources that have been analyzed.- Returns:
- A Java Future containing the result of the ListAnalyzedResources operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource could not be found.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAnalyzedResourcesPaginator
default ListAnalyzedResourcesPublisher listAnalyzedResourcesPaginator(ListAnalyzedResourcesRequest listAnalyzedResourcesRequest) Retrieves a list of resources of the specified type that have been analyzed by the specified analyzer..
This is a variant of
listAnalyzedResources(software.amazon.awssdk.services.accessanalyzer.model.ListAnalyzedResourcesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.accessanalyzer.paginators.ListAnalyzedResourcesPublisher publisher = client.listAnalyzedResourcesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.accessanalyzer.paginators.ListAnalyzedResourcesPublisher publisher = client.listAnalyzedResourcesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.accessanalyzer.model.ListAnalyzedResourcesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.accessanalyzer.model.ListAnalyzedResourcesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAnalyzedResources(software.amazon.awssdk.services.accessanalyzer.model.ListAnalyzedResourcesRequest)
operation.- Parameters:
listAnalyzedResourcesRequest
- Retrieves a list of resources that have been analyzed.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource could not be found.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAnalyzedResourcesPaginator
default ListAnalyzedResourcesPublisher listAnalyzedResourcesPaginator(Consumer<ListAnalyzedResourcesRequest.Builder> listAnalyzedResourcesRequest) Retrieves a list of resources of the specified type that have been analyzed by the specified analyzer..
This is a variant of
listAnalyzedResources(software.amazon.awssdk.services.accessanalyzer.model.ListAnalyzedResourcesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.accessanalyzer.paginators.ListAnalyzedResourcesPublisher publisher = client.listAnalyzedResourcesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.accessanalyzer.paginators.ListAnalyzedResourcesPublisher publisher = client.listAnalyzedResourcesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.accessanalyzer.model.ListAnalyzedResourcesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.accessanalyzer.model.ListAnalyzedResourcesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAnalyzedResources(software.amazon.awssdk.services.accessanalyzer.model.ListAnalyzedResourcesRequest)
operation.This is a convenience which creates an instance of the
ListAnalyzedResourcesRequest.Builder
avoiding the need to create one manually viaListAnalyzedResourcesRequest.builder()
- Parameters:
listAnalyzedResourcesRequest
- AConsumer
that will call methods onListAnalyzedResourcesRequest.Builder
to create a request. Retrieves a list of resources that have been analyzed.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource could not be found.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAnalyzers
default CompletableFuture<ListAnalyzersResponse> listAnalyzers(ListAnalyzersRequest listAnalyzersRequest) Retrieves a list of analyzers.
- Parameters:
listAnalyzersRequest
- Retrieves a list of analyzers.- Returns:
- A Java Future containing the result of the ListAnalyzers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAnalyzers
default CompletableFuture<ListAnalyzersResponse> listAnalyzers(Consumer<ListAnalyzersRequest.Builder> listAnalyzersRequest) Retrieves a list of analyzers.
This is a convenience which creates an instance of the
ListAnalyzersRequest.Builder
avoiding the need to create one manually viaListAnalyzersRequest.builder()
- Parameters:
listAnalyzersRequest
- AConsumer
that will call methods onListAnalyzersRequest.Builder
to create a request. Retrieves a list of analyzers.- Returns:
- A Java Future containing the result of the ListAnalyzers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAnalyzersPaginator
Retrieves a list of analyzers.
This is a variant of
listAnalyzers(software.amazon.awssdk.services.accessanalyzer.model.ListAnalyzersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.accessanalyzer.paginators.ListAnalyzersPublisher publisher = client.listAnalyzersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.accessanalyzer.paginators.ListAnalyzersPublisher publisher = client.listAnalyzersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.accessanalyzer.model.ListAnalyzersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.accessanalyzer.model.ListAnalyzersResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAnalyzers(software.amazon.awssdk.services.accessanalyzer.model.ListAnalyzersRequest)
operation.- Parameters:
listAnalyzersRequest
- Retrieves a list of analyzers.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAnalyzersPaginator
default ListAnalyzersPublisher listAnalyzersPaginator(Consumer<ListAnalyzersRequest.Builder> listAnalyzersRequest) Retrieves a list of analyzers.
This is a variant of
listAnalyzers(software.amazon.awssdk.services.accessanalyzer.model.ListAnalyzersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.accessanalyzer.paginators.ListAnalyzersPublisher publisher = client.listAnalyzersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.accessanalyzer.paginators.ListAnalyzersPublisher publisher = client.listAnalyzersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.accessanalyzer.model.ListAnalyzersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.accessanalyzer.model.ListAnalyzersResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAnalyzers(software.amazon.awssdk.services.accessanalyzer.model.ListAnalyzersRequest)
operation.This is a convenience which creates an instance of the
ListAnalyzersRequest.Builder
avoiding the need to create one manually viaListAnalyzersRequest.builder()
- Parameters:
listAnalyzersRequest
- AConsumer
that will call methods onListAnalyzersRequest.Builder
to create a request. Retrieves a list of analyzers.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listArchiveRules
default CompletableFuture<ListArchiveRulesResponse> listArchiveRules(ListArchiveRulesRequest listArchiveRulesRequest) Retrieves a list of archive rules created for the specified analyzer.
- Parameters:
listArchiveRulesRequest
- Retrieves a list of archive rules created for the specified analyzer.- Returns:
- A Java Future containing the result of the ListArchiveRules operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listArchiveRules
default CompletableFuture<ListArchiveRulesResponse> listArchiveRules(Consumer<ListArchiveRulesRequest.Builder> listArchiveRulesRequest) Retrieves a list of archive rules created for the specified analyzer.
This is a convenience which creates an instance of the
ListArchiveRulesRequest.Builder
avoiding the need to create one manually viaListArchiveRulesRequest.builder()
- Parameters:
listArchiveRulesRequest
- AConsumer
that will call methods onListArchiveRulesRequest.Builder
to create a request. Retrieves a list of archive rules created for the specified analyzer.- Returns:
- A Java Future containing the result of the ListArchiveRules operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listArchiveRulesPaginator
default ListArchiveRulesPublisher listArchiveRulesPaginator(ListArchiveRulesRequest listArchiveRulesRequest) Retrieves a list of archive rules created for the specified analyzer.
This is a variant of
listArchiveRules(software.amazon.awssdk.services.accessanalyzer.model.ListArchiveRulesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.accessanalyzer.paginators.ListArchiveRulesPublisher publisher = client.listArchiveRulesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.accessanalyzer.paginators.ListArchiveRulesPublisher publisher = client.listArchiveRulesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.accessanalyzer.model.ListArchiveRulesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.accessanalyzer.model.ListArchiveRulesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listArchiveRules(software.amazon.awssdk.services.accessanalyzer.model.ListArchiveRulesRequest)
operation.- Parameters:
listArchiveRulesRequest
- Retrieves a list of archive rules created for the specified analyzer.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listArchiveRulesPaginator
default ListArchiveRulesPublisher listArchiveRulesPaginator(Consumer<ListArchiveRulesRequest.Builder> listArchiveRulesRequest) Retrieves a list of archive rules created for the specified analyzer.
This is a variant of
listArchiveRules(software.amazon.awssdk.services.accessanalyzer.model.ListArchiveRulesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.accessanalyzer.paginators.ListArchiveRulesPublisher publisher = client.listArchiveRulesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.accessanalyzer.paginators.ListArchiveRulesPublisher publisher = client.listArchiveRulesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.accessanalyzer.model.ListArchiveRulesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.accessanalyzer.model.ListArchiveRulesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listArchiveRules(software.amazon.awssdk.services.accessanalyzer.model.ListArchiveRulesRequest)
operation.This is a convenience which creates an instance of the
ListArchiveRulesRequest.Builder
avoiding the need to create one manually viaListArchiveRulesRequest.builder()
- Parameters:
listArchiveRulesRequest
- AConsumer
that will call methods onListArchiveRulesRequest.Builder
to create a request. Retrieves a list of archive rules created for the specified analyzer.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listFindings
default CompletableFuture<ListFindingsResponse> listFindings(ListFindingsRequest listFindingsRequest) Retrieves a list of findings generated by the specified analyzer.
To learn about filter keys that you can use to retrieve a list of findings, see IAM Access Analyzer filter keys in the IAM User Guide.
- Parameters:
listFindingsRequest
- Retrieves a list of findings generated by the specified analyzer.- Returns:
- A Java Future containing the result of the ListFindings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource could not be found.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listFindings
default CompletableFuture<ListFindingsResponse> listFindings(Consumer<ListFindingsRequest.Builder> listFindingsRequest) Retrieves a list of findings generated by the specified analyzer.
To learn about filter keys that you can use to retrieve a list of findings, see IAM Access Analyzer filter keys in the IAM User Guide.
This is a convenience which creates an instance of the
ListFindingsRequest.Builder
avoiding the need to create one manually viaListFindingsRequest.builder()
- Parameters:
listFindingsRequest
- AConsumer
that will call methods onListFindingsRequest.Builder
to create a request. Retrieves a list of findings generated by the specified analyzer.- Returns:
- A Java Future containing the result of the ListFindings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource could not be found.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listFindingsPaginator
Retrieves a list of findings generated by the specified analyzer.
To learn about filter keys that you can use to retrieve a list of findings, see IAM Access Analyzer filter keys in the IAM User Guide.
This is a variant of
listFindings(software.amazon.awssdk.services.accessanalyzer.model.ListFindingsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.accessanalyzer.paginators.ListFindingsPublisher publisher = client.listFindingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.accessanalyzer.paginators.ListFindingsPublisher publisher = client.listFindingsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.accessanalyzer.model.ListFindingsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.accessanalyzer.model.ListFindingsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFindings(software.amazon.awssdk.services.accessanalyzer.model.ListFindingsRequest)
operation.- Parameters:
listFindingsRequest
- Retrieves a list of findings generated by the specified analyzer.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource could not be found.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listFindingsPaginator
default ListFindingsPublisher listFindingsPaginator(Consumer<ListFindingsRequest.Builder> listFindingsRequest) Retrieves a list of findings generated by the specified analyzer.
To learn about filter keys that you can use to retrieve a list of findings, see IAM Access Analyzer filter keys in the IAM User Guide.
This is a variant of
listFindings(software.amazon.awssdk.services.accessanalyzer.model.ListFindingsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.accessanalyzer.paginators.ListFindingsPublisher publisher = client.listFindingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.accessanalyzer.paginators.ListFindingsPublisher publisher = client.listFindingsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.accessanalyzer.model.ListFindingsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.accessanalyzer.model.ListFindingsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFindings(software.amazon.awssdk.services.accessanalyzer.model.ListFindingsRequest)
operation.This is a convenience which creates an instance of the
ListFindingsRequest.Builder
avoiding the need to create one manually viaListFindingsRequest.builder()
- Parameters:
listFindingsRequest
- AConsumer
that will call methods onListFindingsRequest.Builder
to create a request. Retrieves a list of findings generated by the specified analyzer.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource could not be found.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPolicyGenerations
default CompletableFuture<ListPolicyGenerationsResponse> listPolicyGenerations(ListPolicyGenerationsRequest listPolicyGenerationsRequest) Lists all of the policy generations requested in the last seven days.
- Parameters:
listPolicyGenerationsRequest
-- Returns:
- A Java Future containing the result of the ListPolicyGenerations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPolicyGenerations
default CompletableFuture<ListPolicyGenerationsResponse> listPolicyGenerations(Consumer<ListPolicyGenerationsRequest.Builder> listPolicyGenerationsRequest) Lists all of the policy generations requested in the last seven days.
This is a convenience which creates an instance of the
ListPolicyGenerationsRequest.Builder
avoiding the need to create one manually viaListPolicyGenerationsRequest.builder()
- Parameters:
listPolicyGenerationsRequest
- AConsumer
that will call methods onListPolicyGenerationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListPolicyGenerations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPolicyGenerationsPaginator
default ListPolicyGenerationsPublisher listPolicyGenerationsPaginator(ListPolicyGenerationsRequest listPolicyGenerationsRequest) Lists all of the policy generations requested in the last seven days.
This is a variant of
listPolicyGenerations(software.amazon.awssdk.services.accessanalyzer.model.ListPolicyGenerationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.accessanalyzer.paginators.ListPolicyGenerationsPublisher publisher = client.listPolicyGenerationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.accessanalyzer.paginators.ListPolicyGenerationsPublisher publisher = client.listPolicyGenerationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.accessanalyzer.model.ListPolicyGenerationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.accessanalyzer.model.ListPolicyGenerationsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPolicyGenerations(software.amazon.awssdk.services.accessanalyzer.model.ListPolicyGenerationsRequest)
operation.- Parameters:
listPolicyGenerationsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPolicyGenerationsPaginator
default ListPolicyGenerationsPublisher listPolicyGenerationsPaginator(Consumer<ListPolicyGenerationsRequest.Builder> listPolicyGenerationsRequest) Lists all of the policy generations requested in the last seven days.
This is a variant of
listPolicyGenerations(software.amazon.awssdk.services.accessanalyzer.model.ListPolicyGenerationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.accessanalyzer.paginators.ListPolicyGenerationsPublisher publisher = client.listPolicyGenerationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.accessanalyzer.paginators.ListPolicyGenerationsPublisher publisher = client.listPolicyGenerationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.accessanalyzer.model.ListPolicyGenerationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.accessanalyzer.model.ListPolicyGenerationsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPolicyGenerations(software.amazon.awssdk.services.accessanalyzer.model.ListPolicyGenerationsRequest)
operation.This is a convenience which creates an instance of the
ListPolicyGenerationsRequest.Builder
avoiding the need to create one manually viaListPolicyGenerationsRequest.builder()
- Parameters:
listPolicyGenerationsRequest
- AConsumer
that will call methods onListPolicyGenerationsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Retrieves a list of tags applied to the specified resource.
- Parameters:
listTagsForResourceRequest
- Retrieves a list of tags applied to the specified resource.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource could not be found.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Retrieves a list of tags applied to the specified resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request. Retrieves a list of tags applied to the specified resource.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource could not be found.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startPolicyGeneration
default CompletableFuture<StartPolicyGenerationResponse> startPolicyGeneration(StartPolicyGenerationRequest startPolicyGenerationRequest) Starts the policy generation request.
- Parameters:
startPolicyGenerationRequest
-- Returns:
- A Java Future containing the result of the StartPolicyGeneration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConflictException A conflict exception error.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ServiceQuotaExceededException Service quote met error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startPolicyGeneration
default CompletableFuture<StartPolicyGenerationResponse> startPolicyGeneration(Consumer<StartPolicyGenerationRequest.Builder> startPolicyGenerationRequest) Starts the policy generation request.
This is a convenience which creates an instance of the
StartPolicyGenerationRequest.Builder
avoiding the need to create one manually viaStartPolicyGenerationRequest.builder()
- Parameters:
startPolicyGenerationRequest
- AConsumer
that will call methods onStartPolicyGenerationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartPolicyGeneration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConflictException A conflict exception error.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ServiceQuotaExceededException Service quote met error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startResourceScan
default CompletableFuture<StartResourceScanResponse> startResourceScan(StartResourceScanRequest startResourceScanRequest) Immediately starts a scan of the policies applied to the specified resource.
- Parameters:
startResourceScanRequest
- Starts a scan of the policies applied to the specified resource.- Returns:
- A Java Future containing the result of the StartResourceScan operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource could not be found.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startResourceScan
default CompletableFuture<StartResourceScanResponse> startResourceScan(Consumer<StartResourceScanRequest.Builder> startResourceScanRequest) Immediately starts a scan of the policies applied to the specified resource.
This is a convenience which creates an instance of the
StartResourceScanRequest.Builder
avoiding the need to create one manually viaStartResourceScanRequest.builder()
- Parameters:
startResourceScanRequest
- AConsumer
that will call methods onStartResourceScanRequest.Builder
to create a request. Starts a scan of the policies applied to the specified resource.- Returns:
- A Java Future containing the result of the StartResourceScan operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource could not be found.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
Adds a tag to the specified resource.
- Parameters:
tagResourceRequest
- Adds a tag to the specified resource.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource could not be found.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds a tag to the specified resource.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request. Adds a tag to the specified resource.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource could not be found.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes a tag from the specified resource.
- Parameters:
untagResourceRequest
- Removes a tag from the specified resource.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource could not be found.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes a tag from the specified resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request. Removes a tag from the specified resource.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource could not be found.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateArchiveRule
default CompletableFuture<UpdateArchiveRuleResponse> updateArchiveRule(UpdateArchiveRuleRequest updateArchiveRuleRequest) Updates the criteria and values for the specified archive rule.
- Parameters:
updateArchiveRuleRequest
- Updates the specified archive rule.- Returns:
- A Java Future containing the result of the UpdateArchiveRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource could not be found.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateArchiveRule
default CompletableFuture<UpdateArchiveRuleResponse> updateArchiveRule(Consumer<UpdateArchiveRuleRequest.Builder> updateArchiveRuleRequest) Updates the criteria and values for the specified archive rule.
This is a convenience which creates an instance of the
UpdateArchiveRuleRequest.Builder
avoiding the need to create one manually viaUpdateArchiveRuleRequest.builder()
- Parameters:
updateArchiveRuleRequest
- AConsumer
that will call methods onUpdateArchiveRuleRequest.Builder
to create a request. Updates the specified archive rule.- Returns:
- A Java Future containing the result of the UpdateArchiveRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource could not be found.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateFindings
default CompletableFuture<UpdateFindingsResponse> updateFindings(UpdateFindingsRequest updateFindingsRequest) Updates the status for the specified findings.
- Parameters:
updateFindingsRequest
- Updates findings with the new values provided in the request.- Returns:
- A Java Future containing the result of the UpdateFindings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource could not be found.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateFindings
default CompletableFuture<UpdateFindingsResponse> updateFindings(Consumer<UpdateFindingsRequest.Builder> updateFindingsRequest) Updates the status for the specified findings.
This is a convenience which creates an instance of the
UpdateFindingsRequest.Builder
avoiding the need to create one manually viaUpdateFindingsRequest.builder()
- Parameters:
updateFindingsRequest
- AConsumer
that will call methods onUpdateFindingsRequest.Builder
to create a request. Updates findings with the new values provided in the request.- Returns:
- A Java Future containing the result of the UpdateFindings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource could not be found.
- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
validatePolicy
default CompletableFuture<ValidatePolicyResponse> validatePolicy(ValidatePolicyRequest validatePolicyRequest) Requests the validation of a policy and returns a list of findings. The findings help you identify issues and provide actionable recommendations to resolve the issue and enable you to author functional policies that meet security best practices.
- Parameters:
validatePolicyRequest
-- Returns:
- A Java Future containing the result of the ValidatePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
validatePolicy
default CompletableFuture<ValidatePolicyResponse> validatePolicy(Consumer<ValidatePolicyRequest.Builder> validatePolicyRequest) Requests the validation of a policy and returns a list of findings. The findings help you identify issues and provide actionable recommendations to resolve the issue and enable you to author functional policies that meet security best practices.
This is a convenience which creates an instance of the
ValidatePolicyRequest.Builder
avoiding the need to create one manually viaValidatePolicyRequest.builder()
- Parameters:
validatePolicyRequest
- AConsumer
that will call methods onValidatePolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ValidatePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
validatePolicyPaginator
default ValidatePolicyPublisher validatePolicyPaginator(ValidatePolicyRequest validatePolicyRequest) Requests the validation of a policy and returns a list of findings. The findings help you identify issues and provide actionable recommendations to resolve the issue and enable you to author functional policies that meet security best practices.
This is a variant of
validatePolicy(software.amazon.awssdk.services.accessanalyzer.model.ValidatePolicyRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.accessanalyzer.paginators.ValidatePolicyPublisher publisher = client.validatePolicyPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.accessanalyzer.paginators.ValidatePolicyPublisher publisher = client.validatePolicyPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.accessanalyzer.model.ValidatePolicyResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.accessanalyzer.model.ValidatePolicyResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
validatePolicy(software.amazon.awssdk.services.accessanalyzer.model.ValidatePolicyRequest)
operation.- Parameters:
validatePolicyRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
validatePolicyPaginator
default ValidatePolicyPublisher validatePolicyPaginator(Consumer<ValidatePolicyRequest.Builder> validatePolicyRequest) Requests the validation of a policy and returns a list of findings. The findings help you identify issues and provide actionable recommendations to resolve the issue and enable you to author functional policies that meet security best practices.
This is a variant of
validatePolicy(software.amazon.awssdk.services.accessanalyzer.model.ValidatePolicyRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.accessanalyzer.paginators.ValidatePolicyPublisher publisher = client.validatePolicyPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.accessanalyzer.paginators.ValidatePolicyPublisher publisher = client.validatePolicyPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.accessanalyzer.model.ValidatePolicyResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.accessanalyzer.model.ValidatePolicyResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
validatePolicy(software.amazon.awssdk.services.accessanalyzer.model.ValidatePolicyRequest)
operation.This is a convenience which creates an instance of the
ValidatePolicyRequest.Builder
avoiding the need to create one manually viaValidatePolicyRequest.builder()
- Parameters:
validatePolicyRequest
- AConsumer
that will call methods onValidatePolicyRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException Validation exception error.
- InternalServerException Internal server error.
- ThrottlingException Throttling limit exceeded error.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AccessAnalyzerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aAccessAnalyzerAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aAccessAnalyzerAsyncClient
.
-