Class: Aws::IoTFleetWise::Types::GetCampaignResponse

Inherits:

Struct

• Object
• Struct
• Aws::IoTFleetWise::Types::GetCampaignResponse

Defined in:

gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/types.rb

Constant Summary

SENSITIVE =

[:signals_to_collect, :data_extra_dimensions]

Instance Attribute Summary

• #arn ⇒ String

  The Amazon Resource Name (ARN) of the campaign.

• #collection_scheme ⇒ Types::CollectionScheme

  Information about the data collection scheme associated with the campaign.

• #compression ⇒ String

  Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise.

• #creation_time ⇒ Time

  The time the campaign was created in seconds since epoch (January 1, 1970 at midnight UTC time).

• #data_destination_configs ⇒ Array<Types::DataDestinationConfig>

  The destination where the campaign sends data.

• #data_extra_dimensions ⇒ Array<String>

  A list of vehicle attributes associated with the campaign.

• #data_partitions ⇒ Array<Types::DataPartition>

  The data partitions associated with the signals collected from the vehicle.

• #description ⇒ String

  The description of the campaign.

• #diagnostics_mode ⇒ String

  Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise.

• #expiry_time ⇒ Time

  The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time).

• #last_modification_time ⇒ Time

  The last time the campaign was modified.

• #name ⇒ String

  The name of the campaign.

• #post_trigger_collection_duration ⇒ Integer

  How long (in seconds) to collect raw data after a triggering event initiates the collection.

• #priority ⇒ Integer

  A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet.

• #signal_catalog_arn ⇒ String

  The ARN of a signal catalog.

• #signals_to_collect ⇒ Array<Types::SignalInformation>

  Information about a list of signals to collect data on.

• #signals_to_fetch ⇒ Array<Types::SignalFetchInformation>

  Information about a list of signals to fetch data from.

• #spooling_mode ⇒ String

  Whether to store collected data after a vehicle lost a connection with the cloud.

• #start_time ⇒ Time

  The time, in milliseconds, to deliver a campaign after it was approved.

• #status ⇒ String

  The state of the campaign.

• #target_arn ⇒ String

  The ARN of the vehicle or the fleet targeted by the campaign.

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the campaign.

Returns:

• (String)

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

class GetCampaignResponse < Struct.new(
  :name,
  :arn,
  :description,
  :signal_catalog_arn,
  :target_arn,
  :status,
  :start_time,
  :expiry_time,
  :post_trigger_collection_duration,
  :diagnostics_mode,
  :spooling_mode,
  :compression,
  :priority,
  :signals_to_collect,
  :collection_scheme,
  :data_extra_dimensions,
  :creation_time,
  :last_modification_time,
  :data_destination_configs,
  :data_partitions,
  :signals_to_fetch)
  SENSITIVE = [:signals_to_collect, :data_extra_dimensions]
  include Aws::Structure
end

#collection_scheme ⇒ Types::CollectionScheme

Information about the data collection scheme associated with the campaign.

Returns:

• (Types::CollectionScheme)

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

class GetCampaignResponse < Struct.new(
  :name,
  :arn,
  :description,
  :signal_catalog_arn,
  :target_arn,
  :status,
  :start_time,
  :expiry_time,
  :post_trigger_collection_duration,
  :diagnostics_mode,
  :spooling_mode,
  :compression,
  :priority,
  :signals_to_collect,
  :collection_scheme,
  :data_extra_dimensions,
  :creation_time,
  :last_modification_time,
  :data_destination_configs,
  :data_partitions,
  :signals_to_fetch)
  SENSITIVE = [:signals_to_collect, :data_extra_dimensions]
  include Aws::Structure
end

#compression ⇒ String

Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If OFF is specified, the signals aren't compressed. If it's not specified, SNAPPY is used.

Returns:

• (String)

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

class GetCampaignResponse < Struct.new(
  :name,
  :arn,
  :description,
  :signal_catalog_arn,
  :target_arn,
  :status,
  :start_time,
  :expiry_time,
  :post_trigger_collection_duration,
  :diagnostics_mode,
  :spooling_mode,
  :compression,
  :priority,
  :signals_to_collect,
  :collection_scheme,
  :data_extra_dimensions,
  :creation_time,
  :last_modification_time,
  :data_destination_configs,
  :data_partitions,
  :signals_to_fetch)
  SENSITIVE = [:signals_to_collect, :data_extra_dimensions]
  include Aws::Structure
end

#creation_time ⇒ Time

