describe_events ¶

def describe_events(
    self,
    *,
    config_overrides: Optional[DatabaseMigrationServiceClientConfig] = None,
    source_identifier: Optional[
        "capo_database_migration_service.types.string.String"
    ] = None,
    source_type: Optional[
        "capo_database_migration_service.types.source_type.SourceType"
    ] = None,
    start_time: Optional[
        "capo_database_migration_service.types.t_stamp.TStamp"
    ] = None,
    end_time: Optional[
        "capo_database_migration_service.types.t_stamp.TStamp"
    ] = None,
    duration: Optional[
        "capo_database_migration_service.types.integer_optional.IntegerOptional"
    ] = None,
    event_categories: Optional[
        "capo_database_migration_service.types.event_categories_list.EventCategoriesList"
    ] = None,
    filters: Optional[
        "capo_database_migration_service.types.filter_list.FilterList"
    ] = None,
    max_records: Optional[
        "capo_database_migration_service.types.integer_optional.IntegerOptional"
    ] = None,
    marker: Optional["capo_database_migration_service.types.string.String"] = None,
) -> "capo_database_migration_service.types.describe_events_response.DescribeEventsResponse":
    """<p> Lists events for a given source identifier and source type. You can also specify a start and end time. For more information on DMS events, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html">Working with Events and Notifications</a> in the <i>Database Migration Service User Guide.</i> </p>

    Args:
        source_identifier: <p> The identifier of an event source.</p>
        source_type: <p>The type of DMS resource that generates events.</p> <p>Valid values: replication-instance | replication-task</p>
        start_time: <p>The start time for the events to be listed.</p>
        end_time: <p>The end time for the events to be listed.</p>
        duration: <p>The duration of the events to be listed.</p>
        event_categories: <p>A list of event categories for the source type that you've chosen.</p>
        filters: <p>Filters applied to events. The only valid filter is <code>replication-instance-id</code>.</p>
        max_records: <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: <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>

    Raises:
        capo_database_migration_service.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_database_migration_service.types.describe_events_message.DescribeEventsMessage]",
    ) -> OperationResponse[
        "capo_database_migration_service.types.describe_events_response.DescribeEventsResponse"
    ]:
        import capo_database_migration_service._operations.amazon_dm_sv20160101.describe_events

        output, http_response = (
            capo_database_migration_service._operations.amazon_dm_sv20160101.describe_events.describe_events(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeEvents")
    )
    input_: capo_database_migration_service.types.describe_events_message.DescribeEventsMessage = {}
    if source_identifier is not None:
        input_["source_identifier"] = source_identifier
    if source_type is not None:
        input_["source_type"] = source_type
    if start_time is not None:
        input_["start_time"] = start_time
    if end_time is not None:
        input_["end_time"] = end_time
    if duration is not None:
        input_["duration"] = duration
    if event_categories is not None:
        input_["event_categories"] = event_categories
    if filters is not None:
        input_["filters"] = filters
    if max_records is not None:
        input_["max_records"] = max_records
    if marker is not None:
        input_["marker"] = marker

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output