Skip to content

UpdateCampaignRequest

Source code in docs_src/capo_iotfleetwise/types/update_campaign_request.py
class UpdateCampaignRequest(TypedDict, closed=True):
    name: "capo_iotfleetwise.types.campaign_name.campaignName"
    """<p> The name of the campaign to update. </p>"""
    description: NotRequired["capo_iotfleetwise.types.description.description"]
    """<p>The description of the campaign.</p>"""
    data_extra_dimensions: NotRequired[
        "capo_iotfleetwise.types.data_extra_dimension_node_path_list.DataExtraDimensionNodePathList"
    ]
    """<p> A list of vehicle attributes to associate with a signal. </p> <p>Default: An empty array</p>"""
    action: "capo_iotfleetwise.types.update_campaign_action.UpdateCampaignAction"
    """<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>"""

action instance-attribute

Specifies how to update a campaign. The action can be one of the following:

  • APPROVE - To approve delivering a data collection scheme to vehicles.

  • SUSPEND - To suspend collecting signal data. The campaign is deleted from vehicles and all vehicles in the suspended campaign will stop sending data.

  • RESUME - To reactivate the SUSPEND campaign. The campaign is redeployed to all vehicles and the vehicles will resume sending data.

  • UPDATE - To update a campaign.

data_extra_dimensions instance-attribute

data_extra_dimensions: NotRequired[DataExtraDimensionNodePathList]

A list of vehicle attributes to associate with a signal.

Default: An empty array

description instance-attribute

description: NotRequired[description]

The description of the campaign.

name instance-attribute

The name of the campaign to update.