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 |
Updates a campaign.
Synopsis
- data UpdateCampaign = UpdateCampaign' {}
- 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' {}
- 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.
UpdateCampaign' | |
|
Instances
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.
UpdateCampaignResponse' | |
|
Instances
newUpdateCampaignResponse Source #
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 theWAITING_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 theWAITING_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.