Class: AWS.IoTFleetWise

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.

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.

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.

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.

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.

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.

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.

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.

      • name — required — (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.

        • periodMs — required — (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.

        • expression — required — (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.

    • dataDestinationConfigs — (Array<map>)

      The destination where the campaign sends data. You can choose to send data to be stored in Amazon S3 or Amazon Timestream.

      Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics.

      You can use Amazon Timestream to access and analyze time series data, and Timestream to query vehicle data so that you can identify trends and patterns.

      • s3Config — (map)

        The Amazon S3 bucket where the Amazon Web Services IoT FleetWise campaign sends data.

        • bucketArn — required — (String)

          The Amazon Resource Name (ARN) of the Amazon S3 bucket.

        • dataFormat — (String)

          Specify the format that files are saved in the Amazon S3 bucket. You can save files in an Apache Parquet or JSON format.

          • Parquet - Store data in a columnar storage file format. Parquet is optimal for fast data retrieval and can reduce costs. This option is selected by default.

          • JSON - Store data in a standard text-based JSON file format.

          Possible values include:
          • "JSON"
          • "PARQUET"
        • storageCompressionFormat — (String)

          By default, stored data is compressed as a .gzip file. Compressed files have a reduced file size, which can optimize the cost of data storage.

          Possible values include:
          • "NONE"
          • "GZIP"
        • prefix — (String)

          (Optional) Enter an S3 bucket prefix. The prefix is the string of characters after the bucket name and before the object name. You can use the prefix to organize data stored in Amazon S3 buckets. For more information, see Organizing objects using prefixes in the Amazon Simple Storage Service User Guide.

          By default, Amazon Web Services IoT FleetWise sets the prefix processed-data/year=YY/month=MM/date=DD/hour=HH/ (in UTC) to data it delivers to Amazon S3. You can enter a prefix to append it to this default prefix. For example, if you enter the prefix vehicles, the prefix will be vehicles/processed-data/year=YY/month=MM/date=DD/hour=HH/.

      • timestreamConfig — (map)

        The Amazon Timestream table where the campaign sends data.

        • timestreamTableArn — required — (String)

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

        • executionRoleArn — required — (String)

          The Amazon Resource Name (ARN) of the task execution role that grants Amazon Web Services IoT FleetWise permission to deliver data to the Amazon Timestream table.

Returns:

• (AWS.Request) —

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

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"
      • "INVALID"
      • "VALIDATING"
    • 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).

    • message — (String)

      The detailed message for the decoder manifest. When a decoder manifest is in an INVALID status, the message contains detailed reason and help information.

Returns:

• (AWS.Request) —

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

var params = {
};
iotfleetwise.getEncryptionConfiguration(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:

    • kmsKeyId — (String)

      The ID of the KMS key that is used for encryption.

    • encryptionStatus — (String)

      The encryption status.

      Possible values include:
      • "PENDING"
      • "SUCCESS"
      • "FAILURE"
    • encryptionType — (String)

      The type of encryption. Set to KMS_BASED_ENCRYPTION to use a KMS key that you own and manage. Set to FLEETWISE_DEFAULT_ENCRYPTION to use an Amazon Web Services managed key that is owned by the Amazon Web Services IoT FleetWise service account.

      Possible values include:
      • "KMS_BASED_ENCRYPTION"
      • "FLEETWISE_DEFAULT_ENCRYPTION"
    • errorMessage — (String)

      The error message that describes why encryption settings couldn't be configured, if applicable.

    • creationTime — (Date)

      The time when encryption was configured in seconds since epoch (January 1, 1970 at midnight UTC time).

    • lastModificationTime — (Date)

      The time when encryption 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.

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.

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.

      • logType — required — (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.

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"
      • "INVALID"
      • "VALIDATING"
    • 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.

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.

      • timestreamDatabaseName — required — (String)

        The name of the Timestream database.

      • timestreamTableName — required — (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.

      • registrationStatus — required — (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.

      • roleArn — required — (String)

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

      • registrationStatus — required — (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.

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.

      • totalStructs — (Integer)

        The total structure for the node.

      • totalProperties — (Integer)

        The total properties for the node.

    • 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.

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.

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.

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.

      • networkInterface — required — (String)

        Contains information about a network interface.

      • canDbcFiles — required — (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. The DBC file can be a maximum size of 200 MB.

      • 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.

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.

    • Key — required — (String)

      The tag's key.

    • Value — required — (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.

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"
      • creationTime — required — (Date)

        The time the campaign was created.

      • lastModificationTime — required — (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.

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.

      • interfaceId — required — (String)

        The ID of the network interface.

      • type — required — (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"
        • "VEHICLE_MIDDLEWARE"
      • canInterface — (map)

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

        • name — required — (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.

        • name — required — (String)

          The name of the interface.

        • requestMessageId — required — (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).

      • vehicleMiddleware — (map)

        The vehicle middleware defined as a type of network interface. Examples of vehicle middleware include ROS2 and SOME/IP.

        • name — required — (String)

          The name of the vehicle middleware.

        • protocolName — required — (String)

          The protocol name of the vehicle middleware.

          Possible values include:
          • "ROS_2"
    • 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.

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"
        • "INVALID"
        • "VALIDATING"
      • creationTime — required — (Date)

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

      • lastModificationTime — required — (Date)

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

      • message — (String)

        The detailed message for the decoder manifest. When a decoder manifest is in an INVALID status, the message contains detailed reason and help information.

    • 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.

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.

      • fullyQualifiedName — required — (String)

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

      • type — required — (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"
        • "MESSAGE_SIGNAL"
      • interfaceId — required — (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.

        • messageId — required — (Integer)

          The ID of the message.

        • isBigEndian — required — (Boolean)

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

        • isSigned — required — (Boolean)

          Whether the message data is specified as a signed value.

        • startBit — required — (Integer)

          Indicates the beginning of the CAN signal. This should always be the least significant bit (LSB).

          This value might be different from the value in a DBC file. For little endian signals, startBit is the same value as in the DBC file. For big endian signals in a DBC file, the start bit is the most significant bit (MSB). You will have to calculate the LSB instead and pass it as the startBit.

        • offset — required — (Float)

          The offset used to calculate the signal value. Combined with factor, the calculation is value = raw_value * factor + offset.

        • factor — required — (Float)

          A multiplier used to decode the CAN message.

        • length — required — (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.

        • pidResponseLength — required — (Integer)

          The length of the requested data.

        • serviceMode — required — (Integer)

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

        • pid — required — (Integer)

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

        • scaling — required — (Float)

          A multiplier used to decode the message.

        • offset — required — (Float)

          The offset used to calculate the signal value. Combined with scaling, the calculation is value = raw_value * scaling + offset.

        • startByte — required — (Integer)

          Indicates the beginning of the message.

        • byteLength — required — (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.

      • messageSignal — (map)

        The decoding information for a specific message which supports higher order data types.

        • topicName — required — (String)

          The topic name for the message signal. It corresponds to topics in ROS 2.

        • structuredMessage — required — (map)

          The structured message for the message signal. It can be defined with either a primitiveMessageDefinition, structuredMessageListDefinition, or structuredMessageDefinition recursively.

          • primitiveMessageDefinition — (map)

            Represents a primitive type node of the complex data structure.

            • ros2PrimitiveMessageDefinition — (map)

              Information about a PrimitiveMessage using a ROS 2 compliant primitive type message of the complex data structure.

              • primitiveType — required — (String)

                The primitive type (integer, floating point, boolean, etc.) for the ROS 2 primitive message definition.

                Possible values include:
                • "BOOL"
                • "BYTE"
                • "CHAR"
                • "FLOAT32"
                • "FLOAT64"
                • "INT8"
                • "UINT8"
                • "INT16"
                • "UINT16"
                • "INT32"
                • "UINT32"
                • "INT64"
                • "UINT64"
                • "STRING"
                • "WSTRING"
              • offset — (Float)

                The offset used to calculate the signal value. Combined with scaling, the calculation is value = raw_value * scaling + offset.

              • scaling — (Float)

                A multiplier used to decode the message.

              • upperBound — (Integer)

                An optional attribute specifying the upper bound for STRING and WSTRING.

          • structuredMessageListDefinition — (map)

            Represents a list type node of the complex data structure.

            • name — required — (String)

              The name of the structured message list definition.

            • listType — required — (String)

              The type of list of the structured message list definition.

              Possible values include:
              • "FIXED_CAPACITY"
              • "DYNAMIC_UNBOUNDED_CAPACITY"
              • "DYNAMIC_BOUNDED_CAPACITY"
            • capacity — (Integer)

              The capacity of the structured message list definition when the list type is FIXED_CAPACITY or DYNAMIC_BOUNDED_CAPACITY.

          • structuredMessageDefinition — (Array<map>)

            Represents a struct type node of the complex data structure.

            • fieldName — required — (String)

              The field name of the structured message. It determines how a data value is referenced in the target language.

    • 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.

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.

      • id — required — (String)

        The unique ID of the fleet.

      • arn — required — (String)

        The Amazon Resource Name (ARN) of the fleet.

      • description — (String)

        A brief description of the fleet.

      • signalCatalogArn — required — (String)

        The ARN of the signal catalog associated with the fleet.

      • creationTime — required — (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.

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.

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.
        • fullyQualifiedName — required — (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.

        • deprecationMessage — (String)

          The deprecation message for the node or the branch that was moved or deleted.

        • comment — (String)

          A comment in addition to the description.

      • 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.
        • fullyQualifiedName — required — (String)

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

        • dataType — required — (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"
          • "STRUCT"
          • "STRUCT_ARRAY"
        • 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.

        • deprecationMessage — (String)

          The deprecation message for the node or the branch that was moved or deleted.

        • comment — (String)

          A comment in addition to the description.

        • structFullyQualifiedName — (String)

          The fully qualified name of the struct node for a sensor if the data type of the actuator is Struct or StructArray. For example, the struct fully qualified name of a sensor might be Vehicle.ADAS.CameraStruct.

      • actuator — (map)

        Information about a node specified as an actuator.

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

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

        • dataType — required — (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"
          • "STRUCT"
          • "STRUCT_ARRAY"
        • 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.

        • deprecationMessage — (String)

          The deprecation message for the node or the branch that was moved or deleted.

        • comment — (String)

          A comment in addition to the description.

        • structFullyQualifiedName — (String)

          The fully qualified name of the struct node for the actuator if the data type of the actuator is Struct or StructArray. For example, the struct fully qualified name of an actuator might be Vehicle.Door.LockStruct.

      • attribute — (map)

        Information about a node specified as an attribute.

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

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

        • dataType — required — (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"
          • "STRUCT"
          • "STRUCT_ARRAY"
        • 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.

        • deprecationMessage — (String)

          The deprecation message for the node or the branch that was moved or deleted.

        • comment — (String)

          A comment in addition to the description.

      • struct — (map)

        Represents a complex or higher-order data structure.

        • fullyQualifiedName — required — (String)

          The fully qualified name of the custom structure. For example, the fully qualified name of a custom structure might be ComplexDataTypes.VehicleDataTypes.SVMCamera.

        • description — (String)

          A brief description of the custom structure.

        • deprecationMessage — (String)

          The deprecation message for the node or the branch that was moved or deleted.

        • comment — (String)

          A comment in addition to the description.

      • property — (map)

        Represents a member of the complex data structure. The datatype of the property can be either primitive or another struct.

        • fullyQualifiedName — required — (String)

          The fully qualified name of the custom property. For example, the fully qualified name of a custom property might be ComplexDataTypes.VehicleDataTypes.SVMCamera.FPS.

        • dataType — required — (String)

          The data type for the custom property.

          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"
          • "STRUCT"
          • "STRUCT_ARRAY"
        • dataEncoding — (String)

          Indicates whether the property is binary data.

          Possible values include:
          • "BINARY"
          • "TYPED"
        • description — (String)

          A brief description of the custom property.

        • deprecationMessage — (String)

          The deprecation message for the node or the branch that was moved or deleted.

        • comment — (String)

          A comment in addition to the description.

        • structFullyQualifiedName — (String)

          The fully qualified name of the struct node for the custom property if the data type of the custom property is Struct or StructArray.

    • 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.

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"
        • "INVALID"
        • "VALIDATING"
      • creationTime — required — (Date)

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

      • lastModificationTime — required — (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.

var params = {
  name: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  signalNodeType: SENSOR | ACTUATOR | ATTRIBUTE | BRANCH | CUSTOM_STRUCT | CUSTOM_PROPERTY
};
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.

  • signalNodeType — (String)

    The type of node in the signal catalog.

    Possible values include:
    • "SENSOR"
    • "ACTUATOR"
    • "ATTRIBUTE"
    • "BRANCH"
    • "CUSTOM_STRUCT"
    • "CUSTOM_PROPERTY"

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.
        • fullyQualifiedName — required — (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.

        • deprecationMessage — (String)

          The deprecation message for the node or the branch that was moved or deleted.

        • comment — (String)

          A comment in addition to the description.

      • 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.
        • fullyQualifiedName — required — (String)

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

        • dataType — required — (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"
          • "STRUCT"
          • "STRUCT_ARRAY"
        • 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.

        • deprecationMessage — (String)

          The deprecation message for the node or the branch that was moved or deleted.

        • comment — (String)

          A comment in addition to the description.

        • structFullyQualifiedName — (String)

          The fully qualified name of the struct node for a sensor if the data type of the actuator is Struct or StructArray. For example, the struct fully qualified name of a sensor might be Vehicle.ADAS.CameraStruct.

      • actuator — (map)

        Information about a node specified as an actuator.

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

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

        • dataType — required — (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"
          • "STRUCT"
          • "STRUCT_ARRAY"
        • 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.

        • deprecationMessage — (String)

          The deprecation message for the node or the branch that was moved or deleted.

        • comment — (String)

          A comment in addition to the description.

        • structFullyQualifiedName — (String)

          The fully qualified name of the struct node for the actuator if the data type of the actuator is Struct or StructArray. For example, the struct fully qualified name of an actuator might be Vehicle.Door.LockStruct.

      • attribute — (map)

        Information about a node specified as an attribute.

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

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

        • dataType — required — (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"
          • "STRUCT"
          • "STRUCT_ARRAY"
        • 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.

        • deprecationMessage — (String)

          The deprecation message for the node or the branch that was moved or deleted.

        • comment — (String)

          A comment in addition to the description.

      • struct — (map)

        Represents a complex or higher-order data structure.

        • fullyQualifiedName — required — (String)

          The fully qualified name of the custom structure. For example, the fully qualified name of a custom structure might be ComplexDataTypes.VehicleDataTypes.SVMCamera.

        • description — (String)

          A brief description of the custom structure.

        • deprecationMessage — (String)

          The deprecation message for the node or the branch that was moved or deleted.

        • comment — (String)

          A comment in addition to the description.

      • property — (map)

        Represents a member of the complex data structure. The datatype of the property can be either primitive or another struct.

        • fullyQualifiedName — required — (String)

          The fully qualified name of the custom property. For example, the fully qualified name of a custom property might be ComplexDataTypes.VehicleDataTypes.SVMCamera.FPS.

        • dataType — required — (String)

          The data type for the custom property.

          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"
          • "STRUCT"
          • "STRUCT_ARRAY"
        • dataEncoding — (String)

          Indicates whether the property is binary data.

          Possible values include:
          • "BINARY"
          • "TYPED"
        • description — (String)

          A brief description of the custom property.

        • deprecationMessage — (String)

          The deprecation message for the node or the branch that was moved or deleted.

        • comment — (String)

          A comment in addition to the description.

        • structFullyQualifiedName — (String)

          The fully qualified name of the struct node for the custom property if the data type of the custom property is Struct or StructArray.

    • nextToken — (String)

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