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.

Classes

NameDescription
Class AgentConfigurationStatus

Information about agents that were instructed to start collecting data. Information includes the agent ID, a description of the operation, and whether the agent configuration was updated.

Class AgentInfo

Information about agents associated with the user’s Amazon Web Services account. Information includes agent IDs, IP addresses, media access control (MAC) addresses, agent or collector status, hostname where the agent resides, and agent version for each agent.

Class AgentNetworkInfo

Network details about the host where the agent/collector resides.

Class ApplicationDiscoveryServicePaginatorFactory

Paginators for the ApplicationDiscoveryService service

Class AssociateConfigurationItemsToApplicationRequest

Container for the parameters to the AssociateConfigurationItemsToApplication operation. Associates one or more configuration items with an application.

Class AssociateConfigurationItemsToApplicationResponse

This is the response object from the AssociateConfigurationItemsToApplication operation.

Class AuthorizationErrorException

The user does not have permission to perform the action. Check the IAM policy associated with this user.

Class BatchDeleteAgentError

An object representing the agent or data collector that failed to delete, each containing agentId, errorMessage, and errorCode.

Class BatchDeleteAgentsRequest

Container for the parameters to the BatchDeleteAgents operation. Deletes 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 collected, use StartBatchDeleteConfigurationTask.

Class BatchDeleteAgentsResponse

This is the response object from the BatchDeleteAgents operation.

Class BatchDeleteConfigurationTask

A metadata object that represents the deletion task being executed.

Class BatchDeleteImportDataError

Error messages returned for each import task that you deleted as a response for this command.

Class BatchDeleteImportDataRequest

Container for the parameters to the BatchDeleteImportData operation. 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.

Amazon Web Services 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.

Class BatchDeleteImportDataResponse

This is the response object from the BatchDeleteImportData operation.

Class ConfigurationTag

Tags for a configuration item. Tags are metadata that help you categorize IT assets.

Class ConflictErrorException

Conflict error.

Class ContinuousExportDescription

A list of continuous export descriptions.

Class CreateApplicationRequest

Container for the parameters to the CreateApplication operation. Creates an application with the given name and description.

Class CreateApplicationResponse

This is the response object from the CreateApplication operation.

Class CreateTagsRequest

Container for the parameters to the CreateTags operation. 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.

Do not store sensitive information (like personal data) in tags.

Class CreateTagsResponse

This is the response object from the CreateTags operation.

Class CustomerAgentInfo

Inventory data for installed discovery agents.

Class CustomerAgentlessCollectorInfo

The inventory data for installed Agentless Collector collectors.

Class CustomerConnectorInfo

Inventory data for installed discovery connectors.

Class CustomerMeCollectorInfo

The inventory data for installed Migration Evaluator collectors.

Class DeleteAgent

An object representing the agent or data collector to be deleted along with the optional configurations for error handling.

Class DeleteApplicationsRequest

Container for the parameters to the DeleteApplications operation. Deletes a list of applications and their associations with configuration items.

Class DeleteApplicationsResponse

This is the response object from the DeleteApplications operation.

Class DeleteTagsRequest

Container for the parameters to the DeleteTags operation. Deletes the association between configuration items and one or more tags. This API accepts a list of multiple configuration items.

Class DeleteTagsResponse

This is the response object from the DeleteTags operation.

Class DeletionWarning

A configuration ID paired with a warning message.

Class DescribeAgentsRequest

Container for the parameters to the DescribeAgents operation. Lists 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 without passing any parameters.

Class DescribeAgentsResponse

This is the response object from the DescribeAgents operation.

Class DescribeBatchDeleteConfigurationTaskRequest

Container for the parameters to the DescribeBatchDeleteConfigurationTask operation. Takes a unique deletion task identifier as input and returns metadata about a configuration deletion task.

Class DescribeBatchDeleteConfigurationTaskResponse

This is the response object from the DescribeBatchDeleteConfigurationTask operation.

Class DescribeConfigurationsRequest

Container for the parameters to the DescribeConfigurations operation. 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 Amazon Web Services Application Discovery Service User Guide.

