Copyright	(c) 2013-2021 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

Amazonka.Discovery.ListServerNeighbors

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Synopsis

Creating a Request

data ListServerNeighbors Source #

See: newListServerNeighbors smart constructor.

Constructors

ListServerNeighbors'

Fields

portInformationNeeded :: Maybe Bool
Flag to indicate if port and protocol information is needed as part of the response.
neighborConfigurationIds :: Maybe [Text]
List of configuration IDs to test for one-hop-away.
nextToken :: 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.
maxResults :: Maybe Int
Maximum number of results to return in a single page of output.
configurationId :: Text
Configuration ID of the server for which neighbors are being listed.

Instances

Instances details

Eq ListServerNeighbors Source #
Instance details Defined in Amazonka.Discovery.ListServerNeighbors Methods (==) :: ListServerNeighbors -> ListServerNeighbors -> Bool # (/=) :: ListServerNeighbors -> ListServerNeighbors -> Bool #
Read ListServerNeighbors Source #
Instance details Defined in Amazonka.Discovery.ListServerNeighbors Methods readsPrec :: Int -> ReadS ListServerNeighbors # readList :: ReadS [ListServerNeighbors] # readPrec :: ReadPrec ListServerNeighbors # readListPrec :: ReadPrec [ListServerNeighbors] #
Show ListServerNeighbors Source #
Instance details Defined in Amazonka.Discovery.ListServerNeighbors Methods showsPrec :: Int -> ListServerNeighbors -> ShowS # show :: ListServerNeighbors -> String # showList :: [ListServerNeighbors] -> ShowS #
Generic ListServerNeighbors Source #
Instance details Defined in Amazonka.Discovery.ListServerNeighbors Associated Types type Rep ListServerNeighbors :: Type -> Type # Methods from :: ListServerNeighbors -> Rep ListServerNeighbors x # to :: Rep ListServerNeighbors x -> ListServerNeighbors #
NFData ListServerNeighbors Source #
Instance details Defined in Amazonka.Discovery.ListServerNeighbors Methods rnf :: ListServerNeighbors -> () #
Hashable ListServerNeighbors Source #
Instance details Defined in Amazonka.Discovery.ListServerNeighbors Methods hashWithSalt :: Int -> ListServerNeighbors -> Int # hash :: ListServerNeighbors -> Int #
ToJSON ListServerNeighbors Source #
Instance details Defined in Amazonka.Discovery.ListServerNeighbors Methods toJSON :: ListServerNeighbors -> Value # toEncoding :: ListServerNeighbors -> Encoding # toJSONList :: [ListServerNeighbors] -> Value # toEncodingList :: [ListServerNeighbors] -> Encoding #
AWSRequest ListServerNeighbors Source #
Instance details Defined in Amazonka.Discovery.ListServerNeighbors Associated Types type AWSResponse ListServerNeighbors # Methods request :: ListServerNeighbors -> Request ListServerNeighbors # response :: MonadResource m => Logger -> Service -> Proxy ListServerNeighbors -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListServerNeighbors))) #
ToHeaders ListServerNeighbors Source #
Instance details Defined in Amazonka.Discovery.ListServerNeighbors Methods toHeaders :: ListServerNeighbors -> [Header] #
ToPath ListServerNeighbors Source #
Instance details Defined in Amazonka.Discovery.ListServerNeighbors Methods toPath :: ListServerNeighbors -> ByteString #
ToQuery ListServerNeighbors Source #
Instance details Defined in Amazonka.Discovery.ListServerNeighbors Methods toQuery :: ListServerNeighbors -> QueryString #
type Rep ListServerNeighbors Source #
Instance details Defined in Amazonka.Discovery.ListServerNeighbors type Rep ListServerNeighbors = D1 ('MetaData "ListServerNeighbors" "Amazonka.Discovery.ListServerNeighbors" "libZSservicesZSamazonka-discoveryZSamazonka-discovery" 'False) (C1 ('MetaCons "ListServerNeighbors'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "portInformationNeeded") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "neighborConfigurationIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "configurationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse ListServerNeighbors Source #
Instance details Defined in Amazonka.Discovery.ListServerNeighbors type AWSResponse ListServerNeighbors = ListServerNeighborsResponse

newListServerNeighbors Source #

Arguments

:: Text	`$sel:configurationId:ListServerNeighbors'`
-> ListServerNeighbors

Create a value of ListServerNeighbors with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:portInformationNeeded:ListServerNeighbors', listServerNeighbors_portInformationNeeded - Flag to indicate if port and protocol information is needed as part of the response.

$sel:neighborConfigurationIds:ListServerNeighbors', listServerNeighbors_neighborConfigurationIds - List of configuration IDs to test for one-hop-away.

$sel:nextToken:ListServerNeighbors', listServerNeighbors_nextToken - 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.

$sel:maxResults:ListServerNeighbors', listServerNeighbors_maxResults - Maximum number of results to return in a single page of output.

$sel:configurationId:ListServerNeighbors', listServerNeighbors_configurationId - Configuration ID of the server for which neighbors are being listed.

Request Lenses

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

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

listServerNeighbors_neighborConfigurationIds :: Lens' ListServerNeighbors (Maybe [Text]) Source #

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

listServerNeighbors_nextToken :: 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.

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

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

listServerNeighbors_configurationId :: Lens' ListServerNeighbors Text Source #

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

Destructuring the Response

data ListServerNeighborsResponse Source #

See: newListServerNeighborsResponse smart constructor.

Constructors

ListServerNeighborsResponse'

Fields

nextToken :: 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.
knownDependencyCount :: Maybe Integer
Count of distinct servers that are one hop away from the given server.
httpStatus :: Int
The response's http status code.
neighbors :: [NeighborConnectionDetail]
List of distinct servers that are one hop away from the given server.

Instances

Instances details

Eq ListServerNeighborsResponse Source #
Instance details Defined in Amazonka.Discovery.ListServerNeighbors Methods (==) :: ListServerNeighborsResponse -> ListServerNeighborsResponse -> Bool # (/=) :: ListServerNeighborsResponse -> ListServerNeighborsResponse -> Bool #
Read ListServerNeighborsResponse Source #
Instance details Defined in Amazonka.Discovery.ListServerNeighbors Methods readsPrec :: Int -> ReadS ListServerNeighborsResponse # readList :: ReadS [ListServerNeighborsResponse] # readPrec :: ReadPrec ListServerNeighborsResponse # readListPrec :: ReadPrec [ListServerNeighborsResponse] #
Show ListServerNeighborsResponse Source #
Instance details Defined in Amazonka.Discovery.ListServerNeighbors Methods showsPrec :: Int -> ListServerNeighborsResponse -> ShowS # show :: ListServerNeighborsResponse -> String # showList :: [ListServerNeighborsResponse] -> ShowS #
Generic ListServerNeighborsResponse Source #
Instance details Defined in Amazonka.Discovery.ListServerNeighbors Associated Types type Rep ListServerNeighborsResponse :: Type -> Type # Methods from :: ListServerNeighborsResponse -> Rep ListServerNeighborsResponse x # to :: Rep ListServerNeighborsResponse x -> ListServerNeighborsResponse #
NFData ListServerNeighborsResponse Source #
Instance details Defined in Amazonka.Discovery.ListServerNeighbors Methods rnf :: ListServerNeighborsResponse -> () #
type Rep ListServerNeighborsResponse Source #
Instance details Defined in Amazonka.Discovery.ListServerNeighbors type Rep ListServerNeighborsResponse = D1 ('MetaData "ListServerNeighborsResponse" "Amazonka.Discovery.ListServerNeighbors" "libZSservicesZSamazonka-discoveryZSamazonka-discovery" 'False) (C1 ('MetaCons "ListServerNeighborsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "knownDependencyCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "neighbors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [NeighborConnectionDetail]))))

newListServerNeighborsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListServerNeighborsResponse'`
-> ListServerNeighborsResponse

Create a value of ListServerNeighborsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nextToken:ListServerNeighbors', listServerNeighborsResponse_nextToken - 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.

$sel:knownDependencyCount:ListServerNeighborsResponse', listServerNeighborsResponse_knownDependencyCount - Count of distinct servers that are one hop away from the given server.

$sel:httpStatus:ListServerNeighborsResponse', listServerNeighborsResponse_httpStatus - The response's http status code.

$sel:neighbors:ListServerNeighborsResponse', listServerNeighborsResponse_neighbors - List of distinct servers that are one hop away from the given server.

Response Lenses

listServerNeighborsResponse_nextToken :: 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.

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

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

listServerNeighborsResponse_httpStatus :: Lens' ListServerNeighborsResponse Int Source #

The response's http status code.

listServerNeighborsResponse_neighbors :: Lens' ListServerNeighborsResponse [NeighborConnectionDetail] Source #

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