Amazon Web Services Policy API

The Policy API from Amazon Web Services — 9 operation(s) for policy.

OpenAPI Specification

amazon-web-services-policy-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Web Services accessanalyzer 2012 09 25 Policy API
  description: <p>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.</p> <p> <b>External access analyzers</b> 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.</p> <p> <b>Unused access analyzers</b> 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.</p> <p>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. </p> <p>This guide describes the IAM Access Analyzer operations that you can call programmatically. For general information about IAM Access Analyzer, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/what-is-access-analyzer.html">Identity and Access Management Access Analyzer</a> in the <b>IAM User Guide</b>.</p>
tags:
- name: Policy
paths:
  /policy/generation/{jobId}:
    GET:
      summary: Amazon Web Services Getgeneratedpolicy
      description: 'Retrieves the policy that was generated using StartPolicyGeneration. '
      operationId: amazonWebServicesGetGeneratedPolicy
      tags:
      - Policy
  /policy/check-access-not-granted:
    POST:
      summary: Amazon Web Services Checkaccessnotgranted
      description: Checks whether the specified access isn't allowed by a policy.
      operationId: amazonWebServicesCheckAccessNotGranted
      tags:
      - Policy
  /policy/check-no-new-access:
    POST:
      summary: Amazon Web Services Checknonewaccess
      description: 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.
      operationId: amazonWebServicesCheckNoNewAccess
      tags:
      - Policy
  /policy/generation:
    PUT:
      summary: Amazon Web Services Startpolicygeneration
      description: Starts the policy generation request.
      operationId: amazonWebServicesStartPolicyGeneration
      tags:
      - Policy
  /policy/validation:
    POST:
      summary: Amazon Web Services Validatepolicy
      description: '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. '
      operationId: amazonWebServicesValidatePolicy
      tags:
      - Policy
  /policy/{resourceArn}/:
    PUT:
      summary: Amazon Web Services Updateresourcepolicy
      description: Replaces the existing resource policy for a bot or bot alias with a new one. If the policy doesn't exist, Amazon Lex returns an exception.
      operationId: amazonWebServicesUpdateResourcePolicy
      tags:
      - Policy
  /policy/{resourceArn}/statements/:
    POST:
      summary: Amazon Web Services Createresourcepolicystatement
      description: Adds a new resource policy statement to a bot or bot alias. If a resource policy exists, the statement is added to the current resource policy. If a policy doesn't exist, a new policy is created. You can't create a resource policy statement that allows cross-account access.
      operationId: amazonWebServicesCreateResourcePolicyStatement
      tags:
      - Policy
  /policy/{resourceArn}/statements/{statementId}/:
    DELETE:
      summary: Amazon Web Services Deleteresourcepolicystatement
      description: Deletes a policy statement from a resource policy. If you delete the last statement from a policy, the policy is deleted. If you specify a statement ID that doesn't exist in the policy, or if the bot or bot alias doesn't have a policy attached, Amazon Lex returns an exception.
      operationId: amazonWebServicesDeleteResourcePolicyStatement
      tags:
      - Policy
  /v1/policy:
    PUT:
      summary: Amazon Web Services Putresourcepolicy
      description: The name of the policy.
      operationId: amazonWebServicesPutResourcePolicy
      tags:
      - Policy