GetDiscoverySummary
Retrieves a short summary of discovered assets.
This API operation takes no request parameters and is called as is at the command prompt as shown in the example.
Response Syntax
{
"agentSummary": {
"activeAgents": number,
"blackListedAgents": number,
"healthyAgents": number,
"shutdownAgents": number,
"totalAgents": number,
"unhealthyAgents": number,
"unknownAgents": number
},
"applications": number,
"connectorSummary": {
"activeConnectors": number,
"blackListedConnectors": number,
"healthyConnectors": number,
"shutdownConnectors": number,
"totalConnectors": number,
"unhealthyConnectors": number,
"unknownConnectors": number
},
"servers": number,
"serversMappedToApplications": number,
"serversMappedtoTags": number
}
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.
- agentSummary
-
Details about discovered agents, including agent status and health.
Type: CustomerAgentInfo object
- applications
-
The number of applications discovered.
Type: Long
- connectorSummary
-
Details about discovered connectors, including connector status and health.
Type: CustomerConnectorInfo object
- servers
-
The number of servers discovered.
Type: Long
- serversMappedToApplications
-
The number of servers mapped to applications.
Type: Long
- serversMappedtoTags
-
The number of servers mapped to tags.
Type: Long
Errors
For information about the errors that are common to all actions, see Common Errors.
- AuthorizationErrorException
-
The AWS user account does not have permission to perform the action. Check the IAM policy associated with this account.
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
Get discovery summary of discovered assets
In the following example GetDiscoverySummary
is called as is, without
any request parameters, directly from the AWS CLI and returns a summary of all discovered
assets associated with your account.
Sample Request
[1212|ttys000|510]$ aws discovery get-discovery-summary
Sample Response
{
"servers": 1370,
"applications": 125,
"serversMappedToApplications": 212,
"serversMappedtoTags": 213,
"agentSummary": {
"activeAgents": 3,
"healthyAgents": 3,
"blackListedAgents": 0,
"shutdownAgents": 0,
"unhealthyAgents": 0,
"totalAgents": 16,
"unknownAgents": 13
},
"connectorSummary": {
"activeConnectors": 1,
"healthyConnectors": 1,
"blackListedConnectors": 0,
"shutdownConnectors": 0,
"unhealthyConnectors": 1,
"totalConnectors": 2,
"unknownConnectors": 0
}
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: