Amazon Web Services Policies API

The Policies API from Amazon Web Services — 6 operation(s) for policies.

OpenAPI Specification

amazon-web-services-policies-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Web Services accessanalyzer 2012 09 25 Policies 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: Policies
paths:
  /policies:
    GET:
      summary: Amazon Web Services Getlifecyclepolicies
      description: Gets summary information about all or the specified data lifecycle policies. To get complete information about a policy, use GetLifecyclePolicy.
      operationId: amazonWebServicesGetLifecyclePolicies
      tags:
      - Policies
  /policies/{policyId}:
    PATCH:
      summary: Amazon Web Services Updatelifecyclepolicy
      description: Updates the specified lifecycle policy. For more information about updating a policy, see Modify lifecycle policies.
      operationId: amazonWebServicesUpdateLifecyclePolicy
      tags:
      - Policies
  /{accountId}/policies/data-retrieval:
    PUT:
      summary: Amazon Web Services Setdataretrievalpolicy
      description: 'This operation sets and then enacts a data retrieval policy in the region specified in the PUT request. You can set one policy per region for an AWS account. The policy is enacted within a few minutes of a successful PUT operation. The set policy operation does not affect retrieval jobs that were in progress before the policy was enacted. For more information about data retrieval policies, see Amazon Glacier Data Retrieval Policies. '
      operationId: amazonWebServicesSetDataRetrievalPolicy
      tags:
      - Policies
  /policies/{policyName}:
    GET:
      summary: Amazon Web Services Getpolicy
      description: Gets information about the specified policy with the policy document of the default version. Requires permission to access the GetPolicy action.
      operationId: amazonWebServicesGetPolicy
      tags:
      - Policies
  /policies/{policyName}/version:
    GET:
      summary: Amazon Web Services Listpolicyversions
      description: Lists the versions of the specified policy and identifies the default version. Requires permission to access the ListPolicyVersions action.
      operationId: amazonWebServicesListPolicyVersions
      tags:
      - Policies
  /policies/{policyName}/version/{policyVersionId}:
    PATCH:
      summary: Amazon Web Services Setdefaultpolicyversion
      description: Sets the specified version of the specified policy as the policy's default (operative) version. This action affects all certificates to which the policy is attached. To list the principals the policy is attached to, use the ListPrincipalPolicies action. Requires permission to access the SetDefaultPolicyVersion action.
      operationId: amazonWebServicesSetDefaultPolicyVersion
      tags:
      - Policies