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

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

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

Overview

Note:

When passing StartMailboxExportJobRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  client_token: "IdempotencyClientToken", # required
  organization_id: "OrganizationId", # required
  entity_id: "WorkMailIdentifier", # required
  description: "Description",
  role_arn: "RoleArn", # required
  kms_key_arn: "KmsKeyArn", # required
  s3_bucket_name: "S3BucketName", # required
  s3_prefix: "S3ObjectKey", # required
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

The idempotency token for the client request.

Returns:

  • (String) —

    The idempotency token for the client request.

#description ⇒ String

The mailbox export job description.

Returns:

  • (String) —

    The mailbox export job description.

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

#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) —

    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.

Returns:

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

Returns:

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

Returns:

  • (String) —

    The name of the S3 bucket.

#s3_prefix ⇒ String

The S3 bucket prefix.

Returns:

  • (String) —

    The S3 bucket prefix.