Class: Aws::ApplicationDiscoveryService::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::ApplicationDiscoveryService::Client
- Includes:
- ClientStubs
- Defined in:
- lib/aws-sdk-applicationdiscoveryservice/client.rb
Overview
An API client for ApplicationDiscoveryService. To construct a client, you need to configure a ‘:region` and `:credentials`.
client = Aws::ApplicationDiscoveryService::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#associate_configuration_items_to_application(params = {}) ⇒ Struct
Associates one or more configuration items with an application.
-
#batch_delete_agents(params = {}) ⇒ Types::BatchDeleteAgentsResponse
Deletes one or more agents or collectors as specified by ID.
-
#batch_delete_import_data(params = {}) ⇒ Types::BatchDeleteImportDataResponse
Deletes one or more import tasks, each identified by their import ID.
-
#create_application(params = {}) ⇒ Types::CreateApplicationResponse
Creates an application with the given name and description.
-
#create_tags(params = {}) ⇒ Struct
Creates one or more tags for configuration items.
-
#delete_applications(params = {}) ⇒ Struct
Deletes a list of applications and their associations with configuration items.
-
#delete_tags(params = {}) ⇒ Struct
Deletes the association between configuration items and one or more tags.
-
#describe_agents(params = {}) ⇒ Types::DescribeAgentsResponse
Lists agents or collectors as specified by ID or other filters.
-
#describe_batch_delete_configuration_task(params = {}) ⇒ Types::DescribeBatchDeleteConfigurationTaskResponse
Takes a unique deletion task identifier as input and returns metadata about a configuration deletion task.
-
#describe_configurations(params = {}) ⇒ Types::DescribeConfigurationsResponse
Retrieves attributes for a list of configuration item IDs.
-
#describe_continuous_exports(params = {}) ⇒ Types::DescribeContinuousExportsResponse
Lists exports as specified by ID.
-
#describe_export_configurations(params = {}) ⇒ Types::DescribeExportConfigurationsResponse
‘DescribeExportConfigurations` is deprecated.
-
#describe_export_tasks(params = {}) ⇒ Types::DescribeExportTasksResponse
Retrieve status of one or more export tasks.
-
#describe_import_tasks(params = {}) ⇒ Types::DescribeImportTasksResponse
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.
-
#describe_tags(params = {}) ⇒ Types::DescribeTagsResponse
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`.
-
#disassociate_configuration_items_from_application(params = {}) ⇒ Struct
Disassociates one or more configuration items from an application.
-
#export_configurations(params = {}) ⇒ Types::ExportConfigurationsResponse
Deprecated.
-
#get_discovery_summary(params = {}) ⇒ Types::GetDiscoverySummaryResponse
Retrieves a short summary of discovered assets.
-
#list_configurations(params = {}) ⇒ Types::ListConfigurationsResponse
Retrieves a list of configuration items as specified by the value passed to the required parameter ‘configurationType`.
-
#list_server_neighbors(params = {}) ⇒ Types::ListServerNeighborsResponse
Retrieves a list of servers that are one network hop away from a specified server.
-
#start_batch_delete_configuration_task(params = {}) ⇒ Types::StartBatchDeleteConfigurationTaskResponse
Takes a list of configurationId as input and starts an asynchronous deletion task to remove the configurationItems.
-
#start_continuous_export(params = {}) ⇒ Types::StartContinuousExportResponse
Start the continuous flow of agent’s discovered data into Amazon Athena.
-
#start_data_collection_by_agent_ids(params = {}) ⇒ Types::StartDataCollectionByAgentIdsResponse
Instructs the specified agents to start collecting data.
-
#start_export_task(params = {}) ⇒ Types::StartExportTaskResponse
Begins the export of a discovered data report to an Amazon S3 bucket managed by Amazon Web Services.
-
#start_import_task(params = {}) ⇒ Types::StartImportTaskResponse
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.
-
#stop_continuous_export(params = {}) ⇒ Types::StopContinuousExportResponse
Stop the continuous flow of agent’s discovered data into Amazon Athena.
-
#stop_data_collection_by_agent_ids(params = {}) ⇒ Types::StopDataCollectionByAgentIdsResponse
Instructs the specified agents to stop collecting data.
-
#update_application(params = {}) ⇒ Struct
Updates metadata about an application.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
395 396 397 |
# File 'lib/aws-sdk-applicationdiscoveryservice/client.rb', line 395 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1767 1768 1769 |
# File 'lib/aws-sdk-applicationdiscoveryservice/client.rb', line 1767 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1770 1771 1772 |
# File 'lib/aws-sdk-applicationdiscoveryservice/client.rb', line 1770 def errors_module Errors end |
Instance Method Details
#associate_configuration_items_to_application(params = {}) ⇒ Struct
Associates one or more configuration items with an application.
422 423 424 425 |
# File 'lib/aws-sdk-applicationdiscoveryservice/client.rb', line 422 def associate_configuration_items_to_application(params = {}, = {}) req = build_request(:associate_configuration_items_to_application, params) req.send_request() end |
#batch_delete_agents(params = {}) ⇒ Types::BatchDeleteAgentsResponse
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`.
458 459 460 461 |
# File 'lib/aws-sdk-applicationdiscoveryservice/client.rb', line 458 def batch_delete_agents(params = {}, = {}) req = build_request(:batch_delete_agents, params) req.send_request() end |
#batch_delete_import_data(params = {}) ⇒ Types::BatchDeleteImportDataResponse
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.
502 503 504 505 |
# File 'lib/aws-sdk-applicationdiscoveryservice/client.rb', line 502 def batch_delete_import_data(params = {}, = {}) req = build_request(:batch_delete_import_data, params) req.send_request() end |
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 |
# File 'lib/aws-sdk-applicationdiscoveryservice/client.rb', line 1745 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-applicationdiscoveryservice' context[:gem_version] = '1.62.0' Seahorse::Client::Request.new(handlers, context) end |
#create_application(params = {}) ⇒ Types::CreateApplicationResponse
Creates an application with the given name and description.
532 533 534 535 |
# File 'lib/aws-sdk-applicationdiscoveryservice/client.rb', line 532 def create_application(params = {}, = {}) req = build_request(:create_application, params) req.send_request() end |
#create_tags(params = {}) ⇒ Struct
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.
569 570 571 572 |
# File 'lib/aws-sdk-applicationdiscoveryservice/client.rb', line 569 def (params = {}, = {}) req = build_request(:create_tags, params) req.send_request() end |
#delete_applications(params = {}) ⇒ Struct
Deletes a list of applications and their associations with configuration items.
590 591 592 593 |
# File 'lib/aws-sdk-applicationdiscoveryservice/client.rb', line 590 def delete_applications(params = {}, = {}) req = build_request(:delete_applications, params) req.send_request() end |
#delete_tags(params = {}) ⇒ Struct
Deletes the association between configuration items and one or more tags. This API accepts a list of multiple configuration items.
624 625 626 627 |
# File 'lib/aws-sdk-applicationdiscoveryservice/client.rb', line 624 def (params = {}, = {}) req = build_request(:delete_tags, params) req.send_request() end |
#describe_agents(params = {}) ⇒ Types::DescribeAgentsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
696 697 698 699 |
# File 'lib/aws-sdk-applicationdiscoveryservice/client.rb', line 696 def describe_agents(params = {}, = {}) req = build_request(:describe_agents, params) req.send_request() end |
#describe_batch_delete_configuration_task(params = {}) ⇒ Types::DescribeBatchDeleteConfigurationTaskResponse
Takes a unique deletion task identifier as input and returns metadata about a configuration deletion task.
739 740 741 742 |
# File 'lib/aws-sdk-applicationdiscoveryservice/client.rb', line 739 def describe_batch_delete_configuration_task(params = {}, = {}) req = build_request(:describe_batch_delete_configuration_task, params) req.send_request() end |
#describe_configurations(params = {}) ⇒ Types::DescribeConfigurationsResponse
Retrieves attributes for a list of configuration item IDs.
<note markdown=“1”> 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*.
</note>
793 794 795 796 |
# File 'lib/aws-sdk-applicationdiscoveryservice/client.rb', line 793 def describe_configurations(params = {}, = {}) req = build_request(:describe_configurations, params) req.send_request() end |
#describe_continuous_exports(params = {}) ⇒ Types::DescribeContinuousExportsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
843 844 845 846 |
# File 'lib/aws-sdk-applicationdiscoveryservice/client.rb', line 843 def describe_continuous_exports(params = {}, = {}) req = build_request(:describe_continuous_exports, params) req.send_request() end |
#describe_export_configurations(params = {}) ⇒ Types::DescribeExportConfigurationsResponse
‘DescribeExportConfigurations` is deprecated. Use [DescribeExportTasks], instead.
[1]: docs.aws.amazon.com/application-discovery/latest/APIReference/API_DescribeExportTasks.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
895 896 897 898 |
# File 'lib/aws-sdk-applicationdiscoveryservice/client.rb', line 895 def describe_export_configurations(params = {}, = {}) req = build_request(:describe_export_configurations, params) req.send_request() end |
#describe_export_tasks(params = {}) ⇒ Types::DescribeExportTasksResponse
Retrieve status of one or more export tasks. You can retrieve the status of up to 100 export tasks.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
964 965 966 967 |
# File 'lib/aws-sdk-applicationdiscoveryservice/client.rb', line 964 def describe_export_tasks(params = {}, = {}) req = build_request(:describe_export_tasks, params) req.send_request() end |
#describe_import_tasks(params = {}) ⇒ Types::DescribeImportTasksResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1025 1026 1027 1028 |
# File 'lib/aws-sdk-applicationdiscoveryservice/client.rb', line 1025 def describe_import_tasks(params = {}, = {}) req = build_request(:describe_import_tasks, params) req.send_request() end |
#describe_tags(params = {}) ⇒ Types::DescribeTagsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1091 1092 1093 1094 |
# File 'lib/aws-sdk-applicationdiscoveryservice/client.rb', line 1091 def (params = {}, = {}) req = build_request(:describe_tags, params) req.send_request() end |
#disassociate_configuration_items_from_application(params = {}) ⇒ Struct
Disassociates one or more configuration items from an application.
1116 1117 1118 1119 |
# File 'lib/aws-sdk-applicationdiscoveryservice/client.rb', line 1116 def disassociate_configuration_items_from_application(params = {}, = {}) req = build_request(:disassociate_configuration_items_from_application, params) req.send_request() end |
#export_configurations(params = {}) ⇒ Types::ExportConfigurationsResponse
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.
1140 1141 1142 1143 |
# File 'lib/aws-sdk-applicationdiscoveryservice/client.rb', line 1140 def export_configurations(params = {}, = {}) req = build_request(:export_configurations, params) req.send_request() end |
#get_discovery_summary(params = {}) ⇒ Types::GetDiscoverySummaryResponse
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.
1198 1199 1200 1201 |
# File 'lib/aws-sdk-applicationdiscoveryservice/client.rb', line 1198 def get_discovery_summary(params = {}, = {}) req = build_request(:get_discovery_summary, params) req.send_request() end |
#list_configurations(params = {}) ⇒ Types::ListConfigurationsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1281 1282 1283 1284 |
# File 'lib/aws-sdk-applicationdiscoveryservice/client.rb', line 1281 def list_configurations(params = {}, = {}) req = build_request(:list_configurations, params) req.send_request() end |
#list_server_neighbors(params = {}) ⇒ Types::ListServerNeighborsResponse
Retrieves a list of servers that are one network hop away from a specified server.
1339 1340 1341 1342 |
# File 'lib/aws-sdk-applicationdiscoveryservice/client.rb', line 1339 def list_server_neighbors(params = {}, = {}) req = build_request(:list_server_neighbors, params) req.send_request() end |
#start_batch_delete_configuration_task(params = {}) ⇒ Types::StartBatchDeleteConfigurationTaskResponse
Takes a list of configurationId as input and starts an asynchronous deletion task to remove the configurationItems. Returns a unique deletion task identifier.
1371 1372 1373 1374 |
# File 'lib/aws-sdk-applicationdiscoveryservice/client.rb', line 1371 def start_batch_delete_configuration_task(params = {}, = {}) req = build_request(:start_batch_delete_configuration_task, params) req.send_request() end |
#start_continuous_export(params = {}) ⇒ Types::StartContinuousExportResponse
Start the continuous flow of agent’s discovered data into Amazon Athena.
1398 1399 1400 1401 |
# File 'lib/aws-sdk-applicationdiscoveryservice/client.rb', line 1398 def start_continuous_export(params = {}, = {}) req = build_request(:start_continuous_export, params) req.send_request() end |
#start_data_collection_by_agent_ids(params = {}) ⇒ Types::StartDataCollectionByAgentIdsResponse
Instructs the specified agents to start collecting data.
1434 1435 1436 1437 |
# File 'lib/aws-sdk-applicationdiscoveryservice/client.rb', line 1434 def start_data_collection_by_agent_ids(params = {}, = {}) req = build_request(:start_data_collection_by_agent_ids, params) req.send_request() end |
#start_export_task(params = {}) ⇒ Types::StartExportTaskResponse
Begins the export of a discovered data report to an Amazon S3 bucket managed by Amazon Web Services.
<note markdown=“1”> 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.
</note>
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.
1547 1548 1549 1550 |
# File 'lib/aws-sdk-applicationdiscoveryservice/client.rb', line 1547 def start_export_task(params = {}, = {}) req = build_request(:start_export_task, params) req.send_request() end |
#start_import_task(params = {}) ⇒ Types::StartImportTaskResponse
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: [s3.us-west-2.amazonaws.com/templates-7cffcf56-bd96-4b1c-b45b-a5b42f282e46/import_template.csv][1].
-
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][2
-
in the *Amazon Web Services Application
Discovery Service User Guide*.
<note markdown=“1”> 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][3
-
in the
*Amazon Web Services Application Discovery Service User Guide*.
</note>
[1]: s3.us-west-2.amazonaws.com/templates-7cffcf56-bd96-4b1c-b45b-a5b42f282e46/import_template.csv [2]: docs.aws.amazon.com/application-discovery/latest/userguide/discovery-import.html [3]: docs.aws.amazon.com/application-discovery/latest/userguide/ads_service_limits.html
1650 1651 1652 1653 |
# File 'lib/aws-sdk-applicationdiscoveryservice/client.rb', line 1650 def start_import_task(params = {}, = {}) req = build_request(:start_import_task, params) req.send_request() end |
#stop_continuous_export(params = {}) ⇒ Types::StopContinuousExportResponse
Stop the continuous flow of agent’s discovered data into Amazon Athena.
1679 1680 1681 1682 |
# File 'lib/aws-sdk-applicationdiscoveryservice/client.rb', line 1679 def stop_continuous_export(params = {}, = {}) req = build_request(:stop_continuous_export, params) req.send_request() end |
#stop_data_collection_by_agent_ids(params = {}) ⇒ Types::StopDataCollectionByAgentIdsResponse
Instructs the specified agents to stop collecting data.
1708 1709 1710 1711 |
# File 'lib/aws-sdk-applicationdiscoveryservice/client.rb', line 1708 def stop_data_collection_by_agent_ids(params = {}, = {}) req = build_request(:stop_data_collection_by_agent_ids, params) req.send_request() end |
#update_application(params = {}) ⇒ Struct
Updates metadata about an application.
1736 1737 1738 1739 |
# File 'lib/aws-sdk-applicationdiscoveryservice/client.rb', line 1736 def update_application(params = {}, = {}) req = build_request(:update_application, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1760 1761 1762 |
# File 'lib/aws-sdk-applicationdiscoveryservice/client.rb', line 1760 def waiter_names [] end |