Skip to content

GetSearchResultsRequest

Source code in docs_src/capo_iotsitewise/types/get_search_results_request.py 
14
15
16
17
18
19
20
21
22
23
24
class GetSearchResultsRequest(TypedDict, closed=True):
    search_id: "capo_iotsitewise.types.search_id.SearchId"
    """<p>The identifier of the search whose results are retrieved.</p>"""
    workspace_name: "capo_iotsitewise.types.workspace_name.WorkspaceName"
    """<p>The name of the workspace the search belongs to.</p>"""
    max_results: NotRequired[
        "capo_iotsitewise.types.get_search_results_request_max_results_integer.GetSearchResultsRequestMaxResultsInteger"
    ]
    """<p>The maximum number of results to return in a single page. Valid range is 1 to 10,000; if omitted, a service-defined default is used.</p>"""
    next_token: NotRequired["capo_iotsitewise.types.next_token.NextToken"]
    """<p>The pagination token returned by a previous GetSearchResults call. Provide it to retrieve the next page of results; omit it to retrieve the first page.</p>"""

max_results instance-attribute 

max_results: NotRequired[GetSearchResultsRequestMaxResultsInteger]

The maximum number of results to return in a single page. Valid range is 1 to 10,000; if omitted, a service-defined default is used.

next_token instance-attribute 

next_token: NotRequired[NextToken]

The pagination token returned by a previous GetSearchResults call. Provide it to retrieve the next page of results; omit it to retrieve the first page.

search_id instance-attribute 

search_id: SearchId

The identifier of the search whose results are retrieved.

workspace_name instance-attribute 

workspace_name: WorkspaceName

The name of the workspace the search belongs to.