Class: Aws::IoTFleetWise::Types::CreateCampaignRequest

Inherits:

Struct

Object
Struct
Aws::IoTFleetWise::Types::CreateCampaignRequest

show all

Defined in:: gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/types.rb

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#collection_scheme ⇒ Types::CollectionScheme
The data collection scheme associated with the campaign.
#compression ⇒ String
(Optional) Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise.
#data_destination_configs ⇒ Array<Types::DataDestinationConfig>
The destination where the campaign sends data.
#data_extra_dimensions ⇒ Array<String>
(Optional) A list of vehicle attributes to associate with a campaign.
#description ⇒ String
An optional description of the campaign to help identify its purpose.
#diagnostics_mode ⇒ String
(Optional) Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise.
#expiry_time ⇒ Time
(Optional) The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time).
#name ⇒ String
The name of the campaign to create.
#post_trigger_collection_duration ⇒ Integer
(Optional) How long (in milliseconds) to collect raw data after a triggering event initiates the collection.
#priority ⇒ Integer
(Optional) A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet.
#signal_catalog_arn ⇒ String
(Optional) The Amazon Resource Name (ARN) of the signal catalog to associate with the campaign.
#signals_to_collect ⇒ Array<Types::SignalInformation>
(Optional) A list of information about signals to collect.
#spooling_mode ⇒ String
(Optional) Whether to store collected data after a vehicle lost a connection with the cloud.
#start_time ⇒ Time
(Optional) The time, in milliseconds, to deliver a campaign after it was approved.
#tags ⇒ Array<Types::Tag>
Metadata that can be used to manage the campaign.
#target_arn ⇒ String
The ARN of the vehicle or fleet to deploy a campaign to.

Instance Attribute Details

#collection_scheme ⇒ `Types::CollectionScheme`

The data collection scheme associated with the campaign. You can specify a scheme that collects data based on time or an event.

Returns:

(Types::CollectionScheme)

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

class CreateCampaignRequest < Struct.new(
  :name,
  :description,
  :signal_catalog_arn,
  :target_arn,
  :start_time,
  :expiry_time,
  :post_trigger_collection_duration,
  :diagnostics_mode,
  :spooling_mode,
  :compression,
  :priority,
  :signals_to_collect,
  :collection_scheme,
  :data_extra_dimensions,
  :tags,
  :data_destination_configs)
  SENSITIVE = []
  include Aws::Structure
end

#compression ⇒ `String`

(Optional) Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If you don't want to compress the signals, use OFF. If it's not specified, SNAPPY is used.

Default: SNAPPY

Returns:

(String)

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

class CreateCampaignRequest < Struct.new(
  :name,
  :description,
  :signal_catalog_arn,
  :target_arn,
  :start_time,
  :expiry_time,
  :post_trigger_collection_duration,
  :diagnostics_mode,
  :spooling_mode,
  :compression,
  :priority,
  :signals_to_collect,
  :collection_scheme,
  :data_extra_dimensions,
  :tags,
  :data_destination_configs)
  SENSITIVE = []
  include Aws::Structure
end

#data_destination_configs ⇒ `Array<Types::DataDestinationConfig>`

The destination where the campaign sends data. You can choose to send data to be stored in Amazon S3 or Amazon Timestream.

Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics. Amazon Web Services IoT FleetWise supports at-least-once file delivery to S3. Your vehicle data is stored on multiple Amazon Web Services IoT FleetWise servers for redundancy and high availability.

You can use Amazon Timestream to access and analyze time series data, and Timestream to query vehicle data so that you can identify trends and patterns.

Returns:

(Array<Types::DataDestinationConfig>)

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

class CreateCampaignRequest < Struct.new(
  :name,
  :description,
  :signal_catalog_arn,
  :target_arn,
  :start_time,
  :expiry_time,
  :post_trigger_collection_duration,
  :diagnostics_mode,
  :spooling_mode,
  :compression,
  :priority,
  :signals_to_collect,
  :collection_scheme,
  :data_extra_dimensions,
  :tags,
  :data_destination_configs)
  SENSITIVE = []
  include Aws::Structure
end

#data_extra_dimensions ⇒ `Array<String>`

(Optional) A list of vehicle attributes to associate with a campaign.

Enrich the data with specified vehicle attributes. For example, add make and model to the campaign, and Amazon Web Services IoT FleetWise will associate the data with those attributes as dimensions in Amazon Timestream. You can then query the data against make and model.

Default: An empty array

Returns:

(Array<String>)

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

