@aws-sdk/client-application-discovery-service 3.296.0 → 3.297.0

package/dist-types/models/models_0.d.ts

@@ -1,6 +1,7 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
 import { ApplicationDiscoveryServiceServiceException as __BaseException } from "./ApplicationDiscoveryServiceServiceException";
 /**
+ * @public
  * <p>Information about agents or connectors that were instructed to start collecting data.
  *       Information includes the agent/connector ID, a description of the operation, and whether the
  *       agent/connector configuration was updated.</p>
@@ -23,6 +24,7 @@ export interface AgentConfigurationStatus {
     description?: string;
 }
 /**
+ * @public
  * <p>Network details about the host where the agent/connector resides.</p>
  */
 export interface AgentNetworkInfo {
@@ -35,6 +37,9 @@ export interface AgentNetworkInfo {
      */
     macAddress?: string;
 }
+/**
+ * @public
+ */
 export declare enum AgentStatus {
     BLACKLISTED = "BLACKLISTED",
     HEALTHY = "HEALTHY",
@@ -44,6 +49,7 @@ export declare enum AgentStatus {
     UNKNOWN = "UNKNOWN"
 }
 /**
+ * @public
  * <p>Information about agents or connectors associated with the user’s Amazon Web Services account.
  *       Information includes agent or connector IDs, IP addresses, media access control (MAC)
  *       addresses, agent or connector health, hostname where the agent or connector resides, and agent
@@ -92,6 +98,9 @@ export interface AgentInfo {
      */
     registeredTime?: string;
 }
+/**
+ * @public
+ */
 export interface AssociateConfigurationItemsToApplicationRequest {
     /**
      * <p>The configuration ID of an application with which items are to be associated.</p>
@@ -102,9 +111,13 @@ export interface AssociateConfigurationItemsToApplicationRequest {
      */
     configurationIds: string[] | undefined;
 }
+/**
+ * @public
+ */
 export interface AssociateConfigurationItemsToApplicationResponse {
 }
 /**
+ * @public
  * <p>The Amazon Web Services user account does not have permission to perform the action. Check the IAM
  *       policy associated with this account.</p>
  */
@@ -117,6 +130,7 @@ export declare class AuthorizationErrorException extends __BaseException {
     constructor(opts: __ExceptionOptionType<AuthorizationErrorException, __BaseException>);
 }
 /**
+ * @public
  * <p>The home region is not set. Set the home region to continue.</p>
  */
 export declare class HomeRegionNotSetException extends __BaseException {
@@ -128,6 +142,7 @@ export declare class HomeRegionNotSetException extends __BaseException {
     constructor(opts: __ExceptionOptionType<HomeRegionNotSetException, __BaseException>);
 }
 /**
+ * @public
  * <p>One or more parameters are not valid. Verify the parameters and try again.</p>
  */
 export declare class InvalidParameterException extends __BaseException {
@@ -139,6 +154,7 @@ export declare class InvalidParameterException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InvalidParameterException, __BaseException>);
 }
 /**
+ * @public
  * <p>The value of one or more parameters are either invalid or out of range. Verify the
  *       parameter values and try again.</p>
  */
@@ -151,6 +167,7 @@ export declare class InvalidParameterValueException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InvalidParameterValueException, __BaseException>);
 }
 /**
+ * @public
  * <p>The server experienced an internal error. Try again.</p>
  */
 export declare class ServerInternalErrorException extends __BaseException {
@@ -161,18 +178,25 @@ export declare class ServerInternalErrorException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ServerInternalErrorException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface BatchDeleteImportDataRequest {
     /**
      * <p>The IDs for the import tasks that you want to delete.</p>
      */
     importTaskIds: string[] | undefined;
 }
+/**
+ * @public
+ */
 export declare enum BatchDeleteImportDataErrorCode {
     INTERNAL_SERVER_ERROR = "INTERNAL_SERVER_ERROR",
     NOT_FOUND = "NOT_FOUND",
     OVER_LIMIT = "OVER_LIMIT"
 }
 /**
+ * @public
  * <p>Error messages returned for each import task that you deleted as a response for this
  *       command.</p>
  */
@@ -190,6 +214,9 @@ export interface BatchDeleteImportDataError {
      */
     errorDescription?: string;
 }
+/**
+ * @public
+ */
 export interface BatchDeleteImportDataResponse {
     /**
      * <p>Error messages returned for each import task that you deleted as a response for this
@@ -197,6 +224,9 @@ export interface BatchDeleteImportDataResponse {
      */
     errors?: BatchDeleteImportDataError[];
 }
+/**
+ * @public
+ */
 export interface CreateApplicationRequest {
     /**
      * <p>Name of the application to be created.</p>
@@ -207,6 +237,9 @@ export interface CreateApplicationRequest {
      */
     description?: string;
 }
+/**
+ * @public
+ */
 export interface CreateApplicationResponse {
     /**
      * <p>Configuration ID of an application to be created.</p>
@@ -214,6 +247,7 @@ export interface CreateApplicationResponse {
     configurationId?: string;
 }
 /**
+ * @public
  * <p>Metadata that help you categorize IT assets.</p>
  *          <important>
  *             <p>Do not store sensitive information (like personal data) in tags.</p>
@@ -229,6 +263,9 @@ export interface Tag {
      */
     value: string | undefined;
 }
+/**
+ * @public
+ */
 export interface CreateTagsRequest {
     /**
      * <p>A list of configuration items that you want to tag.</p>
@@ -239,14 +276,18 @@ export interface CreateTagsRequest {
      *       that you want to create in a <i>key</i>-<i>value</i> format. For
      *       example:</p>
      *          <p>
-     *             <code>{"key": "serverType", "value": "webServer"}</code>
+     *             <code>\{"key": "serverType", "value": "webServer"\}</code>
      *          </p>
      */
     tags: Tag[] | undefined;
 }
+/**
+ * @public
+ */
 export interface CreateTagsResponse {
 }
 /**
+ * @public
  * <p>The specified configuration ID was not located. Verify the configuration ID and try
  *       again.</p>
  */
@@ -258,14 +299,23 @@ export declare class ResourceNotFoundException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface DeleteApplicationsRequest {
     /**
      * <p>Configuration ID of an application to be deleted.</p>
      */
     configurationIds: string[] | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteApplicationsResponse {
 }
+/**
+ * @public
+ */
 export interface DeleteTagsRequest {
     /**
      * <p>A list of configuration items with tags that you want to delete.</p>
@@ -276,14 +326,18 @@ export interface DeleteTagsRequest {
      *       that you want to delete in a <i>key</i>-<i>value</i> format. For
      *       example:</p>
      *          <p>
-     *             <code>{"key": "serverType", "value": "webServer"}</code>
+     *             <code>\{"key": "serverType", "value": "webServer"\}</code>
      *          </p>
      */
     tags?: Tag[];
 }
+/**
+ * @public
+ */
 export interface DeleteTagsResponse {
 }
 /**
+ * @public
  * <p>A filter that can use conditional operators.</p>
  *          <p>For more information about filters, see <a href="https://docs.aws.amazon.com/application-discovery/latest/userguide/discovery-api-queries.html">Querying Discovered
  *         Configuration Items</a> in the <i>Amazon Web Services Application Discovery Service User
@@ -310,6 +364,9 @@ export interface Filter {
      */
     condition: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeAgentsRequest {
     /**
      * <p>The agent or the Connector IDs for which you want information. If you specify no IDs,
@@ -321,7 +378,7 @@ export interface DescribeAgentsRequest {
      * <p>You can filter the request using various logical operators and a
      *         <i>key</i>-<i>value</i> format. For example: </p>
      *          <p>
-     *             <code>{"key": "collectionStatus", "value": "STARTED"}</code>
+     *             <code>\{"key": "collectionStatus", "value": "STARTED"\}</code>
      *          </p>
      */
     filters?: Filter[];
@@ -338,6 +395,9 @@ export interface DescribeAgentsRequest {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export interface DescribeAgentsResponse {
     /**
      * <p>Lists agents or the Connector by ID or lists all agents/Connectors associated with your
@@ -354,18 +414,27 @@ export interface DescribeAgentsResponse {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export interface DescribeConfigurationsRequest {
     /**
      * <p>One or more configuration IDs.</p>
      */
     configurationIds: string[] | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeConfigurationsResponse {
     /**
      * <p>A key in the response map. The value is an array of data.</p>
      */
     configurations?: Record<string, string>[];
 }
+/**
+ * @public
+ */
 export interface DescribeContinuousExportsRequest {
     /**
      * <p>The unique IDs assigned to the exports.</p>
@@ -381,9 +450,15 @@ export interface DescribeContinuousExportsRequest {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export declare enum DataSource {
     AGENT = "AGENT"
 }
+/**
+ * @public
+ */
 export declare enum ContinuousExportStatus {
     ACTIVE = "ACTIVE",
     ERROR = "ERROR",
@@ -394,6 +469,7 @@ export declare enum ContinuousExportStatus {
     STOP_IN_PROGRESS = "STOP_IN_PROGRESS"
 }
 /**
+ * @public
  * <p>A list of continuous export descriptions.</p>
  */
 export interface ContinuousExportDescription {
@@ -542,6 +618,9 @@ export interface ContinuousExportDescription {
      */
     schemaStorageConfig?: Record<string, string>;
 }
+/**
+ * @public
+ */
 export interface DescribeContinuousExportsResponse {
     /**
      * <p>A list of continuous export descriptions.</p>
@@ -553,6 +632,7 @@ export interface DescribeContinuousExportsResponse {
     nextToken?: string;
 }
 /**
+ * @public
  * <p>This operation is not permitted.</p>
  */
 export declare class OperationNotPermittedException extends __BaseException {
@@ -563,6 +643,9 @@ export declare class OperationNotPermittedException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<OperationNotPermittedException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface DescribeExportConfigurationsRequest {
     /**
      * <p>A list of continuous export IDs to search for.</p>
@@ -578,12 +661,16 @@ export interface DescribeExportConfigurationsRequest {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export declare enum ExportStatus {
     FAILED = "FAILED",
     IN_PROGRESS = "IN_PROGRESS",
     SUCCEEDED = "SUCCEEDED"
 }
 /**
+ * @public
  * <p>Information regarding the export status of discovered data. The value is an array of
  *       objects.</p>
  */
@@ -629,6 +716,9 @@ export interface ExportInfo {
      */
     requestedEndTime?: Date;
 }
+/**
+ * @public
+ */
 export interface DescribeExportConfigurationsResponse {
     /**
      * <p></p>
@@ -640,6 +730,7 @@ export interface DescribeExportConfigurationsResponse {
     nextToken?: string;
 }
 /**
+ * @public
  * <p>Used to select which agent's data is to be exported. A single agent ID may be selected
  *       for export using the <a href="http://docs.aws.amazon.com/application-discovery/latest/APIReference/API_StartExportTask.html">StartExportTask</a> action.</p>
  */
@@ -660,6 +751,9 @@ export interface ExportFilter {
      */
     condition: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeExportTasksRequest {
     /**
      * <p>One or more unique identifiers used to query the status of an export request.</p>
@@ -692,6 +786,9 @@ export interface DescribeExportTasksRequest {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export interface DescribeExportTasksResponse {
     /**
      * <p>Contains one or more sets of export request details. When the status of a request is
@@ -708,12 +805,16 @@ export interface DescribeExportTasksResponse {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export declare enum ImportTaskFilterName {
     IMPORT_TASK_ID = "IMPORT_TASK_ID",
     NAME = "NAME",
     STATUS = "STATUS"
 }
 /**
+ * @public
  * <p>A name-values pair of elements you can use to filter the results when querying your import
  *       tasks. Currently, wildcards are not supported for filters.</p>
  *          <note>
@@ -731,6 +832,9 @@ export interface ImportTaskFilter {
      */
     values?: string[];
 }
+/**
+ * @public
+ */
 export interface DescribeImportTasksRequest {
     /**
      * <p>An array of name-value pairs that you provide to filter the results for the
@@ -747,6 +851,9 @@ export interface DescribeImportTasksRequest {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export declare enum ImportStatus {
     DELETE_COMPLETE = "DELETE_COMPLETE",
     DELETE_FAILED = "DELETE_FAILED",
@@ -761,6 +868,7 @@ export declare enum ImportStatus {
     INTERNAL_ERROR = "INTERNAL_ERROR"
 }
 /**
+ * @public
  * <p>An array of information related to the import task request that includes status
  *       information, times, IDs, the Amazon S3 Object URL for the import file, and more.</p>
  */
@@ -841,6 +949,9 @@ export interface ImportTask {
      */
     errorsAndFailedEntriesZip?: string;
 }
+/**
+ * @public
+ */
 export interface DescribeImportTasksResponse {
     /**
      * <p>The token to request the next page of results.</p>
@@ -853,6 +964,7 @@ export interface DescribeImportTasksResponse {
     tasks?: ImportTask[];
 }
 /**
+ * @public
  * <p>The tag filter. Valid names are: <code>tagKey</code>, <code>tagValue</code>,
  *         <code>configurationId</code>.</p>
  */
@@ -866,6 +978,9 @@ export interface TagFilter {
      */
     values: string[] | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeTagsRequest {
     /**
      * <p>You can filter the list using a <i>key</i>-<i>value</i>
@@ -883,6 +998,9 @@ export interface DescribeTagsRequest {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export declare enum ConfigurationItemType {
     APPLICATION = "APPLICATION",
     CONNECTIONS = "CONNECTION",
@@ -890,6 +1008,7 @@ export declare enum ConfigurationItemType {
     SERVER = "SERVER"
 }
 /**
+ * @public
  * <p>Tags for a configuration item. Tags are metadata that help you categorize IT
  *       assets.</p>
  */
@@ -919,6 +1038,9 @@ export interface ConfigurationTag {
      */
     timeOfCreation?: Date;
 }
+/**
+ * @public
+ */
 export interface DescribeTagsResponse {
     /**
      * <p>Depending on the input, this is a list of configuration items tagged with a specific
@@ -930,6 +1052,9 @@ export interface DescribeTagsResponse {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export interface DisassociateConfigurationItemsFromApplicationRequest {
     /**
      * <p>Configuration ID of an application from which each item is disassociated.</p>
@@ -940,16 +1065,28 @@ export interface DisassociateConfigurationItemsFromApplicationRequest {
      */
     configurationIds: string[] | undefined;
 }
+/**
+ * @public
+ */
 export interface DisassociateConfigurationItemsFromApplicationResponse {
 }
+/**
+ * @public
+ */
 export interface ExportConfigurationsResponse {
     /**
      * <p>A unique identifier that you can use to query the export status.</p>
      */
     exportId?: string;
 }
+/**
+ * @public
+ */
 export interface GetDiscoverySummaryRequest {
 }
+/**
+ * @public
+ */
 export interface CustomerAgentlessCollectorInfo {
     activeAgentlessCollectors: number | undefined;
     healthyAgentlessCollectors: number | undefined;
@@ -960,6 +1097,7 @@ export interface CustomerAgentlessCollectorInfo {
     unknownAgentlessCollectors: number | undefined;
 }
 /**
+ * @public
  * <p>Inventory data for installed discovery agents.</p>
  */
 export interface CustomerAgentInfo {
@@ -993,6 +1131,7 @@ export interface CustomerAgentInfo {
     unknownAgents: number | undefined;
 }
 /**
+ * @public
  * <p>Inventory data for installed discovery connectors.</p>
  */
 export interface CustomerConnectorInfo {
@@ -1026,6 +1165,7 @@ export interface CustomerConnectorInfo {
     unknownConnectors: number | undefined;
 }
 /**
+ * @public
  * <p>
  *       The inventory data for installed Migration Evaluator collectors.
  *     </p>
@@ -1074,6 +1214,9 @@ export interface CustomerMeCollectorInfo {
      */
     unknownMeCollectors: number | undefined;
 }
+/**
+ * @public
+ */
 export interface GetDiscoverySummaryResponse {
     /**
      * <p>The number of servers discovered.</p>
@@ -1107,11 +1250,15 @@ export interface GetDiscoverySummaryResponse {
     meCollectorSummary?: CustomerMeCollectorInfo;
     agentlessCollectorSummary?: CustomerAgentlessCollectorInfo;
 }
+/**
+ * @public
+ */
 export declare enum OrderString {
     ASC = "ASC",
     DESC = "DESC"
 }
 /**
+ * @public
  * <p>A field and direction for ordered output.</p>
  */
 export interface OrderByElement {
@@ -1124,6 +1271,9 @@ export interface OrderByElement {
      */
     sortOrder?: OrderString | string;
 }
+/**
+ * @public
+ */
 export interface ListConfigurationsRequest {
     /**
      * <p>A valid configuration identified by Application Discovery Service. </p>
@@ -1133,7 +1283,7 @@ export interface ListConfigurationsRequest {
      * <p>You can filter the request using various logical operators and a
      *         <i>key</i>-<i>value</i> format. For example: </p>
      *          <p>
-     *             <code>{"key": "serverType", "value": "webServer"}</code>
+     *             <code>\{"key": "serverType", "value": "webServer"\}</code>
      *          </p>
      *          <p>For a complete list of filter options and guidance about using them with this action,
      *       see <a href="https://docs.aws.amazon.com/application-discovery/latest/userguide/discovery-api-queries.html#ListConfigurations">Using the ListConfigurations Action</a> in the <i>Amazon Web Services Application Discovery
@@ -1158,6 +1308,9 @@ export interface ListConfigurationsRequest {
      */
     orderBy?: OrderByElement[];
 }
+/**
+ * @public
+ */
 export interface ListConfigurationsResponse {
     /**
      * <p>Returns configuration details, including the configuration ID, attribute names, and
@@ -1173,6 +1326,9 @@ export interface ListConfigurationsResponse {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListServerNeighborsRequest {
     /**
      * <p>Configuration ID of the server for which neighbors are being listed.</p>
@@ -1200,6 +1356,7 @@ export interface ListServerNeighborsRequest {
     nextToken?: string;
 }
 /**
+ * @public
  * <p>Details about neighboring servers.</p>
  */
 export interface NeighborConnectionDetail {
@@ -1224,6 +1381,9 @@ export interface NeighborConnectionDetail {
      */
     connectionsCount: number | undefined;
 }
+/**
+ * @public
+ */
 export interface ListServerNeighborsResponse {
     /**
      * <p>List of distinct servers that are one hop away from the given server.</p>
@@ -1243,6 +1403,7 @@ export interface ListServerNeighborsResponse {
     knownDependencyCount?: number;
 }
 /**
+ * @public
  * <p></p>
  */
 export declare class ConflictErrorException extends __BaseException {
@@ -1254,6 +1415,7 @@ export declare class ConflictErrorException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ConflictErrorException, __BaseException>);
 }
 /**
+ * @public
  * <p>This issue occurs when the same <code>clientRequestToken</code> is used with the
  *         <code>StartImportTask</code> action, but with different parameters. For example, you use the
  *       same request token but have two different import URLs, you can encounter this issue. If the
@@ -1268,8 +1430,14 @@ export declare class ResourceInUseException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ResourceInUseException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface StartContinuousExportRequest {
 }
+/**
+ * @public
+ */
 export interface StartContinuousExportResponse {
     /**
      * <p>The unique ID assigned to this export.</p>
@@ -1300,6 +1468,9 @@ export interface StartContinuousExportResponse {
      */
     schemaStorageConfig?: Record<string, string>;
 }
+/**
+ * @public
+ */
 export interface StartDataCollectionByAgentIdsRequest {
     /**
      * <p>The IDs of the agents or connectors from which to start collecting data. If you send a
@@ -1312,6 +1483,9 @@ export interface StartDataCollectionByAgentIdsRequest {
      */
     agentIds: string[] | undefined;
 }
+/**
+ * @public
+ */
 export interface StartDataCollectionByAgentIdsResponse {
     /**
      * <p>Information about agents or the connector that were instructed to start collecting
@@ -1320,10 +1494,16 @@ export interface StartDataCollectionByAgentIdsResponse {
      */
     agentsConfigurationStatus?: AgentConfigurationStatus[];
 }
+/**
+ * @public
+ */
 export declare enum ExportDataFormat {
     CSV = "CSV",
     GRAPHML = "GRAPHML"
 }
+/**
+ * @public
+ */
 export interface StartExportTaskRequest {
     /**
      * <p>The file format for the returned export data. Default value is <code>CSV</code>.
@@ -1356,12 +1536,18 @@ export interface StartExportTaskRequest {
      */
     endTime?: Date;
 }
+/**
+ * @public
+ */
 export interface StartExportTaskResponse {
     /**
      * <p>A unique identifier used to query the status of an export request.</p>
      */
     exportId?: string;
 }
+/**
+ * @public
+ */
 export interface StartImportTaskRequest {
     /**
      * <p>Optional. A unique token that you can provide to prevent the same import request from
@@ -1388,6 +1574,9 @@ export interface StartImportTaskRequest {
      */
     importUrl: string | undefined;
 }
+/**
+ * @public
+ */
 export interface StartImportTaskResponse {
     /**
      * <p>An array of information related to the import task request including status information,
@@ -1395,12 +1584,18 @@ export interface StartImportTaskResponse {
      */
     task?: ImportTask;
 }
+/**
+ * @public
+ */
 export interface StopContinuousExportRequest {
     /**
      * <p>The unique ID assigned to this export.</p>
      */
     exportId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface StopContinuousExportResponse {
     /**
      * <p>Timestamp that represents when this continuous export started collecting
@@ -1412,12 +1607,18 @@ export interface StopContinuousExportResponse {
      */
     stopTime?: Date;
 }
+/**
+ * @public
+ */
 export interface StopDataCollectionByAgentIdsRequest {
     /**
      * <p>The IDs of the agents or connectors from which to stop collecting data.</p>
      */
     agentIds: string[] | undefined;
 }
+/**
+ * @public
+ */
 export interface StopDataCollectionByAgentIdsResponse {
     /**
      * <p>Information about the agents or connector that were instructed to stop collecting data.
@@ -1426,6 +1627,9 @@ export interface StopDataCollectionByAgentIdsResponse {
      */
     agentsConfigurationStatus?: AgentConfigurationStatus[];
 }
+/**
+ * @public
+ */
 export interface UpdateApplicationRequest {
     /**
      * <p>Configuration ID of the application to be updated.</p>
@@ -1440,6 +1644,9 @@ export interface UpdateApplicationRequest {
      */
     description?: string;
 }
+/**
+ * @public
+ */
 export interface UpdateApplicationResponse {
 }
 /**