Class: AWS.IoTTwinMaker

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

    The metadata transfer job Id.

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:

    • metadataTransferJobId — (String)

      The metadata transfer job Id.

    • arn — (String)

      The metadata transfer job ARN.

    • updateDateTime — (Date)

      Used to update the DateTime property.

    • status — (map)

      The metadata transfer job's status.

      • state — (String)

        The metadata transfer job state.

        Possible values include:
        • "VALIDATING"
        • "PENDING"
        • "RUNNING"
        • "CANCELLING"
        • "ERROR"
        • "COMPLETED"
        • "CANCELLED"
      • error — (map)

        The metadata transfer job error.

        • code — (String)

          The error code.

          Possible values include:
          • "VALIDATION_ERROR"
          • "INTERNAL_FAILURE"
          • "SYNC_INITIALIZING_ERROR"
          • "SYNC_CREATING_ERROR"
          • "SYNC_PROCESSING_ERROR"
          • "SYNC_DELETING_ERROR"
          • "PROCESSING_ERROR"
          • "COMPOSITE_COMPONENT_FAILURE"
        • message — (String)

          The error message.

      • queuedPosition — (Integer)

        The queued position.

    • progress — (map)

      The metadata transfer job's progress.

      • totalCount — (Integer)

        The total count. [of what]

      • succeededCount — (Integer)

        The succeeded count.

      • skippedCount — (Integer)

        The skipped count.

      • failedCount — (Integer)

        The failed count.

Returns:

• (AWS.Request) —

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

var params = {
  componentTypeId: 'STRING_VALUE', /* required */
  workspaceId: 'STRING_VALUE', /* required */
  componentTypeName: 'STRING_VALUE',
  compositeComponentTypes: {
    '<Name>': {
      componentTypeId: 'STRING_VALUE'
    },
    /* '<Name>': ... */
  },
  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'
      },
      displayName: '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.

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

    • displayName — (String)

      A friendly name for the property.

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

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

  • componentTypeName — (String)

    A friendly name for the component type.

  • compositeComponentTypes — (map<map>)

    This is an object that maps strings to compositeComponentTypes of the componentType. CompositeComponentType is referenced by componentTypeId.

    • componentTypeId — (String)

      This is the componentTypeId that the compositeComponentType refers 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:

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

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'
            },
            displayName: 'STRING_VALUE',
            isExternalId: true || false,
            isRequiredInEntity: true || false,
            isStoredExternally: true || false,
            isTimeSeries: true || false
          },
          updateType: UPDATE | DELETE | CREATE | RESET_VALUE,
          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>': ... */
  },
  compositeComponents: {
    '<ComponentPath>': {
      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'
            },
            displayName: 'STRING_VALUE',
            isExternalId: true || false,
            isRequiredInEntity: true || false,
            isStoredExternally: true || false,
            isTimeSeries: true || false
          },
          updateType: UPDATE | DELETE | CREATE | RESET_VALUE,
          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>': ... */
      }
    },
    /* '<ComponentPath>': ... */
  },
  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.

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

        • displayName — (String)

          A friendly name for 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.

      • updateType — (String)

        The update type of the update property request.

        Possible values include:
        • "UPDATE"
        • "DELETE"
        • "CREATE"
        • "RESET_VALUE"
    • 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"
  • compositeComponents — (map<map>)

    This is an object that maps strings to compositeComponent updates in the request. Each key of the map represents the componentPath of the compositeComponent.

    • description — (String)

      The description of the component type.

    • properties — (map<map>)

      This is 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.

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

        • displayName — (String)

          A friendly name for 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.

      • updateType — (String)

        The update type of the update property request.

        Possible values include:
        • "UPDATE"
        • "DELETE"
        • "CREATE"
        • "RESET_VALUE"
    • 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.

