{ "$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": "
Information about a campaign.
You can use the API operation to return this information about multiple created campaigns.
", "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": "The state of a campaign. The status can be one of the following:
CREATING - Amazon Web Services IoT FleetWise is processing your request to create the campaign.
WAITING_FOR_APPROVAL - After a campaign is created, it enters the WAITING_FOR_APPROVAL 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.
RUNNING - The campaign is active.
SUSPENDED - The campaign is suspended. To resume the campaign, use the API operation.