Skip to content

MailboxExportJob

Source code in docs_src/capo_workmail/types/mailbox_export_job.py
class MailboxExportJob(TypedDict, closed=True):
    job_id: NotRequired["capo_workmail.types.mailbox_export_job_id.MailboxExportJobId"]
    """<p>The identifier of the mailbox export job.</p>"""
    entity_id: NotRequired[
        "capo_workmail.types.work_mail_identifier.WorkMailIdentifier"
    ]
    """<p>The identifier of the user or resource associated with the mailbox.</p>"""
    description: NotRequired["capo_workmail.types.description.Description"]
    """<p>The mailbox export job description.</p>"""
    s3_bucket_name: NotRequired["capo_workmail.types.s3_bucket_name.S3BucketName"]
    """<p>The name of the S3 bucket.</p>"""
    s3_path: NotRequired["capo_workmail.types.s3_object_key.S3ObjectKey"]
    """<p>The path to the S3 bucket and file that the mailbox export job exports to.</p>"""
    estimated_progress: "capo_workmail.types.percentage.Percentage"
    """<p>The estimated progress of the mailbox export job, in percentage points.</p>"""
    state: NotRequired[
        "capo_workmail.types.mailbox_export_job_state.MailboxExportJobState"
    ]
    """<p>The state of the mailbox export job.</p>"""
    start_time: NotRequired["capo_workmail.types.timestamp.Timestamp"]
    """<p>The mailbox export job start timestamp.</p>"""
    end_time: NotRequired["capo_workmail.types.timestamp.Timestamp"]
    """<p>The mailbox export job end timestamp.</p>"""

description instance-attribute

description: NotRequired[Description]

The mailbox export job description.

end_time instance-attribute

end_time: NotRequired[Timestamp]

The mailbox export job end timestamp.

entity_id instance-attribute

entity_id: NotRequired[WorkMailIdentifier]

The identifier of the user or resource associated with the mailbox.

estimated_progress instance-attribute

estimated_progress: Percentage

The estimated progress of the mailbox export job, in percentage points.

job_id instance-attribute

job_id: NotRequired[MailboxExportJobId]

The identifier of the mailbox export job.

s3_bucket_name instance-attribute

s3_bucket_name: NotRequired[S3BucketName]

The name of the S3 bucket.

s3_path instance-attribute

s3_path: NotRequired[S3ObjectKey]

The path to the S3 bucket and file that the mailbox export job exports to.

start_time instance-attribute

start_time: NotRequired[Timestamp]

The mailbox export job start timestamp.

state instance-attribute

state: NotRequired[MailboxExportJobState]

The state of the mailbox export job.