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

Class: AWS.IoTTwinMaker

Inherits:
AWS.Service show all
Identifier:
iottwinmaker
API Version:
2021-11-29
Defined in:
(unknown)

Overview

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

Service Description

IoT TwinMaker is a service that enables you to build operational digital twins of physical systems. IoT TwinMaker overlays measurements and analysis from real-world sensors, cameras, and enterprise applications so you can create data visualizations to monitor your physical factory, building, or industrial plant. You can use this real-world data to monitor operations and diagnose and repair errors.

Sending a Request Using IoTTwinMaker

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

var iottwinmaker = new AWS.IoTTwinMaker({apiVersion: '2021-11-29'});

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

AWS.config.apiVersions = {
  iottwinmaker: '2021-11-29',
  // other service API versions
};

var iottwinmaker = new AWS.IoTTwinMaker();

Version:

  • 2021-11-29

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

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

Examples:

Constructing a IoTTwinMaker object

var iottwinmaker = new AWS.IoTTwinMaker({apiVersion: '2021-11-29'});

Options Hash (options):

  • params (map)

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

  • endpoint (String|AWS.Endpoint)

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

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

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

  • credentialProvider (AWS.CredentialProviderChain)

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

  • region (String)

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

  • maxRetries (Integer)

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

  • maxRedirects (Integer)

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

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

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

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

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

  • convertResponseTypes (Boolean)

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

  • correctClockSkew (Boolean)

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

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

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

  • s3DisableBodySigning (Boolean)

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

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

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

  • s3UseArnRegion (Boolean)

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

  • retryDelayOptions (map)

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

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

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

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

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

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

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

  • logger (#write, #log)

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

  • systemClockOffset (Number)

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

  • signatureVersion (String)

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

  • signatureCache (Boolean)

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

  • dynamoDbCrc32 (Boolean)

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

  • useAccelerateEndpoint (Boolean)

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

  • clientSideMonitoring (Boolean)

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

  • endpointDiscoveryEnabled (Boolean|undefined)

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

  • endpointCacheSize (Number)

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

  • hostPrefixEnabled (Boolean)

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

  • stsRegionalEndpoints ('legacy'|'regional')

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

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpointAWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

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

Sets values for multiple time series properties.

Service Reference:

Examples:

Calling the batchPutPropertyValues operation

var params = {
  entries: [ /* required */
    {
      entityPropertyReference: { /* required */
        propertyName: 'STRING_VALUE', /* required */
        componentName: 'STRING_VALUE',
        entityId: 'STRING_VALUE',
        externalIdProperty: {
          '<String>': 'STRING_VALUE',
          /* '<String>': ... */
        }
      },
      propertyValues: [
        {
          value: { /* DataValue */ /* required */
            booleanValue: true || false,
            doubleValue: 'NUMBER_VALUE',
            expression: 'STRING_VALUE',
            integerValue: 'NUMBER_VALUE',
            listValue: [
              /* recursive DataValue */,
              /* more items */
            ],
            longValue: 'NUMBER_VALUE',
            mapValue: {
              '<String>': /* recursive DataValue */,
              /* '<String>': ... */
            },
            relationshipValue: {
              targetComponentName: 'STRING_VALUE',
              targetEntityId: 'STRING_VALUE'
            },
            stringValue: 'STRING_VALUE'
          },
          time: 'STRING_VALUE',
          timestamp: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  workspaceId: 'STRING_VALUE' /* required */
};
iottwinmaker.batchPutPropertyValues(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: {})
    • workspaceId — (String)

      The ID of the workspace that contains the properties to set.

    • entries — (Array<map>)

      An object that maps strings to the property value entries to set. Each string in the mapping must be unique to this object.

      • entityPropertyReferencerequired — (map)

        An object that contains information about the entity that has the property.

        • componentName — (String)

          The name of the component.

        • externalIdProperty — (map<String>)

          A mapping of external IDs to property names. External IDs uniquely identify properties from external data stores.

        • entityId — (String)

          The ID of the entity.

        • propertyNamerequired — (String)

          The name of the property.

      • propertyValues — (Array<map>)

        A list of objects that specify time series property values.

        • timestamp — (Date)

          The timestamp of a value for a time series property.

        • valuerequired — (map)

          An object that specifies a value for a time series property.

          • booleanValue — (Boolean)

            A Boolean value.

          • doubleValue — (Float)

            A double value.

          • integerValue — (Integer)

            An integer value.

          • longValue — (Integer)

            A long value.

          • stringValue — (String)

            A string value.

          • listValue — (Array<map>)

            A list of multiple values.

          • mapValue — (map<map>)

            An object that maps strings to multiple DataValue objects.

          • relationshipValue — (map)

            A value that relates a component to another component.

            • targetEntityId — (String)

              The ID of the target entity associated with this relationship value.

            • targetComponentName — (String)

              The name of the target component associated with the relationship value.

          • expression — (String)

            An expression that produces the value.

        • time — (String)

          ISO8601 DateTime of a value for a time series property.

          The time for when the property value was recorded in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.SSSSSSSSS][Z/±HH:mm].

          • [YYYY]: year

          • [MM]: month

          • [DD]: day

          • [hh]: hour

          • [mm]: minute

          • [ss]: seconds

          • [.SSSSSSSSS]: additional precision, where precedence is maintained. For example: [.573123] is equal to 573123000 nanoseconds.

          • Z: default timezone UTC

          • ± HH:mm: time zone offset in Hours and Minutes.

          Required sub-fields: YYYY-MM-DDThh:mm:ss and [Z/±HH:mm]

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>)

        Entries that caused errors in the batch put operation.

        • errorsrequired — (Array<map>)

          A list of objects that contain information about errors returned by the BatchPutProperty action.

          • errorCoderequired — (String)

            The error code.

          • errorMessagerequired — (String)

            The error message.

          • entryrequired — (map)

            An object that contains information about errors returned by the BatchPutProperty action.

            • entityPropertyReferencerequired — (map)

              An object that contains information about the entity that has the property.

              • componentName — (String)

                The name of the component.

              • externalIdProperty — (map<String>)

                A mapping of external IDs to property names. External IDs uniquely identify properties from external data stores.

              • entityId — (String)

                The ID of the entity.

              • propertyNamerequired — (String)

                The name of the property.

            • propertyValues — (Array<map>)

              A list of objects that specify time series property values.

              • timestamp — (Date)

                The timestamp of a value for a time series property.

              • valuerequired — (map)

                An object that specifies a value for a time series property.

                • booleanValue — (Boolean)

                  A Boolean value.

                • doubleValue — (Float)

                  A double value.

                • integerValue — (Integer)

                  An integer value.

                • longValue — (Integer)

                  A long value.

                • stringValue — (String)

                  A string value.

                • listValue — (Array<map>)

                  A list of multiple values.

                • mapValue — (map<map>)

                  An object that maps strings to multiple DataValue objects.

                • relationshipValue — (map)

                  A value that relates a component to another component.

                  • targetEntityId — (String)

                    The ID of the target entity associated with this relationship value.

                  • targetComponentName — (String)

                    The name of the target component associated with the relationship value.

                • expression — (String)

                  An expression that produces the value.

              • time — (String)

                ISO8601 DateTime of a value for a time series property.

                The time for when the property value was recorded in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.SSSSSSSSS][Z/±HH:mm].

                • [YYYY]: year

                • [MM]: month

                • [DD]: day

                • [hh]: hour

                • [mm]: minute

                • [ss]: seconds

                • [.SSSSSSSSS]: additional precision, where precedence is maintained. For example: [.573123] is equal to 573123000 nanoseconds.

                • Z: default timezone UTC

                • ± HH:mm: time zone offset in Hours and Minutes.

                Required sub-fields: YYYY-MM-DDThh:mm:ss and [Z/±HH:mm]

Returns:

  • (AWS.Request)

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

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

Creates a component type.

Service Reference:

Examples:

Calling the createComponentType operation

var params = {
  componentTypeId: 'STRING_VALUE', /* required */
  workspaceId: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  extendsFrom: [
    'STRING_VALUE',
    /* more items */
  ],
  functions: {
    '<Name>': {
      implementedBy: {
        isNative: true || false,
        lambda: {
          arn: 'STRING_VALUE' /* required */
        }
      },
      requiredProperties: [
        'STRING_VALUE',
        /* more items */
      ],
      scope: ENTITY | WORKSPACE
    },
    /* '<Name>': ... */
  },
  isSingleton: true || false,
  propertyDefinitions: {
    '<Name>': {
      configuration: {
        '<Name>': 'STRING_VALUE',
        /* '<Name>': ... */
      },
      dataType: { /* DataType */
        type: RELATIONSHIP | STRING | LONG | BOOLEAN | INTEGER | DOUBLE | LIST | MAP, /* required */
        allowedValues: [ /* DataValueList */
          { /* DataValue */
            booleanValue: true || false,
            doubleValue: 'NUMBER_VALUE',
            expression: 'STRING_VALUE',
            integerValue: 'NUMBER_VALUE',
            listValue: /* recursive DataValueList */,
            longValue: 'NUMBER_VALUE',
            mapValue: {
              '<String>': /* recursive DataValue */,
              /* '<String>': ... */
            },
            relationshipValue: {
              targetComponentName: 'STRING_VALUE',
              targetEntityId: 'STRING_VALUE'
            },
            stringValue: 'STRING_VALUE'
          },
          /* more items */
        ],
        nestedType: /* recursive DataType */,
        relationship: {
          relationshipType: 'STRING_VALUE',
          targetComponentTypeId: 'STRING_VALUE'
        },
        unitOfMeasure: 'STRING_VALUE'
      },
      defaultValue: { /* DataValue */
        booleanValue: true || false,
        doubleValue: 'NUMBER_VALUE',
        expression: 'STRING_VALUE',
        integerValue: 'NUMBER_VALUE',
        listValue: [ /* DataValueList */
          /* recursive DataValue */,
          /* more items */
        ],
        longValue: 'NUMBER_VALUE',
        mapValue: {
          '<String>': /* recursive DataValue */,
          /* '<String>': ... */
        },
        relationshipValue: {
          targetComponentName: 'STRING_VALUE',
          targetEntityId: 'STRING_VALUE'
        },
        stringValue: 'STRING_VALUE'
      },
      isExternalId: true || false,
      isRequiredInEntity: true || false,
      isStoredExternally: true || false,
      isTimeSeries: true || false
    },
    /* '<Name>': ... */
  },
  propertyGroups: {
    '<Name>': {
      groupType: TABULAR,
      propertyNames: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* '<Name>': ... */
  },
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
iottwinmaker.createComponentType(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: {})
    • workspaceId — (String)

      The ID of the workspace that contains the component type.

    • isSingleton — (Boolean)

      A Boolean value that specifies whether an entity can have more than one component of this type.

    • componentTypeId — (String)

      The ID of the component type.

    • description — (String)

      The description of the component type.

    • propertyDefinitions — (map<map>)

      An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.

      • dataType — (map)

        An object that contains information about the data type.

        • typerequired — (String)

          The underlying type of the data type.

          Possible values include:
          • "RELATIONSHIP"
          • "STRING"
          • "LONG"
          • "BOOLEAN"
          • "INTEGER"
          • "DOUBLE"
          • "LIST"
          • "MAP"
        • allowedValues — (Array<map>)

          The allowed values for this data type.

          • booleanValue — (Boolean)

            A Boolean value.

          • doubleValue — (Float)

            A double value.

          • integerValue — (Integer)

            An integer value.

          • longValue — (Integer)

            A long value.

          • stringValue — (String)

            A string value.

          • mapValue — (map<map>)

            An object that maps strings to multiple DataValue objects.

          • relationshipValue — (map)

            A value that relates a component to another component.

            • targetEntityId — (String)

              The ID of the target entity associated with this relationship value.

            • targetComponentName — (String)

              The name of the target component associated with the relationship value.

          • expression — (String)

            An expression that produces the value.

        • unitOfMeasure — (String)

          The unit of measure used in this data type.

        • relationship — (map)

          A relationship that associates a component with another component.

          • targetComponentTypeId — (String)

            The ID of the target component type associated with this relationship.

          • relationshipType — (String)

            The type of the relationship.

      • isRequiredInEntity — (Boolean)

        A Boolean value that specifies whether the property is required.

      • isExternalId — (Boolean)

        A Boolean value that specifies whether the property ID comes from an external data store.

      • isStoredExternally — (Boolean)

        A Boolean value that specifies whether the property is stored externally.

      • isTimeSeries — (Boolean)

        A Boolean value that specifies whether the property consists of time series data.

      • defaultValue — (map)

        An object that contains the default value.

        • booleanValue — (Boolean)

          A Boolean value.

        • doubleValue — (Float)

          A double value.

        • integerValue — (Integer)

          An integer value.

        • longValue — (Integer)

          A long value.

        • stringValue — (String)

          A string value.

        • listValue — (Array<map>)

          A list of multiple values.

        • mapValue — (map<map>)

          An object that maps strings to multiple DataValue objects.

        • relationshipValue — (map)

          A value that relates a component to another component.

          • targetEntityId — (String)

            The ID of the target entity associated with this relationship value.

          • targetComponentName — (String)

            The name of the target component associated with the relationship value.

        • expression — (String)

          An expression that produces the value.

      • configuration — (map<String>)

        A mapping that specifies configuration information about the property. Use this field to specify information that you read from and write to an external source.

    • extendsFrom — (Array<String>)

      Specifies the parent component type to extend.

    • functions — (map<map>)

      An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.

      • requiredProperties — (Array<String>)

        The required properties of the function.

      • scope — (String)

        The scope of the function.

        Possible values include:
        • "ENTITY"
        • "WORKSPACE"
      • implementedBy — (map)

        The data connector.

        • lambda — (map)

          The Lambda function associated with this data connector.

          • arnrequired — (String)

            The ARN of the Lambda function.

        • isNative — (Boolean)

          A Boolean value that specifies whether the data connector is native to IoT TwinMaker.

    • tags — (map<String>)

      Metadata that you can use to manage the component type.

    • propertyGroups — (map<map>)

      • groupType — (String)

        The group type.

        Possible values include:
        • "TABULAR"
      • propertyNames — (Array<String>)

        The names of properties.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • arn — (String)

        The ARN of the component type.

      • creationDateTime — (Date)

        The date and time when the entity was created.

      • state — (String)

        The current state of the component type.

        Possible values include:
        • "CREATING"
        • "UPDATING"
        • "DELETING"
        • "ACTIVE"
        • "ERROR"

Returns:

  • (AWS.Request)

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

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

Creates an entity.

Service Reference:

Examples:

Calling the createEntity operation

var params = {
  entityName: 'STRING_VALUE', /* required */
  workspaceId: 'STRING_VALUE', /* required */
  components: {
    '<Name>': {
      componentTypeId: 'STRING_VALUE',
      description: 'STRING_VALUE',
      properties: {
        '<Name>': {
          definition: {
            configuration: {
              '<Name>': 'STRING_VALUE',
              /* '<Name>': ... */
            },
            dataType: { /* DataType */
              type: RELATIONSHIP | STRING | LONG | BOOLEAN | INTEGER | DOUBLE | LIST | MAP, /* required */
              allowedValues: [ /* DataValueList */
                { /* DataValue */
                  booleanValue: true || false,
                  doubleValue: 'NUMBER_VALUE',
                  expression: 'STRING_VALUE',
                  integerValue: 'NUMBER_VALUE',
                  listValue: /* recursive DataValueList */,
                  longValue: 'NUMBER_VALUE',
                  mapValue: {
                    '<String>': /* recursive DataValue */,
                    /* '<String>': ... */
                  },
                  relationshipValue: {
                    targetComponentName: 'STRING_VALUE',
                    targetEntityId: 'STRING_VALUE'
                  },
                  stringValue: 'STRING_VALUE'
                },
                /* more items */
              ],
              nestedType: /* recursive DataType */,
              relationship: {
                relationshipType: 'STRING_VALUE',
                targetComponentTypeId: 'STRING_VALUE'
              },
              unitOfMeasure: 'STRING_VALUE'
            },
            defaultValue: { /* DataValue */
              booleanValue: true || false,
              doubleValue: 'NUMBER_VALUE',
              expression: 'STRING_VALUE',
              integerValue: 'NUMBER_VALUE',
              listValue: [ /* DataValueList */
                /* recursive DataValue */,
                /* more items */
              ],
              longValue: 'NUMBER_VALUE',
              mapValue: {
                '<String>': /* recursive DataValue */,
                /* '<String>': ... */
              },
              relationshipValue: {
                targetComponentName: 'STRING_VALUE',
                targetEntityId: 'STRING_VALUE'
              },
              stringValue: 'STRING_VALUE'
            },
            isExternalId: true || false,
            isRequiredInEntity: true || false,
            isStoredExternally: true || false,
            isTimeSeries: true || false
          },
          updateType: UPDATE | DELETE | CREATE,
          value: { /* DataValue */
            booleanValue: true || false,
            doubleValue: 'NUMBER_VALUE',
            expression: 'STRING_VALUE',
            integerValue: 'NUMBER_VALUE',
            listValue: [ /* DataValueList */
              /* recursive DataValue */,
              /* more items */
            ],
            longValue: 'NUMBER_VALUE',
            mapValue: {
              '<String>': /* recursive DataValue */,
              /* '<String>': ... */
            },
            relationshipValue: {
              targetComponentName: 'STRING_VALUE',
              targetEntityId: 'STRING_VALUE'
            },
            stringValue: 'STRING_VALUE'
          }
        },
        /* '<Name>': ... */
      },
      propertyGroups: {
        '<Name>': {
          groupType: TABULAR,
          propertyNames: [
            'STRING_VALUE',
            /* more items */
          ],
          updateType: UPDATE | DELETE | CREATE
        },
        /* '<Name>': ... */
      }
    },
    /* '<Name>': ... */
  },
  description: 'STRING_VALUE',
  entityId: 'STRING_VALUE',
  parentEntityId: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
iottwinmaker.createEntity(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: {})
    • workspaceId — (String)

      The ID of the workspace that contains the entity.

    • entityId — (String)

      The ID of the entity.

    • entityName — (String)

      The name of the entity.

    • description — (String)

      The description of the entity.

    • components — (map<map>)

      An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.

      • description — (String)

        The description of the component request.

      • componentTypeId — (String)

        The ID of the component type.

      • properties — (map<map>)

        An object that maps strings to the properties to set in the component type. Each string in the mapping must be unique to this object.

        • definition — (map)

          An object that specifies information about a property.

          • dataType — (map)

            An object that contains information about the data type.

            • typerequired — (String)

              The underlying type of the data type.

              Possible values include:
              • "RELATIONSHIP"
              • "STRING"
              • "LONG"
              • "BOOLEAN"
              • "INTEGER"
              • "DOUBLE"
              • "LIST"
              • "MAP"
            • allowedValues — (Array<map>)

              The allowed values for this data type.

              • booleanValue — (Boolean)

                A Boolean value.

              • doubleValue — (Float)

                A double value.

              • integerValue — (Integer)

                An integer value.

              • longValue — (Integer)

                A long value.

              • stringValue — (String)

                A string value.

              • mapValue — (map<map>)

                An object that maps strings to multiple DataValue objects.

              • relationshipValue — (map)

                A value that relates a component to another component.

                • targetEntityId — (String)

                  The ID of the target entity associated with this relationship value.

                • targetComponentName — (String)

                  The name of the target component associated with the relationship value.

              • expression — (String)

                An expression that produces the value.

            • unitOfMeasure — (String)

              The unit of measure used in this data type.

            • relationship — (map)

              A relationship that associates a component with another component.

              • targetComponentTypeId — (String)

                The ID of the target component type associated with this relationship.

              • relationshipType — (String)

                The type of the relationship.

          • isRequiredInEntity — (Boolean)

            A Boolean value that specifies whether the property is required.

          • isExternalId — (Boolean)

            A Boolean value that specifies whether the property ID comes from an external data store.

          • isStoredExternally — (Boolean)

            A Boolean value that specifies whether the property is stored externally.

          • isTimeSeries — (Boolean)

            A Boolean value that specifies whether the property consists of time series data.

          • defaultValue — (map)

            An object that contains the default value.

            • booleanValue — (Boolean)

              A Boolean value.

            • doubleValue — (Float)

              A double value.

            • integerValue — (Integer)

              An integer value.

            • longValue — (Integer)

              A long value.

            • stringValue — (String)

              A string value.

            • listValue — (Array<map>)

              A list of multiple values.

            • mapValue — (map<map>)

              An object that maps strings to multiple DataValue objects.

            • relationshipValue — (map)

              A value that relates a component to another component.

              • targetEntityId — (String)

                The ID of the target entity associated with this relationship value.

              • targetComponentName — (String)

                The name of the target component associated with the relationship value.

            • expression — (String)

              An expression that produces the value.

          • configuration — (map<String>)

            A mapping that specifies configuration information about the property. Use this field to specify information that you read from and write to an external source.

        • value — (map)

          The value of the property.

          • booleanValue — (Boolean)

            A Boolean value.

          • doubleValue — (Float)

            A double value.

          • integerValue — (Integer)

            An integer value.

          • longValue — (Integer)

            A long value.

          • stringValue — (String)

            A string value.

          • listValue — (Array<map>)

            A list of multiple values.

          • mapValue — (map<map>)

            An object that maps strings to multiple DataValue objects.

          • relationshipValue — (map)

            A value that relates a component to another component.

            • targetEntityId — (String)

              The ID of the target entity associated with this relationship value.

            • targetComponentName — (String)

              The name of the target component associated with the relationship value.

          • expression — (String)

            An expression that produces the value.

        • updateType — (String)

          The update type of the update property request.

          Possible values include:
          • "UPDATE"
          • "DELETE"
          • "CREATE"
      • propertyGroups — (map<map>)

        The property groups.

        • groupType — (String)

          The group type.

          Possible values include:
          • "TABULAR"
        • propertyNames — (Array<String>)

          The property names.

        • updateType — (String)

          The update type.

          Possible values include:
          • "UPDATE"
          • "DELETE"
          • "CREATE"
    • parentEntityId — (String)

      The ID of the entity's parent entity.

    • tags — (map<String>)

      Metadata that you can use to manage the entity.

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:

      • entityId — (String)

        The ID of the entity.

      • arn — (String)

        The ARN of the entity.

      • creationDateTime — (Date)

        The date and time when the entity was created.

      • state — (String)

        The current state of the entity.

        Possible values include:
        • "CREATING"
        • "UPDATING"
        • "DELETING"
        • "ACTIVE"
        • "ERROR"

Returns:

  • (AWS.Request)

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

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

Creates a scene.

Service Reference:

Examples:

Calling the createScene operation

var params = {
  contentLocation: 'STRING_VALUE', /* required */
  sceneId: 'STRING_VALUE', /* required */
  workspaceId: 'STRING_VALUE', /* required */
  capabilities: [
    'STRING_VALUE',
    /* more items */
  ],
  description: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
iottwinmaker.createScene(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: {})
    • workspaceId — (String)

      The ID of the workspace that contains the scene.

    • sceneId — (String)

      The ID of the scene.

    • contentLocation — (String)

      The relative path that specifies the location of the content definition file.

    • description — (String)

      The description for this scene.

    • capabilities — (Array<String>)

      A list of capabilities that the scene uses to render itself.

    • tags — (map<String>)

      Metadata that you can use to manage the scene.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • arn — (String)

        The ARN of the scene.

      • creationDateTime — (Date)

        The date and time when the scene was created.

Returns:

  • (AWS.Request)

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

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

Creates a workplace.

Service Reference:

Examples:

Calling the createWorkspace operation

var params = {
  role: 'STRING_VALUE', /* required */
  s3Location: 'STRING_VALUE', /* required */
  workspaceId: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
iottwinmaker.createWorkspace(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: {})
    • workspaceId — (String)

      The ID of the workspace.

    • description — (String)

      The description of the workspace.

    • s3Location — (String)

      The ARN of the S3 bucket where resources associated with the workspace are stored.

    • role — (String)

      The ARN of the execution role associated with the workspace.

    • tags — (map<String>)

      Metadata that you can use to manage the workspace

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • arn — (String)

        The ARN of the workspace.

      • creationDateTime — (Date)

        The date and time when the workspace was created.

Returns:

  • (AWS.Request)

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

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

Deletes a component type.

Service Reference:

Examples:

Calling the deleteComponentType operation

var params = {
  componentTypeId: 'STRING_VALUE', /* required */
  workspaceId: 'STRING_VALUE' /* required */
};
iottwinmaker.deleteComponentType(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: {})
    • workspaceId — (String)

      The ID of the workspace that contains the component type.

    • componentTypeId — (String)

      The ID of the component type to delete.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • state — (String)

        The current state of the component type to be deleted.

        Possible values include:
        • "CREATING"
        • "UPDATING"
        • "DELETING"
        • "ACTIVE"
        • "ERROR"

Returns:

  • (AWS.Request)

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

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

Deletes an entity.

Service Reference:

Examples:

Calling the deleteEntity operation

var params = {
  entityId: 'STRING_VALUE', /* required */
  workspaceId: 'STRING_VALUE', /* required */
  isRecursive: true || false
};
iottwinmaker.deleteEntity(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: {})
    • workspaceId — (String)

      The ID of the workspace that contains the entity to delete.

    • entityId — (String)

      The ID of the entity to delete.

    • isRecursive — (Boolean)

      A Boolean value that specifies whether the operation deletes child entities.

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:

      • state — (String)

        The current state of the deleted entity.

        Possible values include:
        • "CREATING"
        • "UPDATING"
        • "DELETING"
        • "ACTIVE"
        • "ERROR"

Returns:

  • (AWS.Request)

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

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

Deletes a scene.

Service Reference:

Examples:

Calling the deleteScene operation

var params = {
  sceneId: 'STRING_VALUE', /* required */
  workspaceId: 'STRING_VALUE' /* required */
};
iottwinmaker.deleteScene(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: {})
    • workspaceId — (String)

      The ID of the workspace.

    • sceneId — (String)

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

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

Deletes a workspace.

Service Reference:

Examples:

Calling the deleteWorkspace operation

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

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

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

Run queries to access information from your knowledge graph of entities within individual workspaces.

Service Reference:

Examples:

Calling the executeQuery operation

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

      The ID of the workspace.

    • queryStatement — (String)

      The query statement.

    • maxResults — (Integer)

      The maximum number of results to return at one time. The default is 25.

      Valid Range: Minimum value of 1. Maximum value of 250.

    • nextToken — (String)

      The string that specifies the next page of results.

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:

      • columnDescriptions — (Array<map>)

        A list of ColumnDescription objects.

        • name — (String)

          The name of the column description.

        • type — (String)

          The type of the column description.

          Possible values include:
          • "NODE"
          • "EDGE"
          • "VALUE"
      • rows — (Array<map>)

        Represents a single row in the query results.

        • rowData — (Array<map>)

          The data in a row of query results.

      • nextToken — (String)

        The string that specifies the next page of results.

Returns:

  • (AWS.Request)

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

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

Retrieves information about a component type.

Service Reference:

Examples:

Calling the getComponentType operation

var params = {
  componentTypeId: 'STRING_VALUE', /* required */
  workspaceId: 'STRING_VALUE' /* required */
};
iottwinmaker.getComponentType(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: {})
    • workspaceId — (String)

      The ID of the workspace that contains the component type.

    • componentTypeId — (String)

      The ID of the component type.

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:

      • workspaceId — (String)

        The ID of the workspace that contains the component type.

      • isSingleton — (Boolean)

        A Boolean value that specifies whether an entity can have more than one component of this type.

      • componentTypeId — (String)

        The ID of the component type.

      • description — (String)

        The description of the component type.

      • propertyDefinitions — (map<map>)

        An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.

        • dataTyperequired — (map)

          An object that contains information about the data type.

          • typerequired — (String)

            The underlying type of the data type.

            Possible values include:
            • "RELATIONSHIP"
            • "STRING"
            • "LONG"
            • "BOOLEAN"
            • "INTEGER"
            • "DOUBLE"
            • "LIST"
            • "MAP"
          • allowedValues — (Array<map>)

            The allowed values for this data type.

            • booleanValue — (Boolean)

              A Boolean value.

            • doubleValue — (Float)

              A double value.

            • integerValue — (Integer)

              An integer value.

            • longValue — (Integer)

              A long value.

            • stringValue — (String)

              A string value.

            • mapValue — (map<map>)

              An object that maps strings to multiple DataValue objects.

            • relationshipValue — (map)

              A value that relates a component to another component.

              • targetEntityId — (String)

                The ID of the target entity associated with this relationship value.

              • targetComponentName — (String)

                The name of the target component associated with the relationship value.

            • expression — (String)

              An expression that produces the value.

          • unitOfMeasure — (String)

            The unit of measure used in this data type.

          • relationship — (map)

            A relationship that associates a component with another component.

            • targetComponentTypeId — (String)

              The ID of the target component type associated with this relationship.

            • relationshipType — (String)

              The type of the relationship.

        • isTimeSeriesrequired — (Boolean)

          A Boolean value that specifies whether the property consists of time series data.

        • isRequiredInEntityrequired — (Boolean)

          A Boolean value that specifies whether the property is required in an entity.

        • isExternalIdrequired — (Boolean)

          A Boolean value that specifies whether the property ID comes from an external data store.

        • isStoredExternallyrequired — (Boolean)

          A Boolean value that specifies whether the property is stored externally.

        • isImportedrequired — (Boolean)

          A Boolean value that specifies whether the property definition is imported from an external data store.

        • isFinalrequired — (Boolean)

          A Boolean value that specifies whether the property definition can be updated.

        • isInheritedrequired — (Boolean)

          A Boolean value that specifies whether the property definition is inherited from a parent entity.

        • defaultValue — (map)

          An object that contains the default value.

          • booleanValue — (Boolean)

            A Boolean value.

          • doubleValue — (Float)

            A double value.

          • integerValue — (Integer)

            An integer value.

          • longValue — (Integer)

            A long value.

          • stringValue — (String)

            A string value.

          • listValue — (Array<map>)

            A list of multiple values.

          • mapValue — (map<map>)

            An object that maps strings to multiple DataValue objects.

          • relationshipValue — (map)

            A value that relates a component to another component.

            • targetEntityId — (String)

              The ID of the target entity associated with this relationship value.

            • targetComponentName — (String)

              The name of the target component associated with the relationship value.

          • expression — (String)

            An expression that produces the value.

        • configuration — (map<String>)

          A mapping that specifies configuration information about the property.

      • extendsFrom — (Array<String>)

        The name of the parent component type that this component type extends.

      • functions — (map<map>)

        An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.

        • requiredProperties — (Array<String>)

          The required properties of the function.

        • scope — (String)

          The scope of the function.

          Possible values include:
          • "ENTITY"
          • "WORKSPACE"
        • implementedBy — (map)

          The data connector.

          • lambda — (map)

            The Lambda function associated with this data connector.

            • arnrequired — (String)

              The ARN of the Lambda function.

          • isNative — (Boolean)

            A Boolean value that specifies whether the data connector is native to IoT TwinMaker.

        • isInherited — (Boolean)

          Indicates whether this function is inherited.

      • creationDateTime — (Date)

        The date and time when the component type was created.

      • updateDateTime — (Date)

        The date and time when the component was last updated.

      • arn — (String)

        The ARN of the component type.

      • isAbstract — (Boolean)

        A Boolean value that specifies whether the component type is abstract.

      • isSchemaInitialized — (Boolean)

        A Boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.

      • status — (map)

        The current status of the component type.

        • state — (String)

          The current state of the entity, component, component type, or workspace.

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

          The error message.

          • code — (String)

            The error code.

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

            The error message.

      • propertyGroups — (map<map>)

        The maximum number of results to return at one time. The default is 25.

        Valid Range: Minimum value of 1. Maximum value of 250.

        • groupTyperequired — (String)

          The group types.

          Possible values include:
          • "TABULAR"
        • propertyNamesrequired — (Array<String>)

          The names of properties.

        • isInheritedrequired — (Boolean)

          A Boolean value that specifies whether the property group is inherited from a parent entity

Returns:

  • (AWS.Request)

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

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

Retrieves information about an entity.

Service Reference:

Examples:

Calling the getEntity operation

var params = {
  entityId: 'STRING_VALUE', /* required */
  workspaceId: 'STRING_VALUE' /* required */
};
iottwinmaker.getEntity(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: {})
    • workspaceId — (String)

      The ID of the workspace.

    • entityId — (String)

      The ID of the entity.

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:

      • entityId — (String)

        The ID of the entity.

      • entityName — (String)

        The name of the entity.

      • arn — (String)

        The ARN of the entity.

      • status — (map)

        The current status of the entity.

        • state — (String)

          The current state of the entity, component, component type, or workspace.

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

          The error message.

          • code — (String)

            The error code.

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

            The error message.

      • workspaceId — (String)

        The ID of the workspace.

      • description — (String)

        The description of the entity.

      • components — (map<map>)

        An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.

        • componentName — (String)

          The name of the component.

        • description — (String)

          The description of the component type.

        • componentTypeId — (String)

          The ID of the component type.

        • status — (map)

          The status of the component type.

          • state — (String)

            The current state of the entity, component, component type, or workspace.

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

            The error message.

            • code — (String)

              The error code.

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

              The error message.

        • definedIn — (String)

          The name of the property definition set in the request.

        • properties — (map<map>)

          An object that maps strings to the properties to set in the component type. Each string in the mapping must be unique to this object.

          • definition — (map)

            An object that specifies information about a property.

            • dataTyperequired — (map)

              An object that contains information about the data type.

              • typerequired — (String)

                The underlying type of the data type.

                Possible values include:
                • "RELATIONSHIP"
                • "STRING"
                • "LONG"
                • "BOOLEAN"
                • "INTEGER"
                • "DOUBLE"
                • "LIST"
                • "MAP"
              • allowedValues — (Array<map>)

                The allowed values for this data type.

                • booleanValue — (Boolean)

                  A Boolean value.

                • doubleValue — (Float)

                  A double value.

                • integerValue — (Integer)

                  An integer value.

                • longValue — (Integer)

                  A long value.

                • stringValue — (String)

                  A string value.

                • mapValue — (map<map>)

                  An object that maps strings to multiple DataValue objects.

                • relationshipValue — (map)

                  A value that relates a component to another component.

                  • targetEntityId — (String)

                    The ID of the target entity associated with this relationship value.

                  • targetComponentName — (String)

                    The name of the target component associated with the relationship value.

                • expression — (String)

                  An expression that produces the value.

              • unitOfMeasure — (String)

                The unit of measure used in this data type.

              • relationship — (map)

                A relationship that associates a component with another component.

                • targetComponentTypeId — (String)

                  The ID of the target component type associated with this relationship.

                • relationshipType — (String)

                  The type of the relationship.

            • isTimeSeriesrequired — (Boolean)

              A Boolean value that specifies whether the property consists of time series data.

            • isRequiredInEntityrequired — (Boolean)

              A Boolean value that specifies whether the property is required in an entity.

            • isExternalIdrequired — (Boolean)

              A Boolean value that specifies whether the property ID comes from an external data store.

            • isStoredExternallyrequired — (Boolean)

              A Boolean value that specifies whether the property is stored externally.

            • isImportedrequired — (Boolean)

              A Boolean value that specifies whether the property definition is imported from an external data store.

            • isFinalrequired — (Boolean)

              A Boolean value that specifies whether the property definition can be updated.

            • isInheritedrequired — (Boolean)

              A Boolean value that specifies whether the property definition is inherited from a parent entity.

            • defaultValue — (map)

              An object that contains the default value.

              • booleanValue — (Boolean)

                A Boolean value.

              • doubleValue — (Float)

                A double value.

              • integerValue — (Integer)

                An integer value.

              • longValue — (Integer)

                A long value.

              • stringValue — (String)

                A string value.

              • listValue — (Array<map>)

                A list of multiple values.

              • mapValue — (map<map>)

                An object that maps strings to multiple DataValue objects.

              • relationshipValue — (map)

                A value that relates a component to another component.

                • targetEntityId — (String)

                  The ID of the target entity associated with this relationship value.

                • targetComponentName — (String)

                  The name of the target component associated with the relationship value.

              • expression — (String)

                An expression that produces the value.

            • configuration — (map<String>)

              A mapping that specifies configuration information about the property.

          • value — (map)

            The value of the property.

            • booleanValue — (Boolean)

              A Boolean value.

            • doubleValue — (Float)

              A double value.

            • integerValue — (Integer)

              An integer value.

            • longValue — (Integer)

              A long value.

            • stringValue — (String)

              A string value.

            • listValue — (Array<map>)

              A list of multiple values.

            • mapValue — (map<map>)

              An object that maps strings to multiple DataValue objects.

            • relationshipValue — (map)

              A value that relates a component to another component.

              • targetEntityId — (String)

                The ID of the target entity associated with this relationship value.

              • targetComponentName — (String)

                The name of the target component associated with the relationship value.

            • expression — (String)

              An expression that produces the value.

        • propertyGroups — (map<map>)

          The property groups.

          • groupTyperequired — (String)

            The group type.

            Possible values include:
            • "TABULAR"
          • propertyNamesrequired — (Array<String>)

            The names of properties

          • isInheritedrequired — (Boolean)

            A Boolean value that specifies whether the property group is inherited from a parent entity

      • parentEntityId — (String)

        The ID of the parent entity for this entity.

      • hasChildEntities — (Boolean)

        A Boolean value that specifies whether the entity has associated child entities.

      • creationDateTime — (Date)

        The date and time when the entity was created.

      • updateDateTime — (Date)

        The date and time when the entity was last updated.

Returns:

  • (AWS.Request)

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

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

Gets the pricing plan.

Service Reference:

Examples:

Calling the getPricingPlan operation

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

      • currentPricingPlan — (map)

        The chosen pricing plan for the current billing cycle.

        • billableEntityCount — (Integer)

          The billable entity count.

        • bundleInformation — (map)

          The pricing plan's bundle information.

          • bundleNamesrequired — (Array<String>)

            The bundle names.

          • pricingTier — (String)

            The pricing tier.

            Possible values include:
            • "TIER_1"
            • "TIER_2"
            • "TIER_3"
            • "TIER_4"
        • effectiveDateTimerequired — (Date)

          The effective date and time of the pricing plan.

        • pricingModerequired — (String)

          The pricing mode.

          Possible values include:
          • "BASIC"
          • "STANDARD"
          • "TIERED_BUNDLE"
        • updateDateTimerequired — (Date)

          The set date and time for updating a pricing plan.

        • updateReasonrequired — (String)

          The update reason, for changing a pricing plan.

          Possible values include:
          • "DEFAULT"
          • "PRICING_TIER_UPDATE"
          • "ENTITY_COUNT_UPDATE"
          • "PRICING_MODE_UPDATE"
          • "OVERWRITTEN"
      • pendingPricingPlan — (map)

        The pending pricing plan.

        • billableEntityCount — (Integer)

          The billable entity count.

        • bundleInformation — (map)

          The pricing plan's bundle information.

          • bundleNamesrequired — (Array<String>)

            The bundle names.

          • pricingTier — (String)

            The pricing tier.

            Possible values include:
            • "TIER_1"
            • "TIER_2"
            • "TIER_3"
            • "TIER_4"
        • effectiveDateTimerequired — (Date)

          The effective date and time of the pricing plan.

        • pricingModerequired — (String)

          The pricing mode.

          Possible values include:
          • "BASIC"
          • "STANDARD"
          • "TIERED_BUNDLE"
        • updateDateTimerequired — (Date)

          The set date and time for updating a pricing plan.

        • updateReasonrequired — (String)

          The update reason, for changing a pricing plan.

          Possible values include:
          • "DEFAULT"
          • "PRICING_TIER_UPDATE"
          • "ENTITY_COUNT_UPDATE"
          • "PRICING_MODE_UPDATE"
          • "OVERWRITTEN"

Returns:

  • (AWS.Request)

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

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

Gets the property values for a component, component type, entity, or workspace.

You must specify a value for either componentName, componentTypeId, entityId, or workspaceId.

Service Reference:

Examples:

Calling the getPropertyValue operation

var params = {
  selectedProperties: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  workspaceId: 'STRING_VALUE', /* required */
  componentName: 'STRING_VALUE',
  componentTypeId: 'STRING_VALUE',
  entityId: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  propertyGroupName: 'STRING_VALUE',
  tabularConditions: {
    orderBy: [
      {
        propertyName: 'STRING_VALUE', /* required */
        order: ASCENDING | DESCENDING
      },
      /* more items */
    ],
    propertyFilters: [
      {
        operator: 'STRING_VALUE',
        propertyName: 'STRING_VALUE',
        value: { /* DataValue */
          booleanValue: true || false,
          doubleValue: 'NUMBER_VALUE',
          expression: 'STRING_VALUE',
          integerValue: 'NUMBER_VALUE',
          listValue: [
            /* recursive DataValue */,
            /* more items */
          ],
          longValue: 'NUMBER_VALUE',
          mapValue: {
            '<String>': /* recursive DataValue */,
            /* '<String>': ... */
          },
          relationshipValue: {
            targetComponentName: 'STRING_VALUE',
            targetEntityId: 'STRING_VALUE'
          },
          stringValue: 'STRING_VALUE'
        }
      },
      /* more items */
    ]
  }
};
iottwinmaker.getPropertyValue(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: {})
    • componentName — (String)

      The name of the component whose property values the operation returns.

    • componentTypeId — (String)

      The ID of the component type whose property values the operation returns.

    • entityId — (String)

      The ID of the entity whose property values the operation returns.

    • selectedProperties — (Array<String>)

      The properties whose values the operation returns.

    • workspaceId — (String)

      The ID of the workspace whose values the operation returns.

    • maxResults — (Integer)

      The maximum number of results to return at one time. The default is 25.

      Valid Range: Minimum value of 1. Maximum value of 250.

    • nextToken — (String)

      The string that specifies the next page of results.

    • propertyGroupName — (String)

      The property group name.

    • tabularConditions — (map)

      The tabular conditions.

      • orderBy — (Array<map>)

        Filter criteria that orders the output. It can be sorted in ascending or descending order.

        • order — (String)

          The set order that filters results.

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

          The property name.

      • propertyFilters — (Array<map>)

        You can filter the request using various logical operators and a key-value format. For example:

        {"key": "serverType", "value": "webServer"}

        • propertyName — (String)

          The property name associated with this property filter.

        • operator — (String)

          The operator associated with this property filter.

        • value — (map)

          The value associated with this property filter.

          • booleanValue — (Boolean)

            A Boolean value.

          • doubleValue — (Float)

            A double value.

          • integerValue — (Integer)

            An integer value.

          • longValue — (Integer)

            A long value.

          • stringValue — (String)

            A string value.

          • listValue — (Array<map>)

            A list of multiple values.

          • mapValue — (map<map>)

            An object that maps strings to multiple DataValue objects.

          • relationshipValue — (map)

            A value that relates a component to another component.

            • targetEntityId — (String)

              The ID of the target entity associated with this relationship value.

            • targetComponentName — (String)

              The name of the target component associated with the relationship value.

          • expression — (String)

            An expression that produces the value.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • propertyValues — (map<map>)

        An object that maps strings to the properties and latest property values in the response. Each string in the mapping must be unique to this object.

        • propertyReferencerequired — (map)

          An object that specifies information about a property.>

          • componentName — (String)

            The name of the component.

          • externalIdProperty — (map<String>)

            A mapping of external IDs to property names. External IDs uniquely identify properties from external data stores.

          • entityId — (String)

            The ID of the entity.

          • propertyNamerequired — (String)

            The name of the property.

        • propertyValue — (map)

          The value of the property.

          • booleanValue — (Boolean)

            A Boolean value.

          • doubleValue — (Float)

            A double value.

          • integerValue — (Integer)

            An integer value.

          • longValue — (Integer)

            A long value.

          • stringValue — (String)

            A string value.

          • listValue — (Array<map>)

            A list of multiple values.

          • mapValue — (map<map>)

            An object that maps strings to multiple DataValue objects.

          • relationshipValue — (map)

            A value that relates a component to another component.

            • targetEntityId — (String)

              The ID of the target entity associated with this relationship value.

            • targetComponentName — (String)

              The name of the target component associated with the relationship value.

          • expression — (String)

            An expression that produces the value.

      • nextToken — (String)

        The string that specifies the next page of results.

      • tabularPropertyValues — (Array<Array<map<map>>>)

        A table of property values.

        • booleanValue — (Boolean)

          A Boolean value.

        • doubleValue — (Float)

          A double value.

        • integerValue — (Integer)

          An integer value.

        • longValue — (Integer)

          A long value.

        • stringValue — (String)

          A string value.

        • listValue — (Array<map>)

          A list of multiple values.

        • mapValue — (map<map>)

          An object that maps strings to multiple DataValue objects.

        • relationshipValue — (map)

          A value that relates a component to another component.

          • targetEntityId — (String)

            The ID of the target entity associated with this relationship value.

          • targetComponentName — (String)

            The name of the target component associated with the relationship value.

        • expression — (String)

          An expression that produces the value.

Returns:

  • (AWS.Request)

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

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

Retrieves information about the history of a time series property value for a component, component type, entity, or workspace.

You must specify a value for workspaceId. For entity-specific queries, specify values for componentName and entityId. For cross-entity quries, specify a value for componentTypeId.

Service Reference:

Examples:

Calling the getPropertyValueHistory operation

var params = {
  selectedProperties: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  workspaceId: 'STRING_VALUE', /* required */
  componentName: 'STRING_VALUE',
  componentTypeId: 'STRING_VALUE',
  endDateTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  endTime: 'STRING_VALUE',
  entityId: 'STRING_VALUE',
  interpolation: {
    interpolationType: LINEAR,
    intervalInSeconds: 'NUMBER_VALUE'
  },
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  orderByTime: ASCENDING | DESCENDING,
  propertyFilters: [
    {
      operator: 'STRING_VALUE',
      propertyName: 'STRING_VALUE',
      value: { /* DataValue */
        booleanValue: true || false,
        doubleValue: 'NUMBER_VALUE',
        expression: 'STRING_VALUE',
        integerValue: 'NUMBER_VALUE',
        listValue: [
          /* recursive DataValue */,
          /* more items */
        ],
        longValue: 'NUMBER_VALUE',
        mapValue: {
          '<String>': /* recursive DataValue */,
          /* '<String>': ... */
        },
        relationshipValue: {
          targetComponentName: 'STRING_VALUE',
          targetEntityId: 'STRING_VALUE'
        },
        stringValue: 'STRING_VALUE'
      }
    },
    /* more items */
  ],
  startDateTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  startTime: 'STRING_VALUE'
};
iottwinmaker.getPropertyValueHistory(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: {})
    • workspaceId — (String)

      The ID of the workspace.

    • entityId — (String)

      The ID of the entity.

    • componentName — (String)

      The name of the component.

    • componentTypeId — (String)

      The ID of the component type.

    • selectedProperties — (Array<String>)

      A list of properties whose value histories the request retrieves.

    • propertyFilters — (Array<map>)

      A list of objects that filter the property value history request.

      • propertyName — (String)

        The property name associated with this property filter.

      • operator — (String)

        The operator associated with this property filter.

      • value — (map)

        The value associated with this property filter.

        • booleanValue — (Boolean)

          A Boolean value.

        • doubleValue — (Float)

          A double value.

        • integerValue — (Integer)

          An integer value.

        • longValue — (Integer)

          A long value.

        • stringValue — (String)

          A string value.

        • listValue — (Array<map>)

          A list of multiple values.

        • mapValue — (map<map>)

          An object that maps strings to multiple DataValue objects.

        • relationshipValue — (map)

          A value that relates a component to another component.

          • targetEntityId — (String)

            The ID of the target entity associated with this relationship value.

          • targetComponentName — (String)

            The name of the target component associated with the relationship value.

        • expression — (String)

          An expression that produces the value.

    • startDateTime — (Date)

      The date and time of the earliest property value to return.

    • endDateTime — (Date)

      The date and time of the latest property value to return.

    • interpolation — (map)

      An object that specifies the interpolation type and the interval over which to interpolate data.

      • interpolationType — (String)

        The interpolation type.

        Possible values include:
        • "LINEAR"
      • intervalInSeconds — (Integer)

        The interpolation time interval in seconds.

    • nextToken — (String)

      The string that specifies the next page of results.

    • maxResults — (Integer)

      The maximum number of results to return at one time. The default is 25.

      Valid Range: Minimum value of 1. Maximum value of 250.

    • orderByTime — (String)

      The time direction to use in the result order.

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

      The ISO8601 DateTime of the earliest property value to return.

      For more information about the ISO8601 DateTime format, see the data type PropertyValue.

    • endTime — (String)

      The ISO8601 DateTime of the latest property value to return.

      For more information about the ISO8601 DateTime format, see the data type PropertyValue.

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:

      • propertyValues — (Array<map>)

        An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.

        • entityPropertyReferencerequired — (map)

          An object that uniquely identifies an entity property.

          • componentName — (String)

            The name of the component.

          • externalIdProperty — (map<String>)

            A mapping of external IDs to property names. External IDs uniquely identify properties from external data stores.

          • entityId — (String)

            The ID of the entity.

          • propertyNamerequired — (String)

            The name of the property.

        • values — (Array<map>)

          A list of objects that contain information about the values in the history of a time series property.

          • timestamp — (Date)

            The timestamp of a value for a time series property.

          • valuerequired — (map)

            An object that specifies a value for a time series property.

            • booleanValue — (Boolean)

              A Boolean value.

            • doubleValue — (Float)

              A double value.

            • integerValue — (Integer)

              An integer value.

            • longValue — (Integer)

              A long value.

            • stringValue — (String)

              A string value.

            • listValue — (Array<map>)

              A list of multiple values.

            • mapValue — (map<map>)

              An object that maps strings to multiple DataValue objects.

            • relationshipValue — (map)

              A value that relates a component to another component.

              • targetEntityId — (String)

                The ID of the target entity associated with this relationship value.

              • targetComponentName — (String)

                The name of the target component associated with the relationship value.

            • expression — (String)

              An expression that produces the value.

          • time — (String)

            ISO8601 DateTime of a value for a time series property.

            The time for when the property value was recorded in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.SSSSSSSSS][Z/±HH:mm].

            • [YYYY]: year

            • [MM]: month

            • [DD]: day

            • [hh]: hour

            • [mm]: minute

            • [ss]: seconds

            • [.SSSSSSSSS]: additional precision, where precedence is maintained. For example: [.573123] is equal to 573123000 nanoseconds.

            • Z: default timezone UTC

            • ± HH:mm: time zone offset in Hours and Minutes.

            Required sub-fields: YYYY-MM-DDThh:mm:ss and [Z/±HH:mm]

      • nextToken — (String)

        The string that specifies the next page of results.

Returns:

  • (AWS.Request)

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

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

Retrieves information about a scene.

Service Reference:

Examples:

Calling the getScene operation

var params = {
  sceneId: 'STRING_VALUE', /* required */
  workspaceId: 'STRING_VALUE' /* required */
};
iottwinmaker.getScene(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: {})
    • workspaceId — (String)

      The ID of the workspace that contains the scene.

    • sceneId — (String)

      The ID of the scene.

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:

      • workspaceId — (String)

        The ID of the workspace that contains the scene.

      • sceneId — (String)

        The ID of the scene.

      • contentLocation — (String)

        The relative path that specifies the location of the content definition file.

      • arn — (String)

        The ARN of the scene.

      • creationDateTime — (Date)

        The date and time when the scene was created.

      • updateDateTime — (Date)

        The date and time when the scene was last updated.

      • description — (String)

        The description of the scene.

      • capabilities — (Array<String>)

        A list of capabilities that the scene uses to render.

Returns:

  • (AWS.Request)

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

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

Retrieves information about a workspace.

Service Reference:

Examples:

Calling the getWorkspace operation

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

      The ID of the workspace.

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:

      • workspaceId — (String)

        The ID of the workspace.

      • arn — (String)

        The ARN of the workspace.

      • description — (String)

        The description of the workspace.

      • s3Location — (String)

        The ARN of the S3 bucket where resources associated with the workspace are stored.

      • role — (String)

        The ARN of the execution role associated with the workspace.

      • creationDateTime — (Date)

        The date and time when the workspace was created.

      • updateDateTime — (Date)

        The date and time when the workspace was last updated.

Returns:

  • (AWS.Request)

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

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

Lists all component types in a workspace.

Service Reference:

Examples:

Calling the listComponentTypes operation

var params = {
  workspaceId: 'STRING_VALUE', /* required */
  filters: [
    {
      extendsFrom: 'STRING_VALUE',
      isAbstract: true || false,
      namespace: 'STRING_VALUE'
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
iottwinmaker.listComponentTypes(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: {})
    • workspaceId — (String)

      The ID of the workspace.

    • filters — (Array<map>)

      A list of objects that filter the request.

      • extendsFrom — (String)

        The component type that the component types in the list extend.

      • namespace — (String)

        The namespace to which the component types in the list belong.

      • isAbstract — (Boolean)

        A Boolean value that specifies whether the component types in the list are abstract.

    • nextToken — (String)

      The string that specifies the next page of results.

    • maxResults — (Integer)

      The maximum number of results to return at one time. The default is 25.

      Valid Range: Minimum value of 1. Maximum value of 250.

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:

      • workspaceId — (String)

        The ID of the workspace.

      • componentTypeSummaries — (Array<map>)

        A list of objects that contain information about the component types.

        • arnrequired — (String)

          The ARN of the component type.

        • componentTypeIdrequired — (String)

          The ID of the component type.

        • creationDateTimerequired — (Date)

          The date and time when the component type was created.

        • updateDateTimerequired — (Date)

          The date and time when the component type was last updated.

        • description — (String)

          The description of the component type.

        • status — (map)

          The current status of the component type.

          • state — (String)

            The current state of the entity, component, component type, or workspace.

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

            The error message.

            • code — (String)

              The error code.

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

              The error message.

      • nextToken — (String)

        The string that specifies the next page of results.

      • maxResults — (Integer)

        Specifies the maximum number of results to display.

Returns:

  • (AWS.Request)

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

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

Lists all entities in a workspace.

Service Reference:

Examples:

Calling the listEntities operation

var params = {
  workspaceId: 'STRING_VALUE', /* required */
  filters: [
    {
      componentTypeId: 'STRING_VALUE',
      externalId: 'STRING_VALUE',
      parentEntityId: 'STRING_VALUE'
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
iottwinmaker.listEntities(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: {})
    • workspaceId — (String)

      The ID of the workspace.

    • filters — (Array<map>)

      A list of objects that filter the request.

      Note: Only one object is accepted as a valid input.
      • parentEntityId — (String)

        The parent of the entities in the list.

      • componentTypeId — (String)

        The ID of the component type in the entities in the list.

      • externalId — (String)

        The external-Id property of a component. The external-Id property is the primary key of an external storage system.

    • maxResults — (Integer)

      The maximum number of results to return at one time. The default is 25.

      Valid Range: Minimum value of 1. Maximum value of 250.

    • nextToken — (String)

      The string that specifies the next page of results.

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:

      • entitySummaries — (Array<map>)

        A list of objects that contain information about the entities.

        • entityIdrequired — (String)

          The ID of the entity.

        • entityNamerequired — (String)

          The name of the entity.

        • arnrequired — (String)

          The ARN of the entity.

        • parentEntityId — (String)

          The ID of the parent entity.

        • statusrequired — (map)

          The current status of the entity.

          • state — (String)

            The current state of the entity, component, component type, or workspace.

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

            The error message.

            • code — (String)

              The error code.

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

              The error message.

        • description — (String)

          The description of the entity.

        • hasChildEntities — (Boolean)

          A Boolean value that specifies whether the entity has child entities or not.

        • creationDateTimerequired — (Date)

          The date and time when the entity was created.

        • updateDateTimerequired — (Date)

          The last date and time when the entity was updated.

      • nextToken — (String)

        The string that specifies the next page of results.

Returns:

  • (AWS.Request)

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

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

Lists all scenes in a workspace.

Service Reference:

Examples:

Calling the listScenes operation

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

      The ID of the workspace that contains the scenes.

    • maxResults — (Integer)

      Specifies the maximum number of results to display.

    • nextToken — (String)

      The string that specifies the next page of results.

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:

      • sceneSummaries — (Array<map>)

        A list of objects that contain information about the scenes.

        • sceneIdrequired — (String)

          The ID of the scene.

        • contentLocationrequired — (String)

          The relative path that specifies the location of the content definition file.

        • arnrequired — (String)

          The ARN of the scene.

        • creationDateTimerequired — (Date)

          The date and time when the scene was created.

        • updateDateTimerequired — (Date)

          The date and time when the scene was last updated.

        • description — (String)

          The scene description.

      • nextToken — (String)

        The string that specifies the next page of results.

Returns:

  • (AWS.Request)

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

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

Lists all tags associated with a resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  resourceARN: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
iottwinmaker.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.

    • maxResults — (Integer)

      The maximum number of results to return at one time. The default is 25.

      Valid Range: Minimum value of 1. Maximum value of 250.

    • nextToken — (String)

      The string that specifies the next page of results.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • tags — (map<String>)

        Metadata that you can use to manage a resource.

      • nextToken — (String)

        The string that specifies the next page of results.

Returns:

  • (AWS.Request)

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

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

Retrieves information about workspaces in the current account.

Service Reference:

Examples:

Calling the listWorkspaces operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
iottwinmaker.listWorkspaces(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: {})
    • maxResults — (Integer)

      The maximum number of results to return at one time. The default is 25.

      Valid Range: Minimum value of 1. Maximum value of 250.

    • nextToken — (String)

      The string that specifies the next page of results.

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:

      • workspaceSummaries — (Array<map>)

        A list of objects that contain information about the workspaces.

        • workspaceIdrequired — (String)

          The ID of the workspace.

        • arnrequired — (String)

          The ARN of the workspace.

        • description — (String)

          The description of the workspace.

        • creationDateTimerequired — (Date)

          The date and time when the workspace was created.

        • updateDateTimerequired — (Date)

          The date and time when the workspace was last updated.

      • nextToken — (String)

        The string that specifies the next page of results.

Returns:

  • (AWS.Request)

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

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

Adds tags to a resource.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  resourceARN: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
iottwinmaker.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The ARN of the resource.

    • tags — (map<String>)

      Metadata to add to this 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.

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

Removes tags from a resource.

Service Reference:

Examples:

Calling the untagResource operation

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

Parameters:

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

      The ARN of the resource.

    • tagKeys — (Array<String>)

      A list of tag key names to remove from the resource. You don't specify the value. Both the key and its associated value are removed.

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.

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

Updates information in a component type.

Service Reference:

Examples:

Calling the updateComponentType operation

var params = {
  componentTypeId: 'STRING_VALUE', /* required */
  workspaceId: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  extendsFrom: [
    'STRING_VALUE',
    /* more items */
  ],
  functions: {
    '<Name>': {
      implementedBy: {
        isNative: true || false,
        lambda: {
          arn: 'STRING_VALUE' /* required */
        }
      },
      requiredProperties: [
        'STRING_VALUE',
        /* more items */
      ],
      scope: ENTITY | WORKSPACE
    },
    /* '<Name>': ... */
  },
  isSingleton: true || false,
  propertyDefinitions: {
    '<Name>': {
      configuration: {
        '<Name>': 'STRING_VALUE',
        /* '<Name>': ... */
      },
      dataType: { /* DataType */
        type: RELATIONSHIP | STRING | LONG | BOOLEAN | INTEGER | DOUBLE | LIST | MAP, /* required */
        allowedValues: [ /* DataValueList */
          { /* DataValue */
            booleanValue: true || false,
            doubleValue: 'NUMBER_VALUE',
            expression: 'STRING_VALUE',
            integerValue: 'NUMBER_VALUE',
            listValue: /* recursive DataValueList */,
            longValue: 'NUMBER_VALUE',
            mapValue: {
              '<String>': /* recursive DataValue */,
              /* '<String>': ... */
            },
            relationshipValue: {
              targetComponentName: 'STRING_VALUE',
              targetEntityId: 'STRING_VALUE'
            },
            stringValue: 'STRING_VALUE'
          },
          /* more items */
        ],
        nestedType: /* recursive DataType */,
        relationship: {
          relationshipType: 'STRING_VALUE',
          targetComponentTypeId: 'STRING_VALUE'
        },
        unitOfMeasure: 'STRING_VALUE'
      },
      defaultValue: { /* DataValue */
        booleanValue: true || false,
        doubleValue: 'NUMBER_VALUE',
        expression: 'STRING_VALUE',
        integerValue: 'NUMBER_VALUE',
        listValue: [ /* DataValueList */
          /* recursive DataValue */,
          /* more items */
        ],
        longValue: 'NUMBER_VALUE',
        mapValue: {
          '<String>': /* recursive DataValue */,
          /* '<String>': ... */
        },
        relationshipValue: {
          targetComponentName: 'STRING_VALUE',
          targetEntityId: 'STRING_VALUE'
        },
        stringValue: 'STRING_VALUE'
      },
      isExternalId: true || false,
      isRequiredInEntity: true || false,
      isStoredExternally: true || false,
      isTimeSeries: true || false
    },
    /* '<Name>': ... */
  },
  propertyGroups: {
    '<Name>': {
      groupType: TABULAR,
      propertyNames: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* '<Name>': ... */
  }
};
iottwinmaker.updateComponentType(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: {})
    • workspaceId — (String)

      The ID of the workspace that contains the component type.

    • isSingleton — (Boolean)

      A Boolean value that specifies whether an entity can have more than one component of this type.

    • componentTypeId — (String)

      The ID of the component type.

    • description — (String)

      The description of the component type.

    • propertyDefinitions — (map<map>)

      An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.

      • dataType — (map)

        An object that contains information about the data type.

        • typerequired — (String)

          The underlying type of the data type.

          Possible values include:
          • "RELATIONSHIP"
          • "STRING"
          • "LONG"
          • "BOOLEAN"
          • "INTEGER"
          • "DOUBLE"
          • "LIST"
          • "MAP"
        • allowedValues — (Array<map>)

          The allowed values for this data type.

          • booleanValue — (Boolean)

            A Boolean value.

          • doubleValue — (Float)

            A double value.

          • integerValue — (Integer)

            An integer value.

          • longValue — (Integer)

            A long value.

          • stringValue — (String)

            A string value.

          • mapValue — (map<map>)

            An object that maps strings to multiple DataValue objects.

          • relationshipValue — (map)

            A value that relates a component to another component.

            • targetEntityId — (String)

              The ID of the target entity associated with this relationship value.

            • targetComponentName — (String)

              The name of the target component associated with the relationship value.

          • expression — (String)

            An expression that produces the value.

        • unitOfMeasure — (String)

          The unit of measure used in this data type.

        • relationship — (map)

          A relationship that associates a component with another component.

          • targetComponentTypeId — (String)

            The ID of the target component type associated with this relationship.

          • relationshipType — (String)

            The type of the relationship.

      • isRequiredInEntity — (Boolean)

        A Boolean value that specifies whether the property is required.

      • isExternalId — (Boolean)

        A Boolean value that specifies whether the property ID comes from an external data store.

      • isStoredExternally — (Boolean)

        A Boolean value that specifies whether the property is stored externally.

      • isTimeSeries — (Boolean)

        A Boolean value that specifies whether the property consists of time series data.

      • defaultValue — (map)

        An object that contains the default value.

        • booleanValue — (Boolean)

          A Boolean value.

        • doubleValue — (Float)

          A double value.

        • integerValue — (Integer)

          An integer value.

        • longValue — (Integer)

          A long value.

        • stringValue — (String)

          A string value.

        • listValue — (Array<map>)

          A list of multiple values.

        • mapValue — (map<map>)

          An object that maps strings to multiple DataValue objects.

        • relationshipValue — (map)

          A value that relates a component to another component.

          • targetEntityId — (String)

            The ID of the target entity associated with this relationship value.

          • targetComponentName — (String)

            The name of the target component associated with the relationship value.

        • expression — (String)

          An expression that produces the value.

      • configuration — (map<String>)

        A mapping that specifies configuration information about the property. Use this field to specify information that you read from and write to an external source.

    • extendsFrom — (Array<String>)

      Specifies the component type that this component type extends.

    • functions — (map<map>)

      An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.

      • requiredProperties — (Array<String>)

        The required properties of the function.

      • scope — (String)

        The scope of the function.

        Possible values include:
        • "ENTITY"
        • "WORKSPACE"
      • implementedBy — (map)

        The data connector.

        • lambda — (map)

          The Lambda function associated with this data connector.

          • arnrequired — (String)

            The ARN of the Lambda function.

        • isNative — (Boolean)

          A Boolean value that specifies whether the data connector is native to IoT TwinMaker.

    • propertyGroups — (map<map>)

      The property groups

      • groupType — (String)

        The group type.

        Possible values include:
        • "TABULAR"
      • propertyNames — (Array<String>)

        The names of properties.

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:

      • workspaceId — (String)

        The ID of the workspace that contains the component type.

      • arn — (String)

        The ARN of the component type.

      • componentTypeId — (String)

        The ID of the component type.

      • state — (String)

        The current state of the component type.

        Possible values include:
        • "CREATING"
        • "UPDATING"
        • "DELETING"
        • "ACTIVE"
        • "ERROR"

Returns:

  • (AWS.Request)

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

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

Updates an entity.

Service Reference:

Examples:

Calling the updateEntity operation

var params = {
  entityId: 'STRING_VALUE', /* required */
  workspaceId: 'STRING_VALUE', /* required */
  componentUpdates: {
    '<Name>': {
      componentTypeId: 'STRING_VALUE',
      description: 'STRING_VALUE',
      propertyGroupUpdates: {
        '<Name>': {
          groupType: TABULAR,
          propertyNames: [
            'STRING_VALUE',
            /* more items */
          ],
          updateType: UPDATE | DELETE | CREATE
        },
        /* '<Name>': ... */
      },
      propertyUpdates: {
        '<Name>': {
          definition: {
            configuration: {
              '<Name>': 'STRING_VALUE',
              /* '<Name>': ... */
            },
            dataType: { /* DataType */
              type: RELATIONSHIP | STRING | LONG | BOOLEAN | INTEGER | DOUBLE | LIST | MAP, /* required */
              allowedValues: [ /* DataValueList */
                { /* DataValue */
                  booleanValue: true || false,
                  doubleValue: 'NUMBER_VALUE',
                  expression: 'STRING_VALUE',
                  integerValue: 'NUMBER_VALUE',
                  listValue: /* recursive DataValueList */,
                  longValue: 'NUMBER_VALUE',
                  mapValue: {
                    '<String>': /* recursive DataValue */,
                    /* '<String>': ... */
                  },
                  relationshipValue: {
                    targetComponentName: 'STRING_VALUE',
                    targetEntityId: 'STRING_VALUE'
                  },
                  stringValue: 'STRING_VALUE'
                },
                /* more items */
              ],
              nestedType: /* recursive DataType */,
              relationship: {
                relationshipType: 'STRING_VALUE',
                targetComponentTypeId: 'STRING_VALUE'
              },
              unitOfMeasure: 'STRING_VALUE'
            },
            defaultValue: { /* DataValue */
              booleanValue: true || false,
              doubleValue: 'NUMBER_VALUE',
              expression: 'STRING_VALUE',
              integerValue: 'NUMBER_VALUE',
              listValue: [ /* DataValueList */
                /* recursive DataValue */,
                /* more items */
              ],
              longValue: 'NUMBER_VALUE',
              mapValue: {
                '<String>': /* recursive DataValue */,
                /* '<String>': ... */
              },
              relationshipValue: {
                targetComponentName: 'STRING_VALUE',
                targetEntityId: 'STRING_VALUE'
              },
              stringValue: 'STRING_VALUE'
            },
            isExternalId: true || false,
            isRequiredInEntity: true || false,
            isStoredExternally: true || false,
            isTimeSeries: true || false
          },
          updateType: UPDATE | DELETE | CREATE,
          value: { /* DataValue */
            booleanValue: true || false,
            doubleValue: 'NUMBER_VALUE',
            expression: 'STRING_VALUE',
            integerValue: 'NUMBER_VALUE',
            listValue: [ /* DataValueList */
              /* recursive DataValue */,
              /* more items */
            ],
            longValue: 'NUMBER_VALUE',
            mapValue: {
              '<String>': /* recursive DataValue */,
              /* '<String>': ... */
            },
            relationshipValue: {
              targetComponentName: 'STRING_VALUE',
              targetEntityId: 'STRING_VALUE'
            },
            stringValue: 'STRING_VALUE'
          }
        },
        /* '<Name>': ... */
      },
      updateType: CREATE | UPDATE | DELETE
    },
    /* '<Name>': ... */
  },
  description: 'STRING_VALUE',
  entityName: 'STRING_VALUE',
  parentEntityUpdate: {
    updateType: UPDATE | DELETE, /* required */
    parentEntityId: 'STRING_VALUE'
  }
};
iottwinmaker.updateEntity(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: {})
    • workspaceId — (String)

      The ID of the workspace that contains the entity.

    • entityId — (String)

      The ID of the entity.

    • entityName — (String)

      The name of the entity.

    • description — (String)

      The description of the entity.

    • componentUpdates — (map<map>)

      An object that maps strings to the component updates in the request. Each string in the mapping must be unique to this object.

      • updateType — (String)

        The update type of the component update request.

        Possible values include:
        • "CREATE"
        • "UPDATE"
        • "DELETE"
      • description — (String)

        The description of the component type.

      • componentTypeId — (String)

        The ID of the component type.

      • propertyUpdates — (map<map>)

        An object that maps strings to the properties to set in the component type update. Each string in the mapping must be unique to this object.

        • definition — (map)

          An object that specifies information about a property.

          • dataType — (map)

            An object that contains information about the data type.

            • typerequired — (String)

              The underlying type of the data type.

              Possible values include:
              • "RELATIONSHIP"
              • "STRING"
              • "LONG"
              • "BOOLEAN"
              • "INTEGER"
              • "DOUBLE"
              • "LIST"
              • "MAP"
            • allowedValues — (Array<map>)

              The allowed values for this data type.

              • booleanValue — (Boolean)

                A Boolean value.

              • doubleValue — (Float)

                A double value.

              • integerValue — (Integer)

                An integer value.

              • longValue — (Integer)

                A long value.

              • stringValue — (String)

                A string value.

              • mapValue — (map<map>)

                An object that maps strings to multiple DataValue objects.

              • relationshipValue — (map)

                A value that relates a component to another component.

                • targetEntityId — (String)

                  The ID of the target entity associated with this relationship value.

                • targetComponentName — (String)

                  The name of the target component associated with the relationship value.

              • expression — (String)

                An expression that produces the value.

            • unitOfMeasure — (String)

              The unit of measure used in this data type.

            • relationship — (map)

              A relationship that associates a component with another component.

              • targetComponentTypeId — (String)

                The ID of the target component type associated with this relationship.

              • relationshipType — (String)

                The type of the relationship.

          • isRequiredInEntity — (Boolean)

            A Boolean value that specifies whether the property is required.

          • isExternalId — (Boolean)

            A Boolean value that specifies whether the property ID comes from an external data store.

          • isStoredExternally — (Boolean)

            A Boolean value that specifies whether the property is stored externally.

          • isTimeSeries — (Boolean)

            A Boolean value that specifies whether the property consists of time series data.

          • defaultValue — (map)

            An object that contains the default value.

            • booleanValue — (Boolean)

              A Boolean value.

            • doubleValue — (Float)

              A double value.

            • integerValue — (Integer)

              An integer value.

            • longValue — (Integer)

              A long value.

            • stringValue — (String)

              A string value.

            • listValue — (Array<map>)

              A list of multiple values.

            • mapValue — (map<map>)

              An object that maps strings to multiple DataValue objects.

            • relationshipValue — (map)

              A value that relates a component to another component.

              • targetEntityId — (String)

                The ID of the target entity associated with this relationship value.

              • targetComponentName — (String)

                The name of the target component associated with the relationship value.

            • expression — (String)

              An expression that produces the value.

          • configuration — (map<String>)

            A mapping that specifies configuration information about the property. Use this field to specify information that you read from and write to an external source.

        • value — (map)

          The value of the property.

          • booleanValue — (Boolean)

            A Boolean value.

          • doubleValue — (Float)

            A double value.

          • integerValue — (Integer)

            An integer value.

          • longValue — (Integer)

            A long value.

          • stringValue — (String)

            A string value.

          • listValue — (Array<map>)

            A list of multiple values.

          • mapValue — (map<map>)

            An object that maps strings to multiple DataValue objects.

          • relationshipValue — (map)

            A value that relates a component to another component.

            • targetEntityId — (String)

              The ID of the target entity associated with this relationship value.

            • targetComponentName — (String)

              The name of the target component associated with the relationship value.

          • expression — (String)

            An expression that produces the value.

        • updateType — (String)

          The update type of the update property request.

          Possible values include:
          • "UPDATE"
          • "DELETE"
          • "CREATE"
      • propertyGroupUpdates — (map<map>)

        The property group updates.

        • groupType — (String)

          The group type.

          Possible values include:
          • "TABULAR"
        • propertyNames — (Array<String>)

          The property names.

        • updateType — (String)

          The update type.

          Possible values include:
          • "UPDATE"
          • "DELETE"
          • "CREATE"
    • parentEntityUpdate — (map)

      An object that describes the update request for a parent entity.

      • updateTyperequired — (String)

        The type of the update.

        Possible values include:
        • "UPDATE"
        • "DELETE"
      • parentEntityId — (String)

        The ID of the parent entity.

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:

      • updateDateTime — (Date)

        The date and time when the entity was last updated.

      • state — (String)

        The current state of the entity update.

        Possible values include:
        • "CREATING"
        • "UPDATING"
        • "DELETING"
        • "ACTIVE"
        • "ERROR"

Returns:

  • (AWS.Request)

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

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

Update the pricing plan.

Service Reference:

Examples:

Calling the updatePricingPlan operation

var params = {
  pricingMode: BASIC | STANDARD | TIERED_BUNDLE, /* required */
  bundleNames: [
    'STRING_VALUE',
    /* more items */
  ]
};
iottwinmaker.updatePricingPlan(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: {})
    • pricingMode — (String)

      The pricing mode.

      Possible values include:
      • "BASIC"
      • "STANDARD"
      • "TIERED_BUNDLE"
    • bundleNames — (Array<String>)

      The bundle names.

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:

      • currentPricingPlan — (map)

        Update the current pricing plan.

        • billableEntityCount — (Integer)

          The billable entity count.

        • bundleInformation — (map)

          The pricing plan's bundle information.

          • bundleNamesrequired — (Array<String>)

            The bundle names.

          • pricingTier — (String)

            The pricing tier.

            Possible values include:
            • "TIER_1"
            • "TIER_2"
            • "TIER_3"
            • "TIER_4"
        • effectiveDateTimerequired — (Date)

          The effective date and time of the pricing plan.

        • pricingModerequired — (String)

          The pricing mode.

          Possible values include:
          • "BASIC"
          • "STANDARD"
          • "TIERED_BUNDLE"
        • updateDateTimerequired — (Date)

          The set date and time for updating a pricing plan.

        • updateReasonrequired — (String)

          The update reason, for changing a pricing plan.

          Possible values include:
          • "DEFAULT"
          • "PRICING_TIER_UPDATE"
          • "ENTITY_COUNT_UPDATE"
          • "PRICING_MODE_UPDATE"
          • "OVERWRITTEN"
      • pendingPricingPlan — (map)

        Update the pending pricing plan.

        • billableEntityCount — (Integer)

          The billable entity count.

        • bundleInformation — (map)

          The pricing plan's bundle information.

          • bundleNamesrequired — (Array<String>)

            The bundle names.

          • pricingTier — (String)

            The pricing tier.

            Possible values include:
            • "TIER_1"
            • "TIER_2"
            • "TIER_3"
            • "TIER_4"
        • effectiveDateTimerequired — (Date)

          The effective date and time of the pricing plan.

        • pricingModerequired — (String)

          The pricing mode.

          Possible values include:
          • "BASIC"
          • "STANDARD"
          • "TIERED_BUNDLE"
        • updateDateTimerequired — (Date)

          The set date and time for updating a pricing plan.

        • updateReasonrequired — (String)

          The update reason, for changing a pricing plan.

          Possible values include:
          • "DEFAULT"
          • "PRICING_TIER_UPDATE"
          • "ENTITY_COUNT_UPDATE"
          • "PRICING_MODE_UPDATE"
          • "OVERWRITTEN"

Returns:

  • (AWS.Request)

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

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

Updates a scene.

Service Reference:

Examples:

Calling the updateScene operation

var params = {
  sceneId: 'STRING_VALUE', /* required */
  workspaceId: 'STRING_VALUE', /* required */
  capabilities: [
    'STRING_VALUE',
    /* more items */
  ],
  contentLocation: 'STRING_VALUE',
  description: 'STRING_VALUE'
};
iottwinmaker.updateScene(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: {})
    • workspaceId — (String)

      The ID of the workspace that contains the scene.

    • sceneId — (String)

      The ID of the scene.

    • contentLocation — (String)

      The relative path that specifies the location of the content definition file.

    • description — (String)

      The description of this scene.

    • capabilities — (Array<String>)

      A list of capabilities that the scene uses to render.

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:

      • updateDateTime — (Date)

        The date and time when the scene was last updated.

Returns:

  • (AWS.Request)

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

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

Updates a workspace.

Service Reference:

Examples:

Calling the updateWorkspace operation

var params = {
  workspaceId: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  role: 'STRING_VALUE'
};
iottwinmaker.updateWorkspace(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: {})
    • workspaceId — (String)

      The ID of the workspace.

    • description — (String)

      The description of the workspace.

    • role — (String)

      The ARN of the execution role associated with the workspace.

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:

      • updateDateTime — (Date)

        The date and time of the current update.

Returns:

  • (AWS.Request)

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

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

Waits for a given IoTTwinMaker resource. The final callback or 'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.

Parameters:

  • state (String)

    the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.

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

    a list of parameters for the given state. See each waiter resource state for required parameters.

Callback (callback):

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

    Callback containing error and data information. See the respective resource state for the expected error or data information.

    If the waiter times out its requests, it will return a ResourceNotReady error.

Returns:

  • (AWS.Request)

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