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_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_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_vehicle(params = {}) ⇒ Types::GetVehicleResponse
Retrieves information about a vehicle.
-
#get_vehicle_status(params = {}) ⇒ Types::GetVehicleStatusResponse
Retrieves information about the status of a vehicle with any associated campaigns.
-
#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_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_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.
447 448 449 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 447 def initialize(*args) super end |
Instance Method Details
#associate_vehicle_fleet(params = {}) ⇒ Struct
Adds, or associates, a vehicle with a fleet.
472 473 474 475 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 472 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.
535 536 537 538 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 535 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.
591 592 593 594 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 591 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.
779 780 781 782 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 779 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.
920 921 922 923 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 920 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.
977 978 979 980 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 977 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.
1034 1035 1036 1037 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1034 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.
1143 1144 1145 1146 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1143 def create_signal_catalog(params = {}, = {}) req = build_request(:create_signal_catalog, 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.
1223 1224 1225 1226 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1223 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.
1252 1253 1254 1255 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1252 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.
1286 1287 1288 1289 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1286 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.
1326 1327 1328 1329 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1326 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).
1359 1360 1361 1362 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1359 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.
1392 1393 1394 1395 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1392 def delete_signal_catalog(params = {}, = {}) req = build_request(:delete_signal_catalog, params) req.send_request() end |
#delete_vehicle(params = {}) ⇒ Types::DeleteVehicleResponse
Deletes a vehicle and removes it from any campaigns.
1425 1426 1427 1428 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1425 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.
1456 1457 1458 1459 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1456 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.
1532 1533 1534 1535 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1532 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.
1572 1573 1574 1575 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1572 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.
1600 1601 1602 1603 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1600 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.
1636 1637 1638 1639 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1636 def get_fleet(params = {}, = {}) req = build_request(:get_fleet, params) req.send_request() end |
#get_logging_options(params = {}) ⇒ Types::GetLoggingOptionsResponse
Retrieves the logging options.
1654 1655 1656 1657 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1654 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).
1692 1693 1694 1695 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1692 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.
1740 1741 1742 1743 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1740 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.
1782 1783 1784 1785 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1782 def get_signal_catalog(params = {}, = {}) req = build_request(:get_signal_catalog, params) req.send_request() end |
#get_vehicle(params = {}) ⇒ Types::GetVehicleResponse
Retrieves information about a vehicle.
1821 1822 1823 1824 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1821 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 a vehicle with any associated campaigns.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1869 1870 1871 1872 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1869 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.
1912 1913 1914 1915 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1912 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.
1962 1963 1964 1965 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1962 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.
2021 2022 2023 2024 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2021 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.
2084 2085 2086 2087 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2084 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.
2166 2167 2168 2169 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2166 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.
2224 2225 2226 2227 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2224 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.
2276 2277 2278 2279 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2276 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.
2327 2328 2329 2330 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2327 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.
2427 2428 2429 2430 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2427 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.
2484 2485 2486 2487 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2484 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.
2588 2589 2590 2591 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2588 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.
2641 2642 2643 2644 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2641 def list_signal_catalogs(params = {}, = {}) req = build_request(:list_signal_catalogs, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags (metadata) you have assigned to the resource.
2669 2670 2671 2672 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2669 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.
2740 2741 2742 2743 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2740 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.
2790 2791 2792 2793 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2790 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.
2834 2835 2836 2837 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2834 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.
2857 2858 2859 2860 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2857 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.
2944 2945 2946 2947 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2944 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.
2974 2975 2976 2977 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2974 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.
2998 2999 3000 3001 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2998 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_campaign(params = {}) ⇒ Types::UpdateCampaignResponse
Updates a campaign.
3056 3057 3058 3059 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 3056 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.
3283 3284 3285 3286 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 3283 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.
3320 3321 3322 3323 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 3320 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.
3369 3370 3371 3372 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 3369 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.
3538 3539 3540 3541 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 3538 def update_signal_catalog(params = {}, = {}) req = build_request(:update_signal_catalog, params) req.send_request() end |
#update_vehicle(params = {}) ⇒ Types::UpdateVehicleResponse
Updates a vehicle.
3592 3593 3594 3595 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 3592 def update_vehicle(params = {}, = {}) req = build_request(:update_vehicle, params) req.send_request() end |