Amazon Pinpoint · Schema

CampaignState

Provides information about the status of a campaign.

CampaignsCommunicationsEmailMarketingMessagingPush NotificationsSMSVoiceCustomer EngagementSegmentationJourneysAnalytics

Properties

Name Type Description
CampaignStatus object
View JSON Schema on GitHub

JSON Schema

amazon-pinpoint-campaign-state-schema.json Raw ↑
{
  "$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-state-schema.json",
  "title": "CampaignState",
  "description": "Provides information about the status of a campaign.",
  "type": "object",
  "properties": {
    "CampaignStatus": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CampaignStatus"
        },
        {
          "description": "<p>The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.</p> <p>If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.</p>"
        }
      ]
    }
  }
}