com.amazonaws.services.accessanalyzer

Class AbstractAWSAccessAnalyzer

java.lang.Object

com.amazonaws.services.accessanalyzer.AbstractAWSAccessAnalyzer

All Implemented Interfaces:

AWSAccessAnalyzer

Direct Known Subclasses:

AbstractAWSAccessAnalyzerAsync

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSAccessAnalyzer
extends Object
implements AWSAccessAnalyzer

Abstract implementation of AWSAccessAnalyzer. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary

Fields inherited from interface com.amazonaws.services.accessanalyzer.AWSAccessAnalyzer

ENDPOINT_PREFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAWSAccessAnalyzer()

Method Summary

Modifier and Type	Method and Description
ApplyArchiveRuleResult	applyArchiveRule(ApplyArchiveRuleRequest request) Retroactively applies the archive rule to existing findings that meet the archive rule criteria.
CancelPolicyGenerationResult	cancelPolicyGeneration(CancelPolicyGenerationRequest request) Cancels the requested policy generation.
CheckAccessNotGrantedResult	checkAccessNotGranted(CheckAccessNotGrantedRequest request) Checks whether the specified access isn't allowed by a policy.
CheckNoNewAccessResult	checkNoNewAccess(CheckNoNewAccessRequest request) Checks whether new access is allowed for an updated policy when compared to the existing policy.
CreateAccessPreviewResult	createAccessPreview(CreateAccessPreviewRequest request) Creates an access preview that allows you to preview IAM Access Analyzer findings for your resource before deploying resource permissions.
CreateAnalyzerResult	createAnalyzer(CreateAnalyzerRequest request) Creates an analyzer for your account.
CreateArchiveRuleResult	createArchiveRule(CreateArchiveRuleRequest request) Creates an archive rule for the specified analyzer.
DeleteAnalyzerResult	deleteAnalyzer(DeleteAnalyzerRequest request) Deletes the specified analyzer.
DeleteArchiveRuleResult	deleteArchiveRule(DeleteArchiveRuleRequest request) Deletes the specified archive rule.
GetAccessPreviewResult	getAccessPreview(GetAccessPreviewRequest request) Retrieves information about an access preview for the specified analyzer.
GetAnalyzedResourceResult	getAnalyzedResource(GetAnalyzedResourceRequest request) Retrieves information about a resource that was analyzed.
GetAnalyzerResult	getAnalyzer(GetAnalyzerRequest request) Retrieves information about the specified analyzer.
GetArchiveRuleResult	getArchiveRule(GetArchiveRuleRequest request) Retrieves information about an archive rule.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetFindingResult	getFinding(GetFindingRequest request) Retrieves information about the specified finding.
GetFindingV2Result	getFindingV2(GetFindingV2Request request) Retrieves information about the specified finding.
GetGeneratedPolicyResult	getGeneratedPolicy(GetGeneratedPolicyRequest request) Retrieves the policy that was generated using StartPolicyGeneration.
ListAccessPreviewFindingsResult	listAccessPreviewFindings(ListAccessPreviewFindingsRequest request) Retrieves a list of access preview findings generated by the specified access preview.
ListAccessPreviewsResult	listAccessPreviews(ListAccessPreviewsRequest request) Retrieves a list of access previews for the specified analyzer.
ListAnalyzedResourcesResult	listAnalyzedResources(ListAnalyzedResourcesRequest request) Retrieves a list of resources of the specified type that have been analyzed by the specified analyzer..
ListAnalyzersResult	listAnalyzers(ListAnalyzersRequest request) Retrieves a list of analyzers.
ListArchiveRulesResult	listArchiveRules(ListArchiveRulesRequest request) Retrieves a list of archive rules created for the specified analyzer.
ListFindingsResult	listFindings(ListFindingsRequest request) Retrieves a list of findings generated by the specified analyzer.
ListFindingsV2Result	listFindingsV2(ListFindingsV2Request request) Retrieves a list of findings generated by the specified analyzer.
ListPolicyGenerationsResult	listPolicyGenerations(ListPolicyGenerationsRequest request) Lists all of the policy generations requested in the last seven days.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Retrieves a list of tags applied to the specified resource.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartPolicyGenerationResult	startPolicyGeneration(StartPolicyGenerationRequest request) Starts the policy generation request.
StartResourceScanResult	startResourceScan(StartResourceScanRequest request) Immediately starts a scan of the policies applied to the specified resource.
TagResourceResult	tagResource(TagResourceRequest request) Adds a tag to the specified resource.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes a tag from the specified resource.
UpdateArchiveRuleResult	updateArchiveRule(UpdateArchiveRuleRequest request) Updates the criteria and values for the specified archive rule.
UpdateFindingsResult	updateFindings(UpdateFindingsRequest request) Updates the status for the specified findings.
ValidatePolicyResult	validatePolicy(ValidatePolicyRequest request) Requests the validation of a policy and returns a list of findings.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractAWSAccessAnalyzer

