Class: Aws::IoTFleetWise::Types::UpdateCampaignRequest

Inherits:

Struct

• Object
• Struct
• Aws::IoTFleetWise::Types::UpdateCampaignRequest

Includes:

Structure

Defined in:

lib/aws-sdk-iotfleetwise/types.rb

Constant Summary

SENSITIVE =

[:data_extra_dimensions]

Instance Attribute Summary

• #action ⇒ String

  Specifies how to update a campaign.

• #data_extra_dimensions ⇒ Array<String>

  A list of vehicle attributes to associate with a signal.

• #description ⇒ String

  The description of the campaign.

• #name ⇒ String

  The name of the campaign to update.

Instance Attribute Details

#action ⇒ String

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. The campaign is deleted from vehicles and all vehicles in the suspended campaign will stop sending data.

• ‘RESUME` - To reactivate the `SUSPEND` campaign. The campaign is redeployed to all vehicles and the vehicles will resume sending data.

• ‘UPDATE` - To update a campaign.

Returns:

• (String)

# File 'lib/aws-sdk-iotfleetwise/types.rb', line 4722

class UpdateCampaignRequest < Struct.new(
  :name,
  :description,
  :data_extra_dimensions,
  :action)
  SENSITIVE = [:data_extra_dimensions]
  include Aws::Structure
end

#data_extra_dimensions ⇒ Array<String>

A list of vehicle attributes to associate with a signal.

Default: An empty array

Returns:

• (Array<String>)

# File 'lib/aws-sdk-iotfleetwise/types.rb', line 4722

class UpdateCampaignRequest < Struct.new(
  :name,
  :description,
  :data_extra_dimensions,
  :action)
  SENSITIVE = [:data_extra_dimensions]
  include Aws::Structure
end

#description ⇒ String

The description of the campaign.

Returns:

• (String)

# File 'lib/aws-sdk-iotfleetwise/types.rb', line 4722

class UpdateCampaignRequest < Struct.new(
  :name,
  :description,
  :data_extra_dimensions,
  :action)
  SENSITIVE = [:data_extra_dimensions]
  include Aws::Structure
end

#name ⇒ String

The name of the campaign to update.

Returns:

• (String)

# File 'lib/aws-sdk-iotfleetwise/types.rb', line 4722

class UpdateCampaignRequest < Struct.new(
  :name,
  :description,
  :data_extra_dimensions,
  :action)
  SENSITIVE = [:data_extra_dimensions]
  include Aws::Structure
end