« blib/lib/Paws/ComputeOptimizer/ExportEC2InstanceRecommendationsResponse.pm
↑ Summary
blib/lib/Paws/ComputeOptimizer/ExportLambdaFunctionRecommendationsResponse.pm »
| 1 | |||
| 2 | package Paws::ComputeOptimizer::ExportLambdaFunctionRecommendations; | ||
| 3 | use Moose; | ||
| 4 | has AccountIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'accountIds' ); | ||
| 5 | has FieldsToExport => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'fieldsToExport' ); | ||
| 6 | has FileFormat => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'fileFormat' ); | ||
| 7 | has Filters => (is => 'ro', isa => 'ArrayRef[Paws::ComputeOptimizer::LambdaFunctionRecommendationFilter]', traits => ['NameInRequest'], request_name => 'filters' ); | ||
| 8 | has IncludeMemberAccounts => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'includeMemberAccounts' ); | ||
| 9 | has S3DestinationConfig => (is => 'ro', isa => 'Paws::ComputeOptimizer::S3DestinationConfig', traits => ['NameInRequest'], request_name => 's3DestinationConfig' , required => 1); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ExportLambdaFunctionRecommendations'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ComputeOptimizer::ExportLambdaFunctionRecommendationsResponse'); | ||
| 15 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::ComputeOptimizer::ExportLambdaFunctionRecommendations - Arguments for method ExportLambdaFunctionRecommendations on L<Paws::ComputeOptimizer> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method ExportLambdaFunctionRecommendations on the | ||
| 27 | L<AWS Compute Optimizer|Paws::ComputeOptimizer> service. Use the attributes of this class | ||
| 28 | as arguments to method ExportLambdaFunctionRecommendations. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ExportLambdaFunctionRecommendations. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $compute-optimizer = Paws->service('ComputeOptimizer'); | ||
| 35 | my $ExportLambdaFunctionRecommendationsResponse = | ||
| 36 | $compute -optimizer->ExportLambdaFunctionRecommendations( | ||
| 37 | S3DestinationConfig => { | ||
| 38 | Bucket => 'MyDestinationBucket', # OPTIONAL | ||
| 39 | KeyPrefix => 'MyDestinationKeyPrefix', # OPTIONAL | ||
| 40 | }, | ||
| 41 | AccountIds => [ 'MyAccountId', ... ], # OPTIONAL | ||
| 42 | FieldsToExport => [ | ||
| 43 | 'AccountId', | ||
| 44 | ... # values: AccountId, FunctionArn, FunctionVersion, Finding, FindingReasonCodes, NumberOfInvocations, UtilizationMetricsDurationMaximum, UtilizationMetricsDurationAverage, UtilizationMetricsMemoryMaximum, UtilizationMetricsMemoryAverage, LookbackPeriodInDays, CurrentConfigurationMemorySize, CurrentConfigurationTimeout, CurrentCostTotal, CurrentCostAverage, RecommendationOptionsConfigurationMemorySize, RecommendationOptionsCostLow, RecommendationOptionsCostHigh, RecommendationOptionsProjectedUtilizationMetricsDurationLowerBound, RecommendationOptionsProjectedUtilizationMetricsDurationUpperBound, RecommendationOptionsProjectedUtilizationMetricsDurationExpected, LastRefreshTimestamp | ||
| 45 | ], # OPTIONAL | ||
| 46 | FileFormat => 'Csv', # OPTIONAL | ||
| 47 | Filters => [ | ||
| 48 | { | ||
| 49 | Name => 'Finding', # values: Finding, FindingReasonCode; OPTIONAL | ||
| 50 | Values => [ 'MyFilterValue', ... ], # OPTIONAL | ||
| 51 | }, | ||
| 52 | ... | ||
| 53 | ], # OPTIONAL | ||
| 54 | IncludeMemberAccounts => 1, # OPTIONAL | ||
| 55 | ); | ||
| 56 | |||
| 57 | # Results: | ||
| 58 | my $JobId = $ExportLambdaFunctionRecommendationsResponse->JobId; | ||
| 59 | my $S3Destination = | ||
| 60 | $ExportLambdaFunctionRecommendationsResponse->S3Destination; | ||
| 61 | |||
| 62 | # Returns a L<Paws::ComputeOptimizer::ExportLambdaFunctionRecommendationsResponse> object. | ||
| 63 | |||
| 64 | 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. | ||
| 65 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/compute-optimizer/ExportLambdaFunctionRecommendations> | ||
| 66 | |||
| 67 | =head1 ATTRIBUTES | ||
| 68 | |||
| 69 | |||
| 70 | =head2 AccountIds => ArrayRef[Str|Undef] | ||
| 71 | |||
| 72 | The IDs of the AWS accounts for which to export Lambda function | ||
| 73 | recommendations. | ||
| 74 | |||
| 75 | If your account is the management account of an organization, use this | ||
| 76 | parameter to specify the member account for which you want to export | ||
| 77 | recommendations. | ||
| 78 | |||
| 79 | This parameter cannot be specified together with the include member | ||
| 80 | accounts parameter. The parameters are mutually exclusive. | ||
| 81 | |||
| 82 | Recommendations for member accounts are not included in the export if | ||
| 83 | this parameter, or the include member accounts parameter, is omitted. | ||
| 84 | |||
| 85 | You can specify multiple account IDs per request. | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | =head2 FieldsToExport => ArrayRef[Str|Undef] | ||
| 90 | |||
| 91 | The recommendations data to include in the export file. For more | ||
| 92 | information about the fields that can be exported, see Exported files | ||
| 93 | (https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html#exported-files) | ||
| 94 | in the I<Compute Optimizer User Guide>. | ||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | =head2 FileFormat => Str | ||
| 99 | |||
| 100 | The format of the export file. | ||
| 101 | |||
| 102 | The only export file format currently supported is C<Csv>. | ||
| 103 | |||
| 104 | Valid values are: C<"Csv"> | ||
| 105 | |||
| 106 | =head2 Filters => ArrayRef[L<Paws::ComputeOptimizer::LambdaFunctionRecommendationFilter>] | ||
| 107 | |||
| 108 | An array of objects that describe a filter to export a more specific | ||
| 109 | set of Lambda function recommendations. | ||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | =head2 IncludeMemberAccounts => Bool | ||
| 114 | |||
| 115 | Indicates whether to include recommendations for resources in all | ||
| 116 | member accounts of the organization if your account is the management | ||
| 117 | account of an organization. | ||
| 118 | |||
| 119 | The member accounts must also be opted in to Compute Optimizer, and | ||
| 120 | trusted access for Compute Optimizer must be enabled in the | ||
| 121 | organization account. For more information, see Compute Optimizer and | ||
| 122 | AWS Organizations trusted access | ||
| 123 | (https://docs.aws.amazon.com/compute-optimizer/latest/ug/security-iam.html#trusted-service-access) | ||
| 124 | in the I<AWS Compute Optimizer User Guide>. | ||
| 125 | |||
| 126 | Recommendations for member accounts of the organization are not | ||
| 127 | included in the export file if this parameter is omitted. | ||
| 128 | |||
| 129 | This parameter cannot be specified together with the account IDs | ||
| 130 | parameter. The parameters are mutually exclusive. | ||
| 131 | |||
| 132 | Recommendations for member accounts are not included in the export if | ||
| 133 | this parameter, or the account IDs parameter, is omitted. | ||
| 134 | |||
| 135 | |||
| 136 | |||
| 137 | =head2 B<REQUIRED> S3DestinationConfig => L<Paws::ComputeOptimizer::S3DestinationConfig> | ||
| 138 | |||
| 139 | |||
| 140 | |||
| 141 | |||
| 142 | |||
| 143 | |||
| 144 | =head1 SEE ALSO | ||
| 145 | |||
| 146 | This class forms part of L<Paws>, documenting arguments for method ExportLambdaFunctionRecommendations in L<Paws::ComputeOptimizer> | ||
| 147 | |||
| 148 | =head1 BUGS and CONTRIBUTIONS | ||
| 149 | |||
| 150 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 151 | |||
| 152 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 153 | |||
| 154 | =cut | ||
| 155 |