AWS Health Imaging

{'jobProperties': {'importConfiguration': {'dicomJsonMetadataImportConfiguration': {'dicomMetadataMappings': [{'metadataFilePath': 'string',
                                                                                                               'seriesInstanceUID': 'string',
                                                                                                               'studyInstanceUID': 'string'}]}}}}

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

See also: AWS API Documentation

Request Syntax

client.get_dicom_import_job(
    datastoreId='string',
    jobId='string'
)

type datastoreId:

string

param datastoreId:

[REQUIRED]

The data store identifier.

type jobId:

string

param jobId:

[REQUIRED]

The import job identifier.

rtype:

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.

      • 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.

{'importConfiguration': {'dicomJsonMetadataImportConfiguration': {'dicomMetadataMappings': [{'metadataFilePath': 'string',
                                                                                             'seriesInstanceUID': 'string',
                                                                                             'studyInstanceUID': 'string'}]}}}

Start importing bulk data into an ACTIVE data store. The import job imports DICOM P10 files or enhances existing DICOM files with JSON metadata. The importConfiguration parameter specifies the import type. The data is found in the S3 prefix specified by the inputS3Uri parameter. The import job stores processing results in the file specified by the outputS3Uri parameter.

See also: AWS API Documentation

Request Syntax

client.start_dicom_import_job(
    jobName='string',
    dataAccessRoleArn='string',
    clientToken='string',
    datastoreId='string',
    inputS3Uri='string',
    outputS3Uri='string',
    inputOwnerAccountId='string',
    importConfiguration={
        'dicomJsonMetadataImportConfiguration': {
            'dicomMetadataMappings': [
                {
                    'studyInstanceUID': 'string',
                    'seriesInstanceUID': 'string',
                    'metadataFilePath': 'string'
                },
            ]
        }
    }
)

type jobName:

string

param jobName:

The import job name.

type dataAccessRoleArn:

string

param dataAccessRoleArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the IAM role that grants permission to access medical imaging resources.

type clientToken:

string

param clientToken:

[REQUIRED]

A unique identifier for API idempotency.

This field is autopopulated if not provided.

type datastoreId:

string

param datastoreId:

[REQUIRED]

The data store identifier.

type inputS3Uri:

string

param inputS3Uri:

[REQUIRED]

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

type outputS3Uri:

string

param outputS3Uri:

[REQUIRED]

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

type inputOwnerAccountId:

string

param inputOwnerAccountId:

The account ID of the source S3 bucket owner.

type importConfiguration:

dict

param importConfiguration:

The import configuration for the import job.

• dicomJsonMetadataImportConfiguration (dict) --

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

  • dicomMetadataMappings (list) -- [REQUIRED]

    Maps DCM files to their metadata.

    • (dict) --

      Maps DCM files to their metadata.

      • studyInstanceUID (string) -- [REQUIRED]

        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) -- [REQUIRED]

        The path to the JSON metadata file relative to inputS3Uri.

rtype:

dict

returns:

Response Syntax

{
    'datastoreId': 'string',
    'jobId': 'string',
    'jobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED',
    'submittedAt': datetime(2015, 1, 1)
}

Response Structure

• (dict) --

  • datastoreId (string) --

    The data store identifier.

  • jobId (string) --

    The import job identifier.

  • jobStatus (string) --

    The import job status.

  • submittedAt (datetime) --

    The timestamp when the import job was submitted.