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 or connectors that were instructed to start collecting data. Information includes the agent/connector ID, a description of the operation, and whether the agent/connector configuration was updated.

Class AgentInfo

Information about agents or connectors associated with the user’s AWS account. Information includes agent or connector IDs, IP addresses, media access control (MAC) addresses, agent or connector health, hostname where the agent or connector resides, and agent version for each agent.

Class AgentNetworkInfo

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

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

ApplicationDiscoveryService exception

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.

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.

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

ApplicationDiscoveryService exception

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.

Class CreateTagsResponse

This is the response object from the CreateTags operation.

Class CustomerAgentInfo

Inventory data for installed discovery agents.

Class CustomerConnectorInfo

Inventory data for installed discovery connectors.

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 DescribeAgentsRequest

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

Class DescribeAgentsResponse

This is the response object from the DescribeAgents 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 AWS 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 account 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 DescribeImportTasks, 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 account 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 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 Filter

A filter that can use conditional operators.

For more information about filters, see Querying Discovered Configuration Items in the AWS 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

ApplicationDiscoveryService exception

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

ApplicationDiscoveryService exception

Class InvalidParameterValueException

ApplicationDiscoveryService exception

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

ApplicationDiscoveryService exception

Class OrderByElement

A field and direction for ordered output.

Class ResourceInUseException

ApplicationDiscoveryService exception

Class ResourceNotFoundException

ApplicationDiscoveryService exception

Class ServerInternalErrorException

ApplicationDiscoveryService exception

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

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

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 or connectors to stop collecting data.

Class StopDataCollectionByAgentIdsResponse

This is the response object from the StopDataCollectionByAgentIds operation.

Class Tag

Metadata that help you categorize IT assets.

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.