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 |
Retrieves a list of servers that are one network hop away from a specified server.
Synopsis
- listServerNeighbors :: Text -> ListServerNeighbors
- data ListServerNeighbors
- lsnPortInformationNeeded :: Lens' ListServerNeighbors (Maybe Bool)
- lsnNeighborConfigurationIds :: Lens' ListServerNeighbors [Text]
- lsnNextToken :: Lens' ListServerNeighbors (Maybe Text)
- lsnMaxResults :: Lens' ListServerNeighbors (Maybe Int)
- lsnConfigurationId :: Lens' ListServerNeighbors Text
- listServerNeighborsResponse :: Int -> ListServerNeighborsResponse
- data ListServerNeighborsResponse
- lsnrsNextToken :: Lens' ListServerNeighborsResponse (Maybe Text)
- lsnrsKnownDependencyCount :: Lens' ListServerNeighborsResponse (Maybe Integer)
- lsnrsResponseStatus :: Lens' ListServerNeighborsResponse Int
- lsnrsNeighbors :: Lens' ListServerNeighborsResponse [NeighborConnectionDetail]
Creating a Request
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 forListServerNeighborsRequest$neighborConfigurationIds
but setListServerNeighborsRequest$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
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 forListServerNeighborsRequest$neighborConfigurationIds
but setListServerNeighborsRequest$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
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.
lsnrsResponseStatus :: Lens' ListServerNeighborsResponse Int Source #
- - | The response status code.
lsnrsNeighbors :: Lens' ListServerNeighborsResponse [NeighborConnectionDetail] Source #
List of distinct servers that are one hop away from the given server.