« blib/lib/Paws/CostExplorer/GetReservationUtilizationResponse.pm
↑ Summary
blib/lib/Paws/CostExplorer/GetRightsizingRecommendationResponse.pm »
| 1 | |||
| 2 | package Paws::CostExplorer::GetRightsizingRecommendation; | ||
| 3 | use Moose; | ||
| 4 | has Configuration => (is => 'ro', isa => 'Paws::CostExplorer::RightsizingRecommendationConfiguration'); | ||
| 5 | has Filter => (is => 'ro', isa => 'Paws::CostExplorer::Expression'); | ||
| 6 | has NextPageToken => (is => 'ro', isa => 'Str'); | ||
| 7 | has PageSize => (is => 'ro', isa => 'Int'); | ||
| 8 | has Service => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetRightsizingRecommendation'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CostExplorer::GetRightsizingRecommendationResponse'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::CostExplorer::GetRightsizingRecommendation - Arguments for method GetRightsizingRecommendation on L<Paws::CostExplorer> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method GetRightsizingRecommendation on the | ||
| 26 | L<AWS Cost Explorer Service|Paws::CostExplorer> service. Use the attributes of this class | ||
| 27 | as arguments to method GetRightsizingRecommendation. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetRightsizingRecommendation. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $ce = Paws->service('CostExplorer'); | ||
| 34 | my $GetRightsizingRecommendationResponse = | ||
| 35 | $ce->GetRightsizingRecommendation( | ||
| 36 | Service => 'MyGenericString', | ||
| 37 | Configuration => { | ||
| 38 | BenefitsConsidered => 1, | ||
| 39 | RecommendationTarget => 'SAME_INSTANCE_FAMILY' | ||
| 40 | , # values: SAME_INSTANCE_FAMILY, CROSS_INSTANCE_FAMILY | ||
| 41 | |||
| 42 | }, # OPTIONAL | ||
| 43 | Filter => { | ||
| 44 | And => [ <Expression>, ... ], # OPTIONAL | ||
| 45 | CostCategories => { | ||
| 46 | Key => 'MyCostCategoryName', # min: 1, max: 50; OPTIONAL | ||
| 47 | MatchOptions => [ | ||
| 48 | 'EQUALS', | ||
| 49 | ... # values: EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE | ||
| 50 | ], # OPTIONAL | ||
| 51 | Values => [ | ||
| 52 | 'MyValue', ... # max: 1024 | ||
| 53 | ], # OPTIONAL | ||
| 54 | }, # OPTIONAL | ||
| 55 | Dimensions => { | ||
| 56 | Key => 'AZ' | ||
| 57 | , # values: AZ, INSTANCE_TYPE, LINKED_ACCOUNT, LINKED_ACCOUNT_NAME, OPERATION, PURCHASE_TYPE, REGION, SERVICE, SERVICE_CODE, USAGE_TYPE, USAGE_TYPE_GROUP, RECORD_TYPE, OPERATING_SYSTEM, TENANCY, SCOPE, PLATFORM, SUBSCRIPTION_ID, LEGAL_ENTITY_NAME, DEPLOYMENT_OPTION, DATABASE_ENGINE, CACHE_ENGINE, INSTANCE_TYPE_FAMILY, BILLING_ENTITY, RESERVATION_ID, RESOURCE_ID, RIGHTSIZING_TYPE, SAVINGS_PLANS_TYPE, SAVINGS_PLAN_ARN, PAYMENT_OPTION, AGREEMENT_END_DATE_TIME_AFTER, AGREEMENT_END_DATE_TIME_BEFORE; OPTIONAL | ||
| 58 | MatchOptions => [ | ||
| 59 | 'EQUALS', | ||
| 60 | ... # values: EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE | ||
| 61 | ], # OPTIONAL | ||
| 62 | Values => [ | ||
| 63 | 'MyValue', ... # max: 1024 | ||
| 64 | ], # OPTIONAL | ||
| 65 | }, # OPTIONAL | ||
| 66 | Not => <Expression>, | ||
| 67 | Or => [ <Expression>, ... ], # OPTIONAL | ||
| 68 | Tags => { | ||
| 69 | Key => 'MyTagKey', # max: 1024; OPTIONAL | ||
| 70 | MatchOptions => [ | ||
| 71 | 'EQUALS', | ||
| 72 | ... # values: EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE | ||
| 73 | ], # OPTIONAL | ||
| 74 | Values => [ | ||
| 75 | 'MyValue', ... # max: 1024 | ||
| 76 | ], # OPTIONAL | ||
| 77 | }, # OPTIONAL | ||
| 78 | }, # OPTIONAL | ||
| 79 | NextPageToken => 'MyNextPageToken', # OPTIONAL | ||
| 80 | PageSize => 1, # OPTIONAL | ||
| 81 | ); | ||
| 82 | |||
| 83 | # Results: | ||
| 84 | my $Configuration = $GetRightsizingRecommendationResponse->Configuration; | ||
| 85 | my $Metadata = $GetRightsizingRecommendationResponse->Metadata; | ||
| 86 | my $NextPageToken = $GetRightsizingRecommendationResponse->NextPageToken; | ||
| 87 | my $RightsizingRecommendations = | ||
| 88 | $GetRightsizingRecommendationResponse->RightsizingRecommendations; | ||
| 89 | my $Summary = $GetRightsizingRecommendationResponse->Summary; | ||
| 90 | |||
| 91 | # Returns a L<Paws::CostExplorer::GetRightsizingRecommendationResponse> object. | ||
| 92 | |||
| 93 | 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. | ||
| 94 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ce/GetRightsizingRecommendation> | ||
| 95 | |||
| 96 | =head1 ATTRIBUTES | ||
| 97 | |||
| 98 | |||
| 99 | =head2 Configuration => L<Paws::CostExplorer::RightsizingRecommendationConfiguration> | ||
| 100 | |||
| 101 | Enables you to customize recommendations across two attributes. You can | ||
| 102 | choose to view recommendations for instances within the same instance | ||
| 103 | families or across different instance families. You can also choose to | ||
| 104 | view your estimated savings associated with recommendations with | ||
| 105 | consideration of existing Savings Plans or RI benefits, or neither. | ||
| 106 | |||
| 107 | |||
| 108 | |||
| 109 | =head2 Filter => L<Paws::CostExplorer::Expression> | ||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | |||
| 114 | |||
| 115 | =head2 NextPageToken => Str | ||
| 116 | |||
| 117 | The pagination token that indicates the next set of results that you | ||
| 118 | want to retrieve. | ||
| 119 | |||
| 120 | |||
| 121 | |||
| 122 | =head2 PageSize => Int | ||
| 123 | |||
| 124 | The number of recommendations that you want returned in a single | ||
| 125 | response object. | ||
| 126 | |||
| 127 | |||
| 128 | |||
| 129 | =head2 B<REQUIRED> Service => Str | ||
| 130 | |||
| 131 | The specific service that you want recommendations for. The only valid | ||
| 132 | value for C<GetRightsizingRecommendation> is "C<AmazonEC2>". | ||
| 133 | |||
| 134 | |||
| 135 | |||
| 136 | |||
| 137 | =head1 SEE ALSO | ||
| 138 | |||
| 139 | This class forms part of L<Paws>, documenting arguments for method GetRightsizingRecommendation in L<Paws::CostExplorer> | ||
| 140 | |||
| 141 | =head1 BUGS and CONTRIBUTIONS | ||
| 142 | |||
| 143 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 144 | |||
| 145 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 146 | |||
| 147 | =cut | ||
| 148 |