amazonka-elasticache-1.2.0.1: Amazon ElastiCache SDK.

Copyright(c) 2013-2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.ElastiCache.DescribeEvents

Contents

Description

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.

Synopsis

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:

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.

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.

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.

deDuration :: Lens' DescribeEvents (Maybe Int) Source

The number of minutes' worth of events to retrieve.

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:

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.

dersStatus :: Lens' DescribeEventsResponse Int Source

The response status code.