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.
419 420 421 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 419 def initialize(*args) super end |
Instance Method Details
#associate_vehicle_fleet(params = {}) ⇒ Struct
Adds, or associates, a vehicle with a fleet.
444 445 446 447 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 444 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.
507 508 509 510 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 507 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.
563 564 565 566 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 563 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.
751 752 753 754 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 751 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.
892 893 894 895 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 892 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.
949 950 951 952 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 949 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.
1006 1007 1008 1009 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1006 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.
1115 1116 1117 1118 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1115 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.
1195 1196 1197 1198 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1195 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.
1224 1225 1226 1227 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1224 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.
1258 1259 1260 1261 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1258 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.
1298 1299 1300 1301 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1298 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).
1331 1332 1333 1334 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1331 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.
1364 1365 1366 1367 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1364 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.
1397 1398 1399 1400 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1397 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.
1428 1429 1430 1431 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1428 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.
1504 1505 1506 1507 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1504 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.
1544 1545 1546 1547 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1544 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.
1572 1573 1574 1575 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1572 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.
1608 1609 1610 1611 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1608 def get_fleet(params = {}, = {}) req = build_request(:get_fleet, params) req.send_request() end |
#get_logging_options(params = {}) ⇒ Types::GetLoggingOptionsResponse
Retrieves the logging options.
1626 1627 1628 1629 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1626 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).
1664 1665 1666 1667 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1664 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.
1712 1713 1714 1715 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1712 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.
1754 1755 1756 1757 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1754 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.
1793 1794 1795 1796 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1793 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.
1841 1842 1843 1844 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1841 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.
1884 1885 1886 1887 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1884 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.
1934 1935 1936 1937 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1934 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.
1993 1994 1995 1996 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1993 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.
2056 2057 2058 2059 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2056 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.
2138 2139 2140 2141 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2138 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.
2196 2197 2198 2199 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2196 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.
2248 2249 2250 2251 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2248 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.
2299 2300 2301 2302 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2299 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.
2399 2400 2401 2402 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2399 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.
2456 2457 2458 2459 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2456 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.
2560 2561 2562 2563 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2560 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.
2613 2614 2615 2616 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2613 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.
2641 2642 2643 2644 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2641 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.
2700 2701 2702 2703 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2700 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.
2750 2751 2752 2753 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2750 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.
2794 2795 2796 2797 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2794 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.
2817 2818 2819 2820 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2817 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.
2904 2905 2906 2907 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2904 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.
2934 2935 2936 2937 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2934 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.
2958 2959 2960 2961 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2958 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_campaign(params = {}) ⇒ Types::UpdateCampaignResponse
Updates a campaign.
3016 3017 3018 3019 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 3016 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.
3243 3244 3245 3246 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 3243 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.
3280 3281 3282 3283 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 3280 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.
3329 3330 3331 3332 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 3329 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.
3498 3499 3500 3501 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 3498 def update_signal_catalog(params = {}, = {}) req = build_request(:update_signal_catalog, params) req.send_request() end |
#update_vehicle(params = {}) ⇒ Types::UpdateVehicleResponse
Updates a vehicle.
3552 3553 3554 3555 |
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 3552 def update_vehicle(params = {}, = {}) req = build_request(:update_vehicle, params) req.send_request() end |