openapi: 3.1.0
info:
  title: Amazon Web Services accessanalyzer 2012 09 25 Indices 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: Indices
paths:
  /indices/{indexName}:
    GET:
      summary: Amazon Web Services Describeindex
      description: Describes a search index. Requires permission to access the DescribeIndex action.
      operationId: amazonWebServicesDescribeIndex
      tags:
      - Indices
  /indices/buckets:
    POST:
      summary: Amazon Web Services Getbucketsaggregation
      description: Aggregates on indexed data with search queries pertaining to particular fields.  Requires permission to access the GetBucketsAggregation action.
      operationId: amazonWebServicesGetBucketsAggregation
      tags:
      - Indices
  /indices/cardinality:
    POST:
      summary: Amazon Web Services Getcardinality
      description: Returns the approximate count of unique values that match the query. Requires permission to access the GetCardinality action.
      operationId: amazonWebServicesGetCardinality
      tags:
      - Indices
  /indices/percentiles:
    POST:
      summary: Amazon Web Services Getpercentiles
      description: 'Groups the aggregated values that match the query into percentile groupings. The default percentile groupings are: 1,5,25,50,75,95,99, although you can specify your own when you call GetPercentiles. This function returns a value for each percentile group specified (or the default percentile groupings). The percentile group "1" contains the aggregated field value that occurs in approximately one percent of the values that match the query. The percentile group "5" contains the aggregated field value that occurs in approximately five percent of the values that match the query, and so on. The result is an approximation, the more values that match the query, the more accurate the percentile values. Requires permission to access the GetPercentiles action.'
      operationId: amazonWebServicesGetPercentiles
      tags:
      - Indices
  /indices/statistics:
    POST:
      summary: Amazon Web Services Getstatistics
      description: Returns the count, average, sum, minimum, maximum, sum of squares, variance, and standard deviation for the specified aggregated field. If the aggregation field is of type String, only the count statistic is returned. Requires permission to access the GetStatistics action.
      operationId: amazonWebServicesGetStatistics
      tags:
      - Indices
  /indices:
    GET:
      summary: Amazon Web Services Listindices
      description: Lists the search indices. Requires permission to access the ListIndices action.
      operationId: amazonWebServicesListIndices
      tags:
      - Indices
  /indices/search:
    POST:
      summary: Amazon Web Services Searchindex
      description: The query search index. Requires permission to access the SearchIndex action.
      operationId: amazonWebServicesSearchIndex
      tags:
      - Indices