Class: Aws::IoTSiteWise::Types::GetAssetPropertyAggregatesRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::IoTSiteWise::Types::GetAssetPropertyAggregatesRequest
- Defined in:
- gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb
Overview
When making an API call, you may pass GetAssetPropertyAggregatesRequest data as a 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,
}
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#aggregate_types ⇒ Array<String>
The data aggregating function.
-
#asset_id ⇒ 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.
-
#max_results ⇒ Integer
The maximum number of results to return for each paginated request.
-
#next_token ⇒ String
The token to be used for the next set of paginated results.
-
#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
). -
#property_id ⇒ String
The ID of the asset property.
-
#qualities ⇒ Array<String>
The quality by which to filter asset data.
-
#resolution ⇒ 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.
-
#time_ordering ⇒ String
The chronological sorting order of the requested information.
Instance Attribute Details
#aggregate_types ⇒ Array<String>
The data aggregating function.
4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4608 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_id ⇒ String
The ID of the asset.
4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4608 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_date ⇒ Time
The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.
4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4608 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_results ⇒ Integer
The maximum number of results to return for each paginated request.
Default: 100
4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4608 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_token ⇒ String
The token to be used for the next set of paginated results.
4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4608 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_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.
4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4608 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_id ⇒ String
The ID of the asset property.
4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4608 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 |
#qualities ⇒ Array<String>
The quality by which to filter asset data.
4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4608 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 |
#resolution ⇒ String
The time interval over which to aggregate data.
4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4608 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_date ⇒ Time
The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.
4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4608 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_ordering ⇒ String
The chronological sorting order of the requested information.
Default: ASCENDING
4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4608 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 |