Amazon WorkMail · Schema

CreateImpersonationRoleRequest

CreateImpersonationRoleRequest schema from Amazon WorkMail API

Business CommunicationCalendarEmailExchangeEnterprise

Properties

Name Type Description
ClientToken object
OrganizationId object
Name object
Type object
Description object
Rules object
View JSON Schema on GitHub

JSON Schema

workmail-create-impersonation-role-request-schema.json Raw ↑
{
  "type": "object",
  "required": [
    "OrganizationId",
    "Name",
    "Type",
    "Rules"
  ],
  "title": "CreateImpersonationRoleRequest",
  "properties": {
    "ClientToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IdempotencyClientToken"
        },
        {
          "description": "The idempotency token for the client request."
        }
      ]
    },
    "OrganizationId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/OrganizationId"
        },
        {
          "description": "The WorkMail organization to create the new impersonation role within."
        }
      ]
    },
    "Name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ImpersonationRoleName"
        },
        {
          "description": "The name of the new impersonation role."
        }
      ]
    },
    "Type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ImpersonationRoleType"
        },
        {
          "description": "The impersonation role's type. The available impersonation role types are <code>READ_ONLY</code> or <code>FULL_ACCESS</code>."
        }
      ]
    },
    "Description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ImpersonationRoleDescription"
        },
        {
          "description": "The description of the new impersonation role."
        }
      ]
    },
    "Rules": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ImpersonationRuleList"
        },
        {
          "description": "The list of rules for the impersonation role."
        }
      ]
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-workmail/refs/heads/main/json-schema/workmail-create-impersonation-role-request-schema.json",
  "description": "CreateImpersonationRoleRequest schema from Amazon WorkMail API"
}