The time the campaign was created in seconds since epoch (January 1, 1970 at midnight UTC time).

Returns:

• (Time)

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

class GetCampaignResponse < Struct.new(
  :name,
  :arn,
  :description,
  :signal_catalog_arn,
  :target_arn,
  :status,
  :start_time,
  :expiry_time,
  :post_trigger_collection_duration,
  :diagnostics_mode,
  :spooling_mode,
  :compression,
  :priority,
  :signals_to_collect,
  :collection_scheme,
  :data_extra_dimensions,
  :creation_time,
  :last_modification_time,
  :data_destination_configs,
  :data_partitions,
  :signals_to_fetch)
  SENSITIVE = [:signals_to_collect, :data_extra_dimensions]
  include Aws::Structure
end

#data_destination_configs ⇒ Array<Types::DataDestinationConfig>

The destination where the campaign sends data. You can send data to an MQTT topic, or store it in Amazon S3 or Amazon Timestream.

MQTT is the publish/subscribe messaging protocol used by Amazon Web Services IoT to communicate with your devices.

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.

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 1913

class GetCampaignResponse < Struct.new(
  :name,
  :arn,
  :description,
  :signal_catalog_arn,
  :target_arn,
  :status,
  :start_time,
  :expiry_time,
  :post_trigger_collection_duration,
  :diagnostics_mode,
  :spooling_mode,
  :compression,
  :priority,
  :signals_to_collect,
  :collection_scheme,
  :data_extra_dimensions,
  :creation_time,
  :last_modification_time,
  :data_destination_configs,
  :data_partitions,
  :signals_to_fetch)
  SENSITIVE = [:signals_to_collect, :data_extra_dimensions]
  include Aws::Structure
end

#data_extra_dimensions ⇒ Array<String>

A list of vehicle attributes associated with the campaign.

Returns:

• (Array<String>)

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

class GetCampaignResponse < Struct.new(
  :name,
  :arn,
  :description,
  :signal_catalog_arn,
  :target_arn,
  :status,
  :start_time,
  :expiry_time,
  :post_trigger_collection_duration,
  :diagnostics_mode,
  :spooling_mode,
  :compression,
  :priority,
  :signals_to_collect,
  :collection_scheme,
  :data_extra_dimensions,
  :creation_time,
  :last_modification_time,
  :data_destination_configs,
  :data_partitions,
  :signals_to_fetch)
  SENSITIVE = [:signals_to_collect, :data_extra_dimensions]
  include Aws::Structure
end

#data_partitions ⇒ Array<Types::DataPartition>

The data partitions associated with the signals collected from the vehicle.

Returns:

• (Array<Types::DataPartition>)

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

class GetCampaignResponse < Struct.new(
  :name,
  :arn,
  :description,
  :signal_catalog_arn,
  :target_arn,
  :status,
  :start_time,
  :expiry_time,
  :post_trigger_collection_duration,
  :diagnostics_mode,
  :spooling_mode,
  :compression,
  :priority,
  :signals_to_collect,
  :collection_scheme,
  :data_extra_dimensions,
  :creation_time,
  :last_modification_time,
  :data_destination_configs,
  :data_partitions,
  :signals_to_fetch)
  SENSITIVE = [:signals_to_collect, :data_extra_dimensions]
  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 1913

class GetCampaignResponse < Struct.new(
  :name,
  :arn,
  :description,
  :signal_catalog_arn,
  :target_arn,
  :status,
  :start_time,
  :expiry_time,
  :post_trigger_collection_duration,
  :diagnostics_mode,
  :spooling_mode,
  :compression,
  :priority,
  :signals_to_collect,
  :collection_scheme,
  :data_extra_dimensions,
  :creation_time,
  :last_modification_time,
  :data_destination_configs,
  :data_partitions,
  :signals_to_fetch)
  SENSITIVE = [:signals_to_collect, :data_extra_dimensions]
  include Aws::Structure
end

#diagnostics_mode ⇒ String

Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise.

Returns:

• (String)

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

class GetCampaignResponse < Struct.new(
  :name,
  :arn,
  :description,
  :signal_catalog_arn,
  :target_arn,
  :status,
  :start_time,
  :expiry_time,
  :post_trigger_collection_duration,
  :diagnostics_mode,
  :spooling_mode,
  :compression,
  :priority,
  :signals_to_collect,
  :collection_scheme,
  :data_extra_dimensions,
  :creation_time,
  :last_modification_time,
  :data_destination_configs,
  :data_partitions,
  :signals_to_fetch)
  SENSITIVE = [:signals_to_collect, :data_extra_dimensions]
  include Aws::Structure
