aws-elixir

View Source AWS.AccessAnalyzer (aws-elixir v1.0.4)

Identity and Access Management Access Analyzer helps you to set, verify, and refine your IAM policies by providing a suite of capabilities.

Its features include findings for external and unused access, basic and custom policy checks for validating policies, and policy generation to generate fine-grained policies. To start using IAM Access Analyzer to identify external or unused access, you first need to create an analyzer.

External access analyzers help identify potential risks of accessing resources by enabling you to identify any resource 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 public and cross-account access to your resources before deploying permissions changes.

Unused access analyzers help identify potential identity access risks by enabling you to identify unused IAM roles, unused access keys, unused console passwords, and IAM principals with unused service and action-level permissions.

Beyond findings, IAM Access Analyzer provides basic and custom policy checks to validate IAM policies before deploying permissions changes. You can use policy generation to refine permissions by attaching a policy generated using access activity logged in CloudTrail logs.

This guide describes the IAM 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.

Link to this section Summary

Functions

apply_archive_rule(client, input, options \\ [])

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

cancel_policy_generation(client, job_id, input, options \\ [])

Cancels the requested policy generation.

check_access_not_granted(client, input, options \\ [])

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

check_no_new_access(client, input, options \\ [])

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

check_no_public_access(client, input, options \\ [])

Checks whether a resource policy can grant public access to the specified resource type.

create_access_preview(client, input, options \\ [])

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

create_analyzer(client, input, options \\ [])

Creates an analyzer for your account.

create_archive_rule(client, analyzer_name, input, options \\ [])

Creates an archive rule for the specified analyzer.

delete_analyzer(client, analyzer_name, input, options \\ [])

Deletes the specified analyzer.

delete_archive_rule(client, analyzer_name, rule_name, input, options \\ [])

Deletes the specified archive rule.

generate_finding_recommendation(client, id, input, options \\ [])

Creates a recommendation for an unused permissions finding.

get_access_preview(client, access_preview_id, analyzer_arn, options \\ [])

Retrieves information about an access preview for the specified analyzer.

get_analyzed_resource(client, analyzer_arn, resource_arn, options \\ [])

Retrieves information about a resource that was analyzed.

get_analyzer(client, analyzer_name, options \\ [])

Retrieves information about the specified analyzer.

get_archive_rule(client, analyzer_name, rule_name, options \\ [])

Retrieves information about an archive rule.

get_finding(client, id, analyzer_arn, options \\ [])

Retrieves information about the specified finding.

get_finding_recommendation(client, id, analyzer_arn, max_results \\ nil, next_token \\ nil, options \\ [])

Retrieves information about a finding recommendation for the specified analyzer.

get_finding_v2(client, id, analyzer_arn, max_results \\ nil, next_token \\ nil, options \\ [])

Retrieves information about the specified finding.

get_generated_policy(client, job_id, include_resource_placeholders \\ nil, include_service_level_template \\ nil, options \\ [])

Retrieves the policy that was generated using StartPolicyGeneration.

list_access_preview_findings(client, access_preview_id, input, options \\ [])

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

list_access_previews(client, analyzer_arn, max_results \\ nil, next_token \\ nil, options \\ [])

Retrieves a list of access previews for the specified analyzer.

list_analyzed_resources(client, input, options \\ [])

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

list_analyzers(client, max_results \\ nil, next_token \\ nil, type \\ nil, options \\ [])

Retrieves a list of analyzers.

list_archive_rules(client, analyzer_name, max_results \\ nil, next_token \\ nil, options \\ [])

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

list_findings(client, input, options \\ [])

Retrieves a list of findings generated by the specified analyzer.

list_findings_v2(client, input, options \\ [])

Retrieves a list of findings generated by the specified analyzer.

list_policy_generations(client, max_results \\ nil, next_token \\ nil, principal_arn \\ nil, options \\ [])

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

list_tags_for_resource(client, resource_arn, options \\ [])

Retrieves a list of tags applied to the specified resource.

metadata()
start_policy_generation(client, input, options \\ [])

Starts the policy generation request.

start_resource_scan(client, input, options \\ [])

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

tag_resource(client, resource_arn, input, options \\ [])

Adds a tag to the specified resource.

untag_resource(client, resource_arn, input, options \\ [])

Removes a tag from the specified resource.

update_analyzer(client, analyzer_name, input, options \\ [])

Modifies the configuration of an existing analyzer.

update_archive_rule(client, analyzer_name, rule_name, input, options \\ [])

Updates the criteria and values for the specified archive rule.

update_findings(client, input, options \\ [])

Updates the status for the specified findings.

validate_policy(client, input, options \\ [])

Requests the validation of a policy and returns a list of findings.

