AWS Application Discovery Service
Amazon Web Services Application Discovery Service Amazon Web Services Application Discovery Service (Application Discovery Service) helps you plan application…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Amazon Web Services Application Discovery Service
Amazon Web Services Application Discovery Service (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 Amazon Web Services Application Discovery Service FAQ .
Application Discovery Service offers three ways of performing discovery and collecting
data about your on-premises servers:
Agentless discovery using
Amazon Web Services Application Discovery Service Agentless Collector (Agentless Collector), which doesn't require you
to install an agent on each host.
Agentless Collector gathers server information regardless of the
operating systems, which minimizes the time required for initial on-premises
infrastructure assessment.
Agentless Collector doesn't collect information about network
dependencies, only agent-based discovery collects that information.
Agent-based discovery using the Amazon Web Services Application
Discovery Agent (Application Discovery Agent) collects a richer set of data than agentless
discovery, 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 Amazon Web Services cloud. For more information, see
Amazon Web Services Application
Discovery Agent .
Amazon Web Services Partner Network (APN) solutions integrate with
Application Discovery Service, enabling you to import details of your on-premises
environment directly into Amazon Web Services Migration Hub (Migration Hub) without using
Agentless Collector or Application Discovery Agent.
Third-party application discovery tools can query Amazon Web Services 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.
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 Amazon Web Services SDKs to
access an API that is tailored to the programming language or platform that you're using. For
more information, see Amazon Web Services 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 HomeRegionNotSetException
error 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 InvalidInputException is returned.
You must call GetHomeRegion to obtain the latest Migration Hub home
Region.
This guide is intended for use with the Amazon Web Services Application Discovery Service User
Guide .
All data is handled according to the Amazon Web Services Privacy Policy . You can operate Application Discovery Service offline to
inspect collected data before it is shared with the service.
Endpoints 28
- POSTAssociate configuration items to application
/#X-Amz-Target=AWSPoseidonService_V2015_11_01.AssociateConfigurationItemsToApplicationAssociates one or more configuration items with an application. - POSTBatch delete agents
/#X-Amz-Target=AWSPoseidonService_V2015_11_01.BatchDeleteAgentsDeletes one or more agents or collectors as specified by ID. Deleting an agent or collector does not delete the previously discovered data. To delete the data… - POSTBatch delete import data
/#X-Amz-Target=AWSPoseidonService_V2015_11_01.BatchDeleteImportDataDeletes one or more import tasks, each identified by their import ID. Each import task has a number of records that can identify servers or applications.… - POSTCreate application
/#X-Amz-Target=AWSPoseidonService_V2015_11_01.CreateApplicationCreates an application with the given name and description. - POSTCreate tags
/#X-Amz-Target=AWSPoseidonService_V2015_11_01.CreateTagsCreates one or more tags for configuration items. Tags are metadata that help you categorize IT assets. This API accepts a list of multiple configuration… - POSTDelete applications
/#X-Amz-Target=AWSPoseidonService_V2015_11_01.DeleteApplicationsDeletes a list of applications and their associations with configuration items. - POSTDelete tags
/#X-Amz-Target=AWSPoseidonService_V2015_11_01.DeleteTagsDeletes the association between configuration items and one or more tags. This API accepts a list of multiple configuration items. - POSTDescribe agents
/#X-Amz-Target=AWSPoseidonService_V2015_11_01.DescribeAgentsLists agents or collectors as specified by ID or other filters. All agents/collectors associated with your user can be listed if you call DescribeAgents as is… - POSTDescribe batch delete configuration task
/#X-Amz-Target=AWSPoseidonService_V2015_11_01.DescribeBatchDeleteConfigurationTaskTakes a unique deletion task identifier as input and returns metadata about a configuration deletion task. - POSTDescribe configurations
/#X-Amz-Target=AWSPoseidonService_V2015_11_01.DescribeConfigurationsRetrieves attributes for a list of configuration item IDs. All of the supplied IDs must be for the same asset type from one of the following: server… - POSTDescribe continuous exports
/#X-Amz-Target=AWSPoseidonService_V2015_11_01.DescribeContinuousExportsLists exports as specified by ID. All continuous exports associated with your user can be listed if you call DescribeContinuousExports as is without passing… - POSTDescribe export configurations
/#X-Amz-Target=AWSPoseidonService_V2015_11_01.DescribeExportConfigurationsDeprecated. DescribeExportConfigurations is deprecated. Use DescribeExportTasks , instead. - POSTDescribe export tasks
/#X-Amz-Target=AWSPoseidonService_V2015_11_01.DescribeExportTasksRetrieve status of one or more export tasks. You can retrieve the status of up to 100 export tasks. - POSTDescribe import tasks
/#X-Amz-Target=AWSPoseidonService_V2015_11_01.DescribeImportTasksReturns an array of import tasks for your account, including status information, times, IDs, the Amazon S3 Object URL for the import file, and more. - POSTDescribe tags
/#X-Amz-Target=AWSPoseidonService_V2015_11_01.DescribeTagsRetrieves a list of configuration items that have tags as specified by the key-value pairs, name and value, passed to the optional parameter filters . There… - POSTDisassociate configuration items from application
/#X-Amz-Target=AWSPoseidonService_V2015_11_01.DisassociateConfigurationItemsFromApplicationDisassociates one or more configuration items from an application. - POSTExport configurations
/#X-Amz-Target=AWSPoseidonService_V2015_11_01.ExportConfigurationsDeprecated. Deprecated. Use StartExportTask instead. Exports all discovered configuration data to an Amazon S3 bucket or an application that enables you to… - POSTGet discovery summary
/#X-Amz-Target=AWSPoseidonService_V2015_11_01.GetDiscoverySummaryRetrieves 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… - POSTList configurations
/#X-Amz-Target=AWSPoseidonService_V2015_11_01.ListConfigurationsRetrieves a list of configuration items as specified by the value passed to the required parameter configurationType . Optional filtering may be applied to… - POSTList server neighbors
/#X-Amz-Target=AWSPoseidonService_V2015_11_01.ListServerNeighborsRetrieves a list of servers that are one network hop away from a specified server. - POSTStart batch delete configuration task
/#X-Amz-Target=AWSPoseidonService_V2015_11_01.StartBatchDeleteConfigurationTaskTakes a list of configurationId as input and starts an asynchronous deletion task to remove the configurationItems. Returns a unique deletion task identifier. - POSTStart continuous export
/#X-Amz-Target=AWSPoseidonService_V2015_11_01.StartContinuousExportStart the continuous flow of agent's discovered data into Amazon Athena. - POSTStart data collection by agent ids
/#X-Amz-Target=AWSPoseidonService_V2015_11_01.StartDataCollectionByAgentIdsInstructs the specified agents to start collecting data. - POSTStart export task
/#X-Amz-Target=AWSPoseidonService_V2015_11_01.StartExportTaskBegins the export of a discovered data report to an Amazon S3 bucket managed by Amazon Web Services. Exports might provide an estimate of fees and savings… - POSTStart import task
/#X-Amz-Target=AWSPoseidonService_V2015_11_01.StartImportTaskStarts an import task, which allows you to import details of your on-premises environment directly into Amazon Web Services Migration Hub without having to… - POSTStop continuous export
/#X-Amz-Target=AWSPoseidonService_V2015_11_01.StopContinuousExportStop the continuous flow of agent's discovered data into Amazon Athena. - POSTStop data collection by agent ids
/#X-Amz-Target=AWSPoseidonService_V2015_11_01.StopDataCollectionByAgentIdsInstructs the specified agents to stop collecting data. - POSTUpdate application
/#X-Amz-Target=AWSPoseidonService_V2015_11_01.UpdateApplicationUpdates metadata about an application.
API details
- Base URL
https://discovery.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 28 operations on 28 pathsPOST 28
2 marked deprecated - Description format
- AWS Smithy model, API version
2015-11-01 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the AWS Application Discovery Service in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Application Discovery Service collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Associate configuration items to application” (POST /#X-Amz-Target=AWSPoseidonService_V2015_11_01.AssociateConfigurationItemsToApplication), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the AWS Application Discovery Service?
Amazon Web Services Application Discovery Service Amazon Web Services Application Discovery Service (Application Discovery Service) helps you plan application… It is listed under Developer tools and has 28 endpoints.
Who publishes the AWS Application Discovery Service?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the AWS Application Discovery Service?
Requests go to https://discovery.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the AWS Application Discovery Service?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the AWS Application Discovery Service have?
28 operations on 28 paths (28 POST).
Is forking the AWS Application Discovery Service free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.