ListFindingsRequest

Retrieves a list of findings generated by the specified analyzer.

Access ControlComplianceIAMPolicy ManagementSecurity

Properties

Name Type Description
analyzerArn object
filter object
sort object
nextToken object
maxResults object
View JSON Schema on GitHub

JSON Schema

iam-access-analyzer-list-findings-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iam-access-analyzer/refs/heads/main/json-schema/iam-access-analyzer-list-findings-request-schema.json",
  "title": "ListFindingsRequest",
  "description": "Retrieves a list of findings generated by the specified analyzer.",
  "type": "object",
  "properties": {
    "analyzerArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AnalyzerArn"
        },
        {
          "description": "The <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources\">ARN of the analyzer</a> to retrieve findings from."
        }
      ]
    },
    "filter": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FilterCriteriaMap"
        },
        {
          "description": "A filter to match for the findings to return."
        }
      ]
    },
    "sort": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SortCriteria"
        },
        {
          "description": "The sort order for the findings returned."
        }
      ]
    },
    "nextToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Token"
        },
        {
          "description": "A token used for pagination of results returned."
        }
      ]
    },
    "maxResults": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Integer"
        },
        {
          "description": "The maximum number of results to return in the response."
        }
      ]
    }
  },
  "required": [
    "analyzerArn"
  ]
}