Link to this section Functions

Link to this function

apply_archive_rule(client, input, options \\ [])

View Source

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

Link to this function

cancel_policy_generation(client, job_id, input, options \\ [])

View Source

Cancels the requested policy generation.

Link to this function

check_access_not_granted(client, input, options \\ [])

View Source

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

Link to this function

check_no_new_access(client, input, options \\ [])

View Source

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.

Link to this function

check_no_public_access(client, input, options \\ [])

View Source

Checks whether a resource policy can grant public access to the specified resource type.

Link to this function

create_access_preview(client, input, options \\ [])

View Source

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

Link to this function

create_analyzer(client, input, options \\ [])

View Source

Creates an analyzer for your account.

Link to this function

create_archive_rule(client, analyzer_name, input, options \\ [])

View Source

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.

Link to this function

delete_analyzer(client, analyzer_name, input, options \\ [])

View Source

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.

Link to this function

delete_archive_rule(client, analyzer_name, rule_name, input, options \\ [])

View Source

Deletes the specified archive rule.

Link to this function

generate_finding_recommendation(client, id, input, options \\ [])

View Source

Creates a recommendation for an unused permissions finding.

Link to this function

get_access_preview(client, access_preview_id, analyzer_arn, options \\ [])

View Source

Retrieves information about an access preview for the specified analyzer.

Link to this function

get_analyzed_resource(client, analyzer_arn, resource_arn, options \\ [])

View Source

Retrieves information about a resource that was analyzed.

Link to this function

get_analyzer(client, analyzer_name, options \\ [])

View Source

Retrieves information about the specified analyzer.

Link to this function

get_archive_rule(client, analyzer_name, rule_name, options \\ [])

View Source

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.

Link to this function

get_finding(client, id, analyzer_arn, options \\ [])

View Source

Retrieves information about the specified finding.

GetFinding and GetFindingV2 both use access-analyzer:GetFinding in the Action element of an IAM policy statement. You must have permission to perform the access-analyzer:GetFinding action.

Link to this function

get_finding_recommendation(client, id, analyzer_arn, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Retrieves information about a finding recommendation for the specified analyzer.

Link to this function

get_finding_v2(client, id, analyzer_arn, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Retrieves information about the specified finding.

GetFinding and GetFindingV2 both use access-analyzer:GetFinding in the Action element of an IAM policy statement. You must have permission to perform the access-analyzer:GetFinding action.

Link to this function

get_generated_policy(client, job_id, include_resource_placeholders \\ nil, include_service_level_template \\ nil, options \\ [])

View Source

Retrieves the policy that was generated using StartPolicyGeneration.

Link to this function

list_access_preview_findings(client, access_preview_id, input, options \\ [])

View Source

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

Link to this function

list_access_previews(client, analyzer_arn, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Retrieves a list of access previews for the specified analyzer.

Link to this function

list_analyzed_resources(client, input, options \\ [])

View Source

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

Link to this function

list_analyzers(client, max_results \\ nil, next_token \\ nil, type \\ nil, options \\ [])

View Source

Retrieves a list of analyzers.

Link to this function

list_archive_rules(client, analyzer_name, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

list_findings(client, input, options \\ [])

View Source

Retrieves a list of findings generated by the specified analyzer.

ListFindings and ListFindingsV2 both use access-analyzer:ListFindings in the Action element of an IAM policy statement. You must have permission to perform the access-analyzer:ListFindings action.

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.

Link to this function

list_findings_v2(client, input, options \\ [])

View Source

Retrieves a list of findings generated by the specified analyzer.

ListFindings and ListFindingsV2 both use access-analyzer:ListFindings in the Action element of an IAM policy statement. You must have permission to perform the access-analyzer:ListFindings action.

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.

Link to this function

list_policy_generations(client, max_results \\ nil, next_token \\ nil, principal_arn \\ nil, options \\ [])

View Source

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

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

Retrieves a list of tags applied to the specified resource.

Link to this function

metadata()

View Source
Link to this function

start_policy_generation(client, input, options \\ [])

View Source

Starts the policy generation request.

Link to this function

start_resource_scan(client, input, options \\ [])

View Source

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

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

Adds a tag to the specified resource.

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Removes a tag from the specified resource.

Link to this function

update_analyzer(client, analyzer_name, input, options \\ [])

View Source

Modifies the configuration of an existing analyzer.

Link to this function

update_archive_rule(client, analyzer_name, rule_name, input, options \\ [])

View Source

Updates the criteria and values for the specified archive rule.

Link to this function

update_findings(client, input, options \\ [])

View Source

Updates the status for the specified findings.

Link to this function

validate_policy(client, input, options \\ [])

View Source

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.