protected AbstractAWSAccessAnalyzer()

Method Detail

applyArchiveRule

public ApplyArchiveRuleResult applyArchiveRule(ApplyArchiveRuleRequest request)

Description copied from interface: AWSAccessAnalyzer

Retroactively applies the archive rule to existing findings that meet the archive rule criteria.

Specified by:

applyArchiveRule in interface AWSAccessAnalyzer

Parameters:

request - Retroactively applies an archive rule.

Returns:

Result of the ApplyArchiveRule operation returned by the service.

See Also:

AWS API Documentation

cancelPolicyGeneration

public CancelPolicyGenerationResult cancelPolicyGeneration(CancelPolicyGenerationRequest request)

Description copied from interface: AWSAccessAnalyzer

Cancels the requested policy generation.

Specified by:

cancelPolicyGeneration in interface AWSAccessAnalyzer

Returns:

Result of the CancelPolicyGeneration operation returned by the service.

See Also:

AWS API Documentation

checkAccessNotGranted

public CheckAccessNotGrantedResult checkAccessNotGranted(CheckAccessNotGrantedRequest request)

Description copied from interface: AWSAccessAnalyzer

Checks whether the specified access isn't allowed by a policy.

Specified by:

checkAccessNotGranted in interface AWSAccessAnalyzer

Returns:

Result of the CheckAccessNotGranted operation returned by the service.

See Also:

AWS API Documentation

checkNoNewAccess

public CheckNoNewAccessResult checkNoNewAccess(CheckNoNewAccessRequest request)

Description copied from interface: AWSAccessAnalyzer

Checks whether new access is allowed for an updated policy when compared to the existing policy.

You can find examples for reference policies and learn how to set up and run a custom policy check for new access in the IAM Access Analyzer custom policy checks samples repository on GitHub. The reference policies in this repository are meant to be passed to the existingPolicyDocument request parameter.

Specified by:

checkNoNewAccess in interface AWSAccessAnalyzer

Returns:

Result of the CheckNoNewAccess operation returned by the service.

See Also:

AWS API Documentation

createAccessPreview

public CreateAccessPreviewResult createAccessPreview(CreateAccessPreviewRequest request)

Description copied from interface: AWSAccessAnalyzer

Creates an access preview that allows you to preview IAM Access Analyzer findings for your resource before deploying resource permissions.

Specified by:

createAccessPreview in interface AWSAccessAnalyzer

Returns:

Result of the CreateAccessPreview operation returned by the service.

See Also:

AWS API Documentation

createAnalyzer

public CreateAnalyzerResult createAnalyzer(CreateAnalyzerRequest request)

Description copied from interface: AWSAccessAnalyzer

Creates an analyzer for your account.

Specified by:

createAnalyzer in interface AWSAccessAnalyzer

Parameters:

request - Creates an analyzer.

Returns:

Result of the CreateAnalyzer operation returned by the service.

See Also:

AWS API Documentation

createArchiveRule

public CreateArchiveRuleResult createArchiveRule(CreateArchiveRuleRequest request)

Description copied from interface: AWSAccessAnalyzer

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.

Specified by:

createArchiveRule in interface AWSAccessAnalyzer

Parameters:

request - Creates an archive rule.

Returns:

Result of the CreateArchiveRule operation returned by the service.

See Also:

AWS API Documentation

deleteAnalyzer

public DeleteAnalyzerResult deleteAnalyzer(DeleteAnalyzerRequest request)

Description copied from interface: AWSAccessAnalyzer

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.

Specified by:

deleteAnalyzer in interface AWSAccessAnalyzer

Parameters:

request - Deletes an analyzer.

Returns:

Result of the DeleteAnalyzer operation returned by the service.

See Also:

AWS API Documentation

deleteArchiveRule

public DeleteArchiveRuleResult deleteArchiveRule(DeleteArchiveRuleRequest request)

Description copied from interface: AWSAccessAnalyzer

Deletes the specified archive rule.

Specified by:

deleteArchiveRule in interface AWSAccessAnalyzer

Parameters:

request - Deletes an archive rule.

Returns:

Result of the DeleteArchiveRule operation returned by the service.

See Also:

AWS API Documentation

