Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.RDS.DescribeEvents

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

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

This operation returns paginated results.

Synopsis

data DescribeEvents = DescribeEvents' {
- duration :: Maybe Int
- endTime :: Maybe ISO8601
- eventCategories :: Maybe [Text]
- filters :: Maybe [Filter]
- marker :: Maybe Text
- maxRecords :: Maybe Int
- sourceIdentifier :: Maybe Text
- sourceType :: Maybe SourceType
- startTime :: Maybe ISO8601
}
newDescribeEvents :: DescribeEvents
describeEvents_duration :: Lens' DescribeEvents (Maybe Int)
describeEvents_endTime :: Lens' DescribeEvents (Maybe UTCTime)
describeEvents_eventCategories :: Lens' DescribeEvents (Maybe [Text])
describeEvents_filters :: Lens' DescribeEvents (Maybe [Filter])
describeEvents_marker :: Lens' DescribeEvents (Maybe Text)
describeEvents_maxRecords :: Lens' DescribeEvents (Maybe Int)
describeEvents_sourceIdentifier :: Lens' DescribeEvents (Maybe Text)
describeEvents_sourceType :: Lens' DescribeEvents (Maybe SourceType)
describeEvents_startTime :: Lens' DescribeEvents (Maybe UTCTime)
data DescribeEventsResponse = DescribeEventsResponse' {
- events :: Maybe [Event]
- marker :: Maybe Text
- httpStatus :: Int
}
newDescribeEventsResponse :: Int -> DescribeEventsResponse
describeEventsResponse_events :: Lens' DescribeEventsResponse (Maybe [Event])
describeEventsResponse_marker :: Lens' DescribeEventsResponse (Maybe Text)
describeEventsResponse_httpStatus :: Lens' DescribeEventsResponse Int

Creating a Request

data DescribeEvents Source #

See: newDescribeEvents smart constructor.

Constructors

DescribeEvents'

Fields

duration :: Maybe Int
The number of minutes to retrieve events for.
Default: 60
endTime :: Maybe ISO8601
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
eventCategories :: Maybe [Text]
A list of event categories that trigger notifications for a event notification subscription.
filters :: Maybe [Filter]
This parameter isn't currently supported.
marker :: Maybe Text
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.
maxRecords :: Maybe Int
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.
sourceIdentifier :: Maybe Text
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.
sourceType :: Maybe SourceType
The event source to retrieve events for. If no value is specified, all events are returned.
startTime :: Maybe ISO8601
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

Instances

Instances details

