Amazon IoT FleetWise · Schema
UpdateCampaignRequest
UpdateCampaignRequest schema
AutomotiveConnected VehiclesIoTTelematicsVehicle Data
Properties
| Name | Type | Description |
|---|---|---|
| name | object | |
| description | object | |
| dataExtraDimensions | object | |
| action | object |
JSON Schema
{
"$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-update-campaign-request-schema.json",
"title": "UpdateCampaignRequest",
"description": "UpdateCampaignRequest schema",
"type": "object",
"properties": {
"name": {
"allOf": [
{
"$ref": "#/components/schemas/campaignName"
},
{
"description": " The name of the campaign to update. "
}
]
},
"description": {
"allOf": [
{
"$ref": "#/components/schemas/description"
},
{
"description": "The description of the campaign."
}
]
},
"dataExtraDimensions": {
"allOf": [
{
"$ref": "#/components/schemas/DataExtraDimensionNodePathList"
},
{
"description": "<p> A list of vehicle attributes to associate with a signal. </p> <p>Default: An empty array</p>"
}
]
},
"action": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateCampaignAction"
},
{
"description": "<p> Specifies how to update a campaign. The action can be one of the following:</p> <ul> <li> <p> <code>APPROVE</code> - To approve delivering a data collection scheme to vehicles. </p> </li> <li> <p> <code>SUSPEND</code> - To suspend collecting signal data. The campaign is deleted from vehicles and all vehicles in the suspended campaign will stop sending data.</p> </li> <li> <p> <code>RESUME</code> - To reactivate the <code>SUSPEND</code> campaign. The campaign is redeployed to all vehicles and the vehicles will resume sending data.</p> </li> <li> <p> <code>UPDATE</code> - To update a campaign. </p> </li> </ul>"
}
]
}
},
"required": [
"name",
"action"
]
}