Skip to content

StartSearchResponse

Source code in docs_src/capo_iotsitewise/types/start_search_response.py 
16
17
18
19
20
21
22
23
24
class StartSearchResponse(TypedDict, closed=True):
    search_id: "capo_iotsitewise.types.search_id.SearchId"
    """<p>The unique identifier assigned to the newly started search.</p>"""
    workspace_name: "capo_iotsitewise.types.workspace_name.WorkspaceName"
    """<p>The name of the workspace the search runs against.</p>"""
    status: "capo_iotsitewise.types.search_status.SearchStatus"
    """<p>The initial status of the search. A newly started search is <code>QUEUED</code>.</p>"""
    group_id: NotRequired["capo_iotsitewise.types.group_id.GroupId"]
    """<p>The group identifier associated with the search, if one was supplied on the request.</p>"""

group_id instance-attribute 

group_id: NotRequired[GroupId]

The group identifier associated with the search, if one was supplied on the request.

search_id instance-attribute 

search_id: SearchId

The unique identifier assigned to the newly started search.

status instance-attribute 

status: SearchStatus

The initial status of the search. A newly started search is QUEUED.

workspace_name instance-attribute 

workspace_name: WorkspaceName

The name of the workspace the search runs against.