« blib/lib/Paws/ComputeOptimizer/GetEBSVolumeRecommendationsResponse.pm
↑ Summary
blib/lib/Paws/ComputeOptimizer/GetEC2InstanceRecommendationsResponse.pm »
| 1 | |||
| 2 | package Paws::ComputeOptimizer::GetEC2InstanceRecommendations; | ||
| 3 | use Moose; | ||
| 4 | has AccountIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'accountIds' ); | ||
| 5 | has Filters => (is => 'ro', isa => 'ArrayRef[Paws::ComputeOptimizer::Filter]', traits => ['NameInRequest'], request_name => 'filters' ); | ||
| 6 | has InstanceArns => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'instanceArns' ); | ||
| 7 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'maxResults' ); | ||
| 8 | has NextToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextToken' ); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetEC2InstanceRecommendations'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ComputeOptimizer::GetEC2InstanceRecommendationsResponse'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::ComputeOptimizer::GetEC2InstanceRecommendations - Arguments for method GetEC2InstanceRecommendations on L<Paws::ComputeOptimizer> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method GetEC2InstanceRecommendations on the | ||
| 26 | L<AWS Compute Optimizer|Paws::ComputeOptimizer> service. Use the attributes of this class | ||
| 27 | as arguments to method GetEC2InstanceRecommendations. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetEC2InstanceRecommendations. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $compute-optimizer = Paws->service('ComputeOptimizer'); | ||
| 34 | my $GetEC2InstanceRecommendationsResponse = | ||
| 35 | $compute -optimizer->GetEC2InstanceRecommendations( | ||
| 36 | AccountIds => [ 'MyAccountId', ... ], # OPTIONAL | ||
| 37 | Filters => [ | ||
| 38 | { | ||
| 39 | Name => 'Finding' | ||
| 40 | , # values: Finding, FindingReasonCodes, RecommendationSourceType; OPTIONAL | ||
| 41 | Values => [ 'MyFilterValue', ... ], # OPTIONAL | ||
| 42 | }, | ||
| 43 | ... | ||
| 44 | ], # OPTIONAL | ||
| 45 | InstanceArns => [ 'MyInstanceArn', ... ], # OPTIONAL | ||
| 46 | MaxResults => 1, # OPTIONAL | ||
| 47 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 48 | ); | ||
| 49 | |||
| 50 | # Results: | ||
| 51 | my $Errors = $GetEC2InstanceRecommendationsResponse->Errors; | ||
| 52 | my $InstanceRecommendations = | ||
| 53 | $GetEC2InstanceRecommendationsResponse->InstanceRecommendations; | ||
| 54 | my $NextToken = $GetEC2InstanceRecommendationsResponse->NextToken; | ||
| 55 | |||
| 56 | # Returns a L<Paws::ComputeOptimizer::GetEC2InstanceRecommendationsResponse> object. | ||
| 57 | |||
| 58 | 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. | ||
| 59 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/compute-optimizer/GetEC2InstanceRecommendations> | ||
| 60 | |||
| 61 | =head1 ATTRIBUTES | ||
| 62 | |||
| 63 | |||
| 64 | =head2 AccountIds => ArrayRef[Str|Undef] | ||
| 65 | |||
| 66 | The ID of the AWS account for which to return instance recommendations. | ||
| 67 | |||
| 68 | If your account is the management account of an organization, use this | ||
| 69 | parameter to specify the member account for which you want to return | ||
| 70 | instance recommendations. | ||
| 71 | |||
| 72 | Only one account ID can be specified per request. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head2 Filters => ArrayRef[L<Paws::ComputeOptimizer::Filter>] | ||
| 77 | |||
| 78 | An array of objects that describe a filter that returns a more specific | ||
| 79 | list of instance recommendations. | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head2 InstanceArns => ArrayRef[Str|Undef] | ||
| 84 | |||
| 85 | The Amazon Resource Name (ARN) of the instances for which to return | ||
| 86 | recommendations. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head2 MaxResults => Int | ||
| 91 | |||
| 92 | The maximum number of instance recommendations to return with a single | ||
| 93 | request. | ||
| 94 | |||
| 95 | To retrieve the remaining results, make another request with the | ||
| 96 | returned C<NextToken> value. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head2 NextToken => Str | ||
| 101 | |||
| 102 | The token to advance to the next page of instance recommendations. | ||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | =head1 SEE ALSO | ||
| 108 | |||
| 109 | This class forms part of L<Paws>, documenting arguments for method GetEC2InstanceRecommendations in L<Paws::ComputeOptimizer> | ||
| 110 | |||
| 111 | =head1 BUGS and CONTRIBUTIONS | ||
| 112 | |||
| 113 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 114 | |||
| 115 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 116 | |||
| 117 | =cut | ||
| 118 |