AWS CLI Command Reference

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

batch-get-asset-property-aggregates

Description

Gets aggregated values (for example, average, minimum, and maximum) for one or more asset properties. For more information, see Querying aggregates in the IoT SiteWise User Guide .

See also: AWS API Documentation

Synopsis

  batch-get-asset-property-aggregates
--entries <value>
[--next-token <value>]
[--max-results <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--entries (list)

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

(structure)

Contains information for an asset property aggregate entry that is associated with the BatchGetAssetPropertyAggregates 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, in UUID format.

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 .

aggregateTypes -> (list)

The data aggregating function.

(string)

resolution -> (string)

The time interval over which to aggregate data.

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,aggregateTypes=string,string,resolution=string,startDate=timestamp,endDate=timestamp,qualities=string,string,timeOrdering=string ...

JSON Syntax:

[
  {
    "entryId": "string",
    "assetId": "string",
    "propertyId": "string",
    "propertyAlias": "string",
    "aggregateTypes": ["AVERAGE"|"COUNT"|"MAXIMUM"|"MINIMUM"|"SUM"|"STANDARD_DEVIATION", ...],
    "resolution": "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 equal to 1 MB.
  • The number of data points in the result set is equal to the value of maxResults . The maximum value of maxResults is 4000.

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

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

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)

Contains error information for an asset property aggregate entry that is associated with the BatchGetAssetPropertyAggregates API.

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

entryId -> (string)

The ID of the entry.

aggregatedValues -> (list)

The requested aggregated asset property values (for example, average, minimum, and maximum).

(structure)

Contains aggregated asset property values (for example, average, minimum, and maximum).

timestamp -> (timestamp)

The date the aggregating computations occurred, in Unix epoch time.

quality -> (string)

The quality of the aggregated data.

value -> (structure)

The value of the aggregates.

average -> (double)

The average (mean) value of the time series over a time interval window.

count -> (double)

The count of data points in the time series over a time interval window.

maximum -> (double)

The maximum value of the time series over a time interval window.

minimum -> (double)

The minimum value of the time series over a time interval window.

sum -> (double)

The sum of the time series over a time interval window.

standardDeviation -> (double)

The standard deviation of the time series over a time interval window.

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

entryId -> (string)

The ID of the entry.

completionStatus -> (string)

The completion status of each entry that is associated with the BatchGetAssetPropertyAggregates 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.