Skip to content

DescribeEventsMessage

Source code in docs_src/capo_elasticache/types/describe_events_message.py
class DescribeEventsMessage(TypedDict, closed=True):
    source_identifier: NotRequired["capo_elasticache.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_elasticache.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_elasticache.types.t_stamp.TStamp"]
    """<p>The beginning of the time interval to retrieve events for, specified in ISO 8601 format.</p> <p> <b>Example:</b> 2017-03-30T07:03:49.555Z</p>"""
    end_time: NotRequired["capo_elasticache.types.t_stamp.TStamp"]
    """<p>The end of the time interval for which to retrieve events, specified in ISO 8601 format.</p> <p> <b>Example:</b> 2017-03-30T07:03:49.555Z</p>"""
    duration: NotRequired["capo_elasticache.types.integer_optional.IntegerOptional"]
    """<p>The number of minutes worth of events to retrieve.</p>"""
    max_records: NotRequired["capo_elasticache.types.integer_optional.IntegerOptional"]
    """<p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a marker is included in the response so that the remaining results can be retrieved.</p> <p>Default: 100</p> <p>Constraints: minimum 20; maximum 100.</p>"""
    marker: NotRequired["capo_elasticache.types.string.String"]
    """<p>An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</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.

Example: 2017-03-30T07:03:49.555Z

marker instance-attribute

marker: NotRequired[String]

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

max_records instance-attribute

max_records: NotRequired[IntegerOptional]

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

Default: 100

Constraints: minimum 20; maximum 100.

source_identifier instance-attribute

source_identifier: 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