Amazon WorkMail · JSON Structure

Workmail Start Mailbox Export Job Request Structure

StartMailboxExportJobRequest schema from Amazon WorkMail API

Type: object Properties: 8 Required: 7
Business CommunicationCalendarEmailExchangeEnterprise

StartMailboxExportJobRequest is a JSON Structure definition published by Amazon WorkMail, describing 8 properties, of which 7 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

ClientToken OrganizationId EntityId Description RoleArn KmsKeyArn S3BucketName S3Prefix

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

JSON Structure

Raw ↑ 
{
  "type": "object",
  "required": [
    "ClientToken",
    "OrganizationId",
    "EntityId",
    "RoleArn",
    "KmsKeyArn",
    "S3BucketName",
    "S3Prefix"
  ],
  "name": "StartMailboxExportJobRequest",
  "properties": {
    "ClientToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IdempotencyClientToken"
        },
        {
          "description": "The idempotency token for the client request."
        }
      ]
    },
    "OrganizationId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/OrganizationId"
        },
        {
          "description": "The identifier associated with the organization."
        }
      ]
    },
    "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."
        }
      ]
    },
    "RoleArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RoleArn"
        },
        {
          "description": "The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the S3 bucket."
        }
      ]
    },
    "KmsKeyArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/KmsKeyArn"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the exported mailbox content."
        }
      ]
    },
    "S3BucketName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/S3BucketName"
        },
        {
          "description": "The name of the S3 bucket."
        }
      ]
    },
    "S3Prefix": {
      "allOf": [
        {
          "$ref": "#/components/schemas/S3ObjectKey"
        },
        {
          "description": "The S3 bucket prefix."
        }
      ]
    }
  },
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-workmail/refs/heads/main/json-structure/workmail-start-mailbox-export-job-request-structure.json",
  "description": "StartMailboxExportJobRequest schema from Amazon WorkMail API"
}