Amazon IAM Access Analyzer · JSON Structure

Iam Access Analyzer Update Findings Request Structure

Updates findings with the new values provided in the request.

Type: object Properties: 5 Required: 2
Access ControlComplianceIAMPolicy ManagementSecurity

UpdateFindingsRequest is a JSON Structure definition published by Amazon IAM Access Analyzer, describing 5 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

analyzerArn status ids resourceArn clientToken

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iam-access-analyzer/refs/heads/main/json-structure/iam-access-analyzer-update-findings-request-structure.json",
  "name": "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"
  ]
}