[ aws . discovery ]

get-discovery-summary

Description

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

Synopsis

  get-discovery-summary
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

servers -> (long)

The number of servers discovered.

applications -> (long)

The number of applications discovered.

serversMappedToApplications -> (long)

The number of servers mapped to applications.

serversMappedtoTags -> (long)

The number of servers mapped to tags.

agentSummary -> (structure)

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 -> (structure)

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 -> (structure)

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 -> (structure)

Details about Agentless Collector collectors, including status.

activeAgentlessCollectors -> (integer)

The number of active Agentless Collector collectors.

healthyAgentlessCollectors -> (integer)

The number of healthy Agentless Collector collectors.

denyListedAgentlessCollectors -> (integer)

The number of deny-listed Agentless Collector collectors.

shutdownAgentlessCollectors -> (integer)

The number of Agentless Collector collectors with SHUTDOWN status.

unhealthyAgentlessCollectors -> (integer)

The number of unhealthy Agentless Collector collectors.

totalAgentlessCollectors -> (integer)

The total number of Agentless Collector collectors.

unknownAgentlessCollectors -> (integer)

The number of unknown Agentless Collector collectors.