Network.AWS.DAX.DescribeEvents

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.

Creating a Request

describeEvents :: DescribeEvents

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

See: describeEvents smart constructor.

Instances

Eq DescribeEvents

Methods

(==) :: DescribeEvents -> DescribeEvents -> Bool

(/=) :: DescribeEvents -> DescribeEvents -> Bool

Data 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

Methods

readsPrec :: Int -> ReadS DescribeEvents

readList :: ReadS [DescribeEvents]

readPrec :: ReadPrec DescribeEvents

readListPrec :: ReadPrec [DescribeEvents]

Show DescribeEvents

Methods

showsPrec :: Int -> DescribeEvents -> ShowS

show :: DescribeEvents -> String

showList :: [DescribeEvents] -> ShowS

Generic DescribeEvents

Associated Types

type Rep DescribeEvents :: * -> *

Methods

from :: DescribeEvents -> Rep DescribeEvents x

to :: Rep DescribeEvents x -> DescribeEvents

Hashable DescribeEvents

Methods

hashWithSalt :: Int -> DescribeEvents -> Int

hash :: DescribeEvents -> Int

ToJSON DescribeEvents

Methods

toJSON :: DescribeEvents -> Value

toEncoding :: DescribeEvents -> Encoding

toJSONList :: [DescribeEvents] -> Value

toEncodingList :: [DescribeEvents] -> Encoding

NFData DescribeEvents

Methods

rnf :: DescribeEvents -> ()

AWSRequest DescribeEvents

Associated Types

type Rs DescribeEvents :: *

Methods

request :: DescribeEvents -> Request DescribeEvents

response :: MonadResource m => Logger -> Service -> Proxy * DescribeEvents -> ClientResponse -> m (Response DescribeEvents)

ToQuery DescribeEvents

Methods

toQuery :: DescribeEvents -> QueryString

ToPath DescribeEvents

Methods

toPath :: DescribeEvents -> ByteString

ToHeaders DescribeEvents

Methods

toHeaders :: DescribeEvents -> [Header]

type Rep DescribeEvents

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

type Rs DescribeEvents

type Rs DescribeEvents = DescribeEventsResponse

Request Lenses

deSourceName :: Lens' DescribeEvents (Maybe Text)

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)

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

deSourceType :: Lens' DescribeEvents (Maybe SourceType)

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

deNextToken :: Lens' DescribeEvents (Maybe Text)

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)

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

deDuration :: Lens' DescribeEvents (Maybe Int)

The number of minutes' worth of events to retrieve.

deMaxResults :: Lens' DescribeEvents (Maybe Int)

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

Arguments

:: Int

dersResponseStatus

-> DescribeEventsResponse

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

See: describeEventsResponse smart constructor.

Instances

Eq DescribeEventsResponse

Methods

(==) :: DescribeEventsResponse -> DescribeEventsResponse -> Bool

(/=) :: DescribeEventsResponse -> DescribeEventsResponse -> Bool

Data DescribeEventsResponse

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

Methods

readsPrec :: Int -> ReadS DescribeEventsResponse

readList :: ReadS [DescribeEventsResponse]

readPrec :: ReadPrec DescribeEventsResponse

readListPrec :: ReadPrec [DescribeEventsResponse]

Show DescribeEventsResponse

Methods

showsPrec :: Int -> DescribeEventsResponse -> ShowS

show :: DescribeEventsResponse -> String

showList :: [DescribeEventsResponse] -> ShowS

Generic DescribeEventsResponse

Associated Types

type Rep DescribeEventsResponse :: * -> *

Methods

from :: DescribeEventsResponse -> Rep DescribeEventsResponse x

to :: Rep DescribeEventsResponse x -> DescribeEventsResponse

NFData DescribeEventsResponse

Methods

rnf :: DescribeEventsResponse -> ()

type Rep DescribeEventsResponse

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

Response Lenses

dersNextToken :: Lens' DescribeEventsResponse (Maybe Text)

Provides an identifier to allow retrieval of paginated results.

dersEvents :: Lens' DescribeEventsResponse [Event]

An array of events. Each element in the array represents one event.

dersResponseStatus :: Lens' DescribeEventsResponse Int

• - | The response status code.