aws-sdk
Version:
AWS SDK for JavaScript
783 lines (782 loc) • 78.7 kB
TypeScript
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class Discovery extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: Discovery.Types.ClientConfiguration)
config: Config & Discovery.Types.ClientConfiguration;
/**
* Associates one or more configuration items with an application.
*/
associateConfigurationItemsToApplication(params: Discovery.Types.AssociateConfigurationItemsToApplicationRequest, callback?: (err: AWSError, data: Discovery.Types.AssociateConfigurationItemsToApplicationResponse) => void): Request<Discovery.Types.AssociateConfigurationItemsToApplicationResponse, AWSError>;
/**
* Associates one or more configuration items with an application.
*/
associateConfigurationItemsToApplication(callback?: (err: AWSError, data: Discovery.Types.AssociateConfigurationItemsToApplicationResponse) => void): Request<Discovery.Types.AssociateConfigurationItemsToApplicationResponse, AWSError>;
/**
* 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.
*/
batchDeleteAgents(params: Discovery.Types.BatchDeleteAgentsRequest, callback?: (err: AWSError, data: Discovery.Types.BatchDeleteAgentsResponse) => void): Request<Discovery.Types.BatchDeleteAgentsResponse, AWSError>;
/**
* 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.
*/
batchDeleteAgents(callback?: (err: AWSError, data: Discovery.Types.BatchDeleteAgentsResponse) => void): Request<Discovery.Types.BatchDeleteAgentsResponse, AWSError>;
/**
* 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.
*/
batchDeleteImportData(params: Discovery.Types.BatchDeleteImportDataRequest, callback?: (err: AWSError, data: Discovery.Types.BatchDeleteImportDataResponse) => void): Request<Discovery.Types.BatchDeleteImportDataResponse, AWSError>;
/**
* 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.
*/
batchDeleteImportData(callback?: (err: AWSError, data: Discovery.Types.BatchDeleteImportDataResponse) => void): Request<Discovery.Types.BatchDeleteImportDataResponse, AWSError>;
/**
* Creates an application with the given name and description.
*/
createApplication(params: Discovery.Types.CreateApplicationRequest, callback?: (err: AWSError, data: Discovery.Types.CreateApplicationResponse) => void): Request<Discovery.Types.CreateApplicationResponse, AWSError>;
/**
* Creates an application with the given name and description.
*/
createApplication(callback?: (err: AWSError, data: Discovery.Types.CreateApplicationResponse) => void): Request<Discovery.Types.CreateApplicationResponse, AWSError>;
/**
* 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.
*/
createTags(params: Discovery.Types.CreateTagsRequest, callback?: (err: AWSError, data: Discovery.Types.CreateTagsResponse) => void): Request<Discovery.Types.CreateTagsResponse, AWSError>;
/**
* 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.
*/
createTags(callback?: (err: AWSError, data: Discovery.Types.CreateTagsResponse) => void): Request<Discovery.Types.CreateTagsResponse, AWSError>;
/**
* Deletes a list of applications and their associations with configuration items.
*/
deleteApplications(params: Discovery.Types.DeleteApplicationsRequest, callback?: (err: AWSError, data: Discovery.Types.DeleteApplicationsResponse) => void): Request<Discovery.Types.DeleteApplicationsResponse, AWSError>;
/**
* Deletes a list of applications and their associations with configuration items.
*/
deleteApplications(callback?: (err: AWSError, data: Discovery.Types.DeleteApplicationsResponse) => void): Request<Discovery.Types.DeleteApplicationsResponse, AWSError>;
/**
* Deletes the association between configuration items and one or more tags. This API accepts a list of multiple configuration items.
*/
deleteTags(params: Discovery.Types.DeleteTagsRequest, callback?: (err: AWSError, data: Discovery.Types.DeleteTagsResponse) => void): Request<Discovery.Types.DeleteTagsResponse, AWSError>;
/**
* Deletes the association between configuration items and one or more tags. This API accepts a list of multiple configuration items.
*/
deleteTags(callback?: (err: AWSError, data: Discovery.Types.DeleteTagsResponse) => void): Request<Discovery.Types.DeleteTagsResponse, AWSError>;
/**
* 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.
*/
describeAgents(params: Discovery.Types.DescribeAgentsRequest, callback?: (err: AWSError, data: Discovery.Types.DescribeAgentsResponse) => void): Request<Discovery.Types.DescribeAgentsResponse, AWSError>;
/**
* 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.
*/
describeAgents(callback?: (err: AWSError, data: Discovery.Types.DescribeAgentsResponse) => void): Request<Discovery.Types.DescribeAgentsResponse, AWSError>;
/**
* Takes a unique deletion task identifier as input and returns metadata about a configuration deletion task.
*/
describeBatchDeleteConfigurationTask(params: Discovery.Types.DescribeBatchDeleteConfigurationTaskRequest, callback?: (err: AWSError, data: Discovery.Types.DescribeBatchDeleteConfigurationTaskResponse) => void): Request<Discovery.Types.DescribeBatchDeleteConfigurationTaskResponse, AWSError>;
/**
* Takes a unique deletion task identifier as input and returns metadata about a configuration deletion task.
*/
describeBatchDeleteConfigurationTask(callback?: (err: AWSError, data: Discovery.Types.DescribeBatchDeleteConfigurationTaskResponse) => void): Request<Discovery.Types.DescribeBatchDeleteConfigurationTaskResponse, AWSError>;
/**
* 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.
*/
describeConfigurations(params: Discovery.Types.DescribeConfigurationsRequest, callback?: (err: AWSError, data: Discovery.Types.DescribeConfigurationsResponse) => void): Request<Discovery.Types.DescribeConfigurationsResponse, AWSError>;
/**
* 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.
*/
describeConfigurations(callback?: (err: AWSError, data: Discovery.Types.DescribeConfigurationsResponse) => void): Request<Discovery.Types.DescribeConfigurationsResponse, AWSError>;
/**
* 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.
*/
describeContinuousExports(params: Discovery.Types.DescribeContinuousExportsRequest, callback?: (err: AWSError, data: Discovery.Types.DescribeContinuousExportsResponse) => void): Request<Discovery.Types.DescribeContinuousExportsResponse, AWSError>;
/**
* 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.
*/
describeContinuousExports(callback?: (err: AWSError, data: Discovery.Types.DescribeContinuousExportsResponse) => void): Request<Discovery.Types.DescribeContinuousExportsResponse, AWSError>;
/**
* DescribeExportConfigurations is deprecated. Use DescribeExportTasks, instead.
*/
describeExportConfigurations(params: Discovery.Types.DescribeExportConfigurationsRequest, callback?: (err: AWSError, data: Discovery.Types.DescribeExportConfigurationsResponse) => void): Request<Discovery.Types.DescribeExportConfigurationsResponse, AWSError>;
/**
* DescribeExportConfigurations is deprecated. Use DescribeExportTasks, instead.
*/
describeExportConfigurations(callback?: (err: AWSError, data: Discovery.Types.DescribeExportConfigurationsResponse) => void): Request<Discovery.Types.DescribeExportConfigurationsResponse, AWSError>;
/**
* Retrieve status of one or more export tasks. You can retrieve the status of up to 100 export tasks.
*/
describeExportTasks(params: Discovery.Types.DescribeExportTasksRequest, callback?: (err: AWSError, data: Discovery.Types.DescribeExportTasksResponse) => void): Request<Discovery.Types.DescribeExportTasksResponse, AWSError>;
/**
* Retrieve status of one or more export tasks. You can retrieve the status of up to 100 export tasks.
*/
describeExportTasks(callback?: (err: AWSError, data: Discovery.Types.DescribeExportTasksResponse) => void): Request<Discovery.Types.DescribeExportTasksResponse, AWSError>;
/**
* 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(params: Discovery.Types.DescribeImportTasksRequest, callback?: (err: AWSError, data: Discovery.Types.DescribeImportTasksResponse) => void): Request<Discovery.Types.DescribeImportTasksResponse, AWSError>;
/**
* 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(callback?: (err: AWSError, data: Discovery.Types.DescribeImportTasksResponse) => void): Request<Discovery.Types.DescribeImportTasksResponse, AWSError>;
/**
* 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.
*/
describeTags(params: Discovery.Types.DescribeTagsRequest, callback?: (err: AWSError, data: Discovery.Types.DescribeTagsResponse) => void): Request<Discovery.Types.DescribeTagsResponse, AWSError>;
/**
* 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.
*/
describeTags(callback?: (err: AWSError, data: Discovery.Types.DescribeTagsResponse) => void): Request<Discovery.Types.DescribeTagsResponse, AWSError>;
/**
* Disassociates one or more configuration items from an application.
*/
disassociateConfigurationItemsFromApplication(params: Discovery.Types.DisassociateConfigurationItemsFromApplicationRequest, callback?: (err: AWSError, data: Discovery.Types.DisassociateConfigurationItemsFromApplicationResponse) => void): Request<Discovery.Types.DisassociateConfigurationItemsFromApplicationResponse, AWSError>;
/**
* Disassociates one or more configuration items from an application.
*/
disassociateConfigurationItemsFromApplication(callback?: (err: AWSError, data: Discovery.Types.DisassociateConfigurationItemsFromApplicationResponse) => void): Request<Discovery.Types.DisassociateConfigurationItemsFromApplicationResponse, AWSError>;
/**
* 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.
*/
exportConfigurations(callback?: (err: AWSError, data: Discovery.Types.ExportConfigurationsResponse) => void): Request<Discovery.Types.ExportConfigurationsResponse, AWSError>;
/**
* 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.
*/
getDiscoverySummary(params: Discovery.Types.GetDiscoverySummaryRequest, callback?: (err: AWSError, data: Discovery.Types.GetDiscoverySummaryResponse) => void): Request<Discovery.Types.GetDiscoverySummaryResponse, AWSError>;
/**
* 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.
*/
getDiscoverySummary(callback?: (err: AWSError, data: Discovery.Types.GetDiscoverySummaryResponse) => void): Request<Discovery.Types.GetDiscoverySummaryResponse, AWSError>;
/**
* 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.
*/
listConfigurations(params: Discovery.Types.ListConfigurationsRequest, callback?: (err: AWSError, data: Discovery.Types.ListConfigurationsResponse) => void): Request<Discovery.Types.ListConfigurationsResponse, AWSError>;
/**
* 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.
*/
listConfigurations(callback?: (err: AWSError, data: Discovery.Types.ListConfigurationsResponse) => void): Request<Discovery.Types.ListConfigurationsResponse, AWSError>;
/**
* Retrieves a list of servers that are one network hop away from a specified server.
*/
listServerNeighbors(params: Discovery.Types.ListServerNeighborsRequest, callback?: (err: AWSError, data: Discovery.Types.ListServerNeighborsResponse) => void): Request<Discovery.Types.ListServerNeighborsResponse, AWSError>;
/**
* Retrieves a list of servers that are one network hop away from a specified server.
*/
listServerNeighbors(callback?: (err: AWSError, data: Discovery.Types.ListServerNeighborsResponse) => void): Request<Discovery.Types.ListServerNeighborsResponse, AWSError>;
/**
* Takes a list of configurationId as input and starts an asynchronous deletion task to remove the configurationItems. Returns a unique deletion task identifier.
*/
startBatchDeleteConfigurationTask(params: Discovery.Types.StartBatchDeleteConfigurationTaskRequest, callback?: (err: AWSError, data: Discovery.Types.StartBatchDeleteConfigurationTaskResponse) => void): Request<Discovery.Types.StartBatchDeleteConfigurationTaskResponse, AWSError>;
/**
* Takes a list of configurationId as input and starts an asynchronous deletion task to remove the configurationItems. Returns a unique deletion task identifier.
*/
startBatchDeleteConfigurationTask(callback?: (err: AWSError, data: Discovery.Types.StartBatchDeleteConfigurationTaskResponse) => void): Request<Discovery.Types.StartBatchDeleteConfigurationTaskResponse, AWSError>;
/**
* Start the continuous flow of agent's discovered data into Amazon Athena.
*/
startContinuousExport(params: Discovery.Types.StartContinuousExportRequest, callback?: (err: AWSError, data: Discovery.Types.StartContinuousExportResponse) => void): Request<Discovery.Types.StartContinuousExportResponse, AWSError>;
/**
* Start the continuous flow of agent's discovered data into Amazon Athena.
*/
startContinuousExport(callback?: (err: AWSError, data: Discovery.Types.StartContinuousExportResponse) => void): Request<Discovery.Types.StartContinuousExportResponse, AWSError>;
/**
* Instructs the specified agents to start collecting data.
*/
startDataCollectionByAgentIds(params: Discovery.Types.StartDataCollectionByAgentIdsRequest, callback?: (err: AWSError, data: Discovery.Types.StartDataCollectionByAgentIdsResponse) => void): Request<Discovery.Types.StartDataCollectionByAgentIdsResponse, AWSError>;
/**
* Instructs the specified agents to start collecting data.
*/
startDataCollectionByAgentIds(callback?: (err: AWSError, data: Discovery.Types.StartDataCollectionByAgentIdsResponse) => void): Request<Discovery.Types.StartDataCollectionByAgentIdsResponse, AWSError>;
/**
* Begins the export of a discovered data report to an Amazon S3 bucket managed by Amazon Web Services. Exports might provide an estimate of fees and savings based on certain information that you provide. Fee estimates do not include any taxes that might apply. Your actual fees and savings depend on a variety of factors, including your actual usage of Amazon Web Services services, which might vary from the estimates provided in this report. If you do not specify preferences or agentIds in the filter, a summary of all servers, applications, tags, and performance is generated. This data is an aggregation of all server data collected through on-premises tooling, file import, application grouping and applying tags. If you specify agentIds in a filter, the task exports up to 72 hours of detailed data collected by the identified Application Discovery Agent, including network, process, and performance details. A time range for exported agent data may be set by using startTime and endTime. Export of detailed agent data is limited to five concurrently running exports. Export of detailed agent data is limited to two exports per day. If you enable ec2RecommendationsPreferences in preferences , an Amazon EC2 instance matching the characteristics of each server in Application Discovery Service is generated. Changing the attributes of the ec2RecommendationsPreferences changes the criteria of the recommendation.
*/
startExportTask(params: Discovery.Types.StartExportTaskRequest, callback?: (err: AWSError, data: Discovery.Types.StartExportTaskResponse) => void): Request<Discovery.Types.StartExportTaskResponse, AWSError>;
/**
* Begins the export of a discovered data report to an Amazon S3 bucket managed by Amazon Web Services. Exports might provide an estimate of fees and savings based on certain information that you provide. Fee estimates do not include any taxes that might apply. Your actual fees and savings depend on a variety of factors, including your actual usage of Amazon Web Services services, which might vary from the estimates provided in this report. If you do not specify preferences or agentIds in the filter, a summary of all servers, applications, tags, and performance is generated. This data is an aggregation of all server data collected through on-premises tooling, file import, application grouping and applying tags. If you specify agentIds in a filter, the task exports up to 72 hours of detailed data collected by the identified Application Discovery Agent, including network, process, and performance details. A time range for exported agent data may be set by using startTime and endTime. Export of detailed agent data is limited to five concurrently running exports. Export of detailed agent data is limited to two exports per day. If you enable ec2RecommendationsPreferences in preferences , an Amazon EC2 instance matching the characteristics of each server in Application Discovery Service is generated. Changing the attributes of the ec2RecommendationsPreferences changes the criteria of the recommendation.
*/
startExportTask(callback?: (err: AWSError, data: Discovery.Types.StartExportTaskResponse) => void): Request<Discovery.Types.StartExportTaskResponse, AWSError>;
/**
* 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.
*/
startImportTask(params: Discovery.Types.StartImportTaskRequest, callback?: (err: AWSError, data: Discovery.Types.StartImportTaskResponse) => void): Request<Discovery.Types.StartImportTaskResponse, AWSError>;
/**
* 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.
*/
startImportTask(callback?: (err: AWSError, data: Discovery.Types.StartImportTaskResponse) => void): Request<Discovery.Types.StartImportTaskResponse, AWSError>;
/**
* Stop the continuous flow of agent's discovered data into Amazon Athena.
*/
stopContinuousExport(params: Discovery.Types.StopContinuousExportRequest, callback?: (err: AWSError, data: Discovery.Types.StopContinuousExportResponse) => void): Request<Discovery.Types.StopContinuousExportResponse, AWSError>;
/**
* Stop the continuous flow of agent's discovered data into Amazon Athena.
*/
stopContinuousExport(callback?: (err: AWSError, data: Discovery.Types.StopContinuousExportResponse) => void): Request<Discovery.Types.StopContinuousExportResponse, AWSError>;
/**
* Instructs the specified agents to stop collecting data.
*/
stopDataCollectionByAgentIds(params: Discovery.Types.StopDataCollectionByAgentIdsRequest, callback?: (err: AWSError, data: Discovery.Types.StopDataCollectionByAgentIdsResponse) => void): Request<Discovery.Types.StopDataCollectionByAgentIdsResponse, AWSError>;
/**
* Instructs the specified agents to stop collecting data.
*/
stopDataCollectionByAgentIds(callback?: (err: AWSError, data: Discovery.Types.StopDataCollectionByAgentIdsResponse) => void): Request<Discovery.Types.StopDataCollectionByAgentIdsResponse, AWSError>;
/**
* Updates metadata about an application.
*/
updateApplication(params: Discovery.Types.UpdateApplicationRequest, callback?: (err: AWSError, data: Discovery.Types.UpdateApplicationResponse) => void): Request<Discovery.Types.UpdateApplicationResponse, AWSError>;
/**
* Updates metadata about an application.
*/
updateApplication(callback?: (err: AWSError, data: Discovery.Types.UpdateApplicationResponse) => void): Request<Discovery.Types.UpdateApplicationResponse, AWSError>;
}
declare namespace Discovery {
export interface AgentConfigurationStatus {
/**
* The agent ID.
*/
agentId?: String;
/**
* Information about the status of the StartDataCollection and StopDataCollection operations. The system has recorded the data collection operation. The agent receives this command the next time it polls for a new command.
*/
operationSucceeded?: Boolean;
/**
* A description of the operation performed.
*/
description?: String;
}
export type AgentConfigurationStatusList = AgentConfigurationStatus[];
export type AgentId = string;
export type AgentIds = AgentId[];
export interface AgentInfo {
/**
* The agent or collector ID.
*/
agentId?: AgentId;
/**
* The name of the host where the agent or collector resides. The host can be a server or virtual machine.
*/
hostName?: String;
/**
* Network details about the host where the agent or collector resides.
*/
agentNetworkInfoList?: AgentNetworkInfoList;
/**
* The ID of the connector.
*/
connectorId?: String;
/**
* The agent or collector version.
*/
version?: String;
/**
* The health of the agent.
*/
health?: AgentStatus;
/**
* Time since agent health was reported.
*/
lastHealthPingTime?: String;
/**
* Status of the collection process for an agent.
*/
collectionStatus?: String;
/**
* Type of agent.
*/
agentType?: String;
/**
* Agent's first registration timestamp in UTC.
*/
registeredTime?: String;
}
export interface AgentNetworkInfo {
/**
* The IP address for the host where the agent/collector resides.
*/
ipAddress?: String;
/**
* The MAC address for the host where the agent/collector resides.
*/
macAddress?: String;
}
export type AgentNetworkInfoList = AgentNetworkInfo[];
export type AgentStatus = "HEALTHY"|"UNHEALTHY"|"RUNNING"|"UNKNOWN"|"BLACKLISTED"|"SHUTDOWN"|string;
export type AgentsInfo = AgentInfo[];
export type ApplicationDescription = string;
export type ApplicationId = string;
export type ApplicationIdsList = ApplicationId[];
export type ApplicationName = string;
export interface AssociateConfigurationItemsToApplicationRequest {
/**
* The configuration ID of an application with which items are to be associated.
*/
applicationConfigurationId: ApplicationId;
/**
* The ID of each configuration item to be associated with an application.
*/
configurationIds: ConfigurationIdList;
}
export interface AssociateConfigurationItemsToApplicationResponse {
}
export interface BatchDeleteAgentError {
/**
* The ID of the agent or data collector to delete.
*/
agentId: AgentId;
/**
* The description of the error that occurred for the delete failed agent.
*/
errorMessage: String;
/**
* The type of error that occurred for the delete failed agent. Valid status are: AGENT_IN_USE | NOT_FOUND | INTERNAL_SERVER_ERROR.
*/
errorCode: DeleteAgentErrorCode;
}
export type BatchDeleteAgentErrors = BatchDeleteAgentError[];
export interface BatchDeleteAgentsRequest {
/**
* The list of agents to delete.
*/
deleteAgents: DeleteAgents;
}
export interface BatchDeleteAgentsResponse {
/**
* A list of agent IDs that failed to delete during the deletion task, each paired with an error message.
*/
errors?: BatchDeleteAgentErrors;
}
export interface BatchDeleteConfigurationTask {
/**
* The deletion task's unique identifier.
*/
taskId?: UUID;
/**
* The current execution status of the deletion task. Valid status are: INITIALIZING | VALIDATING | DELETING | COMPLETED | FAILED.
*/
status?: BatchDeleteConfigurationTaskStatus;
/**
* An epoch seconds timestamp (UTC) of when the deletion task was started.
*/
startTime?: TimeStamp;
/**
* An epoch seconds timestamp (UTC) of when the deletion task was completed or failed.
*/
endTime?: TimeStamp;
/**
* The type of configuration item to delete. Supported types are: SERVER.
*/
configurationType?: DeletionConfigurationItemType;
/**
* The list of configuration IDs that were originally requested to be deleted by the deletion task.
*/
requestedConfigurations?: ConfigurationIdList;
/**
* The list of configuration IDs that were successfully deleted by the deletion task.
*/
deletedConfigurations?: ConfigurationIdList;
/**
* A list of configuration IDs that failed to delete during the deletion task, each paired with an error message.
*/
failedConfigurations?: FailedConfigurationList;
/**
* A list of configuration IDs that produced warnings regarding their deletion, paired with a warning message.
*/
deletionWarnings?: DeletionWarningsList;
}
export type BatchDeleteConfigurationTaskStatus = "INITIALIZING"|"VALIDATING"|"DELETING"|"COMPLETED"|"FAILED"|string;
export interface BatchDeleteImportDataError {
/**
* The unique import ID associated with the error that occurred.
*/
importTaskId?: ImportTaskIdentifier;
/**
* The type of error that occurred for a specific import task.
*/
errorCode?: BatchDeleteImportDataErrorCode;
/**
* The description of the error that occurred for a specific import task.
*/
errorDescription?: BatchDeleteImportDataErrorDescription;
}
export type BatchDeleteImportDataErrorCode = "NOT_FOUND"|"INTERNAL_SERVER_ERROR"|"OVER_LIMIT"|string;
export type BatchDeleteImportDataErrorDescription = string;
export type BatchDeleteImportDataErrorList = BatchDeleteImportDataError[];
export interface BatchDeleteImportDataRequest {
/**
* The IDs for the import tasks that you want to delete.
*/
importTaskIds: ToDeleteIdentifierList;
/**
* Set to true to remove the deleted import task from DescribeImportTasks.
*/
deleteHistory?: Boolean;
}
export interface BatchDeleteImportDataResponse {
/**
* Error messages returned for each import task that you deleted as a response for this command.
*/
errors?: BatchDeleteImportDataErrorList;
}
export type Boolean = boolean;
export type BoxedInteger = number;
export type ClientRequestToken = string;
export type Condition = string;
export type Configuration = {[key: string]: String};
export type ConfigurationId = string;
export type ConfigurationIdList = ConfigurationId[];
export type ConfigurationItemType = "SERVER"|"PROCESS"|"CONNECTION"|"APPLICATION"|string;
export interface ConfigurationTag {
/**
* A type of IT asset to tag.
*/
configurationType?: ConfigurationItemType;
/**
* The configuration ID for the item to tag. You can specify a list of keys and values.
*/
configurationId?: ConfigurationId;
/**
* A type of tag on which to filter. For example, serverType.
*/
key?: TagKey;
/**
* A value on which to filter. For example key = serverType and value = web server.
*/
value?: TagValue;
/**
* The time the configuration tag was created in Coordinated Universal Time (UTC).
*/
timeOfCreation?: TimeStamp;
}
export type ConfigurationTagSet = ConfigurationTag[];
export type Configurations = Configuration[];
export type ConfigurationsDownloadUrl = string;
export type ConfigurationsExportId = string;
export interface ContinuousExportDescription {
/**
* The unique ID assigned to this export.
*/
exportId?: ConfigurationsExportId;
/**
* Describes the status of the export. Can be one of the following values: START_IN_PROGRESS - setting up resources to start continuous export. START_FAILED - an error occurred setting up continuous export. To recover, call start-continuous-export again. ACTIVE - data is being exported to the customer bucket. ERROR - an error occurred during export. To fix the issue, call stop-continuous-export and start-continuous-export. STOP_IN_PROGRESS - stopping the export. STOP_FAILED - an error occurred stopping the export. To recover, call stop-continuous-export again. INACTIVE - the continuous export has been stopped. Data is no longer being exported to the customer bucket.
*/
status?: ContinuousExportStatus;
/**
* Contains information about any errors that have occurred. This data type can have the following values: ACCESS_DENIED - You don’t have permission to start Data Exploration in Amazon Athena. Contact your Amazon Web Services administrator for help. For more information, see Setting Up Amazon Web Services Application Discovery Service in the Application Discovery Service User Guide. DELIVERY_STREAM_LIMIT_FAILURE - You reached the limit for Amazon Kinesis Data Firehose delivery streams. Reduce the number of streams or request a limit increase and try again. For more information, see Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide. FIREHOSE_ROLE_MISSING - The Data Exploration feature is in an error state because your user is missing the Amazon Web ServicesApplicationDiscoveryServiceFirehose role. Turn on Data Exploration in Amazon Athena and try again. For more information, see Creating the Amazon Web ServicesApplicationDiscoveryServiceFirehose Role in the Application Discovery Service User Guide. FIREHOSE_STREAM_DOES_NOT_EXIST - The Data Exploration feature is in an error state because your user is missing one or more of the Kinesis data delivery streams. INTERNAL_FAILURE - The Data Exploration feature is in an error state because of an internal failure. Try again later. If this problem persists, contact Amazon Web Services Support. LAKE_FORMATION_ACCESS_DENIED - You don't have sufficient lake formation permissions to start continuous export. For more information, see Upgrading Amazon Web Services Glue Data Permissions to the Amazon Web Services Lake Formation Model in the Amazon Web Services Lake Formation Developer Guide. You can use one of the following two ways to resolve this issue. If you don’t want to use the Lake Formation permission model, you can change the default Data Catalog settings to use only Amazon Web Services Identity and Access Management (IAM) access control for new databases. For more information, see Change Data Catalog Settings in the Lake Formation Developer Guide. You can give the service-linked IAM roles AWSServiceRoleForApplicationDiscoveryServiceContinuousExport and AWSApplicationDiscoveryServiceFirehose the required Lake Formation permissions. For more information, see Granting Database Permissions in the Lake Formation Developer Guide. AWSServiceRoleForApplicationDiscoveryServiceContinuousExport - Grant database creator permissions, which gives the role database creation ability and implicit permissions for any created tables. For more information, see Implicit Lake Formation Permissions in the Lake Formation Developer Guide. AWSApplicationDiscoveryServiceFirehose - Grant describe permissions for all tables in the database. S3_BUCKET_LIMIT_FAILURE - You reached the limit for Amazon S3 buckets. Reduce the number of S3 buckets or request a limit increase and try again. For more information, see Bucket Restrictions and Limitations in the Amazon Simple Storage Service Developer Guide. S3_NOT_SIGNED_UP - Your account is not signed up for the Amazon S3 service. You must sign up before you can use Amazon S3. You can sign up at the following URL: https://aws.amazon.com/s3.
*/
statusDetail?: StringMax255;
/**
* The name of the s3 bucket where the export data parquet files are stored.
*/
s3Bucket?: S3Bucket;
/**
* The timestamp representing when the continuous export was started.
*/
startTime?: TimeStamp;
/**
* The timestamp that represents when this continuous export was stopped.
*/
stopTime?: TimeStamp;
/**
* The type of data collector used to gather this data (currently only offered for AGENT).
*/
dataSource?: DataSource;
/**
* An object which describes how the data is stored. databaseName - the name of the Glue database used to store the schema.
*/
schemaStorageConfig?: SchemaStorageConfig;
}
export type ContinuousExportDescriptions = ContinuousExportDescription[];
export type ContinuousExportIds = ConfigurationsExportId[];
export type ContinuousExportStatus = "START_IN_PROGRESS"|"START_FAILED"|"ACTIVE"|"ERROR"|"STOP_IN_PROGRESS"|"STOP_FAILED"|"INACTIVE"|string;
export interface CreateApplicationRequest {
/**
* Name of the application to be created.
*/
name: ApplicationName;
/**
* Description of the application to be created.
*/
description?: ApplicationDescription;
}
export interface CreateApplicationResponse {
/**
* Configuration ID of an application to be created.
*/
configurationId?: String;
}
export interface CreateTagsRequest {
/**
* A list of configuration items that you want to tag.
*/
configurationIds: ConfigurationIdList;
/**
* Tags that you want to associate with one or more configuration items. Specify the tags that you want to create in a key-value format. For example: {"key": "serverType", "value": "webServer"}
*/
tags: TagSet;
}
export interface CreateTagsResponse {
}
export interface CustomerAgentInfo {
/**
* Number of active discovery agents.
*/
activeAgents: Integer;
/**
* Number of healthy discovery agents
*/
healthyAgents: Integer;
/**
* Number of blacklisted discovery agents.
*/
blackListedAgents: Integer;
/**
* Number of discovery agents with status SHUTDOWN.
*/
shutdownAgents: Integer;
/**
* Number of unhealthy discovery agents.
*/
unhealthyAgents: Integer;
/**
* Total number of discovery agents.
*/
totalAgents: Integer;
/**
* Number of unknown discovery agents.
*/
unknownAgents: Integer;
}
export interface CustomerAgentlessCollectorInfo {
/**
* The number of active Agentless Collector collectors.
*/
activeAgentlessCollectors: Integer;
/**
* The number of healthy Agentless Collector collectors.
*/
healthyAgentlessCollectors: Integer;
/**
* The number of deny-listed Agentless Collector collectors.
*/
denyListedAgentlessCollectors: Integer;
/**
* The number of Agentless Collector collectors with SHUTDOWN status.
*/
shutdownAgentlessCollectors: Integer;
/**
* The number of unhealthy Agentless Collector collectors.
*/
unhealthyAgentlessCollectors: Integer;
/**
* The total number of Agentless Collector collectors.
*/
totalAgentlessCollectors: Integer;
/**
* The number of unknown Agentless Collector collectors.
*/
unknownAgentlessCollectors: Integer;
}
export interface CustomerConnectorInfo {
/**
* Number of active discovery connectors.
*/
activeConnectors: Integer;
/**
* Number of healthy discovery connectors.
*/
healthyConnectors: Integer;
/**
* Number of blacklisted discovery connectors.
*/
blackListedConnectors: Integer;
/**
* Number of discovery connectors with status SHUTDOWN,
*/
shutdownConnectors: Integer;
/**
* Number of unhealthy discovery connectors.
*/
unhealthyConnectors: Integer;
/**
* Total number of discovery connectors.
*/
totalConnectors: Integer;
/**
* Number of unknown discovery connectors.
*/
unknownConnectors: Integer;
}
export interface CustomerMeCollectorInfo {
/**
* The number of active Migration Evaluator collectors.
*/
activeMeCollectors: Integer;
/**
* The number of healthy Migration Evaluator collectors.
*/
healthyMeCollectors: Integer;
/**
* The number of deny-listed Migration Evaluator collectors.
*/
denyListedMeCollectors: Integer;
/**
* The number of Migration Evaluator collectors with SHUTDOWN status.
*/
shutdownMeCollectors: Integer;
/**
* The number of unhealthy Migration Evaluator collectors.
*/
unhealthyMeCollectors: Integer;
/**
* The total number of Migration Evaluator collectors.
*/
totalMeCollectors: Integer;
/**
* The number of unknown Migration Evaluator collectors.
*/
unknownMeCollectors: Integer;
}
export type DataSource = "AGENT"|string;
export type DatabaseName = string;
export interface DeleteAgent {
/**
* The ID of the agent or data collector to delete.
*/
agentId: AgentId;
/**
* Optional flag used to force delete an agent or data collector. It is needed to delete any agent in HEALTHY/UNHEALTHY/RUNNING status. Note that deleting an agent that is actively reporting health causes it to be re-registered with a different agent ID after data collector re-connects with Amazon Web Services.
*/
force?: Boolean;
}
export type DeleteAgentErrorCode = "NOT_FOUND"|"INTERNAL_SERVER_ERROR"|"AGENT_IN_USE"|string;
export type DeleteAgents = DeleteAgent[];
export interface DeleteApplicationsRequest {
/**
* Configuration ID of an application to be deleted.
*/
configurationIds: ApplicationIdsList;
}
export interface DeleteApplicationsResponse {
}
export interface DeleteTagsRequest {
/**
* A list of configuration items with tags that you want to delete.
*/
configurationIds: ConfigurationIdList;
/**
* Tags that you want to delete from one or more configuration items. Specify the tags that you want to delete in a key-value format. For example: {"key": "serverType", "value": "webServer"}
*/
tags?: TagSet;
}
export interface DeleteTagsResponse {
}
export type DeletionConfigurationItemType = "SERVER"|string;
export interface DeletionWarning {
/**
* The unique identifier of the configuration that produced a warning.
*/
configurationId?: ConfigurationId;
/**
* The integer warning code associated with the warning message.
*/
warningCode?: WarningCode;
/**
* A descriptive message of the warning the associated configuration ID produced.
*/
warningText?: WarningText;
}
export type DeletionWarningsList = DeletionWarning[];
export interface DescribeAgentsRequest {
/**
* The agent or the collector IDs for which you want information. If you specify no IDs, the system returns information about all agents/collectors associated with your user.
*/
agentIds?: AgentIds;
/**
* You can filter the request using various logical operators and a key-value format. For example: {"key": "collectionStatus", "value": "STARTED"}
*/
filters?: Filters;
/**
* The total number of agents/collectors to return in a single page of output. The maximum value is 100.
*/
maxResults?: Integer;
/**
* Token to retrieve the next set of results. For example, if you previously specified 100 IDs for DescribeAgentsRequest$agentIds but set DescribeAgentsRequest$maxResults to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10.
*/
nextToken?: NextToken;
}
export interface DescribeAgentsResponse {
/**
* Lists agents or the collector by ID or lists all agents/collectors associated with your user, if you did not specify an agent/collector ID. The output includes agent/collector IDs, IP addresses, media access control (MAC) addresses, agent/collector health, host name where the agent/collector resides, and the version number of each agent/collector.
*/
agentsInfo?: AgentsInfo;
/**
* Token to retrieve the next set of results. For example, if you specified 100 IDs for DescribeAgentsRequest$agentIds but set DescribeAgentsRequest$maxResults to 10, you received a set of 10 results along with this token. Use this token in the next query to retrieve the next set of 10.
*/
nextToken?: NextToken;
}
export interface DescribeBatchDeleteConfigurationTaskRequest {
/**
* The ID of the task to delete.
*/
taskId: UUID;
}
export interface DescribeBatchDeleteConfigurationTaskResponse {
/**
* The BatchDeleteConfigurationTask that represents the deletion task being executed.
*/
task?: BatchDeleteConfigurationTask;
}
export type DescribeConfigurationsAttribute = {[key: string]: String};
export type DescribeConfigurationsAttributes = DescribeConfigurationsAttribute[];
export interface DescribeConfigurationsRequest {
/**
* One or more configuration IDs.
*/
configurationIds: ConfigurationIdList;
}
export interface DescribeConfigurationsResponse {
/**
* A key in the response map. The value is an array of data.
*/
configurations?: DescribeConfigurationsAttributes;
}
export type DescribeContinuousExportsMaxResults = number;
export interface DescribeContinuousExportsRequest {
/**
* The unique IDs assigned to the exports.
*/
exportIds?: ContinuousExportIds;
/**
* A number between 1 and 100 specifying the maximum number of continuous export descriptions returned.
*/
maxResults?: DescribeContinuousExportsMaxResults;
/**
* The token from the previous call to DescribeExportTasks.
*/
nextToken?: NextToken;
}
export interface DescribeContinuousExportsResponse {
/**
* A list of continuous export descriptions.
*/
descriptions?: ContinuousExportDescriptions;
/**
* The token from the previous call to DescribeExportTasks.
*/
nextToken?: NextToken;
}
export interface DescribeExportConfigurationsRequest {
/**
* A list of continuous export IDs to search for.
*/
exportIds?: ExportIds;
/**
* A number between 1 and 100 specifying the maximum number of continuous export descriptions returned.
*/
maxResults?: Integer;
/**
* The token from the previous call to describe-export-tasks.
*/