« blib/lib/Paws/EC2/DescribeFpgaImagesResult.pm
↑ Summary
blib/lib/Paws/EC2/DescribeHostReservationOfferingsResult.pm »
| 1 | |||
| 2 | package Paws::EC2::DescribeHostReservationOfferings; | ||
| 3 | use Moose; | ||
| 4 | has Filter => (is => 'ro', isa => 'ArrayRef[Paws::EC2::Filter]'); | ||
| 5 | has MaxDuration => (is => 'ro', isa => 'Int'); | ||
| 6 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 7 | has MinDuration => (is => 'ro', isa => 'Int'); | ||
| 8 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 9 | has OfferingId => (is => 'ro', isa => 'Str'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeHostReservationOfferings'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::DescribeHostReservationOfferingsResult'); | ||
| 15 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::EC2::DescribeHostReservationOfferings - Arguments for method DescribeHostReservationOfferings on L<Paws::EC2> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method DescribeHostReservationOfferings on the | ||
| 27 | L<Amazon Elastic Compute Cloud|Paws::EC2> service. Use the attributes of this class | ||
| 28 | as arguments to method DescribeHostReservationOfferings. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeHostReservationOfferings. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $ec2 = Paws->service('EC2'); | ||
| 35 | my $DescribeHostReservationOfferingsResult = | ||
| 36 | $ec2->DescribeHostReservationOfferings( | ||
| 37 | Filter => [ | ||
| 38 | { | ||
| 39 | Name => 'MyString', # OPTIONAL | ||
| 40 | Values => [ | ||
| 41 | 'MyString', ... # OPTIONAL | ||
| 42 | ], # OPTIONAL | ||
| 43 | }, | ||
| 44 | ... | ||
| 45 | ], # OPTIONAL | ||
| 46 | MaxDuration => 1, # OPTIONAL | ||
| 47 | MaxResults => 1, # OPTIONAL | ||
| 48 | MinDuration => 1, # OPTIONAL | ||
| 49 | NextToken => 'MyString', # OPTIONAL | ||
| 50 | OfferingId => 'MyOfferingId', # OPTIONAL | ||
| 51 | ); | ||
| 52 | |||
| 53 | # Results: | ||
| 54 | my $NextToken = $DescribeHostReservationOfferingsResult->NextToken; | ||
| 55 | my $OfferingSet = $DescribeHostReservationOfferingsResult->OfferingSet; | ||
| 56 | |||
| 57 | # Returns a L<Paws::EC2::DescribeHostReservationOfferingsResult> object. | ||
| 58 | |||
| 59 | 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. | ||
| 60 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ec2/DescribeHostReservationOfferings> | ||
| 61 | |||
| 62 | =head1 ATTRIBUTES | ||
| 63 | |||
| 64 | |||
| 65 | =head2 Filter => ArrayRef[L<Paws::EC2::Filter>] | ||
| 66 | |||
| 67 | The filters. | ||
| 68 | |||
| 69 | =over | ||
| 70 | |||
| 71 | =item * | ||
| 72 | |||
| 73 | C<instance-family> - The instance family of the offering (for example, | ||
| 74 | C<m4>). | ||
| 75 | |||
| 76 | =item * | ||
| 77 | |||
| 78 | C<payment-option> - The payment option (C<NoUpfront> | | ||
| 79 | C<PartialUpfront> | C<AllUpfront>). | ||
| 80 | |||
| 81 | =back | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head2 MaxDuration => Int | ||
| 87 | |||
| 88 | This is the maximum duration of the reservation to purchase, specified | ||
| 89 | in seconds. Reservations are available in one-year and three-year | ||
| 90 | terms. The number of seconds specified must be the number of seconds in | ||
| 91 | a year (365x24x60x60) times one of the supported durations (1 or 3). | ||
| 92 | For example, specify 94608000 for three years. | ||
| 93 | |||
| 94 | |||
| 95 | |||
| 96 | =head2 MaxResults => Int | ||
| 97 | |||
| 98 | The maximum number of results to return for the request in a single | ||
| 99 | page. The remaining results can be seen by sending another request with | ||
| 100 | the returned C<nextToken> value. This value can be between 5 and 500. | ||
| 101 | If C<maxResults> is given a larger value than 500, you receive an | ||
| 102 | error. | ||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | =head2 MinDuration => Int | ||
| 107 | |||
| 108 | This is the minimum duration of the reservation you'd like to purchase, | ||
| 109 | specified in seconds. Reservations are available in one-year and | ||
| 110 | three-year terms. The number of seconds specified must be the number of | ||
| 111 | seconds in a year (365x24x60x60) times one of the supported durations | ||
| 112 | (1 or 3). For example, specify 31536000 for one year. | ||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | =head2 NextToken => Str | ||
| 117 | |||
| 118 | The token to use to retrieve the next page of results. | ||
| 119 | |||
| 120 | |||
| 121 | |||
| 122 | =head2 OfferingId => Str | ||
| 123 | |||
| 124 | The ID of the reservation offering. | ||
| 125 | |||
| 126 | |||
| 127 | |||
| 128 | |||
| 129 | =head1 SEE ALSO | ||
| 130 | |||
| 131 | This class forms part of L<Paws>, documenting arguments for method DescribeHostReservationOfferings in L<Paws::EC2> | ||
| 132 | |||
| 133 | =head1 BUGS and CONTRIBUTIONS | ||
| 134 | |||
| 135 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 136 | |||
| 137 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 138 | |||
| 139 | =cut | ||
| 140 |