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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-iotsitewise/types.rb

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aggregate_typesArray<String>

The data aggregating function.

Returns:

  • (Array<String>)


5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
# File 'lib/aws-sdk-iotsitewise/types.rb', line 5579

class GetAssetPropertyAggregatesRequest < Struct.new(
  :asset_id,
  :property_id,
  :property_alias,
  :aggregate_types,
  :resolution,
  :qualities,
  :start_date,
  :end_date,
  :time_ordering,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#asset_idString

The ID of the asset, in UUID format.

Returns:

  • (String)


5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
# File 'lib/aws-sdk-iotsitewise/types.rb', line 5579

class GetAssetPropertyAggregatesRequest < Struct.new(
  :asset_id,
  :property_id,
  :property_alias,
  :aggregate_types,
  :resolution,
  :qualities,
  :start_date,
  :end_date,
  :time_ordering,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#end_dateTime

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

Returns:

  • (Time)


5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
# File 'lib/aws-sdk-iotsitewise/types.rb', line 5579

class GetAssetPropertyAggregatesRequest < Struct.new(
  :asset_id,
  :property_id,
  :property_alias,
  :aggregate_types,
  :resolution,
  :qualities,
  :start_date,
  :end_date,
  :time_ordering,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

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

Returns:

  • (Integer)


5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
# File 'lib/aws-sdk-iotsitewise/types.rb', line 5579

class GetAssetPropertyAggregatesRequest < Struct.new(
  :asset_id,
  :property_id,
  :property_alias,
  :aggregate_types,
  :resolution,
  :qualities,
  :start_date,
  :end_date,
  :time_ordering,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

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

Returns:

  • (String)


5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
# File 'lib/aws-sdk-iotsitewise/types.rb', line 5579

class GetAssetPropertyAggregatesRequest < Struct.new(
  :asset_id,
  :property_id,
  :property_alias,
  :aggregate_types,
  :resolution,
  :qualities,
  :start_date,
  :end_date,
  :time_ordering,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#property_aliasString

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

[1]: docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html

Returns:

  • (String)


5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
# File 'lib/aws-sdk-iotsitewise/types.rb', line 5579

class GetAssetPropertyAggregatesRequest < Struct.new(
  :asset_id,
  :property_id,
  :property_alias,
  :aggregate_types,
  :resolution,
  :qualities,
  :start_date,
  :end_date,
  :time_ordering,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#property_idString

The ID of the asset property, in UUID format.

Returns:

  • (String)


5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
# File 'lib/aws-sdk-iotsitewise/types.rb', line 5579

class GetAssetPropertyAggregatesRequest < Struct.new(
  :asset_id,
  :property_id,
  :property_alias,
  :aggregate_types,
  :resolution,
  :qualities,
  :start_date,
  :end_date,
  :time_ordering,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#qualitiesArray<String>

The quality by which to filter asset data.

Returns:

  • (Array<String>)


5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
# File 'lib/aws-sdk-iotsitewise/types.rb', line 5579

class GetAssetPropertyAggregatesRequest < Struct.new(
  :asset_id,
  :property_id,
  :property_alias,
  :aggregate_types,
  :resolution,
  :qualities,
  :start_date,
  :end_date,
  :time_ordering,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#resolutionString

The time interval over which to aggregate data.

Returns:

  • (String)


5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
# File 'lib/aws-sdk-iotsitewise/types.rb', line 5579

class GetAssetPropertyAggregatesRequest < Struct.new(
  :asset_id,
  :property_id,
  :property_alias,
  :aggregate_types,
  :resolution,
  :qualities,
  :start_date,
  :end_date,
  :time_ordering,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#start_dateTime

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

Returns:

  • (Time)


5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
# File 'lib/aws-sdk-iotsitewise/types.rb', line 5579

class GetAssetPropertyAggregatesRequest < Struct.new(
  :asset_id,
  :property_id,
  :property_alias,
  :aggregate_types,
  :resolution,
  :qualities,
  :start_date,
  :end_date,
  :time_ordering,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#time_orderingString

The chronological sorting order of the requested information.

Default: ‘ASCENDING`

Returns:

  • (String)


5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
# File 'lib/aws-sdk-iotsitewise/types.rb', line 5579

class GetAssetPropertyAggregatesRequest < Struct.new(
  :asset_id,
  :property_id,
  :property_alias,
  :aggregate_types,
  :resolution,
  :qualities,
  :start_date,
  :end_date,
  :time_ordering,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end