Network.AWS.Discovery.ListServerNeighbors

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

Creating a Request

listServerNeighbors

Arguments

:: Text

lsnConfigurationId

-> ListServerNeighbors

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

See: listServerNeighbors smart constructor.

Instances

Eq ListServerNeighbors

Methods

(==) :: ListServerNeighbors -> ListServerNeighbors -> Bool

(/=) :: ListServerNeighbors -> ListServerNeighbors -> Bool

Data 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

Methods

readsPrec :: Int -> ReadS ListServerNeighbors

readList :: ReadS [ListServerNeighbors]

readPrec :: ReadPrec ListServerNeighbors

readListPrec :: ReadPrec [ListServerNeighbors]

Show ListServerNeighbors

Methods

showsPrec :: Int -> ListServerNeighbors -> ShowS

show :: ListServerNeighbors -> String

showList :: [ListServerNeighbors] -> ShowS

Generic ListServerNeighbors

Associated Types

type Rep ListServerNeighbors :: * -> *

Methods

from :: ListServerNeighbors -> Rep ListServerNeighbors x

to :: Rep ListServerNeighbors x -> ListServerNeighbors

Hashable ListServerNeighbors

Methods

hashWithSalt :: Int -> ListServerNeighbors -> Int

hash :: ListServerNeighbors -> Int

ToJSON ListServerNeighbors

Methods

toJSON :: ListServerNeighbors -> Value

toEncoding :: ListServerNeighbors -> Encoding

toJSONList :: [ListServerNeighbors] -> Value

toEncodingList :: [ListServerNeighbors] -> Encoding

NFData ListServerNeighbors

Methods

rnf :: ListServerNeighbors -> ()

AWSRequest ListServerNeighbors

Associated Types

type Rs ListServerNeighbors :: *

Methods

request :: ListServerNeighbors -> Request ListServerNeighbors

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * ListServerNeighbors -> ClientResponse -> m (Response ListServerNeighbors)

ToHeaders ListServerNeighbors

Methods

toHeaders :: ListServerNeighbors -> [Header]

ToPath ListServerNeighbors

Methods

toPath :: ListServerNeighbors -> ByteString

ToQuery ListServerNeighbors

Methods

toQuery :: ListServerNeighbors -> QueryString

type Rep ListServerNeighbors

type Rep ListServerNeighbors = D1 * (MetaData "ListServerNeighbors" "Network.AWS.Discovery.ListServerNeighbors" "amazonka-discovery-1.6.0-7Fn7tKF3n1YLpaRWvV4YBz" False) (C1 * (MetaCons "ListServerNeighbors'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_lsnPortInformationNeeded") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_lsnNeighborConfigurationIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text])))) ((:*:) * (S1 * (MetaSel (Just Symbol "_lsnNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_lsnMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) (S1 * (MetaSel (Just Symbol "_lsnConfigurationId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))))

type Rs ListServerNeighbors

type Rs ListServerNeighbors = ListServerNeighborsResponse

Request Lenses

lsnPortInformationNeeded :: Lens' ListServerNeighbors (Maybe Bool)

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

lsnNeighborConfigurationIds :: Lens' ListServerNeighbors [Text]

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

lsnNextToken :: Lens' ListServerNeighbors (Maybe Text)

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)

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

lsnConfigurationId :: Lens' ListServerNeighbors Text

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

Destructuring the Response

listServerNeighborsResponse

Arguments

:: Int

lsnrsResponseStatus

-> ListServerNeighborsResponse

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

See: listServerNeighborsResponse smart constructor.

Instances

Eq ListServerNeighborsResponse

Methods

(==) :: ListServerNeighborsResponse -> ListServerNeighborsResponse -> Bool

(/=) :: ListServerNeighborsResponse -> ListServerNeighborsResponse -> Bool

Data ListServerNeighborsResponse

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

Methods

readsPrec :: Int -> ReadS ListServerNeighborsResponse

readList :: ReadS [ListServerNeighborsResponse]

readPrec :: ReadPrec ListServerNeighborsResponse

readListPrec :: ReadPrec [ListServerNeighborsResponse]

Show ListServerNeighborsResponse

Methods

showsPrec :: Int -> ListServerNeighborsResponse -> ShowS

show :: ListServerNeighborsResponse -> String

showList :: [ListServerNeighborsResponse] -> ShowS

Generic ListServerNeighborsResponse

Associated Types

type Rep ListServerNeighborsResponse :: * -> *

Methods

from :: ListServerNeighborsResponse -> Rep ListServerNeighborsResponse x

to :: Rep ListServerNeighborsResponse x -> ListServerNeighborsResponse

NFData ListServerNeighborsResponse

Methods

rnf :: ListServerNeighborsResponse -> ()

type Rep ListServerNeighborsResponse

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

Response Lenses

lsnrsNextToken :: Lens' ListServerNeighborsResponse (Maybe Text)

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)

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

lsnrsResponseStatus :: Lens' ListServerNeighborsResponse Int

• - | The response status code.

lsnrsNeighbors :: Lens' ListServerNeighborsResponse [NeighborConnectionDetail]

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