Expand description
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.
-
Recommendations
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
InvalidInputExceptionis returned. -
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.
All data is handled according to the AWS Privacy Policy. You can operate Application Discovery Service offline to inspect collected data before it is shared with the service.
If you’re using the service, you’re probably looking for DiscoveryClient and Discovery.
Structs§
- Agent
Configuration Status 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.
- Agent
Info 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.
- Agent
Network Info Network details about the host where the agent/connector resides.
- Associate
Configuration Items ToApplication Request - Associate
Configuration Items ToApplication Response - Batch
Delete Import Data Request - Batch
Delete Import Data Response - Configuration
Tag Tags for a configuration item. Tags are metadata that help you categorize IT assets.
- Continuous
Export Description A list of continuous export descriptions.
- Create
Application Request - Create
Application Response - Create
Tags Request - Create
Tags Response - Customer
Agent Info Inventory data for installed discovery agents.
- Customer
Connector Info Inventory data for installed discovery connectors.
- Delete
Applications Request - Delete
Applications Response - Delete
Tags Request - Delete
Tags Response - Describe
Agents Request - Describe
Agents Response - Describe
Configurations Request - Describe
Configurations Response - Describe
Continuous Exports Request - Describe
Continuous Exports Response - Describe
Export Configurations Request - Describe
Export Configurations Response - Describe
Export Tasks Request - Describe
Export Tasks Response - Describe
Import Tasks Request - Describe
Import Tasks Response - Describe
Tags Request - Describe
Tags Response - Disassociate
Configuration Items From Application Request - Disassociate
Configuration Items From Application Response - Discovery
Batch Delete Import Data Error Error messages returned for each import task that you deleted as a response for this command.
- Discovery
Client - A client for the AWS Application Discovery Service API.
- Export
Configurations Response - Export
Filter Used to select which agent's data is to be exported. A single agent ID may be selected for export using the StartExportTask action.
- Export
Info Information regarding the export status of discovered data. The value is an array of objects.
- Filter
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.
- GetDiscovery
Summary Request - GetDiscovery
Summary Response - Import
Task 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.
- Import
Task Filter 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.
- List
Configurations Request - List
Configurations Response - List
Server Neighbors Request - List
Server Neighbors Response - Neighbor
Connection Detail Details about neighboring servers.
- Order
ByElement A field and direction for ordered output.
- Start
Continuous Export Request - Start
Continuous Export Response - Start
Data Collection ByAgent IdsRequest - Start
Data Collection ByAgent IdsResponse - Start
Export Task Request - Start
Export Task Response - Start
Import Task Request - Start
Import Task Response - Stop
Continuous Export Request - Stop
Continuous Export Response - Stop
Data Collection ByAgent IdsRequest - Stop
Data Collection ByAgent IdsResponse - Tag
Metadata that help you categorize IT assets.
- TagFilter
The tag filter. Valid names are:
tagKey,tagValue,configurationId.- Update
Application Request - Update
Application Response
Enums§
- Associate
Configuration Items ToApplication Error - Errors returned by AssociateConfigurationItemsToApplication
- Batch
Delete Import Data Error - Errors returned by BatchDeleteImportData
- Create
Application Error - Errors returned by CreateApplication
- Create
Tags Error - Errors returned by CreateTags
- Delete
Applications Error - Errors returned by DeleteApplications
- Delete
Tags Error - Errors returned by DeleteTags
- Describe
Agents Error - Errors returned by DescribeAgents
- Describe
Configurations Error - Errors returned by DescribeConfigurations
- Describe
Continuous Exports Error - Errors returned by DescribeContinuousExports
- Describe
Export Configurations Error - Errors returned by DescribeExportConfigurations
- Describe
Export Tasks Error - Errors returned by DescribeExportTasks
- Describe
Import Tasks Error - Errors returned by DescribeImportTasks
- Describe
Tags Error - Errors returned by DescribeTags
- Disassociate
Configuration Items From Application Error - Errors returned by DisassociateConfigurationItemsFromApplication
- Export
Configurations Error - Errors returned by ExportConfigurations
- GetDiscovery
Summary Error - Errors returned by GetDiscoverySummary
- List
Configurations Error - Errors returned by ListConfigurations
- List
Server Neighbors Error - Errors returned by ListServerNeighbors
- Start
Continuous Export Error - Errors returned by StartContinuousExport
- Start
Data Collection ByAgent IdsError - Errors returned by StartDataCollectionByAgentIds
- Start
Export Task Error - Errors returned by StartExportTask
- Start
Import Task Error - Errors returned by StartImportTask
- Stop
Continuous Export Error - Errors returned by StopContinuousExport
- Stop
Data Collection ByAgent IdsError - Errors returned by StopDataCollectionByAgentIds
- Update
Application Error - Errors returned by UpdateApplication
Traits§
- Discovery
- Trait representing the capabilities of the AWS Application Discovery Service API. AWS Application Discovery Service clients implement this trait.