Skip to content

ListSearchesRequest

Source code in docs_src/capo_iotsitewise/types/list_searches_request.py
class ListSearchesRequest(TypedDict, closed=True):
    workspace_name: "capo_iotsitewise.types.workspace_name.WorkspaceName"
    """<p>The name of the workspace whose searches are listed.</p>"""
    max_results: NotRequired[
        "capo_iotsitewise.types.list_searches_request_max_results_integer.ListSearchesRequestMaxResultsInteger"
    ]
    """<p>The maximum number of searches to return in a single page. Valid range is 1 to 1,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 ListSearches call. Provide it to retrieve the next page; omit it to retrieve the first page.</p>"""
    list_searches_filters: NotRequired[
        "capo_iotsitewise.types.list_searches_filters.ListSearchesFilters"
    ]
    """<p>Optional filters that restrict which searches are returned.</p>"""

list_searches_filters instance-attribute

list_searches_filters: NotRequired[ListSearchesFilters]

Optional filters that restrict which searches are returned.

max_results instance-attribute

max_results: NotRequired[ListSearchesRequestMaxResultsInteger]

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

next_token instance-attribute

next_token: NotRequired[NextToken]

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

workspace_name instance-attribute

workspace_name: WorkspaceName

The name of the workspace whose searches are listed.