Skip to content

DescribeEventsRequest

Source code in docs_src/capo_dax/types/describe_events_request.py
class DescribeEventsRequest(TypedDict, closed=True):
    source_name: NotRequired["capo_dax.types.string.String"]
    """<p>The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.</p>"""
    source_type: NotRequired["capo_dax.types.source_type.SourceType"]
    """<p>The event source to retrieve events for. If no value is specified, all events are returned.</p>"""
    start_time: NotRequired["capo_dax.types.t_stamp.TStamp"]
    """<p>The beginning of the time interval to retrieve events for, specified in ISO 8601 format.</p>"""
    end_time: NotRequired["capo_dax.types.t_stamp.TStamp"]
    """<p>The end of the time interval for which to retrieve events, specified in ISO 8601 format.</p>"""
    duration: NotRequired["capo_dax.types.integer_optional.IntegerOptional"]
    """<p>The number of minutes' worth of events to retrieve.</p>"""
    max_results: NotRequired["capo_dax.types.integer_optional.IntegerOptional"]
    """<p>The maximum number of results to include in the response. If more results exist than the specified <code>MaxResults</code> value, a token is included in the response so that the remaining results can be retrieved.</p> <p>The value for <code>MaxResults</code> must be between 20 and 100.</p>"""
    next_token: NotRequired["capo_dax.types.string.String"]
    """<p>An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by <code>MaxResults</code>.</p>"""

duration instance-attribute

duration: NotRequired[IntegerOptional]

The number of minutes' worth of events to retrieve.

end_time instance-attribute

end_time: NotRequired[TStamp]

The end of the time interval for which to retrieve events, specified in ISO 8601 format.

max_results instance-attribute

max_results: NotRequired[IntegerOptional]

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

The value for MaxResults must be between 20 and 100.

next_token instance-attribute

next_token: NotRequired[String]

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

source_name instance-attribute

source_name: NotRequired[String]

The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.

source_type instance-attribute

source_type: NotRequired[SourceType]

The event source to retrieve events for. If no value is specified, all events are returned.

start_time instance-attribute

start_time: NotRequired[TStamp]

The beginning of the time interval to retrieve events for, specified in ISO 8601 format.