CampaignResponse

{
  "$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-campaign-response-schema.json",
  "title": "CampaignResponse",
  "description": "Provides information about the status, configuration, and other settings for a campaign.",
  "type": "object",
  "properties": {
    "AdditionalTreatments": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ListOfTreatmentResource"
        },
        {
          "description": "An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment."
        }
      ]
    },
    "ApplicationId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The unique identifier for the application that the campaign applies to."
        }
      ]
    },
    "Arn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the campaign."
        }
      ]
    },
    "CreationDate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The date, in ISO 8601 format, when the campaign was created."
        }
      ]
    },
    "CustomDeliveryConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CustomDeliveryConfiguration"
        },
        {
          "description": "The delivery configuration settings for sending the campaign through a custom channel."
        }
      ]
    },
    "DefaultState": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CampaignState"
        },
        {
          "description": "The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment."
        }
      ]
    },
    "Description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The custom description of the campaign."
        }
      ]
    },
    "HoldoutPercent": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integer"
        },
        {
          "description": "The allocated percentage of users (segment members) who shouldn't receive messages from the campaign."
        }
      ]
    },
    "Hook": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CampaignHook"
        },
        {
          "description": "The settings for the AWS Lambda function to use as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign."
        }
      ]
    },
    "Id": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The unique identifier for the campaign."
        }
      ]
    },
    "IsPaused": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__boolean"
        },
        {
          "description": "Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false."
        }
      ]
    },
    "LastModifiedDate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The date, in ISO 8601 format, when the campaign was last modified."
        }
      ]
    },
    "Limits": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CampaignLimits"
        },
        {
          "description": "The messaging limits for the campaign."
        }
      ]
    },
    "MessageConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MessageConfiguration"
        },
        {
          "description": "The message configuration settings for the campaign."
        }
      ]
    },
    "Name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The name of the campaign."
        }
      ]
    },
    "Schedule": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Schedule"
        },
        {
          "description": "The schedule settings for the campaign."
        }
      ]
    },
    "SegmentId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The unique identifier for the segment that's associated with the campaign."
        }
      ]
    },
    "SegmentVersion": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integer"
        },
        {
          "description": "The version number of the segment that's associated with the campaign."
        }
      ]
    },
    "State": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CampaignState"
        },
        {
          "description": "The current status of the campaign."
        }
      ]
    },
    "tags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MapOf__string"
        },
        {
          "description": "A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value."
        }
      ]
    },
    "TemplateConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TemplateConfiguration"
        },
        {
          "description": "The message template that\u2019s used for the campaign."
        }
      ]
    },
    "TreatmentDescription": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The custom description of the default treatment for the campaign."
        }
      ]
    },
    "TreatmentName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The custom name of the default treatment for the campaign, if the campaign has multiple treatments. A <i>treatment</i> is a variation of a campaign that's used for A/B testing."
        }
      ]
    },
    "Version": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integer"
        },
        {
          "description": "The version number of the campaign."
        }
      ]
    },
    "Priority": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integer"
        },
        {
          "description": "Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment."
        }
      ]
    }
  },
  "required": [
    "LastModifiedDate",
    "CreationDate",
    "SegmentId",
    "SegmentVersion",
    "Id",
    "Arn",
    "ApplicationId"
  ]
}