Interface ApplicationDiscoveryAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any
invalid reference
SdkAsyncHttpClient
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.batchDeleteAgents
(Consumer<BatchDeleteAgentsRequest.Builder> batchDeleteAgentsRequest) Deletes one or more agents or collectors as specified by ID.batchDeleteAgents
(BatchDeleteAgentsRequest batchDeleteAgentsRequest) Deletes one or more agents or collectors as specified by ID.batchDeleteImportData
(Consumer<BatchDeleteImportDataRequest.Builder> batchDeleteImportDataRequest) Deletes one or more import tasks, each identified by their import ID.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 aApplicationDiscoveryAsyncClient
.create()
Create aApplicationDiscoveryAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createApplication
(Consumer<CreateApplicationRequest.Builder> createApplicationRequest) Creates an application with the given name and description.createApplication
(CreateApplicationRequest createApplicationRequest) Creates an application with the given name and description.default CompletableFuture
<CreateTagsResponse> createTags
(Consumer<CreateTagsRequest.Builder> createTagsRequest) Creates one or more tags for configuration items.default CompletableFuture
<CreateTagsResponse> createTags
(CreateTagsRequest createTagsRequest) Creates one or more tags for configuration items.deleteApplications
(Consumer<DeleteApplicationsRequest.Builder> deleteApplicationsRequest) Deletes a list of applications and their associations with configuration items.deleteApplications
(DeleteApplicationsRequest deleteApplicationsRequest) Deletes a list of applications and their associations with configuration items.default CompletableFuture
<DeleteTagsResponse> deleteTags
(Consumer<DeleteTagsRequest.Builder> deleteTagsRequest) Deletes the association between configuration items and one or more tags.default CompletableFuture
<DeleteTagsResponse> deleteTags
(DeleteTagsRequest deleteTagsRequest) Deletes the association between configuration items and one or more tags.default CompletableFuture
<DescribeAgentsResponse> Lists agents or collectors as specified by ID or other filters.default CompletableFuture
<DescribeAgentsResponse> describeAgents
(Consumer<DescribeAgentsRequest.Builder> describeAgentsRequest) Lists agents or collectors as specified by ID or other filters.default CompletableFuture
<DescribeAgentsResponse> describeAgents
(DescribeAgentsRequest describeAgentsRequest) Lists agents or collectors as specified by ID or other filters.default DescribeAgentsPublisher
This is a variant ofdescribeAgents(software.amazon.awssdk.services.applicationdiscovery.model.DescribeAgentsRequest)
operation.default DescribeAgentsPublisher
describeAgentsPaginator
(Consumer<DescribeAgentsRequest.Builder> describeAgentsRequest) This is a variant ofdescribeAgents(software.amazon.awssdk.services.applicationdiscovery.model.DescribeAgentsRequest)
operation.default DescribeAgentsPublisher
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.describeConfigurations
(Consumer<DescribeConfigurationsRequest.Builder> describeConfigurationsRequest) Retrieves attributes for a list of configuration item IDs.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.Retrieve status of one or more export tasks.describeExportTasks
(Consumer<DescribeExportTasksRequest.Builder> describeExportTasksRequest) Retrieve status of one or more export tasks.describeExportTasks
(DescribeExportTasksRequest describeExportTasksRequest) Retrieve status of one or more export tasks.default DescribeExportTasksPublisher
This is a variant ofdescribeExportTasks(software.amazon.awssdk.services.applicationdiscovery.model.DescribeExportTasksRequest)
operation.default DescribeExportTasksPublisher
describeExportTasksPaginator
(Consumer<DescribeExportTasksRequest.Builder> describeExportTasksRequest) This is a variant ofdescribeExportTasks(software.amazon.awssdk.services.applicationdiscovery.model.DescribeExportTasksRequest)
operation.default DescribeExportTasksPublisher
describeExportTasksPaginator
(DescribeExportTasksRequest describeExportTasksRequest) This is a variant ofdescribeExportTasks(software.amazon.awssdk.services.applicationdiscovery.model.DescribeExportTasksRequest)
operation.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.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.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 DescribeImportTasksPublisher
This is a variant ofdescribeImportTasks(software.amazon.awssdk.services.applicationdiscovery.model.DescribeImportTasksRequest)
operation.default DescribeImportTasksPublisher
describeImportTasksPaginator
(Consumer<DescribeImportTasksRequest.Builder> describeImportTasksRequest) This is a variant ofdescribeImportTasks(software.amazon.awssdk.services.applicationdiscovery.model.DescribeImportTasksRequest)
operation.default DescribeImportTasksPublisher
describeImportTasksPaginator
(DescribeImportTasksRequest describeImportTasksRequest) This is a variant ofdescribeImportTasks(software.amazon.awssdk.services.applicationdiscovery.model.DescribeImportTasksRequest)
operation.default CompletableFuture
<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 CompletableFuture
<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 CompletableFuture
<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 DescribeTagsPublisher
This is a variant ofdescribeTags(software.amazon.awssdk.services.applicationdiscovery.model.DescribeTagsRequest)
operation.default DescribeTagsPublisher
describeTagsPaginator
(Consumer<DescribeTagsRequest.Builder> describeTagsRequest) This is a variant ofdescribeTags(software.amazon.awssdk.services.applicationdiscovery.model.DescribeTagsRequest)
operation.default DescribeTagsPublisher
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.Retrieves a short summary of discovered assets.getDiscoverySummary
(Consumer<GetDiscoverySummaryRequest.Builder> getDiscoverySummaryRequest) Retrieves a short summary of discovered assets.getDiscoverySummary
(GetDiscoverySummaryRequest getDiscoverySummaryRequest) Retrieves a short summary of discovered assets.listConfigurations
(Consumer<ListConfigurationsRequest.Builder> listConfigurationsRequest) Retrieves a list of configuration items as specified by the value passed to the required parameterconfigurationType
.listConfigurations
(ListConfigurationsRequest listConfigurationsRequest) Retrieves a list of configuration items as specified by the value passed to the required parameterconfigurationType
.default ListConfigurationsPublisher
listConfigurationsPaginator
(Consumer<ListConfigurationsRequest.Builder> listConfigurationsRequest) This is a variant oflistConfigurations(software.amazon.awssdk.services.applicationdiscovery.model.ListConfigurationsRequest)
operation.default ListConfigurationsPublisher
listConfigurationsPaginator
(ListConfigurationsRequest listConfigurationsRequest) This is a variant oflistConfigurations(software.amazon.awssdk.services.applicationdiscovery.model.ListConfigurationsRequest)
operation.listServerNeighbors
(Consumer<ListServerNeighborsRequest.Builder> listServerNeighborsRequest) Retrieves a list of servers that are one network hop away from a specified server.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., ClientOverrideConfigurationstartBatchDeleteConfigurationTask
(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.startContinuousExport
(Consumer<StartContinuousExportRequest.Builder> startContinuousExportRequest) Start the continuous flow of agent's discovered data into Amazon Athena.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 CompletableFuture
<StartExportTaskResponse> Begins the export of a discovered data report to an Amazon S3 bucket managed by Amazon Web Services.default CompletableFuture
<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 CompletableFuture
<StartExportTaskResponse> startExportTask
(StartExportTaskRequest startExportTaskRequest) Begins the export of a discovered data report to an Amazon S3 bucket managed by Amazon Web Services.default CompletableFuture
<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 CompletableFuture
<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.stopContinuousExport
(Consumer<StopContinuousExportRequest.Builder> stopContinuousExportRequest) Stop the continuous flow of agent's discovered data into Amazon Athena.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.updateApplication
(Consumer<UpdateApplicationRequest.Builder> updateApplicationRequest) Updates metadata about an application.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 CompletableFuture<AssociateConfigurationItemsToApplicationResponse> associateConfigurationItemsToApplication(AssociateConfigurationItemsToApplicationRequest associateConfigurationItemsToApplicationRequest) Associates one or more configuration items with an application.
- Parameters:
associateConfigurationItemsToApplicationRequest
-- Returns:
- A Java Future containing the result of the AssociateConfigurationItemsToApplication operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
associateConfigurationItemsToApplication
default CompletableFuture<AssociateConfigurationItemsToApplicationResponse> associateConfigurationItemsToApplication(Consumer<AssociateConfigurationItemsToApplicationRequest.Builder> associateConfigurationItemsToApplicationRequest) 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:
- A Java Future containing the result of the AssociateConfigurationItemsToApplication operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
batchDeleteAgents
default CompletableFuture<BatchDeleteAgentsResponse> batchDeleteAgents(BatchDeleteAgentsRequest batchDeleteAgentsRequest) Deletes one or more agents or collectors as specified by ID. Deleting an agent or collector does not delete the previously discovered data. To delete the data collected, use
StartBatchDeleteConfigurationTask
.- Parameters:
batchDeleteAgentsRequest
-- Returns:
- A Java Future containing the result of the BatchDeleteAgents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
batchDeleteAgents
default CompletableFuture<BatchDeleteAgentsResponse> batchDeleteAgents(Consumer<BatchDeleteAgentsRequest.Builder> batchDeleteAgentsRequest) Deletes one or more agents or collectors as specified by ID. Deleting an agent or collector does not delete the previously discovered data. To delete the data collected, use
StartBatchDeleteConfigurationTask
.
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:
- A Java Future containing the result of the BatchDeleteAgents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
batchDeleteImportData
default CompletableFuture<BatchDeleteImportDataResponse> batchDeleteImportData(BatchDeleteImportDataRequest batchDeleteImportDataRequest) Deletes one or more import tasks, each identified by their import ID. Each import task has a number of records that can identify servers or applications.
Amazon Web Services Application Discovery Service has built-in matching logic that will identify when discovered servers match existing entries that you've previously discovered, the information for the already-existing discovered server is updated. When you delete an import task that contains records that were used to match, the information in those matched records that comes from the deleted records will also be deleted.
- Parameters:
batchDeleteImportDataRequest
-- Returns:
- A Java Future containing the result of the BatchDeleteImportData operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
batchDeleteImportData
default CompletableFuture<BatchDeleteImportDataResponse> batchDeleteImportData(Consumer<BatchDeleteImportDataRequest.Builder> batchDeleteImportDataRequest) Deletes one or more import tasks, each identified by their import ID. Each import task has a number of records that can identify servers or applications.
Amazon Web Services Application Discovery Service has built-in matching logic that will identify when discovered servers match existing entries that you've previously discovered, the information for the already-existing discovered server is updated. When you delete an import task that contains records that were used to match, the information in those matched records that comes from the deleted records will also be deleted.
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:
- A Java Future containing the result of the BatchDeleteImportData operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createApplication
default CompletableFuture<CreateApplicationResponse> createApplication(CreateApplicationRequest createApplicationRequest) Creates an application with the given name and description.
- Parameters:
createApplicationRequest
-- Returns:
- A Java Future containing the result of the CreateApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createApplication
default CompletableFuture<CreateApplicationResponse> createApplication(Consumer<CreateApplicationRequest.Builder> createApplicationRequest) 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:
- A Java Future containing the result of the CreateApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createTags
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:
- A Java Future containing the result of the CreateTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- ResourceNotFoundException The specified configuration ID was not located. Verify the configuration ID and try again.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createTags
default CompletableFuture<CreateTagsResponse> createTags(Consumer<CreateTagsRequest.Builder> createTagsRequest) Creates one or more tags for configuration items. Tags are metadata that help you categorize IT assets. This API accepts a list of multiple configuration items.
Do not store sensitive information (like personal data) in tags.
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:
- A Java Future containing the result of the CreateTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- ResourceNotFoundException The specified configuration ID was not located. Verify the configuration ID and try again.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteApplications
default CompletableFuture<DeleteApplicationsResponse> deleteApplications(DeleteApplicationsRequest deleteApplicationsRequest) Deletes a list of applications and their associations with configuration items.
- Parameters:
deleteApplicationsRequest
-- Returns:
- A Java Future containing the result of the DeleteApplications operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteApplications
default CompletableFuture<DeleteApplicationsResponse> deleteApplications(Consumer<DeleteApplicationsRequest.Builder> deleteApplicationsRequest) 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:
- A Java Future containing the result of the DeleteApplications operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteTags
Deletes the association between configuration items and one or more tags. This API accepts a list of multiple configuration items.
- Parameters:
deleteTagsRequest
-- Returns:
- A Java Future containing the result of the DeleteTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- ResourceNotFoundException The specified configuration ID was not located. Verify the configuration ID and try again.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteTags
default CompletableFuture<DeleteTagsResponse> deleteTags(Consumer<DeleteTagsRequest.Builder> deleteTagsRequest) 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:
- A Java Future containing the result of the DeleteTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- ResourceNotFoundException The specified configuration ID was not located. Verify the configuration ID and try again.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeAgents
default CompletableFuture<DescribeAgentsResponse> describeAgents(DescribeAgentsRequest describeAgentsRequest) Lists agents or collectors as specified by ID or other filters. All agents/collectors associated with your user can be listed if you call
DescribeAgents
as is without passing any parameters.- Parameters:
describeAgentsRequest
-- Returns:
- A Java Future containing the result of the DescribeAgents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeAgents
default CompletableFuture<DescribeAgentsResponse> describeAgents(Consumer<DescribeAgentsRequest.Builder> describeAgentsRequest) Lists agents or collectors as specified by ID or other filters. All agents/collectors associated with your user can be listed if you call
DescribeAgents
as is without passing any parameters.
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 Java Future containing the result of the DescribeAgents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeAgents
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.- Returns:
- A Java Future containing the result of the DescribeAgents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeAgentsPaginator
This is a variant of
describeAgents(software.amazon.awssdk.services.applicationdiscovery.model.DescribeAgentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.applicationdiscovery.paginators.DescribeAgentsPublisher publisher = client.describeAgentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.applicationdiscovery.paginators.DescribeAgentsPublisher publisher = client.describeAgentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.applicationdiscovery.model.DescribeAgentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.applicationdiscovery.model.DescribeAgentsResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeAgentsPaginator
default DescribeAgentsPublisher describeAgentsPaginator(DescribeAgentsRequest describeAgentsRequest) This is a variant of
describeAgents(software.amazon.awssdk.services.applicationdiscovery.model.DescribeAgentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.applicationdiscovery.paginators.DescribeAgentsPublisher publisher = client.describeAgentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.applicationdiscovery.paginators.DescribeAgentsPublisher publisher = client.describeAgentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.applicationdiscovery.model.DescribeAgentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.applicationdiscovery.model.DescribeAgentsResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeAgentsPaginator
default DescribeAgentsPublisher describeAgentsPaginator(Consumer<DescribeAgentsRequest.Builder> describeAgentsRequest) This is a variant of
describeAgents(software.amazon.awssdk.services.applicationdiscovery.model.DescribeAgentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.applicationdiscovery.paginators.DescribeAgentsPublisher publisher = client.describeAgentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.applicationdiscovery.paginators.DescribeAgentsPublisher publisher = client.describeAgentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.applicationdiscovery.model.DescribeAgentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.applicationdiscovery.model.DescribeAgentsResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeBatchDeleteConfigurationTask
default CompletableFuture<DescribeBatchDeleteConfigurationTaskResponse> describeBatchDeleteConfigurationTask(DescribeBatchDeleteConfigurationTaskRequest describeBatchDeleteConfigurationTaskRequest) Takes a unique deletion task identifier as input and returns metadata about a configuration deletion task.
- Parameters:
describeBatchDeleteConfigurationTaskRequest
-- Returns:
- A Java Future containing the result of the DescribeBatchDeleteConfigurationTask operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeBatchDeleteConfigurationTask
default CompletableFuture<DescribeBatchDeleteConfigurationTaskResponse> describeBatchDeleteConfigurationTask(Consumer<DescribeBatchDeleteConfigurationTaskRequest.Builder> describeBatchDeleteConfigurationTaskRequest) 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:
- A Java Future containing the result of the DescribeBatchDeleteConfigurationTask operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeConfigurations
default CompletableFuture<DescribeConfigurationsResponse> describeConfigurations(DescribeConfigurationsRequest describeConfigurationsRequest) Retrieves attributes for a list of configuration item IDs.
All of the supplied IDs must be for the same asset type from one of the following:
-
server
-
application
-
process
-
connection
Output fields are specific to the asset type specified. For example, the output for a server configuration item includes a list of attributes about the server, such as host name, operating system, number of network cards, etc.
For a complete list of outputs for each asset type, see Using the DescribeConfigurations Action in the Amazon Web Services Application Discovery Service User Guide.
- Parameters:
describeConfigurationsRequest
-- Returns:
- A Java Future containing the result of the DescribeConfigurations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
-
describeConfigurations
default CompletableFuture<DescribeConfigurationsResponse> describeConfigurations(Consumer<DescribeConfigurationsRequest.Builder> describeConfigurationsRequest) Retrieves attributes for a list of configuration item IDs.
All of the supplied IDs must be for the same asset type from one of the following:
-
server
-
application
-
process
-
connection
Output fields are specific to the asset type specified. For example, the output for a server configuration item includes a list of attributes about the server, such as host name, operating system, number of network cards, etc.
For a complete list of outputs for each asset type, see Using the DescribeConfigurations Action in the Amazon Web Services Application Discovery Service User Guide.
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:
- A Java Future containing the result of the DescribeConfigurations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
-
describeContinuousExports
default CompletableFuture<DescribeContinuousExportsResponse> describeContinuousExports(DescribeContinuousExportsRequest describeContinuousExportsRequest) Lists exports as specified by ID. All continuous exports associated with your user can be listed if you call
DescribeContinuousExports
as is without passing any parameters.- Parameters:
describeContinuousExportsRequest
-- Returns:
- A Java Future containing the result of the DescribeContinuousExports operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- OperationNotPermittedException This operation is not permitted.
- ResourceNotFoundException The specified configuration ID was not located. Verify the configuration ID and try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeContinuousExports
default CompletableFuture<DescribeContinuousExportsResponse> describeContinuousExports(Consumer<DescribeContinuousExportsRequest.Builder> describeContinuousExportsRequest) Lists exports as specified by ID. All continuous exports associated with your user can be listed if you call
DescribeContinuousExports
as is without passing any parameters.
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 Java Future containing the result of the DescribeContinuousExports operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- OperationNotPermittedException This operation is not permitted.
- ResourceNotFoundException The specified configuration ID was not located. Verify the configuration ID and try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeContinuousExportsPaginator
default DescribeContinuousExportsPublisher describeContinuousExportsPaginator(DescribeContinuousExportsRequest describeContinuousExportsRequest) This is a variant of
describeContinuousExports(software.amazon.awssdk.services.applicationdiscovery.model.DescribeContinuousExportsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.applicationdiscovery.paginators.DescribeContinuousExportsPublisher publisher = client.describeContinuousExportsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.applicationdiscovery.paginators.DescribeContinuousExportsPublisher publisher = client.describeContinuousExportsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.applicationdiscovery.model.DescribeContinuousExportsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.applicationdiscovery.model.DescribeContinuousExportsResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- OperationNotPermittedException This operation is not permitted.
- ResourceNotFoundException The specified configuration ID was not located. Verify the configuration ID and try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeContinuousExportsPaginator
default DescribeContinuousExportsPublisher describeContinuousExportsPaginator(Consumer<DescribeContinuousExportsRequest.Builder> describeContinuousExportsRequest) This is a variant of
describeContinuousExports(software.amazon.awssdk.services.applicationdiscovery.model.DescribeContinuousExportsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.applicationdiscovery.paginators.DescribeContinuousExportsPublisher publisher = client.describeContinuousExportsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.applicationdiscovery.paginators.DescribeContinuousExportsPublisher publisher = client.describeContinuousExportsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.applicationdiscovery.model.DescribeContinuousExportsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.applicationdiscovery.model.DescribeContinuousExportsResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- OperationNotPermittedException This operation is not permitted.
- ResourceNotFoundException The specified configuration ID was not located. Verify the configuration ID and try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeExportTasks
default CompletableFuture<DescribeExportTasksResponse> describeExportTasks(DescribeExportTasksRequest describeExportTasksRequest) Retrieve status of one or more export tasks. You can retrieve the status of up to 100 export tasks.
- Parameters:
describeExportTasksRequest
-- Returns:
- A Java Future containing the result of the DescribeExportTasks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeExportTasks
default CompletableFuture<DescribeExportTasksResponse> describeExportTasks(Consumer<DescribeExportTasksRequest.Builder> describeExportTasksRequest) 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:
- A Java Future containing the result of the DescribeExportTasks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeExportTasks
Retrieve status of one or more export tasks. You can retrieve the status of up to 100 export tasks.
- Returns:
- A Java Future containing the result of the DescribeExportTasks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeExportTasksPaginator
This is a variant of
describeExportTasks(software.amazon.awssdk.services.applicationdiscovery.model.DescribeExportTasksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.applicationdiscovery.paginators.DescribeExportTasksPublisher publisher = client.describeExportTasksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.applicationdiscovery.paginators.DescribeExportTasksPublisher publisher = client.describeExportTasksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.applicationdiscovery.model.DescribeExportTasksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.applicationdiscovery.model.DescribeExportTasksResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeExportTasksPaginator
default DescribeExportTasksPublisher describeExportTasksPaginator(DescribeExportTasksRequest describeExportTasksRequest) This is a variant of
describeExportTasks(software.amazon.awssdk.services.applicationdiscovery.model.DescribeExportTasksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.applicationdiscovery.paginators.DescribeExportTasksPublisher publisher = client.describeExportTasksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.applicationdiscovery.paginators.DescribeExportTasksPublisher publisher = client.describeExportTasksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.applicationdiscovery.model.DescribeExportTasksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.applicationdiscovery.model.DescribeExportTasksResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeExportTasksPaginator
default DescribeExportTasksPublisher describeExportTasksPaginator(Consumer<DescribeExportTasksRequest.Builder> describeExportTasksRequest) This is a variant of
describeExportTasks(software.amazon.awssdk.services.applicationdiscovery.model.DescribeExportTasksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.applicationdiscovery.paginators.DescribeExportTasksPublisher publisher = client.describeExportTasksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.applicationdiscovery.paginators.DescribeExportTasksPublisher publisher = client.describeExportTasksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.applicationdiscovery.model.DescribeExportTasksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.applicationdiscovery.model.DescribeExportTasksResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeImportTasks
default CompletableFuture<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.
- Parameters:
describeImportTasksRequest
-- Returns:
- A Java Future containing the result of the DescribeImportTasks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeImportTasks
default CompletableFuture<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.
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 Java Future containing the result of the DescribeImportTasks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeImportTasks
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.
- Returns:
- A Java Future containing the result of the DescribeImportTasks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeImportTasksPaginator
This is a variant of
describeImportTasks(software.amazon.awssdk.services.applicationdiscovery.model.DescribeImportTasksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.applicationdiscovery.paginators.DescribeImportTasksPublisher publisher = client.describeImportTasksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.applicationdiscovery.paginators.DescribeImportTasksPublisher publisher = client.describeImportTasksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.applicationdiscovery.model.DescribeImportTasksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.applicationdiscovery.model.DescribeImportTasksResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeImportTasksPaginator
default DescribeImportTasksPublisher describeImportTasksPaginator(DescribeImportTasksRequest describeImportTasksRequest) This is a variant of
describeImportTasks(software.amazon.awssdk.services.applicationdiscovery.model.DescribeImportTasksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.applicationdiscovery.paginators.DescribeImportTasksPublisher publisher = client.describeImportTasksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.applicationdiscovery.paginators.DescribeImportTasksPublisher publisher = client.describeImportTasksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.applicationdiscovery.model.DescribeImportTasksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.applicationdiscovery.model.DescribeImportTasksResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeImportTasksPaginator
default DescribeImportTasksPublisher describeImportTasksPaginator(Consumer<DescribeImportTasksRequest.Builder> describeImportTasksRequest) This is a variant of
describeImportTasks(software.amazon.awssdk.services.applicationdiscovery.model.DescribeImportTasksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.applicationdiscovery.paginators.DescribeImportTasksPublisher publisher = client.describeImportTasksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.applicationdiscovery.paginators.DescribeImportTasksPublisher publisher = client.describeImportTasksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.applicationdiscovery.model.DescribeImportTasksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.applicationdiscovery.model.DescribeImportTasksResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeTags
default CompletableFuture<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 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:
- A Java Future containing the result of the DescribeTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- ResourceNotFoundException The specified configuration ID was not located. Verify the configuration ID and try again.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
-
describeTags
default CompletableFuture<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 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:
- A Java Future containing the result of the DescribeTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- ResourceNotFoundException The specified configuration ID was not located. Verify the configuration ID and try again.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
-
describeTags
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.- Returns:
- A Java Future containing the result of the DescribeTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- ResourceNotFoundException The specified configuration ID was not located. Verify the configuration ID and try again.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
-
describeTagsPaginator
This is a variant of
describeTags(software.amazon.awssdk.services.applicationdiscovery.model.DescribeTagsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.applicationdiscovery.paginators.DescribeTagsPublisher publisher = client.describeTagsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.applicationdiscovery.paginators.DescribeTagsPublisher publisher = client.describeTagsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.applicationdiscovery.model.DescribeTagsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.applicationdiscovery.model.DescribeTagsResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- ResourceNotFoundException The specified configuration ID was not located. Verify the configuration ID and try again.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeTagsPaginator
This is a variant of
describeTags(software.amazon.awssdk.services.applicationdiscovery.model.DescribeTagsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.applicationdiscovery.paginators.DescribeTagsPublisher publisher = client.describeTagsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.applicationdiscovery.paginators.DescribeTagsPublisher publisher = client.describeTagsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.applicationdiscovery.model.DescribeTagsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.applicationdiscovery.model.DescribeTagsResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- ResourceNotFoundException The specified configuration ID was not located. Verify the configuration ID and try again.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeTagsPaginator
default DescribeTagsPublisher describeTagsPaginator(Consumer<DescribeTagsRequest.Builder> describeTagsRequest) This is a variant of
describeTags(software.amazon.awssdk.services.applicationdiscovery.model.DescribeTagsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.applicationdiscovery.paginators.DescribeTagsPublisher publisher = client.describeTagsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.applicationdiscovery.paginators.DescribeTagsPublisher publisher = client.describeTagsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.applicationdiscovery.model.DescribeTagsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.applicationdiscovery.model.DescribeTagsResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- ResourceNotFoundException The specified configuration ID was not located. Verify the configuration ID and try again.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
disassociateConfigurationItemsFromApplication
default CompletableFuture<DisassociateConfigurationItemsFromApplicationResponse> disassociateConfigurationItemsFromApplication(DisassociateConfigurationItemsFromApplicationRequest disassociateConfigurationItemsFromApplicationRequest) Disassociates one or more configuration items from an application.
- Parameters:
disassociateConfigurationItemsFromApplicationRequest
-- Returns:
- A Java Future containing the result of the DisassociateConfigurationItemsFromApplication operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
disassociateConfigurationItemsFromApplication
default CompletableFuture<DisassociateConfigurationItemsFromApplicationResponse> disassociateConfigurationItemsFromApplication(Consumer<DisassociateConfigurationItemsFromApplicationRequest.Builder> disassociateConfigurationItemsFromApplicationRequest) 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:
- A Java Future containing the result of the DisassociateConfigurationItemsFromApplication operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getDiscoverySummary
default CompletableFuture<GetDiscoverySummaryResponse> getDiscoverySummary(GetDiscoverySummaryRequest getDiscoverySummaryRequest) Retrieves a short summary of discovered assets.
This API operation takes no request parameters and is called as is at the command prompt as shown in the example.
- Parameters:
getDiscoverySummaryRequest
-- Returns:
- A Java Future containing the result of the GetDiscoverySummary operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getDiscoverySummary
default CompletableFuture<GetDiscoverySummaryResponse> getDiscoverySummary(Consumer<GetDiscoverySummaryRequest.Builder> getDiscoverySummaryRequest) Retrieves a short summary of discovered assets.
This API operation takes no request parameters and is called as is at the command prompt as shown in the example.
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:
- A Java Future containing the result of the GetDiscoverySummary operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getDiscoverySummary
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.
- Returns:
- A Java Future containing the result of the GetDiscoverySummary operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listConfigurations
default CompletableFuture<ListConfigurationsResponse> listConfigurations(ListConfigurationsRequest listConfigurationsRequest) Retrieves a list of configuration items as specified by the value passed to the required parameter
configurationType
. Optional filtering may be applied to refine search results.- Parameters:
listConfigurationsRequest
-- Returns:
- A Java Future containing the result of the ListConfigurations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- ResourceNotFoundException The specified configuration ID was not located. Verify the configuration ID and try again.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listConfigurations
default CompletableFuture<ListConfigurationsResponse> listConfigurations(Consumer<ListConfigurationsRequest.Builder> listConfigurationsRequest) Retrieves a list of configuration items as specified by the value passed to the required parameter
configurationType
. Optional filtering may be applied to refine search results.
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 Java Future containing the result of the ListConfigurations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- ResourceNotFoundException The specified configuration ID was not located. Verify the configuration ID and try again.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listConfigurationsPaginator
default ListConfigurationsPublisher listConfigurationsPaginator(ListConfigurationsRequest listConfigurationsRequest) This is a variant of
listConfigurations(software.amazon.awssdk.services.applicationdiscovery.model.ListConfigurationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.applicationdiscovery.paginators.ListConfigurationsPublisher publisher = client.listConfigurationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.applicationdiscovery.paginators.ListConfigurationsPublisher publisher = client.listConfigurationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.applicationdiscovery.model.ListConfigurationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.applicationdiscovery.model.ListConfigurationsResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- ResourceNotFoundException The specified configuration ID was not located. Verify the configuration ID and try again.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listConfigurationsPaginator
default ListConfigurationsPublisher listConfigurationsPaginator(Consumer<ListConfigurationsRequest.Builder> listConfigurationsRequest) This is a variant of
listConfigurations(software.amazon.awssdk.services.applicationdiscovery.model.ListConfigurationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.applicationdiscovery.paginators.ListConfigurationsPublisher publisher = client.listConfigurationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.applicationdiscovery.paginators.ListConfigurationsPublisher publisher = client.listConfigurationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.applicationdiscovery.model.ListConfigurationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.applicationdiscovery.model.ListConfigurationsResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- ResourceNotFoundException The specified configuration ID was not located. Verify the configuration ID and try again.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listServerNeighbors
default CompletableFuture<ListServerNeighborsResponse> listServerNeighbors(ListServerNeighborsRequest listServerNeighborsRequest) Retrieves a list of servers that are one network hop away from a specified server.
- Parameters:
listServerNeighborsRequest
-- Returns:
- A Java Future containing the result of the ListServerNeighbors operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listServerNeighbors
default CompletableFuture<ListServerNeighborsResponse> listServerNeighbors(Consumer<ListServerNeighborsRequest.Builder> listServerNeighborsRequest) 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:
- A Java Future containing the result of the ListServerNeighbors operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
startBatchDeleteConfigurationTask
default CompletableFuture<StartBatchDeleteConfigurationTaskResponse> startBatchDeleteConfigurationTask(StartBatchDeleteConfigurationTaskRequest startBatchDeleteConfigurationTaskRequest) Takes a list of configurationId as input and starts an asynchronous deletion task to remove the configurationItems. Returns a unique deletion task identifier.
- Parameters:
startBatchDeleteConfigurationTaskRequest
-- Returns:
- A Java Future containing the result of the StartBatchDeleteConfigurationTask operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- LimitExceededException The limit of 200 configuration IDs per request has been exceeded.
- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- OperationNotPermittedException This operation is not permitted.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
startBatchDeleteConfigurationTask
default CompletableFuture<StartBatchDeleteConfigurationTaskResponse> startBatchDeleteConfigurationTask(Consumer<StartBatchDeleteConfigurationTaskRequest.Builder> startBatchDeleteConfigurationTaskRequest) 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:
- A Java Future containing the result of the StartBatchDeleteConfigurationTask operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- LimitExceededException The limit of 200 configuration IDs per request has been exceeded.
- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- OperationNotPermittedException This operation is not permitted.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
startContinuousExport
default CompletableFuture<StartContinuousExportResponse> startContinuousExport(StartContinuousExportRequest startContinuousExportRequest) Start the continuous flow of agent's discovered data into Amazon Athena.
- Parameters:
startContinuousExportRequest
-- Returns:
- A Java Future containing the result of the StartContinuousExport operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConflictErrorException Conflict error.
- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- OperationNotPermittedException This operation is not permitted.
- ResourceInUseException This issue occurs when the same
clientRequestToken
is used with theStartImportTask
action, but with different parameters. For example, you use the same request token but have two different import URLs, you can encounter this issue. If the import tasks are meant to be different, use a differentclientRequestToken
, and try again. - HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
startContinuousExport
default CompletableFuture<StartContinuousExportResponse> startContinuousExport(Consumer<StartContinuousExportRequest.Builder> startContinuousExportRequest) 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:
- A Java Future containing the result of the StartContinuousExport operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConflictErrorException Conflict error.
- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- OperationNotPermittedException This operation is not permitted.
- ResourceInUseException This issue occurs when the same
clientRequestToken
is used with theStartImportTask
action, but with different parameters. For example, you use the same request token but have two different import URLs, you can encounter this issue. If the import tasks are meant to be different, use a differentclientRequestToken
, and try again. - HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
startDataCollectionByAgentIds
default CompletableFuture<StartDataCollectionByAgentIdsResponse> startDataCollectionByAgentIds(StartDataCollectionByAgentIdsRequest startDataCollectionByAgentIdsRequest) Instructs the specified agents to start collecting data.
- Parameters:
startDataCollectionByAgentIdsRequest
-- Returns:
- A Java Future containing the result of the StartDataCollectionByAgentIds operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
startDataCollectionByAgentIds
default CompletableFuture<StartDataCollectionByAgentIdsResponse> startDataCollectionByAgentIds(Consumer<StartDataCollectionByAgentIdsRequest.Builder> startDataCollectionByAgentIdsRequest) 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:
- A Java Future containing the result of the StartDataCollectionByAgentIds operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
startExportTask
default CompletableFuture<StartExportTaskResponse> startExportTask(StartExportTaskRequest startExportTaskRequest) Begins the export of a discovered data report to an Amazon S3 bucket managed by Amazon Web Services.
Exports might provide an estimate of fees and savings based on certain information that you provide. Fee estimates do not include any taxes that might apply. Your actual fees and savings depend on a variety of factors, including your actual usage of Amazon Web Services services, which might vary from the estimates provided in this report.
If you do not specify
preferences
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:
- A Java Future containing the result of the StartExportTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- OperationNotPermittedException This operation is not permitted.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
startExportTask
default CompletableFuture<StartExportTaskResponse> startExportTask(Consumer<StartExportTaskRequest.Builder> startExportTaskRequest) Begins the export of a discovered data report to an Amazon S3 bucket managed by Amazon Web Services.
Exports might provide an estimate of fees and savings based on certain information that you provide. Fee estimates do not include any taxes that might apply. Your actual fees and savings depend on a variety of factors, including your actual usage of Amazon Web Services services, which might vary from the estimates provided in this report.
If you do not specify
preferences
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:
- A Java Future containing the result of the StartExportTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- OperationNotPermittedException This operation is not permitted.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
startExportTask
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.- Returns:
- A Java Future containing the result of the StartExportTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- OperationNotPermittedException This operation is not permitted.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
startImportTask
default CompletableFuture<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. 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:
- A Java Future containing the result of the StartImportTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceInUseException This issue occurs when the same
clientRequestToken
is used with theStartImportTask
action, but with different parameters. For example, you use the same request token but have two different import URLs, you can encounter this issue. If the import tasks are meant to be different, use a differentclientRequestToken
, and try again. - AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceInUseException This issue occurs when the same
-
-
startImportTask
default CompletableFuture<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. 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:
- A Java Future containing the result of the StartImportTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceInUseException This issue occurs when the same
clientRequestToken
is used with theStartImportTask
action, but with different parameters. For example, you use the same request token but have two different import URLs, you can encounter this issue. If the import tasks are meant to be different, use a differentclientRequestToken
, and try again. - AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceInUseException This issue occurs when the same
-
-
stopContinuousExport
default CompletableFuture<StopContinuousExportResponse> stopContinuousExport(StopContinuousExportRequest stopContinuousExportRequest) Stop the continuous flow of agent's discovered data into Amazon Athena.
- Parameters:
stopContinuousExportRequest
-- Returns:
- A Java Future containing the result of the StopContinuousExport operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- OperationNotPermittedException This operation is not permitted.
- ResourceNotFoundException The specified configuration ID was not located. Verify the configuration ID and try again.
- ResourceInUseException This issue occurs when the same
clientRequestToken
is used with theStartImportTask
action, but with different parameters. For example, you use the same request token but have two different import URLs, you can encounter this issue. If the import tasks are meant to be different, use a differentclientRequestToken
, and try again. - HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
stopContinuousExport
default CompletableFuture<StopContinuousExportResponse> stopContinuousExport(Consumer<StopContinuousExportRequest.Builder> stopContinuousExportRequest) 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:
- A Java Future containing the result of the StopContinuousExport operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- OperationNotPermittedException This operation is not permitted.
- ResourceNotFoundException The specified configuration ID was not located. Verify the configuration ID and try again.
- ResourceInUseException This issue occurs when the same
clientRequestToken
is used with theStartImportTask
action, but with different parameters. For example, you use the same request token but have two different import URLs, you can encounter this issue. If the import tasks are meant to be different, use a differentclientRequestToken
, and try again. - HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
stopDataCollectionByAgentIds
default CompletableFuture<StopDataCollectionByAgentIdsResponse> stopDataCollectionByAgentIds(StopDataCollectionByAgentIdsRequest stopDataCollectionByAgentIdsRequest) Instructs the specified agents to stop collecting data.
- Parameters:
stopDataCollectionByAgentIdsRequest
-- Returns:
- A Java Future containing the result of the StopDataCollectionByAgentIds operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
stopDataCollectionByAgentIds
default CompletableFuture<StopDataCollectionByAgentIdsResponse> stopDataCollectionByAgentIds(Consumer<StopDataCollectionByAgentIdsRequest.Builder> stopDataCollectionByAgentIdsRequest) 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:
- A Java Future containing the result of the StopDataCollectionByAgentIds operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateApplication
default CompletableFuture<UpdateApplicationResponse> updateApplication(UpdateApplicationRequest updateApplicationRequest) Updates metadata about an application.
- Parameters:
updateApplicationRequest
-- Returns:
- A Java Future containing the result of the UpdateApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateApplication
default CompletableFuture<UpdateApplicationResponse> updateApplication(Consumer<UpdateApplicationRequest.Builder> updateApplicationRequest) 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:
- A Java Future containing the result of the UpdateApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AuthorizationErrorException The user does not have permission to perform the action. Check the IAM policy associated with this user.
- InvalidParameterException One or more parameters are not valid. Verify the parameters and try again.
- InvalidParameterValueException The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
- ServerInternalErrorException The server experienced an internal error. Try again.
- HomeRegionNotSetException The home Region is not set. Set the home Region to continue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApplicationDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
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
-
create
Create aApplicationDiscoveryAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aApplicationDiscoveryAsyncClient
.
-