AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Interface for accessing ApplicationDiscoveryService AWS Application Discovery Service

AWS Application Discovery Service helps you plan application migration projects by automatically identifying servers, virtual machines (VMs), software, and software dependencies running in your on-premises data centers. Application Discovery Service also collects application performance data, which can help you assess the outcome of your migration. The data collected by Application Discovery Service is securely retained in an Amazon-hosted and managed database in the cloud. You can export the data as a CSV or XML file into your preferred visualization tool or cloud-migration solution to plan your migration. For more information, see the Application Discovery Service FAQ.

Application Discovery Service offers two modes of operation.

Application Discovery Service integrates with application discovery solutions from AWS Partner Network (APN) partners. Third-party application discovery tools can query Application Discovery Service and write to the Application Discovery Service database using a public API. You can then import the data into either a visualization tool or cloud-migration solution.

Application Discovery Service doesn't gather sensitive information. All data is handled according to the AWS Privacy Policy. You can operate Application Discovery Service using offline mode to inspect collected data before it is shared with the service.

Your AWS account must be granted access to Application Discovery Service, a process called whitelisting. This is true for AWS partners and customers alike. To request access, sign up for AWS Application Discovery Service here. We send you information about how to get started.

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.

This guide is intended for use with the AWS Application Discovery Service User Guide .

Inheritance Hierarchy

Amazon.ApplicationDiscoveryService.IAmazonApplicationDiscoveryService

Namespace: Amazon.ApplicationDiscoveryService
Assembly: AWSSDK.ApplicationDiscoveryService.dll
Version: 3.x.y.z

Syntax

C#
public interface IAmazonApplicationDiscoveryService
         IAmazonService, IDisposable

The IAmazonApplicationDiscoveryService type exposes the following members

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method AssociateConfigurationItemsToApplication(AssociateConfigurationItemsToApplicationRequest)

Associates one or more configuration items with an application.

Public Method AssociateConfigurationItemsToApplicationAsync(AssociateConfigurationItemsToApplicationRequest, CancellationToken)

Initiates the asynchronous execution of the AssociateConfigurationItemsToApplication operation.

Public Method CreateApplication(CreateApplicationRequest)

Creates an application with the given name and description.

Public Method CreateApplicationAsync(CreateApplicationRequest, CancellationToken)

Initiates the asynchronous execution of the CreateApplication operation.

Public Method CreateTags(CreateTagsRequest)

Creates one or more tags for configuration items. Tags are metadata that help you categorize IT assets. This API accepts a list of multiple configuration items.

Public Method CreateTagsAsync(CreateTagsRequest, CancellationToken)

Initiates the asynchronous execution of the CreateTags operation.

Public Method DeleteApplications(DeleteApplicationsRequest)

Deletes a list of applications and their associations with configuration items.

