amazonka-discovery-1.6.1: Amazon Application Discovery Service 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.Discovery.ListServerNeighbors

Contents

Description

Retrieves a list of servers that are one network hop away from a specified server.

Synopsis

Creating a Request

listServerNeighbors Source #

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

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

  • lsnPortInformationNeeded - Flag to indicate if port and protocol information is needed as part of the response.
  • lsnNeighborConfigurationIds - List of configuration IDs to test for one-hop-away.
  • lsnNextToken - Token to retrieve the next set of results. For example, if you previously specified 100 IDs for ListServerNeighborsRequest$neighborConfigurationIds but set ListServerNeighborsRequest$maxResults to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10.
  • lsnMaxResults - Maximum number of results to return in a single page of output.
  • lsnConfigurationId - Configuration ID of the server for which neighbors are being listed.

data ListServerNeighbors Source #

See: listServerNeighbors smart constructor.

Instances
Eq ListServerNeighbors Source # 
Instance details

Defined in Network.AWS.Discovery.ListServerNeighbors

Data ListServerNeighbors Source # 
Instance details

Defined in Network.AWS.Discovery.ListServerNeighbors

Methods

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

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

toConstr :: ListServerNeighbors -> Constr #

dataTypeOf :: ListServerNeighbors -> DataType #

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

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

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

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

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

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

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

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

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

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

Read ListServerNeighbors Source # 
Instance details

Defined in Network.AWS.Discovery.ListServerNeighbors

Show ListServerNeighbors Source # 
Instance details

Defined in Network.AWS.Discovery.ListServerNeighbors

Generic ListServerNeighbors Source # 
Instance details

Defined in Network.AWS.Discovery.ListServerNeighbors

Associated Types

type Rep ListServerNeighbors :: Type -> Type #

Hashable ListServerNeighbors Source # 
Instance details

Defined in Network.AWS.Discovery.ListServerNeighbors

ToJSON ListServerNeighbors Source # 
Instance details

Defined in Network.AWS.Discovery.ListServerNeighbors

AWSRequest ListServerNeighbors Source # 
Instance details

Defined in Network.AWS.Discovery.ListServerNeighbors

Associated Types

type Rs ListServerNeighbors :: Type #

ToHeaders ListServerNeighbors Source # 
Instance details

Defined in Network.AWS.Discovery.ListServerNeighbors

ToPath ListServerNeighbors Source # 
Instance details

Defined in Network.AWS.Discovery.ListServerNeighbors

ToQuery ListServerNeighbors Source # 
Instance details

Defined in Network.AWS.Discovery.ListServerNeighbors

NFData ListServerNeighbors Source # 
Instance details

Defined in Network.AWS.Discovery.ListServerNeighbors

Methods

rnf :: ListServerNeighbors -> () #

type Rep ListServerNeighbors Source # 
Instance details

Defined in Network.AWS.Discovery.ListServerNeighbors

type Rep ListServerNeighbors = D1 (MetaData "ListServerNeighbors" "Network.AWS.Discovery.ListServerNeighbors" "amazonka-discovery-1.6.1-BCKU0SsQ5St9AKTJSgbzOA" False) (C1 (MetaCons "ListServerNeighbors'" PrefixI True) ((S1 (MetaSel (Just "_lsnPortInformationNeeded") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_lsnNeighborConfigurationIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 (MetaSel (Just "_lsnNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_lsnMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int)) :*: S1 (MetaSel (Just "_lsnConfigurationId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))
type Rs ListServerNeighbors Source # 
Instance details

Defined in Network.AWS.Discovery.ListServerNeighbors

Request Lenses

lsnPortInformationNeeded :: Lens' ListServerNeighbors (Maybe Bool) Source #

Flag to indicate if port and protocol information is needed as part of the response.

lsnNeighborConfigurationIds :: Lens' ListServerNeighbors [Text] Source #

List of configuration IDs to test for one-hop-away.

lsnNextToken :: Lens' ListServerNeighbors (Maybe Text) Source #

Token to retrieve the next set of results. For example, if you previously specified 100 IDs for ListServerNeighborsRequest$neighborConfigurationIds but set ListServerNeighborsRequest$maxResults to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10.

lsnMaxResults :: Lens' ListServerNeighbors (Maybe Int) Source #

Maximum number of results to return in a single page of output.

lsnConfigurationId :: Lens' ListServerNeighbors Text Source #

Configuration ID of the server for which neighbors are being listed.

Destructuring the Response

listServerNeighborsResponse Source #

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

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

  • lsnrsNextToken - Token to retrieve the next set of results. For example, if you specified 100 IDs for ListServerNeighborsRequest$neighborConfigurationIds but set ListServerNeighborsRequest$maxResults to 10, you received a set of 10 results along with this token. Use this token in the next query to retrieve the next set of 10.
  • lsnrsKnownDependencyCount - Count of distinct servers that are one hop away from the given server.
  • lsnrsResponseStatus - -- | The response status code.
  • lsnrsNeighbors - List of distinct servers that are one hop away from the given server.

data ListServerNeighborsResponse Source #

See: listServerNeighborsResponse smart constructor.

Instances
Eq ListServerNeighborsResponse Source # 
Instance details

Defined in Network.AWS.Discovery.ListServerNeighbors

Data ListServerNeighborsResponse Source # 
Instance details

Defined in Network.AWS.Discovery.ListServerNeighbors

Methods

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

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

toConstr :: ListServerNeighborsResponse -> Constr #

dataTypeOf :: ListServerNeighborsResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read ListServerNeighborsResponse Source # 
Instance details

Defined in Network.AWS.Discovery.ListServerNeighbors

Show ListServerNeighborsResponse Source # 
Instance details

Defined in Network.AWS.Discovery.ListServerNeighbors

Generic ListServerNeighborsResponse Source # 
Instance details

Defined in Network.AWS.Discovery.ListServerNeighbors

Associated Types

type Rep ListServerNeighborsResponse :: Type -> Type #

NFData ListServerNeighborsResponse Source # 
Instance details

Defined in Network.AWS.Discovery.ListServerNeighbors

type Rep ListServerNeighborsResponse Source # 
Instance details

Defined in Network.AWS.Discovery.ListServerNeighbors

type Rep ListServerNeighborsResponse = D1 (MetaData "ListServerNeighborsResponse" "Network.AWS.Discovery.ListServerNeighbors" "amazonka-discovery-1.6.1-BCKU0SsQ5St9AKTJSgbzOA" False) (C1 (MetaCons "ListServerNeighborsResponse'" PrefixI True) ((S1 (MetaSel (Just "_lsnrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lsnrsKnownDependencyCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Integer))) :*: (S1 (MetaSel (Just "_lsnrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int) :*: S1 (MetaSel (Just "_lsnrsNeighbors") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [NeighborConnectionDetail]))))

Response Lenses

lsnrsNextToken :: Lens' ListServerNeighborsResponse (Maybe Text) Source #

Token to retrieve the next set of results. For example, if you specified 100 IDs for ListServerNeighborsRequest$neighborConfigurationIds but set ListServerNeighborsRequest$maxResults to 10, you received a set of 10 results along with this token. Use this token in the next query to retrieve the next set of 10.

lsnrsKnownDependencyCount :: Lens' ListServerNeighborsResponse (Maybe Integer) Source #

Count of distinct servers that are one hop away from the given server.

lsnrsNeighbors :: Lens' ListServerNeighborsResponse [NeighborConnectionDetail] Source #

List of distinct servers that are one hop away from the given server.