Class DescribeConfigurationsResponse

This is the response object from the DescribeConfigurations operation.

Class DescribeContinuousExportsRequest

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

Class DescribeContinuousExportsResponse

This is the response object from the DescribeContinuousExports operation.

Class DescribeExportConfigurationsRequest

Container for the parameters to the DescribeExportConfigurations operation. DescribeExportConfigurations is deprecated. Use DescribeExportTasks, instead.

Class DescribeExportConfigurationsResponse

This is the response object from the DescribeExportConfigurations operation.

Class DescribeExportTasksRequest

Container for the parameters to the DescribeExportTasks operation. Retrieve status of one or more export tasks. You can retrieve the status of up to 100 export tasks.

Class DescribeExportTasksResponse

This is the response object from the DescribeExportTasks operation.

Class DescribeImportTasksRequest

Container for the parameters to the DescribeImportTasks operation. 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.

Class DescribeImportTasksResponse

This is the response object from the DescribeImportTasks operation.

Class DescribeTagsRequest

Container for the parameters to the DescribeTags operation. 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 that have tags can be listed if you call DescribeTags as is without passing any parameters.

Class DescribeTagsResponse

This is the response object from the DescribeTags operation.

Class DisassociateConfigurationItemsFromApplicationRequest

Container for the parameters to the DisassociateConfigurationItemsFromApplication operation. Disassociates one or more configuration items from an application.

Class DisassociateConfigurationItemsFromApplicationResponse

This is the response object from the DisassociateConfigurationItemsFromApplication operation.

Class Ec2RecommendationsExportPreferences

Indicates that the exported data must include EC2 instance type matches for on-premises servers that are discovered through Amazon Web Services Application Discovery Service.

Class ExportConfigurationsRequest

Container for the parameters to the ExportConfigurations operation. 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.

Class ExportConfigurationsResponse

This is the response object from the ExportConfigurations operation.

Class ExportFilter

Used to select which agent's data is to be exported. A single agent ID may be selected for export using the StartExportTask action.

Class ExportInfo

Information regarding the export status of discovered data. The value is an array of objects.

Class ExportPreferences

Indicates the type of data that is being exported. Only one ExportPreferences can be enabled for a StartExportTask action.

Class FailedConfiguration

A configuration ID paired with an error message.

Class Filter

A filter that can use conditional operators.

For more information about filters, see Querying Discovered Configuration Items in the Amazon Web Services Application Discovery Service User Guide.

Class GetDiscoverySummaryRequest

Container for the parameters to the GetDiscoverySummary operation. 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.

Class GetDiscoverySummaryResponse

This is the response object from the GetDiscoverySummary operation.

Class HomeRegionNotSetException

The home Region is not set. Set the home Region to continue.

Class ImportTask

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.

Class ImportTaskFilter

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.

Class InvalidParameterException

One or more parameters are not valid. Verify the parameters and try again.

Class InvalidParameterValueException

The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.

Class LimitExceededException

The limit of 200 configuration IDs per request has been exceeded.

Class ListConfigurationsRequest

Container for the parameters to the ListConfigurations operation. 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.

Class ListConfigurationsResponse

This is the response object from the ListConfigurations operation.

Class ListServerNeighborsRequest

Container for the parameters to the ListServerNeighbors operation. Retrieves a list of servers that are one network hop away from a specified server.

Class ListServerNeighborsResponse

This is the response object from the ListServerNeighbors operation.

Class NeighborConnectionDetail

Details about neighboring servers.

Class OperationNotPermittedException

This operation is not permitted.

Class OrderByElement

A field and direction for ordered output.

Class ReservedInstanceOptions

Used to provide Reserved Instance preferences for the recommendation.

Class ResourceInUseException

This issue occurs when the same clientRequestToken is used with the StartImportTask action, but with different parameters. For example, you use the same request token but have two different import URLs, you can encounter this issue. If the import tasks are meant to be different, use a different clientRequestToken, and try again.

Class ResourceNotFoundException

The specified configuration ID was not located. Verify the configuration ID and try again.

Class ServerInternalErrorException

