com.amazonaws.services.accessanalyzer

Interface AWSAccessAnalyzer

All Known Subinterfaces:

AWSAccessAnalyzerAsync

All Known Implementing Classes:

AbstractAWSAccessAnalyzer, AbstractAWSAccessAnalyzerAsync, AWSAccessAnalyzerAsyncClient, AWSAccessAnalyzerClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSAccessAnalyzer

Interface for accessing Access Analyzer.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSAccessAnalyzer instead.

AWS IAM 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 AWS environment. An external principal can be another AWS account, a root user, an IAM user or role, a federated user, an AWS service, or an anonymous user. You can also use Access Analyzer to preview and validate public and cross-account access to your resources before deploying permissions changes. This guide describes the AWS IAM Access Analyzer operations that you can call programmatically. For general information about Access Analyzer, see AWS IAM Access Analyzer in the IAM User Guide.

To start using Access Analyzer, you first need to create an analyzer.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
ApplyArchiveRuleResult	applyArchiveRule(ApplyArchiveRuleRequest applyArchiveRuleRequest) Retroactively applies the archive rule to existing findings that meet the archive rule criteria.
CancelPolicyGenerationResult	cancelPolicyGeneration(CancelPolicyGenerationRequest cancelPolicyGenerationRequest) Cancels the requested policy generation.
CreateAccessPreviewResult	createAccessPreview(CreateAccessPreviewRequest createAccessPreviewRequest) Creates an access preview that allows you to preview Access Analyzer findings for your resource before deploying resource permissions.
CreateAnalyzerResult	createAnalyzer(CreateAnalyzerRequest createAnalyzerRequest) Creates an analyzer for your account.
CreateArchiveRuleResult	createArchiveRule(CreateArchiveRuleRequest createArchiveRuleRequest) Creates an archive rule for the specified analyzer.
DeleteAnalyzerResult	deleteAnalyzer(DeleteAnalyzerRequest deleteAnalyzerRequest) Deletes the specified analyzer.
DeleteArchiveRuleResult	deleteArchiveRule(DeleteArchiveRuleRequest deleteArchiveRuleRequest) Deletes the specified archive rule.
GetAccessPreviewResult	getAccessPreview(GetAccessPreviewRequest getAccessPreviewRequest) Retrieves information about an access preview for the specified analyzer.
GetAnalyzedResourceResult	getAnalyzedResource(GetAnalyzedResourceRequest getAnalyzedResourceRequest) Retrieves information about a resource that was analyzed.
GetAnalyzerResult	getAnalyzer(GetAnalyzerRequest getAnalyzerRequest) Retrieves information about the specified analyzer.
GetArchiveRuleResult	getArchiveRule(GetArchiveRuleRequest getArchiveRuleRequest) 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 getFindingRequest) Retrieves information about the specified finding.
GetGeneratedPolicyResult	getGeneratedPolicy(GetGeneratedPolicyRequest getGeneratedPolicyRequest) Retrieves the policy that was generated using StartPolicyGeneration.
ListAccessPreviewFindingsResult	listAccessPreviewFindings(ListAccessPreviewFindingsRequest listAccessPreviewFindingsRequest) Retrieves a list of access preview findings generated by the specified access preview.
ListAccessPreviewsResult	listAccessPreviews(ListAccessPreviewsRequest listAccessPreviewsRequest) Retrieves a list of access previews for the specified analyzer.
ListAnalyzedResourcesResult	listAnalyzedResources(ListAnalyzedResourcesRequest listAnalyzedResourcesRequest) Retrieves a list of resources of the specified type that have been analyzed by the specified analyzer..
ListAnalyzersResult	listAnalyzers(ListAnalyzersRequest listAnalyzersRequest) Retrieves a list of analyzers.
ListArchiveRulesResult	listArchiveRules(ListArchiveRulesRequest listArchiveRulesRequest) Retrieves a list of archive rules created for the specified analyzer.
ListFindingsResult	listFindings(ListFindingsRequest listFindingsRequest) Retrieves a list of findings generated by the specified analyzer.
ListPolicyGenerationsResult	listPolicyGenerations(ListPolicyGenerationsRequest listPolicyGenerationsRequest) Lists all of the policy generations requested in the last seven days.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) 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 startPolicyGenerationRequest) Starts the policy generation request.
StartResourceScanResult	startResourceScan(StartResourceScanRequest startResourceScanRequest) Immediately starts a scan of the policies applied to the specified resource.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Adds a tag to the specified resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes a tag from the specified resource.
UpdateArchiveRuleResult	updateArchiveRule(UpdateArchiveRuleRequest updateArchiveRuleRequest) Updates the criteria and values for the specified archive rule.
UpdateFindingsResult	updateFindings(UpdateFindingsRequest updateFindingsRequest) Updates the status for the specified findings.
ValidatePolicyResult	validatePolicy(ValidatePolicyRequest validatePolicyRequest) Requests the validation of a policy and returns a list of findings.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

