Package software.amazon.awssdk.services.applicationdiscovery

Interface ApplicationDiscoveryClient

All Superinterfaces:

AutoCloseable

@Generated("software.amazon.awssdk:codegen")
public interface ApplicationDiscoveryClient
extends AutoCloseable

Service client for accessing null. This can be created using the static builder() method. AWS Application Discovery Service

AWS Application Discovery Service helps you plan application migration projects by automatically identifying servers, virtual machines (VMs), software, and software dependencies running in your on-premises data centers. Application Discovery Service also collects application performance data, which can help you assess the outcome of your migration. The data collected by Application Discovery Service is securely retained in an Amazon-hosted and managed database in the cloud. You can export the data as a CSV or XML file into your preferred visualization tool or cloud-migration solution to plan your migration. For more information, see the Application Discovery Service FAQ.

Application Discovery Service offers two modes of operation.

• Agentless discovery mode is recommended for environments that use VMware vCenter Server. This mode doesn't require you to install an agent on each host. Agentless discovery gathers server information regardless of the operating systems, which minimizes the time required for initial on-premises infrastructure assessment. Agentless discovery doesn't collect information about software and software dependencies. It also doesn't work in non-VMware environments. We recommend that you use agent-based discovery for non-VMware environments and if you want to collect information about software and software dependencies. You can also run agent-based and agentless discovery simultaneously. Use agentless discovery to quickly complete the initial infrastructure assessment and then install agents on select hosts to gather information about software and software dependencies.

• Agent-based discovery mode collects a richer set of data than agentless discovery by using Amazon software, the AWS Application Discovery Agent, which you install on one or more hosts in your data center. The agent captures infrastructure and application information, including an inventory of installed software applications, system and process performance, resource utilization, and network dependencies between workloads. The information collected by agents is secured at rest and in transit to the Application Discovery Service database in the cloud.

Application Discovery Service integrates with application discovery solutions from AWS Partner Network (APN) partners. Third-party application discovery tools can query Application Discovery Service and write to the Application Discovery Service database using a public API. You can then import the data into either a visualization tool or cloud-migration solution.

Application Discovery Service doesn't gather sensitive information. All data is handled according to the AWS Privacy Policy. You can operate Application Discovery Service using offline mode to inspect collected data before it is shared with the service.

Your AWS account must be granted access to Application Discovery Service, a process called whitelisting. This is true for AWS partners and customers alike. To request access, sign up for AWS Application Discovery Service here. We send you information about how to get started.

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

This guide is intended for use with the AWS Application Discovery Service User Guide .

Field Summary

Fields

Modifier and Type	Field	Description
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
default AssociateConfigurationItemsToApplicationResponse	associateConfigurationItemsToApplication(AssociateConfigurationItemsToApplicationRequest associateConfigurationItemsToApplicationRequest)	Associates one or more configuration items with an application.
static ApplicationDiscoveryClientBuilder	builder()	Create a builder that can be used to configure and create a ApplicationDiscoveryClient.
static ApplicationDiscoveryClient	create()	Create a ApplicationDiscoveryClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateApplicationResponse	createApplication(CreateApplicationRequest createApplicationRequest)	Creates an application with the given name and description.
default CreateTagsResponse	createTags(CreateTagsRequest createTagsRequest)	Creates one or more tags for configuration items.
default DeleteApplicationsResponse	deleteApplications(DeleteApplicationsRequest deleteApplicationsRequest)	Deletes a list of applications and their associations with configuration items.
default DeleteTagsResponse	deleteTags(DeleteTagsRequest deleteTagsRequest)	Deletes the association between configuration items and one or more tags.
default DescribeAgentsResponse	describeAgents(DescribeAgentsRequest describeAgentsRequest)	Lists agents or the Connector by ID or lists all agents/Connectors associated with your user account if you did not specify an ID.
default DescribeConfigurationsResponse	describeConfigurations(DescribeConfigurationsRequest describeConfigurationsRequest)	Retrieves attributes for a list of configuration item IDs.
default DescribeExportConfigurationsResponse	describeExportConfigurations(DescribeExportConfigurationsRequest describeExportConfigurationsRequest)	Deprecated.
default DescribeExportTasksResponse	describeExportTasks(DescribeExportTasksRequest describeExportTasksRequest)	Retrieve status of one or more export tasks.
default DescribeTagsResponse	describeTags(DescribeTagsRequest describeTagsRequest)	Retrieves a list of configuration items that are tagged with a specific tag.
default DisassociateConfigurationItemsFromApplicationResponse	disassociateConfigurationItemsFromApplication(DisassociateConfigurationItemsFromApplicationRequest disassociateConfigurationItemsFromApplicationRequest)	Disassociates one or more configuration items from an application.
default ExportConfigurationsResponse	exportConfigurations(ExportConfigurationsRequest exportConfigurationsRequest)	Deprecated.
default GetDiscoverySummaryResponse	getDiscoverySummary(GetDiscoverySummaryRequest getDiscoverySummaryRequest)	Retrieves a short summary of discovered assets.
default ListConfigurationsResponse	listConfigurations(ListConfigurationsRequest listConfigurationsRequest)	Retrieves a list of configuration items according to criteria that you specify in a filter.
default ListServerNeighborsResponse	listServerNeighbors(ListServerNeighborsRequest listServerNeighborsRequest)	Retrieves a list of servers that are one network hop away from a specified server.
static ServiceMetadata	serviceMetadata()
default StartDataCollectionByAgentIdsResponse	startDataCollectionByAgentIds(StartDataCollectionByAgentIdsRequest startDataCollectionByAgentIdsRequest)	Instructs the specified agents or connectors to start collecting data.
default StartExportTaskResponse	startExportTask(StartExportTaskRequest startExportTaskRequest)	Export the configuration data about discovered configuration items and relationships to an S3 bucket in a specified format.
default StopDataCollectionByAgentIdsResponse	stopDataCollectionByAgentIds(StopDataCollectionByAgentIdsRequest stopDataCollectionByAgentIdsRequest)	Instructs the specified agents or connectors to stop collecting data.
default UpdateApplicationResponse	updateApplication(UpdateApplicationRequest updateApplicationRequest)	Updates metadata about an application.

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

