amazonka-iotfleetwise-2.0: Amazon IoT FleetWise SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.IoTFleetWise.Lens

Description

 
Synopsis

Operations

AssociateVehicleFleet

associateVehicleFleet_vehicleName :: Lens' AssociateVehicleFleet Text Source #

The unique ID of the vehicle to associate with the fleet.

BatchCreateVehicle

batchCreateVehicle_vehicles :: Lens' BatchCreateVehicle [CreateVehicleRequestItem] Source #

A list of information about each vehicle to create. For more information, see the API data type.

batchCreateVehicleResponse_errors :: Lens' BatchCreateVehicleResponse (Maybe [CreateVehicleError]) Source #

A list of information about creation errors, or an empty list if there aren't any errors.

batchCreateVehicleResponse_vehicles :: Lens' BatchCreateVehicleResponse (Maybe [CreateVehicleResponseItem]) Source #

A list of information about a batch of created vehicles. For more information, see the API data type.

BatchUpdateVehicle

batchUpdateVehicle_vehicles :: Lens' BatchUpdateVehicle [UpdateVehicleRequestItem] Source #

A list of information about the vehicles to update. For more information, see the API data type.

batchUpdateVehicleResponse_errors :: Lens' BatchUpdateVehicleResponse (Maybe [UpdateVehicleError]) Source #

A list of information about errors returned while updating a batch of vehicles, or, if there aren't any errors, an empty list.

batchUpdateVehicleResponse_vehicles :: Lens' BatchUpdateVehicleResponse (Maybe [UpdateVehicleResponseItem]) Source #

A list of information about the batch of updated vehicles.

This list contains only unique IDs for the vehicles that were updated.

CreateCampaign

createCampaign_compression :: Lens' CreateCampaign (Maybe Compression) Source #

(Optional) Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If you don't want to compress the signals, use OFF. If it's not specified, SNAPPY is used.

Default: SNAPPY

createCampaign_dataExtraDimensions :: Lens' CreateCampaign (Maybe [Text]) Source #

(Optional) A list of vehicle attributes to associate with a campaign.

Enrich the data with specified vehicle attributes. For example, add make and model to the campaign, and Amazon Web Services IoT FleetWise will associate the data with those attributes as dimensions in Amazon Timestream. You can then query the data against make and model.

Default: An empty array

createCampaign_description :: Lens' CreateCampaign (Maybe Text) Source #

An optional description of the campaign to help identify its purpose.

createCampaign_diagnosticsMode :: Lens' CreateCampaign (Maybe DiagnosticsMode) Source #

(Optional) Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise. If you want to send diagnostic trouble codes, use SEND_ACTIVE_DTCS. If it's not specified, OFF is used.

Default: OFF

createCampaign_expiryTime :: Lens' CreateCampaign (Maybe UTCTime) Source #

(Optional) The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time). Vehicle data won't be collected after the campaign expires.

Default: 253402214400 (December 31, 9999, 00:00:00 UTC)

createCampaign_postTriggerCollectionDuration :: Lens' CreateCampaign (Maybe Natural) Source #

(Optional) How long (in milliseconds) to collect raw data after a triggering event initiates the collection. If it's not specified, 0 is used.

Default: 0

createCampaign_priority :: Lens' CreateCampaign (Maybe Natural) Source #

(Optional) A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet. A campaign with the lowest value is deployed to vehicles before any other campaigns. If it's not specified, 0 is used.

Default: 0

createCampaign_signalsToCollect :: Lens' CreateCampaign (Maybe [SignalInformation]) Source #

(Optional) A list of information about signals to collect.

createCampaign_spoolingMode :: Lens' CreateCampaign (Maybe SpoolingMode) Source #

(Optional) Whether to store collected data after a vehicle lost a connection with the cloud. After a connection is re-established, the data is automatically forwarded to Amazon Web Services IoT FleetWise. If you want to store collected data when a vehicle loses connection with the cloud, use TO_DISK. If it's not specified, OFF is used.

Default: OFF

createCampaign_startTime :: Lens' CreateCampaign (Maybe UTCTime) Source #

(Optional) The time, in milliseconds, to deliver a campaign after it was approved. If it's not specified, 0 is used.

Default: 0

createCampaign_tags :: Lens' CreateCampaign (Maybe [Tag]) Source #

Metadata that can be used to manage the campaign.

createCampaign_name :: Lens' CreateCampaign Text Source #

The name of the campaign to create.

createCampaign_signalCatalogArn :: Lens' CreateCampaign Text Source #

(Optional) The Amazon Resource Name (ARN) of the signal catalog to associate with the campaign.

createCampaign_targetArn :: Lens' CreateCampaign Text Source #

The ARN of the vehicle or fleet to deploy a campaign to.

createCampaign_collectionScheme :: Lens' CreateCampaign CollectionScheme Source #

The data collection scheme associated with the campaign. You can specify a scheme that collects data based on time or an event.

CreateDecoderManifest

createDecoderManifest_description :: Lens' CreateDecoderManifest (Maybe Text) Source #

A brief description of the decoder manifest.

createDecoderManifest_networkInterfaces :: Lens' CreateDecoderManifest (Maybe (NonEmpty NetworkInterface)) Source #

A list of information about available network interfaces.

createDecoderManifest_tags :: Lens' CreateDecoderManifest (Maybe [Tag]) Source #

Metadata that can be used to manage the decoder manifest.

createDecoderManifest_name :: Lens' CreateDecoderManifest Text Source #

The unique name of the decoder manifest to create.

createDecoderManifest_modelManifestArn :: Lens' CreateDecoderManifest Text Source #

The Amazon Resource Name (ARN) of the vehicle model (model manifest).

CreateFleet

createFleet_description :: Lens' CreateFleet (Maybe Text) Source #

A brief description of the fleet to create.

createFleet_tags :: Lens' CreateFleet (Maybe [Tag]) Source #

Metadata that can be used to manage the fleet.

createFleet_fleetId :: Lens' CreateFleet Text Source #

The unique ID of the fleet to create.

createFleet_signalCatalogArn :: Lens' CreateFleet Text Source #

The Amazon Resource Name (ARN) of a signal catalog.

CreateModelManifest

createModelManifest_description :: Lens' CreateModelManifest (Maybe Text) Source #

A brief description of the vehicle model.

createModelManifest_tags :: Lens' CreateModelManifest (Maybe [Tag]) Source #

Metadata that can be used to manage the vehicle model.

createModelManifest_name :: Lens' CreateModelManifest Text Source #

The name of the vehicle model to create.

createModelManifest_nodes :: Lens' CreateModelManifest [Text] Source #

A list of nodes, which are a general abstraction of signals.

createModelManifest_signalCatalogArn :: Lens' CreateModelManifest Text Source #

The Amazon Resource Name (ARN) of a signal catalog.

CreateSignalCatalog

createSignalCatalog_description :: Lens' CreateSignalCatalog (Maybe Text) Source #

A brief description of the signal catalog.

createSignalCatalog_nodes :: Lens' CreateSignalCatalog (Maybe [Node]) Source #

A list of information about nodes, which are a general abstraction of signals. For more information, see the API data type.

createSignalCatalog_tags :: Lens' CreateSignalCatalog (Maybe [Tag]) Source #

Metadata that can be used to manage the signal catalog.

createSignalCatalog_name :: Lens' CreateSignalCatalog Text Source #

The name of the signal catalog to create.

CreateVehicle

