You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.IoTFleetWise

Inherits:
AWS.Service show all
Identifier:
iotfleetwise
API Version:
2021-06-17
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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.

Sending a Request Using IoTFleetWise

var iotfleetwise = new AWS.IoTFleetWise();
iotfleetwise.associateVehicleFleet(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the IoTFleetWise object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var iotfleetwise = new AWS.IoTFleetWise({apiVersion: '2021-06-17'});

You can also set the API version globally in AWS.config.apiVersions using the iotfleetwise service identifier:

AWS.config.apiVersions = {
  iotfleetwise: '2021-06-17',
  // other service API versions
};

var iotfleetwise = new AWS.IoTFleetWise();

Version:

  • 2021-06-17

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, setupRequestListeners, defineService

Constructor Details

new AWS.IoTFleetWise(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a IoTFleetWise object

var iotfleetwise = new AWS.IoTFleetWise({apiVersion: '2021-06-17'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.IoTFleetWise.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.IoTFleetWise.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.IoTFleetWise.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

associateVehicleFleet(params = {}, callback) ⇒ AWS.Request

Adds, or associates, a vehicle with a fleet.

Service Reference:

Examples:

Calling the associateVehicleFleet operation

var params = {
  fleetId: 'STRING_VALUE', /* required */
  vehicleName: 'STRING_VALUE' /* required */
};
iotfleetwise.associateVehicleFleet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • vehicleName — (String)

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

    • fleetId — (String)

      The ID of a fleet.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

batchCreateVehicle(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the batchCreateVehicle operation

var params = {
  vehicles: [ /* required */
    {
      decoderManifestArn: 'STRING_VALUE', /* required */
      modelManifestArn: 'STRING_VALUE', /* required */
      vehicleName: 'STRING_VALUE', /* required */
      associationBehavior: CreateIotThing | ValidateIotThingExists,
      attributes: {
        '<attributeName>': 'STRING_VALUE',
        /* '<attributeName>': ... */
      },
      tags: [
        {
          Key: 'STRING_VALUE', /* required */
          Value: 'STRING_VALUE' /* required */
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
iotfleetwise.batchCreateVehicle(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • vehicles — (Array<map>)

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

      • vehicleNamerequired — (String)

        The unique ID of the vehicle to create.

      • modelManifestArnrequired — (String)

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

      • decoderManifestArnrequired — (String)

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

      • attributes — (map<String>)

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

      • associationBehavior — (String)

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

        Possible values include:
        • "CreateIotThing"
        • "ValidateIotThingExists"
      • tags — (Array<map>)

        Metadata which can be used to manage the vehicle.

        • Keyrequired — (String)

          The tag's key.

        • Valuerequired — (String)

          The tag's value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • vehicles — (Array<map>)

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

        • vehicleName — (String)

          The unique ID of the vehicle to create.

        • arn — (String)

          The ARN of the created vehicle.

        • thingArn — (String)

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

      • errors — (Array<map>)

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

        • vehicleName — (String)

          The ID of the vehicle with the error.

        • code — (String)

          An HTTP error code.

        • message — (String)

          A description of the HTTP error.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

batchUpdateVehicle(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the batchUpdateVehicle operation

var params = {
  vehicles: [ /* required */
    {
      vehicleName: 'STRING_VALUE', /* required */
      attributeUpdateMode: Overwrite | Merge,
      attributes: {
        '<attributeName>': 'STRING_VALUE',
        /* '<attributeName>': ... */
      },
      decoderManifestArn: 'STRING_VALUE',
      modelManifestArn: 'STRING_VALUE'
    },
    /* more items */
  ]
};
iotfleetwise.batchUpdateVehicle(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • vehicles — (Array<map>)

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

      • vehicleNamerequired — (String)

        The unique ID of the vehicle to update.

      • modelManifestArn — (String)

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

      • decoderManifestArn — (String)

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

      • attributes — (map<String>)

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

        "engineType" : "1.3 L R2"

      • attributeUpdateMode — (String)

        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.

        Possible values include:
        • "Overwrite"
        • "Merge"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • vehicles — (Array<map>)

        A list of information about the batch of updated vehicles.

        Note: This list contains only unique IDs for the vehicles that were updated.
        • vehicleName — (String)

          The unique ID of the updated vehicle.

        • arn — (String)

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

      • errors — (Array<map>)

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

        • vehicleName — (String)

          The ID of the vehicle with the error.

        • code — (Integer)

          The relevant HTTP error code (400+).

        • message — (String)

          A message associated with the error.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createCampaign(params = {}, callback) ⇒ AWS.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.

Service Reference:

Examples:

Calling the createCampaign operation

var params = {
  collectionScheme: { /* required */
    conditionBasedCollectionScheme: {
      expression: 'STRING_VALUE', /* required */
      conditionLanguageVersion: 'NUMBER_VALUE',
      minimumTriggerIntervalMs: 'NUMBER_VALUE',
      triggerMode: ALWAYS | RISING_EDGE
    },
    timeBasedCollectionScheme: {
      periodMs: 'NUMBER_VALUE' /* required */
    }
  },
  name: 'STRING_VALUE', /* required */
  signalCatalogArn: 'STRING_VALUE', /* required */
  targetArn: 'STRING_VALUE', /* required */
  compression: OFF | SNAPPY,
  dataExtraDimensions: [
    'STRING_VALUE',
    /* more items */
  ],
  description: 'STRING_VALUE',
  diagnosticsMode: OFF | SEND_ACTIVE_DTCS,
  expiryTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  postTriggerCollectionDuration: 'NUMBER_VALUE',
  priority: 'NUMBER_VALUE',
  signalsToCollect: [
    {
      name: 'STRING_VALUE', /* required */
      maxSampleCount: 'NUMBER_VALUE',
      minimumSamplingIntervalMs: 'NUMBER_VALUE'
    },
    /* more items */
  ],
  spoolingMode: OFF | TO_DISK,
  startTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
iotfleetwise.createCampaign(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • name — (String)

      The name of the campaign to create.

    • description — (String)

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

    • signalCatalogArn — (String)

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

    • targetArn — (String)

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

    • startTime — (Date)

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

      Default: 0

    • expiryTime — (Date)

      (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: 253402243200 (December 31, 9999, 00:00:00 UTC)

    • postTriggerCollectionDuration — (Integer)

      (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

    • diagnosticsMode — (String)

      (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

      Possible values include:
      • "OFF"
      • "SEND_ACTIVE_DTCS"
    • spoolingMode — (String)

      (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

      Possible values include:
      • "OFF"
      • "TO_DISK"
    • compression — (String)

      (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

      Possible values include:
      • "OFF"
      • "SNAPPY"
    • priority — (Integer)

      (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

    • signalsToCollect — (Array<map>)

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

      • namerequired — (String)

        The name of the signal.

      • maxSampleCount — (Integer)

        The maximum number of samples to collect.

      • minimumSamplingIntervalMs — (Integer)

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

        Note: If a signal changes often, you might want to collect data at a slower rate.
    • collectionScheme — (map)

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

      • timeBasedCollectionScheme — (map)

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

        • periodMsrequired — (Integer)

          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.

      • conditionBasedCollectionScheme — (map)

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

        • expressionrequired — (String)

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

        • minimumTriggerIntervalMs — (Integer)

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

          Note: If a signal changes often, you might want to collect data at a slower rate.
        • triggerMode — (String)

          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.

          Possible values include:
          • "ALWAYS"
          • "RISING_EDGE"
        • conditionLanguageVersion — (Integer)

          Specifies the version of the conditional expression language.

    • dataExtraDimensions — (Array<String>)

      (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

    • tags — (Array<map>)

      Metadata that can be used to manage the campaign.

      • Keyrequired — (String)

        The tag's key.

      • Valuerequired — (String)

        The tag's value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • name — (String)

        The name of the created campaign.

      • arn — (String)

        The ARN of the created campaign.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createDecoderManifest(params = {}, callback) ⇒ AWS.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.

Service Reference:

Examples:

Calling the createDecoderManifest operation

var params = {
  modelManifestArn: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  networkInterfaces: [
    {
      interfaceId: 'STRING_VALUE', /* required */
      type: CAN_INTERFACE | OBD_INTERFACE, /* required */
      canInterface: {
        name: 'STRING_VALUE', /* required */
        protocolName: 'STRING_VALUE',
        protocolVersion: 'STRING_VALUE'
      },
      obdInterface: {
        name: 'STRING_VALUE', /* required */
        requestMessageId: 'NUMBER_VALUE', /* required */
        dtcRequestIntervalSeconds: 'NUMBER_VALUE',
        hasTransmissionEcu: true || false,
        obdStandard: 'STRING_VALUE',
        pidRequestIntervalSeconds: 'NUMBER_VALUE',
        useExtendedIds: true || false
      }
    },
    /* more items */
  ],
  signalDecoders: [
    {
      fullyQualifiedName: 'STRING_VALUE', /* required */
      interfaceId: 'STRING_VALUE', /* required */
      type: CAN_SIGNAL | OBD_SIGNAL, /* required */
      canSignal: {
        factor: 'NUMBER_VALUE', /* required */
        isBigEndian: true || false, /* required */
        isSigned: true || false, /* required */
        length: 'NUMBER_VALUE', /* required */
        messageId: 'NUMBER_VALUE', /* required */
        offset: 'NUMBER_VALUE', /* required */
        startBit: 'NUMBER_VALUE', /* required */
        name: 'STRING_VALUE'
      },
      obdSignal: {
        byteLength: 'NUMBER_VALUE', /* required */
        offset: 'NUMBER_VALUE', /* required */
        pid: 'NUMBER_VALUE', /* required */
        pidResponseLength: 'NUMBER_VALUE', /* required */
        scaling: 'NUMBER_VALUE', /* required */
        serviceMode: 'NUMBER_VALUE', /* required */
        startByte: 'NUMBER_VALUE', /* required */
        bitMaskLength: 'NUMBER_VALUE',
        bitRightShift: 'NUMBER_VALUE'
      }
    },
    /* more items */
  ],
  tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
iotfleetwise.createDecoderManifest(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • name — (String)

      The unique name of the decoder manifest to create.

    • description — (String)

      A brief description of the decoder manifest.

    • modelManifestArn — (String)

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

    • signalDecoders — (Array<map>)

      A list of information about signal decoders.

      • fullyQualifiedNamerequired — (String)

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

      • typerequired — (String)

        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.

        Possible values include:
        • "CAN_SIGNAL"
        • "OBD_SIGNAL"
      • interfaceIdrequired — (String)

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

      • canSignal — (map)

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

        • messageIdrequired — (Integer)

          The ID of the message.

        • isBigEndianrequired — (Boolean)

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

        • isSignedrequired — (Boolean)

          Whether the message data is specified as a signed value.

        • startBitrequired — (Integer)

          Indicates the beginning of the CAN message.

        • offsetrequired — (Float)

          Indicates where data appears in the CAN message.

        • factorrequired — (Float)

          A multiplier used to decode the CAN message.

        • lengthrequired — (Integer)

          How many bytes of data are in the message.

        • name — (String)

          The name of the signal.

      • obdSignal — (map)

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

        • pidResponseLengthrequired — (Integer)

          The length of the requested data.

        • serviceModerequired — (Integer)

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

        • pidrequired — (Integer)

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

        • scalingrequired — (Float)

          A multiplier used to decode the message.

        • offsetrequired — (Float)

          Indicates where data appears in the message.

        • startByterequired — (Integer)

          Indicates the beginning of the message.

        • byteLengthrequired — (Integer)

          The length of a message.

        • bitRightShift — (Integer)

          The number of positions to shift bits in the message.

        • bitMaskLength — (Integer)

          The number of bits to mask in a message.

    • networkInterfaces — (Array<map>)

      A list of information about available network interfaces.

      • interfaceIdrequired — (String)

        The ID of the network interface.

      • typerequired — (String)

        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.

        Possible values include:
        • "CAN_INTERFACE"
        • "OBD_INTERFACE"
      • canInterface — (map)

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

        • namerequired — (String)

          The unique name of the interface.

        • protocolName — (String)

          The name of the communication protocol for the interface.

        • protocolVersion — (String)

          The version of the communication protocol for the interface.

      • obdInterface — (map)

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

        • namerequired — (String)

          The name of the interface.

        • requestMessageIdrequired — (Integer)

          The ID of the message requesting vehicle data.

        • obdStandard — (String)

          The standard OBD II PID.

        • pidRequestIntervalSeconds — (Integer)

          The maximum number message requests per second.

        • dtcRequestIntervalSeconds — (Integer)

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

        • useExtendedIds — (Boolean)

          Whether to use extended IDs in the message.

        • hasTransmissionEcu — (Boolean)

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

    • tags — (Array<map>)

      Metadata that can be used to manage the decoder manifest.

      • Keyrequired — (String)

        The tag's key.

      • Valuerequired — (String)

        The tag's value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • name — (String)

        The name of the created decoder manifest.

      • arn — (String)

        The ARN of the created decoder manifest.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createFleet(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the createFleet operation

var params = {
  fleetId: 'STRING_VALUE', /* required */
  signalCatalogArn: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
iotfleetwise.createFleet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • fleetId — (String)

      The unique ID of the fleet to create.

    • description — (String)

      A brief description of the fleet to create.

    • signalCatalogArn — (String)

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

    • tags — (Array<map>)

      Metadata that can be used to manage the fleet.

      • Keyrequired — (String)

        The tag's key.

      • Valuerequired — (String)

        The tag's value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • id — (String)

        The ID of the created fleet.

      • arn — (String)

        The ARN of the created fleet.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createModelManifest(params = {}, callback) ⇒ AWS.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.

Service Reference:

Examples:

Calling the createModelManifest operation

var params = {
  name: 'STRING_VALUE', /* required */
  nodes: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  signalCatalogArn: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
iotfleetwise.createModelManifest(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • name — (String)

      The name of the vehicle model to create.

    • description — (String)

      A brief description of the vehicle model.

    • nodes — (Array<String>)

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

    • signalCatalogArn — (String)

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

    • tags — (Array<map>)

      Metadata that can be used to manage the vehicle model.

      • Keyrequired — (String)

        The tag's key.

      • Valuerequired — (String)

        The tag's value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • name — (String)

        The name of the created vehicle model.

      • arn — (String)

        The ARN of the created vehicle model.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createSignalCatalog(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the createSignalCatalog operation

var params = {
  name: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  nodes: [
    {
      actuator: {
        dataType: INT8 | UINT8 | INT16 | UINT16 | INT32 | UINT32 | INT64 | UINT64 | BOOLEAN | FLOAT | DOUBLE | STRING | UNIX_TIMESTAMP | INT8_ARRAY | UINT8_ARRAY | INT16_ARRAY | UINT16_ARRAY | INT32_ARRAY | UINT32_ARRAY | INT64_ARRAY | UINT64_ARRAY | BOOLEAN_ARRAY | FLOAT_ARRAY | DOUBLE_ARRAY | STRING_ARRAY | UNIX_TIMESTAMP_ARRAY | UNKNOWN, /* required */
        fullyQualifiedName: 'STRING_VALUE', /* required */
        allowedValues: [
          'STRING_VALUE',
          /* more items */
        ],
        assignedValue: 'STRING_VALUE',
        description: 'STRING_VALUE',
        max: 'NUMBER_VALUE',
        min: 'NUMBER_VALUE',
        unit: 'STRING_VALUE'
      },
      attribute: {
        dataType: INT8 | UINT8 | INT16 | UINT16 | INT32 | UINT32 | INT64 | UINT64 | BOOLEAN | FLOAT | DOUBLE | STRING | UNIX_TIMESTAMP | INT8_ARRAY | UINT8_ARRAY | INT16_ARRAY | UINT16_ARRAY | INT32_ARRAY | UINT32_ARRAY | INT64_ARRAY | UINT64_ARRAY | BOOLEAN_ARRAY | FLOAT_ARRAY | DOUBLE_ARRAY | STRING_ARRAY | UNIX_TIMESTAMP_ARRAY | UNKNOWN, /* required */
        fullyQualifiedName: 'STRING_VALUE', /* required */
        allowedValues: [
          'STRING_VALUE',
          /* more items */
        ],
        assignedValue: 'STRING_VALUE',
        defaultValue: 'STRING_VALUE',
        description: 'STRING_VALUE',
        max: 'NUMBER_VALUE',
        min: 'NUMBER_VALUE',
        unit: 'STRING_VALUE'
      },
      branch: {
        fullyQualifiedName: 'STRING_VALUE', /* required */
        description: 'STRING_VALUE'
      },
      sensor: {
        dataType: INT8 | UINT8 | INT16 | UINT16 | INT32 | UINT32 | INT64 | UINT64 | BOOLEAN | FLOAT | DOUBLE | STRING | UNIX_TIMESTAMP | INT8_ARRAY | UINT8_ARRAY | INT16_ARRAY | UINT16_ARRAY | INT32_ARRAY | UINT32_ARRAY | INT64_ARRAY | UINT64_ARRAY | BOOLEAN_ARRAY | FLOAT_ARRAY | DOUBLE_ARRAY | STRING_ARRAY | UNIX_TIMESTAMP_ARRAY | UNKNOWN, /* required */
        fullyQualifiedName: 'STRING_VALUE', /* required */
        allowedValues: [
          'STRING_VALUE',
          /* more items */
        ],
        description: 'STRING_VALUE',
        max: 'NUMBER_VALUE',
        min: 'NUMBER_VALUE',
        unit: 'STRING_VALUE'
      }
    },
    /* more items */
  ],
  tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
iotfleetwise.createSignalCatalog(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • name — (String)

      The name of the signal catalog to create.

    • description — (String)

      A brief description of the signal catalog.

    • nodes — (Array<map>)

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

      • branch — (map)

        Information about a node specified as a branch.

        Note: A group of signals that are defined in a hierarchical structure.
        • fullyQualifiedNamerequired — (String)

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

        • description — (String)

          A brief description of the branch.

      • sensor — (map)

        An input component that reports the environmental condition of a vehicle.

        Note: You can collect data about fluid levels, temperatures, vibrations, or battery voltage from sensors.
        • fullyQualifiedNamerequired — (String)

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

        • dataTyperequired — (String)

          The specified data type of the sensor.

          Possible values include:
          • "INT8"
          • "UINT8"
          • "INT16"
          • "UINT16"
          • "INT32"
          • "UINT32"
          • "INT64"
          • "UINT64"
          • "BOOLEAN"
          • "FLOAT"
          • "DOUBLE"
          • "STRING"
          • "UNIX_TIMESTAMP"
          • "INT8_ARRAY"
          • "UINT8_ARRAY"
          • "INT16_ARRAY"
          • "UINT16_ARRAY"
          • "INT32_ARRAY"
          • "UINT32_ARRAY"
          • "INT64_ARRAY"
          • "UINT64_ARRAY"
          • "BOOLEAN_ARRAY"
          • "FLOAT_ARRAY"
          • "DOUBLE_ARRAY"
          • "STRING_ARRAY"
          • "UNIX_TIMESTAMP_ARRAY"
          • "UNKNOWN"
        • description — (String)

          A brief description of a sensor.

        • unit — (String)

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

        • allowedValues — (Array<String>)

          A list of possible values a sensor can take.

        • min — (Float)

          The specified possible minimum value of the sensor.

        • max — (Float)

          The specified possible maximum value of the sensor.

      • actuator — (map)

        Information about a node specified as an actuator.

        Note: An actuator is a digital representation of a vehicle device.
        • fullyQualifiedNamerequired — (String)

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

        • dataTyperequired — (String)

          The specified data type of the actuator.

          Possible values include:
          • "INT8"
          • "UINT8"
          • "INT16"
          • "UINT16"
          • "INT32"
          • "UINT32"
          • "INT64"
          • "UINT64"
          • "BOOLEAN"
          • "FLOAT"
          • "DOUBLE"
          • "STRING"
          • "UNIX_TIMESTAMP"
          • "INT8_ARRAY"
          • "UINT8_ARRAY"
          • "INT16_ARRAY"
          • "UINT16_ARRAY"
          • "INT32_ARRAY"
          • "UINT32_ARRAY"
          • "INT64_ARRAY"
          • "UINT64_ARRAY"
          • "BOOLEAN_ARRAY"
          • "FLOAT_ARRAY"
          • "DOUBLE_ARRAY"
          • "STRING_ARRAY"
          • "UNIX_TIMESTAMP_ARRAY"
          • "UNKNOWN"
        • description — (String)

          A brief description of the actuator.

        • unit — (String)

          The scientific unit for the actuator.

        • allowedValues — (Array<String>)

          A list of possible values an actuator can take.

        • min — (Float)

          The specified possible minimum value of an actuator.

        • max — (Float)

          The specified possible maximum value of an actuator.

        • assignedValue — (String)

          A specified value for the actuator.

      • attribute — (map)

        Information about a node specified as an attribute.

        Note: An attribute represents static information about a vehicle.
        • fullyQualifiedNamerequired — (String)

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

        • dataTyperequired — (String)

          The specified data type of the attribute.

          Possible values include:
          • "INT8"
          • "UINT8"
          • "INT16"
          • "UINT16"
          • "INT32"
          • "UINT32"
          • "INT64"
          • "UINT64"
          • "BOOLEAN"
          • "FLOAT"
          • "DOUBLE"
          • "STRING"
          • "UNIX_TIMESTAMP"
          • "INT8_ARRAY"
          • "UINT8_ARRAY"
          • "INT16_ARRAY"
          • "UINT16_ARRAY"
          • "INT32_ARRAY"
          • "UINT32_ARRAY"
          • "INT64_ARRAY"
          • "UINT64_ARRAY"
          • "BOOLEAN_ARRAY"
          • "FLOAT_ARRAY"
          • "DOUBLE_ARRAY"
          • "STRING_ARRAY"
          • "UNIX_TIMESTAMP_ARRAY"
          • "UNKNOWN"
        • description — (String)

          A brief description of the attribute.

        • unit — (String)

          The scientific unit for the attribute.

        • allowedValues — (Array<String>)

          A list of possible values an attribute can be assigned.

        • min — (Float)

          The specified possible minimum value of the attribute.

        • max — (Float)

          The specified possible maximum value of the attribute.

        • assignedValue — (String)

          A specified value for the attribute.

        • defaultValue — (String)

          The default value of the attribute.

    • tags — (Array<map>)

      Metadata that can be used to manage the signal catalog.

      • Keyrequired — (String)

        The tag's key.

      • Valuerequired — (String)

        The tag's value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • name — (String)

        The name of the created signal catalog.

      • arn — (String)

        The ARN of the created signal catalog.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createVehicle(params = {}, callback) ⇒ AWS.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.

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.

Service Reference:

Examples:

Calling the createVehicle operation

var params = {
  decoderManifestArn: 'STRING_VALUE', /* required */
  modelManifestArn: 'STRING_VALUE', /* required */
  vehicleName: 'STRING_VALUE', /* required */
  associationBehavior: CreateIotThing | ValidateIotThingExists,
  attributes: {
    '<attributeName>': 'STRING_VALUE',
    /* '<attributeName>': ... */
  },
  tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
iotfleetwise.createVehicle(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • vehicleName — (String)

      The unique ID of the vehicle to create.

    • modelManifestArn — (String)

      The Amazon Resource Name ARN of a vehicle model.

    • decoderManifestArn — (String)

      The ARN of a decoder manifest.

    • attributes — (map<String>)

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

    • associationBehavior — (String)

      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:

      Possible values include:
      • "CreateIotThing"
      • "ValidateIotThingExists"
    • tags — (Array<map>)

      Metadata that can be used to manage the vehicle.

      • Keyrequired — (String)

        The tag's key.

      • Valuerequired — (String)

        The tag's value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • vehicleName — (String)

        The unique ID of the created vehicle.

      • arn — (String)

        The ARN of the created vehicle.

      • thingArn — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteCampaign(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the deleteCampaign operation

var params = {
  name: 'STRING_VALUE' /* required */
};
iotfleetwise.deleteCampaign(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • name — (String)

      The name of the campaign to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • name — (String)

        The name of the deleted campaign.

      • arn — (String)

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

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteDecoderManifest(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the deleteDecoderManifest operation

var params = {
  name: 'STRING_VALUE' /* required */
};
iotfleetwise.deleteDecoderManifest(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • name — (String)

      The name of the decoder manifest to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • name — (String)

        The name of the deleted decoder manifest.

      • arn — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteFleet(params = {}, callback) ⇒ AWS.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.

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

Service Reference:

Examples:

Calling the deleteFleet operation

var params = {
  fleetId: 'STRING_VALUE' /* required */
};
iotfleetwise.deleteFleet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • fleetId — (String)

      The ID of the fleet to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • id — (String)

        The ID of the deleted fleet.

      • arn — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteModelManifest(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the deleteModelManifest operation

var params = {
  name: 'STRING_VALUE' /* required */
};
iotfleetwise.deleteModelManifest(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • name — (String)

      The name of the model manifest to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • name — (String)

        The name of the deleted model manifest.

      • arn — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteSignalCatalog(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the deleteSignalCatalog operation

var params = {
  name: 'STRING_VALUE' /* required */
};
iotfleetwise.deleteSignalCatalog(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • name — (String)

      The name of the signal catalog to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • name — (String)

        The name of the deleted signal catalog.

      • arn — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteVehicle(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the deleteVehicle operation

var params = {
  vehicleName: 'STRING_VALUE' /* required */
};
iotfleetwise.deleteVehicle(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • vehicleName — (String)

      The ID of the vehicle to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • vehicleName — (String)

        The ID of the deleted vehicle.

      • arn — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

disassociateVehicleFleet(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the disassociateVehicleFleet operation

var params = {
  fleetId: 'STRING_VALUE', /* required */
  vehicleName: 'STRING_VALUE' /* required */
};
iotfleetwise.disassociateVehicleFleet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • vehicleName — (String)

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

    • fleetId — (String)

      The unique ID of a fleet.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getCampaign(params = {}, callback) ⇒ AWS.Request

Retrieves information about a campaign.

Service Reference:

Examples:

Calling the getCampaign operation

var params = {
  name: 'STRING_VALUE' /* required */
};
iotfleetwise.getCampaign(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • name — (String)

      The name of the campaign to retrieve information about.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • name — (String)

        The name of the campaign.

      • arn — (String)

        The Amazon Resource Name (ARN) of the campaign.

      • description — (String)

        The description of the campaign.

      • signalCatalogArn — (String)

        The ARN of a signal catalog.

      • targetArn — (String)

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

      • status — (String)

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

        Possible values include:
        • "CREATING"
        • "WAITING_FOR_APPROVAL"
        • "RUNNING"
        • "SUSPENDED"
      • startTime — (Date)

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

      • expiryTime — (Date)

        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.

      • postTriggerCollectionDuration — (Integer)

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

      • diagnosticsMode — (String)

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

        Possible values include:
        • "OFF"
        • "SEND_ACTIVE_DTCS"
      • spoolingMode — (String)

        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.

        Possible values include:
        • "OFF"
        • "TO_DISK"
      • compression — (String)

        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.

        Possible values include:
        • "OFF"
        • "SNAPPY"
      • priority — (Integer)

        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.

      • signalsToCollect — (Array<map>)

        Information about a list of signals to collect data on.

        • namerequired — (String)

          The name of the signal.

        • maxSampleCount — (Integer)

          The maximum number of samples to collect.

        • minimumSamplingIntervalMs — (Integer)

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

          Note: If a signal changes often, you might want to collect data at a slower rate.
      • collectionScheme — (map)

        Information about the data collection scheme associated with the campaign.

        • timeBasedCollectionScheme — (map)

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

          • periodMsrequired — (Integer)

            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.

        • conditionBasedCollectionScheme — (map)

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

          • expressionrequired — (String)

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

          • minimumTriggerIntervalMs — (Integer)

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

            Note: If a signal changes often, you might want to collect data at a slower rate.
          • triggerMode — (String)

            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.

            Possible values include:
            • "ALWAYS"
            • "RISING_EDGE"
          • conditionLanguageVersion — (Integer)

            Specifies the version of the conditional expression language.

      • dataExtraDimensions — (Array<String>)

        A list of vehicle attributes associated with the campaign.

      • creationTime — (Date)

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

      • lastModificationTime — (Date)

        The last time the campaign was modified.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getDecoderManifest(params = {}, callback) ⇒ AWS.Request

Retrieves information about a created decoder manifest.

Service Reference:

Examples:

Calling the getDecoderManifest operation

var params = {
  name: 'STRING_VALUE' /* required */
};
iotfleetwise.getDecoderManifest(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • name — (String)

      The name of the decoder manifest to retrieve information about.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • name — (String)

        The name of the decoder manifest.

      • arn — (String)

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

      • description — (String)

        A brief description of the decoder manifest.

      • modelManifestArn — (String)

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

      • status — (String)

        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.

        Possible values include:
        • "ACTIVE"
        • "DRAFT"
      • creationTime — (Date)

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

      • lastModificationTime — (Date)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getFleet(params = {}, callback) ⇒ AWS.Request

Retrieves information about a fleet.

Service Reference:

Examples:

Calling the getFleet operation

var params = {
  fleetId: 'STRING_VALUE' /* required */
};
iotfleetwise.getFleet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • fleetId — (String)

      The ID of the fleet to retrieve information about.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • id — (String)

        The ID of the fleet.

      • arn — (String)

        The Amazon Resource Name (ARN) of the fleet.

      • description — (String)

        A brief description of the fleet.

      • signalCatalogArn — (String)

        The ARN of a signal catalog associated with the fleet.

      • creationTime — (Date)

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

      • lastModificationTime — (Date)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getLoggingOptions(params = {}, callback) ⇒ AWS.Request

Retrieves the logging options.

Service Reference:

Examples:

Calling the getLoggingOptions operation

var params = {
};
iotfleetwise.getLoggingOptions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • cloudWatchLogDelivery — (map)

        Returns information about log delivery to Amazon CloudWatch Logs.

        • logTyperequired — (String)

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

          Possible values include:
          • "OFF"
          • "ERROR"
        • logGroupName — (String)

          The Amazon CloudWatch Logs group the operation sends data to.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getModelManifest(params = {}, callback) ⇒ AWS.Request

Retrieves information about a vehicle model (model manifest).

Service Reference:

Examples:

Calling the getModelManifest operation

var params = {
  name: 'STRING_VALUE' /* required */
};
iotfleetwise.getModelManifest(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • name — (String)

      The name of the vehicle model to retrieve information about.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • name — (String)

        The name of the vehicle model.

      • arn — (String)

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

      • description — (String)

        A brief description of the vehicle model.

      • signalCatalogArn — (String)

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

      • status — (String)

        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.

        Possible values include:
        • "ACTIVE"
        • "DRAFT"
      • creationTime — (Date)

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

      • lastModificationTime — (Date)

        The last time the vehicle model was modified.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getRegisterAccountStatus(params = {}, callback) ⇒ AWS.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.

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

Service Reference:

Examples:

Calling the getRegisterAccountStatus operation

var params = {
};
iotfleetwise.getRegisterAccountStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • customerAccountId — (String)

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

      • accountStatus — (String)

        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.

        Possible values include:
        • "REGISTRATION_PENDING"
        • "REGISTRATION_SUCCESS"
        • "REGISTRATION_FAILURE"
      • timestreamRegistrationResponse — (map)

        Information about the registered Amazon Timestream resources or errors, if any.

        • timestreamDatabaseNamerequired — (String)

          The name of the Timestream database.

        • timestreamTableNamerequired — (String)

          The name of the Timestream database table.

        • timestreamDatabaseArn — (String)

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

        • timestreamTableArn — (String)

          The ARN of the Timestream database table.

        • registrationStatusrequired — (String)

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

          Possible values include:
          • "REGISTRATION_PENDING"
          • "REGISTRATION_SUCCESS"
          • "REGISTRATION_FAILURE"
        • errorMessage — (String)

          A message associated with a registration error.

      • iamRegistrationResponse — (map)

        Information about the registered IAM resources or errors, if any.

        • roleArnrequired — (String)

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

        • registrationStatusrequired — (String)

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

          Possible values include:
          • "REGISTRATION_PENDING"
          • "REGISTRATION_SUCCESS"
          • "REGISTRATION_FAILURE"
        • errorMessage — (String)

          A message associated with a registration error.

      • creationTime — (Date)

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

      • lastModificationTime — (Date)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getSignalCatalog(params = {}, callback) ⇒ AWS.Request

Retrieves information about a signal catalog.

Service Reference:

Examples:

Calling the getSignalCatalog operation

var params = {
  name: 'STRING_VALUE' /* required */
};
iotfleetwise.getSignalCatalog(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • name — (String)

      The name of the signal catalog to retrieve information about.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • name — (String)

        The name of the signal catalog.

      • arn — (String)

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

      • description — (String)

        A brief description of the signal catalog.

      • nodeCounts — (map)

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

        • totalNodes — (Integer)

          The total number of nodes in a vehicle network.

        • totalBranches — (Integer)

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

        • totalSensors — (Integer)

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

        • totalAttributes — (Integer)

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

        • totalActuators — (Integer)

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

      • creationTime — (Date)

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

      • lastModificationTime — (Date)

        The last time the signal catalog was modified.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getVehicle(params = {}, callback) ⇒ AWS.Request

Retrieves information about a vehicle.

Service Reference:

Examples:

Calling the getVehicle operation

var params = {
  vehicleName: 'STRING_VALUE' /* required */
};
iotfleetwise.getVehicle(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • vehicleName — (String)

      The ID of the vehicle to retrieve information about.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • vehicleName — (String)

        The ID of the vehicle.

      • arn — (String)

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

      • modelManifestArn — (String)

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

      • decoderManifestArn — (String)

        The ARN of a decoder manifest associated with the vehicle.

      • attributes — (map<String>)

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

        "engineType" : "1.3 L R2"

      • creationTime — (Date)

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

      • lastModificationTime — (Date)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getVehicleStatus(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getVehicleStatus operation

var params = {
  vehicleName: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
iotfleetwise.getVehicleStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • nextToken — (String)

      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.

    • maxResults — (Integer)

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

    • vehicleName — (String)

      The ID of the vehicle to retrieve information about.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • campaigns — (Array<map>)

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

        • campaignName — (String)

          The name of a campaign.

        • vehicleName — (String)

          The unique ID of the vehicle.

        • status — (String)

          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.

          Possible values include:
          • "CREATED"
          • "READY"
          • "HEALTHY"
          • "SUSPENDED"
          • "DELETING"
      • nextToken — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

importDecoderManifest(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the importDecoderManifest operation

var params = {
  name: 'STRING_VALUE', /* required */
  networkFileDefinitions: [ /* required */
    {
      canDbc: {
        canDbcFiles: [ /* required */
          Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
          /* more items */
        ],
        networkInterface: 'STRING_VALUE', /* required */
        signalsMap: {
          '<string>': 'STRING_VALUE',
          /* '<string>': ... */
        }
      }
    },
    /* more items */
  ]
};
iotfleetwise.importDecoderManifest(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • name — (String)

      The name of the decoder manifest to import.

    • networkFileDefinitions — (Array<map>)

      The file to load into an Amazon Web Services account.

      • canDbc — (map)

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

        • networkInterfacerequired — (String)

          Contains information about a network interface.

        • canDbcFilesrequired — (Array<Buffer, Typed Array, Blob, String>)

          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.

        • signalsMap — (map<String>)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • name — (String)

        The name of the imported decoder manifest.

      • arn — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

importSignalCatalog(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the importSignalCatalog operation

var params = {
  name: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  vss: {
    vssJson: 'STRING_VALUE'
  }
};
iotfleetwise.importSignalCatalog(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • name — (String)

      The name of the signal catalog to import.

    • description — (String)

      A brief description of the signal catalog.

    • vss — (map)

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

      • vssJson — (String)

        Provides the VSS in JSON format.

    • tags — (Array<map>)

      Metadata that can be used to manage the signal catalog.

      • Keyrequired — (String)

        The tag's key.

      • Valuerequired — (String)

        The tag's value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • name — (String)

        The name of the imported signal catalog.

      • arn — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listCampaigns(params = {}, callback) ⇒ AWS.Request

Lists information about created campaigns.

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

Service Reference:

Examples:

Calling the listCampaigns operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  status: 'STRING_VALUE'
};
iotfleetwise.listCampaigns(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • nextToken — (String)

      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.

    • maxResults — (Integer)

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

    • status — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • campaignSummaries — (Array<map>)

        A summary of information about each campaign.

        • arn — (String)

          The Amazon Resource Name (ARN) of a campaign.

        • name — (String)

          The name of a campaign.

        • description — (String)

          The description of the campaign.

        • signalCatalogArn — (String)

          The ARN of the signal catalog associated with the campaign.

        • targetArn — (String)

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

        • status — (String)

          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.

          Possible values include:
          • "CREATING"
          • "WAITING_FOR_APPROVAL"
          • "RUNNING"
          • "SUSPENDED"
        • creationTimerequired — (Date)

          The time the campaign was created.

        • lastModificationTimerequired — (Date)

          The last time the campaign was modified.

      • nextToken — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listDecoderManifestNetworkInterfaces(params = {}, callback) ⇒ AWS.Request

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.

Examples:

Calling the listDecoderManifestNetworkInterfaces operation

var params = {
  name: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
iotfleetwise.listDecoderManifestNetworkInterfaces(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • name — (String)

      The name of the decoder manifest to list information about.

    • nextToken — (String)

      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.

    • maxResults — (Integer)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • networkInterfaces — (Array<map>)

        A list of information about network interfaces.

        • interfaceIdrequired — (String)

          The ID of the network interface.

        • typerequired — (String)

          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.

          Possible values include:
          • "CAN_INTERFACE"
          • "OBD_INTERFACE"
        • canInterface — (map)

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

          • namerequired — (String)

            The unique name of the interface.

          • protocolName — (String)

            The name of the communication protocol for the interface.

          • protocolVersion — (String)

            The version of the communication protocol for the interface.

        • obdInterface — (map)

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

          • namerequired — (String)

            The name of the interface.

          • requestMessageIdrequired — (Integer)

            The ID of the message requesting vehicle data.

          • obdStandard — (String)

            The standard OBD II PID.

          • pidRequestIntervalSeconds — (Integer)

            The maximum number message requests per second.

          • dtcRequestIntervalSeconds — (Integer)

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

          • useExtendedIds — (Boolean)

            Whether to use extended IDs in the message.

          • hasTransmissionEcu — (Boolean)

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

      • nextToken — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listDecoderManifests(params = {}, callback) ⇒ AWS.Request

Lists decoder manifests.

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

Service Reference:

Examples:

Calling the listDecoderManifests operation

var params = {
  maxResults: 'NUMBER_VALUE',
  modelManifestArn: 'STRING_VALUE',
  nextToken: 'STRING_VALUE'
};
iotfleetwise.listDecoderManifests(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • modelManifestArn — (String)

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

    • nextToken — (String)

      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.

    • maxResults — (Integer)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • summaries — (Array<map>)

        A list of information about each decoder manifest.

        • name — (String)

          The name of the decoder manifest.

        • arn — (String)

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

        • modelManifestArn — (String)

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

        • description — (String)

          A brief description of the decoder manifest.

        • status — (String)

          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.

          Possible values include:
          • "ACTIVE"
          • "DRAFT"
        • creationTimerequired — (Date)

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

        • lastModificationTimerequired — (Date)

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

      • nextToken — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listDecoderManifestSignals(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the listDecoderManifestSignals operation

var params = {
  name: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
iotfleetwise.listDecoderManifestSignals(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • name — (String)

      The name of the decoder manifest to list information about.

    • nextToken — (String)

      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.

    • maxResults — (Integer)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • signalDecoders — (Array<map>)

        Information about a list of signals to decode.

        • fullyQualifiedNamerequired — (String)

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

        • typerequired — (String)

          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.

          Possible values include:
          • "CAN_SIGNAL"
          • "OBD_SIGNAL"
        • interfaceIdrequired — (String)

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

        • canSignal — (map)

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

          • messageIdrequired — (Integer)

            The ID of the message.

          • isBigEndianrequired — (Boolean)

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

          • isSignedrequired — (Boolean)

            Whether the message data is specified as a signed value.

          • startBitrequired — (Integer)

            Indicates the beginning of the CAN message.

          • offsetrequired — (Float)

            Indicates where data appears in the CAN message.

          • factorrequired — (Float)

            A multiplier used to decode the CAN message.

          • lengthrequired — (Integer)

            How many bytes of data are in the message.

          • name — (String)

            The name of the signal.

        • obdSignal — (map)

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

          • pidResponseLengthrequired — (Integer)

            The length of the requested data.

          • serviceModerequired — (Integer)

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

          • pidrequired — (Integer)

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

          • scalingrequired — (Float)

            A multiplier used to decode the message.

          • offsetrequired — (Float)

            Indicates where data appears in the message.

          • startByterequired — (Integer)

            Indicates the beginning of the message.

          • byteLengthrequired — (Integer)

            The length of a message.

          • bitRightShift — (Integer)

            The number of positions to shift bits in the message.

          • bitMaskLength — (Integer)

            The number of bits to mask in a message.

      • nextToken — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listFleets(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the listFleets operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
iotfleetwise.listFleets(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • nextToken — (String)

      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.

    • maxResults — (Integer)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • fleetSummaries — (Array<map>)

        A list of information for each fleet.

        • idrequired — (String)

          The unique ID of the fleet.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the fleet.

        • description — (String)

          A brief description of the fleet.

        • signalCatalogArnrequired — (String)

          The ARN of the signal catalog associated with the fleet.

        • creationTimerequired — (Date)

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

        • lastModificationTime — (Date)

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

      • nextToken — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listFleetsForVehicle(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the listFleetsForVehicle operation

var params = {
  vehicleName: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
iotfleetwise.listFleetsForVehicle(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • vehicleName — (String)

      The ID of the vehicle to retrieve information about.

    • nextToken — (String)

      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.

    • maxResults — (Integer)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • fleets — (Array<String>)

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

      • nextToken — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listModelManifestNodes(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the listModelManifestNodes operation

var params = {
  name: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
iotfleetwise.listModelManifestNodes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • name — (String)

      The name of the vehicle model to list information about.

    • nextToken — (String)

      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.

    • maxResults — (Integer)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nodes — (Array<map>)

        A list of information about nodes.

        • branch — (map)

          Information about a node specified as a branch.

          Note: A group of signals that are defined in a hierarchical structure.
          • fullyQualifiedNamerequired — (String)

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

          • description — (String)

            A brief description of the branch.

        • sensor — (map)

          An input component that reports the environmental condition of a vehicle.

          Note: You can collect data about fluid levels, temperatures, vibrations, or battery voltage from sensors.
          • fullyQualifiedNamerequired — (String)

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

          • dataTyperequired — (String)

            The specified data type of the sensor.

            Possible values include:
            • "INT8"
            • "UINT8"
            • "INT16"
            • "UINT16"
            • "INT32"
            • "UINT32"
            • "INT64"
            • "UINT64"
            • "BOOLEAN"
            • "FLOAT"
            • "DOUBLE"
            • "STRING"
            • "UNIX_TIMESTAMP"
            • "INT8_ARRAY"
            • "UINT8_ARRAY"
            • "INT16_ARRAY"
            • "UINT16_ARRAY"
            • "INT32_ARRAY"
            • "UINT32_ARRAY"
            • "INT64_ARRAY"
            • "UINT64_ARRAY"
            • "BOOLEAN_ARRAY"
            • "FLOAT_ARRAY"
            • "DOUBLE_ARRAY"
            • "STRING_ARRAY"
            • "UNIX_TIMESTAMP_ARRAY"
            • "UNKNOWN"
          • description — (String)

            A brief description of a sensor.

          • unit — (String)

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

          • allowedValues — (Array<String>)

            A list of possible values a sensor can take.

          • min — (Float)

            The specified possible minimum value of the sensor.

          • max — (Float)

            The specified possible maximum value of the sensor.

        • actuator — (map)

          Information about a node specified as an actuator.

          Note: An actuator is a digital representation of a vehicle device.
          • fullyQualifiedNamerequired — (String)

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

          • dataTyperequired — (String)

            The specified data type of the actuator.

            Possible values include:
            • "INT8"
            • "UINT8"
            • "INT16"
            • "UINT16"
            • "INT32"
            • "UINT32"
            • "INT64"
            • "UINT64"
            • "BOOLEAN"
            • "FLOAT"
            • "DOUBLE"
            • "STRING"
            • "UNIX_TIMESTAMP"
            • "INT8_ARRAY"
            • "UINT8_ARRAY"
            • "INT16_ARRAY"
            • "UINT16_ARRAY"
            • "INT32_ARRAY"
            • "UINT32_ARRAY"
            • "INT64_ARRAY"
            • "UINT64_ARRAY"
            • "BOOLEAN_ARRAY"
            • "FLOAT_ARRAY"
            • "DOUBLE_ARRAY"
            • "STRING_ARRAY"
            • "UNIX_TIMESTAMP_ARRAY"
            • "UNKNOWN"
          • description — (String)

            A brief description of the actuator.

          • unit — (String)

            The scientific unit for the actuator.

          • allowedValues — (Array<String>)

            A list of possible values an actuator can take.

          • min — (Float)

            The specified possible minimum value of an actuator.

          • max — (Float)

            The specified possible maximum value of an actuator.

          • assignedValue — (String)

            A specified value for the actuator.

        • attribute — (map)

          Information about a node specified as an attribute.

          Note: An attribute represents static information about a vehicle.
          • fullyQualifiedNamerequired — (String)

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

          • dataTyperequired — (String)

            The specified data type of the attribute.

            Possible values include:
            • "INT8"
            • "UINT8"
            • "INT16"
            • "UINT16"
            • "INT32"
            • "UINT32"
            • "INT64"
            • "UINT64"
            • "BOOLEAN"
            • "FLOAT"
            • "DOUBLE"
            • "STRING"
            • "UNIX_TIMESTAMP"
            • "INT8_ARRAY"
            • "UINT8_ARRAY"
            • "INT16_ARRAY"
            • "UINT16_ARRAY"
            • "INT32_ARRAY"
            • "UINT32_ARRAY"
            • "INT64_ARRAY"
            • "UINT64_ARRAY"
            • "BOOLEAN_ARRAY"
            • "FLOAT_ARRAY"
            • "DOUBLE_ARRAY"
            • "STRING_ARRAY"
            • "UNIX_TIMESTAMP_ARRAY"
            • "UNKNOWN"
          • description — (String)

            A brief description of the attribute.

          • unit — (String)

            The scientific unit for the attribute.

          • allowedValues — (Array<String>)

            A list of possible values an attribute can be assigned.

          • min — (Float)

            The specified possible minimum value of the attribute.

          • max — (Float)

            The specified possible maximum value of the attribute.

          • assignedValue — (String)

            A specified value for the attribute.

          • defaultValue — (String)

            The default value of the attribute.

      • nextToken — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listModelManifests(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the listModelManifests operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  signalCatalogArn: 'STRING_VALUE'
};
iotfleetwise.listModelManifests(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • signalCatalogArn — (String)

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

    • nextToken — (String)

      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.

    • maxResults — (Integer)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • summaries — (Array<map>)

        A list of information about vehicle models.

        • name — (String)

          The name of the vehicle model.

        • arn — (String)

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

        • signalCatalogArn — (String)

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

        • description — (String)

          A brief description of the vehicle model.

        • status — (String)

          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.

          Possible values include:
          • "ACTIVE"
          • "DRAFT"
        • creationTimerequired — (Date)

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

        • lastModificationTimerequired — (Date)

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

      • nextToken — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listSignalCatalogNodes(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the listSignalCatalogNodes operation

var params = {
  name: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
iotfleetwise.listSignalCatalogNodes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • name — (String)

      The name of the signal catalog to list information about.

    • nextToken — (String)

      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.

    • maxResults — (Integer)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nodes — (Array<map>)

        A list of information about nodes.

        • branch — (map)

          Information about a node specified as a branch.

          Note: A group of signals that are defined in a hierarchical structure.
          • fullyQualifiedNamerequired — (String)

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

          • description — (String)

            A brief description of the branch.

        • sensor — (map)

          An input component that reports the environmental condition of a vehicle.

          Note: You can collect data about fluid levels, temperatures, vibrations, or battery voltage from sensors.
          • fullyQualifiedNamerequired — (String)

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

          • dataTyperequired — (String)

            The specified data type of the sensor.

            Possible values include:
            • "INT8"
            • "UINT8"
            • "INT16"
            • "UINT16"
            • "INT32"
            • "UINT32"
            • "INT64"
            • "UINT64"
            • "BOOLEAN"
            • "FLOAT"
            • "DOUBLE"
            • "STRING"
            • "UNIX_TIMESTAMP"
            • "INT8_ARRAY"
            • "UINT8_ARRAY"
            • "INT16_ARRAY"
            • "UINT16_ARRAY"
            • "INT32_ARRAY"
            • "UINT32_ARRAY"
            • "INT64_ARRAY"
            • "UINT64_ARRAY"
            • "BOOLEAN_ARRAY"
            • "FLOAT_ARRAY"
            • "DOUBLE_ARRAY"
            • "STRING_ARRAY"
            • "UNIX_TIMESTAMP_ARRAY"
            • "UNKNOWN"
          • description — (String)

            A brief description of a sensor.

          • unit — (String)

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

          • allowedValues — (Array<String>)

            A list of possible values a sensor can take.

          • min — (Float)

            The specified possible minimum value of the sensor.

          • max — (Float)

            The specified possible maximum value of the sensor.

        • actuator — (map)

          Information about a node specified as an actuator.

          Note: An actuator is a digital representation of a vehicle device.
          • fullyQualifiedNamerequired — (String)

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

          • dataTyperequired — (String)

            The specified data type of the actuator.

            Possible values include:
            • "INT8"
            • "UINT8"
            • "INT16"
            • "UINT16"
            • "INT32"
            • "UINT32"
            • "INT64"
            • "UINT64"
            • "BOOLEAN"
            • "FLOAT"
            • "DOUBLE"
            • "STRING"
            • "UNIX_TIMESTAMP"
            • "INT8_ARRAY"
            • "UINT8_ARRAY"
            • "INT16_ARRAY"
            • "UINT16_ARRAY"
            • "INT32_ARRAY"
            • "UINT32_ARRAY"
            • "INT64_ARRAY"
            • "UINT64_ARRAY"
            • "BOOLEAN_ARRAY"
            • "FLOAT_ARRAY"
            • "DOUBLE_ARRAY"
            • "STRING_ARRAY"
            • "UNIX_TIMESTAMP_ARRAY"
            • "UNKNOWN"
          • description — (String)

            A brief description of the actuator.

          • unit — (String)

            The scientific unit for the actuator.

          • allowedValues — (Array<String>)

            A list of possible values an actuator can take.

          • min — (Float)

            The specified possible minimum value of an actuator.

          • max — (Float)

            The specified possible maximum value of an actuator.

          • assignedValue — (String)

            A specified value for the actuator.

        • attribute — (map)

          Information about a node specified as an attribute.

          Note: An attribute represents static information about a vehicle.
          • fullyQualifiedNamerequired — (String)

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

          • dataTyperequired — (String)

            The specified data type of the attribute.

            Possible values include:
            • "INT8"
            • "UINT8"
            • "INT16"
            • "UINT16"
            • "INT32"
            • "UINT32"
            • "INT64"
            • "UINT64"
            • "BOOLEAN"
            • "FLOAT"
            • "DOUBLE"
            • "STRING"
            • "UNIX_TIMESTAMP"
            • "INT8_ARRAY"
            • "UINT8_ARRAY"
            • "INT16_ARRAY"
            • "UINT16_ARRAY"
            • "INT32_ARRAY"
            • "UINT32_ARRAY"
            • "INT64_ARRAY"
            • "UINT64_ARRAY"
            • "BOOLEAN_ARRAY"
            • "FLOAT_ARRAY"
            • "DOUBLE_ARRAY"
            • "STRING_ARRAY"
            • "UNIX_TIMESTAMP_ARRAY"
            • "UNKNOWN"
          • description — (String)

            A brief description of the attribute.

          • unit — (String)

            The scientific unit for the attribute.

          • allowedValues — (Array<String>)

            A list of possible values an attribute can be assigned.

          • min — (Float)

            The specified possible minimum value of the attribute.

          • max — (Float)

            The specified possible maximum value of the attribute.

          • assignedValue — (String)

            A specified value for the attribute.

          • defaultValue — (String)

            The default value of the attribute.

      • nextToken — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listSignalCatalogs(params = {}, callback) ⇒ AWS.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.

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

Service Reference:

Examples:

Calling the listSignalCatalogs operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
iotfleetwise.listSignalCatalogs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • nextToken — (String)

      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.

    • maxResults — (Integer)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • summaries — (Array<map>)

        A list of information about each signal catalog.

        • name — (String)

          The name of the signal catalog.

        • arn — (String)

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

        • creationTime — (Date)

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

        • lastModificationTime — (Date)

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

      • nextToken — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceARN: 'STRING_VALUE' /* required */
};
iotfleetwise.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceARN — (String)

      The ARN of the resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Tags — (Array<map>)

        The list of tags assigned to the resource.

        • Keyrequired — (String)

          The tag's key.

        • Valuerequired — (String)

          The tag's value.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listVehicles(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the listVehicles operation

var params = {
  maxResults: 'NUMBER_VALUE',
  modelManifestArn: 'STRING_VALUE',
  nextToken: 'STRING_VALUE'
};
iotfleetwise.listVehicles(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • modelManifestArn — (String)

      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.

    • nextToken — (String)

      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.

    • maxResults — (Integer)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • vehicleSummaries — (Array<map>)

        A list of vehicles and information about them.

        • vehicleNamerequired — (String)

          The unique ID of the vehicle.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the vehicle.

        • modelManifestArnrequired — (String)

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

        • decoderManifestArnrequired — (String)

          The ARN of a decoder manifest associated with the vehicle.

        • creationTimerequired — (Date)

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

        • lastModificationTimerequired — (Date)

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

      • nextToken — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listVehiclesInFleet(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the listVehiclesInFleet operation

var params = {
  fleetId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
iotfleetwise.listVehiclesInFleet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • fleetId — (String)

      The ID of a fleet.

    • nextToken — (String)

      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.

    • maxResults — (Integer)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • vehicles — (Array<String>)

        A list of vehicles associated with the fleet.

      • nextToken — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

putLoggingOptions(params = {}, callback) ⇒ AWS.Request

Creates or updates the logging option.

Service Reference:

Examples:

Calling the putLoggingOptions operation

var params = {
  cloudWatchLogDelivery: { /* required */
    logType: OFF | ERROR, /* required */
    logGroupName: 'STRING_VALUE'
  }
};
iotfleetwise.putLoggingOptions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • cloudWatchLogDelivery — (map)

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

      • logTyperequired — (String)

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

        Possible values include:
        • "OFF"
        • "ERROR"
      • logGroupName — (String)

        The Amazon CloudWatch Logs group the operation sends data to.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

registerAccount(params = {}, callback) ⇒ AWS.Request

Registers your Amazon Web Services account, IAM, and Amazon Timestream resources so Amazon Web Services IoT FleetWise can transfer your vehicle data to the Amazon Web Services Cloud. 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.

Service Reference:

Examples:

Calling the registerAccount operation

var params = {
  timestreamResources: { /* required */
    timestreamDatabaseName: 'STRING_VALUE', /* required */
    timestreamTableName: 'STRING_VALUE' /* required */
  },
  iamResources: {
    roleArn: 'STRING_VALUE' /* required */
  }
};
iotfleetwise.registerAccount(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • timestreamResources — (map)

      The registered Amazon Timestream resources that Amazon Web Services IoT FleetWise edge agent software can transfer your vehicle data to.

      • timestreamDatabaseNamerequired — (String)

        The name of the registered Amazon Timestream database.

      • timestreamTableNamerequired — (String)

        The name of the registered Amazon Timestream database table.

    • iamResources — (map)

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

      • roleArnrequired — (String)

        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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • registerAccountStatus — (String)

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

        Possible values include:
        • "REGISTRATION_PENDING"
        • "REGISTRATION_SUCCESS"
        • "REGISTRATION_FAILURE"
      • timestreamResources — (map)

        The registered Amazon Timestream resources that Amazon Web Services IoT FleetWise edge agent software can transfer your vehicle data to.

        • timestreamDatabaseNamerequired — (String)

          The name of the registered Amazon Timestream database.

        • timestreamTableNamerequired — (String)

          The name of the registered Amazon Timestream database table.

      • iamResources — (map)

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

        • roleArnrequired — (String)

          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.

      • creationTime — (Date)

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

      • lastModificationTime — (Date)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
iotfleetwise.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceARN — (String)

      The ARN of the resource.

    • Tags — (Array<map>)

      The new or modified tags for the resource.

      • Keyrequired — (String)

        The tag's key.

      • Valuerequired — (String)

        The tag's value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes the given tags (metadata) from the resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
iotfleetwise.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceARN — (String)

      The ARN of the resource.

    • TagKeys — (Array<String>)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateCampaign(params = {}, callback) ⇒ AWS.Request

Updates a campaign.

Service Reference:

Examples:

Calling the updateCampaign operation

var params = {
  action: APPROVE | SUSPEND | RESUME | UPDATE, /* required */
  name: 'STRING_VALUE', /* required */
  dataExtraDimensions: [
    'STRING_VALUE',
    /* more items */
  ],
  description: 'STRING_VALUE'
};
iotfleetwise.updateCampaign(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • name — (String)

      The name of the campaign to update.

    • description — (String)

      The description of the campaign.

    • dataExtraDimensions — (Array<String>)

      A list of vehicle attributes to associate with a signal.

      Default: An empty array

    • action — (String)

      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.

      Possible values include:
      • "APPROVE"
      • "SUSPEND"
      • "RESUME"
      • "UPDATE"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • arn — (String)

        The Amazon Resource Name (ARN) of the campaign.

      • name — (String)

        The name of the updated campaign.

      • status — (String)

        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.

        Possible values include:
        • "CREATING"
        • "WAITING_FOR_APPROVAL"
        • "RUNNING"
        • "SUSPENDED"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateDecoderManifest(params = {}, callback) ⇒ AWS.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.

Service Reference:

Examples:

Calling the updateDecoderManifest operation

var params = {
  name: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  networkInterfacesToAdd: [
    {
      interfaceId: 'STRING_VALUE', /* required */
      type: CAN_INTERFACE | OBD_INTERFACE, /* required */
      canInterface: {
        name: 'STRING_VALUE', /* required */
        protocolName: 'STRING_VALUE',
        protocolVersion: 'STRING_VALUE'
      },
      obdInterface: {
        name: 'STRING_VALUE', /* required */
        requestMessageId: 'NUMBER_VALUE', /* required */
        dtcRequestIntervalSeconds: 'NUMBER_VALUE',
        hasTransmissionEcu: true || false,
        obdStandard: 'STRING_VALUE',
        pidRequestIntervalSeconds: 'NUMBER_VALUE',
        useExtendedIds: true || false
      }
    },
    /* more items */
  ],
  networkInterfacesToRemove: [
    'STRING_VALUE',
    /* more items */
  ],
  networkInterfacesToUpdate: [
    {
      interfaceId: 'STRING_VALUE', /* required */
      type: CAN_INTERFACE | OBD_INTERFACE, /* required */
      canInterface: {
        name: 'STRING_VALUE', /* required */
        protocolName: 'STRING_VALUE',
        protocolVersion: 'STRING_VALUE'
      },
      obdInterface: {
        name: 'STRING_VALUE', /* required */
        requestMessageId: 'NUMBER_VALUE', /* required */
        dtcRequestIntervalSeconds: 'NUMBER_VALUE',
        hasTransmissionEcu: true || false,
        obdStandard: 'STRING_VALUE',
        pidRequestIntervalSeconds: 'NUMBER_VALUE',
        useExtendedIds: true || false
      }
    },
    /* more items */
  ],
  signalDecodersToAdd: [
    {
      fullyQualifiedName: 'STRING_VALUE', /* required */
      interfaceId: 'STRING_VALUE', /* required */
      type: CAN_SIGNAL | OBD_SIGNAL, /* required */
      canSignal: {
        factor: 'NUMBER_VALUE', /* required */
        isBigEndian: true || false, /* required */
        isSigned: true || false, /* required */
        length: 'NUMBER_VALUE', /* required */
        messageId: 'NUMBER_VALUE', /* required */
        offset: 'NUMBER_VALUE', /* required */
        startBit: 'NUMBER_VALUE', /* required */
        name: 'STRING_VALUE'
      },
      obdSignal: {
        byteLength: 'NUMBER_VALUE', /* required */
        offset: 'NUMBER_VALUE', /* required */
        pid: 'NUMBER_VALUE', /* required */
        pidResponseLength: 'NUMBER_VALUE', /* required */
        scaling: 'NUMBER_VALUE', /* required */
        serviceMode: 'NUMBER_VALUE', /* required */
        startByte: 'NUMBER_VALUE', /* required */
        bitMaskLength: 'NUMBER_VALUE',
        bitRightShift: 'NUMBER_VALUE'
      }
    },
    /* more items */
  ],
  signalDecodersToRemove: [
    'STRING_VALUE',
    /* more items */
  ],
  signalDecodersToUpdate: [
    {
      fullyQualifiedName: 'STRING_VALUE', /* required */
      interfaceId: 'STRING_VALUE', /* required */
      type: CAN_SIGNAL | OBD_SIGNAL, /* required */
      canSignal: {
        factor: 'NUMBER_VALUE', /* required */
        isBigEndian: true || false, /* required */
        isSigned: true || false, /* required */
        length: 'NUMBER_VALUE', /* required */
        messageId: 'NUMBER_VALUE', /* required */
        offset: 'NUMBER_VALUE', /* required */
        startBit: 'NUMBER_VALUE', /* required */
        name: 'STRING_VALUE'
      },
      obdSignal: {
        byteLength: 'NUMBER_VALUE', /* required */
        offset: 'NUMBER_VALUE', /* required */
        pid: 'NUMBER_VALUE', /* required */
        pidResponseLength: 'NUMBER_VALUE', /* required */
        scaling: 'NUMBER_VALUE', /* required */
        serviceMode: 'NUMBER_VALUE', /* required */
        startByte: 'NUMBER_VALUE', /* required */
        bitMaskLength: 'NUMBER_VALUE',
        bitRightShift: 'NUMBER_VALUE'
      }
    },
    /* more items */
  ],
  status: ACTIVE | DRAFT
};
iotfleetwise.updateDecoderManifest(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • name — (String)

      The name of the decoder manifest to update.

    • description — (String)

      A brief description of the decoder manifest to update.

    • signalDecodersToAdd — (Array<map>)

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

      • fullyQualifiedNamerequired — (String)

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

      • typerequired — (String)

        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.

        Possible values include:
        • "CAN_SIGNAL"
        • "OBD_SIGNAL"
      • interfaceIdrequired — (String)

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

      • canSignal — (map)

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

        • messageIdrequired — (Integer)

          The ID of the message.

        • isBigEndianrequired — (Boolean)

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

        • isSignedrequired — (Boolean)

          Whether the message data is specified as a signed value.

        • startBitrequired — (Integer)

          Indicates the beginning of the CAN message.

        • offsetrequired — (Float)

          Indicates where data appears in the CAN message.

        • factorrequired — (Float)

          A multiplier used to decode the CAN message.

        • lengthrequired — (Integer)

          How many bytes of data are in the message.

        • name — (String)

          The name of the signal.

      • obdSignal — (map)

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

        • pidResponseLengthrequired — (Integer)

          The length of the requested data.

        • serviceModerequired — (Integer)

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

        • pidrequired — (Integer)

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

        • scalingrequired — (Float)

          A multiplier used to decode the message.

        • offsetrequired — (Float)

          Indicates where data appears in the message.

        • startByterequired — (Integer)

          Indicates the beginning of the message.

        • byteLengthrequired — (Integer)

          The length of a message.

        • bitRightShift — (Integer)

          The number of positions to shift bits in the message.

        • bitMaskLength — (Integer)

          The number of bits to mask in a message.

    • signalDecodersToUpdate — (Array<map>)

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

      • fullyQualifiedNamerequired — (String)

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

      • typerequired — (String)

        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.

        Possible values include:
        • "CAN_SIGNAL"
        • "OBD_SIGNAL"
      • interfaceIdrequired — (String)

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

      • canSignal — (map)

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

        • messageIdrequired — (Integer)

          The ID of the message.

        • isBigEndianrequired — (Boolean)

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

        • isSignedrequired — (Boolean)

          Whether the message data is specified as a signed value.

        • startBitrequired — (Integer)

          Indicates the beginning of the CAN message.

        • offsetrequired — (Float)

          Indicates where data appears in the CAN message.

        • factorrequired — (Float)

          A multiplier used to decode the CAN message.

        • lengthrequired — (Integer)

          How many bytes of data are in the message.

        • name — (String)

          The name of the signal.

      • obdSignal — (map)

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

        • pidResponseLengthrequired — (Integer)

          The length of the requested data.

        • serviceModerequired — (Integer)

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

        • pidrequired — (Integer)

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

        • scalingrequired — (Float)

          A multiplier used to decode the message.

        • offsetrequired — (Float)

          Indicates where data appears in the message.

        • startByterequired — (Integer)

          Indicates the beginning of the message.

        • byteLengthrequired — (Integer)

          The length of a message.

        • bitRightShift — (Integer)

          The number of positions to shift bits in the message.

        • bitMaskLength — (Integer)

          The number of bits to mask in a message.

    • signalDecodersToRemove — (Array<String>)

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

    • networkInterfacesToAdd — (Array<map>)

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

      • interfaceIdrequired — (String)

        The ID of the network interface.

      • typerequired — (String)

        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.

        Possible values include:
        • "CAN_INTERFACE"
        • "OBD_INTERFACE"
      • canInterface — (map)

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

        • namerequired — (String)

          The unique name of the interface.

        • protocolName — (String)

          The name of the communication protocol for the interface.

        • protocolVersion — (String)

          The version of the communication protocol for the interface.

      • obdInterface — (map)

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

        • namerequired — (String)

          The name of the interface.

        • requestMessageIdrequired — (Integer)

          The ID of the message requesting vehicle data.

        • obdStandard — (String)

          The standard OBD II PID.

        • pidRequestIntervalSeconds — (Integer)

          The maximum number message requests per second.

        • dtcRequestIntervalSeconds — (Integer)

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

        • useExtendedIds — (Boolean)

          Whether to use extended IDs in the message.

        • hasTransmissionEcu — (Boolean)

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

    • networkInterfacesToUpdate — (Array<map>)

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

      • interfaceIdrequired — (String)

        The ID of the network interface.

      • typerequired — (String)

        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.

        Possible values include:
        • "CAN_INTERFACE"
        • "OBD_INTERFACE"
      • canInterface — (map)

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

        • namerequired — (String)

          The unique name of the interface.

        • protocolName — (String)

          The name of the communication protocol for the interface.

        • protocolVersion — (String)

          The version of the communication protocol for the interface.

      • obdInterface — (map)

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

        • namerequired — (String)

          The name of the interface.

        • requestMessageIdrequired — (Integer)

          The ID of the message requesting vehicle data.

        • obdStandard — (String)

          The standard OBD II PID.

        • pidRequestIntervalSeconds — (Integer)

          The maximum number message requests per second.

        • dtcRequestIntervalSeconds — (Integer)

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

        • useExtendedIds — (Boolean)

          Whether to use extended IDs in the message.

        • hasTransmissionEcu — (Boolean)

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

    • networkInterfacesToRemove — (Array<String>)

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

    • status — (String)

      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.

      Possible values include:
      • "ACTIVE"
      • "DRAFT"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • name — (String)

        The name of the updated decoder manifest.

      • arn — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateFleet(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the updateFleet operation

var params = {
  fleetId: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE'
};
iotfleetwise.updateFleet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • fleetId — (String)

      The ID of the fleet to update.

    • description — (String)

      An updated description of the fleet.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • id — (String)

        The ID of the updated fleet.

      • arn — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateModelManifest(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the updateModelManifest operation

var params = {
  name: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  nodesToAdd: [
    'STRING_VALUE',
    /* more items */
  ],
  nodesToRemove: [
    'STRING_VALUE',
    /* more items */
  ],
  status: ACTIVE | DRAFT
};
iotfleetwise.updateModelManifest(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • name — (String)

      The name of the vehicle model to update.

    • description — (String)

      A brief description of the vehicle model.

    • nodesToAdd — (Array<String>)

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

    • nodesToRemove — (Array<String>)

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

    • status — (String)

      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.

      Possible values include:
      • "ACTIVE"
      • "DRAFT"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • name — (String)

        The name of the updated vehicle model.

      • arn — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateSignalCatalog(params = {}, callback) ⇒ AWS.Request

Updates a signal catalog.

Service Reference:

Examples:

Calling the updateSignalCatalog operation

var params = {
  name: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  nodesToAdd: [
    {
      actuator: {
        dataType: INT8 | UINT8 | INT16 | UINT16 | INT32 | UINT32 | INT64 | UINT64 | BOOLEAN | FLOAT | DOUBLE | STRING | UNIX_TIMESTAMP | INT8_ARRAY | UINT8_ARRAY | INT16_ARRAY | UINT16_ARRAY | INT32_ARRAY | UINT32_ARRAY | INT64_ARRAY | UINT64_ARRAY | BOOLEAN_ARRAY | FLOAT_ARRAY | DOUBLE_ARRAY | STRING_ARRAY | UNIX_TIMESTAMP_ARRAY | UNKNOWN, /* required */
        fullyQualifiedName: 'STRING_VALUE', /* required */
        allowedValues: [
          'STRING_VALUE',
          /* more items */
        ],
        assignedValue: 'STRING_VALUE',
        description: 'STRING_VALUE',
        max: 'NUMBER_VALUE',
        min: 'NUMBER_VALUE',
        unit: 'STRING_VALUE'
      },
      attribute: {
        dataType: INT8 | UINT8 | INT16 | UINT16 | INT32 | UINT32 | INT64 | UINT64 | BOOLEAN | FLOAT | DOUBLE | STRING | UNIX_TIMESTAMP | INT8_ARRAY | UINT8_ARRAY | INT16_ARRAY | UINT16_ARRAY | INT32_ARRAY | UINT32_ARRAY | INT64_ARRAY | UINT64_ARRAY | BOOLEAN_ARRAY | FLOAT_ARRAY | DOUBLE_ARRAY | STRING_ARRAY | UNIX_TIMESTAMP_ARRAY | UNKNOWN, /* required */
        fullyQualifiedName: 'STRING_VALUE', /* required */
        allowedValues: [
          'STRING_VALUE',
          /* more items */
        ],
        assignedValue: 'STRING_VALUE',
        defaultValue: 'STRING_VALUE',
        description: 'STRING_VALUE',
        max: 'NUMBER_VALUE',
        min: 'NUMBER_VALUE',
        unit: 'STRING_VALUE'
      },
      branch: {
        fullyQualifiedName: 'STRING_VALUE', /* required */
        description: 'STRING_VALUE'
      },
      sensor: {
        dataType: INT8 | UINT8 | INT16 | UINT16 | INT32 | UINT32 | INT64 | UINT64 | BOOLEAN | FLOAT | DOUBLE | STRING | UNIX_TIMESTAMP | INT8_ARRAY | UINT8_ARRAY | INT16_ARRAY | UINT16_ARRAY | INT32_ARRAY | UINT32_ARRAY | INT64_ARRAY | UINT64_ARRAY | BOOLEAN_ARRAY | FLOAT_ARRAY | DOUBLE_ARRAY | STRING_ARRAY | UNIX_TIMESTAMP_ARRAY | UNKNOWN, /* required */
        fullyQualifiedName: 'STRING_VALUE', /* required */
        allowedValues: [
          'STRING_VALUE',
          /* more items */
        ],
        description: 'STRING_VALUE',
        max: 'NUMBER_VALUE',
        min: 'NUMBER_VALUE',
        unit: 'STRING_VALUE'
      }
    },
    /* more items */
  ],
  nodesToRemove: [
    'STRING_VALUE',
    /* more items */
  ],
  nodesToUpdate: [
    {
      actuator: {
        dataType: INT8 | UINT8 | INT16 | UINT16 | INT32 | UINT32 | INT64 | UINT64 | BOOLEAN | FLOAT | DOUBLE | STRING | UNIX_TIMESTAMP | INT8_ARRAY | UINT8_ARRAY | INT16_ARRAY | UINT16_ARRAY | INT32_ARRAY | UINT32_ARRAY | INT64_ARRAY | UINT64_ARRAY | BOOLEAN_ARRAY | FLOAT_ARRAY | DOUBLE_ARRAY | STRING_ARRAY | UNIX_TIMESTAMP_ARRAY | UNKNOWN, /* required */
        fullyQualifiedName: 'STRING_VALUE', /* required */
        allowedValues: [
          'STRING_VALUE',
          /* more items */
        ],
        assignedValue: 'STRING_VALUE',
        description: 'STRING_VALUE',
        max: 'NUMBER_VALUE',
        min: 'NUMBER_VALUE',
        unit: 'STRING_VALUE'
      },
      attribute: {
        dataType: INT8 | UINT8 | INT16 | UINT16 | INT32 | UINT32 | INT64 | UINT64 | BOOLEAN | FLOAT | DOUBLE | STRING | UNIX_TIMESTAMP | INT8_ARRAY | UINT8_ARRAY | INT16_ARRAY | UINT16_ARRAY | INT32_ARRAY | UINT32_ARRAY | INT64_ARRAY | UINT64_ARRAY | BOOLEAN_ARRAY | FLOAT_ARRAY | DOUBLE_ARRAY | STRING_ARRAY | UNIX_TIMESTAMP_ARRAY | UNKNOWN, /* required */
        fullyQualifiedName: 'STRING_VALUE', /* required */
        allowedValues: [
          'STRING_VALUE',
          /* more items */
        ],
        assignedValue: 'STRING_VALUE',
        defaultValue: 'STRING_VALUE',
        description: 'STRING_VALUE',
        max: 'NUMBER_VALUE',
        min: 'NUMBER_VALUE',
        unit: 'STRING_VALUE'
      },
      branch: {
        fullyQualifiedName: 'STRING_VALUE', /* required */
        description: 'STRING_VALUE'
      },
      sensor: {
        dataType: INT8 | UINT8 | INT16 | UINT16 | INT32 | UINT32 | INT64 | UINT64 | BOOLEAN | FLOAT | DOUBLE | STRING | UNIX_TIMESTAMP | INT8_ARRAY | UINT8_ARRAY | INT16_ARRAY | UINT16_ARRAY | INT32_ARRAY | UINT32_ARRAY | INT64_ARRAY | UINT64_ARRAY | BOOLEAN_ARRAY | FLOAT_ARRAY | DOUBLE_ARRAY | STRING_ARRAY | UNIX_TIMESTAMP_ARRAY | UNKNOWN, /* required */
        fullyQualifiedName: 'STRING_VALUE', /* required */
        allowedValues: [
          'STRING_VALUE',
          /* more items */
        ],
        description: 'STRING_VALUE',
        max: 'NUMBER_VALUE',
        min: 'NUMBER_VALUE',
        unit: 'STRING_VALUE'
      }
    },
    /* more items */
  ]
};
iotfleetwise.updateSignalCatalog(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • name — (String)

      The name of the signal catalog to update.

    • description — (String)

      A brief description of the signal catalog to update.

    • nodesToAdd — (Array<map>)

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

      • branch — (map)

        Information about a node specified as a branch.

        Note: A group of signals that are defined in a hierarchical structure.
        • fullyQualifiedNamerequired — (String)

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

        • description — (String)

          A brief description of the branch.

      • sensor — (map)

        An input component that reports the environmental condition of a vehicle.

        Note: You can collect data about fluid levels, temperatures, vibrations, or battery voltage from sensors.
        • fullyQualifiedNamerequired — (String)

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

        • dataTyperequired — (String)

          The specified data type of the sensor.

          Possible values include:
          • "INT8"
          • "UINT8"
          • "INT16"
          • "UINT16"
          • "INT32"
          • "UINT32"
          • "INT64"
          • "UINT64"
          • "BOOLEAN"
          • "FLOAT"
          • "DOUBLE"
          • "STRING"
          • "UNIX_TIMESTAMP"
          • "INT8_ARRAY"
          • "UINT8_ARRAY"
          • "INT16_ARRAY"
          • "UINT16_ARRAY"
          • "INT32_ARRAY"
          • "UINT32_ARRAY"
          • "INT64_ARRAY"
          • "UINT64_ARRAY"
          • "BOOLEAN_ARRAY"
          • "FLOAT_ARRAY"
          • "DOUBLE_ARRAY"
          • "STRING_ARRAY"
          • "UNIX_TIMESTAMP_ARRAY"
          • "UNKNOWN"
        • description — (String)

          A brief description of a sensor.

        • unit — (String)

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

        • allowedValues — (Array<String>)

          A list of possible values a sensor can take.

        • min — (Float)

          The specified possible minimum value of the sensor.

        • max — (Float)

          The specified possible maximum value of the sensor.

      • actuator — (map)

        Information about a node specified as an actuator.

        Note: An actuator is a digital representation of a vehicle device.
        • fullyQualifiedNamerequired — (String)

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

        • dataTyperequired — (String)

          The specified data type of the actuator.

          Possible values include:
          • "INT8"
          • "UINT8"
          • "INT16"
          • "UINT16"
          • "INT32"
          • "UINT32"
          • "INT64"
          • "UINT64"
          • "BOOLEAN"
          • "FLOAT"
          • "DOUBLE"
          • "STRING"
          • "UNIX_TIMESTAMP"
          • "INT8_ARRAY"
          • "UINT8_ARRAY"
          • "INT16_ARRAY"
          • "UINT16_ARRAY"
          • "INT32_ARRAY"
          • "UINT32_ARRAY"
          • "INT64_ARRAY"
          • "UINT64_ARRAY"
          • "BOOLEAN_ARRAY"
          • "FLOAT_ARRAY"
          • "DOUBLE_ARRAY"
          • "STRING_ARRAY"
          • "UNIX_TIMESTAMP_ARRAY"
          • "UNKNOWN"
        • description — (String)

          A brief description of the actuator.

        • unit — (String)

          The scientific unit for the actuator.

        • allowedValues — (Array<String>)

          A list of possible values an actuator can take.

        • min — (Float)

          The specified possible minimum value of an actuator.

        • max — (Float)

          The specified possible maximum value of an actuator.

        • assignedValue — (String)

          A specified value for the actuator.

      • attribute — (map)

        Information about a node specified as an attribute.

        Note: An attribute represents static information about a vehicle.
        • fullyQualifiedNamerequired — (String)

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

        • dataTyperequired — (String)

          The specified data type of the attribute.

          Possible values include:
          • "INT8"
          • "UINT8"
          • "INT16"
          • "UINT16"
          • "INT32"
          • "UINT32"
          • "INT64"
          • "UINT64"
          • "BOOLEAN"
          • "FLOAT"
          • "DOUBLE"
          • "STRING"
          • "UNIX_TIMESTAMP"
          • "INT8_ARRAY"
          • "UINT8_ARRAY"
          • "INT16_ARRAY"
          • "UINT16_ARRAY"
          • "INT32_ARRAY"
          • "UINT32_ARRAY"
          • "INT64_ARRAY"
          • "UINT64_ARRAY"
          • "BOOLEAN_ARRAY"
          • "FLOAT_ARRAY"
          • "DOUBLE_ARRAY"
          • "STRING_ARRAY"
          • "UNIX_TIMESTAMP_ARRAY"
          • "UNKNOWN"
        • description — (String)

          A brief description of the attribute.

        • unit — (String)

          The scientific unit for the attribute.

        • allowedValues — (Array<String>)

          A list of possible values an attribute can be assigned.

        • min — (Float)

          The specified possible minimum value of the attribute.

        • max — (Float)

          The specified possible maximum value of the attribute.

        • assignedValue — (String)

          A specified value for the attribute.

        • defaultValue — (String)

          The default value of the attribute.

    • nodesToUpdate — (Array<map>)

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

      • branch — (map)

        Information about a node specified as a branch.

        Note: A group of signals that are defined in a hierarchical structure.
        • fullyQualifiedNamerequired — (String)

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

        • description — (String)

          A brief description of the branch.

      • sensor — (map)

        An input component that reports the environmental condition of a vehicle.

        Note: You can collect data about fluid levels, temperatures, vibrations, or battery voltage from sensors.
        • fullyQualifiedNamerequired — (String)

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

        • dataTyperequired — (String)

          The specified data type of the sensor.

          Possible values include:
          • "INT8"
          • "UINT8"
          • "INT16"
          • "UINT16"
          • "INT32"
          • "UINT32"
          • "INT64"
          • "UINT64"
          • "BOOLEAN"
          • "FLOAT"
          • "DOUBLE"
          • "STRING"
          • "UNIX_TIMESTAMP"
          • "INT8_ARRAY"
          • "UINT8_ARRAY"
          • "INT16_ARRAY"
          • "UINT16_ARRAY"
          • "INT32_ARRAY"
          • "UINT32_ARRAY"
          • "INT64_ARRAY"
          • "UINT64_ARRAY"
          • "BOOLEAN_ARRAY"
          • "FLOAT_ARRAY"
          • "DOUBLE_ARRAY"
          • "STRING_ARRAY"
          • "UNIX_TIMESTAMP_ARRAY"
          • "UNKNOWN"
        • description — (String)

          A brief description of a sensor.

        • unit — (String)

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

        • allowedValues — (Array<String>)

          A list of possible values a sensor can take.

        • min — (Float)

          The specified possible minimum value of the sensor.

        • max — (Float)

          The specified possible maximum value of the sensor.

      • actuator — (map)

        Information about a node specified as an actuator.

        Note: An actuator is a digital representation of a vehicle device.
        • fullyQualifiedNamerequired — (String)

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

        • dataTyperequired — (String)

          The specified data type of the actuator.

          Possible values include:
          • "INT8"
          • "UINT8"
          • "INT16"
          • "UINT16"
          • "INT32"
          • "UINT32"
          • "INT64"
          • "UINT64"
          • "BOOLEAN"
          • "FLOAT"
          • "DOUBLE"
          • "STRING"
          • "UNIX_TIMESTAMP"
          • "INT8_ARRAY"
          • "UINT8_ARRAY"
          • "INT16_ARRAY"
          • "UINT16_ARRAY"
          • "INT32_ARRAY"
          • "UINT32_ARRAY"
          • "INT64_ARRAY"
          • "UINT64_ARRAY"
          • "BOOLEAN_ARRAY"
          • "FLOAT_ARRAY"
          • "DOUBLE_ARRAY"
          • "STRING_ARRAY"
          • "UNIX_TIMESTAMP_ARRAY"
          • "UNKNOWN"
        • description — (String)

          A brief description of the actuator.

        • unit — (String)

          The scientific unit for the actuator.

        • allowedValues — (Array<String>)

          A list of possible values an actuator can take.

        • min — (Float)

          The specified possible minimum value of an actuator.

        • max — (Float)

          The specified possible maximum value of an actuator.

        • assignedValue — (String)

          A specified value for the actuator.

      • attribute — (map)

        Information about a node specified as an attribute.

        Note: An attribute represents static information about a vehicle.
        • fullyQualifiedNamerequired — (String)

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

        • dataTyperequired — (String)

          The specified data type of the attribute.

          Possible values include:
          • "INT8"
          • "UINT8"
          • "INT16"
          • "UINT16"
          • "INT32"
          • "UINT32"
          • "INT64"
          • "UINT64"
          • "BOOLEAN"
          • "FLOAT"
          • "DOUBLE"
          • "STRING"
          • "UNIX_TIMESTAMP"
          • "INT8_ARRAY"
          • "UINT8_ARRAY"
          • "INT16_ARRAY"
          • "UINT16_ARRAY"
          • "INT32_ARRAY"
          • "UINT32_ARRAY"
          • "INT64_ARRAY"
          • "UINT64_ARRAY"
          • "BOOLEAN_ARRAY"
          • "FLOAT_ARRAY"
          • "DOUBLE_ARRAY"
          • "STRING_ARRAY"
          • "UNIX_TIMESTAMP_ARRAY"
          • "UNKNOWN"
        • description — (String)

          A brief description of the attribute.

        • unit — (String)

          The scientific unit for the attribute.

        • allowedValues — (Array<String>)

          A list of possible values an attribute can be assigned.

        • min — (Float)

          The specified possible minimum value of the attribute.

        • max — (Float)

          The specified possible maximum value of the attribute.

        • assignedValue — (String)

          A specified value for the attribute.

        • defaultValue — (String)

          The default value of the attribute.

    • nodesToRemove — (Array<String>)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • name — (String)

        The name of the updated signal catalog.

      • arn — (String)

        The ARN of the updated signal catalog.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateVehicle(params = {}, callback) ⇒ AWS.Request

Updates a vehicle.

Service Reference:

Examples:

Calling the updateVehicle operation

var params = {
  vehicleName: 'STRING_VALUE', /* required */
  attributeUpdateMode: Overwrite | Merge,
  attributes: {
    '<attributeName>': 'STRING_VALUE',
    /* '<attributeName>': ... */
  },
  decoderManifestArn: 'STRING_VALUE',
  modelManifestArn: 'STRING_VALUE'
};
iotfleetwise.updateVehicle(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • vehicleName — (String)

      The unique ID of the vehicle to update.

    • modelManifestArn — (String)

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

    • decoderManifestArn — (String)

      The ARN of the decoder manifest associated with this vehicle.

    • attributes — (map<String>)

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

      "engineType" : "1.3 L R2"

    • attributeUpdateMode — (String)

      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.

      Possible values include:
      • "Overwrite"
      • "Merge"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • vehicleName — (String)

        The ID of the updated vehicle.

      • arn — (String)

        The ARN of the updated vehicle.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

waitFor(state, params = {}, callback) ⇒ AWS.Request

Waits for a given IoTFleetWise resource. The final callback or 'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.

Parameters:

  • state (String)

    the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.

  • params (map) (defaults to: {})

    a list of parameters for the given state. See each waiter resource state for required parameters.

Callback (callback):

  • function(err, data) { ... }

    Callback containing error and data information. See the respective resource state for the expected error or data information.

    If the waiter times out its requests, it will return a ResourceNotReady error.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.