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.
429 430 431 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 429 def initialize(*args) super end |
Instance Method Details
#associate_vehicle_fleet(params = {}) ⇒ Struct
Adds, or associates, a vehicle with a fleet.
454 455 456 457 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 454 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.
517 518 519 520 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 517 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.
573 574 575 576 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 573 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.
761 762 763 764 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 761 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.
902 903 904 905 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 902 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.
959 960 961 962 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 959 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.
1016 1017 1018 1019 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1016 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.
1125 1126 1127 1128 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1125 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.
1205 1206 1207 1208 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1205 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.
1234 1235 1236 1237 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1234 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.
1268 1269 1270 1271 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1268 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.
1308 1309 1310 1311 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1308 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).
1341 1342 1343 1344 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1341 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.
1374 1375 1376 1377 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1374 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.
1407 1408 1409 1410 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1407 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.
1438 1439 1440 1441 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1438 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.
1514 1515 1516 1517 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1514 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.
1554 1555 1556 1557 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1554 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.
1582 1583 1584 1585 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1582 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.
1618 1619 1620 1621 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1618 def get_fleet(params = {}, = {}) req = build_request(:get_fleet, params) req.send_request() end |
#get_logging_options(params = {}) ⇒ Types::GetLoggingOptionsResponse
Retrieves the logging options.
1636 1637 1638 1639 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1636 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).
1674 1675 1676 1677 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1674 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.
1722 1723 1724 1725 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1722 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.
1764 1765 1766 1767 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1764 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.
1803 1804 1805 1806 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1803 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.
1851 1852 1853 1854 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1851 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.
1894 1895 1896 1897 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1894 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.
1944 1945 1946 1947 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1944 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.
2003 2004 2005 2006 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2003 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.
2066 2067 2068 2069 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2066 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.
2148 2149 2150 2151 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2148 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.
2206 2207 2208 2209 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2206 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.
2258 2259 2260 2261 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2258 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.
2309 2310 2311 2312 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2309 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.
2409 2410 2411 2412 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2409 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.
2466 2467 2468 2469 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2466 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.
2570 2571 2572 2573 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2570 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.
2623 2624 2625 2626 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2623 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.
2651 2652 2653 2654 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2651 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.
2722 2723 2724 2725 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2722 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.
2772 2773 2774 2775 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2772 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.
2816 2817 2818 2819 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2816 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.
2839 2840 2841 2842 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2839 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.
2926 2927 2928 2929 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2926 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.
2956 2957 2958 2959 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2956 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.
2980 2981 2982 2983 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2980 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_campaign(params = {}) ⇒ Types::UpdateCampaignResponse
Updates a campaign.
3038 3039 3040 3041 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 3038 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.
3265 3266 3267 3268 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 3265 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.
3302 3303 3304 3305 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 3302 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.
3351 3352 3353 3354 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 3351 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.
3520 3521 3522 3523 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 3520 def update_signal_catalog(params = {}, = {}) req = build_request(:update_signal_catalog, params) req.send_request() end |
#update_vehicle(params = {}) ⇒ Types::UpdateVehicleResponse
Updates a vehicle.
3574 3575 3576 3577 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 3574 def update_vehicle(params = {}, = {}) req = build_request(:update_vehicle, params) req.send_request() end |