Class: Aws::WorkMail::Types::DescribeMailboxExportJobResponse

Inherits:

Struct

• Object
• Struct
• Aws::WorkMail::Types::DescribeMailboxExportJobResponse

Defined in:

gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #description ⇒ String

  The mailbox export job description.

• #end_time ⇒ Time

  The mailbox export job end timestamp.

• #entity_id ⇒ String

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

• #error_info ⇒ String

  Error information for failed mailbox export jobs.

• #estimated_progress ⇒ Integer

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

• #kms_key_arn ⇒ String

  The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the exported mailbox content.

• #role_arn ⇒ String

  The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the Amazon Simple Storage Service (Amazon S3) bucket.

• #s3_bucket_name ⇒ String

  The name of the S3 bucket.

• #s3_path ⇒ String

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

• #s3_prefix ⇒ String

  The S3 bucket prefix.

• #start_time ⇒ Time

  The mailbox export job start timestamp.

• #state ⇒ String

  The state of the mailbox export job.

Instance Attribute Details

#description ⇒ String

The mailbox export job description.

Returns:

• (String)

# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 1245

class DescribeMailboxExportJobResponse < Struct.new(
  :entity_id,
  :description,
  :role_arn,
  :kms_key_arn,
  :s3_bucket_name,
  :s3_prefix,
  :s3_path,
  :estimated_progress,
  :state,
  :error_info,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#end_time ⇒ Time

The mailbox export job end timestamp.

Returns:

• (Time)

# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 1245

class DescribeMailboxExportJobResponse < Struct.new(
  :entity_id,
  :description,
  :role_arn,
  :kms_key_arn,
  :s3_bucket_name,
  :s3_prefix,
  :s3_path,
  :estimated_progress,
  :state,
  :error_info,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#entity_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 1245

class DescribeMailboxExportJobResponse < Struct.new(
  :entity_id,
  :description,
  :role_arn,
  :kms_key_arn,
  :s3_bucket_name,
  :s3_prefix,
  :s3_path,
  :estimated_progress,
  :state,
  :error_info,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#error_info ⇒ String

Error information for failed mailbox export jobs.

Returns:

• (String)

# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 1245

class DescribeMailboxExportJobResponse < Struct.new(
  :entity_id,
  :description,
  :role_arn,
  :kms_key_arn,
  :s3_bucket_name,
  :s3_prefix,
  :s3_path,
  :estimated_progress,
  :state,
  :error_info,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#estimated_progress ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 1245

class DescribeMailboxExportJobResponse < Struct.new(
  :entity_id,
  :description,
  :role_arn,
  :kms_key_arn,
  :s3_bucket_name,
  :s3_prefix,
  :s3_path,
  :estimated_progress,
  :state,
  :error_info,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_arn ⇒ String

The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the exported mailbox content.

Returns:

• (String)

# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 1245

class DescribeMailboxExportJobResponse < Struct.new(
  :entity_id,
  :description,
  :role_arn,
  :kms_key_arn,
  :s3_bucket_name,
  :s3_prefix,
  :s3_path,
  :estimated_progress,
  :state,
  :error_info,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the Amazon Simple Storage Service (Amazon S3) bucket.

Returns:

• (String)

# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 1245

class DescribeMailboxExportJobResponse < Struct.new(
  :entity_id,
  :description,
  :role_arn,
  :kms_key_arn,
  :s3_bucket_name,
  :s3_prefix,
  :s3_path,
  :estimated_progress,
  :state,
  :error_info,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#s3_bucket_name ⇒ String

The name of the S3 bucket.

Returns:

• (String)

# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 1245

class DescribeMailboxExportJobResponse < Struct.new(
  :entity_id,
  :description,
  :role_arn,
  :kms_key_arn,
  :s3_bucket_name,
  :s3_prefix,
  :s3_path,
  :estimated_progress,
  :state,
  :error_info,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#s3_path ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 1245

class DescribeMailboxExportJobResponse < Struct.new(
  :entity_id,
  :description,
  :role_arn,
  :kms_key_arn,
  :s3_bucket_name,
  :s3_prefix,
  :s3_path,
  :estimated_progress,
  :state,
  :error_info,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#s3_prefix ⇒ String

The S3 bucket prefix.

Returns:

• (String)

# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 1245

class DescribeMailboxExportJobResponse < Struct.new(
  :entity_id,
  :description,
  :role_arn,
  :kms_key_arn,
  :s3_bucket_name,
  :s3_prefix,
  :s3_path,
  :estimated_progress,
  :state,
  :error_info,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

The mailbox export job start timestamp.

Returns:

• (Time)

# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 1245

class DescribeMailboxExportJobResponse < Struct.new(
  :entity_id,
  :description,
  :role_arn,
  :kms_key_arn,
  :s3_bucket_name,
  :s3_prefix,
  :s3_path,
  :estimated_progress,
  :state,
  :error_info,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

The state of the mailbox export job.

Returns:

• (String)

# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 1245

class DescribeMailboxExportJobResponse < Struct.new(
  :entity_id,
  :description,
  :role_arn,
  :kms_key_arn,
  :s3_bucket_name,
  :s3_prefix,
  :s3_path,
  :estimated_progress,
  :state,
  :error_info,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end