Skip to content

SearchInput

Source code in docs_src/capo_datazone/types/search_input.py
class SearchInput(TypedDict, closed=True):
    domain_identifier: "capo_datazone.types.domain_id.DomainId"
    """<p>The identifier of the Amazon DataZone domain.</p>"""
    owning_project_identifier: NotRequired["capo_datazone.types.project_id.ProjectId"]
    """<p>The identifier of the owning project specified for the search.</p>"""
    max_results: NotRequired["capo_datazone.types.max_results.MaxResults"]
    """<p>The maximum number of results to return in a single call to <code>Search</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>Search</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>Search</code> to list the next set of results.</p>"""
    search_scope: "capo_datazone.types.inventory_search_scope.InventorySearchScope"
    """<p>The scope of the search.</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>Specifies the search filters.</p>"""
    sort: NotRequired["capo_datazone.types.search_sort.SearchSort"]
    """<p>Specifies the way in which the search results are to be sorted.</p>"""
    additional_attributes: NotRequired[
        "capo_datazone.types.search_output_additional_attributes.SearchOutputAdditionalAttributes"
    ]
    """<p>Specifies additional attributes for the <code>Search</code> action.</p>"""

additional_attributes instance-attribute

additional_attributes: NotRequired[SearchOutputAdditionalAttributes]

Specifies additional attributes for the Search action.

domain_identifier instance-attribute

domain_identifier: DomainId

The identifier of the Amazon DataZone domain.

filters instance-attribute

filters: NotRequired[FilterClause]

Specifies the search filters.

max_results instance-attribute

max_results: NotRequired[MaxResults]

The maximum number of results to return in a single call to Search. 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 Search 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 Search to list the next set of results.

owning_project_identifier instance-attribute

owning_project_identifier: NotRequired[ProjectId]

The identifier of the owning project specified for the search.

search_in instance-attribute

search_in: NotRequired[SearchInList]

The details of the search.

search_scope instance-attribute

search_scope: InventorySearchScope

The scope of the search.

search_text instance-attribute

search_text: NotRequired[SearchText]

Specifies the text for which to search.

sort instance-attribute

sort: NotRequired[SearchSort]

Specifies the way in which the search results are to be sorted.