@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSIoTFleetWise extends Object implements AWSIoTFleetWise
AWSIoTFleetWise
. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
AssociateVehicleFleetResult |
associateVehicleFleet(AssociateVehicleFleetRequest request)
Adds, or associates, a vehicle with a fleet.
|
BatchCreateVehicleResult |
batchCreateVehicle(BatchCreateVehicleRequest request)
Creates a group, or batch, of vehicles.
|
BatchUpdateVehicleResult |
batchUpdateVehicle(BatchUpdateVehicleRequest request)
Updates a group, or batch, of vehicles.
|
CreateCampaignResult |
createCampaign(CreateCampaignRequest request)
Creates an orchestration of data collection rules.
|
CreateDecoderManifestResult |
createDecoderManifest(CreateDecoderManifestRequest request)
Creates the decoder manifest associated with a model manifest.
|
CreateFleetResult |
createFleet(CreateFleetRequest request)
Creates a fleet that represents a group of vehicles.
|
CreateModelManifestResult |
createModelManifest(CreateModelManifestRequest request)
Creates a vehicle model (model manifest) that specifies signals (attributes, branches, sensors, and actuators).
|
CreateSignalCatalogResult |
createSignalCatalog(CreateSignalCatalogRequest request)
Creates a collection of standardized signals that can be reused to create vehicle models.
|
CreateVehicleResult |
createVehicle(CreateVehicleRequest request)
Creates a vehicle, which is an instance of a vehicle model (model manifest).
|
DeleteCampaignResult |
deleteCampaign(DeleteCampaignRequest request)
Deletes a data collection campaign.
|
DeleteDecoderManifestResult |
deleteDecoderManifest(DeleteDecoderManifestRequest request)
Deletes a decoder manifest.
|
DeleteFleetResult |
deleteFleet(DeleteFleetRequest request)
Deletes a fleet.
|
DeleteModelManifestResult |
deleteModelManifest(DeleteModelManifestRequest request)
Deletes a vehicle model (model manifest).
|
DeleteSignalCatalogResult |
deleteSignalCatalog(DeleteSignalCatalogRequest request)
Deletes a signal catalog.
|
DeleteVehicleResult |
deleteVehicle(DeleteVehicleRequest request)
Deletes a vehicle and removes it from any campaigns.
|
DisassociateVehicleFleetResult |
disassociateVehicleFleet(DisassociateVehicleFleetRequest request)
Removes, or disassociates, a vehicle from a fleet.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetCampaignResult |
getCampaign(GetCampaignRequest request)
Retrieves information about a campaign.
|
GetDecoderManifestResult |
getDecoderManifest(GetDecoderManifestRequest request)
Retrieves information about a created decoder manifest.
|
GetFleetResult |
getFleet(GetFleetRequest request)
Retrieves information about a fleet.
|
GetLoggingOptionsResult |
getLoggingOptions(GetLoggingOptionsRequest request)
Retrieves the logging options.
|
GetModelManifestResult |
getModelManifest(GetModelManifestRequest request)
Retrieves information about a vehicle model (model manifest).
|
GetRegisterAccountStatusResult |
getRegisterAccountStatus(GetRegisterAccountStatusRequest request)
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.
|
GetSignalCatalogResult |
getSignalCatalog(GetSignalCatalogRequest request)
Retrieves information about a signal catalog.
|
GetVehicleResult |
getVehicle(GetVehicleRequest request)
Retrieves information about a vehicle.
|
GetVehicleStatusResult |
getVehicleStatus(GetVehicleStatusRequest request)
Retrieves information about the status of a vehicle with any associated campaigns.
|
ImportDecoderManifestResult |
importDecoderManifest(ImportDecoderManifestRequest request)
Creates a decoder manifest using your existing CAN DBC file from your local device.
|
ImportSignalCatalogResult |
importSignalCatalog(ImportSignalCatalogRequest request)
Creates a signal catalog using your existing VSS formatted content from your local device.
|
ListCampaignsResult |
listCampaigns(ListCampaignsRequest request)
Lists information about created campaigns.
|
ListDecoderManifestNetworkInterfacesResult |
listDecoderManifestNetworkInterfaces(ListDecoderManifestNetworkInterfacesRequest request)
Lists the network interfaces specified in a decoder manifest.
|
ListDecoderManifestsResult |
listDecoderManifests(ListDecoderManifestsRequest request)
Lists decoder manifests.
|
ListDecoderManifestSignalsResult |
listDecoderManifestSignals(ListDecoderManifestSignalsRequest request)
A list of information about signal decoders specified in a decoder manifest.
|
ListFleetsResult |
listFleets(ListFleetsRequest request)
Retrieves information for each created fleet in an Amazon Web Services account.
|
ListFleetsForVehicleResult |
listFleetsForVehicle(ListFleetsForVehicleRequest request)
Retrieves a list of IDs for all fleets that the vehicle is associated with.
|
ListModelManifestNodesResult |
listModelManifestNodes(ListModelManifestNodesRequest request)
Lists information about nodes specified in a vehicle model (model manifest).
|
ListModelManifestsResult |
listModelManifests(ListModelManifestsRequest request)
Retrieves a list of vehicle models (model manifests).
|
ListSignalCatalogNodesResult |
listSignalCatalogNodes(ListSignalCatalogNodesRequest request)
Lists of information about the signals (nodes) specified in a signal catalog.
|
ListSignalCatalogsResult |
listSignalCatalogs(ListSignalCatalogsRequest request)
Lists all the created signal catalogs in an Amazon Web Services account.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Lists the tags (metadata) you have assigned to the resource.
|
ListVehiclesResult |
listVehicles(ListVehiclesRequest request)
Retrieves a list of summaries of created vehicles.
|
ListVehiclesInFleetResult |
listVehiclesInFleet(ListVehiclesInFleetRequest request)
Retrieves a list of summaries of all vehicles associated with a fleet.
|
PutLoggingOptionsResult |
putLoggingOptions(PutLoggingOptionsRequest request)
Creates or updates the logging option.
|
RegisterAccountResult |
registerAccount(RegisterAccountRequest request)
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.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds to or modifies the tags of the given resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes the given tags (metadata) from the resource.
|
UpdateCampaignResult |
updateCampaign(UpdateCampaignRequest request)
Updates a campaign.
|
UpdateDecoderManifestResult |
updateDecoderManifest(UpdateDecoderManifestRequest request)
Updates a decoder manifest.
|
UpdateFleetResult |
updateFleet(UpdateFleetRequest request)
Updates the description of an existing fleet.
|
UpdateModelManifestResult |
updateModelManifest(UpdateModelManifestRequest request)
Updates a vehicle model (model manifest).
|
UpdateSignalCatalogResult |
updateSignalCatalog(UpdateSignalCatalogRequest request)
Updates a signal catalog.
|
UpdateVehicleResult |
updateVehicle(UpdateVehicleRequest request)
Updates a vehicle.
|
public AssociateVehicleFleetResult associateVehicleFleet(AssociateVehicleFleetRequest request)
AWSIoTFleetWise
Adds, or associates, a vehicle with a fleet.
associateVehicleFleet
in interface AWSIoTFleetWise
public BatchCreateVehicleResult batchCreateVehicle(BatchCreateVehicleRequest request)
AWSIoTFleetWise
Creates a group, or batch, of vehicles.
You must specify a decoder manifest and a vehicle model (model manifest) for each vehicle.
For more information, see Create multiple vehicles (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide.
batchCreateVehicle
in interface AWSIoTFleetWise
public BatchUpdateVehicleResult batchUpdateVehicle(BatchUpdateVehicleRequest request)
AWSIoTFleetWise
Updates a group, or batch, of vehicles.
You must specify a decoder manifest and a vehicle model (model manifest) for each vehicle.
For more information, see Update multiple vehicles (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide.
batchUpdateVehicle
in interface AWSIoTFleetWise
public CreateCampaignResult createCampaign(CreateCampaignRequest request)
AWSIoTFleetWise
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.
createCampaign
in interface AWSIoTFleetWise
public CreateDecoderManifestResult createDecoderManifest(CreateDecoderManifestRequest request)
AWSIoTFleetWise
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.
createDecoderManifest
in interface AWSIoTFleetWise
public CreateFleetResult createFleet(CreateFleetRequest request)
AWSIoTFleetWise
Creates a fleet that represents a group of vehicles.
You must create both a signal catalog and vehicles before you can create a fleet.
For more information, see Fleets in the Amazon Web Services IoT FleetWise Developer Guide.
createFleet
in interface AWSIoTFleetWise
public CreateModelManifestResult createModelManifest(CreateModelManifestRequest request)
AWSIoTFleetWise
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.
createModelManifest
in interface AWSIoTFleetWise
public CreateSignalCatalogResult createSignalCatalog(CreateSignalCatalogRequest request)
AWSIoTFleetWise
Creates a collection of standardized signals that can be reused to create vehicle models.
createSignalCatalog
in interface AWSIoTFleetWise
public CreateVehicleResult createVehicle(CreateVehicleRequest request)
AWSIoTFleetWise
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.
If you have an existing Amazon Web Services IoT Thing, you can use Amazon Web Services IoT FleetWise to create a vehicle and collect data from your thing.
For more information, see Create a vehicle (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide.
createVehicle
in interface AWSIoTFleetWise
public DeleteCampaignResult deleteCampaign(DeleteCampaignRequest request)
AWSIoTFleetWise
Deletes a data collection campaign. Deleting a campaign suspends all data collection and removes it from any vehicles.
deleteCampaign
in interface AWSIoTFleetWise
public DeleteDecoderManifestResult deleteDecoderManifest(DeleteDecoderManifestRequest request)
AWSIoTFleetWise
Deletes a decoder manifest. You can't delete a decoder manifest if it has vehicles associated with it.
If the decoder manifest is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.
deleteDecoderManifest
in interface AWSIoTFleetWise
public DeleteFleetResult deleteFleet(DeleteFleetRequest request)
AWSIoTFleetWise
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.
If the fleet is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.
deleteFleet
in interface AWSIoTFleetWise
public DeleteModelManifestResult deleteModelManifest(DeleteModelManifestRequest request)
AWSIoTFleetWise
Deletes a vehicle model (model manifest).
If the vehicle model is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.
deleteModelManifest
in interface AWSIoTFleetWise
public DeleteSignalCatalogResult deleteSignalCatalog(DeleteSignalCatalogRequest request)
AWSIoTFleetWise
Deletes a signal catalog.
If the signal catalog is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.
deleteSignalCatalog
in interface AWSIoTFleetWise
public DeleteVehicleResult deleteVehicle(DeleteVehicleRequest request)
AWSIoTFleetWise
Deletes a vehicle and removes it from any campaigns.
If the vehicle is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.
deleteVehicle
in interface AWSIoTFleetWise
public DisassociateVehicleFleetResult disassociateVehicleFleet(DisassociateVehicleFleetRequest request)
AWSIoTFleetWise
Removes, or disassociates, a vehicle from a fleet. Disassociating a vehicle from a fleet doesn't delete the vehicle.
If the vehicle is successfully dissociated from a fleet, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.
disassociateVehicleFleet
in interface AWSIoTFleetWise
public GetCampaignResult getCampaign(GetCampaignRequest request)
AWSIoTFleetWise
Retrieves information about a campaign.
getCampaign
in interface AWSIoTFleetWise
public GetDecoderManifestResult getDecoderManifest(GetDecoderManifestRequest request)
AWSIoTFleetWise
Retrieves information about a created decoder manifest.
getDecoderManifest
in interface AWSIoTFleetWise
public GetFleetResult getFleet(GetFleetRequest request)
AWSIoTFleetWise
Retrieves information about a fleet.
getFleet
in interface AWSIoTFleetWise
public GetLoggingOptionsResult getLoggingOptions(GetLoggingOptionsRequest request)
AWSIoTFleetWise
Retrieves the logging options.
getLoggingOptions
in interface AWSIoTFleetWise
public GetModelManifestResult getModelManifest(GetModelManifestRequest request)
AWSIoTFleetWise
Retrieves information about a vehicle model (model manifest).
getModelManifest
in interface AWSIoTFleetWise
public GetRegisterAccountStatusResult getRegisterAccountStatus(GetRegisterAccountStatusRequest request)
AWSIoTFleetWise
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.
This API operation doesn't require input parameters.
getRegisterAccountStatus
in interface AWSIoTFleetWise
public GetSignalCatalogResult getSignalCatalog(GetSignalCatalogRequest request)
AWSIoTFleetWise
Retrieves information about a signal catalog.
getSignalCatalog
in interface AWSIoTFleetWise
public GetVehicleResult getVehicle(GetVehicleRequest request)
AWSIoTFleetWise
Retrieves information about a vehicle.
getVehicle
in interface AWSIoTFleetWise
public GetVehicleStatusResult getVehicleStatus(GetVehicleStatusRequest request)
AWSIoTFleetWise
Retrieves information about the status of a vehicle with any associated campaigns.
getVehicleStatus
in interface AWSIoTFleetWise
public ImportDecoderManifestResult importDecoderManifest(ImportDecoderManifestRequest request)
AWSIoTFleetWise
Creates a decoder manifest using your existing CAN DBC file from your local device.
importDecoderManifest
in interface AWSIoTFleetWise
public ImportSignalCatalogResult importSignalCatalog(ImportSignalCatalogRequest request)
AWSIoTFleetWise
Creates a signal catalog using your existing VSS formatted content from your local device.
importSignalCatalog
in interface AWSIoTFleetWise
public ListCampaignsResult listCampaigns(ListCampaignsRequest request)
AWSIoTFleetWise
Lists information about created campaigns.
This API operation uses pagination. Specify the nextToken
parameter in the request to return more
results.
listCampaigns
in interface AWSIoTFleetWise
public ListDecoderManifestNetworkInterfacesResult listDecoderManifestNetworkInterfaces(ListDecoderManifestNetworkInterfacesRequest request)
AWSIoTFleetWise
Lists the network interfaces specified in a decoder manifest.
This API operation uses pagination. Specify the nextToken
parameter in the request to return more
results.
listDecoderManifestNetworkInterfaces
in interface AWSIoTFleetWise
public ListDecoderManifestSignalsResult listDecoderManifestSignals(ListDecoderManifestSignalsRequest request)
AWSIoTFleetWise
A list of information about signal decoders specified in a decoder manifest.
This API operation uses pagination. Specify the nextToken
parameter in the request to return more
results.
listDecoderManifestSignals
in interface AWSIoTFleetWise
public ListDecoderManifestsResult listDecoderManifests(ListDecoderManifestsRequest request)
AWSIoTFleetWise
Lists decoder manifests.
This API operation uses pagination. Specify the nextToken
parameter in the request to return more
results.
listDecoderManifests
in interface AWSIoTFleetWise
public ListFleetsResult listFleets(ListFleetsRequest request)
AWSIoTFleetWise
Retrieves information for each created fleet in an Amazon Web Services account.
This API operation uses pagination. Specify the nextToken
parameter in the request to return more
results.
listFleets
in interface AWSIoTFleetWise
public ListFleetsForVehicleResult listFleetsForVehicle(ListFleetsForVehicleRequest request)
AWSIoTFleetWise
Retrieves a list of IDs for all fleets that the vehicle is associated with.
This API operation uses pagination. Specify the nextToken
parameter in the request to return more
results.
listFleetsForVehicle
in interface AWSIoTFleetWise
public ListModelManifestNodesResult listModelManifestNodes(ListModelManifestNodesRequest request)
AWSIoTFleetWise
Lists information about nodes specified in a vehicle model (model manifest).
This API operation uses pagination. Specify the nextToken
parameter in the request to return more
results.
listModelManifestNodes
in interface AWSIoTFleetWise
public ListModelManifestsResult listModelManifests(ListModelManifestsRequest request)
AWSIoTFleetWise
Retrieves a list of vehicle models (model manifests).
This API operation uses pagination. Specify the nextToken
parameter in the request to return more
results.
listModelManifests
in interface AWSIoTFleetWise
public ListSignalCatalogNodesResult listSignalCatalogNodes(ListSignalCatalogNodesRequest request)
AWSIoTFleetWise
Lists of information about the signals (nodes) specified in a signal catalog.
This API operation uses pagination. Specify the nextToken
parameter in the request to return more
results.
listSignalCatalogNodes
in interface AWSIoTFleetWise
public ListSignalCatalogsResult listSignalCatalogs(ListSignalCatalogsRequest request)
AWSIoTFleetWise
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.
This API operation uses pagination. Specify the nextToken
parameter in the request to return more
results.
listSignalCatalogs
in interface AWSIoTFleetWise
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AWSIoTFleetWise
Lists the tags (metadata) you have assigned to the resource.
listTagsForResource
in interface AWSIoTFleetWise
public ListVehiclesResult listVehicles(ListVehiclesRequest request)
AWSIoTFleetWise
Retrieves a list of summaries of created vehicles.
This API operation uses pagination. Specify the nextToken
parameter in the request to return more
results.
listVehicles
in interface AWSIoTFleetWise
public ListVehiclesInFleetResult listVehiclesInFleet(ListVehiclesInFleetRequest request)
AWSIoTFleetWise
Retrieves a list of summaries of all vehicles associated with a fleet.
This API operation uses pagination. Specify the nextToken
parameter in the request to return more
results.
listVehiclesInFleet
in interface AWSIoTFleetWise
public PutLoggingOptionsResult putLoggingOptions(PutLoggingOptionsRequest request)
AWSIoTFleetWise
Creates or updates the logging option.
putLoggingOptions
in interface AWSIoTFleetWise
public RegisterAccountResult registerAccount(RegisterAccountRequest request)
AWSIoTFleetWise
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.
An Amazon Web Services account is not the same thing as a "user account". An Amazon Web Services user is an identity that you create using Identity and Access Management (IAM) and takes the form of either an IAM user or an IAM role, both with credentials. A single Amazon Web Services account can, and typically does, contain many users and roles.
registerAccount
in interface AWSIoTFleetWise
public TagResourceResult tagResource(TagResourceRequest request)
AWSIoTFleetWise
Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource.
tagResource
in interface AWSIoTFleetWise
public UntagResourceResult untagResource(UntagResourceRequest request)
AWSIoTFleetWise
Removes the given tags (metadata) from the resource.
untagResource
in interface AWSIoTFleetWise
public UpdateCampaignResult updateCampaign(UpdateCampaignRequest request)
AWSIoTFleetWise
Updates a campaign.
updateCampaign
in interface AWSIoTFleetWise
public UpdateDecoderManifestResult updateDecoderManifest(UpdateDecoderManifestRequest request)
AWSIoTFleetWise
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.
updateDecoderManifest
in interface AWSIoTFleetWise
public UpdateFleetResult updateFleet(UpdateFleetRequest request)
AWSIoTFleetWise
Updates the description of an existing fleet.
If the fleet is successfully updated, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty HTTP body.
updateFleet
in interface AWSIoTFleetWise
public UpdateModelManifestResult updateModelManifest(UpdateModelManifestRequest request)
AWSIoTFleetWise
Updates a vehicle model (model manifest). If created vehicles are associated with a vehicle model, it can't be updated.
updateModelManifest
in interface AWSIoTFleetWise
public UpdateSignalCatalogResult updateSignalCatalog(UpdateSignalCatalogRequest request)
AWSIoTFleetWise
Updates a signal catalog.
updateSignalCatalog
in interface AWSIoTFleetWise
public UpdateVehicleResult updateVehicle(UpdateVehicleRequest request)
AWSIoTFleetWise
Updates a vehicle.
updateVehicle
in interface AWSIoTFleetWise
public void shutdown()
AWSIoTFleetWise
shutdown
in interface AWSIoTFleetWise
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSIoTFleetWise
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata
in interface AWSIoTFleetWise
request
- The originally executed request.