You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::WorkMail::Types::MailboxExportJob

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

The details of a mailbox export job, including the user or resource ID associated with the mailbox and the S3 bucket that the mailbox contents are exported to.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

The mailbox export job description.

Returns:

  • (String) —

    The mailbox export job description.

#end_time ⇒ Time

The mailbox export job end timestamp.

Returns:

  • (Time) —

    The mailbox export job end timestamp.

#entity_id ⇒ String

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

Returns:

  • (String) —

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

#estimated_progress ⇒ Integer

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

Returns:

  • (Integer) —

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

#job_id ⇒ String

The identifier of the mailbox export job.

Returns:

  • (String) —

    The identifier of the mailbox export job.

#s3_bucket_name ⇒ String

The name of the S3 bucket.

Returns:

  • (String) —

    The name of the S3 bucket.

#s3_path ⇒ String

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

Returns:

  • (String) —

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

#start_time ⇒ Time

The mailbox export job start timestamp.

Returns:

  • (Time) —

    The mailbox export job start timestamp.

#state ⇒ String

The state of the mailbox export job.

Possible values:

  • RUNNING
  • COMPLETED
  • FAILED
  • CANCELLED

Returns:

  • (String) —

    The state of the mailbox export job.