IoTFleetWise

import { IoTFleetWise } from "https://aws-api.deno.dev/v0.4/services/iotfleetwise.ts?docs=full";

class IoTFleetWise {

constructor(apiFactory: client.ApiFactory);

async associateVehicleFleet(params: AssociateVehicleFleetRequest, opts?: client.RequestOptions): Promise<void>;

async batchCreateVehicle(params: BatchCreateVehicleRequest, opts?: client.RequestOptions): Promise<BatchCreateVehicleResponse>;

async batchUpdateVehicle(params: BatchUpdateVehicleRequest, opts?: client.RequestOptions): Promise<BatchUpdateVehicleResponse>;

async createCampaign(params: CreateCampaignRequest, opts?: client.RequestOptions): Promise<CreateCampaignResponse>;

async createDecoderManifest(params: CreateDecoderManifestRequest, opts?: client.RequestOptions): Promise<CreateDecoderManifestResponse>;

async createFleet(params: CreateFleetRequest, opts?: client.RequestOptions): Promise<CreateFleetResponse>;

async createModelManifest(params: CreateModelManifestRequest, opts?: client.RequestOptions): Promise<CreateModelManifestResponse>;

async createSignalCatalog(params: CreateSignalCatalogRequest, opts?: client.RequestOptions): Promise<CreateSignalCatalogResponse>;

async createVehicle(params: CreateVehicleRequest, opts?: client.RequestOptions): Promise<CreateVehicleResponse>;

async deleteCampaign(params: DeleteCampaignRequest, opts?: client.RequestOptions): Promise<DeleteCampaignResponse>;

async deleteDecoderManifest(params: DeleteDecoderManifestRequest, opts?: client.RequestOptions): Promise<DeleteDecoderManifestResponse>;

async deleteFleet(params: DeleteFleetRequest, opts?: client.RequestOptions): Promise<DeleteFleetResponse>;

async deleteModelManifest(params: DeleteModelManifestRequest, opts?: client.RequestOptions): Promise<DeleteModelManifestResponse>;

async deleteSignalCatalog(params: DeleteSignalCatalogRequest, opts?: client.RequestOptions): Promise<DeleteSignalCatalogResponse>;

async deleteVehicle(params: DeleteVehicleRequest, opts?: client.RequestOptions): Promise<DeleteVehicleResponse>;

async disassociateVehicleFleet(params: DisassociateVehicleFleetRequest, opts?: client.RequestOptions): Promise<void>;

async getCampaign(params: GetCampaignRequest, opts?: client.RequestOptions): Promise<GetCampaignResponse>;

async getDecoderManifest(params: GetDecoderManifestRequest, opts?: client.RequestOptions): Promise<GetDecoderManifestResponse>;

async getFleet(params: GetFleetRequest, opts?: client.RequestOptions): Promise<GetFleetResponse>;

async getLoggingOptions(opts?: client.RequestOptions): Promise<GetLoggingOptionsResponse>;

async getModelManifest(params: GetModelManifestRequest, opts?: client.RequestOptions): Promise<GetModelManifestResponse>;

async getRegisterAccountStatus(opts?: client.RequestOptions): Promise<GetRegisterAccountStatusResponse>;

async getSignalCatalog(params: GetSignalCatalogRequest, opts?: client.RequestOptions): Promise<GetSignalCatalogResponse>;

async getVehicle(params: GetVehicleRequest, opts?: client.RequestOptions): Promise<GetVehicleResponse>;

async getVehicleStatus(params: GetVehicleStatusRequest, opts?: client.RequestOptions): Promise<GetVehicleStatusResponse>;

async importDecoderManifest(params: ImportDecoderManifestRequest, opts?: client.RequestOptions): Promise<ImportDecoderManifestResponse>;

async importSignalCatalog(params: ImportSignalCatalogRequest, opts?: client.RequestOptions): Promise<ImportSignalCatalogResponse>;

async listCampaigns(params?: ListCampaignsRequest, opts?: client.RequestOptions): Promise<ListCampaignsResponse>;

async listDecoderManifestNetworkInterfaces(params: ListDecoderManifestNetworkInterfacesRequest, opts?: client.RequestOptions): Promise<ListDecoderManifestNetworkInterfacesResponse>;

async listDecoderManifests(params?: ListDecoderManifestsRequest, opts?: client.RequestOptions): Promise<ListDecoderManifestsResponse>;

async listDecoderManifestSignals(params: ListDecoderManifestSignalsRequest, opts?: client.RequestOptions): Promise<ListDecoderManifestSignalsResponse>;

async listFleets(params?: ListFleetsRequest, opts?: client.RequestOptions): Promise<ListFleetsResponse>;

async listFleetsForVehicle(params: ListFleetsForVehicleRequest, opts?: client.RequestOptions): Promise<ListFleetsForVehicleResponse>;

async listModelManifestNodes(params: ListModelManifestNodesRequest, opts?: client.RequestOptions): Promise<ListModelManifestNodesResponse>;

async listModelManifests(params?: ListModelManifestsRequest, opts?: client.RequestOptions): Promise<ListModelManifestsResponse>;

async listSignalCatalogNodes(params: ListSignalCatalogNodesRequest, opts?: client.RequestOptions): Promise<ListSignalCatalogNodesResponse>;

async listSignalCatalogs(params?: ListSignalCatalogsRequest, opts?: client.RequestOptions): Promise<ListSignalCatalogsResponse>;

async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;

async listVehicles(params?: ListVehiclesRequest, opts?: client.RequestOptions): Promise<ListVehiclesResponse>;

async listVehiclesInFleet(params: ListVehiclesInFleetRequest, opts?: client.RequestOptions): Promise<ListVehiclesInFleetResponse>;

async putLoggingOptions(params: PutLoggingOptionsRequest, opts?: client.RequestOptions): Promise<void>;

async registerAccount(params: RegisterAccountRequest, opts?: client.RequestOptions): Promise<RegisterAccountResponse>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async updateCampaign(params: UpdateCampaignRequest, opts?: client.RequestOptions): Promise<UpdateCampaignResponse>;

async updateDecoderManifest(params: UpdateDecoderManifestRequest, opts?: client.RequestOptions): Promise<UpdateDecoderManifestResponse>;

async updateFleet(params: UpdateFleetRequest, opts?: client.RequestOptions): Promise<UpdateFleetResponse>;

async updateModelManifest(params: UpdateModelManifestRequest, opts?: client.RequestOptions): Promise<UpdateModelManifestResponse>;

async updateSignalCatalog(params: UpdateSignalCatalogRequest, opts?: client.RequestOptions): Promise<UpdateSignalCatalogResponse>;

async updateVehicle(params: UpdateVehicleRequest, opts?: client.RequestOptions): Promise<UpdateVehicleResponse>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new IoTFleetWise(apiFactory: client.ApiFactory)

[src]

§Methods

associateVehicleFleet(params: AssociateVehicleFleetRequest, opts?: client.RequestOptions): Promise<void>

[src]

Adds, or associates, a vehicle with a fleet.

batchCreateVehicle(params: BatchCreateVehicleRequest, opts?: client.RequestOptions): Promise<BatchCreateVehicleResponse>

[src]

Creates a group, or batch, of vehicles.

Note: 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.

batchUpdateVehicle(params: BatchUpdateVehicleRequest, opts?: client.RequestOptions): Promise<BatchUpdateVehicleResponse>

[src]

Updates a group, or batch, of vehicles.

Note: 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.

createCampaign(params: CreateCampaignRequest, opts?: client.RequestOptions): Promise<CreateCampaignResponse>

[src]

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.

createDecoderManifest(params: CreateDecoderManifestRequest, opts?: client.RequestOptions): Promise<CreateDecoderManifestResponse>

[src]

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.

createFleet(params: CreateFleetRequest, opts?: client.RequestOptions): Promise<CreateFleetResponse>

[src]

Creates a fleet that represents a group of vehicles.

Note: 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.

createModelManifest(params: CreateModelManifestRequest, opts?: client.RequestOptions): Promise<CreateModelManifestResponse>

[src]

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.

createSignalCatalog(params: CreateSignalCatalogRequest, opts?: client.RequestOptions): Promise<CreateSignalCatalogResponse>

[src]

Creates a collection of standardized signals that can be reused to create vehicle models.

createVehicle(params: CreateVehicleRequest, opts?: client.RequestOptions): Promise<CreateVehicleResponse>

[src]

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.

Note: 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.

deleteCampaign(params: DeleteCampaignRequest, opts?: client.RequestOptions): Promise<DeleteCampaignResponse>

[src]

Deletes a data collection campaign. Deleting a campaign suspends all data collection and removes it from any vehicles.

deleteDecoderManifest(params: DeleteDecoderManifestRequest, opts?: client.RequestOptions): Promise<DeleteDecoderManifestResponse>

[src]

Deletes a decoder manifest. You can't delete a decoder manifest if it has vehicles associated with it.

Note: If the decoder manifest is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.

deleteFleet(params: DeleteFleetRequest, opts?: client.RequestOptions): Promise<DeleteFleetResponse>

[src]

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.

Note: If the fleet is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.

deleteModelManifest(params: DeleteModelManifestRequest, opts?: client.RequestOptions): Promise<DeleteModelManifestResponse>

[src]

Deletes a vehicle model (model manifest).

Note: If the vehicle model is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.

deleteSignalCatalog(params: DeleteSignalCatalogRequest, opts?: client.RequestOptions): Promise<DeleteSignalCatalogResponse>

[src]

Deletes a signal catalog.

Note: If the signal catalog is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.

deleteVehicle(params: DeleteVehicleRequest, opts?: client.RequestOptions): Promise<DeleteVehicleResponse>

[src]

Deletes a vehicle and removes it from any campaigns.

Note: If the vehicle is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.

disassociateVehicleFleet(params: DisassociateVehicleFleetRequest, opts?: client.RequestOptions): Promise<void>

[src]

Removes, or disassociates, a vehicle from a fleet. Disassociating a vehicle from a fleet doesn't delete the vehicle.

Note: If the vehicle is successfully dissociated from a fleet, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.

getCampaign(params: GetCampaignRequest, opts?: client.RequestOptions): Promise<GetCampaignResponse>

[src]

Retrieves information about a campaign.

getDecoderManifest(params: GetDecoderManifestRequest, opts?: client.RequestOptions): Promise<GetDecoderManifestResponse>

[src]

Retrieves information about a created decoder manifest.

getFleet(params: GetFleetRequest, opts?: client.RequestOptions): Promise<GetFleetResponse>

[src]

Retrieves information about a fleet.

getLoggingOptions(opts?: client.RequestOptions): Promise<GetLoggingOptionsResponse>

[src]

Retrieves the logging options.

getModelManifest(params: GetModelManifestRequest, opts?: client.RequestOptions): Promise<GetModelManifestResponse>

[src]

Retrieves information about a vehicle model (model manifest).

getRegisterAccountStatus(opts?: client.RequestOptions): Promise<GetRegisterAccountStatusResponse>

[src]

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.

Note: This API operation doesn't require input parameters.

getSignalCatalog(params: GetSignalCatalogRequest, opts?: client.RequestOptions): Promise<GetSignalCatalogResponse>

[src]

Retrieves information about a signal catalog.

getVehicle(params: GetVehicleRequest, opts?: client.RequestOptions): Promise<GetVehicleResponse>

[src]

Retrieves information about a vehicle.

getVehicleStatus(params: GetVehicleStatusRequest, opts?: client.RequestOptions): Promise<GetVehicleStatusResponse>

[src]

Retrieves information about the status of a vehicle with any associated campaigns.

importDecoderManifest(params: ImportDecoderManifestRequest, opts?: client.RequestOptions): Promise<ImportDecoderManifestResponse>

[src]

Creates a decoder manifest using your existing CAN DBC file from your local device.

importSignalCatalog(params: ImportSignalCatalogRequest, opts?: client.RequestOptions): Promise<ImportSignalCatalogResponse>

[src]

Creates a signal catalog using your existing VSS formatted content from your local device.

listCampaigns(params?: ListCampaignsRequest, opts?: client.RequestOptions): Promise<ListCampaignsResponse>

[src]

Lists information about created campaigns.

Note: This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

listDecoderManifestNetworkInterfaces(params: ListDecoderManifestNetworkInterfacesRequest, opts?: client.RequestOptions): Promise<ListDecoderManifestNetworkInterfacesResponse>

[src]

Lists the network interfaces specified in a decoder manifest.

Note: This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

listDecoderManifests(params?: ListDecoderManifestsRequest, opts?: client.RequestOptions): Promise<ListDecoderManifestsResponse>

[src]

Lists decoder manifests.

Note: This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

listDecoderManifestSignals(params: ListDecoderManifestSignalsRequest, opts?: client.RequestOptions): Promise<ListDecoderManifestSignalsResponse>

[src]

A list of information about signal decoders specified in a decoder manifest.

Note: This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

listFleets(params?: ListFleetsRequest, opts?: client.RequestOptions): Promise<ListFleetsResponse>

[src]

Retrieves information for each created fleet in an Amazon Web Services account.

Note: This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

listFleetsForVehicle(params: ListFleetsForVehicleRequest, opts?: client.RequestOptions): Promise<ListFleetsForVehicleResponse>

[src]

Retrieves a list of IDs for all fleets that the vehicle is associated with.

Note: This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

listModelManifestNodes(params: ListModelManifestNodesRequest, opts?: client.RequestOptions): Promise<ListModelManifestNodesResponse>

[src]

Lists information about nodes specified in a vehicle model (model manifest).

Note: This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

listModelManifests(params?: ListModelManifestsRequest, opts?: client.RequestOptions): Promise<ListModelManifestsResponse>

[src]

Retrieves a list of vehicle models (model manifests).

Note: This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

listSignalCatalogNodes(params: ListSignalCatalogNodesRequest, opts?: client.RequestOptions): Promise<ListSignalCatalogNodesResponse>

[src]

Lists of information about the signals (nodes) specified in a signal catalog.

Note: This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

listSignalCatalogs(params?: ListSignalCatalogsRequest, opts?: client.RequestOptions): Promise<ListSignalCatalogsResponse>

[src]

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.

Note: This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>

[src]

Lists the tags (metadata) you have assigned to the resource.

listVehicles(params?: ListVehiclesRequest, opts?: client.RequestOptions): Promise<ListVehiclesResponse>

[src]

Retrieves a list of summaries of created vehicles.

Note: This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

listVehiclesInFleet(params: ListVehiclesInFleetRequest, opts?: client.RequestOptions): Promise<ListVehiclesInFleetResponse>

[src]

Retrieves a list of summaries of all vehicles associated with a fleet.

Note: This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

putLoggingOptions(params: PutLoggingOptionsRequest, opts?: client.RequestOptions): Promise<void>

[src]

Creates or updates the logging option.

registerAccount(params: RegisterAccountRequest, opts?: client.RequestOptions): Promise<RegisterAccountResponse>

[src]

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.

Note: An Amazon Web Services account is not the same thing as a "user account". An Amazon Web Services user is an identity that you create using Identity and Access Management (IAM) and takes the form of either an IAM user or an IAM role, both with credentials. A single Amazon Web Services account can, and typically does, contain many users and roles.

tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource.

untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Removes the given tags (metadata) from the resource.

updateCampaign(params: UpdateCampaignRequest, opts?: client.RequestOptions): Promise<UpdateCampaignResponse>

[src]

Updates a campaign.

updateDecoderManifest(params: UpdateDecoderManifestRequest, opts?: client.RequestOptions): Promise<UpdateDecoderManifestResponse>

[src]

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.

updateFleet(params: UpdateFleetRequest, opts?: client.RequestOptions): Promise<UpdateFleetResponse>

[src]

Updates the description of an existing fleet.

Note: If the fleet is successfully updated, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty HTTP body.

updateModelManifest(params: UpdateModelManifestRequest, opts?: client.RequestOptions): Promise<UpdateModelManifestResponse>

[src]

Updates a vehicle model (model manifest). If created vehicles are associated with a vehicle model, it can't be updated.

updateSignalCatalog(params: UpdateSignalCatalogRequest, opts?: client.RequestOptions): Promise<UpdateSignalCatalogResponse>

[src]

Updates a signal catalog.

updateVehicle(params: UpdateVehicleRequest, opts?: client.RequestOptions): Promise<UpdateVehicleResponse>

[src]

Updates a vehicle.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]