dicom_import_jobs

Creates, updates, deletes, gets or lists a dicom_import_jobs resource.

Overview

Name	dicom_import_jobs
Type	Resource
Id	aws.medical_imaging.dicom_import_jobs

Fields

The following fields are returned by SELECT queries:

get_dicom_import_job

Name	Datatype	Description
data_access_role_arn	string	The Amazon Resource Name (ARN) that grants permissions to access medical imaging resources. (pattern: <code>arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+</code>)
datastore_id	string	The data store identifier. (pattern: <code>[0-9a-z]{32}</code>)
ended_at	string (date-time)	The timestamp for when the import job was ended.
import_configuration	object	The object containing DicomJsonMetadataImportConfiguration.
input_s3_uri	string	The input prefix path for the S3 bucket that contains the DICOM P10 files to be imported. (pattern: <code>s3:​//[a-z0-9][.-a-z0-9]{1,61}[a-z0-9](/.*)?</code>)
job_id	string	The import job identifier. (pattern: <code>[0-9a-z]+</code>)
job_name	string	The import job name. (pattern: <code>[A-Za-z0-9._/#-]+</code>)
job_status	string	The filters for listing import jobs based on status. (SUBMITTED, IN_PROGRESS, COMPLETED, FAILED)
message	string	The error message thrown if an import job fails. (pattern: <code>[\w -:`]+</code>)
output_s3_uri	string	The output prefix of the S3 bucket to upload the results of the DICOM import job. (pattern: <code>s3:​//[a-z0-9][.-a-z0-9]{1,61}[a-z0-9](/.*)?</code>)
submitted_at	string (date-time)	The timestamp for when the import job was submitted.

list_dicom_import_jobs

Name	Datatype	Description
data_access_role_arn	string	The Amazon Resource Name (ARN) that grants permissions to access medical imaging resources. (pattern: <code>arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+</code>)
datastore_id	string	The data store identifier. (pattern: <code>[0-9a-z]{32}</code>)
ended_at	string (date-time)	The timestamp when an import job ended.
job_id	string	The import job identifier. (pattern: <code>[0-9a-z]+</code>)
job_name	string	The import job name. (pattern: <code>[A-Za-z0-9._/#-]+</code>)
job_status	string	The filters for listing import jobs based on status. (SUBMITTED, IN_PROGRESS, COMPLETED, FAILED)
message	string	The error message thrown if an import job fails. (pattern: <code>[\w -:`]+</code>)
submitted_at	string (date-time)	The timestamp when an import job was submitted.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_dicom_import_job	select	datastore_id, job_id, region		Get the import job properties to learn more about the job or job progress. The jobStatus refers to the execution of the import job. Therefore, an import job can return a jobStatus as COMPLETED even if validation issues are discovered during the import process. If a jobStatus returns as COMPLETED, we still recommend you review the output manifests written to S3, as they provide details on the success or failure of individual P10 object imports.
list_dicom_import_jobs	select	datastore_id, region	jobStatus, nextToken, maxResults	List import jobs created for a specific data store.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
datastore_id	string	The data store identifier.
job_id	string	The import job identifier.
region	string	AWS region (default: us-east-1)
jobStatus	string	The filters for listing import jobs based on status.
maxResults	integer	The max results count. The upper bound is determined by load testing.
nextToken	string	The pagination token used to request the list of import jobs on the next page.

SELECT examples

get_dicom_import_job

Get the import job properties to learn more about the job or job progress. The jobStatus refers to the execution of the import job. Therefore, an import job can return a jobStatus as COMPLETED even if validation issues are discovered during the import process. If a jobStatus returns as COMPLETED, we still recommend you review the output manifests written to S3, as they provide details on the success or failure of individual P10 object imports.

SELECT
data_access_role_arn,
datastore_id,
ended_at,
import_configuration,
input_s3_uri,
job_id,
job_name,
job_status,
message,
output_s3_uri,
submitted_at
FROM aws.medical_imaging.dicom_import_jobs
WHERE datastore_id = '{{ datastore_id }}' -- required
AND job_id = '{{ job_id }}' -- required
AND region = '{{ region }}' -- required
;

list_dicom_import_jobs

List import jobs created for a specific data store.

SELECT
data_access_role_arn,
datastore_id,
ended_at,
job_id,
job_name,
job_status,
message,
submitted_at
FROM aws.medical_imaging.dicom_import_jobs
WHERE datastore_id = '{{ datastore_id }}' -- required
AND region = '{{ region }}' -- required
AND jobStatus = '{{ jobStatus }}'
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;