Interface ApplicationDiscoveryClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
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
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionassociateConfigurationItemsToApplication
(Consumer<AssociateConfigurationItemsToApplicationRequest.Builder> associateConfigurationItemsToApplicationRequest) Associates one or more configuration items with an application.associateConfigurationItemsToApplication
(AssociateConfigurationItemsToApplicationRequest associateConfigurationItemsToApplicationRequest) Associates one or more configuration items with an application.default BatchDeleteAgentsResponse
batchDeleteAgents
(Consumer<BatchDeleteAgentsRequest.Builder> batchDeleteAgentsRequest) Deletes one or more agents or collectors as specified by ID.default BatchDeleteAgentsResponse
batchDeleteAgents
(BatchDeleteAgentsRequest batchDeleteAgentsRequest) Deletes one or more agents or collectors as specified by ID.default BatchDeleteImportDataResponse
batchDeleteImportData
(Consumer<BatchDeleteImportDataRequest.Builder> batchDeleteImportDataRequest) Deletes one or more import tasks, each identified by their import ID.default BatchDeleteImportDataResponse
batchDeleteImportData
(BatchDeleteImportDataRequest batchDeleteImportDataRequest) Deletes one or more import tasks, each identified by their import ID.builder()
Create a builder that can be used to configure and create aApplicationDiscoveryClient
.static ApplicationDiscoveryClient
create()
Create aApplicationDiscoveryClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateApplicationResponse
createApplication
(Consumer<CreateApplicationRequest.Builder> createApplicationRequest) Creates an application with the given name and description.default CreateApplicationResponse
createApplication
(CreateApplicationRequest createApplicationRequest) Creates an application with the given name and description.default CreateTagsResponse
createTags
(Consumer<CreateTagsRequest.Builder> createTagsRequest) Creates one or more tags for configuration items.default CreateTagsResponse
createTags
(CreateTagsRequest createTagsRequest) Creates one or more tags for configuration items.default DeleteApplicationsResponse
deleteApplications
(Consumer<DeleteApplicationsRequest.Builder> deleteApplicationsRequest) Deletes a list of applications and their associations with configuration items.default DeleteApplicationsResponse
deleteApplications
(DeleteApplicationsRequest deleteApplicationsRequest) Deletes a list of applications and their associations with configuration items.default DeleteTagsResponse
deleteTags
(Consumer<DeleteTagsRequest.Builder> deleteTagsRequest) Deletes the association between configuration items and one or more tags.default DeleteTagsResponse
deleteTags
(DeleteTagsRequest deleteTagsRequest) Deletes the association between configuration items and one or more tags.default DescribeAgentsResponse
Lists agents or collectors as specified by ID or other filters.default DescribeAgentsResponse
describeAgents
(Consumer<DescribeAgentsRequest.Builder> describeAgentsRequest) Lists agents or collectors as specified by ID or other filters.default DescribeAgentsResponse
describeAgents
(DescribeAgentsRequest describeAgentsRequest) Lists agents or collectors as specified by ID or other filters.default DescribeAgentsIterable
This is a variant ofdescribeAgents(software.amazon.awssdk.services.applicationdiscovery.model.DescribeAgentsRequest)
operation.default DescribeAgentsIterable
describeAgentsPaginator
(Consumer<DescribeAgentsRequest.Builder> describeAgentsRequest) This is a variant ofdescribeAgents(software.amazon.awssdk.services.applicationdiscovery.model.DescribeAgentsRequest)
operation.default DescribeAgentsIterable
describeAgentsPaginator
(DescribeAgentsRequest describeAgentsRequest) This is a variant ofdescribeAgents(software.amazon.awssdk.services.applicationdiscovery.model.DescribeAgentsRequest)
operation.describeBatchDeleteConfigurationTask
(Consumer<DescribeBatchDeleteConfigurationTaskRequest.Builder> describeBatchDeleteConfigurationTaskRequest) Takes a unique deletion task identifier as input and returns metadata about a configuration deletion task.describeBatchDeleteConfigurationTask
(DescribeBatchDeleteConfigurationTaskRequest describeBatchDeleteConfigurationTaskRequest) Takes a unique deletion task identifier as input and returns metadata about a configuration deletion task.default DescribeConfigurationsResponse
describeConfigurations
(Consumer<DescribeConfigurationsRequest.Builder> describeConfigurationsRequest) Retrieves attributes for a list of configuration item IDs.default DescribeConfigurationsResponse
describeConfigurations
(DescribeConfigurationsRequest describeConfigurationsRequest) Retrieves attributes for a list of configuration item IDs.describeContinuousExports
(Consumer<DescribeContinuousExportsRequest.Builder> describeContinuousExportsRequest) Lists exports as specified by ID.describeContinuousExports
(DescribeContinuousExportsRequest describeContinuousExportsRequest) Lists exports as specified by ID.describeContinuousExportsPaginator
(Consumer<DescribeContinuousExportsRequest.Builder> describeContinuousExportsRequest) This is a variant ofdescribeContinuousExports(software.amazon.awssdk.services.applicationdiscovery.model.DescribeContinuousExportsRequest)
operation.describeContinuousExportsPaginator
(DescribeContinuousExportsRequest describeContinuousExportsRequest) This is a variant ofdescribeContinuousExports(software.amazon.awssdk.services.applicationdiscovery.model.DescribeContinuousExportsRequest)
operation.default DescribeExportTasksResponse
Retrieve status of one or more export tasks.default DescribeExportTasksResponse
describeExportTasks
(Consumer<DescribeExportTasksRequest.Builder> describeExportTasksRequest) Retrieve status of one or more export tasks.default DescribeExportTasksResponse
describeExportTasks
(DescribeExportTasksRequest describeExportTasksRequest) Retrieve status of one or more export tasks.default DescribeExportTasksIterable
This is a variant ofdescribeExportTasks(software.amazon.awssdk.services.applicationdiscovery.model.DescribeExportTasksRequest)
operation.default DescribeExportTasksIterable
describeExportTasksPaginator
(Consumer<DescribeExportTasksRequest.Builder> describeExportTasksRequest) This is a variant ofdescribeExportTasks(software.amazon.awssdk.services.applicationdiscovery.model.DescribeExportTasksRequest)
operation.default DescribeExportTasksIterable
describeExportTasksPaginator
(DescribeExportTasksRequest describeExportTasksRequest) This is a variant ofdescribeExportTasks(software.amazon.awssdk.services.applicationdiscovery.model.DescribeExportTasksRequest)
operation.default DescribeImportTasksResponse
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.default DescribeImportTasksResponse
describeImportTasks
(Consumer<DescribeImportTasksRequest.Builder> 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.default DescribeImportTasksResponse
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.default DescribeImportTasksIterable
This is a variant ofdescribeImportTasks(software.amazon.awssdk.services.applicationdiscovery.model.DescribeImportTasksRequest)
operation.default DescribeImportTasksIterable
describeImportTasksPaginator
(Consumer<DescribeImportTasksRequest.Builder> describeImportTasksRequest) This is a variant ofdescribeImportTasks(software.amazon.awssdk.services.applicationdiscovery.model.DescribeImportTasksRequest)
operation.default DescribeImportTasksIterable
describeImportTasksPaginator
(DescribeImportTasksRequest describeImportTasksRequest) This is a variant ofdescribeImportTasks(software.amazon.awssdk.services.applicationdiscovery.model.DescribeImportTasksRequest)
operation.default DescribeTagsResponse
Retrieves a list of configuration items that have tags as specified by the key-value pairs, name and value, passed to the optional parameterfilters
.default DescribeTagsResponse
describeTags
(Consumer<DescribeTagsRequest.Builder> describeTagsRequest) Retrieves a list of configuration items that have tags as specified by the key-value pairs, name and value, passed to the optional parameterfilters
.default DescribeTagsResponse
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 parameterfilters
.default DescribeTagsIterable
This is a variant ofdescribeTags(software.amazon.awssdk.services.applicationdiscovery.model.DescribeTagsRequest)
operation.default DescribeTagsIterable
describeTagsPaginator
(Consumer<DescribeTagsRequest.Builder> describeTagsRequest) This is a variant ofdescribeTags(software.amazon.awssdk.services.applicationdiscovery.model.DescribeTagsRequest)
operation.default DescribeTagsIterable
describeTagsPaginator
(DescribeTagsRequest describeTagsRequest) This is a variant ofdescribeTags(software.amazon.awssdk.services.applicationdiscovery.model.DescribeTagsRequest)
operation.disassociateConfigurationItemsFromApplication
(Consumer<DisassociateConfigurationItemsFromApplicationRequest.Builder> disassociateConfigurationItemsFromApplicationRequest) Disassociates one or more configuration items from an application.disassociateConfigurationItemsFromApplication
(DisassociateConfigurationItemsFromApplicationRequest disassociateConfigurationItemsFromApplicationRequest) Disassociates one or more configuration items from an application.default GetDiscoverySummaryResponse
Retrieves a short summary of discovered assets.default GetDiscoverySummaryResponse
getDiscoverySummary
(Consumer<GetDiscoverySummaryRequest.Builder> getDiscoverySummaryRequest) Retrieves a short summary of discovered assets.default GetDiscoverySummaryResponse
getDiscoverySummary
(GetDiscoverySummaryRequest getDiscoverySummaryRequest) Retrieves a short summary of discovered assets.default ListConfigurationsResponse
listConfigurations
(Consumer<ListConfigurationsRequest.Builder> listConfigurationsRequest) Retrieves a list of configuration items as specified by the value passed to the required parameterconfigurationType
.default ListConfigurationsResponse
listConfigurations
(ListConfigurationsRequest listConfigurationsRequest) Retrieves a list of configuration items as specified by the value passed to the required parameterconfigurationType
.default ListConfigurationsIterable
listConfigurationsPaginator
(Consumer<ListConfigurationsRequest.Builder> listConfigurationsRequest) This is a variant oflistConfigurations(software.amazon.awssdk.services.applicationdiscovery.model.ListConfigurationsRequest)
operation.default ListConfigurationsIterable
listConfigurationsPaginator
(ListConfigurationsRequest listConfigurationsRequest) This is a variant oflistConfigurations(software.amazon.awssdk.services.applicationdiscovery.model.ListConfigurationsRequest)
operation.default ListServerNeighborsResponse
listServerNeighbors
(Consumer<ListServerNeighborsRequest.Builder> listServerNeighborsRequest) Retrieves a list of servers that are one network hop away from a specified server.default ListServerNeighborsResponse
listServerNeighbors
(ListServerNeighborsRequest listServerNeighborsRequest) Retrieves a list of servers that are one network hop away from a specified server.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
startBatchDeleteConfigurationTask
(Consumer<StartBatchDeleteConfigurationTaskRequest.Builder> startBatchDeleteConfigurationTaskRequest) Takes a list of configurationId as input and starts an asynchronous deletion task to remove the configurationItems.startBatchDeleteConfigurationTask
(StartBatchDeleteConfigurationTaskRequest startBatchDeleteConfigurationTaskRequest) Takes a list of configurationId as input and starts an asynchronous deletion task to remove the configurationItems.default StartContinuousExportResponse
startContinuousExport
(Consumer<StartContinuousExportRequest.Builder> startContinuousExportRequest) Start the continuous flow of agent's discovered data into Amazon Athena.default StartContinuousExportResponse
startContinuousExport
(StartContinuousExportRequest startContinuousExportRequest) Start the continuous flow of agent's discovered data into Amazon Athena.startDataCollectionByAgentIds
(Consumer<StartDataCollectionByAgentIdsRequest.Builder> startDataCollectionByAgentIdsRequest) Instructs the specified agents to start collecting data.startDataCollectionByAgentIds
(StartDataCollectionByAgentIdsRequest startDataCollectionByAgentIdsRequest) Instructs the specified agents to start collecting data.default StartExportTaskResponse
Begins the export of a discovered data report to an Amazon S3 bucket managed by Amazon Web Services.default StartExportTaskResponse
startExportTask
(Consumer<StartExportTaskRequest.Builder> startExportTaskRequest) Begins the export of a discovered data report to an Amazon S3 bucket managed by Amazon Web Services.default StartExportTaskResponse
startExportTask
(StartExportTaskRequest startExportTaskRequest) Begins the export of a discovered data report to an Amazon S3 bucket managed by Amazon Web Services.default StartImportTaskResponse
startImportTask
(Consumer<StartImportTaskRequest.Builder> 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.default StartImportTaskResponse
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.default StopContinuousExportResponse
stopContinuousExport
(Consumer<StopContinuousExportRequest.Builder> stopContinuousExportRequest) Stop the continuous flow of agent's discovered data into Amazon Athena.default StopContinuousExportResponse
stopContinuousExport
(StopContinuousExportRequest stopContinuousExportRequest) Stop the continuous flow of agent's discovered data into Amazon Athena.stopDataCollectionByAgentIds
(Consumer<StopDataCollectionByAgentIdsRequest.Builder> stopDataCollectionByAgentIdsRequest) Instructs the specified agents to stop collecting data.stopDataCollectionByAgentIds
(StopDataCollectionByAgentIdsRequest stopDataCollectionByAgentIdsRequest) Instructs the specified agents to stop collecting data.default UpdateApplicationResponse
updateApplication
(Consumer<UpdateApplicationRequest.Builder> updateApplicationRequest) Updates metadata about an application.default UpdateApplicationResponse
updateApplication
(UpdateApplicationRequest updateApplicationRequest) Updates metadata about an application.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
associateConfigurationItemsToApplication
default AssociateConfigurationItemsToApplicationResponse associateConfigurationItemsToApplication(AssociateConfigurationItemsToApplicationRequest associateConfigurationItemsToApplicationRequest) throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException Associates one or more configuration items with an application.
- Parameters:
associateConfigurationItemsToApplicationRequest
-- Returns:
- Result of the AssociateConfigurationItemsToApplication operation returned by the service.
-
associateConfigurationItemsToApplication
default AssociateConfigurationItemsToApplicationResponse associateConfigurationItemsToApplication(Consumer<AssociateConfigurationItemsToApplicationRequest.Builder> associateConfigurationItemsToApplicationRequest) throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException Associates one or more configuration items with an application.
This is a convenience which creates an instance of the
AssociateConfigurationItemsToApplicationRequest.Builder
avoiding the need to create one manually viaAssociateConfigurationItemsToApplicationRequest.builder()
- Parameters:
associateConfigurationItemsToApplicationRequest
- AConsumer
that will call methods onAssociateConfigurationItemsToApplicationRequest.Builder
to create a request.- Returns:
- Result of the AssociateConfigurationItemsToApplication operation returned by the service.
-
batchDeleteAgents
default BatchDeleteAgentsResponse batchDeleteAgents(BatchDeleteAgentsRequest batchDeleteAgentsRequest) throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, AwsServiceException, SdkClientException, ApplicationDiscoveryException 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
.- Parameters:
batchDeleteAgentsRequest
-- Returns:
- Result of the BatchDeleteAgents operation returned by the service.
-
batchDeleteAgents
default BatchDeleteAgentsResponse batchDeleteAgents(Consumer<BatchDeleteAgentsRequest.Builder> batchDeleteAgentsRequest) throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, AwsServiceException, SdkClientException, ApplicationDiscoveryException 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
.
This is a convenience which creates an instance of the
BatchDeleteAgentsRequest.Builder
avoiding the need to create one manually viaBatchDeleteAgentsRequest.builder()
- Parameters:
batchDeleteAgentsRequest
- AConsumer
that will call methods onBatchDeleteAgentsRequest.Builder
to create a request.- Returns:
- Result of the BatchDeleteAgents operation returned by the service.
-
batchDeleteImportData
default BatchDeleteImportDataResponse batchDeleteImportData(BatchDeleteImportDataRequest batchDeleteImportDataRequest) throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException 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.
- Parameters:
batchDeleteImportDataRequest
-- Returns:
- Result of the BatchDeleteImportData operation returned by the service.
-
batchDeleteImportData
default BatchDeleteImportDataResponse batchDeleteImportData(Consumer<BatchDeleteImportDataRequest.Builder> batchDeleteImportDataRequest) throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException 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.
This is a convenience which creates an instance of the
BatchDeleteImportDataRequest.Builder
avoiding the need to create one manually viaBatchDeleteImportDataRequest.builder()
- Parameters:
batchDeleteImportDataRequest
- AConsumer
that will call methods onBatchDeleteImportDataRequest.Builder
to create a request.- Returns:
- Result of the BatchDeleteImportData operation returned by the service.
-
createApplication
default CreateApplicationResponse createApplication(CreateApplicationRequest createApplicationRequest) throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException Creates an application with the given name and description.
- Parameters:
createApplicationRequest
-- Returns:
- Result of the CreateApplication operation returned by the service.
-
createApplication
default CreateApplicationResponse createApplication(Consumer<CreateApplicationRequest.Builder> createApplicationRequest) throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException Creates an application with the given name and description.
This is a convenience which creates an instance of the
CreateApplicationRequest.Builder
avoiding the need to create one manually viaCreateApplicationRequest.builder()
- Parameters:
createApplicationRequest
- AConsumer
that will call methods onCreateApplicationRequest.Builder
to create a request.- Returns:
- Result of the CreateApplication operation returned by the service.
-
createTags
default CreateTagsResponse createTags(CreateTagsRequest createTagsRequest) throws AuthorizationErrorException, ResourceNotFoundException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException 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.
- Parameters:
createTagsRequest
-- Returns:
- Result of the CreateTags operation returned by the service.
-
createTags
default CreateTagsResponse createTags(Consumer<CreateTagsRequest.Builder> createTagsRequest) throws AuthorizationErrorException, ResourceNotFoundException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException 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.
This is a convenience which creates an instance of the
CreateTagsRequest.Builder
avoiding the need to create one manually viaCreateTagsRequest.builder()
- Parameters:
createTagsRequest
- AConsumer
that will call methods onCreateTagsRequest.Builder
to create a request.- Returns:
- Result of the CreateTags operation returned by the service.
-
deleteApplications
default DeleteApplicationsResponse deleteApplications(DeleteApplicationsRequest deleteApplicationsRequest) throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException Deletes a list of applications and their associations with configuration items.
- Parameters:
deleteApplicationsRequest
-- Returns:
- Result of the DeleteApplications operation returned by the service.
-
deleteApplications
default DeleteApplicationsResponse deleteApplications(Consumer<DeleteApplicationsRequest.Builder> deleteApplicationsRequest) throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException Deletes a list of applications and their associations with configuration items.
This is a convenience which creates an instance of the
DeleteApplicationsRequest.Builder
avoiding the need to create one manually viaDeleteApplicationsRequest.builder()
- Parameters:
deleteApplicationsRequest
- AConsumer
that will call methods onDeleteApplicationsRequest.Builder
to create a request.- Returns:
- Result of the DeleteApplications operation returned by the service.
-
deleteTags
default DeleteTagsResponse deleteTags(DeleteTagsRequest deleteTagsRequest) throws AuthorizationErrorException, ResourceNotFoundException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException Deletes the association between configuration items and one or more tags. This API accepts a list of multiple configuration items.
- Parameters:
deleteTagsRequest
-- Returns:
- Result of the DeleteTags operation returned by the service.
-
deleteTags
default DeleteTagsResponse deleteTags(Consumer<DeleteTagsRequest.Builder> deleteTagsRequest) throws AuthorizationErrorException, ResourceNotFoundException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException Deletes the association between configuration items and one or more tags. This API accepts a list of multiple configuration items.
This is a convenience which creates an instance of the
DeleteTagsRequest.Builder
avoiding the need to create one manually viaDeleteTagsRequest.builder()
- Parameters:
deleteTagsRequest
- AConsumer
that will call methods onDeleteTagsRequest.Builder
to create a request.- Returns:
- Result of the DeleteTags operation returned by the service.
-
describeAgents
default DescribeAgentsResponse describeAgents(DescribeAgentsRequest describeAgentsRequest) throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException 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.- Parameters:
describeAgentsRequest
-- Returns:
- Result of the DescribeAgents operation returned by the service.
-
describeAgents
default DescribeAgentsResponse describeAgents(Consumer<DescribeAgentsRequest.Builder> describeAgentsRequest) throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException 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.
This is a convenience which creates an instance of the
DescribeAgentsRequest.Builder
avoiding the need to create one manually viaDescribeAgentsRequest.builder()
- Parameters:
describeAgentsRequest
- AConsumer
that will call methods onDescribeAgentsRequest.Builder
to create a request.- Returns:
- Result of the DescribeAgents operation returned by the service.
-
describeAgents
default DescribeAgentsResponse describeAgents() throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryExceptionLists 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.- Returns:
- Result of the DescribeAgents operation returned by the service.
- See Also:
-
describeAgentsPaginator
default DescribeAgentsIterable describeAgentsPaginator() throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryExceptionThis is a variant of
describeAgents(software.amazon.awssdk.services.applicationdiscovery.model.DescribeAgentsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.applicationdiscovery.paginators.DescribeAgentsIterable responses = client.describeAgentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.applicationdiscovery.paginators.DescribeAgentsIterable responses = client .describeAgentsPaginator(request); for (software.amazon.awssdk.services.applicationdiscovery.model.DescribeAgentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.applicationdiscovery.paginators.DescribeAgentsIterable responses = client.describeAgentsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAgents(software.amazon.awssdk.services.applicationdiscovery.model.DescribeAgentsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeAgentsPaginator
default DescribeAgentsIterable describeAgentsPaginator(DescribeAgentsRequest describeAgentsRequest) throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException This is a variant of
describeAgents(software.amazon.awssdk.services.applicationdiscovery.model.DescribeAgentsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.applicationdiscovery.paginators.DescribeAgentsIterable responses = client.describeAgentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.applicationdiscovery.paginators.DescribeAgentsIterable responses = client .describeAgentsPaginator(request); for (software.amazon.awssdk.services.applicationdiscovery.model.DescribeAgentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.applicationdiscovery.paginators.DescribeAgentsIterable responses = client.describeAgentsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAgents(software.amazon.awssdk.services.applicationdiscovery.model.DescribeAgentsRequest)
operation.- Parameters:
describeAgentsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
-
describeAgentsPaginator
default DescribeAgentsIterable describeAgentsPaginator(Consumer<DescribeAgentsRequest.Builder> describeAgentsRequest) throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException This is a variant of
describeAgents(software.amazon.awssdk.services.applicationdiscovery.model.DescribeAgentsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.applicationdiscovery.paginators.DescribeAgentsIterable responses = client.describeAgentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.applicationdiscovery.paginators.DescribeAgentsIterable responses = client .describeAgentsPaginator(request); for (software.amazon.awssdk.services.applicationdiscovery.model.DescribeAgentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.applicationdiscovery.paginators.DescribeAgentsIterable responses = client.describeAgentsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAgents(software.amazon.awssdk.services.applicationdiscovery.model.DescribeAgentsRequest)
operation.
This is a convenience which creates an instance of the
DescribeAgentsRequest.Builder
avoiding the need to create one manually viaDescribeAgentsRequest.builder()
- Parameters:
describeAgentsRequest
- AConsumer
that will call methods onDescribeAgentsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
-
describeBatchDeleteConfigurationTask
default DescribeBatchDeleteConfigurationTaskResponse describeBatchDeleteConfigurationTask(DescribeBatchDeleteConfigurationTaskRequest describeBatchDeleteConfigurationTaskRequest) throws AuthorizationErrorException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException Takes a unique deletion task identifier as input and returns metadata about a configuration deletion task.
- Parameters:
describeBatchDeleteConfigurationTaskRequest
-- Returns:
- Result of the DescribeBatchDeleteConfigurationTask operation returned by the service.
-
describeBatchDeleteConfigurationTask
default DescribeBatchDeleteConfigurationTaskResponse describeBatchDeleteConfigurationTask(Consumer<DescribeBatchDeleteConfigurationTaskRequest.Builder> describeBatchDeleteConfigurationTaskRequest) throws AuthorizationErrorException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException Takes a unique deletion task identifier as input and returns metadata about a configuration deletion task.
This is a convenience which creates an instance of the
DescribeBatchDeleteConfigurationTaskRequest.Builder
avoiding the need to create one manually viaDescribeBatchDeleteConfigurationTaskRequest.builder()
- Parameters:
describeBatchDeleteConfigurationTaskRequest
- AConsumer
that will call methods onDescribeBatchDeleteConfigurationTaskRequest.Builder
to create a request.- Returns:
- Result of the DescribeBatchDeleteConfigurationTask operation returned by the service.
-
describeConfigurations
default DescribeConfigurationsResponse describeConfigurations(DescribeConfigurationsRequest describeConfigurationsRequest) throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException 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.
- Parameters:
describeConfigurationsRequest
-- Returns:
- Result of the DescribeConfigurations operation returned by the service.
-
-
describeConfigurations
default DescribeConfigurationsResponse describeConfigurations(Consumer<DescribeConfigurationsRequest.Builder> describeConfigurationsRequest) throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException 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.
This is a convenience which creates an instance of the
DescribeConfigurationsRequest.Builder
avoiding the need to create one manually viaDescribeConfigurationsRequest.builder()
- Parameters:
describeConfigurationsRequest
- AConsumer
that will call methods onDescribeConfigurationsRequest.Builder
to create a request.- Returns:
- Result of the DescribeConfigurations operation returned by the service.
-
-
describeContinuousExports
default DescribeContinuousExportsResponse describeContinuousExports(DescribeContinuousExportsRequest describeContinuousExportsRequest) throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, OperationNotPermittedException, ResourceNotFoundException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException 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.- Parameters:
describeContinuousExportsRequest
-- Returns:
- Result of the DescribeContinuousExports operation returned by the service.
-
describeContinuousExports
default DescribeContinuousExportsResponse describeContinuousExports(Consumer<DescribeContinuousExportsRequest.Builder> describeContinuousExportsRequest) throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, OperationNotPermittedException, ResourceNotFoundException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException 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.
This is a convenience which creates an instance of the
DescribeContinuousExportsRequest.Builder
avoiding the need to create one manually viaDescribeContinuousExportsRequest.builder()
- Parameters:
describeContinuousExportsRequest
- AConsumer
that will call methods onDescribeContinuousExportsRequest.Builder
to create a request.- Returns:
- Result of the DescribeContinuousExports operation returned by the service.
-
describeContinuousExportsPaginator
default DescribeContinuousExportsIterable describeContinuousExportsPaginator(DescribeContinuousExportsRequest describeContinuousExportsRequest) throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, OperationNotPermittedException, ResourceNotFoundException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException This is a variant of
describeContinuousExports(software.amazon.awssdk.services.applicationdiscovery.model.DescribeContinuousExportsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.applicationdiscovery.paginators.DescribeContinuousExportsIterable responses = client.describeContinuousExportsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.applicationdiscovery.paginators.DescribeContinuousExportsIterable responses = client .describeContinuousExportsPaginator(request); for (software.amazon.awssdk.services.applicationdiscovery.model.DescribeContinuousExportsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.applicationdiscovery.paginators.DescribeContinuousExportsIterable responses = client.describeContinuousExportsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeContinuousExports(software.amazon.awssdk.services.applicationdiscovery.model.DescribeContinuousExportsRequest)
operation.- Parameters:
describeContinuousExportsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
-
describeContinuousExportsPaginator
default DescribeContinuousExportsIterable describeContinuousExportsPaginator(Consumer<DescribeContinuousExportsRequest.Builder> describeContinuousExportsRequest) throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, OperationNotPermittedException, ResourceNotFoundException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException This is a variant of
describeContinuousExports(software.amazon.awssdk.services.applicationdiscovery.model.DescribeContinuousExportsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.applicationdiscovery.paginators.DescribeContinuousExportsIterable responses = client.describeContinuousExportsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.applicationdiscovery.paginators.DescribeContinuousExportsIterable responses = client .describeContinuousExportsPaginator(request); for (software.amazon.awssdk.services.applicationdiscovery.model.DescribeContinuousExportsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.applicationdiscovery.paginators.DescribeContinuousExportsIterable responses = client.describeContinuousExportsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeContinuousExports(software.amazon.awssdk.services.applicationdiscovery.model.DescribeContinuousExportsRequest)
operation.
This is a convenience which creates an instance of the
DescribeContinuousExportsRequest.Builder
avoiding the need to create one manually viaDescribeContinuousExportsRequest.builder()
- Parameters:
describeContinuousExportsRequest
- AConsumer
that will call methods onDescribeContinuousExportsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
-
describeExportTasks
default DescribeExportTasksResponse describeExportTasks(DescribeExportTasksRequest describeExportTasksRequest) throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException Retrieve status of one or more export tasks. You can retrieve the status of up to 100 export tasks.
- Parameters:
describeExportTasksRequest
-- Returns:
- Result of the DescribeExportTasks operation returned by the service.
-
describeExportTasks
default DescribeExportTasksResponse describeExportTasks(Consumer<DescribeExportTasksRequest.Builder> describeExportTasksRequest) throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException Retrieve status of one or more export tasks. You can retrieve the status of up to 100 export tasks.
This is a convenience which creates an instance of the
DescribeExportTasksRequest.Builder
avoiding the need to create one manually viaDescribeExportTasksRequest.builder()
- Parameters:
describeExportTasksRequest
- AConsumer
that will call methods onDescribeExportTasksRequest.Builder
to create a request.- Returns:
- Result of the DescribeExportTasks operation returned by the service.
-
describeExportTasks
default DescribeExportTasksResponse describeExportTasks() throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryExceptionRetrieve status of one or more export tasks. You can retrieve the status of up to 100 export tasks.
- Returns:
- Result of the DescribeExportTasks operation returned by the service.
- See Also:
-
describeExportTasksPaginator
default DescribeExportTasksIterable describeExportTasksPaginator() throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryExceptionThis is a variant of
describeExportTasks(software.amazon.awssdk.services.applicationdiscovery.model.DescribeExportTasksRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.applicationdiscovery.paginators.DescribeExportTasksIterable responses = client.describeExportTasksPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.applicationdiscovery.paginators.DescribeExportTasksIterable responses = client .describeExportTasksPaginator(request); for (software.amazon.awssdk.services.applicationdiscovery.model.DescribeExportTasksResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.applicationdiscovery.paginators.DescribeExportTasksIterable responses = client.describeExportTasksPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeExportTasks(software.amazon.awssdk.services.applicationdiscovery.model.DescribeExportTasksRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeExportTasksPaginator
default DescribeExportTasksIterable describeExportTasksPaginator(DescribeExportTasksRequest describeExportTasksRequest) throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException This is a variant of
describeExportTasks(software.amazon.awssdk.services.applicationdiscovery.model.DescribeExportTasksRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.applicationdiscovery.paginators.DescribeExportTasksIterable responses = client.describeExportTasksPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.applicationdiscovery.paginators.DescribeExportTasksIterable responses = client .describeExportTasksPaginator(request); for (software.amazon.awssdk.services.applicationdiscovery.model.DescribeExportTasksResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.applicationdiscovery.paginators.DescribeExportTasksIterable responses = client.describeExportTasksPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeExportTasks(software.amazon.awssdk.services.applicationdiscovery.model.DescribeExportTasksRequest)
operation.- Parameters:
describeExportTasksRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
-
describeExportTasksPaginator
default DescribeExportTasksIterable describeExportTasksPaginator(Consumer<DescribeExportTasksRequest.Builder> describeExportTasksRequest) throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException This is a variant of
describeExportTasks(software.amazon.awssdk.services.applicationdiscovery.model.DescribeExportTasksRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.applicationdiscovery.paginators.DescribeExportTasksIterable responses = client.describeExportTasksPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.applicationdiscovery.paginators.DescribeExportTasksIterable responses = client .describeExportTasksPaginator(request); for (software.amazon.awssdk.services.applicationdiscovery.model.DescribeExportTasksResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.applicationdiscovery.paginators.DescribeExportTasksIterable responses = client.describeExportTasksPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeExportTasks(software.amazon.awssdk.services.applicationdiscovery.model.DescribeExportTasksRequest)
operation.
This is a convenience which creates an instance of the
DescribeExportTasksRequest.Builder
avoiding the need to create one manually viaDescribeExportTasksRequest.builder()
- Parameters:
describeExportTasksRequest
- AConsumer
that will call methods onDescribeExportTasksRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
-
describeImportTasks
default DescribeImportTasksResponse describeImportTasks(DescribeImportTasksRequest describeImportTasksRequest) throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException 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.
- Parameters:
describeImportTasksRequest
-- Returns:
- Result of the DescribeImportTasks operation returned by the service.
-
describeImportTasks
default DescribeImportTasksResponse describeImportTasks(Consumer<DescribeImportTasksRequest.Builder> describeImportTasksRequest) throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException 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.
This is a convenience which creates an instance of the
DescribeImportTasksRequest.Builder
avoiding the need to create one manually viaDescribeImportTasksRequest.builder()
- Parameters:
describeImportTasksRequest
- AConsumer
that will call methods onDescribeImportTasksRequest.Builder
to create a request.- Returns:
- Result of the DescribeImportTasks operation returned by the service.
-
describeImportTasks
default DescribeImportTasksResponse describeImportTasks() throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryExceptionReturns an array of import tasks for your account, including status information, times, IDs, the Amazon S3 Object URL for the import file, and more.
- Returns:
- Result of the DescribeImportTasks operation returned by the service.
- See Also:
-
describeImportTasksPaginator
default DescribeImportTasksIterable describeImportTasksPaginator() throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryExceptionThis is a variant of
describeImportTasks(software.amazon.awssdk.services.applicationdiscovery.model.DescribeImportTasksRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.applicationdiscovery.paginators.DescribeImportTasksIterable responses = client.describeImportTasksPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.applicationdiscovery.paginators.DescribeImportTasksIterable responses = client .describeImportTasksPaginator(request); for (software.amazon.awssdk.services.applicationdiscovery.model.DescribeImportTasksResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.applicationdiscovery.paginators.DescribeImportTasksIterable responses = client.describeImportTasksPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeImportTasks(software.amazon.awssdk.services.applicationdiscovery.model.DescribeImportTasksRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeImportTasksPaginator
default DescribeImportTasksIterable describeImportTasksPaginator(DescribeImportTasksRequest describeImportTasksRequest) throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException This is a variant of
describeImportTasks(software.amazon.awssdk.services.applicationdiscovery.model.DescribeImportTasksRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.applicationdiscovery.paginators.DescribeImportTasksIterable responses = client.describeImportTasksPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.applicationdiscovery.paginators.DescribeImportTasksIterable responses = client .describeImportTasksPaginator(request); for (software.amazon.awssdk.services.applicationdiscovery.model.DescribeImportTasksResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.applicationdiscovery.paginators.DescribeImportTasksIterable responses = client.describeImportTasksPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeImportTasks(software.amazon.awssdk.services.applicationdiscovery.model.DescribeImportTasksRequest)
operation.- Parameters:
describeImportTasksRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
-
describeImportTasksPaginator
default DescribeImportTasksIterable describeImportTasksPaginator(Consumer<DescribeImportTasksRequest.Builder> describeImportTasksRequest) throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException This is a variant of
describeImportTasks(software.amazon.awssdk.services.applicationdiscovery.model.DescribeImportTasksRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.applicationdiscovery.paginators.DescribeImportTasksIterable responses = client.describeImportTasksPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.applicationdiscovery.paginators.DescribeImportTasksIterable responses = client .describeImportTasksPaginator(request); for (software.amazon.awssdk.services.applicationdiscovery.model.DescribeImportTasksResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.applicationdiscovery.paginators.DescribeImportTasksIterable responses = client.describeImportTasksPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeImportTasks(software.amazon.awssdk.services.applicationdiscovery.model.DescribeImportTasksRequest)
operation.
This is a convenience which creates an instance of the
DescribeImportTasksRequest.Builder
avoiding the need to create one manually viaDescribeImportTasksRequest.builder()
- Parameters:
describeImportTasksRequest
- AConsumer
that will call methods onDescribeImportTasksRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
-
describeTags
default DescribeTagsResponse describeTags(DescribeTagsRequest describeTagsRequest) throws AuthorizationErrorException, ResourceNotFoundException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException 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.- Parameters:
describeTagsRequest
-- Returns:
- Result of the DescribeTags operation returned by the service.
-
-
describeTags
default DescribeTagsResponse describeTags(Consumer<DescribeTagsRequest.Builder> describeTagsRequest) throws AuthorizationErrorException, ResourceNotFoundException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException 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.
This is a convenience which creates an instance of the
DescribeTagsRequest.Builder
avoiding the need to create one manually viaDescribeTagsRequest.builder()
- Parameters:
describeTagsRequest
- AConsumer
that will call methods onDescribeTagsRequest.Builder
to create a request.- Returns:
- Result of the DescribeTags operation returned by the service.
-
-
describeTags
default DescribeTagsResponse describeTags() throws AuthorizationErrorException, ResourceNotFoundException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryExceptionRetrieves 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.- Returns:
- Result of the DescribeTags operation returned by the service.
- See Also:
-
-
describeTagsPaginator
default DescribeTagsIterable describeTagsPaginator() throws AuthorizationErrorException, ResourceNotFoundException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryExceptionThis is a variant of
describeTags(software.amazon.awssdk.services.applicationdiscovery.model.DescribeTagsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.applicationdiscovery.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.applicationdiscovery.paginators.DescribeTagsIterable responses = client .describeTagsPaginator(request); for (software.amazon.awssdk.services.applicationdiscovery.model.DescribeTagsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.applicationdiscovery.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeTags(software.amazon.awssdk.services.applicationdiscovery.model.DescribeTagsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeTagsPaginator
default DescribeTagsIterable describeTagsPaginator(DescribeTagsRequest describeTagsRequest) throws AuthorizationErrorException, ResourceNotFoundException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException This is a variant of
describeTags(software.amazon.awssdk.services.applicationdiscovery.model.DescribeTagsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.applicationdiscovery.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.applicationdiscovery.paginators.DescribeTagsIterable responses = client .describeTagsPaginator(request); for (software.amazon.awssdk.services.applicationdiscovery.model.DescribeTagsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.applicationdiscovery.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeTags(software.amazon.awssdk.services.applicationdiscovery.model.DescribeTagsRequest)
operation.- Parameters:
describeTagsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
-
describeTagsPaginator
default DescribeTagsIterable describeTagsPaginator(Consumer<DescribeTagsRequest.Builder> describeTagsRequest) throws AuthorizationErrorException, ResourceNotFoundException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException This is a variant of
describeTags(software.amazon.awssdk.services.applicationdiscovery.model.DescribeTagsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.applicationdiscovery.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.applicationdiscovery.paginators.DescribeTagsIterable responses = client .describeTagsPaginator(request); for (software.amazon.awssdk.services.applicationdiscovery.model.DescribeTagsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.applicationdiscovery.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeTags(software.amazon.awssdk.services.applicationdiscovery.model.DescribeTagsRequest)
operation.
This is a convenience which creates an instance of the
DescribeTagsRequest.Builder
avoiding the need to create one manually viaDescribeTagsRequest.builder()
- Parameters:
describeTagsRequest
- AConsumer
that will call methods onDescribeTagsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
-
disassociateConfigurationItemsFromApplication
default DisassociateConfigurationItemsFromApplicationResponse disassociateConfigurationItemsFromApplication(DisassociateConfigurationItemsFromApplicationRequest disassociateConfigurationItemsFromApplicationRequest) throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException Disassociates one or more configuration items from an application.
- Parameters:
disassociateConfigurationItemsFromApplicationRequest
-- Returns:
- Result of the DisassociateConfigurationItemsFromApplication operation returned by the service.
-
disassociateConfigurationItemsFromApplication
default DisassociateConfigurationItemsFromApplicationResponse disassociateConfigurationItemsFromApplication(Consumer<DisassociateConfigurationItemsFromApplicationRequest.Builder> disassociateConfigurationItemsFromApplicationRequest) throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException Disassociates one or more configuration items from an application.
This is a convenience which creates an instance of the
DisassociateConfigurationItemsFromApplicationRequest.Builder
avoiding the need to create one manually viaDisassociateConfigurationItemsFromApplicationRequest.builder()
- Parameters:
disassociateConfigurationItemsFromApplicationRequest
- AConsumer
that will call methods onDisassociateConfigurationItemsFromApplicationRequest.Builder
to create a request.- Returns:
- Result of the DisassociateConfigurationItemsFromApplication operation returned by the service.
-
getDiscoverySummary
default GetDiscoverySummaryResponse getDiscoverySummary(GetDiscoverySummaryRequest getDiscoverySummaryRequest) throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException 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.
- Parameters:
getDiscoverySummaryRequest
-- Returns:
- Result of the GetDiscoverySummary operation returned by the service.
-
getDiscoverySummary
default GetDiscoverySummaryResponse getDiscoverySummary(Consumer<GetDiscoverySummaryRequest.Builder> getDiscoverySummaryRequest) throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException 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.
This is a convenience which creates an instance of the
GetDiscoverySummaryRequest.Builder
avoiding the need to create one manually viaGetDiscoverySummaryRequest.builder()
- Parameters:
getDiscoverySummaryRequest
- AConsumer
that will call methods onGetDiscoverySummaryRequest.Builder
to create a request.- Returns:
- Result of the GetDiscoverySummary operation returned by the service.
-
getDiscoverySummary
default GetDiscoverySummaryResponse getDiscoverySummary() throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryExceptionRetrieves 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.
- Returns:
- Result of the GetDiscoverySummary operation returned by the service.
- See Also:
-
listConfigurations
default ListConfigurationsResponse listConfigurations(ListConfigurationsRequest listConfigurationsRequest) throws AuthorizationErrorException, ResourceNotFoundException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException 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.- Parameters:
listConfigurationsRequest
-- Returns:
- Result of the ListConfigurations operation returned by the service.
-
listConfigurations
default ListConfigurationsResponse listConfigurations(Consumer<ListConfigurationsRequest.Builder> listConfigurationsRequest) throws AuthorizationErrorException, ResourceNotFoundException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException 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.
This is a convenience which creates an instance of the
ListConfigurationsRequest.Builder
avoiding the need to create one manually viaListConfigurationsRequest.builder()
- Parameters:
listConfigurationsRequest
- AConsumer
that will call methods onListConfigurationsRequest.Builder
to create a request.- Returns:
- Result of the ListConfigurations operation returned by the service.
-
listConfigurationsPaginator
default ListConfigurationsIterable listConfigurationsPaginator(ListConfigurationsRequest listConfigurationsRequest) throws AuthorizationErrorException, ResourceNotFoundException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException This is a variant of
listConfigurations(software.amazon.awssdk.services.applicationdiscovery.model.ListConfigurationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.applicationdiscovery.paginators.ListConfigurationsIterable responses = client.listConfigurationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.applicationdiscovery.paginators.ListConfigurationsIterable responses = client .listConfigurationsPaginator(request); for (software.amazon.awssdk.services.applicationdiscovery.model.ListConfigurationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.applicationdiscovery.paginators.ListConfigurationsIterable responses = client.listConfigurationsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listConfigurations(software.amazon.awssdk.services.applicationdiscovery.model.ListConfigurationsRequest)
operation.- Parameters:
listConfigurationsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
-
listConfigurationsPaginator
default ListConfigurationsIterable listConfigurationsPaginator(Consumer<ListConfigurationsRequest.Builder> listConfigurationsRequest) throws AuthorizationErrorException, ResourceNotFoundException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException This is a variant of
listConfigurations(software.amazon.awssdk.services.applicationdiscovery.model.ListConfigurationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.applicationdiscovery.paginators.ListConfigurationsIterable responses = client.listConfigurationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.applicationdiscovery.paginators.ListConfigurationsIterable responses = client .listConfigurationsPaginator(request); for (software.amazon.awssdk.services.applicationdiscovery.model.ListConfigurationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.applicationdiscovery.paginators.ListConfigurationsIterable responses = client.listConfigurationsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listConfigurations(software.amazon.awssdk.services.applicationdiscovery.model.ListConfigurationsRequest)
operation.
This is a convenience which creates an instance of the
ListConfigurationsRequest.Builder
avoiding the need to create one manually viaListConfigurationsRequest.builder()
- Parameters:
listConfigurationsRequest
- AConsumer
that will call methods onListConfigurationsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
-
listServerNeighbors
default ListServerNeighborsResponse listServerNeighbors(ListServerNeighborsRequest listServerNeighborsRequest) throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException Retrieves a list of servers that are one network hop away from a specified server.
- Parameters:
listServerNeighborsRequest
-- Returns:
- Result of the ListServerNeighbors operation returned by the service.
-
listServerNeighbors
default ListServerNeighborsResponse listServerNeighbors(Consumer<ListServerNeighborsRequest.Builder> listServerNeighborsRequest) throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException Retrieves a list of servers that are one network hop away from a specified server.
This is a convenience which creates an instance of the
ListServerNeighborsRequest.Builder
avoiding the need to create one manually viaListServerNeighborsRequest.builder()
- Parameters:
listServerNeighborsRequest
- AConsumer
that will call methods onListServerNeighborsRequest.Builder
to create a request.- Returns:
- Result of the ListServerNeighbors operation returned by the service.
-
startBatchDeleteConfigurationTask
default StartBatchDeleteConfigurationTaskResponse startBatchDeleteConfigurationTask(StartBatchDeleteConfigurationTaskRequest startBatchDeleteConfigurationTaskRequest) throws LimitExceededException, AuthorizationErrorException, ServerInternalErrorException, HomeRegionNotSetException, OperationNotPermittedException, InvalidParameterValueException, AwsServiceException, SdkClientException, ApplicationDiscoveryException Takes a list of configurationId as input and starts an asynchronous deletion task to remove the configurationItems. Returns a unique deletion task identifier.
- Parameters:
startBatchDeleteConfigurationTaskRequest
-- Returns:
- Result of the StartBatchDeleteConfigurationTask operation returned by the service.
-
startBatchDeleteConfigurationTask
default StartBatchDeleteConfigurationTaskResponse startBatchDeleteConfigurationTask(Consumer<StartBatchDeleteConfigurationTaskRequest.Builder> startBatchDeleteConfigurationTaskRequest) throws LimitExceededException, AuthorizationErrorException, ServerInternalErrorException, HomeRegionNotSetException, OperationNotPermittedException, InvalidParameterValueException, AwsServiceException, SdkClientException, ApplicationDiscoveryException Takes a list of configurationId as input and starts an asynchronous deletion task to remove the configurationItems. Returns a unique deletion task identifier.
This is a convenience which creates an instance of the
StartBatchDeleteConfigurationTaskRequest.Builder
avoiding the need to create one manually viaStartBatchDeleteConfigurationTaskRequest.builder()
- Parameters:
startBatchDeleteConfigurationTaskRequest
- AConsumer
that will call methods onStartBatchDeleteConfigurationTaskRequest.Builder
to create a request.- Returns:
- Result of the StartBatchDeleteConfigurationTask operation returned by the service.
-
startContinuousExport
default StartContinuousExportResponse startContinuousExport(StartContinuousExportRequest startContinuousExportRequest) throws ConflictErrorException, AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, OperationNotPermittedException, ResourceInUseException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException Start the continuous flow of agent's discovered data into Amazon Athena.
- Parameters:
startContinuousExportRequest
-- Returns:
- Result of the StartContinuousExport operation returned by the service.
-
startContinuousExport
default StartContinuousExportResponse startContinuousExport(Consumer<StartContinuousExportRequest.Builder> startContinuousExportRequest) throws ConflictErrorException, AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, OperationNotPermittedException, ResourceInUseException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException Start the continuous flow of agent's discovered data into Amazon Athena.
This is a convenience which creates an instance of the
StartContinuousExportRequest.Builder
avoiding the need to create one manually viaStartContinuousExportRequest.builder()
- Parameters:
startContinuousExportRequest
- AConsumer
that will call methods onStartContinuousExportRequest.Builder
to create a request.- Returns:
- Result of the StartContinuousExport operation returned by the service.
-
startDataCollectionByAgentIds
default StartDataCollectionByAgentIdsResponse startDataCollectionByAgentIds(StartDataCollectionByAgentIdsRequest startDataCollectionByAgentIdsRequest) throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException Instructs the specified agents to start collecting data.
- Parameters:
startDataCollectionByAgentIdsRequest
-- Returns:
- Result of the StartDataCollectionByAgentIds operation returned by the service.
-
startDataCollectionByAgentIds
default StartDataCollectionByAgentIdsResponse startDataCollectionByAgentIds(Consumer<StartDataCollectionByAgentIdsRequest.Builder> startDataCollectionByAgentIdsRequest) throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException Instructs the specified agents to start collecting data.
This is a convenience which creates an instance of the
StartDataCollectionByAgentIdsRequest.Builder
avoiding the need to create one manually viaStartDataCollectionByAgentIdsRequest.builder()
- Parameters:
startDataCollectionByAgentIdsRequest
- AConsumer
that will call methods onStartDataCollectionByAgentIdsRequest.Builder
to create a request.- Returns:
- Result of the StartDataCollectionByAgentIds operation returned by the service.
-
startExportTask
default StartExportTaskResponse startExportTask(StartExportTaskRequest startExportTaskRequest) throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, OperationNotPermittedException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException 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
oragentIds
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 usingstartTime
andendTime
. 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
inpreferences
, an Amazon EC2 instance matching the characteristics of each server in Application Discovery Service is generated. Changing the attributes of theec2RecommendationsPreferences
changes the criteria of the recommendation.- Parameters:
startExportTaskRequest
-- Returns:
- Result of the StartExportTask operation returned by the service.
-
startExportTask
default StartExportTaskResponse startExportTask(Consumer<StartExportTaskRequest.Builder> startExportTaskRequest) throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, OperationNotPermittedException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException 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
oragentIds
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 usingstartTime
andendTime
. 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
inpreferences
, an Amazon EC2 instance matching the characteristics of each server in Application Discovery Service is generated. Changing the attributes of theec2RecommendationsPreferences
changes the criteria of the recommendation.
This is a convenience which creates an instance of the
StartExportTaskRequest.Builder
avoiding the need to create one manually viaStartExportTaskRequest.builder()
- Parameters:
startExportTaskRequest
- AConsumer
that will call methods onStartExportTaskRequest.Builder
to create a request.- Returns:
- Result of the StartExportTask operation returned by the service.
-
startExportTask
default StartExportTaskResponse startExportTask() throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, OperationNotPermittedException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryExceptionBegins 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
oragentIds
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 usingstartTime
andendTime
. 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
inpreferences
, an Amazon EC2 instance matching the characteristics of each server in Application Discovery Service is generated. Changing the attributes of theec2RecommendationsPreferences
changes the criteria of the recommendation.- Returns:
- Result of the StartExportTask operation returned by the service.
- See Also:
-
startImportTask
default StartImportTaskResponse startImportTask(StartImportTaskRequest startImportTaskRequest) throws ResourceInUseException, AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException 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.
- Parameters:
startImportTaskRequest
-- Returns:
- Result of the StartImportTask operation returned by the service.
-
-
startImportTask
default StartImportTaskResponse startImportTask(Consumer<StartImportTaskRequest.Builder> startImportTaskRequest) throws ResourceInUseException, AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException 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.
This is a convenience which creates an instance of the
StartImportTaskRequest.Builder
avoiding the need to create one manually viaStartImportTaskRequest.builder()
- Parameters:
startImportTaskRequest
- AConsumer
that will call methods onStartImportTaskRequest.Builder
to create a request.- Returns:
- Result of the StartImportTask operation returned by the service.
-
-
stopContinuousExport
default StopContinuousExportResponse stopContinuousExport(StopContinuousExportRequest stopContinuousExportRequest) throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, OperationNotPermittedException, ResourceNotFoundException, ResourceInUseException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException Stop the continuous flow of agent's discovered data into Amazon Athena.
- Parameters:
stopContinuousExportRequest
-- Returns:
- Result of the StopContinuousExport operation returned by the service.
-
stopContinuousExport
default StopContinuousExportResponse stopContinuousExport(Consumer<StopContinuousExportRequest.Builder> stopContinuousExportRequest) throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, OperationNotPermittedException, ResourceNotFoundException, ResourceInUseException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException Stop the continuous flow of agent's discovered data into Amazon Athena.
This is a convenience which creates an instance of the
StopContinuousExportRequest.Builder
avoiding the need to create one manually viaStopContinuousExportRequest.builder()
- Parameters:
stopContinuousExportRequest
- AConsumer
that will call methods onStopContinuousExportRequest.Builder
to create a request.- Returns:
- Result of the StopContinuousExport operation returned by the service.
-
stopDataCollectionByAgentIds
default StopDataCollectionByAgentIdsResponse stopDataCollectionByAgentIds(StopDataCollectionByAgentIdsRequest stopDataCollectionByAgentIdsRequest) throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException Instructs the specified agents to stop collecting data.
- Parameters:
stopDataCollectionByAgentIdsRequest
-- Returns:
- Result of the StopDataCollectionByAgentIds operation returned by the service.
-
stopDataCollectionByAgentIds
default StopDataCollectionByAgentIdsResponse stopDataCollectionByAgentIds(Consumer<StopDataCollectionByAgentIdsRequest.Builder> stopDataCollectionByAgentIdsRequest) throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException Instructs the specified agents to stop collecting data.
This is a convenience which creates an instance of the
StopDataCollectionByAgentIdsRequest.Builder
avoiding the need to create one manually viaStopDataCollectionByAgentIdsRequest.builder()
- Parameters:
stopDataCollectionByAgentIdsRequest
- AConsumer
that will call methods onStopDataCollectionByAgentIdsRequest.Builder
to create a request.- Returns:
- Result of the StopDataCollectionByAgentIds operation returned by the service.
-
updateApplication
default UpdateApplicationResponse updateApplication(UpdateApplicationRequest updateApplicationRequest) throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException Updates metadata about an application.
- Parameters:
updateApplicationRequest
-- Returns:
- Result of the UpdateApplication operation returned by the service.
-
updateApplication
default UpdateApplicationResponse updateApplication(Consumer<UpdateApplicationRequest.Builder> updateApplicationRequest) throws AuthorizationErrorException, InvalidParameterException, InvalidParameterValueException, ServerInternalErrorException, HomeRegionNotSetException, AwsServiceException, SdkClientException, ApplicationDiscoveryException Updates metadata about an application.
This is a convenience which creates an instance of the
UpdateApplicationRequest.Builder
avoiding the need to create one manually viaUpdateApplicationRequest.builder()
- Parameters:
updateApplicationRequest
- AConsumer
that will call methods onUpdateApplicationRequest.Builder
to create a request.- Returns:
- Result of the UpdateApplication operation returned by the service.
-
create
Create aApplicationDiscoveryClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aApplicationDiscoveryClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-