var params = {
  destination: { /* required */
    type: s3 | iotsitewise | iottwinmaker, /* required */
    iotTwinMakerConfiguration: {
      workspace: 'STRING_VALUE' /* required */
    },
    s3Configuration: {
      location: 'STRING_VALUE' /* required */
    }
  },
  sources: [ /* required */
    {
      type: s3 | iotsitewise | iottwinmaker, /* required */
      iotSiteWiseConfiguration: {
        filters: [
          {
            filterByAsset: {
              assetExternalId: 'STRING_VALUE',
              assetId: 'STRING_VALUE',
              includeAssetModel: true || false,
              includeOffspring: true || false
            },
            filterByAssetModel: {
              assetModelExternalId: 'STRING_VALUE',
              assetModelId: 'STRING_VALUE',
              includeAssets: true || false,
              includeOffspring: true || false
            }
          },
          /* more items */
        ]
      },
      iotTwinMakerConfiguration: {
        workspace: 'STRING_VALUE', /* required */
        filters: [
          {
            filterByComponentType: {
              componentTypeId: 'STRING_VALUE' /* required */
            },
            filterByEntity: {
              entityId: 'STRING_VALUE' /* required */
            }
          },
          /* more items */
        ]
      },
      s3Configuration: {
        location: 'STRING_VALUE' /* required */
      }
    },
    /* more items */
  ],
  description: 'STRING_VALUE',
  metadataTransferJobId: 'STRING_VALUE'
};
iottwinmaker.createMetadataTransferJob(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: {}) —
  • metadataTransferJobId — (String)

    The metadata transfer job Id.

  • description — (String)

    The metadata transfer job description.

  • sources — (Array<map>)

    The metadata transfer job sources.

    • type — required — (String)

      The source configuration type.

      Possible values include:
      • "s3"
      • "iotsitewise"
      • "iottwinmaker"
    • s3Configuration — (map)

      The source configuration S3 configuration.

      • location — required — (String)

        The S3 destination source configuration location.

    • iotSiteWiseConfiguration — (map)

      The source configuration IoT SiteWise configuration.

      • filters — (Array<map>)

        The AWS IoT SiteWise soucre configuration filters.

        • filterByAssetModel — (map)

          Filter by asset model.

          • assetModelId — (String)

            The asset model Id.

          • assetModelExternalId — (String)

            The external-Id property of an asset model.

          • includeOffspring — (Boolean)

            Include asset offspring. [need desc.]

          • includeAssets — (Boolean)

            Bolean to include assets.

        • filterByAsset — (map)

          Filter by asset.

          • assetId — (String)

            Filter by asset Id.

          • assetExternalId — (String)

            The external-Id property of an asset.

          • includeOffspring — (Boolean)

            Includes sub-assets.[need description hekp for this]

          • includeAssetModel — (Boolean)

            Boolean to include the asset model.

    • iotTwinMakerConfiguration — (map)

      The source configuration IoT TwinMaker configuration.

      • workspace — required — (String)

        The IoT TwinMaker workspace.

      • filters — (Array<map>)

        The metadata transfer job AWS IoT TwinMaker source configuration filters.

        • filterByComponentType — (map)

          Filter by component type.

          • componentTypeId — required — (String)

            The component type Id.

        • filterByEntity — (map)

          Filter by entity.

          • entityId — required — (String)

            The entity Id.

  • destination — (map)

    The metadata transfer job destination.

    • type — required — (String)

      The destination type.

      Possible values include:
      • "s3"
      • "iotsitewise"
      • "iottwinmaker"
    • s3Configuration — (map)

      The metadata transfer job S3 configuration. [need to add S3 entity]

      • location — required — (String)

        The S3 destination configuration location.

    • iotTwinMakerConfiguration — (map)

      The metadata transfer job Amazon Web Services IoT TwinMaker configuration.

      • workspace — required — (String)

        The IoT TwinMaker 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:

    • metadataTransferJobId — (String)

      The metadata transfer job Id.

    • arn — (String)

      The metadata transfer job ARN.

    • creationDateTime — (Date)

      The The metadata transfer job creation DateTime property.

    • status — (map)

      The metadata transfer job response status.

      • state — (String)

        The metadata transfer job state.

        Possible values include:
        • "VALIDATING"
        • "PENDING"
        • "RUNNING"
        • "CANCELLING"
        • "ERROR"
        • "COMPLETED"
        • "CANCELLED"
      • error — (map)

        The metadata transfer job error.

        • code — (String)

          The error code.

          Possible values include:
          • "VALIDATION_ERROR"
          • "INTERNAL_FAILURE"
          • "SYNC_INITIALIZING_ERROR"
          • "SYNC_CREATING_ERROR"
          • "SYNC_PROCESSING_ERROR"
          • "SYNC_DELETING_ERROR"
          • "PROCESSING_ERROR"
          • "COMPOSITE_COMPONENT_FAILURE"
        • message — (String)

          The error message.

      • queuedPosition — (Integer)

        The queued position.