getAccessPreview

public GetAccessPreviewResult getAccessPreview(GetAccessPreviewRequest request)

Description copied from interface: AWSAccessAnalyzer

Retrieves information about an access preview for the specified analyzer.

Specified by:

getAccessPreview in interface AWSAccessAnalyzer

Returns:

Result of the GetAccessPreview operation returned by the service.

See Also:

AWS API Documentation

getAnalyzedResource

public GetAnalyzedResourceResult getAnalyzedResource(GetAnalyzedResourceRequest request)

Description copied from interface: AWSAccessAnalyzer

Retrieves information about a resource that was analyzed.

Specified by:

getAnalyzedResource in interface AWSAccessAnalyzer

Parameters:

request - Retrieves an analyzed resource.

Returns:

Result of the GetAnalyzedResource operation returned by the service.

See Also:

AWS API Documentation

getAnalyzer

public GetAnalyzerResult getAnalyzer(GetAnalyzerRequest request)

Description copied from interface: AWSAccessAnalyzer

Retrieves information about the specified analyzer.

Specified by:

getAnalyzer in interface AWSAccessAnalyzer

Parameters:

request - Retrieves an analyzer.

Returns:

Result of the GetAnalyzer operation returned by the service.

See Also:

AWS API Documentation

getArchiveRule

public GetArchiveRuleResult getArchiveRule(GetArchiveRuleRequest request)

Description copied from interface: AWSAccessAnalyzer

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.

Specified by:

getArchiveRule in interface AWSAccessAnalyzer

Parameters:

request - Retrieves an archive rule.

Returns:

Result of the GetArchiveRule operation returned by the service.

See Also:

AWS API Documentation

getFinding

public GetFindingResult getFinding(GetFindingRequest request)

Description copied from interface: AWSAccessAnalyzer

Retrieves information about the specified finding.

Specified by:

getFinding in interface AWSAccessAnalyzer

Parameters:

request - Retrieves a finding.

Returns:

Result of the GetFinding operation returned by the service.

See Also:

AWS API Documentation

getFindingV2

public GetFindingV2Result getFindingV2(GetFindingV2Request request)

Description copied from interface: AWSAccessAnalyzer

Retrieves information about the specified finding.

Specified by:

getFindingV2 in interface AWSAccessAnalyzer

Returns:

Result of the GetFindingV2 operation returned by the service.

See Also:

AWS API Documentation

getGeneratedPolicy

public GetGeneratedPolicyResult getGeneratedPolicy(GetGeneratedPolicyRequest request)

Description copied from interface: AWSAccessAnalyzer

Retrieves the policy that was generated using StartPolicyGeneration.

Specified by:

getGeneratedPolicy in interface AWSAccessAnalyzer

Returns:

Result of the GetGeneratedPolicy operation returned by the service.

See Also:

AWS API Documentation

listAccessPreviewFindings

public ListAccessPreviewFindingsResult listAccessPreviewFindings(ListAccessPreviewFindingsRequest request)

Description copied from interface: AWSAccessAnalyzer

Retrieves a list of access preview findings generated by the specified access preview.

Specified by:

listAccessPreviewFindings in interface AWSAccessAnalyzer

Returns:

Result of the ListAccessPreviewFindings operation returned by the service.

See Also:

AWS API Documentation

listAccessPreviews

public ListAccessPreviewsResult listAccessPreviews(ListAccessPreviewsRequest request)

Description copied from interface: AWSAccessAnalyzer

Retrieves a list of access previews for the specified analyzer.

Specified by:

listAccessPreviews in interface AWSAccessAnalyzer

Returns:

Result of the ListAccessPreviews operation returned by the service.

See Also:

AWS API Documentation

listAnalyzedResources

public ListAnalyzedResourcesResult listAnalyzedResources(ListAnalyzedResourcesRequest request)

Description copied from interface: AWSAccessAnalyzer

Retrieves a list of resources of the specified type that have been analyzed by the specified analyzer..

Specified by:

listAnalyzedResources in interface AWSAccessAnalyzer

Parameters:

request - Retrieves a list of resources that have been analyzed.

Returns:

Result of the ListAnalyzedResources operation returned by the service.

See Also:

AWS API Documentation

listAnalyzers

public ListAnalyzersResult listAnalyzers(ListAnalyzersRequest request)

Description copied from interface: AWSAccessAnalyzer

Retrieves a list of analyzers.

Specified by:

listAnalyzers in interface AWSAccessAnalyzer

Parameters:

request - Retrieves a list of analyzers.

Returns:

