/archive-rule

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

/policy/generation/{jobId}

Cancels the requested policy generation.

• jobId (path, required) — 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.

/finding/{id}#analyzerArn

Retrieves information about the specified finding.

• analyzerArn (query, required) — The ARN of the analyzer that generated the finding.
• id (path, required) — The ID of the finding to retrieve.

/access-preview/{accessPreviewId}

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

• accessPreviewId (path, required) — The unique ID for the access preview.
• maxResults (query, limit) — Pagination limit
• nextToken (query) — Pagination token

/policy/generation/{jobId}

Retrieves the policy that was generated using StartPolicyGeneration .

• jobId (path, required) — 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.
• includeResourcePlaceholders (query) — 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 (query) — 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.

/access-preview

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

/analyzer

Creates an analyzer for your account.

/analyzer

Retrieves a list of analyzers.

• nextToken (query) — A token used for pagination of results returned.
• maxResults (query, limit) — The maximum number of results to return in the response.
• type (query) — The type of analyzer.

/analyzer/{analyzerName}/archive-rule

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 .

• analyzerName (path, required) — The name of the created analyzer.

/analyzer/{analyzerName}/archive-rule

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

• analyzerName (path, required) — The name of the analyzer to retrieve rules from.
• nextToken (query) — A token used for pagination of results returned.
• maxResults (query, limit) — The maximum number of results to return in the request.

/analyzer/{analyzerName}

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.

• analyzerName (path, required) — The name of the analyzer to delete.
• clientToken (query) — A client token.

/analyzer/{analyzerName}

Retrieves information about the specified analyzer.

• analyzerName (path, required) — The name of the analyzer retrieved.

/analyzer/{analyzerName}/archive-rule/{ruleName}

Deletes the specified archive rule.

• analyzerName (path, required) — The name of the analyzer that associated with the archive rule to delete.
• ruleName (path, required) — The name of the rule to delete.
• clientToken (query) — A client token.

/analyzer/{analyzerName}/archive-rule/{ruleName}

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 .

• analyzerName (path, required) — The name of the analyzer to retrieve rules from.
• ruleName (path, required) — The name of the rule to retrieve.

/analyzer/{analyzerName}/archive-rule/{ruleName}

Updates the criteria and values for the specified archive rule.

• analyzerName (path, required) — The name of the analyzer to update the archive rules for.
• ruleName (path, required) — The name of the rule to update.

/access-preview/{accessPreviewId}#analyzerArn

Retrieves information about an access preview for the specified analyzer.

• accessPreviewId (path, required) — The unique ID for the access preview.
• analyzerArn (query, required) — The ARN of the analyzer used to generate the access preview.

/analyzed-resource#analyzerArn&resourceArn

Retrieves information about a resource that was analyzed.

• analyzerArn (query, required) — The ARN of the analyzer to retrieve information from.
• resourceArn (query, required) — The ARN of the resource to retrieve information about.

/access-preview#analyzerArn

Retrieves a list of access previews for the specified analyzer.

• analyzerArn (query, required) — The ARN of the analyzer used to generate the access preview.
• nextToken (query) — A token used for pagination of results returned.
• maxResults (query, limit) — The maximum number of results to return in the response.

/analyzed-resource

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

• maxResults (query, limit) — Pagination limit
• nextToken (query) — Pagination token

/finding

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 .

• maxResults (query, limit) — Pagination limit
• nextToken (query) — Pagination token

/finding

Updates the status for the specified findings.

/policy/generation

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

• principalArn (query) — 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.
• maxResults (query, limit) — The maximum number of results to return in the response.
• nextToken (query) — A token used for pagination of results returned.

/policy/generation

Starts the policy generation request.

/tags/{resourceArn}

Retrieves a list of tags applied to the specified resource.

• resourceArn (path, required) — The ARN of the resource to retrieve tags from.

/tags/{resourceArn}

Adds a tag to the specified resource.

• resourceArn (path, required) — The ARN of the resource to add the tag to.

/resource/scan

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

/tags/{resourceArn}#tagKeys

Removes a tag from the specified resource.

• resourceArn (path, required) — The ARN of the resource to remove the tag from.
• tagKeys (query, required) — The key for the tag to add.

/policy/validation

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.

• maxResults (query, limit) — The maximum number of results to return in the response.
• nextToken (query) — A token used for pagination of results returned.