applyArchiveRule

ApplyArchiveRuleResult 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:

Result of the ApplyArchiveRule operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

cancelPolicyGeneration

CancelPolicyGenerationResult cancelPolicyGeneration(CancelPolicyGenerationRequest cancelPolicyGenerationRequest)

Cancels the requested policy generation.

Parameters:

cancelPolicyGenerationRequest -

Returns:

Result of the CancelPolicyGeneration operation returned by the service.

Throws:

ValidationException - Validation exception error.

InternalServerException - Internal server error.

ThrottlingException - Throttling limit exceeded error.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

createAccessPreview

CreateAccessPreviewResult createAccessPreview(CreateAccessPreviewRequest createAccessPreviewRequest)

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

Parameters:

createAccessPreviewRequest -

Returns:

Result of the CreateAccessPreview operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createAnalyzer

CreateAnalyzerResult createAnalyzer(CreateAnalyzerRequest createAnalyzerRequest)

Creates an analyzer for your account.

Parameters:

createAnalyzerRequest - Creates an analyzer.

Returns:

Result of the CreateAnalyzer operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createArchiveRule

CreateArchiveRuleResult 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 Access Analyzer filter keys in the IAM User Guide.

Parameters:

createArchiveRuleRequest - Creates an archive rule.

Returns:

Result of the CreateArchiveRule operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteAnalyzer

DeleteAnalyzerResult deleteAnalyzer(DeleteAnalyzerRequest deleteAnalyzerRequest)

Deletes the specified analyzer. When you delete an analyzer, 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:

Result of the DeleteAnalyzer operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteArchiveRule

DeleteArchiveRuleResult deleteArchiveRule(DeleteArchiveRuleRequest deleteArchiveRuleRequest)

Deletes the specified archive rule.

Parameters:

deleteArchiveRuleRequest - Deletes an archive rule.

Returns:

Result of the DeleteArchiveRule operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getAccessPreview

GetAccessPreviewResult getAccessPreview(GetAccessPreviewRequest getAccessPreviewRequest)

Retrieves information about an access preview for the specified analyzer.

Parameters:

getAccessPreviewRequest -

Returns:

Result of the GetAccessPreview operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getAnalyzedResource

GetAnalyzedResourceResult getAnalyzedResource(GetAnalyzedResourceRequest getAnalyzedResourceRequest)

Retrieves information about a resource that was analyzed.

Parameters:

getAnalyzedResourceRequest - Retrieves an analyzed resource.

Returns:

Result of the GetAnalyzedResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getAnalyzer

GetAnalyzerResult getAnalyzer(GetAnalyzerRequest getAnalyzerRequest)

Retrieves information about the specified analyzer.

Parameters:

getAnalyzerRequest - Retrieves an analyzer.

Returns:

Result of the GetAnalyzer operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getArchiveRule

GetArchiveRuleResult getArchiveRule(GetArchiveRuleRequest getArchiveRuleRequest)

Retrieves information about an archive rule.

To learn about filter keys that you can use to create an archive rule, see Access Analyzer filter keys in the IAM User Guide.

Parameters:

getArchiveRuleRequest - Retrieves an archive rule.

Returns:

Result of the GetArchiveRule operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getFinding

GetFindingResult getFinding(GetFindingRequest getFindingRequest)

Retrieves information about the specified finding.

Parameters:

getFindingRequest - Retrieves a finding.

