CreateCampaignRequest

import type { CreateCampaignRequest } from "https://aws-api.deno.dev/v0.4/services/iotfleetwise.ts?docs=full";

interface CreateCampaignRequest {

collectionScheme: CollectionScheme;

compression?: Compression | null;

dataExtraDimensions?: string[] | null;

description?: string | null;

diagnosticsMode?: DiagnosticsMode | null;

expiryTime?: Date | number | null;

name: string;

postTriggerCollectionDuration?: number | null;

priority?: number | null;

signalCatalogArn: string;

signalsToCollect?: SignalInformation[] | null;

spoolingMode?: SpoolingMode | null;

startTime?: Date | number | null;

tags?: Tag[] | null;

targetArn: string;

}

§Properties

collectionScheme: CollectionScheme

[src]

The data collection scheme associated with the campaign. You can specify a scheme that collects data based on time or an event.

compression?: Compression | null

[src]

(Optional) Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If you don't want to compress the signals, use OFF. If it's not specified, SNAPPY is used.

Default: SNAPPY

dataExtraDimensions?: string[] | null

[src]

(Optional) A list of vehicle attributes to associate with a campaign.

Enrich the data with specified vehicle attributes. For example, add make and model to the campaign, and Amazon Web Services IoT FleetWise will associate the data with those attributes as dimensions in Amazon Timestream. You can then query the data against make and model.

Default: An empty array

description?: string | null

[src]

An optional description of the campaign to help identify its purpose.

diagnosticsMode?: DiagnosticsMode | null

[src]

(Optional) Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise. If you want to send diagnostic trouble codes, use SEND_ACTIVE_DTCS. If it's not specified, OFF is used.

Default: OFF

expiryTime?: Date | number | null

[src]

(Optional) 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.

Default: 253402214400 (December 31, 9999, 00:00:00 UTC)

name: string

[src]

The name of the campaign to create.

postTriggerCollectionDuration?: number | null

[src]

(Optional) How long (in milliseconds) to collect raw data after a triggering event initiates the collection. If it's not specified, 0 is used.

Default: 0

priority?: number | null

[src]

(Optional) 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. If it's not specified, 0 is used.

Default: 0

signalCatalogArn: string

[src]

(Optional) The Amazon Resource Name (ARN) of the signal catalog to associate with the campaign.

signalsToCollect?: SignalInformation[] | null

[src]

(Optional) A list of information about signals to collect.

spoolingMode?: SpoolingMode | null

[src]

(Optional) 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. If you want to store collected data when a vehicle loses connection with the cloud, use TO_DISK. If it's not specified, OFF is used.

Default: OFF

startTime?: Date | number | null

[src]

(Optional) The time, in milliseconds, to deliver a campaign after it was approved. If it's not specified, 0 is used.

Default: 0

tags?: Tag[] | null

[src]

Metadata that can be used to manage the campaign.

targetArn: string

[src]

The ARN of the vehicle or fleet to deploy a campaign to.