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

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

Overview

Note:

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

Instance Attribute Details

#aggregate_typesArray<String>

The data aggregating function.

Returns:

  • (Array<String>)


2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2938

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.

Returns:

  • (String)


2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2938

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)


2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2938

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 be returned per paginated request.

Default: 100

Returns:

  • (Integer)


2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2938

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)


2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2938

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


2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2938

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.

Returns:

  • (String)


2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2938

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


2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2938

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)


2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2938

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)


2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2938

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)


2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2938

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