HealthImaging / Client / start_dicom_import_job

start_dicom_import_job

HealthImaging.Client.start_dicom_import_job(**kwargs)

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

response = 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'
                },
            ]
        }
    }
)
Parameters:

  • jobName (string) – The import job name.

  • dataAccessRoleArn (string) –

    [REQUIRED]

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

  • clientToken (string) –

    [REQUIRED]

    A unique identifier for API idempotency.

    This field is autopopulated if not provided.

  • datastoreId (string) –

    [REQUIRED]

    The data store identifier.

  • inputS3Uri (string) –

    [REQUIRED]

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

  • outputS3Uri (string) –

    [REQUIRED]

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

  • inputOwnerAccountId (string) – The account ID of the source S3 bucket owner.

  • importConfiguration (dict) –

    The import configuration for the import job.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: dicomJsonMetadataImportConfiguration.

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

Return type:

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.

Exceptions