createVehicle_associationBehavior :: Lens' CreateVehicle (Maybe VehicleAssociationBehavior) Source #

An option to create a new Amazon Web Services IoT thing when creating a vehicle, or to validate an existing Amazon Web Services IoT thing as a vehicle.

Default:

createVehicle_attributes :: Lens' CreateVehicle (Maybe (HashMap Text Text)) Source #

Static information about a vehicle in a key-value pair. For example: "engineType" : "1.3 L R2"

createVehicle_tags :: Lens' CreateVehicle (Maybe [Tag]) Source #

Metadata that can be used to manage the vehicle.

createVehicle_vehicleName :: Lens' CreateVehicle Text Source #

The unique ID of the vehicle to create.

createVehicle_modelManifestArn :: Lens' CreateVehicle Text Source #

The Amazon Resource Name ARN of a vehicle model.

createVehicleResponse_thingArn :: Lens' CreateVehicleResponse (Maybe Text) Source #

The ARN of a created or validated Amazon Web Services IoT thing.

DeleteCampaign

deleteCampaign_name :: Lens' DeleteCampaign Text Source #

The name of the campaign to delete.

deleteCampaignResponse_arn :: Lens' DeleteCampaignResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the deleted campaign.

The ARN isn’t returned if a campaign doesn’t exist.

DeleteDecoderManifest

deleteDecoderManifest_name :: Lens' DeleteDecoderManifest Text Source #

The name of the decoder manifest to delete.

deleteDecoderManifestResponse_arn :: Lens' DeleteDecoderManifestResponse Text Source #

The Amazon Resource Name (ARN) of the deleted decoder manifest.

DeleteFleet

deleteFleet_fleetId :: Lens' DeleteFleet Text Source #

The ID of the fleet to delete.

deleteFleetResponse_arn :: Lens' DeleteFleetResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the deleted fleet.

DeleteModelManifest

deleteModelManifest_name :: Lens' DeleteModelManifest Text Source #

The name of the model manifest to delete.

deleteModelManifestResponse_arn :: Lens' DeleteModelManifestResponse Text Source #

The Amazon Resource Name (ARN) of the deleted model manifest.

DeleteSignalCatalog

deleteSignalCatalog_name :: Lens' DeleteSignalCatalog Text Source #

The name of the signal catalog to delete.

deleteSignalCatalogResponse_arn :: Lens' DeleteSignalCatalogResponse Text Source #

The Amazon Resource Name (ARN) of the deleted signal catalog.

DeleteVehicle

deleteVehicle_vehicleName :: Lens' DeleteVehicle Text Source #

The ID of the vehicle to delete.

deleteVehicleResponse_arn :: Lens' DeleteVehicleResponse Text Source #

The Amazon Resource Name (ARN) of the deleted vehicle.

DisassociateVehicleFleet

disassociateVehicleFleet_vehicleName :: Lens' DisassociateVehicleFleet Text Source #

The unique ID of the vehicle to disassociate from the fleet.

GetCampaign

getCampaign_name :: Lens' GetCampaign Text Source #

The name of the campaign to retrieve information about.

getCampaignResponse_arn :: Lens' GetCampaignResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the campaign.

getCampaignResponse_collectionScheme :: Lens' GetCampaignResponse (Maybe CollectionScheme) Source #

Information about the data collection scheme associated with the campaign.

getCampaignResponse_compression :: Lens' GetCampaignResponse (Maybe Compression) Source #

Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If OFF is specified, the signals aren't compressed. If it's not specified, SNAPPY is used.

getCampaignResponse_creationTime :: Lens' GetCampaignResponse (Maybe UTCTime) Source #

The time the campaign was created in seconds since epoch (January 1, 1970 at midnight UTC time).

getCampaignResponse_dataExtraDimensions :: Lens' GetCampaignResponse (Maybe [Text]) Source #

A list of vehicle attributes associated with the campaign.

getCampaignResponse_diagnosticsMode :: Lens' GetCampaignResponse (Maybe DiagnosticsMode) Source #

Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise.

getCampaignResponse_expiryTime :: Lens' GetCampaignResponse (Maybe UTCTime) Source #

The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time). Vehicle data won't be collected after the campaign expires.

getCampaignResponse_postTriggerCollectionDuration :: Lens' GetCampaignResponse (Maybe Natural) Source #

How long (in seconds) to collect raw data after a triggering event initiates the collection.

getCampaignResponse_priority :: Lens' GetCampaignResponse (Maybe Natural) Source #

A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet. A campaign with the lowest value is deployed to vehicles before any other campaigns.

getCampaignResponse_signalsToCollect :: Lens' GetCampaignResponse (Maybe [SignalInformation]) Source #

Information about a list of signals to collect data on.

getCampaignResponse_spoolingMode :: Lens' GetCampaignResponse (Maybe SpoolingMode) Source #

Whether to store collected data after a vehicle lost a connection with the cloud. After a connection is re-established, the data is automatically forwarded to Amazon Web Services IoT FleetWise.

getCampaignResponse_startTime :: Lens' GetCampaignResponse (Maybe UTCTime) Source #

The time, in milliseconds, to deliver a campaign after it was approved.

getCampaignResponse_status :: Lens' GetCampaignResponse (Maybe CampaignStatus) Source #

The state of the campaign. The status can be one of: CREATING, WAITING_FOR_APPROVAL, RUNNING, and SUSPENDED.

getCampaignResponse_targetArn :: Lens' GetCampaignResponse (Maybe Text) Source #

The ARN of the vehicle or the fleet targeted by the campaign.

GetDecoderManifest

getDecoderManifest_name :: Lens' GetDecoderManifest Text Source #

The name of the decoder manifest to retrieve information about.

getDecoderManifestResponse_modelManifestArn :: Lens' GetDecoderManifestResponse (Maybe Text) Source #

The ARN of a vehicle model (model manifest) associated with the decoder manifest.

getDecoderManifestResponse_status :: Lens' GetDecoderManifestResponse (Maybe ManifestStatus) Source #

The state of the decoder manifest. If the status is ACTIVE, the decoder manifest can't be edited. If the status is marked DRAFT, you can edit the decoder manifest.

getDecoderManifestResponse_arn :: Lens' GetDecoderManifestResponse Text Source #

The Amazon Resource Name (ARN) of the decoder manifest.

getDecoderManifestResponse_creationTime :: Lens' GetDecoderManifestResponse UTCTime Source #

The time the decoder manifest was created in seconds since epoch (January 1, 1970 at midnight UTC time).

getDecoderManifestResponse_lastModificationTime :: Lens' GetDecoderManifestResponse UTCTime Source #

The time the decoder manifest was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).

GetFleet

getFleet_fleetId :: Lens' GetFleet Text Source #

The ID of the fleet to retrieve information about.

getFleetResponse_description :: Lens' GetFleetResponse (Maybe Text) Source #

A brief description of the fleet.

getFleetResponse_httpStatus :: Lens' GetFleetResponse Int Source #

The response's http status code.

getFleetResponse_arn :: Lens' GetFleetResponse Text Source #

The Amazon Resource Name (ARN) of the fleet.

getFleetResponse_signalCatalogArn :: Lens' GetFleetResponse Text Source #

The ARN of a signal catalog associated with the fleet.

getFleetResponse_creationTime :: Lens' GetFleetResponse UTCTime Source #

The time the fleet was created in seconds since epoch (January 1, 1970 at midnight UTC time).

getFleetResponse_lastModificationTime :: Lens' GetFleetResponse UTCTime Source #

