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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates a campaign.

Synopsis

data UpdateCampaign = UpdateCampaign' {
- dataExtraDimensions :: Maybe [Text]
- description :: Maybe Text
- name :: Text
- action :: UpdateCampaignAction
}
newUpdateCampaign :: Text -> UpdateCampaignAction -> UpdateCampaign
updateCampaign_dataExtraDimensions :: Lens' UpdateCampaign (Maybe [Text])
updateCampaign_description :: Lens' UpdateCampaign (Maybe Text)
updateCampaign_name :: Lens' UpdateCampaign Text
updateCampaign_action :: Lens' UpdateCampaign UpdateCampaignAction
data UpdateCampaignResponse = UpdateCampaignResponse' {
- arn :: Maybe Text
- name :: Maybe Text
- status :: Maybe CampaignStatus
- httpStatus :: Int
}
newUpdateCampaignResponse :: Int -> UpdateCampaignResponse
updateCampaignResponse_arn :: Lens' UpdateCampaignResponse (Maybe Text)
updateCampaignResponse_name :: Lens' UpdateCampaignResponse (Maybe Text)
updateCampaignResponse_status :: Lens' UpdateCampaignResponse (Maybe CampaignStatus)
updateCampaignResponse_httpStatus :: Lens' UpdateCampaignResponse Int

Creating a Request

data UpdateCampaign Source #

See: newUpdateCampaign smart constructor.

Constructors

UpdateCampaign'

Fields

dataExtraDimensions :: Maybe [Text]
A list of vehicle attributes to associate with a signal.
Default: An empty array
description :: Maybe Text
The description of the campaign.
name :: Text
The name of the campaign to update.
action :: UpdateCampaignAction
Specifies how to update a campaign. The action can be one of the following:
- APPROVE - To approve delivering a data collection scheme to vehicles.
- SUSPEND - To suspend collecting signal data.
- RESUME - To resume collecting signal data.
- UPDATE - To update a campaign.

Instances

Instances details

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

newUpdateCampaign Source #

Arguments

:: Text	`UpdateCampaign`
-> UpdateCampaignAction	`$sel:action:UpdateCampaign'`
-> UpdateCampaign

Create a value of UpdateCampaign 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:dataExtraDimensions:UpdateCampaign', updateCampaign_dataExtraDimensions - A list of vehicle attributes to associate with a signal.

Default: An empty array

UpdateCampaign, updateCampaign_description - The description of the campaign.

UpdateCampaign, updateCampaign_name - The name of the campaign to update.

$sel:action:UpdateCampaign', updateCampaign_action - Specifies how to update a campaign. The action can be one of the following:

APPROVE - To approve delivering a data collection scheme to vehicles.
SUSPEND - To suspend collecting signal data.
RESUME - To resume collecting signal data.
UPDATE - To update a campaign.

Request Lenses

updateCampaign_dataExtraDimensions :: Lens' UpdateCampaign (Maybe [Text]) Source #

A list of vehicle attributes to associate with a signal.

Default: An empty array

updateCampaign_description :: Lens' UpdateCampaign (Maybe Text) Source #

The description of the campaign.

updateCampaign_name :: Lens' UpdateCampaign Text Source #

The name of the campaign to update.

updateCampaign_action :: Lens' UpdateCampaign UpdateCampaignAction Source #

Specifies how to update a campaign. The action can be one of the following:

APPROVE - To approve delivering a data collection scheme to vehicles.
SUSPEND - To suspend collecting signal data.
RESUME - To resume collecting signal data.
UPDATE - To update a campaign.

Destructuring the Response

data UpdateCampaignResponse Source #

See: newUpdateCampaignResponse smart constructor.

Constructors

UpdateCampaignResponse'

Fields

