AWS HealthLake · Example Payload

Listfhirimportjobs

Lists all FHIR import jobs associated with an account and their statuses.

HealthcareFHIRHealth DataClinical DataHIPAAInteroperabilityNLPMedicalHL7

Listfhirimportjobs is an example object payload from AWS HealthLake, with 5 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

namedescriptionoperationIdrequestresponse

Example Payload

{
  "name": "ListFHIRImportJobs Example",
  "description": "<p> Lists all FHIR import jobs associated with an account and their statuses. </p>",
  "operationId": "listFHIRImportJobs",
  "request": {
    "headers": {
      "Content-Type": "application/x-amz-json-1.0",
      "X-Amz-Target": "HealthLake.ListFHIRImportJobs",
      "X-Amz-Date": "20240115T103000Z",
      "Authorization": "AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240115/us-east-1/healthlake/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=example"
    },
    "body": {
      "DatastoreId": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
      "NextToken": "example-nexttoken",
      "MaxResults": 1,
      "JobName": "my-import-job",
      "JobStatus": "SUBMITTED",
      "SubmittedBefore": "2024-01-15T10:30:00Z",
      "SubmittedAfter": "2024-01-15T10:30:00Z"
    }
  },
  "response": {
    "statusCode": 200,
    "headers": {
      "Content-Type": "application/x-amz-json-1.0"
    },
    "body": {
      "ImportJobPropertiesList": [
        {
          "JobId": "job-a1b2c3d4e5f6a1b2c3d4",
          "JobName": "my-import-job",
          "JobStatus": "SUBMITTED",
          "SubmitTime": "2024-01-15T10:30:00Z",
          "EndTime": "2024-01-15T10:30:00Z",
          "DatastoreId": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
          "InputDataConfig": {
            "S3Uri": "s3://my-bucket/prefix/"
          },
          "JobOutputDataConfig": {
            "S3Configuration": {
              "S3Uri": "example-string",
              "KmsKeyId": "example-string"
            }
          },
          "JobProgressReport": {
            "TotalNumberOfScannedFiles": 1,
            "TotalSizeOfScannedFilesInMB": "example",
            "TotalNumberOfImportedFiles": 1,
            "TotalNumberOfResourcesScanned": 1,
            "TotalNumberOfResourcesImported": 1,
            "TotalNumberOfResourcesWithCustomerError": 1,
            "TotalNumberOfFilesReadWithCustomerError": 1,
            "Throughput": "example"
          },
          "DataAccessRoleArn": "arn:aws:iam::123456789012:role/HealthLakeRole",
          "Message": "Example error message"
        }
      ],
      "NextToken": "example-nexttoken"
    }
  }
}