The time the fleet was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time).

GetLoggingOptions

GetModelManifest

getModelManifest_name :: Lens' GetModelManifest Text Source #

The name of the vehicle model to retrieve information about.

getModelManifestResponse_signalCatalogArn :: Lens' GetModelManifestResponse (Maybe Text) Source #

The ARN of the signal catalog associated with the vehicle model.

getModelManifestResponse_status :: Lens' GetModelManifestResponse (Maybe ManifestStatus) Source #

The state of the vehicle model. If the status is ACTIVE, the vehicle model can't be edited. You can edit the vehicle model if the status is marked DRAFT.

getModelManifestResponse_arn :: Lens' GetModelManifestResponse Text Source #

The Amazon Resource Name (ARN) of the vehicle model.

getModelManifestResponse_creationTime :: Lens' GetModelManifestResponse UTCTime Source #

The time the vehicle model was created, in seconds since epoch (January 1, 1970 at midnight UTC time).

GetRegisterAccountStatus

getRegisterAccountStatusResponse_customerAccountId :: Lens' GetRegisterAccountStatusResponse Text Source #

The unique ID of the Amazon Web Services account, provided at account creation.

getRegisterAccountStatusResponse_accountStatus :: Lens' GetRegisterAccountStatusResponse RegistrationStatus Source #

The status of registering your account and resources. The status can be one of:

  • REGISTRATION_SUCCESS - The Amazon Web Services resource is successfully registered.
  • REGISTRATION_PENDING - Amazon Web Services IoT FleetWise is processing the registration request. This process takes approximately five minutes to complete.
  • REGISTRATION_FAILURE - Amazon Web Services IoT FleetWise can't register the AWS resource. Try again later.

getRegisterAccountStatusResponse_creationTime :: Lens' GetRegisterAccountStatusResponse UTCTime Source #

The time the account was registered, in seconds since epoch (January 1, 1970 at midnight UTC time).

getRegisterAccountStatusResponse_lastModificationTime :: Lens' GetRegisterAccountStatusResponse UTCTime Source #

The time this registration was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time).

GetSignalCatalog

getSignalCatalog_name :: Lens' GetSignalCatalog Text Source #

The name of the signal catalog to retrieve information about.

getSignalCatalogResponse_nodeCounts :: Lens' GetSignalCatalogResponse (Maybe NodeCounts) Source #

The total number of network nodes specified in a signal catalog.

getSignalCatalogResponse_arn :: Lens' GetSignalCatalogResponse Text Source #

The Amazon Resource Name (ARN) of the signal catalog.

getSignalCatalogResponse_creationTime :: Lens' GetSignalCatalogResponse UTCTime Source #

The time the signal catalog was created in seconds since epoch (January 1, 1970 at midnight UTC time).

GetVehicle

getVehicle_vehicleName :: Lens' GetVehicle Text Source #

The ID of the vehicle to retrieve information about.

getVehicleResponse_arn :: Lens' GetVehicleResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the vehicle to retrieve information about.

getVehicleResponse_attributes :: Lens' GetVehicleResponse (Maybe (HashMap Text Text)) Source #

Static information about a vehicle in a key-value pair. For example:

"engineType" : "1.3 L R2"

getVehicleResponse_creationTime :: Lens' GetVehicleResponse (Maybe UTCTime) Source #

The time the vehicle was created in seconds since epoch (January 1, 1970 at midnight UTC time).

getVehicleResponse_decoderManifestArn :: Lens' GetVehicleResponse (Maybe Text) Source #

The ARN of a decoder manifest associated with the vehicle.

getVehicleResponse_lastModificationTime :: Lens' GetVehicleResponse (Maybe UTCTime) Source #

The time the vehicle was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).

getVehicleResponse_modelManifestArn :: Lens' GetVehicleResponse (Maybe Text) Source #

The ARN of a vehicle model (model manifest) associated with the vehicle.

GetVehicleStatus

getVehicleStatus_maxResults :: Lens' GetVehicleStatus (Maybe Natural) Source #

The maximum number of items to return, between 1 and 100, inclusive.

getVehicleStatus_nextToken :: Lens' GetVehicleStatus (Maybe Text) Source #

A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

getVehicleStatus_vehicleName :: Lens' GetVehicleStatus Text Source #

The ID of the vehicle to retrieve information about.

getVehicleStatusResponse_campaigns :: Lens' GetVehicleStatusResponse (Maybe [VehicleStatus]) Source #

Lists information about the state of the vehicle with deployed campaigns.

getVehicleStatusResponse_nextToken :: Lens' GetVehicleStatusResponse (Maybe Text) Source #

The token to retrieve the next set of results, or null if there are no more results.

ImportDecoderManifest

importDecoderManifest_name :: Lens' ImportDecoderManifest Text Source #

The name of the decoder manifest to import.

importDecoderManifestResponse_arn :: Lens' ImportDecoderManifestResponse Text Source #

The Amazon Resource Name (ARN) of the decoder manifest that was imported.

ImportSignalCatalog

importSignalCatalog_description :: Lens' ImportSignalCatalog (Maybe Text) Source #

A brief description of the signal catalog.

importSignalCatalog_tags :: Lens' ImportSignalCatalog (Maybe [Tag]) Source #

Metadata that can be used to manage the signal catalog.

importSignalCatalog_vss :: Lens' ImportSignalCatalog (Maybe FormattedVss) Source #

The contents of the Vehicle Signal Specification (VSS) configuration. VSS is a precise language used to describe and model signals in vehicle networks.

importSignalCatalog_name :: Lens' ImportSignalCatalog Text Source #

The name of the signal catalog to import.

importSignalCatalogResponse_arn :: Lens' ImportSignalCatalogResponse Text Source #

The Amazon Resource Name (ARN) of the imported signal catalog.

ListCampaigns

listCampaigns_maxResults :: Lens' ListCampaigns (Maybe Natural) Source #

The maximum number of items to return, between 1 and 100, inclusive.

listCampaigns_nextToken :: Lens' ListCampaigns (Maybe Text) Source #

A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

listCampaigns_status :: Lens' ListCampaigns (Maybe Text) Source #

Optional parameter to filter the results by the status of each created campaign in your account. The status can be one of: CREATING, WAITING_FOR_APPROVAL, RUNNING, or SUSPENDED.

listCampaignsResponse_nextToken :: Lens' ListCampaignsResponse (Maybe Text) Source #

The token to retrieve the next set of results, or null if there are no more results.

ListDecoderManifestNetworkInterfaces

listDecoderManifestNetworkInterfaces_maxResults :: Lens' ListDecoderManifestNetworkInterfaces (Maybe Natural) Source #

The maximum number of items to return, between 1 and 100, inclusive.

listDecoderManifestNetworkInterfaces_nextToken :: Lens' ListDecoderManifestNetworkInterfaces (Maybe Text) Source #

A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

listDecoderManifestNetworkInterfaces_name :: Lens' ListDecoderManifestNetworkInterfaces Text Source #

The name of the decoder manifest to list information about.

listDecoderManifestNetworkInterfacesResponse_nextToken :: Lens' ListDecoderManifestNetworkInterfacesResponse (Maybe Text) Source #

The token to retrieve the next set of results, or null if there are no more results.

ListDecoderManifestSignals

listDecoderManifestSignals_maxResults :: Lens' ListDecoderManifestSignals (Maybe Natural) Source #

The maximum number of items to return, between 1 and 100, inclusive.

