Amazon HealthLake · JSON Structure

Healthlake Export Job Properties Structure

The properties of a FHIR export job, including the ID, ARN, name, and the status of the job.

Type: object Properties: 9 Required: 5
FHIRHealth DataHealthcareHIPAACloud Computing

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

Properties

JobId JobName JobStatus SubmitTime EndTime DatastoreId OutputDataConfig DataAccessRoleArn Message

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-healthlake/refs/heads/main/json-schema/healthlake-export-job-properties-schema.json",
  "name": "ExportJobProperties",
  "type": "object",
  "required": [
    "JobId",
    "JobStatus",
    "SubmitTime",
    "DatastoreId",
    "OutputDataConfig"
  ],
  "properties": {
    "JobId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/JobId"
        },
        {
          "description": "The AWS generated ID for an export job."
        }
      ]
    },
    "JobName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/JobName"
        },
        {
          "description": "The user generated name for an export job."
        }
      ]
    },
    "JobStatus": {
      "allOf": [
        {
          "$ref": "#/components/schemas/JobStatus"
        },
        {
          "description": "The status of a FHIR export job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED, or FAILED."
        }
      ]
    },
    "SubmitTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The time an export job was initiated."
        }
      ]
    },
    "EndTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The time an export job completed."
        }
      ]
    },
    "DatastoreId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DatastoreId"
        },
        {
          "description": "The AWS generated ID for the data store from which files are being exported for an export job."
        }
      ]
    },
    "OutputDataConfig": {
      "allOf": [
        {
          "$ref": "#/components/schemas/OutputDataConfig"
        },
        {
          "description": "The output data configuration that was supplied when the export job was created."
        }
      ]
    },
    "DataAccessRoleArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IamRoleArn"
        },
        {
          "description": "The Amazon Resource Name used during the initiation of the job."
        }
      ]
    },
    "Message": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Message"
        },
        {
          "description": "An explanation of any errors that may have occurred during the export job."
        }
      ]
    }
  },
  "description": "The properties of a FHIR export job, including the ID, ARN, name, and the status of the job."
}