Amazonka.IoTFleetWise.Types.CampaignSummary

Documentation

data CampaignSummary

Information about a campaign.

You can use the API operation to return this information about multiple created campaigns.

See: newCampaignSummary smart constructor.

Constructors

CampaignSummary'

Fields

• arn :: Maybe Text

  The Amazon Resource Name (ARN) of a campaign.

• description :: Maybe Text

  The description of the campaign.

• name :: Maybe Text

  The name of a campaign.

• signalCatalogArn :: Maybe Text

  The ARN of the signal catalog associated with the campaign.

• status :: Maybe CampaignStatus

  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 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.
• targetArn :: Maybe Text

  The ARN of a vehicle or fleet to which the campaign is deployed.

• creationTime :: POSIX

  The time the campaign was created.

• lastModificationTime :: POSIX

  The last time the campaign was modified.

Instances

FromJSON CampaignSummary

Defined in Amazonka.IoTFleetWise.Types.CampaignSummary

Methods

parseJSON :: Value -> Parser CampaignSummary

parseJSONList :: Value -> Parser [CampaignSummary]

Generic CampaignSummary

Defined in Amazonka.IoTFleetWise.Types.CampaignSummary

Associated Types

type Rep CampaignSummary :: Type -> Type

Methods

from :: CampaignSummary -> Rep CampaignSummary x

to :: Rep CampaignSummary x -> CampaignSummary

Read CampaignSummary

Defined in Amazonka.IoTFleetWise.Types.CampaignSummary

Methods

readsPrec :: Int -> ReadS CampaignSummary

readList :: ReadS [CampaignSummary]

readPrec :: ReadPrec CampaignSummary

readListPrec :: ReadPrec [CampaignSummary]

Show CampaignSummary

Defined in Amazonka.IoTFleetWise.Types.CampaignSummary

Methods

showsPrec :: Int -> CampaignSummary -> ShowS

show :: CampaignSummary -> String

showList :: [CampaignSummary] -> ShowS

NFData CampaignSummary

Defined in Amazonka.IoTFleetWise.Types.CampaignSummary

Methods

rnf :: CampaignSummary -> ()

Eq CampaignSummary

Defined in Amazonka.IoTFleetWise.Types.CampaignSummary

Methods

(==) :: CampaignSummary -> CampaignSummary -> Bool

(/=) :: CampaignSummary -> CampaignSummary -> Bool

Hashable CampaignSummary

Defined in Amazonka.IoTFleetWise.Types.CampaignSummary

Methods

hashWithSalt :: Int -> CampaignSummary -> Int

hash :: CampaignSummary -> Int

type Rep CampaignSummary

Defined in Amazonka.IoTFleetWise.Types.CampaignSummary

type Rep CampaignSummary = D1 ('MetaData "CampaignSummary" "Amazonka.IoTFleetWise.Types.CampaignSummary" "amazonka-iotfleetwise-2.0-3noXdw9CznA79cw3EwaHcU" 'False) (C1 ('MetaCons "CampaignSummary'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "signalCatalogArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CampaignStatus)) :*: S1 ('MetaSel ('Just "targetArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "lastModificationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX)))))

newCampaignSummary

Arguments

:: UTCTime

$sel:creationTime:CampaignSummary'

-> UTCTime

$sel:lastModificationTime:CampaignSummary'

-> 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 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: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)

The Amazon Resource Name (ARN) of a campaign.

campaignSummary_description :: Lens' CampaignSummary (Maybe Text)

The description of the campaign.

campaignSummary_name :: Lens' CampaignSummary (Maybe Text)

The name of a campaign.

campaignSummary_signalCatalogArn :: Lens' CampaignSummary (Maybe Text)

The ARN of the signal catalog associated with the campaign.

campaignSummary_status :: Lens' CampaignSummary (Maybe CampaignStatus)

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

campaignSummary_targetArn :: Lens' CampaignSummary (Maybe Text)

The ARN of a vehicle or fleet to which the campaign is deployed.

campaignSummary_creationTime :: Lens' CampaignSummary UTCTime

The time the campaign was created.

campaignSummary_lastModificationTime :: Lens' CampaignSummary UTCTime

The last time the campaign was modified.