listDecoderManifestSignals_nextToken :: Lens' ListDecoderManifestSignals (Maybe Text) Source #

A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

listDecoderManifestSignals_name :: Lens' ListDecoderManifestSignals Text Source #

The name of the decoder manifest to list information about.

listDecoderManifestSignalsResponse_nextToken :: Lens' ListDecoderManifestSignalsResponse (Maybe Text) Source #

The token to retrieve the next set of results, or null if there are no more results.

ListDecoderManifests

listDecoderManifests_maxResults :: Lens' ListDecoderManifests (Maybe Natural) Source #

The maximum number of items to return, between 1 and 100, inclusive.

listDecoderManifests_modelManifestArn :: Lens' ListDecoderManifests (Maybe Text) Source #

The Amazon Resource Name (ARN) of a vehicle model (model manifest) associated with the decoder manifest.

listDecoderManifests_nextToken :: Lens' ListDecoderManifests (Maybe Text) Source #

A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

listDecoderManifestsResponse_nextToken :: Lens' ListDecoderManifestsResponse (Maybe Text) Source #

The token to retrieve the next set of results, or null if there are no more results.

ListFleets

listFleets_maxResults :: Lens' ListFleets (Maybe Natural) Source #

The maximum number of items to return, between 1 and 100, inclusive.

listFleets_nextToken :: Lens' ListFleets (Maybe Text) Source #

A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

listFleetsResponse_nextToken :: Lens' ListFleetsResponse (Maybe Text) Source #

The token to retrieve the next set of results, or null if there are no more results.

ListFleetsForVehicle

listFleetsForVehicle_maxResults :: Lens' ListFleetsForVehicle (Maybe Natural) Source #

The maximum number of items to return, between 1 and 100, inclusive.

listFleetsForVehicle_nextToken :: Lens' ListFleetsForVehicle (Maybe Text) Source #

A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

listFleetsForVehicle_vehicleName :: Lens' ListFleetsForVehicle Text Source #

The ID of the vehicle to retrieve information about.

listFleetsForVehicleResponse_fleets :: Lens' ListFleetsForVehicleResponse (Maybe [Text]) Source #

A list of fleet IDs that the vehicle is associated with.

listFleetsForVehicleResponse_nextToken :: Lens' ListFleetsForVehicleResponse (Maybe Text) Source #

The token to retrieve the next set of results, or null if there are no more results.

ListModelManifestNodes

listModelManifestNodes_maxResults :: Lens' ListModelManifestNodes (Maybe Natural) Source #

The maximum number of items to return, between 1 and 100, inclusive.

listModelManifestNodes_nextToken :: Lens' ListModelManifestNodes (Maybe Text) Source #

A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

listModelManifestNodes_name :: Lens' ListModelManifestNodes Text Source #

The name of the vehicle model to list information about.

listModelManifestNodesResponse_nextToken :: Lens' ListModelManifestNodesResponse (Maybe Text) Source #

The token to retrieve the next set of results, or null if there are no more results.

ListModelManifests

listModelManifests_maxResults :: Lens' ListModelManifests (Maybe Natural) Source #

The maximum number of items to return, between 1 and 100, inclusive.

listModelManifests_nextToken :: Lens' ListModelManifests (Maybe Text) Source #

A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

listModelManifests_signalCatalogArn :: Lens' ListModelManifests (Maybe Text) Source #

The ARN of a signal catalog. If you specify a signal catalog, only the vehicle models associated with it are returned.

listModelManifestsResponse_nextToken :: Lens' ListModelManifestsResponse (Maybe Text) Source #

The token to retrieve the next set of results, or null if there are no more results.

ListSignalCatalogNodes

listSignalCatalogNodes_maxResults :: Lens' ListSignalCatalogNodes (Maybe Natural) Source #

The maximum number of items to return, between 1 and 100, inclusive.

listSignalCatalogNodes_nextToken :: Lens' ListSignalCatalogNodes (Maybe Text) Source #

A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

listSignalCatalogNodes_name :: Lens' ListSignalCatalogNodes Text Source #

The name of the signal catalog to list information about.

listSignalCatalogNodesResponse_nextToken :: Lens' ListSignalCatalogNodesResponse (Maybe Text) Source #

The token to retrieve the next set of results, or null if there are no more results.

ListSignalCatalogs

listSignalCatalogs_maxResults :: Lens' ListSignalCatalogs (Maybe Natural) Source #

The maximum number of items to return, between 1 and 100, inclusive.

listSignalCatalogs_nextToken :: Lens' ListSignalCatalogs (Maybe Text) Source #

A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

listSignalCatalogsResponse_nextToken :: Lens' ListSignalCatalogsResponse (Maybe Text) Source #

The token to retrieve the next set of results, or null if there are no more results.

ListTagsForResource

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe [Tag]) Source #

The list of tags assigned to the resource.

ListVehicles

listVehicles_maxResults :: Lens' ListVehicles (Maybe Natural) Source #

The maximum number of items to return, between 1 and 100, inclusive.

listVehicles_modelManifestArn :: Lens' ListVehicles (Maybe Text) Source #

The Amazon Resource Name (ARN) of a vehicle model (model manifest). You can use this optional parameter to list only the vehicles created from a certain vehicle model.

listVehicles_nextToken :: Lens' ListVehicles (Maybe Text) Source #

A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

listVehiclesResponse_nextToken :: Lens' ListVehiclesResponse (Maybe Text) Source #

The token to retrieve the next set of results, or null if there are no more results.

listVehiclesResponse_vehicleSummaries :: Lens' ListVehiclesResponse (Maybe [VehicleSummary]) Source #

A list of vehicles and information about them.

ListVehiclesInFleet

listVehiclesInFleet_maxResults :: Lens' ListVehiclesInFleet (Maybe Natural) Source #

The maximum number of items to return, between 1 and 100, inclusive.

listVehiclesInFleet_nextToken :: Lens' ListVehiclesInFleet (Maybe Text) Source #

A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

listVehiclesInFleetResponse_nextToken :: Lens' ListVehiclesInFleetResponse (Maybe Text) Source #

The token to retrieve the next set of results, or null if there are no more results.

listVehiclesInFleetResponse_vehicles :: Lens' ListVehiclesInFleetResponse (Maybe [Text]) Source #

A list of vehicles associated with the fleet.

PutLoggingOptions

putLoggingOptions_cloudWatchLogDelivery :: Lens' PutLoggingOptions CloudWatchLogDeliveryOptions Source #

Creates or updates the log delivery option to Amazon CloudWatch Logs.

RegisterAccount

registerAccount_iamResources :: Lens' RegisterAccount (Maybe IamResources) Source #

The IAM resource that allows Amazon Web Services IoT FleetWise to send data to Amazon Timestream.

registerAccountResponse_registerAccountStatus :: Lens' RegisterAccountResponse RegistrationStatus Source #

The status of registering your Amazon Web Services account, IAM role, and Timestream resources.

registerAccountResponse_iamResources :: Lens' RegisterAccountResponse IamResources Source #

The registered IAM resource that allows Amazon Web Services IoT FleetWise to send data to Amazon Timestream.

registerAccountResponse_creationTime :: Lens' RegisterAccountResponse UTCTime Source #

The time the account was registered, in seconds since epoch (January 1, 1970 at midnight UTC time).

registerAccountResponse_lastModificationTime :: Lens' RegisterAccountResponse UTCTime Source #

The time this registration was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time).

TagResource

tagResource_tags :: Lens' TagResource [Tag] Source #

