Class: Aws::IoTFleetWise::Types::GetCampaignResponse
- Inherits:
-
Struct
- Object
- Struct
- Aws::IoTFleetWise::Types::GetCampaignResponse
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-iotfleetwise/types.rb
Constant Summary collapse
- SENSITIVE =
[:signals_to_collect, :data_extra_dimensions]
Instance Attribute Summary collapse
-
#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.
-
#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.
-
#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.
1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 |
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 1562 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) 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.
1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 |
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 1562 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) 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.
1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 |
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 1562 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) 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).
1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 |
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 1562 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) 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 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.
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.
1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 |
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 1562 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) 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.
1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 |
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 1562 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) SENSITIVE = [:signals_to_collect, :data_extra_dimensions] include Aws::Structure end |
#description ⇒ String
The description of the campaign.
1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 |
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 1562 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) 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.
1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 |
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 1562 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) 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.
1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 |
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 1562 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) SENSITIVE = [:signals_to_collect, :data_extra_dimensions] include Aws::Structure end |
#last_modification_time ⇒ Time
The last time the campaign was modified.
1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 |
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 1562 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) SENSITIVE = [:signals_to_collect, :data_extra_dimensions] include Aws::Structure end |
#name ⇒ String
The name of the campaign.
1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 |
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 1562 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) 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.
1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 |
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 1562 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) 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.
1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 |
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 1562 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) SENSITIVE = [:signals_to_collect, :data_extra_dimensions] include Aws::Structure end |
#signal_catalog_arn ⇒ String
The ARN of a signal catalog.
1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 |
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 1562 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) 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.
1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 |
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 1562 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) 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.
1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 |
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 1562 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) 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.
1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 |
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 1562 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) 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`.
1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 |
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 1562 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) 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.
1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 |
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 1562 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) SENSITIVE = [:signals_to_collect, :data_extra_dimensions] include Aws::Structure end |