« blib/lib/Paws/EC2/DescribeHostReservationsResult.pm
↑ Summary
blib/lib/Paws/EC2/DescribeHostsResult.pm »
| 1 | |||
| 2 | package Paws::EC2::DescribeHosts; | ||
| 3 | use Moose; | ||
| 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 | use MooseX::ClassAttribute; | ||
| 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 L<Paws::EC2> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method DescribeHosts on the | ||
| 25 | L<Amazon Elastic Compute Cloud|Paws::EC2> 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 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $ec2 = Paws->service('EC2'); | ||
| 33 | my $DescribeHostsResult = $ec2->DescribeHosts( | ||
| 34 | Filter => [ | ||
| 35 | { | ||
| 36 | Name => 'MyString', # OPTIONAL | ||
| 37 | Values => [ | ||
| 38 | 'MyString', ... # OPTIONAL | ||
| 39 | ], # OPTIONAL | ||
| 40 | }, | ||
| 41 | ... | ||
| 42 | ], # OPTIONAL | ||
| 43 | HostIds => [ 'MyDedicatedHostId', ... ], # OPTIONAL | ||
| 44 | MaxResults => 1, # OPTIONAL | ||
| 45 | NextToken => 'MyString', # OPTIONAL | ||
| 46 | ); | ||
| 47 | |||
| 48 | # Results: | ||
| 49 | my $Hosts = $DescribeHostsResult->Hosts; | ||
| 50 | my $NextToken = $DescribeHostsResult->NextToken; | ||
| 51 | |||
| 52 | # Returns a L<Paws::EC2::DescribeHostsResult> object. | ||
| 53 | |||
| 54 | 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. | ||
| 55 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ec2/DescribeHosts> | ||
| 56 | |||
| 57 | =head1 ATTRIBUTES | ||
| 58 | |||
| 59 | |||
| 60 | =head2 Filter => ArrayRef[L<Paws::EC2::Filter>] | ||
| 61 | |||
| 62 | The filters. | ||
| 63 | |||
| 64 | =over | ||
| 65 | |||
| 66 | =item * | ||
| 67 | |||
| 68 | C<auto-placement> - Whether auto-placement is enabled or disabled | ||
| 69 | (C<on> | C<off>). | ||
| 70 | |||
| 71 | =item * | ||
| 72 | |||
| 73 | C<availability-zone> - The Availability Zone of the host. | ||
| 74 | |||
| 75 | =item * | ||
| 76 | |||
| 77 | C<client-token> - The idempotency token that you provided when you | ||
| 78 | allocated the host. | ||
| 79 | |||
| 80 | =item * | ||
| 81 | |||
| 82 | C<host-reservation-id> - The ID of the reservation assigned to this | ||
| 83 | host. | ||
| 84 | |||
| 85 | =item * | ||
| 86 | |||
| 87 | C<instance-type> - The instance type size that the Dedicated Host is | ||
| 88 | configured to support. | ||
| 89 | |||
| 90 | =item * | ||
| 91 | |||
| 92 | C<state> - The allocation state of the Dedicated Host (C<available> | | ||
| 93 | C<under-assessment> | C<permanent-failure> | C<released> | | ||
| 94 | C<released-permanent-failure>). | ||
| 95 | |||
| 96 | =item * | ||
| 97 | |||
| 98 | C<tag-key> - The key of a tag assigned to the resource. Use this filter | ||
| 99 | to find all resources assigned a tag with a specific key, regardless of | ||
| 100 | the tag value. | ||
| 101 | |||
| 102 | =back | ||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | =head2 HostIds => ArrayRef[Str|Undef] | ||
| 108 | |||
| 109 | The IDs of the Dedicated Hosts. The IDs are used for targeted instance | ||
| 110 | launches. | ||
| 111 | |||
| 112 | |||
| 113 | |||
| 114 | =head2 MaxResults => Int | ||
| 115 | |||
| 116 | The maximum number of results to return for the request in a single | ||
| 117 | page. The remaining results can be seen by sending another request with | ||
| 118 | the returned C<nextToken> value. This value can be between 5 and 500. | ||
| 119 | If C<maxResults> is given a larger value than 500, you receive an | ||
| 120 | error. | ||
| 121 | |||
| 122 | You cannot specify this parameter and the host IDs parameter in the | ||
| 123 | same request. | ||
| 124 | |||
| 125 | |||
| 126 | |||
| 127 | =head2 NextToken => Str | ||
| 128 | |||
| 129 | The token to use to retrieve the next page of results. | ||
| 130 | |||
| 131 | |||
| 132 | |||
| 133 | |||
| 134 | =head1 SEE ALSO | ||
| 135 | |||
| 136 | This class forms part of L<Paws>, documenting arguments for method DescribeHosts in L<Paws::EC2> | ||
| 137 | |||
| 138 | =head1 BUGS and CONTRIBUTIONS | ||
| 139 | |||
| 140 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 141 | |||
| 142 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 143 | |||
| 144 | =cut | ||
| 145 |