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 |
Synopsis
- data CampaignSummary = CampaignSummary' {}
- newCampaignSummary :: UTCTime -> UTCTime -> CampaignSummary
- campaignSummary_arn :: Lens' CampaignSummary (Maybe Text)
- campaignSummary_description :: Lens' CampaignSummary (Maybe Text)
- campaignSummary_name :: Lens' CampaignSummary (Maybe Text)
- campaignSummary_signalCatalogArn :: Lens' CampaignSummary (Maybe Text)
- campaignSummary_status :: Lens' CampaignSummary (Maybe CampaignStatus)
- campaignSummary_targetArn :: Lens' CampaignSummary (Maybe Text)
- campaignSummary_creationTime :: Lens' CampaignSummary UTCTime
- campaignSummary_lastModificationTime :: Lens' CampaignSummary UTCTime
Documentation
data CampaignSummary Source #
Information about a campaign.
You can use the API operation to return this information about multiple created campaigns.
See: newCampaignSummary
smart constructor.
CampaignSummary' | |
|
Instances
:: UTCTime | |
-> UTCTime | |
-> CampaignSummary |
Create a value of CampaignSummary
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:arn:CampaignSummary'
, campaignSummary_arn
- The Amazon Resource Name (ARN) of a campaign.
$sel:description:CampaignSummary'
, campaignSummary_description
- The description of the campaign.
$sel:name:CampaignSummary'
, campaignSummary_name
- The name of a campaign.
$sel:signalCatalogArn:CampaignSummary'
, campaignSummary_signalCatalogArn
- The ARN of the signal catalog associated with the campaign.
$sel:status:CampaignSummary'
, campaignSummary_status
- The state of a campaign. The status can be one of the following:
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:targetArn:CampaignSummary'
, campaignSummary_targetArn
- The ARN of a vehicle or fleet to which the campaign is deployed.
$sel:creationTime:CampaignSummary'
, campaignSummary_creationTime
- The time the campaign was created.
$sel:lastModificationTime:CampaignSummary'
, campaignSummary_lastModificationTime
- The last time the campaign was modified.
campaignSummary_arn :: Lens' CampaignSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of a campaign.
campaignSummary_description :: Lens' CampaignSummary (Maybe Text) Source #
The description of the campaign.
campaignSummary_name :: Lens' CampaignSummary (Maybe Text) Source #
The name of a campaign.
campaignSummary_signalCatalogArn :: Lens' CampaignSummary (Maybe Text) Source #
The ARN of the signal catalog associated with the campaign.
campaignSummary_status :: Lens' CampaignSummary (Maybe CampaignStatus) Source #
The state of a campaign. The status can be one of the following:
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.
campaignSummary_targetArn :: Lens' CampaignSummary (Maybe Text) Source #
The ARN of a vehicle or fleet to which the campaign is deployed.
campaignSummary_creationTime :: Lens' CampaignSummary UTCTime Source #
The time the campaign was created.
campaignSummary_lastModificationTime :: Lens' CampaignSummary UTCTime Source #
The last time the campaign was modified.