Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . iottwinmaker ]

get-property-value-history

Description

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

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-property-value-history
[--component-name <value>]
[--component-type-id <value>]
[--end-date-time <value>]
[--end-time <value>]
[--entity-id <value>]
[--interpolation <value>]
[--max-results <value>]
[--next-token <value>]
[--order-by-time <value>]
[--property-filters <value>]
--selected-properties <value>
[--start-date-time <value>]
[--start-time <value>]
--workspace-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--component-name (string)

The name of the component.

--component-type-id (string)

The ID of the component type.

--end-date-time (timestamp)

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

--end-time (string)

The ISO8601 DateTime of the latest property value to return.

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

--entity-id (string)

The ID of the entity.

--interpolation (structure)

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

interpolationType -> (string)

The interpolation type.

intervalInSeconds -> (long)

The interpolation time interval in seconds.

Shorthand Syntax:

interpolationType=string,intervalInSeconds=long

JSON Syntax:

{
  "interpolationType": "LINEAR",
  "intervalInSeconds": long
}

--max-results (integer)

The maximum number of results to return.

--next-token (string)

The string that specifies the next page of results.

--order-by-time (string)

The time direction to use in the result order.

Possible values:

  • ASCENDING
  • DESCENDING

--property-filters (list)

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

(structure)

An object that filters items returned by a property request.

operator -> (string)

The operator associated with this property filter.

propertyName -> (string)

The property name associated with this property filter.

value -> (structure)

The value associated with this property filter.

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:

[
  {
    "operator": "string",
    "propertyName": "string",
    "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"
    }
  }
  ...
]

--selected-properties (list)

A list of properties whose value histories the request retrieves.

(string)

Syntax:

"string" "string" ...

--start-date-time (timestamp)

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

--start-time (string)

The ISO8601 DateTime of the earliest property value to return.

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

--workspace-id (string)

The ID of the workspace.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

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

nextToken -> (string)

The string that specifies the next page of results.

propertyValues -> (list)

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

(structure)

The history of values for a time series property.

entityPropertyReference -> (structure)

An object that uniquely identifies an entity 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.

values -> (list)

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

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