create

static ApplicationDiscoveryClient create()

Create a ApplicationDiscoveryClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static ApplicationDiscoveryClientBuilder builder()

Create a builder that can be used to configure and create a ApplicationDiscoveryClient.

associateConfigurationItemsToApplication

default AssociateConfigurationItemsToApplicationResponse associateConfigurationItemsToApplication(AssociateConfigurationItemsToApplicationRequest associateConfigurationItemsToApplicationRequest)
                                                                                           throws AuthorizationErrorException,
                                                                                                  InvalidParameterException,
                                                                                                  InvalidParameterValueException,
                                                                                                  ServerInternalErrorException,
                                                                                                  SdkBaseException,
                                                                                                  SdkClientException,
                                                                                                  ApplicationDiscoveryException

Associates one or more configuration items with an application.

Parameters:

associateConfigurationItemsToApplicationRequest -

Returns:

Result of the AssociateConfigurationItemsToApplication operation returned by the service.

Throws:

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

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.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

createApplication

default CreateApplicationResponse createApplication(CreateApplicationRequest createApplicationRequest)
                                             throws AuthorizationErrorException,
                                                    InvalidParameterException,
                                                    InvalidParameterValueException,
                                                    ServerInternalErrorException,
                                                    SdkBaseException,
                                                    SdkClientException,
                                                    ApplicationDiscoveryException

Creates an application with the given name and description.

Parameters:

createApplicationRequest -

Returns:

Result of the CreateApplication operation returned by the service.

Throws:

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

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.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

createTags

default CreateTagsResponse createTags(CreateTagsRequest createTagsRequest)
                               throws AuthorizationErrorException,
                                      ResourceNotFoundException,
                                      InvalidParameterException,
                                      InvalidParameterValueException,
                                      ServerInternalErrorException,
                                      SdkBaseException,
                                      SdkClientException,
                                      ApplicationDiscoveryException

Creates one or more tags for configuration items. Tags are metadata that help you categorize IT assets. This API accepts a list of multiple configuration items.

Parameters:

createTagsRequest -

Returns:

Result of the CreateTags operation returned by the service.

Throws:

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

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.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

deleteApplications

default DeleteApplicationsResponse deleteApplications(DeleteApplicationsRequest deleteApplicationsRequest)
                                               throws AuthorizationErrorException,
                                                      InvalidParameterException,
                                                      InvalidParameterValueException,
                                                      ServerInternalErrorException,
                                                      SdkBaseException,
                                                      SdkClientException,
                                                      ApplicationDiscoveryException

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

Parameters:

deleteApplicationsRequest -

Returns:

Result of the DeleteApplications operation returned by the service.

Throws:

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

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.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

deleteTags

default DeleteTagsResponse deleteTags(DeleteTagsRequest deleteTagsRequest)
                               throws AuthorizationErrorException,
                                      ResourceNotFoundException,
                                      InvalidParameterException,
                                      InvalidParameterValueException,
                                      ServerInternalErrorException,
                                      SdkBaseException,
                                      SdkClientException,
                                      ApplicationDiscoveryException

Deletes the association between configuration items and one or more tags. This API accepts a list of multiple configuration items.

Parameters:

deleteTagsRequest -

Returns:

Result of the DeleteTags operation returned by the service.

Throws:

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

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.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

describeAgents

