Accessanalyzer

This page documents function available when using the Accessanalyzer module, created with @service Accessanalyzer.

Index

Documentation

Main.Accessanalyzer.apply_archive_ruleMethod
apply_archive_rule(analyzer_arn, rule_name)
apply_archive_rule(analyzer_arn, rule_name, params::Dict{String,<:Any})

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

Arguments

  • analyzer_arn: The Amazon resource name (ARN) of the analyzer.
  • rule_name: The name of the rule to apply.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A client token.
Main.Accessanalyzer.cancel_policy_generationMethod
cancel_policy_generation(job_id)
cancel_policy_generation(job_id, params::Dict{String,<:Any})

Cancels the requested policy generation.

Arguments

  • job_id: The JobId that is returned by the StartPolicyGeneration operation. The JobId can be used with GetGeneratedPolicy to retrieve the generated policies or used with CancelPolicyGeneration to cancel the policy generation request.
Main.Accessanalyzer.create_access_previewMethod
create_access_preview(analyzer_arn, configurations)
create_access_preview(analyzer_arn, configurations, params::Dict{String,<:Any})

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

Arguments

  • analyzer_arn: The ARN of the account analyzer used to generate the access preview. You can only create an access preview for analyzers with an Account type and Active status.
  • configurations: Access control configuration for your resource that is used to generate the access preview. The access preview includes findings for external access allowed to the resource with the proposed access control configuration. The configuration must contain exactly one element.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A client token.
Main.Accessanalyzer.create_analyzerMethod
create_analyzer(analyzer_name, type)
create_analyzer(analyzer_name, type, params::Dict{String,<:Any})

Creates an analyzer for your account.

Arguments

  • analyzer_name: The name of the analyzer to create.
  • type: The type of analyzer to create. Only ACCOUNT and ORGANIZATION analyzers are supported. You can create only one analyzer per account per Region. You can create up to 5 analyzers per organization per Region.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "archiveRules": Specifies the archive rules to add for the analyzer. Archive rules automatically archive findings that meet the criteria you define for the rule.
  • "clientToken": A client token.
  • "tags": The tags to apply to the analyzer.
Main.Accessanalyzer.create_archive_ruleMethod
create_archive_rule(analyzer_name, filter, rule_name)
create_archive_rule(analyzer_name, filter, rule_name, params::Dict{String,<:Any})

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.

Arguments

  • analyzer_name: The name of the created analyzer.
  • filter: The criteria for the rule.
  • rule_name: The name of the rule to create.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A client token.
Main.Accessanalyzer.delete_analyzerMethod
delete_analyzer(analyzer_name)
delete_analyzer(analyzer_name, params::Dict{String,<:Any})

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.

Arguments

  • analyzer_name: The name of the analyzer to delete.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A client token.
Main.Accessanalyzer.delete_archive_ruleMethod
delete_archive_rule(analyzer_name, rule_name)
delete_archive_rule(analyzer_name, rule_name, params::Dict{String,<:Any})

Deletes the specified archive rule.

Arguments

  • analyzer_name: The name of the analyzer that associated with the archive rule to delete.
  • rule_name: The name of the rule to delete.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A client token.
Main.Accessanalyzer.get_access_previewMethod
get_access_preview(access_preview_id, analyzer_arn)
get_access_preview(access_preview_id, analyzer_arn, params::Dict{String,<:Any})

Retrieves information about an access preview for the specified analyzer.

Arguments

  • access_preview_id: The unique ID for the access preview.
  • analyzer_arn: The ARN of the analyzer used to generate the access preview.
Main.Accessanalyzer.get_analyzed_resourceMethod
get_analyzed_resource(analyzer_arn, resource_arn)
get_analyzed_resource(analyzer_arn, resource_arn, params::Dict{String,<:Any})

Retrieves information about a resource that was analyzed.

Arguments

  • analyzer_arn: The ARN of the analyzer to retrieve information from.
  • resource_arn: The ARN of the resource to retrieve information about.
Main.Accessanalyzer.get_analyzerMethod
get_analyzer(analyzer_name)
get_analyzer(analyzer_name, params::Dict{String,<:Any})

Retrieves information about the specified analyzer.

Arguments

  • analyzer_name: The name of the analyzer retrieved.
