[ aws . iottwinmaker ]

batch-put-property-values

Description

Sets values for multiple time series properties.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  batch-put-property-values
--entries <value>
--workspace-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--entries (list)

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

(structure)

An object that specifies information about time series property values. This object is used and consumed by the BatchPutPropertyValues action.

entityPropertyReference -> (structure)

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

componentName -> (string)

The name of the component.

entityId -> (string)

The ID of the entity.

externalIdProperty -> (map)

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

key -> (string)

value -> (string)

propertyName -> (string)

The name of the property.

propertyValues -> (list)

A list of objects that specify time series property values.

(structure)

An object that contains information about a value for a time series property.

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]

timestamp -> (timestamp)

The timestamp of a value for a time series property.

value -> (structure)

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

booleanValue -> (boolean)

A Boolean value.

doubleValue -> (double)

A double value.

expression -> (string)

An expression that produces the value.

integerValue -> (integer)

An integer value.

listValue -> (list)

A list of multiple values.

(structure)

An object that specifies a value for a property.

booleanValue -> (boolean)

A Boolean value.

doubleValue -> (double)

A double value.

expression -> (string)

An expression that produces the value.

integerValue -> (integer)

An integer value.

listValue -> (list)

A list of multiple values.

( … recursive … )

longValue -> (long)

A long value.

mapValue -> (map)

An object that maps strings to multiple DataValue objects.

key -> (string)

( … recursive … )

relationshipValue -> (structure)

A value that relates a component to another component.

targetComponentName -> (string)

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

targetEntityId -> (string)

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

stringValue -> (string)

A string value.

longValue -> (long)

A long value.

mapValue -> (map)

An object that maps strings to multiple DataValue objects.

key -> (string)

value -> (structure)

An object that specifies a value for a property.

booleanValue -> (boolean)

A Boolean value.

doubleValue -> (double)

A double value.

expression -> (string)

An expression that produces the value.

integerValue -> (integer)

An integer value.

listValue -> (list)

A list of multiple values.

( … recursive … )

longValue -> (long)

A long value.

mapValue -> (map)

An object that maps strings to multiple DataValue objects.

key -> (string)

( … recursive … )

relationshipValue -> (structure)

A value that relates a component to another component.

targetComponentName -> (string)

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

targetEntityId -> (string)

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

stringValue -> (string)

A string value.

relationshipValue -> (structure)

A value that relates a component to another component.

targetComponentName -> (string)

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

targetEntityId -> (string)

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

stringValue -> (string)

A string value.

JSON Syntax:

[
  {
    "entityPropertyReference": {
      "componentName": "string",
      "entityId": "string",
      "externalIdProperty": {"string": "string"
        ...},
      "propertyName": "string"
    },
    "propertyValues": [
      {
        "time": "string",
        "timestamp": timestamp,
        "value": {
          "booleanValue": true|false,
          "doubleValue": double,
          "expression": "string",
          "integerValue": integer,
          "listValue": [
            {
              "booleanValue": true|false,
              "doubleValue": double,
              "expression": "string",
              "integerValue": integer,
              "listValue": [
                { ... recursive ... }
                ...
              ],
              "longValue": long,
              "mapValue": {"string": { ... recursive ... }
                ...},
              "relationshipValue": {
                "targetComponentName": "string",
                "targetEntityId": "string"
              },
              "stringValue": "string"
            }
            ...
          ],
          "longValue": long,
          "mapValue": {"string": {
                "booleanValue": true|false,
                "doubleValue": double,
                "expression": "string",
                "integerValue": integer,
                "listValue": [
                  { ... recursive ... }
                  ...
                ],
                "longValue": long,
                "mapValue": {"string": { ... recursive ... }
                  ...},
                "relationshipValue": {
                  "targetComponentName": "string",
                  "targetEntityId": "string"
                },
                "stringValue": "string"
              }
            ...},
          "relationshipValue": {
            "targetComponentName": "string",
            "targetEntityId": "string"
          },
          "stringValue": "string"
        }
      }
      ...
    ]
  }
  ...
]

--workspace-id (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

errorEntries -> (list)

Entries that caused errors in the batch put operation.

(structure)

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

errors -> (list)

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

(structure)

An error returned by the BatchPutProperty action.

entry -> (structure)

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

entityPropertyReference -> (structure)

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

componentName -> (string)

The name of the component.

entityId -> (string)

The ID of the entity.

externalIdProperty -> (map)

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

key -> (string)

value -> (string)

propertyName -> (string)

The name of the property.

propertyValues -> (list)

A list of objects that specify time series property values.

(structure)

An object that contains information about a value for a time series property.

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]

timestamp -> (timestamp)

The timestamp of a value for a time series property.

value -> (structure)

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

booleanValue -> (boolean)

A Boolean value.

doubleValue -> (double)

A double value.

expression -> (string)

An expression that produces the value.

integerValue -> (integer)

An integer value.

listValue -> (list)

A list of multiple values.

(structure)

An object that specifies a value for a property.

booleanValue -> (boolean)

A Boolean value.

doubleValue -> (double)

A double value.

expression -> (string)

An expression that produces the value.

integerValue -> (integer)

An integer value.

listValue -> (list)

A list of multiple values.

( … recursive … )

longValue -> (long)

A long value.

mapValue -> (map)

An object that maps strings to multiple DataValue objects.

key -> (string)

( … recursive … )

relationshipValue -> (structure)

A value that relates a component to another component.

targetComponentName -> (string)

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

targetEntityId -> (string)

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

stringValue -> (string)

A string value.

longValue -> (long)

A long value.

mapValue -> (map)

An object that maps strings to multiple DataValue objects.

key -> (string)

value -> (structure)

An object that specifies a value for a property.

booleanValue -> (boolean)

A Boolean value.

doubleValue -> (double)

A double value.

expression -> (string)

An expression that produces the value.

integerValue -> (integer)

An integer value.

listValue -> (list)

A list of multiple values.

( … recursive … )

longValue -> (long)

A long value.

mapValue -> (map)

An object that maps strings to multiple DataValue objects.

key -> (string)

( … recursive … )

relationshipValue -> (structure)

A value that relates a component to another component.

targetComponentName -> (string)

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

targetEntityId -> (string)

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

stringValue -> (string)

A string value.

relationshipValue -> (structure)

A value that relates a component to another component.

targetComponentName -> (string)

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

targetEntityId -> (string)

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

stringValue -> (string)

A string value.

errorCode -> (string)

The error code.

errorMessage -> (string)

The error message.