arn :: Maybe Text
The Amazon Resource Name (ARN) of the campaign.
name :: Maybe Text
The name of the updated campaign.
status :: Maybe CampaignStatus
The state of a campaign. The status can be one of:
- CREATING - Amazon Web Services IoT FleetWise is processing your request to create the campaign.
- WAITING_FOR_APPROVAL - After a campaign is created, it enters the WAITING_FOR_APPROVAL state. To allow Amazon Web Services IoT FleetWise to deploy the campaign to the target vehicle or fleet, use the API operation to approve the campaign.
- RUNNING - The campaign is active.
- SUSPENDED - The campaign is suspended. To resume the campaign, use the API operation.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic UpdateCampaignResponse Source #
Instance details Defined in Amazonka.IoTFleetWise.UpdateCampaign Associated Types type Rep UpdateCampaignResponse :: Type -> Type # Methods from :: UpdateCampaignResponse -> Rep UpdateCampaignResponse x # to :: Rep UpdateCampaignResponse x -> UpdateCampaignResponse #
Read UpdateCampaignResponse Source #
Instance details Defined in Amazonka.IoTFleetWise.UpdateCampaign Methods readsPrec :: Int -> ReadS UpdateCampaignResponse # readList :: ReadS [UpdateCampaignResponse] # readPrec :: ReadPrec UpdateCampaignResponse # readListPrec :: ReadPrec [UpdateCampaignResponse] #
Show UpdateCampaignResponse Source #
Instance details Defined in Amazonka.IoTFleetWise.UpdateCampaign Methods showsPrec :: Int -> UpdateCampaignResponse -> ShowS # show :: UpdateCampaignResponse -> String # showList :: [UpdateCampaignResponse] -> ShowS #
NFData UpdateCampaignResponse Source #
Instance details Defined in Amazonka.IoTFleetWise.UpdateCampaign Methods rnf :: UpdateCampaignResponse -> () #
Eq UpdateCampaignResponse Source #
Instance details Defined in Amazonka.IoTFleetWise.UpdateCampaign Methods (==) :: UpdateCampaignResponse -> UpdateCampaignResponse -> Bool # (/=) :: UpdateCampaignResponse -> UpdateCampaignResponse -> Bool #
type Rep UpdateCampaignResponse Source #
Instance details Defined in Amazonka.IoTFleetWise.UpdateCampaign type Rep UpdateCampaignResponse = D1 ('MetaData "UpdateCampaignResponse" "Amazonka.IoTFleetWise.UpdateCampaign" "amazonka-iotfleetwise-2.0-3noXdw9CznA79cw3EwaHcU" 'False) (C1 ('MetaCons "UpdateCampaignResponse'" '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 "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CampaignStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newUpdateCampaignResponse Source #

Arguments

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

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

UpdateCampaignResponse, updateCampaignResponse_arn - The Amazon Resource Name (ARN) of the campaign.

UpdateCampaign, updateCampaignResponse_name - The name of the updated campaign.

UpdateCampaignResponse, updateCampaignResponse_status - The state of a campaign. The status can be one of:

CREATING - Amazon Web Services IoT FleetWise is processing your request to create the campaign.
WAITING_FOR_APPROVAL - After a campaign is created, it enters the WAITING_FOR_APPROVAL state. To allow Amazon Web Services IoT FleetWise to deploy the campaign to the target vehicle or fleet, use the API operation to approve the campaign.
RUNNING - The campaign is active.
SUSPENDED - The campaign is suspended. To resume the campaign, use the API operation.

$sel:httpStatus:UpdateCampaignResponse', updateCampaignResponse_httpStatus - The response's http status code.

Response Lenses

updateCampaignResponse_arn :: Lens' UpdateCampaignResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the campaign.

updateCampaignResponse_name :: Lens' UpdateCampaignResponse (Maybe Text) Source #

The name of the updated campaign.

updateCampaignResponse_status :: Lens' UpdateCampaignResponse (Maybe CampaignStatus) Source #

The state of a campaign. The status can be one of:

CREATING - Amazon Web Services IoT FleetWise is processing your request to create the campaign.
WAITING_FOR_APPROVAL - After a campaign is created, it enters the WAITING_FOR_APPROVAL state. To allow Amazon Web Services IoT FleetWise to deploy the campaign to the target vehicle or fleet, use the API operation to approve the campaign.
RUNNING - The campaign is active.
SUSPENDED - The campaign is suspended. To resume the campaign, use the API operation.

updateCampaignResponse_httpStatus :: Lens' UpdateCampaignResponse Int Source #

The response's http status code.