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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

The mailbox export job description.

Returns:

  • (String)


2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 2512

class MailboxExportJob < Struct.new(
  :job_id,
  :entity_id,
  :description,
  :s3_bucket_name,
  :s3_path,
  :estimated_progress,
  :state,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#end_timeTime

The mailbox export job end timestamp.

Returns:

  • (Time)


2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 2512

class MailboxExportJob < Struct.new(
  :job_id,
  :entity_id,
  :description,
  :s3_bucket_name,
  :s3_path,
  :estimated_progress,
  :state,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#entity_idString

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

Returns:

  • (String)


2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 2512

class MailboxExportJob < Struct.new(
  :job_id,
  :entity_id,
  :description,
  :s3_bucket_name,
  :s3_path,
  :estimated_progress,
  :state,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#estimated_progressInteger

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

Returns:

  • (Integer)


2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 2512

class MailboxExportJob < Struct.new(
  :job_id,
  :entity_id,
  :description,
  :s3_bucket_name,
  :s3_path,
  :estimated_progress,
  :state,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#job_idString

The identifier of the mailbox export job.

Returns:

  • (String)


2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 2512

class MailboxExportJob < Struct.new(
  :job_id,
  :entity_id,
  :description,
  :s3_bucket_name,
  :s3_path,
  :estimated_progress,
  :state,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#s3_bucket_nameString

The name of the S3 bucket.

Returns:

  • (String)


2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 2512

class MailboxExportJob < Struct.new(
  :job_id,
  :entity_id,
  :description,
  :s3_bucket_name,
  :s3_path,
  :estimated_progress,
  :state,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#s3_pathString

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

Returns:

  • (String)


2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 2512

class MailboxExportJob < Struct.new(
  :job_id,
  :entity_id,
  :description,
  :s3_bucket_name,
  :s3_path,
  :estimated_progress,
  :state,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#start_timeTime

The mailbox export job start timestamp.

Returns:

  • (Time)


2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 2512

class MailboxExportJob < Struct.new(
  :job_id,
  :entity_id,
  :description,
  :s3_bucket_name,
  :s3_path,
  :estimated_progress,
  :state,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#stateString

The state of the mailbox export job.

Returns:

  • (String)


2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 2512

class MailboxExportJob < Struct.new(
  :job_id,
  :entity_id,
  :description,
  :s3_bucket_name,
  :s3_path,
  :estimated_progress,
  :state,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end