Main.Accessanalyzer.get_archive_ruleMethod
get_archive_rule(analyzer_name, rule_name)
get_archive_rule(analyzer_name, rule_name, params::Dict{String,<:Any})

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.

Arguments

  • analyzer_name: The name of the analyzer to retrieve rules from.
  • rule_name: The name of the rule to retrieve.
Main.Accessanalyzer.get_findingMethod
get_finding(analyzer_arn, id)
get_finding(analyzer_arn, id, params::Dict{String,<:Any})

Retrieves information about the specified finding.

Arguments

  • analyzer_arn: The ARN of the analyzer that generated the finding.
  • id: The ID of the finding to retrieve.
Main.Accessanalyzer.get_generated_policyMethod
get_generated_policy(job_id)
get_generated_policy(job_id, params::Dict{String,<:Any})

Retrieves the policy that was generated using StartPolicyGeneration.

Arguments

  • job_id: The JobId that is returned by the StartPolicyGeneration operation. The JobId can be used with GetGeneratedPolicy to retrieve the generated policies or used with CancelPolicyGeneration to cancel the policy generation request.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "includeResourcePlaceholders": The level of detail that you want to generate. You can specify whether to generate policies with placeholders for resource ARNs for actions that support resource level granularity in policies. For example, in the resource section of a policy, you can receive a placeholder such as "Resource":"arn:aws:s3:::{BucketName}" instead of "*".
  • "includeServiceLevelTemplate": The level of detail that you want to generate. You can specify whether to generate service-level policies. IAM Access Analyzer uses iam:servicelastaccessed to identify services that have been used recently to create this service-level template.
Main.Accessanalyzer.list_access_preview_findingsMethod
list_access_preview_findings(access_preview_id, analyzer_arn)
list_access_preview_findings(access_preview_id, analyzer_arn, params::Dict{String,<:Any})

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

Arguments

  • access_preview_id: The unique ID for the access preview.
  • analyzer_arn: The ARN of the analyzer used to generate the access.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "filter": Criteria to filter the returned findings.
  • "maxResults": The maximum number of results to return in the response.
  • "nextToken": A token used for pagination of results returned.
Main.Accessanalyzer.list_access_previewsMethod
list_access_previews(analyzer_arn)
list_access_previews(analyzer_arn, params::Dict{String,<:Any})

Retrieves a list of access previews for the specified analyzer.

Arguments

  • analyzer_arn: The ARN of the analyzer used to generate the access preview.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return in the response.
  • "nextToken": A token used for pagination of results returned.
Main.Accessanalyzer.list_analyzed_resourcesMethod
list_analyzed_resources(analyzer_arn)
list_analyzed_resources(analyzer_arn, params::Dict{String,<:Any})

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

Arguments

  • analyzer_arn: The ARN of the analyzer to retrieve a list of analyzed resources from.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return in the response.
  • "nextToken": A token used for pagination of results returned.
  • "resourceType": The type of resource.
Main.Accessanalyzer.list_analyzersMethod
list_analyzers()
list_analyzers(params::Dict{String,<:Any})

Retrieves a list of analyzers.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return in the response.
  • "nextToken": A token used for pagination of results returned.
  • "type": The type of analyzer.
Main.Accessanalyzer.list_archive_rulesMethod
list_archive_rules(analyzer_name)
list_archive_rules(analyzer_name, params::Dict{String,<:Any})

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

Arguments

  • analyzer_name: The name of the analyzer to retrieve rules from.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return in the request.
  • "nextToken": A token used for pagination of results returned.
Main.Accessanalyzer.list_findingsMethod
list_findings(analyzer_arn)
list_findings(analyzer_arn, params::Dict{String,<:Any})

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.

Arguments

  • analyzer_arn: The ARN of the analyzer to retrieve findings from.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "filter": A filter to match for the findings to return.
  • "maxResults": The maximum number of results to return in the response.
  • "nextToken": A token used for pagination of results returned.
  • "sort": The sort order for the findings returned.
