applicationdiscoveryservice/aws.sdk.kotlin.services.applicationdiscoveryservice/ApplicationDiscoveryClient

ApplicationDiscoveryClient

interface ApplicationDiscoveryClient : SdkClient

Amazon Web Services Application Discovery Service

Amazon Web Services Application Discovery Service (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 Amazon Web Services Application Discovery Service FAQ.

Application Discovery Service offers three ways of performing discovery and collecting data about your on-premises servers:

Agentless discovery using Amazon Web Services Application Discovery Service Agentless Collector (Agentless Collector), which doesn't require you to install an agent on each host.

Agentless Collector gathers server information regardless of the operating systems, which minimizes the time required for initial on-premises infrastructure assessment.
Agentless Collector doesn't collect information about network dependencies, only agent-based discovery collects that information.

Agent-based discovery using the Amazon Web Services Application Discovery Agent (Application Discovery Agent) collects a richer set of data than agentless discovery, which you install on one or more hosts in your data center.

The agent captures infrastructure and application information, including an inventory of running processes, system performance information, resource utilization, and network dependencies.
The information collected by agents is secured at rest and in transit to the Application Discovery Service database in the Amazon Web Services cloud. For more information, see Amazon Web Services Application Discovery Agent.

Amazon Web Services Partner Network (APN) solutions integrate with Application Discovery Service, enabling you to import details of your on-premises environment directly into Amazon Web Services Migration Hub (Migration Hub) without using Agentless Collector or Application Discovery Agent.

Third-party application discovery tools can query Amazon Web Services Application Discovery Service, and they can write to the Application Discovery Service database using the public API.
In this way, you can import data into Migration Hub and view it, so that you can associate applications with servers and track migrations.

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 Amazon Web Services SDKs to access an API that is tailored to the programming language or platform that you're using. For more information, see Amazon Web Services 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 Amazon Web Services Application Discovery Service User Guide.

All data is handled according to the Amazon Web Services Privacy Policy. You can operate Application Discovery Service offline to inspect collected data before it is shared with the service.

Types

Builder

class Builder : AbstractSdkClientBuilder<ApplicationDiscoveryClient.Config, ApplicationDiscoveryClient.Config.Builder, ApplicationDiscoveryClient>

Companion

object Companion : AbstractAwsSdkClientFactory<ApplicationDiscoveryClient.Config, ApplicationDiscoveryClient.Config.Builder, ApplicationDiscoveryClient, ApplicationDiscoveryClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, IdempotencyTokenConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

config

abstract override val config: ApplicationDiscoveryClient.Config

ApplicationDiscoveryClient's configuration

Functions

associateConfigurationItemsToApplication

abstract suspend fun associateConfigurationItemsToApplication(input: AssociateConfigurationItemsToApplicationRequest): AssociateConfigurationItemsToApplicationResponse

Associates one or more configuration items with an application.

batchDeleteAgents

abstract suspend fun batchDeleteAgents(input: BatchDeleteAgentsRequest): BatchDeleteAgentsResponse

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.

batchDeleteImportData

abstract suspend fun batchDeleteImportData(input: BatchDeleteImportDataRequest): BatchDeleteImportDataResponse

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.

createApplication

abstract suspend fun createApplication(input: CreateApplicationRequest): CreateApplicationResponse

Creates an application with the given name and description.

createTags

abstract suspend fun createTags(input: CreateTagsRequest): CreateTagsResponse

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.

deleteApplications

abstract suspend fun deleteApplications(input: DeleteApplicationsRequest): DeleteApplicationsResponse

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

deleteTags

abstract suspend fun deleteTags(input: DeleteTagsRequest): DeleteTagsResponse

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

describeAgents

abstract suspend fun describeAgents(input: DescribeAgentsRequest = DescribeAgentsRequest { }): DescribeAgentsResponse

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.

describeBatchDeleteConfigurationTask

abstract suspend fun describeBatchDeleteConfigurationTask(input: DescribeBatchDeleteConfigurationTaskRequest): DescribeBatchDeleteConfigurationTaskResponse

Takes a unique deletion task identifier as input and returns metadata about a configuration deletion task.

describeConfigurations

abstract suspend fun describeConfigurations(input: DescribeConfigurationsRequest): DescribeConfigurationsResponse

Retrieves attributes for a list of configuration item IDs.

describeContinuousExports

abstract suspend fun describeContinuousExports(input: DescribeContinuousExportsRequest = DescribeContinuousExportsRequest { }): DescribeContinuousExportsResponse

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.

describeExportConfigurations

abstract suspend fun ~~describeExportConfigurations~~(input: DescribeExportConfigurationsRequest = DescribeExportConfigurationsRequest { }): DescribeExportConfigurationsResponse

DescribeExportConfigurations is deprecated. Use DescribeExportTasks, instead.

describeExportTasks

abstract suspend fun describeExportTasks(input: DescribeExportTasksRequest = DescribeExportTasksRequest { }): DescribeExportTasksResponse

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

describeImportTasks

abstract suspend fun describeImportTasks(input: DescribeImportTasksRequest = DescribeImportTasksRequest { }): DescribeImportTasksResponse

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.

describeTags

abstract suspend fun describeTags(input: DescribeTagsRequest = DescribeTagsRequest { }): DescribeTagsResponse

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.

disassociateConfigurationItemsFromApplication

abstract suspend fun disassociateConfigurationItemsFromApplication(input: DisassociateConfigurationItemsFromApplicationRequest): DisassociateConfigurationItemsFromApplicationResponse

Disassociates one or more configuration items from an application.

exportConfigurations

abstract suspend fun ~~exportConfigurations~~(input: ExportConfigurationsRequest = ExportConfigurationsRequest { }): ExportConfigurationsResponse

Deprecated. Use StartExportTask instead.

getDiscoverySummary

abstract suspend fun getDiscoverySummary(input: GetDiscoverySummaryRequest = GetDiscoverySummaryRequest { }): GetDiscoverySummaryResponse

Retrieves a short summary of discovered assets.

listConfigurations

abstract suspend fun listConfigurations(input: ListConfigurationsRequest): ListConfigurationsResponse

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.

listServerNeighbors

abstract suspend fun listServerNeighbors(input: ListServerNeighborsRequest): ListServerNeighborsResponse

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

startBatchDeleteConfigurationTask

abstract suspend fun startBatchDeleteConfigurationTask(input: StartBatchDeleteConfigurationTaskRequest): StartBatchDeleteConfigurationTaskResponse

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

startContinuousExport

abstract suspend fun startContinuousExport(input: StartContinuousExportRequest = StartContinuousExportRequest { }): StartContinuousExportResponse

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

startDataCollectionByAgentIds

abstract suspend fun startDataCollectionByAgentIds(input: StartDataCollectionByAgentIdsRequest): StartDataCollectionByAgentIdsResponse

Instructs the specified agents to start collecting data.

startExportTask

abstract suspend fun startExportTask(input: StartExportTaskRequest = StartExportTaskRequest { }): StartExportTaskResponse

Begins the export of a discovered data report to an Amazon S3 bucket managed by Amazon Web Services.

startImportTask

abstract suspend fun startImportTask(input: StartImportTaskRequest): StartImportTaskResponse

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.

stopContinuousExport

abstract suspend fun stopContinuousExport(input: StopContinuousExportRequest): StopContinuousExportResponse

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

stopDataCollectionByAgentIds

abstract suspend fun stopDataCollectionByAgentIds(input: StopDataCollectionByAgentIdsRequest): StopDataCollectionByAgentIdsResponse

Instructs the specified agents to stop collecting data.

updateApplication

abstract suspend fun updateApplication(input: UpdateApplicationRequest): UpdateApplicationResponse

Updates metadata about an application.

Inherited functions

associateConfigurationItemsToApplication

inline suspend fun ApplicationDiscoveryClient.associateConfigurationItemsToApplication(crossinline block: AssociateConfigurationItemsToApplicationRequest.Builder.() -> Unit): AssociateConfigurationItemsToApplicationResponse

Associates one or more configuration items with an application.

batchDeleteAgents

inline suspend fun ApplicationDiscoveryClient.batchDeleteAgents(crossinline block: BatchDeleteAgentsRequest.Builder.() -> Unit): BatchDeleteAgentsResponse

batchDeleteImportData

inline suspend fun ApplicationDiscoveryClient.batchDeleteImportData(crossinline block: BatchDeleteImportDataRequest.Builder.() -> Unit): BatchDeleteImportDataResponse

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.

expect abstract fun close()

createApplication

inline suspend fun ApplicationDiscoveryClient.createApplication(crossinline block: CreateApplicationRequest.Builder.() -> Unit): CreateApplicationResponse

Creates an application with the given name and description.

createTags

inline suspend fun ApplicationDiscoveryClient.createTags(crossinline block: CreateTagsRequest.Builder.() -> Unit): CreateTagsResponse

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.

deleteApplications

inline suspend fun ApplicationDiscoveryClient.deleteApplications(crossinline block: DeleteApplicationsRequest.Builder.() -> Unit): DeleteApplicationsResponse

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

deleteTags

inline suspend fun ApplicationDiscoveryClient.deleteTags(crossinline block: DeleteTagsRequest.Builder.() -> Unit): DeleteTagsResponse

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

describeAgents

inline suspend fun ApplicationDiscoveryClient.describeAgents(crossinline block: DescribeAgentsRequest.Builder.() -> Unit): DescribeAgentsResponse

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.

describeAgentsPaginated

fun ApplicationDiscoveryClient.describeAgentsPaginated(initialRequest: DescribeAgentsRequest = DescribeAgentsRequest { }): Flow<DescribeAgentsResponse>

fun ApplicationDiscoveryClient.describeAgentsPaginated(block: DescribeAgentsRequest.Builder.() -> Unit): Flow<DescribeAgentsResponse>

Paginate over DescribeAgentsResponse results.

describeBatchDeleteConfigurationTask

inline suspend fun ApplicationDiscoveryClient.describeBatchDeleteConfigurationTask(crossinline block: DescribeBatchDeleteConfigurationTaskRequest.Builder.() -> Unit): DescribeBatchDeleteConfigurationTaskResponse

Takes a unique deletion task identifier as input and returns metadata about a configuration deletion task.

describeConfigurations

inline suspend fun ApplicationDiscoveryClient.describeConfigurations(crossinline block: DescribeConfigurationsRequest.Builder.() -> Unit): DescribeConfigurationsResponse

Retrieves attributes for a list of configuration item IDs.

describeContinuousExports

inline suspend fun ApplicationDiscoveryClient.describeContinuousExports(crossinline block: DescribeContinuousExportsRequest.Builder.() -> Unit): DescribeContinuousExportsResponse

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.

describeContinuousExportsPaginated

fun ApplicationDiscoveryClient.describeContinuousExportsPaginated(initialRequest: DescribeContinuousExportsRequest = DescribeContinuousExportsRequest { }): Flow<DescribeContinuousExportsResponse>

fun ApplicationDiscoveryClient.describeContinuousExportsPaginated(block: DescribeContinuousExportsRequest.Builder.() -> Unit): Flow<DescribeContinuousExportsResponse>

Paginate over DescribeContinuousExportsResponse results.

describeExportConfigurations

inline suspend fun ApplicationDiscoveryClient.~~describeExportConfigurations~~(crossinline block: DescribeExportConfigurationsRequest.Builder.() -> Unit): DescribeExportConfigurationsResponse

DescribeExportConfigurations is deprecated. Use DescribeExportTasks, instead.

describeExportConfigurationsPaginated

fun ApplicationDiscoveryClient.describeExportConfigurationsPaginated(initialRequest: DescribeExportConfigurationsRequest = DescribeExportConfigurationsRequest { }): Flow<DescribeExportConfigurationsResponse>

fun ApplicationDiscoveryClient.describeExportConfigurationsPaginated(block: DescribeExportConfigurationsRequest.Builder.() -> Unit): Flow<DescribeExportConfigurationsResponse>

Paginate over DescribeExportConfigurationsResponse results.

describeExportTasks

inline suspend fun ApplicationDiscoveryClient.describeExportTasks(crossinline block: DescribeExportTasksRequest.Builder.() -> Unit): DescribeExportTasksResponse

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

describeExportTasksPaginated

fun ApplicationDiscoveryClient.describeExportTasksPaginated(initialRequest: DescribeExportTasksRequest = DescribeExportTasksRequest { }): Flow<DescribeExportTasksResponse>

fun ApplicationDiscoveryClient.describeExportTasksPaginated(block: DescribeExportTasksRequest.Builder.() -> Unit): Flow<DescribeExportTasksResponse>

Paginate over DescribeExportTasksResponse results.

describeImportTasks

inline suspend fun ApplicationDiscoveryClient.describeImportTasks(crossinline block: DescribeImportTasksRequest.Builder.() -> Unit): DescribeImportTasksResponse

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.

describeImportTasksPaginated

fun ApplicationDiscoveryClient.describeImportTasksPaginated(initialRequest: DescribeImportTasksRequest = DescribeImportTasksRequest { }): Flow<DescribeImportTasksResponse>

fun ApplicationDiscoveryClient.describeImportTasksPaginated(block: DescribeImportTasksRequest.Builder.() -> Unit): Flow<DescribeImportTasksResponse>

Paginate over DescribeImportTasksResponse results.

describeTags

inline suspend fun ApplicationDiscoveryClient.describeTags(crossinline block: DescribeTagsRequest.Builder.() -> Unit): DescribeTagsResponse

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.

describeTagsPaginated

fun ApplicationDiscoveryClient.describeTagsPaginated(initialRequest: DescribeTagsRequest = DescribeTagsRequest { }): Flow<DescribeTagsResponse>

fun ApplicationDiscoveryClient.describeTagsPaginated(block: DescribeTagsRequest.Builder.() -> Unit): Flow<DescribeTagsResponse>

Paginate over DescribeTagsResponse results.

disassociateConfigurationItemsFromApplication

inline suspend fun ApplicationDiscoveryClient.disassociateConfigurationItemsFromApplication(crossinline block: DisassociateConfigurationItemsFromApplicationRequest.Builder.() -> Unit): DisassociateConfigurationItemsFromApplicationResponse

Disassociates one or more configuration items from an application.

exportConfigurations

inline suspend fun ApplicationDiscoveryClient.~~exportConfigurations~~(crossinline block: ExportConfigurationsRequest.Builder.() -> Unit): ExportConfigurationsResponse

Deprecated. Use StartExportTask instead.

getDiscoverySummary

inline suspend fun ApplicationDiscoveryClient.getDiscoverySummary(crossinline block: GetDiscoverySummaryRequest.Builder.() -> Unit): GetDiscoverySummaryResponse

Retrieves a short summary of discovered assets.

listConfigurations

inline suspend fun ApplicationDiscoveryClient.listConfigurations(crossinline block: ListConfigurationsRequest.Builder.() -> Unit): ListConfigurationsResponse

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.

listConfigurationsPaginated

fun ApplicationDiscoveryClient.listConfigurationsPaginated(initialRequest: ListConfigurationsRequest): Flow<ListConfigurationsResponse>

fun ApplicationDiscoveryClient.listConfigurationsPaginated(block: ListConfigurationsRequest.Builder.() -> Unit): Flow<ListConfigurationsResponse>

Paginate over ListConfigurationsResponse results.

listServerNeighbors

inline suspend fun ApplicationDiscoveryClient.listServerNeighbors(crossinline block: ListServerNeighborsRequest.Builder.() -> Unit): ListServerNeighborsResponse

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

startBatchDeleteConfigurationTask

inline suspend fun ApplicationDiscoveryClient.startBatchDeleteConfigurationTask(crossinline block: StartBatchDeleteConfigurationTaskRequest.Builder.() -> Unit): StartBatchDeleteConfigurationTaskResponse

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

startContinuousExport

inline suspend fun ApplicationDiscoveryClient.startContinuousExport(crossinline block: StartContinuousExportRequest.Builder.() -> Unit): StartContinuousExportResponse

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

startDataCollectionByAgentIds

inline suspend fun ApplicationDiscoveryClient.startDataCollectionByAgentIds(crossinline block: StartDataCollectionByAgentIdsRequest.Builder.() -> Unit): StartDataCollectionByAgentIdsResponse

Instructs the specified agents to start collecting data.

startExportTask

inline suspend fun ApplicationDiscoveryClient.startExportTask(crossinline block: StartExportTaskRequest.Builder.() -> Unit): StartExportTaskResponse

Begins the export of a discovered data report to an Amazon S3 bucket managed by Amazon Web Services.

startImportTask

inline suspend fun ApplicationDiscoveryClient.startImportTask(crossinline block: StartImportTaskRequest.Builder.() -> Unit): StartImportTaskResponse

stopContinuousExport

inline suspend fun ApplicationDiscoveryClient.stopContinuousExport(crossinline block: StopContinuousExportRequest.Builder.() -> Unit): StopContinuousExportResponse

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

stopDataCollectionByAgentIds

inline suspend fun ApplicationDiscoveryClient.stopDataCollectionByAgentIds(crossinline block: StopDataCollectionByAgentIdsRequest.Builder.() -> Unit): StopDataCollectionByAgentIdsResponse

Instructs the specified agents to stop collecting data.

updateApplication

inline suspend fun ApplicationDiscoveryClient.updateApplication(crossinline block: UpdateApplicationRequest.Builder.() -> Unit): UpdateApplicationResponse

Updates metadata about an application.

withConfig

fun ApplicationDiscoveryClient.withConfig(block: ApplicationDiscoveryClient.Config.Builder.() -> Unit): ApplicationDiscoveryClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.