amazonka-rds-2.0: gen/Amazonka/RDS/DescribeEvents.hs
{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}
-- Derived from AWS service descriptions, licensed under Apache 2.0.
-- |
-- Module : Amazonka.RDS.DescribeEvents
-- Copyright : (c) 2013-2023 Brendan Hay
-- License : Mozilla Public License, v. 2.0.
-- Maintainer : Brendan Hay
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- 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
-- <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/working-with-events.html Monitoring Amazon RDS events>
-- in the /Amazon RDS User Guide/ and
-- <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/working-with-events.html 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.
module Amazonka.RDS.DescribeEvents
( -- * Creating a Request
DescribeEvents (..),
newDescribeEvents,
-- * Request Lenses
describeEvents_duration,
describeEvents_endTime,
describeEvents_eventCategories,
describeEvents_filters,
describeEvents_marker,
describeEvents_maxRecords,
describeEvents_sourceIdentifier,
describeEvents_sourceType,
describeEvents_startTime,
-- * Destructuring the Response
DescribeEventsResponse (..),
newDescribeEventsResponse,
-- * Response Lenses
describeEventsResponse_events,
describeEventsResponse_marker,
describeEventsResponse_httpStatus,
)
where
import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude
import Amazonka.RDS.Types
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response
-- |
--
-- /See:/ 'newDescribeEvents' smart constructor.
data DescribeEvents = DescribeEvents'
{ -- | The number of minutes to retrieve events for.
--
-- Default: 60
duration :: Prelude.Maybe Prelude.Int,
-- | 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
-- <http://en.wikipedia.org/wiki/ISO_8601 ISO8601 Wikipedia page.>
--
-- Example: 2009-07-08T18:00Z
endTime :: Prelude.Maybe Data.ISO8601,
-- | A list of event categories that trigger notifications for a event
-- notification subscription.
eventCategories :: Prelude.Maybe [Prelude.Text],
-- | This parameter isn\'t currently supported.
filters :: Prelude.Maybe [Filter],
-- | 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@.
marker :: Prelude.Maybe Prelude.Text,
-- | 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.
maxRecords :: Prelude.Maybe Prelude.Int,
-- | 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.
sourceIdentifier :: Prelude.Maybe Prelude.Text,
-- | The event source to retrieve events for. If no value is specified, all
-- events are returned.
sourceType :: Prelude.Maybe SourceType,
-- | The beginning of the time interval to retrieve events for, specified in
-- ISO 8601 format. For more information about ISO 8601, go to the
-- <http://en.wikipedia.org/wiki/ISO_8601 ISO8601 Wikipedia page.>
--
-- Example: 2009-07-08T18:00Z
startTime :: Prelude.Maybe Data.ISO8601
}
deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)
-- |
-- Create a value of 'DescribeEvents' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'duration', 'describeEvents_duration' - The number of minutes to retrieve events for.
--
-- Default: 60
--
-- 'endTime', '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
-- <http://en.wikipedia.org/wiki/ISO_8601 ISO8601 Wikipedia page.>
--
-- Example: 2009-07-08T18:00Z
--
-- 'eventCategories', 'describeEvents_eventCategories' - A list of event categories that trigger notifications for a event
-- notification subscription.
--
-- 'filters', 'describeEvents_filters' - This parameter isn\'t currently supported.
--
-- 'marker', '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@.
--
-- 'maxRecords', '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.
--
-- 'sourceIdentifier', '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.
--
-- 'sourceType', 'describeEvents_sourceType' - The event source to retrieve events for. If no value is specified, all
-- events are returned.
--
-- 'startTime', '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
-- <http://en.wikipedia.org/wiki/ISO_8601 ISO8601 Wikipedia page.>
--
-- Example: 2009-07-08T18:00Z
newDescribeEvents ::
DescribeEvents
newDescribeEvents =
DescribeEvents'
{ duration = Prelude.Nothing,
endTime = Prelude.Nothing,
eventCategories = Prelude.Nothing,
filters = Prelude.Nothing,
marker = Prelude.Nothing,
maxRecords = Prelude.Nothing,
sourceIdentifier = Prelude.Nothing,
sourceType = Prelude.Nothing,
startTime = Prelude.Nothing
}
-- | The number of minutes to retrieve events for.
--
-- Default: 60
describeEvents_duration :: Lens.Lens' DescribeEvents (Prelude.Maybe Prelude.Int)
describeEvents_duration = Lens.lens (\DescribeEvents' {duration} -> duration) (\s@DescribeEvents' {} a -> s {duration = a} :: DescribeEvents)
-- | 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
-- <http://en.wikipedia.org/wiki/ISO_8601 ISO8601 Wikipedia page.>
--
-- Example: 2009-07-08T18:00Z
describeEvents_endTime :: Lens.Lens' DescribeEvents (Prelude.Maybe Prelude.UTCTime)
describeEvents_endTime = Lens.lens (\DescribeEvents' {endTime} -> endTime) (\s@DescribeEvents' {} a -> s {endTime = a} :: DescribeEvents) Prelude.. Lens.mapping Data._Time
-- | A list of event categories that trigger notifications for a event
-- notification subscription.
describeEvents_eventCategories :: Lens.Lens' DescribeEvents (Prelude.Maybe [Prelude.Text])
describeEvents_eventCategories = Lens.lens (\DescribeEvents' {eventCategories} -> eventCategories) (\s@DescribeEvents' {} a -> s {eventCategories = a} :: DescribeEvents) Prelude.. Lens.mapping Lens.coerced
-- | This parameter isn\'t currently supported.
describeEvents_filters :: Lens.Lens' DescribeEvents (Prelude.Maybe [Filter])
describeEvents_filters = Lens.lens (\DescribeEvents' {filters} -> filters) (\s@DescribeEvents' {} a -> s {filters = a} :: DescribeEvents) Prelude.. Lens.mapping Lens.coerced
-- | 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_marker :: Lens.Lens' DescribeEvents (Prelude.Maybe Prelude.Text)
describeEvents_marker = Lens.lens (\DescribeEvents' {marker} -> marker) (\s@DescribeEvents' {} a -> s {marker = a} :: DescribeEvents)
-- | 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_maxRecords :: Lens.Lens' DescribeEvents (Prelude.Maybe Prelude.Int)
describeEvents_maxRecords = Lens.lens (\DescribeEvents' {maxRecords} -> maxRecords) (\s@DescribeEvents' {} a -> s {maxRecords = a} :: DescribeEvents)
-- | 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_sourceIdentifier :: Lens.Lens' DescribeEvents (Prelude.Maybe Prelude.Text)
describeEvents_sourceIdentifier = Lens.lens (\DescribeEvents' {sourceIdentifier} -> sourceIdentifier) (\s@DescribeEvents' {} a -> s {sourceIdentifier = a} :: DescribeEvents)
-- | The event source to retrieve events for. If no value is specified, all
-- events are returned.
describeEvents_sourceType :: Lens.Lens' DescribeEvents (Prelude.Maybe SourceType)
describeEvents_sourceType = Lens.lens (\DescribeEvents' {sourceType} -> sourceType) (\s@DescribeEvents' {} a -> s {sourceType = a} :: DescribeEvents)
-- | The beginning of the time interval to retrieve events for, specified in
-- ISO 8601 format. For more information about ISO 8601, go to the
-- <http://en.wikipedia.org/wiki/ISO_8601 ISO8601 Wikipedia page.>
--
-- Example: 2009-07-08T18:00Z
describeEvents_startTime :: Lens.Lens' DescribeEvents (Prelude.Maybe Prelude.UTCTime)
describeEvents_startTime = Lens.lens (\DescribeEvents' {startTime} -> startTime) (\s@DescribeEvents' {} a -> s {startTime = a} :: DescribeEvents) Prelude.. Lens.mapping Data._Time
instance Core.AWSPager DescribeEvents where
page rq rs
| Core.stop
( rs
Lens.^? describeEventsResponse_marker
Prelude.. Lens._Just
) =
Prelude.Nothing
| Core.stop
( rs
Lens.^? describeEventsResponse_events
Prelude.. Lens._Just
) =
Prelude.Nothing
| Prelude.otherwise =
Prelude.Just
Prelude.$ rq
Prelude.& describeEvents_marker
Lens..~ rs
Lens.^? describeEventsResponse_marker
Prelude.. Lens._Just
instance Core.AWSRequest DescribeEvents where
type
AWSResponse DescribeEvents =
DescribeEventsResponse
request overrides =
Request.postQuery (overrides defaultService)
response =
Response.receiveXMLWrapper
"DescribeEventsResult"
( \s h x ->
DescribeEventsResponse'
Prelude.<$> ( x
Data..@? "Events"
Core..!@ Prelude.mempty
Prelude.>>= Core.may (Data.parseXMLList "Event")
)
Prelude.<*> (x Data..@? "Marker")
Prelude.<*> (Prelude.pure (Prelude.fromEnum s))
)
instance Prelude.Hashable DescribeEvents where
hashWithSalt _salt DescribeEvents' {..} =
_salt
`Prelude.hashWithSalt` duration
`Prelude.hashWithSalt` endTime
`Prelude.hashWithSalt` eventCategories
`Prelude.hashWithSalt` filters
`Prelude.hashWithSalt` marker
`Prelude.hashWithSalt` maxRecords
`Prelude.hashWithSalt` sourceIdentifier
`Prelude.hashWithSalt` sourceType
`Prelude.hashWithSalt` startTime
instance Prelude.NFData DescribeEvents where
rnf DescribeEvents' {..} =
Prelude.rnf duration
`Prelude.seq` Prelude.rnf endTime
`Prelude.seq` Prelude.rnf eventCategories
`Prelude.seq` Prelude.rnf filters
`Prelude.seq` Prelude.rnf marker
`Prelude.seq` Prelude.rnf maxRecords
`Prelude.seq` Prelude.rnf sourceIdentifier
`Prelude.seq` Prelude.rnf sourceType
`Prelude.seq` Prelude.rnf startTime
instance Data.ToHeaders DescribeEvents where
toHeaders = Prelude.const Prelude.mempty
instance Data.ToPath DescribeEvents where
toPath = Prelude.const "/"
instance Data.ToQuery DescribeEvents where
toQuery DescribeEvents' {..} =
Prelude.mconcat
[ "Action"
Data.=: ("DescribeEvents" :: Prelude.ByteString),
"Version"
Data.=: ("2014-10-31" :: Prelude.ByteString),
"Duration" Data.=: duration,
"EndTime" Data.=: endTime,
"EventCategories"
Data.=: Data.toQuery
( Data.toQueryList "EventCategory"
Prelude.<$> eventCategories
),
"Filters"
Data.=: Data.toQuery
(Data.toQueryList "Filter" Prelude.<$> filters),
"Marker" Data.=: marker,
"MaxRecords" Data.=: maxRecords,
"SourceIdentifier" Data.=: sourceIdentifier,
"SourceType" Data.=: sourceType,
"StartTime" Data.=: startTime
]
-- | Contains the result of a successful invocation of the @DescribeEvents@
-- action.
--
-- /See:/ 'newDescribeEventsResponse' smart constructor.
data DescribeEventsResponse = DescribeEventsResponse'
{ -- | A list of @Event@ instances.
events :: Prelude.Maybe [Event],
-- | 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@.
marker :: Prelude.Maybe Prelude.Text,
-- | The response's http status code.
httpStatus :: Prelude.Int
}
deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)
-- |
-- Create a value of 'DescribeEventsResponse' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'events', 'describeEventsResponse_events' - A list of @Event@ instances.
--
-- 'marker', '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@.
--
-- 'httpStatus', 'describeEventsResponse_httpStatus' - The response's http status code.
newDescribeEventsResponse ::
-- | 'httpStatus'
Prelude.Int ->
DescribeEventsResponse
newDescribeEventsResponse pHttpStatus_ =
DescribeEventsResponse'
{ events = Prelude.Nothing,
marker = Prelude.Nothing,
httpStatus = pHttpStatus_
}
-- | A list of @Event@ instances.
describeEventsResponse_events :: Lens.Lens' DescribeEventsResponse (Prelude.Maybe [Event])
describeEventsResponse_events = Lens.lens (\DescribeEventsResponse' {events} -> events) (\s@DescribeEventsResponse' {} a -> s {events = a} :: DescribeEventsResponse) Prelude.. Lens.mapping Lens.coerced
-- | 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_marker :: Lens.Lens' DescribeEventsResponse (Prelude.Maybe Prelude.Text)
describeEventsResponse_marker = Lens.lens (\DescribeEventsResponse' {marker} -> marker) (\s@DescribeEventsResponse' {} a -> s {marker = a} :: DescribeEventsResponse)
-- | The response's http status code.
describeEventsResponse_httpStatus :: Lens.Lens' DescribeEventsResponse Prelude.Int
describeEventsResponse_httpStatus = Lens.lens (\DescribeEventsResponse' {httpStatus} -> httpStatus) (\s@DescribeEventsResponse' {} a -> s {httpStatus = a} :: DescribeEventsResponse)
instance Prelude.NFData DescribeEventsResponse where
rnf DescribeEventsResponse' {..} =
Prelude.rnf events
`Prelude.seq` Prelude.rnf marker
`Prelude.seq` Prelude.rnf httpStatus