The server experienced an internal error. Try again.

Class StartBatchDeleteConfigurationTaskRequest

Container for the parameters to the StartBatchDeleteConfigurationTask operation. Takes a list of configurationId as input and starts an asynchronous deletion task to remove the configurationItems. Returns a unique deletion task identifier.

Class StartBatchDeleteConfigurationTaskResponse

This is the response object from the StartBatchDeleteConfigurationTask operation.

Class StartContinuousExportRequest

Container for the parameters to the StartContinuousExport operation. Start the continuous flow of agent's discovered data into Amazon Athena.

Class StartContinuousExportResponse

This is the response object from the StartContinuousExport operation.

Class StartDataCollectionByAgentIdsRequest

Container for the parameters to the StartDataCollectionByAgentIds operation. Instructs the specified agents to start collecting data.

Class StartDataCollectionByAgentIdsResponse

This is the response object from the StartDataCollectionByAgentIds operation.

Class StartExportTaskRequest

Container for the parameters to the StartExportTask operation. Begins 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 based on certain information that you provide. Fee estimates do not include any taxes that might apply. Your actual fees and savings depend on a variety of factors, including your actual usage of Amazon Web Services services, which might vary from the estimates provided in this report.

If you do not specify preferences or agentIds in the filter, a summary of all servers, applications, tags, and performance is generated. This data is an aggregation of all server data collected through on-premises tooling, file import, application grouping and applying tags.

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. Export of detailed agent data is limited to two exports per day.

If you enable ec2RecommendationsPreferences in preferences , an Amazon EC2 instance matching the characteristics of each server in Application Discovery Service is generated. Changing the attributes of the ec2RecommendationsPreferences changes the criteria of the recommendation.

Class StartExportTaskResponse

This is the response object from the StartExportTask operation.

Class StartImportTaskRequest

Container for the parameters to the StartImportTask operation. Starts an import task, which allows you to import details of your on-premises environment directly into Amazon Web Services Migration Hub without having to use the Amazon Web Services Application Discovery Service (Application Discovery Service) tools such as the Amazon Web Services Application Discovery Service Agentless Collector or Application 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 Amazon Web Services CLI or one of the Amazon Web Services SDKs to import the records from your file.

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

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

Class StartImportTaskResponse

This is the response object from the StartImportTask operation.

Class StopContinuousExportRequest

Container for the parameters to the StopContinuousExport operation. Stop the continuous flow of agent's discovered data into Amazon Athena.

Class StopContinuousExportResponse

This is the response object from the StopContinuousExport operation.

Class StopDataCollectionByAgentIdsRequest

Container for the parameters to the StopDataCollectionByAgentIds operation. Instructs the specified agents to stop collecting data.

Class StopDataCollectionByAgentIdsResponse

This is the response object from the StopDataCollectionByAgentIds operation.

Class Tag

Metadata that help you categorize IT assets.

Do not store sensitive information (like personal data) in tags.

Class TagFilter

The tag filter. Valid names are: tagKey, tagValue, configurationId.

Class UpdateApplicationRequest

Container for the parameters to the UpdateApplication operation. Updates metadata about an application.

Class UpdateApplicationResponse

This is the response object from the UpdateApplication operation.

Class UsageMetricBasis

Specifies the performance metrics to use for the server that is used for recommendations.

Interfaces

NameDescription
Interface IApplicationDiscoveryServicePaginatorFactory

Paginators for the ApplicationDiscoveryService service

Interface IDescribeAgentsPaginator

Paginator for the DescribeAgents operation

Interface IDescribeContinuousExportsPaginator

Paginator for the DescribeContinuousExports operation

Interface IDescribeExportConfigurationsPaginator

Paginator for the DescribeExportConfigurations operation

Interface IDescribeExportTasksPaginator

Paginator for the DescribeExportTasks operation

Interface IDescribeImportTasksPaginator

Paginator for the DescribeImportTasks operation

Interface IDescribeTagsPaginator

Paginator for the DescribeTags operation

Interface IListConfigurationsPaginator

Paginator for the ListConfigurations operation