JobDetails

Contains details about the policy generation request.

Access ControlComplianceIAMPolicy ManagementSecurity

Properties

Name Type Description
jobId object
status object
startedOn object
completedOn object
jobError object
View JSON Schema on GitHub

JSON Schema

iam-access-analyzer-job-details-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-job-details-schema.json",
  "title": "JobDetails",
  "description": "Contains details about the policy generation request.",
  "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."
        }
      ]
    },
    "status": {
      "allOf": [
        {
          "$ref": "#/components/schemas/JobStatus"
        },
        {
          "description": "The status of the job request."
        }
      ]
    },
    "startedOn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "A timestamp of when the job was started."
        }
      ]
    },
    "completedOn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "A timestamp of when the job was completed."
        }
      ]
    },
    "jobError": {
      "allOf": [
        {
          "$ref": "#/components/schemas/JobError"
        },
        {
          "description": "The job error for the policy generation request."
        }
      ]
    }
  },
  "required": [
    "jobId",
    "status",
    "startedOn"
  ]
}