Skip to content

SearchSummary

Source code in docs_src/capo_iotsitewise/types/search_summary.py
class SearchSummary(TypedDict, closed=True):
    search_id: "capo_iotsitewise.types.search_id.SearchId"
    """<p>The unique identifier of the 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 current status of the search.</p>"""
    query_statement: (
        "capo_iotsitewise.types.search_query_statement.SearchQueryStatement"
    )
    """<p>The natural-language query that was submitted for the search.</p>"""
    search_type: "capo_iotsitewise.types.search_type.SearchType"
    """<p>The search strategy used for the search.</p>"""
    status_reason: NotRequired["str"]
    """<p>A human-readable explanation of the current status. Populated when the search has <code>FAILED</code>.</p>"""
    started_at: NotRequired["datetime.datetime"]
    """<p>The time at which the search was started.</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.

query_statement instance-attribute

query_statement: SearchQueryStatement

The natural-language query that was submitted for the search.

search_id instance-attribute

search_id: SearchId

The unique identifier of the search.

search_type instance-attribute

search_type: SearchType

The search strategy used for the search.

started_at instance-attribute

started_at: NotRequired[datetime]

The time at which the search was started.

status instance-attribute

status: SearchStatus

The current status of the search.

status_reason instance-attribute

status_reason: NotRequired[str]

A human-readable explanation of the current status. Populated when the search has FAILED.

workspace_name instance-attribute

workspace_name: WorkspaceName

The name of the workspace the search runs against.