Skip to content

SearchTypesInput

Source code in docs_src/capo_datazone/types/search_types_input.py
class SearchTypesInput(TypedDict, closed=True):
    domain_identifier: "capo_datazone.types.domain_id.DomainId"
    """<p>The identifier of the Amazon DataZone domain in which to invoke the <code>SearchTypes</code> action.</p>"""
    max_results: NotRequired["capo_datazone.types.max_results.MaxResults"]
    """<p>The maximum number of results to return in a single call to <code>SearchTypes</code>. When the number of results to be listed is greater than the value of <code>MaxResults</code>, the response contains a <code>NextToken</code> value that you can use in a subsequent call to <code>SearchTypes</code> to list the next set of results. </p>"""
    next_token: NotRequired["capo_datazone.types.pagination_token.PaginationToken"]
    """<p>When the number of results is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of results, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>SearchTypes</code> to list the next set of results.</p>"""
    search_scope: "capo_datazone.types.types_search_scope.TypesSearchScope"
    """<p>Specifies the scope of the search for types.</p>"""
    search_text: NotRequired["capo_datazone.types.search_text.SearchText"]
    """<p>Specifies the text for which to search.</p>"""
    search_in: NotRequired["capo_datazone.types.search_in_list.SearchInList"]
    """<p>The details of the search.</p>"""
    filters: NotRequired["capo_datazone.types.filter_clause.FilterClause"]
    """<p>The filters for the <code>SearchTypes</code> action.</p>"""
    sort: NotRequired["capo_datazone.types.search_sort.SearchSort"]
    """<p>The specifies the way to sort the <code>SearchTypes</code> results.</p>"""
    managed: "bool"
    """<p>Specifies whether the search is managed.</p>"""

domain_identifier instance-attribute

domain_identifier: DomainId

The identifier of the Amazon DataZone domain in which to invoke the SearchTypes action.

filters instance-attribute

filters: NotRequired[FilterClause]

The filters for the SearchTypes action.

managed instance-attribute

managed: bool

Specifies whether the search is managed.

max_results instance-attribute

max_results: NotRequired[MaxResults]

The maximum number of results to return in a single call to SearchTypes. When the number of results to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to SearchTypes to list the next set of results.

next_token instance-attribute

next_token: NotRequired[PaginationToken]

When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to SearchTypes to list the next set of results.

search_in instance-attribute

search_in: NotRequired[SearchInList]

The details of the search.

search_scope instance-attribute

search_scope: TypesSearchScope

Specifies the scope of the search for types.

search_text instance-attribute

search_text: NotRequired[SearchText]

Specifies the text for which to search.

sort instance-attribute

sort: NotRequired[SearchSort]

The specifies the way to sort the SearchTypes results.