AbstractAWSApplicationDiscovery (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.applicationdiscovery.AbstractAWSApplicationDiscovery

All Implemented Interfaces:

AWSApplicationDiscovery

Direct Known Subclasses:

AbstractAWSApplicationDiscoveryAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSApplicationDiscovery
extends Object
implements AWSApplicationDiscovery
```
Abstract implementation of AWSApplicationDiscovery. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.applicationdiscovery.AWSApplicationDiscovery
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`AssociateConfigurationItemsToApplicationResult`	`associateConfigurationItemsToApplication(AssociateConfigurationItemsToApplicationRequest request)` Associates one or more configuration items with an application.
`BatchDeleteImportDataResult`	`batchDeleteImportData(BatchDeleteImportDataRequest request)` Deletes one or more import tasks, each identified by their import ID.
`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 connectors as specified by ID or other filters.
`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`	`setEndpoint(String endpoint)` Overrides the default endpoint for this client ("https://discovery.us-west-2.amazonaws.com").
`void`	`setRegion(Region region)` An alternative to `AWSApplicationDiscovery.setEndpoint(String)`, sets the regional endpoint for this client's service calls.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartContinuousExportResult`	`startContinuousExport(StartContinuousExportRequest request)` Start the continuous flow of agent's discovered data into Amazon Athena.
`StartDataCollectionByAgentIdsResult`	`startDataCollectionByAgentIds(StartDataCollectionByAgentIdsRequest request)` Instructs the specified agents or connectors to start collecting data.
`StartExportTaskResult`	`startExportTask(StartExportTaskRequest request)` Begins the export of discovered data to an S3 bucket.
`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 Application Discovery Service (ADS) tools such as the Discovery Connector or 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 or connectors to stop collecting data.
`UpdateApplicationResult`	`updateApplication(UpdateApplicationRequest request)` Updates metadata about an application.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: AWSApplicationDiscovery
    
    Overrides the default endpoint for this client ("https://discovery.us-west-2.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.
    Callers can pass in just the endpoint (ex: "discovery.us-west-2.amazonaws.com") or a full URL, including the protocol (ex: "https://discovery.us-west-2.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.
    For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: 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.
    
    Specified by:
    
    setEndpoint in interface AWSApplicationDiscovery
    
    Parameters:
    
    endpoint - The endpoint (ex: "discovery.us-west-2.amazonaws.com") or a full URL, including the protocol (ex: "https://discovery.us-west-2.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: AWSApplicationDiscovery
    
    An alternative to AWSApplicationDiscovery.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.
    
    Specified by:
    
    setRegion in interface AWSApplicationDiscovery
    
    Parameters:
    
    region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.
    
    See Also:
    
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - associateConfigurationItemsToApplication
```
public AssociateConfigurationItemsToApplicationResult associateConfigurationItemsToApplication(AssociateConfigurationItemsToApplicationRequest request)
```
    Description copied from interface: AWSApplicationDiscovery
    
    Associates one or more configuration items with an application.
    
    Specified by:
    
    associateConfigurationItemsToApplication in interface AWSApplicationDiscovery
    
    Returns:
    
    Result of the AssociateConfigurationItemsToApplication operation returned by the service.
  - batchDeleteImportData
```
public BatchDeleteImportDataResult batchDeleteImportData(BatchDeleteImportDataRequest request)
```
    Description copied from interface: AWSApplicationDiscovery
    
    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
    
    Returns:
    
    Result of the BatchDeleteImportData operation returned by the service.
  - createApplication
```
public CreateApplicationResult createApplication(CreateApplicationRequest request)
```
    Description copied from interface: AWSApplicationDiscovery
    
    Creates an application with the given name and description.
    
    Specified by:
    
    createApplication in interface AWSApplicationDiscovery
    
    Returns:
    
    Result of the CreateApplication operation returned by the service.
  - createTags
```
public CreateTagsResult createTags(CreateTagsRequest request)
```
    Description copied from interface: AWSApplicationDiscovery
    
    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
    
    Returns:
    
    Result of the CreateTags operation returned by the service.
  - deleteApplications
```
public DeleteApplicationsResult deleteApplications(DeleteApplicationsRequest request)
```
    Description copied from interface: AWSApplicationDiscovery
    
    Deletes a list of applications and their associations with configuration items.
    
    Specified by:
    
    deleteApplications in interface AWSApplicationDiscovery
    
    Returns:
    
    Result of the DeleteApplications operation returned by the service.
  - deleteTags
```
public DeleteTagsResult deleteTags(DeleteTagsRequest request)
```
    Description copied from interface: AWSApplicationDiscovery
    
    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
    
    Returns:
    
    Result of the DeleteTags operation returned by the service.
  - describeAgents
```
public DescribeAgentsResult describeAgents(DescribeAgentsRequest request)
```
    Description copied from interface: AWSApplicationDiscovery
    
    Lists agents or connectors as specified by ID or other filters. All agents/connectors associated with your user account can be listed if you call DescribeAgents as is without passing any parameters.
    
    Specified by:
    
    describeAgents in interface AWSApplicationDiscovery
    
    Returns:
    
    Result of the DescribeAgents operation returned by the service.
  - describeConfigurations
```
public DescribeConfigurationsResult describeConfigurations(DescribeConfigurationsRequest request)
```
    Description copied from interface: AWSApplicationDiscovery
    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
    
    Returns:
    
    Result of the DescribeConfigurations operation returned by the service.
  - describeContinuousExports
```
public DescribeContinuousExportsResult describeContinuousExports(DescribeContinuousExportsRequest request)
```
    Description copied from interface: AWSApplicationDiscovery
    
    Lists exports as specified by ID. All continuous exports associated with your user account can be listed if you call DescribeContinuousExports as is without passing any parameters.
    
    Specified by:
    
    describeContinuousExports in interface AWSApplicationDiscovery
    
    Returns:
    
    Result of the DescribeContinuousExports operation returned by the service.
  - describeExportConfigurations
```
@Deprecated
public DescribeExportConfigurationsResult describeExportConfigurations(DescribeExportConfigurationsRequest request)
```
    Deprecated.
    
    Description copied from interface: AWSApplicationDiscovery
    
    DescribeExportConfigurations is deprecated. Use DescribeExportTasks, instead.
    
    Specified by:
    
    describeExportConfigurations in interface AWSApplicationDiscovery
    
    Returns:
    
    Result of the DescribeExportConfigurations operation returned by the service.
  - describeExportTasks
```
public DescribeExportTasksResult describeExportTasks(DescribeExportTasksRequest request)
```
    Description copied from interface: AWSApplicationDiscovery
    
    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
    
    Returns:
    
    Result of the DescribeExportTasks operation returned by the service.
  - describeImportTasks
```
public DescribeImportTasksResult describeImportTasks(DescribeImportTasksRequest request)
```
    Description copied from interface: AWSApplicationDiscovery
    
    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
    
    Returns:
    
    Result of the DescribeImportTasks operation returned by the service.
  - describeTags
```
public DescribeTagsResult describeTags(DescribeTagsRequest request)
```
    Description copied from interface: AWSApplicationDiscovery
    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 account that have tags can be listed if you call DescribeTags as is without passing any parameters.
    Specified by:
    
    describeTags in interface AWSApplicationDiscovery
    
    Returns:
    
    Result of the DescribeTags operation returned by the service.
  - disassociateConfigurationItemsFromApplication
```
public DisassociateConfigurationItemsFromApplicationResult disassociateConfigurationItemsFromApplication(DisassociateConfigurationItemsFromApplicationRequest request)
```
    Description copied from interface: AWSApplicationDiscovery
    
    Disassociates one or more configuration items from an application.
    
    Specified by:
    
    disassociateConfigurationItemsFromApplication in interface AWSApplicationDiscovery
    
    Returns:
    
    Result of the DisassociateConfigurationItemsFromApplication operation returned by the service.
  - exportConfigurations
```
@Deprecated
public ExportConfigurationsResult exportConfigurations(ExportConfigurationsRequest request)
```
    Deprecated.
    
    Description copied from interface: AWSApplicationDiscovery
    
    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
    
    Returns:
    
    Result of the ExportConfigurations operation returned by the service.
  - getDiscoverySummary
```
public GetDiscoverySummaryResult getDiscoverySummary(GetDiscoverySummaryRequest request)
```
    Description copied from interface: AWSApplicationDiscovery
    
    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
    
    Returns:
    
    Result of the GetDiscoverySummary operation returned by the service.
  - listConfigurations
```
public ListConfigurationsResult listConfigurations(ListConfigurationsRequest request)
```
    Description copied from interface: AWSApplicationDiscovery
    
    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
    
    Returns:
    
    Result of the ListConfigurations operation returned by the service.
  - listServerNeighbors
```
public ListServerNeighborsResult listServerNeighbors(ListServerNeighborsRequest request)
```
    Description copied from interface: AWSApplicationDiscovery
    
    Retrieves a list of servers that are one network hop away from a specified server.
    
    Specified by:
    
    listServerNeighbors in interface AWSApplicationDiscovery
    
    Returns:
    
    Result of the ListServerNeighbors operation returned by the service.
  - startContinuousExport
```
public StartContinuousExportResult startContinuousExport(StartContinuousExportRequest request)
```
    Description copied from interface: AWSApplicationDiscovery
    
    Start the continuous flow of agent's discovered data into Amazon Athena.
    
    Specified by:
    
    startContinuousExport in interface AWSApplicationDiscovery
    
    Returns:
    
    Result of the StartContinuousExport operation returned by the service.
  - startDataCollectionByAgentIds
```
public StartDataCollectionByAgentIdsResult startDataCollectionByAgentIds(StartDataCollectionByAgentIdsRequest request)
```
    Description copied from interface: AWSApplicationDiscovery
    
    Instructs the specified agents or connectors to start collecting data.
    
    Specified by:
    
    startDataCollectionByAgentIds in interface AWSApplicationDiscovery
    
    Returns:
    
    Result of the StartDataCollectionByAgentIds operation returned by the service.
  - startExportTask
```
public StartExportTaskResult startExportTask(StartExportTaskRequest request)
```
    Description copied from interface: AWSApplicationDiscovery
    
    Begins the export of discovered data to an S3 bucket.
    
    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.
    
    If you do not include an agentIds filter, summary data is exported that includes both Amazon Web Services Agentless Discovery Connector data and summary data from Amazon Web Services Discovery Agents. Export of summary data is limited to two exports per day.
    
    Specified by:
    
    startExportTask in interface AWSApplicationDiscovery
    
    Returns:
    
    Result of the StartExportTask operation returned by the service.
  - startImportTask
```
public StartImportTaskResult startImportTask(StartImportTaskRequest request)
```
    Description copied from interface: AWSApplicationDiscovery
    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 Application Discovery Service (ADS) tools such as the Discovery Connector or 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
    
    Returns:
    
    Result of the StartImportTask operation returned by the service.
  - stopContinuousExport
```
public StopContinuousExportResult stopContinuousExport(StopContinuousExportRequest request)
```
    Description copied from interface: AWSApplicationDiscovery
    
    Stop the continuous flow of agent's discovered data into Amazon Athena.
    
    Specified by:
    
    stopContinuousExport in interface AWSApplicationDiscovery
    
    Returns:
    
    Result of the StopContinuousExport operation returned by the service.
  - stopDataCollectionByAgentIds
```
public StopDataCollectionByAgentIdsResult stopDataCollectionByAgentIds(StopDataCollectionByAgentIdsRequest request)
```
    Description copied from interface: AWSApplicationDiscovery
    
    Instructs the specified agents or connectors to stop collecting data.
    
    Specified by:
    
    stopDataCollectionByAgentIds in interface AWSApplicationDiscovery
    
    Returns:
    
    Result of the StopDataCollectionByAgentIds operation returned by the service.
  - updateApplication
```
public UpdateApplicationResult updateApplication(UpdateApplicationRequest request)
```
    Description copied from interface: AWSApplicationDiscovery
    
    Updates metadata about an application.
    
    Specified by:
    
    updateApplication in interface AWSApplicationDiscovery
    
    Returns:
    
    Result of the UpdateApplication operation returned by the service.
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSApplicationDiscovery
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AWSApplicationDiscovery
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSApplicationDiscovery
    
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    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.

Did this page help you?

Class AbstractAWSApplicationDiscovery

Field Summary

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

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setEndpoint

setRegion

associateConfigurationItemsToApplication

batchDeleteImportData

createApplication

createTags

deleteApplications

deleteTags

describeAgents

describeConfigurations

describeContinuousExports

describeExportConfigurations

describeExportTasks

describeImportTasks

describeTags

disassociateConfigurationItemsFromApplication

exportConfigurations

getDiscoverySummary

listConfigurations

listServerNeighbors

startContinuousExport

startDataCollectionByAgentIds

startExportTask

startImportTask

stopContinuousExport

stopDataCollectionByAgentIds

updateApplication

shutdown

getCachedResponseMetadata