Class: Aws::ApplicationDiscoveryService::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::ApplicationDiscoveryService::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-applicationdiscoveryservice/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.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
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.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
419 420 421 |
# File 'gems/aws-sdk-applicationdiscoveryservice/lib/aws-sdk-applicationdiscoveryservice/client.rb', line 419 def initialize(*args) super end |
Instance Method Details
#associate_configuration_items_to_application(params = {}) ⇒ Struct
Associates one or more configuration items with an application.
446 447 448 449 |
# File 'gems/aws-sdk-applicationdiscoveryservice/lib/aws-sdk-applicationdiscoveryservice/client.rb', line 446 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
.
482 483 484 485 |
# File 'gems/aws-sdk-applicationdiscoveryservice/lib/aws-sdk-applicationdiscoveryservice/client.rb', line 482 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.
526 527 528 529 |
# File 'gems/aws-sdk-applicationdiscoveryservice/lib/aws-sdk-applicationdiscoveryservice/client.rb', line 526 def batch_delete_import_data(params = {}, = {}) req = build_request(:batch_delete_import_data, params) req.send_request() end |
#create_application(params = {}) ⇒ Types::CreateApplicationResponse
Creates an application with the given name and description.
556 557 558 559 |
# File 'gems/aws-sdk-applicationdiscoveryservice/lib/aws-sdk-applicationdiscoveryservice/client.rb', line 556 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.
593 594 595 596 |
# File 'gems/aws-sdk-applicationdiscoveryservice/lib/aws-sdk-applicationdiscoveryservice/client.rb', line 593 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.
614 615 616 617 |
# File 'gems/aws-sdk-applicationdiscoveryservice/lib/aws-sdk-applicationdiscoveryservice/client.rb', line 614 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.
648 649 650 651 |
# File 'gems/aws-sdk-applicationdiscoveryservice/lib/aws-sdk-applicationdiscoveryservice/client.rb', line 648 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.
720 721 722 723 |
# File 'gems/aws-sdk-applicationdiscoveryservice/lib/aws-sdk-applicationdiscoveryservice/client.rb', line 720 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.
763 764 765 766 |
# File 'gems/aws-sdk-applicationdiscoveryservice/lib/aws-sdk-applicationdiscoveryservice/client.rb', line 763 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.
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.
817 818 819 820 |
# File 'gems/aws-sdk-applicationdiscoveryservice/lib/aws-sdk-applicationdiscoveryservice/client.rb', line 817 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.
867 868 869 870 |
# File 'gems/aws-sdk-applicationdiscoveryservice/lib/aws-sdk-applicationdiscoveryservice/client.rb', line 867 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
919 920 921 922 |
# File 'gems/aws-sdk-applicationdiscoveryservice/lib/aws-sdk-applicationdiscoveryservice/client.rb', line 919 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.
988 989 990 991 |
# File 'gems/aws-sdk-applicationdiscoveryservice/lib/aws-sdk-applicationdiscoveryservice/client.rb', line 988 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.
1049 1050 1051 1052 |
# File 'gems/aws-sdk-applicationdiscoveryservice/lib/aws-sdk-applicationdiscoveryservice/client.rb', line 1049 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.
1115 1116 1117 1118 |
# File 'gems/aws-sdk-applicationdiscoveryservice/lib/aws-sdk-applicationdiscoveryservice/client.rb', line 1115 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.
1140 1141 1142 1143 |
# File 'gems/aws-sdk-applicationdiscoveryservice/lib/aws-sdk-applicationdiscoveryservice/client.rb', line 1140 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.
1164 1165 1166 1167 |
# File 'gems/aws-sdk-applicationdiscoveryservice/lib/aws-sdk-applicationdiscoveryservice/client.rb', line 1164 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.
1222 1223 1224 1225 |
# File 'gems/aws-sdk-applicationdiscoveryservice/lib/aws-sdk-applicationdiscoveryservice/client.rb', line 1222 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.
1305 1306 1307 1308 |
# File 'gems/aws-sdk-applicationdiscoveryservice/lib/aws-sdk-applicationdiscoveryservice/client.rb', line 1305 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.
1363 1364 1365 1366 |
# File 'gems/aws-sdk-applicationdiscoveryservice/lib/aws-sdk-applicationdiscoveryservice/client.rb', line 1363 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.
1395 1396 1397 1398 |
# File 'gems/aws-sdk-applicationdiscoveryservice/lib/aws-sdk-applicationdiscoveryservice/client.rb', line 1395 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.
1422 1423 1424 1425 |
# File 'gems/aws-sdk-applicationdiscoveryservice/lib/aws-sdk-applicationdiscoveryservice/client.rb', line 1422 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.
1458 1459 1460 1461 |
# File 'gems/aws-sdk-applicationdiscoveryservice/lib/aws-sdk-applicationdiscoveryservice/client.rb', line 1458 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.
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.
1571 1572 1573 1574 |
# File 'gems/aws-sdk-applicationdiscoveryservice/lib/aws-sdk-applicationdiscoveryservice/client.rb', line 1571 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: 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.
1674 1675 1676 1677 |
# File 'gems/aws-sdk-applicationdiscoveryservice/lib/aws-sdk-applicationdiscoveryservice/client.rb', line 1674 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.
1703 1704 1705 1706 |
# File 'gems/aws-sdk-applicationdiscoveryservice/lib/aws-sdk-applicationdiscoveryservice/client.rb', line 1703 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.
1732 1733 1734 1735 |
# File 'gems/aws-sdk-applicationdiscoveryservice/lib/aws-sdk-applicationdiscoveryservice/client.rb', line 1732 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.
1760 1761 1762 1763 |
# File 'gems/aws-sdk-applicationdiscoveryservice/lib/aws-sdk-applicationdiscoveryservice/client.rb', line 1760 def update_application(params = {}, = {}) req = build_request(:update_application, params) req.send_request() end |