File Coverage

blib/lib/Paws/EC2/DescribeHosts.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::EC2::DescribeHosts;
3 1     1   277 use Moose;
  1         3  
  1         5  
4             has Filter => (is => 'ro', isa => 'ArrayRef[Paws::EC2::Filter]', traits => ['NameInRequest'], request_name => 'filter' );
5             has HostIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'hostId' );
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   5595 use MooseX::ClassAttribute;
  1         2  
  1         7  
10              
11             class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeHosts');
12             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::DescribeHostsResult');
13             class_has _result_key => (isa => 'Str', is => 'ro');
14             1;
15              
16             ### main pod documentation begin ###
17              
18             =head1 NAME
19              
20             Paws::EC2::DescribeHosts - Arguments for method DescribeHosts on Paws::EC2
21              
22             =head1 DESCRIPTION
23              
24             This class represents the parameters used for calling the method DescribeHosts on the
25             Amazon Elastic Compute Cloud service. Use the attributes of this class
26             as arguments to method DescribeHosts.
27              
28             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeHosts.
29              
30             As an example:
31              
32             $service_obj->DescribeHosts(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 Filter => ArrayRef[L<Paws::EC2::Filter>]
40              
41             One or more filters.
42              
43             =over
44              
45             =item *
46              
47             C<instance-type> - The instance type size that the Dedicated Host is
48             configured to support.
49              
50             =item *
51              
52             C<auto-placement> - Whether auto-placement is enabled or disabled
53             (C<on> | C<off>).
54              
55             =item *
56              
57             C<host-reservation-id> - The ID of the reservation assigned to this
58             host.
59              
60             =item *
61              
62             C<client-token> - The idempotency token you provided when you launched
63             the instance
64              
65             =item *
66              
67             C<state>- The allocation state of the Dedicated Host (C<available> |
68             C<under-assessment> | C<permanent-failure> | C<released> |
69             C<released-permanent-failure>).
70              
71             =item *
72              
73             C<availability-zone> - The Availability Zone of the host.
74              
75             =back
76              
77              
78              
79              
80             =head2 HostIds => ArrayRef[Str|Undef]
81              
82             The IDs of the Dedicated Hosts. The IDs are used for targeted instance
83             launches.
84              
85              
86              
87             =head2 MaxResults => Int
88              
89             The maximum number of results to return for the request in a single
90             page. The remaining results can be seen by sending another request with
91             the returned C<nextToken> value. This value can be between 5 and 500;
92             if C<maxResults> is given a larger value than 500, you will receive an
93             error. You cannot specify this parameter and the host IDs parameter in
94             the same request.
95              
96              
97              
98             =head2 NextToken => Str
99              
100             The token to retrieve the next page of results.
101              
102              
103              
104              
105             =head1 SEE ALSO
106              
107             This class forms part of L<Paws>, documenting arguments for method DescribeHosts in L<Paws::EC2>
108              
109             =head1 BUGS and CONTRIBUTIONS
110              
111             The source code is located here: https://github.com/pplu/aws-sdk-perl
112              
113             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
114              
115             =cut
116