default DescribeAgentsResponse describeAgents(DescribeAgentsRequest describeAgentsRequest)
                                       throws AuthorizationErrorException,
                                              InvalidParameterException,
                                              InvalidParameterValueException,
                                              ServerInternalErrorException,
                                              SdkBaseException,
                                              SdkClientException,
                                              ApplicationDiscoveryException

Lists agents or the Connector by ID or lists all agents/Connectors associated with your user account if you did not specify an ID.

Parameters:

describeAgentsRequest -

Returns:

Result of the DescribeAgents operation returned by the service.

Throws:

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

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.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

describeConfigurations

default DescribeConfigurationsResponse describeConfigurations(DescribeConfigurationsRequest describeConfigurationsRequest)
                                                       throws AuthorizationErrorException,
                                                              InvalidParameterException,
                                                              InvalidParameterValueException,
                                                              ServerInternalErrorException,
                                                              SdkBaseException,
                                                              SdkClientException,
                                                              ApplicationDiscoveryException

Retrieves attributes for a list of configuration item IDs. All of the supplied IDs must be for the same asset type (server, application, process, or connection). Output fields are specific to the asset type selected. For example, the output for a server configuration item includes a list of attributes about the server, such as host name, operating system, and number of network cards.

For a complete list of outputs for each asset type, see Using the DescribeConfigurations Action.

Parameters:

describeConfigurationsRequest -

Returns:

Result of the DescribeConfigurations operation returned by the service.

Throws:

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

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.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

describeExportConfigurations

default DescribeExportConfigurationsResponse describeExportConfigurations(DescribeExportConfigurationsRequest describeExportConfigurationsRequest)
                                                                   throws AuthorizationErrorException,
                                                                          ResourceNotFoundException,
                                                                          InvalidParameterException,
                                                                          InvalidParameterValueException,
                                                                          ServerInternalErrorException,
                                                                          SdkBaseException,
                                                                          SdkClientException,
                                                                          ApplicationDiscoveryException

Deprecated. Use DescribeExportTasks instead.

Retrieves the status of a given export process. You can retrieve status from a maximum of 100 processes.

Parameters:

describeExportConfigurationsRequest -

Returns:

Result of the DescribeExportConfigurations operation returned by the service.

Throws:

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

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.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

describeExportTasks

default DescribeExportTasksResponse describeExportTasks(DescribeExportTasksRequest describeExportTasksRequest)
                                                 throws AuthorizationErrorException,
                                                        InvalidParameterException,
                                                        InvalidParameterValueException,
                                                        ServerInternalErrorException,
                                                        SdkBaseException,
                                                        SdkClientException,
                                                        ApplicationDiscoveryException

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

Parameters:

describeExportTasksRequest -

Returns:

Result of the DescribeExportTasks operation returned by the service.

Throws:

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

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.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

describeTags

default DescribeTagsResponse describeTags(DescribeTagsRequest describeTagsRequest)
                                   throws AuthorizationErrorException,
                                          ResourceNotFoundException,
                                          InvalidParameterException,
                                          InvalidParameterValueException,
                                          ServerInternalErrorException,
                                          SdkBaseException,
                                          SdkClientException,
                                          ApplicationDiscoveryException

Retrieves a list of configuration items that are tagged with a specific tag. Or retrieves a list of all tags assigned to a specific configuration item.

Parameters:

describeTagsRequest -

Returns:

Result of the DescribeTags operation returned by the service.

Throws:

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

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.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

disassociateConfigurationItemsFromApplication

default DisassociateConfigurationItemsFromApplicationResponse disassociateConfigurationItemsFromApplication(DisassociateConfigurationItemsFromApplicationRequest disassociateConfigurationItemsFromApplicationRequest)
                                                                                                     throws AuthorizationErrorException,
                                                                                                            InvalidParameterException,
                                                                                                            InvalidParameterValueException,
                                                                                                            ServerInternalErrorException,
                                                                                                            SdkBaseException,
                                                                                                            SdkClientException,
                                                                                                            ApplicationDiscoveryException

Disassociates one or more configuration items from an application.

Parameters:

disassociateConfigurationItemsFromApplicationRequest -

Returns:

Result of the DisassociateConfigurationItemsFromApplication operation returned by the service.

Throws:

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

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.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

exportConfigurations

default ExportConfigurationsResponse exportConfigurations(ExportConfigurationsRequest exportConfigurationsRequest)
                                                   throws AuthorizationErrorException,
                                                          InvalidParameterException,
                                                          InvalidParameterValueException,
                                                          ServerInternalErrorException,
                                                          OperationNotPermittedException,
                                                          SdkBaseException,
                                                          SdkClientException,
                                                          ApplicationDiscoveryException

Deprecated. Use StartExportTask instead.

