Skip to content

DescribeEventsMessage

Source code in docs_src/capo_database_migration_service/types/describe_events_message.py
class DescribeEventsMessage(TypedDict, closed=True):
    source_identifier: NotRequired[
        "capo_database_migration_service.types.string.String"
    ]
    """<p> The identifier of an event source.</p>"""
    source_type: NotRequired[
        "capo_database_migration_service.types.source_type.SourceType"
    ]
    """<p>The type of DMS resource that generates events.</p> <p>Valid values: replication-instance | replication-task</p>"""
    start_time: NotRequired["capo_database_migration_service.types.t_stamp.TStamp"]
    """<p>The start time for the events to be listed.</p>"""
    end_time: NotRequired["capo_database_migration_service.types.t_stamp.TStamp"]
    """<p>The end time for the events to be listed.</p>"""
    duration: NotRequired[
        "capo_database_migration_service.types.integer_optional.IntegerOptional"
    ]
    """<p>The duration of the events to be listed.</p>"""
    event_categories: NotRequired[
        "capo_database_migration_service.types.event_categories_list.EventCategoriesList"
    ]
    """<p>A list of event categories for the source type that you've chosen.</p>"""
    filters: NotRequired["capo_database_migration_service.types.filter_list.FilterList"]
    """<p>Filters applied to events. The only valid filter is <code>replication-instance-id</code>.</p>"""
    max_records: NotRequired[
        "capo_database_migration_service.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 called 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_database_migration_service.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 duration of the events to be listed.

end_time instance-attribute

end_time: NotRequired[TStamp]

The end time for the events to be listed.

event_categories instance-attribute

event_categories: NotRequired[EventCategoriesList]

A list of event categories for the source type that you've chosen.

filters instance-attribute

filters: NotRequired[FilterList]

Filters applied to events. The only valid filter is replication-instance-id.

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 called 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 an event source.

source_type instance-attribute

source_type: NotRequired[SourceType]

The type of DMS resource that generates events.

Valid values: replication-instance | replication-task

start_time instance-attribute

start_time: NotRequired[TStamp]

The start time for the events to be listed.