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

Amazonka.IoTFleetWise.CreateCampaign

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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' {
- arn :: Maybe Text
- name :: Maybe Text
- httpStatus :: Int
}
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.

Constructors

CreateCampaign'

Fields

compression :: Maybe 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
dataExtraDimensions :: Maybe [Text]
(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 :: Maybe Text
An optional description of the campaign to help identify its purpose.
diagnosticsMode :: Maybe 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
expiryTime :: Maybe POSIX
(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)
postTriggerCollectionDuration :: Maybe Natural
(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 :: Maybe Natural
(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
signalsToCollect :: Maybe [SignalInformation]
(Optional) A list of information about signals to collect.
spoolingMode :: Maybe 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
startTime :: Maybe POSIX
(Optional) The time, in milliseconds, to deliver a campaign after it was approved. If it's not specified, 0 is used.
Default: 0
tags :: Maybe [Tag]
Metadata that can be used to manage the campaign.
name :: Text
The name of the campaign to create.
signalCatalogArn :: Text
(Optional) The Amazon Resource Name (ARN) of the signal catalog to associate with the campaign.
targetArn :: Text
The ARN of the vehicle or fleet to deploy a campaign to.
collectionScheme :: CollectionScheme
The data collection scheme associated with the campaign. You can specify a scheme that collects data based on time or an event.

Instances

Instances details

ToJSON CreateCampaign Source #
Instance details Defined in Amazonka.IoTFleetWise.CreateCampaign Methods toJSON :: CreateCampaign -> Value # toEncoding :: CreateCampaign -> Encoding # toJSONList :: [CreateCampaign] -> Value # toEncodingList :: [CreateCampaign] -> Encoding #
ToHeaders CreateCampaign Source #
Instance details Defined in Amazonka.IoTFleetWise.CreateCampaign Methods toHeaders :: CreateCampaign -> [Header] #
ToPath CreateCampaign Source #
Instance details Defined in Amazonka.IoTFleetWise.CreateCampaign Methods toPath :: CreateCampaign -> ByteString #
ToQuery CreateCampaign Source #
Instance details Defined in Amazonka.IoTFleetWise.CreateCampaign Methods toQuery :: CreateCampaign -> QueryString #
AWSRequest CreateCampaign Source #
Instance details Defined in Amazonka.IoTFleetWise.CreateCampaign Associated Types type AWSResponse CreateCampaign # Methods request :: (Service -> Service) -> CreateCampaign -> Request CreateCampaign # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateCampaign -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateCampaign))) #
Generic CreateCampaign Source #
Instance details Defined in Amazonka.IoTFleetWise.CreateCampaign Associated Types type Rep CreateCampaign :: Type -> Type # Methods from :: CreateCampaign -> Rep CreateCampaign x # to :: Rep CreateCampaign x -> CreateCampaign #
Read CreateCampaign Source #
Instance details Defined in Amazonka.IoTFleetWise.CreateCampaign Methods readsPrec :: Int -> ReadS CreateCampaign # readList :: ReadS [CreateCampaign] # readPrec :: ReadPrec CreateCampaign # readListPrec :: ReadPrec [CreateCampaign] #
Show CreateCampaign Source #
Instance details Defined in Amazonka.IoTFleetWise.CreateCampaign Methods showsPrec :: Int -> CreateCampaign -> ShowS # show :: CreateCampaign -> String # showList :: [CreateCampaign] -> ShowS #
NFData CreateCampaign Source #
Instance details Defined in Amazonka.IoTFleetWise.CreateCampaign Methods rnf :: CreateCampaign -> () #
Eq CreateCampaign Source #
Instance details Defined in Amazonka.IoTFleetWise.CreateCampaign Methods (==) :: CreateCampaign -> CreateCampaign -> Bool # (/=) :: CreateCampaign -> CreateCampaign -> Bool #
Hashable CreateCampaign Source #
Instance details Defined in Amazonka.IoTFleetWise.CreateCampaign Methods hashWithSalt :: Int -> CreateCampaign -> Int # hash :: CreateCampaign -> Int #
type AWSResponse CreateCampaign Source #
Instance details Defined in Amazonka.IoTFleetWise.CreateCampaign type AWSResponse CreateCampaign = CreateCampaignResponse
type Rep CreateCampaign Source #
Instance details Defined in Amazonka.IoTFleetWise.CreateCampaign type Rep CreateCampaign = D1 ('MetaData "CreateCampaign" "Amazonka.IoTFleetWise.CreateCampaign" "amazonka-iotfleetwise-2.0-3noXdw9CznA79cw3EwaHcU" 'False) (C1 ('MetaCons "CreateCampaign'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "compression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Compression)) :: (S1 ('MetaSel ('Just "dataExtraDimensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "diagnosticsMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DiagnosticsMode)) :: S1 ('MetaSel ('Just "expiryTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "postTriggerCollectionDuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "priority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))) :: (((S1 ('MetaSel ('Just "signalsToCollect") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SignalInformation])) :: S1 ('MetaSel ('Just "spoolingMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SpoolingMode))) :: (S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])))) :: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "signalCatalogArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "targetArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "collectionScheme") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CollectionScheme))))))

newCreateCampaign Source #

Arguments

:: Text	`CreateCampaign`
-> Text	`CreateCampaign`
-> Text	`CreateCampaign`
-> CollectionScheme	`$sel:collectionScheme:CreateCampaign'`
-> 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.

Constructors

CreateCampaignResponse'
Fields arn :: Maybe Text The ARN of the created campaign. name :: Maybe Text The name of the created campaign. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateCampaignResponse Source #
Instance details Defined in Amazonka.IoTFleetWise.CreateCampaign Associated Types type Rep CreateCampaignResponse :: Type -> Type # Methods from :: CreateCampaignResponse -> Rep CreateCampaignResponse x # to :: Rep CreateCampaignResponse x -> CreateCampaignResponse #
Read CreateCampaignResponse Source #
Instance details Defined in Amazonka.IoTFleetWise.CreateCampaign Methods readsPrec :: Int -> ReadS CreateCampaignResponse # readList :: ReadS [CreateCampaignResponse] # readPrec :: ReadPrec CreateCampaignResponse # readListPrec :: ReadPrec [CreateCampaignResponse] #
Show CreateCampaignResponse Source #
Instance details Defined in Amazonka.IoTFleetWise.CreateCampaign Methods showsPrec :: Int -> CreateCampaignResponse -> ShowS # show :: CreateCampaignResponse -> String # showList :: [CreateCampaignResponse] -> ShowS #
NFData CreateCampaignResponse Source #
Instance details Defined in Amazonka.IoTFleetWise.CreateCampaign Methods rnf :: CreateCampaignResponse -> () #
Eq CreateCampaignResponse Source #
Instance details Defined in Amazonka.IoTFleetWise.CreateCampaign Methods (==) :: CreateCampaignResponse -> CreateCampaignResponse -> Bool # (/=) :: CreateCampaignResponse -> CreateCampaignResponse -> Bool #
type Rep CreateCampaignResponse Source #
Instance details Defined in Amazonka.IoTFleetWise.CreateCampaign type Rep CreateCampaignResponse = D1 ('MetaData "CreateCampaignResponse" "Amazonka.IoTFleetWise.CreateCampaign" "amazonka-iotfleetwise-2.0-3noXdw9CznA79cw3EwaHcU" 'False) (C1 ('MetaCons "CreateCampaignResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateCampaignResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateCampaignResponse'`
-> CreateCampaignResponse

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.