Discovery Service AWS Application - docs.aws.amazon.com

1 AWS ApplicationDiscovery ServiceAPI ReferenceAPI Version 2015-11-01 AWS Application Discovery Service API ReferenceAWS Application Discovery Service : API ReferenceCopyright 2019 Amazon Web services , Inc. and/or its affiliates. All rights 's trademarks and trade dress may not be used in connection with any product or Service that is not Amazon's, in any mannerthat is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks notowned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored Application Discovery Service API ReferenceTable of ContentsWelcome .. 1 Querying Discovered Configuration Items .. 2 Using the DescribeConfigurationsAction .. 2 Using the ListConfigurationsAction .. 4 Actions .. 14 AssociateConfigurationItemsToApplication .. 15 Request Syntax .. 15 Request Parameters .. 15 Response Elements .. 15 Errors .. 15 Example.

2 16 See Also.. 16 BatchDeleteImportData .. 17 Request Syntax .. 17 Request Parameters .. 17 Response Syntax .. 17 Response Elements .. 17 Errors .. 18 See Also.. 18 CreateApplication .. 19 Request Syntax .. 19 Request Parameters .. 19 Response Syntax .. 19 Response Elements .. 19 Errors .. 19 Example.. 20 See Also.. 20 CreateTags .. 22 Request Syntax .. 22 Request Parameters .. 22 Response Elements .. 22 Errors .. 22 Example.. 23 See Also.. 23 DeleteApplications.. 25 Request Syntax .. 25 Request Parameters .. 25 Response Elements .. 25 Errors .. 25 Example.. 26 See Also.. 26 DeleteTags .. 27 Request Syntax .. 27 Request Parameters .. 27 Response Elements .. 27 Errors .. 27 Example.. 28 See Also.. 28 DescribeAgents .. 30 Request Syntax .. 30 Request Parameters .. 30 Response Syntax .. 31 Response Elements .. 31 Errors .. 31 API Version 2015-11-01iiiAWS Application Discovery Service API ReferenceExample.

3 32 See Also.. 33 DescribeConfigurations.. 34 Request Syntax .. 34 Request Parameters .. 34 Response Syntax .. 34 Response Elements .. 34 Errors .. 35 Example.. 35 See Also.. 36 DescribeContinuousExports .. 37 Request Syntax .. 37 Request Parameters .. 37 Response Syntax .. 37 Response Elements .. 38 Errors .. 38 Example.. 39 See Also.. 39 DescribeExportConfigurations .. 41 Request Syntax .. 41 Request Parameters .. 41 Response Syntax .. 41 Response Elements .. 42 Errors .. 42 See Also.. 42 DescribeExportTasks .. 44 Request Syntax .. 44 Request Parameters .. 44 Response Syntax .. 45 Response Elements .. 45 Errors .. 45 Example.. 46 See Also.. 47 DescribeImportTasks .. 48 Request Syntax .. 48 Request Parameters .. 48 Response Syntax .. 48 Response Elements .. 49 Errors .. 49 See Also.. 50 DescribeTags .. 51 Request Syntax .. 51 Request Parameters .. 51 Response Syntax .. 52 Response Elements .. 52 Errors.

4 52 Example.. 53 See Also.. 53 DisassociateConfigurationItemsFromApplic ation .. 55 Request Syntax .. 55 Request Parameters .. 55 Response Elements .. 55 Errors .. 55 Example.. 56 See Also.. 56 ExportConfigurations .. 57 Response Syntax .. 57 API Version 2015-11-01ivAWS Application Discovery Service API ReferenceResponse Elements .. 57 Errors .. 57 See Also.. 58 GetDiscoverySummary .. 59 Response Syntax .. 59 Response Elements .. 59 Errors .. 60 Example.. 60 See Also.. 61 ListConfigurations.. 62 Request Syntax .. 62 Request Parameters .. 62 Response Syntax .. 63 Response Elements .. 63 Errors .. 63 Example.. 64 See Also.. 65 ListServerNeighbors .. 66 Request Syntax .. 66 Request Parameters .. 66 Response Syntax .. 67 Response Elements .. 67 Errors .. 67 Example.. 68 See Also.. 68 StartContinuousExport .. 70 Response Syntax .. 70 Response Elements .. 70 Errors .. 70 Example.. 71 See Also.. 72 StartDataCollectionByAgentIds.

5 73 Request Syntax .. 73 Request Parameters .. 73 Response Syntax .. 73 Response Elements .. 73 Errors .. 74 Example.. 74 See Also.. 75 StartExportTask .. 76 Request Syntax .. 76 Request Parameters .. 76 Response Syntax .. 77 Response Elements .. 77 Errors .. 77 Example.. 78 See Also.. 79 StartImportTask .. 80 Request Syntax .. 80 Request Parameters .. 80 Response Syntax .. 81 Response Elements .. 81 Errors .. 82 See Also.. 82 StopContinuousExport .. 83 Request Syntax .. 83 Request Parameters .. 83 API Version 2015-11-01vAWS Application Discovery Service API ReferenceResponse Syntax .. 83 Response Elements .. 83 Errors .. 83 Example.. 84 See Also.. 85 StopDataCollectionByAgentIds .. 86 Request Syntax .. 86 Request Parameters .. 86 Response Syntax .. 86 Response Elements .. 86 Errors .. 86 Example.. 87 See Also.. 87 UpdateApplication.. 89 Request Syntax .. 89 Request Parameters .. 89 Response Elements.

