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

Inherits:

Struct

• Object
• Struct
• Aws::IoTFleetWise::Types::CampaignSummary

Defined in:

gems/aws-sdk-iotfleetwise/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

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

  The Amazon Resource Name (ARN) of a campaign.

• #creation_time ⇒ Time

  The time the campaign was created.

• #description ⇒ String

  The description of the campaign.

• #last_modification_time ⇒ Time

  The last time the campaign was modified.

• #name ⇒ String

  The name of a campaign.

• #signal_catalog_arn ⇒ String

  The ARN of the signal catalog associated with the campaign.

• #status ⇒ String

  The state of a campaign.

• #target_arn ⇒ String

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

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of a campaign.

Returns:

• (String)

# File 'gems/aws-sdk-iotfleetwise/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_time ⇒ Time

The time the campaign was created.

Returns:

• (Time)

# File 'gems/aws-sdk-iotfleetwise/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

#description ⇒ String

The description of the campaign.

Returns:

• (String)

# File 'gems/aws-sdk-iotfleetwise/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_time ⇒ Time

The last time the campaign was modified.

Returns:

• (Time)

# File 'gems/aws-sdk-iotfleetwise/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

#name ⇒ String

The name of a campaign.

Returns:

• (String)

# File 'gems/aws-sdk-iotfleetwise/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_arn ⇒ String

The ARN of the signal catalog associated with the campaign.

Returns:

• (String)

# File 'gems/aws-sdk-iotfleetwise/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

#status ⇒ String

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)

# File 'gems/aws-sdk-iotfleetwise/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_arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-iotfleetwise/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