Discovery

import { Discovery } from "https://aws-api.deno.dev/v0.4/services/discovery.ts?docs=full";

class Discovery {

constructor(apiFactory: client.ApiFactory);

async associateConfigurationItemsToApplication(params: AssociateConfigurationItemsToApplicationRequest, opts?: client.RequestOptions): Promise<void>;

async batchDeleteImportData(params: BatchDeleteImportDataRequest, opts?: client.RequestOptions): Promise<BatchDeleteImportDataResponse>;

async createApplication(params: CreateApplicationRequest, opts?: client.RequestOptions): Promise<CreateApplicationResponse>;

async createTags(params: CreateTagsRequest, opts?: client.RequestOptions): Promise<void>;

async deleteApplications(params: DeleteApplicationsRequest, opts?: client.RequestOptions): Promise<void>;

async deleteTags(params: DeleteTagsRequest, opts?: client.RequestOptions): Promise<void>;

async describeAgents(params?: DescribeAgentsRequest, opts?: client.RequestOptions): Promise<DescribeAgentsResponse>;

async describeConfigurations(params: DescribeConfigurationsRequest, opts?: client.RequestOptions): Promise<DescribeConfigurationsResponse>;

async describeContinuousExports(params?: DescribeContinuousExportsRequest, opts?: client.RequestOptions): Promise<DescribeContinuousExportsResponse>;

async describeExportConfigurations(params?: DescribeExportConfigurationsRequest, opts?: client.RequestOptions): Promise<DescribeExportConfigurationsResponse>;

async describeExportTasks(params?: DescribeExportTasksRequest, opts?: client.RequestOptions): Promise<DescribeExportTasksResponse>;

async describeImportTasks(params?: DescribeImportTasksRequest, opts?: client.RequestOptions): Promise<DescribeImportTasksResponse>;

async describeTags(params?: DescribeTagsRequest, opts?: client.RequestOptions): Promise<DescribeTagsResponse>;

async disassociateConfigurationItemsFromApplication(params: DisassociateConfigurationItemsFromApplicationRequest, opts?: client.RequestOptions): Promise<void>;

async exportConfigurations(opts?: client.RequestOptions): Promise<ExportConfigurationsResponse>;

async getDiscoverySummary(opts?: client.RequestOptions): Promise<GetDiscoverySummaryResponse>;

async listConfigurations(params: ListConfigurationsRequest, opts?: client.RequestOptions): Promise<ListConfigurationsResponse>;

async listServerNeighbors(params: ListServerNeighborsRequest, opts?: client.RequestOptions): Promise<ListServerNeighborsResponse>;

async startContinuousExport(opts?: client.RequestOptions): Promise<StartContinuousExportResponse>;

async startDataCollectionByAgentIds(params: StartDataCollectionByAgentIdsRequest, opts?: client.RequestOptions): Promise<StartDataCollectionByAgentIdsResponse>;

async startExportTask(params?: StartExportTaskRequest, opts?: client.RequestOptions): Promise<StartExportTaskResponse>;

async startImportTask(params: StartImportTaskRequest, opts?: client.RequestOptions): Promise<StartImportTaskResponse>;

async stopContinuousExport(params: StopContinuousExportRequest, opts?: client.RequestOptions): Promise<StopContinuousExportResponse>;

async stopDataCollectionByAgentIds(params: StopDataCollectionByAgentIdsRequest, opts?: client.RequestOptions): Promise<StopDataCollectionByAgentIdsResponse>;

async updateApplication(params: UpdateApplicationRequest, opts?: client.RequestOptions): Promise<void>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new Discovery(apiFactory: client.ApiFactory)

[src]

§Methods

associateConfigurationItemsToApplication(params: AssociateConfigurationItemsToApplicationRequest, opts?: client.RequestOptions): Promise<void>

[src]

Associates one or more configuration items with an application.

batchDeleteImportData(params: BatchDeleteImportDataRequest, opts?: client.RequestOptions): Promise<BatchDeleteImportDataResponse>

[src]

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.

createApplication(params: CreateApplicationRequest, opts?: client.RequestOptions): Promise<CreateApplicationResponse>

[src]

Creates an application with the given name and description.

createTags(params: CreateTagsRequest, opts?: client.RequestOptions): Promise<void>

[src]

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.

! IMPORTANT: ! Do not store sensitive information (like personal data) in tags.

deleteApplications(params: DeleteApplicationsRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

deleteTags(params: DeleteTagsRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

describeAgents(params?: DescribeAgentsRequest, opts?: client.RequestOptions): Promise<DescribeAgentsResponse>

[src]

Lists agents or connectors as specified by ID or other filters. All agents/connectors associated with your user account can be listed if you call DescribeAgents as is without passing any parameters.

describeConfigurations(params: DescribeConfigurationsRequest, opts?: client.RequestOptions): Promise<DescribeConfigurationsResponse>

[src]

Retrieves attributes for a list of configuration item IDs.

Note: 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.

describeContinuousExports(params?: DescribeContinuousExportsRequest, opts?: client.RequestOptions): Promise<DescribeContinuousExportsResponse>

[src]

Lists exports as specified by ID. All continuous exports associated with your user account can be listed if you call DescribeContinuousExports as is without passing any parameters.

describeExportConfigurations(params?: DescribeExportConfigurationsRequest, opts?: client.RequestOptions): Promise<DescribeExportConfigurationsResponse>

[src]

DescribeExportConfigurations is deprecated. Use DescribeExportTasks, instead.

describeExportTasks(params?: DescribeExportTasksRequest, opts?: client.RequestOptions): Promise<DescribeExportTasksResponse>

[src]

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

describeImportTasks(params?: DescribeImportTasksRequest, opts?: client.RequestOptions): Promise<DescribeImportTasksResponse>

[src]

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.

describeTags(params?: DescribeTagsRequest, opts?: client.RequestOptions): Promise<DescribeTagsResponse>

[src]

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 account that have tags can be listed if you call DescribeTags as is without passing any parameters.

disassociateConfigurationItemsFromApplication(params: DisassociateConfigurationItemsFromApplicationRequest, opts?: client.RequestOptions): Promise<void>

[src]

Disassociates one or more configuration items from an application.

exportConfigurations(opts?: client.RequestOptions): Promise<ExportConfigurationsResponse>

[src]

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.

getDiscoverySummary(opts?: client.RequestOptions): Promise<GetDiscoverySummaryResponse>

[src]

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.

listConfigurations(params: ListConfigurationsRequest, opts?: client.RequestOptions): Promise<ListConfigurationsResponse>

[src]

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.

listServerNeighbors(params: ListServerNeighborsRequest, opts?: client.RequestOptions): Promise<ListServerNeighborsResponse>

[src]

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

startContinuousExport(opts?: client.RequestOptions): Promise<StartContinuousExportResponse>

[src]

Start the continuous flow of agent's discovered data into Amazon Athena.

startDataCollectionByAgentIds(params: StartDataCollectionByAgentIdsRequest, opts?: client.RequestOptions): Promise<StartDataCollectionByAgentIdsResponse>

[src]

Instructs the specified agents or connectors to start collecting data.

startExportTask(params?: StartExportTaskRequest, opts?: client.RequestOptions): Promise<StartExportTaskResponse>

[src]

Begins the export of discovered data to an S3 bucket.

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.

If you do not include an agentIds filter, summary data is exported that includes both Amazon Web Services Agentless Discovery Connector data and summary data from Amazon Web Services Discovery Agents. Export of summary data is limited to two exports per day.

startImportTask(params: StartImportTaskRequest, opts?: client.RequestOptions): Promise<StartImportTaskResponse>

[src]

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 Application Discovery Service (ADS) tools such as the Discovery Connector or 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.

Note: 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.

stopContinuousExport(params: StopContinuousExportRequest, opts?: client.RequestOptions): Promise<StopContinuousExportResponse>

[src]

Stop the continuous flow of agent's discovered data into Amazon Athena.

stopDataCollectionByAgentIds(params: StopDataCollectionByAgentIdsRequest, opts?: client.RequestOptions): Promise<StopDataCollectionByAgentIdsResponse>

[src]

Instructs the specified agents or connectors to stop collecting data.

updateApplication(params: UpdateApplicationRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates metadata about an application.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]