@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSApplicationDiscovery
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSApplicationDiscovery instead.
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
AssociateConfigurationItemsToApplicationResult |
associateConfigurationItemsToApplication(AssociateConfigurationItemsToApplicationRequest associateConfigurationItemsToApplicationRequest)
Associates one or more configuration items with an application.
|
BatchDeleteAgentsResult |
batchDeleteAgents(BatchDeleteAgentsRequest batchDeleteAgentsRequest)
Deletes one or more agents or collectors as specified by ID.
|
BatchDeleteImportDataResult |
batchDeleteImportData(BatchDeleteImportDataRequest batchDeleteImportDataRequest)
Deletes one or more import tasks, each identified by their import ID.
|
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 collectors as specified by ID or other filters.
|
DescribeBatchDeleteConfigurationTaskResult |
describeBatchDeleteConfigurationTask(DescribeBatchDeleteConfigurationTaskRequest describeBatchDeleteConfigurationTaskRequest)
Takes a unique deletion task identifier as input and returns metadata about a configuration deletion task.
|
DescribeConfigurationsResult |
describeConfigurations(DescribeConfigurationsRequest describeConfigurationsRequest)
Retrieves attributes for a list of configuration item IDs.
|
DescribeContinuousExportsResult |
describeContinuousExports(DescribeContinuousExportsRequest describeContinuousExportsRequest)
Lists exports as specified by ID.
|
DescribeExportConfigurationsResult |
describeExportConfigurations(DescribeExportConfigurationsRequest describeExportConfigurationsRequest)
Deprecated.
|
DescribeExportTasksResult |
describeExportTasks(DescribeExportTasksRequest describeExportTasksRequest)
Retrieve status of one or more export tasks.
|
DescribeImportTasksResult |
describeImportTasks(DescribeImportTasksRequest describeImportTasksRequest)
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 describeTagsRequest)
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 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 as specified by the value passed to the required parameter
configurationType. |
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.
|
StartBatchDeleteConfigurationTaskResult |
startBatchDeleteConfigurationTask(StartBatchDeleteConfigurationTaskRequest startBatchDeleteConfigurationTaskRequest)
Takes a list of configurationId as input and starts an asynchronous deletion task to remove the
configurationItems.
|
StartContinuousExportResult |
startContinuousExport(StartContinuousExportRequest startContinuousExportRequest)
Start the continuous flow of agent's discovered data into Amazon Athena.
|
StartDataCollectionByAgentIdsResult |
startDataCollectionByAgentIds(StartDataCollectionByAgentIdsRequest startDataCollectionByAgentIdsRequest)
Instructs the specified agents to start collecting data.
|
StartExportTaskResult |
startExportTask(StartExportTaskRequest startExportTaskRequest)
Begins the export of a discovered data report to an Amazon S3 bucket managed by Amazon Web Services.
|
StartImportTaskResult |
startImportTask(StartImportTaskRequest startImportTaskRequest)
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 stopContinuousExportRequest)
Stop the continuous flow of agent's discovered data into Amazon Athena.
|
StopDataCollectionByAgentIdsResult |
stopDataCollectionByAgentIds(StopDataCollectionByAgentIdsRequest stopDataCollectionByAgentIdsRequest)
Instructs the specified agents to stop collecting data.
|
UpdateApplicationResult |
updateApplication(UpdateApplicationRequest updateApplicationRequest)
Updates metadata about an application.
|
static final String ENDPOINT_PREFIX
@Deprecated void setEndpoint(String endpoint)
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
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: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
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.
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.@Deprecated void setRegion(Region region)
AwsClientBuilder#setRegion(String)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.
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.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)AssociateConfigurationItemsToApplicationResult associateConfigurationItemsToApplication(AssociateConfigurationItemsToApplicationRequest associateConfigurationItemsToApplicationRequest)
Associates one or more configuration items with an application.
associateConfigurationItemsToApplicationRequest - 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.BatchDeleteAgentsResult batchDeleteAgents(BatchDeleteAgentsRequest batchDeleteAgentsRequest)
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.
batchDeleteAgentsRequest - 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.BatchDeleteImportDataResult batchDeleteImportData(BatchDeleteImportDataRequest batchDeleteImportDataRequest)
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.
batchDeleteImportDataRequest - 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.CreateApplicationResult createApplication(CreateApplicationRequest createApplicationRequest)
Creates an application with the given name and description.
createApplicationRequest - 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.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.
Do not store sensitive information (like personal data) in tags.
createTagsRequest - 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.DeleteApplicationsResult deleteApplications(DeleteApplicationsRequest deleteApplicationsRequest)
Deletes a list of applications and their associations with configuration items.
deleteApplicationsRequest - 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.DeleteTagsResult deleteTags(DeleteTagsRequest deleteTagsRequest)
Deletes the association between configuration items and one or more tags. This API accepts a list of multiple configuration items.
deleteTagsRequest - 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.DescribeAgentsResult describeAgents(DescribeAgentsRequest describeAgentsRequest)
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.
describeAgentsRequest - 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.DescribeBatchDeleteConfigurationTaskResult describeBatchDeleteConfigurationTask(DescribeBatchDeleteConfigurationTaskRequest describeBatchDeleteConfigurationTaskRequest)
Takes a unique deletion task identifier as input and returns metadata about a configuration deletion task.
describeBatchDeleteConfigurationTaskRequest - 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.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 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.
describeConfigurationsRequest - 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.DescribeContinuousExportsResult describeContinuousExports(DescribeContinuousExportsRequest describeContinuousExportsRequest)
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.
describeContinuousExportsRequest - 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.@Deprecated DescribeExportConfigurationsResult describeExportConfigurations(DescribeExportConfigurationsRequest describeExportConfigurationsRequest)
DescribeExportConfigurations is deprecated. Use DescribeExportTasks, instead.
describeExportConfigurationsRequest - 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.DescribeExportTasksResult describeExportTasks(DescribeExportTasksRequest describeExportTasksRequest)
Retrieve status of one or more export tasks. You can retrieve the status of up to 100 export tasks.
describeExportTasksRequest - 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.DescribeImportTasksResult describeImportTasks(DescribeImportTasksRequest describeImportTasksRequest)
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.
describeImportTasksRequest - 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.DescribeTagsResult describeTags(DescribeTagsRequest describeTagsRequest)
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.
describeTagsRequest - 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.DisassociateConfigurationItemsFromApplicationResult disassociateConfigurationItemsFromApplication(DisassociateConfigurationItemsFromApplicationRequest disassociateConfigurationItemsFromApplicationRequest)
Disassociates one or more configuration items from an application.
disassociateConfigurationItemsFromApplicationRequest - 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.@Deprecated ExportConfigurationsResult exportConfigurations(ExportConfigurationsRequest exportConfigurationsRequest)
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.
exportConfigurationsRequest - 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.GetDiscoverySummaryResult getDiscoverySummary(GetDiscoverySummaryRequest getDiscoverySummaryRequest)
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.
getDiscoverySummaryRequest - 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.ListConfigurationsResult listConfigurations(ListConfigurationsRequest listConfigurationsRequest)
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.
listConfigurationsRequest - 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.ListServerNeighborsResult listServerNeighbors(ListServerNeighborsRequest listServerNeighborsRequest)
Retrieves a list of servers that are one network hop away from a specified server.
listServerNeighborsRequest - 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.StartBatchDeleteConfigurationTaskResult startBatchDeleteConfigurationTask(StartBatchDeleteConfigurationTaskRequest startBatchDeleteConfigurationTaskRequest)
Takes a list of configurationId as input and starts an asynchronous deletion task to remove the configurationItems. Returns a unique deletion task identifier.
startBatchDeleteConfigurationTaskRequest - 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.StartContinuousExportResult startContinuousExport(StartContinuousExportRequest startContinuousExportRequest)
Start the continuous flow of agent's discovered data into Amazon Athena.
startContinuousExportRequest - 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.StartDataCollectionByAgentIdsResult startDataCollectionByAgentIds(StartDataCollectionByAgentIdsRequest startDataCollectionByAgentIdsRequest)
Instructs the specified agents to start collecting data.
startDataCollectionByAgentIdsRequest - 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.StartExportTaskResult startExportTask(StartExportTaskRequest startExportTaskRequest)
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.
startExportTaskRequest - 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.StartImportTaskResult startImportTask(StartImportTaskRequest startImportTaskRequest)
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:
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.
Fill out the template with your server and application data.
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.
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.
startImportTaskRequest - 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.StopContinuousExportResult stopContinuousExport(StopContinuousExportRequest stopContinuousExportRequest)
Stop the continuous flow of agent's discovered data into Amazon Athena.
stopContinuousExportRequest - 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.StopDataCollectionByAgentIdsResult stopDataCollectionByAgentIds(StopDataCollectionByAgentIdsRequest stopDataCollectionByAgentIdsRequest)
Instructs the specified agents to stop collecting data.
stopDataCollectionByAgentIdsRequest - 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.UpdateApplicationResult updateApplication(UpdateApplicationRequest updateApplicationRequest)
Updates metadata about an application.
updateApplicationRequest - 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.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request - The originally executed request.