ToHeaders DescribeEvents Source #
Instance details Defined in Amazonka.RDS.DescribeEvents Methods toHeaders :: DescribeEvents -> [Header] #
ToPath DescribeEvents Source #
Instance details Defined in Amazonka.RDS.DescribeEvents Methods toPath :: DescribeEvents -> ByteString #
ToQuery DescribeEvents Source #
Instance details Defined in Amazonka.RDS.DescribeEvents Methods toQuery :: DescribeEvents -> QueryString #
AWSPager DescribeEvents Source #
Instance details Defined in Amazonka.RDS.DescribeEvents Methods page :: DescribeEvents -> AWSResponse DescribeEvents -> Maybe DescribeEvents #
AWSRequest DescribeEvents Source #
Instance details Defined in Amazonka.RDS.DescribeEvents Associated Types type AWSResponse DescribeEvents # Methods request :: (Service -> Service) -> DescribeEvents -> Request DescribeEvents # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeEvents -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeEvents))) #
Generic DescribeEvents Source #
Instance details Defined in Amazonka.RDS.DescribeEvents Associated Types type Rep DescribeEvents :: Type -> Type # Methods from :: DescribeEvents -> Rep DescribeEvents x # to :: Rep DescribeEvents x -> DescribeEvents #
Read DescribeEvents Source #
Instance details Defined in Amazonka.RDS.DescribeEvents Methods readsPrec :: Int -> ReadS DescribeEvents # readList :: ReadS [DescribeEvents] # readPrec :: ReadPrec DescribeEvents # readListPrec :: ReadPrec [DescribeEvents] #
Show DescribeEvents Source #
Instance details Defined in Amazonka.RDS.DescribeEvents Methods showsPrec :: Int -> DescribeEvents -> ShowS # show :: DescribeEvents -> String # showList :: [DescribeEvents] -> ShowS #
NFData DescribeEvents Source #
Instance details Defined in Amazonka.RDS.DescribeEvents Methods rnf :: DescribeEvents -> () #
Eq DescribeEvents Source #
Instance details Defined in Amazonka.RDS.DescribeEvents Methods (==) :: DescribeEvents -> DescribeEvents -> Bool # (/=) :: DescribeEvents -> DescribeEvents -> Bool #
Hashable DescribeEvents Source #
Instance details Defined in Amazonka.RDS.DescribeEvents Methods hashWithSalt :: Int -> DescribeEvents -> Int # hash :: DescribeEvents -> Int #
type AWSResponse DescribeEvents Source #
Instance details Defined in Amazonka.RDS.DescribeEvents type AWSResponse DescribeEvents = DescribeEventsResponse
type Rep DescribeEvents Source #
Instance details Defined in Amazonka.RDS.DescribeEvents type Rep DescribeEvents = D1 ('MetaData "DescribeEvents" "Amazonka.RDS.DescribeEvents" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DescribeEvents'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "duration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))) :: (S1 ('MetaSel ('Just "eventCategories") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])))) :: ((S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "sourceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "sourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SourceType)) :: S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)))))))

newDescribeEvents :: DescribeEvents Source #

Create a value of DescribeEvents with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeEvents, describeEvents_duration - The number of minutes to retrieve events for.

Default: 60

$sel:endTime:DescribeEvents', describeEvents_endTime - 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

DescribeEvents, describeEvents_eventCategories - A list of event categories that trigger notifications for a event notification subscription.

$sel:filters:DescribeEvents', describeEvents_filters - This parameter isn't currently supported.

DescribeEvents, describeEvents_marker - 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.

$sel:maxRecords:DescribeEvents', describeEvents_maxRecords - 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.

DescribeEvents, describeEvents_sourceIdentifier - 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.

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

DescribeEvents, describeEvents_startTime - 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

Request Lenses

describeEvents_duration :: Lens' DescribeEvents (Maybe Int) Source #

The number of minutes to retrieve events for.

Default: 60

describeEvents_endTime :: Lens' DescribeEvents (Maybe UTCTime) Source #

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

describeEvents_eventCategories :: Lens' DescribeEvents (Maybe [Text]) Source #

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

describeEvents_filters :: Lens' DescribeEvents (Maybe [Filter]) Source #

This parameter isn't currently supported.

describeEvents_marker :: Lens' DescribeEvents (Maybe Text) Source #

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.

describeEvents_maxRecords :: Lens' DescribeEvents (Maybe Int) Source #

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.

describeEvents_sourceIdentifier :: Lens' DescribeEvents (Maybe Text) Source #

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.

describeEvents_sourceType :: Lens' DescribeEvents (Maybe SourceType) Source #

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

describeEvents_startTime :: Lens' DescribeEvents (Maybe UTCTime) Source #

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

Destructuring the Response

data DescribeEventsResponse Source #

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

See: newDescribeEventsResponse smart constructor.

Constructors

DescribeEventsResponse'
Fields events :: Maybe [Event] A list of `Event` instances. marker :: Maybe Text 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`. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeEventsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeEvents Associated Types type Rep DescribeEventsResponse :: Type -> Type # Methods from :: DescribeEventsResponse -> Rep DescribeEventsResponse x # to :: Rep DescribeEventsResponse x -> DescribeEventsResponse #
Read DescribeEventsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeEvents Methods readsPrec :: Int -> ReadS DescribeEventsResponse # readList :: ReadS [DescribeEventsResponse] # readPrec :: ReadPrec DescribeEventsResponse # readListPrec :: ReadPrec [DescribeEventsResponse] #
Show DescribeEventsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeEvents Methods showsPrec :: Int -> DescribeEventsResponse -> ShowS # show :: DescribeEventsResponse -> String # showList :: [DescribeEventsResponse] -> ShowS #
NFData DescribeEventsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeEvents Methods rnf :: DescribeEventsResponse -> () #
Eq DescribeEventsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeEvents Methods (==) :: DescribeEventsResponse -> DescribeEventsResponse -> Bool # (/=) :: DescribeEventsResponse -> DescribeEventsResponse -> Bool #
type Rep DescribeEventsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeEvents type Rep DescribeEventsResponse = D1 ('MetaData "DescribeEventsResponse" "Amazonka.RDS.DescribeEvents" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DescribeEventsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "events") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Event])) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeEventsResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeEventsResponse'`
-> DescribeEventsResponse

Create a value of DescribeEventsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:events:DescribeEventsResponse', describeEventsResponse_events - A list of Event instances.

DescribeEvents, describeEventsResponse_marker - 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.

$sel:httpStatus:DescribeEventsResponse', describeEventsResponse_httpStatus - The response's http status code.

Response Lenses

describeEventsResponse_events :: Lens' DescribeEventsResponse (Maybe [Event]) Source #

A list of Event instances.

describeEventsResponse_marker :: Lens' DescribeEventsResponse (Maybe Text) Source #

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.

describeEventsResponse_httpStatus :: Lens' DescribeEventsResponse Int Source #

The response's http status code.