Amazon WorkMail · Schema

FolderConfiguration

The configuration applied to an organization's folders by its retention policy.

Business CommunicationCalendarEmailExchangeEnterprise

Properties

Name Type Description
Name object
Action object
Period object
View JSON Schema on GitHub

JSON Schema

workmail-folder-configuration-schema.json Raw ↑
{
  "type": "object",
  "required": [
    "Name",
    "Action"
  ],
  "properties": {
    "Name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FolderName"
        },
        {
          "description": "The folder name."
        }
      ]
    },
    "Action": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RetentionAction"
        },
        {
          "description": "The action to take on the folder contents at the end of the folder configuration period."
        }
      ]
    },
    "Period": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RetentionPeriod"
        },
        {
          "description": "The number of days for which the folder-configuration action applies."
        }
      ]
    }
  },
  "description": "The configuration applied to an organization's folders by its retention policy.",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "FolderConfiguration",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-workmail/refs/heads/main/json-schema/workmail-folder-configuration-schema.json"
}