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.

Implementation for accessing ApplicationDiscoveryService AWS Application Discovery Service

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:

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 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 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.ApplicationDiscoveryService.AmazonApplicationDiscoveryServiceClient

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

Syntax

C#
public class AmazonApplicationDiscoveryServiceClient : AmazonServiceClient
         IAmazonApplicationDiscoveryService, IAmazonService, IDisposable

The AmazonApplicationDiscoveryServiceClient type exposes the following members

Constructors

NameDescription
Public Method AmazonApplicationDiscoveryServiceClient()

Constructs AmazonApplicationDiscoveryServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonApplicationDiscoveryServiceClient(RegionEndpoint)

Constructs AmazonApplicationDiscoveryServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonApplicationDiscoveryServiceClient(AmazonApplicationDiscoveryServiceConfig)

Constructs AmazonApplicationDiscoveryServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonApplicationDiscoveryServiceClient(AWSCredentials)

Constructs AmazonApplicationDiscoveryServiceClient with AWS Credentials

Public Method AmazonApplicationDiscoveryServiceClient(AWSCredentials, RegionEndpoint)

Constructs AmazonApplicationDiscoveryServiceClient with AWS Credentials

Public Method AmazonApplicationDiscoveryServiceClient(AWSCredentials, AmazonApplicationDiscoveryServiceConfig)

Constructs AmazonApplicationDiscoveryServiceClient with AWS Credentials and an AmazonApplicationDiscoveryServiceClient Configuration object.

Public Method AmazonApplicationDiscoveryServiceClient(string, string)

Constructs AmazonApplicationDiscoveryServiceClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonApplicationDiscoveryServiceClient(string, string, RegionEndpoint)

Constructs AmazonApplicationDiscoveryServiceClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonApplicationDiscoveryServiceClient(string, string, AmazonApplicationDiscoveryServiceConfig)

Constructs AmazonApplicationDiscoveryServiceClient with AWS Access Key ID, AWS Secret Key and an AmazonApplicationDiscoveryServiceClient Configuration object.

Public Method AmazonApplicationDiscoveryServiceClient(string, string, string)

Constructs AmazonApplicationDiscoveryServiceClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonApplicationDiscoveryServiceClient(string, string, string, RegionEndpoint)

Constructs AmazonApplicationDiscoveryServiceClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonApplicationDiscoveryServiceClient(string, string, string, AmazonApplicationDiscoveryServiceConfig)

Constructs AmazonApplicationDiscoveryServiceClient with AWS Access Key ID, AWS Secret Key and an AmazonApplicationDiscoveryServiceClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

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)

Associates one or more configuration items with an application.

Public Method BatchDeleteImportData(BatchDeleteImportDataRequest)

Deletes 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.

AWS Application Discovery Service has built-in matching logic that will identify when discovered servers match existing entries that you've previously discovered, the information for the already-existing discovered server is updated. When you delete an import task that contains records that were used to match, the information in those matched records that comes from the deleted records will also be deleted.

Public Method BatchDeleteImportDataAsync(BatchDeleteImportDataRequest, CancellationToken)

Deletes 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.

AWS Application Discovery Service has built-in matching logic that will identify when discovered servers match existing entries that you've previously discovered, the information for the already-existing discovered server is updated. When you delete an import task that contains records that were used to match, the information in those matched records that comes from the deleted records will also be deleted.

Public Method CreateApplication(CreateApplicationRequest)

Creates an application with the given name and description.

Public Method CreateApplicationAsync(CreateApplicationRequest, CancellationToken)

Creates an application with the given name and description.

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)

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 DeleteApplications(DeleteApplicationsRequest)

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

Public Method DeleteApplicationsAsync(DeleteApplicationsRequest, CancellationToken)

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

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)

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

Public Method DescribeAgents(DescribeAgentsRequest)

Lists agents or connectors as specified by ID or other filters. All agents/connectors associated with your user account can be listed if you call DescribeAgents as is without passing any parameters.

