Class: Aws::IoTTwinMaker::Types::ListPropertiesRequest

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#component_nameString

The name of the component whose properties are returned by the operation.

Returns:

  • (String)


2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 2583

class ListPropertiesRequest < Struct.new(
  :workspace_id,
  :component_name,
  :component_path,
  :entity_id,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#component_pathString

This string specifies the path to the composite component, starting from the top-level component.

Returns:

  • (String)


2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 2583

class ListPropertiesRequest < Struct.new(
  :workspace_id,
  :component_name,
  :component_path,
  :entity_id,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#entity_idString

The ID for the entity whose metadata (component/properties) is returned by the operation.

Returns:

  • (String)


2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 2583

class ListPropertiesRequest < Struct.new(
  :workspace_id,
  :component_name,
  :component_path,
  :entity_id,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

The maximum number of results returned at one time. The default is 25.

Returns:

  • (Integer)


2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 2583

class ListPropertiesRequest < Struct.new(
  :workspace_id,
  :component_name,
  :component_path,
  :entity_id,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

The string that specifies the next page of results.

Returns:

  • (String)


2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 2583

class ListPropertiesRequest < Struct.new(
  :workspace_id,
  :component_name,
  :component_path,
  :entity_id,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#workspace_idString

The workspace ID.

Returns:

  • (String)


2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 2583

class ListPropertiesRequest < Struct.new(
  :workspace_id,
  :component_name,
  :component_path,
  :entity_id,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end