« blib/lib/Paws/EC2/DescribeCustomerGatewaysResult.pm
↑ Summary
blib/lib/Paws/EC2/DescribeDhcpOptionsResult.pm »
| 1 | |||
| 2 | package Paws::EC2::DescribeDhcpOptions; | ||
| 3 | 1 | ▶ | use Moose; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 4 | 1 | has DhcpOptionsIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'DhcpOptionsId' ); | |
| 5 | 1 | has DryRun => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'dryRun' ); | |
| 6 | 1 | has Filters => (is => 'ro', isa => 'ArrayRef[Paws::EC2::Filter]', traits => ['NameInRequest'], request_name => 'Filter' ); | |
| 7 | 1 | has MaxResults => (is => 'ro', isa => 'Int'); | |
| 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 => 'DescribeDhcpOptions'); | |
| 13 | 1 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::DescribeDhcpOptionsResult'); | |
| 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::DescribeDhcpOptions - Arguments for method DescribeDhcpOptions on L<Paws::EC2> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method DescribeDhcpOptions on the | ||
| 26 | L<Amazon Elastic Compute Cloud|Paws::EC2> service. Use the attributes of this class | ||
| 27 | as arguments to method DescribeDhcpOptions. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeDhcpOptions. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $ec2 = Paws->service('EC2'); | ||
| 34 | # To describe a DHCP options set | ||
| 35 | # This example describes the specified DHCP options set. | ||
| 36 | my $DescribeDhcpOptionsResult = | ||
| 37 | $ec2->DescribeDhcpOptions( 'DhcpOptionsIds' => ['dopt-d9070ebb'] ); | ||
| 38 | |||
| 39 | # Results: | ||
| 40 | my $DhcpOptions = $DescribeDhcpOptionsResult->DhcpOptions; | ||
| 41 | |||
| 42 | # Returns a L<Paws::EC2::DescribeDhcpOptionsResult> object. | ||
| 43 | |||
| 44 | 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. | ||
| 45 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ec2/DescribeDhcpOptions> | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 DhcpOptionsIds => ArrayRef[Str|Undef] | ||
| 51 | |||
| 52 | The IDs of one or more DHCP options sets. | ||
| 53 | |||
| 54 | Default: Describes all your DHCP options sets. | ||
| 55 | |||
| 56 | |||
| 57 | |||
| 58 | =head2 DryRun => Bool | ||
| 59 | |||
| 60 | Checks whether you have the required permissions for the action, | ||
| 61 | without actually making the request, and provides an error response. If | ||
| 62 | you have the required permissions, the error response is | ||
| 63 | C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>. | ||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | =head2 Filters => ArrayRef[L<Paws::EC2::Filter>] | ||
| 68 | |||
| 69 | One or more filters. | ||
| 70 | |||
| 71 | =over | ||
| 72 | |||
| 73 | =item * | ||
| 74 | |||
| 75 | C<dhcp-options-id> - The ID of a DHCP options set. | ||
| 76 | |||
| 77 | =item * | ||
| 78 | |||
| 79 | C<key> - The key for one of the options (for example, C<domain-name>). | ||
| 80 | |||
| 81 | =item * | ||
| 82 | |||
| 83 | C<value> - The value for one of the options. | ||
| 84 | |||
| 85 | =item * | ||
| 86 | |||
| 87 | C<owner-id> - The ID of the AWS account that owns the DHCP options set. | ||
| 88 | |||
| 89 | =item * | ||
| 90 | |||
| 91 | C<tag>:E<lt>keyE<gt> - The key/value combination of a tag assigned to | ||
| 92 | the resource. Use the tag key in the filter name and the tag value as | ||
| 93 | the filter value. For example, to find all resources that have a tag | ||
| 94 | with the key C<Owner> and the value C<TeamA>, specify C<tag:Owner> for | ||
| 95 | the filter name and C<TeamA> for the filter value. | ||
| 96 | |||
| 97 | =item * | ||
| 98 | |||
| 99 | C<tag-key> - The key of a tag assigned to the resource. Use this filter | ||
| 100 | to find all resources assigned a tag with a specific key, regardless of | ||
| 101 | the tag value. | ||
| 102 | |||
| 103 | =back | ||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | |||
| 108 | =head2 MaxResults => Int | ||
| 109 | |||
| 110 | The maximum number of results to return with a single call. To retrieve | ||
| 111 | the remaining results, make another call with the returned C<nextToken> | ||
| 112 | value. | ||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | =head2 NextToken => Str | ||
| 117 | |||
| 118 | The token for the next page of results. | ||
| 119 | |||
| 120 | |||
| 121 | |||
| 122 | |||
| 123 | =head1 SEE ALSO | ||
| 124 | |||
| 125 | This class forms part of L<Paws>, documenting arguments for method DescribeDhcpOptions in L<Paws::EC2> | ||
| 126 | |||
| 127 | =head1 BUGS and CONTRIBUTIONS | ||
| 128 | |||
| 129 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 130 | |||
| 131 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 132 | |||
| 133 | =cut | ||
| 134 | |||