AWS Application Discovery Service helps you plan application migration projects. It automatically identifies servers, virtual machines (VMs), and network dependencies in your on-premises data centers. For more information, see the AWS Application Discovery Service FAQ. Application Discovery Service offers three ways of performing discovery and collecting data about your on-premises servers:
Agentless discovery is recommended for environments that use VMware vCenter Server. This mode doesn't require you to install an agent on each host. It does not work in non-VMware environments.
Agentless discovery gathers server information regardless of the operating systems, which minimizes the time required for initial on-premises infrastructure assessment.
Agentless discovery doesn't collect information about network dependencies, only agent-based discovery collects that information.
Agent-based discovery collects a richer set of data than agentless discovery by using the AWS Application Discovery Agent, which you install on one or more hosts in your data center.
The agent captures infrastructure and application information, including an inventory of running processes, system performance information, resource utilization, and network dependencies.
The information collected by agents is secured at rest and in transit to the Application Discovery Service database in the cloud.
AWS Partner Network (APN) solutions integrate with Application Discovery Service, enabling you to import details of your on-premises environment directly into Migration Hub without using the discovery connector or discovery agent.
Third-party application discovery tools can query AWS Application Discovery Service, and they can write to the Application Discovery Service database using the public API.
In this way, you can import data into Migration Hub and view it, so that you can associate applications with servers and track migrations.
We recommend that you use agent-based discovery for non-VMware environments, and whenever you want to collect information about network dependencies. You can run agent-based and agentless discovery simultaneously. Use agentless discovery to complete the initial infrastructure assessment quickly, and then install agents on select hosts to collect additional information.
Working With This Guide
This API reference provides descriptions, syntax, and usage examples for each of the actions and data types for Application Discovery Service. The topic for each action shows the API request parameters and the response. Alternatively, you can use one of the AWS SDKs to access an API that is tailored to the programming language or platform that you're using. For more information, see AWS SDKs.
Remember that you must set your Migration Hub home region before you call any of these APIs.
You must make API calls for write actions (create, notify, associate, disassociate, import, or put) while in your home region, or a
HomeRegionNotSetExceptionerror is returned.
API calls for read actions (list, describe, stop, and delete) are permitted outside of your home region.
Although it is unlikely, the Migration Hub home region could change. If you call APIs outside the home region, an
You must call
GetHomeRegionto obtain the latest Migration Hub home region.
This guide is intended for use with the AWS Application Discovery Service User Guide.
Information about agents or connectors that were instructed to start collecting data. Information includes the agent/connector ID, a description of the operation, and whether the agent/connector configuration was updated.
Information about agents or connectors associated with the user’s AWS account. Information includes agent or connector IDs, IP addresses, media access control (MAC) addresses, agent or connector health, hostname where the agent or connector resides, and agent version for each agent.
Network details about the host where the agent/connector resides.
Tags for a configuration item. Tags are metadata that help you categorize IT assets.
A list of continuous export descriptions.
Inventory data for installed discovery agents.
Inventory data for installed discovery connectors.
Error messages returned for each import task that you deleted as a response for this command.
A client for the AWS Application Discovery Service API.
Used to select which agent's data is to be exported. A single agent ID may be selected for export using the StartExportTask action.
Information regarding the export status of discovered data. The value is an array of objects.
A filter that can use conditional operators.
For more information about filters, see Querying Discovered Configuration Items in the AWS Application Discovery Service User Guide.
An array of information related to the import task request that includes status information, times, IDs, the Amazon S3 Object URL for the import file, and more.
A name-values pair of elements you can use to filter the results when querying your import tasks. Currently, wildcards are not supported for filters.
When filtering by import status, all other filter values are ignored.
Details about neighboring servers.
A field and direction for ordered output.
Metadata that help you categorize IT assets.
The tag filter. Valid names are:
Errors returned by AssociateConfigurationItemsToApplication
Errors returned by BatchDeleteImportData
Errors returned by CreateApplication
Errors returned by CreateTags
Errors returned by DeleteApplications
Errors returned by DeleteTags
Errors returned by DescribeAgents
Errors returned by DescribeConfigurations
Errors returned by DescribeContinuousExports
Errors returned by DescribeExportConfigurations
Errors returned by DescribeExportTasks
Errors returned by DescribeImportTasks
Errors returned by DescribeTags
Errors returned by DisassociateConfigurationItemsFromApplication
Errors returned by ExportConfigurations
Errors returned by GetDiscoverySummary
Errors returned by ListConfigurations
Errors returned by ListServerNeighbors
Errors returned by StartContinuousExport
Errors returned by StartDataCollectionByAgentIds
Errors returned by StartExportTask
Errors returned by StartImportTask
Errors returned by StopContinuousExport
Errors returned by StopDataCollectionByAgentIds
Errors returned by UpdateApplication
Trait representing the capabilities of the AWS Application Discovery Service API. AWS Application Discovery Service clients implement this trait.