amazonka-dynamodb-dax-1.6.1: Amazon DynamoDB Accelerator (DAX) 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.DAX.DescribeEvents

Contents

Description

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

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 by MaxResults .
  • 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 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.

data DescribeEvents Source #

See: describeEvents smart constructor.

Instances
Eq DescribeEvents Source # 
Instance details

Defined in Network.AWS.DAX.DescribeEvents

Data DescribeEvents Source # 
Instance details

Defined in Network.AWS.DAX.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.DAX.DescribeEvents

Show DescribeEvents Source # 
Instance details

Defined in Network.AWS.DAX.DescribeEvents

Generic DescribeEvents Source # 
Instance details

Defined in Network.AWS.DAX.DescribeEvents

Associated Types

type Rep DescribeEvents :: Type -> Type #

Hashable DescribeEvents Source # 
Instance details

Defined in Network.AWS.DAX.DescribeEvents

ToJSON DescribeEvents Source # 
Instance details

Defined in Network.AWS.DAX.DescribeEvents

AWSRequest DescribeEvents Source # 
Instance details

Defined in Network.AWS.DAX.DescribeEvents

Associated Types

type Rs DescribeEvents :: Type #

ToHeaders DescribeEvents Source # 
Instance details

Defined in Network.AWS.DAX.DescribeEvents

ToPath DescribeEvents Source # 
Instance details

Defined in Network.AWS.DAX.DescribeEvents

ToQuery DescribeEvents Source # 
Instance details

Defined in Network.AWS.DAX.DescribeEvents

NFData DescribeEvents Source # 
Instance details

Defined in Network.AWS.DAX.DescribeEvents

Methods

rnf :: DescribeEvents -> () #

type Rep DescribeEvents Source # 
Instance details

Defined in Network.AWS.DAX.DescribeEvents

type Rep DescribeEvents = D1 (MetaData "DescribeEvents" "Network.AWS.DAX.DescribeEvents" "amazonka-dynamodb-dax-1.6.1-6GOQo4sHyZjF5gipywaEPV" False) (C1 (MetaCons "DescribeEvents'" PrefixI True) ((S1 (MetaSel (Just "_deSourceName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_deStartTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 (MetaSel (Just "_deSourceType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe SourceType)))) :*: ((S1 (MetaSel (Just "_deNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_deEndTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 (MetaSel (Just "_deDuration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int)) :*: S1 (MetaSel (Just "_deMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))))))
type Rs DescribeEvents Source # 
Instance details

Defined in Network.AWS.DAX.DescribeEvents

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
Eq DescribeEventsResponse Source # 
Instance details

Defined in Network.AWS.DAX.DescribeEvents

Data DescribeEventsResponse Source # 
Instance details

Defined in Network.AWS.DAX.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.DAX.DescribeEvents

Show DescribeEventsResponse Source # 
Instance details

Defined in Network.AWS.DAX.DescribeEvents

Generic DescribeEventsResponse Source # 
Instance details

Defined in Network.AWS.DAX.DescribeEvents

Associated Types

type Rep DescribeEventsResponse :: Type -> Type #

NFData DescribeEventsResponse Source # 
Instance details

Defined in Network.AWS.DAX.DescribeEvents

Methods

rnf :: DescribeEventsResponse -> () #

type Rep DescribeEventsResponse Source # 
Instance details

Defined in Network.AWS.DAX.DescribeEvents

type Rep DescribeEventsResponse = D1 (MetaData "DescribeEventsResponse" "Network.AWS.DAX.DescribeEvents" "amazonka-dynamodb-dax-1.6.1-6GOQo4sHyZjF5gipywaEPV" False) (C1 (MetaCons "DescribeEventsResponse'" PrefixI True) (S1 (MetaSel (Just "_dersNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_dersEvents") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Event])) :*: S1 (MetaSel (Just "_dersResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

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.