File Coverage

blib/lib/Paws/Discovery/DescribeAgents.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::Discovery::DescribeAgents;
3 1     1   330 use Moose;
  1         2  
  1         7  
4             has AgentIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'agentIds' );
5             has Filters => (is => 'ro', isa => 'ArrayRef[Paws::Discovery::Filter]', traits => ['NameInRequest'], request_name => 'filters' );
6             has MaxResults => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'maxResults' );
7             has NextToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextToken' );
8              
9 1     1   5918 use MooseX::ClassAttribute;
  1         3  
  1         9  
10              
11             class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeAgents');
12             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Discovery::DescribeAgentsResponse');
13             class_has _result_key => (isa => 'Str', is => 'ro');
14             1;
15              
16             ### main pod documentation begin ###
17              
18             =head1 NAME
19              
20             Paws::Discovery::DescribeAgents - Arguments for method DescribeAgents on Paws::Discovery
21              
22             =head1 DESCRIPTION
23              
24             This class represents the parameters used for calling the method DescribeAgents on the
25             AWS Application Discovery Service service. Use the attributes of this class
26             as arguments to method DescribeAgents.
27              
28             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeAgents.
29              
30             As an example:
31              
32             $service_obj->DescribeAgents(Att1 => $value1, Att2 => $value2, ...);
33              
34             Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
35              
36             =head1 ATTRIBUTES
37              
38              
39             =head2 AgentIds => ArrayRef[Str|Undef]
40              
41             The agent or the Connector IDs for which you want information. If you
42             specify no IDs, the system returns information about all
43             agents/Connectors associated with your AWS user account.
44              
45              
46              
47             =head2 Filters => ArrayRef[L<Paws::Discovery::Filter>]
48              
49             You can filter the request using various logical operators and a
50             I<key>-I<value> format. For example:
51              
52             C<{"key": "collectionStatus", "value": "STARTED"}>
53              
54              
55              
56             =head2 MaxResults => Int
57              
58             The total number of agents/Connectors to return in a single page of
59             output. The maximum value is 100.
60              
61              
62              
63             =head2 NextToken => Str
64              
65             Token to retrieve the next set of results. For example, if you
66             previously specified 100 IDs for C<DescribeAgentsRequest$agentIds> but
67             set C<DescribeAgentsRequest$maxResults> to 10, you received a set of 10
68             results along with a token. Use that token in this query to get the
69             next set of 10.
70              
71              
72              
73              
74             =head1 SEE ALSO
75              
76             This class forms part of L<Paws>, documenting arguments for method DescribeAgents in L<Paws::Discovery>
77              
78             =head1 BUGS and CONTRIBUTIONS
79              
80             The source code is located here: https://github.com/pplu/aws-sdk-perl
81              
82             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
83              
84             =cut
85