Public Method DeleteApplicationsAsync(DeleteApplicationsRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteApplications operation.

Public Method DeleteTags(DeleteTagsRequest)

Deletes the association between configuration items and one or more tags. This API accepts a list of multiple configuration items.

Public Method DeleteTagsAsync(DeleteTagsRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteTags operation.

Public Method DescribeAgents(DescribeAgentsRequest)

Lists agents or the Connector by ID or lists all agents/Connectors associated with your user account if you did not specify an ID.

Public Method DescribeAgentsAsync(DescribeAgentsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeAgents operation.

Public Method DescribeConfigurations(DescribeConfigurationsRequest)

Retrieves attributes for a list of configuration item IDs. All of the supplied IDs must be for the same asset type (server, application, process, or connection). Output fields are specific to the asset type selected. For example, the output for a server configuration item includes a list of attributes about the server, such as host name, operating system, and number of network cards.

For a complete list of outputs for each asset type, see Using the DescribeConfigurations Action.

Public Method DescribeConfigurationsAsync(DescribeConfigurationsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeConfigurations operation.

Public Method DescribeExportConfigurations(DescribeExportConfigurationsRequest)

Deprecated. Use DescribeExportTasks instead.

Retrieves the status of a given export process. You can retrieve status from a maximum of 100 processes.

Public Method DescribeExportConfigurationsAsync(DescribeExportConfigurationsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeExportConfigurations operation.

Public Method DescribeExportTasks(DescribeExportTasksRequest)

Retrieve status of one or more export tasks. You can retrieve the status of up to 100 export tasks.

Public Method DescribeExportTasksAsync(DescribeExportTasksRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeExportTasks operation.

Public Method DescribeTags(DescribeTagsRequest)

Retrieves a list of configuration items that are tagged with a specific tag. Or retrieves a list of all tags assigned to a specific configuration item.

Public Method DescribeTagsAsync(DescribeTagsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeTags operation.

Public Method DisassociateConfigurationItemsFromApplication(DisassociateConfigurationItemsFromApplicationRequest)

Disassociates one or more configuration items from an application.

Public Method DisassociateConfigurationItemsFromApplicationAsync(DisassociateConfigurationItemsFromApplicationRequest, CancellationToken)

Initiates the asynchronous execution of the DisassociateConfigurationItemsFromApplication operation.

Public Method ExportConfigurations(ExportConfigurationsRequest)

Deprecated. Use StartExportTask instead.

Exports all discovered configuration data to an Amazon S3 bucket or an application that enables you to view and evaluate the data. Data includes tags and tag associations, processes, connections, servers, and system performance. This API returns an export ID that you can query using the DescribeExportConfigurations API. The system imposes a limit of two configuration exports in six hours.

Public Method ExportConfigurationsAsync(ExportConfigurationsRequest, CancellationToken)

Initiates the asynchronous execution of the ExportConfigurations operation.

Public Method GetDiscoverySummary(GetDiscoverySummaryRequest)

Retrieves a short summary of discovered assets.

Public Method GetDiscoverySummaryAsync(GetDiscoverySummaryRequest, CancellationToken)

Initiates the asynchronous execution of the GetDiscoverySummary operation.

Public Method ListConfigurations(ListConfigurationsRequest)

Retrieves a list of configuration items according to criteria that you specify in a filter. The filter criteria identifies the relationship requirements.

Public Method ListConfigurationsAsync(ListConfigurationsRequest, CancellationToken)

Initiates the asynchronous execution of the ListConfigurations operation.

Public Method ListServerNeighbors(ListServerNeighborsRequest)

Retrieves a list of servers that are one network hop away from a specified server.

Public Method ListServerNeighborsAsync(ListServerNeighborsRequest, CancellationToken)

Initiates the asynchronous execution of the ListServerNeighbors operation.

Public Method StartDataCollectionByAgentIds(StartDataCollectionByAgentIdsRequest)

Instructs the specified agents or connectors to start collecting data.

Public Method StartDataCollectionByAgentIdsAsync(StartDataCollectionByAgentIdsRequest, CancellationToken)

Initiates the asynchronous execution of the StartDataCollectionByAgentIds operation.

Public Method StartExportTask(StartExportTaskRequest)

Begins the export of discovered data to an S3 bucket.

If you specify agentId in a filter, the task exports up to 72 hours of detailed data collected by the identified Application Discovery Agent, including network, process, and performance details. A time range for exported agent data may be set by using startTime and endTime. Export of detailed agent data is limited to five concurrently running exports.

If you do not include an agentId filter, summary data is exported that includes both AWS Agentless Discovery Connector data and summary data from AWS Discovery Agents. Export of summary data is limited to two exports per day.

Public Method StartExportTaskAsync(StartExportTaskRequest, CancellationToken)

Initiates the asynchronous execution of the StartExportTask operation.

Public Method StopDataCollectionByAgentIds(StopDataCollectionByAgentIdsRequest)

Instructs the specified agents or connectors to stop collecting data.

Public Method StopDataCollectionByAgentIdsAsync(StopDataCollectionByAgentIdsRequest, CancellationToken)

Initiates the asynchronous execution of the StopDataCollectionByAgentIds operation.

Public Method UpdateApplication(UpdateApplicationRequest)

Updates metadata about an application.

Public Method UpdateApplicationAsync(UpdateApplicationRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateApplication operation.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms