com.amazonaws.services.applicationdiscovery

Class AWSApplicationDiscoveryClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.applicationdiscovery.AWSApplicationDiscoveryClient

All Implemented Interfaces:

AWSApplicationDiscovery

Direct Known Subclasses:

AWSApplicationDiscoveryAsyncClient

@ThreadSafe
public class AWSApplicationDiscoveryClient
extends AmazonWebServiceClient
implements AWSApplicationDiscovery

Client for accessing AWS Application Discovery Service. All service calls made using this client are blocking, and will not return until the service call 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.

Field Summary

Fields

Modifier and Type	Field and Description
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Constructor Summary

Constructors

Constructor and Description
AWSApplicationDiscoveryClient() Constructs a new client to invoke service methods on AWS Application Discovery Service.
AWSApplicationDiscoveryClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on AWS Application Discovery Service using the specified AWS account credentials.
AWSApplicationDiscoveryClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWS Application Discovery Service using the specified AWS account credentials and client configuration options.
AWSApplicationDiscoveryClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on AWS Application Discovery Service using the specified AWS account credentials provider.
AWSApplicationDiscoveryClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWS Application Discovery Service using the specified AWS account credentials provider and client configuration options.
AWSApplicationDiscoveryClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Constructs a new client to invoke service methods on AWS Application Discovery Service using the specified AWS account credentials provider, client configuration options, and request metric collector.
AWSApplicationDiscoveryClient(ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWS Application Discovery Service.

Method Summary

Methods

Modifier and Type	Method and Description
CreateTagsResult	createTags(CreateTagsRequest createTagsRequest) Creates one or more tags for configuration items.
DeleteTagsResult	deleteTags(DeleteTagsRequest deleteTagsRequest) Deletes the association between configuration items and one or more tags.
DescribeAgentsResult	describeAgents(DescribeAgentsRequest describeAgentsRequest) Lists AWS agents by ID or lists all agents associated with your user account if you did not specify an agent ID.
DescribeConfigurationsResult	describeConfigurations(DescribeConfigurationsRequest describeConfigurationsRequest) Retrieves a list of attributes for a specific configuration ID.
DescribeExportConfigurationsResult	describeExportConfigurations(DescribeExportConfigurationsRequest describeExportConfigurationsRequest) Retrieves the status of a given export process.
DescribeTagsResult	describeTags(DescribeTagsRequest describeTagsRequest) Retrieves a list of configuration items that are tagged with a specific tag.
ExportConfigurationsResult	exportConfigurations(ExportConfigurationsRequest exportConfigurationsRequest) Exports all discovered configuration data to an Amazon S3 bucket or an application that enables you to view and evaluate the data.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
ListConfigurationsResult	listConfigurations(ListConfigurationsRequest listConfigurationsRequest) Retrieves a list of configurations items according to the criteria you specify in a filter.
StartDataCollectionByAgentIdsResult	startDataCollectionByAgentIds(StartDataCollectionByAgentIdsRequest startDataCollectionByAgentIdsRequest) Instructs the specified agents to start collecting data.
StopDataCollectionByAgentIdsResult	stopDataCollectionByAgentIds(StopDataCollectionByAgentIdsRequest stopDataCollectionByAgentIdsRequest) Instructs the specified agents to stop collecting data.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeMarshalling, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.applicationdiscovery.AWSApplicationDiscovery

setEndpoint, setRegion, shutdown

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Constructor Detail

AWSApplicationDiscoveryClient

public AWSApplicationDiscoveryClient()

Constructs a new client to invoke service methods on AWS Application Discovery Service. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AWSApplicationDiscoveryClient

public AWSApplicationDiscoveryClient(ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AWS Application Discovery Service. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to AWS Application Discovery Service (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AWSApplicationDiscoveryClient

public AWSApplicationDiscoveryClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on AWS Application Discovery Service using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AWSApplicationDiscoveryClient

public AWSApplicationDiscoveryClient(AWSCredentials awsCredentials,
                             ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AWS Application Discovery Service using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AWS Application Discovery Service (ex: proxy settings, retry counts, etc.).

AWSApplicationDiscoveryClient

public AWSApplicationDiscoveryClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on AWS Application Discovery Service using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AWSApplicationDiscoveryClient

public AWSApplicationDiscoveryClient(AWSCredentialsProvider awsCredentialsProvider,
                             ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AWS Application Discovery Service using the specified AWS account credentials provider and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AWS Application Discovery Service (ex: proxy settings, retry counts, etc.).

AWSApplicationDiscoveryClient

public AWSApplicationDiscoveryClient(AWSCredentialsProvider awsCredentialsProvider,
                             ClientConfiguration clientConfiguration,
                             RequestMetricCollector requestMetricCollector)

Constructs a new client to invoke service methods on AWS Application Discovery Service using the specified AWS account credentials provider, client configuration options, and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AWS Application Discovery Service (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

Method Detail

createTags

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

Specified by:

createTags in interface AWSApplicationDiscovery

Parameters:

createTagsRequest -

Returns:

Result of the CreateTags operation returned by the service.

Throws:

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

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

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

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

ServerInternalErrorException - The server experienced an internal error. Try again.

deleteTags

public DeleteTagsResult deleteTags(DeleteTagsRequest deleteTagsRequest)

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

Specified by:

deleteTags in interface AWSApplicationDiscovery

Parameters:

deleteTagsRequest -

Returns:

Result of the DeleteTags operation returned by the service.

Throws:

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

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

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

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

ServerInternalErrorException - The server experienced an internal error. Try again.

describeAgents

public DescribeAgentsResult describeAgents(DescribeAgentsRequest describeAgentsRequest)

Lists AWS agents by ID or lists all agents associated with your user account if you did not specify an agent ID.

Specified by:

describeAgents in interface AWSApplicationDiscovery

Parameters:

describeAgentsRequest -

Returns:

Result of the DescribeAgents operation returned by the service.

Throws:

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

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

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

ServerInternalErrorException - The server experienced an internal error. Try again.

describeConfigurations

public DescribeConfigurationsResult describeConfigurations(DescribeConfigurationsRequest describeConfigurationsRequest)

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.

Specified by:

describeConfigurations in interface AWSApplicationDiscovery

Parameters:

describeConfigurationsRequest -

Returns:

Result of the DescribeConfigurations operation returned by the service.

Throws:

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

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

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

ServerInternalErrorException - The server experienced an internal error. Try again.

describeExportConfigurations

public DescribeExportConfigurationsResult describeExportConfigurations(DescribeExportConfigurationsRequest describeExportConfigurationsRequest)

Retrieves the status of a given export process. You can retrieve status from a maximum of 100 processes.

Specified by:

describeExportConfigurations in interface AWSApplicationDiscovery

Parameters:

describeExportConfigurationsRequest -

Returns:

Result of the DescribeExportConfigurations operation returned by the service.

Throws:

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

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

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

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

ServerInternalErrorException - The server experienced an internal error. Try again.

describeTags

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

Specified by:

describeTags in interface AWSApplicationDiscovery

Parameters:

describeTagsRequest -

Returns:

Result of the DescribeTags operation returned by the service.

Throws:

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

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

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

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

ServerInternalErrorException - The server experienced an internal error. Try again.

exportConfigurations

public ExportConfigurationsResult exportConfigurations(ExportConfigurationsRequest exportConfigurationsRequest)

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 which you can query using the GetExportStatus API. The system imposes a limit of two configuration exports in six hours.

Specified by:

exportConfigurations in interface AWSApplicationDiscovery

Parameters:

exportConfigurationsRequest -

Returns:

Result of the ExportConfigurations operation returned by the service.

Throws:

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

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

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

ServerInternalErrorException - The server experienced an internal error. Try again.

OperationNotPermittedException - This operation is not permitted.

listConfigurations

public ListConfigurationsResult listConfigurations(ListConfigurationsRequest listConfigurationsRequest)

Retrieves a list of configurations items according to the criteria you specify in a filter. The filter criteria identify relationship requirements.

Specified by:

listConfigurations in interface AWSApplicationDiscovery

Parameters:

listConfigurationsRequest -

Returns:

Result of the ListConfigurations operation returned by the service.

Throws:

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

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

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

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

ServerInternalErrorException - The server experienced an internal error. Try again.

startDataCollectionByAgentIds

public StartDataCollectionByAgentIdsResult startDataCollectionByAgentIds(StartDataCollectionByAgentIdsRequest startDataCollectionByAgentIdsRequest)

Instructs the specified agents to start collecting data. Agents can reside on host servers or virtual machines in your data center.

Specified by:

startDataCollectionByAgentIds in interface AWSApplicationDiscovery

Parameters:

startDataCollectionByAgentIdsRequest -

Returns:

Result of the StartDataCollectionByAgentIds operation returned by the service.

Throws:

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

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

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

ServerInternalErrorException - The server experienced an internal error. Try again.

stopDataCollectionByAgentIds

public StopDataCollectionByAgentIdsResult stopDataCollectionByAgentIds(StopDataCollectionByAgentIdsRequest stopDataCollectionByAgentIdsRequest)

Instructs the specified agents to stop collecting data.

Specified by:

stopDataCollectionByAgentIds in interface AWSApplicationDiscovery

Parameters:

stopDataCollectionByAgentIdsRequest -

Returns:

Result of the StopDataCollectionByAgentIds operation returned by the service.

Throws:

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

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

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

ServerInternalErrorException - The server experienced an internal error. Try again.

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AWSApplicationDiscovery

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.