Skip to content

DescribeEventAggregatesRequest

Source code in docs_src/capo_health/types/describe_event_aggregates_request.py 
16
17
18
19
20
21
22
23
24
class DescribeEventAggregatesRequest(TypedDict, closed=True):
    filter: NotRequired["capo_health.types.event_filter.EventFilter"]
    """<p>Values to narrow the results returned.</p>"""
    aggregate_field: "capo_health.types.event_aggregate_field.eventAggregateField"
    """<p>The only currently supported value is <code>eventTypeCategory</code>.</p>"""
    max_results: NotRequired["capo_health.types.max_results.maxResults"]
    """<p>The maximum number of items to return in one batch, between 10 and 100, inclusive.</p>"""
    next_token: NotRequired["capo_health.types.next_token.nextToken"]
    """<p>If the results of a search are large, only a portion of the results are returned, and a <code>nextToken</code> pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.</p>"""

aggregate_field instance-attribute 

aggregate_field: eventAggregateField

The only currently supported value is eventTypeCategory.

filter instance-attribute 

filter: NotRequired[EventFilter]

Values to narrow the results returned.

max_results instance-attribute 

max_results: NotRequired[maxResults]

The maximum number of items to return in one batch, between 10 and 100, inclusive.

next_token instance-attribute 

next_token: NotRequired[nextToken]

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.