Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Returns events related to DAX clusters and parameter groups. You can obtain events specific to a particular DAX cluster or 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.
Synopsis
- describeEvents :: DescribeEvents
- data DescribeEvents
- deSourceName :: Lens' DescribeEvents (Maybe Text)
- deStartTime :: Lens' DescribeEvents (Maybe UTCTime)
- deSourceType :: Lens' DescribeEvents (Maybe SourceType)
- deNextToken :: Lens' DescribeEvents (Maybe Text)
- deEndTime :: Lens' DescribeEvents (Maybe UTCTime)
- deDuration :: Lens' DescribeEvents (Maybe Int)
- deMaxResults :: Lens' DescribeEvents (Maybe Int)
- describeEventsResponse :: Int -> DescribeEventsResponse
- data DescribeEventsResponse
- dersNextToken :: Lens' DescribeEventsResponse (Maybe Text)
- dersEvents :: Lens' DescribeEventsResponse [Event]
- 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:
deSourceName
- The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.deStartTime
- The beginning of the time interval to retrieve events for, specified in ISO 8601 format.deSourceType
- The event source to retrieve events for. If no value is specified, all events are returned.deNextToken
- An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified byMaxResults
.deEndTime
- The end of the time interval for which to retrieve events, specified in ISO 8601 format.deDuration
- The number of minutes' worth of events to retrieve.deMaxResults
- The maximum number of results to include in the response. If more results exist than the specifiedMaxResults
value, a token is included in the response so that the remaining results can be retrieved. The value forMaxResults
must be between 20 and 100.
data DescribeEvents Source #
See: describeEvents
smart constructor.
Instances
Request Lenses
deSourceName :: 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.
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.
deNextToken :: Lens' DescribeEvents (Maybe Text) Source #
An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults
.
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.
deMaxResults :: Lens' DescribeEvents (Maybe Int) Source #
The maximum number of results to include in the response. If more results exist than the specified MaxResults
value, a token is included in the response so that the remaining results can be retrieved. The value for MaxResults
must be between 20 and 100.
Destructuring the Response
describeEventsResponse Source #
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:
dersNextToken
- Provides an identifier to allow retrieval of paginated results.dersEvents
- An array of events. Each element in the array represents one event.dersResponseStatus
- -- | The response status code.
data DescribeEventsResponse Source #
See: describeEventsResponse
smart constructor.
Instances
Response Lenses
dersNextToken :: Lens' DescribeEventsResponse (Maybe Text) Source #
Provides an identifier to allow retrieval of paginated results.
dersEvents :: Lens' DescribeEventsResponse [Event] Source #
An array of events. Each element in the array represents one event.
dersResponseStatus :: Lens' DescribeEventsResponse Int Source #
- - | The response status code.