Exports all discovered configuration data to an Amazon S3 bucket or an application that enables you to view and evaluate the data. Data includes tags and tag associations, processes, connections, servers, and system performance. This API returns an export ID that you can query using the DescribeExportConfigurations API. The system imposes a limit of two configuration exports in six hours.

Parameters:

exportConfigurationsRequest -

Returns:

Result of the ExportConfigurations operation returned by the service.

Throws:

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

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.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getDiscoverySummary

default GetDiscoverySummaryResponse getDiscoverySummary(GetDiscoverySummaryRequest getDiscoverySummaryRequest)
                                                 throws AuthorizationErrorException,
                                                        InvalidParameterException,
                                                        InvalidParameterValueException,
                                                        ServerInternalErrorException,
                                                        SdkBaseException,
                                                        SdkClientException,
                                                        ApplicationDiscoveryException

Retrieves a short summary of discovered assets.

Parameters:

getDiscoverySummaryRequest -

Returns:

Result of the GetDiscoverySummary operation returned by the service.

Throws:

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

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.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

listConfigurations

default ListConfigurationsResponse listConfigurations(ListConfigurationsRequest listConfigurationsRequest)
                                               throws AuthorizationErrorException,
                                                      ResourceNotFoundException,
                                                      InvalidParameterException,
                                                      InvalidParameterValueException,
                                                      ServerInternalErrorException,
                                                      SdkBaseException,
                                                      SdkClientException,
                                                      ApplicationDiscoveryException

Retrieves a list of configuration items according to criteria that you specify in a filter. The filter criteria identifies the relationship requirements.

Parameters:

listConfigurationsRequest -

Returns:

Result of the ListConfigurations operation returned by the service.

Throws:

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

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.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

listServerNeighbors

default ListServerNeighborsResponse listServerNeighbors(ListServerNeighborsRequest listServerNeighborsRequest)
                                                 throws AuthorizationErrorException,
                                                        InvalidParameterException,
                                                        InvalidParameterValueException,
                                                        ServerInternalErrorException,
                                                        SdkBaseException,
                                                        SdkClientException,
                                                        ApplicationDiscoveryException

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

Parameters:

listServerNeighborsRequest -

Returns:

Result of the ListServerNeighbors operation returned by the service.

Throws:

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

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.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

startDataCollectionByAgentIds

default StartDataCollectionByAgentIdsResponse startDataCollectionByAgentIds(StartDataCollectionByAgentIdsRequest startDataCollectionByAgentIdsRequest)
                                                                     throws AuthorizationErrorException,
                                                                            InvalidParameterException,
                                                                            InvalidParameterValueException,
                                                                            ServerInternalErrorException,
                                                                            SdkBaseException,
                                                                            SdkClientException,
                                                                            ApplicationDiscoveryException

Instructs the specified agents or connectors to start collecting data.

Parameters:

startDataCollectionByAgentIdsRequest -

Returns:

Result of the StartDataCollectionByAgentIds operation returned by the service.

Throws:

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

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.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

startExportTask

default StartExportTaskResponse startExportTask(StartExportTaskRequest startExportTaskRequest)
                                         throws AuthorizationErrorException,
                                                InvalidParameterException,
                                                InvalidParameterValueException,
                                                ServerInternalErrorException,
                                                OperationNotPermittedException,
                                                SdkBaseException,
                                                SdkClientException,
                                                ApplicationDiscoveryException

Export the configuration data about discovered configuration items and relationships to an S3 bucket in a specified format.

Parameters:

startExportTaskRequest -

Returns:

Result of the StartExportTask operation returned by the service.

Throws:

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

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.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

stopDataCollectionByAgentIds

default StopDataCollectionByAgentIdsResponse stopDataCollectionByAgentIds(StopDataCollectionByAgentIdsRequest stopDataCollectionByAgentIdsRequest)
                                                                   throws AuthorizationErrorException,
                                                                          InvalidParameterException,
                                                                          InvalidParameterValueException,
                                                                          ServerInternalErrorException,
                                                                          SdkBaseException,
                                                                          SdkClientException,
                                                                          ApplicationDiscoveryException

Instructs the specified agents or connectors to stop collecting data.

Parameters:

stopDataCollectionByAgentIdsRequest -

Returns:

Result of the StopDataCollectionByAgentIds operation returned by the service.

Throws:

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

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.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

updateApplication

default UpdateApplicationResponse updateApplication(UpdateApplicationRequest updateApplicationRequest)
                                             throws AuthorizationErrorException,
                                                    InvalidParameterException,
                                                    InvalidParameterValueException,
                                                    ServerInternalErrorException,
                                                    SdkBaseException,
                                                    SdkClientException,
                                                    ApplicationDiscoveryException

Updates metadata about an application.

Parameters:

updateApplicationRequest -

Returns:

Result of the UpdateApplication operation returned by the service.

Throws:

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

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.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

serviceMetadata

static ServiceMetadata serviceMetadata()