« blib/lib/Paws/EC2/DescribeNetworkAclsResult.pm
↑ Summary
blib/lib/Paws/EC2/DescribeNetworkInterfacesResult.pm »
| 1 | |||
| 2 | package Paws::EC2::DescribeNetworkInterfaces; | ||
| 3 | 1 | ▶ | use Moose; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 4 | 1 | has DryRun => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'dryRun' ); | |
| 5 | 1 | has Filters => (is => 'ro', isa => 'ArrayRef[Paws::EC2::Filter]', traits => ['NameInRequest'], request_name => 'filter' ); | |
| 6 | 1 | has MaxResults => (is => 'ro', isa => 'Int'); | |
| 7 | 1 | has NetworkInterfaceIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'NetworkInterfaceId' ); | |
| 8 | 1 | has NextToken => (is => 'ro', isa => 'Str'); | |
| 9 | |||
| 10 | 1 | ▶ | use MooseX::ClassAttribute; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 11 | |||
| 12 | 1 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeNetworkInterfaces'); | |
| 13 | 1 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::DescribeNetworkInterfacesResult'); | |
| 14 | 1 | class_has _result_key => (isa => 'Str', is => 'ro'); | |
| 15 | 1 | 1; | |
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::EC2::DescribeNetworkInterfaces - Arguments for method DescribeNetworkInterfaces on L<Paws::EC2> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method DescribeNetworkInterfaces on the | ||
| 26 | L<Amazon Elastic Compute Cloud|Paws::EC2> service. Use the attributes of this class | ||
| 27 | as arguments to method DescribeNetworkInterfaces. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeNetworkInterfaces. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $ec2 = Paws->service('EC2'); | ||
| 34 | # To describe a network interface | ||
| 35 | my $DescribeNetworkInterfacesResult = $ec2->DescribeNetworkInterfaces( | ||
| 36 | 'NetworkInterfaceIds' => ['eni-e5aa89a3'] ); | ||
| 37 | |||
| 38 | # Results: | ||
| 39 | my $NetworkInterfaces = $DescribeNetworkInterfacesResult->NetworkInterfaces; | ||
| 40 | |||
| 41 | # Returns a L<Paws::EC2::DescribeNetworkInterfacesResult> object. | ||
| 42 | |||
| 43 | 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. | ||
| 44 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ec2/DescribeNetworkInterfaces> | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 DryRun => Bool | ||
| 50 | |||
| 51 | Checks whether you have the required permissions for the action, | ||
| 52 | without actually making the request, and provides an error response. If | ||
| 53 | you have the required permissions, the error response is | ||
| 54 | C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>. | ||
| 55 | |||
| 56 | |||
| 57 | |||
| 58 | =head2 Filters => ArrayRef[L<Paws::EC2::Filter>] | ||
| 59 | |||
| 60 | One or more filters. | ||
| 61 | |||
| 62 | =over | ||
| 63 | |||
| 64 | =item * | ||
| 65 | |||
| 66 | C<addresses.private-ip-address> - The private IPv4 addresses associated | ||
| 67 | with the network interface. | ||
| 68 | |||
| 69 | =item * | ||
| 70 | |||
| 71 | C<addresses.primary> - Whether the private IPv4 address is the primary | ||
| 72 | IP address associated with the network interface. | ||
| 73 | |||
| 74 | =item * | ||
| 75 | |||
| 76 | C<addresses.association.public-ip> - The association ID returned when | ||
| 77 | the network interface was associated with the Elastic IP address | ||
| 78 | (IPv4). | ||
| 79 | |||
| 80 | =item * | ||
| 81 | |||
| 82 | C<addresses.association.owner-id> - The owner ID of the addresses | ||
| 83 | associated with the network interface. | ||
| 84 | |||
| 85 | =item * | ||
| 86 | |||
| 87 | C<association.association-id> - The association ID returned when the | ||
| 88 | network interface was associated with an IPv4 address. | ||
| 89 | |||
| 90 | =item * | ||
| 91 | |||
| 92 | C<association.allocation-id> - The allocation ID returned when you | ||
| 93 | allocated the Elastic IP address (IPv4) for your network interface. | ||
| 94 | |||
| 95 | =item * | ||
| 96 | |||
| 97 | C<association.ip-owner-id> - The owner of the Elastic IP address (IPv4) | ||
| 98 | associated with the network interface. | ||
| 99 | |||
| 100 | =item * | ||
| 101 | |||
| 102 | C<association.public-ip> - The address of the Elastic IP address (IPv4) | ||
| 103 | bound to the network interface. | ||
| 104 | |||
| 105 | =item * | ||
| 106 | |||
| 107 | C<association.public-dns-name> - The public DNS name for the network | ||
| 108 | interface (IPv4). | ||
| 109 | |||
| 110 | =item * | ||
| 111 | |||
| 112 | C<attachment.attachment-id> - The ID of the interface attachment. | ||
| 113 | |||
| 114 | =item * | ||
| 115 | |||
| 116 | C<attachment.attach-time> - The time that the network interface was | ||
| 117 | attached to an instance. | ||
| 118 | |||
| 119 | =item * | ||
| 120 | |||
| 121 | C<attachment.delete-on-termination> - Indicates whether the attachment | ||
| 122 | is deleted when an instance is terminated. | ||
| 123 | |||
| 124 | =item * | ||
| 125 | |||
| 126 | C<attachment.device-index> - The device index to which the network | ||
| 127 | interface is attached. | ||
| 128 | |||
| 129 | =item * | ||
| 130 | |||
| 131 | C<attachment.instance-id> - The ID of the instance to which the network | ||
| 132 | interface is attached. | ||
| 133 | |||
| 134 | =item * | ||
| 135 | |||
| 136 | C<attachment.instance-owner-id> - The owner ID of the instance to which | ||
| 137 | the network interface is attached. | ||
| 138 | |||
| 139 | =item * | ||
| 140 | |||
| 141 | C<attachment.status> - The status of the attachment (C<attaching> | | ||
| 142 | C<attached> | C<detaching> | C<detached>). | ||
| 143 | |||
| 144 | =item * | ||
| 145 | |||
| 146 | C<availability-zone> - The Availability Zone of the network interface. | ||
| 147 | |||
| 148 | =item * | ||
| 149 | |||
| 150 | C<description> - The description of the network interface. | ||
| 151 | |||
| 152 | =item * | ||
| 153 | |||
| 154 | C<group-id> - The ID of a security group associated with the network | ||
| 155 | interface. | ||
| 156 | |||
| 157 | =item * | ||
| 158 | |||
| 159 | C<group-name> - The name of a security group associated with the | ||
| 160 | network interface. | ||
| 161 | |||
| 162 | =item * | ||
| 163 | |||
| 164 | C<ipv6-addresses.ipv6-address> - An IPv6 address associated with the | ||
| 165 | network interface. | ||
| 166 | |||
| 167 | =item * | ||
| 168 | |||
| 169 | C<mac-address> - The MAC address of the network interface. | ||
| 170 | |||
| 171 | =item * | ||
| 172 | |||
| 173 | C<network-interface-id> - The ID of the network interface. | ||
| 174 | |||
| 175 | =item * | ||
| 176 | |||
| 177 | C<owner-id> - The account ID of the network interface owner. | ||
| 178 | |||
| 179 | =item * | ||
| 180 | |||
| 181 | C<private-ip-address> - The private IPv4 address or addresses of the | ||
| 182 | network interface. | ||
| 183 | |||
| 184 | =item * | ||
| 185 | |||
| 186 | C<private-dns-name> - The private DNS name of the network interface | ||
| 187 | (IPv4). | ||
| 188 | |||
| 189 | =item * | ||
| 190 | |||
| 191 | C<requester-id> - The alias or account ID of the principal or service | ||
| 192 | that created the network interface. | ||
| 193 | |||
| 194 | =item * | ||
| 195 | |||
| 196 | C<requester-managed> - Indicates whether the network interface is being | ||
| 197 | managed by an Amazon Web Service (for example, Management Console, Auto | ||
| 198 | Scaling, and so on). | ||
| 199 | |||
| 200 | =item * | ||
| 201 | |||
| 202 | C<source-dest-check> - Indicates whether the network interface performs | ||
| 203 | source/destination checking. A value of C<true> means checking is | ||
| 204 | enabled, and C<false> means checking is disabled. The value must be | ||
| 205 | C<false> for the network interface to perform network address | ||
| 206 | translation (NAT) in your VPC. | ||
| 207 | |||
| 208 | =item * | ||
| 209 | |||
| 210 | C<status> - The status of the network interface. If the network | ||
| 211 | interface is not attached to an instance, the status is C<available>; | ||
| 212 | if a network interface is attached to an instance the status is | ||
| 213 | C<in-use>. | ||
| 214 | |||
| 215 | =item * | ||
| 216 | |||
| 217 | C<subnet-id> - The ID of the subnet for the network interface. | ||
| 218 | |||
| 219 | =item * | ||
| 220 | |||
| 221 | C<tag>:E<lt>keyE<gt> - The key/value combination of a tag assigned to | ||
| 222 | the resource. Use the tag key in the filter name and the tag value as | ||
| 223 | the filter value. For example, to find all resources that have a tag | ||
| 224 | with the key C<Owner> and the value C<TeamA>, specify C<tag:Owner> for | ||
| 225 | the filter name and C<TeamA> for the filter value. | ||
| 226 | |||
| 227 | =item * | ||
| 228 | |||
| 229 | C<tag-key> - The key of a tag assigned to the resource. Use this filter | ||
| 230 | to find all resources assigned a tag with a specific key, regardless of | ||
| 231 | the tag value. | ||
| 232 | |||
| 233 | =item * | ||
| 234 | |||
| 235 | C<vpc-id> - The ID of the VPC for the network interface. | ||
| 236 | |||
| 237 | =back | ||
| 238 | |||
| 239 | |||
| 240 | |||
| 241 | |||
| 242 | =head2 MaxResults => Int | ||
| 243 | |||
| 244 | The maximum number of items to return for this request. The request | ||
| 245 | returns a token that you can specify in a subsequent call to get the | ||
| 246 | next set of results. You cannot specify this parameter and the network | ||
| 247 | interface IDs parameter in the same request. | ||
| 248 | |||
| 249 | |||
| 250 | |||
| 251 | =head2 NetworkInterfaceIds => ArrayRef[Str|Undef] | ||
| 252 | |||
| 253 | One or more network interface IDs. | ||
| 254 | |||
| 255 | Default: Describes all your network interfaces. | ||
| 256 | |||
| 257 | |||
| 258 | |||
| 259 | =head2 NextToken => Str | ||
| 260 | |||
| 261 | The token to retrieve the next page of results. | ||
| 262 | |||
| 263 | |||
| 264 | |||
| 265 | |||
| 266 | =head1 SEE ALSO | ||
| 267 | |||
| 268 | This class forms part of L<Paws>, documenting arguments for method DescribeNetworkInterfaces in L<Paws::EC2> | ||
| 269 | |||
| 270 | =head1 BUGS and CONTRIBUTIONS | ||
| 271 | |||
| 272 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 273 | |||
| 274 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 275 | |||
| 276 | =cut | ||
| 277 | |||