Skip to content

Start Mailbox Export Job

workmail_start_mailbox_export_job R Documentation

Starts a mailbox export job to export MIME-format email messages and calendar items from the specified mailbox to the specified Amazon Simple Storage Service (Amazon S3) bucket

Description

Starts a mailbox export job to export MIME-format email messages and calendar items from the specified mailbox to the specified Amazon Simple Storage Service (Amazon S3) bucket. For more information, see Exporting mailbox content in the WorkMail Administrator Guide.

Usage

workmail_start_mailbox_export_job(ClientToken, OrganizationId, EntityId,
  Description, RoleArn, KmsKeyArn, S3BucketName, S3Prefix)

Arguments

ClientToken

[required] The idempotency token for the client request.

OrganizationId

[required] The identifier associated with the organization.

EntityId

[required] 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

Description

The mailbox export job description.

RoleArn

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

KmsKeyArn

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

S3BucketName

[required] The name of the S3 bucket.

S3Prefix

[required] The S3 bucket prefix.

Value

A list with the following syntax: 

list(
  JobId = "string"
)

Request syntax

svc$start_mailbox_export_job(
  ClientToken = "string",
  OrganizationId = "string",
  EntityId = "string",
  Description = "string",
  RoleArn = "string",
  KmsKeyArn = "string",
  S3BucketName = "string",
  S3Prefix = "string"
)