Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.AWSHealth.DescribeEvents

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about events that meet the specified filter criteria. Events are returned in a summary form and do not include the detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the DescribeEventDetails and DescribeAffectedEntities operations.

If no filter criteria are specified, all events are returned. Results are sorted by lastModifiedTime , starting with the most recent.

This operation returns paginated results.

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:

deLocale - The locale (language) to return information in. English (en) is the default and the only supported value at this time.
deNextToken - If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
deFilter - Values to narrow the results returned.
deMaxResults - The maximum number of items to return in one batch, between 10 and 100, inclusive.

data DescribeEvents Source #

See: describeEvents smart constructor.

Instances

Eq DescribeEvents Source #
Instance details Defined in Network.AWS.AWSHealth.DescribeEvents Methods (==) :: DescribeEvents -> DescribeEvents -> Bool # (/=) :: DescribeEvents -> DescribeEvents -> Bool #
Data DescribeEvents Source #
Instance details Defined in Network.AWS.AWSHealth.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.AWSHealth.DescribeEvents Methods readsPrec :: Int -> ReadS DescribeEvents # readList :: ReadS [DescribeEvents] # readPrec :: ReadPrec DescribeEvents # readListPrec :: ReadPrec [DescribeEvents] #
Show DescribeEvents Source #
Instance details Defined in Network.AWS.AWSHealth.DescribeEvents Methods showsPrec :: Int -> DescribeEvents -> ShowS # show :: DescribeEvents -> String # showList :: [DescribeEvents] -> ShowS #
Generic DescribeEvents Source #
Instance details Defined in Network.AWS.AWSHealth.DescribeEvents Associated Types type Rep DescribeEvents :: Type -> Type # Methods from :: DescribeEvents -> Rep DescribeEvents x # to :: Rep DescribeEvents x -> DescribeEvents #
Hashable DescribeEvents Source #
Instance details Defined in Network.AWS.AWSHealth.DescribeEvents Methods hashWithSalt :: Int -> DescribeEvents -> Int # hash :: DescribeEvents -> Int #
ToJSON DescribeEvents Source #
Instance details Defined in Network.AWS.AWSHealth.DescribeEvents Methods toJSON :: DescribeEvents -> Value # toEncoding :: DescribeEvents -> Encoding # toJSONList :: [DescribeEvents] -> Value # toEncodingList :: [DescribeEvents] -> Encoding #
AWSPager DescribeEvents Source #
Instance details Defined in Network.AWS.AWSHealth.DescribeEvents Methods page :: DescribeEvents -> Rs DescribeEvents -> Maybe DescribeEvents #
AWSRequest DescribeEvents Source #
Instance details Defined in Network.AWS.AWSHealth.DescribeEvents Associated Types type Rs DescribeEvents :: Type # Methods request :: DescribeEvents -> Request DescribeEvents # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy DescribeEvents -> ClientResponse -> m (Response DescribeEvents) #
ToHeaders DescribeEvents Source #
Instance details Defined in Network.AWS.AWSHealth.DescribeEvents Methods toHeaders :: DescribeEvents -> [Header] #
ToPath DescribeEvents Source #
Instance details Defined in Network.AWS.AWSHealth.DescribeEvents Methods toPath :: DescribeEvents -> ByteString #
ToQuery DescribeEvents Source #
Instance details Defined in Network.AWS.AWSHealth.DescribeEvents Methods toQuery :: DescribeEvents -> QueryString #
NFData DescribeEvents Source #
Instance details Defined in Network.AWS.AWSHealth.DescribeEvents Methods rnf :: DescribeEvents -> () #
type Rep DescribeEvents Source #
Instance details Defined in Network.AWS.AWSHealth.DescribeEvents type Rep DescribeEvents = D1 (MetaData "DescribeEvents" "Network.AWS.AWSHealth.DescribeEvents" "amazonka-health-1.6.1-BRRcu5UluZl9SYo4GukvCE" False) (C1 (MetaCons "DescribeEvents'" PrefixI True) ((S1 (MetaSel (Just "_deLocale") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_deNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_deFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe EventFilter)) :*: S1 (MetaSel (Just "_deMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)))))
type Rs DescribeEvents Source #
Instance details Defined in Network.AWS.AWSHealth.DescribeEvents type Rs DescribeEvents = DescribeEventsResponse

Request Lenses

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

The locale (language) to return information in. English (en) is the default and the only supported value at this time.

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

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

deFilter :: Lens' DescribeEvents (Maybe EventFilter) Source #

Values to narrow the results returned.

deMaxResults :: Lens' DescribeEvents (Maybe Natural) Source #

The maximum number of items to return in one batch, between 10 and 100, inclusive.

Destructuring the Response

describeEventsResponse Source #

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 - If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
dersEvents - The events that match the specified filter criteria.
dersResponseStatus - -- | The response status code.

data DescribeEventsResponse Source #

See: describeEventsResponse smart constructor.

Instances

Eq DescribeEventsResponse Source #
Instance details Defined in Network.AWS.AWSHealth.DescribeEvents Methods (==) :: DescribeEventsResponse -> DescribeEventsResponse -> Bool # (/=) :: DescribeEventsResponse -> DescribeEventsResponse -> Bool #
Data DescribeEventsResponse Source #
Instance details Defined in Network.AWS.AWSHealth.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.AWSHealth.DescribeEvents Methods readsPrec :: Int -> ReadS DescribeEventsResponse # readList :: ReadS [DescribeEventsResponse] # readPrec :: ReadPrec DescribeEventsResponse # readListPrec :: ReadPrec [DescribeEventsResponse] #
Show DescribeEventsResponse Source #
Instance details Defined in Network.AWS.AWSHealth.DescribeEvents Methods showsPrec :: Int -> DescribeEventsResponse -> ShowS # show :: DescribeEventsResponse -> String # showList :: [DescribeEventsResponse] -> ShowS #
Generic DescribeEventsResponse Source #
Instance details Defined in Network.AWS.AWSHealth.DescribeEvents Associated Types type Rep DescribeEventsResponse :: Type -> Type # Methods from :: DescribeEventsResponse -> Rep DescribeEventsResponse x # to :: Rep DescribeEventsResponse x -> DescribeEventsResponse #
NFData DescribeEventsResponse Source #
Instance details Defined in Network.AWS.AWSHealth.DescribeEvents Methods rnf :: DescribeEventsResponse -> () #
type Rep DescribeEventsResponse Source #
Instance details Defined in Network.AWS.AWSHealth.DescribeEvents type Rep DescribeEventsResponse = D1 (MetaData "DescribeEventsResponse" "Network.AWS.AWSHealth.DescribeEvents" "amazonka-health-1.6.1-BRRcu5UluZl9SYo4GukvCE" 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 #

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

dersEvents :: Lens' DescribeEventsResponse [Event] Source #

The events that match the specified filter criteria.

dersResponseStatus :: Lens' DescribeEventsResponse Int Source #

- | The response status code.