Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Creates an orchestration of data collection rules. The Amazon Web Services IoT FleetWise Edge Agent software running in vehicles uses campaigns to decide how to collect and transfer data to the cloud. You create campaigns in the cloud. After you or your team approve campaigns, Amazon Web Services IoT FleetWise automatically deploys them to vehicles.
For more information, see Collect and transfer data with campaigns in the Amazon Web Services IoT FleetWise Developer Guide.
Synopsis
- data CreateCampaign = CreateCampaign' {
- compression :: Maybe Compression
- dataExtraDimensions :: Maybe [Text]
- description :: Maybe Text
- diagnosticsMode :: Maybe DiagnosticsMode
- expiryTime :: Maybe POSIX
- postTriggerCollectionDuration :: Maybe Natural
- priority :: Maybe Natural
- signalsToCollect :: Maybe [SignalInformation]
- spoolingMode :: Maybe SpoolingMode
- startTime :: Maybe POSIX
- tags :: Maybe [Tag]
- name :: Text
- signalCatalogArn :: Text
- targetArn :: Text
- collectionScheme :: CollectionScheme
- newCreateCampaign :: Text -> Text -> Text -> CollectionScheme -> CreateCampaign
- createCampaign_compression :: Lens' CreateCampaign (Maybe Compression)
- createCampaign_dataExtraDimensions :: Lens' CreateCampaign (Maybe [Text])
- createCampaign_description :: Lens' CreateCampaign (Maybe Text)
- createCampaign_diagnosticsMode :: Lens' CreateCampaign (Maybe DiagnosticsMode)
- createCampaign_expiryTime :: Lens' CreateCampaign (Maybe UTCTime)
- createCampaign_postTriggerCollectionDuration :: Lens' CreateCampaign (Maybe Natural)
- createCampaign_priority :: Lens' CreateCampaign (Maybe Natural)
- createCampaign_signalsToCollect :: Lens' CreateCampaign (Maybe [SignalInformation])
- createCampaign_spoolingMode :: Lens' CreateCampaign (Maybe SpoolingMode)
- createCampaign_startTime :: Lens' CreateCampaign (Maybe UTCTime)
- createCampaign_tags :: Lens' CreateCampaign (Maybe [Tag])
- createCampaign_name :: Lens' CreateCampaign Text
- createCampaign_signalCatalogArn :: Lens' CreateCampaign Text
- createCampaign_targetArn :: Lens' CreateCampaign Text
- createCampaign_collectionScheme :: Lens' CreateCampaign CollectionScheme
- data CreateCampaignResponse = CreateCampaignResponse' {}
- newCreateCampaignResponse :: Int -> CreateCampaignResponse
- createCampaignResponse_arn :: Lens' CreateCampaignResponse (Maybe Text)
- createCampaignResponse_name :: Lens' CreateCampaignResponse (Maybe Text)
- createCampaignResponse_httpStatus :: Lens' CreateCampaignResponse Int
Creating a Request
data CreateCampaign Source #
See: newCreateCampaign
smart constructor.
CreateCampaign' | |
|
Instances
:: Text | |
-> Text | |
-> Text | |
-> CollectionScheme | |
-> CreateCampaign |
Create a value of CreateCampaign
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:compression:CreateCampaign'
, createCampaign_compression
- (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
$sel:dataExtraDimensions:CreateCampaign'
, createCampaign_dataExtraDimensions
- (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
CreateCampaign
, createCampaign_description
- An optional description of the campaign to help identify its purpose.
$sel:diagnosticsMode:CreateCampaign'
, createCampaign_diagnosticsMode
- (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
$sel:expiryTime:CreateCampaign'
, createCampaign_expiryTime
- (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)
$sel:postTriggerCollectionDuration:CreateCampaign'
, createCampaign_postTriggerCollectionDuration
- (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
$sel:priority:CreateCampaign'
, createCampaign_priority
- (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
$sel:signalsToCollect:CreateCampaign'
, createCampaign_signalsToCollect
- (Optional) A list of information about signals to collect.
$sel:spoolingMode:CreateCampaign'
, createCampaign_spoolingMode
- (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
$sel:startTime:CreateCampaign'
, createCampaign_startTime
- (Optional) The time, in milliseconds, to deliver a campaign after it was
approved. If it's not specified, 0
is used.
Default: 0
CreateCampaign
, createCampaign_tags
- Metadata that can be used to manage the campaign.
CreateCampaign
, createCampaign_name
- The name of the campaign to create.
CreateCampaign
, createCampaign_signalCatalogArn
- (Optional) The Amazon Resource Name (ARN) of the signal catalog to
associate with the campaign.
CreateCampaign
, createCampaign_targetArn
- The ARN of the vehicle or fleet to deploy a campaign to.
$sel:collectionScheme:CreateCampaign'
, createCampaign_collectionScheme
- The data collection scheme associated with the campaign. You can specify
a scheme that collects data based on time or an event.
Request Lenses
createCampaign_compression :: Lens' CreateCampaign (Maybe Compression) Source #
(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
createCampaign_dataExtraDimensions :: Lens' CreateCampaign (Maybe [Text]) Source #
(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
createCampaign_description :: Lens' CreateCampaign (Maybe Text) Source #
An optional description of the campaign to help identify its purpose.
createCampaign_diagnosticsMode :: Lens' CreateCampaign (Maybe DiagnosticsMode) Source #
(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
createCampaign_expiryTime :: Lens' CreateCampaign (Maybe UTCTime) Source #
(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)
createCampaign_postTriggerCollectionDuration :: Lens' CreateCampaign (Maybe Natural) Source #
(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
createCampaign_priority :: Lens' CreateCampaign (Maybe Natural) Source #
(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
createCampaign_signalsToCollect :: Lens' CreateCampaign (Maybe [SignalInformation]) Source #
(Optional) A list of information about signals to collect.
createCampaign_spoolingMode :: Lens' CreateCampaign (Maybe SpoolingMode) Source #
(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
createCampaign_startTime :: Lens' CreateCampaign (Maybe UTCTime) Source #
(Optional) The time, in milliseconds, to deliver a campaign after it was
approved. If it's not specified, 0
is used.
Default: 0
createCampaign_tags :: Lens' CreateCampaign (Maybe [Tag]) Source #
Metadata that can be used to manage the campaign.
createCampaign_name :: Lens' CreateCampaign Text Source #
The name of the campaign to create.
createCampaign_signalCatalogArn :: Lens' CreateCampaign Text Source #
(Optional) The Amazon Resource Name (ARN) of the signal catalog to associate with the campaign.
createCampaign_targetArn :: Lens' CreateCampaign Text Source #
The ARN of the vehicle or fleet to deploy a campaign to.
createCampaign_collectionScheme :: Lens' CreateCampaign CollectionScheme Source #
The data collection scheme associated with the campaign. You can specify a scheme that collects data based on time or an event.
Destructuring the Response
data CreateCampaignResponse Source #
See: newCreateCampaignResponse
smart constructor.
Instances
newCreateCampaignResponse Source #
Create a value of CreateCampaignResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateCampaignResponse
, createCampaignResponse_arn
- The ARN of the created campaign.
CreateCampaign
, createCampaignResponse_name
- The name of the created campaign.
$sel:httpStatus:CreateCampaignResponse'
, createCampaignResponse_httpStatus
- The response's http status code.
Response Lenses
createCampaignResponse_arn :: Lens' CreateCampaignResponse (Maybe Text) Source #
The ARN of the created campaign.
createCampaignResponse_name :: Lens' CreateCampaignResponse (Maybe Text) Source #
The name of the created campaign.
createCampaignResponse_httpStatus :: Lens' CreateCampaignResponse Int Source #
The response's http status code.