com.amazonaws.services.applicationdiscovery

Interface AWSApplicationDiscovery

All Known Subinterfaces:

AWSApplicationDiscoveryAsync

All Known Implementing Classes:

AbstractAWSApplicationDiscovery, AbstractAWSApplicationDiscoveryAsync, AWSApplicationDiscoveryAsyncClient, AWSApplicationDiscoveryClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
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.

AWS Application Discovery Service

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 .

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
AssociateConfigurationItemsToApplicationResult	associateConfigurationItemsToApplication(AssociateConfigurationItemsToApplicationRequest associateConfigurationItemsToApplicationRequest) Associates one or more configuration items with an application.
CreateApplicationResult	createApplication(CreateApplicationRequest createApplicationRequest) Creates an application with the given name and description.
CreateTagsResult	createTags(CreateTagsRequest createTagsRequest) Creates one or more tags for configuration items.
DeleteApplicationsResult	deleteApplications(DeleteApplicationsRequest deleteApplicationsRequest) Deletes a list of applications and their associations with configuration items.
DeleteTagsResult	deleteTags(DeleteTagsRequest deleteTagsRequest) Deletes the association between configuration items and one or more tags.
DescribeAgentsResult	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.
DescribeConfigurationsResult	describeConfigurations(DescribeConfigurationsRequest describeConfigurationsRequest) Retrieves attributes for a list of configuration item IDs.
DescribeExportConfigurationsResult	describeExportConfigurations(DescribeExportConfigurationsRequest describeExportConfigurationsRequest) Deprecated.
DescribeExportTasksResult	describeExportTasks(DescribeExportTasksRequest describeExportTasksRequest) Retrieve status of one or more export tasks.
DescribeTagsResult	describeTags(DescribeTagsRequest describeTagsRequest) Retrieves a list of configuration items that are tagged with a specific tag.
DisassociateConfigurationItemsFromApplicationResult	disassociateConfigurationItemsFromApplication(DisassociateConfigurationItemsFromApplicationRequest disassociateConfigurationItemsFromApplicationRequest) Disassociates one or more configuration items from an application.
ExportConfigurationsResult	exportConfigurations(ExportConfigurationsRequest exportConfigurationsRequest) Deprecated.
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.
GetDiscoverySummaryResult	getDiscoverySummary(GetDiscoverySummaryRequest getDiscoverySummaryRequest) Retrieves a short summary of discovered assets.
ListConfigurationsResult	listConfigurations(ListConfigurationsRequest listConfigurationsRequest) Retrieves a list of configuration items according to criteria that you specify in a filter.
ListServerNeighborsResult	listServerNeighbors(ListServerNeighborsRequest listServerNeighborsRequest) Retrieves a list of servers that are one network hop away from a specified server.
void	setEndpoint(String endpoint) Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
void	setRegion(Region region) Deprecated. use AwsClientBuilder#setRegion(String)
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartDataCollectionByAgentIdsResult	startDataCollectionByAgentIds(StartDataCollectionByAgentIdsRequest startDataCollectionByAgentIdsRequest) Instructs the specified agents or connectors to start collecting data.
StartExportTaskResult	startExportTask(StartExportTaskRequest startExportTaskRequest) Begins the export of discovered data to an S3 bucket.
StopDataCollectionByAgentIdsResult	stopDataCollectionByAgentIds(StopDataCollectionByAgentIdsRequest stopDataCollectionByAgentIdsRequest) Instructs the specified agents or connectors to stop collecting data.
UpdateApplicationResult	updateApplication(UpdateApplicationRequest updateApplicationRequest) Updates metadata about an application.

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

@Deprecated
void setEndpoint(String endpoint)

Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));

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

@Deprecated
void setRegion(Region region)

Deprecated. use AwsClientBuilder#setRegion(String)

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)

associateConfigurationItemsToApplication

AssociateConfigurationItemsToApplicationResult associateConfigurationItemsToApplication(AssociateConfigurationItemsToApplicationRequest associateConfigurationItemsToApplicationRequest)

