Amazon HealthLake · JSON Structure

Healthlake List Fhir Export Jobs Request Structure

Type: object Properties: 7 Required: 1
FHIRHealth DataHealthcareHIPAACloud Computing

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

Properties

DatastoreId NextToken MaxResults JobName JobStatus SubmittedBefore SubmittedAfter

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-list-fhir-export-jobs-request-schema.json",
  "name": "ListFHIRExportJobsRequest",
  "type": "object",
  "required": [
    "DatastoreId"
  ],
  "properties": {
    "DatastoreId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DatastoreId"
        },
        {
          "description": " This parameter limits the response to the export job with the specified data store ID. "
        }
      ]
    },
    "NextToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NextToken"
        },
        {
          "description": " A pagination token used to identify the next page of results to return for a ListFHIRExportJobs query. "
        }
      ]
    },
    "MaxResults": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MaxResultsInteger"
        },
        {
          "description": " This parameter limits the number of results returned for a ListFHIRExportJobs to a maximum quantity specified by the user. "
        }
      ]
    },
    "JobName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/JobName"
        },
        {
          "description": " This parameter limits the response to the export job with the specified job name. "
        }
      ]
    },
    "JobStatus": {
      "allOf": [
        {
          "$ref": "#/components/schemas/JobStatus"
        },
        {
          "description": " This parameter limits the response to the export jobs with the specified job status. "
        }
      ]
    },
    "SubmittedBefore": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": " This parameter limits the response to FHIR export jobs submitted before a user specified date. "
        }
      ]
    },
    "SubmittedAfter": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": " This parameter limits the response to FHIR export jobs submitted after a user specified date. "
        }
      ]
    }
  }
}