Skip to content

DescribeEventsRequest

Source code in docs_src/capo_memorydb/types/describe_events_request.py
class DescribeEventsRequest(TypedDict, closed=True):
    source_name: NotRequired["capo_memorydb.types.string.String"]
    """<p>The identifier of the event source for which events are returned. If not specified, all sources are included in the response.</p>"""
    source_type: NotRequired["capo_memorydb.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_memorydb.types.t_stamp.TStamp"]
    """<p>The beginning of the time interval to retrieve events for, specified in ISO 8601 format. Example: 2017-03-30T07:03:49.555Z</p>"""
    end_time: NotRequired["capo_memorydb.types.t_stamp.TStamp"]
    """<p>The end of the time interval for which to retrieve events, specified in ISO 8601 format. Example: 2017-03-30T07:03:49.555Z</p>"""
    duration: NotRequired["capo_memorydb.types.integer_optional.IntegerOptional"]
    """<p>The number of minutes worth of events to retrieve.</p>"""
    max_results: NotRequired["capo_memorydb.types.integer_optional.IntegerOptional"]
    """<p>The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.</p>"""
    next_token: NotRequired["capo_memorydb.types.string.String"]
    """<p>An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. </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. Example: 2017-03-30T07:03:49.555Z

max_results instance-attribute

max_results: NotRequired[IntegerOptional]

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

next_token instance-attribute

next_token: NotRequired[String]

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

source_name instance-attribute

source_name: NotRequired[String]

The identifier of the event source for which events are returned. If not specified, 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. Example: 2017-03-30T07:03:49.555Z