6 89 Errors .. 89 Example.. 90 See Also.. 90 Data Types .. 91 AgentConfigurationStatus .. 92 Contents.. 92 See Also.. 92 AgentInfo .. 93 Contents.. 93 See Also.. 94 AgentNetworkInfo .. 95 Contents.. 95 See Also.. 95 BatchDeleteImportDataError .. 96 Contents.. 96 See Also.. 96 ConfigurationTag .. 97 Contents.. 97 See Also.. 97 ContinuousExportDescription .. 98 Contents.. 98 See Also.. 99 CustomerAgentInfo .. 101 Contents.. 101 See Also.. 102 CustomerConnectorInfo .. 103 Contents.. 103 See Also.. 104 ExportFilter .. 105 Contents.. 105 See Also.. 105 ExportInfo .. 106 Contents.. 106 See Also.. 107 Filter.. 108 Contents.. 108 See Also.. 108 ImportTask .. 109 Contents.. 109 See Also.. 111 API Version 2015-11-01viAWS Application Discovery Service API ReferenceImportTaskFilter .. 112 Contents.. 112 See Also.. 112 NeighborConnectionDetail .. 113 Contents.. 113 See Also.. 113 OrderByElement .. 114 Contents.. 114 See Also.

7 114 Tag .. 115 Contents.. 115 See Also.. 115 TagFilter .. 116 Contents.. 116 See Also.. 116 Common Parameters .. 117 Common Errors .. 119 API Version 2015-11-01viiAWS Application Discovery Service API ReferenceWelcomeAWS Application Discovery Service helps you plan Application migration projects by automaticallyidentifying servers, virtual machines (VMs), software, and software dependencies running in your on-premises data centers. Application Discovery Service also collects Application performance data, whichcan help you assess the outcome of your migration. The data collected by Application Discovery Serviceis securely retained in an AWS-hosted and managed database in the cloud. You can export the data as aCSV or XML file into your preferred visualization tool or cloud-migration solution to plan your more information, see AWS Application Discovery Service Discovery Service offers the following two modes of operation: Agentless Discovery mode is recommended for environments that use VMware vCenter mode doesn't require you to install an agent on each host.

8 Agentless Discovery gathers serverinformation regardless of the operating systems, which minimizes the time required for initial on-premises infrastructure assessment. Agentless Discovery doesn't collect information about softwareand software dependencies. It also doesn't work in non-VMware environments. Agent-based Discovery mode collects a richer set of data than agentless Discovery by using the AWSA pplication Discovery Agent, which you install on one or more hosts in your data center. The agentcaptures infrastructure and Application information, including an inventory of installed softwareapplications, system and process performance, resource utilization, and network dependenciesbetween workloads. The information collected by agents is secured at rest and in transit to theApplication Discovery Service database in the recommend that you use agent-based Discovery for non-VMware environments and to collectinformation about software and software dependencies. You can also run agent-based and agentlessdiscovery simultaneously.

9 Use agentless Discovery to quickly complete the initial infrastructureassessment and then install agents on select Discovery Service integrates with Application Discovery solutions from AWS Partner Network(APN) partners. Third-party Application Discovery tools can query Application Discovery Service andwrite to the Application Discovery Service database using a public API. You can then import the data intoeither a visualization tool or cloud-migration Discovery Service doesn't gather sensitive information. All data is handled accordingto the AWS Privacy Policy. You can operate Application Discovery Service offline to inspectcollected data before it is shared with the API reference provides descriptions, syntax, and usage examples for each of the actions and datatypes for Application Discovery Service . The topic for each action shows the API request parameters andthe response. Alternatively, you can use one of the AWS SDKs to access an API that is tailored to theprogramming language or platform that you're using.

10 For more information, see AWS guide is intended for use with the Application Discovery Service User Version 2015-11-011 AWS Application Discovery Service API ReferenceUsing the DescribeConfigurationsActionQuerying Discovered ConfigurationItemsA configuration item is an IT asset that was discovered in your data center by an agent or the you use Application Discovery Service , you can specify filters and query specific configurationitems for server, Application , process, and connection tables in the following sections list the available input filters and output sorting options for twoApplication Discovery Service actions: DescribeConfigurations ListConfigurationsThe filtering and sorting options are organized by the type of asset to which apply (server, Application ,process, or connection).Using the DescribeConfigurationsActionThe DescribeConfigurationsaction retrieves attributes for a list of configuration IDs. All thesupplied IDs must be for the same asset type (server, Application , process, or connection).