Returns:

• (AWS.Request) —

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

var params = {
  contentLocation: 'STRING_VALUE', /* required */
  sceneId: 'STRING_VALUE', /* required */
  workspaceId: 'STRING_VALUE', /* required */
  capabilities: [
    'STRING_VALUE',
    /* more items */
  ],
  description: 'STRING_VALUE',
  sceneMetadata: {
    '<Name>': 'STRING_VALUE',
    /* '<Name>': ... */
  },
  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.

  • sceneMetadata — (map<String>)

    The request metadata.

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.

var params = {
  syncRole: 'STRING_VALUE', /* required */
  syncSource: 'STRING_VALUE', /* required */
  workspaceId: 'STRING_VALUE', /* required */
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
iottwinmaker.createSyncJob(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 workspace ID.

  • syncSource — (String)

    The sync source.

    Note: Currently the only supported syncSoource is SITEWISE .
  • syncRole — (String)

    The SyncJob IAM role. This IAM role is used by the SyncJob to read from the syncSource, and create, update, or delete the corresponding resources.

  • tags — (map<String>)

    The SyncJob tags.

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 SyncJob ARN.

    • creationDateTime — (Date)

      The date and time for the SyncJob creation.

    • state — (String)

      The SyncJob response state.

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

Returns:

• (AWS.Request) —

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

var params = {
  workspaceId: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  role: 'STRING_VALUE',
  s3Location: '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.

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.

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.

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.

var params = {
  syncSource: 'STRING_VALUE', /* required */
  workspaceId: 'STRING_VALUE' /* required */
};
iottwinmaker.deleteSyncJob(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 workspace ID.

  • syncSource — (String)

    The sync source.

    Note: Currently the only supported syncSource is SITEWISE .

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 SyncJob response state.

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

Returns:

• (AWS.Request) —

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

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. The data object has the following properties:

    • message — (String)

      The string that specifies the delete result for the workspace.

Returns:

• (AWS.Request) —

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

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

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

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.

      • dataType — required — (map)

        An object that contains information about the data type.

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

      • isTimeSeries — required — (Boolean)

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

      • isRequiredInEntity — required — (Boolean)

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

      • isExternalId — required — (Boolean)

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

      • isStoredExternally — required — (Boolean)

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

      • isImported — required — (Boolean)

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

      • isFinal — required — (Boolean)

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

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

      • displayName — (String)

        A friendly name for 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.

          • arn — required — (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"
          • "SYNC_INITIALIZING_ERROR"
          • "SYNC_CREATING_ERROR"
          • "SYNC_PROCESSING_ERROR"
          • "SYNC_DELETING_ERROR"
          • "PROCESSING_ERROR"
          • "COMPOSITE_COMPONENT_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.

      • groupType — required — (String)

        The group types.

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

        The names of properties.

      • isInherited — required — (Boolean)

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

    • syncSource — (String)

      The syncSource of the SyncJob, if this entity was created by a SyncJob.

    • componentTypeName — (String)

      The component type name.

    • compositeComponentTypes — (map<map>)

      This is an object that maps strings to compositeComponentTypes of the componentType. CompositeComponentType is referenced by componentTypeId.

      • componentTypeId — (String)

        This is the componentTypeId that this compositeComponentType refers to.

      • isInherited — (Boolean)

        This boolean indicates whether this compositeComponentType is inherited from its parent.

Returns:

• (AWS.Request) —

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

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"
          • "SYNC_INITIALIZING_ERROR"
          • "SYNC_CREATING_ERROR"
          • "SYNC_PROCESSING_ERROR"
          • "SYNC_DELETING_ERROR"
          • "PROCESSING_ERROR"
          • "COMPOSITE_COMPONENT_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"
            • "SYNC_INITIALIZING_ERROR"
            • "SYNC_CREATING_ERROR"
            • "SYNC_PROCESSING_ERROR"
            • "SYNC_DELETING_ERROR"
            • "PROCESSING_ERROR"
            • "COMPOSITE_COMPONENT_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.

          • dataType — required — (map)

            An object that contains information about the data type.

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

          • isTimeSeries — required — (Boolean)

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

          • isRequiredInEntity — required — (Boolean)

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

          • isExternalId — required — (Boolean)

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

          • isStoredExternally — required — (Boolean)

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

          • isImported — required — (Boolean)

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

          • isFinal — required — (Boolean)

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

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

          • displayName — (String)

            A friendly name for 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.

        • areAllPropertyValuesReturned — (Boolean)

          This flag notes whether all values of a list or map type property are returned in the API response. The maximum number of values per property returned is 50.

      • propertyGroups — (map<map>)

        The property groups.

        • groupType — required — (String)

          The group type.

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

          The names of properties

        • isInherited — required — (Boolean)

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

      • syncSource — (String)

        The syncSource of the sync job, if this entity was created by a sync job.

      • areAllPropertiesReturned — (Boolean)

        This flag notes whether all properties of the component are returned in the API response. The maximum number of properties returned is 800.

      • compositeComponents — (map<map>)

        This lists objects that contain information about the compositeComponents.

        • componentName — required — (String)

          The name of the component.

        • componentTypeId — required — (String)

          The ID of the component type.

        • definedIn — (String)

          The name of the property definition set in the request.

        • description — (String)

          The description of the component request.

        • propertyGroups — (map<map>)

          The property groups.

          • groupType — required — (String)

            The group type.

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

            The names of properties

          • isInherited — required — (Boolean)

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

        • status — required — (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"
              • "SYNC_INITIALIZING_ERROR"
              • "SYNC_CREATING_ERROR"
              • "SYNC_PROCESSING_ERROR"
              • "SYNC_DELETING_ERROR"
              • "PROCESSING_ERROR"
              • "COMPOSITE_COMPONENT_FAILURE"
            • message — (String)

              The error message.

        • syncSource — (String)

          The syncSource of the sync job, if this entity was created by a sync job.

        • componentPath — (String)

          This string specifies the path to the composite component, starting from the top-level component.

      • areAllCompositeComponentsReturned — (Boolean)

        This flag notes whether all compositeComponents are returned in the API response.

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

    • syncSource — (String)

      The syncSource of the sync job, if this entity was created by a sync job.

    • areAllComponentsReturned — (Boolean)

      This flag notes whether all components are returned in the API response. The maximum number of components returned is 30.

Returns:

• (AWS.Request) —

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

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

    The metadata transfer job Id.

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:

    • metadataTransferJobId — (String)

      The metadata transfer job Id.

    • arn — (String)

      The metadata transfer job ARN.

    • description — (String)

      The metadata transfer job description.

    • sources — (Array<map>)

      The metadata transfer job's sources.

      • type — required — (String)

        The source configuration type.

        Possible values include:
        • "s3"
        • "iotsitewise"
        • "iottwinmaker"
      • s3Configuration — (map)

        The source configuration S3 configuration.

        • location — required — (String)

          The S3 destination source configuration location.

      • iotSiteWiseConfiguration — (map)

        The source configuration IoT SiteWise configuration.

        • filters — (Array<map>)

          The AWS IoT SiteWise soucre configuration filters.

          • filterByAssetModel — (map)

            Filter by asset model.

            • assetModelId — (String)

              The asset model Id.

            • assetModelExternalId — (String)

              The external-Id property of an asset model.

            • includeOffspring — (Boolean)

              Include asset offspring. [need desc.]

            • includeAssets — (Boolean)

              Bolean to include assets.

          • filterByAsset — (map)

            Filter by asset.

            • assetId — (String)

              Filter by asset Id.

            • assetExternalId — (String)

              The external-Id property of an asset.

            • includeOffspring — (Boolean)

              Includes sub-assets.[need description hekp for this]

            • includeAssetModel — (Boolean)

              Boolean to include the asset model.

      • iotTwinMakerConfiguration — (map)

        The source configuration IoT TwinMaker configuration.

        • workspace — required — (String)

          The IoT TwinMaker workspace.

        • filters — (Array<map>)

          The metadata transfer job AWS IoT TwinMaker source configuration filters.

          • filterByComponentType — (map)

            Filter by component type.

            • componentTypeId — required — (String)

              The component type Id.

          • filterByEntity — (map)

            Filter by entity.

            • entityId — required — (String)

              The entity Id.

    • destination — (map)

      The metadata transfer job's destination.

      • type — required — (String)

        The destination type.

        Possible values include:
        • "s3"
        • "iotsitewise"
        • "iottwinmaker"
      • s3Configuration — (map)

        The metadata transfer job S3 configuration. [need to add S3 entity]

        • location — required — (String)

          The S3 destination configuration location.

      • iotTwinMakerConfiguration — (map)

        The metadata transfer job Amazon Web Services IoT TwinMaker configuration.

        • workspace — required — (String)

          The IoT TwinMaker workspace.

    • metadataTransferJobRole — (String)

      The metadata transfer job's role.

    • reportUrl — (String)

      The metadata transfer job's report URL.

    • creationDateTime — (Date)

      The metadata transfer job's creation DateTime property.

    • updateDateTime — (Date)

      The metadata transfer job's update DateTime property.

    • status — (map)

      The metadata transfer job's status.

      • state — (String)

        The metadata transfer job state.

        Possible values include:
        • "VALIDATING"
        • "PENDING"
        • "RUNNING"
        • "CANCELLING"
        • "ERROR"
        • "COMPLETED"
        • "CANCELLED"
      • error — (map)

        The metadata transfer job error.

        • code — (String)

          The error code.

          Possible values include:
          • "VALIDATION_ERROR"
          • "INTERNAL_FAILURE"
          • "SYNC_INITIALIZING_ERROR"
          • "SYNC_CREATING_ERROR"
          • "SYNC_PROCESSING_ERROR"
          • "SYNC_DELETING_ERROR"
          • "PROCESSING_ERROR"
          • "COMPOSITE_COMPONENT_FAILURE"
        • message — (String)

          The error message.

      • queuedPosition — (Integer)

        The queued position.

    • progress — (map)

      The metadata transfer job's progress.

      • totalCount — (Integer)

        The total count. [of what]

      • succeededCount — (Integer)

        The succeeded count.

      • skippedCount — (Integer)

        The skipped count.

      • failedCount — (Integer)

        The failed count.

Returns:

• (AWS.Request) —

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

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.

        • bundleNames — required — (Array<String>)

          The bundle names.

        • pricingTier — (String)

          The pricing tier.

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

        The effective date and time of the pricing plan.

      • pricingMode — required — (String)

        The pricing mode.

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

        The set date and time for updating a pricing plan.

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

        • bundleNames — required — (Array<String>)

          The bundle names.

        • pricingTier — (String)

          The pricing tier.

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

        The effective date and time of the pricing plan.

      • pricingMode — required — (String)

        The pricing mode.

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

        The set date and time for updating a pricing plan.

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

var params = {
  selectedProperties: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  workspaceId: 'STRING_VALUE', /* required */
  componentName: 'STRING_VALUE',
  componentPath: '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.

  • componentPath — (String)

    This string specifies the path to the composite component, starting from the top-level component.

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

      • propertyReference — required — (map)

        An object that specifies information about a property.

        • componentName — (String)

          The name of the component.

        • componentPath — (String)

          This string specifies the path to the composite component, starting from the top-level 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.

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

var params = {
  selectedProperties: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  workspaceId: 'STRING_VALUE', /* required */
  componentName: 'STRING_VALUE',
  componentPath: '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.

  • componentPath — (String)

    This string specifies the path to the composite component, starting from the top-level 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.

      • entityPropertyReference — required — (map)

        An object that uniquely identifies an entity property.

        • componentName — (String)

          The name of the component.

        • componentPath — (String)

          This string specifies the path to the composite component, starting from the top-level 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.

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

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

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.

    • sceneMetadata — (map<String>)

      The response metadata.

    • generatedSceneMetadata — (map<String>)

      The generated scene metadata.

    • error — (map)

      The SceneResponse error.

      • code — (String)

        The SceneError code.

        Possible values include:
        • "MATTERPORT_ERROR"
      • message — (String)

        The SceneError message.

Returns:

• (AWS.Request) —

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

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

    The sync source.

    Note: Currently the only supported syncSource is SITEWISE .
  • workspaceId — (String)

    The workspace ID.

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 sync job ARN.

    • workspaceId — (String)

      The ID of the workspace that contains the sync job.

    • syncSource — (String)

      The sync soucre.

      Note: Currently the only supported syncSource is SITEWISE .
    • syncRole — (String)

      The sync IAM role.

    • status — (map)

      The SyncJob response status.

      • state — (String)

        The SyncJob status state.

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

        The SyncJob error.

        • code — (String)

          The error code.

          Possible values include:
          • "VALIDATION_ERROR"
          • "INTERNAL_FAILURE"
          • "SYNC_INITIALIZING_ERROR"
          • "SYNC_CREATING_ERROR"
          • "SYNC_PROCESSING_ERROR"
          • "SYNC_DELETING_ERROR"
          • "PROCESSING_ERROR"
          • "COMPOSITE_COMPONENT_FAILURE"
        • message — (String)

          The error message.

    • creationDateTime — (Date)

      The creation date and time.

    • updateDateTime — (Date)

      The update date and time.

Returns:

• (AWS.Request) —

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

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.

    • linkedServices — (Array<String>)

      A list of services that are linked to 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.

var params = {
  entityId: 'STRING_VALUE', /* required */
  workspaceId: 'STRING_VALUE', /* required */
  componentPath: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
iottwinmaker.listComponents(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 workspace ID.

  • entityId — (String)

    The ID for the entity whose metadata (component/properties) is returned by the operation.

  • componentPath — (String)

    This string specifies the path to the composite component, starting from the top-level component.

  • maxResults — (Integer)

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

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

    • componentSummaries — (Array<map>)

      A list of objects that contain information about the components.

      • componentName — required — (String)

        The name of the component.

      • componentTypeId — required — (String)

        The ID of the component type.

      • definedIn — (String)

        The name of the property definition set in the request.

      • description — (String)

        The description of the component request.

      • propertyGroups — (map<map>)

        The property groups.

        • groupType — required — (String)

          The group type.

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

          The names of properties

        • isInherited — required — (Boolean)

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

      • status — required — (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"
            • "SYNC_INITIALIZING_ERROR"
            • "SYNC_CREATING_ERROR"
            • "SYNC_PROCESSING_ERROR"
            • "SYNC_DELETING_ERROR"
            • "PROCESSING_ERROR"
            • "COMPOSITE_COMPONENT_FAILURE"
          • message — (String)

            The error message.

      • syncSource — (String)

        The syncSource of the sync job, if this entity was created by a sync job.

      • componentPath — (String)

        This string specifies the path to the composite component, starting from the top-level component.

    • nextToken — (String)

      The string that specifies the next page of component results.

Returns:

• (AWS.Request) —

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

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.

      • arn — required — (String)

        The ARN of the component type.

      • componentTypeId — required — (String)

        The ID of the component type.

      • creationDateTime — required — (Date)

        The date and time when the component type was created.

      • updateDateTime — required — (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"
            • "SYNC_INITIALIZING_ERROR"
            • "SYNC_CREATING_ERROR"
            • "SYNC_PROCESSING_ERROR"
            • "SYNC_DELETING_ERROR"
            • "PROCESSING_ERROR"
            • "COMPOSITE_COMPONENT_FAILURE"
          • message — (String)

            The error message.

      • componentTypeName — (String)

        The component type name.

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

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.

      • entityId — required — (String)

        The ID of the entity.

      • entityName — required — (String)

        The name of the entity.

      • arn — required — (String)

        The ARN of the entity.

      • parentEntityId — (String)

        The ID of the parent entity.

      • status — required — (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"
            • "SYNC_INITIALIZING_ERROR"
            • "SYNC_CREATING_ERROR"
            • "SYNC_PROCESSING_ERROR"
            • "SYNC_DELETING_ERROR"
            • "PROCESSING_ERROR"
            • "COMPOSITE_COMPONENT_FAILURE"
          • message — (String)

            The error message.

      • description — (String)

        The description of the entity.

      • hasChildEntities — (Boolean)

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

      • creationDateTime — required — (Date)

        The date and time when the entity was created.

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

var params = {
  destinationType: s3 | iotsitewise | iottwinmaker, /* required */
  sourceType: s3 | iotsitewise | iottwinmaker, /* required */
  filters: [
    {
      state: VALIDATING | PENDING | RUNNING | CANCELLING | ERROR | COMPLETED | CANCELLED,
      workspaceId: 'STRING_VALUE'
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
iottwinmaker.listMetadataTransferJobs(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: {}) —
  • sourceType — (String)

    The metadata transfer job's source type.

    Possible values include:
    • "s3"
    • "iotsitewise"
    • "iottwinmaker"
  • destinationType — (String)

    The metadata transfer job's destination type.

    Possible values include:
    • "s3"
    • "iotsitewise"
    • "iottwinmaker"
  • filters — (Array<map>)

    An object that filters metadata transfer jobs.

    • workspaceId — (String)

      The workspace Id.

    • state — (String)

      The filter state.

      Possible values include:
      • "VALIDATING"
      • "PENDING"
      • "RUNNING"
      • "CANCELLING"
      • "ERROR"
      • "COMPLETED"
      • "CANCELLED"
  • nextToken — (String)

    The string that specifies the next page of results.

  • maxResults — (Integer)

    The maximum number of results to return at one time.

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:

    • metadataTransferJobSummaries — (Array<map>)

      The metadata transfer job summaries.

      • metadataTransferJobId — required — (String)

        The metadata transfer job summary Id.

      • arn — required — (String)

        The metadata transfer job summary ARN.

      • creationDateTime — required — (Date)

        The metadata transfer job summary creation DateTime object.

      • updateDateTime — required — (Date)

        The metadata transfer job summary update DateTime object

      • status — required — (map)

        The metadata transfer job summary status.

        • state — (String)

          The metadata transfer job state.

          Possible values include:
          • "VALIDATING"
          • "PENDING"
          • "RUNNING"
          • "CANCELLING"
          • "ERROR"
          • "COMPLETED"
          • "CANCELLED"
        • error — (map)

          The metadata transfer job error.

          • code — (String)

            The error code.

            Possible values include:
            • "VALIDATION_ERROR"
            • "INTERNAL_FAILURE"
            • "SYNC_INITIALIZING_ERROR"
            • "SYNC_CREATING_ERROR"
            • "SYNC_PROCESSING_ERROR"
            • "SYNC_DELETING_ERROR"
            • "PROCESSING_ERROR"
            • "COMPOSITE_COMPONENT_FAILURE"
          • message — (String)

            The error message.

        • queuedPosition — (Integer)

          The queued position.

      • progress — (map)

        The metadata transfer job summary progess.

        • totalCount — (Integer)

          The total count. [of what]

        • succeededCount — (Integer)

          The succeeded count.

        • skippedCount — (Integer)

          The skipped count.

        • failedCount — (Integer)

          The failed count.

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

var params = {
  entityId: 'STRING_VALUE', /* required */
  workspaceId: 'STRING_VALUE', /* required */
  componentName: 'STRING_VALUE',
  componentPath: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
iottwinmaker.listProperties(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 workspace ID.

  • componentName — (String)

    The name of the component whose properties are returned by the operation.

  • componentPath — (String)

    This string specifies the path to the composite component, starting from the top-level component.

  • entityId — (String)

    The ID for the entity whose metadata (component/properties) is returned by the operation.

  • maxResults — (Integer)

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

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

    • propertySummaries — (Array<map>)

      A list of objects that contain information about the properties.

      • definition — (map)

        This is the schema for the property.

        • dataType — required — (map)

          An object that contains information about the data type.

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

        • isTimeSeries — required — (Boolean)

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

        • isRequiredInEntity — required — (Boolean)

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

        • isExternalId — required — (Boolean)

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

        • isStoredExternally — required — (Boolean)

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

        • isImported — required — (Boolean)

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

        • isFinal — required — (Boolean)

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

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

        • displayName — (String)

          A friendly name for the property.

      • propertyName — required — (String)

        This is the name of the property.

      • value — (map)

        This is the value for 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.

      • areAllPropertyValuesReturned — (Boolean)

        This flag notes whether all values of a list or map type property are returned in the API response. The maximum number of values per property returned is 50.

    • nextToken — (String)

      The string that specifies the next page of property results.

Returns:

• (AWS.Request) —

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