AutoCloseable
@Generated("software.amazon.awssdk:codegen") public interface ApplicationDiscoveryAsyncClient extends AutoCloseable
builder()
method.
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.
Agentless discovery mode is recommended for environments that use VMware vCenter Server. This mode doesn't require you to install an agent on each host. Agentless discovery gathers server information regardless of the operating systems, which minimizes the time required for initial on-premises infrastructure assessment. Agentless discovery doesn't collect information about software and software dependencies. It also doesn't work in non-VMware environments. We recommend that you use agent-based discovery for non-VMware environments and if you want to collect information about software and software dependencies. You can also run agent-based and agentless discovery simultaneously. Use agentless discovery to quickly complete the initial infrastructure assessment and then install agents on select hosts to gather information about software and software dependencies.
Agent-based discovery mode collects a richer set of data than agentless discovery by using Amazon software, the AWS Application Discovery Agent, which you install on one or more hosts in your data center. The agent captures infrastructure and application information, including an inventory of installed software applications, system and process performance, resource utilization, and network dependencies between workloads. The information collected by agents is secured at rest and in transit to the Application Discovery Service database in the cloud.
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 .
Modifier and Type | Method | Description |
---|---|---|
default CompletableFuture<AssociateConfigurationItemsToApplicationResponse> |
associateConfigurationItemsToApplication(AssociateConfigurationItemsToApplicationRequest associateConfigurationItemsToApplicationRequest) |
Associates one or more configuration items with an application.
|
static ApplicationDiscoveryAsyncClientBuilder |
builder() |
Create a builder that can be used to configure and create a
ApplicationDiscoveryAsyncClient . |
static ApplicationDiscoveryAsyncClient |
create() |
Create a
ApplicationDiscoveryAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CompletableFuture<CreateApplicationResponse> |
createApplication(CreateApplicationRequest createApplicationRequest) |
Creates an application with the given name and description.
|
default CompletableFuture<CreateTagsResponse> |
createTags(CreateTagsRequest createTagsRequest) |
Creates one or more tags for configuration items.
|
default CompletableFuture<DeleteApplicationsResponse> |
deleteApplications(DeleteApplicationsRequest deleteApplicationsRequest) |
Deletes a list of applications and their associations with configuration items.
|
default CompletableFuture<DeleteTagsResponse> |
deleteTags(DeleteTagsRequest deleteTagsRequest) |
Deletes the association between configuration items and one or more tags.
|
default CompletableFuture<DescribeAgentsResponse> |
describeAgents(DescribeAgentsRequest 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.
|
default CompletableFuture<DescribeConfigurationsResponse> |
describeConfigurations(DescribeConfigurationsRequest describeConfigurationsRequest) |
Retrieves attributes for a list of configuration item IDs.
|
default CompletableFuture<DescribeExportConfigurationsResponse> |
describeExportConfigurations(DescribeExportConfigurationsRequest describeExportConfigurationsRequest) |
Deprecated.
|
default CompletableFuture<DescribeExportTasksResponse> |
describeExportTasks(DescribeExportTasksRequest describeExportTasksRequest) |
Retrieve status of one or more export tasks.
|
default CompletableFuture<DescribeTagsResponse> |
describeTags(DescribeTagsRequest describeTagsRequest) |
Retrieves a list of configuration items that are tagged with a specific tag.
|
default CompletableFuture<DisassociateConfigurationItemsFromApplicationResponse> |
disassociateConfigurationItemsFromApplication(DisassociateConfigurationItemsFromApplicationRequest disassociateConfigurationItemsFromApplicationRequest) |
Disassociates one or more configuration items from an application.
|
default CompletableFuture<ExportConfigurationsResponse> |
exportConfigurations(ExportConfigurationsRequest exportConfigurationsRequest) |
Deprecated.
|
default CompletableFuture<GetDiscoverySummaryResponse> |
getDiscoverySummary(GetDiscoverySummaryRequest getDiscoverySummaryRequest) |
Retrieves a short summary of discovered assets.
|
default CompletableFuture<ListConfigurationsResponse> |
listConfigurations(ListConfigurationsRequest listConfigurationsRequest) |
Retrieves a list of configuration items according to criteria that you specify in a filter.
|
default CompletableFuture<ListServerNeighborsResponse> |
listServerNeighbors(ListServerNeighborsRequest listServerNeighborsRequest) |
Retrieves a list of servers that are one network hop away from a specified server.
|
default CompletableFuture<StartDataCollectionByAgentIdsResponse> |
startDataCollectionByAgentIds(StartDataCollectionByAgentIdsRequest startDataCollectionByAgentIdsRequest) |
Instructs the specified agents or connectors to start collecting data.
|
default CompletableFuture<StartExportTaskResponse> |
startExportTask(StartExportTaskRequest startExportTaskRequest) |
Export the configuration data about discovered configuration items and relationships to an S3 bucket in a
specified format.
|
default CompletableFuture<StopDataCollectionByAgentIdsResponse> |
stopDataCollectionByAgentIds(StopDataCollectionByAgentIdsRequest stopDataCollectionByAgentIdsRequest) |
Instructs the specified agents or connectors to stop collecting data.
|
default CompletableFuture<UpdateApplicationResponse> |
updateApplication(UpdateApplicationRequest updateApplicationRequest) |
Updates metadata about an application.
|
close
static ApplicationDiscoveryAsyncClient create()
ApplicationDiscoveryAsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static ApplicationDiscoveryAsyncClientBuilder builder()
ApplicationDiscoveryAsyncClient
.default CompletableFuture<AssociateConfigurationItemsToApplicationResponse> associateConfigurationItemsToApplication(AssociateConfigurationItemsToApplicationRequest associateConfigurationItemsToApplicationRequest)
Associates one or more configuration items with an application.
associateConfigurationItemsToApplicationRequest
- default CompletableFuture<CreateApplicationResponse> createApplication(CreateApplicationRequest createApplicationRequest)
Creates an application with the given name and description.
createApplicationRequest
- default CompletableFuture<CreateTagsResponse> createTags(CreateTagsRequest 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.
createTagsRequest
- default CompletableFuture<DeleteApplicationsResponse> deleteApplications(DeleteApplicationsRequest deleteApplicationsRequest)
Deletes a list of applications and their associations with configuration items.
deleteApplicationsRequest
- default CompletableFuture<DeleteTagsResponse> deleteTags(DeleteTagsRequest deleteTagsRequest)
Deletes the association between configuration items and one or more tags. This API accepts a list of multiple configuration items.
deleteTagsRequest
- default CompletableFuture<DescribeAgentsResponse> describeAgents(DescribeAgentsRequest 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.
describeAgentsRequest
- default CompletableFuture<DescribeConfigurationsResponse> describeConfigurations(DescribeConfigurationsRequest 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.
describeConfigurationsRequest
- default CompletableFuture<DescribeExportConfigurationsResponse> describeExportConfigurations(DescribeExportConfigurationsRequest describeExportConfigurationsRequest)
Deprecated. Use DescribeExportTasks
instead.
Retrieves the status of a given export process. You can retrieve status from a maximum of 100 processes.
describeExportConfigurationsRequest
- default CompletableFuture<DescribeExportTasksResponse> describeExportTasks(DescribeExportTasksRequest describeExportTasksRequest)
Retrieve status of one or more export tasks. You can retrieve the status of up to 100 export tasks.
describeExportTasksRequest
- default CompletableFuture<DescribeTagsResponse> describeTags(DescribeTagsRequest 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.
describeTagsRequest
- default CompletableFuture<DisassociateConfigurationItemsFromApplicationResponse> disassociateConfigurationItemsFromApplication(DisassociateConfigurationItemsFromApplicationRequest disassociateConfigurationItemsFromApplicationRequest)
Disassociates one or more configuration items from an application.
disassociateConfigurationItemsFromApplicationRequest
- default CompletableFuture<ExportConfigurationsResponse> exportConfigurations(ExportConfigurationsRequest 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.
exportConfigurationsRequest
- default CompletableFuture<GetDiscoverySummaryResponse> getDiscoverySummary(GetDiscoverySummaryRequest getDiscoverySummaryRequest)
Retrieves a short summary of discovered assets.
getDiscoverySummaryRequest
- default CompletableFuture<ListConfigurationsResponse> listConfigurations(ListConfigurationsRequest listConfigurationsRequest)
Retrieves a list of configuration items according to criteria that you specify in a filter. The filter criteria identifies the relationship requirements.
listConfigurationsRequest
- default CompletableFuture<ListServerNeighborsResponse> listServerNeighbors(ListServerNeighborsRequest listServerNeighborsRequest)
Retrieves a list of servers that are one network hop away from a specified server.
listServerNeighborsRequest
- default CompletableFuture<StartDataCollectionByAgentIdsResponse> startDataCollectionByAgentIds(StartDataCollectionByAgentIdsRequest startDataCollectionByAgentIdsRequest)
Instructs the specified agents or connectors to start collecting data.
startDataCollectionByAgentIdsRequest
- default CompletableFuture<StartExportTaskResponse> startExportTask(StartExportTaskRequest startExportTaskRequest)
Export the configuration data about discovered configuration items and relationships to an S3 bucket in a specified format.
startExportTaskRequest
- default CompletableFuture<StopDataCollectionByAgentIdsResponse> stopDataCollectionByAgentIds(StopDataCollectionByAgentIdsRequest stopDataCollectionByAgentIdsRequest)
Instructs the specified agents or connectors to stop collecting data.
stopDataCollectionByAgentIdsRequest
- default CompletableFuture<UpdateApplicationResponse> updateApplication(UpdateApplicationRequest updateApplicationRequest)
Updates metadata about an application.
updateApplicationRequest
- Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.