CampaignSummary

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iot-fleetwise/refs/heads/main/json-schema/iot-fleetwise-campaign-summary-schema.json",
  "title": "CampaignSummary",
  "description": "<p>Information about a campaign. </p> <p>You can use the API operation to return this information about multiple created campaigns.</p>",
  "type": "object",
  "properties": {
    "arn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/arn"
        },
        {
          "description": "The Amazon Resource Name (ARN) of a campaign."
        }
      ]
    },
    "name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/campaignName"
        },
        {
          "description": "The name of a campaign."
        }
      ]
    },
    "description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/description"
        },
        {
          "description": "The description of the campaign."
        }
      ]
    },
    "signalCatalogArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/arn"
        },
        {
          "description": "The ARN of the signal catalog associated with the campaign."
        }
      ]
    },
    "targetArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/arn"
        },
        {
          "description": "The ARN of a vehicle or fleet to which the campaign is deployed."
        }
      ]
    },
    "status": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CampaignStatus"
        },
        {
          "description": "<p>The state of a campaign. The status can be one of the following:</p> <ul> <li> <p> <code>CREATING</code> - Amazon Web Services IoT FleetWise is processing your request to create the campaign.</p> </li> <li> <p> <code>WAITING_FOR_APPROVAL</code> - After a campaign is created, it enters the <code>WAITING_FOR_APPROVAL</code> state. To allow Amazon Web Services IoT FleetWise to deploy the campaign to the target vehicle or fleet, use the API operation to approve the campaign. </p> </li> <li> <p> <code>RUNNING</code> - The campaign is active. </p> </li> <li> <p> <code>SUSPENDED</code> - The campaign is suspended. To resume the campaign, use the API operation. </p> </li> </ul>"
        }
      ]
    },
    "creationTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/timestamp"
        },
        {
          "description": "The time the campaign was created."
        }
      ]
    },
    "lastModificationTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/timestamp"
        },
        {
          "description": "The last time the campaign was modified."
        }
      ]
    }
  },
  "required": [
    "creationTime",
    "lastModificationTime"
  ]
}