Amazon Web Services, Inc.

Access Analyzer

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

Identity & security#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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, internal, 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, internal, or unused access, you first need to create an analyzer. External access analyzers help you 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. Internal access analyzers help you identify which principals within your organization or account have access to selected resources. This analysis supports implementing the principle of least privilege by ensuring that your specified resources can only be accessed by the intended principals within your organization. Unused access analyzers help you 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 Using Identity and Access Management Access Analyzer in the IAM User Guide .

Endpoints 39

Analyzer

  • GETList analyzers/analyzer?nextToken=string&maxResults=0&type=stringRetrieves a list of analyzers.
  • PUTCreate analyzer/analyzerCreates an analyzer for your account.
  • GETGet analyzer/analyzer/:analyzerNameRetrieves information about the specified analyzer.
  • PUTUpdate analyzer/analyzer/:analyzerNameModifies the configuration of an existing analyzer. This action is not supported for external access analyzers.
  • DELETEDelete analyzer/analyzer/:analyzerName?clientToken=stringDeletes the specified analyzer. When you delete an analyzer, IAM Access Analyzer is disabled for the account or organization in the current or specific…
  • DELETEDelete service linked analyzer/service-linked-analyzer/:analyzerName?clientToken=stringDeletes a service-linked analyzer. This operation can be invoked by both authorized Amazon Web Services services and customers. When invoked by a customer,…

Archive rule

  • GETList archive rules/analyzer/:analyzerName/archive-rule?nextToken=string&maxResults=0Retrieves a list of archive rules created for the specified analyzer.
  • PUTCreate archive rule/analyzer/:analyzerName/archive-ruleCreates an archive rule for the specified analyzer. Archive rules automatically archive new findings that meet the criteria you define when you create the…
  • GETGet archive rule/analyzer/:analyzerName/archive-rule/:ruleNameRetrieves 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…
  • PUTUpdate archive rule/analyzer/:analyzerName/archive-rule/:ruleNameUpdates the criteria and values for the specified archive rule.
  • DELETEDelete archive rule/analyzer/:analyzerName/archive-rule/:ruleName?clientToken=stringDeletes the specified archive rule.
  • PUTApply archive rule/archive-ruleRetroactively applies the archive rule to existing findings that meet the archive rule criteria.
  • GETGet generated policy/policy/generation/:jobId?includeResourcePlaceholders=true&includeServiceLevelTemplate=trueRetrieves the policy that was generated using StartPolicyGeneration .
  • PUTCancel policy generation/policy/generation/:jobIdCancels the requested policy generation.
  • POSTCheck access not granted/policy/check-access-not-grantedChecks whether the specified access isn't allowed by a policy.
  • POSTCheck no new access/policy/check-no-new-accessChecks 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…
  • POSTCheck no public access/policy/check-no-public-accessChecks whether a resource policy can grant public access to the specified resource type.
  • GETList access previews/access-preview?analyzerArn=string&nextToken=string&maxResults=0Retrieves a list of access previews for the specified analyzer.
  • PUTCreate access preview/access-previewCreates an access preview that allows you to preview IAM Access Analyzer findings for your resource before deploying resource permissions.
  • PUTCreate service linked analyzer/service-linked-analyzerCreates a service-linked analyzer managed by an Amazon Web Services service. This operation can only be invoked by authorized Amazon Web Services services.…
  • GETGet finding recommendation/recommendation/:id?analyzerArn=string&maxResults=0&nextToken=stringRetrieves information about a finding recommendation for the specified analyzer.
  • POSTGenerate finding recommendation/recommendation/:id?analyzerArn=stringCreates a recommendation for an unused permissions finding.
  • GETGet access preview/access-preview/:accessPreviewId?analyzerArn=stringRetrieves information about an access preview for the specified analyzer.
  • POSTList access preview findings/access-preview/:accessPreviewIdRetrieves a list of access preview findings generated by the specified access preview.
  • GETGet analyzed resource/analyzed-resource?analyzerArn=string&resourceArn=stringRetrieves information about a resource that was analyzed. This action is supported only for external access analyzers.
  • POSTList analyzed resources/analyzed-resourceRetrieves a list of resources of the specified type that have been analyzed by the specified analyzer.
  • GETGet finding/finding/:id?analyzerArn=stringRetrieves information about the specified finding. GetFinding and GetFindingV2 both use access-analyzer:GetFinding in the Action element of an IAM policy…
  • GETGet finding v2/findingv2/:id?analyzerArn=string&maxResults=0&nextToken=stringRetrieves information about the specified finding. GetFinding and GetFindingV2 both use access-analyzer:GetFinding in the Action element of an IAM policy…
  • POSTGet findings statistics/analyzer/findings/statisticsRetrieves a list of aggregated finding statistics for an external access or unused access analyzer.
  • PUTUpdate findings/findingUpdates the status for the specified findings.
  • POSTList findings/findingRetrieves a list of findings generated by the specified analyzer. ListFindings and ListFindingsV2 both use access-analyzer:ListFindings in the Action element…
  • POSTList findings v2/findingv2Retrieves a list of findings generated by the specified analyzer. ListFindings and ListFindingsV2 both use access-analyzer:ListFindings in the Action element…
  • GETList policy generations/policy/generation?principalArn=string&maxResults=0&nextToken=stringLists all of the policy generations requested in the last seven days.
  • PUTStart policy generation/policy/generationStarts the policy generation request.
  • GETList tags for resource/tags/:resourceArnRetrieves a list of tags applied to the specified resource.
  • POSTTag resource/tags/:resourceArnAdds a tag to the specified resource.
  • DELETEUntag resource/tags/:resourceArn?tagKeys=Removes a tag from the specified resource.
  • POSTStart resource scan/resource/scanImmediately starts a scan of the policies applied to the specified resource. This action is supported only for external access analyzers.
  • POSTValidate policy/policy/validation?maxResults=0&nextToken=stringRequests the validation of a policy and returns a list of findings. The findings help you identify issues and provide actionable recommendations to resolve…

API details

Base URL
https://access-analyzer.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
39 operations on 24 pathsGET 13POST 12PUT 10DELETE 4
Main resources
Analyzer 6Archive rule 5
Description format
AWS Smithy model, API version 2019-11-01

How to test the Access Analyzer in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Access Analyzer collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “List analyzers” (GET /analyzer?nextToken=string&maxResults=0&type=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Access Analyzer?

Identity and Access Management Access Analyzer helps you to set, verify, and refine your IAM policies by providing a suite of capabilities. Its features… It is listed under Identity & security and has 39 endpoints.

Who publishes the Access Analyzer?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Access Analyzer?

Requests go to https://access-analyzer.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Access Analyzer?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Access Analyzer have?

39 operations on 24 paths (13 GET, 12 POST, 10 PUT, 4 DELETE). The largest groups are Analyzer, Archive rule.

Is forking the Access Analyzer free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.