amazonka-elasticache-1.6.1: Amazon ElastiCache SDK.

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

Network.AWS.ElastiCache.DescribeEvents

Contents

Description

Returns events related to clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular 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.

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:

  • deStartTime - The beginning of the time interval to retrieve events for, specified in ISO 8601 format. Example: 2017-03-30T07:03:49.555Z
  • deSourceType - The event source to retrieve events for. If no value is specified, all events are returned.
  • deSourceIdentifier - The identifier of the event source for which events are returned. If not specified, all sources are included in the response.
  • deMarker - 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 - 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 - The end of the time interval for which to retrieve events, specified in ISO 8601 format. Example: 2017-03-30T07:03:49.555Z
  • deDuration - The number of minutes worth of events to retrieve.

data DescribeEvents Source #

Represents the input of a DescribeEvents operation.

See: describeEvents smart constructor.

Instances
Eq DescribeEvents Source # 
Instance details

Defined in Network.AWS.ElastiCache.DescribeEvents

Data DescribeEvents Source # 
Instance details

Defined in Network.AWS.ElastiCache.DescribeEvents

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeEvents -> c DescribeEvents #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeEvents #

toConstr :: DescribeEvents -> Constr #

dataTypeOf :: DescribeEvents -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeEvents) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeEvents) #

gmapT :: (forall b. Data b => b -> b) -> DescribeEvents -> DescribeEvents #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeEvents -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeEvents -> r #

gmapQ :: (forall d. Data d => d -> u) -> DescribeEvents -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeEvents -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeEvents -> m DescribeEvents #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeEvents -> m DescribeEvents #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeEvents -> m DescribeEvents #

Read DescribeEvents Source # 
Instance details

Defined in Network.AWS.ElastiCache.DescribeEvents

Show DescribeEvents Source # 
Instance details

Defined in Network.AWS.ElastiCache.DescribeEvents

Generic DescribeEvents Source # 
Instance details

Defined in Network.AWS.ElastiCache.DescribeEvents

Associated Types

type Rep DescribeEvents :: Type -> Type #

Hashable DescribeEvents Source # 
Instance details

Defined in Network.AWS.ElastiCache.DescribeEvents

AWSPager DescribeEvents Source # 
Instance details

Defined in Network.AWS.ElastiCache.DescribeEvents

AWSRequest DescribeEvents Source # 
Instance details

Defined in Network.AWS.ElastiCache.DescribeEvents

Associated Types

type Rs DescribeEvents :: Type #

ToHeaders DescribeEvents Source # 
Instance details

Defined in Network.AWS.ElastiCache.DescribeEvents

ToPath DescribeEvents Source # 
Instance details

Defined in Network.AWS.ElastiCache.DescribeEvents

ToQuery DescribeEvents Source # 
Instance details

Defined in Network.AWS.ElastiCache.DescribeEvents

NFData DescribeEvents Source # 
Instance details

Defined in Network.AWS.ElastiCache.DescribeEvents

Methods

rnf :: DescribeEvents -> () #

type Rep DescribeEvents Source # 
Instance details

Defined in Network.AWS.ElastiCache.DescribeEvents

type Rep DescribeEvents = D1 (MetaData "DescribeEvents" "Network.AWS.ElastiCache.DescribeEvents" "amazonka-elasticache-1.6.1-7qPjCRJV7Sp8jKm0QWBmxX" False) (C1 (MetaCons "DescribeEvents'" PrefixI True) ((S1 (MetaSel (Just "_deStartTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ISO8601)) :*: (S1 (MetaSel (Just "_deSourceType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe SourceType)) :*: S1 (MetaSel (Just "_deSourceIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_deMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_deMaxRecords") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 (MetaSel (Just "_deEndTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 (MetaSel (Just "_deDuration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))))))
type Rs DescribeEvents Source # 
Instance details

Defined in Network.AWS.ElastiCache.DescribeEvents

Request Lenses

deStartTime :: Lens' DescribeEvents (Maybe UTCTime) Source #

The beginning of the time interval to retrieve events for, specified in ISO 8601 format. Example: 2017-03-30T07:03:49.555Z

deSourceType :: Lens' DescribeEvents (Maybe SourceType) Source #

The event source to retrieve events for. If no value is specified, all events are returned.

deSourceIdentifier :: Lens' DescribeEvents (Maybe Text) Source #

The identifier of the event source for which events are returned. If not specified, 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 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.

deEndTime :: Lens' DescribeEvents (Maybe UTCTime) Source #

The end of the time interval for which to retrieve events, specified in ISO 8601 format. Example: 2017-03-30T07:03:49.555Z

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:

  • dersEvents - A list of events. Each element in the list contains detailed information about one event.
  • dersMarker - Provides an identifier to allow retrieval of paginated results.
  • dersResponseStatus - -- | The response status code.

data DescribeEventsResponse Source #

Represents the output of a DescribeEvents operation.

See: describeEventsResponse smart constructor.

Instances
Eq DescribeEventsResponse Source # 
Instance details

Defined in Network.AWS.ElastiCache.DescribeEvents

Data DescribeEventsResponse Source # 
Instance details

Defined in Network.AWS.ElastiCache.DescribeEvents

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeEventsResponse -> c DescribeEventsResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeEventsResponse #

toConstr :: DescribeEventsResponse -> Constr #

dataTypeOf :: DescribeEventsResponse -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeEventsResponse) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeEventsResponse) #

gmapT :: (forall b. Data b => b -> b) -> DescribeEventsResponse -> DescribeEventsResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeEventsResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeEventsResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> DescribeEventsResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeEventsResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeEventsResponse -> m DescribeEventsResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeEventsResponse -> m DescribeEventsResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeEventsResponse -> m DescribeEventsResponse #

Read DescribeEventsResponse Source # 
Instance details

Defined in Network.AWS.ElastiCache.DescribeEvents

Show DescribeEventsResponse Source # 
Instance details

Defined in Network.AWS.ElastiCache.DescribeEvents

Generic DescribeEventsResponse Source # 
Instance details

Defined in Network.AWS.ElastiCache.DescribeEvents

Associated Types

type Rep DescribeEventsResponse :: Type -> Type #

NFData DescribeEventsResponse Source # 
Instance details

Defined in Network.AWS.ElastiCache.DescribeEvents

Methods

rnf :: DescribeEventsResponse -> () #

type Rep DescribeEventsResponse Source # 
Instance details

Defined in Network.AWS.ElastiCache.DescribeEvents

type Rep DescribeEventsResponse = D1 (MetaData "DescribeEventsResponse" "Network.AWS.ElastiCache.DescribeEvents" "amazonka-elasticache-1.6.1-7qPjCRJV7Sp8jKm0QWBmxX" False) (C1 (MetaCons "DescribeEventsResponse'" PrefixI True) (S1 (MetaSel (Just "_dersEvents") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Event])) :*: (S1 (MetaSel (Just "_dersMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_dersResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

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.