Skip to content

DescribeEventsRequest

Source code in docs_src/capo_health/types/describe_events_request.py 
14
15
16
17
18
19
20
21
22
23
24
class DescribeEventsRequest(TypedDict, closed=True):
    filter: NotRequired["capo_health.types.event_filter.EventFilter"]
    """<p>Values to narrow the results returned.</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>"""
    max_results: NotRequired[
        "capo_health.types.max_results_lower_range.maxResultsLowerRange"
    ]
    """<p>The maximum number of items to return in one batch, between 1 and 100, inclusive.</p>"""
    locale: NotRequired["capo_health.types.locale.locale"]
    """<p>The locale (language) to return information in. English (en) is the default and the only supported value at this time.</p>"""

filter instance-attribute 

filter: NotRequired[EventFilter]

Values to narrow the results returned.

locale instance-attribute 

locale: NotRequired[locale]

The locale (language) to return information in. English (en) is the default and the only supported value at this time.

max_results instance-attribute 

max_results: NotRequired[maxResultsLowerRange]

The maximum number of items to return in one batch, between 1 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.