TreatmentResource

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/json-schema/amazon-pinpoint-treatment-resource-schema.json",
  "title": "TreatmentResource",
  "description": "Specifies the settings for a campaign treatment. A <i>treatment</i> is a variation of a campaign that's used for A/B testing of a campaign.",
  "type": "object",
  "properties": {
    "CustomDeliveryConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CustomDeliveryConfiguration"
        },
        {
          "description": "The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object."
        }
      ]
    },
    "Id": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The unique identifier for the treatment."
        }
      ]
    },
    "MessageConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MessageConfiguration"
        },
        {
          "description": "The message configuration settings for the treatment."
        }
      ]
    },
    "Schedule": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Schedule"
        },
        {
          "description": "The schedule settings for the treatment."
        }
      ]
    },
    "SizePercent": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integer"
        },
        {
          "description": "The allocated percentage of users (segment members) that the treatment is sent to."
        }
      ]
    },
    "State": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CampaignState"
        },
        {
          "description": "The current status of the treatment."
        }
      ]
    },
    "TemplateConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TemplateConfiguration"
        },
        {
          "description": "The message template to use for the treatment."
        }
      ]
    },
    "TreatmentDescription": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The custom description of the treatment."
        }
      ]
    },
    "TreatmentName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The custom name of the treatment."
        }
      ]
    }
  },
  "required": [
    "Id",
    "SizePercent"
  ]
}