Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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.
See: AWS API Reference for DescribeEvents.
This operation returns paginated results.
- describeEvents :: DescribeEvents
- data DescribeEvents
- deStartTime :: Lens' DescribeEvents (Maybe UTCTime)
- deSourceType :: Lens' DescribeEvents (Maybe SourceType)
- deFilters :: Lens' DescribeEvents [Filter]
- deSourceIdentifier :: Lens' DescribeEvents (Maybe Text)
- deMaxRecords :: Lens' DescribeEvents (Maybe Int)
- deEventCategories :: Lens' DescribeEvents [Text]
- deEndTime :: Lens' DescribeEvents (Maybe UTCTime)
- deMarker :: Lens' DescribeEvents (Maybe Text)
- deDuration :: Lens' DescribeEvents (Maybe Int)
- describeEventsResponse :: Int -> DescribeEventsResponse
- data DescribeEventsResponse
- dersEvents :: Lens' DescribeEventsResponse [Event]
- dersMarker :: Lens' DescribeEventsResponse (Maybe Text)
- dersStatus :: Lens' DescribeEventsResponse Int
Creating a Request
describeEvents :: DescribeEvents Source
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:
data DescribeEvents Source
See: describeEvents
smart constructor.
Request Lenses
deStartTime :: 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
deSourceType :: Lens' DescribeEvents (Maybe SourceType) Source
The event source to retrieve events for. If no value is specified, all events are returned.
deFilters :: Lens' DescribeEvents [Filter] Source
This parameter is not currently supported.
deSourceIdentifier :: Lens' DescribeEvents (Maybe Text) Source
The identifier of the event source for which events will be 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 aDBInstanceIdentifier
must be supplied. - If the source type is
DBSecurityGroup
, aDBSecurityGroupName
must be supplied. - If the source type is
DBParameterGroup
, aDBParameterGroupName
must be supplied. - If the source type is
DBSnapshot
, aDBSnapshotIdentifier
must be supplied. - Cannot end with a hyphen or contain two consecutive hyphens.
deMaxRecords :: 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 the remaining
results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
deEventCategories :: Lens' DescribeEvents [Text] Source
A list of event categories that trigger notifications for a event notification subscription.
deEndTime :: 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
deMarker :: 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
.
deDuration :: Lens' DescribeEvents (Maybe Int) Source
The number of minutes to retrieve events for.
Default: 60
Destructuring the Response
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:
data DescribeEventsResponse Source
Contains the result of a successful invocation of the DescribeEvents action.
See: describeEventsResponse
smart constructor.
Response Lenses
dersEvents :: Lens' DescribeEventsResponse [Event] Source
A list of Event instances.
dersMarker :: 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
.
dersStatus :: Lens' DescribeEventsResponse Int Source
The response status code.