Skip to content

ImportJob

Source code in docs_src/capo_mailmanager/types/import_job.py
class ImportJob(TypedDict, closed=True):
    job_id: "capo_mailmanager.types.job_id.JobId"
    """<p>The identifier of the import job.</p>"""
    name: "capo_mailmanager.types.job_name.JobName"
    """<p>A user-friendly name for the import job.</p>"""
    status: "capo_mailmanager.types.import_job_status.ImportJobStatus"
    """<p>The status of the import job.</p>"""
    pre_signed_url: "capo_mailmanager.types.pre_signed_url.PreSignedUrl"
    """<p>The pre-signed URL target for uploading the input file.</p>"""
    imported_items_count: NotRequired[
        "capo_mailmanager.types.job_items_count.JobItemsCount"
    ]
    """<p>The number of addresses in the input that were successfully imported into the address list.</p>"""
    failed_items_count: NotRequired[
        "capo_mailmanager.types.job_items_count.JobItemsCount"
    ]
    """<p>The number of addresses in the input that failed to get imported into address list.</p>"""
    import_data_format: "capo_mailmanager.types.import_data_format.ImportDataFormat"
    """<p>The format of the input for the import job.</p>"""
    address_list_id: "capo_mailmanager.types.address_list_id.AddressListId"
    """<p>The unique identifier of the address list the import job was created for.</p>"""
    created_timestamp: "datetime.datetime"
    """<p>The timestamp of when the import job was created.</p>"""
    start_timestamp: NotRequired["datetime.datetime"]
    """<p>The timestamp of when the import job was started.</p>"""
    completed_timestamp: NotRequired["datetime.datetime"]
    """<p>The timestamp of when the import job was completed.</p>"""
    error: NotRequired["capo_mailmanager.types.error_message.ErrorMessage"]
    """<p>The reason for failure of an import job.</p>"""

address_list_id instance-attribute

address_list_id: AddressListId

The unique identifier of the address list the import job was created for.

completed_timestamp instance-attribute

completed_timestamp: NotRequired[datetime]

The timestamp of when the import job was completed.

created_timestamp instance-attribute

created_timestamp: datetime

The timestamp of when the import job was created.

error instance-attribute

error: NotRequired[ErrorMessage]

The reason for failure of an import job.

failed_items_count instance-attribute

failed_items_count: NotRequired[JobItemsCount]

The number of addresses in the input that failed to get imported into address list.

import_data_format instance-attribute

import_data_format: ImportDataFormat

The format of the input for the import job.

imported_items_count instance-attribute

imported_items_count: NotRequired[JobItemsCount]

The number of addresses in the input that were successfully imported into the address list.

job_id instance-attribute

job_id: JobId

The identifier of the import job.

name instance-attribute

name: JobName

A user-friendly name for the import job.

pre_signed_url instance-attribute

pre_signed_url: PreSignedUrl

The pre-signed URL target for uploading the input file.

start_timestamp instance-attribute

start_timestamp: NotRequired[datetime]

The timestamp of when the import job was started.

status instance-attribute

The status of the import job.