class CreateCampaignRequest < Struct.new(
  :name,
  :description,
  :signal_catalog_arn,
  :target_arn,
  :start_time,
  :expiry_time,
  :post_trigger_collection_duration,
  :diagnostics_mode,
  :spooling_mode,
  :compression,
  :priority,
  :signals_to_collect,
  :collection_scheme,
  :data_extra_dimensions,
  :tags,
  :data_destination_configs)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ `String`

An optional description of the campaign to help identify its purpose.

Returns:

(String)

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

class CreateCampaignRequest < Struct.new(
  :name,
  :description,
  :signal_catalog_arn,
  :target_arn,
  :start_time,
  :expiry_time,
  :post_trigger_collection_duration,
  :diagnostics_mode,
  :spooling_mode,
  :compression,
  :priority,
  :signals_to_collect,
  :collection_scheme,
  :data_extra_dimensions,
  :tags,
  :data_destination_configs)
  SENSITIVE = []
  include Aws::Structure
end

#diagnostics_mode ⇒ `String`

(Optional) Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise. If you want to send diagnostic trouble codes, use SEND_ACTIVE_DTCS. If it's not specified, OFF is used.

Default: OFF

Returns:

(String)

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

class CreateCampaignRequest < Struct.new(
  :name,
  :description,
  :signal_catalog_arn,
  :target_arn,
  :start_time,
  :expiry_time,
  :post_trigger_collection_duration,
  :diagnostics_mode,
  :spooling_mode,
  :compression,
  :priority,
  :signals_to_collect,
  :collection_scheme,
  :data_extra_dimensions,
  :tags,
  :data_destination_configs)
  SENSITIVE = []
  include Aws::Structure
end

#expiry_time ⇒ `Time`

(Optional) The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time). Vehicle data isn't collected after the campaign expires.

Default: 253402214400 (December 31, 9999, 00:00:00 UTC)

Returns:

(Time)

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

class CreateCampaignRequest < Struct.new(
  :name,
  :description,
  :signal_catalog_arn,
  :target_arn,
  :start_time,
  :expiry_time,
  :post_trigger_collection_duration,
  :diagnostics_mode,
  :spooling_mode,
  :compression,
  :priority,
  :signals_to_collect,
  :collection_scheme,
  :data_extra_dimensions,
  :tags,
  :data_destination_configs)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ `String`

The name of the campaign to create.

Returns:

(String)

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

class CreateCampaignRequest < Struct.new(
  :name,
  :description,
  :signal_catalog_arn,
  :target_arn,
  :start_time,
  :expiry_time,
  :post_trigger_collection_duration,
  :diagnostics_mode,
  :spooling_mode,
  :compression,
  :priority,
  :signals_to_collect,
  :collection_scheme,
  :data_extra_dimensions,
  :tags,
  :data_destination_configs)
  SENSITIVE = []
  include Aws::Structure
end

#post_trigger_collection_duration ⇒ `Integer`

(Optional) How long (in milliseconds) to collect raw data after a triggering event initiates the collection. If it's not specified, 0 is used.

Default: 0

Returns:

(Integer)

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

class CreateCampaignRequest < Struct.new(
  :name,
  :description,
  :signal_catalog_arn,
  :target_arn,
  :start_time,
  :expiry_time,
  :post_trigger_collection_duration,
  :diagnostics_mode,
  :spooling_mode,
  :compression,
  :priority,
  :signals_to_collect,
  :collection_scheme,
  :data_extra_dimensions,
  :tags,
  :data_destination_configs)
  SENSITIVE = []
  include Aws::Structure
end

#priority ⇒ `Integer`

(Optional) A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet. A campaign with the lowest value is deployed to vehicles before any other campaigns. If it's not specified, 0 is used.

Default: 0

Returns:

(Integer)

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

class CreateCampaignRequest < Struct.new(
  :name,
  :description,
  :signal_catalog_arn,
  :target_arn,
  :start_time,
  :expiry_time,
  :post_trigger_collection_duration,
  :diagnostics_mode,
  :spooling_mode,
  :compression,
  :priority,
  :signals_to_collect,
  :collection_scheme,
  :data_extra_dimensions,
  :tags,
  :data_destination_configs)
  SENSITIVE = []
  include Aws::Structure
end

#signal_catalog_arn ⇒ `String`

(Optional) The Amazon Resource Name (ARN) of the signal catalog to associate with the campaign.

Returns:

(String)

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

class CreateCampaignRequest < Struct.new(
  :name,
  :description,
  :signal_catalog_arn,
  :target_arn,
  :start_time,
  :expiry_time,
  :post_trigger_collection_duration,
  :diagnostics_mode,
  :spooling_mode,
  :compression,
  :priority,
  :signals_to_collect,
  :collection_scheme,
  :data_extra_dimensions,
  :tags,
  :data_destination_configs)
  SENSITIVE = []
  include Aws::Structure
