File Coverage

blib/lib/Paws/Discovery.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::Discovery;
2 1     1   4373 use Moose;
  1         2  
  1         10  
3             sub service { 'discovery' }
4             sub version { '2015-11-01' }
5             sub target_prefix { 'AWSPoseidonService_V2015_11_01' }
6             sub json_version { "1.1" }
7             has max_attempts => (is => 'ro', isa => 'Int', default => 5);
8             has retry => (is => 'ro', isa => 'HashRef', default => sub {
9             { base => 'rand', type => 'exponential', growth_factor => 2 }
10             });
11             has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [
12             ] });
13              
14             with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::V4Signature', 'Paws::Net::JsonCaller', 'Paws::Net::JsonResponse';
15              
16            
17             sub AssociateConfigurationItemsToApplication {
18             my $self = shift;
19             my $call_object = $self->new_with_coercions('Paws::Discovery::AssociateConfigurationItemsToApplication', @_);
20             return $self->caller->do_call($self, $call_object);
21             }
22             sub CreateApplication {
23             my $self = shift;
24             my $call_object = $self->new_with_coercions('Paws::Discovery::CreateApplication', @_);
25             return $self->caller->do_call($self, $call_object);
26             }
27             sub CreateTags {
28             my $self = shift;
29             my $call_object = $self->new_with_coercions('Paws::Discovery::CreateTags', @_);
30             return $self->caller->do_call($self, $call_object);
31             }
32             sub DeleteApplications {
33             my $self = shift;
34             my $call_object = $self->new_with_coercions('Paws::Discovery::DeleteApplications', @_);
35             return $self->caller->do_call($self, $call_object);
36             }
37             sub DeleteTags {
38             my $self = shift;
39             my $call_object = $self->new_with_coercions('Paws::Discovery::DeleteTags', @_);
40             return $self->caller->do_call($self, $call_object);
41             }
42             sub DescribeAgents {
43             my $self = shift;
44             my $call_object = $self->new_with_coercions('Paws::Discovery::DescribeAgents', @_);
45             return $self->caller->do_call($self, $call_object);
46             }
47             sub DescribeConfigurations {
48             my $self = shift;
49             my $call_object = $self->new_with_coercions('Paws::Discovery::DescribeConfigurations', @_);
50             return $self->caller->do_call($self, $call_object);
51             }
52             sub DescribeExportConfigurations {
53             my $self = shift;
54             my $call_object = $self->new_with_coercions('Paws::Discovery::DescribeExportConfigurations', @_);
55             return $self->caller->do_call($self, $call_object);
56             }
57             sub DescribeExportTasks {
58             my $self = shift;
59             my $call_object = $self->new_with_coercions('Paws::Discovery::DescribeExportTasks', @_);
60             return $self->caller->do_call($self, $call_object);
61             }
62             sub DescribeTags {
63             my $self = shift;
64             my $call_object = $self->new_with_coercions('Paws::Discovery::DescribeTags', @_);
65             return $self->caller->do_call($self, $call_object);
66             }
67             sub DisassociateConfigurationItemsFromApplication {
68             my $self = shift;
69             my $call_object = $self->new_with_coercions('Paws::Discovery::DisassociateConfigurationItemsFromApplication', @_);
70             return $self->caller->do_call($self, $call_object);
71             }
72             sub ExportConfigurations {
73             my $self = shift;
74             my $call_object = $self->new_with_coercions('Paws::Discovery::ExportConfigurations', @_);
75             return $self->caller->do_call($self, $call_object);
76             }
77             sub GetDiscoverySummary {
78             my $self = shift;
79             my $call_object = $self->new_with_coercions('Paws::Discovery::GetDiscoverySummary', @_);
80             return $self->caller->do_call($self, $call_object);
81             }
82             sub ListConfigurations {
83             my $self = shift;
84             my $call_object = $self->new_with_coercions('Paws::Discovery::ListConfigurations', @_);
85             return $self->caller->do_call($self, $call_object);
86             }
87             sub ListServerNeighbors {
88             my $self = shift;
89             my $call_object = $self->new_with_coercions('Paws::Discovery::ListServerNeighbors', @_);
90             return $self->caller->do_call($self, $call_object);
91             }
92             sub StartDataCollectionByAgentIds {
93             my $self = shift;
94             my $call_object = $self->new_with_coercions('Paws::Discovery::StartDataCollectionByAgentIds', @_);
95             return $self->caller->do_call($self, $call_object);
96             }
97             sub StartExportTask {
98             my $self = shift;
99             my $call_object = $self->new_with_coercions('Paws::Discovery::StartExportTask', @_);
100             return $self->caller->do_call($self, $call_object);
101             }
102             sub StopDataCollectionByAgentIds {
103             my $self = shift;
104             my $call_object = $self->new_with_coercions('Paws::Discovery::StopDataCollectionByAgentIds', @_);
105             return $self->caller->do_call($self, $call_object);
106             }
107             sub UpdateApplication {
108             my $self = shift;
109             my $call_object = $self->new_with_coercions('Paws::Discovery::UpdateApplication', @_);
110             return $self->caller->do_call($self, $call_object);
111             }
112            
113              
114              
115             sub operations { qw/AssociateConfigurationItemsToApplication CreateApplication CreateTags DeleteApplications DeleteTags DescribeAgents DescribeConfigurations DescribeExportConfigurations DescribeExportTasks DescribeTags DisassociateConfigurationItemsFromApplication ExportConfigurations GetDiscoverySummary ListConfigurations ListServerNeighbors StartDataCollectionByAgentIds StartExportTask StopDataCollectionByAgentIds UpdateApplication / }
116              
117             1;
118              
119             ### main pod documentation begin ###
120              
121             =head1 NAME
122              
123             Paws::Discovery - Perl Interface to AWS AWS Application Discovery Service
124              
125             =head1 SYNOPSIS
126              
127             use Paws;
128              
129             my $obj = Paws->service('Discovery');
130             my $res = $obj->Method(
131             Arg1 => $val1,
132             Arg2 => [ 'V1', 'V2' ],
133             # if Arg3 is an object, the HashRef will be used as arguments to the constructor
134             # of the arguments type
135             Arg3 => { Att1 => 'Val1' },
136             # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
137             # the constructor of the arguments type
138             Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ],
139             );
140              
141             =head1 DESCRIPTION
142              
143             AWS Application Discovery Service
144              
145             AWS Application Discovery Service helps you plan application migration
146             projects by automatically identifying servers, virtual machines (VMs),
147             software, and software dependencies running in your on-premises data
148             centers. Application Discovery Service also collects application
149             performance data, which can help you assess the outcome of your
150             migration. The data collected by Application Discovery Service is
151             securely retained in an Amazon-hosted and managed database in the
152             cloud. You can export the data as a CSV or XML file into your preferred
153             visualization tool or cloud-migration solution to plan your migration.
154             For more information, see the Application Discovery Service FAQ.
155              
156             Application Discovery Service offers two modes of operation.
157              
158             =over
159              
160             =item *
161              
162             B<Agentless discovery> mode is recommended for environments that use
163             VMware vCenter Server. This mode doesn't require you to install an
164             agent on each host. Agentless discovery gathers server information
165             regardless of the operating systems, which minimizes the time required
166             for initial on-premises infrastructure assessment. Agentless discovery
167             doesn't collect information about software and software dependencies.
168             It also doesn't work in non-VMware environments. We recommend that you
169             use agent-based discovery for non-VMware environments and if you want
170             to collect information about software and software dependencies. You
171             can also run agent-based and agentless discovery simultaneously. Use
172             agentless discovery to quickly complete the initial infrastructure
173             assessment and then install agents on select hosts to gather
174             information about software and software dependencies.
175              
176             =item *
177              
178             B<Agent-based discovery> mode collects a richer set of data than
179             agentless discovery by using Amazon software, the AWS Application
180             Discovery Agent, which you install on one or more hosts in your data
181             center. The agent captures infrastructure and application information,
182             including an inventory of installed software applications, system and
183             process performance, resource utilization, and network dependencies
184             between workloads. The information collected by agents is secured at
185             rest and in transit to the Application Discovery Service database in
186             the cloud.
187              
188             =back
189              
190             Application Discovery Service integrates with application discovery
191             solutions from AWS Partner Network (APN) partners. Third-party
192             application discovery tools can query Application Discovery Service and
193             write to the Application Discovery Service database using a public API.
194             You can then import the data into either a visualization tool or
195             cloud-migration solution.
196              
197             Application Discovery Service doesn't gather sensitive information. All
198             data is handled according to the AWS Privacy Policy. You can operate
199             Application Discovery Service using offline mode to inspect collected
200             data before it is shared with the service.
201              
202             Your AWS account must be granted access to Application Discovery
203             Service, a process called I<whitelisting>. This is true for AWS
204             partners and customers alike. To request access, sign up for AWS
205             Application Discovery Service here. We send you information about how
206             to get started.
207              
208             This API reference provides descriptions, syntax, and usage examples
209             for each of the actions and data types for Application Discovery
210             Service. The topic for each action shows the API request parameters and
211             the response. Alternatively, you can use one of the AWS SDKs to access
212             an API that is tailored to the programming language or platform that
213             you're using. For more information, see AWS SDKs.
214              
215             This guide is intended for use with the I<AWS Application Discovery
216             Service User Guide> .
217              
218             =head1 METHODS
219              
220             =head2 AssociateConfigurationItemsToApplication(ApplicationConfigurationId => Str, ConfigurationIds => ArrayRef[Str|Undef])
221              
222             Each argument is described in detail in: L<Paws::Discovery::AssociateConfigurationItemsToApplication>
223              
224             Returns: a L<Paws::Discovery::AssociateConfigurationItemsToApplicationResponse> instance
225              
226             Associates one or more configuration items with an application.
227              
228              
229             =head2 CreateApplication(Name => Str, [Description => Str])
230              
231             Each argument is described in detail in: L<Paws::Discovery::CreateApplication>
232              
233             Returns: a L<Paws::Discovery::CreateApplicationResponse> instance
234              
235             Creates an application with the given name and description.
236              
237              
238             =head2 CreateTags(ConfigurationIds => ArrayRef[Str|Undef], Tags => ArrayRef[L<Paws::Discovery::Tag>])
239              
240             Each argument is described in detail in: L<Paws::Discovery::CreateTags>
241              
242             Returns: a L<Paws::Discovery::CreateTagsResponse> instance
243              
244             Creates one or more tags for configuration items. Tags are metadata
245             that help you categorize IT assets. This API accepts a list of multiple
246             configuration items.
247              
248              
249             =head2 DeleteApplications(ConfigurationIds => ArrayRef[Str|Undef])
250              
251             Each argument is described in detail in: L<Paws::Discovery::DeleteApplications>
252              
253             Returns: a L<Paws::Discovery::DeleteApplicationsResponse> instance
254              
255             Deletes a list of applications and their associations with
256             configuration items.
257              
258              
259             =head2 DeleteTags(ConfigurationIds => ArrayRef[Str|Undef], [Tags => ArrayRef[L<Paws::Discovery::Tag>]])
260              
261             Each argument is described in detail in: L<Paws::Discovery::DeleteTags>
262              
263             Returns: a L<Paws::Discovery::DeleteTagsResponse> instance
264              
265             Deletes the association between configuration items and one or more
266             tags. This API accepts a list of multiple configuration items.
267              
268              
269             =head2 DescribeAgents([AgentIds => ArrayRef[Str|Undef], Filters => ArrayRef[L<Paws::Discovery::Filter>], MaxResults => Int, NextToken => Str])
270              
271             Each argument is described in detail in: L<Paws::Discovery::DescribeAgents>
272              
273             Returns: a L<Paws::Discovery::DescribeAgentsResponse> instance
274              
275             Lists agents or the Connector by ID or lists all agents/Connectors
276             associated with your user account if you did not specify an ID.
277              
278              
279             =head2 DescribeConfigurations(ConfigurationIds => ArrayRef[Str|Undef])
280              
281             Each argument is described in detail in: L<Paws::Discovery::DescribeConfigurations>
282              
283             Returns: a L<Paws::Discovery::DescribeConfigurationsResponse> instance
284              
285             Retrieves attributes for a list of configuration item IDs. All of the
286             supplied IDs must be for the same asset type (server, application,
287             process, or connection). Output fields are specific to the asset type
288             selected. For example, the output for a I<server> configuration item
289             includes a list of attributes about the server, such as host name,
290             operating system, and number of network cards.
291              
292             For a complete list of outputs for each asset type, see Using the
293             DescribeConfigurations Action.
294              
295              
296             =head2 DescribeExportConfigurations([ExportIds => ArrayRef[Str|Undef], MaxResults => Int, NextToken => Str])
297              
298             Each argument is described in detail in: L<Paws::Discovery::DescribeExportConfigurations>
299              
300             Returns: a L<Paws::Discovery::DescribeExportConfigurationsResponse> instance
301              
302             Deprecated. Use C<DescribeExportTasks> instead.
303              
304             Retrieves the status of a given export process. You can retrieve status
305             from a maximum of 100 processes.
306              
307              
308             =head2 DescribeExportTasks([ExportIds => ArrayRef[Str|Undef], Filters => ArrayRef[L<Paws::Discovery::ExportFilter>], MaxResults => Int, NextToken => Str])
309              
310             Each argument is described in detail in: L<Paws::Discovery::DescribeExportTasks>
311              
312             Returns: a L<Paws::Discovery::DescribeExportTasksResponse> instance
313              
314             Retrieve status of one or more export tasks. You can retrieve the
315             status of up to 100 export tasks.
316              
317              
318             =head2 DescribeTags([Filters => ArrayRef[L<Paws::Discovery::TagFilter>], MaxResults => Int, NextToken => Str])
319              
320             Each argument is described in detail in: L<Paws::Discovery::DescribeTags>
321              
322             Returns: a L<Paws::Discovery::DescribeTagsResponse> instance
323              
324             Retrieves a list of configuration items that are tagged with a specific
325             tag. Or retrieves a list of all tags assigned to a specific
326             configuration item.
327              
328              
329             =head2 DisassociateConfigurationItemsFromApplication(ApplicationConfigurationId => Str, ConfigurationIds => ArrayRef[Str|Undef])
330              
331             Each argument is described in detail in: L<Paws::Discovery::DisassociateConfigurationItemsFromApplication>
332              
333             Returns: a L<Paws::Discovery::DisassociateConfigurationItemsFromApplicationResponse> instance
334              
335             Disassociates one or more configuration items from an application.
336              
337              
338             =head2 ExportConfigurations( => )
339              
340             Each argument is described in detail in: L<Paws::Discovery::ExportConfigurations>
341              
342             Returns: a L<Paws::Discovery::ExportConfigurationsResponse> instance
343              
344             Deprecated. Use C<StartExportTask> instead.
345              
346             Exports all discovered configuration data to an Amazon S3 bucket or an
347             application that enables you to view and evaluate the data. Data
348             includes tags and tag associations, processes, connections, servers,
349             and system performance. This API returns an export ID that you can
350             query using the I<DescribeExportConfigurations> API. The system imposes
351             a limit of two configuration exports in six hours.
352              
353              
354             =head2 GetDiscoverySummary()
355              
356             Each argument is described in detail in: L<Paws::Discovery::GetDiscoverySummary>
357              
358             Returns: a L<Paws::Discovery::GetDiscoverySummaryResponse> instance
359              
360             Retrieves a short summary of discovered assets.
361              
362              
363             =head2 ListConfigurations(ConfigurationType => Str, [Filters => ArrayRef[L<Paws::Discovery::Filter>], MaxResults => Int, NextToken => Str, OrderBy => ArrayRef[L<Paws::Discovery::OrderByElement>]])
364              
365             Each argument is described in detail in: L<Paws::Discovery::ListConfigurations>
366              
367             Returns: a L<Paws::Discovery::ListConfigurationsResponse> instance
368              
369             Retrieves a list of configuration items according to criteria that you
370             specify in a filter. The filter criteria identifies the relationship
371             requirements.
372              
373              
374             =head2 ListServerNeighbors(ConfigurationId => Str, [MaxResults => Int, NeighborConfigurationIds => ArrayRef[Str|Undef], NextToken => Str, PortInformationNeeded => Bool])
375              
376             Each argument is described in detail in: L<Paws::Discovery::ListServerNeighbors>
377              
378             Returns: a L<Paws::Discovery::ListServerNeighborsResponse> instance
379              
380             Retrieves a list of servers that are one network hop away from a
381             specified server.
382              
383              
384             =head2 StartDataCollectionByAgentIds(AgentIds => ArrayRef[Str|Undef])
385              
386             Each argument is described in detail in: L<Paws::Discovery::StartDataCollectionByAgentIds>
387              
388             Returns: a L<Paws::Discovery::StartDataCollectionByAgentIdsResponse> instance
389              
390             Instructs the specified agents or connectors to start collecting data.
391              
392              
393             =head2 StartExportTask([EndTime => Str, ExportDataFormat => ArrayRef[Str|Undef], Filters => ArrayRef[L<Paws::Discovery::ExportFilter>], StartTime => Str])
394              
395             Each argument is described in detail in: L<Paws::Discovery::StartExportTask>
396              
397             Returns: a L<Paws::Discovery::StartExportTaskResponse> instance
398              
399             Begins the export of discovered data to an S3 bucket.
400              
401             If you specify C<agentId> in a filter, the task exports up to 72 hours
402             of detailed data collected by the identified Application Discovery
403             Agent, including network, process, and performance details. A time
404             range for exported agent data may be set by using C<startTime> and
405             C<endTime>. Export of detailed agent data is limited to five
406             concurrently running exports.
407              
408             If you do not include an C<agentId> filter, summary data is exported
409             that includes both AWS Agentless Discovery Connector data and summary
410             data from AWS Discovery Agents. Export of summary data is limited to
411             two exports per day.
412              
413              
414             =head2 StopDataCollectionByAgentIds(AgentIds => ArrayRef[Str|Undef])
415              
416             Each argument is described in detail in: L<Paws::Discovery::StopDataCollectionByAgentIds>
417              
418             Returns: a L<Paws::Discovery::StopDataCollectionByAgentIdsResponse> instance
419              
420             Instructs the specified agents or connectors to stop collecting data.
421              
422              
423             =head2 UpdateApplication(ConfigurationId => Str, [Description => Str, Name => Str])
424              
425             Each argument is described in detail in: L<Paws::Discovery::UpdateApplication>
426              
427             Returns: a L<Paws::Discovery::UpdateApplicationResponse> instance
428              
429             Updates metadata about an application.
430              
431              
432              
433              
434             =head1 PAGINATORS
435              
436             Paginator methods are helpers that repetively call methods that return partial results
437              
438              
439              
440              
441             =head1 SEE ALSO
442              
443             This service class forms part of L<Paws>
444              
445             =head1 BUGS and CONTRIBUTIONS
446              
447             The source code is located here: https://github.com/pplu/aws-sdk-perl
448              
449             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
450              
451             =cut
452