The new or modified tags for the resource.

UntagResource

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

A list of the keys of the tags to be removed from the resource.

UpdateCampaign

updateCampaign_dataExtraDimensions :: Lens' UpdateCampaign (Maybe [Text]) Source #

A list of vehicle attributes to associate with a signal.

Default: An empty array

updateCampaign_description :: Lens' UpdateCampaign (Maybe Text) Source #

The description of the campaign.

updateCampaign_name :: Lens' UpdateCampaign Text Source #

The name of the campaign to update.

updateCampaign_action :: Lens' UpdateCampaign UpdateCampaignAction Source #

Specifies how to update a campaign. The action can be one of the following:

  • APPROVE - To approve delivering a data collection scheme to vehicles.
  • SUSPEND - To suspend collecting signal data.
  • RESUME - To resume collecting signal data.
  • UPDATE - To update a campaign.

updateCampaignResponse_arn :: Lens' UpdateCampaignResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the campaign.

updateCampaignResponse_status :: Lens' UpdateCampaignResponse (Maybe CampaignStatus) Source #

The state of a campaign. The status can be one of:

  • CREATING - Amazon Web Services IoT FleetWise is processing your request to create the campaign.
  • WAITING_FOR_APPROVAL - After a campaign is created, it enters the WAITING_FOR_APPROVAL state. To allow Amazon Web Services IoT FleetWise to deploy the campaign to the target vehicle or fleet, use the API operation to approve the campaign.
  • RUNNING - The campaign is active.
  • SUSPENDED - The campaign is suspended. To resume the campaign, use the API operation.

UpdateDecoderManifest

updateDecoderManifest_description :: Lens' UpdateDecoderManifest (Maybe Text) Source #

A brief description of the decoder manifest to update.

updateDecoderManifest_networkInterfacesToAdd :: Lens' UpdateDecoderManifest (Maybe (NonEmpty NetworkInterface)) Source #

A list of information about the network interfaces to add to the decoder manifest.

updateDecoderManifest_networkInterfacesToRemove :: Lens' UpdateDecoderManifest (Maybe (NonEmpty Text)) Source #

A list of network interfaces to remove from the decoder manifest.

updateDecoderManifest_networkInterfacesToUpdate :: Lens' UpdateDecoderManifest (Maybe (NonEmpty NetworkInterface)) Source #

A list of information about the network interfaces to update in the decoder manifest.

updateDecoderManifest_signalDecodersToAdd :: Lens' UpdateDecoderManifest (Maybe (NonEmpty SignalDecoder)) Source #

A list of information about decoding additional signals to add to the decoder manifest.

updateDecoderManifest_signalDecodersToRemove :: Lens' UpdateDecoderManifest (Maybe (NonEmpty Text)) Source #

A list of signal decoders to remove from the decoder manifest.

updateDecoderManifest_signalDecodersToUpdate :: Lens' UpdateDecoderManifest (Maybe (NonEmpty SignalDecoder)) Source #

A list of updated information about decoding signals to update in the decoder manifest.

updateDecoderManifest_status :: Lens' UpdateDecoderManifest (Maybe ManifestStatus) Source #

The state of the decoder manifest. If the status is ACTIVE, the decoder manifest can't be edited. If the status is DRAFT, you can edit the decoder manifest.

updateDecoderManifest_name :: Lens' UpdateDecoderManifest Text Source #

The name of the decoder manifest to update.

updateDecoderManifestResponse_arn :: Lens' UpdateDecoderManifestResponse Text Source #

The Amazon Resource Name (ARN) of the updated decoder manifest.

UpdateFleet

updateFleet_description :: Lens' UpdateFleet (Maybe Text) Source #

An updated description of the fleet.

updateFleet_fleetId :: Lens' UpdateFleet Text Source #

The ID of the fleet to update.

updateFleetResponse_arn :: Lens' UpdateFleetResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the updated fleet.

UpdateModelManifest

updateModelManifest_description :: Lens' UpdateModelManifest (Maybe Text) Source #

A brief description of the vehicle model.

updateModelManifest_nodesToAdd :: Lens' UpdateModelManifest (Maybe (NonEmpty Text)) Source #

A list of fullyQualifiedName of nodes, which are a general abstraction of signals, to add to the vehicle model.

updateModelManifest_nodesToRemove :: Lens' UpdateModelManifest (Maybe (NonEmpty Text)) Source #

A list of fullyQualifiedName of nodes, which are a general abstraction of signals, to remove from the vehicle model.

updateModelManifest_status :: Lens' UpdateModelManifest (Maybe ManifestStatus) Source #

The state of the vehicle model. If the status is ACTIVE, the vehicle model can't be edited. If the status is DRAFT, you can edit the vehicle model.

updateModelManifest_name :: Lens' UpdateModelManifest Text Source #

The name of the vehicle model to update.

updateModelManifestResponse_arn :: Lens' UpdateModelManifestResponse Text Source #

The Amazon Resource Name (ARN) of the updated vehicle model.

UpdateSignalCatalog

updateSignalCatalog_description :: Lens' UpdateSignalCatalog (Maybe Text) Source #

A brief description of the signal catalog to update.

updateSignalCatalog_nodesToAdd :: Lens' UpdateSignalCatalog (Maybe [Node]) Source #

A list of information about nodes to add to the signal catalog.

updateSignalCatalog_nodesToRemove :: Lens' UpdateSignalCatalog (Maybe (NonEmpty Text)) Source #

A list of fullyQualifiedName of nodes to remove from the signal catalog.

updateSignalCatalog_nodesToUpdate :: Lens' UpdateSignalCatalog (Maybe [Node]) Source #

A list of information about nodes to update in the signal catalog.

updateSignalCatalog_name :: Lens' UpdateSignalCatalog Text Source #

The name of the signal catalog to update.

UpdateVehicle

updateVehicle_attributeUpdateMode :: Lens' UpdateVehicle (Maybe UpdateMode) Source #

The method the specified attributes will update the existing attributes on the vehicle. UseOverwite to replace the vehicle attributes with the specified attributes. Or use Merge to combine all attributes.

This is required if attributes are present in the input.

updateVehicle_attributes :: Lens' UpdateVehicle (Maybe (HashMap Text Text)) Source #

Static information about a vehicle in a key-value pair. For example:

"engineType" : "1.3 L R2"

updateVehicle_decoderManifestArn :: Lens' UpdateVehicle (Maybe Text) Source #

The ARN of the decoder manifest associated with this vehicle.

updateVehicle_modelManifestArn :: Lens' UpdateVehicle (Maybe Text) Source #

The ARN of a vehicle model (model manifest) associated with the vehicle.

updateVehicle_vehicleName :: Lens' UpdateVehicle Text Source #

The unique ID of the vehicle to update.

Types

Actuator

actuator_allowedValues :: Lens' Actuator (Maybe [Text]) Source #

A list of possible values an actuator can take.

actuator_assignedValue :: Lens' Actuator (Maybe Text) Source #

A specified value for the actuator.

actuator_description :: Lens' Actuator (Maybe Text) Source #

A brief description of the actuator.

actuator_max :: Lens' Actuator (Maybe Double) Source #

The specified possible maximum value of an actuator.

actuator_min :: Lens' Actuator (Maybe Double) Source #

The specified possible minimum value of an actuator.

actuator_unit :: Lens' Actuator (Maybe Text) Source #

The scientific unit for the actuator.

actuator_fullyQualifiedName :: Lens' Actuator Text Source #

