blib/lib/Paws/ComputeOptimizer/ExportEC2InstanceRecommendations.pm untested

filter: Statementstmt 0.0% 0 / 21 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 23 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::ComputeOptimizer::ExportEC2InstanceRecommendations;
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::Filter]', 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 => 'ExportEC2InstanceRecommendations');
14 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ComputeOptimizer::ExportEC2InstanceRecommendationsResponse');
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::ExportEC2InstanceRecommendations - Arguments for method ExportEC2InstanceRecommendations on L<Paws::ComputeOptimizer>
23  
24 =head1 DESCRIPTION
25  
26 This class represents the parameters used for calling the method ExportEC2InstanceRecommendations on the
27 L<AWS Compute Optimizer|Paws::ComputeOptimizer> service. Use the attributes of this class
28 as arguments to method ExportEC2InstanceRecommendations.
29  
30 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ExportEC2InstanceRecommendations.
31  
32 =head1 SYNOPSIS
33  
34 my $compute-optimizer = Paws->service('ComputeOptimizer');
35 my $ExportEC2InstanceRecommendationsResponse =
36 $compute -optimizer->ExportEC2InstanceRecommendations(
37 S3DestinationConfig => {
38 Bucket => 'MyDestinationBucket', # OPTIONAL
39 KeyPrefix => 'MyDestinationKeyPrefix', # OPTIONAL
40 },
41 AccountIds => [ 'MyAccountId', ... ], # OPTIONAL
42 FieldsToExport => [
43 'AccountId',
44 ... # values: AccountId, InstanceArn, InstanceName, Finding, FindingReasonCodes, LookbackPeriodInDays, CurrentInstanceType, UtilizationMetricsCpuMaximum, UtilizationMetricsMemoryMaximum, UtilizationMetricsEbsReadOpsPerSecondMaximum, UtilizationMetricsEbsWriteOpsPerSecondMaximum, UtilizationMetricsEbsReadBytesPerSecondMaximum, UtilizationMetricsEbsWriteBytesPerSecondMaximum, UtilizationMetricsDiskReadOpsPerSecondMaximum, UtilizationMetricsDiskWriteOpsPerSecondMaximum, UtilizationMetricsDiskReadBytesPerSecondMaximum, UtilizationMetricsDiskWriteBytesPerSecondMaximum, UtilizationMetricsNetworkInBytesPerSecondMaximum, UtilizationMetricsNetworkOutBytesPerSecondMaximum, UtilizationMetricsNetworkPacketsInPerSecondMaximum, UtilizationMetricsNetworkPacketsOutPerSecondMaximum, CurrentOnDemandPrice, CurrentStandardOneYearNoUpfrontReservedPrice, CurrentStandardThreeYearNoUpfrontReservedPrice, CurrentVCpus, CurrentMemory, CurrentStorage, CurrentNetwork, RecommendationOptionsInstanceType, RecommendationOptionsProjectedUtilizationMetricsCpuMaximum, RecommendationOptionsProjectedUtilizationMetricsMemoryMaximum, RecommendationOptionsPlatformDifferences, RecommendationOptionsPerformanceRisk, RecommendationOptionsVcpus, RecommendationOptionsMemory, RecommendationOptionsStorage, RecommendationOptionsNetwork, RecommendationOptionsOnDemandPrice, RecommendationOptionsStandardOneYearNoUpfrontReservedPrice, RecommendationOptionsStandardThreeYearNoUpfrontReservedPrice, RecommendationsSourcesRecommendationSourceArn, RecommendationsSourcesRecommendationSourceType, LastRefreshTimestamp
45 ], # OPTIONAL
46 FileFormat => 'Csv', # OPTIONAL
47 Filters => [
48 {
49 Name => 'Finding'
50 , # values: Finding, FindingReasonCodes, RecommendationSourceType; OPTIONAL
51 Values => [ 'MyFilterValue', ... ], # OPTIONAL
52 },
53 ...
54 ], # OPTIONAL
55 IncludeMemberAccounts => 1, # OPTIONAL
56 );
57  
58 # Results:
59 my $JobId = $ExportEC2InstanceRecommendationsResponse->JobId;
60 my $S3Destination =
61 $ExportEC2InstanceRecommendationsResponse->S3Destination;
62  
63 # Returns a L<Paws::ComputeOptimizer::ExportEC2InstanceRecommendationsResponse> object.
64  
65 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.
66 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/compute-optimizer/ExportEC2InstanceRecommendations>
67  
68 =head1 ATTRIBUTES
69  
70  
71 =head2 AccountIds => ArrayRef[Str|Undef]
72  
73 The IDs of the AWS accounts for which to export instance
74 recommendations.
75  
76 If your account is the management account of an organization, use this
77 parameter to specify the member account for which you want to export
78 recommendations.
79  
80 This parameter cannot be specified together with the include member
81 accounts parameter. The parameters are mutually exclusive.
82  
83 Recommendations for member accounts are not included in the export if
84 this parameter, or the include member accounts parameter, is omitted.
85  
86 You can specify multiple account IDs per request.
87  
88  
89  
90 =head2 FieldsToExport => ArrayRef[Str|Undef]
91  
92 The recommendations data to include in the export file. For more
93 information about the fields that can be exported, see Exported files
94 (https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html#exported-files)
95 in the I<Compute Optimizer User Guide>.
96  
97  
98  
99 =head2 FileFormat => Str
100  
101 The format of the export file.
102  
103 The only export file format currently supported is C<Csv>.
104  
105 Valid values are: C<"Csv">
106  
107 =head2 Filters => ArrayRef[L<Paws::ComputeOptimizer::Filter>]
108  
109 An array of objects that describe a filter to export a more specific
110 set of instance recommendations.
111  
112  
113  
114 =head2 IncludeMemberAccounts => Bool
115  
116 Indicates whether to include recommendations for resources in all
117 member accounts of the organization if your account is the management
118 account of an organization.
119  
120 The member accounts must also be opted in to Compute Optimizer, and
121 trusted access for Compute Optimizer must be enabled in the
122 organization account. For more information, see Compute Optimizer and
123 AWS Organizations trusted access
124 (https://docs.aws.amazon.com/compute-optimizer/latest/ug/security-iam.html#trusted-service-access)
125 in the I<AWS Compute Optimizer User Guide>.
126  
127 Recommendations for member accounts of the organization are not
128 included in the export file if this parameter is omitted.
129  
130 Recommendations for member accounts are not included in the export if
131 this parameter, or the account IDs parameter, is omitted.
132  
133  
134  
135 =head2 B<REQUIRED> S3DestinationConfig => L<Paws::ComputeOptimizer::S3DestinationConfig>
136  
137 An object to specify the destination Amazon Simple Storage Service
138 (Amazon S3) bucket name and key prefix for the export job.
139  
140 You must create the destination Amazon S3 bucket for your
141 recommendations export before you create the export job. Compute
142 Optimizer does not create the S3 bucket for you. After you create the
143 S3 bucket, ensure that it has the required permission policy to allow
144 Compute Optimizer to write the export file to it. If you plan to
145 specify an object prefix when you create the export job, you must
146 include the object prefix in the policy that you add to the S3 bucket.
147 For more information, see Amazon S3 Bucket Policy for Compute Optimizer
148 (https://docs.aws.amazon.com/compute-optimizer/latest/ug/create-s3-bucket-policy-for-compute-optimizer.html)
149 in the I<Compute Optimizer user guide>.
150  
151  
152  
153  
154 =head1 SEE ALSO
155  
156 This class forms part of L<Paws>, documenting arguments for method ExportEC2InstanceRecommendations in L<Paws::ComputeOptimizer>
157  
158 =head1 BUGS and CONTRIBUTIONS
159  
160 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
161  
162 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
163  
164 =cut
165