end

#expiry_time ⇒ Time

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

Returns:

• (Time)

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

class GetCampaignResponse < Struct.new(
  :name,
  :arn,
  :description,
  :signal_catalog_arn,
  :target_arn,
  :status,
  :start_time,
  :expiry_time,
  :post_trigger_collection_duration,
  :diagnostics_mode,
  :spooling_mode,
  :compression,
  :priority,
  :signals_to_collect,
  :collection_scheme,
  :data_extra_dimensions,
  :creation_time,
  :last_modification_time,
  :data_destination_configs,
  :data_partitions,
  :signals_to_fetch)
  SENSITIVE = [:signals_to_collect, :data_extra_dimensions]
  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 1913

class GetCampaignResponse < Struct.new(
  :name,
  :arn,
  :description,
  :signal_catalog_arn,
  :target_arn,
  :status,
  :start_time,
  :expiry_time,
  :post_trigger_collection_duration,
  :diagnostics_mode,
  :spooling_mode,
  :compression,
  :priority,
  :signals_to_collect,
  :collection_scheme,
  :data_extra_dimensions,
  :creation_time,
  :last_modification_time,
  :data_destination_configs,
  :data_partitions,
  :signals_to_fetch)
  SENSITIVE = [:signals_to_collect, :data_extra_dimensions]
  include Aws::Structure
end

#name ⇒ String

The name of the campaign.

Returns:

• (String)

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

class GetCampaignResponse < Struct.new(
  :name,
  :arn,
  :description,
  :signal_catalog_arn,
  :target_arn,
  :status,
  :start_time,
  :expiry_time,
  :post_trigger_collection_duration,
  :diagnostics_mode,
  :spooling_mode,
  :compression,
  :priority,
  :signals_to_collect,
  :collection_scheme,
  :data_extra_dimensions,
  :creation_time,
  :last_modification_time,
  :data_destination_configs,
  :data_partitions,
  :signals_to_fetch)
  SENSITIVE = [:signals_to_collect, :data_extra_dimensions]
  include Aws::Structure
end

#post_trigger_collection_duration ⇒ Integer

How long (in seconds) to collect raw data after a triggering event initiates the collection.

Returns:

• (Integer)

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

class GetCampaignResponse < Struct.new(
  :name,
  :arn,
  :description,
  :signal_catalog_arn,
  :target_arn,
  :status,
  :start_time,
  :expiry_time,
  :post_trigger_collection_duration,
  :diagnostics_mode,
  :spooling_mode,
  :compression,
  :priority,
  :signals_to_collect,
  :collection_scheme,
  :data_extra_dimensions,
  :creation_time,
  :last_modification_time,
  :data_destination_configs,
  :data_partitions,
  :signals_to_fetch)
  SENSITIVE = [:signals_to_collect, :data_extra_dimensions]
  include Aws::Structure
end

#priority ⇒ Integer

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.

Returns:

• (Integer)

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

class GetCampaignResponse < Struct.new(
  :name,
  :arn,
  :description,
  :signal_catalog_arn,
  :target_arn,
  :status,
  :start_time,
  :expiry_time,
  :post_trigger_collection_duration,
  :diagnostics_mode,
  :spooling_mode,
  :compression,
  :priority,
  :signals_to_collect,
  :collection_scheme,
  :data_extra_dimensions,
  :creation_time,
  :last_modification_time,
  :data_destination_configs,
  :data_partitions,
  :signals_to_fetch)
  SENSITIVE = [:signals_to_collect, :data_extra_dimensions]
  include Aws::Structure
end

#signal_catalog_arn ⇒ String

The ARN of a signal catalog.

Returns:

• (String)

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

class GetCampaignResponse < Struct.new(
  :name,
  :arn,
  :description,
  :signal_catalog_arn,
  :target_arn,
  :status,
  :start_time,
  :expiry_time,
  :post_trigger_collection_duration,
  :diagnostics_mode,
  :spooling_mode,
  :compression,
  :priority,
  :signals_to_collect,
  :collection_scheme,
  :data_extra_dimensions,
  :creation_time,
  :last_modification_time,
  :data_destination_configs,
  :data_partitions,
  :signals_to_fetch)
  SENSITIVE = [:signals_to_collect, :data_extra_dimensions]
  include Aws::Structure
end

#signals_to_collect ⇒ Array<Types::SignalInformation>

Information about a list of signals to collect data on.

Returns:

• (Array<Types::SignalInformation>)

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