The fully qualified name of the actuator. For example, the fully qualified name of an actuator might be Vehicle.Front.Left.Door.Lock.

actuator_dataType :: Lens' Actuator NodeDataType Source #

The specified data type of the actuator.

Attribute

attribute_allowedValues :: Lens' Attribute (Maybe [Text]) Source #

A list of possible values an attribute can be assigned.

attribute_assignedValue :: Lens' Attribute (Maybe Text) Source #

A specified value for the attribute.

attribute_defaultValue :: Lens' Attribute (Maybe Text) Source #

The default value of the attribute.

attribute_description :: Lens' Attribute (Maybe Text) Source #

A brief description of the attribute.

attribute_max :: Lens' Attribute (Maybe Double) Source #

The specified possible maximum value of the attribute.

attribute_min :: Lens' Attribute (Maybe Double) Source #

The specified possible minimum value of the attribute.

attribute_unit :: Lens' Attribute (Maybe Text) Source #

The scientific unit for the attribute.

attribute_fullyQualifiedName :: Lens' Attribute Text Source #

The fully qualified name of the attribute. For example, the fully qualified name of an attribute might be Vehicle.Body.Engine.Type.

attribute_dataType :: Lens' Attribute NodeDataType Source #

The specified data type of the attribute.

Branch

branch_description :: Lens' Branch (Maybe Text) Source #

A brief description of the branch.

branch_fullyQualifiedName :: Lens' Branch Text Source #

The fully qualified name of the branch. For example, the fully qualified name of a branch might be Vehicle.Body.Engine.

CampaignSummary

campaignSummary_arn :: Lens' CampaignSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of a campaign.

campaignSummary_description :: Lens' CampaignSummary (Maybe Text) Source #

The description of the campaign.

campaignSummary_signalCatalogArn :: Lens' CampaignSummary (Maybe Text) Source #

The ARN of the signal catalog associated with the campaign.

campaignSummary_status :: Lens' CampaignSummary (Maybe CampaignStatus) Source #

The state of a campaign. The status can be one of the following:

  • CREATING - Amazon Web Services IoT FleetWise is processing your request to create the campaign.
  • WAITING_FOR_APPROVAL - After a campaign is created, it enters the WAITING_FOR_APPROVAL state. To allow Amazon Web Services IoT FleetWise to deploy the campaign to the target vehicle or fleet, use the API operation to approve the campaign.
  • RUNNING - The campaign is active.
  • SUSPENDED - The campaign is suspended. To resume the campaign, use the API operation.

campaignSummary_targetArn :: Lens' CampaignSummary (Maybe Text) Source #

The ARN of a vehicle or fleet to which the campaign is deployed.

campaignSummary_creationTime :: Lens' CampaignSummary UTCTime Source #

The time the campaign was created.

campaignSummary_lastModificationTime :: Lens' CampaignSummary UTCTime Source #

The last time the campaign was modified.

CanDbcDefinition

canDbcDefinition_signalsMap :: Lens' CanDbcDefinition (Maybe (HashMap Text Text)) Source #

Pairs every signal specified in your vehicle model with a signal decoder.

canDbcDefinition_networkInterface :: Lens' CanDbcDefinition Text Source #

Contains information about a network interface.

canDbcDefinition_canDbcFiles :: Lens' CanDbcDefinition (NonEmpty ByteString) Source #

A list of DBC files. You can upload only one DBC file for each network interface and specify up to five (inclusive) files in the list.

CanInterface

canInterface_protocolName :: Lens' CanInterface (Maybe Text) Source #

The name of the communication protocol for the interface.

canInterface_protocolVersion :: Lens' CanInterface (Maybe Text) Source #

The version of the communication protocol for the interface.

canInterface_name :: Lens' CanInterface Text Source #

The unique name of the interface.

CanSignal

canSignal_name :: Lens' CanSignal (Maybe Text) Source #

The name of the signal.

canSignal_isBigEndian :: Lens' CanSignal Bool Source #

Whether the byte ordering of a CAN message is big-endian.

canSignal_isSigned :: Lens' CanSignal Bool Source #

Whether the message data is specified as a signed value.

canSignal_startBit :: Lens' CanSignal Natural Source #

Indicates the beginning of the CAN message.

canSignal_offset :: Lens' CanSignal Double Source #

Indicates where data appears in the CAN message.

canSignal_factor :: Lens' CanSignal Double Source #

A multiplier used to decode the CAN message.

canSignal_length :: Lens' CanSignal Natural Source #

How many bytes of data are in the message.

CloudWatchLogDeliveryOptions

cloudWatchLogDeliveryOptions_logGroupName :: Lens' CloudWatchLogDeliveryOptions (Maybe Text) Source #

The Amazon CloudWatch Logs group the operation sends data to.

cloudWatchLogDeliveryOptions_logType :: Lens' CloudWatchLogDeliveryOptions LogType Source #

The type of log to send data to Amazon CloudWatch Logs.

CollectionScheme

collectionScheme_conditionBasedCollectionScheme :: Lens' CollectionScheme (Maybe ConditionBasedCollectionScheme) Source #

Information about a collection scheme that uses a simple logical expression to recognize what data to collect.

collectionScheme_timeBasedCollectionScheme :: Lens' CollectionScheme (Maybe TimeBasedCollectionScheme) Source #

Information about a collection scheme that uses a time period to decide how often to collect data.

ConditionBasedCollectionScheme

conditionBasedCollectionScheme_minimumTriggerIntervalMs :: Lens' ConditionBasedCollectionScheme (Maybe Natural) Source #

The minimum duration of time between two triggering events to collect data, in milliseconds.

If a signal changes often, you might want to collect data at a slower rate.

conditionBasedCollectionScheme_triggerMode :: Lens' ConditionBasedCollectionScheme (Maybe TriggerMode) Source #

Whether to collect data for all triggering events (ALWAYS). Specify (RISING_EDGE), or specify only when the condition first evaluates to false. For example, triggering on "AirbagDeployed"; Users aren't interested on triggering when the airbag is already exploded; they only care about the change from not deployed => deployed.

conditionBasedCollectionScheme_expression :: Lens' ConditionBasedCollectionScheme Text Source #

The logical expression used to recognize what data to collect. For example, $variable.Vehicle.OutsideAirTemperature >= 105.0.

CreateVehicleError

createVehicleError_vehicleName :: Lens' CreateVehicleError (Maybe Text) Source #

The ID of the vehicle with the error.

CreateVehicleRequestItem

createVehicleRequestItem_associationBehavior :: Lens' CreateVehicleRequestItem (Maybe VehicleAssociationBehavior) Source #

An option to create a new Amazon Web Services IoT thing when creating a vehicle, or to validate an existing thing as a vehicle.

createVehicleRequestItem_attributes :: Lens' CreateVehicleRequestItem (Maybe (HashMap Text Text)) Source #

Static information about a vehicle in a key-value pair. For example: "engine Type" : "v6"

createVehicleRequestItem_tags :: Lens' CreateVehicleRequestItem (Maybe [Tag]) Source #

Metadata which can be used to manage the vehicle.

createVehicleRequestItem_modelManifestArn :: Lens' CreateVehicleRequestItem Text Source #

The ARN of the vehicle model (model manifest) to create the vehicle from.

createVehicleRequestItem_decoderManifestArn :: Lens' CreateVehicleRequestItem Text Source #

The Amazon Resource Name (ARN) of a decoder manifest associated with the vehicle to create.

