@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSIoTFleetWiseClient extends AmazonWebServiceClient implements AWSIoTFleetWise
Amazon Web Services IoT FleetWise is a fully managed service that you can use to collect, model, and transfer vehicle data to the Amazon Web Services cloud at scale. With Amazon Web Services IoT FleetWise, you can standardize all of your vehicle data models, independent of the in-vehicle communication architecture, and define data collection rules to transfer only high-value data to the cloud.
For more information, see What is Amazon Web Services IoT FleetWise? in the Amazon Web Services IoT FleetWise Developer Guide.
LOGGING_AWS_REQUEST_METRIC
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.
|
static AWSIoTFleetWiseClientBuilder |
builder() |
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.
|
GetEncryptionConfigurationResult |
getEncryptionConfiguration(GetEncryptionConfigurationRequest request)
Retrieves the encryption configuration for resources and data in Amazon Web Services IoT FleetWise.
|
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.
|
PutEncryptionConfigurationResult |
putEncryptionConfiguration(PutEncryptionConfigurationRequest request)
Creates or updates the encryption configuration.
|
PutLoggingOptionsResult |
putLoggingOptions(PutLoggingOptionsRequest request)
Creates or updates the logging option.
|
RegisterAccountResult |
registerAccount(RegisterAccountRequest request)
|
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.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
public static AWSIoTFleetWiseClientBuilder builder()
public AssociateVehicleFleetResult associateVehicleFleet(AssociateVehicleFleetRequest request)
Adds, or associates, a vehicle with a fleet.
associateVehicleFleet
in interface AWSIoTFleetWise
associateVehicleFleetRequest
- InternalServerException
- The request couldn't be completed because the server temporarily failed.ResourceNotFoundException
- The resource wasn't found.LimitExceededException
- A service quota was exceeded.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException
- You don't have sufficient permission to perform this action.public BatchCreateVehicleResult batchCreateVehicle(BatchCreateVehicleRequest request)
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
batchCreateVehicleRequest
- InternalServerException
- The request couldn't be completed because the server temporarily failed.LimitExceededException
- A service quota was exceeded.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException
- You don't have sufficient permission to perform this action.public BatchUpdateVehicleResult batchUpdateVehicle(BatchUpdateVehicleRequest request)
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
batchUpdateVehicleRequest
- InternalServerException
- The request couldn't be completed because the server temporarily failed.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException
- You don't have sufficient permission to perform this action.public CreateCampaignResult createCampaign(CreateCampaignRequest request)
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
createCampaignRequest
- ResourceNotFoundException
- The resource wasn't found.InternalServerException
- The request couldn't be completed because the server temporarily failed.ConflictException
- The request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.LimitExceededException
- A service quota was exceeded.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException
- You don't have sufficient permission to perform this action.public CreateDecoderManifestResult createDecoderManifest(CreateDecoderManifestRequest request)
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
createDecoderManifestRequest
- ResourceNotFoundException
- The resource wasn't found.InternalServerException
- The request couldn't be completed because the server temporarily failed.ConflictException
- The request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.LimitExceededException
- A service quota was exceeded.DecoderManifestValidationException
- The request couldn't be completed because it contains signal decoders with one or more validation errors.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException
- You don't have sufficient permission to perform this action.public CreateFleetResult createFleet(CreateFleetRequest request)
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
createFleetRequest
- InternalServerException
- The request couldn't be completed because the server temporarily failed.ResourceNotFoundException
- The resource wasn't found.ConflictException
- The request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.LimitExceededException
- A service quota was exceeded.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException
- You don't have sufficient permission to perform this action.public CreateModelManifestResult createModelManifest(CreateModelManifestRequest request)
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
createModelManifestRequest
- ResourceNotFoundException
- The resource wasn't found.InternalServerException
- The request couldn't be completed because the server temporarily failed.ConflictException
- The request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.LimitExceededException
- A service quota was exceeded.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.InvalidSignalsException
- The request couldn't be completed because it contains signals that aren't valid.AccessDeniedException
- You don't have sufficient permission to perform this action.public CreateSignalCatalogResult createSignalCatalog(CreateSignalCatalogRequest request)
Creates a collection of standardized signals that can be reused to create vehicle models.
createSignalCatalog
in interface AWSIoTFleetWise
createSignalCatalogRequest
- InternalServerException
- The request couldn't be completed because the server temporarily failed.ConflictException
- The request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.LimitExceededException
- A service quota was exceeded.InvalidNodeException
- The specified node type doesn't match the expected node type for a node. You can specify the node type as
branch, sensor, actuator, or attribute.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.InvalidSignalsException
- The request couldn't be completed because it contains signals that aren't valid.AccessDeniedException
- You don't have sufficient permission to perform this action.public CreateVehicleResult createVehicle(CreateVehicleRequest request)
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
createVehicleRequest
- InternalServerException
- The request couldn't be completed because the server temporarily failed.ResourceNotFoundException
- The resource wasn't found.ConflictException
- The request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.LimitExceededException
- A service quota was exceeded.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException
- You don't have sufficient permission to perform this action.public DeleteCampaignResult deleteCampaign(DeleteCampaignRequest request)
Deletes a data collection campaign. Deleting a campaign suspends all data collection and removes it from any vehicles.
deleteCampaign
in interface AWSIoTFleetWise
deleteCampaignRequest
- ResourceNotFoundException
- The resource wasn't found.InternalServerException
- The request couldn't be completed because the server temporarily failed.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException
- You don't have sufficient permission to perform this action.public DeleteDecoderManifestResult deleteDecoderManifest(DeleteDecoderManifestRequest request)
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
deleteDecoderManifestRequest
- InternalServerException
- The request couldn't be completed because the server temporarily failed.ConflictException
- The request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException
- You don't have sufficient permission to perform this action.public DeleteFleetResult deleteFleet(DeleteFleetRequest request)
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
deleteFleetRequest
- InternalServerException
- The request couldn't be completed because the server temporarily failed.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException
- You don't have sufficient permission to perform this action.public DeleteModelManifestResult deleteModelManifest(DeleteModelManifestRequest request)
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
deleteModelManifestRequest
- InternalServerException
- The request couldn't be completed because the server temporarily failed.ConflictException
- The request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException
- You don't have sufficient permission to perform this action.public DeleteSignalCatalogResult deleteSignalCatalog(DeleteSignalCatalogRequest request)
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
deleteSignalCatalogRequest
- InternalServerException
- The request couldn't be completed because the server temporarily failed.ConflictException
- The request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException
- You don't have sufficient permission to perform this action.public DeleteVehicleResult deleteVehicle(DeleteVehicleRequest request)
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
deleteVehicleRequest
- InternalServerException
- The request couldn't be completed because the server temporarily failed.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException
- You don't have sufficient permission to perform this action.public DisassociateVehicleFleetResult disassociateVehicleFleet(DisassociateVehicleFleetRequest request)
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
disassociateVehicleFleetRequest
- InternalServerException
- The request couldn't be completed because the server temporarily failed.ResourceNotFoundException
- The resource wasn't found.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException
- You don't have sufficient permission to perform this action.public GetCampaignResult getCampaign(GetCampaignRequest request)
Retrieves information about a campaign.
getCampaign
in interface AWSIoTFleetWise
getCampaignRequest
- ResourceNotFoundException
- The resource wasn't found.InternalServerException
- The request couldn't be completed because the server temporarily failed.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException
- You don't have sufficient permission to perform this action.public GetDecoderManifestResult getDecoderManifest(GetDecoderManifestRequest request)
Retrieves information about a created decoder manifest.
getDecoderManifest
in interface AWSIoTFleetWise
getDecoderManifestRequest
- ResourceNotFoundException
- The resource wasn't found.InternalServerException
- The request couldn't be completed because the server temporarily failed.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException
- You don't have sufficient permission to perform this action.public GetEncryptionConfigurationResult getEncryptionConfiguration(GetEncryptionConfigurationRequest request)
Retrieves the encryption configuration for resources and data in Amazon Web Services IoT FleetWise.
getEncryptionConfiguration
in interface AWSIoTFleetWise
getEncryptionConfigurationRequest
- ResourceNotFoundException
- The resource wasn't found.InternalServerException
- The request couldn't be completed because the server temporarily failed.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException
- You don't have sufficient permission to perform this action.public GetFleetResult getFleet(GetFleetRequest request)
Retrieves information about a fleet.
getFleet
in interface AWSIoTFleetWise
getFleetRequest
- InternalServerException
- The request couldn't be completed because the server temporarily failed.ResourceNotFoundException
- The resource wasn't found.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException
- You don't have sufficient permission to perform this action.public GetLoggingOptionsResult getLoggingOptions(GetLoggingOptionsRequest request)
Retrieves the logging options.
getLoggingOptions
in interface AWSIoTFleetWise
getLoggingOptionsRequest
- InternalServerException
- The request couldn't be completed because the server temporarily failed.ThrottlingException
- The request couldn't be completed due to throttling.AccessDeniedException
- You don't have sufficient permission to perform this action.public GetModelManifestResult getModelManifest(GetModelManifestRequest request)
Retrieves information about a vehicle model (model manifest).
getModelManifest
in interface AWSIoTFleetWise
getModelManifestRequest
- ResourceNotFoundException
- The resource wasn't found.InternalServerException
- The request couldn't be completed because the server temporarily failed.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException
- You don't have sufficient permission to perform this action.public 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.
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
getRegisterAccountStatusRequest
- ResourceNotFoundException
- The resource wasn't found.InternalServerException
- The request couldn't be completed because the server temporarily failed.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException
- You don't have sufficient permission to perform this action.public GetSignalCatalogResult getSignalCatalog(GetSignalCatalogRequest request)
Retrieves information about a signal catalog.
getSignalCatalog
in interface AWSIoTFleetWise
getSignalCatalogRequest
- ResourceNotFoundException
- The resource wasn't found.InternalServerException
- The request couldn't be completed because the server temporarily failed.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException
- You don't have sufficient permission to perform this action.public GetVehicleResult getVehicle(GetVehicleRequest request)
Retrieves information about a vehicle.
getVehicle
in interface AWSIoTFleetWise
getVehicleRequest
- InternalServerException
- The request couldn't be completed because the server temporarily failed.ResourceNotFoundException
- The resource wasn't found.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException
- You don't have sufficient permission to perform this action.public GetVehicleStatusResult getVehicleStatus(GetVehicleStatusRequest request)
Retrieves information about the status of a vehicle with any associated campaigns.
getVehicleStatus
in interface AWSIoTFleetWise
getVehicleStatusRequest
- ResourceNotFoundException
- The resource wasn't found.InternalServerException
- The request couldn't be completed because the server temporarily failed.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException
- You don't have sufficient permission to perform this action.public ImportDecoderManifestResult importDecoderManifest(ImportDecoderManifestRequest request)
Creates a decoder manifest using your existing CAN DBC file from your local device.
importDecoderManifest
in interface AWSIoTFleetWise
importDecoderManifestRequest
- ResourceNotFoundException
- The resource wasn't found.InternalServerException
- The request couldn't be completed because the server temporarily failed.ConflictException
- The request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.DecoderManifestValidationException
- The request couldn't be completed because it contains signal decoders with one or more validation errors.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.InvalidSignalsException
- The request couldn't be completed because it contains signals that aren't valid.AccessDeniedException
- You don't have sufficient permission to perform this action.public ImportSignalCatalogResult importSignalCatalog(ImportSignalCatalogRequest request)
Creates a signal catalog using your existing VSS formatted content from your local device.
importSignalCatalog
in interface AWSIoTFleetWise
importSignalCatalogRequest
- ResourceNotFoundException
- The resource wasn't found.InternalServerException
- The request couldn't be completed because the server temporarily failed.ConflictException
- The request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.LimitExceededException
- A service quota was exceeded.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.InvalidSignalsException
- The request couldn't be completed because it contains signals that aren't valid.AccessDeniedException
- You don't have sufficient permission to perform this action.public ListCampaignsResult listCampaigns(ListCampaignsRequest request)
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
listCampaignsRequest
- InternalServerException
- The request couldn't be completed because the server temporarily failed.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException
- You don't have sufficient permission to perform this action.public ListDecoderManifestNetworkInterfacesResult listDecoderManifestNetworkInterfaces(ListDecoderManifestNetworkInterfacesRequest request)
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
listDecoderManifestNetworkInterfacesRequest
- ResourceNotFoundException
- The resource wasn't found.InternalServerException
- The request couldn't be completed because the server temporarily failed.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException
- You don't have sufficient permission to perform this action.public ListDecoderManifestSignalsResult listDecoderManifestSignals(ListDecoderManifestSignalsRequest request)
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
listDecoderManifestSignalsRequest
- ResourceNotFoundException
- The resource wasn't found.InternalServerException
- The request couldn't be completed because the server temporarily failed.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException
- You don't have sufficient permission to perform this action.public ListDecoderManifestsResult listDecoderManifests(ListDecoderManifestsRequest request)
Lists decoder manifests.
This API operation uses pagination. Specify the nextToken
parameter in the request to return more
results.
listDecoderManifests
in interface AWSIoTFleetWise
listDecoderManifestsRequest
- InternalServerException
- The request couldn't be completed because the server temporarily failed.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException
- You don't have sufficient permission to perform this action.public ListFleetsResult listFleets(ListFleetsRequest request)
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
listFleetsRequest
- InternalServerException
- The request couldn't be completed because the server temporarily failed.ResourceNotFoundException
- The resource wasn't found.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException
- You don't have sufficient permission to perform this action.public ListFleetsForVehicleResult listFleetsForVehicle(ListFleetsForVehicleRequest request)
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
listFleetsForVehicleRequest
- InternalServerException
- The request couldn't be completed because the server temporarily failed.ResourceNotFoundException
- The resource wasn't found.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException
- You don't have sufficient permission to perform this action.public ListModelManifestNodesResult listModelManifestNodes(ListModelManifestNodesRequest request)
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
listModelManifestNodesRequest
- InternalServerException
- The request couldn't be completed because the server temporarily failed.ResourceNotFoundException
- The resource wasn't found.LimitExceededException
- A service quota was exceeded.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException
- You don't have sufficient permission to perform this action.public ListModelManifestsResult listModelManifests(ListModelManifestsRequest request)
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
listModelManifestsRequest
- InternalServerException
- The request couldn't be completed because the server temporarily failed.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException
- You don't have sufficient permission to perform this action.public ListSignalCatalogNodesResult listSignalCatalogNodes(ListSignalCatalogNodesRequest request)
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
listSignalCatalogNodesRequest
- InternalServerException
- The request couldn't be completed because the server temporarily failed.ResourceNotFoundException
- The resource wasn't found.LimitExceededException
- A service quota was exceeded.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException
- You don't have sufficient permission to perform this action.public ListSignalCatalogsResult listSignalCatalogs(ListSignalCatalogsRequest request)
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
listSignalCatalogsRequest
- InternalServerException
- The request couldn't be completed because the server temporarily failed.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException
- You don't have sufficient permission to perform this action.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Lists the tags (metadata) you have assigned to the resource.
listTagsForResource
in interface AWSIoTFleetWise
listTagsForResourceRequest
- ResourceNotFoundException
- The resource wasn't found.InternalServerException
- The request couldn't be completed because the server temporarily failed.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException
- You don't have sufficient permission to perform this action.public ListVehiclesResult listVehicles(ListVehiclesRequest request)
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
listVehiclesRequest
- InternalServerException
- The request couldn't be completed because the server temporarily failed.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException
- You don't have sufficient permission to perform this action.public ListVehiclesInFleetResult listVehiclesInFleet(ListVehiclesInFleetRequest request)
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
listVehiclesInFleetRequest
- InternalServerException
- The request couldn't be completed because the server temporarily failed.ResourceNotFoundException
- The resource wasn't found.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException
- You don't have sufficient permission to perform this action.public PutEncryptionConfigurationResult putEncryptionConfiguration(PutEncryptionConfigurationRequest request)
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.
putEncryptionConfiguration
in interface AWSIoTFleetWise
putEncryptionConfigurationRequest
- ResourceNotFoundException
- The resource wasn't found.InternalServerException
- The request couldn't be completed because the server temporarily failed.ConflictException
- The request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException
- You don't have sufficient permission to perform this action.public PutLoggingOptionsResult putLoggingOptions(PutLoggingOptionsRequest request)
Creates or updates the logging option.
putLoggingOptions
in interface AWSIoTFleetWise
putLoggingOptionsRequest
- ResourceNotFoundException
- The resource wasn't found.InternalServerException
- The request couldn't be completed because the server temporarily failed.ConflictException
- The request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException
- You don't have sufficient permission to perform this action.public RegisterAccountResult registerAccount(RegisterAccountRequest request)
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.
An Amazon Web Services account is not the same thing as a "user." 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
registerAccountRequest
- ResourceNotFoundException
- The resource wasn't found.InternalServerException
- The request couldn't be completed because the server temporarily failed.ConflictException
- The request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException
- You don't have sufficient permission to perform this action.public TagResourceResult tagResource(TagResourceRequest request)
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
tagResourceRequest
- ResourceNotFoundException
- The resource wasn't found.InternalServerException
- The request couldn't be completed because the server temporarily failed.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException
- You don't have sufficient permission to perform this action.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes the given tags (metadata) from the resource.
untagResource
in interface AWSIoTFleetWise
untagResourceRequest
- ResourceNotFoundException
- The resource wasn't found.InternalServerException
- The request couldn't be completed because the server temporarily failed.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException
- You don't have sufficient permission to perform this action.public UpdateCampaignResult updateCampaign(UpdateCampaignRequest request)
Updates a campaign.
updateCampaign
in interface AWSIoTFleetWise
updateCampaignRequest
- ResourceNotFoundException
- The resource wasn't found.InternalServerException
- The request couldn't be completed because the server temporarily failed.ConflictException
- The request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException
- You don't have sufficient permission to perform this action.public UpdateDecoderManifestResult updateDecoderManifest(UpdateDecoderManifestRequest request)
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
updateDecoderManifestRequest
- ResourceNotFoundException
- The resource wasn't found.InternalServerException
- The request couldn't be completed because the server temporarily failed.ConflictException
- The request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.LimitExceededException
- A service quota was exceeded.DecoderManifestValidationException
- The request couldn't be completed because it contains signal decoders with one or more validation errors.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException
- You don't have sufficient permission to perform this action.public UpdateFleetResult updateFleet(UpdateFleetRequest request)
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
updateFleetRequest
- InternalServerException
- The request couldn't be completed because the server temporarily failed.ResourceNotFoundException
- The resource wasn't found.ConflictException
- The request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException
- You don't have sufficient permission to perform this action.public UpdateModelManifestResult updateModelManifest(UpdateModelManifestRequest request)
Updates a vehicle model (model manifest). If created vehicles are associated with a vehicle model, it can't be updated.
updateModelManifest
in interface AWSIoTFleetWise
updateModelManifestRequest
- InternalServerException
- The request couldn't be completed because the server temporarily failed.ResourceNotFoundException
- The resource wasn't found.ConflictException
- The request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.InvalidSignalsException
- The request couldn't be completed because it contains signals that aren't valid.AccessDeniedException
- You don't have sufficient permission to perform this action.public UpdateSignalCatalogResult updateSignalCatalog(UpdateSignalCatalogRequest request)
Updates a signal catalog.
updateSignalCatalog
in interface AWSIoTFleetWise
updateSignalCatalogRequest
- ResourceNotFoundException
- The resource wasn't found.InternalServerException
- The request couldn't be completed because the server temporarily failed.ConflictException
- The request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.LimitExceededException
- A service quota was exceeded.InvalidNodeException
- The specified node type doesn't match the expected node type for a node. You can specify the node type as
branch, sensor, actuator, or attribute.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.InvalidSignalsException
- The request couldn't be completed because it contains signals that aren't valid.AccessDeniedException
- You don't have sufficient permission to perform this action.public UpdateVehicleResult updateVehicle(UpdateVehicleRequest request)
Updates a vehicle.
updateVehicle
in interface AWSIoTFleetWise
updateVehicleRequest
- InternalServerException
- The request couldn't be completed because the server temporarily failed.ResourceNotFoundException
- The resource wasn't found.ConflictException
- The request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.ThrottlingException
- The request couldn't be completed due to throttling.ValidationException
- The input fails to satisfy the constraints specified by an Amazon Web Services service.AccessDeniedException
- You don't have sufficient permission to perform this action.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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 the request.
getCachedResponseMetadata
in interface AWSIoTFleetWise
request
- The originally executed requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AWSIoTFleetWise
shutdown
in class AmazonWebServiceClient