end

#signals_to_collect ⇒ `Array<Types::SignalInformation>`

(Optional) A list of information about signals to collect.

Returns:

(Array<Types::SignalInformation>)

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

class CreateCampaignRequest < Struct.new(
  :name,
  :description,
  :signal_catalog_arn,
  :target_arn,
  :start_time,
  :expiry_time,
  :post_trigger_collection_duration,
  :diagnostics_mode,
  :spooling_mode,
  :compression,
  :priority,
  :signals_to_collect,
  :collection_scheme,
  :data_extra_dimensions,
  :tags,
  :data_destination_configs)
  SENSITIVE = []
  include Aws::Structure
end

#spooling_mode ⇒ `String`

(Optional) Whether to store collected data after a vehicle lost a connection with the cloud. After a connection is re-established, the data is automatically forwarded to Amazon Web Services IoT FleetWise. If you want to store collected data when a vehicle loses connection with the cloud, use TO_DISK. If it's not specified, OFF is used.

Default: OFF

Returns:

(String)

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

class CreateCampaignRequest < Struct.new(
  :name,
  :description,
  :signal_catalog_arn,
  :target_arn,
  :start_time,
  :expiry_time,
  :post_trigger_collection_duration,
  :diagnostics_mode,
  :spooling_mode,
  :compression,
  :priority,
  :signals_to_collect,
  :collection_scheme,
  :data_extra_dimensions,
  :tags,
  :data_destination_configs)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ `Time`

(Optional) The time, in milliseconds, to deliver a campaign after it was approved. If it's not specified, 0 is used.

Default: 0

Returns:

(Time)

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

class CreateCampaignRequest < Struct.new(
  :name,
  :description,
  :signal_catalog_arn,
  :target_arn,
  :start_time,
  :expiry_time,
  :post_trigger_collection_duration,
  :diagnostics_mode,
  :spooling_mode,
  :compression,
  :priority,
  :signals_to_collect,
  :collection_scheme,
  :data_extra_dimensions,
  :tags,
  :data_destination_configs)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ `Array<Types::Tag>`

Metadata that can be used to manage the campaign.

Returns:

(Array<Types::Tag>)

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

class CreateCampaignRequest < Struct.new(
  :name,
  :description,
  :signal_catalog_arn,
  :target_arn,
  :start_time,
  :expiry_time,
  :post_trigger_collection_duration,
  :diagnostics_mode,
  :spooling_mode,
  :compression,
  :priority,
  :signals_to_collect,
  :collection_scheme,
  :data_extra_dimensions,
  :tags,
  :data_destination_configs)
  SENSITIVE = []
  include Aws::Structure
end

#target_arn ⇒ `String`

The ARN of the vehicle or fleet to deploy a campaign to.

Returns:

(String)

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

class CreateCampaignRequest < Struct.new(
  :name,
  :description,
  :signal_catalog_arn,
  :target_arn,
  :start_time,
  :expiry_time,
  :post_trigger_collection_duration,
  :diagnostics_mode,
  :spooling_mode,
  :compression,
  :priority,
  :signals_to_collect,
  :collection_scheme,
  :data_extra_dimensions,
  :tags,
  :data_destination_configs)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::IoTFleetWise::Types::CreateCampaignRequest

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#collection_scheme ⇒ Types::CollectionScheme

#compression ⇒ String

#data_destination_configs ⇒ Array<Types::DataDestinationConfig>

#data_extra_dimensions ⇒ Array<String>

#description ⇒ String

#diagnostics_mode ⇒ String

#expiry_time ⇒ Time

#name ⇒ String

#post_trigger_collection_duration ⇒ Integer

#priority ⇒ Integer

#signal_catalog_arn ⇒ String

#signals_to_collect ⇒ Array<Types::SignalInformation>

#spooling_mode ⇒ String

#start_time ⇒ Time

#tags ⇒ Array<Types::Tag>

#target_arn ⇒ String

#collection_scheme ⇒ `Types::CollectionScheme`

#compression ⇒ `String`

#data_destination_configs ⇒ `Array<Types::DataDestinationConfig>`

#data_extra_dimensions ⇒ `Array<String>`

#description ⇒ `String`

#diagnostics_mode ⇒ `String`

#expiry_time ⇒ `Time`

#name ⇒ `String`

#post_trigger_collection_duration ⇒ `Integer`

#priority ⇒ `Integer`

#signal_catalog_arn ⇒ `String`

#signals_to_collect ⇒ `Array<Types::SignalInformation>`

#spooling_mode ⇒ `String`

#start_time ⇒ `Time`

#tags ⇒ `Array<Types::Tag>`

#target_arn ⇒ `String`