CreateVehicleResponseItem

createVehicleResponseItem_thingArn :: Lens' CreateVehicleResponseItem (Maybe Text) Source #

The ARN of a created or validated Amazon Web Services IoT thing.

DecoderManifestSummary

decoderManifestSummary_arn :: Lens' DecoderManifestSummary (Maybe Text) Source #

The ARN of a vehicle model (model manifest) associated with the decoder manifest.

decoderManifestSummary_description :: Lens' DecoderManifestSummary (Maybe Text) Source #

A brief description of the decoder manifest.

decoderManifestSummary_modelManifestArn :: Lens' DecoderManifestSummary (Maybe Text) Source #

The ARN of a vehicle model (model manifest) associated with the decoder manifest.

decoderManifestSummary_status :: Lens' DecoderManifestSummary (Maybe ManifestStatus) Source #

The state of the decoder manifest. If the status is ACTIVE, the decoder manifest can't be edited. If the status is marked DRAFT, you can edit the decoder manifest.

decoderManifestSummary_creationTime :: Lens' DecoderManifestSummary UTCTime Source #

The time the decoder manifest was created in seconds since epoch (January 1, 1970 at midnight UTC time).

decoderManifestSummary_lastModificationTime :: Lens' DecoderManifestSummary UTCTime Source #

The time the decoder manifest was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).

FleetSummary

fleetSummary_description :: Lens' FleetSummary (Maybe Text) Source #

A brief description of the fleet.

fleetSummary_lastModificationTime :: Lens' FleetSummary (Maybe UTCTime) Source #

The time the fleet was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).

fleetSummary_id :: Lens' FleetSummary Text Source #

The unique ID of the fleet.

fleetSummary_arn :: Lens' FleetSummary Text Source #

The Amazon Resource Name (ARN) of the fleet.

fleetSummary_signalCatalogArn :: Lens' FleetSummary Text Source #

The ARN of the signal catalog associated with the fleet.

fleetSummary_creationTime :: Lens' FleetSummary UTCTime Source #

The time the fleet was created, in seconds since epoch (January 1, 1970 at midnight UTC time).

FormattedVss

formattedVss_vssJson :: Lens' FormattedVss (Maybe Text) Source #

Provides the VSS in JSON format.

IamRegistrationResponse

iamRegistrationResponse_errorMessage :: Lens' IamRegistrationResponse (Maybe Text) Source #

A message associated with a registration error.

iamRegistrationResponse_roleArn :: Lens' IamRegistrationResponse Text Source #

The Amazon Resource Name (ARN) of the IAM role to register.

iamRegistrationResponse_registrationStatus :: Lens' IamRegistrationResponse RegistrationStatus Source #

The status of registering your IAM resource. The status can be one of REGISTRATION_SUCCESS, REGISTRATION_PENDING, REGISTRATION_FAILURE.

IamResources

iamResources_roleArn :: Lens' IamResources Text Source #

The Amazon Resource Name (ARN) of the IAM resource that allows Amazon Web Services IoT FleetWise to send data to Amazon Timestream. For example, arn:aws:iam::123456789012:role/SERVICE-ROLE-ARN.

ModelManifestSummary

modelManifestSummary_arn :: Lens' ModelManifestSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the vehicle model.

modelManifestSummary_description :: Lens' ModelManifestSummary (Maybe Text) Source #

A brief description of the vehicle model.

modelManifestSummary_signalCatalogArn :: Lens' ModelManifestSummary (Maybe Text) Source #

The ARN of the signal catalog associated with the vehicle model.

modelManifestSummary_status :: Lens' ModelManifestSummary (Maybe ManifestStatus) Source #

The state of the vehicle model. If the status is ACTIVE, the vehicle model can't be edited. If the status is DRAFT, you can edit the vehicle model.

modelManifestSummary_creationTime :: Lens' ModelManifestSummary UTCTime Source #

The time the vehicle model was created, in seconds since epoch (January 1, 1970 at midnight UTC time).

modelManifestSummary_lastModificationTime :: Lens' ModelManifestSummary UTCTime Source #

The time the vehicle model was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time).

NetworkFileDefinition

networkFileDefinition_canDbc :: Lens' NetworkFileDefinition (Maybe CanDbcDefinition) Source #

Information, including CAN DBC files, about the configurations used to create a decoder manifest.

NetworkInterface

networkInterface_canInterface :: Lens' NetworkInterface (Maybe CanInterface) Source #

Information about a network interface specified by the Controller Area Network (CAN) protocol.

networkInterface_obdInterface :: Lens' NetworkInterface (Maybe ObdInterface) Source #

Information about a network interface specified by the On-board diagnostic (OBD) II protocol.

networkInterface_interfaceId :: Lens' NetworkInterface Text Source #

The ID of the network interface.

networkInterface_type :: Lens' NetworkInterface NetworkInterfaceType Source #

The network protocol for the vehicle. For example, CAN_SIGNAL specifies a protocol that defines how data is communicated between electronic control units (ECUs). OBD_SIGNAL specifies a protocol that defines how self-diagnostic data is communicated between ECUs.

Node

node_actuator :: Lens' Node (Maybe Actuator) Source #

Information about a node specified as an actuator.

An actuator is a digital representation of a vehicle device.

node_attribute :: Lens' Node (Maybe Attribute) Source #

Information about a node specified as an attribute.

An attribute represents static information about a vehicle.

node_branch :: Lens' Node (Maybe Branch) Source #

Information about a node specified as a branch.

A group of signals that are defined in a hierarchical structure.

node_sensor :: Lens' Node (Maybe Sensor) Source #

Undocumented member.

NodeCounts

nodeCounts_totalActuators :: Lens' NodeCounts (Maybe Int) Source #

The total number of nodes in a vehicle network that represent actuators.

nodeCounts_totalAttributes :: Lens' NodeCounts (Maybe Int) Source #

The total number of nodes in a vehicle network that represent attributes.

nodeCounts_totalBranches :: Lens' NodeCounts (Maybe Int) Source #

The total number of nodes in a vehicle network that represent branches.

nodeCounts_totalNodes :: Lens' NodeCounts (Maybe Int) Source #

The total number of nodes in a vehicle network.

nodeCounts_totalSensors :: Lens' NodeCounts (Maybe Int) Source #

The total number of nodes in a vehicle network that represent sensors.

ObdInterface

obdInterface_dtcRequestIntervalSeconds :: Lens' ObdInterface (Maybe Natural) Source #

The maximum number message requests per diagnostic trouble code per second.

obdInterface_hasTransmissionEcu :: Lens' ObdInterface (Maybe Bool) Source #

Whether the vehicle has a transmission control module (TCM).

obdInterface_pidRequestIntervalSeconds :: Lens' ObdInterface (Maybe Natural) Source #

The maximum number message requests per second.

obdInterface_useExtendedIds :: Lens' ObdInterface (Maybe Bool) Source #

Whether to use extended IDs in the message.

obdInterface_name :: Lens' ObdInterface Text Source #

The name of the interface.

obdInterface_requestMessageId :: Lens' ObdInterface Natural Source #

The ID of the message requesting vehicle data.

ObdSignal

obdSignal_bitMaskLength :: Lens' ObdSignal (Maybe Natural) Source #

The number of bits to mask in a message.

obdSignal_bitRightShift :: Lens' ObdSignal (Maybe Natural) Source #

The number of positions to shift bits in the message.

obdSignal_pidResponseLength :: Lens' ObdSignal Natural Source #

