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

Amazon Web Services Application Discovery Service

Amazon Web Services Application Discovery Service (Application Discovery Service) helps you plan application migration projects. It automatically identifies servers, virtual machines (VMs), and network dependencies in your on-premises data centers. For more information, see the Amazon Web Services Application Discovery Service FAQ.

Application Discovery Service offers three ways of performing discovery and collecting data about your on-premises servers:

• Agentless discovery using Amazon Web Services Application Discovery Service Agentless Collector (Agentless Collector), which doesn't require you to install an agent on each host.

  • Agentless Collector gathers server information regardless of the operating systems, which minimizes the time required for initial on-premises infrastructure assessment.

  • Agentless Collector doesn't collect information about network dependencies, only agent-based discovery collects that information.

• Agent-based discovery using the Amazon Web Services Application Discovery Agent (Application Discovery Agent) collects a richer set of data than agentless discovery, which you install on one or more hosts in your data center.

  • The agent captures infrastructure and application information, including an inventory of running processes, system performance information, resource utilization, and network dependencies.

  • The information collected by agents is secured at rest and in transit to the Application Discovery Service database in the Amazon Web Services cloud. For more information, see Amazon Web Services Application Discovery Agent.

• Amazon Web Services Partner Network (APN) solutions integrate with Application Discovery Service, enabling you to import details of your on-premises environment directly into Amazon Web Services Migration Hub (Migration Hub) without using Agentless Collector or Application Discovery Agent.

  • Third-party application discovery tools can query Amazon Web Services Application Discovery Service, and they can write to the Application Discovery Service database using the public API.

  • In this way, you can import data into Migration Hub and view it, so that you can associate applications with servers and track migrations.

Working With This Guide

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 Amazon Web Services SDKs to access an API that is tailored to the programming language or platform that you're using. For more information, see Amazon Web Services SDKs.

• Remember that you must set your Migration Hub home Region before you call any of these APIs.

• You must make API calls for write actions (create, notify, associate, disassociate, import, or put) while in your home Region, or a HomeRegionNotSetException error is returned.

• API calls for read actions (list, describe, stop, and delete) are permitted outside of your home Region.

• Although it is unlikely, the Migration Hub home Region could change. If you call APIs outside the home Region, an InvalidInputException is returned.

• You must call GetHomeRegion to obtain the latest Migration Hub home Region.

This guide is intended for use with the Amazon Web Services Application Discovery Service User Guide.

All data is handled according to the Amazon Web Services Privacy Policy. You can operate Application Discovery Service offline to inspect collected data before it is shared with the service.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

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

ENDPOINT_PREFIX

Constructor Summary

Constructors

