Skip to content

SearchListingsOutput

Source code in docs_src/capo_datazone/types/search_listings_output.py 
13
14
15
16
17
18
19
20
21
22
23
class SearchListingsOutput(TypedDict, closed=True):
    items: NotRequired["capo_datazone.types.search_result_items.SearchResultItems"]
    """<p>The results of the <code>SearchListings</code> action.</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>"""
    total_match_count: NotRequired["int"]
    """<p>Total number of search results.</p>"""
    aggregates: NotRequired[
        "capo_datazone.types.aggregation_output_list.AggregationOutputList"
    ]
    """<p>Contains computed counts grouped by field values based on the requested aggregation attributes for the matching listings.</p>"""

aggregates instance-attribute 

aggregates: NotRequired[AggregationOutputList]

Contains computed counts grouped by field values based on the requested aggregation attributes for the matching listings.

items instance-attribute 

items: NotRequired[SearchResultItems]

The results of the SearchListings action.

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 SearchListings to list the next set of results.

total_match_count instance-attribute 

total_match_count: NotRequired[int]

Total number of search results.