describe_events async ¶

async def describe_events(
    self,
    *,
    config_overrides: Optional[AsyncDocDBClientConfig] = None,
    source_identifier: Optional["capo_docdb.types.string.String"] = None,
    source_type: Optional["capo_docdb.types.source_type.SourceType"] = None,
    start_time: Optional["capo_docdb.types.t_stamp.TStamp"] = None,
    end_time: Optional["capo_docdb.types.t_stamp.TStamp"] = None,
    duration: Optional["capo_docdb.types.integer_optional.IntegerOptional"] = None,
    event_categories: Optional[
        "capo_docdb.types.event_categories_list.EventCategoriesList"
    ] = None,
    filters: Optional["capo_docdb.types.filter_list.FilterList"] = None,
    max_records: Optional[
        "capo_docdb.types.integer_optional.IntegerOptional"
    ] = None,
    marker: Optional["capo_docdb.types.string.String"] = None,
) -> "capo_docdb.types.events_message.EventsMessage":
    """<p>Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days. You can obtain events specific to a particular DB instance, security group, snapshot, or parameter group by providing the name as a parameter. By default, the events of the past hour are returned.</p>

    Args:
        source_identifier: <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: <p>The event source to retrieve events for. If no value is specified, all events are returned.</p>
        start_time: <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: <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: <p>The number of minutes to retrieve events for.</p> <p>Default: 60</p>
        event_categories: <p>A list of event categories that trigger notifications for an event notification subscription.</p>
        filters: <p>This parameter is not currently supported.</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 (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_docdb.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_docdb.types.describe_events_message.DescribeEventsMessage]",
    ) -> AsyncOperationResponse["capo_docdb.types.events_message.EventsMessage"]:
        import capo_docdb._operations.amazon_rd_sv19.describe_events

        (
            output,
            http_response,
        ) = await capo_docdb._operations.amazon_rd_sv19.describe_events.async_describe_events(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeEvents")
    )
    input_: capo_docdb.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 = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output