HealthImaging / Client / get_dicom_import_job

get_dicom_import_job

HealthImaging.Client.get_dicom_import_job(**kwargs)

Get the import job properties to learn more about the job or job progress.

Note

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.

See also: AWS API Documentation

Request Syntax

response = client.get_dicom_import_job(
    datastoreId='string',
    jobId='string'
)
Parameters:

  • datastoreId (string) –

    [REQUIRED]

    The data store identifier.

  • jobId (string) –

    [REQUIRED]

    The import job identifier.

Return type:

dict

Returns:

Response Syntax

{
    'jobProperties': {
        'jobId': 'string',
        'jobName': 'string',
        'jobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED',
        'datastoreId': 'string',
        'dataAccessRoleArn': 'string',
        'endedAt': datetime(2015, 1, 1),
        'submittedAt': datetime(2015, 1, 1),
        'inputS3Uri': 'string',
        'outputS3Uri': 'string',
        'message': 'string',
        'importConfiguration': {
            'dicomJsonMetadataImportConfiguration': {
                'dicomMetadataMappings': [
                    {
                        'studyInstanceUID': 'string',
                        'seriesInstanceUID': 'string',
                        'metadataFilePath': 'string'
                    },
                ]
            }
        }
    }
}

Response Structure

  • (dict) –

    • jobProperties (dict) –

      The properties of the import job.

      • jobId (string) –

        The import job identifier.

      • jobName (string) –

        The import job name.

      • jobStatus (string) –

        The filters for listing import jobs based on status.

      • datastoreId (string) –

        The data store identifier.

      • dataAccessRoleArn (string) –

        The Amazon Resource Name (ARN) that grants permissions to access medical imaging resources.

      • endedAt (datetime) –

        The timestamp for when the import job was ended.

      • submittedAt (datetime) –

        The timestamp for when the import job was submitted.

      • inputS3Uri (string) –

        The input prefix path for the S3 bucket that contains the DICOM P10 files to be imported.

      • outputS3Uri (string) –

        The output prefix of the S3 bucket to upload the results of the DICOM import job.

      • message (string) –

        The error message thrown if an import job fails.

      • importConfiguration (dict) –

        The object containing DicomJsonMetadataImportConfiguration.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: dicomJsonMetadataImportConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

        • dicomJsonMetadataImportConfiguration (dict) –

          The configuration parameters that are specific to DICOM JSON metadata import operations.

          • dicomMetadataMappings (list) –

            Maps DCM files to their metadata.

            • (dict) –

              Maps DCM files to their metadata.

              • studyInstanceUID (string) –

                The Study Instance UID that identifies the study.

              • seriesInstanceUID (string) –

                The Series Instance UID that identifies the series. This parameter is optional because the mapping might be at the study level.

              • metadataFilePath (string) –

                The path to the JSON metadata file relative to inputS3Uri.

Exceptions