Returns:

Result of the GetFinding operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getGeneratedPolicy

GetGeneratedPolicyResult getGeneratedPolicy(GetGeneratedPolicyRequest getGeneratedPolicyRequest)

Retrieves the policy that was generated using StartPolicyGeneration.

Parameters:

getGeneratedPolicyRequest -

Returns:

Result of the GetGeneratedPolicy operation returned by the service.

Throws:

ValidationException - Validation exception error.

InternalServerException - Internal server error.

ThrottlingException - Throttling limit exceeded error.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

listAccessPreviewFindings

ListAccessPreviewFindingsResult listAccessPreviewFindings(ListAccessPreviewFindingsRequest listAccessPreviewFindingsRequest)

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

Parameters:

listAccessPreviewFindingsRequest -

Returns:

Result of the ListAccessPreviewFindings operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listAccessPreviews

ListAccessPreviewsResult listAccessPreviews(ListAccessPreviewsRequest listAccessPreviewsRequest)

Retrieves a list of access previews for the specified analyzer.

Parameters:

listAccessPreviewsRequest -

Returns:

Result of the ListAccessPreviews operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listAnalyzedResources

ListAnalyzedResourcesResult 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:

Result of the ListAnalyzedResources operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listAnalyzers

ListAnalyzersResult listAnalyzers(ListAnalyzersRequest listAnalyzersRequest)

Retrieves a list of analyzers.

Parameters:

listAnalyzersRequest - Retrieves a list of analyzers.

Returns:

Result of the ListAnalyzers operation returned by the service.

Throws:

ValidationException - Validation exception error.

InternalServerException - Internal server error.

ThrottlingException - Throttling limit exceeded error.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

listArchiveRules

ListArchiveRulesResult 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:

Result of the ListArchiveRules operation returned by the service.

Throws:

ValidationException - Validation exception error.

InternalServerException - Internal server error.

ThrottlingException - Throttling limit exceeded error.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

listFindings

ListFindingsResult 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 Access Analyzer filter keys in the IAM User Guide.

Parameters:

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

Returns:

Result of the ListFindings operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listPolicyGenerations

ListPolicyGenerationsResult listPolicyGenerations(ListPolicyGenerationsRequest listPolicyGenerationsRequest)

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

Parameters:

listPolicyGenerationsRequest -

Returns:

Result of the ListPolicyGenerations operation returned by the service.

Throws:

ValidationException - Validation exception error.

InternalServerException - Internal server error.

ThrottlingException - Throttling limit exceeded error.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult 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:

Result of the ListTagsForResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

startPolicyGeneration

StartPolicyGenerationResult startPolicyGeneration(StartPolicyGenerationRequest startPolicyGenerationRequest)

Starts the policy generation request.

Parameters:

startPolicyGenerationRequest -

Returns:

Result of the StartPolicyGeneration operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

startResourceScan

StartResourceScanResult 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:

Result of the StartResourceScan operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Adds a tag to the specified resource.

Parameters:

tagResourceRequest - Adds a tag to the specified resource.

Returns:

Result of the TagResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes a tag from the specified resource.

Parameters:

untagResourceRequest - Removes a tag from the specified resource.

Returns:

Result of the UntagResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateArchiveRule

UpdateArchiveRuleResult updateArchiveRule(UpdateArchiveRuleRequest updateArchiveRuleRequest)

Updates the criteria and values for the specified archive rule.

Parameters:

updateArchiveRuleRequest - Updates the specified archive rule.

Returns:

Result of the UpdateArchiveRule operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateFindings

UpdateFindingsResult updateFindings(UpdateFindingsRequest updateFindingsRequest)

Updates the status for the specified findings.

Parameters:

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

Returns:

Result of the UpdateFindings operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

validatePolicy

ValidatePolicyResult 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:

Result of the ValidatePolicy operation returned by the service.

Throws:

ValidationException - Validation exception error.

InternalServerException - Internal server error.

ThrottlingException - Throttling limit exceeded error.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

shutdown

void shutdown()

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.

getCachedResponseMetadata

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. 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.

Parameters:

request - The originally executed request.

Returns:

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