Skip to content

GetPropertyValueRequest

Source code in docs_src/capo_iottwinmaker/types/get_property_value_request.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
class GetPropertyValueRequest(TypedDict, closed=True):
    component_name: NotRequired["capo_iottwinmaker.types.name.Name"]
    """<p>The name of the component whose property values the operation returns.</p>"""
    component_path: NotRequired["capo_iottwinmaker.types.component_path.ComponentPath"]
    """<p>This string specifies the path to the composite component, starting from the top-level component.</p>"""
    component_type_id: NotRequired[
        "capo_iottwinmaker.types.component_type_id.ComponentTypeId"
    ]
    """<p>The ID of the component type whose property values the operation returns.</p>"""
    entity_id: NotRequired["capo_iottwinmaker.types.entity_id.EntityId"]
    """<p>The ID of the entity whose property values the operation returns.</p>"""
    selected_properties: (
        "capo_iottwinmaker.types.selected_property_list.SelectedPropertyList"
    )
    """<p>The properties whose values the operation returns.</p>"""
    workspace_id: "capo_iottwinmaker.types.id.Id"
    """<p>The ID of the workspace whose values the operation returns.</p>"""
    max_results: NotRequired["capo_iottwinmaker.types.max_results.MaxResults"]
    """<p>The maximum number of results to return at one time. The default is 25.</p> <p>Valid Range: Minimum value of 1. Maximum value of 250.</p>"""
    next_token: NotRequired["capo_iottwinmaker.types.next_token.NextToken"]
    """<p>The string that specifies the next page of results.</p>"""
    property_group_name: NotRequired["capo_iottwinmaker.types.name.Name"]
    """<p>The property group name.</p>"""
    tabular_conditions: NotRequired[
        "capo_iottwinmaker.types.tabular_conditions.TabularConditions"
    ]
    """<p>The tabular conditions.</p>"""

component_name instance-attribute 

component_name: NotRequired[Name]

The name of the component whose property values the operation returns.

component_path instance-attribute 

component_path: NotRequired[ComponentPath]

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

component_type_id instance-attribute 

component_type_id: NotRequired[ComponentTypeId]

The ID of the component type whose property values the operation returns.

entity_id instance-attribute 

entity_id: NotRequired[EntityId]

The ID of the entity whose property values the operation returns.

max_results instance-attribute 

max_results: NotRequired[MaxResults]

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

Valid Range: Minimum value of 1. Maximum value of 250.

next_token instance-attribute 

next_token: NotRequired[NextToken]

The string that specifies the next page of results.

property_group_name instance-attribute 

property_group_name: NotRequired[Name]

The property group name.

selected_properties instance-attribute 

selected_properties: SelectedPropertyList

The properties whose values the operation returns.

tabular_conditions instance-attribute 

tabular_conditions: NotRequired[TabularConditions]

The tabular conditions.

workspace_id instance-attribute 

workspace_id: Id

The ID of the workspace whose values the operation returns.