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 ]

get-asset-property-aggregates

Description

Gets aggregated values for an asset property. For more information, see Querying aggregates in the IoT SiteWise User Guide .

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 .

See also: AWS API Documentation

get-asset-property-aggregates is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: aggregatedValues

Synopsis

  get-asset-property-aggregates
[--asset-id <value>]
[--property-id <value>]
[--property-alias <value>]
--aggregate-types <value>
--resolution <value>
[--qualities <value>]
--start-date <value>
--end-date <value>
[--time-ordering <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <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

--asset-id (string)

The ID of the asset.

--property-id (string)

The ID of the asset property.

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

--aggregate-types (list)

The data aggregating function.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  AVERAGE
  COUNT
  MAXIMUM
  MINIMUM
  SUM
  STANDARD_DEVIATION

--resolution (string)

The time interval over which to aggregate data.

--qualities (list)

The quality by which to filter asset data.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  GOOD
  BAD
  UNCERTAIN

--start-date (timestamp)

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

--end-date (timestamp)

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

--time-ordering (string)

The chronological sorting order of the requested information.

Default: ASCENDING

Possible values:

  • ASCENDING
  • DESCENDING

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

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

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

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To retrieve an asset property's aggregated average and count values

The following get-asset-property-aggregates example retrieves a wind turbine asset's average total power and count of total power data points for a 1 hour period in time.

aws iotsitewise get-asset-property-aggregates \
    --asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE \
    --property-id a1b2c3d4-5678-90ab-cdef-66666EXAMPLE \
    --start-date 1580849400 \
    --end-date 1580853000 \
    --aggregate-types AVERAGE COUNT \
    --resolution 1h

Output:

{
    "aggregatedValues": [
        {
            "timestamp": 1580850000.0,
            "quality": "GOOD",
            "value": {
                "average": 8723.46538886233,
                "count": 12.0
            }
        }
    ]
}

For more information, see Querying asset property aggregates in the AWS IoT SiteWise User Guide.

Output

aggregatedValues -> (list)

The requested aggregated values.

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

nextToken -> (string)

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