Result of the ListAnalyzers operation returned by the service.

See Also:

AWS API Documentation

listArchiveRules

public ListArchiveRulesResult listArchiveRules(ListArchiveRulesRequest request)

Description copied from interface: AWSAccessAnalyzer

Retrieves a list of archive rules created for the specified analyzer.

Specified by:

listArchiveRules in interface AWSAccessAnalyzer

Parameters:

request - Retrieves a list of archive rules created for the specified analyzer.

Returns:

Result of the ListArchiveRules operation returned by the service.

See Also:

AWS API Documentation

listFindings

public ListFindingsResult listFindings(ListFindingsRequest request)

Description copied from interface: AWSAccessAnalyzer

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.

Specified by:

listFindings in interface AWSAccessAnalyzer

Parameters:

request - Retrieves a list of findings generated by the specified analyzer.

Returns:

Result of the ListFindings operation returned by the service.

See Also:

AWS API Documentation

listFindingsV2

public ListFindingsV2Result listFindingsV2(ListFindingsV2Request request)

Description copied from interface: AWSAccessAnalyzer

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.

Specified by:

listFindingsV2 in interface AWSAccessAnalyzer

Returns:

Result of the ListFindingsV2 operation returned by the service.

See Also:

AWS API Documentation

listPolicyGenerations

public ListPolicyGenerationsResult listPolicyGenerations(ListPolicyGenerationsRequest request)

Description copied from interface: AWSAccessAnalyzer

Lists all of the policy generations requested in the last seven days.

Specified by:

listPolicyGenerations in interface AWSAccessAnalyzer

Returns:

Result of the ListPolicyGenerations operation returned by the service.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Description copied from interface: AWSAccessAnalyzer

Retrieves a list of tags applied to the specified resource.

Specified by:

listTagsForResource in interface AWSAccessAnalyzer

Parameters:

request - Retrieves a list of tags applied to the specified resource.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

AWS API Documentation

startPolicyGeneration

public StartPolicyGenerationResult startPolicyGeneration(StartPolicyGenerationRequest request)

Description copied from interface: AWSAccessAnalyzer

Starts the policy generation request.

Specified by:

startPolicyGeneration in interface AWSAccessAnalyzer

Returns:

Result of the StartPolicyGeneration operation returned by the service.

See Also:

AWS API Documentation

startResourceScan

public StartResourceScanResult startResourceScan(StartResourceScanRequest request)

Description copied from interface: AWSAccessAnalyzer

Immediately starts a scan of the policies applied to the specified resource.

Specified by:

startResourceScan in interface AWSAccessAnalyzer

Parameters:

request - Starts a scan of the policies applied to the specified resource.

Returns:

Result of the StartResourceScan operation returned by the service.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Description copied from interface: AWSAccessAnalyzer

Adds a tag to the specified resource.

Specified by:

tagResource in interface AWSAccessAnalyzer

Parameters:

request - Adds a tag to the specified resource.

Returns:

Result of the TagResource operation returned by the service.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Description copied from interface: AWSAccessAnalyzer

Removes a tag from the specified resource.

Specified by:

untagResource in interface AWSAccessAnalyzer

Parameters:

request - Removes a tag from the specified resource.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

AWS API Documentation

updateArchiveRule

public UpdateArchiveRuleResult updateArchiveRule(UpdateArchiveRuleRequest request)

Description copied from interface: AWSAccessAnalyzer

Updates the criteria and values for the specified archive rule.

Specified by:

updateArchiveRule in interface AWSAccessAnalyzer

Parameters:

request - Updates the specified archive rule.

Returns:

Result of the UpdateArchiveRule operation returned by the service.

See Also:

AWS API Documentation

updateFindings

public UpdateFindingsResult updateFindings(UpdateFindingsRequest request)

Description copied from interface: AWSAccessAnalyzer

Updates the status for the specified findings.

Specified by:

updateFindings in interface AWSAccessAnalyzer

Parameters:

request - Updates findings with the new values provided in the request.

Returns:

Result of the UpdateFindings operation returned by the service.

See Also:

AWS API Documentation

validatePolicy

public ValidatePolicyResult validatePolicy(ValidatePolicyRequest request)

Description copied from interface: AWSAccessAnalyzer

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.

Specified by:

validatePolicy in interface AWSAccessAnalyzer

Returns:

Result of the ValidatePolicy operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Description copied from interface: AWSAccessAnalyzer

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSAccessAnalyzer

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Description copied from interface: AWSAccessAnalyzer

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Specified by:

getCachedResponseMetadata in interface AWSAccessAnalyzer

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.