Class: AWS.IoTSiteWise

Inherits:
AWS.Service show all
Identifier:
iotsitewise
API Version:
2019-12-02
Defined in:
(unknown)

Overview

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

Service Description

Welcome to the AWS IoT SiteWise API Reference. AWS IoT SiteWise is an AWS service that connects Industrial Internet of Things (IIoT) devices to the power of the AWS Cloud. For more information, see the AWS IoT SiteWise User Guide. For information about AWS IoT SiteWise quotas, see Quotas in the AWS IoT SiteWise User Guide.

Sending a Request Using IoTSiteWise

var iotsitewise = new AWS.IoTSiteWise();
iotsitewise.associateAssets(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 IoTSiteWise object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var iotsitewise = new AWS.IoTSiteWise({apiVersion: '2019-12-02'});

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

AWS.config.apiVersions = {
  iotsitewise: '2019-12-02',
  // other service API versions
};

var iotsitewise = new AWS.IoTSiteWise();

Version:

  • 2019-12-02

Waiter Resource States

This service supports a list of resource states that can be polled using the waitFor() method. The resource states are:

assetModelNotExists, assetModelActive, assetNotExists, assetActive, portalNotExists, portalActive

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.IoTSiteWise(options = {}) ⇒ Object

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

Examples:

Constructing a IoTSiteWise object

var iotsitewise = new AWS.IoTSiteWise({apiVersion: '2019-12-02'});

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)

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

  • 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.IoTSiteWise.region for more information.

  • maxRetries (Integer)

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

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.IoTSiteWise.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.
  • 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'.

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

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

Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's model. For more information, see Associating assets in the AWS IoT SiteWise User Guide.

Service Reference:

Examples:

Calling the associateAssets operation

