UpdateCampaignResponse

UpdateCampaignResponse schema

AutomotiveConnected VehiclesIoTTelematicsVehicle Data

Properties

Name Type Description
arn object
name object
status object
View JSON Schema on GitHub

JSON Schema

iot-fleetwise-update-campaign-response-schema.json Raw ↑
{
  "$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-response-schema.json",
  "title": "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>"
        }
      ]
    }
  }
}