aws-elixir v0.6.0 AWS.Discovery View Source
AWS Application Discovery Service
AWS Application Discovery Service helps you plan application migration projects. It automatically identifies servers, virtual machines (VMs), and network dependencies in your on-premises data centers. For more information, see the AWS Application Discovery Service FAQ. Application Discovery Service offers three ways of performing discovery and collecting data about your on-premises servers:
- **Agentless discovery** is recommended for environments that use
VMware vCenter Server. This mode doesn't require you to install an agent on
each host. It does not work in non-VMware environments.
- 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 network dependencies, only agent-based discovery collects that information.
- **Agent-based discovery** collects a
richer set of data than agentless discovery by using 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 running processes, system performance information, resource utilization, and network dependencies.
- The information collected by agents is secured at rest and in transit to the Application Discovery Service database in the cloud.
- **AWS Partner Network (APN) solutions**
integrate with Application Discovery Service, enabling you to import
details of your on-premises environment directly into Migration Hub without
using the discovery connector or discovery agent.
- Third-party application discovery tools can query AWS Application Discovery Service, and they can write to the Application Discovery Service database using the public API.
- In this way, you can import data into Migration Hub and view it, so that you can associate applications with servers and track migrations.
- Remember that you must set your Migration Hub home region before you call any of these APIs.
- You must make API calls for write actions (create, notify, associate, disassociate, import, or put) while in your home region, or a `HomeRegionNotSetException` error is returned.
- API calls for read actions (list, describe, stop, and delete) are permitted outside of your home region.
- Although it is unlikely, the Migration Hub home region could change. If you call APIs outside the home region, an `InvalidInputException` is returned.
- You must call `GetHomeRegion` to obtain the latest Migration Hub home region.
Link to this section Summary
Functions
Associates one or more configuration items with an application.
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.
Creates an application with the given name and description.
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.
Deletes a list of applications and their associations with configuration items.
Deletes the association between configuration items and one or more tags. This API accepts a list of multiple configuration items.
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.
Retrieves attributes for a list of configuration item IDs.
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 is deprecated. Use
DescribeImportTasks,
instead.
Retrieve status of one or more export tasks. You can retrieve the status of up to 100 export tasks.
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.
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.
Disassociates one or more configuration items from an application.
Deprecated. Use StartExportTask instead.
Retrieves a short summary of discovered assets.
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.
Retrieves a list of servers that are one network hop away from a specified server.
Start the continuous flow of agent's discovered data into Amazon Athena.
Instructs the specified agents or connectors to start collecting data.
Begins the export of discovered data to an S3 bucket.
Starts an import task, which allows you to import details of your on-premises environment directly into AWS 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.
Stop the continuous flow of agent's discovered data into Amazon Athena.
Instructs the specified agents or connectors to stop collecting data.
Updates metadata about an application.
Link to this section Functions
associate_configuration_items_to_application(client, input, options \\ [])
View SourceAssociates one or more configuration items with an application.
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.
AWS 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.
Creates an application with the given name and description.
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.
Deletes a list of applications and their associations with configuration items.
Deletes the association between configuration items and one or more tags. This API accepts a list of multiple configuration items.
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.
Retrieves attributes for a list of configuration item IDs.
- server
- application
- process
- connection
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 is deprecated. Use
DescribeImportTasks,
instead.
Retrieve status of one or more export tasks. You can retrieve the status of up to 100 export tasks.
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.
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
disassociate_configuration_items_from_application(client, input, options \\ [])
View SourceDisassociates one or more configuration items from an application.
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.
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.
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.
Retrieves a list of servers that are one network hop away from a specified server.
Start the continuous flow of agent's discovered data into Amazon Athena.
Instructs the specified agents or connectors to start collecting data.
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 AWS Agentless Discovery Connector data and summary data from
AWS Discovery Agents. Export of summary data is limited to two exports per
day.
Starts an import task, which allows you to import details of your on-premises environment directly into AWS 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](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 AWS CLI or one of the AWS SDKs to import the records from your file.
Stop the continuous flow of agent's discovered data into Amazon Athena.
Instructs the specified agents or connectors to stop collecting data.
Updates metadata about an application.