Skip to content

ListEntitiesRequest

Source code in docs_src/capo_iottwinmaker/types/list_entities_request.py 
14
15
16
17
18
19
20
21
22
23
24
class ListEntitiesRequest(TypedDict, closed=True):
    workspace_id: "capo_iottwinmaker.types.id.Id"
    """<p>The ID of the workspace.</p>"""
    filters: NotRequired[
        "capo_iottwinmaker.types.list_entities_filters.ListEntitiesFilters"
    ]
    """<p>A list of objects that filter the request.</p> <note> <p>Only one object is accepted as a valid input.</p> </note>"""
    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>"""

filters instance-attribute 

filters: NotRequired[ListEntitiesFilters]

A list of objects that filter the request.

Only one object is accepted as a valid input.

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.

workspace_id instance-attribute 

workspace_id: Id

The ID of the workspace.