Amazon WorkMail · JSON Structure

Workmail Folder Configuration Structure

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

Type: object Properties: 3 Required: 2
Business CommunicationCalendarEmailExchangeEnterprise

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

Properties

Name Action Period

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

JSON Structure

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-structure.org/meta/core/v0/#",
  "name": "FolderConfiguration",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-workmail/refs/heads/main/json-structure/workmail-folder-configuration-structure.json"
}