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.

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'
    }
}

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.

Exceptions