Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

get_discovery_summary

get_discovery_summary()

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.

See also: AWS API Documentation

Request Syntax

response = client.get_discovery_summary()
Return type
dict
Returns
Response Syntax
{
    'servers': 123,
    'applications': 123,
    'serversMappedToApplications': 123,
    'serversMappedtoTags': 123,
    'agentSummary': {
        'activeAgents': 123,
        'healthyAgents': 123,
        'blackListedAgents': 123,
        'shutdownAgents': 123,
        'unhealthyAgents': 123,
        'totalAgents': 123,
        'unknownAgents': 123
    },
    'connectorSummary': {
        'activeConnectors': 123,
        'healthyConnectors': 123,
        'blackListedConnectors': 123,
        'shutdownConnectors': 123,
        'unhealthyConnectors': 123,
        'totalConnectors': 123,
        'unknownConnectors': 123
    },
    'meCollectorSummary': {
        'activeMeCollectors': 123,
        'healthyMeCollectors': 123,
        'denyListedMeCollectors': 123,
        'shutdownMeCollectors': 123,
        'unhealthyMeCollectors': 123,
        'totalMeCollectors': 123,
        'unknownMeCollectors': 123
    },
    'agentlessCollectorSummary': {
        'activeAgentlessCollectors': 123,
        'healthyAgentlessCollectors': 123,
        'denyListedAgentlessCollectors': 123,
        'shutdownAgentlessCollectors': 123,
        'unhealthyAgentlessCollectors': 123,
        'totalAgentlessCollectors': 123,
        'unknownAgentlessCollectors': 123
    }
}

Response Structure

  • (dict) --
    • servers (integer) --

      The number of servers discovered.

    • applications (integer) --

      The number of applications discovered.

    • serversMappedToApplications (integer) --

      The number of servers mapped to applications.

    • serversMappedtoTags (integer) --

      The number of servers mapped to tags.

    • agentSummary (dict) --

      Details about discovered agents, including agent status and health.

      • activeAgents (integer) --

        Number of active discovery agents.

      • healthyAgents (integer) --

        Number of healthy discovery agents

      • blackListedAgents (integer) --

        Number of blacklisted discovery agents.

      • shutdownAgents (integer) --

        Number of discovery agents with status SHUTDOWN.

      • unhealthyAgents (integer) --

        Number of unhealthy discovery agents.

      • totalAgents (integer) --

        Total number of discovery agents.

      • unknownAgents (integer) --

        Number of unknown discovery agents.

    • connectorSummary (dict) --

      Details about discovered connectors, including connector status and health.

      • activeConnectors (integer) --

        Number of active discovery connectors.

      • healthyConnectors (integer) --

        Number of healthy discovery connectors.

      • blackListedConnectors (integer) --

        Number of blacklisted discovery connectors.

      • shutdownConnectors (integer) --

        Number of discovery connectors with status SHUTDOWN,

      • unhealthyConnectors (integer) --

        Number of unhealthy discovery connectors.

      • totalConnectors (integer) --

        Total number of discovery connectors.

      • unknownConnectors (integer) --

        Number of unknown discovery connectors.

    • meCollectorSummary (dict) --

      Details about Migration Evaluator collectors, including collector status and health.

      • activeMeCollectors (integer) --

        The number of active Migration Evaluator collectors.

      • healthyMeCollectors (integer) --

        The number of healthy Migration Evaluator collectors.

      • denyListedMeCollectors (integer) --

        The number of deny-listed Migration Evaluator collectors.

      • shutdownMeCollectors (integer) --

        The number of Migration Evaluator collectors with SHUTDOWN status.

      • unhealthyMeCollectors (integer) --

        The number of unhealthy Migration Evaluator collectors.

      • totalMeCollectors (integer) --

        The total number of Migration Evaluator collectors.

      • unknownMeCollectors (integer) --

        The number of unknown Migration Evaluator collectors.

    • agentlessCollectorSummary (dict) --
      • activeAgentlessCollectors (integer) --
      • healthyAgentlessCollectors (integer) --
      • denyListedAgentlessCollectors (integer) --
      • shutdownAgentlessCollectors (integer) --
      • unhealthyAgentlessCollectors (integer) --
      • totalAgentlessCollectors (integer) --
      • unknownAgentlessCollectors (integer) --

Exceptions

  • ApplicationDiscoveryService.Client.exceptions.AuthorizationErrorException
  • ApplicationDiscoveryService.Client.exceptions.InvalidParameterException
  • ApplicationDiscoveryService.Client.exceptions.InvalidParameterValueException
  • ApplicationDiscoveryService.Client.exceptions.ServerInternalErrorException
  • ApplicationDiscoveryService.Client.exceptions.HomeRegionNotSetException