Class: Aws::IoTFleetWise::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::IoTFleetWise::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb
Overview
An API client for IoTFleetWise. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::IoTFleetWise::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#associate_vehicle_fleet(params = {}) ⇒ Struct
Adds, or associates, a vehicle with a fleet.
-
#batch_create_vehicle(params = {}) ⇒ Types::BatchCreateVehicleResponse
Creates a group, or batch, of vehicles.
-
#batch_update_vehicle(params = {}) ⇒ Types::BatchUpdateVehicleResponse
Updates a group, or batch, of vehicles.
-
#create_campaign(params = {}) ⇒ Types::CreateCampaignResponse
Creates an orchestration of data collection rules.
-
#create_decoder_manifest(params = {}) ⇒ Types::CreateDecoderManifestResponse
Creates the decoder manifest associated with a model manifest.
-
#create_fleet(params = {}) ⇒ Types::CreateFleetResponse
Creates a fleet that represents a group of vehicles.
-
#create_model_manifest(params = {}) ⇒ Types::CreateModelManifestResponse
Creates a vehicle model (model manifest) that specifies signals (attributes, branches, sensors, and actuators).
-
#create_signal_catalog(params = {}) ⇒ Types::CreateSignalCatalogResponse
Creates a collection of standardized signals that can be reused to create vehicle models.
-
#create_state_template(params = {}) ⇒ Types::CreateStateTemplateResponse
Creates a state template.
-
#create_vehicle(params = {}) ⇒ Types::CreateVehicleResponse
Creates a vehicle, which is an instance of a vehicle model (model manifest).
-
#delete_campaign(params = {}) ⇒ Types::DeleteCampaignResponse
Deletes a data collection campaign.
-
#delete_decoder_manifest(params = {}) ⇒ Types::DeleteDecoderManifestResponse
Deletes a decoder manifest.
-
#delete_fleet(params = {}) ⇒ Types::DeleteFleetResponse
Deletes a fleet.
-
#delete_model_manifest(params = {}) ⇒ Types::DeleteModelManifestResponse
Deletes a vehicle model (model manifest).
-
#delete_signal_catalog(params = {}) ⇒ Types::DeleteSignalCatalogResponse
Deletes a signal catalog.
-
#delete_state_template(params = {}) ⇒ Types::DeleteStateTemplateResponse
Deletes a state template.
-
#delete_vehicle(params = {}) ⇒ Types::DeleteVehicleResponse
Deletes a vehicle and removes it from any campaigns.
-
#disassociate_vehicle_fleet(params = {}) ⇒ Struct
Removes, or disassociates, a vehicle from a fleet.
-
#get_campaign(params = {}) ⇒ Types::GetCampaignResponse
Retrieves information about a campaign.
-
#get_decoder_manifest(params = {}) ⇒ Types::GetDecoderManifestResponse
Retrieves information about a created decoder manifest.
-
#get_encryption_configuration(params = {}) ⇒ Types::GetEncryptionConfigurationResponse
Retrieves the encryption configuration for resources and data in Amazon Web Services IoT FleetWise.
-
#get_fleet(params = {}) ⇒ Types::GetFleetResponse
Retrieves information about a fleet.
-
#get_logging_options(params = {}) ⇒ Types::GetLoggingOptionsResponse
Retrieves the logging options.
-
#get_model_manifest(params = {}) ⇒ Types::GetModelManifestResponse
Retrieves information about a vehicle model (model manifest).
-
#get_register_account_status(params = {}) ⇒ Types::GetRegisterAccountStatusResponse
Retrieves information about the status of registering your Amazon Web Services account, IAM, and Amazon Timestream resources so that Amazon Web Services IoT FleetWise can transfer your vehicle data to the Amazon Web Services Cloud.
-
#get_signal_catalog(params = {}) ⇒ Types::GetSignalCatalogResponse
Retrieves information about a signal catalog.
-
#get_state_template(params = {}) ⇒ Types::GetStateTemplateResponse
Retrieves information about a state template.
-
#get_vehicle(params = {}) ⇒ Types::GetVehicleResponse
Retrieves information about a vehicle.
-
#get_vehicle_status(params = {}) ⇒ Types::GetVehicleStatusResponse
Retrieves information about the status of campaigns, decoder manifests, or state templates associated with a vehicle.
-
#import_decoder_manifest(params = {}) ⇒ Types::ImportDecoderManifestResponse
Creates a decoder manifest using your existing CAN DBC file from your local device.
-
#import_signal_catalog(params = {}) ⇒ Types::ImportSignalCatalogResponse
Creates a signal catalog using your existing VSS formatted content from your local device.
-
#list_campaigns(params = {}) ⇒ Types::ListCampaignsResponse
Lists information about created campaigns.
-
#list_decoder_manifest_network_interfaces(params = {}) ⇒ Types::ListDecoderManifestNetworkInterfacesResponse
Lists the network interfaces specified in a decoder manifest.
-
#list_decoder_manifest_signals(params = {}) ⇒ Types::ListDecoderManifestSignalsResponse
A list of information about signal decoders specified in a decoder manifest.
-
#list_decoder_manifests(params = {}) ⇒ Types::ListDecoderManifestsResponse
Lists decoder manifests.
-
#list_fleets(params = {}) ⇒ Types::ListFleetsResponse
Retrieves information for each created fleet in an Amazon Web Services account.
-
#list_fleets_for_vehicle(params = {}) ⇒ Types::ListFleetsForVehicleResponse
Retrieves a list of IDs for all fleets that the vehicle is associated with.
-
#list_model_manifest_nodes(params = {}) ⇒ Types::ListModelManifestNodesResponse
Lists information about nodes specified in a vehicle model (model manifest).
-
#list_model_manifests(params = {}) ⇒ Types::ListModelManifestsResponse
Retrieves a list of vehicle models (model manifests).
-
#list_signal_catalog_nodes(params = {}) ⇒ Types::ListSignalCatalogNodesResponse
Lists of information about the signals (nodes) specified in a signal catalog.
-
#list_signal_catalogs(params = {}) ⇒ Types::ListSignalCatalogsResponse
Lists all the created signal catalogs in an Amazon Web Services account.
-
#list_state_templates(params = {}) ⇒ Types::ListStateTemplatesResponse
Lists information about created state templates.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags (metadata) you have assigned to the resource.
-
#list_vehicles(params = {}) ⇒ Types::ListVehiclesResponse
Retrieves a list of summaries of created vehicles.
-
#list_vehicles_in_fleet(params = {}) ⇒ Types::ListVehiclesInFleetResponse
Retrieves a list of summaries of all vehicles associated with a fleet.
-
#put_encryption_configuration(params = {}) ⇒ Types::PutEncryptionConfigurationResponse
Creates or updates the encryption configuration.
-
#put_logging_options(params = {}) ⇒ Struct
Creates or updates the logging option.
-
#register_account(params = {}) ⇒ Types::RegisterAccountResponse
This API operation contains deprecated parameters.
-
#tag_resource(params = {}) ⇒ Struct
Adds to or modifies the tags of the given resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes the given tags (metadata) from the resource.
-
#update_campaign(params = {}) ⇒ Types::UpdateCampaignResponse
Updates a campaign.
-
#update_decoder_manifest(params = {}) ⇒ Types::UpdateDecoderManifestResponse
Updates a decoder manifest.
-
#update_fleet(params = {}) ⇒ Types::UpdateFleetResponse
Updates the description of an existing fleet.
-
#update_model_manifest(params = {}) ⇒ Types::UpdateModelManifestResponse
Updates a vehicle model (model manifest).
-
#update_signal_catalog(params = {}) ⇒ Types::UpdateSignalCatalogResponse
Updates a signal catalog.
-
#update_state_template(params = {}) ⇒ Types::UpdateStateTemplateResponse
Updates a state template.
-
#update_vehicle(params = {}) ⇒ Types::UpdateVehicleResponse
Updates a vehicle.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
480 481 482 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 480 def initialize(*args) super end |
Instance Method Details
#associate_vehicle_fleet(params = {}) ⇒ Struct
Adds, or associates, a vehicle with a fleet.
505 506 507 508 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 505 def associate_vehicle_fleet(params = {}, = {}) req = build_request(:associate_vehicle_fleet, params) req.send_request() end |
#batch_create_vehicle(params = {}) ⇒ Types::BatchCreateVehicleResponse
Creates a group, or batch, of vehicles.
For more information, see Create multiple vehicles (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide.
583 584 585 586 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 583 def batch_create_vehicle(params = {}, = {}) req = build_request(:batch_create_vehicle, params) req.send_request() end |
#batch_update_vehicle(params = {}) ⇒ Types::BatchUpdateVehicleResponse
Updates a group, or batch, of vehicles.
For more information, see Update multiple vehicles (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide.
670 671 672 673 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 670 def batch_update_vehicle(params = {}, = {}) req = build_request(:batch_update_vehicle, params) req.send_request() end |
#create_campaign(params = {}) ⇒ Types::CreateCampaignResponse
Creates an orchestration of data collection rules. The Amazon Web Services IoT FleetWise Edge Agent software running in vehicles uses campaigns to decide how to collect and transfer data to the cloud. You create campaigns in the cloud. After you or your team approve campaigns, Amazon Web Services IoT FleetWise automatically deploys them to vehicles.
For more information, see Collect and transfer data with campaigns in the Amazon Web Services IoT FleetWise Developer Guide.
Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.
919 920 921 922 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 919 def create_campaign(params = {}, = {}) req = build_request(:create_campaign, params) req.send_request() end |
#create_decoder_manifest(params = {}) ⇒ Types::CreateDecoderManifestResponse
Creates the decoder manifest associated with a model manifest. To create a decoder manifest, the following must be true:
Every signal decoder has a unique name.
Each signal decoder is associated with a network interface.
Each network interface has a unique ID.
The signal decoders are specified in the model manifest.
1083 1084 1085 1086 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1083 def create_decoder_manifest(params = {}, = {}) req = build_request(:create_decoder_manifest, params) req.send_request() end |
#create_fleet(params = {}) ⇒ Types::CreateFleetResponse
Creates a fleet that represents a group of vehicles.
For more information, see Fleets in the Amazon Web Services IoT FleetWise Developer Guide.
1140 1141 1142 1143 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1140 def create_fleet(params = {}, = {}) req = build_request(:create_fleet, params) req.send_request() end |
#create_model_manifest(params = {}) ⇒ Types::CreateModelManifestResponse
Creates a vehicle model (model manifest) that specifies signals (attributes, branches, sensors, and actuators).
For more information, see Vehicle models in the Amazon Web Services IoT FleetWise Developer Guide.
1197 1198 1199 1200 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1197 def create_model_manifest(params = {}, = {}) req = build_request(:create_model_manifest, params) req.send_request() end |
#create_signal_catalog(params = {}) ⇒ Types::CreateSignalCatalogResponse
Creates a collection of standardized signals that can be reused to create vehicle models.
1306 1307 1308 1309 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1306 def create_signal_catalog(params = {}, = {}) req = build_request(:create_signal_catalog, params) req.send_request() end |
#create_state_template(params = {}) ⇒ Types::CreateStateTemplateResponse
Creates a state template. State templates contain state properties, which are signals that belong to a signal catalog that is synchronized between the Amazon Web Services IoT FleetWise Edge and the Amazon Web Services Cloud.
Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.
1399 1400 1401 1402 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1399 def create_state_template(params = {}, = {}) req = build_request(:create_state_template, params) req.send_request() end |
#create_vehicle(params = {}) ⇒ Types::CreateVehicleResponse
Creates a vehicle, which is an instance of a vehicle model (model manifest). Vehicles created from the same vehicle model consist of the same signals inherited from the vehicle model.
For more information, see Create a vehicle (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide.
1500 1501 1502 1503 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1500 def create_vehicle(params = {}, = {}) req = build_request(:create_vehicle, params) req.send_request() end |
#delete_campaign(params = {}) ⇒ Types::DeleteCampaignResponse
Deletes a data collection campaign. Deleting a campaign suspends all data collection and removes it from any vehicles.
1529 1530 1531 1532 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1529 def delete_campaign(params = {}, = {}) req = build_request(:delete_campaign, params) req.send_request() end |
#delete_decoder_manifest(params = {}) ⇒ Types::DeleteDecoderManifestResponse
Deletes a decoder manifest. You can't delete a decoder manifest if it has vehicles associated with it.
1558 1559 1560 1561 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1558 def delete_decoder_manifest(params = {}, = {}) req = build_request(:delete_decoder_manifest, params) req.send_request() end |
#delete_fleet(params = {}) ⇒ Types::DeleteFleetResponse
Deletes a fleet. Before you delete a fleet, all vehicles must be dissociated from the fleet. For more information, see Delete a fleet (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide.
1593 1594 1595 1596 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1593 def delete_fleet(params = {}, = {}) req = build_request(:delete_fleet, params) req.send_request() end |
#delete_model_manifest(params = {}) ⇒ Types::DeleteModelManifestResponse
Deletes a vehicle model (model manifest).
1621 1622 1623 1624 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1621 def delete_model_manifest(params = {}, = {}) req = build_request(:delete_model_manifest, params) req.send_request() end |
#delete_signal_catalog(params = {}) ⇒ Types::DeleteSignalCatalogResponse
Deletes a signal catalog.
1649 1650 1651 1652 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1649 def delete_signal_catalog(params = {}, = {}) req = build_request(:delete_signal_catalog, params) req.send_request() end |
#delete_state_template(params = {}) ⇒ Types::DeleteStateTemplateResponse
Deletes a state template.
1679 1680 1681 1682 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1679 def delete_state_template(params = {}, = {}) req = build_request(:delete_state_template, params) req.send_request() end |
#delete_vehicle(params = {}) ⇒ Types::DeleteVehicleResponse
Deletes a vehicle and removes it from any campaigns.
1707 1708 1709 1710 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1707 def delete_vehicle(params = {}, = {}) req = build_request(:delete_vehicle, params) req.send_request() end |
#disassociate_vehicle_fleet(params = {}) ⇒ Struct
Removes, or disassociates, a vehicle from a fleet. Disassociating a vehicle from a fleet doesn't delete the vehicle.
1732 1733 1734 1735 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1732 def disassociate_vehicle_fleet(params = {}, = {}) req = build_request(:disassociate_vehicle_fleet, params) req.send_request() end |
#get_campaign(params = {}) ⇒ Types::GetCampaignResponse
Retrieves information about a campaign.
Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.
1839 1840 1841 1842 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1839 def get_campaign(params = {}, = {}) req = build_request(:get_campaign, params) req.send_request() end |
#get_decoder_manifest(params = {}) ⇒ Types::GetDecoderManifestResponse
Retrieves information about a created decoder manifest.
1879 1880 1881 1882 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1879 def get_decoder_manifest(params = {}, = {}) req = build_request(:get_decoder_manifest, params) req.send_request() end |
#get_encryption_configuration(params = {}) ⇒ Types::GetEncryptionConfigurationResponse
Retrieves the encryption configuration for resources and data in Amazon Web Services IoT FleetWise.
1907 1908 1909 1910 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1907 def get_encryption_configuration(params = {}, = {}) req = build_request(:get_encryption_configuration, params) req.send_request() end |
#get_fleet(params = {}) ⇒ Types::GetFleetResponse
Retrieves information about a fleet.
1943 1944 1945 1946 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1943 def get_fleet(params = {}, = {}) req = build_request(:get_fleet, params) req.send_request() end |
#get_logging_options(params = {}) ⇒ Types::GetLoggingOptionsResponse
Retrieves the logging options.
1961 1962 1963 1964 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1961 def (params = {}, = {}) req = build_request(:get_logging_options, params) req.send_request() end |
#get_model_manifest(params = {}) ⇒ Types::GetModelManifestResponse
Retrieves information about a vehicle model (model manifest).
1999 2000 2001 2002 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1999 def get_model_manifest(params = {}, = {}) req = build_request(:get_model_manifest, params) req.send_request() end |
#get_register_account_status(params = {}) ⇒ Types::GetRegisterAccountStatusResponse
Retrieves information about the status of registering your Amazon Web Services account, IAM, and Amazon Timestream resources so that Amazon Web Services IoT FleetWise can transfer your vehicle data to the Amazon Web Services Cloud.
For more information, including step-by-step procedures, see Setting up Amazon Web Services IoT FleetWise.
2047 2048 2049 2050 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2047 def get_register_account_status(params = {}, = {}) req = build_request(:get_register_account_status, params) req.send_request() end |
#get_signal_catalog(params = {}) ⇒ Types::GetSignalCatalogResponse
Retrieves information about a signal catalog.
2089 2090 2091 2092 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2089 def get_signal_catalog(params = {}, = {}) req = build_request(:get_signal_catalog, params) req.send_request() end |
#get_state_template(params = {}) ⇒ Types::GetStateTemplateResponse
Retrieves information about a state template.
Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.
2145 2146 2147 2148 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2145 def get_state_template(params = {}, = {}) req = build_request(:get_state_template, params) req.send_request() end |
#get_vehicle(params = {}) ⇒ Types::GetVehicleResponse
Retrieves information about a vehicle.
2189 2190 2191 2192 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2189 def get_vehicle(params = {}, = {}) req = build_request(:get_vehicle, params) req.send_request() end |
#get_vehicle_status(params = {}) ⇒ Types::GetVehicleStatusResponse
Retrieves information about the status of campaigns, decoder manifests, or state templates associated with a vehicle.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2239 2240 2241 2242 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2239 def get_vehicle_status(params = {}, = {}) req = build_request(:get_vehicle_status, params) req.send_request() end |
#import_decoder_manifest(params = {}) ⇒ Types::ImportDecoderManifestResponse
Creates a decoder manifest using your existing CAN DBC file from your local device.
The CAN signal name must be unique and not repeated across CAN message definitions in a .dbc file.
2285 2286 2287 2288 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2285 def import_decoder_manifest(params = {}, = {}) req = build_request(:import_decoder_manifest, params) req.send_request() end |
#import_signal_catalog(params = {}) ⇒ Types::ImportSignalCatalogResponse
Creates a signal catalog using your existing VSS formatted content from your local device.
2335 2336 2337 2338 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2335 def import_signal_catalog(params = {}, = {}) req = build_request(:import_signal_catalog, params) req.send_request() end |
#list_campaigns(params = {}) ⇒ Types::ListCampaignsResponse
Lists information about created campaigns.
nextToken
parameter
in the request to return more results.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2400 2401 2402 2403 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2400 def list_campaigns(params = {}, = {}) req = build_request(:list_campaigns, params) req.send_request() end |
#list_decoder_manifest_network_interfaces(params = {}) ⇒ Types::ListDecoderManifestNetworkInterfacesResponse
Lists the network interfaces specified in a decoder manifest.
nextToken
parameter
in the request to return more results.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2464 2465 2466 2467 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2464 def list_decoder_manifest_network_interfaces(params = {}, = {}) req = build_request(:list_decoder_manifest_network_interfaces, params) req.send_request() end |
#list_decoder_manifest_signals(params = {}) ⇒ Types::ListDecoderManifestSignalsResponse
A list of information about signal decoders specified in a decoder manifest.
nextToken
parameter
in the request to return more results.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2550 2551 2552 2553 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2550 def list_decoder_manifest_signals(params = {}, = {}) req = build_request(:list_decoder_manifest_signals, params) req.send_request() end |
#list_decoder_manifests(params = {}) ⇒ Types::ListDecoderManifestsResponse
Lists decoder manifests.
nextToken
parameter
in the request to return more results.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2614 2615 2616 2617 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2614 def list_decoder_manifests(params = {}, = {}) req = build_request(:list_decoder_manifests, params) req.send_request() end |
#list_fleets(params = {}) ⇒ Types::ListFleetsResponse
Retrieves information for each created fleet in an Amazon Web Services account.
nextToken
parameter
in the request to return more results.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2672 2673 2674 2675 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2672 def list_fleets(params = {}, = {}) req = build_request(:list_fleets, params) req.send_request() end |
#list_fleets_for_vehicle(params = {}) ⇒ Types::ListFleetsForVehicleResponse
Retrieves a list of IDs for all fleets that the vehicle is associated with.
nextToken
parameter
in the request to return more results.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2723 2724 2725 2726 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2723 def list_fleets_for_vehicle(params = {}, = {}) req = build_request(:list_fleets_for_vehicle, params) req.send_request() end |
#list_model_manifest_nodes(params = {}) ⇒ Types::ListModelManifestNodesResponse
Lists information about nodes specified in a vehicle model (model manifest).
nextToken
parameter
in the request to return more results.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2823 2824 2825 2826 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2823 def list_model_manifest_nodes(params = {}, = {}) req = build_request(:list_model_manifest_nodes, params) req.send_request() end |
#list_model_manifests(params = {}) ⇒ Types::ListModelManifestsResponse
Retrieves a list of vehicle models (model manifests).
nextToken
parameter
in the request to return more results.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2886 2887 2888 2889 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2886 def list_model_manifests(params = {}, = {}) req = build_request(:list_model_manifests, params) req.send_request() end |
#list_signal_catalog_nodes(params = {}) ⇒ Types::ListSignalCatalogNodesResponse
Lists of information about the signals (nodes) specified in a signal catalog.
nextToken
parameter
in the request to return more results.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2990 2991 2992 2993 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2990 def list_signal_catalog_nodes(params = {}, = {}) req = build_request(:list_signal_catalog_nodes, params) req.send_request() end |
#list_signal_catalogs(params = {}) ⇒ Types::ListSignalCatalogsResponse
Lists all the created signal catalogs in an Amazon Web Services account.
You can use to list information about each signal (node) specified in a signal catalog.
nextToken
parameter
in the request to return more results.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3043 3044 3045 3046 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 3043 def list_signal_catalogs(params = {}, = {}) req = build_request(:list_signal_catalogs, params) req.send_request() end |
#list_state_templates(params = {}) ⇒ Types::ListStateTemplatesResponse
Lists information about created state templates.
Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3100 3101 3102 3103 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 3100 def list_state_templates(params = {}, = {}) req = build_request(:list_state_templates, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags (metadata) you have assigned to the resource.
3128 3129 3130 3131 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 3128 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_vehicles(params = {}) ⇒ Types::ListVehiclesResponse
Retrieves a list of summaries of created vehicles.
nextToken
parameter
in the request to return more results.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3223 3224 3225 3226 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 3223 def list_vehicles(params = {}, = {}) req = build_request(:list_vehicles, params) req.send_request() end |
#list_vehicles_in_fleet(params = {}) ⇒ Types::ListVehiclesInFleetResponse
Retrieves a list of summaries of all vehicles associated with a fleet.
nextToken
parameter
in the request to return more results.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3273 3274 3275 3276 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 3273 def list_vehicles_in_fleet(params = {}, = {}) req = build_request(:list_vehicles_in_fleet, params) req.send_request() end |
#put_encryption_configuration(params = {}) ⇒ Types::PutEncryptionConfigurationResponse
Creates or updates the encryption configuration. Amazon Web Services IoT FleetWise can encrypt your data and resources using an Amazon Web Services managed key. Or, you can use a KMS key that you own and manage. For more information, see Data encryption in the Amazon Web Services IoT FleetWise Developer Guide.
3317 3318 3319 3320 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 3317 def put_encryption_configuration(params = {}, = {}) req = build_request(:put_encryption_configuration, params) req.send_request() end |
#put_logging_options(params = {}) ⇒ Struct
Creates or updates the logging option.
3340 3341 3342 3343 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 3340 def (params = {}, = {}) req = build_request(:put_logging_options, params) req.send_request() end |
#register_account(params = {}) ⇒ Types::RegisterAccountResponse
This API operation contains deprecated parameters. Register your account again without the Timestream resources parameter so that Amazon Web Services IoT FleetWise can remove the Timestream metadata stored. You should then pass the data destination into the CreateCampaign API operation.
You must delete any existing campaigns that include an empty data destination before you register your account again. For more information, see the DeleteCampaign API operation.
If you want to delete the Timestream inline policy from the service-linked role, such as to mitigate an overly permissive policy, you must first delete any existing campaigns. Then delete the service-linked role and register your account again to enable CloudWatch metrics. For more information, see DeleteServiceLinkedRole in the Identity and Access Management API Reference.
Registers your Amazon Web Services account, IAM, and Amazon Timestream resources so Amazon Web Services IoT FleetWise can transfer your vehicle data to the Amazon Web Services Cloud. For more information, including step-by-step procedures, see Setting up Amazon Web Services IoT FleetWise.
3427 3428 3429 3430 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 3427 def register_account(params = {}, = {}) req = build_request(:register_account, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource.
3457 3458 3459 3460 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 3457 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes the given tags (metadata) from the resource.
3481 3482 3483 3484 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 3481 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_campaign(params = {}) ⇒ Types::UpdateCampaignResponse
Updates a campaign.
3539 3540 3541 3542 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 3539 def update_campaign(params = {}, = {}) req = build_request(:update_campaign, params) req.send_request() end |
#update_decoder_manifest(params = {}) ⇒ Types::UpdateDecoderManifestResponse
Updates a decoder manifest.
A decoder manifest can only be updated when the status is DRAFT
.
Only ACTIVE
decoder manifests can be associated with vehicles.
3798 3799 3800 3801 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 3798 def update_decoder_manifest(params = {}, = {}) req = build_request(:update_decoder_manifest, params) req.send_request() end |
#update_fleet(params = {}) ⇒ Types::UpdateFleetResponse
Updates the description of an existing fleet.
3830 3831 3832 3833 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 3830 def update_fleet(params = {}, = {}) req = build_request(:update_fleet, params) req.send_request() end |
#update_model_manifest(params = {}) ⇒ Types::UpdateModelManifestResponse
Updates a vehicle model (model manifest). If created vehicles are associated with a vehicle model, it can't be updated.
3879 3880 3881 3882 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 3879 def update_model_manifest(params = {}, = {}) req = build_request(:update_model_manifest, params) req.send_request() end |
#update_signal_catalog(params = {}) ⇒ Types::UpdateSignalCatalogResponse
Updates a signal catalog.
4048 4049 4050 4051 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 4048 def update_signal_catalog(params = {}, = {}) req = build_request(:update_signal_catalog, params) req.send_request() end |
#update_state_template(params = {}) ⇒ Types::UpdateStateTemplateResponse
Updates a state template.
Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.
4130 4131 4132 4133 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 4130 def update_state_template(params = {}, = {}) req = build_request(:update_state_template, params) req.send_request() end |
#update_vehicle(params = {}) ⇒ Types::UpdateVehicleResponse
Updates a vehicle.
Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.
4234 4235 4236 4237 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 4234 def update_vehicle(params = {}, = {}) req = build_request(:update_vehicle, params) req.send_request() end |