Amazon WorkMail · JSON Structure

Workmail Mailbox Export Job Structure

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.

Type: object Properties: 9
Business CommunicationCalendarEmailExchangeEnterprise

MailboxExportJob is a JSON Structure definition published by Amazon WorkMail, describing 9 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

JobId EntityId Description S3BucketName S3Path EstimatedProgress State StartTime EndTime

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "type": "object",
  "properties": {
    "JobId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MailboxExportJobId"
        },
        {
          "description": "The identifier of the mailbox export job."
        }
      ]
    },
    "EntityId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkMailIdentifier"
        },
        {
          "description": "The identifier of the user or resource associated with the mailbox."
        }
      ]
    },
    "Description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Description"
        },
        {
          "description": "The mailbox export job description."
        }
      ]
    },
    "S3BucketName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/S3BucketName"
        },
        {
          "description": "The name of the S3 bucket."
        }
      ]
    },
    "S3Path": {
      "allOf": [
        {
          "$ref": "#/components/schemas/S3ObjectKey"
        },
        {
          "description": "The path to the S3 bucket and file that the mailbox export job exports to."
        }
      ]
    },
    "EstimatedProgress": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Percentage"
        },
        {
          "description": "The estimated progress of the mailbox export job, in percentage points."
        }
      ]
    },
    "State": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MailboxExportJobState"
        },
        {
          "description": "The state of the mailbox export job."
        }
      ]
    },
    "StartTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The mailbox export job start timestamp."
        }
      ]
    },
    "EndTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The mailbox export job end timestamp."
        }
      ]
    }
  },
  "description": "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.",
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "name": "MailboxExportJob",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-workmail/refs/heads/main/json-structure/workmail-mailbox-export-job-structure.json"
}