class GetCampaignResponse < Struct.new(
  :name,
  :arn,
  :description,
  :signal_catalog_arn,
  :target_arn,
  :status,
  :start_time,
  :expiry_time,
  :post_trigger_collection_duration,
  :diagnostics_mode,
  :spooling_mode,
  :compression,
  :priority,
  :signals_to_collect,
  :collection_scheme,
  :data_extra_dimensions,
  :creation_time,
  :last_modification_time,
  :data_destination_configs,
  :data_partitions,
  :signals_to_fetch)
  SENSITIVE = [:signals_to_collect, :data_extra_dimensions]
  include Aws::Structure
end

#signals_to_fetch ⇒ Array<Types::SignalFetchInformation>

Information about a list of signals to fetch data from.

Returns:

• (Array<Types::SignalFetchInformation>)

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

class GetCampaignResponse < Struct.new(
  :name,
  :arn,
  :description,
  :signal_catalog_arn,
  :target_arn,
  :status,
  :start_time,
  :expiry_time,
  :post_trigger_collection_duration,
  :diagnostics_mode,
  :spooling_mode,
  :compression,
  :priority,
  :signals_to_collect,
  :collection_scheme,
  :data_extra_dimensions,
  :creation_time,
  :last_modification_time,
  :data_destination_configs,
  :data_partitions,
  :signals_to_fetch)
  SENSITIVE = [:signals_to_collect, :data_extra_dimensions]
  include Aws::Structure
end

#spooling_mode ⇒ String

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.

Returns:

• (String)

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

class GetCampaignResponse < Struct.new(
  :name,
  :arn,
  :description,
  :signal_catalog_arn,
  :target_arn,
  :status,
  :start_time,
  :expiry_time,
  :post_trigger_collection_duration,
  :diagnostics_mode,
  :spooling_mode,
  :compression,
  :priority,
  :signals_to_collect,
  :collection_scheme,
  :data_extra_dimensions,
  :creation_time,
  :last_modification_time,
  :data_destination_configs,
  :data_partitions,
  :signals_to_fetch)
  SENSITIVE = [:signals_to_collect, :data_extra_dimensions]
  include Aws::Structure
end

#start_time ⇒ Time

The time, in milliseconds, to deliver a campaign after it was approved.

Returns:

• (Time)

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

class GetCampaignResponse < Struct.new(
  :name,
  :arn,
  :description,
  :signal_catalog_arn,
  :target_arn,
  :status,
  :start_time,
  :expiry_time,
  :post_trigger_collection_duration,
  :diagnostics_mode,
  :spooling_mode,
  :compression,
  :priority,
  :signals_to_collect,
  :collection_scheme,
  :data_extra_dimensions,
  :creation_time,
  :last_modification_time,
  :data_destination_configs,
  :data_partitions,
  :signals_to_fetch)
  SENSITIVE = [:signals_to_collect, :data_extra_dimensions]
  include Aws::Structure
end

#status ⇒ String

The state of the campaign. The status can be one of: CREATING, WAITING_FOR_APPROVAL, RUNNING, and SUSPENDED.

Returns:

• (String)

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

class GetCampaignResponse < Struct.new(
  :name,
  :arn,
  :description,
  :signal_catalog_arn,
  :target_arn,
  :status,
  :start_time,
  :expiry_time,
  :post_trigger_collection_duration,
  :diagnostics_mode,
  :spooling_mode,
  :compression,
  :priority,
  :signals_to_collect,
  :collection_scheme,
  :data_extra_dimensions,
  :creation_time,
  :last_modification_time,
  :data_destination_configs,
  :data_partitions,
  :signals_to_fetch)
  SENSITIVE = [:signals_to_collect, :data_extra_dimensions]
  include Aws::Structure
end

#target_arn ⇒ String

The ARN of the vehicle or the fleet targeted by the campaign.

Returns:

• (String)

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

class GetCampaignResponse < Struct.new(
  :name,
  :arn,
  :description,
  :signal_catalog_arn,
  :target_arn,
  :status,
  :start_time,
  :expiry_time,
  :post_trigger_collection_duration,
  :diagnostics_mode,
  :spooling_mode,
  :compression,
  :priority,
  :signals_to_collect,
  :collection_scheme,
  :data_extra_dimensions,
  :creation_time,
  :last_modification_time,
  :data_destination_configs,
  :data_partitions,
  :signals_to_fetch)
  SENSITIVE = [:signals_to_collect, :data_extra_dimensions]
  include Aws::Structure
end