com.amazonaws.services.applicationdiscovery

Interface AWSApplicationDiscovery

All Known Subinterfaces:

AWSApplicationDiscoveryAsync

All Known Implementing Classes:

AbstractAWSApplicationDiscovery, AbstractAWSApplicationDiscoveryAsync, AWSApplicationDiscoveryAsyncClient, AWSApplicationDiscoveryClient

public interface AWSApplicationDiscovery

Interface for accessing AWS Application Discovery Service.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSApplicationDiscovery instead.

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
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

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.
void	setEndpoint(String endpoint) Overrides the default endpoint for this client ("https://discovery.us-west-2.amazonaws.com").
void	setRegion(Region region) An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartDataCollectionByAgentIdsResult	startDataCollectionByAgentIds(StartDataCollectionByAgentIdsRequest startDataCollectionByAgentIdsRequest) Instructs the specified agents to start collecting data.
StopDataCollectionByAgentIdsResult	stopDataCollectionByAgentIds(StopDataCollectionByAgentIdsRequest stopDataCollectionByAgentIdsRequest) Instructs the specified agents to stop collecting data.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

setEndpoint

void setEndpoint(String endpoint)

Overrides the default endpoint for this client ("https://discovery.us-west-2.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "discovery.us-west-2.amazonaws.com") or a full URL, including the protocol (ex: "https://discovery.us-west-2.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

endpoint - The endpoint (ex: "discovery.us-west-2.amazonaws.com") or a full URL, including the protocol (ex: "https://discovery.us-west-2.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

setRegion

void setRegion(Region region)

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)

createTags

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.

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

DeleteTagsResult deleteTags(DeleteTagsRequest deleteTagsRequest)

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

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

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.

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

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.

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

DescribeExportConfigurationsResult describeExportConfigurations(DescribeExportConfigurationsRequest describeExportConfigurationsRequest)

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

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

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.

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

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.

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

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.

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

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.

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

StopDataCollectionByAgentIdsResult stopDataCollectionByAgentIds(StopDataCollectionByAgentIdsRequest stopDataCollectionByAgentIdsRequest)

Instructs the specified agents to stop collecting data.

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.

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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

Parameters:

request - The originally executed request.

Returns:

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