Class: Aws::IoTFleetWise::Types::CampaignSummary

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-iotfleetwise/types.rb

Overview

Information about a campaign.

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The Amazon Resource Name (ARN) of a campaign.

Returns:

  • (String)


320
321
322
323
324
325
326
327
328
329
330
331
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 320

class CampaignSummary < Struct.new(
  :arn,
  :name,
  :description,
  :signal_catalog_arn,
  :target_arn,
  :status,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#creation_timeTime

The time the campaign was created.

Returns:

  • (Time)


320
321
322
323
324
325
326
327
328
329
330
331
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 320

class CampaignSummary < Struct.new(
  :arn,
  :name,
  :description,
  :signal_catalog_arn,
  :target_arn,
  :status,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The description of the campaign.

Returns:

  • (String)


320
321
322
323
324
325
326
327
328
329
330
331
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 320

class CampaignSummary < Struct.new(
  :arn,
  :name,
  :description,
  :signal_catalog_arn,
  :target_arn,
  :status,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#last_modification_timeTime

The last time the campaign was modified.

Returns:

  • (Time)


320
321
322
323
324
325
326
327
328
329
330
331
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 320

class CampaignSummary < Struct.new(
  :arn,
  :name,
  :description,
  :signal_catalog_arn,
  :target_arn,
  :status,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of a campaign.

Returns:

  • (String)


320
321
322
323
324
325
326
327
328
329
330
331
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 320

class CampaignSummary < Struct.new(
  :arn,
  :name,
  :description,
  :signal_catalog_arn,
  :target_arn,
  :status,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#signal_catalog_arnString

The ARN of the signal catalog associated with the campaign.

Returns:

  • (String)


320
321
322
323
324
325
326
327
328
329
330
331
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 320

class CampaignSummary < Struct.new(
  :arn,
  :name,
  :description,
  :signal_catalog_arn,
  :target_arn,
  :status,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

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.

Returns:

  • (String)


320
321
322
323
324
325
326
327
328
329
330
331
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 320

class CampaignSummary < Struct.new(
  :arn,
  :name,
  :description,
  :signal_catalog_arn,
  :target_arn,
  :status,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#target_arnString

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

Returns:

  • (String)


320
321
322
323
324
325
326
327
328
329
330
331
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 320

class CampaignSummary < Struct.new(
  :arn,
  :name,
  :description,
  :signal_catalog_arn,
  :target_arn,
  :status,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end