var params = {
  assetId: 'STRING_VALUE', /* required */
  childAssetId: 'STRING_VALUE', /* required */
  hierarchyId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
iotsitewise.associateAssets(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: {})
    • assetId — (String)

      The ID of the parent asset.

    • hierarchyId — (String)

      The ID of a hierarchy in the parent asset's model. Hierarchies allow different groupings of assets to be formed that all come from the same asset model. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide.

    • childAssetId — (String)

      The ID of the child asset to be associated.

    • clientToken — (String)

      A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

      If a token is not provided, the SDK will use a version 4 UUID.

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.

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

Associates a group (batch) of assets with an AWS IoT SiteWise Monitor project.

Service Reference:

Examples:

Calling the batchAssociateProjectAssets operation

var params = {
  assetIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  projectId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
iotsitewise.batchAssociateProjectAssets(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: {})
    • projectId — (String)

      The ID of the project to which to associate the assets.

    • assetIds — (Array<String>)

      The IDs of the assets to be associated to the project.

    • clientToken — (String)

      A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

      If a token is not provided, the SDK will use a version 4 UUID.

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:

      • errors — (Array<map>)

        A list of associated error information, if any.

        • assetIdrequired — (String)

          The ID of the asset.

        • coderequired — (String)

          The error code.

          Possible values include:
          • "INTERNAL_FAILURE"
        • messagerequired — (String)

          The error message.

Returns:

  • (AWS.Request)

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

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

Disassociates a group (batch) of assets from an AWS IoT SiteWise Monitor project.

Service Reference:

Examples:

Calling the batchDisassociateProjectAssets operation

var params = {
  assetIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  projectId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
iotsitewise.batchDisassociateProjectAssets(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: {})
    • projectId — (String)

      The ID of the project from which to disassociate the assets.

    • assetIds — (Array<String>)

      The IDs of the assets to be disassociated from the project.

    • clientToken — (String)

      A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

      If a token is not provided, the SDK will use a version 4 UUID.

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:

      • errors — (Array<map>)

        A list of associated error information, if any.

        • assetIdrequired — (String)

          The ID of the asset.

        • coderequired — (String)

          The error code.

          Possible values include:
          • "INTERNAL_FAILURE"
        • messagerequired — (String)

          The error message.

Returns:

  • (AWS.Request)

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

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

Sends a list of asset property values to AWS IoT SiteWise. Each value is a timestamp-quality-value (TQV) data point. For more information, see Ingesting data using the API in the AWS IoT SiteWise User Guide.

To identify an asset property, you must specify one of the following:

  • The assetId and propertyId of an asset property.

  • A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.

With respect to Unix epoch time, AWS IoT SiteWise accepts only TQVs that have a timestamp of no more than 15 minutes in the past and no more than 5 minutes in the future. AWS IoT SiteWise rejects timestamps outside of the inclusive range of [-15, +5] minutes and returns a TimestampOutOfRangeException error.

For each asset property, AWS IoT SiteWise overwrites TQVs with duplicate timestamps unless the newer TQV has a different quality. For example, if you store a TQV {T1, GOOD, V1}, then storing {T1, GOOD, V2} replaces the existing TQV.

AWS IoT SiteWise authorizes access to each BatchPutAssetPropertyValue entry individually. For more information, see BatchPutAssetPropertyValue authorization in the AWS IoT SiteWise User Guide.

Service Reference:

Examples:

Calling the batchPutAssetPropertyValue operation

var params = {
  entries: [ /* required */
    {
      entryId: 'STRING_VALUE', /* required */
      propertyValues: [ /* required */
        {
          timestamp: { /* required */
            timeInSeconds: 'NUMBER_VALUE', /* required */
            offsetInNanos: 'NUMBER_VALUE'
          },
          value: { /* required */
            booleanValue: true || false,
            doubleValue: 'NUMBER_VALUE',
            integerValue: 'NUMBER_VALUE',
            stringValue: 'STRING_VALUE'
          },
          quality: GOOD | BAD | UNCERTAIN
        },
        /* more items */
      ],
      assetId: 'STRING_VALUE',
      propertyAlias: 'STRING_VALUE',
      propertyId: 'STRING_VALUE'
    },
    /* more items */
  ]
};
iotsitewise.batchPutAssetPropertyValue(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: {})
    • entries — (Array<map>)

      The list of asset property value entries for the batch put request. You can specify up to 10 entries per request.

      • entryIdrequired — (String)

        The user specified ID for the entry. You can use this ID to identify which entries failed.

      • assetId — (String)

        The ID of the asset to update.

      • propertyId — (String)

        The ID of the asset property for this entry.

      • propertyAlias — (String)

        The property alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the AWS IoT SiteWise User Guide.

      • propertyValuesrequired — (Array<map>)

        The list of property values to upload. You can specify up to 10 propertyValues array elements.

        • valuerequired — (map)

          The value of the asset property (see Variant).

          • stringValue — (String)

            Asset property data of type string (sequence of characters).

          • integerValue — (Integer)

            Asset property data of type integer (whole number).

          • doubleValue — (Float)

            Asset property data of type double (floating point number).

          • booleanValue — (Boolean)

            Asset property data of type Boolean (true or false).

        • timestamprequired — (map)

          The timestamp of the asset property value.

          • timeInSecondsrequired — (Integer)

            The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.

          • offsetInNanos — (Integer)

            The nanosecond offset from timeInSeconds.

        • quality — (String)

          The quality of the asset property value.

          Possible values include:
          • "GOOD"
          • "BAD"
          • "UNCERTAIN"

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:

      • errorEntries — (Array<map>)

        A list of the errors (if any) associated with the batch put request. Each error entry contains the entryId of the entry that failed.

        • entryIdrequired — (String)

          The ID of the failed entry.

        • errorsrequired — (Array<map>)

          The list of update property value errors.

          • errorCoderequired — (String)

            The error code.

            Possible values include:
            • "ResourceNotFoundException"
            • "InvalidRequestException"
            • "InternalFailureException"
            • "ServiceUnavailableException"
            • "ThrottlingException"
            • "LimitExceededException"
            • "ConflictingOperationException"
            • "TimestampOutOfRangeException"
            • "AccessDeniedException"
          • errorMessagerequired — (String)

            The associated error message.

          • timestampsrequired — (Array<map>)

            A list of timestamps for each error, if any.

            • timeInSecondsrequired — (Integer)

              The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.

            • offsetInNanos — (Integer)

              The nanosecond offset from timeInSeconds.

Returns:

  • (AWS.Request)

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

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

Creates an access policy that grants the specified AWS Single Sign-On user or group access to the specified AWS IoT SiteWise Monitor portal or project resource.

Service Reference:

Examples:

Calling the createAccessPolicy operation

var params = {
  accessPolicyIdentity: { /* required */
    group: {
      id: 'STRING_VALUE' /* required */
    },
    user: {
      id: 'STRING_VALUE' /* required */
    }
  },
  accessPolicyPermission: ADMINISTRATOR | VIEWER, /* required */
  accessPolicyResource: { /* required */
    portal: {
      id: 'STRING_VALUE' /* required */
    },
    project: {
      id: 'STRING_VALUE' /* required */
    }
  },
  clientToken: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
iotsitewise.createAccessPolicy(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: {})
    • accessPolicyIdentity — (map)

      The identity for this access policy. Choose either a user or a group but not both.

      • user — (map)

        A user identity.

        • idrequired — (String)

          The AWS SSO ID of the user.

      • group — (map)

        A group identity.

        • idrequired — (String)

          The AWS SSO ID of the group.

    • accessPolicyResource — (map)

      The AWS IoT SiteWise Monitor resource for this access policy. Choose either portal or project but not both.

      • portal — (map)

        A portal resource.

        • idrequired — (String)

          The ID of the portal.

      • project — (map)

        A project resource.

        • idrequired — (String)

          The ID of the project.

    • accessPolicyPermission — (String)

      The permission level for this access policy. Note that a project ADMINISTRATOR is also known as a project owner.

      Possible values include:
      • "ADMINISTRATOR"
      • "VIEWER"
    • clientToken — (String)

      A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

      If a token is not provided, the SDK will use a version 4 UUID.
    • tags — (map<String>)

      A list of key-value pairs that contain metadata for the access policy. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.

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:

      • accessPolicyId — (String)

        The ID of the access policy.

      • accessPolicyArn — (String)

        The ARN of the access policy, which has the following format.

        arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId}

Returns:

  • (AWS.Request)

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

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

Creates an asset from an existing asset model. For more information, see Creating assets in the AWS IoT SiteWise User Guide.

Service Reference:

Examples:

Calling the createAsset operation

var params = {
  assetModelId: 'STRING_VALUE', /* required */
  assetName: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
iotsitewise.createAsset(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: {})
    • assetName — (String)

      A unique, friendly name for the asset.

    • assetModelId — (String)

      The ID of the asset model from which to create the asset.

    • clientToken — (String)

      A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

      If a token is not provided, the SDK will use a version 4 UUID.
    • tags — (map<String>)

      A list of key-value pairs that contain metadata for the asset. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.

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:

      • assetId — (String)

        The ID of the asset. This ID uniquely identifies the asset within AWS IoT SiteWise and can be used with other AWS IoT SiteWise APIs.

      • assetArn — (String)

        The ARN of the asset, which has the following format.

        arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}

      • assetStatus — (map)

        The status of the asset, which contains a state (CREATING after successfully calling this operation) and any error message.

        • staterequired — (String)

          The current status of the asset.

          Possible values include:
          • "CREATING"
          • "ACTIVE"
          • "UPDATING"
          • "DELETING"
          • "FAILED"
        • error — (map)

          Contains associated error information, if any.

          • coderequired — (String)

            The error code.

            Possible values include:
            • "VALIDATION_ERROR"
            • "INTERNAL_FAILURE"
          • messagerequired — (String)

            The error message.

Returns:

  • (AWS.Request)

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

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

Creates an asset model from specified property and hierarchy definitions. You create assets from asset models. With asset models, you can easily create assets of the same type that have standardized definitions. Each asset created from a model inherits the asset model's property and hierarchy definitions. For more information, see Defining asset models in the AWS IoT SiteWise User Guide.

Service Reference:

Examples:

Calling the createAssetModel operation

var params = {
  assetModelName: 'STRING_VALUE', /* required */
  assetModelDescription: 'STRING_VALUE',
  assetModelHierarchies: [
    {
      childAssetModelId: 'STRING_VALUE', /* required */
      name: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  assetModelProperties: [
    {
      dataType: STRING | INTEGER | DOUBLE | BOOLEAN, /* required */
      name: 'STRING_VALUE', /* required */
      type: { /* required */
        attribute: {
          defaultValue: 'STRING_VALUE'
        },
        measurement: {
        },
        metric: {
          expression: 'STRING_VALUE', /* required */
          variables: [ /* required */
            {
              name: 'STRING_VALUE', /* required */
              value: { /* required */
                propertyId: 'STRING_VALUE', /* required */
                hierarchyId: 'STRING_VALUE'
              }
            },
            /* more items */
          ],
          window: { /* required */
            tumbling: {
              interval: 'STRING_VALUE' /* required */
            }
          }
        },
        transform: {
          expression: 'STRING_VALUE', /* required */
          variables: [ /* required */
            {
              name: 'STRING_VALUE', /* required */
              value: { /* required */
                propertyId: 'STRING_VALUE', /* required */
                hierarchyId: 'STRING_VALUE'
              }
            },
            /* more items */
          ]
        }
      },
      unit: 'STRING_VALUE'
    },
    /* more items */
  ],
  clientToken: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
iotsitewise.createAssetModel(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: {})
    • assetModelName — (String)

      A unique, friendly name for the asset model.

    • assetModelDescription — (String)

      A description for the asset model.

    • assetModelProperties — (Array<map>)

      The property definitions of the asset model. For more information, see Asset properties in the AWS IoT SiteWise User Guide.

      You can specify up to 200 properties per asset model. For more information, see Quotas in the AWS IoT SiteWise User Guide.

      • namerequired — (String)

        The name of the property definition.

      • dataTyperequired — (String)

        The data type of the property definition.

        Possible values include:
        • "STRING"
        • "INTEGER"
        • "DOUBLE"
        • "BOOLEAN"
      • unit — (String)

        The unit of the property definition, such as Newtons or RPM.

      • typerequired — (map)

        The property definition type (see PropertyType). You can only specify one type in a property definition.

        • attribute — (map)

          Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an IIoT wind turbine.

          • defaultValue — (String)

            The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see Updating attribute values in the AWS IoT SiteWise User Guide.

        • measurement — (map)

          Specifies an asset measurement property. A measurement represents a device's raw sensor data stream, such as timestamped temperature values or timestamped power values.

        • transform — (map)

          Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.

          • expressionrequired — (String)

            The mathematical expression that defines the transformation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.

            For more information, see Quotas in the AWS IoT SiteWise User Guide.

          • variablesrequired — (Array<map>)

            The list of variables used in the expression.

            • namerequired — (String)

              The friendly name of the variable to be used in the expression.

            • valuerequired — (map)

              The variable that identifies an asset property from which to use values.

              • propertyIdrequired — (String)

                The ID of the property to use as the variable. You can use the property name if it's from the same asset model.

              • hierarchyId — (String)

                The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID.

                You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide.

        • metric — (map)

          Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.

          • expressionrequired — (String)

            The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.

            For more information, see Quotas in the AWS IoT SiteWise User Guide.

          • variablesrequired — (Array<map>)

            The list of variables used in the expression.

            • namerequired — (String)

              The friendly name of the variable to be used in the expression.

            • valuerequired — (map)

              The variable that identifies an asset property from which to use values.

              • propertyIdrequired — (String)

                The ID of the property to use as the variable. You can use the property name if it's from the same asset model.

              • hierarchyId — (String)

                The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID.

                You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide.

          • windowrequired — (map)

            The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression. AWS IoT SiteWise computes one data point per window.

            • tumbling — (map)

              The tumbling time interval window.

              • intervalrequired — (String)

                The time interval for the tumbling window. Note that w represents weeks, d represents days, h represents hours, and m represents minutes. AWS IoT SiteWise computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval at the end of each hour, and so on.

                When AWS IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. AWS IoT SiteWise places the computed data point at the end of the interval.

    • assetModelHierarchies — (Array<map>)

      The hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide.

      You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the AWS IoT SiteWise User Guide.

      • namerequired — (String)

        The name of the asset model hierarchy definition (as specified in CreateAssetModel or UpdateAssetModel).

      • childAssetModelIdrequired — (String)

        The ID of an asset model for this hierarchy.

    • clientToken — (String)

      A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

      If a token is not provided, the SDK will use a version 4 UUID.
    • tags — (map<String>)

      A list of key-value pairs that contain metadata for the asset model. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.

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:

      • assetModelId — (String)

        The ID of the asset model. You can use this ID when you call other AWS IoT SiteWise APIs.

      • assetModelArn — (String)

        The ARN of the asset model, which has the following format.

        arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}

      • assetModelStatus — (map)

        The status of the asset model, which contains a state (CREATING after successfully calling this operation) and any error message.

        • staterequired — (String)

          The current state of the asset model.

          Possible values include:
          • "CREATING"
          • "ACTIVE"
          • "UPDATING"
          • "PROPAGATING"
          • "DELETING"
          • "FAILED"
        • error — (map)

          Contains associated error information, if any.

          • coderequired — (String)

            The error code.

            Possible values include:
            • "VALIDATION_ERROR"
            • "INTERNAL_FAILURE"
          • messagerequired — (String)

            The error message.

Returns:

  • (AWS.Request)

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

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

Creates a dashboard in an AWS IoT SiteWise Monitor project.

Service Reference:

Examples:

Calling the createDashboard operation

var params = {
  dashboardDefinition: 'STRING_VALUE', /* required */
  dashboardName: 'STRING_VALUE', /* required */
  projectId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  dashboardDescription: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
iotsitewise.createDashboard(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: {})
    • projectId — (String)

      The ID of the project in which to create the dashboard.

    • dashboardName — (String)

      A friendly name for the dashboard.

    • dashboardDescription — (String)

      A description for the dashboard.

    • dashboardDefinition — (String)

      The dashboard definition specified in a JSON literal. For detailed information, see Creating dashboards (CLI) in the AWS IoT SiteWise User Guide.

    • clientToken — (String)

      A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

      If a token is not provided, the SDK will use a version 4 UUID.
    • tags — (map<String>)

      A list of key-value pairs that contain metadata for the dashboard. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.

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:

      • dashboardId — (String)

        The ID of the dashboard.

      • dashboardArn — (String)

        The ARN of the dashboard, which has the following format.

        arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}

Returns:

  • (AWS.Request)

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

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

Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to AWS IoT SiteWise. For more information, see Ingesting data using a gateway in the AWS IoT SiteWise User Guide.

Service Reference:

Examples:

Calling the createGateway operation

var params = {
  gatewayName: 'STRING_VALUE', /* required */
  gatewayPlatform: { /* required */
    greengrass: { /* required */
      groupArn: 'STRING_VALUE' /* required */
    }
  },
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
iotsitewise.createGateway(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: {})
    • gatewayName — (String)

      A unique, friendly name for the gateway.

    • gatewayPlatform — (map)

      The gateway's platform. You can only specify one platform in a gateway.

      • greengrassrequired — (map)

        A gateway that runs on AWS IoT Greengrass.

        • groupArnrequired — (String)

          The ARN of the Greengrass group. For more information about how to find a group's ARN, see ListGroups and GetGroup in the AWS IoT Greengrass API Reference.

    • tags — (map<String>)

      A list of key-value pairs that contain metadata for the gateway. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.

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:

      • gatewayId — (String)

        The ID of the gateway device. You can use this ID when you call other AWS IoT SiteWise APIs.

      • gatewayArn — (String)

        The ARN of the gateway, which has the following format.

        arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}

Returns:

  • (AWS.Request)

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

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

Creates a portal, which can contain projects and dashboards. Before you can create a portal, you must enable AWS Single Sign-On. AWS IoT SiteWise Monitor uses AWS SSO to manage user permissions. For more information, see Enabling AWS SSO in the AWS IoT SiteWise User Guide.

Note: Before you can sign in to a new portal, you must add at least one AWS SSO user or group to that portal. For more information, see Adding or removing portal administrators in the AWS IoT SiteWise User Guide.

Service Reference:

Examples:

Calling the createPortal operation

var params = {
  portalContactEmail: 'STRING_VALUE', /* required */
  portalName: 'STRING_VALUE', /* required */
  roleArn: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  portalDescription: 'STRING_VALUE',
  portalLogoImageFile: {
    data: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */, /* required */
    type: PNG /* required */
  },
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
iotsitewise.createPortal(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: {})
    • portalName — (String)

      A friendly name for the portal.

    • portalDescription — (String)

      A description for the portal.

    • portalContactEmail — (String)

      The AWS administrator's contact email address.

    • clientToken — (String)

      A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

      If a token is not provided, the SDK will use a version 4 UUID.
    • portalLogoImageFile — (map)

      A logo image to display in the portal. Upload a square, high-resolution image. The image is displayed on a dark background.

      • datarequired — (Buffer, Typed Array, Blob, String)

        The image file contents, represented as a base64-encoded string. The file size must be less than 1 MB.

      • typerequired — (String)

        The file type of the image.

        Possible values include:
        • "PNG"
    • roleArn — (String)

      The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf. For more information, see Using service roles for AWS IoT SiteWise Monitor in the AWS IoT SiteWise User Guide.

    • tags — (map<String>)

      A list of key-value pairs that contain metadata for the portal. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.

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:

      • portalId — (String)

        The ID of the created portal.

      • portalArn — (String)

        The ARN of the portal, which has the following format.

        arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}

      • portalStartUrl — (String)

        The public URL for the AWS IoT SiteWise Monitor portal.

      • portalStatus — (map)

        The status of the portal, which contains a state (CREATING after successfully calling this operation) and any error message.

        • staterequired — (String)

          The current state of the portal.

          Possible values include:
          • "CREATING"
          • "UPDATING"
          • "DELETING"
          • "ACTIVE"
          • "FAILED"
        • error — (map)

          Contains associated error information, if any.

          • code — (String)

            The error code.

            Possible values include:
            • "INTERNAL_FAILURE"
            • "VALIDATION_ERROR"
            • "LIMIT_EXCEEDED"
          • message — (String)

            The error message.

      • ssoApplicationId — (String)

        The associated AWS SSO application Id.

Returns:

  • (AWS.Request)

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

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

Creates a project in the specified portal.

Service Reference:

Examples:

Calling the createProject operation

var params = {
  portalId: 'STRING_VALUE', /* required */
  projectName: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  projectDescription: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
iotsitewise.createProject(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: {})
    • portalId — (String)

      The ID of the portal in which to create the project.

    • projectName — (String)

      A friendly name for the project.

    • projectDescription — (String)

      A description for the project.

    • clientToken — (String)

      A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

      If a token is not provided, the SDK will use a version 4 UUID.
    • tags — (map<String>)

      A list of key-value pairs that contain metadata for the project. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.

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:

      • projectId — (String)

        The ID of the project.

      • projectArn — (String)

        The ARN of the project, which has the following format.

        arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId}

Returns:

  • (AWS.Request)

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

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

Deletes an access policy that grants the specified AWS Single Sign-On identity access to the specified AWS IoT SiteWise Monitor resource. You can use this operation to revoke access to an AWS IoT SiteWise Monitor resource.

Service Reference:

Examples:

Calling the deleteAccessPolicy operation

var params = {
  accessPolicyId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
iotsitewise.deleteAccessPolicy(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: {})
    • accessPolicyId — (String)

      The ID of the access policy to be deleted.

    • clientToken — (String)

      A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

      If a token is not provided, the SDK will use a version 4 UUID.

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.

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

Deletes an asset. This action can't be undone. For more information, see Deleting assets and models in the AWS IoT SiteWise User Guide.

Note: You can't delete an asset that's associated to another asset. For more information, see DisassociateAssets.

Service Reference:

Examples:

Calling the deleteAsset operation

var params = {
  assetId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
iotsitewise.deleteAsset(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: {})
    • assetId — (String)

      The ID of the asset to delete.

    • clientToken — (String)

      A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

      If a token is not provided, the SDK will use a version 4 UUID.

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:

      • assetStatus — (map)

        The status of the asset, which contains a state (DELETING after successfully calling this operation) and any error message.

        • staterequired — (String)

          The current status of the asset.

          Possible values include:
          • "CREATING"
          • "ACTIVE"
          • "UPDATING"
          • "DELETING"
          • "FAILED"
        • error — (map)

          Contains associated error information, if any.

          • coderequired — (String)

            The error code.

            Possible values include:
            • "VALIDATION_ERROR"
            • "INTERNAL_FAILURE"
          • messagerequired — (String)

            The error message.

Returns:

  • (AWS.Request)

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

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

Deletes an asset model. This action can't be undone. You must delete all assets created from an asset model before you can delete the model. Also, you can't delete an asset model if a parent asset model exists that contains a property formula expression that depends on the asset model that you want to delete. For more information, see Deleting assets and models in the AWS IoT SiteWise User Guide.

Service Reference:

Examples:

Calling the deleteAssetModel operation

var params = {
  assetModelId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
iotsitewise.deleteAssetModel(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: {})
    • assetModelId — (String)

      The ID of the asset model to delete.

    • clientToken — (String)

      A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

      If a token is not provided, the SDK will use a version 4 UUID.

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:

      • assetModelStatus — (map)

        The status of the asset model, which contains a state (DELETING after successfully calling this operation) and any error message.

        • staterequired — (String)

          The current state of the asset model.

          Possible values include:
          • "CREATING"
          • "ACTIVE"
          • "UPDATING"
          • "PROPAGATING"
          • "DELETING"
          • "FAILED"
        • error — (map)

          Contains associated error information, if any.

          • coderequired — (String)

            The error code.

            Possible values include:
            • "VALIDATION_ERROR"
            • "INTERNAL_FAILURE"
          • messagerequired — (String)

            The error message.

Returns:

  • (AWS.Request)

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

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

Deletes a dashboard from AWS IoT SiteWise Monitor.

Service Reference:

Examples:

Calling the deleteDashboard operation

var params = {
  dashboardId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
iotsitewise.deleteDashboard(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: {})
    • dashboardId — (String)

      The ID of the dashboard to delete.

    • clientToken — (String)

      A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

      If a token is not provided, the SDK will use a version 4 UUID.

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.

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

Deletes a gateway from AWS IoT SiteWise. When you delete a gateway, some of the gateway's files remain in your gateway's file system. For more information, see Data retention in the AWS IoT SiteWise User Guide.

Service Reference:

Examples:

Calling the deleteGateway operation

var params = {
  gatewayId: 'STRING_VALUE' /* required */
};
iotsitewise.deleteGateway(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: {})
    • gatewayId — (String)

      The ID of the gateway 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.

Returns:

  • (AWS.Request)

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

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

Deletes a portal from AWS IoT SiteWise Monitor.

Service Reference:

Examples:

Calling the deletePortal operation

var params = {
  portalId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
iotsitewise.deletePortal(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: {})
    • portalId — (String)

      The ID of the portal to delete.

    • clientToken — (String)

      A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

      If a token is not provided, the SDK will use a version 4 UUID.

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:

      • portalStatus — (map)

        The status of the portal, which contains a state (DELETING after successfully calling this operation) and any error message.

        • staterequired — (String)

          The current state of the portal.

          Possible values include:
          • "CREATING"
          • "UPDATING"
          • "DELETING"
          • "ACTIVE"
          • "FAILED"
        • error — (map)

          Contains associated error information, if any.

          • code — (String)

            The error code.

            Possible values include:
            • "INTERNAL_FAILURE"
            • "VALIDATION_ERROR"
            • "LIMIT_EXCEEDED"
          • message — (String)

            The error message.

Returns:

  • (AWS.Request)

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

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

Deletes a project from AWS IoT SiteWise Monitor.

Service Reference:

Examples:

Calling the deleteProject operation

var params = {
  projectId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
iotsitewise.deleteProject(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: {})
    • projectId — (String)

      The ID of the project.

    • clientToken — (String)

      A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

      If a token is not provided, the SDK will use a version 4 UUID.

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.

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

Describes an access policy, which specifies an AWS SSO user or group's access to an AWS IoT SiteWise Monitor portal or project.

Service Reference:

Examples:

Calling the describeAccessPolicy operation

var params = {
  accessPolicyId: 'STRING_VALUE' /* required */
};
iotsitewise.describeAccessPolicy(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: {})
    • accessPolicyId — (String)

      The ID of the access policy.

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:

      • accessPolicyId — (String)

        The ID of the access policy.

      • accessPolicyArn — (String)

        The ARN of the access policy, which has the following format.

        arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId}

      • accessPolicyIdentity — (map)

        The AWS SSO identity (user or group) to which this access policy applies.

        • user — (map)

          A user identity.

          • idrequired — (String)

            The AWS SSO ID of the user.

        • group — (map)

          A group identity.

          • idrequired — (String)

            The AWS SSO ID of the group.

      • accessPolicyResource — (map)

        The AWS IoT SiteWise Monitor resource (portal or project) to which this access policy provides access.

        • portal — (map)

          A portal resource.

          • idrequired — (String)

            The ID of the portal.

        • project — (map)

          A project resource.

          • idrequired — (String)

            The ID of the project.

      • accessPolicyPermission — (String)

        The access policy permission. Note that a project ADMINISTRATOR is also known as a project owner.

        Possible values include:
        • "ADMINISTRATOR"
        • "VIEWER"
      • accessPolicyCreationDate — (Date)

        The date the access policy was created, in Unix epoch time.

      • accessPolicyLastUpdateDate — (Date)

        The date the access policy was last updated, in Unix epoch time.

Returns:

  • (AWS.Request)

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

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

Retrieves information about an asset.

Service Reference:

Examples:

Calling the describeAsset operation

var params = {
  assetId: 'STRING_VALUE' /* required */
};
iotsitewise.describeAsset(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: {})
    • assetId — (String)

      The ID of the asset.

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:

      • assetId — (String)

        The ID of the asset.

      • assetArn — (String)

        The ARN of the asset, which has the following format.

        arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}

      • assetName — (String)

        The name of the asset.

      • assetModelId — (String)

        The ID of the asset model that was used to create the asset.

      • assetProperties — (Array<map>)

        The list of asset properties for the asset.

        • idrequired — (String)

          The ID of the asset property.

        • namerequired — (String)

          The name of the property.

        • alias — (String)

          The property alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the AWS IoT SiteWise User Guide.

        • notification — (map)

          The asset property's notification topic and state. For more information, see UpdateAssetProperty.

          • topicrequired — (String)

            The MQTT topic to which AWS IoT SiteWise publishes property value update notifications.

          • staterequired — (String)

            The current notification state.

            Possible values include:
            • "ENABLED"
            • "DISABLED"
        • dataTyperequired — (String)

          The data type of the asset property.

          Possible values include:
          • "STRING"
          • "INTEGER"
          • "DOUBLE"
          • "BOOLEAN"
        • unit — (String)

          The unit (such as Newtons or RPM) of the asset property.

      • assetHierarchies — (Array<map>)

        A list of asset hierarchies that each contain a hierarchyId. A hierarchy specifies allowed parent/child asset relationships.

        • id — (String)

          The ID of the hierarchy. This ID is a hierarchyId.

        • namerequired — (String)

          The hierarchy name provided in the CreateAssetModel or UpdateAssetModel API.

      • assetCreationDate — (Date)

        The date the asset was created, in Unix epoch time.

      • assetLastUpdateDate — (Date)

        The date the asset was last updated, in Unix epoch time.

      • assetStatus — (map)

        The current status of the asset, which contains a state and any error message.

        • staterequired — (String)

          The current status of the asset.

          Possible values include:
          • "CREATING"
          • "ACTIVE"
          • "UPDATING"
          • "DELETING"
          • "FAILED"
        • error — (map)

          Contains associated error information, if any.

          • coderequired — (String)

            The error code.

            Possible values include:
            • "VALIDATION_ERROR"
            • "INTERNAL_FAILURE"
          • messagerequired — (String)

            The error message.

Returns:

  • (AWS.Request)

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

Waiter Resource States:

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

Retrieves information about an asset model.

Service Reference:

Examples:

Calling the describeAssetModel operation

var params = {
  assetModelId: 'STRING_VALUE' /* required */
};
iotsitewise.describeAssetModel(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: {})
    • assetModelId — (String)

      The ID of the asset model.

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:

      • assetModelId — (String)

        The ID of the asset model.

      • assetModelArn — (String)

        The ARN of the asset model, which has the following format.

        arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}

      • assetModelName — (String)

        The name of the asset model.

      • assetModelDescription — (String)

        The asset model's description.

      • assetModelProperties — (Array<map>)

        The list of asset properties for the asset model.

        • id — (String)

          The ID of the asset model property.

        • namerequired — (String)

          The name of the asset model property.

        • dataTyperequired — (String)

          The data type of the asset model property.

          Possible values include:
          • "STRING"
          • "INTEGER"
          • "DOUBLE"
          • "BOOLEAN"
        • unit — (String)

          The unit of the asset model property, such as Newtons or RPM.

        • typerequired — (map)

          The property type (see PropertyType).

          • attribute — (map)

            Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an IIoT wind turbine.

            • defaultValue — (String)

              The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see Updating attribute values in the AWS IoT SiteWise User Guide.

          • measurement — (map)

            Specifies an asset measurement property. A measurement represents a device's raw sensor data stream, such as timestamped temperature values or timestamped power values.

          • transform — (map)

            Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.

            • expressionrequired — (String)

              The mathematical expression that defines the transformation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.

              For more information, see Quotas in the AWS IoT SiteWise User Guide.

            • variablesrequired — (Array<map>)

              The list of variables used in the expression.

              • namerequired — (String)

                The friendly name of the variable to be used in the expression.

              • valuerequired — (map)

                The variable that identifies an asset property from which to use values.

                • propertyIdrequired — (String)

                  The ID of the property to use as the variable. You can use the property name if it's from the same asset model.

                • hierarchyId — (String)

                  The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID.

                  You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide.

          • metric — (map)

            Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.

            • expressionrequired — (String)

              The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.

              For more information, see Quotas in the AWS IoT SiteWise User Guide.

            • variablesrequired — (Array<map>)

              The list of variables used in the expression.

              • namerequired — (String)

                The friendly name of the variable to be used in the expression.

              • valuerequired — (map)

                The variable that identifies an asset property from which to use values.

                • propertyIdrequired — (String)

                  The ID of the property to use as the variable. You can use the property name if it's from the same asset model.

                • hierarchyId — (String)

                  The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID.

                  You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide.

            • windowrequired — (map)

              The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression. AWS IoT SiteWise computes one data point per window.

              • tumbling — (map)

                The tumbling time interval window.

                • intervalrequired — (String)

                  The time interval for the tumbling window. Note that w represents weeks, d represents days, h represents hours, and m represents minutes. AWS IoT SiteWise computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval at the end of each hour, and so on.

                  When AWS IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. AWS IoT SiteWise places the computed data point at the end of the interval.

      • assetModelHierarchies — (Array<map>)

        A list of asset model hierarchies that each contain a childAssetModelId and a hierarchyId (named id). A hierarchy specifies allowed parent/child asset relationships for an asset model.

        • id — (String)

          The ID of the asset model hierarchy. This ID is a hierarchyId.

        • namerequired — (String)

          The name of the asset model hierarchy that you specify by using the CreateAssetModel or UpdateAssetModel API.

        • childAssetModelIdrequired — (String)

          The ID of the asset model. All assets in this hierarchy must be instances of the childAssetModelId asset model.

      • assetModelCreationDate — (Date)

        The date the asset model was created, in Unix epoch time.

      • assetModelLastUpdateDate — (Date)

        The date the asset model was last updated, in Unix epoch time.

      • assetModelStatus — (map)

        The current status of the asset model, which contains a state and any error message.

        • staterequired — (String)

          The current state of the asset model.

          Possible values include:
          • "CREATING"
          • "ACTIVE"
          • "UPDATING"
          • "PROPAGATING"
          • "DELETING"
          • "FAILED"
        • error — (map)

          Contains associated error information, if any.

          • coderequired — (String)

            The error code.

            Possible values include:
            • "VALIDATION_ERROR"
            • "INTERNAL_FAILURE"
          • messagerequired — (String)

            The error message.

Returns:

  • (AWS.Request)

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

Waiter Resource States:

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

Retrieves information about an asset property.

Note: When you call this operation for an attribute property, this response includes the default attribute value that you define in the asset model. If you update the default value in the model, this operation's response includes the new default value.

This operation doesn't return the value of the asset property. To get the value of an asset property, use GetAssetPropertyValue.

Service Reference:

Examples:

Calling the describeAssetProperty operation

var params = {
  assetId: 'STRING_VALUE', /* required */
  propertyId: 'STRING_VALUE' /* required */
};
iotsitewise.describeAssetProperty(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: {})
    • assetId — (String)

      The ID of the asset.

    • propertyId — (String)

      The ID of the asset 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:

      • assetId — (String)

        The ID of the asset.

      • assetName — (String)

        The name of the asset.

      • assetModelId — (String)

        The ID of the asset model.

      • assetProperty — (map)

        The asset property's definition, alias, and notification state.

        • idrequired — (String)

          The ID of the asset property.

        • namerequired — (String)

          The name of the property.

        • alias — (String)

          The property alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the AWS IoT SiteWise User Guide.

        • notification — (map)

          The asset property's notification topic and state. For more information, see UpdateAssetProperty.

          • topicrequired — (String)

            The MQTT topic to which AWS IoT SiteWise publishes property value update notifications.

          • staterequired — (String)

            The current notification state.

            Possible values include:
            • "ENABLED"
            • "DISABLED"
        • dataTyperequired — (String)

          The property data type.

          Possible values include:
          • "STRING"
          • "INTEGER"
          • "DOUBLE"
          • "BOOLEAN"
        • unit — (String)

          The unit (such as Newtons or RPM) of the asset property.

        • type — (map)

          The property type (see PropertyType). A property contains one type.

          • attribute — (map)

            Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an IIoT wind turbine.

            • defaultValue — (String)

              The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see Updating attribute values in the AWS IoT SiteWise User Guide.

          • measurement — (map)

            Specifies an asset measurement property. A measurement represents a device's raw sensor data stream, such as timestamped temperature values or timestamped power values.

          • transform — (map)

            Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.

            • expressionrequired — (String)

              The mathematical expression that defines the transformation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.

              For more information, see Quotas in the AWS IoT SiteWise User Guide.

            • variablesrequired — (Array<map>)

              The list of variables used in the expression.

              • namerequired — (String)

                The friendly name of the variable to be used in the expression.

              • valuerequired — (map)

                The variable that identifies an asset property from which to use values.

                • propertyIdrequired — (String)

                  The ID of the property to use as the variable. You can use the property name if it's from the same asset model.

                • hierarchyId — (String)

                  The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID.

                  You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide.

          • metric — (map)

            Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.

            • expressionrequired — (String)

              The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.

              For more information, see Quotas in the AWS IoT SiteWise User Guide.

            • variablesrequired — (Array<map>)

              The list of variables used in the expression.

              • namerequired — (String)

                The friendly name of the variable to be used in the expression.

              • valuerequired — (map)

                The variable that identifies an asset property from which to use values.

                • propertyIdrequired — (String)

                  The ID of the property to use as the variable. You can use the property name if it's from the same asset model.

                • hierarchyId — (String)

                  The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID.

                  You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide.

            • windowrequired — (map)

              The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression. AWS IoT SiteWise computes one data point per window.

              • tumbling — (map)

                The tumbling time interval window.

                • intervalrequired — (String)

                  The time interval for the tumbling window. Note that w represents weeks, d represents days, h represents hours, and m represents minutes. AWS IoT SiteWise computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval at the end of each hour, and so on.

                  When AWS IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. AWS IoT SiteWise places the computed data point at the end of the interval.

Returns:

  • (AWS.Request)

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

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

Retrieves information about a dashboard.

Service Reference:

Examples:

Calling the describeDashboard operation

var params = {
  dashboardId: 'STRING_VALUE' /* required */
};
iotsitewise.describeDashboard(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: {})
    • dashboardId — (String)

      The ID of the dashboard.

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:

      • dashboardId — (String)

        The ID of the dashboard.

      • dashboardArn — (String)

        The ARN of the dashboard, which has the following format.

        arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}

      • dashboardName — (String)

        The name of the dashboard.

      • projectId — (String)

        The ID of the project that the dashboard is in.

      • dashboardDescription — (String)

        The dashboard's description.

      • dashboardDefinition — (String)

        The dashboard's definition JSON literal. For detailed information, see Creating dashboards (CLI) in the AWS IoT SiteWise User Guide.

      • dashboardCreationDate — (Date)

        The date the dashboard was created, in Unix epoch time.

      • dashboardLastUpdateDate — (Date)

        The date the dashboard was last updated, in Unix epoch time.

Returns:

  • (AWS.Request)

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

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

Retrieves information about a gateway.

Service Reference:

Examples:

Calling the describeGateway operation

var params = {
  gatewayId: 'STRING_VALUE' /* required */
};
iotsitewise.describeGateway(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: {})
    • gatewayId — (String)

      The ID of the gateway device.

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:

      • gatewayId — (String)

        The ID of the gateway device.

      • gatewayName — (String)

        The name of the gateway.

      • gatewayArn — (String)

        The ARN of the gateway, which has the following format.

        arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}

      • gatewayPlatform — (map)

        The gateway's platform.

        • greengrassrequired — (map)

          A gateway that runs on AWS IoT Greengrass.

          • groupArnrequired — (String)

            The ARN of the Greengrass group. For more information about how to find a group's ARN, see ListGroups and GetGroup in the AWS IoT Greengrass API Reference.

      • gatewayCapabilitySummaries — (Array<map>)

        A list of gateway capability summaries that each contain a namespace and status. Each gateway capability defines data sources for the gateway. To retrieve a capability configuration's definition, use DescribeGatewayCapabilityConfiguration.

        • capabilityNamespacerequired — (String)

          The namespace of the capability configuration. For example, if you configure OPC-UA sources from the AWS IoT SiteWise console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version, where version is a number such as 1.

        • capabilitySyncStatusrequired — (String)

          The synchronization status of the capability configuration. The sync status can be one of the following:

          • IN_SYNC – The gateway is running the capability configuration.

          • OUT_OF_SYNC – The gateway hasn't received the capability configuration.

          • SYNC_FAILED – The gateway rejected the capability configuration.

          Possible values include:
          • "IN_SYNC"
          • "OUT_OF_SYNC"
          • "SYNC_FAILED"
      • creationDate — (Date)

        The date the gateway was created, in Unix epoch time.

      • lastUpdateDate — (Date)

        The date the gateway was last updated, in Unix epoch time.

Returns:

  • (AWS.Request)

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

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

Retrieves information about a gateway capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the AWS IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway.

Examples:

Calling the describeGatewayCapabilityConfiguration operation

var params = {
  capabilityNamespace: 'STRING_VALUE', /* required */
  gatewayId: 'STRING_VALUE' /* required */
};
iotsitewise.describeGatewayCapabilityConfiguration(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: {})
    • gatewayId — (String)

      The ID of the gateway that defines the capability configuration.

    • capabilityNamespace — (String)

      The namespace of the capability configuration. For example, if you configure OPC-UA sources from the AWS IoT SiteWise console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version, where version is a number such as 1.

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:

      • gatewayId — (String)

        The ID of the gateway that defines the capability configuration.

      • capabilityNamespace — (String)

        The namespace of the gateway capability.

      • capabilityConfiguration — (String)

        The JSON document that defines the gateway capability's configuration. For more information, see Configuring data sources (CLI) in the AWS IoT SiteWise User Guide.

      • capabilitySyncStatus — (String)

        The synchronization status of the capability configuration. The sync status can be one of the following:

        • IN_SYNC – The gateway is running the capability configuration.

        • OUT_OF_SYNC – The gateway hasn't received the capability configuration.

        • SYNC_FAILED – The gateway rejected the capability configuration.

        Possible values include:
        • "IN_SYNC"
        • "OUT_OF_SYNC"
        • "SYNC_FAILED"

Returns:

  • (AWS.Request)

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

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

Retrieves the current AWS IoT SiteWise logging options.

Service Reference:

Examples:

Calling the describeLoggingOptions operation

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

      • loggingOptions — (map)

        The current logging options.

        • levelrequired — (String)

          The AWS IoT SiteWise logging verbosity level.

          Possible values include:
          • "ERROR"
          • "INFO"
          • "OFF"

Returns:

  • (AWS.Request)

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

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

Retrieves information about a portal.

Service Reference:

Examples:

Calling the describePortal operation

var params = {
  portalId: 'STRING_VALUE' /* required */
};
iotsitewise.describePortal(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: {})
    • portalId — (String)

      The ID of the portal.

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:

      • portalId — (String)

        The ID of the portal.

      • portalArn — (String)

        The ARN of the portal, which has the following format.

        arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}

      • portalName — (String)

        The name of the portal.

      • portalDescription — (String)

        The portal's description.

      • portalClientId — (String)

        The AWS SSO application generated client ID (used with AWS SSO APIs).

      • portalStartUrl — (String)

        The public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal.

      • portalContactEmail — (String)

        The AWS administrator's contact email address.

      • portalStatus — (map)

        The current status of the portal, which contains a state and any error message.

        • staterequired — (String)

          The current state of the portal.

          Possible values include:
          • "CREATING"
          • "UPDATING"
          • "DELETING"
          • "ACTIVE"
          • "FAILED"
        • error — (map)

          Contains associated error information, if any.

          • code — (String)

            The error code.

            Possible values include:
            • "INTERNAL_FAILURE"
            • "VALIDATION_ERROR"
            • "LIMIT_EXCEEDED"
          • message — (String)

            The error message.

      • portalCreationDate — (Date)

        The date the portal was created, in Unix epoch time.

      • portalLastUpdateDate — (Date)

        The date the portal was last updated, in Unix epoch time.

      • portalLogoImageLocation — (map)

        The portal's logo image, which is available at a URL.

        • idrequired — (String)

          The ID of the image.

        • urlrequired — (String)

          The URL where the image is available. The URL is valid for 15 minutes so that you can view and download the image

      • roleArn — (String)

        The ARN of the service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf. For more information, see Using service roles for AWS IoT SiteWise Monitor in the AWS IoT SiteWise User Guide.

Returns:

  • (AWS.Request)

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

Waiter Resource States:

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

Retrieves information about a project.

Service Reference:

Examples:

Calling the describeProject operation

var params = {
  projectId: 'STRING_VALUE' /* required */
};
iotsitewise.describeProject(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: {})
    • projectId — (String)

      The ID of the project.

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:

      • projectId — (String)

        The ID of the project.

      • projectArn — (String)

        The ARN of the project, which has the following format.

        arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId}

      • projectName — (String)

        The name of the project.

      • portalId — (String)

        The ID of the portal that the project is in.

      • projectDescription — (String)

        The project's description.

      • projectCreationDate — (Date)

        The date the project was created, in Unix epoch time.

      • projectLastUpdateDate — (Date)

        The date the project was last updated, in Unix epoch time.

Returns:

  • (AWS.Request)

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

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

Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model.

Service Reference:

Examples:

Calling the disassociateAssets operation

var params = {
  assetId: 'STRING_VALUE', /* required */
  childAssetId: 'STRING_VALUE', /* required */
  hierarchyId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
iotsitewise.disassociateAssets(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: {})
    • assetId — (String)

      The ID of the parent asset from which to disassociate the child asset.

    • hierarchyId — (String)

      The ID of a hierarchy in the parent asset's model. Hierarchies allow different groupings of assets to be formed that all come from the same asset model. You can use the hierarchy ID to identify the correct asset to disassociate. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide.

    • childAssetId — (String)

      The ID of the child asset to disassociate.

    • clientToken — (String)

      A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

      If a token is not provided, the SDK will use a version 4 UUID.

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.

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

Gets aggregated values for an asset property. For more information, see Querying aggregates in the AWS IoT SiteWise User Guide.

To identify an asset property, you must specify one of the following:

  • The assetId and propertyId of an asset property.

  • A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.

Service Reference:

Examples:

Calling the getAssetPropertyAggregates operation

var params = {
  aggregateTypes: [ /* required */
    AVERAGE | COUNT | MAXIMUM | MINIMUM | SUM | STANDARD_DEVIATION,
    /* more items */
  ],
  endDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  resolution: 'STRING_VALUE', /* required */
  startDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  assetId: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  propertyAlias: 'STRING_VALUE',
  propertyId: 'STRING_VALUE',
  qualities: [
    GOOD | BAD | UNCERTAIN,
    /* more items */
  ],
  timeOrdering: ASCENDING | DESCENDING
};
iotsitewise.getAssetPropertyAggregates(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: {})
    • assetId — (String)

      The ID of the asset.

    • propertyId — (String)

      The ID of the asset property.

    • propertyAlias — (String)

      The property alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the AWS IoT SiteWise User Guide.

    • aggregateTypes — (Array<String>)

      The data aggregating function.

    • resolution — (String)

      The time interval over which to aggregate data.

    • qualities — (Array<String>)

      The quality by which to filter asset data.

    • startDate — (Date)

      The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.

    • endDate — (Date)

      The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.

    • timeOrdering — (String)

      The chronological sorting order of the requested information.

      Default: ASCENDING

      Possible values include:
      • "ASCENDING"
      • "DESCENDING"
    • nextToken — (String)

      The token to be used for the next set of paginated results.

    • maxResults — (Integer)

      The maximum number of results to be returned per paginated request.

      Default: 100

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:

      • aggregatedValues — (Array<map>)

        The requested aggregated values.

        • timestamprequired — (Date)

          The date the aggregating computations occurred, in Unix epoch time.

        • quality — (String)

          The quality of the aggregated data.

          Possible values include:
          • "GOOD"
          • "BAD"
          • "UNCERTAIN"
        • valuerequired — (map)

          The value of the aggregates.

          • average — (Float)

            The average (mean) value of the time series over a time interval window.

          • count — (Float)

            The count of data points in the time series over a time interval window.

          • maximum — (Float)

            The maximum value of the time series over a time interval window.

          • minimum — (Float)

            The minimum value of the time series over a time interval window.

          • sum — (Float)

            The sum of the time series over a time interval window.

          • standardDeviation — (Float)

            The standard deviation of the time series over a time interval window.

      • nextToken — (String)

        The token for the next set of results, or null if there are no additional results.

Returns:

  • (AWS.Request)

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

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

Gets an asset property's current value. For more information, see Querying current values in the AWS IoT SiteWise User Guide.

To identify an asset property, you must specify one of the following:

  • The assetId and propertyId of an asset property.

  • A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.

Service Reference:

Examples:

Calling the getAssetPropertyValue operation

var params = {
  assetId: 'STRING_VALUE',
  propertyAlias: 'STRING_VALUE',
  propertyId: 'STRING_VALUE'
};
iotsitewise.getAssetPropertyValue(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: {})
    • assetId — (String)

      The ID of the asset.

    • propertyId — (String)

      The ID of the asset property.

    • propertyAlias — (String)

      The property alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the AWS IoT SiteWise User Guide.

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:

      • propertyValue — (map)

        The current asset property value.

        • valuerequired — (map)

          The value of the asset property (see Variant).

          • stringValue — (String)

            Asset property data of type string (sequence of characters).

          • integerValue — (Integer)

            Asset property data of type integer (whole number).

          • doubleValue — (Float)

            Asset property data of type double (floating point number).

          • booleanValue — (Boolean)

            Asset property data of type Boolean (true or false).

        • timestamprequired — (map)

          The timestamp of the asset property value.

          • timeInSecondsrequired — (Integer)

            The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.

          • offsetInNanos — (Integer)

            The nanosecond offset from timeInSeconds.

        • quality — (String)

          The quality of the asset property value.

          Possible values include:
          • "GOOD"
          • "BAD"
          • "UNCERTAIN"

Returns:

  • (AWS.Request)

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

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

Gets the history of an asset property's values. For more information, see Querying historical values in the AWS IoT SiteWise User Guide.

To identify an asset property, you must specify one of the following:

  • The assetId and propertyId of an asset property.

  • A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.

Service Reference:

Examples:

Calling the getAssetPropertyValueHistory operation

var params = {
  assetId: 'STRING_VALUE',
  endDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  propertyAlias: 'STRING_VALUE',
  propertyId: 'STRING_VALUE',
  qualities: [
    GOOD | BAD | UNCERTAIN,
    /* more items */
  ],
  startDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  timeOrdering: ASCENDING | DESCENDING
};
iotsitewise.getAssetPropertyValueHistory(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: {})
    • assetId — (String)

      The ID of the asset.

    • propertyId — (String)

      The ID of the asset property.

    • propertyAlias — (String)

      The property alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the AWS IoT SiteWise User Guide.

    • startDate — (Date)

      The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.

    • endDate — (Date)

      The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.

    • qualities — (Array<String>)

      The quality by which to filter asset data.

    • timeOrdering — (String)

      The chronological sorting order of the requested information.

      Default: ASCENDING

      Possible values include:
      • "ASCENDING"
      • "DESCENDING"
    • nextToken — (String)

      The token to be used for the next set of paginated results.

    • maxResults — (Integer)

      The maximum number of results to be returned per paginated request.

      Default: 100

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:

      • assetPropertyValueHistory — (Array<map>)

        The asset property's value history.

        • valuerequired — (map)

          The value of the asset property (see Variant).

          • stringValue — (String)

            Asset property data of type string (sequence of characters).

          • integerValue — (Integer)

            Asset property data of type integer (whole number).

          • doubleValue — (Float)

            Asset property data of type double (floating point number).

          • booleanValue — (Boolean)

            Asset property data of type Boolean (true or false).

        • timestamprequired — (map)

          The timestamp of the asset property value.

          • timeInSecondsrequired — (Integer)

            The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.

          • offsetInNanos — (Integer)

            The nanosecond offset from timeInSeconds.

        • quality — (String)

          The quality of the asset property value.

          Possible values include:
          • "GOOD"
          • "BAD"
          • "UNCERTAIN"
      • nextToken — (String)

        The token for the next set of results, or null if there are no additional results.

Returns:

  • (AWS.Request)

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

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

Retrieves a paginated list of access policies for an AWS SSO identity (a user or group) or an AWS IoT SiteWise Monitor resource (a portal or project).

Service Reference:

Examples:

Calling the listAccessPolicies operation

var params = {
  identityId: 'STRING_VALUE',
  identityType: USER | GROUP,
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  resourceId: 'STRING_VALUE',
  resourceType: PORTAL | PROJECT
};
iotsitewise.listAccessPolicies(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: {})
    • identityType — (String)

      The type of identity (user or group). This parameter is required if you specify identityId.

      Possible values include:
      • "USER"
      • "GROUP"
    • identityId — (String)

      The ID of the identity. This parameter is required if you specify identityType.

    • resourceType — (String)

      The type of resource (portal or project). This parameter is required if you specify resourceId.

      Possible values include:
      • "PORTAL"
      • "PROJECT"
    • resourceId — (String)

      The ID of the resource. This parameter is required if you specify resourceType.

    • nextToken — (String)

      The token to be used for the next set of paginated results.

    • maxResults — (Integer)

      The maximum number of results to be returned per paginated request.

      Default: 50

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:

      • accessPolicySummaries — (Array<map>)

        A list that summarizes each access policy.

        • idrequired — (String)

          The ID of the access policy.

        • identityrequired — (map)

          The AWS SSO identity (a user or group).

          • user — (map)

            A user identity.

            • idrequired — (String)

              The AWS SSO ID of the user.

          • group — (map)

            A group identity.

            • idrequired — (String)

              The AWS SSO ID of the group.

        • resourcerequired — (map)

          The AWS IoT SiteWise Monitor resource (a portal or project).

          • portal — (map)

            A portal resource.

            • idrequired — (String)

              The ID of the portal.

          • project — (map)

            A project resource.

            • idrequired — (String)

              The ID of the project.

        • permissionrequired — (String)

          The permissions for the access policy. Note that a project ADMINISTRATOR is also known as a project owner.

          Possible values include:
          • "ADMINISTRATOR"
          • "VIEWER"
        • creationDate — (Date)

          The date the access policy was created, in Unix epoch time.

        • lastUpdateDate — (Date)

          The date the access policy was last updated, in Unix epoch time.

      • nextToken — (String)

        The token for the next set of results, or null if there are no additional results.

Returns:

  • (AWS.Request)

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

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

Retrieves a paginated list of summaries of all asset models.

Service Reference:

Examples:

Calling the listAssetModels operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
iotsitewise.listAssetModels(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)

      The token to be used for the next set of paginated results.

    • maxResults — (Integer)

      The maximum number of results to be returned per paginated request.

      Default: 50

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:

      • assetModelSummaries — (Array<map>)

        A list that summarizes each asset model.

        • idrequired — (String)

          The ID of the asset model (used with AWS IoT SiteWise APIs).

        • arnrequired — (String)

          The ARN of the asset model, which has the following format.

          arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}

        • namerequired — (String)

          The name of the asset model.

        • descriptionrequired — (String)

          The asset model description.

        • creationDaterequired — (Date)

          The date the asset model was created, in Unix epoch time.

        • lastUpdateDaterequired — (Date)

          The date the asset model was last updated, in Unix epoch time.

        • statusrequired — (map)

          The current status of the asset model.

          • staterequired — (String)

            The current state of the asset model.

            Possible values include:
            • "CREATING"
            • "ACTIVE"
            • "UPDATING"
            • "PROPAGATING"
            • "DELETING"
            • "FAILED"
          • error — (map)

            Contains associated error information, if any.

            • coderequired — (String)

              The error code.

              Possible values include:
              • "VALIDATION_ERROR"
              • "INTERNAL_FAILURE"
            • messagerequired — (String)

              The error message.

      • nextToken — (String)

        The token for the next set of results, or null if there are no additional results.

Returns:

  • (AWS.Request)

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

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

Retrieves a paginated list of asset summaries.

You can use this operation to do the following:

  • List assets based on a specific asset model.

  • List top-level assets.

You can't use this operation to list all assets. To retrieve summaries for all of your assets, use ListAssetModels to get all of your asset model IDs. Then, use ListAssets to get all assets for each asset model.

Service Reference:

Examples:

Calling the listAssets operation

var params = {
  assetModelId: 'STRING_VALUE',
  filter: ALL | TOP_LEVEL,
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
iotsitewise.listAssets(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)

      The token to be used for the next set of paginated results.

    • maxResults — (Integer)

      The maximum number of results to be returned per paginated request.

      Default: 50

    • assetModelId — (String)

      The ID of the asset model by which to filter the list of assets. This parameter is required if you choose ALL for filter.

    • filter — (String)

      The filter for the requested list of assets. Choose one of the following options:

      • ALL – The list includes all assets for a given asset model ID. The assetModelId parameter is required if you filter by ALL.

      • TOP_LEVEL – The list includes only top-level assets in the asset hierarchy tree.

      Default: ALL

      Possible values include:
      • "ALL"
      • "TOP_LEVEL"

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:

      • assetSummaries — (Array<map>)

        A list that summarizes each asset.

        • idrequired — (String)

          The ID of the asset.

        • arnrequired — (String)

          The ARN of the asset, which has the following format.

          arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}

        • namerequired — (String)

          The name of the asset.

        • assetModelIdrequired — (String)

          The ID of the asset model used to create this asset.

        • creationDaterequired — (Date)

          The date the asset was created, in Unix epoch time.

        • lastUpdateDaterequired — (Date)

          The date the asset was last updated, in Unix epoch time.

        • statusrequired — (map)

          The current status of the asset.

          • staterequired — (String)

            The current status of the asset.

            Possible values include:
            • "CREATING"
            • "ACTIVE"
            • "UPDATING"
            • "DELETING"
            • "FAILED"
          • error — (map)

            Contains associated error information, if any.

            • coderequired — (String)

              The error code.

              Possible values include:
              • "VALIDATION_ERROR"
              • "INTERNAL_FAILURE"
            • messagerequired — (String)

              The error message.

        • hierarchiesrequired — (Array<map>)

          A list of asset hierarchies that each contain a hierarchyId. A hierarchy specifies allowed parent/child asset relationships.

          • id — (String)

            The ID of the hierarchy. This ID is a hierarchyId.

          • namerequired — (String)

            The hierarchy name provided in the CreateAssetModel or UpdateAssetModel API.

      • nextToken — (String)

        The token for the next set of results, or null if there are no additional results.

Returns:

  • (AWS.Request)

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

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

Retrieves a paginated list of associated assets.

You can use this operation to do the following:

  • List child assets associated to a parent asset by a hierarchy that you specify.

  • List an asset's parent asset.

Service Reference:

Examples:

Calling the listAssociatedAssets operation

var params = {
  assetId: 'STRING_VALUE', /* required */
  hierarchyId: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  traversalDirection: PARENT | CHILD
};
iotsitewise.listAssociatedAssets(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: {})
    • assetId — (String)

      The ID of the asset to query.

    • hierarchyId — (String)

      The ID of the hierarchy by which child assets are associated to the asset. To find a hierarchy ID, use the DescribeAsset or DescribeAssetModel operations. This parameter is required if you choose CHILD for traversalDirection.

      For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide.

    • traversalDirection — (String)

      The direction to list associated assets. Choose one of the following options:

      • CHILD – The list includes all child assets associated to the asset. The hierarchyId parameter is required if you choose CHILD.

      • PARENT – The list includes the asset's parent asset.

      Default: CHILD

      Possible values include:
      • "PARENT"
      • "CHILD"
    • nextToken — (String)

      The token to be used for the next set of paginated results.

    • maxResults — (Integer)

      The maximum number of results to be returned per paginated request.

      Default: 50

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:

      • assetSummaries — (Array<map>)

        A list that summarizes the associated assets.

        • idrequired — (String)

          The ID of the asset.

        • arnrequired — (String)

          The ARN of the asset, which has the following format.

          arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}

        • namerequired — (String)

          The name of the asset.

        • assetModelIdrequired — (String)

          The ID of the asset model used to create the asset.

        • creationDaterequired — (Date)

          The date the asset was created, in Unix epoch time.

        • lastUpdateDaterequired — (Date)

          The date the asset was last updated, in Unix epoch time.

        • statusrequired — (map)

          The current status of the asset.

          • staterequired — (String)

            The current status of the asset.

            Possible values include:
            • "CREATING"
            • "ACTIVE"
            • "UPDATING"
            • "DELETING"
            • "FAILED"
          • error — (map)

            Contains associated error information, if any.

            • coderequired — (String)

              The error code.

              Possible values include:
              • "VALIDATION_ERROR"
              • "INTERNAL_FAILURE"
            • messagerequired — (String)

              The error message.

        • hierarchiesrequired — (Array<map>)

          A list of asset hierarchies that each contain a hierarchyId. A hierarchy specifies allowed parent/child asset relationships.

          • id — (String)

            The ID of the hierarchy. This ID is a hierarchyId.

          • namerequired — (String)

            The hierarchy name provided in the CreateAssetModel or UpdateAssetModel API.

      • nextToken — (String)

        The token for the next set of results, or null if there are no additional results.

Returns:

  • (AWS.Request)

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

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

Retrieves a paginated list of dashboards for an AWS IoT SiteWise Monitor project.

Service Reference:

Examples:

Calling the listDashboards operation

var params = {
  projectId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
iotsitewise.listDashboards(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: {})
    • projectId — (String)

      The ID of the project.

    • nextToken — (String)

      The token to be used for the next set of paginated results.

    • maxResults — (Integer)

      The maximum number of results to be returned per paginated request.

      Default: 50

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:

      • dashboardSummaries — (Array<map>)

        A list that summarizes each dashboard in the project.

        • idrequired — (String)

          The ID of the dashboard.

        • namerequired — (String)

          The name of the dashboard

        • description — (String)

          The dashboard's description.

        • creationDate — (Date)

          The date the dashboard was created, in Unix epoch time.

        • lastUpdateDate — (Date)

          The date the dashboard was last updated, in Unix epoch time.

      • nextToken — (String)

        The token for the next set of results, or null if there are no additional results.

Returns:

  • (AWS.Request)

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

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

Retrieves a paginated list of gateways.

Service Reference:

Examples:

Calling the listGateways operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
iotsitewise.listGateways(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)

      The token to be used for the next set of paginated results.

    • maxResults — (Integer)

      The maximum number of results to be returned per paginated request.

      Default: 50

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:

      • gatewaySummaries — (Array<map>)

        A list that summarizes each gateway.

        • gatewayIdrequired — (String)

          The ID of the gateway device.

        • gatewayNamerequired — (String)

          The name of the asset.

        • gatewayCapabilitySummaries — (Array<map>)

          A list of gateway capability summaries that each contain a namespace and status. Each gateway capability defines data sources for the gateway. To retrieve a capability configuration's definition, use DescribeGatewayCapabilityConfiguration.

          • capabilityNamespacerequired — (String)

            The namespace of the capability configuration. For example, if you configure OPC-UA sources from the AWS IoT SiteWise console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version, where version is a number such as 1.

          • capabilitySyncStatusrequired — (String)

            The synchronization status of the capability configuration. The sync status can be one of the following:

            • IN_SYNC – The gateway is running the capability configuration.

            • OUT_OF_SYNC – The gateway hasn't received the capability configuration.

            • SYNC_FAILED – The gateway rejected the capability configuration.

            Possible values include:
            • "IN_SYNC"
            • "OUT_OF_SYNC"
            • "SYNC_FAILED"
        • creationDaterequired — (Date)

          The date the gateway was created, in Unix epoch time.

        • lastUpdateDaterequired — (Date)

          The date the gateway was last updated, in Unix epoch time.

      • nextToken — (String)

        The token for the next set of results, or null if there are no additional results.

Returns:

  • (AWS.Request)

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

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

Retrieves a paginated list of AWS IoT SiteWise Monitor portals.

Service Reference:

Examples:

Calling the listPortals operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
iotsitewise.listPortals(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)

      The token to be used for the next set of paginated results.

    • maxResults — (Integer)

      The maximum number of results to be returned per paginated request.

      Default: 50

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:

      • portalSummaries — (Array<map>)

        A list that summarizes each portal.

        • idrequired — (String)

          The ID of the portal.

        • namerequired — (String)

          The name of the portal.

        • description — (String)

          The portal's description.

        • startUrlrequired — (String)

          The public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal.

        • creationDate — (Date)

          The date the portal was created, in Unix epoch time.

        • lastUpdateDate — (Date)

          The date the portal was last updated, in Unix epoch time.

        • roleArn — (String)

          The ARN of the service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf. For more information, see Using service roles for AWS IoT SiteWise Monitor in the AWS IoT SiteWise User Guide.

        • statusrequired — (map)

          Contains information about the current status of a portal.

          • staterequired — (String)

            The current state of the portal.

            Possible values include:
            • "CREATING"
            • "UPDATING"
            • "DELETING"
            • "ACTIVE"
            • "FAILED"
          • error — (map)

            Contains associated error information, if any.

            • code — (String)

              The error code.

              Possible values include:
              • "INTERNAL_FAILURE"
              • "VALIDATION_ERROR"
              • "LIMIT_EXCEEDED"
            • message — (String)

              The error message.

      • nextToken — (String)

        The token for the next set of results, or null if there are no additional results.

Returns:

  • (AWS.Request)

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

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

Retrieves a paginated list of assets associated with an AWS IoT SiteWise Monitor project.

Service Reference:

Examples:

Calling the listProjectAssets operation

var params = {
  projectId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
iotsitewise.listProjectAssets(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: {})
    • projectId — (String)

      The ID of the project.

    • nextToken — (String)

      The token to be used for the next set of paginated results.

    • maxResults — (Integer)

      The maximum number of results to be returned per paginated request.

      Default: 50

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:

      • assetIds — (Array<String>)

        A list that contains the IDs of each asset associated with the project.

      • nextToken — (String)

        The token for the next set of results, or null if there are no additional results.

Returns:

  • (AWS.Request)

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

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

Retrieves a paginated list of projects for an AWS IoT SiteWise Monitor portal.

Service Reference:

Examples:

Calling the listProjects operation

var params = {
  portalId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
iotsitewise.listProjects(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: {})
    • portalId — (String)

      The ID of the portal.

    • nextToken — (String)

      The token to be used for the next set of paginated results.

    • maxResults — (Integer)

      The maximum number of results to be returned per paginated request.

      Default: 50

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:

      • projectSummaries — (Array<map>)

        A list that summarizes each project in the portal.

        • idrequired — (String)

          The ID of the project.

        • namerequired — (String)

          The name of the project.

        • description — (String)

          The project's description.

        • creationDate — (Date)

          The date the project was created, in Unix epoch time.

        • lastUpdateDate — (Date)

          The date the project was last updated, in Unix epoch time.

      • nextToken — (String)

        The token for the next set of results, or null if there are no additional results.

Returns:

  • (AWS.Request)

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

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

Retrieves the list of tags for an AWS IoT SiteWise resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
iotsitewise.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:

Returns:

  • (AWS.Request)

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

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

Sets logging options for AWS IoT SiteWise.

Service Reference:

Examples:

Calling the putLoggingOptions operation

var params = {
  loggingOptions: { /* required */
    level: ERROR | INFO | OFF /* required */
  }
};
iotsitewise.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: {})
    • loggingOptions — (map)

      The logging options to set.

      • levelrequired — (String)

        The AWS IoT SiteWise logging verbosity level.

        Possible values include:
        • "ERROR"
        • "INFO"
        • "OFF"

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.

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

Adds tags to an AWS IoT SiteWise resource. If a tag already exists for the resource, this operation updates the tag's value.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
iotsitewise.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 to tag.

    • tags — (map<String>)

      A list of key-value pairs that contain metadata for the resource. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.

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 a tag from an AWS IoT SiteWise resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
iotsitewise.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 to untag.

    • tagKeys — (Array<String>)

      A list of keys for tags to remove 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.

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

Updates an existing access policy that specifies an AWS SSO user or group's access to an AWS IoT SiteWise Monitor portal or project resource.

Service Reference:

Examples:

Calling the updateAccessPolicy operation

var params = {
  accessPolicyId: 'STRING_VALUE', /* required */
  accessPolicyIdentity: { /* required */
    group: {
      id: 'STRING_VALUE' /* required */
    },
    user: {
      id: 'STRING_VALUE' /* required */
    }
  },
  accessPolicyPermission: ADMINISTRATOR | VIEWER, /* required */
  accessPolicyResource: { /* required */
    portal: {
      id: 'STRING_VALUE' /* required */
    },
    project: {
      id: 'STRING_VALUE' /* required */
    }
  },
  clientToken: 'STRING_VALUE'
};
iotsitewise.updateAccessPolicy(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: {})
    • accessPolicyId — (String)

      The ID of the access policy.

    • accessPolicyIdentity — (map)

      The identity for this access policy. Choose either a user or a group but not both.

      • user — (map)

        A user identity.

        • idrequired — (String)

          The AWS SSO ID of the user.

      • group — (map)

        A group identity.

        • idrequired — (String)

          The AWS SSO ID of the group.

    • accessPolicyResource — (map)

      The AWS IoT SiteWise Monitor resource for this access policy. Choose either portal or project but not both.

      • portal — (map)

        A portal resource.

        • idrequired — (String)

          The ID of the portal.

      • project — (map)

        A project resource.

        • idrequired — (String)

          The ID of the project.

    • accessPolicyPermission — (String)

      The permission level for this access policy. Note that a project ADMINISTRATOR is also known as a project owner.

      Possible values include:
      • "ADMINISTRATOR"
      • "VIEWER"
    • clientToken — (String)

      A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

      If a token is not provided, the SDK will use a version 4 UUID.

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.

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

Updates an asset's name. For more information, see Updating assets and models in the AWS IoT SiteWise User Guide.

Service Reference:

Examples:

Calling the updateAsset operation

var params = {
  assetId: 'STRING_VALUE', /* required */
  assetName: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
iotsitewise.updateAsset(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: {})
    • assetId — (String)

      The ID of the asset to update.

    • assetName — (String)

      A unique, friendly name for the asset.

    • clientToken — (String)

      A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

      If a token is not provided, the SDK will use a version 4 UUID.

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:

      • assetStatus — (map)

        The status of the asset, which contains a state (UPDATING after successfully calling this operation) and any error message.

        • staterequired — (String)

          The current status of the asset.

          Possible values include:
          • "CREATING"
          • "ACTIVE"
          • "UPDATING"
          • "DELETING"
          • "FAILED"
        • error — (map)

          Contains associated error information, if any.

          • coderequired — (String)

            The error code.

            Possible values include:
            • "VALIDATION_ERROR"
            • "INTERNAL_FAILURE"
          • messagerequired — (String)

            The error message.

Returns:

  • (AWS.Request)

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

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

Updates an asset model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models in the AWS IoT SiteWise User Guide.

This operation overwrites the existing model with the provided model. To avoid deleting your asset model's properties or hierarchies, you must include their IDs and definitions in the updated asset model payload. For more information, see DescribeAssetModel.

If you remove a property from an asset model or update a property's formula expression, AWS IoT SiteWise deletes all previous data for that property. If you remove a hierarchy definition from an asset model, AWS IoT SiteWise disassociates every asset associated with that hierarchy. You can't change the type or data type of an existing property.

Service Reference:

Examples:

Calling the updateAssetModel operation

var params = {
  assetModelId: 'STRING_VALUE', /* required */
  assetModelName: 'STRING_VALUE', /* required */
  assetModelDescription: 'STRING_VALUE',
  assetModelHierarchies: [
    {
      childAssetModelId: 'STRING_VALUE', /* required */
      name: 'STRING_VALUE', /* required */
      id: 'STRING_VALUE'
    },
    /* more items */
  ],
  assetModelProperties: [
    {
      dataType: STRING | INTEGER | DOUBLE | BOOLEAN, /* required */
      name: 'STRING_VALUE', /* required */
      type: { /* required */
        attribute: {
          defaultValue: 'STRING_VALUE'
        },
        measurement: {
        },
        metric: {
          expression: 'STRING_VALUE', /* required */
          variables: [ /* required */
            {
              name: 'STRING_VALUE', /* required */
              value: { /* required */
                propertyId: 'STRING_VALUE', /* required */
                hierarchyId: 'STRING_VALUE'
              }
            },
            /* more items */
          ],
          window: { /* required */
            tumbling: {
              interval: 'STRING_VALUE' /* required */
            }
          }
        },
        transform: {
          expression: 'STRING_VALUE', /* required */
          variables: [ /* required */
            {
              name: 'STRING_VALUE', /* required */
              value: { /* required */
                propertyId: 'STRING_VALUE', /* required */
                hierarchyId: 'STRING_VALUE'
              }
            },
            /* more items */
          ]
        }
      },
      id: 'STRING_VALUE',
      unit: 'STRING_VALUE'
    },
    /* more items */
  ],
  clientToken: 'STRING_VALUE'
};
iotsitewise.updateAssetModel(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: {})
    • assetModelId — (String)

      The ID of the asset model to update.

    • assetModelName — (String)

      A unique, friendly name for the asset model.

    • assetModelDescription — (String)

      A description for the asset model.

    • assetModelProperties — (Array<map>)

      The updated property definitions of the asset model. For more information, see Asset properties in the AWS IoT SiteWise User Guide.

      You can specify up to 200 properties per asset model. For more information, see Quotas in the AWS IoT SiteWise User Guide.

      • id — (String)

        The ID of the asset model property.

      • namerequired — (String)

        The name of the asset model property.

      • dataTyperequired — (String)

        The data type of the asset model property.

        Possible values include:
        • "STRING"
        • "INTEGER"
        • "DOUBLE"
        • "BOOLEAN"
      • unit — (String)

        The unit of the asset model property, such as Newtons or RPM.

      • typerequired — (map)

        The property type (see PropertyType).

        • attribute — (map)

          Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an IIoT wind turbine.

          • defaultValue — (String)

            The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see Updating attribute values in the AWS IoT SiteWise User Guide.

        • measurement — (map)

          Specifies an asset measurement property. A measurement represents a device's raw sensor data stream, such as timestamped temperature values or timestamped power values.

        • transform — (map)

          Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.

          • expressionrequired — (String)

            The mathematical expression that defines the transformation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.

            For more information, see Quotas in the AWS IoT SiteWise User Guide.

          • variablesrequired — (Array<map>)

            The list of variables used in the expression.

            • namerequired — (String)

              The friendly name of the variable to be used in the expression.

            • valuerequired — (map)

              The variable that identifies an asset property from which to use values.

              • propertyIdrequired — (String)

                The ID of the property to use as the variable. You can use the property name if it's from the same asset model.

              • hierarchyId — (String)

                The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID.

                You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide.

        • metric — (map)

          Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.

          • expressionrequired — (String)

            The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.

            For more information, see Quotas in the AWS IoT SiteWise User Guide.

          • variablesrequired — (Array<map>)

            The list of variables used in the expression.

            • namerequired — (String)

              The friendly name of the variable to be used in the expression.

            • valuerequired — (map)

              The variable that identifies an asset property from which to use values.

              • propertyIdrequired — (String)

                The ID of the property to use as the variable. You can use the property name if it's from the same asset model.

              • hierarchyId — (String)

                The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID.

                You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide.

          • windowrequired — (map)

            The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression. AWS IoT SiteWise computes one data point per window.

            • tumbling — (map)

              The tumbling time interval window.

              • intervalrequired — (String)

                The time interval for the tumbling window. Note that w represents weeks, d represents days, h represents hours, and m represents minutes. AWS IoT SiteWise computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval at the end of each hour, and so on.

                When AWS IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. AWS IoT SiteWise places the computed data point at the end of the interval.

    • assetModelHierarchies — (Array<map>)

      The updated hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide.

      You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the AWS IoT SiteWise User Guide.

      • id — (String)

        The ID of the asset model hierarchy. This ID is a hierarchyId.

      • namerequired — (String)

        The name of the asset model hierarchy that you specify by using the CreateAssetModel or UpdateAssetModel API.

      • childAssetModelIdrequired — (String)

        The ID of the asset model. All assets in this hierarchy must be instances of the childAssetModelId asset model.

    • clientToken — (String)

      A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

      If a token is not provided, the SDK will use a version 4 UUID.

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:

      • assetModelStatus — (map)

        The status of the asset model, which contains a state (UPDATING after successfully calling this operation) and any error message.

        • staterequired — (String)

          The current state of the asset model.

          Possible values include:
          • "CREATING"
          • "ACTIVE"
          • "UPDATING"
          • "PROPAGATING"
          • "DELETING"
          • "FAILED"
        • error — (map)

          Contains associated error information, if any.

          • coderequired — (String)

            The error code.

            Possible values include:
            • "VALIDATION_ERROR"
            • "INTERNAL_FAILURE"
          • messagerequired — (String)

            The error message.

Returns:

  • (AWS.Request)

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

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

Updates an asset property's alias and notification state.

This operation overwrites the property's existing alias and notification state. To keep your existing property's alias or notification state, you must include the existing values in the UpdateAssetProperty request. For more information, see DescribeAssetProperty.

Service Reference:

Examples:

Calling the updateAssetProperty operation

var params = {
  assetId: 'STRING_VALUE', /* required */
  propertyId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  propertyAlias: 'STRING_VALUE',
  propertyNotificationState: ENABLED | DISABLED
};
iotsitewise.updateAssetProperty(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: {})
    • assetId — (String)

      The ID of the asset to be updated.

    • propertyId — (String)

      The ID of the asset property to be updated.

    • propertyAlias — (String)

      The property alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the AWS IoT SiteWise User Guide.

      If you omit this parameter, the alias is removed from the property.

    • propertyNotificationState — (String)

      The MQTT notification state (enabled or disabled) for this asset property. When the notification state is enabled, AWS IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see Interacting with other services in the AWS IoT SiteWise User Guide.

      If you omit this parameter, the notification state is set to DISABLED.

      Possible values include:
      • "ENABLED"
      • "DISABLED"
    • clientToken — (String)

      A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

      If a token is not provided, the SDK will use a version 4 UUID.

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.

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

Updates an AWS IoT SiteWise Monitor dashboard.

Service Reference:

Examples:

Calling the updateDashboard operation

var params = {
  dashboardDefinition: 'STRING_VALUE', /* required */
  dashboardId: 'STRING_VALUE', /* required */
  dashboardName: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  dashboardDescription: 'STRING_VALUE'
};
iotsitewise.updateDashboard(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: {})
    • dashboardId — (String)

      The ID of the dashboard to update.

    • dashboardName — (String)

      A new friendly name for the dashboard.

    • dashboardDescription — (String)

      A new description for the dashboard.

    • dashboardDefinition — (String)

      The new dashboard definition, as specified in a JSON literal. For detailed information, see Creating dashboards (CLI) in the AWS IoT SiteWise User Guide.

    • clientToken — (String)

      A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

      If a token is not provided, the SDK will use a version 4 UUID.

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.

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

Updates a gateway's name.

Service Reference:

Examples:

Calling the updateGateway operation

var params = {
  gatewayId: 'STRING_VALUE', /* required */
  gatewayName: 'STRING_VALUE' /* required */
};
iotsitewise.updateGateway(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: {})
    • gatewayId — (String)

      The ID of the gateway to update.

    • gatewayName — (String)

      A unique, friendly name for the gateway.

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.

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

Updates a gateway capability configuration or defines a new capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the AWS IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway.

Examples:

Calling the updateGatewayCapabilityConfiguration operation

var params = {
  capabilityConfiguration: 'STRING_VALUE', /* required */
  capabilityNamespace: 'STRING_VALUE', /* required */
  gatewayId: 'STRING_VALUE' /* required */
};
iotsitewise.updateGatewayCapabilityConfiguration(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: {})
    • gatewayId — (String)

      The ID of the gateway to be updated.

    • capabilityNamespace — (String)

      The namespace of the gateway capability configuration to be updated. For example, if you configure OPC-UA sources from the AWS IoT SiteWise console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version, where version is a number such as 1.

    • capabilityConfiguration — (String)

      The JSON document that defines the configuration for the gateway capability. For more information, see Configuring data sources (CLI) in the AWS IoT SiteWise User Guide.

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:

      • capabilityNamespace — (String)

        The namespace of the gateway capability.

      • capabilitySyncStatus — (String)

        The synchronization status of the capability configuration. The sync status can be one of the following:

        • IN_SYNC – The gateway is running the capability configuration.

        • OUT_OF_SYNC – The gateway hasn't received the capability configuration.

        • SYNC_FAILED – The gateway rejected the capability configuration.

        After you update a capability configuration, its sync status is OUT_OF_SYNC until the gateway receives and applies or rejects the updated configuration.

        Possible values include:
        • "IN_SYNC"
        • "OUT_OF_SYNC"
        • "SYNC_FAILED"

Returns:

  • (AWS.Request)

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

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

Updates an AWS IoT SiteWise Monitor portal.

Service Reference:

Examples:

Calling the updatePortal operation

var params = {
  portalContactEmail: 'STRING_VALUE', /* required */
  portalId: 'STRING_VALUE', /* required */
  portalName: 'STRING_VALUE', /* required */
  roleArn: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  portalDescription: 'STRING_VALUE',
  portalLogoImage: {
    file: {
      data: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */, /* required */
      type: PNG /* required */
    },
    id: 'STRING_VALUE'
  }
};
iotsitewise.updatePortal(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: {})
    • portalId — (String)

      The ID of the portal to update.

    • portalName — (String)

      A new friendly name for the portal.

    • portalDescription — (String)

      A new description for the portal.

    • portalContactEmail — (String)

      The AWS administrator's contact email address.

    • portalLogoImage — (map)

      Contains an image that is one of the following:

      • An image file. Choose this option to upload a new image.

      • The ID of an existing image. Choose this option to keep an existing image.

      • id — (String)

        The ID of an existing image. Specify this parameter to keep an existing image.

      • file — (map)

        Contains an image file.

        • datarequired — (Buffer, Typed Array, Blob, String)

          The image file contents, represented as a base64-encoded string. The file size must be less than 1 MB.

        • typerequired — (String)

          The file type of the image.

          Possible values include:
          • "PNG"
    • roleArn — (String)

      The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf. For more information, see Using service roles for AWS IoT SiteWise Monitor in the AWS IoT SiteWise User Guide.

    • clientToken — (String)

      A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

      If a token is not provided, the SDK will use a version 4 UUID.

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:

      • portalStatus — (map)

        The status of the portal, which contains a state (UPDATING after successfully calling this operation) and any error message.

        • staterequired — (String)

          The current state of the portal.

          Possible values include:
          • "CREATING"
          • "UPDATING"
          • "DELETING"
          • "ACTIVE"
          • "FAILED"
        • error — (map)

          Contains associated error information, if any.

          • code — (String)

            The error code.

            Possible values include:
            • "INTERNAL_FAILURE"
            • "VALIDATION_ERROR"
            • "LIMIT_EXCEEDED"
          • message — (String)

            The error message.

Returns:

  • (AWS.Request)

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

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

Updates an AWS IoT SiteWise Monitor project.

Service Reference:

Examples:

Calling the updateProject operation

var params = {
  projectId: 'STRING_VALUE', /* required */
  projectName: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  projectDescription: 'STRING_VALUE'
};
iotsitewise.updateProject(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: {})
    • projectId — (String)

      The ID of the project to update.

    • projectName — (String)

      A new friendly name for the project.

    • projectDescription — (String)

      A new description for the project.

    • clientToken — (String)

      A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

      If a token is not provided, the SDK will use a version 4 UUID.

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.

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

Waits for a given IoTSiteWise 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.

Examples:

Waiting for the assetModelNotExists state

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

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.

Waiter Resource States:

Waiter Resource Details

iotsitewise.waitFor('assetModelNotExists', params = {}, [callback]) ⇒ AWS.Request

Waits for the assetModelNotExists state by periodically calling the underlying IoTSiteWise.describeAssetModel() operation every 3 seconds (at most 20 times).

Examples:

Waiting for the assetModelNotExists state

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

Parameters:

  • params (Object)
    • assetModelId — (String)

      The ID of the asset model.

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:

      • assetModelId — (String)

        The ID of the asset model.

      • assetModelArn — (String)

        The ARN of the asset model, which has the following format.

        arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}

      • assetModelName — (String)

        The name of the asset model.

      • assetModelDescription — (String)

        The asset model's description.

      • assetModelProperties — (Array<map>)

        The list of asset properties for the asset model.

        • id — (String)

          The ID of the asset model property.

        • namerequired — (String)

          The name of the asset model property.

        • dataTyperequired — (String)

          The data type of the asset model property.

          Possible values include:
          • "STRING"
          • "INTEGER"
          • "DOUBLE"
          • "BOOLEAN"
        • unit — (String)

          The unit of the asset model property, such as Newtons or RPM.

        • typerequired — (map)

          The property type (see PropertyType).

          • attribute — (map)

            Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an IIoT wind turbine.

            • defaultValue — (String)

              The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see Updating attribute values in the AWS IoT SiteWise User Guide.

          • measurement — (map)

            Specifies an asset measurement property. A measurement represents a device's raw sensor data stream, such as timestamped temperature values or timestamped power values.

          • transform — (map)

            Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.

            • expressionrequired — (String)

              The mathematical expression that defines the transformation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.

              For more information, see Quotas in the AWS IoT SiteWise User Guide.

            • variablesrequired — (Array<map>)

              The list of variables used in the expression.

              • namerequired — (String)

                The friendly name of the variable to be used in the expression.

              • valuerequired — (map)

                The variable that identifies an asset property from which to use values.

                • propertyIdrequired — (String)

                  The ID of the property to use as the variable. You can use the property name if it's from the same asset model.

                • hierarchyId — (String)

                  The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID.

                  You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide.

          • metric — (map)

            Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.

            • expressionrequired — (String)

              The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.

              For more information, see Quotas in the AWS IoT SiteWise User Guide.

            • variablesrequired — (Array<map>)

              The list of variables used in the expression.

              • namerequired — (String)

                The friendly name of the variable to be used in the expression.

              • valuerequired — (map)

                The variable that identifies an asset property from which to use values.

                • propertyIdrequired — (String)

                  The ID of the property to use as the variable. You can use the property name if it's from the same asset model.

                • hierarchyId — (String)

                  The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID.

                  You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide.

            • windowrequired — (map)

              The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression. AWS IoT SiteWise computes one data point per window.

              • tumbling — (map)

                The tumbling time interval window.

                • intervalrequired — (String)

                  The time interval for the tumbling window. Note that w represents weeks, d represents days, h represents hours, and m represents minutes. AWS IoT SiteWise computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval at the end of each hour, and so on.

                  When AWS IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. AWS IoT SiteWise places the computed data point at the end of the interval.

      • assetModelHierarchies — (Array<map>)

        A list of asset model hierarchies that each contain a childAssetModelId and a hierarchyId (named id). A hierarchy specifies allowed parent/child asset relationships for an asset model.

        • id — (String)

          The ID of the asset model hierarchy. This ID is a hierarchyId.

        • namerequired — (String)

          The name of the asset model hierarchy that you specify by using the CreateAssetModel or UpdateAssetModel API.

        • childAssetModelIdrequired — (String)

          The ID of the asset model. All assets in this hierarchy must be instances of the childAssetModelId asset model.

      • assetModelCreationDate — (Date)

        The date the asset model was created, in Unix epoch time.

      • assetModelLastUpdateDate — (Date)

        The date the asset model was last updated, in Unix epoch time.

      • assetModelStatus — (map)

        The current status of the asset model, which contains a state and any error message.

        • staterequired — (String)

          The current state of the asset model.

          Possible values include:
          • "CREATING"
          • "ACTIVE"
          • "UPDATING"
          • "PROPAGATING"
          • "DELETING"
          • "FAILED"
        • error — (map)

          Contains associated error information, if any.

          • coderequired — (String)

            The error code.

            Possible values include:
            • "VALIDATION_ERROR"
            • "INTERNAL_FAILURE"
          • messagerequired — (String)

            The error message.

Returns:

  • (AWS.Request)

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

See Also:

iotsitewise.waitFor('assetModelActive', params = {}, [callback]) ⇒ AWS.Request

Waits for the assetModelActive state by periodically calling the underlying IoTSiteWise.describeAssetModel() operation every 3 seconds (at most 20 times).

Examples:

Waiting for the assetModelActive state

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

Parameters:

  • params (Object)
    • assetModelId — (String)

      The ID of the asset model.

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:

      • assetModelId — (String)

        The ID of the asset model.

      • assetModelArn — (String)

        The ARN of the asset model, which has the following format.

        arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}

      • assetModelName — (String)

        The name of the asset model.

      • assetModelDescription — (String)

        The asset model's description.

      • assetModelProperties — (Array<map>)

        The list of asset properties for the asset model.

        • id — (String)

          The ID of the asset model property.

        • namerequired — (String)

          The name of the asset model property.

        • dataTyperequired — (String)

          The data type of the asset model property.

          Possible values include:
          • "STRING"
          • "INTEGER"
          • "DOUBLE"
          • "BOOLEAN"
        • unit — (String)

          The unit of the asset model property, such as Newtons or RPM.

        • typerequired — (map)

          The property type (see PropertyType).

          • attribute — (map)

            Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an IIoT wind turbine.

            • defaultValue — (String)

              The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see Updating attribute values in the AWS IoT SiteWise User Guide.

          • measurement — (map)

            Specifies an asset measurement property. A measurement represents a device's raw sensor data stream, such as timestamped temperature values or timestamped power values.

          • transform — (map)

            Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.

            • expressionrequired — (String)

              The mathematical expression that defines the transformation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.

              For more information, see Quotas in the AWS IoT SiteWise User Guide.

            • variablesrequired — (Array<map>)

              The list of variables used in the expression.

              • namerequired — (String)

                The friendly name of the variable to be used in the expression.

              • valuerequired — (map)

                The variable that identifies an asset property from which to use values.

                • propertyIdrequired — (String)

                  The ID of the property to use as the variable. You can use the property name if it's from the same asset model.

                • hierarchyId — (String)

                  The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID.

                  You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide.

          • metric — (map)

            Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.

            • expressionrequired — (String)

              The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.

              For more information, see Quotas in the AWS IoT SiteWise User Guide.

            • variablesrequired — (Array<map>)

              The list of variables used in the expression.

              • namerequired — (String)

                The friendly name of the variable to be used in the expression.

              • valuerequired — (map)

                The variable that identifies an asset property from which to use values.

                • propertyIdrequired — (String)

                  The ID of the property to use as the variable. You can use the property name if it's from the same asset model.

                • hierarchyId — (String)

                  The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID.

                  You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide.

            • windowrequired — (map)

              The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression. AWS IoT SiteWise computes one data point per window.

              • tumbling — (map)

                The tumbling time interval window.

                • intervalrequired — (String)

                  The time interval for the tumbling window. Note that w represents weeks, d represents days, h represents hours, and m represents minutes. AWS IoT SiteWise computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval at the end of each hour, and so on.

                  When AWS IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. AWS IoT SiteWise places the computed data point at the end of the interval.

      • assetModelHierarchies — (Array<map>)

        A list of asset model hierarchies that each contain a childAssetModelId and a hierarchyId (named id). A hierarchy specifies allowed parent/child asset relationships for an asset model.

        • id — (String)

          The ID of the asset model hierarchy. This ID is a hierarchyId.

        • namerequired — (String)

          The name of the asset model hierarchy that you specify by using the CreateAssetModel or UpdateAssetModel API.

        • childAssetModelIdrequired — (String)

          The ID of the asset model. All assets in this hierarchy must be instances of the childAssetModelId asset model.

      • assetModelCreationDate — (Date)

        The date the asset model was created, in Unix epoch time.

      • assetModelLastUpdateDate — (Date)

        The date the asset model was last updated, in Unix epoch time.

      • assetModelStatus — (map)

        The current status of the asset model, which contains a state and any error message.

        • staterequired — (String)

          The current state of the asset model.

          Possible values include:
          • "CREATING"
          • "ACTIVE"
          • "UPDATING"
          • "PROPAGATING"
          • "DELETING"
          • "FAILED"
        • error — (map)

          Contains associated error information, if any.

          • coderequired — (String)

            The error code.

            Possible values include:
            • "VALIDATION_ERROR"
            • "INTERNAL_FAILURE"
          • messagerequired — (String)

            The error message.

Returns:

  • (AWS.Request)

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

See Also:

iotsitewise.waitFor('assetNotExists', params = {}, [callback]) ⇒ AWS.Request

Waits for the assetNotExists state by periodically calling the underlying IoTSiteWise.describeAsset() operation every 3 seconds (at most 20 times).

Examples:

Waiting for the assetNotExists state

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

Parameters:

  • params (Object)
    • assetId — (String)

      The ID of the asset.

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:

      • assetId — (String)

        The ID of the asset.

      • assetArn — (String)

        The ARN of the asset, which has the following format.

        arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}

      • assetName — (String)

        The name of the asset.

      • assetModelId — (String)

        The ID of the asset model that was used to create the asset.

      • assetProperties — (Array<map>)

        The list of asset properties for the asset.

        • idrequired — (String)

          The ID of the asset property.

        • namerequired — (String)

          The name of the property.

        • alias — (String)

          The property alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the AWS IoT SiteWise User Guide.

        • notification — (map)

          The asset property's notification topic and state. For more information, see UpdateAssetProperty.

          • topicrequired — (String)

            The MQTT topic to which AWS IoT SiteWise publishes property value update notifications.

          • staterequired — (String)

            The current notification state.

            Possible values include:
            • "ENABLED"
            • "DISABLED"
        • dataTyperequired — (String)

          The data type of the asset property.

          Possible values include:
          • "STRING"
          • "INTEGER"
          • "DOUBLE"
          • "BOOLEAN"
        • unit — (String)

          The unit (such as Newtons or RPM) of the asset property.

      • assetHierarchies — (Array<map>)

        A list of asset hierarchies that each contain a hierarchyId. A hierarchy specifies allowed parent/child asset relationships.

        • id — (String)

          The ID of the hierarchy. This ID is a hierarchyId.

        • namerequired — (String)

          The hierarchy name provided in the CreateAssetModel or UpdateAssetModel API.

      • assetCreationDate — (Date)

        The date the asset was created, in Unix epoch time.

      • assetLastUpdateDate — (Date)

        The date the asset was last updated, in Unix epoch time.

      • assetStatus — (map)

        The current status of the asset, which contains a state and any error message.

        • staterequired — (String)

          The current status of the asset.

          Possible values include:
          • "CREATING"
          • "ACTIVE"
          • "UPDATING"
          • "DELETING"
          • "FAILED"
        • error — (map)

          Contains associated error information, if any.

          • coderequired — (String)

            The error code.

            Possible values include:
            • "VALIDATION_ERROR"
            • "INTERNAL_FAILURE"
          • messagerequired — (String)

            The error message.

Returns:

  • (AWS.Request)

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

See Also:

iotsitewise.waitFor('assetActive', params = {}, [callback]) ⇒ AWS.Request

Waits for the assetActive state by periodically calling the underlying IoTSiteWise.describeAsset() operation every 3 seconds (at most 20 times).

Examples:

Waiting for the assetActive state

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

Parameters:

  • params (Object)
    • assetId — (String)

      The ID of the asset.

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:

      • assetId — (String)

        The ID of the asset.

      • assetArn — (String)

        The ARN of the asset, which has the following format.

        arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}

      • assetName — (String)

        The name of the asset.

      • assetModelId — (String)

        The ID of the asset model that was used to create the asset.

      • assetProperties — (Array<map>)

        The list of asset properties for the asset.

        • idrequired — (String)

          The ID of the asset property.

        • namerequired — (String)

          The name of the property.

        • alias — (String)

          The property alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the AWS IoT SiteWise User Guide.

        • notification — (map)

          The asset property's notification topic and state. For more information, see UpdateAssetProperty.

          • topicrequired — (String)

            The MQTT topic to which AWS IoT SiteWise publishes property value update notifications.

          • staterequired — (String)

            The current notification state.

            Possible values include:
            • "ENABLED"
            • "DISABLED"
        • dataTyperequired — (String)

          The data type of the asset property.

          Possible values include:
          • "STRING"
          • "INTEGER"
          • "DOUBLE"
          • "BOOLEAN"
        • unit — (String)

          The unit (such as Newtons or RPM) of the asset property.

      • assetHierarchies — (Array<map>)

        A list of asset hierarchies that each contain a hierarchyId. A hierarchy specifies allowed parent/child asset relationships.

        • id — (String)

          The ID of the hierarchy. This ID is a hierarchyId.

        • namerequired — (String)

          The hierarchy name provided in the CreateAssetModel or UpdateAssetModel API.

      • assetCreationDate — (Date)

        The date the asset was created, in Unix epoch time.

      • assetLastUpdateDate — (Date)

        The date the asset was last updated, in Unix epoch time.

      • assetStatus — (map)

        The current status of the asset, which contains a state and any error message.

        • staterequired — (String)

          The current status of the asset.

          Possible values include:
          • "CREATING"
          • "ACTIVE"
          • "UPDATING"
          • "DELETING"
          • "FAILED"
        • error — (map)

          Contains associated error information, if any.

          • coderequired — (String)

            The error code.

            Possible values include:
            • "VALIDATION_ERROR"
            • "INTERNAL_FAILURE"
          • messagerequired — (String)

            The error message.

Returns:

  • (AWS.Request)

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

See Also:

iotsitewise.waitFor('portalNotExists', params = {}, [callback]) ⇒ AWS.Request

Waits for the portalNotExists state by periodically calling the underlying IoTSiteWise.describePortal() operation every 3 seconds (at most 20 times).

Examples:

Waiting for the portalNotExists state

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

Parameters:

  • params (Object)
    • portalId — (String)

      The ID of the portal.

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:

      • portalId — (String)

        The ID of the portal.

      • portalArn — (String)

        The ARN of the portal, which has the following format.

        arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}

      • portalName — (String)

        The name of the portal.

      • portalDescription — (String)

        The portal's description.

      • portalClientId — (String)

        The AWS SSO application generated client ID (used with AWS SSO APIs).

      • portalStartUrl — (String)

        The public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal.

      • portalContactEmail — (String)

        The AWS administrator's contact email address.

      • portalStatus — (map)

        The current status of the portal, which contains a state and any error message.

        • staterequired — (String)

          The current state of the portal.

          Possible values include:
          • "CREATING"
          • "UPDATING"
          • "DELETING"
          • "ACTIVE"
          • "FAILED"
        • error — (map)

          Contains associated error information, if any.

          • code — (String)

            The error code.

            Possible values include:
            • "INTERNAL_FAILURE"
            • "VALIDATION_ERROR"
            • "LIMIT_EXCEEDED"
          • message — (String)

            The error message.

      • portalCreationDate — (Date)

        The date the portal was created, in Unix epoch time.

      • portalLastUpdateDate — (Date)

        The date the portal was last updated, in Unix epoch time.

      • portalLogoImageLocation — (map)

        The portal's logo image, which is available at a URL.

        • idrequired — (String)

          The ID of the image.

        • urlrequired — (String)

          The URL where the image is available. The URL is valid for 15 minutes so that you can view and download the image

      • roleArn — (String)

        The ARN of the service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf. For more information, see Using service roles for AWS IoT SiteWise Monitor in the AWS IoT SiteWise User Guide.

Returns:

  • (AWS.Request)

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

See Also:

iotsitewise.waitFor('portalActive', params = {}, [callback]) ⇒ AWS.Request

Waits for the portalActive state by periodically calling the underlying IoTSiteWise.describePortal() operation every 3 seconds (at most 20 times).

Examples:

Waiting for the portalActive state

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

Parameters:

  • params (Object)
    • portalId — (String)

      The ID of the portal.

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:

      • portalId — (String)

        The ID of the portal.

      • portalArn — (String)

        The ARN of the portal, which has the following format.

        arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}

      • portalName — (String)

        The name of the portal.

      • portalDescription — (String)

        The portal's description.

      • portalClientId — (String)

        The AWS SSO application generated client ID (used with AWS SSO APIs).

      • portalStartUrl — (String)

        The public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal.

      • portalContactEmail — (String)

        The AWS administrator's contact email address.

      • portalStatus — (map)

        The current status of the portal, which contains a state and any error message.

        • staterequired — (String)

          The current state of the portal.

          Possible values include:
          • "CREATING"
          • "UPDATING"
          • "DELETING"
          • "ACTIVE"
          • "FAILED"
        • error — (map)

          Contains associated error information, if any.

          • code — (String)

            The error code.

            Possible values include:
            • "INTERNAL_FAILURE"
            • "VALIDATION_ERROR"
            • "LIMIT_EXCEEDED"
          • message — (String)

            The error message.

      • portalCreationDate — (Date)

        The date the portal was created, in Unix epoch time.

      • portalLastUpdateDate — (Date)

        The date the portal was last updated, in Unix epoch time.

      • portalLogoImageLocation — (map)

        The portal's logo image, which is available at a URL.

        • idrequired — (String)

          The ID of the image.

        • urlrequired — (String)

          The URL where the image is available. The URL is valid for 15 minutes so that you can view and download the image

      • roleArn — (String)

        The ARN of the service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf. For more information, see Using service roles for AWS IoT SiteWise Monitor in the AWS IoT SiteWise User Guide.

Returns:

  • (AWS.Request)

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

See Also: