Class: Aws::WorkMail::Types::StartMailboxExportJobRequest

Inherits:

Struct

• Object
• Struct
• Aws::WorkMail::Types::StartMailboxExportJobRequest

Defined in:

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

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_token ⇒ String

  The idempotency token for the client request.

• #description ⇒ String

  The mailbox export job description.

• #entity_id ⇒ String

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

• #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.

• #organization_id ⇒ String

  The identifier associated with the organization.

• #role_arn ⇒ String

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

• #s3_bucket_name ⇒ String

  The name of the S3 bucket.

• #s3_prefix ⇒ String

  The S3 bucket prefix.

Instance Attribute Details

#client_token ⇒ String

The idempotency token for the client request.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

• (String)

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

class StartMailboxExportJobRequest < Struct.new(
  :client_token,
  :organization_id,
  :entity_id,
  :description,
  :role_arn,
  :kms_key_arn,
  :s3_bucket_name,
  :s3_prefix)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The mailbox export job description.

Returns:

• (String)

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

class StartMailboxExportJobRequest < Struct.new(
  :client_token,
  :organization_id,
  :entity_id,
  :description,
  :role_arn,
  :kms_key_arn,
  :s3_bucket_name,
  :s3_prefix)
  SENSITIVE = []
  include Aws::Structure
end

#entity_id ⇒ String

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

The identifier can accept UserId or ResourceId, Username or Resourcename, or email. The following identity formats are available:

• Entity ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789 , or S-1-1-12-1234567890-123456789-123456789-1234

• Email address: entity@domain.tld

• Entity name: entity

Returns:

• (String)

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

class StartMailboxExportJobRequest < Struct.new(
  :client_token,
  :organization_id,
  :entity_id,
  :description,
  :role_arn,
  :kms_key_arn,
  :s3_bucket_name,
  :s3_prefix)
  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 4506

class StartMailboxExportJobRequest < Struct.new(
  :client_token,
  :organization_id,
  :entity_id,
  :description,
  :role_arn,
  :kms_key_arn,
  :s3_bucket_name,
  :s3_prefix)
  SENSITIVE = []
  include Aws::Structure
end

#organization_id ⇒ String

The identifier associated with the organization.

Returns:

• (String)

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

class StartMailboxExportJobRequest < Struct.new(
  :client_token,
  :organization_id,
  :entity_id,
  :description,
  :role_arn,
  :kms_key_arn,
  :s3_bucket_name,
  :s3_prefix)
  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 S3 bucket.

Returns:

• (String)

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

class StartMailboxExportJobRequest < Struct.new(
  :client_token,
  :organization_id,
  :entity_id,
  :description,
  :role_arn,
  :kms_key_arn,
  :s3_bucket_name,
  :s3_prefix)
  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 4506

class StartMailboxExportJobRequest < Struct.new(
  :client_token,
  :organization_id,
  :entity_id,
  :description,
  :role_arn,
  :kms_key_arn,
  :s3_bucket_name,
  :s3_prefix)
  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 4506

class StartMailboxExportJobRequest < Struct.new(
  :client_token,
  :organization_id,
  :entity_id,
  :description,
  :role_arn,
  :kms_key_arn,
  :s3_bucket_name,
  :s3_prefix)
  SENSITIVE = []
  include Aws::Structure
end