Constructor and Description
AWSApplicationDiscoveryClient() Deprecated. use AWSApplicationDiscoveryClientBuilder.defaultClient()
AWSApplicationDiscoveryClient(AWSCredentials awsCredentials) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AWSApplicationDiscoveryClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
AWSApplicationDiscoveryClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AWSApplicationDiscoveryClient(AWSCredentialsProvider awsCredentialsProvider) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)
AWSApplicationDiscoveryClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AWSApplicationDiscoveryClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
AWSApplicationDiscoveryClient(ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Method Summary

Modifier and Type	Method and Description
AssociateConfigurationItemsToApplicationResult	associateConfigurationItemsToApplication(AssociateConfigurationItemsToApplicationRequest request) Associates one or more configuration items with an application.
BatchDeleteAgentsResult	batchDeleteAgents(BatchDeleteAgentsRequest request) Deletes one or more agents or collectors as specified by ID.
BatchDeleteImportDataResult	batchDeleteImportData(BatchDeleteImportDataRequest request) Deletes one or more import tasks, each identified by their import ID.
static AWSApplicationDiscoveryClientBuilder	builder()
CreateApplicationResult	createApplication(CreateApplicationRequest request) Creates an application with the given name and description.
CreateTagsResult	createTags(CreateTagsRequest request) Creates one or more tags for configuration items.
DeleteApplicationsResult	deleteApplications(DeleteApplicationsRequest request) Deletes a list of applications and their associations with configuration items.
DeleteTagsResult	deleteTags(DeleteTagsRequest request) Deletes the association between configuration items and one or more tags.
DescribeAgentsResult	describeAgents(DescribeAgentsRequest request) Lists agents or collectors as specified by ID or other filters.
DescribeBatchDeleteConfigurationTaskResult	describeBatchDeleteConfigurationTask(DescribeBatchDeleteConfigurationTaskRequest request) Takes a unique deletion task identifier as input and returns metadata about a configuration deletion task.
DescribeConfigurationsResult	describeConfigurations(DescribeConfigurationsRequest request) Retrieves attributes for a list of configuration item IDs.
DescribeContinuousExportsResult	describeContinuousExports(DescribeContinuousExportsRequest request) Lists exports as specified by ID.
DescribeExportConfigurationsResult	describeExportConfigurations(DescribeExportConfigurationsRequest request) Deprecated.
DescribeExportTasksResult	describeExportTasks(DescribeExportTasksRequest request) Retrieve status of one or more export tasks.
DescribeImportTasksResult	describeImportTasks(DescribeImportTasksRequest request) Returns an array of import tasks for your account, including status information, times, IDs, the Amazon S3 Object URL for the import file, and more.
DescribeTagsResult	describeTags(DescribeTagsRequest request) Retrieves a list of configuration items that have tags as specified by the key-value pairs, name and value, passed to the optional parameter filters.
DisassociateConfigurationItemsFromApplicationResult	disassociateConfigurationItemsFromApplication(DisassociateConfigurationItemsFromApplicationRequest request) Disassociates one or more configuration items from an application.
ExportConfigurationsResult	exportConfigurations(ExportConfigurationsRequest request) 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 request) Retrieves a short summary of discovered assets.
ListConfigurationsResult	listConfigurations(ListConfigurationsRequest request) Retrieves a list of configuration items as specified by the value passed to the required parameter configurationType.
ListServerNeighborsResult	listServerNeighbors(ListServerNeighborsRequest request) Retrieves a list of servers that are one network hop away from a specified server.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartBatchDeleteConfigurationTaskResult	startBatchDeleteConfigurationTask(StartBatchDeleteConfigurationTaskRequest request) Takes a list of configurationId as input and starts an asynchronous deletion task to remove the configurationItems.
StartContinuousExportResult	startContinuousExport(StartContinuousExportRequest request) Start the continuous flow of agent's discovered data into Amazon Athena.
StartDataCollectionByAgentIdsResult	startDataCollectionByAgentIds(StartDataCollectionByAgentIdsRequest request) Instructs the specified agents to start collecting data.
StartExportTaskResult	startExportTask(StartExportTaskRequest request) Begins the export of a discovered data report to an Amazon S3 bucket managed by Amazon Web Services.
StartImportTaskResult	startImportTask(StartImportTaskRequest request) Starts an import task, which allows you to import details of your on-premises environment directly into Amazon Web Services Migration Hub without having to use the Amazon Web Services Application Discovery Service (Application Discovery Service) tools such as the Amazon Web Services Application Discovery Service Agentless Collector or Application Discovery Agent.
StopContinuousExportResult	stopContinuousExport(StopContinuousExportRequest request) Stop the continuous flow of agent's discovered data into Amazon Athena.
StopDataCollectionByAgentIdsResult	stopDataCollectionByAgentIds(StopDataCollectionByAgentIdsRequest request) Instructs the specified agents to stop collecting data.
UpdateApplicationResult	updateApplication(UpdateApplicationRequest request) Updates metadata about an application.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

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

setEndpoint, setRegion

Constructor Detail

AWSApplicationDiscoveryClient

@Deprecated
public AWSApplicationDiscoveryClient()

Deprecated. use AWSApplicationDiscoveryClientBuilder.defaultClient()

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

