Amazon WorkMail · Schema

MailboxExportJob

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.

Business CommunicationCalendarEmailExchangeEnterprise

Properties

Name Type Description
JobId object
EntityId object
Description object
S3BucketName object
S3Path object
EstimatedProgress object
State object
StartTime object
EndTime object
View JSON Schema on GitHub

JSON Schema

workmail-mailbox-export-job-schema.json 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-schema.org/draft/2020-12/schema",
  "title": "MailboxExportJob",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-workmail/refs/heads/main/json-schema/workmail-mailbox-export-job-schema.json"
}