NAME
Paws::Discovery - Perl Interface to AWS AWS Application Discovery Service
SYNOPSIS
use Paws;
my $obj = Paws->service('Discovery');
my $res = $obj->Method(
Arg1 => $val1,
Arg2 => [ 'V1', 'V2' ],
# if Arg3 is an object, the HashRef will be used as arguments to the constructor
# of the arguments type
Arg3 => { Att1 => 'Val1' },
# if Arg4 is an array of objects, the HashRefs will be passed as arguments to
# the constructor of the arguments type
Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ],
);DESCRIPTION
AWS Application Discovery Service
AWS Application Discovery Service helps you plan application migration projects by automatically identifying servers, virtual machines (VMs), software, and software dependencies running in your on-premises data centers. Application Discovery Service also collects application performance data, which can help you assess the outcome of your migration. The data collected by Application Discovery Service is securely retained in an Amazon-hosted and managed database in the cloud. You can export the data as a CSV or XML file into your preferred visualization tool or cloud-migration solution to plan your migration. For more information, see the Application Discovery Service FAQ.
Application Discovery Service offers two modes of operation.
Agentless discovery mode is recommended for environments that use VMware vCenter Server. This mode doesn't require you to install an agent on each host. 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 software and software dependencies. It also doesn't work in non-VMware environments. We recommend that you use agent-based discovery for non-VMware environments and if you want to collect information about software and software dependencies. You can also run agent-based and agentless discovery simultaneously. Use agentless discovery to quickly complete the initial infrastructure assessment and then install agents on select hosts to gather information about software and software dependencies.
Agent-based discovery mode collects a richer set of data than agentless discovery by using Amazon software, 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 installed software applications, system and process performance, resource utilization, and network dependencies between workloads. The information collected by agents is secured at rest and in transit to the Application Discovery Service database in the cloud.
Application Discovery Service integrates with application discovery solutions from AWS Partner Network (APN) partners. Third-party application discovery tools can query Application Discovery Service and write to the Application Discovery Service database using a public API. You can then import the data into either a visualization tool or cloud-migration solution.
Application Discovery Service doesn't gather sensitive information. All data is handled according to the AWS Privacy Policy. You can operate Application Discovery Service using offline mode to inspect collected data before it is shared with the service.
Your AWS account must be granted access to Application Discovery Service, a process called whitelisting. This is true for AWS partners and customers alike. To request access, sign up for AWS Application Discovery Service here. We send you information about how to get started.
This API reference provides descriptions, syntax, and usage examples for each of the actions and data types for Application Discovery Service. The topic for each action shows the API request parameters and the response. Alternatively, you can use one of the AWS SDKs to access an API that is tailored to the programming language or platform that you're using. For more information, see AWS SDKs.
This guide is intended for use with the AWS Application Discovery Service User Guide .
METHODS
AssociateConfigurationItemsToApplication(ApplicationConfigurationId => Str, ConfigurationIds => ArrayRef[Str|Undef])
Each argument is described in detail in: Paws::Discovery::AssociateConfigurationItemsToApplication
Returns: a Paws::Discovery::AssociateConfigurationItemsToApplicationResponse instance
Associates one or more configuration items with an application.CreateApplication(Name => Str, [Description => Str])
Each argument is described in detail in: Paws::Discovery::CreateApplication
Returns: a Paws::Discovery::CreateApplicationResponse instance
Creates an application with the given name and description.CreateTags(ConfigurationIds => ArrayRef[Str|Undef], Tags => ArrayRef[Paws::Discovery::Tag])
Each argument is described in detail in: Paws::Discovery::CreateTags
Returns: a Paws::Discovery::CreateTagsResponse instance
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.DeleteApplications(ConfigurationIds => ArrayRef[Str|Undef])
Each argument is described in detail in: Paws::Discovery::DeleteApplications
Returns: a Paws::Discovery::DeleteApplicationsResponse instance
Deletes a list of applications and their associations with
configuration items.DeleteTags(ConfigurationIds => ArrayRef[Str|Undef], [Tags => ArrayRef[Paws::Discovery::Tag]])
Each argument is described in detail in: Paws::Discovery::DeleteTags
Returns: a Paws::Discovery::DeleteTagsResponse instance
Deletes the association between configuration items and one or more
tags. This API accepts a list of multiple configuration items.DescribeAgents([AgentIds => ArrayRef[Str|Undef], Filters => ArrayRef[Paws::Discovery::Filter], MaxResults => Int, NextToken => Str])
Each argument is described in detail in: Paws::Discovery::DescribeAgents
Returns: a Paws::Discovery::DescribeAgentsResponse instance
Lists agents or the Connector by ID or lists all agents/Connectors
associated with your user account if you did not specify an ID.DescribeConfigurations(ConfigurationIds => ArrayRef[Str|Undef])
Each argument is described in detail in: Paws::Discovery::DescribeConfigurations
Returns: a Paws::Discovery::DescribeConfigurationsResponse instance
Retrieves attributes for a list of configuration item IDs. All of the
supplied IDs must be for the same asset type (server, application,
process, or connection). Output fields are specific to the asset type
selected. For example, the output for a I<server> configuration item
includes a list of attributes about the server, such as host name,
operating system, and number of network cards.For a complete list of outputs for each asset type, see Using the DescribeConfigurations Action.
DescribeExportConfigurations([ExportIds => ArrayRef[Str|Undef], MaxResults => Int, NextToken => Str])
Each argument is described in detail in: Paws::Discovery::DescribeExportConfigurations
Returns: a Paws::Discovery::DescribeExportConfigurationsResponse instance
Deprecated. Use C<DescribeExportTasks> instead.Retrieves the status of a given export process. You can retrieve status from a maximum of 100 processes.
DescribeExportTasks([ExportIds => ArrayRef[Str|Undef], MaxResults => Int, NextToken => Str])
Each argument is described in detail in: Paws::Discovery::DescribeExportTasks
Returns: a Paws::Discovery::DescribeExportTasksResponse instance
Retrieve status of one or more export tasks. You can retrieve the
status of up to 100 export tasks.DescribeTags([Filters => ArrayRef[Paws::Discovery::TagFilter], MaxResults => Int, NextToken => Str])
Each argument is described in detail in: Paws::Discovery::DescribeTags
Returns: a Paws::Discovery::DescribeTagsResponse instance
Retrieves a list of configuration items that are tagged with a specific
tag. Or retrieves a list of all tags assigned to a specific
configuration item.DisassociateConfigurationItemsFromApplication(ApplicationConfigurationId => Str, ConfigurationIds => ArrayRef[Str|Undef])
Each argument is described in detail in: Paws::Discovery::DisassociateConfigurationItemsFromApplication
Returns: a Paws::Discovery::DisassociateConfigurationItemsFromApplicationResponse instance
Disassociates one or more configuration items from an application.ExportConfigurations( => )
Each argument is described in detail in: Paws::Discovery::ExportConfigurations
Returns: a Paws::Discovery::ExportConfigurationsResponse instance
Deprecated. Use C<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()
Each argument is described in detail in: Paws::Discovery::GetDiscoverySummary
Returns: a Paws::Discovery::GetDiscoverySummaryResponse instance
Retrieves a short summary of discovered assets.ListConfigurations(ConfigurationType => Str, [Filters => ArrayRef[Paws::Discovery::Filter], MaxResults => Int, NextToken => Str, OrderBy => ArrayRef[Paws::Discovery::OrderByElement]])
Each argument is described in detail in: Paws::Discovery::ListConfigurations
Returns: a Paws::Discovery::ListConfigurationsResponse instance
Retrieves a list of configuration items according to criteria that you
specify in a filter. The filter criteria identifies the relationship
requirements.ListServerNeighbors(ConfigurationId => Str, [MaxResults => Int, NeighborConfigurationIds => ArrayRef[Str|Undef], NextToken => Str, PortInformationNeeded => Bool])
Each argument is described in detail in: Paws::Discovery::ListServerNeighbors
Returns: a Paws::Discovery::ListServerNeighborsResponse instance
Retrieves a list of servers that are one network hop away from a
specified server.StartDataCollectionByAgentIds(AgentIds => ArrayRef[Str|Undef])
Each argument is described in detail in: Paws::Discovery::StartDataCollectionByAgentIds
Returns: a Paws::Discovery::StartDataCollectionByAgentIdsResponse instance
Instructs the specified agents or connectors to start collecting data.StartExportTask([ExportDataFormat => ArrayRef[Str|Undef]])
Each argument is described in detail in: Paws::Discovery::StartExportTask
Returns: a Paws::Discovery::StartExportTaskResponse instance
Export the configuration data about discovered configuration items and
relationships to an S3 bucket in a specified format.StopDataCollectionByAgentIds(AgentIds => ArrayRef[Str|Undef])
Each argument is described in detail in: Paws::Discovery::StopDataCollectionByAgentIds
Returns: a Paws::Discovery::StopDataCollectionByAgentIdsResponse instance
Instructs the specified agents or connectors to stop collecting data.UpdateApplication(ConfigurationId => Str, [Description => Str, Name => Str])
Each argument is described in detail in: Paws::Discovery::UpdateApplication
Returns: a Paws::Discovery::UpdateApplicationResponse instance
Updates metadata about an application.PAGINATORS
Paginator methods are helpers that repetively call methods that return partial results
SEE ALSO
This service class forms part of Paws
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues