amazonka-health-1.6.0: Amazon Health APIs and Notifications 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.AWSHealth.DescribeEventTypes

Contents

Description

Returns the event types that meet the specified filter criteria. If no filter criteria are specified, all event types are returned, in no particular order.

This operation returns paginated results.

Synopsis

Creating a Request

describeEventTypes :: DescribeEventTypes Source #

Creates a value of DescribeEventTypes with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • detLocale - The locale (language) to return information in. English (en) is the default and the only supported value at this time.
  • detNextToken - 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.
  • detFilter - Values to narrow the results returned.
  • detMaxResults - The maximum number of items to return in one batch, between 10 and 100, inclusive.

data DescribeEventTypes Source #

See: describeEventTypes smart constructor.

Instances

Eq DescribeEventTypes Source # 
Data DescribeEventTypes Source # 

Methods

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

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

toConstr :: DescribeEventTypes -> Constr #

dataTypeOf :: DescribeEventTypes -> DataType #

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

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

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

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

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

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

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

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

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

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

Read DescribeEventTypes Source # 
Show DescribeEventTypes Source # 
Generic DescribeEventTypes Source # 
Hashable DescribeEventTypes Source # 
ToJSON DescribeEventTypes Source # 
NFData DescribeEventTypes Source # 

Methods

rnf :: DescribeEventTypes -> () #

AWSPager DescribeEventTypes Source # 
AWSRequest DescribeEventTypes Source # 
ToHeaders DescribeEventTypes Source # 
ToPath DescribeEventTypes Source # 
ToQuery DescribeEventTypes Source # 
type Rep DescribeEventTypes Source # 
type Rep DescribeEventTypes = D1 * (MetaData "DescribeEventTypes" "Network.AWS.AWSHealth.DescribeEventTypes" "amazonka-health-1.6.0-H1RIs4q7hy3FFBDXG5xlcn" False) (C1 * (MetaCons "DescribeEventTypes'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_detLocale") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_detNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_detFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe EventTypeFilter))) (S1 * (MetaSel (Just Symbol "_detMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))))))
type Rs DescribeEventTypes Source # 

Request Lenses

detLocale :: Lens' DescribeEventTypes (Maybe Text) Source #

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

detNextToken :: Lens' DescribeEventTypes (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.

detFilter :: Lens' DescribeEventTypes (Maybe EventTypeFilter) Source #

Values to narrow the results returned.

detMaxResults :: Lens' DescribeEventTypes (Maybe Natural) Source #

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

Destructuring the Response

describeEventTypesResponse Source #

Creates a value of DescribeEventTypesResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • detrsEventTypes - A list of event types that match the filter criteria. Event types have a category (issue , accountNotification , or scheduledChange ), a service (for example, EC2 , RDS , DATAPIPELINE , BILLING ), and a code (in the format AWS_SERVICE _DESCRIPTION ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT ).
  • detrsNextToken - 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.
  • detrsResponseStatus - -- | The response status code.

data DescribeEventTypesResponse Source #

See: describeEventTypesResponse smart constructor.

Instances

Eq DescribeEventTypesResponse Source # 
Data DescribeEventTypesResponse Source # 

Methods

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

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

toConstr :: DescribeEventTypesResponse -> Constr #

dataTypeOf :: DescribeEventTypesResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read DescribeEventTypesResponse Source # 
Show DescribeEventTypesResponse Source # 
Generic DescribeEventTypesResponse Source # 
NFData DescribeEventTypesResponse Source # 
type Rep DescribeEventTypesResponse Source # 
type Rep DescribeEventTypesResponse = D1 * (MetaData "DescribeEventTypesResponse" "Network.AWS.AWSHealth.DescribeEventTypes" "amazonka-health-1.6.0-H1RIs4q7hy3FFBDXG5xlcn" False) (C1 * (MetaCons "DescribeEventTypesResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_detrsEventTypes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [EventType]))) ((:*:) * (S1 * (MetaSel (Just Symbol "_detrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_detrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

detrsEventTypes :: Lens' DescribeEventTypesResponse [EventType] Source #

A list of event types that match the filter criteria. Event types have a category (issue , accountNotification , or scheduledChange ), a service (for example, EC2 , RDS , DATAPIPELINE , BILLING ), and a code (in the format AWS_SERVICE _DESCRIPTION ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT ).

detrsNextToken :: Lens' DescribeEventTypesResponse (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.