Main.Accessanalyzer.list_policy_generationsMethod
list_policy_generations()
list_policy_generations(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return in the response.
  • "nextToken": A token used for pagination of results returned.
  • "principalArn": The ARN of the IAM entity (user or role) for which you are generating a policy. Use this with ListGeneratedPolicies to filter the results to only include results for a specific principal.
Main.Accessanalyzer.list_tags_for_resourceMethod
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

Retrieves a list of tags applied to the specified resource.

Arguments

  • resource_arn: The ARN of the resource to retrieve tags from.
Main.Accessanalyzer.start_policy_generationMethod
start_policy_generation(policy_generation_details)
start_policy_generation(policy_generation_details, params::Dict{String,<:Any})

Starts the policy generation request.

Arguments

  • policy_generation_details: Contains the ARN of the IAM entity (user or role) for which you are generating a policy.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.
  • "cloudTrailDetails": A CloudTrailDetails object that contains details about a Trail that you want to analyze to generate policies.
Main.Accessanalyzer.start_resource_scanMethod
start_resource_scan(analyzer_arn, resource_arn)
start_resource_scan(analyzer_arn, resource_arn, params::Dict{String,<:Any})

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

Arguments

  • analyzer_arn: The ARN of the analyzer to use to scan the policies applied to the specified resource.
  • resource_arn: The ARN of the resource to scan.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "resourceOwnerAccount": The Amazon Web Services account ID that owns the resource. For most Amazon Web Services resources, the owning account is the account in which the resource was created.
Main.Accessanalyzer.tag_resourceMethod
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

Adds a tag to the specified resource.

Arguments

  • resource_arn: The ARN of the resource to add the tag to.
  • tags: The tags to add to the resource.
Main.Accessanalyzer.untag_resourceMethod
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

Removes a tag from the specified resource.

Arguments

  • resource_arn: The ARN of the resource to remove the tag from.
  • tag_keys: The key for the tag to add.
Main.Accessanalyzer.update_archive_ruleMethod
update_archive_rule(analyzer_name, filter, rule_name)
update_archive_rule(analyzer_name, filter, rule_name, params::Dict{String,<:Any})

Updates the criteria and values for the specified archive rule.

Arguments

  • analyzer_name: The name of the analyzer to update the archive rules for.
  • filter: A filter to match for the rules to update. Only rules that match the filter are updated.
  • rule_name: The name of the rule to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A client token.
Main.Accessanalyzer.update_findingsMethod
update_findings(analyzer_arn, status)
update_findings(analyzer_arn, status, params::Dict{String,<:Any})

Updates the status for the specified findings.

Arguments

  • analyzer_arn: The ARN of the analyzer that generated the findings to update.
  • status: The state represents the action to take to update the finding Status. Use ARCHIVE to change an Active finding to an Archived finding. Use ACTIVE to change an Archived finding to an Active finding.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A client token.
  • "ids": The IDs of the findings to update.
  • "resourceArn": The ARN of the resource identified in the finding.
Main.Accessanalyzer.validate_policyMethod
validate_policy(policy_document, policy_type)
validate_policy(policy_document, policy_type, params::Dict{String,<:Any})

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.

Arguments

  • policy_document: The JSON policy document to use as the content for the policy.
  • policy_type: The type of policy to validate. Identity policies grant permissions to IAM principals. Identity policies include managed and inline policies for IAM roles, users, and groups. They also include service-control policies (SCPs) that are attached to an Amazon Web Services organization, organizational unit (OU), or an account. Resource policies grant permissions on Amazon Web Services resources. Resource policies include trust policies for IAM roles and bucket policies for Amazon S3 buckets. You can provide a generic input such as identity policy or resource policy or a specific input such as managed policy or Amazon S3 bucket policy.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "locale": The locale to use for localizing the findings.
  • "maxResults": The maximum number of results to return in the response.
  • "nextToken": A token used for pagination of results returned.
  • "validatePolicyResourceType": The type of resource to attach to your resource policy. Specify a value for the policy validation resource type only if the policy type is RESOURCE_POLICY. For example, to validate a resource policy to attach to an Amazon S3 bucket, you can choose AWS::S3::Bucket for the policy validation resource type. For resource types not supported as valid values, IAM Access Analyzer runs policy checks that apply to all resource policies. For example, to validate a resource policy to attach to a KMS key, do not specify a value for the policy validation resource type and IAM Access Analyzer will run policy checks that apply to all resource policies.