Network.AWS.RDS.DescribeEvents

Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.

This operation returns paginated results.

Creating a Request

describeEvents :: DescribeEvents

Creates a value of DescribeEvents with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• deStartTime - 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
• deSourceType - The event source to retrieve events for. If no value is specified, all events are returned.
• deFilters - This parameter is not currently supported.
• deSourceIdentifier - 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 DBInstance , then a DBInstanceIdentifier must be supplied. * If the source type is DBSecurityGroup , a DBSecurityGroupName must be supplied. * If the source type is DBParameterGroup , a DBParameterGroupName must be supplied. * If the source type is DBSnapshot , a DBSnapshotIdentifier must be supplied. * Cannot end with a hyphen or contain two consecutive hyphens.
• deEventCategories - A list of event categories that trigger notifications for a event notification subscription.
• deMarker - 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 .
• deMaxRecords - 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.
• deEndTime - 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
• deDuration - The number of minutes to retrieve events for. Default: 60

data DescribeEvents

See: describeEvents smart constructor.

Instances

Eq DescribeEvents

Methods

(==) :: DescribeEvents -> DescribeEvents -> Bool

(/=) :: DescribeEvents -> DescribeEvents -> Bool

Data DescribeEvents

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeEvents -> c DescribeEvents

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeEvents

toConstr :: DescribeEvents -> Constr

dataTypeOf :: DescribeEvents -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeEvents)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeEvents)

gmapT :: (forall b. Data b => b -> b) -> DescribeEvents -> DescribeEvents

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeEvents -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeEvents -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeEvents -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeEvents -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeEvents -> m DescribeEvents

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeEvents -> m DescribeEvents

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeEvents -> m DescribeEvents

Read DescribeEvents

Methods

readsPrec :: Int -> ReadS DescribeEvents

readList :: ReadS [DescribeEvents]

readPrec :: ReadPrec DescribeEvents

readListPrec :: ReadPrec [DescribeEvents]

Show DescribeEvents

Methods

showsPrec :: Int -> DescribeEvents -> ShowS

show :: DescribeEvents -> String

showList :: [DescribeEvents] -> ShowS

Generic DescribeEvents

Associated Types

type Rep DescribeEvents :: * -> *

Methods

from :: DescribeEvents -> Rep DescribeEvents x

to :: Rep DescribeEvents x -> DescribeEvents

Hashable DescribeEvents

Methods

hashWithSalt :: Int -> DescribeEvents -> Int

hash :: DescribeEvents -> Int

NFData DescribeEvents

Methods

rnf :: DescribeEvents -> ()

AWSPager DescribeEvents

Methods

page :: DescribeEvents -> Rs DescribeEvents -> Maybe DescribeEvents

AWSRequest DescribeEvents

Associated Types

type Rs DescribeEvents :: *

Methods

request :: DescribeEvents -> Request DescribeEvents

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * DescribeEvents -> ClientResponse -> m (Response DescribeEvents)

ToHeaders DescribeEvents

Methods

toHeaders :: DescribeEvents -> [Header]

ToPath DescribeEvents

Methods

toPath :: DescribeEvents -> ByteString

ToQuery DescribeEvents

Methods

toQuery :: DescribeEvents -> QueryString

type Rep DescribeEvents

type Rep DescribeEvents = D1 * (MetaData "DescribeEvents" "Network.AWS.RDS.DescribeEvents" "amazonka-rds-1.6.0-1gpCa37cwlvAUzWljvprAs" False) (C1 * (MetaCons "DescribeEvents'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_deStartTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe ISO8601))) (S1 * (MetaSel (Just Symbol "_deSourceType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe SourceType)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_deFilters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Filter]))) (S1 * (MetaSel (Just Symbol "_deSourceIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_deEventCategories") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text]))) (S1 * (MetaSel (Just Symbol "_deMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_deMaxRecords") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) ((:*:) * (S1 * (MetaSel (Just Symbol "_deEndTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe ISO8601))) (S1 * (MetaSel (Just Symbol "_deDuration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))))))))