@Deprecated
public AWSApplicationDiscoveryClient(ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withClientConfiguration(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

@Deprecated
public AWSApplicationDiscoveryClient(AWSCredentials awsCredentials)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AWSApplicationDiscoveryClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();

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

@Deprecated
public AWSApplicationDiscoveryClient(AWSCredentials awsCredentials,
                                                 ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(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

@Deprecated
public AWSApplicationDiscoveryClient(AWSCredentialsProvider awsCredentialsProvider)

Deprecated. use AwsClientBuilder.withCredentials(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

@Deprecated
public AWSApplicationDiscoveryClient(AWSCredentialsProvider awsCredentialsProvider,
                                                 ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(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

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

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(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

builder

public static AWSApplicationDiscoveryClientBuilder builder()

associateConfigurationItemsToApplication

public AssociateConfigurationItemsToApplicationResult associateConfigurationItemsToApplication(AssociateConfigurationItemsToApplicationRequest request)

Associates one or more configuration items with an application.

Specified by:

associateConfigurationItemsToApplication in interface AWSApplicationDiscovery

Parameters:

associateConfigurationItemsToApplicationRequest -

Returns:

Result of the AssociateConfigurationItemsToApplication operation returned by the service.

Throws:

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

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.

HomeRegionNotSetException - The home Region is not set. Set the home Region to continue.

batchDeleteAgents

public BatchDeleteAgentsResult batchDeleteAgents(BatchDeleteAgentsRequest request)

Deletes one or more agents or collectors as specified by ID. Deleting an agent or collector does not delete the previously discovered data. To delete the data collected, use StartBatchDeleteConfigurationTask.

Specified by:

batchDeleteAgents in interface AWSApplicationDiscovery

Parameters:

batchDeleteAgentsRequest -

Returns:

Result of the BatchDeleteAgents operation returned by the service.

Throws:

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

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.

batchDeleteImportData

public BatchDeleteImportDataResult batchDeleteImportData(BatchDeleteImportDataRequest request)

Deletes one or more import tasks, each identified by their import ID. Each import task has a number of records that can identify servers or applications.

Amazon Web Services Application Discovery Service has built-in matching logic that will identify when discovered servers match existing entries that you've previously discovered, the information for the already-existing discovered server is updated. When you delete an import task that contains records that were used to match, the information in those matched records that comes from the deleted records will also be deleted.

Specified by:

batchDeleteImportData in interface AWSApplicationDiscovery

Parameters:

batchDeleteImportDataRequest -

Returns:

Result of the BatchDeleteImportData operation returned by the service.

Throws:

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

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.

HomeRegionNotSetException - The home Region is not set. Set the home Region to continue.

createApplication

public CreateApplicationResult createApplication(CreateApplicationRequest request)

Creates an application with the given name and description.

Specified by:

createApplication in interface AWSApplicationDiscovery

Parameters:

createApplicationRequest -

Returns:

Result of the CreateApplication operation returned by the service.

Throws:

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

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.

HomeRegionNotSetException - The home Region is not set. Set the home Region to continue.

createTags

public CreateTagsResult createTags(CreateTagsRequest request)

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.

Do not store sensitive information (like personal data) in tags.

Specified by:

createTags in interface AWSApplicationDiscovery

Parameters:

createTagsRequest -

Returns:

Result of the CreateTags operation returned by the service.

Throws:

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

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.

HomeRegionNotSetException - The home Region is not set. Set the home Region to continue.

deleteApplications

public DeleteApplicationsResult deleteApplications(DeleteApplicationsRequest request)

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

Specified by:

deleteApplications in interface AWSApplicationDiscovery

Parameters:

deleteApplicationsRequest -

Returns:

Result of the DeleteApplications operation returned by the service.

Throws:

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

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.

HomeRegionNotSetException - The home Region is not set. Set the home Region to continue.

deleteTags

public DeleteTagsResult deleteTags(DeleteTagsRequest request)

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 user does not have permission to perform the action. Check the IAM policy associated with this user.

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.

HomeRegionNotSetException - The home Region is not set. Set the home Region to continue.

describeAgents

public DescribeAgentsResult describeAgents(DescribeAgentsRequest request)

Lists agents or collectors as specified by ID or other filters. All agents/collectors associated with your user can be listed if you call DescribeAgents as is without passing any parameters.

Specified by:

describeAgents in interface AWSApplicationDiscovery

Parameters:

describeAgentsRequest -

Returns:

Result of the DescribeAgents operation returned by the service.

Throws:

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

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.

HomeRegionNotSetException - The home Region is not set. Set the home Region to continue.

describeBatchDeleteConfigurationTask

public DescribeBatchDeleteConfigurationTaskResult describeBatchDeleteConfigurationTask(DescribeBatchDeleteConfigurationTaskRequest request)

Takes a unique deletion task identifier as input and returns metadata about a configuration deletion task.

Specified by:

describeBatchDeleteConfigurationTask in interface AWSApplicationDiscovery

Parameters:

describeBatchDeleteConfigurationTaskRequest -

Returns:

Result of the DescribeBatchDeleteConfigurationTask operation returned by the service.

Throws:

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

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.

HomeRegionNotSetException - The home Region is not set. Set the home Region to continue.

describeConfigurations

public DescribeConfigurationsResult describeConfigurations(DescribeConfigurationsRequest request)

Retrieves attributes for a list of configuration item IDs.

All of the supplied IDs must be for the same asset type from one of the following:

• server

• application

• process

• connection

Output fields are specific to the asset type specified. For example, the output for a server configuration item includes a list of attributes about the server, such as host name, operating system, number of network cards, etc.

For a complete list of outputs for each asset type, see Using the DescribeConfigurations Action in the Amazon Web Services Application Discovery Service User Guide.

Specified by:

describeConfigurations in interface AWSApplicationDiscovery

Parameters:

describeConfigurationsRequest -

Returns:

Result of the DescribeConfigurations operation returned by the service.

Throws:

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

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.

HomeRegionNotSetException - The home Region is not set. Set the home Region to continue.

describeContinuousExports

public DescribeContinuousExportsResult describeContinuousExports(DescribeContinuousExportsRequest request)

Lists exports as specified by ID. All continuous exports associated with your user can be listed if you call DescribeContinuousExports as is without passing any parameters.

Specified by:

describeContinuousExports in interface AWSApplicationDiscovery

Parameters:

describeContinuousExportsRequest -

Returns:

Result of the DescribeContinuousExports operation returned by the service.

Throws:

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

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.

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

HomeRegionNotSetException - The home Region is not set. Set the home Region to continue.

describeExportConfigurations

@Deprecated
public DescribeExportConfigurationsResult describeExportConfigurations(DescribeExportConfigurationsRequest request)

Deprecated.

DescribeExportConfigurations is deprecated. Use DescribeExportTasks, instead.

Specified by:

describeExportConfigurations in interface AWSApplicationDiscovery

Parameters:

describeExportConfigurationsRequest -

Returns:

Result of the DescribeExportConfigurations operation returned by the service.

Throws:

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

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.

HomeRegionNotSetException - The home Region is not set. Set the home Region to continue.

describeExportTasks

public DescribeExportTasksResult describeExportTasks(DescribeExportTasksRequest request)

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

Specified by:

describeExportTasks in interface AWSApplicationDiscovery

Parameters:

describeExportTasksRequest -

Returns:

Result of the DescribeExportTasks operation returned by the service.

Throws:

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

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.

HomeRegionNotSetException - The home Region is not set. Set the home Region to continue.

describeImportTasks

public DescribeImportTasksResult describeImportTasks(DescribeImportTasksRequest request)

Returns an array of import tasks for your account, including status information, times, IDs, the Amazon S3 Object URL for the import file, and more.

Specified by:

describeImportTasks in interface AWSApplicationDiscovery

Parameters:

describeImportTasksRequest -

Returns:

Result of the DescribeImportTasks operation returned by the service.

Throws:

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

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.

HomeRegionNotSetException - The home Region is not set. Set the home Region to continue.

describeTags

public DescribeTagsResult describeTags(DescribeTagsRequest request)

Retrieves a list of configuration items that have tags as specified by the key-value pairs, name and value, passed to the optional parameter filters.

There are three valid tag filter names:

• tagKey

• tagValue

• configurationId

Also, all configuration items associated with your user that have tags can be listed if you call DescribeTags as is without passing any parameters.

Specified by:

describeTags in interface AWSApplicationDiscovery

Parameters:

describeTagsRequest -

Returns:

Result of the DescribeTags operation returned by the service.

Throws:

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

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.

HomeRegionNotSetException - The home Region is not set. Set the home Region to continue.

disassociateConfigurationItemsFromApplication

public DisassociateConfigurationItemsFromApplicationResult disassociateConfigurationItemsFromApplication(DisassociateConfigurationItemsFromApplicationRequest request)

Disassociates one or more configuration items from an application.

Specified by:

disassociateConfigurationItemsFromApplication in interface AWSApplicationDiscovery

Parameters:

disassociateConfigurationItemsFromApplicationRequest -

Returns:

Result of the DisassociateConfigurationItemsFromApplication operation returned by the service.

Throws:

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

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.

HomeRegionNotSetException - The home Region is not set. Set the home Region to continue.

exportConfigurations

@Deprecated
public ExportConfigurationsResult exportConfigurations(ExportConfigurationsRequest request)

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.

Specified by:

exportConfigurations in interface AWSApplicationDiscovery

Parameters:

exportConfigurationsRequest -

Returns:

Result of the ExportConfigurations operation returned by the service.

Throws:

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

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.

HomeRegionNotSetException - The home Region is not set. Set the home Region to continue.

getDiscoverySummary

public GetDiscoverySummaryResult getDiscoverySummary(GetDiscoverySummaryRequest request)

Retrieves a short summary of discovered assets.

This API operation takes no request parameters and is called as is at the command prompt as shown in the example.

Specified by:

getDiscoverySummary in interface AWSApplicationDiscovery

Parameters:

getDiscoverySummaryRequest -

Returns:

Result of the GetDiscoverySummary operation returned by the service.

Throws:

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

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.

HomeRegionNotSetException - The home Region is not set. Set the home Region to continue.

listConfigurations

public ListConfigurationsResult listConfigurations(ListConfigurationsRequest request)

Retrieves a list of configuration items as specified by the value passed to the required parameter configurationType. Optional filtering may be applied to refine search results.

Specified by:

listConfigurations in interface AWSApplicationDiscovery

Parameters:

listConfigurationsRequest -

Returns:

Result of the ListConfigurations operation returned by the service.

Throws:

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

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.

HomeRegionNotSetException - The home Region is not set. Set the home Region to continue.

listServerNeighbors

public ListServerNeighborsResult listServerNeighbors(ListServerNeighborsRequest request)

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

Specified by:

listServerNeighbors in interface AWSApplicationDiscovery

Parameters:

listServerNeighborsRequest -

Returns:

Result of the ListServerNeighbors operation returned by the service.

Throws:

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

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.

HomeRegionNotSetException - The home Region is not set. Set the home Region to continue.

startBatchDeleteConfigurationTask

public StartBatchDeleteConfigurationTaskResult startBatchDeleteConfigurationTask(StartBatchDeleteConfigurationTaskRequest request)

Takes a list of configurationId as input and starts an asynchronous deletion task to remove the configurationItems. Returns a unique deletion task identifier.

Specified by:

startBatchDeleteConfigurationTask in interface AWSApplicationDiscovery

Parameters:

startBatchDeleteConfigurationTaskRequest -

Returns:

Result of the StartBatchDeleteConfigurationTask operation returned by the service.

Throws:

LimitExceededException - The limit of 200 configuration IDs per request has been exceeded.

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

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

HomeRegionNotSetException - The home Region is not set. Set the home Region to continue.

OperationNotPermittedException - This operation is not permitted.

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

startContinuousExport

public StartContinuousExportResult startContinuousExport(StartContinuousExportRequest request)

Start the continuous flow of agent's discovered data into Amazon Athena.

Specified by:

startContinuousExport in interface AWSApplicationDiscovery

Parameters:

startContinuousExportRequest -

Returns:

Result of the StartContinuousExport operation returned by the service.

Throws:

ConflictErrorException - Conflict error.

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

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.

ResourceInUseException - This issue occurs when the same clientRequestToken is used with the StartImportTask action, but with different parameters. For example, you use the same request token but have two different import URLs, you can encounter this issue. If the import tasks are meant to be different, use a different clientRequestToken, and try again.

HomeRegionNotSetException - The home Region is not set. Set the home Region to continue.

startDataCollectionByAgentIds

public StartDataCollectionByAgentIdsResult startDataCollectionByAgentIds(StartDataCollectionByAgentIdsRequest request)

Instructs the specified agents to start collecting data.

Specified by:

startDataCollectionByAgentIds in interface AWSApplicationDiscovery

Parameters:

startDataCollectionByAgentIdsRequest -

Returns:

Result of the StartDataCollectionByAgentIds operation returned by the service.

Throws:

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

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.

HomeRegionNotSetException - The home Region is not set. Set the home Region to continue.

startExportTask

public StartExportTaskResult startExportTask(StartExportTaskRequest request)

Begins the export of a discovered data report to an Amazon S3 bucket managed by Amazon Web Services.

Exports might provide an estimate of fees and savings based on certain information that you provide. Fee estimates do not include any taxes that might apply. Your actual fees and savings depend on a variety of factors, including your actual usage of Amazon Web Services services, which might vary from the estimates provided in this report.

If you do not specify preferences or agentIds in the filter, a summary of all servers, applications, tags, and performance is generated. This data is an aggregation of all server data collected through on-premises tooling, file import, application grouping and applying tags.

If you specify agentIds 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. Export of detailed agent data is limited to two exports per day.

If you enable ec2RecommendationsPreferences in preferences , an Amazon EC2 instance matching the characteristics of each server in Application Discovery Service is generated. Changing the attributes of the ec2RecommendationsPreferences changes the criteria of the recommendation.

Specified by:

startExportTask in interface AWSApplicationDiscovery

Parameters:

startExportTaskRequest -

Returns:

Result of the StartExportTask operation returned by the service.

Throws:

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

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.

HomeRegionNotSetException - The home Region is not set. Set the home Region to continue.

startImportTask

public StartImportTaskResult startImportTask(StartImportTaskRequest request)

Starts an import task, which allows you to import details of your on-premises environment directly into Amazon Web Services Migration Hub without having to use the Amazon Web Services Application Discovery Service (Application Discovery Service) tools such as the Amazon Web Services Application Discovery Service Agentless Collector or Application Discovery Agent. This gives you the option to perform migration assessment and planning directly from your imported data, including the ability to group your devices as applications and track their migration status.

To start an import request, do this:

1. Download the specially formatted comma separated value (CSV) import template, which you can find here: https://s3.us-west-2.amazonaws.com/templates-7cffcf56-bd96-4b1c-b45b-a5b42f282e46/import_template.csv.

2. Fill out the template with your server and application data.

3. Upload your import file to an Amazon S3 bucket, and make a note of it's Object URL. Your import file must be in the CSV format.

4. Use the console or the StartImportTask command with the Amazon Web Services CLI or one of the Amazon Web Services SDKs to import the records from your file.

For more information, including step-by-step procedures, see Migration Hub Import in the Amazon Web Services Application Discovery Service User Guide.

There are limits to the number of import tasks you can create (and delete) in an Amazon Web Services account. For more information, see Amazon Web Services Application Discovery Service Limits in the Amazon Web Services Application Discovery Service User Guide.

Specified by:

startImportTask in interface AWSApplicationDiscovery

Parameters:

startImportTaskRequest -

Returns:

Result of the StartImportTask operation returned by the service.

Throws:

ResourceInUseException - This issue occurs when the same clientRequestToken is used with the StartImportTask action, but with different parameters. For example, you use the same request token but have two different import URLs, you can encounter this issue. If the import tasks are meant to be different, use a different clientRequestToken, and try again.

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

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.

HomeRegionNotSetException - The home Region is not set. Set the home Region to continue.

stopContinuousExport

public StopContinuousExportResult stopContinuousExport(StopContinuousExportRequest request)

Stop the continuous flow of agent's discovered data into Amazon Athena.

Specified by:

stopContinuousExport in interface AWSApplicationDiscovery

Parameters:

stopContinuousExportRequest -

Returns:

Result of the StopContinuousExport operation returned by the service.

Throws:

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

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.

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

ResourceInUseException - This issue occurs when the same clientRequestToken is used with the StartImportTask action, but with different parameters. For example, you use the same request token but have two different import URLs, you can encounter this issue. If the import tasks are meant to be different, use a different clientRequestToken, and try again.

HomeRegionNotSetException - The home Region is not set. Set the home Region to continue.

stopDataCollectionByAgentIds

public StopDataCollectionByAgentIdsResult stopDataCollectionByAgentIds(StopDataCollectionByAgentIdsRequest request)

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 user does not have permission to perform the action. Check the IAM policy associated with this user.

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.

HomeRegionNotSetException - The home Region is not set. Set the home Region to continue.

updateApplication

public UpdateApplicationResult updateApplication(UpdateApplicationRequest request)

Updates metadata about an application.

Specified by:

updateApplication in interface AWSApplicationDiscovery

Parameters:

updateApplicationRequest -

Returns:

Result of the UpdateApplication operation returned by the service.

Throws:

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

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.

HomeRegionNotSetException - The home Region is not set. Set the home Region to continue.

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.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSApplicationDiscovery

Overrides:

shutdown in class AmazonWebServiceClient