Skip to content

ListComponentsRequest

Source code in docs_src/capo_iottwinmaker/types/list_components_request.py 
15
16
17
18
19
20
21
22
23
24
25
class ListComponentsRequest(TypedDict, closed=True):
    workspace_id: "capo_iottwinmaker.types.id.Id"
    """<p>The workspace ID.</p>"""
    entity_id: "capo_iottwinmaker.types.entity_id.EntityId"
    """<p>The ID for the entity whose metadata (component/properties) is returned by the operation.</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>"""
    max_results: NotRequired["capo_iottwinmaker.types.max_results.MaxResults"]
    """<p>The maximum number of results returned at one time. The default is 25.</p>"""
    next_token: NotRequired["capo_iottwinmaker.types.next_token.NextToken"]
    """<p>The string that specifies the next page of results.</p>"""

component_path instance-attribute 

component_path: NotRequired[ComponentPath]

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

entity_id instance-attribute 

entity_id: EntityId

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

max_results instance-attribute 

max_results: NotRequired[MaxResults]

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

next_token instance-attribute 

next_token: NotRequired[NextToken]

The string that specifies the next page of results.

workspace_id instance-attribute 

workspace_id: Id

The workspace ID.