Class: Aws::IoTSiteWise::Types::ListTimeSeriesRequest

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 ListTimeSeriesRequest data as a hash:

{
  next_token: "NextToken",
  max_results: 1,
  asset_id: "ID",
  alias_prefix: "PropertyAlias",
  time_series_type: "ASSOCIATED", # accepts ASSOCIATED, DISASSOCIATED
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#alias_prefixString

The alias prefix of the time series.

Returns:

  • (String)


5919
5920
5921
5922
5923
5924
5925
5926
5927
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5919

class ListTimeSeriesRequest < Struct.new(
  :next_token,
  :max_results,
  :asset_id,
  :alias_prefix,
  :time_series_type)
  SENSITIVE = []
  include Aws::Structure
end

#asset_idString

The ID of the asset in which the asset property was created.

Returns:

  • (String)


5919
5920
5921
5922
5923
5924
5925
5926
5927
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5919

class ListTimeSeriesRequest < Struct.new(
  :next_token,
  :max_results,
  :asset_id,
  :alias_prefix,
  :time_series_type)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

The maximum number of results to return for each paginated request.

Returns:

  • (Integer)


5919
5920
5921
5922
5923
5924
5925
5926
5927
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5919

class ListTimeSeriesRequest < Struct.new(
  :next_token,
  :max_results,
  :asset_id,
  :alias_prefix,
  :time_series_type)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

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

Returns:

  • (String)


5919
5920
5921
5922
5923
5924
5925
5926
5927
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5919

class ListTimeSeriesRequest < Struct.new(
  :next_token,
  :max_results,
  :asset_id,
  :alias_prefix,
  :time_series_type)
  SENSITIVE = []
  include Aws::Structure
end

#time_series_typeString

The type of the time series. The time series type can be one of the following values:

  • ASSOCIATED – The time series is associated with an asset property.

  • DISASSOCIATED – The time series isn't associated with any asset property.

Returns:

  • (String)


5919
5920
5921
5922
5923
5924
5925
5926
5927
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5919

class ListTimeSeriesRequest < Struct.new(
  :next_token,
  :max_results,
  :asset_id,
  :alias_prefix,
  :time_series_type)
  SENSITIVE = []
  include Aws::Structure
end