Amazon Web Services Findings API

openapi: 3.1.0
info:
  title: Amazon Web Services accessanalyzer 2012 09 25 Findings 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: Findings
paths:
  /findings/{scanName}:
    GET:
      summary: Amazon Web Services Getfindings
      description: Returns a list of all findings generated by a particular scan.
      operationId: amazonWebServicesGetFindings
      tags:
      - Findings
  /findings/details/batch/get:
    POST:
      summary: Amazon Web Services Batchgetfindingdetails
      description: Gets vulnerability details for findings.
      operationId: amazonWebServicesBatchGetFindingDetails
      tags:
      - Findings
  /findings/aggregation/list:
    POST:
      summary: Amazon Web Services Listfindingaggregations
      description: Lists aggregated finding data for your environment based on specific criteria.
      operationId: amazonWebServicesListFindingAggregations
      tags:
      - Findings
  /findings/list:
    POST:
      summary: Amazon Web Services Listfindings
      description: Lists findings for your environment.
      operationId: amazonWebServicesListFindings
      tags:
      - Findings
  /findings/sample:
    POST:
      summary: Amazon Web Services Createsamplefindings
      description: Creates sample findings.
      operationId: amazonWebServicesCreateSampleFindings
      tags:
      - Findings
  /findings/statistics:
    POST:
      summary: Amazon Web Services Getfindingstatistics
      description: Retrieves (queries) aggregated statistical data about findings.
      operationId: amazonWebServicesGetFindingStatistics
      tags:
      - Findings
  /findings/describe:
    POST:
      summary: Amazon Web Services Getfindings
      description: Retrieves the details of one or more findings.
      operationId: amazonWebServicesGetFindings
      tags:
      - Findings
  /findings/{findingId}/reveal:
    GET:
      summary: Amazon Web Services Getsensitivedataoccurrences
      description: Retrieves occurrences of sensitive data reported by a finding.
      operationId: amazonWebServicesGetSensitiveDataOccurrences
      tags:
      - Findings
  /findings/{findingId}/reveal/availability:
    GET:
      summary: Amazon Web Services Getsensitivedataoccurrencesavailability
      description: Checks whether occurrences of sensitive data can be retrieved for a finding.
      operationId: amazonWebServicesGetSensitiveDataOccurrencesAvailability
      tags:
      - Findings
  /findings:
    POST:
      summary: Amazon Web Services Listfindings
      description: Retrieves a subset of information about one or more findings.
      operationId: amazonWebServicesListFindings
      tags:
      - Findings
    PATCH:
      summary: Amazon Web Services Updatefindings
      description: ' UpdateFindings is deprecated. Instead of UpdateFindings, use BatchUpdateFindings. Updates the Note and RecordState of the Security Hub-aggregated findings that the filter attributes specify. Any member account that can view the finding also sees the update to the finding.'
      operationId: amazonWebServicesUpdateFindings
      tags:
      - Findings
  /findings/import:
    POST:
      summary: Amazon Web Services Batchimportfindings
      description: 'Imports security findings generated by a finding provider into Security Hub. This action is requested by the finding provider to import its findings into Security Hub.  BatchImportFindings must be called by one of the following:   The Amazon Web Services account that is associated with a finding if you are using the default product ARN or are a partner sending findings from within a customer''s Amazon Web Services account. In these cases, the identifier of the account that you are calling BatchImportFindings from needs to be the same as the AwsAccountId attribute for the finding.   An Amazon Web Services account that Security Hub has allow-listed for an official partner integration. In this case, you can call BatchImportFindings from the allow-listed account and send findings from different customer accounts in the same batch.   The maximum allowed size for a finding is 240 Kb. An error is returned for any finding larger than 240 Kb. After a finding is created, BatchImportFindings cannot be used to update the following finding fields and objects, which Security Hub customers use to manage their investigation workflow.    Note     UserDefinedFields     VerificationState     Workflow    Finding providers also should not use BatchImportFindings to update the following attributes.    Confidence     Criticality     RelatedFindings     Severity     Types    Instead, finding providers use FindingProviderFields to provide values for these attributes.'
      operationId: amazonWebServicesBatchImportFindings
      tags:
      - Findings
  /findings/batchupdate:
    PATCH:
      summary: Amazon Web Services Batchupdatefindings
      description: Used by Security Hub customers to update information about their investigation into a finding. Requested by administrator accounts or member accounts. Administrator accounts can update findings for their account and their member accounts. Member accounts can update findings for their account. Updates from BatchUpdateFindings do not affect the value of UpdatedAt for a finding. Administrator and member accounts can use BatchUpdateFindings to update the following finding fields and objects.    Confidence     Criticality     Note     RelatedFindings     Severity     Types     UserDefinedFields     VerificationState     Workflow    You can configure IAM policies to restrict access to fields and field values. For example, you might not want member accounts to be able to suppress findings or change the finding severity. See Configuring access to BatchUpdateFindings in the Security Hub User Guide.
      operationId: amazonWebServicesBatchUpdateFindings
      tags:
      - Findings