GetCampaignResponse

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

interface GetCampaignResponse {

arn?: string | null;

collectionScheme?: CollectionScheme | null;

compression?: Compression | null;

creationTime?: Date | number | null;

dataExtraDimensions?: string[] | null;

description?: string | null;

diagnosticsMode?: DiagnosticsMode | null;

expiryTime?: Date | number | null;

lastModificationTime?: Date | number | null;

name?: string | null;

postTriggerCollectionDuration?: number | null;

priority?: number | null;

signalCatalogArn?: string | null;

signalsToCollect?: SignalInformation[] | null;

spoolingMode?: SpoolingMode | null;

startTime?: Date | number | null;

status?: CampaignStatus | null;

targetArn?: string | null;

}

§Properties

arn?: string | null

[src]

The Amazon Resource Name (ARN) of the campaign.

collectionScheme?: CollectionScheme | null

[src]

Information about the data collection scheme associated with the campaign.

compression?: Compression | null

[src]

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

creationTime?: Date | number | null

[src]

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

dataExtraDimensions?: string[] | null

[src]

A list of vehicle attributes associated with the campaign.

description?: string | null

[src]

The description of the campaign.

diagnosticsMode?: DiagnosticsMode | null

[src]

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

expiryTime?: Date | number | null

[src]

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.

lastModificationTime?: Date | number | null

[src]

The last time the campaign was modified.

name?: string | null

[src]

The name of the campaign.

postTriggerCollectionDuration?: number | null

[src]

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

priority?: number | null

[src]

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.

signalCatalogArn?: string | null

[src]

The ARN of a signal catalog.

signalsToCollect?: SignalInformation[] | null

[src]

Information about a list of signals to collect data on.

spoolingMode?: SpoolingMode | null

[src]

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.

startTime?: Date | number | null

[src]

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

status?: CampaignStatus | null

[src]

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

targetArn?: string | null

[src]

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