- Navigation Guide
@aws-sdk/client-iotfleetwise
GetCampaignCommandOutput Interface
Members
Name | Type | Details |
|---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
arn | string | undefined | The Amazon Resource Name (ARN) of the campaign. |
collectionScheme | CollectionScheme | undefined | Information about the data collection scheme associated with the campaign. |
compression | Compression | undefined | Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If |
creationTime | Date | undefined | The time the campaign was created in seconds since epoch (January 1, 1970 at midnight UTC time). |
dataDestinationConfigs | DataDestinationConfig[] | undefined | The destination where the campaign sends data. You can send data to an MQTT topic, or store it in Amazon S3 or Amazon Timestream. MQTT is the publish/subscribe messaging protocol used by Amazon Web Services IoT to communicate with your devices. Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics. You can use Amazon Timestream to access and analyze time series data, and Timestream to query vehicle data so that you can identify trends and patterns. |
dataExtraDimensions | string[] | undefined | A list of vehicle attributes associated with the campaign. |
dataPartitions | DataPartition[] | undefined | The data partitions associated with the signals collected from the vehicle. |
description | string | undefined | The description of the campaign. |
diagnosticsMode | DiagnosticsMode | undefined | Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise. |
expiryTime | Date | undefined | 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 | undefined | The last time the campaign was modified. |
name | string | undefined | The name of the campaign. |
postTriggerCollectionDuration | number | undefined | How long (in seconds) to collect raw data after a triggering event initiates the collection. |
priority | number | undefined | 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 | undefined | The ARN of a signal catalog. |
signalsToCollect | SignalInformation[] | undefined | Information about a list of signals to collect data on. |
signalsToFetch | SignalFetchInformation[] | undefined | Information about a list of signals to fetch data from. |
spoolingMode | SpoolingMode | undefined | 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 | undefined | The time, in milliseconds, to deliver a campaign after it was approved. |
status | CampaignStatus | undefined | The state of the campaign. The status can be one of: |
targetArn | string | undefined | The ARN of the vehicle or the fleet targeted by the campaign. |
Full Signature
export interface GetCampaignCommandOutput extends GetCampaignResponse, MetadataBearer