Update an AWS IoT FleetWise campaign - AWS IoT FleetWise

Update an AWS IoT FleetWise campaign

You can use the UpdateCampaign API operation to update an existing campaign. The following command uses AWS CLI.

  • Replace campaign-name with the name of the campaign that you're updating.

  • Replace action with one of the following:

    • APPROVE – Approves the campaign to allow AWS IoT FleetWise to deploy it to a vehicle or fleet.

    • SUSPEND – Suspends the campaign. The campaign is deleted from vehicles and all vehicles in the suspended campaign will stop sending data.

    • RESUME – Reactivates the SUSPEND campaign. The campaign is redeployed to all vehicles and the vehicles will resume sending data.

    • UPDATE – Updates the campaign by defining attributes and associating them with the campaign.

  • Replace description with a new description.

    The description can have up to 2,048 characters.

  • Replace data-extra-dimensions with specified vehicle attributes to enrich data collected during the campaign. For example, you can add vehicle make and model to the campaign, and AWS IoT FleetWise will associate the data with those attributes as dimensions in Amazon Timestream. You can then query the data against vehicle make and model.

aws iotfleetwise update-campaign \
            --name campaign-name \
            --action action \
            --description description \
            --data-extra-dimensions data-extra-dimensions

If you enabled encryption using a customer managed AWS KMS key, include the following policy statement so that your role can invoke the UpdateCampaign API operation. 

{
  "Version": "2012-10-17",
  "Statement": [

    {
      "Effect": "Allow",
      "Action": [
        "kms:GenerateDataKey*",
        "kms:Decrypt"
      ],
      "Resource": [
        "arn:aws:kms:KMS_KEY_REGION:KMS_KEY_ACCOUNT_ID:key/KMS_KEY_ID"
      ]
    },
  ]
}