Amazon WorkMail · JSON Structure

Workmail Put Retention Policy Request Structure

PutRetentionPolicyRequest schema from Amazon WorkMail API

Type: object Properties: 5 Required: 3
Business CommunicationCalendarEmailExchangeEnterprise

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

Properties

OrganizationId Id Name Description FolderConfigurations

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

JSON Structure

Raw ↑ 
{
  "type": "object",
  "required": [
    "OrganizationId",
    "Name",
    "FolderConfigurations"
  ],
  "name": "PutRetentionPolicyRequest",
  "properties": {
    "OrganizationId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/OrganizationId"
        },
        {
          "description": "The organization ID."
        }
      ]
    },
    "Id": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ShortString"
        },
        {
          "description": "The retention policy ID."
        }
      ]
    },
    "Name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ShortString"
        },
        {
          "description": "The retention policy name."
        }
      ]
    },
    "Description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PolicyDescription"
        },
        {
          "description": "The retention policy description."
        }
      ]
    },
    "FolderConfigurations": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FolderConfigurations"
        },
        {
          "description": "The retention policy folder configurations."
        }
      ]
    }
  },
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-workmail/refs/heads/main/json-structure/workmail-put-retention-policy-request-structure.json",
  "description": "PutRetentionPolicyRequest schema from Amazon WorkMail API"
}