Public Method DescribeAgentsAsync(DescribeAgentsRequest, CancellationToken)

Lists agents or connectors as specified by ID or other filters. All agents/connectors associated with your user account can be listed if you call DescribeAgents as is without passing any parameters.

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 from one of the following:

  • server

  • application

  • process

  • connection

Output fields are specific to the asset type specified. For example, the output for a server configuration item includes a list of attributes about the server, such as host name, operating system, number of network cards, etc.

For a complete list of outputs for each asset type, see Using the DescribeConfigurations Action in the AWS Application Discovery Service User Guide.

Public Method DescribeConfigurationsAsync(DescribeConfigurationsRequest, CancellationToken)

Retrieves 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

  • application

  • process

  • connection

Output fields are specific to the asset type specified. For example, the output for a server configuration item includes a list of attributes about the server, such as host name, operating system, number of network cards, etc.

For a complete list of outputs for each asset type, see Using the DescribeConfigurations Action in the AWS Application Discovery Service User Guide.

Public Method DescribeContinuousExports(DescribeContinuousExportsRequest)

Lists exports as specified by ID. All continuous exports associated with your user account can be listed if you call DescribeContinuousExports as is without passing any parameters.

Public Method DescribeContinuousExportsAsync(DescribeContinuousExportsRequest, CancellationToken)

Lists exports as specified by ID. All continuous exports associated with your user account can be listed if you call DescribeContinuousExports as is without passing any parameters.

Public Method DescribeExportConfigurations(DescribeExportConfigurationsRequest)

DescribeExportConfigurations is deprecated. Use DescribeImportTasks, instead.

Public Method DescribeExportConfigurationsAsync(DescribeExportConfigurationsRequest, CancellationToken)

DescribeExportConfigurations is deprecated. Use DescribeImportTasks, instead.

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)

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

Public Method DescribeImportTasks(DescribeImportTasksRequest)

Returns an array of import tasks for your account, including status information, times, IDs, the Amazon S3 Object URL for the import file, and more.

Public Method DescribeImportTasksAsync(DescribeImportTasksRequest, CancellationToken)

Returns an array of import tasks for your account, including status information, times, IDs, the Amazon S3 Object URL for the import file, and more.

Public Method DescribeTags(DescribeTagsRequest)

Retrieves 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 are three valid tag filter names:

  • tagKey

  • tagValue

  • configurationId

Also, all configuration items associated with your user account that have tags can be listed if you call DescribeTags as is without passing any parameters.

Public Method DescribeTagsAsync(DescribeTagsRequest, CancellationToken)

Retrieves 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 are three valid tag filter names:

  • tagKey

  • tagValue

  • configurationId

Also, all configuration items associated with your user account that have tags can be listed if you call DescribeTags as is without passing any parameters.

Public Method DisassociateConfigurationItemsFromApplication(DisassociateConfigurationItemsFromApplicationRequest)

Disassociates one or more configuration items from an application.

Public Method DisassociateConfigurationItemsFromApplicationAsync(DisassociateConfigurationItemsFromApplicationRequest, CancellationToken)

Disassociates one or more configuration items from an application.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
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)

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 GetDiscoverySummary(GetDiscoverySummaryRequest)

Retrieves 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 example.

Public Method GetDiscoverySummaryAsync(GetDiscoverySummaryRequest, CancellationToken)

Retrieves 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 example.

Public Method ListConfigurations(ListConfigurationsRequest)

Retrieves a list of configuration items as specified by the value passed to the required parameter configurationType. Optional filtering may be applied to refine search results.

Public Method ListConfigurationsAsync(ListConfigurationsRequest, CancellationToken)

Retrieves a list of configuration items as specified by the value passed to the required parameter configurationType. Optional filtering may be applied to refine search results.

Public Method ListServerNeighbors(ListServerNeighborsRequest)

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

Public Method ListServerNeighborsAsync(ListServerNeighborsRequest, CancellationToken)

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

Public Method StartContinuousExport(StartContinuousExportRequest)

