Amazon IAM Access Analyzer · JSON Structure

Iam Access Analyzer Policy Generation Structure

Contains details about the policy generation status and properties.

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

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

Properties

jobId principalArn status startedOn completedOn

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-policy-generation-structure.json",
  "name": "PolicyGeneration",
  "description": "Contains details about the policy generation status and properties.",
  "type": "object",
  "properties": {
    "jobId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/JobId"
        },
        {
          "description": "The <code>JobId</code> that is returned by the <code>StartPolicyGeneration</code> operation. The <code>JobId</code> can be used with <code>GetGeneratedPolicy</code> to retrieve the generated policies or used with <code>CancelPolicyGeneration</code> to cancel the policy generation request."
        }
      ]
    },
    "principalArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PrincipalArn"
        },
        {
          "description": "The ARN of the IAM entity (user or role) for which you are generating a policy."
        }
      ]
    },
    "status": {
      "allOf": [
        {
          "$ref": "#/components/schemas/JobStatus"
        },
        {
          "description": "The status of the policy generation request."
        }
      ]
    },
    "startedOn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "A timestamp of when the policy generation started."
        }
      ]
    },
    "completedOn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "A timestamp of when the policy generation was completed."
        }
      ]
    }
  },
  "required": [
    "jobId",
    "principalArn",
    "status",
    "startedOn"
  ]
}