Amazon IoT FleetWise · JSON Structure

Iot Fleetwise Update Campaign Response Structure

UpdateCampaignResponse schema

Type: object Properties: 3
AutomotiveConnected VehiclesIoTTelematicsVehicle Data

UpdateCampaignResponse is a JSON Structure definition published by Amazon IoT FleetWise, describing 3 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

arn name status

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iot-fleetwise/refs/heads/main/json-structure/iot-fleetwise-update-campaign-response-structure.json",
  "name": "UpdateCampaignResponse",
  "description": "UpdateCampaignResponse schema",
  "type": "object",
  "properties": {
    "arn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/arn"
        },
        {
          "description": " The Amazon Resource Name (ARN) of the campaign. "
        }
      ]
    },
    "name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/campaignName"
        },
        {
          "description": "The name of the updated campaign."
        }
      ]
    },
    "status": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CampaignStatus"
        },
        {
          "description": "<p>The state of a campaign. The status can be one of:</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>"
        }
      ]
    }
  }
}