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.GetCampaign

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves information about a campaign.

Synopsis

data GetCampaign = GetCampaign' {
- name :: Text
}
newGetCampaign :: Text -> GetCampaign
getCampaign_name :: Lens' GetCampaign Text
data GetCampaignResponse = GetCampaignResponse' {
- arn :: Maybe Text
- collectionScheme :: Maybe CollectionScheme
- compression :: Maybe Compression
- creationTime :: Maybe POSIX
- dataExtraDimensions :: Maybe [Text]
- description :: Maybe Text
- diagnosticsMode :: Maybe DiagnosticsMode
- expiryTime :: Maybe POSIX
- lastModificationTime :: Maybe POSIX
- name :: Maybe Text
- postTriggerCollectionDuration :: Maybe Natural
- priority :: Maybe Natural
- signalCatalogArn :: Maybe Text
- signalsToCollect :: Maybe [SignalInformation]
- spoolingMode :: Maybe SpoolingMode
- startTime :: Maybe POSIX
- status :: Maybe CampaignStatus
- targetArn :: Maybe Text
- httpStatus :: Int
}
newGetCampaignResponse :: Int -> GetCampaignResponse
getCampaignResponse_arn :: Lens' GetCampaignResponse (Maybe Text)
getCampaignResponse_collectionScheme :: Lens' GetCampaignResponse (Maybe CollectionScheme)
getCampaignResponse_compression :: Lens' GetCampaignResponse (Maybe Compression)
getCampaignResponse_creationTime :: Lens' GetCampaignResponse (Maybe UTCTime)
getCampaignResponse_dataExtraDimensions :: Lens' GetCampaignResponse (Maybe [Text])
getCampaignResponse_description :: Lens' GetCampaignResponse (Maybe Text)
getCampaignResponse_diagnosticsMode :: Lens' GetCampaignResponse (Maybe DiagnosticsMode)
getCampaignResponse_expiryTime :: Lens' GetCampaignResponse (Maybe UTCTime)
getCampaignResponse_lastModificationTime :: Lens' GetCampaignResponse (Maybe UTCTime)
getCampaignResponse_name :: Lens' GetCampaignResponse (Maybe Text)
getCampaignResponse_postTriggerCollectionDuration :: Lens' GetCampaignResponse (Maybe Natural)
getCampaignResponse_priority :: Lens' GetCampaignResponse (Maybe Natural)
getCampaignResponse_signalCatalogArn :: Lens' GetCampaignResponse (Maybe Text)
getCampaignResponse_signalsToCollect :: Lens' GetCampaignResponse (Maybe [SignalInformation])
getCampaignResponse_spoolingMode :: Lens' GetCampaignResponse (Maybe SpoolingMode)
getCampaignResponse_startTime :: Lens' GetCampaignResponse (Maybe UTCTime)
getCampaignResponse_status :: Lens' GetCampaignResponse (Maybe CampaignStatus)
getCampaignResponse_targetArn :: Lens' GetCampaignResponse (Maybe Text)
getCampaignResponse_httpStatus :: Lens' GetCampaignResponse Int

Creating a Request

data GetCampaign Source #

See: newGetCampaign smart constructor.

Constructors

GetCampaign'
Fields name :: Text The name of the campaign to retrieve information about.

Instances

Instances details

