ListServerNeighbors
Retrieves a list of servers that are one network hop away from a specified server.
Request Syntax
{
"configurationId": "string",
"maxResults": number,
"neighborConfigurationIds": [ "string" ],
"nextToken": "string",
"portInformationNeeded": boolean
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- configurationId
-
Configuration ID of the server for which neighbors are being listed.
Type: String
Length Constraints: Maximum length of 200.
Pattern:
\S*Required: Yes
- maxResults
-
Maximum number of results to return in a single page of output.
Type: Integer
Required: No
- neighborConfigurationIds
-
List of configuration IDs to test for one-hop-away.
Type: Array of strings
Length Constraints: Maximum length of 200.
Pattern:
\S*Required: No
- nextToken
-
Token to retrieve the next set of results. For example, if you previously specified 100 IDs for
ListServerNeighborsRequest$neighborConfigurationIdsbut setListServerNeighborsRequest$maxResultsto 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.Type: String
Length Constraints: Maximum length of 10000.
Pattern:
[\s\S]*Required: No
- portInformationNeeded
-
Flag to indicate if port and protocol information is needed as part of the response.
Type: Boolean
Required: No
Response Syntax
{
"knownDependencyCount": number,
"neighbors": [
{
"connectionsCount": number,
"destinationPort": number,
"destinationServerId": "string",
"sourceServerId": "string",
"transportProtocol": "string"
}
],
"nextToken": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- knownDependencyCount
-
Count of distinct servers that are one hop away from the given server.
Type: Long
- neighbors
-
List of distinct servers that are one hop away from the given server.
Type: Array of NeighborConnectionDetail objects
- nextToken
-
Token to retrieve the next set of results. For example, if you specified 100 IDs for
ListServerNeighborsRequest$neighborConfigurationIdsbut setListServerNeighborsRequest$maxResultsto 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.Type: String
Length Constraints: Maximum length of 10000.
Pattern:
[\s\S]*
Errors
For information about the errors that are common to all actions, see Common Errors.
- AuthorizationErrorException
-
The user does not have permission to perform the action. Check the IAM policy associated with this user.
HTTP Status Code: 400
- HomeRegionNotSetException
-
The home Region is not set. Set the home Region to continue.
HTTP Status Code: 400
- InvalidParameterException
-
One or more parameters are not valid. Verify the parameters and try again.
HTTP Status Code: 400
- InvalidParameterValueException
-
The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
HTTP Status Code: 400
- ServerInternalErrorException
-
The server experienced an internal error. Try again.
HTTP Status Code: 500
Examples
List server neighbors
The following example requests to find out if there are any server neighbors that
are one network hop away from the server specified in the required parameter
configurationId. Port information is also requested by passing "true" to
the boolean parameter portInformationNeeded (note that boolean parameters
must be passed as all lowercase without any quotes). It this particular example, no server
neighbors are found that are one network hop away.
Sample Request
{
"configurationId": "d-server-0974b967a76335589",
"neighborConfigurationIds": [ "d-server-0c269e353e6d1fb4c","d-server-01440c9c5df26ae50" ],
"portInformationNeeded": true
}Sample Response
{
"neighbors": [],
"knownDependencyCount": 0
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
