Skip to content

RDS  >  Operations  >  describe_events

describe_events

Operation

describe_events async

describe_events(request: DescribeEventsInput | DescribeEventsInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeEventsOutput
describe_events(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeEventsInputDict]) -> DescribeEventsOutput

Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days. Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be obtained by providing the name as a parameter.

For more information on working with events, see Monitoring Amazon RDS events in the Amazon RDS User Guide and Monitoring Amazon Aurora events in the Amazon Aurora User Guide.

Note

By default, RDS returns events that were generated in the past hour.

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
DescribeEventsOutput

An instance of DescribeEventsOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

DescribeEventsInput dataclass

Bases: _SerdeShape

Attributes
duration class-attribute instance-attribute
duration: int | None = ...

The number of minutes to retrieve events for.

Default: 60

end_time class-attribute instance-attribute
end_time: datetime | None = ...

The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

event_categories class-attribute instance-attribute
event_categories: list[str] | None = ...

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

filters class-attribute instance-attribute
filters: list[Filter] | None = ...

This parameter isn't currently supported.

marker class-attribute instance-attribute
marker: str | None = ...

An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

max_records class-attribute instance-attribute
max_records: int | None = ...

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 you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

source_identifier class-attribute instance-attribute
source_identifier: str | None = ...

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 supplied, SourceType must also be provided.

  • If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.

  • If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.

  • If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.

  • If the source type is a DB security group, a DBSecurityGroupName value must be supplied.

  • If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.

  • If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

  • If the source type is an RDS Proxy, a DBProxyName value must be supplied.

  • Can't end with a hyphen or contain two consecutive hyphens.

source_type class-attribute instance-attribute
source_type: str | None = ...

The event source to retrieve events for. If no value is specified, all events are returned.

start_time class-attribute instance-attribute
start_time: datetime | None = ...

The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

Dictionaries

DescribeEventsInputDict

Bases: TypedDict

Dictionary form of DescribeEventsInput.

Attributes
duration instance-attribute
duration: int | None

The number of minutes to retrieve events for.

Default: 60

end_time instance-attribute
end_time: datetime | None

The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

event_categories instance-attribute
event_categories: Sequence[str] | None

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

filters instance-attribute
filters: Sequence[Filter | FilterDict] | None

This parameter isn't currently supported.

marker instance-attribute
marker: str | None

An optional pagination token provided by a previous DescribeEvents 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: int | None

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 you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

source_identifier instance-attribute
source_identifier: str | None

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 supplied, SourceType must also be provided.

  • If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.

  • If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.

  • If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.

  • If the source type is a DB security group, a DBSecurityGroupName value must be supplied.

  • If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.

  • If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

  • If the source type is an RDS Proxy, a DBProxyName value must be supplied.

  • Can't end with a hyphen or contain two consecutive hyphens.

source_type instance-attribute
source_type: str | None

The event source to retrieve events for. If no value is specified, all events are returned.

start_time instance-attribute
start_time: datetime | None

The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

Output

DescribeEventsOutput dataclass

Bases: _SerdeShape

Contains the result of a successful invocation of the DescribeEvents action.

Attributes

events class-attribute instance-attribute
events: list[Event] | None = ...

A list of Event instances.

marker class-attribute instance-attribute
marker: str | None = ...

An optional pagination token provided by a previous Events request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.