Class: Aws::IoTFleetWise::Types::UpdateStateTemplateRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-iotfleetwise/types.rb

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#data_extra_dimensions ⇒ Array<String>

A list of vehicle attributes to associate with the payload published on the state template’s MQTT topic. (See [ Processing last known state vehicle data using MQTT messaging]). For example, if you add ‘Vehicle.Attributes.Make` and `Vehicle.Attributes.Model` attributes, Amazon Web Services IoT FleetWise will enrich the protobuf encoded payload with those attributes in the `extraDimensions` field.

Default: An empty array

[1]: docs.aws.amazon.com/iot-fleetwise/latest/developerguide/process-visualize-data.html#process-last-known-state-vehicle-data

Returns:

  • (Array<String>) 


5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
 
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 5023

class UpdateStateTemplateRequest < Struct.new(
  :identifier,
  :description,
  :state_template_properties_to_add,
  :state_template_properties_to_remove,
  :data_extra_dimensions,
  :metadata_extra_dimensions)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A brief description of the state template.

Returns:

  • (String) 


5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
 
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 5023

class UpdateStateTemplateRequest < Struct.new(
  :identifier,
  :description,
  :state_template_properties_to_add,
  :state_template_properties_to_remove,
  :data_extra_dimensions,
  :metadata_extra_dimensions)
  SENSITIVE = []
  include Aws::Structure
end

#identifier ⇒ String

A unique, service-generated identifier.

Returns:

  • (String) 


5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
 
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 5023

class UpdateStateTemplateRequest < Struct.new(
  :identifier,
  :description,
  :state_template_properties_to_add,
  :state_template_properties_to_remove,
  :data_extra_dimensions,
  :metadata_extra_dimensions)
  SENSITIVE = []
  include Aws::Structure
end

#metadata_extra_dimensions ⇒ Array<String>

A list of vehicle attributes to associate with user properties of the messages published on the state template’s MQTT topic. (See [ Processing last known state vehicle data using MQTT messaging]). For example, if you add ‘Vehicle.Attributes.Make` and `Vehicle.Attributes.Model` attributes, Amazon Web Services IoT FleetWise will include these attributes as User Properties with the MQTT message.

[1]: docs.aws.amazon.com/iot-fleetwise/latest/developerguide/process-visualize-data.html#process-last-known-state-vehicle-data

Returns:

  • (Array<String>) 


5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
 
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 5023

class UpdateStateTemplateRequest < Struct.new(
  :identifier,
  :description,
  :state_template_properties_to_add,
  :state_template_properties_to_remove,
  :data_extra_dimensions,
  :metadata_extra_dimensions)
  SENSITIVE = []
  include Aws::Structure
end

#state_template_properties_to_add ⇒ Array<String>

Add signals from which data is collected as part of the state template.

Returns:

  • (Array<String>) 


5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
 
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 5023

class UpdateStateTemplateRequest < Struct.new(
  :identifier,
  :description,
  :state_template_properties_to_add,
  :state_template_properties_to_remove,
  :data_extra_dimensions,
  :metadata_extra_dimensions)
  SENSITIVE = []
  include Aws::Structure
end

#state_template_properties_to_remove ⇒ Array<String>

Remove signals from which data is collected as part of the state template.

Returns:

  • (Array<String>) 


5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
 
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 5023

class UpdateStateTemplateRequest < Struct.new(
  :identifier,
  :description,
  :state_template_properties_to_add,
  :state_template_properties_to_remove,
  :data_extra_dimensions,
  :metadata_extra_dimensions)
  SENSITIVE = []
  include Aws::Structure
end