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.DescribeEventTypes

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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.

Creating a Request

describeEventTypes :: DescribeEventTypes #

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 #

See: describeEventTypes smart constructor.

Instances

Eq DescribeEventTypes #
Methods (==) :: DescribeEventTypes -> DescribeEventTypes -> Bool # (/=) :: DescribeEventTypes -> DescribeEventTypes -> Bool #
Data DescribeEventTypes #
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 #
Methods readsPrec :: Int -> ReadS DescribeEventTypes # readList :: ReadS [DescribeEventTypes] # readPrec :: ReadPrec DescribeEventTypes # readListPrec :: ReadPrec [DescribeEventTypes] #
Show DescribeEventTypes #
Methods showsPrec :: Int -> DescribeEventTypes -> ShowS # show :: DescribeEventTypes -> String # showList :: [DescribeEventTypes] -> ShowS #
Generic DescribeEventTypes #
Associated Types type Rep DescribeEventTypes :: * -> * # Methods from :: DescribeEventTypes -> Rep DescribeEventTypes x # to :: Rep DescribeEventTypes x -> DescribeEventTypes #
Hashable DescribeEventTypes #
Methods hashWithSalt :: Int -> DescribeEventTypes -> Int # hash :: DescribeEventTypes -> Int #
ToJSON DescribeEventTypes #
Methods toJSON :: DescribeEventTypes -> Value # toEncoding :: DescribeEventTypes -> Encoding # toJSONList :: [DescribeEventTypes] -> Value # toEncodingList :: [DescribeEventTypes] -> Encoding #
NFData DescribeEventTypes #
Methods rnf :: DescribeEventTypes -> () #
AWSPager DescribeEventTypes #
Methods page :: DescribeEventTypes -> Rs DescribeEventTypes -> Maybe DescribeEventTypes #
AWSRequest DescribeEventTypes #
Associated Types type Rs DescribeEventTypes :: * # Methods request :: DescribeEventTypes -> Request DescribeEventTypes # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * DescribeEventTypes -> ClientResponse -> m (Response DescribeEventTypes) #
ToHeaders DescribeEventTypes #
Methods toHeaders :: DescribeEventTypes -> [Header] #
ToPath DescribeEventTypes #
Methods toPath :: DescribeEventTypes -> ByteString #
ToQuery DescribeEventTypes #
Methods toQuery :: DescribeEventTypes -> QueryString #
type Rep DescribeEventTypes #
type Rep DescribeEventTypes = D1 * (MetaData "DescribeEventTypes" "Network.AWS.AWSHealth.DescribeEventTypes" "amazonka-health-1.6.0-D9sHVUZLo0s1lT2PmFORiS" 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 #
type Rs DescribeEventTypes = DescribeEventTypesResponse

Request Lenses

detLocale :: Lens' DescribeEventTypes (Maybe Text) #

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

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

Values to narrow the results returned.

detMaxResults :: Lens' DescribeEventTypes (Maybe Natural) #

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

Destructuring the Response

describeEventTypesResponse #

Arguments

:: Int	`detrsResponseStatus`
-> DescribeEventTypesResponse

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 #

See: describeEventTypesResponse smart constructor.

Instances

Eq DescribeEventTypesResponse #
Methods (==) :: DescribeEventTypesResponse -> DescribeEventTypesResponse -> Bool # (/=) :: DescribeEventTypesResponse -> DescribeEventTypesResponse -> Bool #
Data DescribeEventTypesResponse #
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 #
Methods readsPrec :: Int -> ReadS DescribeEventTypesResponse # readList :: ReadS [DescribeEventTypesResponse] # readPrec :: ReadPrec DescribeEventTypesResponse # readListPrec :: ReadPrec [DescribeEventTypesResponse] #
Show DescribeEventTypesResponse #
Methods showsPrec :: Int -> DescribeEventTypesResponse -> ShowS # show :: DescribeEventTypesResponse -> String # showList :: [DescribeEventTypesResponse] -> ShowS #
Generic DescribeEventTypesResponse #
Associated Types type Rep DescribeEventTypesResponse :: * -> * # Methods from :: DescribeEventTypesResponse -> Rep DescribeEventTypesResponse x # to :: Rep DescribeEventTypesResponse x -> DescribeEventTypesResponse #
NFData DescribeEventTypesResponse #
Methods rnf :: DescribeEventTypesResponse -> () #
type Rep DescribeEventTypesResponse #
type Rep DescribeEventTypesResponse = D1 * (MetaData "DescribeEventTypesResponse" "Network.AWS.AWSHealth.DescribeEventTypes" "amazonka-health-1.6.0-D9sHVUZLo0s1lT2PmFORiS" 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] #

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

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 :: Lens' DescribeEventTypesResponse Int #

- | The response status code.