amazonka-elasticache-0.1.3: Amazon ElastiCache SDK.

Safe HaskellNone
LanguageHaskell2010

Network.AWS.ElastiCache.DescribeEvents

Contents

Description

The DescribeEvents operation 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.

http://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_DescribeEvents.html

Synopsis

Request

Request constructor

Request lenses

deDuration :: Lens' DescribeEvents (Maybe Int) Source

The number of minutes' worth of events to retrieve.

deEndTime :: Lens' DescribeEvents (Maybe UTCTime) Source

The end of the time interval for which to retrieve events, specified in ISO 8601 format.

deMarker :: Lens' DescribeEvents (Maybe Text) Source

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. 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.

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.

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'

deStartTime :: Lens' DescribeEvents (Maybe UTCTime) Source

The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

Response

Response constructor

describeEventsResponse :: DescribeEventsResponse Source

DescribeEventsResponse constructor.

The fields accessible through corresponding lenses are:

Response lenses

derEvents :: Lens' DescribeEventsResponse [Event] Source

A list of events. Each element in the list contains detailed information about one event.

derMarker :: Lens' DescribeEventsResponse (Maybe Text) Source

Provides an identifier to allow retrieval of paginated results.