SearchListingsInput ¶

class SearchListingsInput(TypedDict, closed=True):
    domain_identifier: "capo_datazone.types.domain_id.DomainId"
    """<p>The identifier of the domain in which to search listings.</p>"""
    search_text: NotRequired["str"]
    """<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>"""
    max_results: NotRequired["capo_datazone.types.max_results.MaxResults"]
    """<p>The maximum number of results to return in a single call to <code>SearchListings</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>SearchListings</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>SearchListings</code> to list the next set of results.</p>"""
    filters: NotRequired["capo_datazone.types.filter_clause.FilterClause"]
    """<p>Specifies the filters for the search of listings.</p>"""
    aggregations: NotRequired["capo_datazone.types.aggregation_list.AggregationList"]
    """<p>Enables you to specify one or more attributes to compute and return counts grouped by field values.</p>"""
    sort: NotRequired["capo_datazone.types.search_sort.SearchSort"]
    """<p>Specifies the way for sorting the search results.</p>"""
    additional_attributes: NotRequired[
        "capo_datazone.types.search_output_additional_attributes.SearchOutputAdditionalAttributes"
    ]
    """<p>Specifies additional attributes for the search.</p>"""