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 |
The DescribeEvents action returns events related to cache clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cache cluster, cache security group, or cache parameter group by providing the name as a parameter.
By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.
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)
- deSourceIdentifier :: Lens' DescribeEvents (Maybe Text)
- deMarker :: Lens' DescribeEvents (Maybe Text)
- deMaxRecords :: Lens' DescribeEvents (Maybe Int)
- deEndTime :: Lens' DescribeEvents (Maybe UTCTime)
- deDuration :: Lens' DescribeEvents (Maybe Int)
- describeEventsResponse :: Int -> DescribeEventsResponse
- data DescribeEventsResponse
- dersEvents :: Lens' DescribeEventsResponse [Event]
- dersMarker :: Lens' DescribeEventsResponse (Maybe Text)
- dersResponseStatus :: 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
Represents the input of a DescribeEvents action.
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.
deSourceType :: Lens' DescribeEvents (Maybe SourceType) Source
The event source to retrieve events for. If no value is specified, all events are returned.
Valid values are: 'cache-cluster' | 'cache-parameter-group' | 'cache-security-group' | 'cache-subnet-group'
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.
deMarker :: Lens' DescribeEvents (Maybe Text) Source
An optional marker returned from a prior request. Use this marker for pagination of results from this action. 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) Source
The maximum number of records to include in the response. If more
records exist than the specified MaxRecords
value, 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) Source
The end of the time interval for which to retrieve events, specified in ISO 8601 format.
deDuration :: Lens' DescribeEvents (Maybe Int) Source
The number of minutes' worth of events to retrieve.
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
Represents the output of a DescribeEvents action.
See: describeEventsResponse
smart constructor.
Response Lenses
dersEvents :: Lens' DescribeEventsResponse [Event] Source
A list of events. Each element in the list contains detailed information about one event.
dersMarker :: Lens' DescribeEventsResponse (Maybe Text) Source
Provides an identifier to allow retrieval of paginated results.
dersResponseStatus :: Lens' DescribeEventsResponse Int Source
The response status code.