Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1457355285.1 KB

Retrieves information about a campaign.

Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.

post/#X-Amz-Target=IoTAutobahnControlPlane.GetCampaign

Headers

X-Amz-Target'IoTAutobahnControlPlane.GetCampaign' required

Request body

namestring required

The name of the campaign to retrieve information about.

Response

Success

namestring

The name of the campaign.

arnstring

The Amazon Resource Name (ARN) of the campaign.

descriptionstring

The description of the campaign.

signalCatalogArnstring

The ARN of a signal catalog.

targetArnstring

The ARN of the vehicle or the fleet targeted by the campaign.

status'CREATING' | 'WAITING_FOR_APPROVAL' | 'RUNNING' | 'SUSPENDED'

The state of the campaign. The status can be one of: <code>CREATING</code>, <code>WAITING_FOR_APPROVAL</code>, <code>RUNNING</code>, and <code>SUSPENDED</code>.

startTimestring date-time

The time, in milliseconds, to deliver a campaign after it was approved.

expiryTimestring date-time

The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time). Vehicle data won't be collected after the campaign expires.

postTriggerCollectionDurationinteger

How long (in seconds) to collect raw data after a triggering event initiates the collection.

diagnosticsMode'OFF' | 'SEND_ACTIVE_DTCS'

Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise.

spoolingMode'OFF' | 'TO_DISK'

Whether to store collected data after a vehicle lost a connection with the cloud. After a connection is re-established, the data is automatically forwarded to Amazon Web Services IoT FleetWise.

compression'OFF' | 'SNAPPY'

Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If <code>OFF</code> is specified, the signals aren't compressed. If it's not specified, <code>SNAPPY</code> is used.

priorityinteger

A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet. A campaign with the lowest value is deployed to vehicles before any other campaigns.

dataExtraDimensionsNodePath[]

A list of vehicle attributes associated with the campaign.

creationTimestring date-time

The time the campaign was created in seconds since epoch (January 1, 1970 at midnight UTC time).

lastModificationTimestring date-time

The last time the campaign was modified.