View Source AWS.AccessAnalyzer (aws-elixir v0.13.3)
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.
Link to this section Summary
Functions
Retroactively applies the archive rule to existing findings that meet the archive rule criteria.
Cancels the requested policy generation.
Creates an access preview that allows you to preview IAM Access Analyzer findings for your resource before deploying resource permissions.
Creates an analyzer for your account.
Creates an archive rule for the specified analyzer.
Deletes the specified analyzer.
Deletes the specified archive rule.
Retrieves information about an access preview for the specified analyzer.
Retrieves information about a resource that was analyzed.
Retrieves information about the specified analyzer.
Retrieves information about an archive rule.
Retrieves information about the specified finding.
Retrieves the policy that was generated using StartPolicyGeneration
.
Retrieves a list of access preview findings generated by the specified access preview.
Retrieves a list of access previews for the specified analyzer.
Retrieves a list of resources of the specified type that have been analyzed by the specified analyzer..
Retrieves a list of analyzers.
Retrieves a list of archive rules created for the specified analyzer.
Retrieves a list of findings generated by the specified analyzer.
Lists all of the policy generations requested in the last seven days.
Retrieves a list of tags applied to the specified resource.
Starts the policy generation request.
Immediately starts a scan of the policies applied to the specified resource.
Adds a tag to the specified resource.
Removes a tag from the specified resource.
Updates the criteria and values for the specified archive rule.
Updates the status for the specified findings.
Requests the validation of a policy and returns a list of findings.
Link to this section Functions
Retroactively applies the archive rule to existing findings that meet the archive rule criteria.
Cancels the requested policy generation.
Creates an access preview that allows you to preview IAM Access Analyzer findings for your resource before deploying resource permissions.
Creates an analyzer for your account.
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.
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.
delete_archive_rule(client, analyzer_name, rule_name, input, options \\ [])
View SourceDeletes the specified archive rule.
get_access_preview(client, access_preview_id, analyzer_arn, options \\ [])
View SourceRetrieves information about an access preview for the specified analyzer.
get_analyzed_resource(client, analyzer_arn, resource_arn, options \\ [])
View SourceRetrieves information about a resource that was analyzed.
Retrieves information about the specified analyzer.
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.
Retrieves information about the specified finding.
get_generated_policy(client, job_id, include_resource_placeholders \\ nil, include_service_level_template \\ nil, options \\ [])
View SourceRetrieves the policy that was generated using StartPolicyGeneration
.
list_access_preview_findings(client, access_preview_id, input, options \\ [])
View SourceRetrieves 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 \\ [])
View SourceRetrieves a list of access previews for the specified analyzer.
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 \\ [])
View SourceRetrieves a list of analyzers.
list_archive_rules(client, analyzer_name, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceRetrieves a list of archive rules created for the specified analyzer.
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.
list_policy_generations(client, max_results \\ nil, next_token \\ nil, principal_arn \\ nil, options \\ [])
View SourceLists all of the policy generations requested in the last seven days.
Retrieves a list of tags applied to the specified resource.
Starts the policy generation request.
Immediately starts a scan of the policies applied to the specified resource.
Adds a tag to the specified resource.
Removes a tag from the specified resource.
update_archive_rule(client, analyzer_name, rule_name, input, options \\ [])
View SourceUpdates the criteria and values for the specified archive rule.
Updates the status for the specified findings.
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.