Skip to content

DICOMImportJobProperties

Source code in docs_src/capo_medical_imaging/types/dicom_import_job_properties.py
class DICOMImportJobProperties(TypedDict, closed=True):
    job_id: "capo_medical_imaging.types.job_id.JobId"
    """<p>The import job identifier.</p>"""
    job_name: "capo_medical_imaging.types.job_name.JobName"
    """<p>The import job name.</p>"""
    job_status: "capo_medical_imaging.types.job_status.JobStatus"
    """<p>The filters for listing import jobs based on status.</p>"""
    datastore_id: "capo_medical_imaging.types.datastore_id.DatastoreId"
    """<p>The data store identifier.</p>"""
    data_access_role_arn: "capo_medical_imaging.types.role_arn.RoleArn"
    """<p>The Amazon Resource Name (ARN) that grants permissions to access medical imaging resources.</p>"""
    ended_at: NotRequired["capo_medical_imaging.types.date.Date"]
    """<p>The timestamp for when the import job was ended.</p>"""
    submitted_at: NotRequired["capo_medical_imaging.types.date.Date"]
    """<p>The timestamp for when the import job was submitted.</p>"""
    input_s3_uri: "capo_medical_imaging.types.s3_uri.S3Uri"
    """<p>The input prefix path for the S3 bucket that contains the DICOM P10 files to be imported.</p>"""
    output_s3_uri: "capo_medical_imaging.types.s3_uri.S3Uri"
    """<p>The output prefix of the S3 bucket to upload the results of the DICOM import job.</p>"""
    message: NotRequired["capo_medical_imaging.types.message.Message"]
    """<p>The error message thrown if an import job fails.</p>"""
    import_configuration: NotRequired[
        "capo_medical_imaging.types.import_configuration.ImportConfiguration"
    ]
    """<p>The object containing <code>DicomJsonMetadataImportConfiguration</code>.</p>"""

data_access_role_arn instance-attribute

data_access_role_arn: RoleArn

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

datastore_id instance-attribute

datastore_id: DatastoreId

The data store identifier.

ended_at instance-attribute

ended_at: NotRequired[Date]

The timestamp for when the import job was ended.

import_configuration instance-attribute

import_configuration: NotRequired[ImportConfiguration]

The object containing DicomJsonMetadataImportConfiguration.

input_s3_uri instance-attribute

input_s3_uri: S3Uri

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

job_id instance-attribute

job_id: JobId

The import job identifier.

job_name instance-attribute

job_name: JobName

The import job name.

job_status instance-attribute

job_status: JobStatus

The filters for listing import jobs based on status.

message instance-attribute

message: NotRequired[Message]

The error message thrown if an import job fails.

output_s3_uri instance-attribute

output_s3_uri: S3Uri

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

submitted_at instance-attribute

submitted_at: NotRequired[Date]

The timestamp for when the import job was submitted.