@ThreadSafe public class AWSApplicationDiscoveryAsyncClient extends AWSApplicationDiscoveryClient implements AWSApplicationDiscoveryAsync
AsyncHandler can be
used to receive notification when an asynchronous operation completes.
The AWS Application Discovery Service helps Systems Integrators quickly and reliably plan application migration projects by automatically identifying applications running in on-premises data centers, their associated dependencies, and their performance profile.
Planning data center migrations can involve thousands of workloads that are often deeply interdependent. Application discovery and dependency mapping are important early first steps in the migration process, but difficult to perform at scale due to the lack of automated tools.
The AWS Application Discovery Service automatically collects configuration and usage data from servers to develop a list of applications, how they perform, and how they are interdependent. This information is securely retained in an AWS Application Discovery Service database which you can export as a CSV file into your preferred visualization tool or cloud migration solution to help reduce the complexity and time in planning your cloud migration.
The Application Discovery Service is currently available for preview. Only customers who are engaged with AWS Professional Services or a certified AWS partner can use the service. To see the list of certified partners and request access to the Application Discovery Service, complete the following preview form.
This API reference provides descriptions, syntax, and usage examples for each of the actions and data types for the 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 Discovery Service User Guide .
The following are short descriptions of each API action, organized by function.
Managing AWS Agents Using the Application Discovery Service
An AWS agent is software that you install on on-premises servers and virtual machines that are targeted for discovery and migration. Agents run on Linux and Windows Server and collect server configuration and activity information about your applications and infrastructure. Specifically, agents collect the following information and send it to the Application Discovery Service using Secure Sockets Layer (SSL) encryption:
User information (user name, home directory)
Group information (name)
List of installed packages
List of kernel modules
All create and stop process events
DNS queries
NIC information
TCP/UDP process listening ports
TCPV4/V6 connections
Operating system information
System performance
Process performance
The Application Discovery Service API includes the following actions to manage AWS agents:
StartDataCollectionByAgentIds: Instructs the specified agents to start collecting data. The Application Discovery Service takes several minutes to receive and process data after you initiate data collection.
StopDataCollectionByAgentIds: Instructs the specified agents to stop collecting data.
DescribeAgents: Lists AWS agents by ID or lists all agents associated with your user account if you did not specify an agent ID. The output includes agent IDs, IP addresses, media access control (MAC) addresses, agent health, host name where the agent resides, and the version number of each agent.
Querying Configuration Items
A configuration item is an IT asset that was discovered in your data center by an AWS agent. When you use the Application Discovery Service, you can specify filters and query specific configuration items. The service supports Server, Process, and Connection configuration items. This means you can specify a value for the following keys and query your IT assets:
Server
server.HostName
server.osName
server.osVersion
server.configurationId
server.agentId
Process
process.name
process.CommandLine
process.configurationId
server.hostName
server.osName
server.osVersion
server.configurationId
server.agentId
Connection
connection.sourceIp
connection.sourcePort
connection.destinationIp
connection.destinationPort
sourceProcess.configurationId
sourceProcess.commandLine
sourceProcess.name
destinationProcessId.configurationId
destinationProcess.commandLine
destinationProcess.name
sourceServer.configurationId
sourceServer.hostName
sourceServer.osName
sourceServer.osVersion
destinationServer.configurationId
destinationServer.hostName
destinationServer.osName
destinationServer.osVersion
The Application Discovery Service includes the following actions for querying configuration items.
DescribeConfigurations: Retrieves a list of attributes for a specific configuration ID. For example, the output for a server configuration item includes a list of attributes about the server, including host name, operating system, number of network cards, etc.
ListConfigurations: Retrieves a list of configuration items according to the criteria you specify in a filter. The filter criteria identify relationship requirements. For example, you can specify filter criteria of process.name with values of nginx and apache.
Tagging Discovered Configuration Items
You can tag discovered configuration items. Tags are metadata that help you
categorize IT assets in your data center. Tags use a key-value
format. For example, {"key": "serverType", "value": "webServer"}
.
CreateTags: Creates one or more tags for a configuration items.
DescribeTags: 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.
DeleteTags: Deletes the association between a configuration item and one or more tags.
Exporting Data
You can export data as a CSV file to an Amazon S3 bucket or into your preferred visualization tool or cloud migration solution to help reduce the complexity and time in planning your cloud migration.
ExportConfigurations: Exports all discovered configuration data to an Amazon S3 bucket. Data includes tags and tag associations, processes, connections, servers, and system performance. This API returns an export ID which you can query using the GetExportStatus API.
DescribeExportConfigurations: Gets the status of the data export. When the export is complete, the service returns an Amazon S3 URL where you can download CSV files that include the data.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Constructor and Description |
|---|
AWSApplicationDiscoveryAsyncClient()
Constructs a new asynchronous client to invoke service methods on AWS
Application Discovery Service.
|
AWSApplicationDiscoveryAsyncClient(AWSCredentials awsCredentials)
Constructs a new asynchronous client to invoke service methods on AWS
Application Discovery Service using the specified AWS account
credentials.
|
AWSApplicationDiscoveryAsyncClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AWS
Application Discovery Service using the specified AWS account
credentials, executor service, and client configuration options.
|
AWSApplicationDiscoveryAsyncClient(AWSCredentials awsCredentials,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AWS
Application Discovery Service using the specified AWS account credentials
and executor service.
|
AWSApplicationDiscoveryAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new asynchronous client to invoke service methods on AWS
Application Discovery Service using the specified AWS account credentials
provider.
|
AWSApplicationDiscoveryAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new asynchronous client to invoke service methods on AWS
Application Discovery Service using the provided AWS account credentials
provider and client configuration options.
|
AWSApplicationDiscoveryAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AWS
Application Discovery Service using the specified AWS account credentials
provider, executor service, and client configuration options.
|
AWSApplicationDiscoveryAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AWS
Application Discovery Service using the specified AWS account credentials
provider and executor service.
|
AWSApplicationDiscoveryAsyncClient(ClientConfiguration clientConfiguration)
Constructs a new asynchronous client to invoke service methods on AWS
Application Discovery Service.
|
createTags, deleteTags, describeAgents, describeConfigurations, describeExportConfigurations, describeTags, exportConfigurations, getCachedResponseMetadata, listConfigurations, startDataCollectionByAgentIds, stopDataCollectionByAgentIdsaddRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcreateTags, deleteTags, describeAgents, describeConfigurations, describeExportConfigurations, describeTags, exportConfigurations, getCachedResponseMetadata, listConfigurations, setEndpoint, setRegion, startDataCollectionByAgentIds, stopDataCollectionByAgentIdspublic AWSApplicationDiscoveryAsyncClient()
Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
public AWSApplicationDiscoveryAsyncClient(ClientConfiguration clientConfiguration)
Asynchronous methods are delegated to a fixed-size thread pool containing
a number of threads equal to the maximum number of concurrent connections
configured via ClientConfiguration.getMaxConnections().
clientConfiguration - The client configuration options controlling how this client
connects to AWS Application Discovery Service (ex: proxy settings,
retry counts, etc).DefaultAWSCredentialsProviderChain,
Executors.newFixedThreadPool(int)public AWSApplicationDiscoveryAsyncClient(AWSCredentials awsCredentials)
Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
awsCredentials - The AWS credentials (access key ID and secret key) to use when
authenticating with AWS services.Executors.newFixedThreadPool(int)public AWSApplicationDiscoveryAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
awsCredentials - The AWS credentials (access key ID and secret key) to use when
authenticating with AWS services.executorService - The executor service by which all asynchronous requests will be
executed.public AWSApplicationDiscoveryAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
awsCredentials - The AWS credentials (access key ID and secret key) to use when
authenticating with AWS services.clientConfiguration - Client configuration options (ex: max retry limit, proxy settings,
etc).executorService - The executor service by which all asynchronous requests will be
executed.public AWSApplicationDiscoveryAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
awsCredentialsProvider - The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.Executors.newFixedThreadPool(int)public AWSApplicationDiscoveryAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
Asynchronous methods are delegated to a fixed-size thread pool containing
a number of threads equal to the maximum number of concurrent connections
configured via ClientConfiguration.getMaxConnections().
awsCredentialsProvider - The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.clientConfiguration - Client configuration options (ex: max retry limit, proxy settings,
etc).DefaultAWSCredentialsProviderChain,
Executors.newFixedThreadPool(int)public AWSApplicationDiscoveryAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
awsCredentialsProvider - The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.executorService - The executor service by which all asynchronous requests will be
executed.public AWSApplicationDiscoveryAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)
awsCredentialsProvider - The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.clientConfiguration - Client configuration options (ex: max retry limit, proxy settings,
etc).executorService - The executor service by which all asynchronous requests will be
executed.public ExecutorService getExecutorService()
public Future<CreateTagsResult> createTagsAsync(CreateTagsRequest request)
AWSApplicationDiscoveryAsyncCreates 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.
createTagsAsync in interface AWSApplicationDiscoveryAsyncpublic Future<CreateTagsResult> createTagsAsync(CreateTagsRequest request, AsyncHandler<CreateTagsRequest,CreateTagsResult> asyncHandler)
AWSApplicationDiscoveryAsyncCreates 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.
createTagsAsync in interface AWSApplicationDiscoveryAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteTagsResult> deleteTagsAsync(DeleteTagsRequest request)
AWSApplicationDiscoveryAsyncDeletes the association between configuration items and one or more tags. This API accepts a list of multiple configuration items.
deleteTagsAsync in interface AWSApplicationDiscoveryAsyncpublic Future<DeleteTagsResult> deleteTagsAsync(DeleteTagsRequest request, AsyncHandler<DeleteTagsRequest,DeleteTagsResult> asyncHandler)
AWSApplicationDiscoveryAsyncDeletes the association between configuration items and one or more tags. This API accepts a list of multiple configuration items.
deleteTagsAsync in interface AWSApplicationDiscoveryAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeAgentsResult> describeAgentsAsync(DescribeAgentsRequest request)
AWSApplicationDiscoveryAsyncLists AWS agents by ID or lists all agents associated with your user account if you did not specify an agent ID.
describeAgentsAsync in interface AWSApplicationDiscoveryAsyncpublic Future<DescribeAgentsResult> describeAgentsAsync(DescribeAgentsRequest request, AsyncHandler<DescribeAgentsRequest,DescribeAgentsResult> asyncHandler)
AWSApplicationDiscoveryAsyncLists AWS agents by ID or lists all agents associated with your user account if you did not specify an agent ID.
describeAgentsAsync in interface AWSApplicationDiscoveryAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeConfigurationsResult> describeConfigurationsAsync(DescribeConfigurationsRequest request)
AWSApplicationDiscoveryAsyncRetrieves a list of attributes for a specific configuration ID. For example, the output for a server configuration item includes a list of attributes about the server, including host name, operating system, number of network cards, etc.
describeConfigurationsAsync in interface AWSApplicationDiscoveryAsyncpublic Future<DescribeConfigurationsResult> describeConfigurationsAsync(DescribeConfigurationsRequest request, AsyncHandler<DescribeConfigurationsRequest,DescribeConfigurationsResult> asyncHandler)
AWSApplicationDiscoveryAsyncRetrieves a list of attributes for a specific configuration ID. For example, the output for a server configuration item includes a list of attributes about the server, including host name, operating system, number of network cards, etc.
describeConfigurationsAsync in interface AWSApplicationDiscoveryAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeExportConfigurationsResult> describeExportConfigurationsAsync(DescribeExportConfigurationsRequest request)
AWSApplicationDiscoveryAsyncRetrieves the status of a given export process. You can retrieve status from a maximum of 100 processes.
describeExportConfigurationsAsync in interface AWSApplicationDiscoveryAsyncpublic Future<DescribeExportConfigurationsResult> describeExportConfigurationsAsync(DescribeExportConfigurationsRequest request, AsyncHandler<DescribeExportConfigurationsRequest,DescribeExportConfigurationsResult> asyncHandler)
AWSApplicationDiscoveryAsyncRetrieves the status of a given export process. You can retrieve status from a maximum of 100 processes.
describeExportConfigurationsAsync in interface AWSApplicationDiscoveryAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeTagsResult> describeTagsAsync(DescribeTagsRequest request)
AWSApplicationDiscoveryAsyncRetrieves 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.
describeTagsAsync in interface AWSApplicationDiscoveryAsyncpublic Future<DescribeTagsResult> describeTagsAsync(DescribeTagsRequest request, AsyncHandler<DescribeTagsRequest,DescribeTagsResult> asyncHandler)
AWSApplicationDiscoveryAsyncRetrieves 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.
describeTagsAsync in interface AWSApplicationDiscoveryAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ExportConfigurationsResult> exportConfigurationsAsync(ExportConfigurationsRequest request)
AWSApplicationDiscoveryAsyncExports 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 which you can query using the GetExportStatus API. The system imposes a limit of two configuration exports in six hours.
exportConfigurationsAsync in interface AWSApplicationDiscoveryAsyncpublic Future<ExportConfigurationsResult> exportConfigurationsAsync(ExportConfigurationsRequest request, AsyncHandler<ExportConfigurationsRequest,ExportConfigurationsResult> asyncHandler)
AWSApplicationDiscoveryAsyncExports 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 which you can query using the GetExportStatus API. The system imposes a limit of two configuration exports in six hours.
exportConfigurationsAsync in interface AWSApplicationDiscoveryAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListConfigurationsResult> listConfigurationsAsync(ListConfigurationsRequest request)
AWSApplicationDiscoveryAsyncRetrieves a list of configurations items according to the criteria you specify in a filter. The filter criteria identify relationship requirements.
listConfigurationsAsync in interface AWSApplicationDiscoveryAsyncpublic Future<ListConfigurationsResult> listConfigurationsAsync(ListConfigurationsRequest request, AsyncHandler<ListConfigurationsRequest,ListConfigurationsResult> asyncHandler)
AWSApplicationDiscoveryAsyncRetrieves a list of configurations items according to the criteria you specify in a filter. The filter criteria identify relationship requirements.
listConfigurationsAsync in interface AWSApplicationDiscoveryAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<StartDataCollectionByAgentIdsResult> startDataCollectionByAgentIdsAsync(StartDataCollectionByAgentIdsRequest request)
AWSApplicationDiscoveryAsyncInstructs the specified agents to start collecting data. Agents can reside on host servers or virtual machines in your data center.
startDataCollectionByAgentIdsAsync in interface AWSApplicationDiscoveryAsyncpublic Future<StartDataCollectionByAgentIdsResult> startDataCollectionByAgentIdsAsync(StartDataCollectionByAgentIdsRequest request, AsyncHandler<StartDataCollectionByAgentIdsRequest,StartDataCollectionByAgentIdsResult> asyncHandler)
AWSApplicationDiscoveryAsyncInstructs the specified agents to start collecting data. Agents can reside on host servers or virtual machines in your data center.
startDataCollectionByAgentIdsAsync in interface AWSApplicationDiscoveryAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<StopDataCollectionByAgentIdsResult> stopDataCollectionByAgentIdsAsync(StopDataCollectionByAgentIdsRequest request)
AWSApplicationDiscoveryAsyncInstructs the specified agents to stop collecting data.
stopDataCollectionByAgentIdsAsync in interface AWSApplicationDiscoveryAsyncpublic Future<StopDataCollectionByAgentIdsResult> stopDataCollectionByAgentIdsAsync(StopDataCollectionByAgentIdsRequest request, AsyncHandler<StopDataCollectionByAgentIdsRequest,StopDataCollectionByAgentIdsResult> asyncHandler)
AWSApplicationDiscoveryAsyncInstructs the specified agents to stop collecting data.
stopDataCollectionByAgentIdsAsync in interface AWSApplicationDiscoveryAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public void shutdown()
getExecutorService().shutdown() followed by
getExecutorService().awaitTermination() prior to calling this
method.shutdown in interface AWSApplicationDiscoveryshutdown in class AmazonWebServiceClientCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.