Class: Aws::IoTSiteWise::Types::ListAssetPropertiesRequest

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#asset_idString

The ID of the asset. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

Returns:

  • (String)


6366
6367
6368
6369
6370
6371
6372
6373
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 6366

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

#filterString

Filters the requested list of asset properties. You can choose one of the following options:

  • ALL – The list includes all asset properties for a given asset model ID.

  • BASE – The list includes only base asset properties for a given asset model ID.

Default: BASE

Returns:

  • (String)


6366
6367
6368
6369
6370
6371
6372
6373
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 6366

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

#max_resultsInteger

The maximum number of results to return for each paginated request. If not specified, the default value is 50.

Returns:

  • (Integer)


6366
6367
6368
6369
6370
6371
6372
6373
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 6366

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

#next_tokenString

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

Returns:

  • (String)


6366
6367
6368
6369
6370
6371
6372
6373
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 6366

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