The length of the requested data.

obdSignal_serviceMode :: Lens' ObdSignal Natural Source #

The mode of operation (diagnostic service) in a message.

obdSignal_pid :: Lens' ObdSignal Natural Source #

The diagnostic code used to request data from a vehicle for this signal.

obdSignal_scaling :: Lens' ObdSignal Double Source #

A multiplier used to decode the message.

obdSignal_offset :: Lens' ObdSignal Double Source #

Indicates where data appears in the message.

obdSignal_startByte :: Lens' ObdSignal Natural Source #

Indicates the beginning of the message.

obdSignal_byteLength :: Lens' ObdSignal Natural Source #

The length of a message.

Sensor

sensor_allowedValues :: Lens' Sensor (Maybe [Text]) Source #

A list of possible values a sensor can take.

sensor_description :: Lens' Sensor (Maybe Text) Source #

A brief description of a sensor.

sensor_max :: Lens' Sensor (Maybe Double) Source #

The specified possible maximum value of the sensor.

sensor_min :: Lens' Sensor (Maybe Double) Source #

The specified possible minimum value of the sensor.

sensor_unit :: Lens' Sensor (Maybe Text) Source #

The scientific unit of measurement for data collected by the sensor.

sensor_fullyQualifiedName :: Lens' Sensor Text Source #

The fully qualified name of the sensor. For example, the fully qualified name of a sensor might be Vehicle.Body.Engine.Battery.

sensor_dataType :: Lens' Sensor NodeDataType Source #

The specified data type of the sensor.

SignalCatalogSummary

signalCatalogSummary_arn :: Lens' SignalCatalogSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the signal catalog.

signalCatalogSummary_creationTime :: Lens' SignalCatalogSummary (Maybe UTCTime) Source #

The time the signal catalog was created in seconds since epoch (January 1, 1970 at midnight UTC time).

signalCatalogSummary_lastModificationTime :: Lens' SignalCatalogSummary (Maybe UTCTime) Source #

The time the signal catalog was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).

SignalDecoder

signalDecoder_canSignal :: Lens' SignalDecoder (Maybe CanSignal) Source #

Information about signal decoder using the Controller Area Network (CAN) protocol.

signalDecoder_obdSignal :: Lens' SignalDecoder (Maybe ObdSignal) Source #

Information about signal decoder using the On-board diagnostic (OBD) II protocol.

signalDecoder_fullyQualifiedName :: Lens' SignalDecoder Text Source #

The fully qualified name of a signal decoder as defined in a vehicle model.

signalDecoder_type :: Lens' SignalDecoder SignalDecoderType Source #

The network protocol for the vehicle. For example, CAN_SIGNAL specifies a protocol that defines how data is communicated between electronic control units (ECUs). OBD_SIGNAL specifies a protocol that defines how self-diagnostic data is communicated between ECUs.

signalDecoder_interfaceId :: Lens' SignalDecoder Text Source #

The ID of a network interface that specifies what network protocol a vehicle follows.

SignalInformation

signalInformation_maxSampleCount :: Lens' SignalInformation (Maybe Natural) Source #

The maximum number of samples to collect.

signalInformation_minimumSamplingIntervalMs :: Lens' SignalInformation (Maybe Natural) Source #

The minimum duration of time (in milliseconds) between two triggering events to collect data.

If a signal changes often, you might want to collect data at a slower rate.

Tag

tag_key :: Lens' Tag Text Source #

The tag's key.

tag_value :: Lens' Tag Text Source #

The tag's value.

TimeBasedCollectionScheme

timeBasedCollectionScheme_periodMs :: Lens' TimeBasedCollectionScheme Natural Source #

The time period (in milliseconds) to decide how often to collect data. For example, if the time period is 60000, the Edge Agent software collects data once every minute.

TimestreamRegistrationResponse

timestreamRegistrationResponse_timestreamDatabaseArn :: Lens' TimestreamRegistrationResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Timestream database.

timestreamRegistrationResponse_registrationStatus :: Lens' TimestreamRegistrationResponse RegistrationStatus Source #

The status of registering your Amazon Timestream resources. The status can be one of REGISTRATION_SUCCESS, REGISTRATION_PENDING, REGISTRATION_FAILURE.

TimestreamResources

timestreamResources_timestreamDatabaseName :: Lens' TimestreamResources Text Source #

The name of the registered Amazon Timestream database.

timestreamResources_timestreamTableName :: Lens' TimestreamResources Text Source #

The name of the registered Amazon Timestream database table.

UpdateVehicleError

updateVehicleError_code :: Lens' UpdateVehicleError (Maybe Int) Source #

The relevant HTTP error code (400+).

updateVehicleError_message :: Lens' UpdateVehicleError (Maybe Text) Source #

A message associated with the error.

updateVehicleError_vehicleName :: Lens' UpdateVehicleError (Maybe Text) Source #

The ID of the vehicle with the error.

UpdateVehicleRequestItem

updateVehicleRequestItem_attributeUpdateMode :: Lens' UpdateVehicleRequestItem (Maybe UpdateMode) Source #

The method the specified attributes will update the existing attributes on the vehicle. UseOverwite to replace the vehicle attributes with the specified attributes. Or use Merge to combine all attributes.

This is required if attributes are present in the input.

updateVehicleRequestItem_attributes :: Lens' UpdateVehicleRequestItem (Maybe (HashMap Text Text)) Source #

Static information about a vehicle in a key-value pair. For example:

"engineType" : "1.3 L R2"

updateVehicleRequestItem_decoderManifestArn :: Lens' UpdateVehicleRequestItem (Maybe Text) Source #

The ARN of the signal decoder manifest associated with the vehicle to update.

updateVehicleRequestItem_modelManifestArn :: Lens' UpdateVehicleRequestItem (Maybe Text) Source #

The ARN of the vehicle model (model manifest) associated with the vehicle to update.

UpdateVehicleResponseItem

updateVehicleResponseItem_arn :: Lens' UpdateVehicleResponseItem (Maybe Text) Source #

The Amazon Resource Name (ARN) of the updated vehicle.

VehicleStatus

vehicleStatus_status :: Lens' VehicleStatus (Maybe VehicleState) Source #

The state of a vehicle, which can be one of the following:

  • CREATED - Amazon Web Services IoT FleetWise sucessfully created the vehicle.
  • READY - The vehicle is ready to receive a campaign deployment.
  • HEALTHY - A campaign deployment was delivered to the vehicle.
  • SUSPENDED - A campaign associated with the vehicle was suspended and data collection was paused.
  • DELETING - Amazon Web Services IoT FleetWise is removing a campaign from the vehicle.

vehicleStatus_vehicleName :: Lens' VehicleStatus (Maybe Text) Source #

The unique ID of the vehicle.

VehicleSummary

vehicleSummary_arn :: Lens' VehicleSummary Text Source #

The Amazon Resource Name (ARN) of the vehicle.

vehicleSummary_modelManifestArn :: Lens' VehicleSummary Text Source #

The ARN of a vehicle model (model manifest) associated with the vehicle.

vehicleSummary_decoderManifestArn :: Lens' VehicleSummary Text Source #

The ARN of a decoder manifest associated with the vehicle.

vehicleSummary_creationTime :: Lens' VehicleSummary UTCTime Source #

The time the vehicle was created in seconds since epoch (January 1, 1970 at midnight UTC time).

vehicleSummary_lastModificationTime :: Lens' VehicleSummary UTCTime Source #

The time the vehicle was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).