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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of entities that have been affected by the specified events, based on the specified filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the AWS service. Events that have impact beyond that of the affected entities, or where the extent of impact is unknown, include at least one entity indicating this.

At least one event ARN is required. Results are sorted by the lastUpdatedTime of the entity, starting with the most recent.

This operation returns paginated results.

Creating a Request

describeAffectedEntities #

Arguments

:: EntityFilter	`daeFilter`
-> DescribeAffectedEntities

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

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

daeLocale - The locale (language) to return information in. English (en) is the default and the only supported value at this time.
daeNextToken - 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.
daeMaxResults - The maximum number of items to return in one batch, between 10 and 100, inclusive.
daeFilter - Values to narrow the results returned. At least one event ARN is required.

data DescribeAffectedEntities #

See: describeAffectedEntities smart constructor.

Instances

Eq DescribeAffectedEntities #
Instance details Defined in Network.AWS.AWSHealth.DescribeAffectedEntities Methods (==) :: DescribeAffectedEntities -> DescribeAffectedEntities -> Bool # (/=) :: DescribeAffectedEntities -> DescribeAffectedEntities -> Bool #
Data DescribeAffectedEntities #
Instance details Defined in Network.AWS.AWSHealth.DescribeAffectedEntities Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeAffectedEntities -> c DescribeAffectedEntities # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeAffectedEntities # toConstr :: DescribeAffectedEntities -> Constr # dataTypeOf :: DescribeAffectedEntities -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeAffectedEntities) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeAffectedEntities) # gmapT :: (forall b. Data b => b -> b) -> DescribeAffectedEntities -> DescribeAffectedEntities # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeAffectedEntities -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeAffectedEntities -> r # gmapQ :: (forall d. Data d => d -> u) -> DescribeAffectedEntities -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeAffectedEntities -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeAffectedEntities -> m DescribeAffectedEntities # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeAffectedEntities -> m DescribeAffectedEntities # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeAffectedEntities -> m DescribeAffectedEntities #
Read DescribeAffectedEntities #
Instance details Defined in Network.AWS.AWSHealth.DescribeAffectedEntities Methods readsPrec :: Int -> ReadS DescribeAffectedEntities # readList :: ReadS [DescribeAffectedEntities] # readPrec :: ReadPrec DescribeAffectedEntities # readListPrec :: ReadPrec [DescribeAffectedEntities] #
Show DescribeAffectedEntities #
Instance details Defined in Network.AWS.AWSHealth.DescribeAffectedEntities Methods showsPrec :: Int -> DescribeAffectedEntities -> ShowS # show :: DescribeAffectedEntities -> String # showList :: [DescribeAffectedEntities] -> ShowS #
Generic DescribeAffectedEntities #
Instance details Defined in Network.AWS.AWSHealth.DescribeAffectedEntities Associated Types type Rep DescribeAffectedEntities :: * -> * # Methods from :: DescribeAffectedEntities -> Rep DescribeAffectedEntities x # to :: Rep DescribeAffectedEntities x -> DescribeAffectedEntities #
Hashable DescribeAffectedEntities #
Instance details Defined in Network.AWS.AWSHealth.DescribeAffectedEntities Methods hashWithSalt :: Int -> DescribeAffectedEntities -> Int # hash :: DescribeAffectedEntities -> Int #
ToJSON DescribeAffectedEntities #
Instance details Defined in Network.AWS.AWSHealth.DescribeAffectedEntities Methods toJSON :: DescribeAffectedEntities -> Value # toEncoding :: DescribeAffectedEntities -> Encoding # toJSONList :: [DescribeAffectedEntities] -> Value # toEncodingList :: [DescribeAffectedEntities] -> Encoding #
AWSPager DescribeAffectedEntities #
Instance details Defined in Network.AWS.AWSHealth.DescribeAffectedEntities Methods page :: DescribeAffectedEntities -> Rs DescribeAffectedEntities -> Maybe DescribeAffectedEntities #
AWSRequest DescribeAffectedEntities #
Instance details Defined in Network.AWS.AWSHealth.DescribeAffectedEntities Associated Types type Rs DescribeAffectedEntities :: * # Methods request :: DescribeAffectedEntities -> Request DescribeAffectedEntities # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy DescribeAffectedEntities -> ClientResponse -> m (Response DescribeAffectedEntities) #
ToHeaders DescribeAffectedEntities #
Instance details Defined in Network.AWS.AWSHealth.DescribeAffectedEntities Methods toHeaders :: DescribeAffectedEntities -> [Header] #
ToPath DescribeAffectedEntities #
Instance details Defined in Network.AWS.AWSHealth.DescribeAffectedEntities Methods toPath :: DescribeAffectedEntities -> ByteString #
ToQuery DescribeAffectedEntities #
Instance details Defined in Network.AWS.AWSHealth.DescribeAffectedEntities Methods toQuery :: DescribeAffectedEntities -> QueryString #
NFData DescribeAffectedEntities #
Instance details Defined in Network.AWS.AWSHealth.DescribeAffectedEntities Methods rnf :: DescribeAffectedEntities -> () #
type Rep DescribeAffectedEntities #
Instance details Defined in Network.AWS.AWSHealth.DescribeAffectedEntities type Rep DescribeAffectedEntities = D1 (MetaData "DescribeAffectedEntities" "Network.AWS.AWSHealth.DescribeAffectedEntities" "amazonka-health-1.6.0-F7iViukHIETCkBa9Qq00Mc" False) (C1 (MetaCons "DescribeAffectedEntities'" PrefixI True) ((S1 (MetaSel (Just "_daeLocale") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_daeNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_daeMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)) :*: S1 (MetaSel (Just "_daeFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 EntityFilter))))
type Rs DescribeAffectedEntities #
Instance details Defined in Network.AWS.AWSHealth.DescribeAffectedEntities type Rs DescribeAffectedEntities = DescribeAffectedEntitiesResponse

Request Lenses

daeLocale :: Lens' DescribeAffectedEntities (Maybe Text) #

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

daeNextToken :: Lens' DescribeAffectedEntities (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.

daeMaxResults :: Lens' DescribeAffectedEntities (Maybe Natural) #

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

daeFilter :: Lens' DescribeAffectedEntities EntityFilter #

Values to narrow the results returned. At least one event ARN is required.

Destructuring the Response

describeAffectedEntitiesResponse #

Arguments

:: Int	`daersResponseStatus`
-> DescribeAffectedEntitiesResponse

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

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

daersEntities - The entities that match the filter criteria.
daersNextToken - 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.
daersResponseStatus - -- | The response status code.

data DescribeAffectedEntitiesResponse #

See: describeAffectedEntitiesResponse smart constructor.

Instances

Eq DescribeAffectedEntitiesResponse #
Instance details Defined in Network.AWS.AWSHealth.DescribeAffectedEntities Methods (==) :: DescribeAffectedEntitiesResponse -> DescribeAffectedEntitiesResponse -> Bool # (/=) :: DescribeAffectedEntitiesResponse -> DescribeAffectedEntitiesResponse -> Bool #
Data DescribeAffectedEntitiesResponse #
Instance details Defined in Network.AWS.AWSHealth.DescribeAffectedEntities Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeAffectedEntitiesResponse -> c DescribeAffectedEntitiesResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeAffectedEntitiesResponse # toConstr :: DescribeAffectedEntitiesResponse -> Constr # dataTypeOf :: DescribeAffectedEntitiesResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeAffectedEntitiesResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeAffectedEntitiesResponse) # gmapT :: (forall b. Data b => b -> b) -> DescribeAffectedEntitiesResponse -> DescribeAffectedEntitiesResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeAffectedEntitiesResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeAffectedEntitiesResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> DescribeAffectedEntitiesResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeAffectedEntitiesResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeAffectedEntitiesResponse -> m DescribeAffectedEntitiesResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeAffectedEntitiesResponse -> m DescribeAffectedEntitiesResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeAffectedEntitiesResponse -> m DescribeAffectedEntitiesResponse #
Read DescribeAffectedEntitiesResponse #
Instance details Defined in Network.AWS.AWSHealth.DescribeAffectedEntities Methods readsPrec :: Int -> ReadS DescribeAffectedEntitiesResponse # readList :: ReadS [DescribeAffectedEntitiesResponse] # readPrec :: ReadPrec DescribeAffectedEntitiesResponse # readListPrec :: ReadPrec [DescribeAffectedEntitiesResponse] #
Show DescribeAffectedEntitiesResponse #
Instance details Defined in Network.AWS.AWSHealth.DescribeAffectedEntities Methods showsPrec :: Int -> DescribeAffectedEntitiesResponse -> ShowS # show :: DescribeAffectedEntitiesResponse -> String # showList :: [DescribeAffectedEntitiesResponse] -> ShowS #
Generic DescribeAffectedEntitiesResponse #
Instance details Defined in Network.AWS.AWSHealth.DescribeAffectedEntities Associated Types type Rep DescribeAffectedEntitiesResponse :: * -> * # Methods from :: DescribeAffectedEntitiesResponse -> Rep DescribeAffectedEntitiesResponse x # to :: Rep DescribeAffectedEntitiesResponse x -> DescribeAffectedEntitiesResponse #
NFData DescribeAffectedEntitiesResponse #
Instance details Defined in Network.AWS.AWSHealth.DescribeAffectedEntities Methods rnf :: DescribeAffectedEntitiesResponse -> () #
type Rep DescribeAffectedEntitiesResponse #
Instance details Defined in Network.AWS.AWSHealth.DescribeAffectedEntities type Rep DescribeAffectedEntitiesResponse = D1 (MetaData "DescribeAffectedEntitiesResponse" "Network.AWS.AWSHealth.DescribeAffectedEntities" "amazonka-health-1.6.0-F7iViukHIETCkBa9Qq00Mc" False) (C1 (MetaCons "DescribeAffectedEntitiesResponse'" PrefixI True) (S1 (MetaSel (Just "_daersEntities") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [AffectedEntity])) :: (S1 (MetaSel (Just "_daersNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_daersResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

daersEntities :: Lens' DescribeAffectedEntitiesResponse [AffectedEntity] #

The entities that match the filter criteria.

daersNextToken :: Lens' DescribeAffectedEntitiesResponse (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.

daersResponseStatus :: Lens' DescribeAffectedEntitiesResponse Int #

- | The response status code.