Start the continuous flow of agent's discovered data into Amazon Athena.

Public Method StartContinuousExportAsync(StartContinuousExportRequest, CancellationToken)

Start the continuous flow of agent's discovered data into Amazon Athena.

Public Method StartDataCollectionByAgentIds(StartDataCollectionByAgentIdsRequest)

Instructs the specified agents or connectors to start collecting data.

Public Method StartDataCollectionByAgentIdsAsync(StartDataCollectionByAgentIdsRequest, CancellationToken)

Instructs the specified agents or connectors to start collecting data.

Public Method StartExportTask(StartExportTaskRequest)

Begins the export of discovered data to an S3 bucket.

If you specify agentIds 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 agentIds 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)

Begins the export of discovered data to an S3 bucket.

If you specify agentIds 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 agentIds 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 StartImportTask(StartImportTaskRequest)

Starts an import task, which allows you to import details of your on-premises environment directly into AWS Migration Hub without having to use the Application Discovery Service (ADS) tools such as the Discovery Connector or Discovery Agent. This gives you the option to perform migration assessment and planning directly from your imported data, including the ability to group your devices as applications and track their migration status.

To start an import request, do this:

  1. Download the specially formatted comma separated value (CSV) import template, which you can find here: https://s3-us-west-2.amazonaws.com/templates-7cffcf56-bd96-4b1c-b45b-a5b42f282e46/import_template.csv.

  2. Fill out the template with your server and application data.

  3. Upload your import file to an Amazon S3 bucket, and make a note of it's Object URL. Your import file must be in the CSV format.

  4. Use the console or the StartImportTask command with the AWS CLI or one of the AWS SDKs to import the records from your file.

For more information, including step-by-step procedures, see Migration Hub Import in the AWS Application Discovery Service User Guide.

There are limits to the number of import tasks you can create (and delete) in an AWS account. For more information, see AWS Application Discovery Service Limits in the AWS Application Discovery Service User Guide.

Public Method StartImportTaskAsync(StartImportTaskRequest, CancellationToken)

Starts an import task, which allows you to import details of your on-premises environment directly into AWS Migration Hub without having to use the Application Discovery Service (ADS) tools such as the Discovery Connector or Discovery Agent. This gives you the option to perform migration assessment and planning directly from your imported data, including the ability to group your devices as applications and track their migration status.

To start an import request, do this:

  1. Download the specially formatted comma separated value (CSV) import template, which you can find here: https://s3-us-west-2.amazonaws.com/templates-7cffcf56-bd96-4b1c-b45b-a5b42f282e46/import_template.csv.

  2. Fill out the template with your server and application data.

  3. Upload your import file to an Amazon S3 bucket, and make a note of it's Object URL. Your import file must be in the CSV format.

  4. Use the console or the StartImportTask command with the AWS CLI or one of the AWS SDKs to import the records from your file.

For more information, including step-by-step procedures, see Migration Hub Import in the AWS Application Discovery Service User Guide.

There are limits to the number of import tasks you can create (and delete) in an AWS account. For more information, see AWS Application Discovery Service Limits in the AWS Application Discovery Service User Guide.

Public Method StopContinuousExport(StopContinuousExportRequest)

Stop the continuous flow of agent's discovered data into Amazon Athena.

Public Method StopContinuousExportAsync(StopContinuousExportRequest, CancellationToken)

Stop the continuous flow of agent's discovered data into Amazon Athena.

Public Method StopDataCollectionByAgentIds(StopDataCollectionByAgentIdsRequest)

Instructs the specified agents or connectors to stop collecting data.

Public Method StopDataCollectionByAgentIdsAsync(StopDataCollectionByAgentIdsRequest, CancellationToken)

Instructs the specified agents or connectors to stop collecting data.

Public Method UpdateApplication(UpdateApplicationRequest)

Updates metadata about an application.

Public Method UpdateApplicationAsync(UpdateApplicationRequest, CancellationToken)

Updates metadata about an application.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

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