« blib/lib/Paws/EC2/DescribeFleetInstancesResult.pm
↑ Summary
blib/lib/Paws/EC2/DescribeFleetsInstances.pm »
| 1 | |||
| 2 | package Paws::EC2::DescribeFleets; | ||
| 3 | use Moose; | ||
| 4 | has DryRun => (is => 'ro', isa => 'Bool'); | ||
| 5 | has Filters => (is => 'ro', isa => 'ArrayRef[Paws::EC2::Filter]', traits => ['NameInRequest'], request_name => 'Filter' ); | ||
| 6 | has FleetIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'FleetId' ); | ||
| 7 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 8 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeFleets'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::DescribeFleetsResult'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::EC2::DescribeFleets - Arguments for method DescribeFleets on L<Paws::EC2> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method DescribeFleets on the | ||
| 26 | L<Amazon Elastic Compute Cloud|Paws::EC2> service. Use the attributes of this class | ||
| 27 | as arguments to method DescribeFleets. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeFleets. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $ec2 = Paws->service('EC2'); | ||
| 34 | my $DescribeFleetsResult = $ec2->DescribeFleets( | ||
| 35 | DryRun => 1, # OPTIONAL | ||
| 36 | Filters => [ | ||
| 37 | { | ||
| 38 | Name => 'MyString', # OPTIONAL | ||
| 39 | Values => [ | ||
| 40 | 'MyString', ... # OPTIONAL | ||
| 41 | ], # OPTIONAL | ||
| 42 | }, | ||
| 43 | ... | ||
| 44 | ], # OPTIONAL | ||
| 45 | FleetIds => [ 'MyFleetId', ... ], # OPTIONAL | ||
| 46 | MaxResults => 1, # OPTIONAL | ||
| 47 | NextToken => 'MyString', # OPTIONAL | ||
| 48 | ); | ||
| 49 | |||
| 50 | # Results: | ||
| 51 | my $Fleets = $DescribeFleetsResult->Fleets; | ||
| 52 | my $NextToken = $DescribeFleetsResult->NextToken; | ||
| 53 | |||
| 54 | # Returns a L<Paws::EC2::DescribeFleetsResult> object. | ||
| 55 | |||
| 56 | 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. | ||
| 57 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ec2/DescribeFleets> | ||
| 58 | |||
| 59 | =head1 ATTRIBUTES | ||
| 60 | |||
| 61 | |||
| 62 | =head2 DryRun => Bool | ||
| 63 | |||
| 64 | Checks whether you have the required permissions for the action, | ||
| 65 | without actually making the request, and provides an error response. If | ||
| 66 | you have the required permissions, the error response is | ||
| 67 | C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>. | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head2 Filters => ArrayRef[L<Paws::EC2::Filter>] | ||
| 72 | |||
| 73 | The filters. | ||
| 74 | |||
| 75 | =over | ||
| 76 | |||
| 77 | =item * | ||
| 78 | |||
| 79 | C<activity-status> - The progress of the EC2 Fleet ( C<error> | | ||
| 80 | C<pending-fulfillment> | C<pending-termination> | C<fulfilled>). | ||
| 81 | |||
| 82 | =item * | ||
| 83 | |||
| 84 | C<excess-capacity-termination-policy> - Indicates whether to terminate | ||
| 85 | running instances if the target capacity is decreased below the current | ||
| 86 | EC2 Fleet size (C<true> | C<false>). | ||
| 87 | |||
| 88 | =item * | ||
| 89 | |||
| 90 | C<fleet-state> - The state of the EC2 Fleet (C<submitted> | C<active> | | ||
| 91 | C<deleted> | C<failed> | C<deleted-running> | C<deleted-terminating> | | ||
| 92 | C<modifying>). | ||
| 93 | |||
| 94 | =item * | ||
| 95 | |||
| 96 | C<replace-unhealthy-instances> - Indicates whether EC2 Fleet should | ||
| 97 | replace unhealthy instances (C<true> | C<false>). | ||
| 98 | |||
| 99 | =item * | ||
| 100 | |||
| 101 | C<type> - The type of request (C<instant> | C<request> | C<maintain>). | ||
| 102 | |||
| 103 | =back | ||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | |||
| 108 | =head2 FleetIds => ArrayRef[Str|Undef] | ||
| 109 | |||
| 110 | The ID of the EC2 Fleets. | ||
| 111 | |||
| 112 | |||
| 113 | |||
| 114 | =head2 MaxResults => Int | ||
| 115 | |||
| 116 | The maximum number of results to return in a single call. Specify a | ||
| 117 | value between 1 and 1000. The default value is 1000. To retrieve the | ||
| 118 | remaining results, make another call with the returned C<NextToken> | ||
| 119 | value. | ||
| 120 | |||
| 121 | |||
| 122 | |||
| 123 | =head2 NextToken => Str | ||
| 124 | |||
| 125 | The token for the next set of results. | ||
| 126 | |||
| 127 | |||
| 128 | |||
| 129 | |||
| 130 | =head1 SEE ALSO | ||
| 131 | |||
| 132 | This class forms part of L<Paws>, documenting arguments for method DescribeFleets in L<Paws::EC2> | ||
| 133 | |||
| 134 | =head1 BUGS and CONTRIBUTIONS | ||
| 135 | |||
| 136 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 137 | |||
| 138 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 139 | |||
| 140 | =cut | ||
| 141 |