Associates one or more configuration items with an application.

Parameters:

associateConfigurationItemsToApplicationRequest -

Returns:

Result of the AssociateConfigurationItemsToApplication 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.

createApplication

CreateApplicationResult createApplication(CreateApplicationRequest createApplicationRequest)

Creates an application with the given name and description.

Parameters:

createApplicationRequest -

Returns:

Result of the CreateApplication 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.

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.

deleteApplications

DeleteApplicationsResult deleteApplications(DeleteApplicationsRequest deleteApplicationsRequest)

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

Parameters:

deleteApplicationsRequest -

Returns:

Result of the DeleteApplications 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.

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 agents or the Connector by ID or lists all agents/Connectors associated with your user account if you did not specify an 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 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.

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

@Deprecated
DescribeExportConfigurationsResult describeExportConfigurations(DescribeExportConfigurationsRequest describeExportConfigurationsRequest)

Deprecated.

Deprecated. Use DescribeExportTasks instead.

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.

describeExportTasks

DescribeExportTasksResult describeExportTasks(DescribeExportTasksRequest describeExportTasksRequest)

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

Parameters:

describeExportTasksRequest -

Returns:

Result of the DescribeExportTasks 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.

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.

disassociateConfigurationItemsFromApplication

DisassociateConfigurationItemsFromApplicationResult disassociateConfigurationItemsFromApplication(DisassociateConfigurationItemsFromApplicationRequest disassociateConfigurationItemsFromApplicationRequest)

Disassociates one or more configuration items from an application.

Parameters:

disassociateConfigurationItemsFromApplicationRequest -

Returns:

Result of the DisassociateConfigurationItemsFromApplication 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.

exportConfigurations

@Deprecated
ExportConfigurationsResult exportConfigurations(ExportConfigurationsRequest exportConfigurationsRequest)

Deprecated.

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.

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.

getDiscoverySummary

GetDiscoverySummaryResult getDiscoverySummary(GetDiscoverySummaryRequest getDiscoverySummaryRequest)

Retrieves a short summary of discovered assets.

Parameters:

getDiscoverySummaryRequest -

Returns:

Result of the GetDiscoverySummary 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.

listConfigurations

ListConfigurationsResult 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.

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.

listServerNeighbors

ListServerNeighborsResult listServerNeighbors(ListServerNeighborsRequest listServerNeighborsRequest)

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

Parameters:

listServerNeighborsRequest -

Returns:

Result of the ListServerNeighbors 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.

startDataCollectionByAgentIds

StartDataCollectionByAgentIdsResult startDataCollectionByAgentIds(StartDataCollectionByAgentIdsRequest startDataCollectionByAgentIdsRequest)

Instructs the specified agents or connectors to start collecting data.

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.

startExportTask

StartExportTaskResult startExportTask(StartExportTaskRequest startExportTaskRequest)

Begins the export of discovered data to an S3 bucket.

If you specify agentId in a filter, the task exports up to 72 hours of detailed data collected by the identified Application Discovery Agent, including network, process, and performance details. A time range for exported agent data may be set by using startTime and endTime. Export of detailed agent data is limited to five concurrently running exports.

If you do not include an agentId filter, summary data is exported that includes both AWS Agentless Discovery Connector data and summary data from AWS Discovery Agents. Export of summary data is limited to two exports per day.

Parameters:

startExportTaskRequest -

Returns:

Result of the StartExportTask 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.

stopDataCollectionByAgentIds

StopDataCollectionByAgentIdsResult stopDataCollectionByAgentIds(StopDataCollectionByAgentIdsRequest stopDataCollectionByAgentIdsRequest)

Instructs the specified agents or connectors 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.

updateApplication

UpdateApplicationResult updateApplication(UpdateApplicationRequest updateApplicationRequest)

Updates metadata about an application.

Parameters:

updateApplicationRequest -

Returns:

Result of the UpdateApplication 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.