ToJSON GetCampaign Source #
Instance details Defined in Amazonka.IoTFleetWise.GetCampaign Methods toJSON :: GetCampaign -> Value # toEncoding :: GetCampaign -> Encoding # toJSONList :: [GetCampaign] -> Value # toEncodingList :: [GetCampaign] -> Encoding #
ToHeaders GetCampaign Source #
Instance details Defined in Amazonka.IoTFleetWise.GetCampaign Methods toHeaders :: GetCampaign -> [Header] #
ToPath GetCampaign Source #
Instance details Defined in Amazonka.IoTFleetWise.GetCampaign Methods toPath :: GetCampaign -> ByteString #
ToQuery GetCampaign Source #
Instance details Defined in Amazonka.IoTFleetWise.GetCampaign Methods toQuery :: GetCampaign -> QueryString #
AWSRequest GetCampaign Source #
Instance details Defined in Amazonka.IoTFleetWise.GetCampaign Associated Types type AWSResponse GetCampaign # Methods request :: (Service -> Service) -> GetCampaign -> Request GetCampaign # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetCampaign -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetCampaign))) #
Generic GetCampaign Source #
Instance details Defined in Amazonka.IoTFleetWise.GetCampaign Associated Types type Rep GetCampaign :: Type -> Type # Methods from :: GetCampaign -> Rep GetCampaign x # to :: Rep GetCampaign x -> GetCampaign #
Read GetCampaign Source #
Instance details Defined in Amazonka.IoTFleetWise.GetCampaign Methods readsPrec :: Int -> ReadS GetCampaign # readList :: ReadS [GetCampaign] # readPrec :: ReadPrec GetCampaign # readListPrec :: ReadPrec [GetCampaign] #
Show GetCampaign Source #
Instance details Defined in Amazonka.IoTFleetWise.GetCampaign Methods showsPrec :: Int -> GetCampaign -> ShowS # show :: GetCampaign -> String # showList :: [GetCampaign] -> ShowS #
NFData GetCampaign Source #
Instance details Defined in Amazonka.IoTFleetWise.GetCampaign Methods rnf :: GetCampaign -> () #
Eq GetCampaign Source #
Instance details Defined in Amazonka.IoTFleetWise.GetCampaign Methods (==) :: GetCampaign -> GetCampaign -> Bool # (/=) :: GetCampaign -> GetCampaign -> Bool #
Hashable GetCampaign Source #
Instance details Defined in Amazonka.IoTFleetWise.GetCampaign Methods hashWithSalt :: Int -> GetCampaign -> Int # hash :: GetCampaign -> Int #
type AWSResponse GetCampaign Source #
Instance details Defined in Amazonka.IoTFleetWise.GetCampaign type AWSResponse GetCampaign = GetCampaignResponse
type Rep GetCampaign Source #
Instance details Defined in Amazonka.IoTFleetWise.GetCampaign type Rep GetCampaign = D1 ('MetaData "GetCampaign" "Amazonka.IoTFleetWise.GetCampaign" "amazonka-iotfleetwise-2.0-3noXdw9CznA79cw3EwaHcU" 'False) (C1 ('MetaCons "GetCampaign'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetCampaign Source #

Arguments

:: Text	`GetCampaign`
-> GetCampaign

Create a value of GetCampaign 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:

GetCampaign, getCampaign_name - The name of the campaign to retrieve information about.

Request Lenses

getCampaign_name :: Lens' GetCampaign Text Source #

The name of the campaign to retrieve information about.

Destructuring the Response

data GetCampaignResponse Source #

See: newGetCampaignResponse smart constructor.

Constructors

GetCampaignResponse'

Fields

arn :: Maybe Text
The Amazon Resource Name (ARN) of the campaign.
collectionScheme :: Maybe CollectionScheme
Information about the data collection scheme associated with the campaign.
compression :: Maybe Compression
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 :: Maybe POSIX
The time the campaign was created in seconds since epoch (January 1, 1970 at midnight UTC time).
dataExtraDimensions :: Maybe [Text]
A list of vehicle attributes associated with the campaign.
description :: Maybe Text
The description of the campaign.
diagnosticsMode :: Maybe DiagnosticsMode
Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise.
expiryTime :: Maybe POSIX
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 :: Maybe POSIX
The last time the campaign was modified.
name :: Maybe Text
The name of the campaign.
postTriggerCollectionDuration :: Maybe Natural
How long (in seconds) to collect raw data after a triggering event initiates the collection.
priority :: Maybe Natural
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 :: Maybe Text
The ARN of a signal catalog.
signalsToCollect :: Maybe [SignalInformation]
Information about a list of signals to collect data on.
spoolingMode :: Maybe SpoolingMode
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 :: Maybe POSIX
The time, in milliseconds, to deliver a campaign after it was approved.
status :: Maybe CampaignStatus
The state of the campaign. The status can be one of: CREATING, WAITING_FOR_APPROVAL, RUNNING, and SUSPENDED.
targetArn :: Maybe Text
The ARN of the vehicle or the fleet targeted by the campaign.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetCampaignResponse Source #
Instance details Defined in Amazonka.IoTFleetWise.GetCampaign Associated Types type Rep GetCampaignResponse :: Type -> Type # Methods from :: GetCampaignResponse -> Rep GetCampaignResponse x # to :: Rep GetCampaignResponse x -> GetCampaignResponse #
Read GetCampaignResponse Source #
Instance details Defined in Amazonka.IoTFleetWise.GetCampaign Methods readsPrec :: Int -> ReadS GetCampaignResponse # readList :: ReadS [GetCampaignResponse] # readPrec :: ReadPrec GetCampaignResponse # readListPrec :: ReadPrec [GetCampaignResponse] #
Show GetCampaignResponse Source #
Instance details Defined in Amazonka.IoTFleetWise.GetCampaign Methods showsPrec :: Int -> GetCampaignResponse -> ShowS # show :: GetCampaignResponse -> String # showList :: [GetCampaignResponse] -> ShowS #
NFData GetCampaignResponse Source #
Instance details Defined in Amazonka.IoTFleetWise.GetCampaign Methods rnf :: GetCampaignResponse -> () #
Eq GetCampaignResponse Source #
Instance details Defined in Amazonka.IoTFleetWise.GetCampaign Methods (==) :: GetCampaignResponse -> GetCampaignResponse -> Bool # (/=) :: GetCampaignResponse -> GetCampaignResponse -> Bool #
type Rep GetCampaignResponse Source #
Instance details Defined in Amazonka.IoTFleetWise.GetCampaign type Rep GetCampaignResponse = D1 ('MetaData "GetCampaignResponse" "Amazonka.IoTFleetWise.GetCampaign" "amazonka-iotfleetwise-2.0-3noXdw9CznA79cw3EwaHcU" 'False) (C1 ('MetaCons "GetCampaignResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "collectionScheme") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CollectionScheme))) :: (S1 ('MetaSel ('Just "compression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Compression)) :: S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: ((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 "lastModificationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))))) :: (((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "postTriggerCollectionDuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "priority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "signalCatalogArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: 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 "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CampaignStatus)) :: (S1 ('MetaSel ('Just "targetArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))))

newGetCampaignResponse Source #

Arguments

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

Create a value of GetCampaignResponse 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:

GetCampaignResponse, getCampaignResponse_arn - The Amazon Resource Name (ARN) of the campaign.

$sel:collectionScheme:GetCampaignResponse', getCampaignResponse_collectionScheme - Information about the data collection scheme associated with the campaign.

$sel:compression:GetCampaignResponse', getCampaignResponse_compression - 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.

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

$sel:dataExtraDimensions:GetCampaignResponse', getCampaignResponse_dataExtraDimensions - A list of vehicle attributes associated with the campaign.

GetCampaignResponse, getCampaignResponse_description - The description of the campaign.

$sel:diagnosticsMode:GetCampaignResponse', getCampaignResponse_diagnosticsMode - Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise.

$sel:expiryTime:GetCampaignResponse', getCampaignResponse_expiryTime - 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.

GetCampaignResponse, getCampaignResponse_lastModificationTime - The last time the campaign was modified.

GetCampaign, getCampaignResponse_name - The name of the campaign.

$sel:postTriggerCollectionDuration:GetCampaignResponse', getCampaignResponse_postTriggerCollectionDuration - How long (in seconds) to collect raw data after a triggering event initiates the collection.

$sel:priority:GetCampaignResponse', getCampaignResponse_priority - 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.

GetCampaignResponse, getCampaignResponse_signalCatalogArn - The ARN of a signal catalog.

$sel:signalsToCollect:GetCampaignResponse', getCampaignResponse_signalsToCollect - Information about a list of signals to collect data on.

$sel:spoolingMode:GetCampaignResponse', getCampaignResponse_spoolingMode - 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.

$sel:startTime:GetCampaignResponse', getCampaignResponse_startTime - The time, in milliseconds, to deliver a campaign after it was approved.

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

GetCampaignResponse, getCampaignResponse_targetArn - The ARN of the vehicle or the fleet targeted by the campaign.

$sel:httpStatus:GetCampaignResponse', getCampaignResponse_httpStatus - The response's http status code.

Response Lenses

getCampaignResponse_arn :: Lens' GetCampaignResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the campaign.

getCampaignResponse_collectionScheme :: Lens' GetCampaignResponse (Maybe CollectionScheme) Source #

Information about the data collection scheme associated with the campaign.

getCampaignResponse_compression :: Lens' GetCampaignResponse (Maybe Compression) Source #

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.

getCampaignResponse_creationTime :: Lens' GetCampaignResponse (Maybe UTCTime) Source #

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

getCampaignResponse_dataExtraDimensions :: Lens' GetCampaignResponse (Maybe [Text]) Source #

A list of vehicle attributes associated with the campaign.

getCampaignResponse_description :: Lens' GetCampaignResponse (Maybe Text) Source #

The description of the campaign.

getCampaignResponse_diagnosticsMode :: Lens' GetCampaignResponse (Maybe DiagnosticsMode) Source #

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

getCampaignResponse_expiryTime :: Lens' GetCampaignResponse (Maybe UTCTime) Source #

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.

getCampaignResponse_lastModificationTime :: Lens' GetCampaignResponse (Maybe UTCTime) Source #

The last time the campaign was modified.

getCampaignResponse_name :: Lens' GetCampaignResponse (Maybe Text) Source #

The name of the campaign.

getCampaignResponse_postTriggerCollectionDuration :: Lens' GetCampaignResponse (Maybe Natural) Source #

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

getCampaignResponse_priority :: Lens' GetCampaignResponse (Maybe Natural) Source #

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.

getCampaignResponse_signalCatalogArn :: Lens' GetCampaignResponse (Maybe Text) Source #

The ARN of a signal catalog.

getCampaignResponse_signalsToCollect :: Lens' GetCampaignResponse (Maybe [SignalInformation]) Source #

Information about a list of signals to collect data on.

getCampaignResponse_spoolingMode :: Lens' GetCampaignResponse (Maybe SpoolingMode) Source #

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.

getCampaignResponse_startTime :: Lens' GetCampaignResponse (Maybe UTCTime) Source #

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

getCampaignResponse_status :: Lens' GetCampaignResponse (Maybe CampaignStatus) Source #

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

getCampaignResponse_targetArn :: Lens' GetCampaignResponse (Maybe Text) Source #

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

getCampaignResponse_httpStatus :: Lens' GetCampaignResponse Int Source #

The response's http status code.