UpdateFindingsRequest

Updates findings with the new values provided in the request.

Access ControlComplianceIAMPolicy ManagementSecurity

Properties

Name Type Description
analyzerArn object
status object
ids object
resourceArn object
clientToken object
View JSON Schema on GitHub

JSON Schema

iam-access-analyzer-update-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-update-findings-request-schema.json",
  "title": "UpdateFindingsRequest",
  "description": "Updates findings with the new values provided in the request.",
  "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> that generated the findings to update."
        }
      ]
    },
    "status": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FindingStatusUpdate"
        },
        {
          "description": "The state represents the action to take to update the finding Status. Use <code>ARCHIVE</code> to change an Active finding to an Archived finding. Use <code>ACTIVE</code> to change an Archived finding to an Active finding."
        }
      ]
    },
    "ids": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FindingIdList"
        },
        {
          "description": "The IDs of the findings to update."
        }
      ]
    },
    "resourceArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ResourceArn"
        },
        {
          "description": "The ARN of the resource identified in the finding."
        }
      ]
    },
    "clientToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "A client token."
        }
      ]
    }
  },
  "required": [
    "analyzerArn",
    "status"
  ]
}