Updates a campaign.
post/#X-Amz-Target=IoTAutobahnControlPlane.UpdateCampaign
Headers
X-Amz-Target'IoTAutobahnControlPlane.UpdateCampaign' required
Request body
namestring required
The name of the campaign to update.
descriptionstring
The description of the campaign.
dataExtraDimensionsNodePath[]
<p> A list of vehicle attributes to associate with a signal. </p> <p>Default: An empty array</p>
action'APPROVE' | 'SUSPEND' | 'RESUME' | 'UPDATE' required
<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>
Response
Success
arnstring
The Amazon Resource Name (ARN) of the campaign.
namestring
The name of the updated campaign.
status'CREATING' | 'WAITING_FOR_APPROVAL' | 'RUNNING' | 'SUSPENDED'
<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 you create a campaign, it enters this state. Use the API operation to approve the campaign for deployment to the target vehicle or fleet. </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>