[ aws . iotsitewise ]

batch-get-asset-property-value-history

Description

Gets the historical values for one or more asset properties. For more information, see Querying historical values in the IoT SiteWise User Guide .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  batch-get-asset-property-value-history
--entries <value>
[--next-token <value>]
[--max-results <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--entries (list)

The list of asset property historical value entries for the batch get request. You can specify up to 16 entries per request.

(structure)

Contains information for an asset property historical value entry that is associated with the BatchGetAssetPropertyValueHistory API.

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

• The assetId and propertyId of an asset property.

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

entryId -> (string)

The ID of the entry.

assetId -> (string)

The ID of the asset in which the asset property was created.

propertyId -> (string)

The ID of the asset property.

propertyAlias -> (string)

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

startDate -> (timestamp)

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

endDate -> (timestamp)

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

qualities -> (list)

The quality by which to filter asset data.

(string)

timeOrdering -> (string)

The chronological sorting order of the requested information.

Default: ASCENDING

Shorthand Syntax:

entryId=string,assetId=string,propertyId=string,propertyAlias=string,startDate=timestamp,endDate=timestamp,qualities=string,string,timeOrdering=string ...

JSON Syntax:

[
  {
    "entryId": "string",
    "assetId": "string",
    "propertyId": "string",
    "propertyAlias": "string",
    "startDate": timestamp,
    "endDate": timestamp,
    "qualities": ["GOOD"|"BAD"|"UNCERTAIN", ...],
    "timeOrdering": "ASCENDING"|"DESCENDING"
  }
  ...
]

--next-token (string)

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

--max-results (integer)

The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first.

• The size of the result set is less than 1 MB.

• The number of data points in the result set is less than the value of maxResults . The maximum value of maxResults is 4000.

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

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

(structure)

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

errorCode -> (string)

The error code.

errorMessage -> (string)

The associated error message.

entryId -> (string)

The ID of the entry.

successEntries -> (list)

A list of entries that were processed successfully by this batch request. Each success entry contains the entryId of the entry that succeeded and the latest query result.

(structure)

Contains success information for an entry that is associated with the BatchGetAssetPropertyValueHistory API.

entryId -> (string)

The ID of the entry.

assetPropertyValueHistory -> (list)

The requested historical values for the specified asset property.

(structure)

Contains asset property value information.

value -> (structure)

The value of the asset property (see Variant ).

stringValue -> (string)

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

integerValue -> (integer)

Asset property data of type integer (whole number).

doubleValue -> (double)

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

booleanValue -> (boolean)

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

timestamp -> (structure)

The timestamp of the asset property value.

timeInSeconds -> (long)

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

offsetInNanos -> (integer)

The nanosecond offset from timeInSeconds .

quality -> (string)

The quality of the asset property value.

skippedEntries -> (list)

A list of entries that were not processed by this batch request. because these entries had been completely processed by previous paginated requests. Each skipped entry contains the entryId of the entry that skipped.

(structure)

Contains information for an entry that has been processed by the previous BatchGetAssetPropertyValueHistory request.

entryId -> (string)

The ID of the entry.

completionStatus -> (string)

The completion status of each entry that is associated with the BatchGetAssetPropertyValueHistory API.

errorInfo -> (structure)

The error information, such as the error code and the timestamp.

errorCode -> (string)

The error code.

errorTimestamp -> (timestamp)

The date the error occurred, in Unix epoch time.

nextToken -> (string)

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