amazonka-health-1.4.5: Amazon Health APIs and Notifications SDK.

Copyright(c) 2013-2016 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.AWSHealth.DescribeEvents

Contents

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.

Synopsis

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:

  • deLocale - The locale (language) to return information in. The default is English.
  • 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.

data DescribeEvents #

See: describeEvents smart constructor.

Instances

Eq DescribeEvents # 
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 # 
Show DescribeEvents # 
Generic DescribeEvents # 

Associated Types

type Rep DescribeEvents :: * -> * #

Hashable DescribeEvents # 
ToJSON DescribeEvents # 
NFData DescribeEvents # 

Methods

rnf :: DescribeEvents -> () #

AWSRequest DescribeEvents # 
ToQuery DescribeEvents # 
ToPath DescribeEvents # 
ToHeaders DescribeEvents # 
type Rep DescribeEvents # 
type Rep DescribeEvents = D1 (MetaData "DescribeEvents" "Network.AWS.AWSHealth.DescribeEvents" "amazonka-health-1.4.5-E6M6i11BIouHnurBp0iAtj" False) (C1 (MetaCons "DescribeEvents'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_deLocale") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_deNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_deFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe EventFilter))) (S1 (MetaSel (Just Symbol "_deMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))))))
type Rs DescribeEvents # 

Request Lenses

deLocale :: Lens' DescribeEvents (Maybe Text) #

The locale (language) to return information in. The default is English.

deNextToken :: Lens' DescribeEvents (Maybe Text) #

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) #

Values to narrow the results returned.

deMaxResults :: Lens' DescribeEvents (Maybe Natural) #

The maximum number of items to return in one batch.

Destructuring the Response

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 #

See: describeEventsResponse smart constructor.

Instances

Eq DescribeEventsResponse # 
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 # 
Show DescribeEventsResponse # 
Generic DescribeEventsResponse # 
NFData DescribeEventsResponse # 

Methods

rnf :: DescribeEventsResponse -> () #

type Rep DescribeEventsResponse # 
type Rep DescribeEventsResponse = D1 (MetaData "DescribeEventsResponse" "Network.AWS.AWSHealth.DescribeEvents" "amazonka-health-1.4.5-E6M6i11BIouHnurBp0iAtj" 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 DecidedUnpack) (Rec0 Int)))))

Response Lenses

dersNextToken :: Lens' DescribeEventsResponse (Maybe Text) #

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] #

The events that match the specified filter criteria.

dersResponseStatus :: Lens' DescribeEventsResponse Int #

  • - | The response status code.