You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::IoTSiteWise::Types::GetAssetPropertyAggregatesRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing GetAssetPropertyAggregatesRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  asset_id: "ID",
  property_id: "ID",
  property_alias: "AssetPropertyAlias",
  aggregate_types: ["AVERAGE"], # required, accepts AVERAGE, COUNT, MAXIMUM, MINIMUM, SUM, STANDARD_DEVIATION
  resolution: "Resolution", # required
  qualities: ["GOOD"], # accepts GOOD, BAD, UNCERTAIN
  start_date: Time.now, # required
  end_date: Time.now, # required
  time_ordering: "ASCENDING", # accepts ASCENDING, DESCENDING
  next_token: "NextToken",
  max_results: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#aggregate_types ⇒ Array<String>

The data aggregating function.

Returns:

  • (Array<String>) —

    The data aggregating function.

#asset_id ⇒ String

The ID of the asset.

Returns:

  • (String) —

    The ID of the asset.

#end_date ⇒ Time

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

Returns:

  • (Time) —

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

#max_results ⇒ Integer

The maximum number of results to be returned per paginated request.

Default: 100

Returns:

  • (Integer) —

    The maximum number of results to be returned per paginated request.

#next_token ⇒ String

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

Returns:

  • (String) —

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

#property_alias ⇒ String

The property 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 AWS IoT SiteWise User Guide.

Returns:

  • (String) —

    The property alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature).

#property_id ⇒ String

The ID of the asset property.

Returns:

  • (String) —

    The ID of the asset property.

#qualities ⇒ Array<String>

The quality by which to filter asset data.

Returns:

  • (Array<String>) —

    The quality by which to filter asset data.

#resolution ⇒ String

The time interval over which to aggregate data.

Returns:

  • (String) —

    The time interval over which to aggregate data.

#start_date ⇒ Time

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

Returns:

  • (Time) —

    The exclusive start 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

Returns:

  • (String) —

    The chronological sorting order of the requested information.