« blib/lib/Paws/MediaConnect/ListOfferingsResponse.pm
↑ Summary
blib/lib/Paws/MediaConnect/ListReservationsResponse.pm »
| 1 | |||
| 2 | package Paws::MediaConnect::ListReservations; | ||
| 3 | use Moose; | ||
| 4 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'maxResults'); | ||
| 5 | has NextToken => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'nextToken'); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListReservations'); | ||
| 10 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v1/reservations'); | ||
| 11 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::MediaConnect::ListReservationsResponse'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::MediaConnect::ListReservations - Arguments for method ListReservations on L<Paws::MediaConnect> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method ListReservations on the | ||
| 24 | L<AWS MediaConnect|Paws::MediaConnect> service. Use the attributes of this class | ||
| 25 | as arguments to method ListReservations. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListReservations. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $mediaconnect = Paws->service('MediaConnect'); | ||
| 32 | my $ListReservationsResponse = $mediaconnect->ListReservations( | ||
| 33 | MaxResults => 1, # OPTIONAL | ||
| 34 | NextToken => 'My__string', # OPTIONAL | ||
| 35 | ); | ||
| 36 | |||
| 37 | # Results: | ||
| 38 | my $NextToken = $ListReservationsResponse->NextToken; | ||
| 39 | my $Reservations = $ListReservationsResponse->Reservations; | ||
| 40 | |||
| 41 | # Returns a L<Paws::MediaConnect::ListReservationsResponse> 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/mediaconnect/ListReservations> | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 MaxResults => Int | ||
| 50 | |||
| 51 | The maximum number of results to return per API request. For example, | ||
| 52 | you submit a ListReservations request with MaxResults set at 5. | ||
| 53 | Although 20 items match your request, the service returns no more than | ||
| 54 | the first 5 items. (The service also returns a NextToken value that you | ||
| 55 | can use to fetch the next batch of results.) The service might return | ||
| 56 | fewer results than the MaxResults value. If MaxResults is not included | ||
| 57 | in the request, the service defaults to pagination with a maximum of 10 | ||
| 58 | results per page. | ||
| 59 | |||
| 60 | |||
| 61 | |||
| 62 | =head2 NextToken => Str | ||
| 63 | |||
| 64 | The token that identifies which batch of results that you want to see. | ||
| 65 | For example, you submit a ListReservations request with MaxResults set | ||
| 66 | at 5. The service returns the first batch of results (up to 5) and a | ||
| 67 | NextToken value. To see the next batch of results, you can submit the | ||
| 68 | ListOfferings request a second time and specify the NextToken value. | ||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head1 SEE ALSO | ||
| 74 | |||
| 75 | This class forms part of L<Paws>, documenting arguments for method ListReservations in L<Paws::MediaConnect> | ||
| 76 | |||
| 77 | =head1 BUGS and CONTRIBUTIONS | ||
| 78 | |||
| 79 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 80 | |||
| 81 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 82 | |||
| 83 | =cut | ||
| 84 |