Values.GetCampaignResponseSourceRetrieves 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.
type nonrec t = {name : CampaignName.t option;The name of the campaign.
*)arn : CampaignArn.t option;The Amazon Resource Name (ARN) of the campaign.
*)description : Description.t option;The description of the campaign.
*)signalCatalogArn : Arn.t option;The ARN of a signal catalog.
*)targetArn : Arn.t option;The ARN of the vehicle or the fleet targeted by the campaign.
*)status : CampaignStatus.t option;The state of the campaign. The status can be one of: CREATING, WAITING_FOR_APPROVAL, RUNNING, and SUSPENDED.
*)startTime : Timestamp.t option;The time, in milliseconds, to deliver a campaign after it was approved.
*)expiryTime : Timestamp.t option;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.
*)postTriggerCollectionDuration : Uint32.t option;How long (in seconds) to collect raw data after a triggering event initiates the collection.
*)diagnosticsMode : DiagnosticsMode.t option;Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise.
*)spoolingMode : SpoolingMode.t option;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 : Compression.t option;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.
*)priority : Priority.t option;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.
*)signalsToCollect : SignalInformationList.t option;Information about a list of signals to collect data on.
*)collectionScheme : CollectionScheme.t option;Information about the data collection scheme associated with the campaign.
*)dataExtraDimensions : DataExtraDimensionNodePathList.t option;A list of vehicle attributes associated with the campaign.
*)creationTime : Timestamp.t option;The time the campaign was created in seconds since epoch (January 1, 1970 at midnight UTC time).
*)lastModificationTime : Timestamp.t option;The last time the campaign was modified.
*)dataDestinationConfigs : DataDestinationConfigs.t option;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.
*)dataPartitions : DataPartitions.t option;The data partitions associated with the signals collected from the vehicle.
*)signalsToFetch : SignalFetchInformationList.t option;Information about a list of signals to fetch data from.
*)}type nonrec error = [ | `AccessDeniedException of AccessDeniedException.t| `InternalServerException of InternalServerException.t| `ResourceNotFoundException of ResourceNotFoundException.t| `ThrottlingException of ThrottlingException.t| `ValidationException of ValidationException.t| `Unknown_operation_error of string * string option ]val make :
?name:??? ->
?arn:??? ->
?description:??? ->
?signalCatalogArn:??? ->
?targetArn:??? ->
?status:??? ->
?startTime:??? ->
?expiryTime:??? ->
?postTriggerCollectionDuration:??? ->
?diagnosticsMode:??? ->
?spoolingMode:??? ->
?compression:??? ->
?priority:??? ->
?signalsToCollect:??? ->
?collectionScheme:??? ->
?dataExtraDimensions:??? ->
?creationTime:??? ->
?lastModificationTime:??? ->
?dataDestinationConfigs:??? ->
?dataPartitions:??? ->
?signalsToFetch:??? ->
unit ->
tval error_of_json :
string ->
Yojson.Safe.t ->
[> `AccessDeniedException of AccessDeniedException.t
| `InternalServerException of InternalServerException.t
| `ResourceNotFoundException of ResourceNotFoundException.t
| `ThrottlingException of ThrottlingException.t
| `Unknown_operation_error of string * string option
| `ValidationException of ValidationException.t ]val error_of_xml :
string ->
Awso.Xml.t ->
[> `AccessDeniedException of AccessDeniedException.t
| `InternalServerException of InternalServerException.t
| `ResourceNotFoundException of ResourceNotFoundException.t
| `ThrottlingException of ThrottlingException.t
| `Unknown_operation_error of string * string option
| `ValidationException of ValidationException.t ]val to_value :
t ->
[> `Structure of
(string
* [> `Enum of string
| `Integer of Priority.t
| `List of
[> `String of NodePath.t
| `Structure of
(string
* [> `Integer of LanguageVersion.t
| `List of [> `String of ActionEventExpression.t ] list
| `Long of MaxSampleCount.t
| `String of WildcardSignalName.t
| `Structure of
(string
* [> `Enum of string
| `Integer of LanguageVersion.t
| `String of S3BucketArn.t
| `Structure of
(string
* [> `Enum of string
| `Integer of StorageMaximumSizeValue.t
| `Long of PositiveLong.t
| `String of FetchConfigEventExpression.t ])
list ])
list ])
list ]
list
| `Long of Uint32.t
| `String of CampaignName.t
| `Structure of
(string
* [> `Structure of
(string
* [> `Enum of string
| `Integer of LanguageVersion.t
| `Long of CollectionPeriodMs.t
| `String of EventExpression.t ])
list ])
list
| `Timestamp of Timestamp.t ])
list ]