type Rs DescribeEvents

type Rs DescribeEvents = DescribeEventsResponse

Request Lenses

deStartTime :: Lens' DescribeEvents (Maybe UTCTime)

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

deSourceType :: Lens' DescribeEvents (Maybe SourceType)

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

deFilters :: Lens' DescribeEvents [Filter]

This parameter is not currently supported.

deSourceIdentifier :: Lens' DescribeEvents (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 DBInstance , then a DBInstanceIdentifier must be supplied. * If the source type is DBSecurityGroup , a DBSecurityGroupName must be supplied. * If the source type is DBParameterGroup , a DBParameterGroupName must be supplied. * If the source type is DBSnapshot , a DBSnapshotIdentifier must be supplied. * Cannot end with a hyphen or contain two consecutive hyphens.

deEventCategories :: Lens' DescribeEvents [Text]

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

deMarker :: Lens' DescribeEvents (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 .

deMaxRecords :: Lens' DescribeEvents (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 the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.

deEndTime :: Lens' DescribeEvents (Maybe UTCTime)

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

deDuration :: Lens' DescribeEvents (Maybe Int)

The number of minutes to retrieve events for. Default: 60

Destructuring the Response

describeEventsResponse

Arguments

:: Int

dersResponseStatus

-> DescribeEventsResponse

Creates a value of DescribeEventsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dersEvents - A list of Event instances.
• dersMarker - 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 .
• dersResponseStatus - -- | The response status code.

data DescribeEventsResponse

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

See: describeEventsResponse smart constructor.

Instances

Eq DescribeEventsResponse

Methods

(==) :: DescribeEventsResponse -> DescribeEventsResponse -> Bool

(/=) :: DescribeEventsResponse -> DescribeEventsResponse -> Bool

Data DescribeEventsResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeEventsResponse -> c DescribeEventsResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeEventsResponse

toConstr :: DescribeEventsResponse -> Constr

dataTypeOf :: DescribeEventsResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeEventsResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeEventsResponse)

gmapT :: (forall b. Data b => b -> b) -> DescribeEventsResponse -> DescribeEventsResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeEventsResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeEventsResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeEventsResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeEventsResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeEventsResponse -> m DescribeEventsResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeEventsResponse -> m DescribeEventsResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeEventsResponse -> m DescribeEventsResponse

Read DescribeEventsResponse

Methods

readsPrec :: Int -> ReadS DescribeEventsResponse

readList :: ReadS [DescribeEventsResponse]

readPrec :: ReadPrec DescribeEventsResponse

readListPrec :: ReadPrec [DescribeEventsResponse]

Show DescribeEventsResponse

Methods

showsPrec :: Int -> DescribeEventsResponse -> ShowS

show :: DescribeEventsResponse -> String

showList :: [DescribeEventsResponse] -> ShowS

Generic DescribeEventsResponse

Associated Types

type Rep DescribeEventsResponse :: * -> *

Methods

from :: DescribeEventsResponse -> Rep DescribeEventsResponse x

to :: Rep DescribeEventsResponse x -> DescribeEventsResponse

NFData DescribeEventsResponse

Methods

rnf :: DescribeEventsResponse -> ()

type Rep DescribeEventsResponse

type Rep DescribeEventsResponse = D1 * (MetaData "DescribeEventsResponse" "Network.AWS.RDS.DescribeEvents" "amazonka-rds-1.6.0-1gpCa37cwlvAUzWljvprAs" False) (C1 * (MetaCons "DescribeEventsResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_dersEvents") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Event]))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dersMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_dersResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

dersEvents :: Lens' DescribeEventsResponse [Event]

A list of Event instances.

dersMarker :: Lens' DescribeEventsResponse (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 .

dersResponseStatus :: Lens' DescribeEventsResponse Int

• - | The response status code.