Skip to content

DescribeEventsMessage

Source code in docs_src/capo_docdb/types/describe_events_message.py
class DescribeEventsMessage(TypedDict, closed=True):
    source_identifier: NotRequired["capo_docdb.types.string.String"]
    """<p>The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.</p> <p>Constraints:</p> <ul> <li> <p>If <code>SourceIdentifier</code> is provided, <code>SourceType</code> must also be provided.</p> </li> <li> <p>If the source type is <code>DBInstance</code>, a <code>DBInstanceIdentifier</code> must be provided.</p> </li> <li> <p>If the source type is <code>DBSecurityGroup</code>, a <code>DBSecurityGroupName</code> must be provided.</p> </li> <li> <p>If the source type is <code>DBParameterGroup</code>, a <code>DBParameterGroupName</code> must be provided.</p> </li> <li> <p>If the source type is <code>DBSnapshot</code>, a <code>DBSnapshotIdentifier</code> must be provided.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul>"""
    source_type: NotRequired["capo_docdb.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_docdb.types.t_stamp.TStamp"]
    """<p> The beginning of the time interval to retrieve events for, specified in ISO 8601 format. </p> <p>Example: 2009-07-08T18:00Z</p>"""
    end_time: NotRequired["capo_docdb.types.t_stamp.TStamp"]
    """<p> The end of the time interval for which to retrieve events, specified in ISO 8601 format. </p> <p>Example: 2009-07-08T18:00Z</p>"""
    duration: NotRequired["capo_docdb.types.integer_optional.IntegerOptional"]
    """<p>The number of minutes to retrieve events for.</p> <p>Default: 60</p>"""
    event_categories: NotRequired[
        "capo_docdb.types.event_categories_list.EventCategoriesList"
    ]
    """<p>A list of event categories that trigger notifications for an event notification subscription.</p>"""
    filters: NotRequired["capo_docdb.types.filter_list.FilterList"]
    """<p>This parameter is not currently supported.</p>"""
    max_records: NotRequired["capo_docdb.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 pagination token (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_docdb.types.string.String"]
    """<p>An optional pagination token provided by a previous request. 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 to retrieve events for.

Default: 60

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: 2009-07-08T18:00Z

event_categories instance-attribute

event_categories: NotRequired[EventCategoriesList]

A list of event categories that trigger notifications for an event notification subscription.

filters instance-attribute

filters: NotRequired[FilterList]

This parameter is not currently supported.

marker instance-attribute

marker: NotRequired[String]

An optional pagination token provided by a previous request. 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 pagination token (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, then all sources are included in the response.

Constraints:

  • If SourceIdentifier is provided, SourceType must also be provided.

  • If the source type is DBInstance, a DBInstanceIdentifier must be provided.

  • If the source type is DBSecurityGroup, a DBSecurityGroupName must be provided.

  • If the source type is DBParameterGroup, a DBParameterGroupName must be provided.

  • If the source type is DBSnapshot, a DBSnapshotIdentifier must be provided.

  • Cannot end with a hyphen or contain two consecutive hyphens.

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: 2009-07-08T18:00Z