Amazon Web Services Group API

openapi: 3.1.0
info:
  title: Amazon Web Services accessanalyzer 2012 09 25 Group 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: Group
paths:
  /group/{groupIdentifier}/associate:
    PATCH:
      summary: Amazon Web Services Associateresource
      description: Associates a canary with a group. Using groups can help you with managing and automating your canaries, and you can also view aggregated run results and statistics for all canaries in a group.  You must run this operation in the Region where the canary exists.
      operationId: amazonWebServicesAssociateResource
      tags:
      - Group
  /group:
    POST:
      summary: Amazon Web Services Creategroup
      description: Creates a group which you can use to associate canaries with each other, including cross-Region canaries. Using groups can help you with managing and automating your canaries, and you can also view aggregated run results and statistics for all canaries in a group.  Groups are global resources. When you create a group, it is replicated across Amazon Web Services Regions, and you can view it and add canaries to it from any Region. Although the group ARN format reflects the Region name where it was created, a group is not constrained to any Region. This means that you can put canaries from multiple Regions into the same group, and then use that group to view and manage all of those canaries in a single view. Groups are supported in all Regions except the Regions that are disabled by default. For more information about these Regions, see Enabling a Region. Each group can contain as many as 10 canaries. You can have as many as 20 groups in your account. Any single canary can be a member of up to 10 groups.
      operationId: amazonWebServicesCreateGroup
      tags:
      - Group
  /group/{groupIdentifier}:
    GET:
      summary: Amazon Web Services Getgroup
      description: Returns information about one group. Groups are a global resource, so you can use this operation from any Region.
      operationId: amazonWebServicesGetGroup
      tags:
      - Group
  /group/{groupIdentifier}/disassociate:
    PATCH:
      summary: Amazon Web Services Disassociateresource
      description: Removes a canary from a group. You must run this operation in the Region where the canary exists.
      operationId: amazonWebServicesDisassociateResource
      tags:
      - Group
  /group/{groupIdentifier}/resources:
    POST:
      summary: Amazon Web Services Listgroupresources
      description: This operation returns a list of the ARNs of the canaries that are associated with the specified group.
      operationId: amazonWebServicesListGroupResources
      tags:
      - Group